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

Tue, 24 Dec 2013 09:17:37 -0800

author
ksrini
date
Tue, 24 Dec 2013 09:17:37 -0800
changeset 2227
998b10c43157
parent 2201
ef44a2971cb1
child 2525
2eb010b6cb22
child 3315
6f0746b6de9f
permissions
-rw-r--r--

8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com

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

mercurial