com.jetbrains.pluginverifier.verifiers.PluginVerificationContext.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of verifier-intellij Show documentation
JetBrains Plugin Verifier Classes for IntelliJ Platform integration with API usage detection and reporting.
The newest version!
/*
 * Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
 */

package com.jetbrains.pluginverifier.verifiers

import com.jetbrains.plugin.structure.base.telemetry.MutablePluginTelemetry
import com.jetbrains.plugin.structure.base.telemetry.PluginTelemetry
import com.jetbrains.plugin.structure.classes.resolvers.Resolver
import com.jetbrains.plugin.structure.intellij.plugin.IdePlugin
import com.jetbrains.pluginverifier.PluginVerificationDescriptor
import com.jetbrains.pluginverifier.dependencies.DependenciesGraph
import com.jetbrains.pluginverifier.repository.PluginInfo
import com.jetbrains.pluginverifier.results.problems.CompatibilityProblem
import com.jetbrains.pluginverifier.telemetry.TelemetryRegistrar
import com.jetbrains.pluginverifier.usages.ApiUsageProcessor
import com.jetbrains.pluginverifier.usages.deprecated.DeprecatedApiRegistrar
import com.jetbrains.pluginverifier.usages.deprecated.DeprecatedApiUsage
import com.jetbrains.pluginverifier.usages.deprecated.DeprecatedApiUsageProcessor
import com.jetbrains.pluginverifier.usages.discouraging.DiscouragingClassUsageProcessor
import com.jetbrains.pluginverifier.usages.experimental.ExperimentalApiRegistrar
import com.jetbrains.pluginverifier.usages.experimental.ExperimentalApiUsage
import com.jetbrains.pluginverifier.usages.experimental.ExperimentalApiUsageProcessor
import com.jetbrains.pluginverifier.usages.internal.InternalApiUsage
import com.jetbrains.pluginverifier.usages.internal.InternalApiUsageProcessor
import com.jetbrains.pluginverifier.usages.internal.InternalApiUsageRegistrar
import com.jetbrains.pluginverifier.usages.javaPlugin.JavaPluginApiCompatibilityIssueAnalyzer
import com.jetbrains.pluginverifier.usages.javaPlugin.JavaPluginApiUsageProcessor
import com.jetbrains.pluginverifier.usages.javaPlugin.JavaPluginApiUsageRegistrar
import com.jetbrains.pluginverifier.usages.javaPlugin.JavaPluginClassUsage
import com.jetbrains.pluginverifier.usages.nonExtendable.NonExtendableApiRegistrar
import com.jetbrains.pluginverifier.usages.nonExtendable.NonExtendableApiUsage
import com.jetbrains.pluginverifier.usages.overrideOnly.OverrideOnlyMethodUsage
import com.jetbrains.pluginverifier.usages.overrideOnly.OverrideOnlyMethodUsageProcessor
import com.jetbrains.pluginverifier.usages.overrideOnly.OverrideOnlyRegistrar
import com.jetbrains.pluginverifier.usages.properties.PropertyUsageProcessor
import com.jetbrains.pluginverifier.verifiers.packages.PackageFilter
import com.jetbrains.pluginverifier.warnings.CompatibilityWarning
import com.jetbrains.pluginverifier.warnings.PluginStructureWarning
import com.jetbrains.pluginverifier.warnings.WarningRegistrar

data class PluginVerificationContext(
  val idePlugin: IdePlugin,
  val verificationDescriptor: PluginVerificationDescriptor,
  val pluginResolver: Resolver,
  val allResolver: Resolver,
  override val externalClassesPackageFilter: PackageFilter,
  val dependenciesGraph: DependenciesGraph
) : VerificationContext,
  ProblemRegistrar,
  WarningRegistrar,
  DeprecatedApiRegistrar,
  ExperimentalApiRegistrar,
  OverrideOnlyRegistrar,
  InternalApiUsageRegistrar,
  NonExtendableApiRegistrar,
  JavaPluginApiUsageRegistrar,
  TelemetryRegistrar {

  override val classResolver
    get() = allResolver

  override val apiUsageProcessors: List =
    listOf(
      DeprecatedApiUsageProcessor(this),
      ExperimentalApiUsageProcessor(this),
      DiscouragingClassUsageProcessor(this),
      InternalApiUsageProcessor(this),
      OverrideOnlyMethodUsageProcessor(this),
      JavaPluginApiUsageProcessor(this),
      PropertyUsageProcessor()
    )

  private val compatibilityIssueAnalyzers = hashSetOf>(JavaPluginApiCompatibilityIssueAnalyzer())

  val compatibilityProblems = hashSetOf()
  val compatibilityWarnings = hashSetOf()
  val deprecatedUsages = hashSetOf()
  val experimentalApiUsages = hashSetOf()
  val internalApiUsages = hashSetOf()
  val nonExtendableApiUsages = hashSetOf()
  val overrideOnlyMethodUsages = hashSetOf()
  val pluginStructureWarnings = hashSetOf()
  private val _telemetry = MutablePluginTelemetry()
  val telemetry: PluginTelemetry
    get() = _telemetry

  override val problemRegistrar
    get() = this

  override val warningRegistrar
    get() = this


  override fun registerProblem(problem: CompatibilityProblem) {
    compatibilityProblems += problem
  }

  override fun registerDeprecatedUsage(deprecatedApiUsage: DeprecatedApiUsage) {
    deprecatedUsages += deprecatedApiUsage
  }

  override fun registerExperimentalApiUsage(experimentalApiUsage: ExperimentalApiUsage) {
    experimentalApiUsages += experimentalApiUsage
  }

  override fun registerInternalApiUsage(internalApiUsage: InternalApiUsage) {
    internalApiUsages += internalApiUsage
  }

  override fun registerNonExtendableApiUsage(nonExtendableApiUsage: NonExtendableApiUsage) {
    nonExtendableApiUsages += nonExtendableApiUsage
  }

  override fun registerOverrideOnlyMethodUsage(overrideOnlyMethodUsage: OverrideOnlyMethodUsage) {
    overrideOnlyMethodUsages += overrideOnlyMethodUsage
  }

  override fun registerJavaPluginClassUsage(javaPluginClassUsage: JavaPluginClassUsage) {
    compatibilityIssueAnalyzers.filterIsInstance()
            .map { it.analyze(this, javaPluginClassUsage) }
  }

  override fun registerCompatibilityWarning(warning: CompatibilityWarning) {
    compatibilityWarnings += warning
  }

  override fun reportTelemetry(pluginInfo: PluginInfo, telemetry: PluginTelemetry) {
    _telemetry.merge(telemetry)
  }

  fun registerPluginStructureWarning(warning: PluginStructureWarning) {
    pluginStructureWarnings += warning
  }
}