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

Fri, 06 Dec 2013 09:07:47 -0800

author
ksrini
date
Fri, 06 Dec 2013 09:07:47 -0800
changeset 2218
2d0a0ae7fa9c
parent 2212
4cb9de4dd420
child 2413
fe033d997ddf
permissions
-rw-r--r--

8029504: Regression: TestDocRootLink test fails on Windows
Reviewed-by: bpatel, jjg

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

mercurial