View Javadoc

    1   /*
    2    $Id: Variable.java,v 1.12 2006/03/27 16:53:34 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.12 $
    58   */
    59  public class Variable {
    60
    61      public static Variable THIS_VARIABLE = new Variable();
    62      public static Variable SUPER_VARIABLE = new Variable();
    63
    64      private int index;
    65      private ClassNode type;
    66      private String name;
    67      private boolean holder;
    68      private boolean property;
    69
    70      // br for setting on the LocalVariableTable in the class file
    71      // these fields should probably go to jvm Operand class
    72      private Label startLabel = null;
    73      private Label endLabel = null;
    74      private boolean dynamicTyped;
    75
    76      private Variable(){
    77          dynamicTyped = true;
    78          index=0;
    79          holder=false;
    80          property=false;
    81      }
    82
    83      public Variable(int index, ClassNode type, String name) {
    84          this.index = index;
    85          this.type = type;
    86          this.name = name;
    87      }
    88
    89      public String getName() {
    90          return name;
    91      }
    92
    93      public ClassNode getType() {
    94          return type;
    95      }
    96
    97      public String getTypeName() {
    98          return type.getName();
    99      }
    100
    101     /***
    102      * @return the stack index for this variable
    103      */
    104     public int getIndex() {
    105         return index;
    106     }
    107
    108     /***
    109      * @return is this local variable shared in other scopes (and so must use a ValueHolder)
    110      */
    111     public boolean isHolder() {
    112         return holder;
    113     }
    114
    115     public void setHolder(boolean holder) {
    116         this.holder = holder;
    117     }
    118
    119     public boolean isProperty() {
    120         return property;
    121     }
    122
    123     public void setProperty(boolean property) {
    124         this.property = property;
    125     }
    126
    127     public Label getStartLabel() {
    128         return startLabel;
    129     }
    130
    131     public void setStartLabel(Label startLabel) {
    132         this.startLabel = startLabel;
    133     }
    134
    135     public Label getEndLabel() {
    136         return endLabel;
    137     }
    138
    139     public void setEndLabel(Label endLabel) {
    140         this.endLabel = endLabel;
    141     }
    142
    143     public String toString() {
    144         // TODO Auto-generated method stub
    145         return super.toString() + "[" + type + " " + name + " (" + index + ")";
    146     }
    147
    148     public void setType(ClassNode type) {
    149         this.type = type;
    150         dynamicTyped |= type==ClassHelper.DYNAMIC_TYPE;
    151     }
    152
    153     public void setDynamicTyped(boolean b) {
    154         dynamicTyped = b;
    155     }
    156
    157     public boolean isDynamicTyped() {
    158         return dynamicTyped;
    159     }
    160 }