View Javadoc

1   /*
2    $Id: Variable.java,v 1.9 2005/11/13 16:42:11 blackdrag Exp $
3   
4    Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5   
6    Redistribution and use of this software and associated documentation
7    ("Software"), with or without modification, are permitted provided
8    that the following conditions are met:
9   
10   1. Redistributions of source code must retain copyright
11      statements and notices.  Redistributions must also contain a
12      copy of this document.
13  
14   2. Redistributions in binary form must reproduce the
15      above copyright notice, this list of conditions and the
16      following disclaimer in the documentation and/or other
17      materials provided with the distribution.
18  
19   3. The name "groovy" must not be used to endorse or promote
20      products derived from this Software without prior written
21      permission of The Codehaus.  For written permission,
22      please contact info@codehaus.org.
23  
24   4. Products derived from this Software may not be called "groovy"
25      nor may "groovy" appear in their names without prior written
26      permission of The Codehaus. "groovy" is a registered
27      trademark of The Codehaus.
28  
29   5. Due credit should be given to The Codehaus -
30      http://groovy.codehaus.org/
31  
32   THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
33   ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
34   NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
35   FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
36   THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
43   OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45   */
46  package org.codehaus.groovy.classgen;
47  
48  import org.codehaus.groovy.ast.ClassHelper;
49  import org.codehaus.groovy.ast.ClassNode;
50  import org.objectweb.asm.Label;
51  
52  
53  /***
54   * Represents compile time variable metadata while compiling a method.
55   * 
56   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
57   * @version $Revision: 1.9 $
58   */
59  public class Variable {
60  
61      private int index;
62      private ClassNode type;
63      private String name;
64      private boolean holder;
65      private boolean property;
66  
67      // br for setting on the LocalVariableTable in the class file
68      // these fields should probably go to jvm Operand class
69      private Label startLabel = null;
70      private Label endLabel = null;
71      private boolean dynamicTyped;
72  
73      public Variable(int index, ClassNode type, String name) {
74          this.index = index;
75          this.type = type;
76          this.name = name;
77      }
78  
79      public String getName() {
80          return name;
81      }
82  
83      public ClassNode getType() {
84          return type;
85      }
86      
87      public String getTypeName() {
88          return type.getName();
89      }
90  
91      /***
92       * @return the stack index for this variable
93       */
94      public int getIndex() {
95          return index;
96      }
97  
98      /***
99       * @return is this local variable shared in other scopes (and so must use a ValueHolder)
100      */
101     public boolean isHolder() {
102         return holder;
103     }
104 
105     public void setHolder(boolean holder) {
106         this.holder = holder;
107     }
108 
109     public boolean isProperty() {
110         return property;
111     }
112 
113     public void setProperty(boolean property) {
114         this.property = property;
115     }
116     
117     public Label getStartLabel() {
118         return startLabel;
119     }
120 
121     public void setStartLabel(Label startLabel) {
122         this.startLabel = startLabel;
123     }
124 
125     public Label getEndLabel() {
126         return endLabel;
127     }
128 
129     public void setEndLabel(Label endLabel) {
130         this.endLabel = endLabel;
131     }
132 
133     public String toString() {
134         // TODO Auto-generated method stub
135         return super.toString() + "[" + type + " " + name + " (" + index + ")";
136     }
137 
138     /***
139      * derive a new Variable from this if this is a primitive variable, or return this instance
140      * @return
141      */
142     public Variable deriveBoxedVersion() {
143         if (ClassHelper.isPrimitiveType(getType())) {
144             ClassNode t = ClassHelper.getWrapper(getType());
145             return new Variable(index, t, name);
146         } else {
147             return this;
148         }
149     }
150 
151     public void setType(ClassNode type) {
152         this.type = type;
153         dynamicTyped |= type==ClassHelper.DYNAMIC_TYPE;
154     }
155 
156     public void setDynamicTyped(boolean b) {
157         dynamicTyped = b;
158     }
159     
160     public boolean isDynamicTyped() {
161         return dynamicTyped;
162     }
163 }