/*

 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.

 * 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.doclint;

import java.io.File;

import java.io.IOException;

import java.io.PrintWriter;

import java.util.ArrayList;

import java.util.List;

import javax.lang.model.element.Name;

import javax.tools.StandardLocation;

import com.sun.source.doctree.DocCommentTree;

import com.sun.source.tree.ClassTree;

import com.sun.source.tree.CompilationUnitTree;

import com.sun.source.tree.MethodTree;

import com.sun.source.tree.Tree;

import com.sun.source.tree.VariableTree;

import com.sun.source.util.JavacTask;

import com.sun.source.util.Plugin;

import com.sun.source.util.TaskEvent;

import com.sun.source.util.TaskListener;

import com.sun.source.util.TreePath;

import com.sun.source.util.TreePathScanner;

import com.sun.tools.javac.api.JavacTaskImpl;

import com.sun.tools.javac.api.JavacTool;

import com.sun.tools.javac.file.JavacFileManager;

import com.sun.tools.javac.main.JavaCompiler;

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

/**

 * Multi-function entry point for the doc check utility.

 *

 * This class can be invoked in the following ways:

 * <ul>

 * <li>From the command line

 * <li>From javac, as a plugin

 * <li>Directly, via a simple API

 * </ul>

 *

 * <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></p>

 */

public class DocLint implements Plugin {

    public static final String XMSGS_OPTION = "-Xmsgs";

    public static final String XMSGS_CUSTOM_PREFIX = "-Xmsgs:";

    private static final String STATS = "-stats";

    // <editor-fold defaultstate="collapsed" desc="Command-line entry point">

    public static void main(String... args) {

        try {

            new DocLint().run(args);

        } catch (BadArgs e) {

            System.err.println(e.getMessage());

            System.exit(1);

        } catch (IOException e) {

            System.err.println(e);

            System.exit(2);

        }

    }

    // </editor-fold>

    // <editor-fold defaultstate="collapsed" desc="Simple API">

    public static class BadArgs extends Exception {

        private static final long serialVersionUID = 0;

        BadArgs(String code, Object... args) {

            this.code = code;

            this.args = args;

        }

        final String code;

        final Object[] args;

    }

    /**

     * Simple API entry point.

     */

    public void run(String... args) throws BadArgs, IOException {

        PrintWriter out = new PrintWriter(System.out);

        try {

            run(out, args);

        } finally {

            out.flush();

        }

    }

    public void run(PrintWriter out, String... args) throws BadArgs, IOException {

        env = new Env();

        processArgs(args);

        if (needHelp)

            showHelp(out);

        if (javacFiles.isEmpty()) {

            if (!needHelp)

                System.out.println("no files given");

        }

        JavacTool tool = JavacTool.create();

        JavacFileManager fm = new JavacFileManager(new Context(), false, null);

        fm.setSymbolFileEnabled(false);

        fm.setLocation(StandardLocation.PLATFORM_CLASS_PATH, javacBootClassPath);

        fm.setLocation(StandardLocation.CLASS_PATH, javacClassPath);

        fm.setLocation(StandardLocation.SOURCE_PATH, javacSourcePath);

        JavacTask task = tool.getTask(out, fm, null, javacOpts, null,

                fm.getJavaFileObjectsFromFiles(javacFiles));

        Iterable<? extends CompilationUnitTree> units = task.parse();

        ((JavacTaskImpl) task).enter();

        env.init(task);

        checker = new Checker(env);

        DeclScanner ds = new DeclScanner() {

            @Override

            void visitDecl(Tree tree, Name name) {

                TreePath p = getCurrentPath();

                DocCommentTree dc = env.trees.getDocCommentTree(p);

                checker.scan(dc, p);

            }

        };

        ds.scan(units, null);

        reportStats(out);

        Context ctx = ((JavacTaskImpl) task).getContext();

        JavaCompiler c = JavaCompiler.instance(ctx);

        c.printCount("error", c.errorCount());

        c.printCount("warn", c.warningCount());

    }

    void processArgs(String... args) throws BadArgs {

        javacOpts = new ArrayList<String>();

        javacFiles = new ArrayList<File>();

        if (args.length == 0)

            needHelp = true;

        for (int i = 0; i < args.length; i++) {

            String arg = args[i];

            if (arg.matches("-Xmax(errs|warns)") && i + 1 < args.length) {

                if (args[++i].matches("[0-9]+")) {

                    javacOpts.add(arg);

                    javacOpts.add(args[i]);

                } else {

                    throw new BadArgs("dc.bad.value.for.option", arg, args[i]);

                }

            } else if (arg.equals(STATS)) {

                env.messages.setStatsEnabled(true);

            } else if (arg.matches("-bootclasspath") && i + 1 < args.length) {

                javacBootClassPath = splitPath(args[++i]);

            } else if (arg.matches("-classpath") && i + 1 < args.length) {

                javacClassPath = splitPath(args[++i]);

            } else if (arg.matches("-sourcepath") && i + 1 < args.length) {

                javacSourcePath = splitPath(args[++i]);

            } else if (arg.equals(XMSGS_OPTION)) {

                env.messages.setOptions(null);

            } else if (arg.startsWith(XMSGS_CUSTOM_PREFIX)) {

                env.messages.setOptions(arg.substring(arg.indexOf(":") + 1));

            } else if (arg.equals("-h") || arg.equals("-help") || arg.equals("--help")

                    || arg.equals("-?") || arg.equals("-usage")) {

                needHelp = true;

            } else if (arg.startsWith("-")) {

                throw new BadArgs("dc.bad.option", arg);

            } else {

                while (i < args.length)

                    javacFiles.add(new File(args[i++]));

            }

        }

    }

    void showHelp(PrintWriter out) {

        out.println("Usage:");

        out.println("    doclint [options] source-files...");

        out.println("");

        out.println("Options:");

        out.println("  -Xmsgs  ");

        out.println("    Same as -Xmsgs:all");

        out.println("  -Xmsgs:values");

        out.println("    Specify categories of issues to be checked, where 'values'");

        out.println("    is a comma-separated list of any of the following:");

        out.println("      reference      show places where comments contain incorrect");

        out.println("                     references to Java source code elements");

        out.println("      syntax         show basic syntax errors within comments");

        out.println("      html           show issues with HTML tags and attributes");

        out.println("      accessibility  show issues for accessibility");

        out.println("      missing        show issues with missing documentation");

        out.println("      all            all of the above");

        out.println("    Precede a value with '-' to negate it");

        out.println("    Categories may be qualified by one of:");

        out.println("      /public /protected /package /private");

        out.println("    For positive categories (not beginning with '-')");

        out.println("    the qualifier applies to that access level and above.");

        out.println("    For negative categories (beginning with '-')");

        out.println("    the qualifier applies to that access level and below.");

        out.println("    If a qualifier is missing, the category applies to");

        out.println("    all access levels.");

        out.println("    For example, -Xmsgs:all,-syntax/private");

        out.println("    This will enable all messages, except syntax errors");

        out.println("    in the doc comments of private methods.");

        out.println("    If no -Xmsgs options are provided, the default is");

        out.println("    equivalent to -Xmsgs:all/protected, meaning that");

        out.println("    all messages are reported for protected and public");

        out.println("    declarations only. ");

        out.println("  -h -help --help -usage -?");

        out.println("    Show this message.");

        out.println("");

        out.println("The following javac options are also supported");

        out.println("  -bootclasspath, -classpath, -sourcepath, -Xmaxerrs, -Xmaxwarns");

        out.println("");

        out.println("To run doclint on part of a project, put the compiled classes for your");

        out.println("project on the classpath (or bootclasspath), then specify the source files");

        out.println("to be checked on the command line.");

    }

    List<File> splitPath(String path) {

        List<File> files = new ArrayList<File>();

        for (String f: path.split(File.separator)) {

            if (f.length() > 0)

                files.add(new File(f));

        }

        return files;

    }

    List<File> javacBootClassPath;

    List<File> javacClassPath;

    List<File> javacSourcePath;

    List<String> javacOpts;

    List<File> javacFiles;

    boolean needHelp = false;

    // </editor-fold>

    // <editor-fold defaultstate="collapsed" desc="javac Plugin">

    @Override

    public String getName() {

        return "doclint";

    }

    @Override

    public void init(JavacTask task, String... args) {

        init(task, args, true);

    }

    // </editor-fold>

    // <editor-fold defaultstate="collapsed" desc="Embedding API">

    public void init(JavacTask task, String[] args, boolean addTaskListener) {

        env = new Env();

        for (int i = 0; i < args.length; i++) {

            String arg = args[i];

            if (arg.equals(XMSGS_OPTION)) {

                env.messages.setOptions(null);

            } else if (arg.startsWith(XMSGS_CUSTOM_PREFIX)) {

                env.messages.setOptions(arg.substring(arg.indexOf(":") + 1));

            } else

                throw new IllegalArgumentException(arg);

        }

        env.init(task);

        checker = new Checker(env);

        if (addTaskListener) {

            final DeclScanner ds = new DeclScanner() {

                @Override

                void visitDecl(Tree tree, Name name) {

                    TreePath p = getCurrentPath();

                    DocCommentTree dc = env.trees.getDocCommentTree(p);

                    checker.scan(dc, p);

                }

            };

            TaskListener tl = new TaskListener() {

                @Override

                public void started(TaskEvent e) {

                    return;

                }

                @Override

                public void finished(TaskEvent e) {

                    switch (e.getKind()) {

                        case ENTER:

                            ds.scan(e.getCompilationUnit(), null);

                    }

                }

            };

            task.addTaskListener(tl);

        }

    }

    public void scan(TreePath p) {

        DocCommentTree dc = env.trees.getDocCommentTree(p);

        checker.scan(dc, p);

    }

    public void reportStats(PrintWriter out) {

        env.messages.reportStats(out);

    }

    // </editor-fold>

    Env env;

    Checker checker;

    public static boolean isValidOption(String opt) {

        if (opt.equals(XMSGS_OPTION))

           return true;

        if (opt.startsWith(XMSGS_CUSTOM_PREFIX))

           return Messages.Options.isValidOptions(opt.substring(XMSGS_CUSTOM_PREFIX.length()));

        return false;

    }

    // <editor-fold defaultstate="collapsed" desc="DeclScanner">

    static abstract class DeclScanner extends TreePathScanner<Void, Void> {

        abstract void visitDecl(Tree tree, Name name);

        @Override

        public Void visitClass(ClassTree tree, Void ignore) {

            visitDecl(tree, tree.getSimpleName());

            return super.visitClass(tree, ignore);

        }

        @Override

        public Void visitMethod(MethodTree tree, Void ignore) {

            visitDecl(tree, tree.getName());

            //return super.visitMethod(tree, ignore);

            return null;

        }

        @Override

        public Void visitVariable(VariableTree tree, Void ignore) {

            visitDecl(tree, tree.getName());

            return super.visitVariable(tree, ignore);

        }

    }

    // </editor-fold>

}