1 /* <lambda>null2 * Copyright (C) 2019 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.tools.metalava 18 19 import com.android.tools.metalava.model.Item 20 import com.android.tools.metalava.model.PackageItem 21 import com.android.tools.metalava.model.visitors.ApiVisitor 22 23 /** 24 * An [ApiVisitor] that applies a regex replacement to the documentation of 25 * [Item]s from the given packages and their sub-packages. 26 */ 27 class DocReplacement( 28 private val packageNames: List<String>, 29 private val regex: Regex, 30 private val replacement: String 31 ) : ApiVisitor() { 32 33 private fun appliesToPackage(packageItem: PackageItem): Boolean { 34 val fqn = packageItem.qualifiedName() 35 return packageNames.any { 36 pkg -> fqn.startsWith(pkg) && (fqn.length == pkg.length || fqn[pkg.length] == '.') 37 } 38 } 39 40 override fun visitItem(item: Item) { 41 val doc = item.documentation 42 if (doc.isBlank()) { 43 return 44 } 45 val pkg = item.containingPackage(strict = false) 46 if (pkg != null && appliesToPackage(pkg)) { 47 val new = doc.replace(regex, replacement) 48 if (new != doc) { 49 item.documentation = new 50 } 51 } 52 } 53 }