duke@1: /*
jjg@893:  * Copyright (c) 2001, 2011, 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.javadoc;
duke@1: 
duke@1: import com.sun.tools.javac.util.Context;
duke@1: import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
duke@1: import com.sun.tools.javac.util.List;
duke@1: import com.sun.tools.javac.code.Kinds;
duke@1: import com.sun.tools.javac.code.Symbol.*;
duke@1: import com.sun.tools.javac.comp.Enter;
duke@1: import com.sun.tools.javac.tree.JCTree.*;
duke@1: import javax.tools.JavaFileObject;
duke@1: 
duke@1: /**
duke@1:  *  Javadoc's own enter phase does a few things above and beyond that
duke@1:  *  done by javac.
duke@1:  *  @author Neal Gafter
duke@1:  */
duke@1: public class JavadocEnter extends Enter {
duke@1:     public static JavadocEnter instance0(Context context) {
duke@1:         Enter instance = context.get(enterKey);
duke@1:         if (instance == null)
duke@1:             instance = new JavadocEnter(context);
duke@1:         return (JavadocEnter)instance;
duke@1:     }
duke@1: 
jjg@893:     public static void preRegister(Context context) {
duke@1:         context.put(enterKey, new Context.Factory<Enter>() {
jjg@893:                public Enter make(Context c) {
jjg@893:                    return new JavadocEnter(c);
duke@1:                }
duke@1:         });
duke@1:     }
duke@1: 
duke@1:     protected JavadocEnter(Context context) {
duke@1:         super(context);
duke@1:         messager = Messager.instance0(context);
duke@1:         docenv = DocEnv.instance(context);
duke@1:     }
duke@1: 
duke@1:     final Messager messager;
duke@1:     final DocEnv docenv;
duke@1: 
ksrini@1065:     @Override
duke@1:     public void main(List<JCCompilationUnit> trees) {
duke@1:         // count all Enter errors as warnings.
duke@1:         int nerrors = messager.nerrors;
duke@1:         super.main(trees);
duke@1:         messager.nwarnings += (messager.nerrors - nerrors);
duke@1:         messager.nerrors = nerrors;
duke@1:     }
duke@1: 
ksrini@1065:     @Override
duke@1:     public void visitTopLevel(JCCompilationUnit tree) {
duke@1:         super.visitTopLevel(tree);
duke@1:         if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) {
duke@1:             String comment = tree.docComments.get(tree);
duke@1:             docenv.makePackageDoc(tree.packge, comment, tree);
duke@1:         }
duke@1:     }
duke@1: 
ksrini@1065:     @Override
duke@1:     public void visitClassDef(JCClassDecl tree) {
duke@1:         super.visitClassDef(tree);
ksrini@1065:         if (tree.sym == null) return;
ksrini@1065:         if (tree.sym.kind == Kinds.TYP || tree.sym.kind == Kinds.ERR) {
duke@1:             String comment = env.toplevel.docComments.get(tree);
jjg@74:             ClassSymbol c = tree.sym;
duke@1:             docenv.makeClassDoc(c, comment, tree, env.toplevel.lineMap);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /** Don't complain about a duplicate class. */
ksrini@1065:     @Override
duke@1:     protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {}
duke@1: 
duke@1: }