1 /*
2  * Copyright (c) 2001, 2018, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package com.sun.tools.javadoc.main;
27 
28 import javax.tools.JavaFileObject;
29 
30 import com.sun.source.util.TreePath;
31 import com.sun.tools.javac.code.Symbol.*;
32 import com.sun.tools.javac.comp.Enter;
33 import com.sun.tools.javac.tree.JCTree.*;
34 import com.sun.tools.javac.util.Context;
35 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
36 import com.sun.tools.javac.util.List;
37 
38 import static com.sun.tools.javac.code.Kinds.Kind.*;
39 import com.sun.tools.javac.main.JavaCompiler;
40 
41 /**
42  *  Javadoc's own enter phase does a few things above and beyond that
43  *  done by javac.
44  *
45  *  <p><b>This is NOT part of any supported API.
46  *  If you write code that depends on this, you do so at your own risk.
47  *  This code and its internal interfaces are subject to change or
48  *  deletion without notice.</b>
49  *
50  *  @author Neal Gafter
51  */
52 @Deprecated(since="9", forRemoval=true)
53 @SuppressWarnings("removal")
54 public class JavadocEnter extends Enter {
instance(Context context)55     public static JavadocEnter instance(Context context) {
56         Enter instance = context.get(enterKey);
57         if (instance == null)
58             instance = new JavadocEnter(context);
59         return (JavadocEnter)instance;
60     }
61 
preRegister(Context context)62     public static void preRegister(Context context) {
63         context.put(enterKey, (Context.Factory<Enter>)JavadocEnter::new);
64     }
65 
JavadocEnter(Context context)66     protected JavadocEnter(Context context) {
67         super(context);
68         messager = Messager.instance0(context);
69         docenv = DocEnv.instance(context);
70         compiler = JavaCompiler.instance(context);
71     }
72 
73     final Messager messager;
74     final DocEnv docenv;
75     final JavaCompiler compiler;
76 
77     @Override
main(List<JCCompilationUnit> trees)78     public void main(List<JCCompilationUnit> trees) {
79         // count all Enter errors as warnings.
80         int nerrors = messager.nerrors;
81         super.main(trees);
82         compiler.enterDone();
83         messager.nwarnings += (messager.nerrors - nerrors);
84         messager.nerrors = nerrors;
85     }
86 
87     @Override
visitTopLevel(JCCompilationUnit tree)88     public void visitTopLevel(JCCompilationUnit tree) {
89         super.visitTopLevel(tree);
90         if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) {
91             JCPackageDecl pd = tree.getPackage();
92             TreePath tp = pd == null ? docenv.getTreePath(tree) : docenv.getTreePath(tree, pd);
93             docenv.makePackageDoc(tree.packge, tp);
94         }
95     }
96 
97     @Override
visitClassDef(JCClassDecl tree)98     public void visitClassDef(JCClassDecl tree) {
99         super.visitClassDef(tree);
100         if (tree.sym == null) return;
101         if (tree.sym.kind == TYP || tree.sym.kind == ERR) {
102             ClassSymbol c = tree.sym;
103             docenv.makeClassDoc(c, docenv.getTreePath(env.toplevel, tree));
104         }
105     }
106 
107     /** Don't complain about a duplicate class. */
108     @Override
duplicateClass(DiagnosticPosition pos, ClassSymbol c)109     protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {}
110 
111 }
112