001 /* 002 $Id: Variable.java,v 1.7 2004/07/10 03:31:39 bran Exp $ 003 004 Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved. 005 006 Redistribution and use of this software and associated documentation 007 ("Software"), with or without modification, are permitted provided 008 that the following conditions are met: 009 010 1. Redistributions of source code must retain copyright 011 statements and notices. Redistributions must also contain a 012 copy of this document. 013 014 2. Redistributions in binary form must reproduce the 015 above copyright notice, this list of conditions and the 016 following disclaimer in the documentation and/or other 017 materials provided with the distribution. 018 019 3. The name "groovy" must not be used to endorse or promote 020 products derived from this Software without prior written 021 permission of The Codehaus. For written permission, 022 please contact info@codehaus.org. 023 024 4. Products derived from this Software may not be called "groovy" 025 nor may "groovy" appear in their names without prior written 026 permission of The Codehaus. "groovy" is a registered 027 trademark of The Codehaus. 028 029 5. Due credit should be given to The Codehaus - 030 http://groovy.codehaus.org/ 031 032 THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS 033 ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT 034 NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 035 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 036 THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 037 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 038 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 039 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 040 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 041 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 042 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 043 OF THE POSSIBILITY OF SUCH DAMAGE. 044 045 */ 046 package org.codehaus.groovy.classgen; 047 048 import org.codehaus.groovy.ast.Type; 049 import org.objectweb.asm.Label; 050 051 052 /** 053 * Represents compile time variable metadata while compiling a method. 054 * 055 * @author <a href="mailto:james@coredevelopers.net">James Strachan</a> 056 * @version $Revision: 1.7 $ 057 */ 058 public class Variable { 059 060 private int index; 061 private Type type; 062 private String name; 063 private boolean holder; 064 private boolean property; 065 066 // br for setting on the LocalVariableTable in the class file 067 // these fields should probably go to jvm Operand class 068 private Label startLabel = null; 069 private Label endLabel = null; 070 071 public Variable(int index, Type type, String name) { 072 this.index = index; 073 this.type = type; 074 this.name = name; 075 } 076 077 public String getName() { 078 return name; 079 } 080 081 public Type getType() { 082 return type; 083 } 084 085 public String getTypeName() { 086 return type.getName(); 087 } 088 089 /** 090 * @return the stack index for this variable 091 */ 092 public int getIndex() { 093 return index; 094 } 095 096 /** 097 * @return is this local variable shared in other scopes (and so must use a ValueHolder) 098 */ 099 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 }