JavadocEnter.java revision 3904:7486e172ca65 
1/*
2 * Copyright (c) 2001, 2017, 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
26package com.sun.tools.javadoc.main;
27
28import javax.tools.JavaFileObject;
29
30import com.sun.source.util.TreePath;
31import com.sun.tools.javac.code.Symbol.*;
32import com.sun.tools.javac.comp.Enter;
33import com.sun.tools.javac.tree.JCTree.*;
34import com.sun.tools.javac.util.Context;
35import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
36import com.sun.tools.javac.util.List;
37
38import static com.sun.tools.javac.code.Kinds.Kind.*;
39import 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
53public class JavadocEnter extends Enter {
54    public static JavadocEnter instance(Context context) {
55        Enter instance = context.get(enterKey);
56        if (instance == null)
57            instance = new JavadocEnter(context);
58        return (JavadocEnter)instance;
59    }
60
61    public static void preRegister(Context context) {
62        context.put(enterKey, (Context.Factory<Enter>)JavadocEnter::new);
63    }
64
65    protected JavadocEnter(Context context) {
66        super(context);
67        messager = Messager.instance0(context);
68        docenv = DocEnv.instance(context);
69        compiler = JavaCompiler.instance(context);
70    }
71
72    final Messager messager;
73    final DocEnv docenv;
74    final JavaCompiler compiler;
75
76    @Override
77    public void main(List<JCCompilationUnit> trees) {
78        // count all Enter errors as warnings.
79        int nerrors = messager.nerrors;
80        super.main(trees);
81        compiler.enterDone();
82        messager.nwarnings += (messager.nerrors - nerrors);
83        messager.nerrors = nerrors;
84    }
85
86    @Override
87    public void visitTopLevel(JCCompilationUnit tree) {
88        super.visitTopLevel(tree);
89        if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) {
90            JCPackageDecl pd = tree.getPackage();
91            TreePath tp = pd == null ? docenv.getTreePath(tree) : docenv.getTreePath(tree, pd);
92            docenv.makePackageDoc(tree.packge, tp);
93        }
94    }
95
96    @Override
97    public void visitClassDef(JCClassDecl tree) {
98        super.visitClassDef(tree);
99        if (tree.sym == null) return;
100        if (tree.sym.kind == TYP || tree.sym.kind == ERR) {
101            ClassSymbol c = tree.sym;
102            docenv.makeClassDoc(c, docenv.getTreePath(env.toplevel, tree));
103        }
104    }
105
106    /** Don't complain about a duplicate class. */
107    @Override
108    protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {}
109
110}
111