com.jetbrains.pluginverifier.usages.deprecated.DeprecatedApiUsageProcessor.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.

There is a newer version: 1.379

/*
 * 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.usages.deprecated

import com.jetbrains.pluginverifier.results.reference.ClassReference
import com.jetbrains.pluginverifier.results.reference.FieldReference
import com.jetbrains.pluginverifier.results.reference.MethodReference
import com.jetbrains.pluginverifier.usages.FilteringApiUsageProcessor
import com.jetbrains.pluginverifier.usages.SamePluginUsageFilter
import com.jetbrains.pluginverifier.verifiers.VerificationContext
import com.jetbrains.pluginverifier.verifiers.resolution.ClassFile
import com.jetbrains.pluginverifier.verifiers.resolution.ClassFileMember
import com.jetbrains.pluginverifier.verifiers.resolution.ClassUsageType
import com.jetbrains.pluginverifier.verifiers.resolution.Field
import com.jetbrains.pluginverifier.verifiers.resolution.Method
import org.objectweb.asm.tree.AbstractInsnNode

class DeprecatedApiUsageProcessor(private val deprecatedApiRegistrar: DeprecatedApiRegistrar) : FilteringApiUsageProcessor(SamePluginUsageFilter()) {

  /**
   * Process a reference to a [Class] from the API.
   *
   * Suppose that a `ApiConsumer` class has a method `consume()`:
   * ```
   *     public void consume() {
  new DeprecatedModuleApi();
   *     }
   * ```
   * @param classReference refers to the callee or the invocation target (`DeprecatedModuleApi`)
   * @param resolvedClass is a fully resolved model of the callee or the invocation target (`DeprecatedModuleApi`)
   * @param context indicates the verification context with additional data
   * @param referrer is a model corresponding to the caller. In this case, it is a `consume()` [Method] from the example
   * @param classUsageType indicates a usage type. In the example, it is a _default_ usage type.
   *
   */
  override fun doProcessClassReference(
    classReference: ClassReference,
    resolvedClass: ClassFile,
    referrer: ClassFileMember,
    classUsageType: ClassUsageType,
    context: VerificationContext
  ) {
    val deprecationInfo = resolvedClass.deprecationInfo ?: return
    deprecatedApiRegistrar.registerDeprecatedUsage(
      DeprecatedClassUsage(classReference, resolvedClass.location, referrer.location, deprecationInfo)
    )
  }

  override fun doProcessMethodInvocation(
    invokedMethodReference: MethodReference,
    invokedMethod: Method,
    invocationInstruction: AbstractInsnNode,
    callerMethod: Method,
    context: VerificationContext
  ) {
    val deprecationInfo = invokedMethod.deprecationInfo ?: return
    deprecatedApiRegistrar.registerDeprecatedUsage(
      DeprecatedMethodUsage(invokedMethodReference, invokedMethod.location, callerMethod.location, deprecationInfo)
    )
  }

  override fun doProcessFieldAccess(
    fieldReference: FieldReference,
    resolvedField: Field,
    callerMethod: Method,
    context: VerificationContext
  ) {
    val deprecationInfo = resolvedField.deprecationInfo ?: return
    deprecatedApiRegistrar.registerDeprecatedUsage(
      DeprecatedFieldUsage(fieldReference, resolvedField.location, callerMethod.location, deprecationInfo)
    )
  }
}