langtools/src/share/classes/com/sun/tools/javadoc/JavadocEnter.java
author pgovereau
Tue, 22 Apr 2014 17:07:54 -0400
changeset 24069 dfb8f11542fc
parent 17578 46ac954e4a84
child 24604 7f68545b5128
permissions -rw-r--r--
8034245: Refactor TopLevel tree node. Summary: Added JCPackageDecl to JCTree to store package-level information. Reviewed-by: jjg, jlahoda
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
17578
46ac954e4a84 8013852: update reference impl for type-annotations
jjg
parents: 14802
diff changeset
     2
 * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1264
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.tools.javadoc;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
13077
16fb753bb5dc 7174143: encapsulate doc comment table
jjg
parents: 10203
diff changeset
    28
import javax.tools.JavaFileObject;
16fb753bb5dc 7174143: encapsulate doc comment table
jjg
parents: 10203
diff changeset
    29
24069
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents: 17578
diff changeset
    30
import com.sun.source.util.TreePath;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
import com.sun.tools.javac.code.Kinds;
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
import com.sun.tools.javac.code.Symbol.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
import com.sun.tools.javac.comp.Enter;
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
import com.sun.tools.javac.tree.JCTree.*;
13077
16fb753bb5dc 7174143: encapsulate doc comment table
jjg
parents: 10203
diff changeset
    35
import com.sun.tools.javac.util.Context;
16fb753bb5dc 7174143: encapsulate doc comment table
jjg
parents: 10203
diff changeset
    36
import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
16fb753bb5dc 7174143: encapsulate doc comment table
jjg
parents: 10203
diff changeset
    37
import com.sun.tools.javac.util.List;
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 *  Javadoc's own enter phase does a few things above and beyond that
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 *  done by javac.
14260
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14258
diff changeset
    42
 *
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14258
diff changeset
    43
 *  <p><b>This is NOT part of any supported API.
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14258
diff changeset
    44
 *  If you write code that depends on this, you do so at your own risk.
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14258
diff changeset
    45
 *  This code and its internal interfaces are subject to change or
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14258
diff changeset
    46
 *  deletion without notice.</b>
727a84636f12 8000665: fix "internal API" comments on javadoc files
jjg
parents: 14258
diff changeset
    47
 *
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
 *  @author Neal Gafter
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
public class JavadocEnter extends Enter {
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
    public static JavadocEnter instance0(Context context) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
        Enter instance = context.get(enterKey);
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
        if (instance == null)
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
            instance = new JavadocEnter(context);
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
        return (JavadocEnter)instance;
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
8614
06e42328ddab 7021650: fix Context issues
jjg
parents: 5520
diff changeset
    58
    public static void preRegister(Context context) {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
        context.put(enterKey, new Context.Factory<Enter>() {
8614
06e42328ddab 7021650: fix Context issues
jjg
parents: 5520
diff changeset
    60
               public Enter make(Context c) {
06e42328ddab 7021650: fix Context issues
jjg
parents: 5520
diff changeset
    61
                   return new JavadocEnter(c);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
               }
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
        });
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
    protected JavadocEnter(Context context) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
        super(context);
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
        messager = Messager.instance0(context);
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
        docenv = DocEnv.instance(context);
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    final Messager messager;
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
    final DocEnv docenv;
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
10203
cca843a7d258 7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents: 8614
diff changeset
    75
    @Override
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
    public void main(List<JCCompilationUnit> trees) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
        // count all Enter errors as warnings.
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
        int nerrors = messager.nerrors;
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        super.main(trees);
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
        messager.nwarnings += (messager.nerrors - nerrors);
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
        messager.nerrors = nerrors;
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
10203
cca843a7d258 7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents: 8614
diff changeset
    84
    @Override
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    public void visitTopLevel(JCCompilationUnit tree) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
        super.visitTopLevel(tree);
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
        if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) {
24069
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents: 17578
diff changeset
    88
            JCPackageDecl pd = tree.getPackage();
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents: 17578
diff changeset
    89
            TreePath tp = pd == null ? docenv.getTreePath(tree) : docenv.getTreePath(tree, pd);
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents: 17578
diff changeset
    90
            docenv.makePackageDoc(tree.packge, tp);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
10203
cca843a7d258 7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents: 8614
diff changeset
    94
    @Override
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
    public void visitClassDef(JCClassDecl tree) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
        super.visitClassDef(tree);
10203
cca843a7d258 7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents: 8614
diff changeset
    97
        if (tree.sym == null) return;
cca843a7d258 7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents: 8614
diff changeset
    98
        if (tree.sym.kind == Kinds.TYP || tree.sym.kind == Kinds.ERR) {
868
d0f233085cbb 6657907: javadoc has unchecked warnings
jjg
parents: 10
diff changeset
    99
            ClassSymbol c = tree.sym;
14802
969e90f68ac5 8004828: refactor init of *DocImpl classes
jjg
parents: 14260
diff changeset
   100
            docenv.makeClassDoc(c, docenv.getTreePath(env.toplevel, tree));
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
    /** Don't complain about a duplicate class. */
10203
cca843a7d258 7064544: (javadoc) miscellaneous fixes requested by netbeans
ksrini
parents: 8614
diff changeset
   105
    @Override
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
    protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {}
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
}