proguard.classfile.editor.AnnotationAdder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proguard-core Show documentation
ProGuardCORE is a free library to read, analyze, modify, and write Java class files.
There is a newer version: 9.1.6
/*
 * ProGuardCORE -- library to process Java bytecode.
 *
 * Copyright (c) 2002-2020 Guardsquare NV
 *
 * 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 proguard.classfile.editor;

import proguard.classfile.*;
import proguard.classfile.attribute.annotation.*;
import proguard.classfile.attribute.annotation.visitor.AnnotationVisitor;
import proguard.util.ArrayUtil;

/**
 * This {@link AnnotationVisitor} adds all annotations that it visits to the given target annotation
 * element value, target annotation attribute, or target parameter annotation attribute.
 *
 * @author Eric Lafortune
 */
public class AnnotationAdder implements AnnotationVisitor {
  private static final ElementValue[] EMPTY_ELEMENT_VALUES = new ElementValue[0];

  private final ProgramClass targetClass;
  private final AnnotationElementValue targetAnnotationElementValue;
  private final AnnotationsAttributeEditor annotationsAttributeEditor;
  private final ParameterAnnotationsAttributeEditor parameterAnnotationsAttributeEditor;

  private final ConstantAdder constantAdder;

  /**
   * Creates a new AnnotationAdder that will copy annotations into the given target annotation
   * element value.
   */
  public AnnotationAdder(
      ProgramClass targetClass, AnnotationElementValue targetAnnotationElementValue) {
    this.targetClass = targetClass;
    this.targetAnnotationElementValue = targetAnnotationElementValue;
    this.annotationsAttributeEditor = null;
    this.parameterAnnotationsAttributeEditor = null;

    constantAdder = new ConstantAdder(targetClass);
  }

  /**
   * Creates a new AnnotationAdder that will copy annotations into the given target annotations
   * attribute.
   */
  public AnnotationAdder(
      ProgramClass targetClass, AnnotationsAttribute targetAnnotationsAttribute) {
    this.targetClass = targetClass;
    this.targetAnnotationElementValue = null;
    this.annotationsAttributeEditor = new AnnotationsAttributeEditor(targetAnnotationsAttribute);
    this.parameterAnnotationsAttributeEditor = null;

    constantAdder = new ConstantAdder(targetClass);
  }

  /**
   * Creates a new AnnotationAdder that will copy annotations into the given target parameter
   * annotations attribute.
   */
  public AnnotationAdder(
      ProgramClass targetClass, ParameterAnnotationsAttribute targetParameterAnnotationsAttribute) {
    this.targetClass = targetClass;
    this.targetAnnotationElementValue = null;
    this.annotationsAttributeEditor = null;
    this.parameterAnnotationsAttributeEditor =
        new ParameterAnnotationsAttributeEditor(targetParameterAnnotationsAttribute);

    constantAdder = new ConstantAdder(targetClass);
  }

  // Implementations for AnnotationVisitor.

  public void visitAnnotation(Clazz clazz, Annotation annotation) {
    Annotation newAnnotation =
        new Annotation(
            constantAdder.addConstant(clazz, annotation.u2typeIndex),
            0,
            annotation.u2elementValuesCount > 0
                ? new ElementValue[annotation.u2elementValuesCount]
                : EMPTY_ELEMENT_VALUES);

    newAnnotation.referencedClasses = ArrayUtil.cloneOrNull(annotation.referencedClasses);

    // Add the element values.
    annotation.elementValuesAccept(clazz, new ElementValueAdder(targetClass, newAnnotation, false));

    // What's the target?
    if (targetAnnotationElementValue != null) {
      // Simply set the completed annotation.
      targetAnnotationElementValue.annotationValue = newAnnotation;
    } else {
      // Add the completed annotation.
      annotationsAttributeEditor.addAnnotation(newAnnotation);
    }
  }

  public void visitAnnotation(
      Clazz clazz, Method method, int parameterIndex, Annotation annotation) {
    Annotation newAnnotation =
        new Annotation(
            constantAdder.addConstant(clazz, annotation.u2typeIndex),
            0,
            annotation.u2elementValuesCount > 0
                ? new ElementValue[annotation.u2elementValuesCount]
                : EMPTY_ELEMENT_VALUES);

    newAnnotation.referencedClasses = ArrayUtil.cloneOrNull(annotation.referencedClasses);

    // Add the element values.
    annotation.elementValuesAccept(clazz, new ElementValueAdder(targetClass, newAnnotation, false));

    // Add the completed annotation.
    parameterAnnotationsAttributeEditor.addAnnotation(parameterIndex, newAnnotation);
  }
}