001    /*
002     $Id: VariableScope.java 3419 2006-01-19 00:07:02Z blackdrag $
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.ast;
047    
048    import java.util.HashMap;
049    import java.util.Map;
050    
051    /**
052     * Represents a variable scope. This is primarily used to determine variable sharing
053     * across method and closure boundaries.
054     *
055     * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
056     * @author Jochen Theodorou
057     * @version $Revision: 3419 $
058     */
059    public class VariableScope  {
060        private Map declaredVariables = new HashMap();
061        private Map referencedLocalVariables = new HashMap();
062        private Map referencedClassVariables = new HashMap();
063     
064        private boolean inStaticContext = false;
065        private boolean resolvesDynamic = false; 
066        private ClassNode clazzScope;
067        private VariableScope parent;
068    
069        public VariableScope() {
070        }
071        public VariableScope(VariableScope parent) {
072            this.parent = parent;
073        }
074        public Map getDeclaredVariables() {
075            return declaredVariables;
076        }
077        public Variable getDeclaredVariable(String name) {
078            return (Variable) declaredVariables.get(name);
079        }
080        public Map getReferencedLocalVariables() {
081            return referencedLocalVariables;
082        }
083        
084        public boolean isReferencedLocalVariable(String name) {
085            return referencedLocalVariables.containsKey(name);
086        }
087        
088        public Map getReferencedClassVariables() {
089            return referencedClassVariables;
090        }
091        
092        public boolean isReferencedClassVariable(String name) {
093            return referencedClassVariables.containsKey(name);
094        }
095        public VariableScope getParent() {
096            return parent;
097        }
098    
099        public boolean isInStaticContext() {
100            return inStaticContext;
101        }
102    
103        public void setInStaticContext(boolean inStaticContext) {
104            this.inStaticContext = inStaticContext;
105        }
106    
107        public boolean isResolvingDynamic() {
108            return resolvesDynamic;
109        }
110    
111        public void setDynamicResolving(boolean resolvesDynamic) {
112            this.resolvesDynamic = resolvesDynamic;
113        }
114    
115        public void setClassScope(ClassNode node) {
116            this.clazzScope = node;
117        }
118        
119        public ClassNode getClassScope(){
120            return clazzScope;
121        }
122        
123        public boolean isClassScope(){
124            return clazzScope!=null;
125        }
126        
127        public boolean isRoot() {
128            return parent==null;
129        }
130        
131        public VariableScope copy() {
132            VariableScope copy = new VariableScope();
133            copy.clazzScope = clazzScope;
134            copy.declaredVariables.putAll(declaredVariables);
135            copy.inStaticContext = inStaticContext;
136            copy.parent = parent;
137            copy.referencedClassVariables.putAll(referencedClassVariables);
138            copy.referencedLocalVariables.putAll(referencedLocalVariables);
139            copy.resolvesDynamic = resolvesDynamic;
140            return copy;
141        }
142    }