1 /*
2 * Copyright (c) 2001, 2015, Oracle and/or its affiliates. All rights reserved.
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
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
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 *
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.
24 */
25
26 package com.sun.tools.doclets.formats.html;
27
28 import java.io.*;
29
30 import javax.tools.FileObject;
31
32 import com.sun.javadoc.*;
33 import com.sun.tools.doclets.formats.html.markup.*;
34 import com.sun.tools.doclets.internal.toolkit.*;
35 import com.sun.tools.doclets.internal.toolkit.util.*;
36
37 /**
38 * Converts Java Source Code to HTML.
39 *
40 * <p><b>This is NOT part of any supported API.
41 * If you write code that depends on this, you do so at your own risk.
42 * This code and its internal interfaces are subject to change or
43 * deletion without notice.</b>
44 *
45 * @author Jamie Ho
46 * @author Bhavesh Patel (Modified)
47 * @since 1.4
48 */
49 public class SourceToHTMLConverter {
50
51 /**
52 * The number of trailing blank lines at the end of the page.
53 * This is inserted so that anchors at the bottom of small pages
54 * can be reached.
55 */
56 private static final int NUM_BLANK_LINES = 60;
57
58 /**
59 * New line to be added to the documentation.
60 */
61 private static final String NEW_LINE = DocletConstants.NL;
62
63 private final ConfigurationImpl configuration;
64 private final Utils utils;
65
66 private final RootDoc rootDoc;
67
68 private DocPath outputdir;
69
70 /**
71 * Relative path from the documentation root to the file that is being
72 * generated.
73 */
74 private DocPath relativePath = DocPath.empty;
75
76 private SourceToHTMLConverter(ConfigurationImpl configuration, RootDoc rd,
77 DocPath outputdir) {
78 this.configuration = configuration;
79 this.utils = configuration.utils;
80 this.rootDoc = rd;
81 this.outputdir = outputdir;
82 }
83
84 /**
85 * Convert the Classes in the given RootDoc to an HTML.
86 *
87 * @param configuration the configuration.
88 * @param rd the RootDoc to convert.
89 * @param outputdir the name of the directory to output to.
90 */
91 public static void convertRoot(ConfigurationImpl configuration, RootDoc rd,
92 DocPath outputdir) {
93 new SourceToHTMLConverter(configuration, rd, outputdir).generate();
94 }
95
96 void generate() {
97 if (rootDoc == null || outputdir == null) {
98 return;
99 }
100 for (PackageDoc pd : rootDoc.specifiedPackages()) {
101 // If -nodeprecated option is set and the package is marked as deprecated,
102 // do not convert the package files to HTML.
103 if (!(configuration.nodeprecated && utils.isDeprecated(pd)))
104 convertPackage(pd, outputdir);
105 }
106 for (ClassDoc cd : rootDoc.specifiedClasses()) {
107 // If -nodeprecated option is set and the class is marked as deprecated
108 // or the containing package is deprecated, do not convert the
109 // package files to HTML.
110 if (!(configuration.nodeprecated &&
111 (utils.isDeprecated(cd) || utils.isDeprecated(cd.containingPackage()))))
112 convertClass(cd, outputdir);
113 }
114 }
115
116 /**
117 * Convert the Classes in the given Package to an HTML.
118 *
119 * @param pd the Package to convert.
120 * @param outputdir the name of the directory to output to.
121 */
122 public void convertPackage(PackageDoc pd, DocPath outputdir) {
123 if (pd == null) {
124 return;
125 }
126 for (ClassDoc cd : pd.allClasses()) {
127 // If -nodeprecated option is set and the class is marked as deprecated,
128 // do not convert the package files to HTML. We do not check for
129 // containing package deprecation since it is already check in
130 // the calling method above.
131 if (!(configuration.nodeprecated && utils.isDeprecated(cd)))
132 convertClass(cd, outputdir);
133 }
134 }
135
136 /**
137 * Convert the given Class to an HTML.
138 *
139 * @param cd the class to convert.
140 * @param outputdir the name of the directory to output to.
141 */
142 public void convertClass(ClassDoc cd, DocPath outputdir) {
143 if (cd == null) {
144 return;
145 }
146 try {
147 SourcePosition sp = cd.position();
148 if (sp == null)
149 return;
150 Reader r;
151 // temp hack until we can update SourcePosition API.
152 if (sp instanceof com.sun.tools.javadoc.SourcePositionImpl) {
153 FileObject fo = ((com.sun.tools.javadoc.SourcePositionImpl) sp).fileObject();
154 if (fo == null)
155 return;
156 r = fo.openReader(true);
157 } else {
158 File file = sp.file();
159 if (file == null)
160 return;
161 r = new FileReader(file);
162 }
163 int lineno = 1;
164 String line;
165 relativePath = DocPaths.SOURCE_OUTPUT
166 .resolve(DocPath.forPackage(cd))
167 .invert();
168 Content body = getHeader();
169 Content pre = new HtmlTree(HtmlTag.PRE);
170 try (LineNumberReader reader = new LineNumberReader(r)) {
171 while ((line = reader.readLine()) != null) {
172 addLineNo(pre, lineno);
173 addLine(pre, line, lineno);
174 lineno++;
175 }
176 }
177 addBlankLines(pre);
178 Content div = HtmlTree.DIV(HtmlStyle.sourceContainer, pre);
179 body.addContent((configuration.allowTag(HtmlTag.MAIN)) ? HtmlTree.MAIN(div) : div);
180 writeToFile(body, outputdir.resolve(DocPath.forClass(cd)));
181 } catch (IOException e) {
182 e.printStackTrace();
183 }
184 }
185
186 /**
187 * Write the output to the file.
188 *
189 * @param body the documentation content to be written to the file.
190 * @param path the path for the file.
191 */
192 private void writeToFile(Content body, DocPath path) throws IOException {
193 Content htmlDocType = configuration.isOutputHtml5()
194 ? DocType.HTML5
195 : DocType.TRANSITIONAL;
196 Content head = new HtmlTree(HtmlTag.HEAD);
197 head.addContent(HtmlTree.TITLE(new StringContent(
198 configuration.getText("doclet.Window_Source_title"))));
199 head.addContent(getStyleSheetProperties());
200 Content htmlTree = HtmlTree.HTML(configuration.getLocale().getLanguage(),
201 head, body);
202 Content htmlDocument = new HtmlDocument(htmlDocType, htmlTree);
203 configuration.message.notice("doclet.Generating_0", path.getPath());
204 DocFile df = DocFile.createFileForOutput(configuration, path);
205 try (Writer w = df.openWriter()) {
206 htmlDocument.write(w, true);
207 }
208
209 }
210
211 /**
212 * Returns a link to the stylesheet file.
213 *
214 * @return an HtmlTree for the lINK tag which provides the stylesheet location
215 */
216 public HtmlTree getStyleSheetProperties() {
217 String filename = configuration.stylesheetfile;
218 DocPath stylesheet;
219 if (filename.length() > 0) {
220 DocFile file = DocFile.createFileForInput(configuration, filename);
221 stylesheet = DocPath.create(file.getName());
222 } else {
223 stylesheet = DocPaths.STYLESHEET;
224 }
225 DocPath p = relativePath.resolve(stylesheet);
226 HtmlTree link = HtmlTree.LINK("stylesheet", "text/css", p.getPath(), "Style");
227 return link;
228 }
229
230 /**
231 * Get the header.
232 *
233 * @return the header content for the HTML file
234 */
235 private static Content getHeader() {
236 return new HtmlTree(HtmlTag.BODY);
237 }
238
239 /**
240 * Add the line numbers for the source code.
241 *
242 * @param pre the content tree to which the line number will be added
243 * @param lineno The line number
244 */
245 private static void addLineNo(Content pre, int lineno) {
246 HtmlTree span = new HtmlTree(HtmlTag.SPAN);
247 span.addStyle(HtmlStyle.sourceLineNo);
248 if (lineno < 10) {
249 span.addContent("00" + Integer.toString(lineno));
250 } else if (lineno < 100) {
251 span.addContent("0" + Integer.toString(lineno));
252 } else {
253 span.addContent(Integer.toString(lineno));
254 }
255 pre.addContent(span);
256 }
257
258 /**
259 * Add a line from source to the HTML file that is generated.
260 *
261 * @param pre the content tree to which the line will be added.
262 * @param line the string to format.
263 * @param currentLineNo the current number.
264 */
265 private void addLine(Content pre, String line, int currentLineNo) {
266 if (line != null) {
267 Content anchor = HtmlTree.A(configuration.htmlVersion,
268 "line." + Integer.toString(currentLineNo),
269 new StringContent(utils.replaceTabs(configuration, line)));
270 pre.addContent(anchor);
271 pre.addContent(NEW_LINE);
272 }
273 }
274
275 /**
276 * Add trailing blank lines at the end of the page.
277 *
278 * @param pre the content tree to which the blank lines will be added.
279 */
280 private static void addBlankLines(Content pre) {
281 for (int i = 0; i < NUM_BLANK_LINES; i++) {
282 pre.addContent(NEW_LINE);
283 }
284 }
285
286 /**
287 * Given a <code>Doc</code>, return an anchor name for it.
288 *
289 * @param d the <code>Doc</code> to check.
290 * @return the name of the anchor.
291 */
292 public static String getAnchorName(Doc d) {
293 return "line." + d.position().line();
294 }
295 }