author | erikj |
Tue, 12 Sep 2017 19:03:39 +0200 | |
changeset 47216 | 71c04702a3d5 |
parent 45769 | jdk/make/src/classes/build/tools/taglet/ModuleGraph.java@2ed643787f98 |
child 48759 | ffa68af7da87 |
permissions | -rw-r--r-- |
44417
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
1 |
/* |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
2 |
* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved. |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
4 |
* |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
10 |
* |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
15 |
* accompanied this code). |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
16 |
* |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
20 |
* |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
23 |
* questions. |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
24 |
*/ |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
25 |
|
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
26 |
package build.tools.taglet; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
27 |
|
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
28 |
import java.util.EnumSet; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
29 |
import java.util.List; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
30 |
import java.util.Set; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
31 |
import javax.lang.model.element.Element; |
45769
2ed643787f98
8182736: javadoc generates bad names and broken module graph links
jjg
parents:
44417
diff
changeset
|
32 |
import javax.lang.model.element.ModuleElement; |
44417
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
33 |
import com.sun.source.doctree.DocTree; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
34 |
import jdk.javadoc.doclet.Taglet; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
35 |
import static jdk.javadoc.doclet.Taglet.Location.*; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
36 |
|
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
37 |
/** |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
38 |
* A block tag to optionally insert a reference to a module graph. |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
39 |
*/ |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
40 |
public class ModuleGraph implements Taglet { |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
41 |
private static final boolean enableModuleGraph = |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
42 |
Boolean.getBoolean("enableModuleGraph"); |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
43 |
|
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
44 |
/** Returns the set of locations in which a taglet may be used. */ |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
45 |
@Override |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
46 |
public Set<Location> getAllowedLocations() { |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
47 |
return EnumSet.of(MODULE); |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
48 |
} |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
49 |
|
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
50 |
@Override |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
51 |
public boolean isInlineTag() { |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
52 |
return false; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
53 |
} |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
54 |
|
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
55 |
@Override |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
56 |
public String getName() { |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
57 |
return "moduleGraph"; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
58 |
} |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
59 |
|
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
60 |
@Override |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
61 |
public String toString(List<? extends DocTree> tags, Element element) { |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
62 |
if (!enableModuleGraph) { |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
63 |
return ""; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
64 |
} |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
65 |
|
45769
2ed643787f98
8182736: javadoc generates bad names and broken module graph links
jjg
parents:
44417
diff
changeset
|
66 |
String moduleName = ((ModuleElement) element).getQualifiedName().toString(); |
44417
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
67 |
String imageFile = moduleName + "-graph.png"; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
68 |
int thumbnailHeight = -1; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
69 |
String hoverImage = ""; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
70 |
if (!moduleName.equals("java.base")) { |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
71 |
thumbnailHeight = 100; // also appears in the stylesheet |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
72 |
hoverImage = "<span>" |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
73 |
+ getImage(moduleName, imageFile, -1, true) |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
74 |
+ "</span>"; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
75 |
} |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
76 |
return "<dt>" |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
77 |
+ "<span class=\"simpleTagLabel\">Module Graph:</span>\n" |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
78 |
+ "</dt>" |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
79 |
+ "<dd>" |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
80 |
+ "<a class=moduleGraph href=\"" + imageFile + "\">" |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
81 |
+ getImage(moduleName, imageFile, thumbnailHeight, false) |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
82 |
+ hoverImage |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
83 |
+ "</a>" |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
84 |
+ "</dd>"; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
85 |
} |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
86 |
|
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
87 |
private static final String VERTICAL_ALIGN = "vertical-align:top"; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
88 |
private static final String BORDER = "border: solid lightgray 1px;"; |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
89 |
|
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
90 |
private String getImage(String moduleName, String file, int height, boolean useBorder) { |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
91 |
return String.format("<img style=\"%s\" alt=\"Module graph for %s\" src=\"%s\"%s>", |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
92 |
useBorder ? BORDER + " " + VERTICAL_ALIGN : VERTICAL_ALIGN, |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
93 |
moduleName, |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
94 |
file, |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
95 |
(height <= 0 ? "" : " height=\"" + height + "\"")); |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
96 |
} |
a431edba1629
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
diff
changeset
|
97 |
} |