KickJava   Java API By Example, From Geeks To Geeks.

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


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 Benoit Cerrina <b.cerrina@wanadoo.fr>
15  * Copyright (C) 2002 Jan Arne Petersen <jpetersen@uni-bonn.de>
16  * Copyright (C) 2002-2004 Anders Bengtsson <ndrsbngtssn@yahoo.se>
17  * Copyright (C) 2004 Thomas E Enebo <enebo@acm.org>
18  * Copyright (C) 2004 Stefan Matthias Aust <sma@3plus4.de>
19  *
20  * Alternatively, the contents of this file may be used under the terms of
21  * either of the GNU General Public License Version 2 or later (the "GPL"),
22  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
23  * in which case the provisions of the GPL or the LGPL are applicable instead
24  * of those above. If you wish to allow use of your version of this file only
25  * under the terms of either the GPL or the LGPL, and not to allow others to
26  * use your version of this file under the terms of the CPL, indicate your
27  * decision by deleting the provisions above and replace them with the notice
28  * and other provisions required by the GPL or the LGPL. If you do not delete
29  * the provisions above, a recipient may use your version of this file under
30  * the terms of any one of the CPL, the GPL or the LGPL.
31  ***** END LICENSE BLOCK *****/

32 package org.jruby.ast;
33
34 import java.io.IOException JavaDoc;
35 import java.util.List JavaDoc;
36
37 import org.jruby.ast.types.INameNode;
38 import org.jruby.ast.visitor.NodeVisitor;
39 import org.jruby.evaluator.Instruction;
40 import org.jruby.lexer.yacc.ISourcePosition;
41
42 /**
43  * An assignment to a local variable.
44  */

45 public class LocalAsgnNode extends AssignableNode implements INameNode {
46     static final long serialVersionUID = 1118108700098164006L;
47
48     // The name of the variable
49
private String JavaDoc name;
50     
51     // A scoped location of this variable (high 16 bits is how many scopes down and low 16 bits
52
// is what index in the right scope to set the value.
53
private final int location;
54
55     public LocalAsgnNode(ISourcePosition position, String JavaDoc name, int location, Node valueNode) {
56         super(position, NodeTypes.LOCALASGNNODE);
57         this.name = name.intern();
58         this.location = location;
59         setValueNode(valueNode);
60     }
61     
62     private void readObject(java.io.ObjectInputStream JavaDoc in) throws IOException JavaDoc, ClassNotFoundException JavaDoc {
63         in.defaultReadObject();
64         
65         // deserialized strings are not interned; intern it now
66
name = name.intern();
67     }
68
69     /**
70      * Accept for the visitor pattern.
71      * @param iVisitor the visitor
72      **/

73     public Instruction accept(NodeVisitor iVisitor) {
74         return iVisitor.visitLocalAsgnNode(this);
75     }
76     
77     /**
78      * Name of the local assignment.
79      **/

80     public String JavaDoc getName() {
81         return name;
82     }
83     
84     /**
85      * Change the name of this local assignment (for refactoring)
86      * @param name
87      */

88     public void setName(String JavaDoc name) {
89         this.name = name;
90     }
91
92     /**
93      * How many scopes should we burrow down to until we need to set the block variable value.
94      *
95      * @return 0 for current scope, 1 for one down, ...
96      */

97     public int getDepth() {
98         return location >> 16;
99     }
100     
101     /**
102      * Gets the index within the scope construct that actually holds the eval'd value
103      * of this local variable
104      *
105      * @return Returns an int offset into storage structure
106      */

107     public int getIndex() {
108         return location & 0xffff;
109     }
110     
111     public List JavaDoc childNodes() {
112         return createList(getValueNode());
113     }
114
115 }
116
Popular Tags