slack.lint.util.Names.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slack-lint-checks Show documentation
Slack lint checks.
The newest version!
/*
 * Copyright 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package slack.lint.util

import kotlin.metadata.ClassName

/**
 * Represents a qualified package
 *
 * @property segments the segments representing the package
 */
internal class PackageName(val segments: List) {
  /** The Java-style package name for this [Name], separated with `.` */
  val javaPackageName: String
    get() = segments.joinToString(".")
}

/**
 * Represents the qualified name for an element
 *
 * @property pkg the package for this element
 * @property nameSegments the segments representing the element - there can be multiple in the case
 *   of nested classes.
 */
internal class Name(private val pkg: PackageName, private val nameSegments: List) {
  /** The short name for this [Name] */
  val shortName: String
    get() = nameSegments.last()

  /** The Java-style fully qualified name for this [Name], separated with `.` */
  val javaFqn: String
    get() = pkg.segments.joinToString(".", postfix = ".") + nameSegments.joinToString(".")

  /**
   * The [ClassName] for use with kotlinx.metadata. Note that in kotlinx.metadata the actual type
   * might be different from the underlying JVM type, for example: kotlin/Int -> java/lang/Integer
   */
  val kmClassName: ClassName
    get() = pkg.segments.joinToString("/", postfix = "/") + nameSegments.joinToString(".")

  /** The [PackageName] of this element. */
  val packageName: PackageName
    get() = pkg
}

/** @return a [PackageName] with a Java-style (separated with `.`) [packageName]. */
internal fun Package(packageName: String): PackageName = PackageName(packageName.split("."))

/** @return a [PackageName] with a Java-style (separated with `.`) [packageName]. */
internal fun Package(packageName: PackageName, shortName: String): PackageName =
  PackageName(packageName.segments + shortName.split("."))

/** @return a [Name] with the provided [pkg] and Java-style (separated with `.`) [shortName]. */
internal fun Name(pkg: PackageName, shortName: String): Name = Name(pkg, shortName.split("."))