author | jjg |
Fri, 27 May 2016 13:06:58 -0700 | |
changeset 38617 | d93a7f64e231 |
parent 38614 | 364c1a6618c0 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
38614 | 2 |
* Copyright (c) 2001, 2016, Oracle and/or its affiliates. All rights reserved. |
10 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5520 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
10 | 24 |
*/ |
25 |
||
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
26 |
package com.sun.tools.doclets.formats.html; |
10 | 27 |
|
28 |
import java.io.*; |
|
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
29 |
|
1869
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
30 |
import javax.tools.FileObject; |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
31 |
|
1869
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
32 |
import com.sun.javadoc.*; |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
33 |
import com.sun.tools.doclets.formats.html.markup.*; |
1869
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
34 |
import com.sun.tools.doclets.internal.toolkit.*; |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
35 |
import com.sun.tools.doclets.internal.toolkit.util.*; |
38614 | 36 |
import com.sun.tools.javadoc.main.SourcePositionImpl; |
10 | 37 |
|
38 |
/** |
|
39 |
* Converts Java Source Code to HTML. |
|
40 |
* |
|
14260 | 41 |
* <p><b>This is NOT part of any supported API. |
42 |
* If you write code that depends on this, you do so at your own risk. |
|
43 |
* This code and its internal interfaces are subject to change or |
|
44 |
* deletion without notice.</b> |
|
10 | 45 |
* |
46 |
* @author Jamie Ho |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
47 |
* @author Bhavesh Patel (Modified) |
10 | 48 |
* @since 1.4 |
49 |
*/ |
|
38617 | 50 |
@Deprecated |
10 | 51 |
public class SourceToHTMLConverter { |
52 |
||
53 |
/** |
|
54 |
* The number of trailing blank lines at the end of the page. |
|
55 |
* This is inserted so that anchors at the bottom of small pages |
|
56 |
* can be reached. |
|
57 |
*/ |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
58 |
private static final int NUM_BLANK_LINES = 60; |
10 | 59 |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
60 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
61 |
* New line to be added to the documentation. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
62 |
*/ |
17560 | 63 |
private static final String NEW_LINE = DocletConstants.NL; |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
64 |
|
14542 | 65 |
private final ConfigurationImpl configuration; |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
22159
diff
changeset
|
66 |
private final Utils utils; |
14542 | 67 |
|
68 |
private final RootDoc rootDoc; |
|
69 |
||
70 |
private DocPath outputdir; |
|
71 |
||
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
72 |
/** |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
73 |
* Relative path from the documentation root to the file that is being |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
74 |
* generated. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
75 |
*/ |
14542 | 76 |
private DocPath relativePath = DocPath.empty; |
10 | 77 |
|
14542 | 78 |
private SourceToHTMLConverter(ConfigurationImpl configuration, RootDoc rd, |
79 |
DocPath outputdir) { |
|
80 |
this.configuration = configuration; |
|
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
22159
diff
changeset
|
81 |
this.utils = configuration.utils; |
14542 | 82 |
this.rootDoc = rd; |
83 |
this.outputdir = outputdir; |
|
84 |
} |
|
10 | 85 |
|
86 |
/** |
|
87 |
* Convert the Classes in the given RootDoc to an HTML. |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
88 |
* |
10 | 89 |
* @param configuration the configuration. |
90 |
* @param rd the RootDoc to convert. |
|
91 |
* @param outputdir the name of the directory to output to. |
|
92 |
*/ |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
93 |
public static void convertRoot(ConfigurationImpl configuration, RootDoc rd, |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14260
diff
changeset
|
94 |
DocPath outputdir) { |
14542 | 95 |
new SourceToHTMLConverter(configuration, rd, outputdir).generate(); |
96 |
} |
|
97 |
||
98 |
void generate() { |
|
99 |
if (rootDoc == null || outputdir == null) { |
|
10 | 100 |
return; |
101 |
} |
|
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17571
diff
changeset
|
102 |
for (PackageDoc pd : rootDoc.specifiedPackages()) { |
9606
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
103 |
// If -nodeprecated option is set and the package is marked as deprecated, |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
104 |
// do not convert the package files to HTML. |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
22159
diff
changeset
|
105 |
if (!(configuration.nodeprecated && utils.isDeprecated(pd))) |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17571
diff
changeset
|
106 |
convertPackage(pd, outputdir); |
10 | 107 |
} |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17571
diff
changeset
|
108 |
for (ClassDoc cd : rootDoc.specifiedClasses()) { |
9606
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
109 |
// If -nodeprecated option is set and the class is marked as deprecated |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
110 |
// or the containing package is deprecated, do not convert the |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
111 |
// package files to HTML. |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
112 |
if (!(configuration.nodeprecated && |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
22159
diff
changeset
|
113 |
(utils.isDeprecated(cd) || utils.isDeprecated(cd.containingPackage())))) |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17571
diff
changeset
|
114 |
convertClass(cd, outputdir); |
10 | 115 |
} |
116 |
} |
|
117 |
||
118 |
/** |
|
119 |
* Convert the Classes in the given Package to an HTML. |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
120 |
* |
10 | 121 |
* @param pd the Package to convert. |
122 |
* @param outputdir the name of the directory to output to. |
|
123 |
*/ |
|
14542 | 124 |
public void convertPackage(PackageDoc pd, DocPath outputdir) { |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
125 |
if (pd == null) { |
10 | 126 |
return; |
127 |
} |
|
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17571
diff
changeset
|
128 |
for (ClassDoc cd : pd.allClasses()) { |
9606
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
129 |
// If -nodeprecated option is set and the class is marked as deprecated, |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
130 |
// do not convert the package files to HTML. We do not check for |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
131 |
// containing package deprecation since it is already check in |
e5a619cb5dd3
6492694: @deprecated tag doesn't work in package-info files.
bpatel
parents:
8631
diff
changeset
|
132 |
// the calling method above. |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
22159
diff
changeset
|
133 |
if (!(configuration.nodeprecated && utils.isDeprecated(cd))) |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17571
diff
changeset
|
134 |
convertClass(cd, outputdir); |
10 | 135 |
} |
136 |
} |
|
137 |
||
138 |
/** |
|
139 |
* Convert the given Class to an HTML. |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
140 |
* |
10 | 141 |
* @param cd the class to convert. |
142 |
* @param outputdir the name of the directory to output to. |
|
143 |
*/ |
|
14542 | 144 |
public void convertClass(ClassDoc cd, DocPath outputdir) { |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
145 |
if (cd == null) { |
10 | 146 |
return; |
147 |
} |
|
148 |
try { |
|
1869
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
149 |
SourcePosition sp = cd.position(); |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
150 |
if (sp == null) |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
151 |
return; |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
152 |
Reader r; |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
153 |
// temp hack until we can update SourcePosition API. |
38614 | 154 |
if (sp instanceof SourcePositionImpl) { |
155 |
FileObject fo = ((SourcePositionImpl) sp).fileObject(); |
|
1869
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
156 |
if (fo == null) |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
157 |
return; |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
158 |
r = fo.openReader(true); |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
159 |
} else { |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
160 |
File file = sp.file(); |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
161 |
if (file == null) |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
162 |
return; |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
163 |
r = new FileReader(file); |
0e193a8f3520
6794582: javadoc should read files using a FileManager
jjg
parents:
1863
diff
changeset
|
164 |
} |
10 | 165 |
int lineno = 1; |
166 |
String line; |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14260
diff
changeset
|
167 |
relativePath = DocPaths.SOURCE_OUTPUT |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14260
diff
changeset
|
168 |
.resolve(DocPath.forPackage(cd)) |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14260
diff
changeset
|
169 |
.invert(); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
170 |
Content body = getHeader(); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
171 |
Content pre = new HtmlTree(HtmlTag.PRE); |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17571
diff
changeset
|
172 |
try (LineNumberReader reader = new LineNumberReader(r)) { |
10 | 173 |
while ((line = reader.readLine()) != null) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
174 |
addLineNo(pre, lineno); |
14542 | 175 |
addLine(pre, line, lineno); |
10 | 176 |
lineno++; |
177 |
} |
|
178 |
} |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
179 |
addBlankLines(pre); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
180 |
Content div = HtmlTree.DIV(HtmlStyle.sourceContainer, pre); |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
181 |
body.addContent((configuration.allowTag(HtmlTag.MAIN)) ? HtmlTree.MAIN(div) : div); |
14542 | 182 |
writeToFile(body, outputdir.resolve(DocPath.forClass(cd))); |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
183 |
} catch (IOException e) { |
10 | 184 |
e.printStackTrace(); |
185 |
} |
|
186 |
} |
|
187 |
||
188 |
/** |
|
189 |
* Write the output to the file. |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
190 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
191 |
* @param body the documentation content to be written to the file. |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
192 |
* @param path the path for the file. |
10 | 193 |
*/ |
14542 | 194 |
private void writeToFile(Content body, DocPath path) throws IOException { |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
195 |
Content htmlDocType = configuration.isOutputHtml5() |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
196 |
? DocType.HTML5 |
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
197 |
: DocType.TRANSITIONAL; |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
198 |
Content head = new HtmlTree(HtmlTag.HEAD); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
199 |
head.addContent(HtmlTree.TITLE(new StringContent( |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
200 |
configuration.getText("doclet.Window_Source_title")))); |
14542 | 201 |
head.addContent(getStyleSheetProperties()); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
202 |
Content htmlTree = HtmlTree.HTML(configuration.getLocale().getLanguage(), |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
203 |
head, body); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
204 |
Content htmlDocument = new HtmlDocument(htmlDocType, htmlTree); |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
205 |
configuration.message.notice("doclet.Generating_0", path.getPath()); |
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
206 |
DocFile df = DocFile.createFileForOutput(configuration, path); |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
17571
diff
changeset
|
207 |
try (Writer w = df.openWriter()) { |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
208 |
htmlDocument.write(w, true); |
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
209 |
} |
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
210 |
|
10 | 211 |
} |
212 |
||
213 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
214 |
* Returns a link to the stylesheet file. |
10 | 215 |
* |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
216 |
* @return an HtmlTree for the lINK tag which provides the stylesheet location |
10 | 217 |
*/ |
14542 | 218 |
public HtmlTree getStyleSheetProperties() { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
219 |
String filename = configuration.stylesheetfile; |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14260
diff
changeset
|
220 |
DocPath stylesheet; |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
221 |
if (filename.length() > 0) { |
14368
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
222 |
DocFile file = DocFile.createFileForInput(configuration, filename); |
6f4c62de6985
8001664: refactor javadoc to use abstraction to handle files
jjg
parents:
14357
diff
changeset
|
223 |
stylesheet = DocPath.create(file.getName()); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
224 |
} else { |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14260
diff
changeset
|
225 |
stylesheet = DocPaths.STYLESHEET; |
10 | 226 |
} |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14260
diff
changeset
|
227 |
DocPath p = relativePath.resolve(stylesheet); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
14260
diff
changeset
|
228 |
HtmlTree link = HtmlTree.LINK("stylesheet", "text/css", p.getPath(), "Style"); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
229 |
return link; |
10 | 230 |
} |
231 |
||
232 |
/** |
|
233 |
* Get the header. |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
234 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
235 |
* @return the header content for the HTML file |
10 | 236 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
237 |
private static Content getHeader() { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
238 |
return new HtmlTree(HtmlTag.BODY); |
10 | 239 |
} |
240 |
||
241 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
242 |
* Add the line numbers for the source code. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
243 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
244 |
* @param pre the content tree to which the line number will be added |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
245 |
* @param lineno The line number |
10 | 246 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
247 |
private static void addLineNo(Content pre, int lineno) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
248 |
HtmlTree span = new HtmlTree(HtmlTag.SPAN); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
249 |
span.addStyle(HtmlStyle.sourceLineNo); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
250 |
if (lineno < 10) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
251 |
span.addContent("00" + Integer.toString(lineno)); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
252 |
} else if (lineno < 100) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
253 |
span.addContent("0" + Integer.toString(lineno)); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
254 |
} else { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
255 |
span.addContent(Integer.toString(lineno)); |
10 | 256 |
} |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
257 |
pre.addContent(span); |
10 | 258 |
} |
259 |
||
260 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
261 |
* Add a line from source to the HTML file that is generated. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
262 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
263 |
* @param pre the content tree to which the line will be added. |
10 | 264 |
* @param line the string to format. |
265 |
* @param currentLineNo the current number. |
|
266 |
*/ |
|
14542 | 267 |
private void addLine(Content pre, String line, int currentLineNo) { |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
268 |
if (line != null) { |
31297
86fe1414f12c
8081854: Javadoc should generate named anchors for HTML4 output
bpatel
parents:
29957
diff
changeset
|
269 |
Content anchor = HtmlTree.A(configuration.htmlVersion, |
86fe1414f12c
8081854: Javadoc should generate named anchors for HTML4 output
bpatel
parents:
29957
diff
changeset
|
270 |
"line." + Integer.toString(currentLineNo), |
29957
7740f9657f56
8072945: Javadoc should generate valid and compliant HTML5 output
bpatel
parents:
25874
diff
changeset
|
271 |
new StringContent(utils.replaceTabs(configuration, line))); |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
272 |
pre.addContent(anchor); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
273 |
pre.addContent(NEW_LINE); |
10 | 274 |
} |
275 |
} |
|
276 |
||
277 |
/** |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
278 |
* Add trailing blank lines at the end of the page. |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
279 |
* |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
280 |
* @param pre the content tree to which the blank lines will be added. |
10 | 281 |
*/ |
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
282 |
private static void addBlankLines(Content pre) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
283 |
for (int i = 0; i < NUM_BLANK_LINES; i++) { |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
284 |
pre.addContent(NEW_LINE); |
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
285 |
} |
10 | 286 |
} |
287 |
||
288 |
/** |
|
289 |
* Given a <code>Doc</code>, return an anchor name for it. |
|
7614
cfadc977ca75
6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents:
5520
diff
changeset
|
290 |
* |
10 | 291 |
* @param d the <code>Doc</code> to check. |
292 |
* @return the name of the anchor. |
|
293 |
*/ |
|
294 |
public static String getAnchorName(Doc d) { |
|
295 |
return "line." + d.position().line(); |
|
296 |
} |
|
297 |
} |