1 /*
2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3  *
4  * This code is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License version 2 only, as
6  * published by the Free Software Foundation.  Oracle designates this
7  * particular file as subject to the "Classpath" exception as provided
8  * by Oracle in the LICENSE file that accompanied this code.
9  *
10  * This code is distributed in the hope that it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13  * version 2 for more details (a copy is included in the LICENSE file that
14  * accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License version
17  * 2 along with this work; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19  *
20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21  * or visit www.oracle.com if you need additional information or have any
22  * questions.
23  */
24 
25 /*
26  * This file is available under and governed by the GNU General Public
27  * License version 2 only, as published by the Free Software Foundation.
28  * However, the following notice accompanied the original version of this
29  * file:
30  *
31  * ASM: a very small and fast Java bytecode manipulation framework
32  * Copyright (c) 2000-2011 INRIA, France Telecom
33  * All rights reserved.
34  *
35  * Redistribution and use in source and binary forms, with or without
36  * modification, are permitted provided that the following conditions
37  * are met:
38  * 1. Redistributions of source code must retain the above copyright
39  *    notice, this list of conditions and the following disclaimer.
40  * 2. Redistributions in binary form must reproduce the above copyright
41  *    notice, this list of conditions and the following disclaimer in the
42  *    documentation and/or other materials provided with the distribution.
43  * 3. Neither the name of the copyright holders nor the names of its
44  *    contributors may be used to endorse or promote products derived from
45  *    this software without specific prior written permission.
46  *
47  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
48  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
50  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
51  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
52  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
53  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
54  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
55  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
56  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
57  * THE POSSIBILITY OF SUCH DAMAGE.
58  */
59 package jdk.internal.org.objectweb.asm.tree;
60 
61 import java.util.List;
62 import jdk.internal.org.objectweb.asm.Label;
63 import jdk.internal.org.objectweb.asm.MethodVisitor;
64 import jdk.internal.org.objectweb.asm.Opcodes;
65 import jdk.internal.org.objectweb.asm.TypePath;
66 
67 /**
68  * A node that represents a type annotation on a local or resource variable.
69  *
70  * @author Eric Bruneton
71  */
72 public class LocalVariableAnnotationNode extends TypeAnnotationNode {
73 
74     /**
75       * The fist instructions corresponding to the continuous ranges that make the scope of this local
76       * variable (inclusive). Must not be {@literal null}.
77       */
78     public List<LabelNode> start;
79 
80     /**
81       * The last instructions corresponding to the continuous ranges that make the scope of this local
82       * variable (exclusive). This list must have the same size as the 'start' list. Must not be
83       * {@literal null}.
84       */
85     public List<LabelNode> end;
86 
87     /**
88       * The local variable's index in each range. This list must have the same size as the 'start'
89       * list. Must not be {@literal null}.
90       */
91     public List<Integer> index;
92 
93     /**
94       * Constructs a new {@link LocalVariableAnnotationNode}. <i>Subclasses must not use this
95       * constructor</i>. Instead, they must use the {@link #LocalVariableAnnotationNode(int, TypePath,
96       * LabelNode[], LabelNode[], int[], String)} version.
97       *
98       * @param typeRef a reference to the annotated type. See {@link jdk.internal.org.objectweb.asm.TypeReference}.
99       * @param typePath the path to the annotated type argument, wildcard bound, array element type, or
100       *     static inner type within 'typeRef'. May be {@literal null} if the annotation targets
101       *     'typeRef' as a whole.
102       * @param start the fist instructions corresponding to the continuous ranges that make the scope
103       *     of this local variable (inclusive).
104       * @param end the last instructions corresponding to the continuous ranges that make the scope of
105       *     this local variable (exclusive). This array must have the same size as the 'start' array.
106       * @param index the local variable's index in each range. This array must have the same size as
107       *     the 'start' array.
108       * @param descriptor the class descriptor of the annotation class.
109       */
LocalVariableAnnotationNode( final int typeRef, final TypePath typePath, final LabelNode[] start, final LabelNode[] end, final int[] index, final String descriptor)110     public LocalVariableAnnotationNode(
111             final int typeRef,
112             final TypePath typePath,
113             final LabelNode[] start,
114             final LabelNode[] end,
115             final int[] index,
116             final String descriptor) {
117         this(Opcodes.ASM7, typeRef, typePath, start, end, index, descriptor);
118     }
119 
120     /**
121       * Constructs a new {@link LocalVariableAnnotationNode}.
122       *
123       * @param api the ASM API version implemented by this visitor. Must be one of {@link
124       *     Opcodes#ASM4}, {@link Opcodes#ASM5}, {@link Opcodes#ASM6} or {@link Opcodes#ASM7}.
125       * @param typeRef a reference to the annotated type. See {@link jdk.internal.org.objectweb.asm.TypeReference}.
126       * @param start the fist instructions corresponding to the continuous ranges that make the scope
127       *     of this local variable (inclusive).
128       * @param end the last instructions corresponding to the continuous ranges that make the scope of
129       *     this local variable (exclusive). This array must have the same size as the 'start' array.
130       * @param index the local variable's index in each range. This array must have the same size as
131       *     the 'start' array.
132       * @param typePath the path to the annotated type argument, wildcard bound, array element type, or
133       *     static inner type within 'typeRef'. May be {@literal null} if the annotation targets
134       *     'typeRef' as a whole.
135       * @param descriptor the class descriptor of the annotation class.
136       */
LocalVariableAnnotationNode( final int api, final int typeRef, final TypePath typePath, final LabelNode[] start, final LabelNode[] end, final int[] index, final String descriptor)137     public LocalVariableAnnotationNode(
138             final int api,
139             final int typeRef,
140             final TypePath typePath,
141             final LabelNode[] start,
142             final LabelNode[] end,
143             final int[] index,
144             final String descriptor) {
145         super(api, typeRef, typePath, descriptor);
146         this.start = Util.asArrayList(start);
147         this.end = Util.asArrayList(end);
148         this.index = Util.asArrayList(index);
149     }
150 
151     /**
152       * Makes the given visitor visit this type annotation.
153       *
154       * @param methodVisitor the visitor that must visit this annotation.
155       * @param visible {@literal true} if the annotation is visible at runtime.
156       */
accept(final MethodVisitor methodVisitor, final boolean visible)157     public void accept(final MethodVisitor methodVisitor, final boolean visible) {
158         Label[] startLabels = new Label[this.start.size()];
159         Label[] endLabels = new Label[this.end.size()];
160         int[] indices = new int[this.index.size()];
161         for (int i = 0, n = startLabels.length; i < n; ++i) {
162             startLabels[i] = this.start.get(i).getLabel();
163             endLabels[i] = this.end.get(i).getLabel();
164             indices[i] = this.index.get(i);
165         }
166         accept(
167                 methodVisitor.visitLocalVariableAnnotation(
168                         typeRef, typePath, startLabels, endLabels, indices, desc, visible));
169     }
170 }
171