src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AbstractDoclet.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AbstractDoclet.java Tue Sep 12 19:03:39 2017 +0200
@@ -0,0 +1,289 @@
+/*
+ * Copyright (c) 2003, 2017, 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 jdk.javadoc.internal.doclets.toolkit;
+
+import java.util.SortedSet;
+import java.util.TreeSet;
+
+import javax.lang.model.SourceVersion;
+import javax.lang.model.element.PackageElement;
+import javax.lang.model.element.TypeElement;
+
+import jdk.javadoc.doclet.Doclet;
+import jdk.javadoc.doclet.DocletEnvironment;
+import jdk.javadoc.doclet.StandardDoclet;
+import jdk.javadoc.internal.doclets.formats.html.HtmlDoclet;
+import jdk.javadoc.internal.doclets.toolkit.builders.AbstractBuilder;
+import jdk.javadoc.internal.doclets.toolkit.builders.BuilderFactory;
+import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
+import jdk.javadoc.internal.doclets.toolkit.util.UncheckedDocletException;
+import jdk.javadoc.internal.doclets.toolkit.util.InternalException;
+import jdk.javadoc.internal.doclets.toolkit.util.PackageListWriter;
+import jdk.javadoc.internal.doclets.toolkit.util.ResourceIOException;
+import jdk.javadoc.internal.doclets.toolkit.util.SimpleDocletException;
+import jdk.javadoc.internal.doclets.toolkit.util.Utils;
+
+import static javax.tools.Diagnostic.Kind.*;
+
+/**
+ * An abstract implementation of a Doclet.
+ *
+ * <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 Jamie Ho
+ */
+public abstract class AbstractDoclet implements Doclet {
+
+ /**
+ * The global configuration information for this run.
+ */
+ private BaseConfiguration configuration;
+
+ protected Messages messages;
+
+ /*
+ * a handle to our utility methods
+ */
+ protected Utils utils;
+
+ /**
+ * The only doclet that may use this toolkit is {@value}
+ */
+ private static final String TOOLKIT_DOCLET_NAME =
+ jdk.javadoc.internal.doclets.formats.html.HtmlDoclet.class.getName();
+
+ /**
+ * Verify that the only doclet that is using this toolkit is
+ * {@value #TOOLKIT_DOCLET_NAME}.
+ */
+ private boolean isValidDoclet() {
+ if (!getClass().getName().equals(TOOLKIT_DOCLET_NAME)) {
+ messages.error("doclet.Toolkit_Usage_Violation",
+ TOOLKIT_DOCLET_NAME);
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * The method that starts the execution of the doclet.
+ *
+ * @param docEnv the {@link DocletEnvironment}.
+ * @return true if the doclet executed without error. False otherwise.
+ */
+ @Override
+ public boolean run(DocletEnvironment docEnv) {
+ configuration = getConfiguration();
+ configuration.initConfiguration(docEnv);
+ configuration.cmtUtils = new CommentUtils(configuration);
+ configuration.utils = new Utils(configuration);
+ utils = configuration.utils;
+ configuration.workArounds = new WorkArounds(configuration);
+ messages = configuration.getMessages();
+
+ if (!isValidDoclet()) {
+ return false;
+ }
+
+ try {
+ try {
+ startGeneration(docEnv);
+ return true;
+ } catch (UncheckedDocletException e) {
+ throw (DocletException) e.getCause();
+ }
+
+ } catch (DocFileIOException e) {
+ switch (e.mode) {
+ case READ:
+ messages.error("doclet.exception.read.file",
+ e.fileName.getPath(), e.getCause());
+ break;
+ case WRITE:
+ messages.error("doclet.exception.write.file",
+ e.fileName.getPath(), e.getCause());
+ }
+ dumpStack(configuration.dumpOnError, e);
+
+ } catch (ResourceIOException e) {
+ messages.error("doclet.exception.read.resource",
+ e.resource.getPath(), e.getCause());
+ dumpStack(configuration.dumpOnError, e);
+
+ } catch (SimpleDocletException e) {
+ configuration.reporter.print(ERROR, e.getMessage());
+ dumpStack(configuration.dumpOnError, e);
+
+ } catch (InternalException e) {
+ configuration.reporter.print(ERROR, e.getMessage());
+ reportInternalError(e.getCause());
+
+ } catch (DocletException | RuntimeException | Error e) {
+ messages.error("doclet.internal.exception", e);
+ reportInternalError(e);
+ }
+
+ return false;
+ }
+
+ private void reportInternalError(Throwable t) {
+ if (getClass().equals(StandardDoclet.class) || getClass().equals(HtmlDoclet.class)) {
+ System.err.println(configuration.getResources().getText("doclet.internal.report.bug"));
+ }
+ dumpStack(true, t);
+ }
+
+ private void dumpStack(boolean enabled, Throwable t) {
+ if (enabled && t != null) {
+ t.printStackTrace(System.err);
+ }
+ }
+
+ /**
+ * Returns the SourceVersion indicating the features supported by this doclet.
+ *
+ * @return SourceVersion
+ */
+ @Override
+ public SourceVersion getSupportedSourceVersion() {
+ return SourceVersion.RELEASE_9;
+ }
+
+ /**
+ * Create the configuration instance and returns it.
+ *
+ * @return the configuration of the doclet.
+ */
+ public abstract BaseConfiguration getConfiguration();
+
+ /**
+ * Start the generation of files. Call generate methods in the individual
+ * writers, which will in turn generate the documentation files. Call the
+ * TreeWriter generation first to ensure the Class Hierarchy is built
+ * first and then can be used in the later generation.
+ *
+ * @see jdk.doclet.DocletEnvironment
+ * @throws DocletException if there is a problem while generating the documentation
+ */
+ private void startGeneration(DocletEnvironment docEnv) throws DocletException {
+ if (configuration.getIncludedTypeElements().isEmpty()) {
+ messages.error("doclet.No_Public_Classes_To_Document");
+ return;
+ }
+ if (!configuration.setOptions()) {
+ return;
+ }
+ messages.notice("doclet.build_version",
+ configuration.getDocletSpecificBuildDate());
+ ClassTree classtree = new ClassTree(configuration, configuration.nodeprecated);
+
+ generateClassFiles(docEnv, classtree);
+
+ PackageListWriter.generate(configuration);
+ generatePackageFiles(classtree);
+ generateModuleFiles();
+
+ generateOtherFiles(docEnv, classtree);
+ configuration.tagletManager.printReport();
+ }
+
+ /**
+ * Generate additional documentation that is added to the API documentation.
+ *
+ * @param docEnv the DocletEnvironment
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
+ */
+ protected void generateOtherFiles(DocletEnvironment docEnv, ClassTree classtree)
+ throws DocletException {
+ BuilderFactory builderFactory = configuration.getBuilderFactory();
+ AbstractBuilder constantsSummaryBuilder = builderFactory.getConstantsSummaryBuilder();
+ constantsSummaryBuilder.build();
+ AbstractBuilder serializedFormBuilder = builderFactory.getSerializedFormBuilder();
+ serializedFormBuilder.build();
+ }
+
+ /**
+ * Generate the module documentation.
+ *
+ * @throws DocletException if there is a problem while generating the documentation
+ *
+ */
+ protected abstract void generateModuleFiles() throws DocletException;
+
+ /**
+ * Generate the package documentation.
+ *
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
+ */
+ protected abstract void generatePackageFiles(ClassTree classtree) throws DocletException;
+
+ /**
+ * Generate the class documentation.
+ *
+ * @param arr the set of types to be documented
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
+ */
+ protected abstract void generateClassFiles(SortedSet<TypeElement> arr, ClassTree classtree)
+ throws DocletException;
+
+ /**
+ * Iterate through all classes and construct documentation for them.
+ *
+ * @param docEnv the DocletEnvironment
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
+ */
+ protected void generateClassFiles(DocletEnvironment docEnv, ClassTree classtree)
+ throws DocletException {
+ generateClassFiles(classtree);
+ SortedSet<PackageElement> packages = new TreeSet<>(utils.makePackageComparator());
+ packages.addAll(configuration.getSpecifiedPackageElements());
+ configuration.modulePackages.values().stream().forEach(packages::addAll);
+ for (PackageElement pkg : packages) {
+ generateClassFiles(utils.getAllClasses(pkg), classtree);
+ }
+ }
+
+ /**
+ * Generate the class files for single classes specified on the command line.
+ *
+ * @param classtree the data structure representing the class tree
+ * @throws DocletException if there is a problem while generating the documentation
+ */
+ private void generateClassFiles(ClassTree classtree) throws DocletException {
+ SortedSet<PackageElement> packages = configuration.typeElementCatalog.packages();
+ for (PackageElement pkg : packages) {
+ generateClassFiles(configuration.typeElementCatalog.allClasses(pkg), classtree);
+ }
+ }
+}