KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jruby > ast > LocalVarNode


1 /***** BEGIN LICENSE BLOCK *****
2  * Version: CPL 1.0/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Common Public
5  * License Version 1.0 (the "License"); you may not use this file
6  * except in compliance with the License. You may obtain a copy of
7  * the License at http://www.eclipse.org/legal/cpl-v10.html
8  *
9  * Software distributed under the License is distributed on an "AS
10  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
11  * implied. See the License for the specific language governing
12  * rights and limitations under the License.
13  *
14  * Copyright (C) 2002 Anders Bengtsson <ndrsbngtssn@yahoo.se>
15  * Copyright (C) 2002 Jan Arne Petersen <jpetersen@uni-bonn.de>
16  * Copyright (C) 2002 Benoit Cerrina <b.cerrina@wanadoo.fr>
17  * Copyright (C) 2004-2006 Thomas E Enebo <enebo@acm.org>
18  *
19  * Alternatively, the contents of this file may be used under the terms of
20  * either of the GNU General Public License Version 2 or later (the "GPL"),
21  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
22  * in which case the provisions of the GPL or the LGPL are applicable instead
23  * of those above. If you wish to allow use of your version of this file only
24  * under the terms of either the GPL or the LGPL, and not to allow others to
25  * use your version of this file under the terms of the CPL, indicate your
26  * decision by deleting the provisions above and replace them with the notice
27  * and other provisions required by the GPL or the LGPL. If you do not delete
28  * the provisions above, a recipient may use your version of this file under
29  * the terms of any one of the CPL, the GPL or the LGPL.
30  ***** END LICENSE BLOCK *****/
31 package org.jruby.ast;
32
33 import java.util.List JavaDoc;
34
35 import org.jruby.ast.types.INameNode;
36 import org.jruby.ast.visitor.NodeVisitor;
37 import org.jruby.evaluator.Instruction;
38 import org.jruby.lexer.yacc.ISourcePosition;
39
40 /**
41  * Access a local variable
42  */
43 public class LocalVarNode extends Node implements INameNode {
44     static final long serialVersionUID = 8562701804939317217L;
45
46     // The name of the variable
47 private String JavaDoc name;
48     
49     // A scoped location of this variable (high 16 bits is how many scopes down and low 16 bits
50 // is what index in the right scope to set the value.
51 private final int location;
52
53     public LocalVarNode(ISourcePosition position, int location, String JavaDoc name) {
54         super(position, NodeTypes.LOCALVARNODE);
55         this.location = location;
56         this.name = name;
57     }
58
59     /**
60      * Accept for the visitor pattern.
61      * @param iVisitor the visitor
62      **/
63     public Instruction accept(NodeVisitor iVisitor) {
64         return iVisitor.visitLocalVarNode(this);
65     }
66
67     /**
68      * How many scopes should we burrow down to until we need to set the block variable value.
69      *
70      * @return 0 for current scope, 1 for one down, ...
71      */
72     public int getDepth() {
73         return location >> 16;
74     }
75     
76     /**
77      * Gets the index within the scope construct that actually holds the eval'd value
78      * of this local variable
79      *
80      * @return Returns an int offset into storage structure
81      */
82     public int getIndex() {
83         return location & 0xffff;
84     }
85
86     /**
87      * What is the name of this variable
88      *
89      * @return the name of the variable
90      */
91     public String JavaDoc getName() {
92         return name;
93     }
94     
95     /**
96      * Set the name of this variable (for refactoring support)
97      * @param name the new name
98      */
99     public void setName(String JavaDoc name) {
100         this.name = name;
101     }
102     
103     public List JavaDoc childNodes() {
104         return EMPTY_LIST;
105     }
106
107 }
108
Popular Tags