Tue, 11 Dec 2012 15:05:55 -0800
8004828: refactor init of *DocImpl classes
Reviewed-by: darcy
duke@1 | 1 | /* |
jjg@1359 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.javadoc; |
duke@1 | 27 | |
duke@1 | 28 | import java.io.IOException; |
jjg@197 | 29 | import java.util.Locale; |
jjg@1412 | 30 | import javax.tools.JavaFileManager; |
jjg@197 | 31 | import javax.tools.JavaFileObject; |
jjg@197 | 32 | import javax.tools.StandardJavaFileManager; |
duke@1 | 33 | |
duke@1 | 34 | import com.sun.javadoc.*; |
duke@1 | 35 | |
duke@1 | 36 | import com.sun.tools.javac.tree.JCTree.JCClassDecl; |
duke@1 | 37 | import com.sun.tools.javac.util.List; |
duke@1 | 38 | import com.sun.tools.javac.util.ListBuffer; |
duke@1 | 39 | import com.sun.tools.javac.util.Position; |
duke@1 | 40 | |
duke@1 | 41 | /** |
duke@1 | 42 | * This class holds the information from one run of javadoc. |
duke@1 | 43 | * Particularly the packages, classes and options specified |
jjg@1359 | 44 | * by the user. |
jjg@1359 | 45 | * |
jjg@1359 | 46 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 47 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 48 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 49 | * deletion without notice.</b> |
duke@1 | 50 | * |
duke@1 | 51 | * @since 1.2 |
duke@1 | 52 | * @author Robert Field |
duke@1 | 53 | * @author Atul M Dambalkar |
duke@1 | 54 | * @author Neal Gafter (rewrite) |
duke@1 | 55 | */ |
duke@1 | 56 | public class RootDocImpl extends DocImpl implements RootDoc { |
duke@1 | 57 | |
duke@1 | 58 | /** |
duke@1 | 59 | * list of classes specified on the command line. |
duke@1 | 60 | */ |
duke@1 | 61 | private List<ClassDocImpl> cmdLineClasses; |
duke@1 | 62 | |
duke@1 | 63 | /** |
duke@1 | 64 | * list of packages specified on the command line. |
duke@1 | 65 | */ |
duke@1 | 66 | private List<PackageDocImpl> cmdLinePackages; |
duke@1 | 67 | |
duke@1 | 68 | /** |
duke@1 | 69 | * a collection of all options. |
duke@1 | 70 | */ |
duke@1 | 71 | private List<String[]> options; |
duke@1 | 72 | |
duke@1 | 73 | /** |
duke@1 | 74 | * Constructor used when reading source files. |
duke@1 | 75 | * |
duke@1 | 76 | * @param env the documentation environment, state for this javadoc run |
duke@1 | 77 | * @param classes list of classes specified on the commandline |
duke@1 | 78 | * @param packages list of package names specified on the commandline |
duke@1 | 79 | * @param options list of options |
duke@1 | 80 | */ |
duke@1 | 81 | public RootDocImpl(DocEnv env, List<JCClassDecl> classes, List<String> packages, List<String[]> options) { |
duke@1 | 82 | super(env, null); |
duke@1 | 83 | this.options = options; |
duke@1 | 84 | setPackages(env, packages); |
duke@1 | 85 | setClasses(env, classes); |
duke@1 | 86 | } |
duke@1 | 87 | |
duke@1 | 88 | /** |
duke@1 | 89 | * Constructor used when reading class files. |
duke@1 | 90 | * |
duke@1 | 91 | * @param env the documentation environment, state for this javadoc run |
duke@1 | 92 | * @param classes list of class names specified on the commandline |
duke@1 | 93 | * @param options list of options |
duke@1 | 94 | */ |
duke@1 | 95 | public RootDocImpl(DocEnv env, List<String> classes, List<String[]> options) { |
duke@1 | 96 | super(env, null); |
duke@1 | 97 | this.options = options; |
duke@1 | 98 | cmdLinePackages = List.nil(); |
duke@1 | 99 | ListBuffer<ClassDocImpl> classList = new ListBuffer<ClassDocImpl>(); |
duke@1 | 100 | for (String className : classes) { |
duke@1 | 101 | ClassDocImpl c = env.loadClass(className); |
duke@1 | 102 | if (c == null) |
duke@1 | 103 | env.error(null, "javadoc.class_not_found", className); |
duke@1 | 104 | else |
duke@1 | 105 | classList = classList.append(c); |
duke@1 | 106 | } |
duke@1 | 107 | cmdLineClasses = classList.toList(); |
duke@1 | 108 | } |
duke@1 | 109 | |
duke@1 | 110 | /** |
duke@1 | 111 | * Initialize classes information. Those classes are input from |
duke@1 | 112 | * command line. |
duke@1 | 113 | * |
duke@1 | 114 | * @param env the compilation environment |
duke@1 | 115 | * @param classes a list of ClassDeclaration |
duke@1 | 116 | */ |
duke@1 | 117 | private void setClasses(DocEnv env, List<JCClassDecl> classes) { |
duke@1 | 118 | ListBuffer<ClassDocImpl> result = new ListBuffer<ClassDocImpl>(); |
duke@1 | 119 | for (JCClassDecl def : classes) { |
duke@1 | 120 | //### Do we want modifier check here? |
duke@1 | 121 | if (env.shouldDocument(def.sym)) { |
duke@1 | 122 | ClassDocImpl cd = env.getClassDoc(def.sym); |
duke@1 | 123 | if (cd != null) { |
duke@1 | 124 | cd.isIncluded = true; |
duke@1 | 125 | result.append(cd); |
duke@1 | 126 | } //else System.out.println(" (classdoc is null)");//DEBUG |
duke@1 | 127 | } //else System.out.println(" (env.shouldDocument() returned false)");//DEBUG |
duke@1 | 128 | } |
duke@1 | 129 | cmdLineClasses = result.toList(); |
duke@1 | 130 | } |
duke@1 | 131 | |
duke@1 | 132 | /** |
duke@1 | 133 | * Initialize packages information. |
duke@1 | 134 | * |
duke@1 | 135 | * @param env the compilation environment |
duke@1 | 136 | * @param packages a list of package names (String) |
duke@1 | 137 | */ |
duke@1 | 138 | private void setPackages(DocEnv env, List<String> packages) { |
duke@1 | 139 | ListBuffer<PackageDocImpl> packlist = new ListBuffer<PackageDocImpl>(); |
duke@1 | 140 | for (String name : packages) { |
duke@1 | 141 | PackageDocImpl pkg = env.lookupPackage(name); |
duke@1 | 142 | if (pkg != null) { |
duke@1 | 143 | pkg.isIncluded = true; |
duke@1 | 144 | packlist.append(pkg); |
duke@1 | 145 | } else { |
duke@1 | 146 | env.warning(null, "main.no_source_files_for_package", name); |
duke@1 | 147 | } |
duke@1 | 148 | } |
duke@1 | 149 | cmdLinePackages = packlist.toList(); |
duke@1 | 150 | } |
duke@1 | 151 | |
duke@1 | 152 | /** |
duke@1 | 153 | * Command line options. |
duke@1 | 154 | * |
duke@1 | 155 | * <pre> |
duke@1 | 156 | * For example, given: |
duke@1 | 157 | * javadoc -foo this that -bar other ... |
duke@1 | 158 | * |
duke@1 | 159 | * This method will return: |
duke@1 | 160 | * options()[0][0] = "-foo" |
duke@1 | 161 | * options()[0][1] = "this" |
duke@1 | 162 | * options()[0][2] = "that" |
duke@1 | 163 | * options()[1][0] = "-bar" |
duke@1 | 164 | * options()[1][1] = "other" |
duke@1 | 165 | * </pre> |
duke@1 | 166 | * |
duke@1 | 167 | * @return an array of arrays of String. |
duke@1 | 168 | */ |
duke@1 | 169 | public String[][] options() { |
duke@1 | 170 | return options.toArray(new String[options.length()][]); |
duke@1 | 171 | } |
duke@1 | 172 | |
duke@1 | 173 | /** |
duke@1 | 174 | * Packages specified on the command line. |
duke@1 | 175 | */ |
duke@1 | 176 | public PackageDoc[] specifiedPackages() { |
duke@1 | 177 | return (PackageDoc[])cmdLinePackages |
duke@1 | 178 | .toArray(new PackageDocImpl[cmdLinePackages.length()]); |
duke@1 | 179 | } |
duke@1 | 180 | |
duke@1 | 181 | /** |
duke@1 | 182 | * Classes and interfaces specified on the command line. |
duke@1 | 183 | */ |
duke@1 | 184 | public ClassDoc[] specifiedClasses() { |
duke@1 | 185 | ListBuffer<ClassDocImpl> classesToDocument = new ListBuffer<ClassDocImpl>(); |
duke@1 | 186 | for (ClassDocImpl cd : cmdLineClasses) { |
duke@1 | 187 | cd.addAllClasses(classesToDocument, true); |
duke@1 | 188 | } |
duke@1 | 189 | return (ClassDoc[])classesToDocument.toArray(new ClassDocImpl[classesToDocument.length()]); |
duke@1 | 190 | } |
duke@1 | 191 | |
duke@1 | 192 | /** |
duke@1 | 193 | * Return all classes and interfaces (including those inside |
duke@1 | 194 | * packages) to be documented. |
duke@1 | 195 | */ |
duke@1 | 196 | public ClassDoc[] classes() { |
duke@1 | 197 | ListBuffer<ClassDocImpl> classesToDocument = new ListBuffer<ClassDocImpl>(); |
duke@1 | 198 | for (ClassDocImpl cd : cmdLineClasses) { |
duke@1 | 199 | cd.addAllClasses(classesToDocument, true); |
duke@1 | 200 | } |
duke@1 | 201 | for (PackageDocImpl pd : cmdLinePackages) { |
duke@1 | 202 | pd.addAllClassesTo(classesToDocument); |
duke@1 | 203 | } |
duke@1 | 204 | return classesToDocument.toArray(new ClassDocImpl[classesToDocument.length()]); |
duke@1 | 205 | } |
duke@1 | 206 | |
duke@1 | 207 | /** |
duke@1 | 208 | * Return a ClassDoc for the specified class/interface name |
duke@1 | 209 | * |
duke@1 | 210 | * @param qualifiedName qualified class name |
duke@1 | 211 | * (i.e. includes package name). |
duke@1 | 212 | * |
duke@1 | 213 | * @return a ClassDocImpl holding the specified class, null if |
duke@1 | 214 | * this class is not referenced. |
duke@1 | 215 | */ |
duke@1 | 216 | public ClassDoc classNamed(String qualifiedName) { |
duke@1 | 217 | return env.lookupClass(qualifiedName); |
duke@1 | 218 | } |
duke@1 | 219 | |
duke@1 | 220 | /** |
duke@1 | 221 | * Return a PackageDoc for the specified package name |
duke@1 | 222 | * |
duke@1 | 223 | * @param name package name |
duke@1 | 224 | * |
duke@1 | 225 | * @return a PackageDoc holding the specified package, null if |
duke@1 | 226 | * this package is not referenced. |
duke@1 | 227 | */ |
duke@1 | 228 | public PackageDoc packageNamed(String name) { |
duke@1 | 229 | return env.lookupPackage(name); |
duke@1 | 230 | } |
duke@1 | 231 | |
duke@1 | 232 | /** |
duke@1 | 233 | * Return the name of this Doc item. |
duke@1 | 234 | * |
duke@1 | 235 | * @return the string <code>"*RootDocImpl*"</code>. |
duke@1 | 236 | */ |
duke@1 | 237 | public String name() { |
duke@1 | 238 | return "*RootDocImpl*"; |
duke@1 | 239 | } |
duke@1 | 240 | |
duke@1 | 241 | /** |
duke@1 | 242 | * Return the name of this Doc item. |
duke@1 | 243 | * |
duke@1 | 244 | * @return the string <code>"*RootDocImpl*"</code>. |
duke@1 | 245 | */ |
duke@1 | 246 | public String qualifiedName() { |
duke@1 | 247 | return "*RootDocImpl*"; |
duke@1 | 248 | } |
duke@1 | 249 | |
duke@1 | 250 | /** |
duke@1 | 251 | * Return true if this Doc is include in the active set. |
duke@1 | 252 | * RootDocImpl isn't even a program entity so it is always false. |
duke@1 | 253 | */ |
duke@1 | 254 | public boolean isIncluded() { |
duke@1 | 255 | return false; |
duke@1 | 256 | } |
duke@1 | 257 | |
duke@1 | 258 | /** |
duke@1 | 259 | * Print error message, increment error count. |
duke@1 | 260 | * |
duke@1 | 261 | * @param msg message to print |
duke@1 | 262 | */ |
duke@1 | 263 | public void printError(String msg) { |
duke@1 | 264 | env.printError(msg); |
duke@1 | 265 | } |
duke@1 | 266 | |
duke@1 | 267 | /** |
duke@1 | 268 | * Print error message, increment error count. |
duke@1 | 269 | * |
duke@1 | 270 | * @param msg message to print |
duke@1 | 271 | */ |
duke@1 | 272 | public void printError(SourcePosition pos, String msg) { |
duke@1 | 273 | env.printError(pos, msg); |
duke@1 | 274 | } |
duke@1 | 275 | |
duke@1 | 276 | /** |
duke@1 | 277 | * Print warning message, increment warning count. |
duke@1 | 278 | * |
duke@1 | 279 | * @param msg message to print |
duke@1 | 280 | */ |
duke@1 | 281 | public void printWarning(String msg) { |
duke@1 | 282 | env.printWarning(msg); |
duke@1 | 283 | } |
duke@1 | 284 | |
duke@1 | 285 | /** |
duke@1 | 286 | * Print warning message, increment warning count. |
duke@1 | 287 | * |
duke@1 | 288 | * @param msg message to print |
duke@1 | 289 | */ |
duke@1 | 290 | public void printWarning(SourcePosition pos, String msg) { |
duke@1 | 291 | env.printWarning(pos, msg); |
duke@1 | 292 | } |
duke@1 | 293 | |
duke@1 | 294 | /** |
duke@1 | 295 | * Print a message. |
duke@1 | 296 | * |
duke@1 | 297 | * @param msg message to print |
duke@1 | 298 | */ |
duke@1 | 299 | public void printNotice(String msg) { |
duke@1 | 300 | env.printNotice(msg); |
duke@1 | 301 | } |
duke@1 | 302 | |
duke@1 | 303 | /** |
duke@1 | 304 | * Print a message. |
duke@1 | 305 | * |
duke@1 | 306 | * @param msg message to print |
duke@1 | 307 | */ |
duke@1 | 308 | public void printNotice(SourcePosition pos, String msg) { |
duke@1 | 309 | env.printNotice(pos, msg); |
duke@1 | 310 | } |
duke@1 | 311 | |
duke@1 | 312 | /** |
duke@1 | 313 | * Return the path of the overview file and null if it does not exist. |
duke@1 | 314 | * @return the path of the overview file and null if it does not exist. |
duke@1 | 315 | */ |
jjg@197 | 316 | private JavaFileObject getOverviewPath() { |
duke@1 | 317 | for (String[] opt : options) { |
duke@1 | 318 | if (opt[0].equals("-overview")) { |
jjg@197 | 319 | if (env.fileManager instanceof StandardJavaFileManager) { |
jjg@197 | 320 | StandardJavaFileManager fm = (StandardJavaFileManager) env.fileManager; |
jjg@197 | 321 | return fm.getJavaFileObjects(opt[1]).iterator().next(); |
jjg@197 | 322 | } |
duke@1 | 323 | } |
duke@1 | 324 | } |
duke@1 | 325 | return null; |
duke@1 | 326 | } |
duke@1 | 327 | |
duke@1 | 328 | /** |
duke@1 | 329 | * Do lazy initialization of "documentation" string. |
duke@1 | 330 | */ |
jjg@912 | 331 | @Override |
duke@1 | 332 | protected String documentation() { |
duke@1 | 333 | if (documentation == null) { |
jjg@197 | 334 | JavaFileObject overviewPath = getOverviewPath(); |
duke@1 | 335 | if (overviewPath == null) { |
duke@1 | 336 | // no doc file to be had |
duke@1 | 337 | documentation = ""; |
duke@1 | 338 | } else { |
duke@1 | 339 | // read from file |
duke@1 | 340 | try { |
duke@1 | 341 | documentation = readHTMLDocumentation( |
jjg@197 | 342 | overviewPath.openInputStream(), |
duke@1 | 343 | overviewPath); |
duke@1 | 344 | } catch (IOException exc) { |
duke@1 | 345 | documentation = ""; |
jjg@197 | 346 | env.error(null, "javadoc.File_Read_Error", overviewPath.getName()); |
duke@1 | 347 | } |
duke@1 | 348 | } |
duke@1 | 349 | } |
duke@1 | 350 | return documentation; |
duke@1 | 351 | } |
duke@1 | 352 | |
duke@1 | 353 | /** |
duke@1 | 354 | * Return the source position of the entity, or null if |
duke@1 | 355 | * no position is available. |
duke@1 | 356 | */ |
jjg@912 | 357 | @Override |
duke@1 | 358 | public SourcePosition position() { |
jjg@197 | 359 | JavaFileObject path; |
duke@1 | 360 | return ((path = getOverviewPath()) == null) ? |
duke@1 | 361 | null : |
duke@1 | 362 | SourcePositionImpl.make(path, Position.NOPOS, null); |
duke@1 | 363 | } |
bpatel@191 | 364 | |
bpatel@191 | 365 | /** |
bpatel@191 | 366 | * Return the locale provided by the user or the default locale value. |
bpatel@191 | 367 | */ |
bpatel@191 | 368 | public Locale getLocale() { |
bpatel@191 | 369 | return env.doclocale.locale; |
bpatel@191 | 370 | } |
jjg@1412 | 371 | |
jjg@1412 | 372 | /** |
jjg@1412 | 373 | * Return the current file manager. |
jjg@1412 | 374 | */ |
jjg@1412 | 375 | public JavaFileManager getFileManager() { |
jjg@1412 | 376 | return env.fileManager; |
jjg@1412 | 377 | } |
duke@1 | 378 | } |