1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 8272944
* @summary Use snippets in jdk.javadoc documentation
* @key needs-src needs-src-jdk_javadoc
* @library /tools/lib ../../lib
* @modules jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
* jdk.javadoc/jdk.javadoc.internal.tool
* @build snippets.SnippetUtils toolbox.JavacTask toolbox.ToolBox javadoc.tester.*
* @run main TestDocletExample
*/
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.spi.ToolProvider;
import java.util.stream.Stream;
import snippets.SnippetUtils;
import toolbox.Task;
import toolbox.TestRunner;
import toolbox.ToolBox;
import javax.tools.DiagnosticCollector;
import javax.tools.JavaFileObject;
public class TestDocletExample extends TestRunner {
public static void main(String... args) throws Exception {
try {
var t = new TestDocletExample();
t.runTests(m -> new Object[] { Path.of(m.getName()) });
} catch (SnippetUtils.ConfigurationException e) {
System.err.println("NOTE: " + e.getMessage() + "; test skipped");
}
}
SnippetUtils snippets;
ToolBox tb = new ToolBox();
TestDocletExample() throws SnippetUtils.ConfigurationException {
super(System.out);
snippets = new SnippetUtils("jdk.javadoc");
}
@Test
public void testEntryPoint(Path base) throws Exception {
var docletPkg = snippets.getElements().getPackageElement("jdk.javadoc.doclet");
var dc = snippets.getDocTrees().getDocCommentTree(docletPkg);
var entryPointSnippet = snippets.getSnippetById(dc, "entry-point");
var entryPointCode = entryPointSnippet.getBody().getBody();
var code = """
class C {
%s { }
}
""".formatted(entryPointCode);
DiagnosticCollector<JavaFileObject> collector = new DiagnosticCollector<>();
snippets.parse(code, null, collector);
var diags = collector.getDiagnostics();
if (diags.isEmpty()) {
out.println("parsed entry point snippet");
} else {
diags.forEach(out::println);
throw new Exception("parse failed");
}
}
@Test
public void testDocletExample(Path base) throws Exception {
// get source code
var docletPkg = snippets.getElements().getPackageElement("jdk.javadoc.doclet");
var dc = snippets.getDocTrees().getDocCommentTree(docletPkg);
var exampleSnippet = snippets.getSnippetById(dc, "Example.java");
var exampleCode = exampleSnippet.getBody().getBody();
// compile it
Path src = base.resolve("src");
Path classes = base.resolve("classes");
Files.createDirectories(classes);
tb.writeJavaFiles(src, exampleCode);
new toolbox.JavacTask(tb)
.outdir(classes)
.files(tb.findJavaFiles(src))
.run(Task.Expect.SUCCESS)
.writeAll();
// get demo command
var cmdSnippet = snippets.getSnippetById(dc, "run-doclet");
var cmd = cmdSnippet.getBody().getBody()
.replaceAll("\\s+//.*", "") // remove markup
.replaceAll("\\\\\n", " ") // join lines
.trim();
out.println(cmd);
tb.writeFile(src.resolve("overview.html"),
"""
<!doctype html>
<html><title>Overview</title>
<body>
Overview
</body>
</html>
""");
var cmdWords = Stream.of(cmd.split("\\s+"))
.map(s -> s.replace("source-location", src.toString()))
.map(s -> s.replace("doclet-classes", classes.toString()))
.toList();
var toolName = cmdWords.get(0);
var toolArgs = cmdWords.subList(1, cmdWords.size());
ToolProvider tool = ToolProvider.findFirst(toolName)
.orElseThrow(() -> new Exception("tool not found: " + toolName));
int rc = tool.run(System.out, System.err, toolArgs.toArray(new String[0]));
if (rc != 0) {
throw new Exception("ecommand return code: " + rc);
}
}
}
|
