View Javadoc

    1   /*
    2    $Id: Variable.java,v 1.7 2004/07/10 03:31:39 bran 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.Type;
    49  import org.objectweb.asm.Label;
    50
    51
    52  /***
    53   * Represents compile time variable metadata while compiling a method.
    54   *
    55   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
    56   * @version $Revision: 1.7 $
    57   */
    58  public class Variable {
    59
    60      private int index;
    61      private Type type;
    62      private String name;
    63      private boolean holder;
    64      private boolean property;
    65
    66      // br for setting on the LocalVariableTable in the class file
    67      // these fields should probably go to jvm Operand class
    68      private Label startLabel = null;
    69      private Label endLabel = null;
    70
    71      public Variable(int index, Type type, String name) {
    72          this.index = index;
    73          this.type = type;
    74          this.name = name;
    75      }
    76
    77      public String getName() {
    78          return name;
    79      }
    80
    81      public Type getType() {
    82          return type;
    83      }
    84
    85      public String getTypeName() {
    86          return type.getName();
    87      }
    88
    89      /***
    90       * @return the stack index for this variable
    91       */
    92      public int getIndex() {
    93          return index;
    94      }
    95
    96      /***
    97       * @return is this local variable shared in other scopes (and so must use a ValueHolder)
    98       */
    99      public boolean isHolder() {
    100         return holder;
    101     }
    102
    103     public void setHolder(boolean holder) {
    104         this.holder = holder;
    105     }
    106
    107     public boolean isProperty() {
    108         return property;
    109     }
    110
    111     public void setProperty(boolean property) {
    112         this.property = property;
    113     }
    114
    115     public Label getStartLabel() {
    116         return startLabel;
    117     }
    118
    119     public void setStartLabel(Label startLabel) {
    120         this.startLabel = startLabel;
    121     }
    122
    123     public Label getEndLabel() {
    124         return endLabel;
    125     }
    126
    127     public void setEndLabel(Label endLabel) {
    128         this.endLabel = endLabel;
    129     }
    130
    131     public String toString() {
    132         // TODO Auto-generated method stub
    133         return super.toString() + "[" + type + " " + name + " (" + index + ")";
    134     }
    135
    136     /***
    137      * derive a new Variable from this if this is a primitive variable, or return this instance
    138      * @return
    139      */
    140     public Variable deriveBoxedVersion() {
    141         if (BytecodeHelper.isPrimitiveType(this.getTypeName())) {
    142             Type t = new Type(BytecodeHelper.getObjectTypeForPrimitive(getTypeName()));
    143             return new Variable(index, t, name);
    144         } else {
    145             return this;
    146         }
    147     }
    148
    149     public void setType(Type type) {
    150         this.type = type;
    151     }
    152
    153     public void setDynamic(boolean b) {
    154         type.setDynamic(b);
    155     }
    156 }