Mercurial > jdk8-mips64-public > langtools / file revision

 /*

  * Copyright (c) 2012, 2013, 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.javadoc.api;

 import java.io.InputStream;

 import java.io.OutputStream;

 import java.io.OutputStreamWriter;

 import java.io.PrintWriter;

 import java.io.Writer;

 import java.nio.charset.Charset;

 import java.util.Collections;

 import java.util.EnumSet;

 import java.util.Locale;

 import java.util.Set;

 import javax.lang.model.SourceVersion;

 import javax.tools.DiagnosticListener;

 import javax.tools.DocumentationTool;

 import javax.tools.JavaFileManager;

 import javax.tools.JavaFileObject;

 import javax.tools.StandardJavaFileManager;

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

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

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

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

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

 import com.sun.tools.javadoc.ToolOption;

 /**

  * Provides access to functionality specific to the JDK documentation tool,

  * javadoc.

  *

  * <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 JavadocTool implements DocumentationTool {

     @Override

     public DocumentationTask getTask(

             Writer out,

             JavaFileManager fileManager,

             DiagnosticListener<? super JavaFileObject> diagnosticListener,

             Class<?> docletClass,

             Iterable<String> options,

             Iterable<? extends JavaFileObject> compilationUnits) {

         Context context = new Context();

         return getTask(out, fileManager, diagnosticListener,

                 docletClass, options, compilationUnits, context);

     }

     public DocumentationTask getTask(

             Writer out,

             JavaFileManager fileManager,

             DiagnosticListener<? super JavaFileObject> diagnosticListener,

             Class<?> docletClass,

             Iterable<String> options,

             Iterable<? extends JavaFileObject> compilationUnits,

             Context context) {

         try {

             ClientCodeWrapper ccw = ClientCodeWrapper.instance(context);

             if (options != null) {

                 for (String option : options)

                     option.getClass(); // null check

             }

             if (compilationUnits != null) {

                 compilationUnits = ccw.wrapJavaFileObjects(compilationUnits); // implicit null check

                 for (JavaFileObject cu : compilationUnits) {

                     if (cu.getKind() != JavaFileObject.Kind.SOURCE) {

                         final String kindMsg = "All compilation units must be of SOURCE kind";

                         throw new IllegalArgumentException(kindMsg);

                     }

                 }

             }

             if (diagnosticListener != null)

                 context.put(DiagnosticListener.class, ccw.wrap(diagnosticListener));

             if (out == null)

                 context.put(Log.outKey, new PrintWriter(System.err, true));

             else if (out instanceof PrintWriter)

                 context.put(Log.outKey, ((PrintWriter) out));

             else

                 context.put(Log.outKey, new PrintWriter(out, true));

             if (fileManager == null)

                 fileManager = getStandardFileManager(diagnosticListener, null, null);

             fileManager = ccw.wrap(fileManager);

             context.put(JavaFileManager.class, fileManager);

             return new JavadocTaskImpl(context, docletClass, options, compilationUnits);

         } catch (ClientCodeException ex) {

             throw new RuntimeException(ex.getCause());

         }

     }

     // TODO: used shared static method in JavacFileManager

     @Override

     public StandardJavaFileManager getStandardFileManager(

             DiagnosticListener<? super JavaFileObject> diagnosticListener,

             Locale locale,

             Charset charset) {

         Context context = new Context();

         context.put(Locale.class, locale);

         if (diagnosticListener != null)

             context.put(DiagnosticListener.class, diagnosticListener);

         PrintWriter pw = (charset == null)

                 ? new PrintWriter(System.err, true)

                 : new PrintWriter(new OutputStreamWriter(System.err, charset), true);

         context.put(Log.outKey, pw);

         return new JavacFileManager(context, true, charset);

     }

     @Override

     public int run(InputStream in, OutputStream out, OutputStream err, String... arguments) {

         PrintWriter err_pw = new PrintWriter(err == null ? System.err : err, true);

         PrintWriter out_pw = new PrintWriter(out == null ? System.out : out);

         try {

             String standardDocletName = "com.sun.tools.doclets.standard.Standard";

             ClassLoader cl = getClass().getClassLoader();

             return com.sun.tools.javadoc.Main.execute(

                     "javadoc", err_pw, err_pw, out_pw, standardDocletName, cl, arguments);

         } finally {

             err_pw.flush();

             out_pw.flush();

         }

     }

     @Override

     public Set<SourceVersion> getSourceVersions() {

         return Collections.unmodifiableSet(

                 EnumSet.range(SourceVersion.RELEASE_3, SourceVersion.latest()));

     }

     @Override

     public int isSupportedOption(String option) {

         if (option == null)

             throw new NullPointerException();

         for (ToolOption o: ToolOption.values()) {

             if (o.opt.equals(option))

                 return o.hasArg ? 1 : 0;

         }

         return -1;

     }

 }