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