duke@1: /*
jjg@912:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javadoc;
duke@1: 
duke@1: import java.io.IOException;
jjg@197: import java.util.Locale;
jjg@197: import javax.tools.JavaFileObject;
jjg@197: import javax.tools.StandardJavaFileManager;
duke@1: 
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: import com.sun.tools.javac.tree.JCTree.JCClassDecl;
duke@1: import com.sun.tools.javac.util.List;
duke@1: import com.sun.tools.javac.util.ListBuffer;
duke@1: import com.sun.tools.javac.util.Position;
duke@1: 
duke@1: /**
duke@1:  * This class holds the information from one run of javadoc.
duke@1:  * Particularly the packages, classes and options specified
duke@1:  * by the user..
duke@1:  *
duke@1:  * @since 1.2
duke@1:  * @author Robert Field
duke@1:  * @author Atul M Dambalkar
duke@1:  * @author Neal Gafter (rewrite)
duke@1:  */
duke@1: public class RootDocImpl extends DocImpl implements RootDoc {
duke@1: 
duke@1:     /**
duke@1:      * list of classes specified on the command line.
duke@1:      */
duke@1:     private List<ClassDocImpl> cmdLineClasses;
duke@1: 
duke@1:     /**
duke@1:      * list of packages specified on the command line.
duke@1:      */
duke@1:     private List<PackageDocImpl> cmdLinePackages;
duke@1: 
duke@1:     /**
duke@1:      * a collection of all options.
duke@1:      */
duke@1:     private List<String[]> options;
duke@1: 
duke@1:     /**
duke@1:      * Constructor used when reading source files.
duke@1:      *
duke@1:      * @param env the documentation environment, state for this javadoc run
duke@1:      * @param classes list of classes specified on the commandline
duke@1:      * @param packages list of package names specified on the commandline
duke@1:      * @param options list of options
duke@1:      */
duke@1:     public RootDocImpl(DocEnv env, List<JCClassDecl> classes, List<String> packages, List<String[]> options) {
duke@1:         super(env, null);
duke@1:         this.options = options;
duke@1:         setPackages(env, packages);
duke@1:         setClasses(env, classes);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Constructor used when reading class files.
duke@1:      *
duke@1:      * @param env the documentation environment, state for this javadoc run
duke@1:      * @param classes list of class names specified on the commandline
duke@1:      * @param options list of options
duke@1:      */
duke@1:     public RootDocImpl(DocEnv env, List<String> classes, List<String[]> options) {
duke@1:         super(env, null);
duke@1:         this.options = options;
duke@1:         cmdLinePackages = List.nil();
duke@1:         ListBuffer<ClassDocImpl> classList = new ListBuffer<ClassDocImpl>();
duke@1:         for (String className : classes) {
duke@1:             ClassDocImpl c = env.loadClass(className);
duke@1:             if (c == null)
duke@1:                 env.error(null, "javadoc.class_not_found", className);
duke@1:             else
duke@1:                 classList = classList.append(c);
duke@1:         }
duke@1:         cmdLineClasses = classList.toList();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Initialize classes information. Those classes are input from
duke@1:      * command line.
duke@1:      *
duke@1:      * @param env the compilation environment
duke@1:      * @param classes a list of ClassDeclaration
duke@1:      */
duke@1:     private void setClasses(DocEnv env, List<JCClassDecl> classes) {
duke@1:         ListBuffer<ClassDocImpl> result = new ListBuffer<ClassDocImpl>();
duke@1:         for (JCClassDecl def : classes) {
duke@1:             //### Do we want modifier check here?
duke@1:             if (env.shouldDocument(def.sym)) {
duke@1:                 ClassDocImpl cd = env.getClassDoc(def.sym);
duke@1:                 if (cd != null) {
duke@1:                     cd.isIncluded = true;
duke@1:                     result.append(cd);
duke@1:                 } //else System.out.println(" (classdoc is null)");//DEBUG
duke@1:             } //else System.out.println(" (env.shouldDocument() returned false)");//DEBUG
duke@1:         }
duke@1:         cmdLineClasses = result.toList();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Initialize packages information.
duke@1:      *
duke@1:      * @param env the compilation environment
duke@1:      * @param packages a list of package names (String)
duke@1:      */
duke@1:     private void setPackages(DocEnv env, List<String> packages) {
duke@1:         ListBuffer<PackageDocImpl> packlist = new ListBuffer<PackageDocImpl>();
duke@1:         for (String name : packages) {
duke@1:             PackageDocImpl pkg = env.lookupPackage(name);
duke@1:             if (pkg != null) {
duke@1:                 pkg.isIncluded = true;
duke@1:                 packlist.append(pkg);
duke@1:             } else {
duke@1:                 env.warning(null, "main.no_source_files_for_package", name);
duke@1:             }
duke@1:         }
duke@1:         cmdLinePackages = packlist.toList();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Command line options.
duke@1:      *
duke@1:      * <pre>
duke@1:      * For example, given:
duke@1:      *     javadoc -foo this that -bar other ...
duke@1:      *
duke@1:      * This method will return:
duke@1:      *      options()[0][0] = "-foo"
duke@1:      *      options()[0][1] = "this"
duke@1:      *      options()[0][2] = "that"
duke@1:      *      options()[1][0] = "-bar"
duke@1:      *      options()[1][1] = "other"
duke@1:      * </pre>
duke@1:      *
duke@1:      * @return an array of arrays of String.
duke@1:      */
duke@1:     public String[][] options() {
duke@1:         return options.toArray(new String[options.length()][]);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Packages specified on the command line.
duke@1:      */
duke@1:     public PackageDoc[] specifiedPackages() {
duke@1:         return (PackageDoc[])cmdLinePackages
duke@1:             .toArray(new PackageDocImpl[cmdLinePackages.length()]);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Classes and interfaces specified on the command line.
duke@1:      */
duke@1:     public ClassDoc[] specifiedClasses() {
duke@1:         ListBuffer<ClassDocImpl> classesToDocument = new ListBuffer<ClassDocImpl>();
duke@1:         for (ClassDocImpl cd : cmdLineClasses) {
duke@1:             cd.addAllClasses(classesToDocument, true);
duke@1:         }
duke@1:         return (ClassDoc[])classesToDocument.toArray(new ClassDocImpl[classesToDocument.length()]);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return all classes and interfaces (including those inside
duke@1:      * packages) to be documented.
duke@1:      */
duke@1:     public ClassDoc[] classes() {
duke@1:         ListBuffer<ClassDocImpl> classesToDocument = new ListBuffer<ClassDocImpl>();
duke@1:         for (ClassDocImpl cd : cmdLineClasses) {
duke@1:             cd.addAllClasses(classesToDocument, true);
duke@1:         }
duke@1:         for (PackageDocImpl pd : cmdLinePackages) {
duke@1:             pd.addAllClassesTo(classesToDocument);
duke@1:         }
duke@1:         return classesToDocument.toArray(new ClassDocImpl[classesToDocument.length()]);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return a ClassDoc for the specified class/interface name
duke@1:      *
duke@1:      * @param qualifiedName qualified class name
duke@1:      *                        (i.e. includes package name).
duke@1:      *
duke@1:      * @return a ClassDocImpl holding the specified class, null if
duke@1:      * this class is not referenced.
duke@1:      */
duke@1:     public ClassDoc classNamed(String qualifiedName) {
duke@1:         return env.lookupClass(qualifiedName);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return a PackageDoc for the specified package name
duke@1:      *
duke@1:      * @param name package name
duke@1:      *
duke@1:      * @return a PackageDoc holding the specified package, null if
duke@1:      * this package is not referenced.
duke@1:      */
duke@1:     public PackageDoc packageNamed(String name) {
duke@1:         return env.lookupPackage(name);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the name of this Doc item.
duke@1:      *
duke@1:      * @return the string <code>"*RootDocImpl*"</code>.
duke@1:      */
duke@1:     public String name() {
duke@1:         return "*RootDocImpl*";
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the name of this Doc item.
duke@1:      *
duke@1:      * @return the string <code>"*RootDocImpl*"</code>.
duke@1:      */
duke@1:     public String qualifiedName() {
duke@1:         return "*RootDocImpl*";
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this Doc is include in the active set.
duke@1:      * RootDocImpl isn't even a program entity so it is always false.
duke@1:      */
duke@1:     public boolean isIncluded() {
duke@1:         return false;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     public void printError(String msg) {
duke@1:         env.printError(msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print error message, increment error count.
duke@1:      *
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     public void printError(SourcePosition pos, String msg) {
duke@1:         env.printError(pos, msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     public void printWarning(String msg) {
duke@1:         env.printWarning(msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print warning message, increment warning count.
duke@1:      *
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     public void printWarning(SourcePosition pos, String msg) {
duke@1:         env.printWarning(pos, msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     public void printNotice(String msg) {
duke@1:         env.printNotice(msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print a message.
duke@1:      *
duke@1:      * @param msg message to print
duke@1:      */
duke@1:     public void printNotice(SourcePosition pos, String msg) {
duke@1:         env.printNotice(pos, msg);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the path of the overview file and null if it does not exist.
duke@1:      * @return the path of the overview file and null if it does not exist.
duke@1:      */
jjg@197:     private JavaFileObject getOverviewPath() {
duke@1:         for (String[] opt : options) {
duke@1:             if (opt[0].equals("-overview")) {
jjg@197:                 if (env.fileManager instanceof StandardJavaFileManager) {
jjg@197:                     StandardJavaFileManager fm = (StandardJavaFileManager) env.fileManager;
jjg@197:                     return fm.getJavaFileObjects(opt[1]).iterator().next();
jjg@197:                 }
duke@1:             }
duke@1:         }
duke@1:         return null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Do lazy initialization of "documentation" string.
duke@1:      */
jjg@912:     @Override
duke@1:     protected String documentation() {
duke@1:         if (documentation == null) {
duke@1:             int cnt = options.length();
jjg@197:             JavaFileObject overviewPath = getOverviewPath();
duke@1:             if (overviewPath == null) {
duke@1:                 // no doc file to be had
duke@1:                 documentation = "";
duke@1:             } else {
duke@1:                 // read from file
duke@1:                 try {
duke@1:                     documentation = readHTMLDocumentation(
jjg@197:                         overviewPath.openInputStream(),
duke@1:                         overviewPath);
duke@1:                 } catch (IOException exc) {
duke@1:                     documentation = "";
jjg@197:                     env.error(null, "javadoc.File_Read_Error", overviewPath.getName());
duke@1:                 }
duke@1:             }
duke@1:         }
duke@1:         return documentation;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the source position of the entity, or null if
duke@1:      * no position is available.
duke@1:      */
jjg@912:     @Override
duke@1:     public SourcePosition position() {
jjg@197:         JavaFileObject path;
duke@1:         return ((path = getOverviewPath()) == null) ?
duke@1:             null :
duke@1:             SourcePositionImpl.make(path, Position.NOPOS, null);
duke@1:     }
bpatel@191: 
bpatel@191:     /**
bpatel@191:      * Return the locale provided by the user or the default locale value.
bpatel@191:      */
bpatel@191:     public Locale getLocale() {
bpatel@191:         return env.doclocale.locale;
bpatel@191:     }
duke@1: }