duke@1: /*
xdono@229:  * Copyright 2000-2009 Sun Microsystems, Inc.  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
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun 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:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javadoc;
duke@1: 
jjg@197: import java.lang.reflect.Modifier;
duke@1: import java.util.*;
jjg@197: import javax.tools.JavaFileManager;
duke@1: 
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: import com.sun.tools.javac.code.*;
duke@1: import com.sun.tools.javac.code.Symbol.*;
duke@1: import com.sun.tools.javac.code.Type.ClassType;
duke@1: import com.sun.tools.javac.comp.Attr;
duke@1: import com.sun.tools.javac.comp.Check;
duke@1: import com.sun.tools.javac.tree.JCTree.*;
duke@1: import com.sun.tools.javac.util.Context;
jjg@113: import com.sun.tools.javac.util.Names;
duke@1: import com.sun.tools.javac.util.Position;
duke@1: 
duke@1: /**
duke@1:  * Holds the environment for a run of javadoc.
duke@1:  * Holds only the information needed throughout the
duke@1:  * run and not the compiler info that could be GC'ed
duke@1:  * or ported.
duke@1:  *
duke@1:  * @since 1.4
duke@1:  * @author Robert Field
duke@1:  * @author Neal Gafter (rewrite)
duke@1:  * @author Scott Seligman (generics)
duke@1:  */
duke@1: public class DocEnv {
duke@1:     protected static final Context.Key<DocEnv> docEnvKey =
duke@1:         new Context.Key<DocEnv>();
duke@1: 
duke@1:     public static DocEnv instance(Context context) {
duke@1:         DocEnv instance = context.get(docEnvKey);
duke@1:         if (instance == null)
duke@1:             instance = new DocEnv(context);
duke@1:         return instance;
duke@1:     }
duke@1: 
duke@1:     private Messager messager;
duke@1: 
duke@1:     DocLocale doclocale;
duke@1: 
duke@1:     /** Predefined symbols known to the compiler. */
duke@1:     Symtab syms;
duke@1: 
duke@1:     /** Referenced directly in RootDocImpl. */
duke@1:     JavadocClassReader reader;
duke@1: 
duke@1:     /** The compiler's attribution phase (needed to evaluate
duke@1:      *  constant initializers). */
duke@1:     Attr attr;
duke@1: 
duke@1:     /** Javadoc's own version of the compiler's enter phase. */
duke@1:     JavadocEnter enter;
duke@1: 
duke@1:     /** The name table. */
jjg@113:     Names names;
duke@1: 
duke@1:     /** The encoding name. */
duke@1:     private String encoding;
duke@1: 
duke@1:     final Symbol externalizableSym;
duke@1: 
duke@1:     /** Access filter (public, protected, ...).  */
duke@1:     ModifierFilter showAccess;
duke@1: 
duke@1:     private ClassDocImpl runtimeException;
duke@1: 
duke@1:     /** True if we are using a sentence BreakIterator. */
duke@1:     boolean breakiterator;
duke@1: 
duke@1:     /**
duke@1:      * True if we do not want to print any notifications at all.
duke@1:      */
duke@1:     boolean quiet = false;
duke@1: 
duke@1:     Check chk;
duke@1:     Types types;
jjg@197:     JavaFileManager fileManager;
duke@1: 
duke@1:     /** Allow documenting from class files? */
duke@1:     boolean docClasses = false;
duke@1: 
duke@1:     /** Does the doclet only expect pre-1.5 doclet API? */
duke@1:     boolean legacyDoclet = true;
duke@1: 
duke@1:     /**
duke@1:      * Set this to true if you would like to not emit any errors, warnings and
duke@1:      * notices.
duke@1:      */
duke@1:     private boolean silent = false;
duke@1: 
duke@1:     /**
duke@1:      * Constructor
duke@1:      *
duke@1:      * @param context      Context for this javadoc instance.
duke@1:      */
duke@1:     private DocEnv(Context context) {
duke@1:         context.put(docEnvKey, this);
duke@1: 
duke@1:         messager = Messager.instance0(context);
duke@1:         syms = Symtab.instance(context);
duke@1:         reader = JavadocClassReader.instance0(context);
duke@1:         enter = JavadocEnter.instance0(context);
duke@1:         attr = Attr.instance(context);
jjg@113:         names = Names.instance(context);
duke@1:         externalizableSym = reader.enterClass(names.fromString("java.io.Externalizable"));
duke@1:         chk = Check.instance(context);
duke@1:         types = Types.instance(context);
jjg@197:         fileManager = context.get(JavaFileManager.class);
duke@1: 
duke@1:         // Default.  Should normally be reset with setLocale.
duke@1:         this.doclocale = new DocLocale(this, "", breakiterator);
duke@1:     }
duke@1: 
duke@1:     public void setSilent(boolean silent) {
duke@1:         this.silent = silent;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Look up ClassDoc by qualified name.
duke@1:      */
duke@1:     public ClassDocImpl lookupClass(String name) {
duke@1:         ClassSymbol c = getClassSymbol(name);
duke@1:         if (c != null) {
duke@1:             return getClassDoc(c);
duke@1:         } else {
duke@1:             return null;
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Load ClassDoc by qualified name.
duke@1:      */
duke@1:     public ClassDocImpl loadClass(String name) {
duke@1:         try {
duke@1:             ClassSymbol c = reader.loadClass(names.fromString(name));
duke@1:             return getClassDoc(c);
duke@1:         } catch (CompletionFailure ex) {
duke@1:             chk.completionError(null, ex);
duke@1:             return null;
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Look up PackageDoc by qualified name.
duke@1:      */
duke@1:     public PackageDocImpl lookupPackage(String name) {
duke@1:         //### Jing alleges that class check is needed
duke@1:         //### to avoid a compiler bug.  Most likely
duke@1:         //### instead a dummy created for error recovery.
duke@1:         //### Should investigate this.
duke@1:         PackageSymbol p = syms.packages.get(names.fromString(name));
duke@1:         ClassSymbol c = getClassSymbol(name);
duke@1:         if (p != null && c == null) {
duke@1:             return getPackageDoc(p);
duke@1:         } else {
duke@1:             return null;
duke@1:         }
duke@1:     }
duke@1:         // where
duke@1:         /** Retrieve class symbol by fully-qualified name.
duke@1:          */
duke@1:         ClassSymbol getClassSymbol(String name) {
duke@1:             // Name may contain nested class qualification.
duke@1:             // Generate candidate flatnames with successively shorter
duke@1:             // package qualifiers and longer nested class qualifiers.
duke@1:             int nameLen = name.length();
duke@1:             char[] nameChars = name.toCharArray();
duke@1:             int idx = name.length();
duke@1:             for (;;) {
duke@1:                 ClassSymbol s = syms.classes.get(names.fromChars(nameChars, 0, nameLen));
duke@1:                 if (s != null)
duke@1:                     return s; // found it!
duke@1:                 idx = name.substring(0, idx).lastIndexOf('.');
duke@1:                 if (idx < 0) break;
duke@1:                 nameChars[idx] = '$';
duke@1:             }
duke@1:             return null;
duke@1:         }
duke@1: 
duke@1:     /**
duke@1:      * Set the locale.
duke@1:      */
duke@1:     public void setLocale(String localeName) {
duke@1:         // create locale specifics
duke@1:         doclocale = new DocLocale(this, localeName, breakiterator);
duke@1:         // reset Messager if locale has changed.
duke@1:         messager.reset();
duke@1:     }
duke@1: 
duke@1:     /** Check whether this member should be documented. */
duke@1:     public boolean shouldDocument(VarSymbol sym) {
duke@1:         long mod = sym.flags();
duke@1: 
duke@1:         if ((mod & Flags.SYNTHETIC) != 0) {
duke@1:             return false;
duke@1:         }
duke@1: 
duke@1:         return showAccess.checkModifier(translateModifiers(mod));
duke@1:     }
duke@1: 
duke@1:     /** Check whether this member should be documented. */
duke@1:     public boolean shouldDocument(MethodSymbol sym) {
duke@1:         long mod = sym.flags();
duke@1: 
duke@1:         if ((mod & Flags.SYNTHETIC) != 0) {
duke@1:             return false;
duke@1:         }
duke@1: 
duke@1:         return showAccess.checkModifier(translateModifiers(mod));
duke@1:     }
duke@1: 
duke@1:     /** check whether this class should be documented. */
duke@1:     public boolean shouldDocument(ClassSymbol sym) {
duke@1:         return
duke@1:             (sym.flags_field&Flags.SYNTHETIC) == 0 && // no synthetics
duke@1:             (docClasses || getClassDoc(sym).tree != null) &&
duke@1:             isVisible(sym);
duke@1:     }
duke@1: 
duke@1:     //### Comment below is inaccurate wrt modifier filter testing
duke@1:     /**
duke@1:      * Check the visibility if this is an nested class.
duke@1:      * if this is not a nested class, return true.
duke@1:      * if this is an static visible nested class,
duke@1:      *    return true.
duke@1:      * if this is an visible nested class
duke@1:      *    if the outer class is visible return true.
duke@1:      *    else return false.
duke@1:      * IMPORTANT: This also allows, static nested classes
duke@1:      * to be defined inside an nested class, which is not
duke@1:      * allowed by the compiler. So such an test case will
duke@1:      * not reach upto this method itself, but if compiler
duke@1:      * allows it, then that will go through.
duke@1:      */
duke@1:     protected boolean isVisible(ClassSymbol sym) {
duke@1:         long mod = sym.flags_field;
duke@1:         if (!showAccess.checkModifier(translateModifiers(mod))) {
duke@1:             return false;
duke@1:         }
duke@1:         ClassSymbol encl = sym.owner.enclClass();
duke@1:         return (encl == null || (mod & Flags.STATIC) != 0 || isVisible(encl));
duke@1:     }
duke@1: 
duke@1:     //---------------- print forwarders ----------------//
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param msg message to print.
duke@1:      */
duke@1:     public void printError(String msg) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.printError(msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      */
duke@1:     public void error(DocImpl doc, String key) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.error(doc==null ? null : doc.position(), key);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      */
duke@1:     public void error(SourcePosition pos, String key) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.error(pos, key);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param msg message to print.
duke@1:      */
duke@1:     public void printError(SourcePosition pos, String msg) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.printError(pos, msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      */
duke@1:     public void error(DocImpl doc, String key, String a1) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.error(doc==null ? null : doc.position(), key, a1);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      * @param a2 second argument
duke@1:      */
duke@1:     public void error(DocImpl doc, String key, String a1, String a2) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.error(doc==null ? null : doc.position(), key, a1, a2);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      * @param a2 second argument
duke@1:      * @param a3 third argument
duke@1:      */
duke@1:     public void error(DocImpl doc, String key, String a1, String a2, String a3) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.error(doc==null ? null : doc.position(), key, a1, a2, a3);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param msg message to print.
duke@1:      */
duke@1:     public void printWarning(String msg) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.printWarning(msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      */
duke@1:     public void warning(DocImpl doc, String key) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.warning(doc==null ? null : doc.position(), key);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param msg message to print.
duke@1:      */
duke@1:     public void printWarning(SourcePosition pos, String msg) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.printWarning(pos, msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      */
duke@1:     public void warning(DocImpl doc, String key, String a1) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.warning(doc==null ? null : doc.position(), key, a1);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      * @param a2 second argument
duke@1:      */
duke@1:     public void warning(DocImpl doc, String key, String a1, String a2) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.warning(doc==null ? null : doc.position(), key, a1, a2);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      * @param a2 second argument
duke@1:      * @param a3 third argument
duke@1:      */
duke@1:     public void warning(DocImpl doc, String key, String a1, String a2, String a3) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.warning(doc==null ? null : doc.position(), key, a1, a2, a3);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      * @param a2 second argument
duke@1:      * @param a3 third argument
duke@1:      */
duke@1:     public void warning(DocImpl doc, String key, String a1, String a2, String a3,
duke@1:                         String a4) {
duke@1:         if (silent)
duke@1:             return;
duke@1:         messager.warning(doc==null ? null : doc.position(), key, a1, a2, a3, a4);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param msg message to print.
duke@1:      */
duke@1:     public void printNotice(String msg) {
duke@1:         if (silent || quiet)
duke@1:             return;
duke@1:         messager.printNotice(msg);
duke@1:     }
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      */
duke@1:     public void notice(String key) {
duke@1:         if (silent || quiet)
duke@1:             return;
duke@1:         messager.notice(key);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param msg message to print.
duke@1:      */
duke@1:     public void printNotice(SourcePosition pos, String msg) {
duke@1:         if (silent || quiet)
duke@1:             return;
duke@1:         messager.printNotice(pos, msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      */
duke@1:     public void notice(String key, String a1) {
duke@1:         if (silent || quiet)
duke@1:             return;
duke@1:         messager.notice(key, a1);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      * @param a2 second argument
duke@1:      */
duke@1:     public void notice(String key, String a1, String a2) {
duke@1:         if (silent || quiet)
duke@1:             return;
duke@1:         messager.notice(key, a1, a2);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param key selects message from resource
duke@1:      * @param a1 first argument
duke@1:      * @param a2 second argument
duke@1:      * @param a3 third argument
duke@1:      */
duke@1:     public void notice(String key, String a1, String a2, String a3) {
duke@1:         if (silent || quiet)
duke@1:             return;
duke@1:         messager.notice(key, a1, a2, a3);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Exit, reporting errors and warnings.
duke@1:      */
duke@1:     public void exit() {
duke@1:         // Messager should be replaced by a more general
duke@1:         // compilation environment.  This can probably
duke@1:         // subsume DocEnv as well.
duke@1:         messager.exit();
duke@1:     }
duke@1: 
duke@1:     private Map<PackageSymbol, PackageDocImpl> packageMap =
duke@1:             new HashMap<PackageSymbol, PackageDocImpl>();
duke@1:     /**
duke@1:      * Return the PackageDoc of this package symbol.
duke@1:      */
duke@1:     public PackageDocImpl getPackageDoc(PackageSymbol pack) {
duke@1:         PackageDocImpl result = packageMap.get(pack);
duke@1:         if (result != null) return result;
duke@1:         result = new PackageDocImpl(this, pack);
duke@1:         packageMap.put(pack, result);
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Create the PackageDoc (or a subtype) for a package symbol.
duke@1:      */
duke@1:     void makePackageDoc(PackageSymbol pack, String docComment, JCCompilationUnit tree) {
duke@1:         PackageDocImpl result = packageMap.get(pack);
duke@1:         if (result != null) {
duke@1:             if (docComment != null) result.setRawCommentText(docComment);
duke@1:             if (tree != null) result.setTree(tree);
duke@1:         } else {
duke@1:             result = new PackageDocImpl(this, pack, docComment, tree);
duke@1:             packageMap.put(pack, result);
duke@1:         }
duke@1:     }
duke@1: 
duke@1: 
duke@1:     private Map<ClassSymbol, ClassDocImpl> classMap =
duke@1:             new HashMap<ClassSymbol, ClassDocImpl>();
duke@1:     /**
duke@1:      * Return the ClassDoc (or a subtype) of this class symbol.
duke@1:      */
duke@1:     ClassDocImpl getClassDoc(ClassSymbol clazz) {
duke@1:         ClassDocImpl result = classMap.get(clazz);
duke@1:         if (result != null) return result;
duke@1:         if (isAnnotationType(clazz)) {
duke@1:             result = new AnnotationTypeDocImpl(this, clazz);
duke@1:         } else {
duke@1:             result = new ClassDocImpl(this, clazz);
duke@1:         }
duke@1:         classMap.put(clazz, result);
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Create the ClassDoc (or a subtype) for a class symbol.
duke@1:      */
duke@1:     void makeClassDoc(ClassSymbol clazz, String docComment, JCClassDecl tree, Position.LineMap lineMap) {
duke@1:         ClassDocImpl result = classMap.get(clazz);
duke@1:         if (result != null) {
duke@1:             if (docComment != null) result.setRawCommentText(docComment);
duke@1:             if (tree != null) result.setTree(tree);
duke@1:             return;
duke@1:         }
duke@1:         if (isAnnotationType(tree)) {   // flags of clazz may not yet be set
duke@1:             result = new AnnotationTypeDocImpl(this, clazz, docComment, tree, lineMap);
duke@1:         } else {
duke@1:             result = new ClassDocImpl(this, clazz, docComment, tree, lineMap);
duke@1:         }
duke@1:         classMap.put(clazz, result);
duke@1:     }
duke@1: 
duke@1:     private static boolean isAnnotationType(ClassSymbol clazz) {
duke@1:         return ClassDocImpl.isAnnotationType(clazz);
duke@1:     }
duke@1: 
duke@1:     private static boolean isAnnotationType(JCClassDecl tree) {
duke@1:         return (tree.mods.flags & Flags.ANNOTATION) != 0;
duke@1:     }
duke@1: 
duke@1:     private Map<VarSymbol, FieldDocImpl> fieldMap =
duke@1:             new HashMap<VarSymbol, FieldDocImpl>();
duke@1:     /**
duke@1:      * Return the FieldDoc of this var symbol.
duke@1:      */
duke@1:     FieldDocImpl getFieldDoc(VarSymbol var) {
duke@1:         FieldDocImpl result = fieldMap.get(var);
duke@1:         if (result != null) return result;
duke@1:         result = new FieldDocImpl(this, var);
duke@1:         fieldMap.put(var, result);
duke@1:         return result;
duke@1:     }
duke@1:     /**
duke@1:      * Create a FieldDoc for a var symbol.
duke@1:      */
duke@1:     void makeFieldDoc(VarSymbol var, String docComment, JCVariableDecl tree, Position.LineMap lineMap) {
duke@1:         FieldDocImpl result = fieldMap.get(var);
duke@1:         if (result != null) {
duke@1:             if (docComment != null) result.setRawCommentText(docComment);
duke@1:             if (tree != null) result.setTree(tree);
duke@1:         } else {
duke@1:             result = new FieldDocImpl(this, var, docComment, tree, lineMap);
duke@1:             fieldMap.put(var, result);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     private Map<MethodSymbol, ExecutableMemberDocImpl> methodMap =
duke@1:             new HashMap<MethodSymbol, ExecutableMemberDocImpl>();
duke@1:     /**
duke@1:      * Create a MethodDoc for this MethodSymbol.
duke@1:      * Should be called only on symbols representing methods.
duke@1:      */
duke@1:     void makeMethodDoc(MethodSymbol meth, String docComment,
duke@1:                        JCMethodDecl tree, Position.LineMap lineMap) {
duke@1:         MethodDocImpl result = (MethodDocImpl)methodMap.get(meth);
duke@1:         if (result != null) {
duke@1:             if (docComment != null) result.setRawCommentText(docComment);
duke@1:             if (tree != null) result.setTree(tree);
duke@1:         } else {
duke@1:             result = new MethodDocImpl(this, meth, docComment, tree, lineMap);
duke@1:             methodMap.put(meth, result);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the MethodDoc for a MethodSymbol.
duke@1:      * Should be called only on symbols representing methods.
duke@1:      */
duke@1:     public MethodDocImpl getMethodDoc(MethodSymbol meth) {
duke@1:         MethodDocImpl result = (MethodDocImpl)methodMap.get(meth);
duke@1:         if (result != null) return result;
duke@1:         result = new MethodDocImpl(this, meth);
duke@1:         methodMap.put(meth, result);
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Create the ConstructorDoc for a MethodSymbol.
duke@1:      * Should be called only on symbols representing constructors.
duke@1:      */
duke@1:     void makeConstructorDoc(MethodSymbol meth, String docComment,
duke@1:                             JCMethodDecl tree, Position.LineMap lineMap) {
duke@1:         ConstructorDocImpl result = (ConstructorDocImpl)methodMap.get(meth);
duke@1:         if (result != null) {
duke@1:             if (docComment != null) result.setRawCommentText(docComment);
duke@1:             if (tree != null) result.setTree(tree);
duke@1:         } else {
duke@1:             result = new ConstructorDocImpl(this, meth, docComment, tree, lineMap);
duke@1:             methodMap.put(meth, result);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the ConstructorDoc for a MethodSymbol.
duke@1:      * Should be called only on symbols representing constructors.
duke@1:      */
duke@1:     public ConstructorDocImpl getConstructorDoc(MethodSymbol meth) {
duke@1:         ConstructorDocImpl result = (ConstructorDocImpl)methodMap.get(meth);
duke@1:         if (result != null) return result;
duke@1:         result = new ConstructorDocImpl(this, meth);
duke@1:         methodMap.put(meth, result);
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Create the AnnotationTypeElementDoc for a MethodSymbol.
duke@1:      * Should be called only on symbols representing annotation type elements.
duke@1:      */
duke@1:     void makeAnnotationTypeElementDoc(MethodSymbol meth,
duke@1:                                       String docComment, JCMethodDecl tree, Position.LineMap lineMap) {
duke@1:         AnnotationTypeElementDocImpl result =
duke@1:             (AnnotationTypeElementDocImpl)methodMap.get(meth);
duke@1:         if (result != null) {
duke@1:             if (docComment != null) result.setRawCommentText(docComment);
duke@1:             if (tree != null) result.setTree(tree);
duke@1:         } else {
duke@1:             result =
duke@1:                 new AnnotationTypeElementDocImpl(this, meth, docComment, tree, lineMap);
duke@1:             methodMap.put(meth, result);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the AnnotationTypeElementDoc for a MethodSymbol.
duke@1:      * Should be called only on symbols representing annotation type elements.
duke@1:      */
duke@1:     public AnnotationTypeElementDocImpl getAnnotationTypeElementDoc(
duke@1:             MethodSymbol meth) {
duke@1: 
duke@1:         AnnotationTypeElementDocImpl result =
duke@1:             (AnnotationTypeElementDocImpl)methodMap.get(meth);
duke@1:         if (result != null) return result;
duke@1:         result = new AnnotationTypeElementDocImpl(this, meth);
duke@1:         methodMap.put(meth, result);
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1: //  private Map<ClassType, ParameterizedTypeImpl> parameterizedTypeMap =
duke@1: //          new HashMap<ClassType, ParameterizedTypeImpl>();
duke@1:     /**
duke@1:      * Return the ParameterizedType of this instantiation.
duke@1: //   * ### Could use Type.sameTypeAs() instead of equality matching in hashmap
duke@1: //   * ### to avoid some duplication.
duke@1:      */
duke@1:     ParameterizedTypeImpl getParameterizedType(ClassType t) {
duke@1:         return new ParameterizedTypeImpl(this, t);
duke@1: //      ParameterizedTypeImpl result = parameterizedTypeMap.get(t);
duke@1: //      if (result != null) return result;
duke@1: //      result = new ParameterizedTypeImpl(this, t);
duke@1: //      parameterizedTypeMap.put(t, result);
duke@1: //      return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Set the encoding.
duke@1:      */
duke@1:     public void setEncoding(String encoding) {
duke@1:         this.encoding = encoding;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Get the encoding.
duke@1:      */
duke@1:     public String getEncoding() {
duke@1:         return encoding;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Convert modifier bits from private coding used by
duke@1:      * the compiler to that of java.lang.reflect.Modifier.
duke@1:      */
duke@1:     static int translateModifiers(long flags) {
duke@1:         int result = 0;
duke@1:         if ((flags & Flags.ABSTRACT) != 0)
duke@1:             result |= Modifier.ABSTRACT;
duke@1:         if ((flags & Flags.FINAL) != 0)
duke@1:             result |= Modifier.FINAL;
duke@1:         if ((flags & Flags.INTERFACE) != 0)
duke@1:             result |= Modifier.INTERFACE;
duke@1:         if ((flags & Flags.NATIVE) != 0)
duke@1:             result |= Modifier.NATIVE;
duke@1:         if ((flags & Flags.PRIVATE) != 0)
duke@1:             result |= Modifier.PRIVATE;
duke@1:         if ((flags & Flags.PROTECTED) != 0)
duke@1:             result |= Modifier.PROTECTED;
duke@1:         if ((flags & Flags.PUBLIC) != 0)
duke@1:             result |= Modifier.PUBLIC;
duke@1:         if ((flags & Flags.STATIC) != 0)
duke@1:             result |= Modifier.STATIC;
duke@1:         if ((flags & Flags.SYNCHRONIZED) != 0)
duke@1:             result |= Modifier.SYNCHRONIZED;
duke@1:         if ((flags & Flags.TRANSIENT) != 0)
duke@1:             result |= Modifier.TRANSIENT;
duke@1:         if ((flags & Flags.VOLATILE) != 0)
duke@1:             result |= Modifier.VOLATILE;
duke@1:         return result;
duke@1:     }
duke@1: }