/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.tools.javadoc.main;

import javax.tools.JavaFileObject;

import com.sun.source.util.TreePath;

import com.sun.tools.javac.code.Symbol.*;

import com.sun.tools.javac.comp.Enter;

import com.sun.tools.javac.tree.JCTree.*;

import com.sun.tools.javac.util.Context;

import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;

import com.sun.tools.javac.util.List;

import static com.sun.tools.javac.code.Kinds.Kind.*;

/**

 *  Javadoc's own enter phase does a few things above and beyond that

 *  done by javac.

 *

 *  <p><b>This is NOT part of any supported API.

 *  If you write code that depends on this, you do so at your own risk.

 *  This code and its internal interfaces are subject to change or

 *  deletion without notice.</b>

 *

 *  @author Neal Gafter

 */

@Deprecated

public class JavadocEnter extends Enter {

    public static JavadocEnter instance(Context context) {

        Enter instance = context.get(enterKey);

        if (instance == null)

            instance = new JavadocEnter(context);

        return (JavadocEnter)instance;

    }

    public static void preRegister(Context context) {

        context.put(enterKey, (Context.Factory<Enter>)JavadocEnter::new);

    }

    protected JavadocEnter(Context context) {

        super(context);

        messager = Messager.instance0(context);

        docenv = DocEnv.instance(context);

    }

    final Messager messager;

    final DocEnv docenv;

    @Override

    public void main(List<JCCompilationUnit> trees) {

        // count all Enter errors as warnings.

        int nerrors = messager.nerrors;

        super.main(trees);

        messager.nwarnings += (messager.nerrors - nerrors);

        messager.nerrors = nerrors;

    }

    @Override

    public void visitTopLevel(JCCompilationUnit tree) {

        super.visitTopLevel(tree);

        if (tree.sourcefile.isNameCompatible("package-info", JavaFileObject.Kind.SOURCE)) {

            JCPackageDecl pd = tree.getPackage();

            TreePath tp = pd == null ? docenv.getTreePath(tree) : docenv.getTreePath(tree, pd);

            docenv.makePackageDoc(tree.packge, tp);

        }

    }

    @Override

    public void visitClassDef(JCClassDecl tree) {

        super.visitClassDef(tree);

        if (tree.sym == null) return;

        if (tree.sym.kind == TYP || tree.sym.kind == ERR) {

            ClassSymbol c = tree.sym;

            docenv.makeClassDoc(c, docenv.getTreePath(env.toplevel, tree));

        }

    }

    /** Don't complain about a duplicate class. */

    @Override

    protected void duplicateClass(DiagnosticPosition pos, ClassSymbol c) {}

}