com.jetbrains.plugin.structure.base.problems.PluginProblems.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of structure-base Show documentation

Base library for parsing JetBrains plugins. Used by other JetBrains Plugins structure libraries.

There is a newer version: 3.290

package com.jetbrains.plugin.structure.base.problems

import org.slf4j.Logger
import org.slf4j.LoggerFactory
import kotlin.reflect.KClass

private val LOG: Logger = LoggerFactory.getLogger(PluginProblems::class.java)

fun PluginProblem.isReclassified(): Boolean = this is ReclassifiedPluginProblem

/**
 * Unwrap an original problem from a reclassified problem.
 * If this is not a reclassified problem, return itself.
 */
val PluginProblem.unwrapped: PluginProblem
  get() = if (this is ReclassifiedPluginProblem) {
    unwrapped
  } else {
    this
  }

/**
 * Indicate if this problem is an [Invalid Descriptor Problem](InvalidDescriptorProblem).
 * If this is a reclassified problem, the original problem will be unwrapped and checked.
 */
val PluginProblem.isInvalidDescriptorProblem: Boolean
  get() = if (isReclassified()) {
    unwrapped is InvalidDescriptorProblem
  } else {
    this is InvalidDescriptorProblem
  }

val PluginProblem.isError: Boolean
  get() = level == PluginProblem.Level.ERROR

fun PluginProblem.isInstance(pluginProblemClass: KClass<*>): Boolean =
  pluginProblemClass.isInstance(unwrapped)


private const val PLUGIN_PROBLEM_PACKAGE_DEFAULT_PREFIX = "com.jetbrains.plugin.structure."

object PluginProblems {
  /**
   * Resolves a Kotlin class by a given problem identifier.
   *
   * The following formats are supported:
   *
   * - Fully qualified problem identifier which corresponds to a class name, such as
   *    `com.jetbrains.plugin.structure.intellij.problems.ForbiddenPluginIdPrefix`
   * - Problem identifier which can be resolved to a fully qualified class name in the `com.jetbrains.plugin.structure`
   *    package prefix, such as `intellij.problems.ForbiddenPluginIdPrefix`.
   */
  fun resolveClass(problemId: String): KClass? {
    val fqProblemId = if (problemId.startsWith(PLUGIN_PROBLEM_PACKAGE_DEFAULT_PREFIX)) {
      problemId
    } else {
      PLUGIN_PROBLEM_PACKAGE_DEFAULT_PREFIX + problemId
    }
    return runCatching {
      val pluginProblemJavaClass = Class.forName(fqProblemId, false, this.javaClass.getClassLoader())
      pluginProblemJavaClass.kotlin
    }.onFailure { t ->
      LOG.error("Plugin problem ID '{}' could not be resolved to a class " +
        "corresponding to a plugin problem: {}", problemId, t.message)
    }.getOrNull()
  }
}