1 /*

     2  * Copyright (c) 2007, 2014, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package com.sun.tools.classfile;

    27 

    28 import java.io.IOException;

    29 import java.lang.reflect.Constructor;

    30 import java.util.HashMap;

    31 import java.util.Map;

    32 

    33 /**

    34  *  <p><b>This is NOT part of any supported API.

    35  *  If you write code that depends on this, you do so at your own risk.

    36  *  This code and its internal interfaces are subject to change or

    37  *  deletion without notice.</b>

    38  */

    39 

    40 public abstract class Attribute {

    41     public static final String AnnotationDefault        = "AnnotationDefault";

    42     public static final String BootstrapMethods         = "BootstrapMethods";

    43     public static final String CharacterRangeTable      = "CharacterRangeTable";

    44     public static final String Code                     = "Code";

    45     public static final String ConstantValue            = "ConstantValue";

    46     public static final String CompilationID            = "CompilationID";

    47     public static final String Deprecated               = "Deprecated";

    48     public static final String EnclosingMethod          = "EnclosingMethod";

    49     public static final String Exceptions               = "Exceptions";

    50     public static final String InnerClasses             = "InnerClasses";

    51     public static final String LineNumberTable          = "LineNumberTable";

    52     public static final String LocalVariableTable       = "LocalVariableTable";

    53     public static final String LocalVariableTypeTable   = "LocalVariableTypeTable";

    54     public static final String MethodParameters         = "MethodParameters";

    55     public static final String RuntimeVisibleAnnotations = "RuntimeVisibleAnnotations";

    56     public static final String RuntimeInvisibleAnnotations = "RuntimeInvisibleAnnotations";

    57     public static final String RuntimeVisibleParameterAnnotations = "RuntimeVisibleParameterAnnotations";

    58     public static final String RuntimeInvisibleParameterAnnotations = "RuntimeInvisibleParameterAnnotations";

    59     public static final String RuntimeVisibleTypeAnnotations = "RuntimeVisibleTypeAnnotations";

    60     public static final String RuntimeInvisibleTypeAnnotations = "RuntimeInvisibleTypeAnnotations";

    61     public static final String Signature                = "Signature";

    62     public static final String SourceDebugExtension     = "SourceDebugExtension";

    63     public static final String SourceFile               = "SourceFile";

    64     public static final String SourceID                 = "SourceID";

    65     public static final String StackMap                 = "StackMap";

    66     public static final String StackMapTable            = "StackMapTable";

    67     public static final String Synthetic                = "Synthetic";

    68 

    69     public static class Factory {

    70         public Factory() {

    71             // defer init of standardAttributeClasses until after options set up

    72         }

    73 

    74         public Attribute createAttribute(ClassReader cr, int name_index, byte[] data)

    75                 throws IOException {

    76             if (standardAttributes == null) {

    77                 init();

    78             }

    79 

    80             ConstantPool cp = cr.getConstantPool();

    81             String reasonForDefaultAttr;

    82             try {

    83                 String name = cp.getUTF8Value(name_index);

    84                 Class<? extends Attribute> attrClass = standardAttributes.get(name);

    85                 if (attrClass != null) {

    86                     try {

    87                         Class<?>[] constrArgTypes = {ClassReader.class, int.class, int.class};

    88                         Constructor<? extends Attribute> constr = attrClass.getDeclaredConstructor(constrArgTypes);

    89                         return constr.newInstance(cr, name_index, data.length);

    90                     } catch (Throwable t) {

    91                         reasonForDefaultAttr = t.toString();

    92                         // fall through and use DefaultAttribute

    93                         // t.printStackTrace();

    94                     }

    95                 } else {

    96                     reasonForDefaultAttr = "unknown attribute";

    97                 }

    98             } catch (ConstantPoolException e) {

    99                 reasonForDefaultAttr = e.toString();

   100                 // fall through and use DefaultAttribute

   101             }

   102             return new DefaultAttribute(cr, name_index, data, reasonForDefaultAttr);

   103         }

   104 

   105         protected void init() {

   106             standardAttributes = new HashMap<>();

   107             standardAttributes.put(AnnotationDefault, AnnotationDefault_attribute.class);

   108             standardAttributes.put(BootstrapMethods,  BootstrapMethods_attribute.class);

   109             standardAttributes.put(CharacterRangeTable, CharacterRangeTable_attribute.class);

   110             standardAttributes.put(Code,              Code_attribute.class);

   111             standardAttributes.put(CompilationID,     CompilationID_attribute.class);

   112             standardAttributes.put(ConstantValue,     ConstantValue_attribute.class);

   113             standardAttributes.put(Deprecated,        Deprecated_attribute.class);

   114             standardAttributes.put(EnclosingMethod,   EnclosingMethod_attribute.class);

   115             standardAttributes.put(Exceptions,        Exceptions_attribute.class);

   116             standardAttributes.put(InnerClasses,      InnerClasses_attribute.class);

   117             standardAttributes.put(LineNumberTable,   LineNumberTable_attribute.class);

   118             standardAttributes.put(LocalVariableTable, LocalVariableTable_attribute.class);

   119             standardAttributes.put(LocalVariableTypeTable, LocalVariableTypeTable_attribute.class);

   120             standardAttributes.put(MethodParameters,  MethodParameters_attribute.class);

   121             standardAttributes.put(RuntimeInvisibleAnnotations, RuntimeInvisibleAnnotations_attribute.class);

   122             standardAttributes.put(RuntimeInvisibleParameterAnnotations, RuntimeInvisibleParameterAnnotations_attribute.class);

   123             standardAttributes.put(RuntimeVisibleAnnotations, RuntimeVisibleAnnotations_attribute.class);

   124             standardAttributes.put(RuntimeVisibleParameterAnnotations, RuntimeVisibleParameterAnnotations_attribute.class);

   125             standardAttributes.put(RuntimeVisibleTypeAnnotations, RuntimeVisibleTypeAnnotations_attribute.class);

   126             standardAttributes.put(RuntimeInvisibleTypeAnnotations, RuntimeInvisibleTypeAnnotations_attribute.class);

   127             standardAttributes.put(Signature,         Signature_attribute.class);

   128             standardAttributes.put(SourceDebugExtension, SourceDebugExtension_attribute.class);

   129             standardAttributes.put(SourceFile,        SourceFile_attribute.class);

   130             standardAttributes.put(SourceID,          SourceID_attribute.class);

   131             standardAttributes.put(StackMap,          StackMap_attribute.class);

   132             standardAttributes.put(StackMapTable,     StackMapTable_attribute.class);

   133             standardAttributes.put(Synthetic,         Synthetic_attribute.class);

   134         }

   135 

   136         private Map<String,Class<? extends Attribute>> standardAttributes;

   137     }

   138 

   139     public static Attribute read(ClassReader cr) throws IOException {

   140         return cr.readAttribute();

   141     }

   142 

   143     protected Attribute(int name_index, int length) {

   144         attribute_name_index = name_index;

   145         attribute_length = length;

   146     }

   147 

   148     public String getName(ConstantPool constant_pool) throws ConstantPoolException {

   149         return constant_pool.getUTF8Value(attribute_name_index);

   150     }

   151 

   152     public abstract <R,D> R accept(Attribute.Visitor<R,D> visitor, D data);

   153 

   154     public int byteLength() {

   155         return 6 + attribute_length;

   156     }

   157 

   158     public final int attribute_name_index;

   159     public final int attribute_length;

   160 

   161 

   162     public interface Visitor<R,P> {

   163         R visitBootstrapMethods(BootstrapMethods_attribute attr, P p);

   164         R visitDefault(DefaultAttribute attr, P p);

   165         R visitAnnotationDefault(AnnotationDefault_attribute attr, P p);

   166         R visitCharacterRangeTable(CharacterRangeTable_attribute attr, P p);

   167         R visitCode(Code_attribute attr, P p);

   168         R visitCompilationID(CompilationID_attribute attr, P p);

   169         R visitConstantValue(ConstantValue_attribute attr, P p);

   170         R visitDeprecated(Deprecated_attribute attr, P p);

   171         R visitEnclosingMethod(EnclosingMethod_attribute attr, P p);

   172         R visitExceptions(Exceptions_attribute attr, P p);

   173         R visitInnerClasses(InnerClasses_attribute attr, P p);

   174         R visitLineNumberTable(LineNumberTable_attribute attr, P p);

   175         R visitLocalVariableTable(LocalVariableTable_attribute attr, P p);

   176         R visitLocalVariableTypeTable(LocalVariableTypeTable_attribute attr, P p);

   177         R visitMethodParameters(MethodParameters_attribute attr, P p);

   178         R visitRuntimeVisibleAnnotations(RuntimeVisibleAnnotations_attribute attr, P p);

   179         R visitRuntimeInvisibleAnnotations(RuntimeInvisibleAnnotations_attribute attr, P p);

   180         R visitRuntimeVisibleParameterAnnotations(RuntimeVisibleParameterAnnotations_attribute attr, P p);

   181         R visitRuntimeInvisibleParameterAnnotations(RuntimeInvisibleParameterAnnotations_attribute attr, P p);

   182         R visitRuntimeVisibleTypeAnnotations(RuntimeVisibleTypeAnnotations_attribute attr, P p);

   183         R visitRuntimeInvisibleTypeAnnotations(RuntimeInvisibleTypeAnnotations_attribute attr, P p);

   184         R visitSignature(Signature_attribute attr, P p);

   185         R visitSourceDebugExtension(SourceDebugExtension_attribute attr, P p);

   186         R visitSourceFile(SourceFile_attribute attr, P p);

   187         R visitSourceID(SourceID_attribute attr, P p);

   188         R visitStackMap(StackMap_attribute attr, P p);

   189         R visitStackMapTable(StackMapTable_attribute attr, P p);

   190         R visitSynthetic(Synthetic_attribute attr, P p);

   191     }

   192 }