View Javadoc

    1   /*
    2    $Id: VariableScope.java 3419 2006-01-19 00:07:02Z blackdrag $
    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.ast;
    47
    48  import java.util.HashMap;
    49  import java.util.Map;
    50
    51  /***
    52   * Represents a variable scope. This is primarily used to determine variable sharing
    53   * across method and closure boundaries.
    54   *
    55   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
    56   * @author Jochen Theodorou
    57   * @version $Revision: 3419 $
    58   */
    59  public class VariableScope  {
    60      private Map declaredVariables = new HashMap();
    61      private Map referencedLocalVariables = new HashMap();
    62      private Map referencedClassVariables = new HashMap();
    63
    64      private boolean inStaticContext = false;
    65      private boolean resolvesDynamic = false;
    66      private ClassNode clazzScope;
    67      private VariableScope parent;
    68
    69      public VariableScope() {
    70      }
    71      public VariableScope(VariableScope parent) {
    72          this.parent = parent;
    73      }
    74      public Map getDeclaredVariables() {
    75          return declaredVariables;
    76      }
    77      public Variable getDeclaredVariable(String name) {
    78          return (Variable) declaredVariables.get(name);
    79      }
    80      public Map getReferencedLocalVariables() {
    81          return referencedLocalVariables;
    82      }
    83
    84      public boolean isReferencedLocalVariable(String name) {
    85          return referencedLocalVariables.containsKey(name);
    86      }
    87
    88      public Map getReferencedClassVariables() {
    89          return referencedClassVariables;
    90      }
    91
    92      public boolean isReferencedClassVariable(String name) {
    93          return referencedClassVariables.containsKey(name);
    94      }
    95      public VariableScope getParent() {
    96          return parent;
    97      }
    98
    99      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 }