duke@1: /*
ohair@554:  * Copyright (c) 2006, 2008, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javac.api;
duke@1: 
duke@1: 
duke@1: import javax.lang.model.element.Element;
duke@1: import javax.lang.model.element.ExecutableElement;
duke@1: import javax.lang.model.element.TypeElement;
duke@1: 
duke@1: import com.sun.tools.javac.comp.AttrContext;
duke@1: import com.sun.tools.javac.comp.Env;
duke@1: 
duke@1: 
duke@1: 
duke@1: /**
duke@1:  * Provides an implementation of Scope.
duke@1:  *
jjg@581:  * <p><b>This is NOT part of any supported API.
duke@1:  * If you write code that depends on this, you do so at your own
duke@1:  * risk.  This code and its internal interfaces are subject to change
duke@1:  * or deletion without notice.</b></p>
duke@1:  *
duke@1:  * @author Jonathan Gibbons;
duke@1:  */
duke@1: public class JavacScope implements com.sun.source.tree.Scope {
duke@1:     protected final Env<AttrContext> env;
duke@1: 
duke@1:     /** Creates a new instance of JavacScope */
duke@1:     JavacScope(Env<AttrContext> env) {
duke@1:         env.getClass(); // null-check
duke@1:         this.env = env;
duke@1:     }
duke@1: 
duke@1:     public JavacScope getEnclosingScope() {
duke@1:         if (env.outer != null && env.outer != env)
duke@1:             return  new JavacScope(env.outer);
duke@1:         else {
duke@1:             // synthesize an outermost "star-import" scope
duke@1:             return new JavacScope(env) {
duke@1:                 public boolean isStarImportScope() {
duke@1:                     return true;
duke@1:                 }
duke@1:                 public JavacScope getEnclosingScope() {
duke@1:                     return null;
duke@1:                 }
duke@1:                 public Iterable<? extends Element> getLocalElements() {
duke@1:                     return env.toplevel.starImportScope.getElements();
duke@1:                 }
duke@1:             };
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     public TypeElement getEnclosingClass() {
duke@1:         // hide the dummy class that javac uses to enclose the top level declarations
duke@1:         return (env.outer == null || env.outer == env ? null : env.enclClass.sym);
duke@1:     }
duke@1: 
duke@1:     public ExecutableElement getEnclosingMethod() {
duke@1:         return (env.enclMethod == null ? null : env.enclMethod.sym);
duke@1:     }
duke@1: 
duke@1:     public Iterable<? extends Element> getLocalElements() {
duke@1:         return env.info.getLocalElements();
duke@1:     }
duke@1: 
duke@1:     public Env<AttrContext> getEnv() {
duke@1:         return env;
duke@1:     }
duke@1: 
duke@1:     public boolean isStarImportScope() {
duke@1:         return false;
duke@1:     }
duke@1: 
duke@1:     public boolean equals(Object other) {
duke@1:         if (other instanceof JavacScope) {
duke@1:             JavacScope s = (JavacScope) other;
duke@1:             return (env.equals(s.env)
duke@1:                 && isStarImportScope() == s.isStarImportScope());
duke@1:         } else
duke@1:             return false;
duke@1:     }
duke@1: 
duke@1:     public int hashCode() {
duke@1:         return env.hashCode() + (isStarImportScope() ? 1 : 0);
duke@1:     }
duke@1: 
duke@1:     public String toString() {
duke@1:         return "JavacScope[env=" + env + ",starImport=" + isStarImportScope() + "]";
duke@1:     }
duke@1: }