Tue, 20 Jan 2009 15:17:45 -0800
6794582: javadoc should read files using a FileManager
Reviewed-by: darcy, bpatel
duke@1 | 1 | /* |
duke@1 | 2 | * Copyright 2003-2005 Sun Microsystems, Inc. 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 |
duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
duke@1 | 9 | * by Sun 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 | * |
duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
duke@1 | 23 | * have any questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.formats.html; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 29 | import com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder; |
duke@1 | 30 | import com.sun.tools.doclets.internal.toolkit.taglets.*; |
duke@1 | 31 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 32 | import com.sun.javadoc.*; |
duke@1 | 33 | |
duke@1 | 34 | /** |
duke@1 | 35 | * The taglet writer that writes HTML. |
duke@1 | 36 | * |
duke@1 | 37 | * @since 1.5 |
duke@1 | 38 | * @author Jamie Ho |
duke@1 | 39 | */ |
duke@1 | 40 | |
duke@1 | 41 | public class TagletWriterImpl extends TagletWriter { |
duke@1 | 42 | |
duke@1 | 43 | private HtmlDocletWriter htmlWriter; |
duke@1 | 44 | |
duke@1 | 45 | public TagletWriterImpl(HtmlDocletWriter htmlWriter, boolean isFirstSentence) { |
duke@1 | 46 | this.htmlWriter = htmlWriter; |
duke@1 | 47 | this.isFirstSentence = isFirstSentence; |
duke@1 | 48 | } |
duke@1 | 49 | |
duke@1 | 50 | /** |
duke@1 | 51 | * {@inheritDoc} |
duke@1 | 52 | */ |
duke@1 | 53 | public TagletOutput getOutputInstance() { |
duke@1 | 54 | return new TagletOutputImpl(""); |
duke@1 | 55 | } |
duke@1 | 56 | |
duke@1 | 57 | /** |
duke@1 | 58 | * {@inheritDoc} |
duke@1 | 59 | */ |
duke@1 | 60 | public TagletOutput getDocRootOutput() { |
duke@1 | 61 | return new TagletOutputImpl(htmlWriter.relativepathNoSlash); |
duke@1 | 62 | } |
duke@1 | 63 | |
duke@1 | 64 | /** |
duke@1 | 65 | * {@inheritDoc} |
duke@1 | 66 | */ |
duke@1 | 67 | public TagletOutput deprecatedTagOutput(Doc doc) { |
duke@1 | 68 | StringBuffer output = new StringBuffer(); |
duke@1 | 69 | Tag[] deprs = doc.tags("deprecated"); |
duke@1 | 70 | if (doc instanceof ClassDoc) { |
duke@1 | 71 | if (Util.isDeprecated((ProgramElementDoc) doc)) { |
bpatel@182 | 72 | output.append("<STRONG>" + |
duke@1 | 73 | ConfigurationImpl.getInstance(). |
bpatel@182 | 74 | getText("doclet.Deprecated") + "</STRONG> "); |
duke@1 | 75 | if (deprs.length > 0) { |
duke@1 | 76 | Tag[] commentTags = deprs[0].inlineTags(); |
duke@1 | 77 | if (commentTags.length > 0) { |
duke@1 | 78 | |
duke@1 | 79 | output.append(commentTagsToOutput(null, doc, |
duke@1 | 80 | deprs[0].inlineTags(), false).toString() |
duke@1 | 81 | ); |
duke@1 | 82 | } |
duke@1 | 83 | } |
duke@1 | 84 | output.append("<p>"); |
duke@1 | 85 | } |
duke@1 | 86 | } else { |
duke@1 | 87 | MemberDoc member = (MemberDoc) doc; |
duke@1 | 88 | if (Util.isDeprecated((ProgramElementDoc) doc)) { |
bpatel@182 | 89 | output.append("<DD><STRONG>" + |
duke@1 | 90 | ConfigurationImpl.getInstance(). |
bpatel@182 | 91 | getText("doclet.Deprecated") + "</STRONG> "); |
duke@1 | 92 | if (deprs.length > 0) { |
duke@1 | 93 | output.append("<I>"); |
duke@1 | 94 | output.append(commentTagsToOutput(null, doc, |
duke@1 | 95 | deprs[0].inlineTags(), false).toString()); |
duke@1 | 96 | output.append("</I>"); |
duke@1 | 97 | } |
duke@1 | 98 | if (member instanceof ExecutableMemberDoc) { |
duke@1 | 99 | output.append(DocletConstants.NL + "<P>" + |
duke@1 | 100 | DocletConstants.NL); |
duke@1 | 101 | } |
duke@1 | 102 | } else { |
duke@1 | 103 | if (Util.isDeprecated(member.containingClass())) { |
bpatel@182 | 104 | output.append("<DD><STRONG>" + |
duke@1 | 105 | ConfigurationImpl.getInstance(). |
bpatel@182 | 106 | getText("doclet.Deprecated") + "</STRONG> "); |
duke@1 | 107 | } |
duke@1 | 108 | } |
duke@1 | 109 | } |
duke@1 | 110 | return new TagletOutputImpl(output.toString()); |
duke@1 | 111 | } |
duke@1 | 112 | |
duke@1 | 113 | /** |
duke@1 | 114 | * {@inheritDoc} |
duke@1 | 115 | */ |
duke@1 | 116 | public MessageRetriever getMsgRetriever() { |
duke@1 | 117 | return htmlWriter.configuration.message; |
duke@1 | 118 | } |
duke@1 | 119 | |
duke@1 | 120 | /** |
duke@1 | 121 | * {@inheritDoc} |
duke@1 | 122 | */ |
duke@1 | 123 | public TagletOutput getParamHeader(String header) { |
duke@1 | 124 | StringBuffer result = new StringBuffer(); |
duke@1 | 125 | result.append("<DT>"); |
bpatel@182 | 126 | result.append("<STRONG>" + header + "</STRONG>"); |
duke@1 | 127 | return new TagletOutputImpl(result.toString()); |
duke@1 | 128 | } |
duke@1 | 129 | |
duke@1 | 130 | /** |
duke@1 | 131 | * {@inheritDoc} |
duke@1 | 132 | */ |
duke@1 | 133 | public TagletOutput paramTagOutput(ParamTag paramTag, String paramName) { |
duke@1 | 134 | TagletOutput result = new TagletOutputImpl("<DD><CODE>" + paramName + "</CODE>" |
duke@1 | 135 | + " - " + htmlWriter.commentTagsToString(paramTag, null, paramTag.inlineTags(), false)); |
duke@1 | 136 | return result; |
duke@1 | 137 | } |
duke@1 | 138 | |
duke@1 | 139 | /** |
duke@1 | 140 | * {@inheritDoc} |
duke@1 | 141 | */ |
duke@1 | 142 | public TagletOutput returnTagOutput(Tag returnTag) { |
duke@1 | 143 | TagletOutput result = new TagletOutputImpl(DocletConstants.NL + "<DT>" + |
bpatel@182 | 144 | "<STRONG>" + htmlWriter.configuration.getText("doclet.Returns") + |
bpatel@182 | 145 | "</STRONG>" + "<DD>" + |
duke@1 | 146 | htmlWriter.commentTagsToString(returnTag, null, returnTag.inlineTags(), |
duke@1 | 147 | false)); |
duke@1 | 148 | return result; |
duke@1 | 149 | } |
duke@1 | 150 | |
duke@1 | 151 | /** |
duke@1 | 152 | * {@inheritDoc} |
duke@1 | 153 | */ |
duke@1 | 154 | public TagletOutput seeTagOutput(Doc holder, SeeTag[] seeTags) { |
duke@1 | 155 | String result = ""; |
duke@1 | 156 | if (seeTags.length > 0) { |
duke@1 | 157 | result = addSeeHeader(result); |
duke@1 | 158 | for (int i = 0; i < seeTags.length; ++i) { |
duke@1 | 159 | if (i > 0) { |
duke@1 | 160 | result += ", " + DocletConstants.NL; |
duke@1 | 161 | } |
duke@1 | 162 | result += htmlWriter.seeTagToString(seeTags[i]); |
duke@1 | 163 | } |
duke@1 | 164 | } |
duke@1 | 165 | if (holder.isField() && ((FieldDoc)holder).constantValue() != null && |
duke@1 | 166 | htmlWriter instanceof ClassWriterImpl) { |
duke@1 | 167 | //Automatically add link to constant values page for constant fields. |
duke@1 | 168 | result = addSeeHeader(result); |
duke@1 | 169 | result += htmlWriter.getHyperLink(htmlWriter.relativePath + |
duke@1 | 170 | ConfigurationImpl.CONSTANTS_FILE_NAME |
duke@1 | 171 | + "#" + ((ClassWriterImpl) htmlWriter).getClassDoc().qualifiedName() |
duke@1 | 172 | + "." + ((FieldDoc) holder).name(), |
duke@1 | 173 | htmlWriter.configuration.getText("doclet.Constants_Summary")); |
duke@1 | 174 | } |
duke@1 | 175 | if (holder.isClass() && ((ClassDoc)holder).isSerializable()) { |
duke@1 | 176 | //Automatically add link to serialized form page for serializable classes. |
duke@1 | 177 | if (!(SerializedFormBuilder.serialInclude(holder) && |
duke@1 | 178 | SerializedFormBuilder.serialInclude(((ClassDoc)holder).containingPackage()))) { |
duke@1 | 179 | return result.equals("") ? null : new TagletOutputImpl(result); |
duke@1 | 180 | } |
duke@1 | 181 | result = addSeeHeader(result); |
duke@1 | 182 | result += htmlWriter.getHyperLink(htmlWriter.relativePath + "serialized-form.html", |
duke@1 | 183 | ((ClassDoc)holder).qualifiedName(), htmlWriter.configuration.getText("doclet.Serialized_Form"), false); |
duke@1 | 184 | } |
duke@1 | 185 | return result.equals("") ? null : new TagletOutputImpl(result); |
duke@1 | 186 | } |
duke@1 | 187 | |
duke@1 | 188 | private String addSeeHeader(String result) { |
duke@1 | 189 | if (result != null && result.length() > 0) { |
duke@1 | 190 | return result + ", " + DocletConstants.NL; |
duke@1 | 191 | } else { |
bpatel@182 | 192 | return "<DT><STRONG>" + htmlWriter.configuration().getText("doclet.See_Also") + "</STRONG><DD>"; |
duke@1 | 193 | } |
duke@1 | 194 | } |
duke@1 | 195 | |
duke@1 | 196 | /** |
duke@1 | 197 | * {@inheritDoc} |
duke@1 | 198 | */ |
duke@1 | 199 | public TagletOutput simpleTagOutput(Tag[] simpleTags, String header) { |
bpatel@182 | 200 | String result = "<DT><STRONG>" + header + "</STRONG></DT>" + DocletConstants.NL + |
duke@1 | 201 | " <DD>"; |
duke@1 | 202 | for (int i = 0; i < simpleTags.length; i++) { |
duke@1 | 203 | if (i > 0) { |
duke@1 | 204 | result += ", "; |
duke@1 | 205 | } |
duke@1 | 206 | result += htmlWriter.commentTagsToString(simpleTags[i], null, simpleTags[i].inlineTags(), false); |
duke@1 | 207 | } |
duke@1 | 208 | return new TagletOutputImpl(result + "</DD>" + DocletConstants.NL); |
duke@1 | 209 | } |
duke@1 | 210 | |
duke@1 | 211 | /** |
duke@1 | 212 | * {@inheritDoc} |
duke@1 | 213 | */ |
duke@1 | 214 | public TagletOutput simpleTagOutput(Tag simpleTag, String header) { |
bpatel@182 | 215 | return new TagletOutputImpl("<DT><STRONG>" + header + "</STRONG></DT>" + " <DD>" |
duke@1 | 216 | + htmlWriter.commentTagsToString(simpleTag, null, simpleTag.inlineTags(), false) |
duke@1 | 217 | + "</DD>" + DocletConstants.NL); |
duke@1 | 218 | } |
duke@1 | 219 | |
duke@1 | 220 | /** |
duke@1 | 221 | * {@inheritDoc} |
duke@1 | 222 | */ |
duke@1 | 223 | public TagletOutput getThrowsHeader() { |
bpatel@182 | 224 | return new TagletOutputImpl(DocletConstants.NL + "<DT>" + "<STRONG>" + |
bpatel@182 | 225 | htmlWriter.configuration().getText("doclet.Throws") + "</STRONG>"); |
duke@1 | 226 | } |
duke@1 | 227 | |
duke@1 | 228 | /** |
duke@1 | 229 | * {@inheritDoc} |
duke@1 | 230 | */ |
duke@1 | 231 | public TagletOutput throwsTagOutput(ThrowsTag throwsTag) { |
duke@1 | 232 | String result = DocletConstants.NL + "<DD>"; |
duke@1 | 233 | result += throwsTag.exceptionType() == null ? |
duke@1 | 234 | htmlWriter.codeText(throwsTag.exceptionName()) : |
duke@1 | 235 | htmlWriter.codeText( |
duke@1 | 236 | htmlWriter.getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER, |
duke@1 | 237 | throwsTag.exceptionType()))); |
duke@1 | 238 | TagletOutput text = new TagletOutputImpl( |
duke@1 | 239 | htmlWriter.commentTagsToString(throwsTag, null, |
duke@1 | 240 | throwsTag.inlineTags(), false)); |
duke@1 | 241 | if (text != null && text.toString().length() > 0) { |
duke@1 | 242 | result += " - " + text; |
duke@1 | 243 | } |
duke@1 | 244 | return new TagletOutputImpl(result); |
duke@1 | 245 | } |
duke@1 | 246 | |
duke@1 | 247 | /** |
duke@1 | 248 | * {@inheritDoc} |
duke@1 | 249 | */ |
duke@1 | 250 | public TagletOutput throwsTagOutput(Type throwsType) { |
duke@1 | 251 | return new TagletOutputImpl(DocletConstants.NL + "<DD>" + |
duke@1 | 252 | htmlWriter.codeText(htmlWriter.getLink( |
duke@1 | 253 | new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER, throwsType)))); |
duke@1 | 254 | } |
duke@1 | 255 | |
duke@1 | 256 | /** |
duke@1 | 257 | * {@inheritDoc} |
duke@1 | 258 | */ |
duke@1 | 259 | public TagletOutput valueTagOutput(FieldDoc field, String constantVal, |
duke@1 | 260 | boolean includeLink) { |
duke@1 | 261 | return new TagletOutputImpl(includeLink ? |
duke@1 | 262 | htmlWriter.getDocLink(LinkInfoImpl.CONTEXT_VALUE_TAG, field, |
duke@1 | 263 | constantVal, false) : constantVal); |
duke@1 | 264 | } |
duke@1 | 265 | |
duke@1 | 266 | /** |
duke@1 | 267 | * {@inheritDoc} |
duke@1 | 268 | */ |
duke@1 | 269 | public TagletOutput commentTagsToOutput(Tag holderTag, Tag[] tags) { |
duke@1 | 270 | return commentTagsToOutput(holderTag, null, tags, false); |
duke@1 | 271 | } |
duke@1 | 272 | |
duke@1 | 273 | /** |
duke@1 | 274 | * {@inheritDoc} |
duke@1 | 275 | */ |
duke@1 | 276 | public TagletOutput commentTagsToOutput(Doc holderDoc, Tag[] tags) { |
duke@1 | 277 | return commentTagsToOutput(null, holderDoc, tags, false); |
duke@1 | 278 | } |
duke@1 | 279 | |
duke@1 | 280 | /** |
duke@1 | 281 | * {@inheritDoc} |
duke@1 | 282 | */ |
duke@1 | 283 | public TagletOutput commentTagsToOutput(Tag holderTag, |
duke@1 | 284 | Doc holderDoc, Tag[] tags, boolean isFirstSentence) { |
duke@1 | 285 | return new TagletOutputImpl(htmlWriter.commentTagsToString( |
duke@1 | 286 | holderTag, holderDoc, tags, isFirstSentence)); |
duke@1 | 287 | } |
duke@1 | 288 | |
duke@1 | 289 | /** |
duke@1 | 290 | * {@inheritDoc} |
duke@1 | 291 | */ |
duke@1 | 292 | public Configuration configuration() { |
duke@1 | 293 | return htmlWriter.configuration(); |
duke@1 | 294 | } |
duke@1 | 295 | |
duke@1 | 296 | /** |
duke@1 | 297 | * Return an instance of a TagletWriter that knows how to write HTML. |
duke@1 | 298 | * |
duke@1 | 299 | * @return an instance of a TagletWriter that knows how to write HTML. |
duke@1 | 300 | */ |
duke@1 | 301 | public TagletOutput getTagletOutputInstance() { |
duke@1 | 302 | return new TagletOutputImpl(""); |
duke@1 | 303 | } |
duke@1 | 304 | } |