src/share/classes/com/sun/tools/javadoc/DocEnv.java

Mon, 18 Jul 2016 23:53:12 +0300

author
aefimov
date
Mon, 18 Jul 2016 23:53:12 +0300
changeset 3315
6f0746b6de9f
parent 2201
ef44a2971cb1
child 3446
e468915bad3a
permissions
-rw-r--r--

8138725: Add options for Javadoc generation
Reviewed-by: jjg

duke@1 1 /*
aefimov@3315 2 * Copyright (c) 2000, 2016, 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
jjg@197 28 import java.lang.reflect.Modifier;
duke@1 29 import java.util.*;
jjg@1443 30
jjg@197 31 import javax.tools.JavaFileManager;
duke@1 32
duke@1 33 import com.sun.javadoc.*;
jjg@1490 34 import com.sun.source.util.JavacTask;
jjg@1443 35 import com.sun.source.util.TreePath;
jjg@1490 36 import com.sun.tools.doclint.DocLint;
jjg@1490 37 import com.sun.tools.javac.api.BasicJavacTask;
duke@1 38 import com.sun.tools.javac.code.*;
duke@1 39 import com.sun.tools.javac.code.Symbol.*;
duke@1 40 import com.sun.tools.javac.code.Type.ClassType;
duke@1 41 import com.sun.tools.javac.comp.Check;
bpatel@2201 42 import com.sun.tools.javac.file.JavacFileManager;
jjg@1443 43 import com.sun.tools.javac.tree.JCTree;
duke@1 44 import com.sun.tools.javac.tree.JCTree.*;
duke@1 45 import com.sun.tools.javac.util.Context;
jjg@113 46 import com.sun.tools.javac.util.Names;
duke@1 47
duke@1 48 /**
duke@1 49 * Holds the environment for a run of javadoc.
duke@1 50 * Holds only the information needed throughout the
duke@1 51 * run and not the compiler info that could be GC'ed
duke@1 52 * or ported.
duke@1 53 *
jjg@1359 54 * <p><b>This is NOT part of any supported API.
jjg@1359 55 * If you write code that depends on this, you do so at your own risk.
jjg@1359 56 * This code and its internal interfaces are subject to change or
jjg@1359 57 * deletion without notice.</b>
jjg@1359 58 *
duke@1 59 * @since 1.4
duke@1 60 * @author Robert Field
duke@1 61 * @author Neal Gafter (rewrite)
duke@1 62 * @author Scott Seligman (generics)
duke@1 63 */
duke@1 64 public class DocEnv {
duke@1 65 protected static final Context.Key<DocEnv> docEnvKey =
duke@1 66 new Context.Key<DocEnv>();
duke@1 67
duke@1 68 public static DocEnv instance(Context context) {
duke@1 69 DocEnv instance = context.get(docEnvKey);
duke@1 70 if (instance == null)
duke@1 71 instance = new DocEnv(context);
duke@1 72 return instance;
duke@1 73 }
duke@1 74
duke@1 75 private Messager messager;
duke@1 76
duke@1 77 DocLocale doclocale;
duke@1 78
duke@1 79 /** Predefined symbols known to the compiler. */
duke@1 80 Symtab syms;
duke@1 81
duke@1 82 /** Referenced directly in RootDocImpl. */
duke@1 83 JavadocClassReader reader;
duke@1 84
duke@1 85 /** Javadoc's own version of the compiler's enter phase. */
duke@1 86 JavadocEnter enter;
duke@1 87
duke@1 88 /** The name table. */
aefimov@3315 89 private final Names names;
duke@1 90
duke@1 91 /** The encoding name. */
duke@1 92 private String encoding;
duke@1 93
duke@1 94 final Symbol externalizableSym;
duke@1 95
duke@1 96 /** Access filter (public, protected, ...). */
ksrini@1051 97 protected ModifierFilter showAccess;
duke@1 98
duke@1 99 /** True if we are using a sentence BreakIterator. */
duke@1 100 boolean breakiterator;
duke@1 101
duke@1 102 /**
duke@1 103 * True if we do not want to print any notifications at all.
duke@1 104 */
duke@1 105 boolean quiet = false;
duke@1 106
duke@1 107 Check chk;
duke@1 108 Types types;
jjg@197 109 JavaFileManager fileManager;
jjg@1409 110 Context context;
jjg@1490 111 DocLint doclint;
aefimov@3315 112 JavaScriptScanner javaScriptScanner;
duke@1 113
jjg@1443 114 WeakHashMap<JCTree, TreePath> treePaths = new WeakHashMap<JCTree, TreePath>();
jjg@1443 115
duke@1 116 /** Allow documenting from class files? */
duke@1 117 boolean docClasses = false;
duke@1 118
duke@1 119 /** Does the doclet only expect pre-1.5 doclet API? */
ksrini@1051 120 protected boolean legacyDoclet = true;
duke@1 121
duke@1 122 /**
duke@1 123 * Set this to true if you would like to not emit any errors, warnings and
duke@1 124 * notices.
duke@1 125 */
duke@1 126 private boolean silent = false;
duke@1 127
duke@1 128 /**
bpatel@1998 129 * The source language version.
bpatel@1998 130 */
bpatel@1998 131 protected Source source;
bpatel@1998 132
bpatel@1998 133 /**
duke@1 134 * Constructor
duke@1 135 *
duke@1 136 * @param context Context for this javadoc instance.
duke@1 137 */
ksrini@1051 138 protected DocEnv(Context context) {
duke@1 139 context.put(docEnvKey, this);
jjg@1409 140 this.context = context;
duke@1 141
duke@1 142 messager = Messager.instance0(context);
duke@1 143 syms = Symtab.instance(context);
duke@1 144 reader = JavadocClassReader.instance0(context);
duke@1 145 enter = JavadocEnter.instance0(context);
jjg@113 146 names = Names.instance(context);
duke@1 147 externalizableSym = reader.enterClass(names.fromString("java.io.Externalizable"));
duke@1 148 chk = Check.instance(context);
duke@1 149 types = Types.instance(context);
jjg@197 150 fileManager = context.get(JavaFileManager.class);
bpatel@2201 151 if (fileManager instanceof JavacFileManager) {
bpatel@2201 152 ((JavacFileManager)fileManager).setSymbolFileEnabled(false);
bpatel@2201 153 }
duke@1 154
duke@1 155 // Default. Should normally be reset with setLocale.
duke@1 156 this.doclocale = new DocLocale(this, "", breakiterator);
bpatel@1998 157 source = Source.instance(context);
duke@1 158 }
duke@1 159
duke@1 160 public void setSilent(boolean silent) {
duke@1 161 this.silent = silent;
duke@1 162 }
duke@1 163
duke@1 164 /**
duke@1 165 * Look up ClassDoc by qualified name.
duke@1 166 */
duke@1 167 public ClassDocImpl lookupClass(String name) {
duke@1 168 ClassSymbol c = getClassSymbol(name);
duke@1 169 if (c != null) {
duke@1 170 return getClassDoc(c);
duke@1 171 } else {
duke@1 172 return null;
duke@1 173 }
duke@1 174 }
duke@1 175
duke@1 176 /**
duke@1 177 * Load ClassDoc by qualified name.
duke@1 178 */
duke@1 179 public ClassDocImpl loadClass(String name) {
duke@1 180 try {
duke@1 181 ClassSymbol c = reader.loadClass(names.fromString(name));
duke@1 182 return getClassDoc(c);
duke@1 183 } catch (CompletionFailure ex) {
duke@1 184 chk.completionError(null, ex);
duke@1 185 return null;
duke@1 186 }
duke@1 187 }
duke@1 188
duke@1 189 /**
duke@1 190 * Look up PackageDoc by qualified name.
duke@1 191 */
duke@1 192 public PackageDocImpl lookupPackage(String name) {
duke@1 193 //### Jing alleges that class check is needed
duke@1 194 //### to avoid a compiler bug. Most likely
duke@1 195 //### instead a dummy created for error recovery.
duke@1 196 //### Should investigate this.
duke@1 197 PackageSymbol p = syms.packages.get(names.fromString(name));
duke@1 198 ClassSymbol c = getClassSymbol(name);
duke@1 199 if (p != null && c == null) {
duke@1 200 return getPackageDoc(p);
duke@1 201 } else {
duke@1 202 return null;
duke@1 203 }
duke@1 204 }
duke@1 205 // where
duke@1 206 /** Retrieve class symbol by fully-qualified name.
duke@1 207 */
duke@1 208 ClassSymbol getClassSymbol(String name) {
duke@1 209 // Name may contain nested class qualification.
duke@1 210 // Generate candidate flatnames with successively shorter
duke@1 211 // package qualifiers and longer nested class qualifiers.
duke@1 212 int nameLen = name.length();
duke@1 213 char[] nameChars = name.toCharArray();
duke@1 214 int idx = name.length();
duke@1 215 for (;;) {
duke@1 216 ClassSymbol s = syms.classes.get(names.fromChars(nameChars, 0, nameLen));
duke@1 217 if (s != null)
duke@1 218 return s; // found it!
duke@1 219 idx = name.substring(0, idx).lastIndexOf('.');
duke@1 220 if (idx < 0) break;
duke@1 221 nameChars[idx] = '$';
duke@1 222 }
duke@1 223 return null;
duke@1 224 }
duke@1 225
duke@1 226 /**
duke@1 227 * Set the locale.
duke@1 228 */
duke@1 229 public void setLocale(String localeName) {
duke@1 230 // create locale specifics
duke@1 231 doclocale = new DocLocale(this, localeName, breakiterator);
jjg@1411 232 // update Messager if locale has changed.
jjg@1411 233 messager.setLocale(doclocale.locale);
duke@1 234 }
duke@1 235
duke@1 236 /** Check whether this member should be documented. */
duke@1 237 public boolean shouldDocument(VarSymbol sym) {
duke@1 238 long mod = sym.flags();
duke@1 239
duke@1 240 if ((mod & Flags.SYNTHETIC) != 0) {
duke@1 241 return false;
duke@1 242 }
duke@1 243
duke@1 244 return showAccess.checkModifier(translateModifiers(mod));
duke@1 245 }
duke@1 246
duke@1 247 /** Check whether this member should be documented. */
duke@1 248 public boolean shouldDocument(MethodSymbol sym) {
duke@1 249 long mod = sym.flags();
duke@1 250
duke@1 251 if ((mod & Flags.SYNTHETIC) != 0) {
duke@1 252 return false;
duke@1 253 }
duke@1 254
duke@1 255 return showAccess.checkModifier(translateModifiers(mod));
duke@1 256 }
duke@1 257
duke@1 258 /** check whether this class should be documented. */
duke@1 259 public boolean shouldDocument(ClassSymbol sym) {
duke@1 260 return
duke@1 261 (sym.flags_field&Flags.SYNTHETIC) == 0 && // no synthetics
duke@1 262 (docClasses || getClassDoc(sym).tree != null) &&
duke@1 263 isVisible(sym);
duke@1 264 }
duke@1 265
duke@1 266 //### Comment below is inaccurate wrt modifier filter testing
duke@1 267 /**
duke@1 268 * Check the visibility if this is an nested class.
duke@1 269 * if this is not a nested class, return true.
duke@1 270 * if this is an static visible nested class,
duke@1 271 * return true.
duke@1 272 * if this is an visible nested class
duke@1 273 * if the outer class is visible return true.
duke@1 274 * else return false.
duke@1 275 * IMPORTANT: This also allows, static nested classes
duke@1 276 * to be defined inside an nested class, which is not
duke@1 277 * allowed by the compiler. So such an test case will
duke@1 278 * not reach upto this method itself, but if compiler
duke@1 279 * allows it, then that will go through.
duke@1 280 */
duke@1 281 protected boolean isVisible(ClassSymbol sym) {
duke@1 282 long mod = sym.flags_field;
duke@1 283 if (!showAccess.checkModifier(translateModifiers(mod))) {
duke@1 284 return false;
duke@1 285 }
duke@1 286 ClassSymbol encl = sym.owner.enclClass();
duke@1 287 return (encl == null || (mod & Flags.STATIC) != 0 || isVisible(encl));
duke@1 288 }
duke@1 289
duke@1 290 //---------------- print forwarders ----------------//
duke@1 291
duke@1 292 /**
duke@1 293 * Print error message, increment error count.
duke@1 294 *
duke@1 295 * @param msg message to print.
duke@1 296 */
duke@1 297 public void printError(String msg) {
duke@1 298 if (silent)
duke@1 299 return;
duke@1 300 messager.printError(msg);
duke@1 301 }
duke@1 302
duke@1 303 /**
duke@1 304 * Print error message, increment error count.
duke@1 305 *
duke@1 306 * @param key selects message from resource
duke@1 307 */
duke@1 308 public void error(DocImpl doc, String key) {
duke@1 309 if (silent)
duke@1 310 return;
duke@1 311 messager.error(doc==null ? null : doc.position(), key);
duke@1 312 }
duke@1 313
duke@1 314 /**
duke@1 315 * Print error message, increment error count.
duke@1 316 *
duke@1 317 * @param key selects message from resource
duke@1 318 */
duke@1 319 public void error(SourcePosition pos, String key) {
duke@1 320 if (silent)
duke@1 321 return;
duke@1 322 messager.error(pos, key);
duke@1 323 }
duke@1 324
duke@1 325 /**
duke@1 326 * Print error message, increment error count.
duke@1 327 *
duke@1 328 * @param msg message to print.
duke@1 329 */
duke@1 330 public void printError(SourcePosition pos, String msg) {
duke@1 331 if (silent)
duke@1 332 return;
duke@1 333 messager.printError(pos, msg);
duke@1 334 }
duke@1 335
duke@1 336 /**
duke@1 337 * Print error message, increment error count.
duke@1 338 *
duke@1 339 * @param key selects message from resource
duke@1 340 * @param a1 first argument
duke@1 341 */
duke@1 342 public void error(DocImpl doc, String key, String a1) {
duke@1 343 if (silent)
duke@1 344 return;
duke@1 345 messager.error(doc==null ? null : doc.position(), key, a1);
duke@1 346 }
duke@1 347
duke@1 348 /**
duke@1 349 * Print error message, increment error count.
duke@1 350 *
duke@1 351 * @param key selects message from resource
duke@1 352 * @param a1 first argument
duke@1 353 * @param a2 second argument
duke@1 354 */
duke@1 355 public void error(DocImpl doc, String key, String a1, String a2) {
duke@1 356 if (silent)
duke@1 357 return;
duke@1 358 messager.error(doc==null ? null : doc.position(), key, a1, a2);
duke@1 359 }
duke@1 360
duke@1 361 /**
duke@1 362 * Print error message, increment error count.
duke@1 363 *
duke@1 364 * @param key selects message from resource
duke@1 365 * @param a1 first argument
duke@1 366 * @param a2 second argument
duke@1 367 * @param a3 third argument
duke@1 368 */
duke@1 369 public void error(DocImpl doc, String key, String a1, String a2, String a3) {
duke@1 370 if (silent)
duke@1 371 return;
duke@1 372 messager.error(doc==null ? null : doc.position(), key, a1, a2, a3);
duke@1 373 }
duke@1 374
duke@1 375 /**
duke@1 376 * Print warning message, increment warning count.
duke@1 377 *
duke@1 378 * @param msg message to print.
duke@1 379 */
duke@1 380 public void printWarning(String msg) {
duke@1 381 if (silent)
duke@1 382 return;
duke@1 383 messager.printWarning(msg);
duke@1 384 }
duke@1 385
duke@1 386 /**
duke@1 387 * Print warning message, increment warning count.
duke@1 388 *
duke@1 389 * @param key selects message from resource
duke@1 390 */
duke@1 391 public void warning(DocImpl doc, String key) {
duke@1 392 if (silent)
duke@1 393 return;
duke@1 394 messager.warning(doc==null ? null : doc.position(), key);
duke@1 395 }
duke@1 396
duke@1 397 /**
duke@1 398 * Print warning message, increment warning count.
duke@1 399 *
duke@1 400 * @param msg message to print.
duke@1 401 */
duke@1 402 public void printWarning(SourcePosition pos, String msg) {
duke@1 403 if (silent)
duke@1 404 return;
duke@1 405 messager.printWarning(pos, msg);
duke@1 406 }
duke@1 407
duke@1 408 /**
duke@1 409 * Print warning message, increment warning count.
duke@1 410 *
duke@1 411 * @param key selects message from resource
duke@1 412 * @param a1 first argument
duke@1 413 */
duke@1 414 public void warning(DocImpl doc, String key, String a1) {
duke@1 415 if (silent)
duke@1 416 return;
jjg@1490 417 // suppress messages that have (probably) been covered by doclint
jjg@1490 418 if (doclint != null && doc != null && key.startsWith("tag"))
jjg@1490 419 return;
duke@1 420 messager.warning(doc==null ? null : doc.position(), key, a1);
duke@1 421 }
duke@1 422
duke@1 423 /**
duke@1 424 * Print warning message, increment warning count.
duke@1 425 *
duke@1 426 * @param key selects message from resource
duke@1 427 * @param a1 first argument
duke@1 428 * @param a2 second argument
duke@1 429 */
duke@1 430 public void warning(DocImpl doc, String key, String a1, String a2) {
duke@1 431 if (silent)
duke@1 432 return;
duke@1 433 messager.warning(doc==null ? null : doc.position(), key, a1, a2);
duke@1 434 }
duke@1 435
duke@1 436 /**
duke@1 437 * Print warning message, increment warning count.
duke@1 438 *
duke@1 439 * @param key selects message from resource
duke@1 440 * @param a1 first argument
duke@1 441 * @param a2 second argument
duke@1 442 * @param a3 third argument
duke@1 443 */
duke@1 444 public void warning(DocImpl doc, String key, String a1, String a2, String a3) {
duke@1 445 if (silent)
duke@1 446 return;
duke@1 447 messager.warning(doc==null ? null : doc.position(), key, a1, a2, a3);
duke@1 448 }
duke@1 449
duke@1 450 /**
duke@1 451 * Print warning message, increment warning count.
duke@1 452 *
duke@1 453 * @param key selects message from resource
duke@1 454 * @param a1 first argument
duke@1 455 * @param a2 second argument
duke@1 456 * @param a3 third argument
duke@1 457 */
duke@1 458 public void warning(DocImpl doc, String key, String a1, String a2, String a3,
duke@1 459 String a4) {
duke@1 460 if (silent)
duke@1 461 return;
duke@1 462 messager.warning(doc==null ? null : doc.position(), key, a1, a2, a3, a4);
duke@1 463 }
duke@1 464
duke@1 465 /**
duke@1 466 * Print a message.
duke@1 467 *
duke@1 468 * @param msg message to print.
duke@1 469 */
duke@1 470 public void printNotice(String msg) {
duke@1 471 if (silent || quiet)
duke@1 472 return;
duke@1 473 messager.printNotice(msg);
duke@1 474 }
duke@1 475
duke@1 476
duke@1 477 /**
duke@1 478 * Print a message.
duke@1 479 *
duke@1 480 * @param key selects message from resource
duke@1 481 */
duke@1 482 public void notice(String key) {
duke@1 483 if (silent || quiet)
duke@1 484 return;
duke@1 485 messager.notice(key);
duke@1 486 }
duke@1 487
duke@1 488 /**
duke@1 489 * Print a message.
duke@1 490 *
duke@1 491 * @param msg message to print.
duke@1 492 */
duke@1 493 public void printNotice(SourcePosition pos, String msg) {
duke@1 494 if (silent || quiet)
duke@1 495 return;
duke@1 496 messager.printNotice(pos, msg);
duke@1 497 }
duke@1 498
duke@1 499 /**
duke@1 500 * Print a message.
duke@1 501 *
duke@1 502 * @param key selects message from resource
duke@1 503 * @param a1 first argument
duke@1 504 */
duke@1 505 public void notice(String key, String a1) {
duke@1 506 if (silent || quiet)
duke@1 507 return;
duke@1 508 messager.notice(key, a1);
duke@1 509 }
duke@1 510
duke@1 511 /**
duke@1 512 * Print a message.
duke@1 513 *
duke@1 514 * @param key selects message from resource
duke@1 515 * @param a1 first argument
duke@1 516 * @param a2 second argument
duke@1 517 */
duke@1 518 public void notice(String key, String a1, String a2) {
duke@1 519 if (silent || quiet)
duke@1 520 return;
duke@1 521 messager.notice(key, a1, a2);
duke@1 522 }
duke@1 523
duke@1 524 /**
duke@1 525 * Print a message.
duke@1 526 *
duke@1 527 * @param key selects message from resource
duke@1 528 * @param a1 first argument
duke@1 529 * @param a2 second argument
duke@1 530 * @param a3 third argument
duke@1 531 */
duke@1 532 public void notice(String key, String a1, String a2, String a3) {
duke@1 533 if (silent || quiet)
duke@1 534 return;
duke@1 535 messager.notice(key, a1, a2, a3);
duke@1 536 }
duke@1 537
duke@1 538 /**
duke@1 539 * Exit, reporting errors and warnings.
duke@1 540 */
duke@1 541 public void exit() {
duke@1 542 // Messager should be replaced by a more general
duke@1 543 // compilation environment. This can probably
duke@1 544 // subsume DocEnv as well.
duke@1 545 messager.exit();
duke@1 546 }
duke@1 547
ksrini@1051 548 protected Map<PackageSymbol, PackageDocImpl> packageMap =
duke@1 549 new HashMap<PackageSymbol, PackageDocImpl>();
duke@1 550 /**
duke@1 551 * Return the PackageDoc of this package symbol.
duke@1 552 */
duke@1 553 public PackageDocImpl getPackageDoc(PackageSymbol pack) {
duke@1 554 PackageDocImpl result = packageMap.get(pack);
duke@1 555 if (result != null) return result;
duke@1 556 result = new PackageDocImpl(this, pack);
duke@1 557 packageMap.put(pack, result);
duke@1 558 return result;
duke@1 559 }
duke@1 560
duke@1 561 /**
duke@1 562 * Create the PackageDoc (or a subtype) for a package symbol.
duke@1 563 */
jjg@1443 564 void makePackageDoc(PackageSymbol pack, TreePath treePath) {
duke@1 565 PackageDocImpl result = packageMap.get(pack);
duke@1 566 if (result != null) {
jjg@1443 567 if (treePath != null) result.setTreePath(treePath);
duke@1 568 } else {
jjg@1443 569 result = new PackageDocImpl(this, pack, treePath);
duke@1 570 packageMap.put(pack, result);
duke@1 571 }
duke@1 572 }
duke@1 573
duke@1 574
ksrini@1051 575 protected Map<ClassSymbol, ClassDocImpl> classMap =
duke@1 576 new HashMap<ClassSymbol, ClassDocImpl>();
duke@1 577 /**
duke@1 578 * Return the ClassDoc (or a subtype) of this class symbol.
duke@1 579 */
ksrini@1051 580 public ClassDocImpl getClassDoc(ClassSymbol clazz) {
duke@1 581 ClassDocImpl result = classMap.get(clazz);
duke@1 582 if (result != null) return result;
duke@1 583 if (isAnnotationType(clazz)) {
duke@1 584 result = new AnnotationTypeDocImpl(this, clazz);
duke@1 585 } else {
duke@1 586 result = new ClassDocImpl(this, clazz);
duke@1 587 }
duke@1 588 classMap.put(clazz, result);
duke@1 589 return result;
duke@1 590 }
duke@1 591
duke@1 592 /**
duke@1 593 * Create the ClassDoc (or a subtype) for a class symbol.
duke@1 594 */
jjg@1443 595 protected void makeClassDoc(ClassSymbol clazz, TreePath treePath) {
duke@1 596 ClassDocImpl result = classMap.get(clazz);
duke@1 597 if (result != null) {
jjg@1443 598 if (treePath != null) result.setTreePath(treePath);
duke@1 599 return;
duke@1 600 }
jjg@1443 601 if (isAnnotationType((JCClassDecl) treePath.getLeaf())) { // flags of clazz may not yet be set
jjg@1443 602 result = new AnnotationTypeDocImpl(this, clazz, treePath);
duke@1 603 } else {
jjg@1443 604 result = new ClassDocImpl(this, clazz, treePath);
duke@1 605 }
duke@1 606 classMap.put(clazz, result);
duke@1 607 }
duke@1 608
ksrini@1051 609 protected static boolean isAnnotationType(ClassSymbol clazz) {
duke@1 610 return ClassDocImpl.isAnnotationType(clazz);
duke@1 611 }
duke@1 612
ksrini@1051 613 protected static boolean isAnnotationType(JCClassDecl tree) {
duke@1 614 return (tree.mods.flags & Flags.ANNOTATION) != 0;
duke@1 615 }
duke@1 616
ksrini@1051 617 protected Map<VarSymbol, FieldDocImpl> fieldMap =
duke@1 618 new HashMap<VarSymbol, FieldDocImpl>();
duke@1 619 /**
duke@1 620 * Return the FieldDoc of this var symbol.
duke@1 621 */
ksrini@1051 622 public FieldDocImpl getFieldDoc(VarSymbol var) {
duke@1 623 FieldDocImpl result = fieldMap.get(var);
duke@1 624 if (result != null) return result;
duke@1 625 result = new FieldDocImpl(this, var);
duke@1 626 fieldMap.put(var, result);
duke@1 627 return result;
duke@1 628 }
duke@1 629 /**
duke@1 630 * Create a FieldDoc for a var symbol.
duke@1 631 */
jjg@1443 632 protected void makeFieldDoc(VarSymbol var, TreePath treePath) {
duke@1 633 FieldDocImpl result = fieldMap.get(var);
duke@1 634 if (result != null) {
jjg@1443 635 if (treePath != null) result.setTreePath(treePath);
duke@1 636 } else {
jjg@1443 637 result = new FieldDocImpl(this, var, treePath);
duke@1 638 fieldMap.put(var, result);
duke@1 639 }
duke@1 640 }
duke@1 641
ksrini@1051 642 protected Map<MethodSymbol, ExecutableMemberDocImpl> methodMap =
duke@1 643 new HashMap<MethodSymbol, ExecutableMemberDocImpl>();
duke@1 644 /**
duke@1 645 * Create a MethodDoc for this MethodSymbol.
duke@1 646 * Should be called only on symbols representing methods.
duke@1 647 */
jjg@1443 648 protected void makeMethodDoc(MethodSymbol meth, TreePath treePath) {
duke@1 649 MethodDocImpl result = (MethodDocImpl)methodMap.get(meth);
duke@1 650 if (result != null) {
jjg@1443 651 if (treePath != null) result.setTreePath(treePath);
duke@1 652 } else {
jjg@1443 653 result = new MethodDocImpl(this, meth, treePath);
duke@1 654 methodMap.put(meth, result);
duke@1 655 }
duke@1 656 }
duke@1 657
duke@1 658 /**
duke@1 659 * Return the MethodDoc for a MethodSymbol.
duke@1 660 * Should be called only on symbols representing methods.
duke@1 661 */
duke@1 662 public MethodDocImpl getMethodDoc(MethodSymbol meth) {
sundar@721 663 assert !meth.isConstructor() : "not expecting a constructor symbol";
duke@1 664 MethodDocImpl result = (MethodDocImpl)methodMap.get(meth);
duke@1 665 if (result != null) return result;
duke@1 666 result = new MethodDocImpl(this, meth);
duke@1 667 methodMap.put(meth, result);
duke@1 668 return result;
duke@1 669 }
duke@1 670
duke@1 671 /**
duke@1 672 * Create the ConstructorDoc for a MethodSymbol.
duke@1 673 * Should be called only on symbols representing constructors.
duke@1 674 */
jjg@1443 675 protected void makeConstructorDoc(MethodSymbol meth, TreePath treePath) {
duke@1 676 ConstructorDocImpl result = (ConstructorDocImpl)methodMap.get(meth);
duke@1 677 if (result != null) {
jjg@1443 678 if (treePath != null) result.setTreePath(treePath);
duke@1 679 } else {
jjg@1443 680 result = new ConstructorDocImpl(this, meth, treePath);
duke@1 681 methodMap.put(meth, result);
duke@1 682 }
duke@1 683 }
duke@1 684
duke@1 685 /**
duke@1 686 * Return the ConstructorDoc for a MethodSymbol.
duke@1 687 * Should be called only on symbols representing constructors.
duke@1 688 */
duke@1 689 public ConstructorDocImpl getConstructorDoc(MethodSymbol meth) {
sundar@721 690 assert meth.isConstructor() : "expecting a constructor symbol";
duke@1 691 ConstructorDocImpl result = (ConstructorDocImpl)methodMap.get(meth);
duke@1 692 if (result != null) return result;
duke@1 693 result = new ConstructorDocImpl(this, meth);
duke@1 694 methodMap.put(meth, result);
duke@1 695 return result;
duke@1 696 }
duke@1 697
duke@1 698 /**
duke@1 699 * Create the AnnotationTypeElementDoc for a MethodSymbol.
duke@1 700 * Should be called only on symbols representing annotation type elements.
duke@1 701 */
jjg@1443 702 protected void makeAnnotationTypeElementDoc(MethodSymbol meth, TreePath treePath) {
duke@1 703 AnnotationTypeElementDocImpl result =
duke@1 704 (AnnotationTypeElementDocImpl)methodMap.get(meth);
duke@1 705 if (result != null) {
jjg@1443 706 if (treePath != null) result.setTreePath(treePath);
duke@1 707 } else {
duke@1 708 result =
jjg@1443 709 new AnnotationTypeElementDocImpl(this, meth, treePath);
duke@1 710 methodMap.put(meth, result);
duke@1 711 }
duke@1 712 }
duke@1 713
duke@1 714 /**
duke@1 715 * Return the AnnotationTypeElementDoc for a MethodSymbol.
duke@1 716 * Should be called only on symbols representing annotation type elements.
duke@1 717 */
duke@1 718 public AnnotationTypeElementDocImpl getAnnotationTypeElementDoc(
duke@1 719 MethodSymbol meth) {
duke@1 720
duke@1 721 AnnotationTypeElementDocImpl result =
duke@1 722 (AnnotationTypeElementDocImpl)methodMap.get(meth);
duke@1 723 if (result != null) return result;
duke@1 724 result = new AnnotationTypeElementDocImpl(this, meth);
duke@1 725 methodMap.put(meth, result);
duke@1 726 return result;
duke@1 727 }
duke@1 728
duke@1 729 // private Map<ClassType, ParameterizedTypeImpl> parameterizedTypeMap =
duke@1 730 // new HashMap<ClassType, ParameterizedTypeImpl>();
duke@1 731 /**
duke@1 732 * Return the ParameterizedType of this instantiation.
duke@1 733 // * ### Could use Type.sameTypeAs() instead of equality matching in hashmap
duke@1 734 // * ### to avoid some duplication.
duke@1 735 */
duke@1 736 ParameterizedTypeImpl getParameterizedType(ClassType t) {
duke@1 737 return new ParameterizedTypeImpl(this, t);
duke@1 738 // ParameterizedTypeImpl result = parameterizedTypeMap.get(t);
duke@1 739 // if (result != null) return result;
duke@1 740 // result = new ParameterizedTypeImpl(this, t);
duke@1 741 // parameterizedTypeMap.put(t, result);
duke@1 742 // return result;
duke@1 743 }
duke@1 744
jjg@1443 745 TreePath getTreePath(JCCompilationUnit tree) {
jjg@1443 746 TreePath p = treePaths.get(tree);
jjg@1443 747 if (p == null)
jjg@1443 748 treePaths.put(tree, p = new TreePath(tree));
jjg@1443 749 return p;
jjg@1443 750 }
jjg@1443 751
jjg@1490 752 TreePath getTreePath(JCCompilationUnit toplevel, JCClassDecl tree) {
jjg@1490 753 TreePath p = treePaths.get(tree);
jjg@1490 754 if (p == null)
jjg@1490 755 treePaths.put(tree, p = new TreePath(getTreePath(toplevel), tree));
jjg@1490 756 return p;
jjg@1490 757 }
jjg@1490 758
jjg@1490 759 TreePath getTreePath(JCCompilationUnit toplevel, JCClassDecl cdecl, JCTree tree) {
jjg@1490 760 return new TreePath(getTreePath(toplevel, cdecl), tree);
jjg@1443 761 }
jjg@1443 762
duke@1 763 /**
duke@1 764 * Set the encoding.
duke@1 765 */
duke@1 766 public void setEncoding(String encoding) {
duke@1 767 this.encoding = encoding;
duke@1 768 }
duke@1 769
duke@1 770 /**
duke@1 771 * Get the encoding.
duke@1 772 */
duke@1 773 public String getEncoding() {
duke@1 774 return encoding;
duke@1 775 }
duke@1 776
duke@1 777 /**
duke@1 778 * Convert modifier bits from private coding used by
duke@1 779 * the compiler to that of java.lang.reflect.Modifier.
duke@1 780 */
duke@1 781 static int translateModifiers(long flags) {
duke@1 782 int result = 0;
duke@1 783 if ((flags & Flags.ABSTRACT) != 0)
duke@1 784 result |= Modifier.ABSTRACT;
duke@1 785 if ((flags & Flags.FINAL) != 0)
duke@1 786 result |= Modifier.FINAL;
duke@1 787 if ((flags & Flags.INTERFACE) != 0)
duke@1 788 result |= Modifier.INTERFACE;
duke@1 789 if ((flags & Flags.NATIVE) != 0)
duke@1 790 result |= Modifier.NATIVE;
duke@1 791 if ((flags & Flags.PRIVATE) != 0)
duke@1 792 result |= Modifier.PRIVATE;
duke@1 793 if ((flags & Flags.PROTECTED) != 0)
duke@1 794 result |= Modifier.PROTECTED;
duke@1 795 if ((flags & Flags.PUBLIC) != 0)
duke@1 796 result |= Modifier.PUBLIC;
duke@1 797 if ((flags & Flags.STATIC) != 0)
duke@1 798 result |= Modifier.STATIC;
duke@1 799 if ((flags & Flags.SYNCHRONIZED) != 0)
duke@1 800 result |= Modifier.SYNCHRONIZED;
duke@1 801 if ((flags & Flags.TRANSIENT) != 0)
duke@1 802 result |= Modifier.TRANSIENT;
duke@1 803 if ((flags & Flags.VOLATILE) != 0)
duke@1 804 result |= Modifier.VOLATILE;
duke@1 805 return result;
duke@1 806 }
jjg@1490 807
bpatel@2169 808 void initDoclint(Collection<String> opts, Collection<String> customTagNames) {
jjg@1490 809 ArrayList<String> doclintOpts = new ArrayList<String>();
jjg@1490 810
jjg@1490 811 for (String opt: opts) {
jjg@1490 812 doclintOpts.add(opt == null ? DocLint.XMSGS_OPTION : DocLint.XMSGS_CUSTOM_PREFIX + opt);
jjg@1490 813 }
jjg@1490 814
jjg@1558 815 if (doclintOpts.isEmpty()) {
jjg@1558 816 doclintOpts.add(DocLint.XMSGS_OPTION);
jjg@1558 817 } else if (doclintOpts.size() == 1
jjg@1490 818 && doclintOpts.get(0).equals(DocLint.XMSGS_CUSTOM_PREFIX + "none")) {
jjg@1490 819 return;
jjg@1490 820 }
jjg@1490 821
bpatel@2169 822 String sep = "";
bpatel@2169 823 StringBuilder customTags = new StringBuilder();
bpatel@2169 824 for (String customTag : customTagNames) {
bpatel@2169 825 customTags.append(sep);
bpatel@2169 826 customTags.append(customTag);
bpatel@2169 827 sep = DocLint.TAGS_SEPARATOR;
bpatel@2169 828 }
bpatel@2169 829 doclintOpts.add(DocLint.XCUSTOM_TAGS_PREFIX + customTags.toString());
bpatel@2169 830
jjg@1490 831 JavacTask t = BasicJavacTask.instance(context);
jjg@1490 832 doclint = new DocLint();
jjg@1668 833 // standard doclet normally generates H1, H2
jjg@1668 834 doclintOpts.add(DocLint.XIMPLICIT_HEADERS + "2");
jjg@1490 835 doclint.init(t, doclintOpts.toArray(new String[doclintOpts.size()]), false);
jjg@1490 836 }
jjg@1490 837
aefimov@3315 838 JavaScriptScanner initJavaScriptScanner(boolean allowScriptInComments) {
aefimov@3315 839 if (allowScriptInComments) {
aefimov@3315 840 javaScriptScanner = null;
aefimov@3315 841 } else {
aefimov@3315 842 javaScriptScanner = new JavaScriptScanner();
aefimov@3315 843 }
aefimov@3315 844 return javaScriptScanner;
aefimov@3315 845 }
aefimov@3315 846
jjg@1490 847 boolean showTagMessages() {
jjg@1490 848 return (doclint == null);
jjg@1490 849 }
duke@1 850 }

mercurial