src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java

Tue, 14 May 2013 10:14:56 -0700

author
jjg
date
Tue, 14 May 2013 10:14:56 -0700
changeset 1750
081d7c72ee92
parent 1748
051b728cfe90
child 1751
ca8808c88f94
permissions
-rw-r--r--

8012311: Cleanup names and duplicatre code in TagletManager
Reviewed-by: darcy

duke@1 1 /*
jjg@1521 2 * Copyright (c) 1998, 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.doclets.formats.html;
duke@1 27
duke@1 28 import java.io.*;
duke@1 29 import java.text.SimpleDateFormat;
duke@1 30 import java.util.*;
duke@1 31
bpatel@233 32 import com.sun.javadoc.*;
bpatel@233 33 import com.sun.tools.doclets.formats.html.markup.*;
bpatel@233 34 import com.sun.tools.doclets.internal.toolkit.*;
jjg@1357 35 import com.sun.tools.doclets.internal.toolkit.taglets.*;
bpatel@233 36 import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1 37
duke@1 38 /**
duke@1 39 * Class for the Html Format Code Generation specific to JavaDoc.
duke@1 40 * This Class contains methods related to the Html Code Generation which
duke@1 41 * are used extensively while generating the entire documentation.
duke@1 42 *
jjg@1359 43 * <p><b>This is NOT part of any supported API.
jjg@1359 44 * If you write code that depends on this, you do so at your own risk.
jjg@1359 45 * This code and its internal interfaces are subject to change or
jjg@1359 46 * deletion without notice.</b>
jjg@1359 47 *
duke@1 48 * @since 1.2
duke@1 49 * @author Atul M Dambalkar
duke@1 50 * @author Robert Field
bpatel@233 51 * @author Bhavesh Patel (Modified)
duke@1 52 */
duke@1 53 public class HtmlDocletWriter extends HtmlDocWriter {
duke@1 54
duke@1 55 /**
duke@1 56 * Relative path from the file getting generated to the destination
duke@1 57 * directory. For example, if the file getting generated is
jjg@1372 58 * "java/lang/Object.html", then the path to the root is "../..".
duke@1 59 * This string can be empty if the file getting generated is in
duke@1 60 * the destination directory.
duke@1 61 */
jjg@1372 62 public final DocPath pathToRoot;
duke@1 63
duke@1 64 /**
jjg@1372 65 * Platform-independent path from the current or the
duke@1 66 * destination directory to the file getting generated.
duke@1 67 * Used when creating the file.
duke@1 68 */
jjg@1372 69 public final DocPath path;
duke@1 70
duke@1 71 /**
duke@1 72 * Name of the file getting generated. If the file getting generated is
duke@1 73 * "java/lang/Object.html", then the filename is "Object.html".
duke@1 74 */
jjg@1372 75 public final DocPath filename;
duke@1 76
duke@1 77 /**
duke@1 78 * The global configuration information for this run.
duke@1 79 */
jjg@1410 80 public final ConfigurationImpl configuration;
duke@1 81
duke@1 82 /**
bpatel@766 83 * To check whether annotation heading is printed or not.
bpatel@766 84 */
bpatel@766 85 protected boolean printedAnnotationHeading = false;
bpatel@766 86
bpatel@766 87 /**
bpatel@1477 88 * To check whether the repeated annotations is documented or not.
bpatel@1477 89 */
bpatel@1477 90 private boolean isAnnotationDocumented = false;
bpatel@1477 91
bpatel@1477 92 /**
bpatel@1477 93 * To check whether the container annotations is documented or not.
bpatel@1477 94 */
bpatel@1477 95 private boolean isContainerDocumented = false;
bpatel@1477 96
bpatel@1477 97 /**
duke@1 98 * Constructor to construct the HtmlStandardWriter object.
duke@1 99 *
jjg@1372 100 * @param path File to be generated.
duke@1 101 */
jjg@1372 102 public HtmlDocletWriter(ConfigurationImpl configuration, DocPath path)
jjg@1372 103 throws IOException {
jjg@1372 104 super(configuration, path);
duke@1 105 this.configuration = configuration;
duke@1 106 this.path = path;
jjg@1372 107 this.pathToRoot = path.parent().invert();
jjg@1372 108 this.filename = path.basename();
duke@1 109 }
duke@1 110
duke@1 111 /**
duke@1 112 * Replace {&#064;docRoot} tag used in options that accept HTML text, such
duke@1 113 * as -header, -footer, -top and -bottom, and when converting a relative
duke@1 114 * HREF where commentTagsToString inserts a {&#064;docRoot} where one was
duke@1 115 * missing. (Also see DocRootTaglet for {&#064;docRoot} tags in doc
duke@1 116 * comments.)
duke@1 117 * <p>
duke@1 118 * Replace {&#064;docRoot} tag in htmlstr with the relative path to the
duke@1 119 * destination directory from the directory where the file is being
duke@1 120 * written, looping to handle all such tags in htmlstr.
duke@1 121 * <p>
duke@1 122 * For example, for "-d docs" and -header containing {&#064;docRoot}, when
duke@1 123 * the HTML page for source file p/C1.java is being generated, the
duke@1 124 * {&#064;docRoot} tag would be inserted into the header as "../",
duke@1 125 * the relative path from docs/p/ to docs/ (the document root).
duke@1 126 * <p>
duke@1 127 * Note: This doc comment was written with '&amp;#064;' representing '@'
duke@1 128 * to prevent the inline tag from being interpreted.
duke@1 129 */
duke@1 130 public String replaceDocRootDir(String htmlstr) {
duke@1 131 // Return if no inline tags exist
duke@1 132 int index = htmlstr.indexOf("{@");
duke@1 133 if (index < 0) {
duke@1 134 return htmlstr;
duke@1 135 }
duke@1 136 String lowerHtml = htmlstr.toLowerCase();
duke@1 137 // Return index of first occurrence of {@docroot}
duke@1 138 // Note: {@docRoot} is not case sensitive when passed in w/command line option
duke@1 139 index = lowerHtml.indexOf("{@docroot}", index);
duke@1 140 if (index < 0) {
duke@1 141 return htmlstr;
duke@1 142 }
jjg@910 143 StringBuilder buf = new StringBuilder();
duke@1 144 int previndex = 0;
duke@1 145 while (true) {
bpatel@997 146 if (configuration.docrootparent.length() > 0) {
jjg@1372 147 final String docroot_parent = "{@docroot}/..";
bpatel@997 148 // Search for lowercase version of {@docRoot}/..
jjg@1372 149 index = lowerHtml.indexOf(docroot_parent, previndex);
bpatel@997 150 // If next {@docRoot}/.. pattern not found, append rest of htmlstr and exit loop
bpatel@997 151 if (index < 0) {
bpatel@997 152 buf.append(htmlstr.substring(previndex));
bpatel@997 153 break;
bpatel@997 154 }
bpatel@997 155 // If next {@docroot}/.. pattern found, append htmlstr up to start of tag
bpatel@997 156 buf.append(htmlstr.substring(previndex, index));
jjg@1372 157 previndex = index + docroot_parent.length();
bpatel@997 158 // Insert docrootparent absolute path where {@docRoot}/.. was located
bpatel@997 159
bpatel@997 160 buf.append(configuration.docrootparent);
bpatel@997 161 // Append slash if next character is not a slash
bpatel@997 162 if (previndex < htmlstr.length() && htmlstr.charAt(previndex) != '/') {
jjg@1372 163 buf.append('/');
bpatel@997 164 }
bpatel@997 165 } else {
jjg@1372 166 final String docroot = "{@docroot}";
bpatel@997 167 // Search for lowercase version of {@docRoot}
jjg@1372 168 index = lowerHtml.indexOf(docroot, previndex);
bpatel@997 169 // If next {@docRoot} tag not found, append rest of htmlstr and exit loop
bpatel@997 170 if (index < 0) {
bpatel@997 171 buf.append(htmlstr.substring(previndex));
bpatel@997 172 break;
bpatel@997 173 }
bpatel@997 174 // If next {@docroot} tag found, append htmlstr up to start of tag
bpatel@997 175 buf.append(htmlstr.substring(previndex, index));
jjg@1372 176 previndex = index + docroot.length();
bpatel@997 177 // Insert relative path where {@docRoot} was located
jjg@1372 178 buf.append(pathToRoot.isEmpty() ? "." : pathToRoot.getPath());
bpatel@997 179 // Append slash if next character is not a slash
jjg@1372 180 if (previndex < htmlstr.length() && htmlstr.charAt(previndex) != '/') {
jjg@1372 181 buf.append('/');
bpatel@997 182 }
duke@1 183 }
duke@1 184 }
duke@1 185 return buf.toString();
duke@1 186 }
duke@1 187
duke@1 188 /**
bpatel@766 189 * Get the script to show or hide the All classes link.
bpatel@766 190 *
bpatel@766 191 * @param id id of the element to show or hide
bpatel@766 192 * @return a content tree for the script
bpatel@766 193 */
bpatel@766 194 public Content getAllClassesLinkScript(String id) {
bpatel@766 195 HtmlTree script = new HtmlTree(HtmlTag.SCRIPT);
bpatel@766 196 script.addAttr(HtmlAttr.TYPE, "text/javascript");
bpatel@793 197 String scriptCode = "<!--" + DocletConstants.NL +
bpatel@793 198 " allClassesLink = document.getElementById(\"" + id + "\");" + DocletConstants.NL +
bpatel@793 199 " if(window==top) {" + DocletConstants.NL +
bpatel@793 200 " allClassesLink.style.display = \"block\";" + DocletConstants.NL +
bpatel@793 201 " }" + DocletConstants.NL +
bpatel@793 202 " else {" + DocletConstants.NL +
bpatel@793 203 " allClassesLink.style.display = \"none\";" + DocletConstants.NL +
bpatel@793 204 " }" + DocletConstants.NL +
bpatel@793 205 " //-->" + DocletConstants.NL;
bpatel@766 206 Content scriptContent = new RawHtml(scriptCode);
bpatel@766 207 script.addContent(scriptContent);
bpatel@766 208 Content div = HtmlTree.DIV(script);
bpatel@766 209 return div;
bpatel@766 210 }
bpatel@766 211
bpatel@766 212 /**
bpatel@766 213 * Add method information.
bpatel@766 214 *
bpatel@766 215 * @param method the method to be documented
bpatel@766 216 * @param dl the content tree to which the method information will be added
bpatel@766 217 */
bpatel@766 218 private void addMethodInfo(MethodDoc method, Content dl) {
duke@1 219 ClassDoc[] intfacs = method.containingClass().interfaces();
duke@1 220 MethodDoc overriddenMethod = method.overriddenMethod();
bpatel@233 221 // Check whether there is any implementation or overridden info to be
bpatel@233 222 // printed. If no overridden or implementation info needs to be
bpatel@233 223 // printed, do not print this section.
bpatel@233 224 if ((intfacs.length > 0 &&
bpatel@233 225 new ImplementedMethods(method, this.configuration).build().length > 0) ||
bpatel@233 226 overriddenMethod != null) {
bpatel@766 227 MethodWriterImpl.addImplementsInfo(this, method, dl);
duke@1 228 if (overriddenMethod != null) {
bpatel@766 229 MethodWriterImpl.addOverridden(this,
bpatel@766 230 method.overriddenType(), overriddenMethod, dl);
duke@1 231 }
duke@1 232 }
duke@1 233 }
duke@1 234
bpatel@766 235 /**
bpatel@766 236 * Adds the tags information.
bpatel@766 237 *
bpatel@766 238 * @param doc the doc for which the tags will be generated
bpatel@766 239 * @param htmltree the documentation tree to which the tags will be added
bpatel@766 240 */
bpatel@766 241 protected void addTagsInfo(Doc doc, Content htmltree) {
bpatel@766 242 if (configuration.nocomment) {
duke@1 243 return;
duke@1 244 }
bpatel@766 245 Content dl = new HtmlTree(HtmlTag.DL);
duke@1 246 if (doc instanceof MethodDoc) {
bpatel@766 247 addMethodInfo((MethodDoc) doc, dl);
duke@1 248 }
jjg@1744 249 TagletOutputImpl output = new TagletOutputImpl();
duke@1 250 TagletWriter.genTagOuput(configuration.tagletManager, doc,
jjg@1750 251 configuration.tagletManager.getCustomTaglets(doc),
duke@1 252 getTagletWriterInstance(false), output);
jjg@1744 253 dl.addContent(output.getContent());
bpatel@766 254 htmltree.addContent(dl);
duke@1 255 }
duke@1 256
duke@1 257 /**
bpatel@233 258 * Check whether there are any tags for Serialization Overview
bpatel@233 259 * section to be printed.
bpatel@222 260 *
bpatel@233 261 * @param field the FieldDoc object to check for tags.
bpatel@222 262 * @return true if there are tags to be printed else return false.
bpatel@222 263 */
bpatel@233 264 protected boolean hasSerializationOverviewTags(FieldDoc field) {
jjg@1744 265 TagletOutputImpl output = new TagletOutputImpl();
bpatel@233 266 TagletWriter.genTagOuput(configuration.tagletManager, field,
jjg@1750 267 configuration.tagletManager.getCustomTaglets(field),
bpatel@222 268 getTagletWriterInstance(false), output);
jjg@1744 269 return !output.getContent().isEmpty();
bpatel@222 270 }
bpatel@222 271
bpatel@222 272 /**
duke@1 273 * Returns a TagletWriter that knows how to write HTML.
duke@1 274 *
duke@1 275 * @return a TagletWriter that knows how to write HTML.
duke@1 276 */
duke@1 277 public TagletWriter getTagletWriterInstance(boolean isFirstSentence) {
duke@1 278 return new TagletWriterImpl(this, isFirstSentence);
duke@1 279 }
duke@1 280
duke@1 281 /**
bpatel@766 282 * Get Package link, with target frame.
duke@1 283 *
bpatel@766 284 * @param pd The link will be to the "package-summary.html" page for this package
bpatel@766 285 * @param target name of the target frame
bpatel@766 286 * @param label tag for the link
bpatel@766 287 * @return a content for the target package link
duke@1 288 */
bpatel@766 289 public Content getTargetPackageLink(PackageDoc pd, String target,
bpatel@766 290 Content label) {
jjg@1373 291 return getHyperLink(pathString(pd, DocPaths.PACKAGE_SUMMARY), label, "", target);
duke@1 292 }
duke@1 293
duke@1 294 /**
bpatel@1568 295 * Get Profile Package link, with target frame.
bpatel@1568 296 *
bpatel@1568 297 * @param pd the packageDoc object
bpatel@1568 298 * @param target name of the target frame
bpatel@1568 299 * @param label tag for the link
bpatel@1568 300 * @param profileName the name of the profile being documented
bpatel@1568 301 * @return a content for the target profile packages link
bpatel@1568 302 */
bpatel@1568 303 public Content getTargetProfilePackageLink(PackageDoc pd, String target,
bpatel@1568 304 Content label, String profileName) {
bpatel@1568 305 return getHyperLink(pathString(pd, DocPaths.profilePackageSummary(profileName)),
bpatel@1568 306 label, "", target);
bpatel@1568 307 }
bpatel@1568 308
bpatel@1568 309 /**
bpatel@1568 310 * Get Profile link, with target frame.
bpatel@1568 311 *
bpatel@1568 312 * @param target name of the target frame
bpatel@1568 313 * @param label tag for the link
bpatel@1568 314 * @param profileName the name of the profile being documented
bpatel@1568 315 * @return a content for the target profile link
bpatel@1568 316 */
bpatel@1568 317 public Content getTargetProfileLink(String target, Content label,
bpatel@1568 318 String profileName) {
bpatel@1568 319 return getHyperLink(pathToRoot.resolve(
bpatel@1568 320 DocPaths.profileSummary(profileName)), label, "", target);
bpatel@1568 321 }
bpatel@1568 322
bpatel@1568 323 /**
bpatel@1568 324 * Get the type name for profile search.
bpatel@1568 325 *
bpatel@1568 326 * @param cd the classDoc object for which the type name conversion is needed
bpatel@1568 327 * @return a type name string for the type
bpatel@1568 328 */
bpatel@1568 329 public String getTypeNameForProfile(ClassDoc cd) {
bpatel@1568 330 StringBuilder typeName =
bpatel@1568 331 new StringBuilder((cd.containingPackage()).name().replace(".", "/"));
bpatel@1568 332 typeName.append("/")
bpatel@1568 333 .append(cd.name().replace(".", "$"));
bpatel@1568 334 return typeName.toString();
bpatel@1568 335 }
bpatel@1568 336
bpatel@1568 337 /**
bpatel@1568 338 * Check if a type belongs to a profile.
bpatel@1568 339 *
bpatel@1568 340 * @param cd the classDoc object that needs to be checked
bpatel@1568 341 * @param profileValue the profile in which the type needs to be checked
bpatel@1568 342 * @return true if the type is in the profile
bpatel@1568 343 */
bpatel@1568 344 public boolean isTypeInProfile(ClassDoc cd, int profileValue) {
bpatel@1568 345 return (configuration.profiles.getProfile(getTypeNameForProfile(cd)) <= profileValue);
bpatel@1568 346 }
bpatel@1568 347
bpatel@1568 348 public void addClassesSummary(ClassDoc[] classes, String label,
bpatel@1568 349 String tableSummary, String[] tableHeader, Content summaryContentTree,
bpatel@1568 350 int profileValue) {
bpatel@1568 351 if(classes.length > 0) {
bpatel@1568 352 Arrays.sort(classes);
jjg@1747 353 Content caption = getTableCaption(new RawHtml(label));
bpatel@1568 354 Content table = HtmlTree.TABLE(HtmlStyle.packageSummary, 0, 3, 0,
bpatel@1568 355 tableSummary, caption);
bpatel@1568 356 table.addContent(getSummaryTableHeader(tableHeader, "col"));
bpatel@1568 357 Content tbody = new HtmlTree(HtmlTag.TBODY);
bpatel@1568 358 for (int i = 0; i < classes.length; i++) {
bpatel@1568 359 if (!isTypeInProfile(classes[i], profileValue)) {
bpatel@1568 360 continue;
bpatel@1568 361 }
bpatel@1568 362 if (!Util.isCoreClass(classes[i]) ||
bpatel@1568 363 !configuration.isGeneratedDoc(classes[i])) {
bpatel@1568 364 continue;
bpatel@1568 365 }
jjg@1736 366 Content classContent = getLink(new LinkInfoImpl(
jjg@1738 367 configuration, LinkInfoImpl.Kind.PACKAGE, classes[i]));
bpatel@1568 368 Content tdClass = HtmlTree.TD(HtmlStyle.colFirst, classContent);
bpatel@1568 369 HtmlTree tr = HtmlTree.TR(tdClass);
bpatel@1568 370 if (i%2 == 0)
bpatel@1568 371 tr.addStyle(HtmlStyle.altColor);
bpatel@1568 372 else
bpatel@1568 373 tr.addStyle(HtmlStyle.rowColor);
bpatel@1568 374 HtmlTree tdClassDescription = new HtmlTree(HtmlTag.TD);
bpatel@1568 375 tdClassDescription.addStyle(HtmlStyle.colLast);
bpatel@1568 376 if (Util.isDeprecated(classes[i])) {
bpatel@1568 377 tdClassDescription.addContent(deprecatedLabel);
bpatel@1568 378 if (classes[i].tags("deprecated").length > 0) {
bpatel@1568 379 addSummaryDeprecatedComment(classes[i],
bpatel@1568 380 classes[i].tags("deprecated")[0], tdClassDescription);
bpatel@1568 381 }
bpatel@1568 382 }
bpatel@1568 383 else
bpatel@1568 384 addSummaryComment(classes[i], tdClassDescription);
bpatel@1568 385 tr.addContent(tdClassDescription);
bpatel@1568 386 tbody.addContent(tr);
bpatel@1568 387 }
bpatel@1568 388 table.addContent(tbody);
bpatel@1568 389 Content li = HtmlTree.LI(HtmlStyle.blockList, table);
bpatel@1568 390 summaryContentTree.addContent(li);
bpatel@1568 391 }
bpatel@1568 392 }
bpatel@1568 393
bpatel@1568 394 /**
bpatel@766 395 * Generates the HTML document tree and prints it out.
bpatel@766 396 *
bpatel@766 397 * @param metakeywords Array of String keywords for META tag. Each element
bpatel@766 398 * of the array is assigned to a separate META tag.
bpatel@766 399 * Pass in null for no array
bpatel@766 400 * @param includeScript true if printing windowtitle script
bpatel@766 401 * false for files that appear in the left-hand frames
bpatel@766 402 * @param body the body htmltree to be included in the document
bpatel@766 403 */
bpatel@766 404 public void printHtmlDocument(String[] metakeywords, boolean includeScript,
jjg@1364 405 Content body) throws IOException {
jjg@1410 406 Content htmlDocType = DocType.TRANSITIONAL;
bpatel@766 407 Content htmlComment = new Comment(configuration.getText("doclet.New_Page"));
bpatel@766 408 Content head = new HtmlTree(HtmlTag.HEAD);
bpatel@766 409 if (!configuration.notimestamp) {
jjg@1361 410 Content headComment = new Comment(getGeneratedByString());
bpatel@766 411 head.addContent(headComment);
bpatel@766 412 }
bpatel@766 413 if (configuration.charset.length() > 0) {
bpatel@766 414 Content meta = HtmlTree.META("Content-Type", "text/html",
bpatel@766 415 configuration.charset);
bpatel@766 416 head.addContent(meta);
bpatel@766 417 }
bpatel@766 418 head.addContent(getTitle());
bpatel@766 419 if (!configuration.notimestamp) {
bpatel@766 420 SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
bpatel@766 421 Content meta = HtmlTree.META("date", dateFormat.format(new Date()));
bpatel@766 422 head.addContent(meta);
bpatel@766 423 }
bpatel@766 424 if (metakeywords != null) {
bpatel@766 425 for (int i=0; i < metakeywords.length; i++) {
bpatel@766 426 Content meta = HtmlTree.META("keywords", metakeywords[i]);
bpatel@766 427 head.addContent(meta);
bpatel@766 428 }
bpatel@766 429 }
bpatel@766 430 head.addContent(getStyleSheetProperties());
bpatel@1417 431 head.addContent(getScriptProperties());
bpatel@766 432 Content htmlTree = HtmlTree.HTML(configuration.getLocale().getLanguage(),
bpatel@766 433 head, body);
bpatel@766 434 Content htmlDocument = new HtmlDocument(htmlDocType,
bpatel@766 435 htmlComment, htmlTree);
jjg@1365 436 write(htmlDocument);
bpatel@766 437 }
bpatel@766 438
bpatel@766 439 /**
bpatel@766 440 * Get the window title.
bpatel@766 441 *
bpatel@766 442 * @param title the title string to construct the complete window title
bpatel@766 443 * @return the window title string
bpatel@766 444 */
bpatel@766 445 public String getWindowTitle(String title) {
bpatel@766 446 if (configuration.windowtitle.length() > 0) {
bpatel@766 447 title += " (" + configuration.windowtitle + ")";
bpatel@766 448 }
bpatel@766 449 return title;
bpatel@766 450 }
bpatel@766 451
bpatel@766 452 /**
bpatel@766 453 * Get user specified header and the footer.
bpatel@766 454 *
bpatel@766 455 * @param header if true print the user provided header else print the
bpatel@766 456 * user provided footer.
bpatel@766 457 */
bpatel@766 458 public Content getUserHeaderFooter(boolean header) {
bpatel@766 459 String content;
bpatel@766 460 if (header) {
bpatel@766 461 content = replaceDocRootDir(configuration.header);
bpatel@766 462 } else {
bpatel@766 463 if (configuration.footer.length() != 0) {
bpatel@766 464 content = replaceDocRootDir(configuration.footer);
bpatel@766 465 } else {
bpatel@766 466 content = replaceDocRootDir(configuration.header);
bpatel@766 467 }
bpatel@766 468 }
bpatel@766 469 Content rawContent = new RawHtml(content);
bpatel@766 470 Content em = HtmlTree.EM(rawContent);
bpatel@766 471 return em;
bpatel@766 472 }
bpatel@766 473
bpatel@766 474 /**
bpatel@766 475 * Adds the user specified top.
bpatel@766 476 *
bpatel@766 477 * @param body the content tree to which user specified top will be added
bpatel@766 478 */
bpatel@766 479 public void addTop(Content body) {
bpatel@766 480 Content top = new RawHtml(replaceDocRootDir(configuration.top));
bpatel@766 481 body.addContent(top);
bpatel@766 482 }
bpatel@766 483
bpatel@766 484 /**
bpatel@766 485 * Adds the user specified bottom.
bpatel@766 486 *
bpatel@766 487 * @param body the content tree to which user specified bottom will be added
bpatel@766 488 */
bpatel@766 489 public void addBottom(Content body) {
bpatel@766 490 Content bottom = new RawHtml(replaceDocRootDir(configuration.bottom));
bpatel@766 491 Content small = HtmlTree.SMALL(bottom);
bpatel@766 492 Content p = HtmlTree.P(HtmlStyle.legalCopy, small);
bpatel@766 493 body.addContent(p);
bpatel@766 494 }
bpatel@766 495
bpatel@766 496 /**
bpatel@766 497 * Adds the navigation bar for the Html page at the top and and the bottom.
bpatel@766 498 *
bpatel@766 499 * @param header If true print navigation bar at the top of the page else
bpatel@766 500 * @param body the HtmlTree to which the nav links will be added
bpatel@766 501 */
bpatel@766 502 protected void addNavLinks(boolean header, Content body) {
bpatel@766 503 if (!configuration.nonavbar) {
bpatel@766 504 String allClassesId = "allclasses_";
bpatel@766 505 HtmlTree navDiv = new HtmlTree(HtmlTag.DIV);
bpatel@766 506 if (header) {
bpatel@766 507 body.addContent(HtmlConstants.START_OF_TOP_NAVBAR);
bpatel@766 508 navDiv.addStyle(HtmlStyle.topNav);
bpatel@766 509 allClassesId += "navbar_top";
bpatel@766 510 Content a = getMarkerAnchor("navbar_top");
bpatel@766 511 navDiv.addContent(a);
jjg@1373 512 Content skipLinkContent = getHyperLink(DocLink.fragment("skip-navbar_top"),
jjg@1373 513 HtmlTree.EMPTY,
jjg@1373 514 configuration.getText("doclet.Skip_navigation_links"),
jjg@1373 515 "");
bpatel@766 516 navDiv.addContent(skipLinkContent);
bpatel@766 517 } else {
bpatel@766 518 body.addContent(HtmlConstants.START_OF_BOTTOM_NAVBAR);
bpatel@766 519 navDiv.addStyle(HtmlStyle.bottomNav);
bpatel@766 520 allClassesId += "navbar_bottom";
bpatel@766 521 Content a = getMarkerAnchor("navbar_bottom");
bpatel@766 522 navDiv.addContent(a);
jjg@1373 523 Content skipLinkContent = getHyperLink(DocLink.fragment("skip-navbar_bottom"),
jjg@1373 524 HtmlTree.EMPTY,
jjg@1373 525 configuration.getText("doclet.Skip_navigation_links"),
jjg@1373 526 "");
bpatel@766 527 navDiv.addContent(skipLinkContent);
bpatel@766 528 }
bpatel@766 529 if (header) {
bpatel@766 530 navDiv.addContent(getMarkerAnchor("navbar_top_firstrow"));
bpatel@766 531 } else {
bpatel@766 532 navDiv.addContent(getMarkerAnchor("navbar_bottom_firstrow"));
bpatel@766 533 }
bpatel@766 534 HtmlTree navList = new HtmlTree(HtmlTag.UL);
bpatel@766 535 navList.addStyle(HtmlStyle.navList);
jjg@1606 536 navList.addAttr(HtmlAttr.TITLE,
jjg@1606 537 configuration.getText("doclet.Navigation"));
bpatel@766 538 if (configuration.createoverview) {
bpatel@766 539 navList.addContent(getNavLinkContents());
bpatel@766 540 }
bpatel@766 541 if (configuration.packages.length == 1) {
bpatel@766 542 navList.addContent(getNavLinkPackage(configuration.packages[0]));
bpatel@766 543 } else if (configuration.packages.length > 1) {
bpatel@766 544 navList.addContent(getNavLinkPackage());
bpatel@766 545 }
bpatel@766 546 navList.addContent(getNavLinkClass());
bpatel@766 547 if(configuration.classuse) {
bpatel@766 548 navList.addContent(getNavLinkClassUse());
bpatel@766 549 }
bpatel@766 550 if(configuration.createtree) {
bpatel@766 551 navList.addContent(getNavLinkTree());
bpatel@766 552 }
bpatel@766 553 if(!(configuration.nodeprecated ||
bpatel@766 554 configuration.nodeprecatedlist)) {
bpatel@766 555 navList.addContent(getNavLinkDeprecated());
bpatel@766 556 }
bpatel@766 557 if(configuration.createindex) {
bpatel@766 558 navList.addContent(getNavLinkIndex());
bpatel@766 559 }
bpatel@766 560 if (!configuration.nohelp) {
bpatel@766 561 navList.addContent(getNavLinkHelp());
bpatel@766 562 }
bpatel@766 563 navDiv.addContent(navList);
bpatel@766 564 Content aboutDiv = HtmlTree.DIV(HtmlStyle.aboutLanguage, getUserHeaderFooter(header));
bpatel@766 565 navDiv.addContent(aboutDiv);
bpatel@766 566 body.addContent(navDiv);
bpatel@766 567 Content ulNav = HtmlTree.UL(HtmlStyle.navList, getNavLinkPrevious());
bpatel@766 568 ulNav.addContent(getNavLinkNext());
bpatel@766 569 Content subDiv = HtmlTree.DIV(HtmlStyle.subNav, ulNav);
bpatel@766 570 Content ulFrames = HtmlTree.UL(HtmlStyle.navList, getNavShowLists());
bpatel@766 571 ulFrames.addContent(getNavHideLists(filename));
bpatel@766 572 subDiv.addContent(ulFrames);
bpatel@766 573 HtmlTree ulAllClasses = HtmlTree.UL(HtmlStyle.navList, getNavLinkClassIndex());
bpatel@766 574 ulAllClasses.addAttr(HtmlAttr.ID, allClassesId.toString());
bpatel@766 575 subDiv.addContent(ulAllClasses);
bpatel@766 576 subDiv.addContent(getAllClassesLinkScript(allClassesId.toString()));
bpatel@766 577 addSummaryDetailLinks(subDiv);
bpatel@766 578 if (header) {
bpatel@766 579 subDiv.addContent(getMarkerAnchor("skip-navbar_top"));
bpatel@766 580 body.addContent(subDiv);
bpatel@766 581 body.addContent(HtmlConstants.END_OF_TOP_NAVBAR);
bpatel@766 582 } else {
bpatel@766 583 subDiv.addContent(getMarkerAnchor("skip-navbar_bottom"));
bpatel@766 584 body.addContent(subDiv);
bpatel@766 585 body.addContent(HtmlConstants.END_OF_BOTTOM_NAVBAR);
bpatel@766 586 }
bpatel@766 587 }
bpatel@766 588 }
bpatel@766 589
bpatel@766 590 /**
bpatel@766 591 * Get the word "NEXT" to indicate that no link is available. Override
bpatel@766 592 * this method to customize next link.
bpatel@766 593 *
bpatel@766 594 * @return a content tree for the link
bpatel@766 595 */
bpatel@766 596 protected Content getNavLinkNext() {
bpatel@766 597 return getNavLinkNext(null);
bpatel@766 598 }
bpatel@766 599
bpatel@766 600 /**
bpatel@766 601 * Get the word "PREV" to indicate that no link is available. Override
bpatel@766 602 * this method to customize prev link.
bpatel@766 603 *
bpatel@766 604 * @return a content tree for the link
bpatel@766 605 */
bpatel@766 606 protected Content getNavLinkPrevious() {
bpatel@766 607 return getNavLinkPrevious(null);
bpatel@766 608 }
bpatel@766 609
bpatel@766 610 /**
duke@1 611 * Do nothing. This is the default method.
duke@1 612 */
bpatel@766 613 protected void addSummaryDetailLinks(Content navDiv) {
bpatel@766 614 }
bpatel@766 615
bpatel@766 616 /**
bpatel@766 617 * Get link to the "overview-summary.html" page.
bpatel@766 618 *
bpatel@766 619 * @return a content tree for the link
bpatel@766 620 */
bpatel@766 621 protected Content getNavLinkContents() {
jjg@1372 622 Content linkContent = getHyperLink(pathToRoot.resolve(DocPaths.OVERVIEW_SUMMARY),
jjg@1373 623 overviewLabel, "", "");
bpatel@766 624 Content li = HtmlTree.LI(linkContent);
bpatel@766 625 return li;
bpatel@766 626 }
bpatel@766 627
bpatel@766 628 /**
bpatel@766 629 * Get link to the "package-summary.html" page for the package passed.
bpatel@766 630 *
bpatel@766 631 * @param pkg Package to which link will be generated
bpatel@766 632 * @return a content tree for the link
bpatel@766 633 */
bpatel@766 634 protected Content getNavLinkPackage(PackageDoc pkg) {
bpatel@766 635 Content linkContent = getPackageLink(pkg,
bpatel@766 636 packageLabel);
bpatel@766 637 Content li = HtmlTree.LI(linkContent);
bpatel@766 638 return li;
bpatel@766 639 }
bpatel@766 640
bpatel@766 641 /**
bpatel@766 642 * Get the word "Package" , to indicate that link is not available here.
bpatel@766 643 *
bpatel@766 644 * @return a content tree for the link
bpatel@766 645 */
bpatel@766 646 protected Content getNavLinkPackage() {
bpatel@766 647 Content li = HtmlTree.LI(packageLabel);
bpatel@766 648 return li;
bpatel@766 649 }
bpatel@766 650
bpatel@766 651 /**
bpatel@766 652 * Get the word "Use", to indicate that link is not available.
bpatel@766 653 *
bpatel@766 654 * @return a content tree for the link
bpatel@766 655 */
bpatel@766 656 protected Content getNavLinkClassUse() {
bpatel@766 657 Content li = HtmlTree.LI(useLabel);
bpatel@766 658 return li;
bpatel@766 659 }
bpatel@766 660
bpatel@766 661 /**
bpatel@766 662 * Get link for previous file.
bpatel@766 663 *
bpatel@766 664 * @param prev File name for the prev link
bpatel@766 665 * @return a content tree for the link
bpatel@766 666 */
jjg@1372 667 public Content getNavLinkPrevious(DocPath prev) {
bpatel@766 668 Content li;
bpatel@766 669 if (prev != null) {
jjg@1373 670 li = HtmlTree.LI(getHyperLink(prev, prevLabel, "", ""));
bpatel@766 671 }
bpatel@766 672 else
bpatel@766 673 li = HtmlTree.LI(prevLabel);
bpatel@766 674 return li;
bpatel@766 675 }
bpatel@766 676
bpatel@766 677 /**
bpatel@766 678 * Get link for next file. If next is null, just print the label
bpatel@766 679 * without linking it anywhere.
bpatel@766 680 *
bpatel@766 681 * @param next File name for the next link
bpatel@766 682 * @return a content tree for the link
bpatel@766 683 */
jjg@1372 684 public Content getNavLinkNext(DocPath next) {
bpatel@766 685 Content li;
bpatel@766 686 if (next != null) {
jjg@1373 687 li = HtmlTree.LI(getHyperLink(next, nextLabel, "", ""));
bpatel@766 688 }
bpatel@766 689 else
bpatel@766 690 li = HtmlTree.LI(nextLabel);
bpatel@766 691 return li;
bpatel@766 692 }
bpatel@766 693
bpatel@766 694 /**
bpatel@766 695 * Get "FRAMES" link, to switch to the frame version of the output.
bpatel@766 696 *
bpatel@766 697 * @param link File to be linked, "index.html"
bpatel@766 698 * @return a content tree for the link
bpatel@766 699 */
jjg@1372 700 protected Content getNavShowLists(DocPath link) {
jjg@1373 701 DocLink dl = new DocLink(link, path.getPath(), null);
jjg@1373 702 Content framesContent = getHyperLink(dl, framesLabel, "", "_top");
bpatel@766 703 Content li = HtmlTree.LI(framesContent);
bpatel@766 704 return li;
bpatel@766 705 }
bpatel@766 706
bpatel@766 707 /**
bpatel@766 708 * Get "FRAMES" link, to switch to the frame version of the output.
bpatel@766 709 *
bpatel@766 710 * @return a content tree for the link
bpatel@766 711 */
bpatel@766 712 protected Content getNavShowLists() {
jjg@1372 713 return getNavShowLists(pathToRoot.resolve(DocPaths.INDEX));
bpatel@766 714 }
bpatel@766 715
bpatel@766 716 /**
bpatel@766 717 * Get "NO FRAMES" link, to switch to the non-frame version of the output.
bpatel@766 718 *
bpatel@766 719 * @param link File to be linked
bpatel@766 720 * @return a content tree for the link
bpatel@766 721 */
jjg@1372 722 protected Content getNavHideLists(DocPath link) {
jjg@1373 723 Content noFramesContent = getHyperLink(link, noframesLabel, "", "_top");
bpatel@766 724 Content li = HtmlTree.LI(noFramesContent);
bpatel@766 725 return li;
bpatel@766 726 }
bpatel@766 727
bpatel@766 728 /**
bpatel@766 729 * Get "Tree" link in the navigation bar. If there is only one package
bpatel@766 730 * specified on the command line, then the "Tree" link will be to the
bpatel@766 731 * only "package-tree.html" file otherwise it will be to the
bpatel@766 732 * "overview-tree.html" file.
bpatel@766 733 *
bpatel@766 734 * @return a content tree for the link
duke@1 735 */
bpatel@766 736 protected Content getNavLinkTree() {
bpatel@766 737 Content treeLinkContent;
bpatel@766 738 PackageDoc[] packages = configuration.root.specifiedPackages();
bpatel@766 739 if (packages.length == 1 && configuration.root.specifiedClasses().length == 0) {
bpatel@766 740 treeLinkContent = getHyperLink(pathString(packages[0],
jjg@1373 741 DocPaths.PACKAGE_TREE), treeLabel,
bpatel@766 742 "", "");
bpatel@766 743 } else {
jjg@1372 744 treeLinkContent = getHyperLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE),
jjg@1373 745 treeLabel, "", "");
bpatel@766 746 }
bpatel@766 747 Content li = HtmlTree.LI(treeLinkContent);
bpatel@766 748 return li;
bpatel@766 749 }
bpatel@766 750
bpatel@766 751 /**
bpatel@766 752 * Get the overview tree link for the main tree.
bpatel@766 753 *
bpatel@766 754 * @param label the label for the link
bpatel@766 755 * @return a content tree for the link
bpatel@766 756 */
bpatel@766 757 protected Content getNavLinkMainTree(String label) {
jjg@1372 758 Content mainTreeContent = getHyperLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE),
bpatel@766 759 new StringContent(label));
bpatel@766 760 Content li = HtmlTree.LI(mainTreeContent);
bpatel@766 761 return li;
duke@1 762 }
duke@1 763
duke@1 764 /**
bpatel@766 765 * Get the word "Class", to indicate that class link is not available.
bpatel@766 766 *
bpatel@766 767 * @return a content tree for the link
bpatel@766 768 */
bpatel@766 769 protected Content getNavLinkClass() {
bpatel@766 770 Content li = HtmlTree.LI(classLabel);
bpatel@766 771 return li;
bpatel@766 772 }
bpatel@766 773
bpatel@766 774 /**
bpatel@766 775 * Get "Deprecated" API link in the navigation bar.
bpatel@766 776 *
bpatel@766 777 * @return a content tree for the link
bpatel@766 778 */
bpatel@766 779 protected Content getNavLinkDeprecated() {
jjg@1372 780 Content linkContent = getHyperLink(pathToRoot.resolve(DocPaths.DEPRECATED_LIST),
jjg@1373 781 deprecatedLabel, "", "");
bpatel@766 782 Content li = HtmlTree.LI(linkContent);
bpatel@766 783 return li;
bpatel@766 784 }
bpatel@766 785
bpatel@766 786 /**
bpatel@766 787 * Get link for generated index. If the user has used "-splitindex"
bpatel@766 788 * command line option, then link to file "index-files/index-1.html" is
bpatel@766 789 * generated otherwise link to file "index-all.html" is generated.
bpatel@766 790 *
bpatel@766 791 * @return a content tree for the link
bpatel@766 792 */
bpatel@766 793 protected Content getNavLinkClassIndex() {
jjg@1372 794 Content allClassesContent = getHyperLink(pathToRoot.resolve(
jjg@1373 795 DocPaths.ALLCLASSES_NOFRAME),
bpatel@766 796 allclassesLabel, "", "");
bpatel@766 797 Content li = HtmlTree.LI(allClassesContent);
bpatel@766 798 return li;
bpatel@766 799 }
duke@1 800
duke@1 801 /**
bpatel@766 802 * Get link for generated class index.
bpatel@766 803 *
bpatel@766 804 * @return a content tree for the link
bpatel@766 805 */
bpatel@766 806 protected Content getNavLinkIndex() {
jjg@1372 807 Content linkContent = getHyperLink(pathToRoot.resolve(
jjg@1372 808 (configuration.splitindex
jjg@1372 809 ? DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1))
jjg@1373 810 : DocPaths.INDEX_ALL)),
bpatel@766 811 indexLabel, "", "");
bpatel@766 812 Content li = HtmlTree.LI(linkContent);
bpatel@766 813 return li;
bpatel@766 814 }
bpatel@766 815
bpatel@766 816 /**
bpatel@766 817 * Get help file link. If user has provided a help file, then generate a
bpatel@766 818 * link to the user given file, which is already copied to current or
bpatel@766 819 * destination directory.
bpatel@766 820 *
bpatel@766 821 * @return a content tree for the link
bpatel@766 822 */
bpatel@766 823 protected Content getNavLinkHelp() {
jjg@1372 824 String helpfile = configuration.helpfile;
jjg@1372 825 DocPath helpfilenm;
jjg@1372 826 if (helpfile.isEmpty()) {
jjg@1372 827 helpfilenm = DocPaths.HELP_DOC;
bpatel@766 828 } else {
jjg@1383 829 DocFile file = DocFile.createFileForInput(configuration, helpfile);
jjg@1383 830 helpfilenm = DocPath.create(file.getName());
bpatel@766 831 }
jjg@1373 832 Content linkContent = getHyperLink(pathToRoot.resolve(helpfilenm),
bpatel@766 833 helpLabel, "", "");
bpatel@766 834 Content li = HtmlTree.LI(linkContent);
bpatel@766 835 return li;
bpatel@766 836 }
bpatel@766 837
bpatel@766 838 /**
bpatel@766 839 * Get summary table header.
bpatel@766 840 *
bpatel@766 841 * @param header the header for the table
bpatel@766 842 * @param scope the scope of the headers
bpatel@766 843 * @return a content tree for the header
bpatel@766 844 */
bpatel@766 845 public Content getSummaryTableHeader(String[] header, String scope) {
bpatel@766 846 Content tr = new HtmlTree(HtmlTag.TR);
bpatel@766 847 int size = header.length;
bpatel@766 848 Content tableHeader;
bpatel@766 849 if (size == 1) {
bpatel@766 850 tableHeader = new StringContent(header[0]);
bpatel@766 851 tr.addContent(HtmlTree.TH(HtmlStyle.colOne, scope, tableHeader));
bpatel@766 852 return tr;
bpatel@766 853 }
bpatel@766 854 for (int i = 0; i < size; i++) {
bpatel@766 855 tableHeader = new StringContent(header[i]);
bpatel@766 856 if(i == 0)
bpatel@766 857 tr.addContent(HtmlTree.TH(HtmlStyle.colFirst, scope, tableHeader));
bpatel@766 858 else if(i == (size - 1))
bpatel@766 859 tr.addContent(HtmlTree.TH(HtmlStyle.colLast, scope, tableHeader));
bpatel@766 860 else
bpatel@766 861 tr.addContent(HtmlTree.TH(scope, tableHeader));
bpatel@766 862 }
bpatel@766 863 return tr;
bpatel@766 864 }
bpatel@766 865
bpatel@766 866 /**
bpatel@766 867 * Get table caption.
bpatel@766 868 *
bpatel@766 869 * @param rawText the caption for the table which could be raw Html
bpatel@766 870 * @return a content tree for the caption
bpatel@766 871 */
jjg@1747 872 public Content getTableCaption(Content title) {
bpatel@766 873 Content captionSpan = HtmlTree.SPAN(title);
bpatel@766 874 Content space = getSpace();
bpatel@766 875 Content tabSpan = HtmlTree.SPAN(HtmlStyle.tabEnd, space);
bpatel@766 876 Content caption = HtmlTree.CAPTION(captionSpan);
bpatel@766 877 caption.addContent(tabSpan);
bpatel@766 878 return caption;
bpatel@766 879 }
bpatel@766 880
bpatel@766 881 /**
bpatel@766 882 * Get the marker anchor which will be added to the documentation tree.
bpatel@766 883 *
bpatel@766 884 * @param anchorName the anchor name attribute
bpatel@766 885 * @return a content tree for the marker anchor
bpatel@766 886 */
bpatel@766 887 public Content getMarkerAnchor(String anchorName) {
bpatel@766 888 return getMarkerAnchor(anchorName, null);
bpatel@766 889 }
bpatel@766 890
bpatel@766 891 /**
bpatel@766 892 * Get the marker anchor which will be added to the documentation tree.
bpatel@766 893 *
bpatel@766 894 * @param anchorName the anchor name attribute
bpatel@766 895 * @param anchorContent the content that should be added to the anchor
bpatel@766 896 * @return a content tree for the marker anchor
bpatel@766 897 */
bpatel@766 898 public Content getMarkerAnchor(String anchorName, Content anchorContent) {
bpatel@766 899 if (anchorContent == null)
bpatel@766 900 anchorContent = new Comment(" ");
bpatel@766 901 Content markerAnchor = HtmlTree.A_NAME(anchorName, anchorContent);
bpatel@766 902 return markerAnchor;
bpatel@766 903 }
bpatel@766 904
bpatel@766 905 /**
bpatel@766 906 * Returns a packagename content.
bpatel@766 907 *
bpatel@766 908 * @param packageDoc the package to check
bpatel@766 909 * @return package name content
bpatel@766 910 */
bpatel@766 911 public Content getPackageName(PackageDoc packageDoc) {
bpatel@766 912 return packageDoc == null || packageDoc.name().length() == 0 ?
bpatel@766 913 defaultPackageLabel :
bpatel@766 914 getPackageLabel(packageDoc.name());
bpatel@766 915 }
bpatel@766 916
bpatel@766 917 /**
bpatel@766 918 * Returns a package name label.
bpatel@766 919 *
jjg@1358 920 * @param packageName the package name
bpatel@766 921 * @return the package name content
bpatel@766 922 */
bpatel@766 923 public Content getPackageLabel(String packageName) {
bpatel@766 924 return new StringContent(packageName);
bpatel@766 925 }
bpatel@766 926
bpatel@766 927 /**
bpatel@995 928 * Add package deprecation information to the documentation tree
bpatel@995 929 *
bpatel@995 930 * @param deprPkgs list of deprecated packages
bpatel@995 931 * @param headingKey the caption for the deprecated package table
bpatel@995 932 * @param tableSummary the summary for the deprecated package table
bpatel@995 933 * @param tableHeader table headers for the deprecated package table
bpatel@995 934 * @param contentTree the content tree to which the deprecated package table will be added
bpatel@995 935 */
bpatel@995 936 protected void addPackageDeprecatedAPI(List<Doc> deprPkgs, String headingKey,
bpatel@995 937 String tableSummary, String[] tableHeader, Content contentTree) {
bpatel@995 938 if (deprPkgs.size() > 0) {
bpatel@995 939 Content table = HtmlTree.TABLE(0, 3, 0, tableSummary,
jjg@1747 940 getTableCaption(configuration.getResource(headingKey)));
bpatel@995 941 table.addContent(getSummaryTableHeader(tableHeader, "col"));
bpatel@995 942 Content tbody = new HtmlTree(HtmlTag.TBODY);
bpatel@995 943 for (int i = 0; i < deprPkgs.size(); i++) {
bpatel@995 944 PackageDoc pkg = (PackageDoc) deprPkgs.get(i);
bpatel@995 945 HtmlTree td = HtmlTree.TD(HtmlStyle.colOne,
bpatel@995 946 getPackageLink(pkg, getPackageName(pkg)));
bpatel@995 947 if (pkg.tags("deprecated").length > 0) {
bpatel@995 948 addInlineDeprecatedComment(pkg, pkg.tags("deprecated")[0], td);
bpatel@995 949 }
bpatel@995 950 HtmlTree tr = HtmlTree.TR(td);
bpatel@995 951 if (i % 2 == 0) {
bpatel@995 952 tr.addStyle(HtmlStyle.altColor);
bpatel@995 953 } else {
bpatel@995 954 tr.addStyle(HtmlStyle.rowColor);
bpatel@995 955 }
bpatel@995 956 tbody.addContent(tr);
bpatel@995 957 }
bpatel@995 958 table.addContent(tbody);
bpatel@995 959 Content li = HtmlTree.LI(HtmlStyle.blockList, table);
bpatel@995 960 Content ul = HtmlTree.UL(HtmlStyle.blockList, li);
bpatel@995 961 contentTree.addContent(ul);
bpatel@995 962 }
bpatel@995 963 }
bpatel@995 964
bpatel@995 965 /**
jjg@1381 966 * Return the path to the class page for a classdoc.
duke@1 967 *
duke@1 968 * @param cd Class to which the path is requested.
duke@1 969 * @param name Name of the file(doesn't include path).
duke@1 970 */
jjg@1372 971 protected DocPath pathString(ClassDoc cd, DocPath name) {
duke@1 972 return pathString(cd.containingPackage(), name);
duke@1 973 }
duke@1 974
duke@1 975 /**
duke@1 976 * Return path to the given file name in the given package. So if the name
duke@1 977 * passed is "Object.html" and the name of the package is "java.lang", and
duke@1 978 * if the relative path is "../.." then returned string will be
duke@1 979 * "../../java/lang/Object.html"
duke@1 980 *
duke@1 981 * @param pd Package in which the file name is assumed to be.
duke@1 982 * @param name File name, to which path string is.
duke@1 983 */
jjg@1372 984 protected DocPath pathString(PackageDoc pd, DocPath name) {
jjg@1372 985 return pathToRoot.resolve(DocPath.forPackage(pd).resolve(name));
duke@1 986 }
duke@1 987
duke@1 988 /**
duke@1 989 * Return the link to the given package.
duke@1 990 *
duke@1 991 * @param pkg the package to link to.
duke@1 992 * @param label the label for the link.
bpatel@766 993 * @return a content tree for the package link.
bpatel@766 994 */
jjg@1740 995 public Content getPackageLink(PackageDoc pkg, String label) {
jjg@1740 996 return getPackageLink(pkg, new StringContent(label));
jjg@1740 997 }
jjg@1740 998
jjg@1740 999 /**
jjg@1740 1000 * Return the link to the given package.
jjg@1740 1001 *
jjg@1740 1002 * @param pkg the package to link to.
jjg@1740 1003 * @param label the label for the link.
jjg@1740 1004 * @return a content tree for the package link.
jjg@1740 1005 */
bpatel@766 1006 public Content getPackageLink(PackageDoc pkg, Content label) {
bpatel@766 1007 boolean included = pkg != null && pkg.isIncluded();
bpatel@766 1008 if (! included) {
bpatel@766 1009 PackageDoc[] packages = configuration.packages;
bpatel@766 1010 for (int i = 0; i < packages.length; i++) {
bpatel@766 1011 if (packages[i].equals(pkg)) {
bpatel@766 1012 included = true;
bpatel@766 1013 break;
bpatel@766 1014 }
bpatel@766 1015 }
bpatel@766 1016 }
bpatel@766 1017 if (included || pkg == null) {
jjg@1372 1018 return getHyperLink(pathString(pkg, DocPaths.PACKAGE_SUMMARY),
jjg@1373 1019 label);
bpatel@766 1020 } else {
jjg@1373 1021 DocLink crossPkgLink = getCrossPackageLink(Util.getPackageName(pkg));
bpatel@766 1022 if (crossPkgLink != null) {
jjg@1373 1023 return getHyperLink(crossPkgLink, label);
duke@1 1024 } else {
duke@1 1025 return label;
duke@1 1026 }
duke@1 1027 }
duke@1 1028 }
duke@1 1029
jjg@1737 1030 public Content italicsClassName(ClassDoc cd, boolean qual) {
jjg@1737 1031 Content name = new StringContent((qual)? cd.qualifiedName(): cd.name());
jjg@1737 1032 return (cd.isInterface())? HtmlTree.I(name): name;
duke@1 1033 }
duke@1 1034
duke@1 1035 /**
bpatel@766 1036 * Add the link to the content tree.
bpatel@766 1037 *
bpatel@766 1038 * @param doc program element doc for which the link will be added
bpatel@766 1039 * @param label label for the link
bpatel@766 1040 * @param htmltree the content tree to which the link will be added
bpatel@766 1041 */
bpatel@766 1042 public void addSrcLink(ProgramElementDoc doc, Content label, Content htmltree) {
bpatel@766 1043 if (doc == null) {
bpatel@766 1044 return;
bpatel@766 1045 }
bpatel@766 1046 ClassDoc cd = doc.containingClass();
bpatel@766 1047 if (cd == null) {
bpatel@766 1048 //d must be a class doc since in has no containing class.
bpatel@766 1049 cd = (ClassDoc) doc;
bpatel@766 1050 }
jjg@1372 1051 DocPath href = pathToRoot
jjg@1372 1052 .resolve(DocPaths.SOURCE_OUTPUT)
jjg@1372 1053 .resolve(DocPath.forClass(cd));
jjg@1373 1054 Content linkContent = getHyperLink(href.fragment(SourceToHTMLConverter.getAnchorName(doc)), label, "", "");
bpatel@766 1055 htmltree.addContent(linkContent);
bpatel@766 1056 }
bpatel@766 1057
bpatel@766 1058 /**
duke@1 1059 * Return the link to the given class.
duke@1 1060 *
duke@1 1061 * @param linkInfo the information about the link.
duke@1 1062 *
duke@1 1063 * @return the link for the given class.
duke@1 1064 */
jjg@1736 1065 public Content getLink(LinkInfoImpl linkInfo) {
duke@1 1066 LinkFactoryImpl factory = new LinkFactoryImpl(this);
jjg@1741 1067 return factory.getLink(linkInfo);
duke@1 1068 }
duke@1 1069
duke@1 1070 /**
duke@1 1071 * Return the type parameters for the given class.
duke@1 1072 *
duke@1 1073 * @param linkInfo the information about the link.
duke@1 1074 * @return the type for the given class.
duke@1 1075 */
jjg@1736 1076 public Content getTypeParameterLinks(LinkInfoImpl linkInfo) {
duke@1 1077 LinkFactoryImpl factory = new LinkFactoryImpl(this);
jjg@1736 1078 return factory.getTypeParameterLinks(linkInfo, false);
duke@1 1079 }
duke@1 1080
duke@1 1081 /*************************************************************
duke@1 1082 * Return a class cross link to external class documentation.
duke@1 1083 * The name must be fully qualified to determine which package
duke@1 1084 * the class is in. The -link option does not allow users to
duke@1 1085 * link to external classes in the "default" package.
duke@1 1086 *
duke@1 1087 * @param qualifiedClassName the qualified name of the external class.
duke@1 1088 * @param refMemName the name of the member being referenced. This should
duke@1 1089 * be null or empty string if no member is being referenced.
duke@1 1090 * @param label the label for the external link.
bpatel@182 1091 * @param strong true if the link should be strong.
duke@1 1092 * @param style the style of the link.
duke@1 1093 * @param code true if the label should be code font.
duke@1 1094 */
jjg@1737 1095 public Content getCrossClassLink(String qualifiedClassName, String refMemName,
jjg@1737 1096 Content label, boolean strong, String style,
duke@1 1097 boolean code) {
jjg@1373 1098 String className = "";
jjg@1373 1099 String packageName = qualifiedClassName == null ? "" : qualifiedClassName;
duke@1 1100 int periodIndex;
jjg@1373 1101 while ((periodIndex = packageName.lastIndexOf('.')) != -1) {
duke@1 1102 className = packageName.substring(periodIndex + 1, packageName.length()) +
duke@1 1103 (className.length() > 0 ? "." + className : "");
jjg@1737 1104 Content defaultLabel = new StringContent(className);
jjg@1737 1105 if (code)
jjg@1737 1106 defaultLabel = HtmlTree.CODE(defaultLabel);
duke@1 1107 packageName = packageName.substring(0, periodIndex);
duke@1 1108 if (getCrossPackageLink(packageName) != null) {
duke@1 1109 //The package exists in external documentation, so link to the external
duke@1 1110 //class (assuming that it exists). This is definitely a limitation of
duke@1 1111 //the -link option. There are ways to determine if an external package
duke@1 1112 //exists, but no way to determine if the external class exists. We just
duke@1 1113 //have to assume that it does.
jjg@1373 1114 DocLink link = configuration.extern.getExternalLink(packageName, pathToRoot,
jjg@1373 1115 className + ".html", refMemName);
jjg@1737 1116 return getHyperLink(link,
jjg@1737 1117 (label == null) || label.isEmpty() ? defaultLabel : label,
bpatel@182 1118 strong, style,
duke@1 1119 configuration.getText("doclet.Href_Class_Or_Interface_Title", packageName),
duke@1 1120 "");
duke@1 1121 }
duke@1 1122 }
duke@1 1123 return null;
duke@1 1124 }
duke@1 1125
duke@1 1126 public boolean isClassLinkable(ClassDoc cd) {
duke@1 1127 if (cd.isIncluded()) {
duke@1 1128 return configuration.isGeneratedDoc(cd);
duke@1 1129 }
duke@1 1130 return configuration.extern.isExternal(cd);
duke@1 1131 }
duke@1 1132
jjg@1373 1133 public DocLink getCrossPackageLink(String pkgName) {
jjg@1372 1134 return configuration.extern.getExternalLink(pkgName, pathToRoot,
jjg@1373 1135 DocPaths.PACKAGE_SUMMARY.getPath());
duke@1 1136 }
duke@1 1137
bpatel@766 1138 /**
bpatel@766 1139 * Get the class link.
bpatel@766 1140 *
bpatel@766 1141 * @param context the id of the context where the link will be added
bpatel@766 1142 * @param cd the class doc to link to
bpatel@766 1143 * @return a content tree for the link
bpatel@766 1144 */
jjg@1735 1145 public Content getQualifiedClassLink(LinkInfoImpl.Kind context, ClassDoc cd) {
jjg@1738 1146 return getLink(new LinkInfoImpl(configuration, context, cd)
jjg@1738 1147 .label(configuration.getClassName(cd)));
duke@1 1148 }
duke@1 1149
duke@1 1150 /**
bpatel@766 1151 * Add the class link.
bpatel@766 1152 *
bpatel@766 1153 * @param context the id of the context where the link will be added
bpatel@766 1154 * @param cd the class doc to link to
bpatel@766 1155 * @param contentTree the content tree to which the link will be added
duke@1 1156 */
jjg@1735 1157 public void addPreQualifiedClassLink(LinkInfoImpl.Kind context, ClassDoc cd, Content contentTree) {
bpatel@766 1158 addPreQualifiedClassLink(context, cd, false, contentTree);
duke@1 1159 }
duke@1 1160
duke@1 1161 /**
duke@1 1162 * Retrieve the class link with the package portion of the label in
jjg@1373 1163 * plain text. If the qualifier is excluded, it will not be included in the
duke@1 1164 * link label.
duke@1 1165 *
duke@1 1166 * @param cd the class to link to.
bpatel@182 1167 * @param isStrong true if the link should be strong.
duke@1 1168 * @return the link with the package portion of the label in plain text.
duke@1 1169 */
jjg@1737 1170 public Content getPreQualifiedClassLink(LinkInfoImpl.Kind context,
bpatel@182 1171 ClassDoc cd, boolean isStrong) {
jjg@1737 1172 ContentBuilder classlink = new ContentBuilder();
duke@1 1173 PackageDoc pd = cd.containingPackage();
jjg@1737 1174 if (pd != null && ! configuration.shouldExcludeQualifier(pd.name())) {
jjg@1737 1175 classlink.addContent(getPkgName(cd));
duke@1 1176 }
jjg@1737 1177 classlink.addContent(getLink(new LinkInfoImpl(configuration,
jjg@1738 1178 context, cd).label(cd.name()).strong(isStrong)));
duke@1 1179 return classlink;
duke@1 1180 }
duke@1 1181
bpatel@766 1182 /**
bpatel@766 1183 * Add the class link with the package portion of the label in
bpatel@766 1184 * plain text. If the qualifier is excluded, it will not be included in the
bpatel@766 1185 * link label.
bpatel@766 1186 *
bpatel@766 1187 * @param context the id of the context where the link will be added
bpatel@766 1188 * @param cd the class to link to
bpatel@766 1189 * @param isStrong true if the link should be strong
bpatel@766 1190 * @param contentTree the content tree to which the link with be added
bpatel@766 1191 */
jjg@1735 1192 public void addPreQualifiedClassLink(LinkInfoImpl.Kind context,
bpatel@766 1193 ClassDoc cd, boolean isStrong, Content contentTree) {
bpatel@766 1194 PackageDoc pd = cd.containingPackage();
bpatel@766 1195 if(pd != null && ! configuration.shouldExcludeQualifier(pd.name())) {
bpatel@766 1196 contentTree.addContent(getPkgName(cd));
bpatel@766 1197 }
jjg@1736 1198 contentTree.addContent(getLink(new LinkInfoImpl(configuration,
jjg@1738 1199 context, cd).label(cd.name()).strong(isStrong)));
bpatel@766 1200 }
duke@1 1201
duke@1 1202 /**
bpatel@766 1203 * Add the class link, with only class name as the strong link and prefixing
duke@1 1204 * plain package name.
bpatel@766 1205 *
bpatel@766 1206 * @param context the id of the context where the link will be added
bpatel@766 1207 * @param cd the class to link to
bpatel@766 1208 * @param contentTree the content tree to which the link with be added
duke@1 1209 */
jjg@1735 1210 public void addPreQualifiedStrongClassLink(LinkInfoImpl.Kind context, ClassDoc cd, Content contentTree) {
bpatel@766 1211 addPreQualifiedClassLink(context, cd, true, contentTree);
duke@1 1212 }
duke@1 1213
duke@1 1214 /**
bpatel@766 1215 * Get the link for the given member.
duke@1 1216 *
bpatel@766 1217 * @param context the id of the context where the link will be added
bpatel@766 1218 * @param doc the member being linked to
bpatel@766 1219 * @param label the label for the link
bpatel@766 1220 * @return a content tree for the doc link
duke@1 1221 */
jjg@1735 1222 public Content getDocLink(LinkInfoImpl.Kind context, MemberDoc doc, String label) {
jjg@1737 1223 return getDocLink(context, doc.containingClass(), doc,
jjg@1737 1224 new StringContent(label));
duke@1 1225 }
duke@1 1226
duke@1 1227 /**
duke@1 1228 * Return the link for the given member.
duke@1 1229 *
duke@1 1230 * @param context the id of the context where the link will be printed.
duke@1 1231 * @param doc the member being linked to.
duke@1 1232 * @param label the label for the link.
bpatel@182 1233 * @param strong true if the link should be strong.
duke@1 1234 * @return the link for the given member.
duke@1 1235 */
jjg@1736 1236 public Content getDocLink(LinkInfoImpl.Kind context, MemberDoc doc, String label,
jjg@1736 1237 boolean strong) {
bpatel@182 1238 return getDocLink(context, doc.containingClass(), doc, label, strong);
duke@1 1239 }
duke@1 1240
duke@1 1241 /**
duke@1 1242 * Return the link for the given member.
duke@1 1243 *
duke@1 1244 * @param context the id of the context where the link will be printed.
duke@1 1245 * @param classDoc the classDoc that we should link to. This is not
duke@1 1246 * necessarily equal to doc.containingClass(). We may be
duke@1 1247 * inheriting comments.
duke@1 1248 * @param doc the member being linked to.
duke@1 1249 * @param label the label for the link.
bpatel@182 1250 * @param strong true if the link should be strong.
duke@1 1251 * @return the link for the given member.
duke@1 1252 */
jjg@1736 1253 public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc,
jjg@1736 1254 String label, boolean strong) {
jjg@1606 1255 return getDocLink(context, classDoc, doc, label, strong, false);
jjg@1606 1256 }
jjg@1746 1257 public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc,
jjg@1746 1258 Content label, boolean strong) {
jjg@1746 1259 return getDocLink(context, classDoc, doc, label, strong, false);
jjg@1746 1260 }
jjg@1606 1261
jjg@1606 1262 /**
jjg@1606 1263 * Return the link for the given member.
jjg@1606 1264 *
jjg@1606 1265 * @param context the id of the context where the link will be printed.
jjg@1606 1266 * @param classDoc the classDoc that we should link to. This is not
jjg@1606 1267 * necessarily equal to doc.containingClass(). We may be
jjg@1606 1268 * inheriting comments.
jjg@1606 1269 * @param doc the member being linked to.
jjg@1606 1270 * @param label the label for the link.
jjg@1606 1271 * @param strong true if the link should be strong.
jjg@1606 1272 * @param isProperty true if the doc parameter is a JavaFX property.
jjg@1606 1273 * @return the link for the given member.
jjg@1606 1274 */
jjg@1736 1275 public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc,
jjg@1737 1276 String label, boolean strong, boolean isProperty) {
jjg@1746 1277 return getDocLink(context, classDoc, doc, new StringContent(check(label)), strong, isProperty);
jjg@1746 1278 }
jjg@1746 1279
jjg@1746 1280 String check(String s) {
jjg@1746 1281 if (s.matches(".*[&<>].*"))throw new IllegalArgumentException(s);
jjg@1746 1282 return s;
jjg@1737 1283 }
jjg@1737 1284
jjg@1737 1285 public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc,
jjg@1737 1286 Content label, boolean strong, boolean isProperty) {
duke@1 1287 if (! (doc.isIncluded() ||
jjg@1410 1288 Util.isLinkable(classDoc, configuration))) {
jjg@1737 1289 return label;
duke@1 1290 } else if (doc instanceof ExecutableMemberDoc) {
duke@1 1291 ExecutableMemberDoc emd = (ExecutableMemberDoc)doc;
jjg@1738 1292 return getLink(new LinkInfoImpl(configuration, context, classDoc)
jjg@1738 1293 .label(label).where(getAnchor(emd, isProperty)).strong(strong));
duke@1 1294 } else if (doc instanceof MemberDoc) {
jjg@1738 1295 return getLink(new LinkInfoImpl(configuration, context, classDoc)
jjg@1738 1296 .label(label).where(doc.name()).strong(strong));
duke@1 1297 } else {
jjg@1737 1298 return label;
duke@1 1299 }
duke@1 1300 }
duke@1 1301
bpatel@766 1302 /**
bpatel@766 1303 * Return the link for the given member.
bpatel@766 1304 *
bpatel@766 1305 * @param context the id of the context where the link will be added
bpatel@766 1306 * @param classDoc the classDoc that we should link to. This is not
bpatel@766 1307 * necessarily equal to doc.containingClass(). We may be
bpatel@766 1308 * inheriting comments
bpatel@766 1309 * @param doc the member being linked to
bpatel@766 1310 * @param label the label for the link
bpatel@766 1311 * @return the link for the given member
bpatel@766 1312 */
jjg@1735 1313 public Content getDocLink(LinkInfoImpl.Kind context, ClassDoc classDoc, MemberDoc doc,
jjg@1737 1314 Content label) {
bpatel@766 1315 if (! (doc.isIncluded() ||
jjg@1410 1316 Util.isLinkable(classDoc, configuration))) {
jjg@1737 1317 return label;
bpatel@766 1318 } else if (doc instanceof ExecutableMemberDoc) {
jjg@1738 1319 ExecutableMemberDoc emd = (ExecutableMemberDoc) doc;
jjg@1738 1320 return getLink(new LinkInfoImpl(configuration, context, classDoc)
jjg@1738 1321 .label(label).where(getAnchor(emd)));
bpatel@766 1322 } else if (doc instanceof MemberDoc) {
jjg@1738 1323 return getLink(new LinkInfoImpl(configuration, context, classDoc)
jjg@1738 1324 .label(label).where(doc.name()));
bpatel@766 1325 } else {
jjg@1737 1326 return label;
bpatel@766 1327 }
bpatel@766 1328 }
bpatel@766 1329
duke@1 1330 public String getAnchor(ExecutableMemberDoc emd) {
jjg@1606 1331 return getAnchor(emd, false);
jjg@1606 1332 }
jjg@1606 1333
jjg@1606 1334 public String getAnchor(ExecutableMemberDoc emd, boolean isProperty) {
jjg@1606 1335 if (isProperty) {
jjg@1606 1336 return emd.name();
jjg@1606 1337 }
duke@1 1338 StringBuilder signature = new StringBuilder(emd.signature());
duke@1 1339 StringBuilder signatureParsed = new StringBuilder();
duke@1 1340 int counter = 0;
duke@1 1341 for (int i = 0; i < signature.length(); i++) {
duke@1 1342 char c = signature.charAt(i);
duke@1 1343 if (c == '<') {
duke@1 1344 counter++;
duke@1 1345 } else if (c == '>') {
duke@1 1346 counter--;
duke@1 1347 } else if (counter == 0) {
duke@1 1348 signatureParsed.append(c);
duke@1 1349 }
duke@1 1350 }
duke@1 1351 return emd.name() + signatureParsed.toString();
duke@1 1352 }
duke@1 1353
jjg@1745 1354 public Content seeTagToContent(SeeTag see) {
duke@1 1355 String tagName = see.name();
duke@1 1356 if (! (tagName.startsWith("@link") || tagName.equals("@see"))) {
jjg@1745 1357 return new ContentBuilder();
duke@1 1358 }
jjg@1365 1359
duke@1 1360 String seetext = replaceDocRootDir(see.text());
duke@1 1361
duke@1 1362 //Check if @see is an href or "string"
duke@1 1363 if (seetext.startsWith("<") || seetext.startsWith("\"")) {
jjg@1745 1364 return new RawHtml(seetext);
duke@1 1365 }
duke@1 1366
jjg@1365 1367 boolean plain = tagName.equalsIgnoreCase("@linkplain");
jjg@1737 1368 Content label = plainOrCode(plain, new RawHtml(see.label()));
jjg@1365 1369
duke@1 1370 //The text from the @see tag. We will output this text when a label is not specified.
jjg@1737 1371 Content text = plainOrCode(plain, new RawHtml(seetext));
duke@1 1372
duke@1 1373 ClassDoc refClass = see.referencedClass();
duke@1 1374 String refClassName = see.referencedClassName();
duke@1 1375 MemberDoc refMem = see.referencedMember();
duke@1 1376 String refMemName = see.referencedMemberName();
jjg@1365 1377
duke@1 1378 if (refClass == null) {
duke@1 1379 //@see is not referencing an included class
duke@1 1380 PackageDoc refPackage = see.referencedPackage();
duke@1 1381 if (refPackage != null && refPackage.isIncluded()) {
duke@1 1382 //@see is referencing an included package
jjg@1365 1383 if (label.isEmpty())
jjg@1737 1384 label = plainOrCode(plain, new StringContent(refPackage.name()));
jjg@1745 1385 return getPackageLink(refPackage, label);
duke@1 1386 } else {
duke@1 1387 //@see is not referencing an included class or package. Check for cross links.
jjg@1737 1388 Content classCrossLink;
jjg@1373 1389 DocLink packageCrossLink = getCrossPackageLink(refClassName);
duke@1 1390 if (packageCrossLink != null) {
duke@1 1391 //Package cross link found
jjg@1737 1392 return getHyperLink(packageCrossLink,
jjg@1745 1393 (label.isEmpty() ? text : label));
duke@1 1394 } else if ((classCrossLink = getCrossClassLink(refClassName,
jjg@1365 1395 refMemName, label, false, "", !plain)) != null) {
jjg@1365 1396 //Class cross link found (possibly to a member in the class)
jjg@1745 1397 return classCrossLink;
duke@1 1398 } else {
duke@1 1399 //No cross link found so print warning
duke@1 1400 configuration.getDocletSpecificMsg().warning(see.position(), "doclet.see.class_or_package_not_found",
duke@1 1401 tagName, seetext);
jjg@1745 1402 return (label.isEmpty() ? text: label);
duke@1 1403 }
duke@1 1404 }
duke@1 1405 } else if (refMemName == null) {
duke@1 1406 // Must be a class reference since refClass is not null and refMemName is null.
jjg@1365 1407 if (label.isEmpty()) {
jjg@1737 1408 label = plainOrCode(plain, new StringContent(refClass.name()));
duke@1 1409 }
jjg@1738 1410 return getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.DEFAULT, refClass)
jjg@1745 1411 .label(label));
duke@1 1412 } else if (refMem == null) {
duke@1 1413 // Must be a member reference since refClass is not null and refMemName is not null.
duke@1 1414 // However, refMem is null, so this referenced member does not exist.
jjg@1745 1415 return (label.isEmpty() ? text: label);
duke@1 1416 } else {
duke@1 1417 // Must be a member reference since refClass is not null and refMemName is not null.
duke@1 1418 // refMem is not null, so this @see tag must be referencing a valid member.
duke@1 1419 ClassDoc containing = refMem.containingClass();
duke@1 1420 if (see.text().trim().startsWith("#") &&
duke@1 1421 ! (containing.isPublic() ||
jjg@1410 1422 Util.isLinkable(containing, configuration))) {
duke@1 1423 // Since the link is relative and the holder is not even being
duke@1 1424 // documented, this must be an inherited link. Redirect it.
duke@1 1425 // The current class either overrides the referenced member or
duke@1 1426 // inherits it automatically.
jjg@405 1427 if (this instanceof ClassWriterImpl) {
jjg@405 1428 containing = ((ClassWriterImpl) this).getClassDoc();
jjg@405 1429 } else if (!containing.isPublic()){
jjg@405 1430 configuration.getDocletSpecificMsg().warning(
jjg@405 1431 see.position(), "doclet.see.class_or_package_not_accessible",
jjg@405 1432 tagName, containing.qualifiedName());
jjg@405 1433 } else {
jjg@405 1434 configuration.getDocletSpecificMsg().warning(
jjg@405 1435 see.position(), "doclet.see.class_or_package_not_found",
jjg@405 1436 tagName, seetext);
jjg@405 1437 }
duke@1 1438 }
duke@1 1439 if (configuration.currentcd != containing) {
duke@1 1440 refMemName = containing.name() + "." + refMemName;
duke@1 1441 }
duke@1 1442 if (refMem instanceof ExecutableMemberDoc) {
duke@1 1443 if (refMemName.indexOf('(') < 0) {
duke@1 1444 refMemName += ((ExecutableMemberDoc)refMem).signature();
duke@1 1445 }
duke@1 1446 }
duke@1 1447
jjg@1737 1448 text = plainOrCode(plain, new StringContent(refMemName));
jjg@1365 1449
jjg@1735 1450 return getDocLink(LinkInfoImpl.Kind.SEE_TAG, containing,
jjg@1746 1451 refMem, (label.isEmpty() ? text: label), false);
duke@1 1452 }
duke@1 1453 }
duke@1 1454
jjg@1737 1455 private Content plainOrCode(boolean plain, Content body) {
jjg@1737 1456 return (plain || body.isEmpty()) ? body : HtmlTree.CODE(body);
jjg@1737 1457 }
jjg@1737 1458
bpatel@766 1459 /**
bpatel@766 1460 * Add the inline comment.
bpatel@766 1461 *
bpatel@766 1462 * @param doc the doc for which the inline comment will be added
bpatel@766 1463 * @param tag the inline tag to be added
bpatel@766 1464 * @param htmltree the content tree to which the comment will be added
bpatel@766 1465 */
bpatel@766 1466 public void addInlineComment(Doc doc, Tag tag, Content htmltree) {
jjg@1724 1467 addCommentTags(doc, tag, tag.inlineTags(), false, false, htmltree);
bpatel@766 1468 }
bpatel@766 1469
bpatel@766 1470 /**
bpatel@766 1471 * Add the inline deprecated comment.
bpatel@766 1472 *
bpatel@766 1473 * @param doc the doc for which the inline deprecated comment will be added
bpatel@766 1474 * @param tag the inline tag to be added
bpatel@766 1475 * @param htmltree the content tree to which the comment will be added
bpatel@766 1476 */
bpatel@766 1477 public void addInlineDeprecatedComment(Doc doc, Tag tag, Content htmltree) {
bpatel@766 1478 addCommentTags(doc, tag.inlineTags(), true, false, htmltree);
bpatel@766 1479 }
bpatel@766 1480
bpatel@766 1481 /**
bpatel@766 1482 * Adds the summary content.
bpatel@766 1483 *
bpatel@766 1484 * @param doc the doc for which the summary will be generated
bpatel@766 1485 * @param htmltree the documentation tree to which the summary will be added
bpatel@766 1486 */
bpatel@766 1487 public void addSummaryComment(Doc doc, Content htmltree) {
bpatel@766 1488 addSummaryComment(doc, doc.firstSentenceTags(), htmltree);
bpatel@766 1489 }
bpatel@766 1490
bpatel@766 1491 /**
bpatel@766 1492 * Adds the summary content.
bpatel@766 1493 *
bpatel@766 1494 * @param doc the doc for which the summary will be generated
bpatel@766 1495 * @param firstSentenceTags the first sentence tags for the doc
bpatel@766 1496 * @param htmltree the documentation tree to which the summary will be added
bpatel@766 1497 */
bpatel@766 1498 public void addSummaryComment(Doc doc, Tag[] firstSentenceTags, Content htmltree) {
bpatel@766 1499 addCommentTags(doc, firstSentenceTags, false, true, htmltree);
bpatel@766 1500 }
bpatel@766 1501
bpatel@766 1502 public void addSummaryDeprecatedComment(Doc doc, Tag tag, Content htmltree) {
bpatel@766 1503 addCommentTags(doc, tag.firstSentenceTags(), true, true, htmltree);
bpatel@766 1504 }
bpatel@766 1505
bpatel@766 1506 /**
bpatel@766 1507 * Adds the inline comment.
bpatel@766 1508 *
bpatel@766 1509 * @param doc the doc for which the inline comments will be generated
bpatel@766 1510 * @param htmltree the documentation tree to which the inline comments will be added
bpatel@766 1511 */
bpatel@766 1512 public void addInlineComment(Doc doc, Content htmltree) {
bpatel@766 1513 addCommentTags(doc, doc.inlineTags(), false, false, htmltree);
bpatel@766 1514 }
bpatel@766 1515
duke@1 1516 /**
bpatel@766 1517 * Adds the comment tags.
bpatel@766 1518 *
bpatel@766 1519 * @param doc the doc for which the comment tags will be generated
bpatel@766 1520 * @param tags the first sentence tags for the doc
bpatel@766 1521 * @param depr true if it is deprecated
jjg@1372 1522 * @param first true if the first sentence tags should be added
bpatel@766 1523 * @param htmltree the documentation tree to which the comment tags will be added
bpatel@766 1524 */
bpatel@766 1525 private void addCommentTags(Doc doc, Tag[] tags, boolean depr,
bpatel@766 1526 boolean first, Content htmltree) {
jjg@1724 1527 addCommentTags(doc, null, tags, depr, first, htmltree);
jjg@1724 1528 }
jjg@1724 1529
jjg@1724 1530 /**
jjg@1724 1531 * Adds the comment tags.
jjg@1724 1532 *
jjg@1724 1533 * @param doc the doc for which the comment tags will be generated
jjg@1724 1534 * @param holderTag the block tag context for the inline tags
jjg@1724 1535 * @param tags the first sentence tags for the doc
jjg@1724 1536 * @param depr true if it is deprecated
jjg@1724 1537 * @param first true if the first sentence tags should be added
jjg@1724 1538 * @param htmltree the documentation tree to which the comment tags will be added
jjg@1724 1539 */
jjg@1724 1540 private void addCommentTags(Doc doc, Tag holderTag, Tag[] tags, boolean depr,
jjg@1724 1541 boolean first, Content htmltree) {
bpatel@766 1542 if(configuration.nocomment){
bpatel@766 1543 return;
bpatel@766 1544 }
bpatel@766 1545 Content div;
jjg@1745 1546 Content result = commentTagsToContent(null, doc, tags, first);
bpatel@766 1547 if (depr) {
bpatel@766 1548 Content italic = HtmlTree.I(result);
bpatel@766 1549 div = HtmlTree.DIV(HtmlStyle.block, italic);
bpatel@766 1550 htmltree.addContent(div);
bpatel@766 1551 }
bpatel@766 1552 else {
bpatel@766 1553 div = HtmlTree.DIV(HtmlStyle.block, result);
bpatel@766 1554 htmltree.addContent(div);
bpatel@766 1555 }
bpatel@766 1556 if (tags.length == 0) {
bpatel@766 1557 htmltree.addContent(getSpace());
bpatel@766 1558 }
bpatel@766 1559 }
bpatel@766 1560
bpatel@766 1561 /**
duke@1 1562 * Converts inline tags and text to text strings, expanding the
duke@1 1563 * inline tags along the way. Called wherever text can contain
duke@1 1564 * an inline tag, such as in comments or in free-form text arguments
duke@1 1565 * to non-inline tags.
duke@1 1566 *
duke@1 1567 * @param holderTag specific tag where comment resides
duke@1 1568 * @param doc specific doc where comment resides
duke@1 1569 * @param tags array of text tags and inline tags (often alternating)
duke@1 1570 * present in the text of interest for this doc
duke@1 1571 * @param isFirstSentence true if text is first sentence
duke@1 1572 */
jjg@1745 1573 public Content commentTagsToContent(Tag holderTag, Doc doc, Tag[] tags,
duke@1 1574 boolean isFirstSentence) {
jjg@1747 1575 Content result = new ContentBuilder();
bpatel@997 1576 boolean textTagChange = false;
duke@1 1577 // Array of all possible inline tags for this javadoc run
duke@1 1578 configuration.tagletManager.checkTags(doc, tags, true);
duke@1 1579 for (int i = 0; i < tags.length; i++) {
duke@1 1580 Tag tagelem = tags[i];
duke@1 1581 String tagName = tagelem.name();
duke@1 1582 if (tagelem instanceof SeeTag) {
jjg@1745 1583 result.addContent(seeTagToContent((SeeTag) tagelem));
duke@1 1584 } else if (! tagName.equals("Text")) {
jjg@1745 1585 boolean wasEmpty = result.isEmpty();
duke@1 1586 TagletOutput output = TagletWriter.getInlineTagOuput(
duke@1 1587 configuration.tagletManager, holderTag,
jjg@74 1588 tagelem, getTagletWriterInstance(isFirstSentence));
jjg@1745 1589 if (output != null)
jjg@1745 1590 result.addContent(((TagletOutputImpl) output).getContent());
jjg@1745 1591 if (wasEmpty && isFirstSentence && tagelem.name().equals("@inheritDoc") && !result.isEmpty()) {
duke@1 1592 break;
bpatel@997 1593 } else if (configuration.docrootparent.length() > 0 &&
bpatel@997 1594 tagelem.name().equals("@docRoot") &&
bpatel@997 1595 ((tags[i + 1]).text()).startsWith("/..")) {
bpatel@997 1596 //If Xdocrootparent switch ON, set the flag to remove the /.. occurance after
bpatel@997 1597 //{@docRoot} tag in the very next Text tag.
bpatel@997 1598 textTagChange = true;
bpatel@997 1599 continue;
duke@1 1600 } else {
bpatel@997 1601 continue;
duke@1 1602 }
duke@1 1603 } else {
bpatel@997 1604 String text = tagelem.text();
bpatel@997 1605 //If Xdocrootparent switch ON, remove the /.. occurance after {@docRoot} tag.
bpatel@997 1606 if (textTagChange) {
bpatel@997 1607 text = text.replaceFirst("/..", "");
bpatel@997 1608 textTagChange = false;
bpatel@997 1609 }
duke@1 1610 //This is just a regular text tag. The text may contain html links (<a>)
duke@1 1611 //or inline tag {@docRoot}, which will be handled as special cases.
bpatel@997 1612 text = redirectRelativeLinks(tagelem.holder(), text);
duke@1 1613
duke@1 1614 // Replace @docRoot only if not represented by an instance of DocRootTaglet,
duke@1 1615 // that is, only if it was not present in a source file doc comment.
duke@1 1616 // This happens when inserted by the doclet (a few lines
duke@1 1617 // above in this method). [It might also happen when passed in on the command
duke@1 1618 // line as a text argument to an option (like -header).]
duke@1 1619 text = replaceDocRootDir(text);
duke@1 1620 if (isFirstSentence) {
duke@1 1621 text = removeNonInlineHtmlTags(text);
duke@1 1622 }
jjg@1748 1623 text = Util.replaceTabs(configuration, text);
jjg@1748 1624 result.addContent(new RawHtml(text));
duke@1 1625 }
duke@1 1626 }
jjg@1745 1627 return result;
duke@1 1628 }
duke@1 1629
duke@1 1630 /**
duke@1 1631 * Return true if relative links should not be redirected.
duke@1 1632 *
duke@1 1633 * @return Return true if a relative link should not be redirected.
duke@1 1634 */
duke@1 1635 private boolean shouldNotRedirectRelativeLinks() {
duke@1 1636 return this instanceof AnnotationTypeWriter ||
duke@1 1637 this instanceof ClassWriter ||
duke@1 1638 this instanceof PackageSummaryWriter;
duke@1 1639 }
duke@1 1640
duke@1 1641 /**
duke@1 1642 * Suppose a piece of documentation has a relative link. When you copy
jjg@1372 1643 * that documentation to another place such as the index or class-use page,
duke@1 1644 * that relative link will no longer work. We should redirect those links
duke@1 1645 * so that they will work again.
duke@1 1646 * <p>
duke@1 1647 * Here is the algorithm used to fix the link:
duke@1 1648 * <p>
jjg@1326 1649 * {@literal <relative link> => docRoot + <relative path to file> + <relative link> }
duke@1 1650 * <p>
duke@1 1651 * For example, suppose com.sun.javadoc.RootDoc has this link:
jjg@1326 1652 * {@literal <a href="package-summary.html">The package Page</a> }
duke@1 1653 * <p>
duke@1 1654 * If this link appeared in the index, we would redirect
duke@1 1655 * the link like this:
duke@1 1656 *
jjg@1326 1657 * {@literal <a href="./com/sun/javadoc/package-summary.html">The package Page</a>}
duke@1 1658 *
duke@1 1659 * @param doc the Doc object whose documentation is being written.
duke@1 1660 * @param text the text being written.
duke@1 1661 *
duke@1 1662 * @return the text, with all the relative links redirected to work.
duke@1 1663 */
duke@1 1664 private String redirectRelativeLinks(Doc doc, String text) {
duke@1 1665 if (doc == null || shouldNotRedirectRelativeLinks()) {
duke@1 1666 return text;
duke@1 1667 }
duke@1 1668
jjg@1372 1669 DocPath redirectPathFromRoot;
duke@1 1670 if (doc instanceof ClassDoc) {
jjg@1372 1671 redirectPathFromRoot = DocPath.forPackage(((ClassDoc) doc).containingPackage());
duke@1 1672 } else if (doc instanceof MemberDoc) {
jjg@1372 1673 redirectPathFromRoot = DocPath.forPackage(((MemberDoc) doc).containingPackage());
duke@1 1674 } else if (doc instanceof PackageDoc) {
jjg@1372 1675 redirectPathFromRoot = DocPath.forPackage((PackageDoc) doc);
duke@1 1676 } else {
duke@1 1677 return text;
duke@1 1678 }
duke@1 1679
duke@1 1680 //Redirect all relative links.
duke@1 1681 int end, begin = text.toLowerCase().indexOf("<a");
duke@1 1682 if(begin >= 0){
jjg@1362 1683 StringBuilder textBuff = new StringBuilder(text);
duke@1 1684
duke@1 1685 while(begin >=0){
duke@1 1686 if (textBuff.length() > begin + 2 && ! Character.isWhitespace(textBuff.charAt(begin+2))) {
duke@1 1687 begin = textBuff.toString().toLowerCase().indexOf("<a", begin + 1);
duke@1 1688 continue;
duke@1 1689 }
duke@1 1690
duke@1 1691 begin = textBuff.indexOf("=", begin) + 1;
duke@1 1692 end = textBuff.indexOf(">", begin +1);
duke@1 1693 if(begin == 0){
duke@1 1694 //Link has no equal symbol.
duke@1 1695 configuration.root.printWarning(
duke@1 1696 doc.position(),
duke@1 1697 configuration.getText("doclet.malformed_html_link_tag", text));
duke@1 1698 break;
duke@1 1699 }
duke@1 1700 if (end == -1) {
duke@1 1701 //Break without warning. This <a> tag is not necessarily malformed. The text
duke@1 1702 //might be missing '>' character because the href has an inline tag.
duke@1 1703 break;
duke@1 1704 }
jjg@1372 1705 if (textBuff.substring(begin, end).indexOf("\"") != -1){
duke@1 1706 begin = textBuff.indexOf("\"", begin) + 1;
duke@1 1707 end = textBuff.indexOf("\"", begin +1);
jjg@1372 1708 if (begin == 0 || end == -1){
duke@1 1709 //Link is missing a quote.
duke@1 1710 break;
duke@1 1711 }
duke@1 1712 }
duke@1 1713 String relativeLink = textBuff.substring(begin, end);
jjg@1372 1714 if (!(relativeLink.toLowerCase().startsWith("mailto:") ||
jjg@1372 1715 relativeLink.toLowerCase().startsWith("http:") ||
jjg@1372 1716 relativeLink.toLowerCase().startsWith("https:") ||
jjg@1372 1717 relativeLink.toLowerCase().startsWith("file:"))) {
jjg@1372 1718 relativeLink = "{@"+(new DocRootTaglet()).getName() + "}/"
jjg@1372 1719 + redirectPathFromRoot.resolve(relativeLink).getPath();
duke@1 1720 textBuff.replace(begin, end, relativeLink);
duke@1 1721 }
duke@1 1722 begin = textBuff.toString().toLowerCase().indexOf("<a", begin + 1);
duke@1 1723 }
duke@1 1724 return textBuff.toString();
duke@1 1725 }
duke@1 1726 return text;
duke@1 1727 }
duke@1 1728
jjg@1748 1729 static Set<String> blockTags = new HashSet<>();
jjg@1748 1730 static {
jjg@1748 1731 for (HtmlTag t: HtmlTag.values()) {
jjg@1748 1732 if (t.blockType == HtmlTag.BlockType.BLOCK)
jjg@1748 1733 blockTags.add(t.value);
jjg@1748 1734 }
jjg@1748 1735 }
jjg@1748 1736
jjg@1748 1737 public static String removeNonInlineHtmlTags(String text) {
jjg@1748 1738 final int len = text.length();
jjg@1748 1739
jjg@1748 1740 int startPos = 0; // start of text to copy
jjg@1748 1741 int lessThanPos = text.indexOf('<'); // position of latest '<'
jjg@1748 1742 if (lessThanPos < 0) {
duke@1 1743 return text;
duke@1 1744 }
jjg@1748 1745
jjg@1748 1746 StringBuilder result = new StringBuilder();
jjg@1748 1747 main: while (lessThanPos != -1) {
jjg@1748 1748 int currPos = lessThanPos + 1;
jjg@1748 1749 if (currPos == len)
jjg@1748 1750 break;
jjg@1748 1751 char ch = text.charAt(currPos);
jjg@1748 1752 if (ch == '/') {
jjg@1748 1753 if (++currPos == len)
jjg@1748 1754 break;
jjg@1748 1755 ch = text.charAt(currPos);
jjg@1748 1756 }
jjg@1748 1757 int tagPos = currPos;
jjg@1748 1758 while (isHtmlTagLetterOrDigit(ch)) {
jjg@1748 1759 if (++currPos == len)
jjg@1748 1760 break main;
jjg@1748 1761 ch = text.charAt(currPos);
jjg@1748 1762 }
jjg@1748 1763 if (ch == '>' && blockTags.contains(text.substring(tagPos, currPos).toLowerCase())) {
jjg@1748 1764 result.append(text, startPos, lessThanPos);
jjg@1748 1765 startPos = currPos + 1;
jjg@1748 1766 }
jjg@1748 1767 lessThanPos = text.indexOf('<', currPos);
duke@1 1768 }
jjg@1748 1769 result.append(text.substring(startPos));
jjg@1748 1770
jjg@1748 1771 return result.toString();
duke@1 1772 }
duke@1 1773
jjg@1748 1774 private static boolean isHtmlTagLetterOrDigit(char ch) {
jjg@1748 1775 return ('a' <= ch && ch <= 'z') ||
jjg@1748 1776 ('A' <= ch && ch <= 'Z') ||
jjg@1748 1777 ('1' <= ch && ch <= '6');
duke@1 1778 }
duke@1 1779
duke@1 1780 /**
bpatel@766 1781 * Returns a link to the stylesheet file.
bpatel@766 1782 *
bpatel@766 1783 * @return an HtmlTree for the lINK tag which provides the stylesheet location
bpatel@766 1784 */
bpatel@766 1785 public HtmlTree getStyleSheetProperties() {
jjg@1383 1786 String stylesheetfile = configuration.stylesheetfile;
jjg@1372 1787 DocPath stylesheet;
jjg@1383 1788 if (stylesheetfile.isEmpty()) {
jjg@1383 1789 stylesheet = DocPaths.STYLESHEET;
bpatel@766 1790 } else {
jjg@1383 1791 DocFile file = DocFile.createFileForInput(configuration, stylesheetfile);
jjg@1383 1792 stylesheet = DocPath.create(file.getName());
bpatel@766 1793 }
jjg@1372 1794 HtmlTree link = HtmlTree.LINK("stylesheet", "text/css",
jjg@1372 1795 pathToRoot.resolve(stylesheet).getPath(),
jjg@1372 1796 "Style");
bpatel@766 1797 return link;
bpatel@766 1798 }
bpatel@766 1799
bpatel@766 1800 /**
bpatel@1417 1801 * Returns a link to the JavaScript file.
bpatel@1417 1802 *
bpatel@1417 1803 * @return an HtmlTree for the Script tag which provides the JavaScript location
bpatel@1417 1804 */
bpatel@1417 1805 public HtmlTree getScriptProperties() {
bpatel@1417 1806 HtmlTree script = HtmlTree.SCRIPT("text/javascript",
bpatel@1417 1807 pathToRoot.resolve(DocPaths.JAVASCRIPT).getPath());
bpatel@1417 1808 return script;
bpatel@1417 1809 }
bpatel@1417 1810
bpatel@1417 1811 /**
jjh@972 1812 * According to
jjh@972 1813 * <cite>The Java&trade; Language Specification</cite>,
jjh@972 1814 * all the outer classes and static nested classes are core classes.
duke@1 1815 */
duke@1 1816 public boolean isCoreClass(ClassDoc cd) {
duke@1 1817 return cd.containingClass() == null || cd.isStatic();
duke@1 1818 }
duke@1 1819
duke@1 1820 /**
bpatel@766 1821 * Adds the annotatation types for the given packageDoc.
bpatel@766 1822 *
bpatel@766 1823 * @param packageDoc the package to write annotations for.
bpatel@766 1824 * @param htmltree the documentation tree to which the annotation info will be
bpatel@766 1825 * added
bpatel@766 1826 */
bpatel@766 1827 public void addAnnotationInfo(PackageDoc packageDoc, Content htmltree) {
bpatel@766 1828 addAnnotationInfo(packageDoc, packageDoc.annotations(), htmltree);
bpatel@766 1829 }
bpatel@766 1830
bpatel@766 1831 /**
jjg@1521 1832 * Add the annotation types of the executable receiver.
jjg@1521 1833 *
jjg@1521 1834 * @param method the executable to write the receiver annotations for.
bpatel@1686 1835 * @param descList list of annotation description.
jjg@1521 1836 * @param htmltree the documentation tree to which the annotation info will be
jjg@1521 1837 * added
jjg@1521 1838 */
bpatel@1686 1839 public void addReceiverAnnotationInfo(ExecutableMemberDoc method, AnnotationDesc[] descList,
bpatel@1686 1840 Content htmltree) {
bpatel@1686 1841 addAnnotationInfo(0, method, descList, false, htmltree);
jjg@1521 1842 }
jjg@1521 1843
jjg@1521 1844 /**
bpatel@766 1845 * Adds the annotatation types for the given doc.
bpatel@766 1846 *
jjg@1358 1847 * @param doc the package to write annotations for
bpatel@766 1848 * @param htmltree the content tree to which the annotation types will be added
bpatel@766 1849 */
bpatel@766 1850 public void addAnnotationInfo(ProgramElementDoc doc, Content htmltree) {
bpatel@766 1851 addAnnotationInfo(doc, doc.annotations(), htmltree);
bpatel@766 1852 }
bpatel@766 1853
bpatel@766 1854 /**
bpatel@766 1855 * Add the annotatation types for the given doc and parameter.
bpatel@766 1856 *
bpatel@766 1857 * @param indent the number of spaces to indent the parameters.
bpatel@766 1858 * @param doc the doc to write annotations for.
bpatel@766 1859 * @param param the parameter to write annotations for.
bpatel@766 1860 * @param tree the content tree to which the annotation types will be added
bpatel@766 1861 */
bpatel@766 1862 public boolean addAnnotationInfo(int indent, Doc doc, Parameter param,
bpatel@766 1863 Content tree) {
bpatel@766 1864 return addAnnotationInfo(indent, doc, param.annotations(), false, tree);
bpatel@766 1865 }
bpatel@766 1866
bpatel@766 1867 /**
bpatel@766 1868 * Adds the annotatation types for the given doc.
bpatel@766 1869 *
bpatel@766 1870 * @param doc the doc to write annotations for.
bpatel@766 1871 * @param descList the array of {@link AnnotationDesc}.
bpatel@766 1872 * @param htmltree the documentation tree to which the annotation info will be
bpatel@766 1873 * added
bpatel@766 1874 */
bpatel@766 1875 private void addAnnotationInfo(Doc doc, AnnotationDesc[] descList,
bpatel@766 1876 Content htmltree) {
bpatel@766 1877 addAnnotationInfo(0, doc, descList, true, htmltree);
bpatel@766 1878 }
bpatel@766 1879
bpatel@766 1880 /**
jjg@1747 1881 * Adds the annotation types for the given doc.
bpatel@766 1882 *
bpatel@766 1883 * @param indent the number of extra spaces to indent the annotations.
bpatel@766 1884 * @param doc the doc to write annotations for.
bpatel@766 1885 * @param descList the array of {@link AnnotationDesc}.
bpatel@766 1886 * @param htmltree the documentation tree to which the annotation info will be
bpatel@766 1887 * added
bpatel@766 1888 */
bpatel@766 1889 private boolean addAnnotationInfo(int indent, Doc doc,
bpatel@766 1890 AnnotationDesc[] descList, boolean lineBreak, Content htmltree) {
jjg@1747 1891 List<Content> annotations = getAnnotations(indent, descList, lineBreak);
bpatel@1686 1892 String sep ="";
jjg@1747 1893 if (annotations.isEmpty()) {
bpatel@766 1894 return false;
bpatel@766 1895 }
jjg@1747 1896 for (Content annotation: annotations) {
bpatel@1686 1897 htmltree.addContent(sep);
jjg@1747 1898 htmltree.addContent(annotation);
bpatel@1686 1899 sep = " ";
bpatel@766 1900 }
bpatel@766 1901 return true;
bpatel@766 1902 }
bpatel@766 1903
bpatel@766 1904 /**
duke@1 1905 * Return the string representations of the annotation types for
duke@1 1906 * the given doc.
duke@1 1907 *
duke@1 1908 * @param indent the number of extra spaces to indent the annotations.
duke@1 1909 * @param descList the array of {@link AnnotationDesc}.
duke@1 1910 * @param linkBreak if true, add new line between each member value.
duke@1 1911 * @return an array of strings representing the annotations being
duke@1 1912 * documented.
duke@1 1913 */
jjg@1747 1914 private List<Content> getAnnotations(int indent, AnnotationDesc[] descList, boolean linkBreak) {
jjg@1521 1915 return getAnnotations(indent, descList, linkBreak, true);
jjg@1521 1916 }
jjg@1521 1917
jjg@1521 1918 /**
jjg@1521 1919 * Return the string representations of the annotation types for
jjg@1521 1920 * the given doc.
jjg@1521 1921 *
jjg@1521 1922 * A {@code null} {@code elementType} indicates that all the
jjg@1521 1923 * annotations should be returned without any filtering.
jjg@1521 1924 *
jjg@1521 1925 * @param indent the number of extra spaces to indent the annotations.
jjg@1521 1926 * @param descList the array of {@link AnnotationDesc}.
jjg@1521 1927 * @param linkBreak if true, add new line between each member value.
jjg@1521 1928 * @param elementType the type of targeted element (used for filtering
jjg@1521 1929 * type annotations from declaration annotations)
jjg@1521 1930 * @return an array of strings representing the annotations being
jjg@1521 1931 * documented.
jjg@1521 1932 */
jjg@1747 1933 public List<Content> getAnnotations(int indent, AnnotationDesc[] descList, boolean linkBreak,
jjg@1521 1934 boolean isJava5DeclarationLocation) {
jjg@1747 1935 List<Content> results = new ArrayList<Content>();
jjg@1747 1936 ContentBuilder annotation;
duke@1 1937 for (int i = 0; i < descList.length; i++) {
duke@1 1938 AnnotationTypeDoc annotationDoc = descList[i].annotationType();
bpatel@1477 1939 // If an annotation is not documented, do not add it to the list. If
bpatel@1477 1940 // the annotation is of a repeatable type, and if it is not documented
bpatel@1477 1941 // and also if its container annotation is not documented, do not add it
bpatel@1477 1942 // to the list. If an annotation of a repeatable type is not documented
bpatel@1477 1943 // but its container is documented, it will be added to the list.
bpatel@1477 1944 if (! Util.isDocumentedAnnotation(annotationDoc) &&
bpatel@1477 1945 (!isAnnotationDocumented && !isContainerDocumented)) {
duke@1 1946 continue;
duke@1 1947 }
jjg@1521 1948 /* TODO: check logic here to correctly handle declaration
jjg@1521 1949 * and type annotations.
jjg@1521 1950 if (Util.isDeclarationAnnotation(annotationDoc, isJava5DeclarationLocation)) {
jjg@1521 1951 continue;
jjg@1521 1952 }*/
jjg@1747 1953 annotation = new ContentBuilder();
bpatel@1477 1954 isAnnotationDocumented = false;
jjg@1410 1955 LinkInfoImpl linkInfo = new LinkInfoImpl(configuration,
jjg@1735 1956 LinkInfoImpl.Kind.ANNOTATION, annotationDoc);
duke@1 1957 AnnotationDesc.ElementValuePair[] pairs = descList[i].elementValues();
bpatel@1477 1958 // If the annotation is synthesized, do not print the container.
bpatel@1477 1959 if (descList[i].isSynthesized()) {
duke@1 1960 for (int j = 0; j < pairs.length; j++) {
duke@1 1961 AnnotationValue annotationValue = pairs[j].value();
jjg@74 1962 List<AnnotationValue> annotationTypeValues = new ArrayList<AnnotationValue>();
duke@1 1963 if (annotationValue.value() instanceof AnnotationValue[]) {
duke@1 1964 AnnotationValue[] annotationArray =
bpatel@1477 1965 (AnnotationValue[]) annotationValue.value();
bpatel@1477 1966 annotationTypeValues.addAll(Arrays.asList(annotationArray));
duke@1 1967 } else {
duke@1 1968 annotationTypeValues.add(annotationValue);
duke@1 1969 }
bpatel@1477 1970 String sep = "";
bpatel@1477 1971 for (AnnotationValue av : annotationTypeValues) {
jjg@1747 1972 annotation.addContent(sep);
jjg@1747 1973 annotation.addContent(annotationValueToContent(av));
bpatel@1477 1974 sep = " ";
duke@1 1975 }
duke@1 1976 }
bpatel@1477 1977 }
bpatel@1477 1978 else if (isAnnotationArray(pairs)) {
bpatel@1477 1979 // If the container has 1 or more value defined and if the
bpatel@1477 1980 // repeatable type annotation is not documented, do not print
bpatel@1477 1981 // the container.
bpatel@1477 1982 if (pairs.length == 1 && isAnnotationDocumented) {
bpatel@1477 1983 AnnotationValue[] annotationArray =
bpatel@1477 1984 (AnnotationValue[]) (pairs[0].value()).value();
bpatel@1477 1985 List<AnnotationValue> annotationTypeValues = new ArrayList<AnnotationValue>();
bpatel@1477 1986 annotationTypeValues.addAll(Arrays.asList(annotationArray));
bpatel@1477 1987 String sep = "";
bpatel@1477 1988 for (AnnotationValue av : annotationTypeValues) {
jjg@1747 1989 annotation.addContent(sep);
jjg@1747 1990 annotation.addContent(annotationValueToContent(av));
bpatel@1477 1991 sep = " ";
bpatel@1477 1992 }
bpatel@1477 1993 }
bpatel@1477 1994 // If the container has 1 or more value defined and if the
bpatel@1477 1995 // repeatable type annotation is not documented, print the container.
bpatel@1477 1996 else {
bpatel@1477 1997 addAnnotations(annotationDoc, linkInfo, annotation, pairs,
bpatel@1477 1998 indent, false);
bpatel@1477 1999 }
bpatel@1477 2000 }
bpatel@1477 2001 else {
bpatel@1477 2002 addAnnotations(annotationDoc, linkInfo, annotation, pairs,
bpatel@1477 2003 indent, linkBreak);
duke@1 2004 }
jjg@1747 2005 annotation.addContent(linkBreak ? DocletConstants.NL : "");
jjg@1747 2006 results.add(annotation);
duke@1 2007 }
duke@1 2008 return results;
duke@1 2009 }
duke@1 2010
bpatel@1477 2011 /**
bpatel@1477 2012 * Add annotation to the annotation string.
bpatel@1477 2013 *
bpatel@1477 2014 * @param annotationDoc the annotation being documented
bpatel@1477 2015 * @param linkInfo the information about the link
bpatel@1477 2016 * @param annotation the annotation string to which the annotation will be added
bpatel@1477 2017 * @param pairs annotation type element and value pairs
bpatel@1477 2018 * @param indent the number of extra spaces to indent the annotations.
bpatel@1477 2019 * @param linkBreak if true, add new line between each member value
bpatel@1477 2020 */
bpatel@1477 2021 private void addAnnotations(AnnotationTypeDoc annotationDoc, LinkInfoImpl linkInfo,
jjg@1747 2022 ContentBuilder annotation, AnnotationDesc.ElementValuePair[] pairs,
bpatel@1477 2023 int indent, boolean linkBreak) {
jjg@1737 2024 linkInfo.label = new StringContent("@" + annotationDoc.name());
jjg@1747 2025 annotation.addContent(getLink(linkInfo));
bpatel@1477 2026 if (pairs.length > 0) {
jjg@1747 2027 annotation.addContent("(");
bpatel@1477 2028 for (int j = 0; j < pairs.length; j++) {
bpatel@1477 2029 if (j > 0) {
jjg@1747 2030 annotation.addContent(",");
bpatel@1477 2031 if (linkBreak) {
jjg@1747 2032 annotation.addContent(DocletConstants.NL);
bpatel@1477 2033 int spaces = annotationDoc.name().length() + 2;
bpatel@1477 2034 for (int k = 0; k < (spaces + indent); k++) {
jjg@1747 2035 annotation.addContent(" ");
bpatel@1477 2036 }
bpatel@1477 2037 }
bpatel@1477 2038 }
jjg@1747 2039 annotation.addContent(getDocLink(LinkInfoImpl.Kind.ANNOTATION,
bpatel@1477 2040 pairs[j].element(), pairs[j].element().name(), false));
jjg@1747 2041 annotation.addContent("=");
bpatel@1477 2042 AnnotationValue annotationValue = pairs[j].value();
bpatel@1477 2043 List<AnnotationValue> annotationTypeValues = new ArrayList<AnnotationValue>();
bpatel@1477 2044 if (annotationValue.value() instanceof AnnotationValue[]) {
bpatel@1477 2045 AnnotationValue[] annotationArray =
bpatel@1477 2046 (AnnotationValue[]) annotationValue.value();
bpatel@1477 2047 annotationTypeValues.addAll(Arrays.asList(annotationArray));
bpatel@1477 2048 } else {
bpatel@1477 2049 annotationTypeValues.add(annotationValue);
bpatel@1477 2050 }
jjg@1747 2051 annotation.addContent(annotationTypeValues.size() == 1 ? "" : "{");
bpatel@1477 2052 String sep = "";
bpatel@1477 2053 for (AnnotationValue av : annotationTypeValues) {
jjg@1747 2054 annotation.addContent(sep);
jjg@1747 2055 annotation.addContent(annotationValueToContent(av));
bpatel@1477 2056 sep = ",";
bpatel@1477 2057 }
jjg@1747 2058 annotation.addContent(annotationTypeValues.size() == 1 ? "" : "}");
bpatel@1477 2059 isContainerDocumented = false;
bpatel@1477 2060 }
jjg@1747 2061 annotation.addContent(")");
bpatel@1477 2062 }
bpatel@1477 2063 }
bpatel@1477 2064
bpatel@1477 2065 /**
bpatel@1477 2066 * Check if the annotation contains an array of annotation as a value. This
bpatel@1477 2067 * check is to verify if a repeatable type annotation is present or not.
bpatel@1477 2068 *
bpatel@1477 2069 * @param pairs annotation type element and value pairs
bpatel@1477 2070 *
bpatel@1477 2071 * @return true if the annotation contains an array of annotation as a value.
bpatel@1477 2072 */
bpatel@1477 2073 private boolean isAnnotationArray(AnnotationDesc.ElementValuePair[] pairs) {
bpatel@1477 2074 AnnotationValue annotationValue;
bpatel@1477 2075 for (int j = 0; j < pairs.length; j++) {
bpatel@1477 2076 annotationValue = pairs[j].value();
bpatel@1477 2077 if (annotationValue.value() instanceof AnnotationValue[]) {
bpatel@1477 2078 AnnotationValue[] annotationArray =
bpatel@1477 2079 (AnnotationValue[]) annotationValue.value();
bpatel@1477 2080 if (annotationArray.length > 1) {
bpatel@1477 2081 if (annotationArray[0].value() instanceof AnnotationDesc) {
bpatel@1477 2082 AnnotationTypeDoc annotationDoc =
bpatel@1477 2083 ((AnnotationDesc) annotationArray[0].value()).annotationType();
bpatel@1477 2084 isContainerDocumented = true;
bpatel@1477 2085 if (Util.isDocumentedAnnotation(annotationDoc)) {
bpatel@1477 2086 isAnnotationDocumented = true;
bpatel@1477 2087 }
bpatel@1477 2088 return true;
bpatel@1477 2089 }
bpatel@1477 2090 }
bpatel@1477 2091 }
bpatel@1477 2092 }
bpatel@1477 2093 return false;
bpatel@1477 2094 }
bpatel@1477 2095
jjg@1747 2096 private Content annotationValueToContent(AnnotationValue annotationValue) {
duke@1 2097 if (annotationValue.value() instanceof Type) {
duke@1 2098 Type type = (Type) annotationValue.value();
duke@1 2099 if (type.asClassDoc() != null) {
jjg@1410 2100 LinkInfoImpl linkInfo = new LinkInfoImpl(configuration,
jjg@1735 2101 LinkInfoImpl.Kind.ANNOTATION, type);
jjg@1737 2102 linkInfo.label = new StringContent((type.asClassDoc().isIncluded() ?
jjg@1737 2103 type.typeName() :
jjg@1737 2104 type.qualifiedTypeName()) + type.dimension() + ".class");
jjg@1747 2105 return getLink(linkInfo);
duke@1 2106 } else {
jjg@1747 2107 return new StringContent(type.typeName() + type.dimension() + ".class");
duke@1 2108 }
duke@1 2109 } else if (annotationValue.value() instanceof AnnotationDesc) {
jjg@1747 2110 List<Content> list = getAnnotations(0,
duke@1 2111 new AnnotationDesc[]{(AnnotationDesc) annotationValue.value()},
duke@1 2112 false);
jjg@1747 2113 ContentBuilder buf = new ContentBuilder();
jjg@1747 2114 for (Content c: list) {
jjg@1747 2115 buf.addContent(c);
duke@1 2116 }
jjg@1747 2117 return buf;
duke@1 2118 } else if (annotationValue.value() instanceof MemberDoc) {
jjg@1735 2119 return getDocLink(LinkInfoImpl.Kind.ANNOTATION,
duke@1 2120 (MemberDoc) annotationValue.value(),
jjg@1747 2121 ((MemberDoc) annotationValue.value()).name(), false);
duke@1 2122 } else {
jjg@1747 2123 return new StringContent(annotationValue.toString());
duke@1 2124 }
duke@1 2125 }
duke@1 2126
duke@1 2127 /**
duke@1 2128 * Return the configuation for this doclet.
duke@1 2129 *
duke@1 2130 * @return the configuration for this doclet.
duke@1 2131 */
duke@1 2132 public Configuration configuration() {
duke@1 2133 return configuration;
duke@1 2134 }
duke@1 2135 }

mercurial