author | jjg |
Fri, 27 May 2016 13:06:58 -0700 | |
changeset 38617 | d93a7f64e231 |
parent 37938 | 42baa89d2156 |
child 44573 | 245bb4e6f983 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
36526 | 2 |
* Copyright (c) 1998, 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 |
||
37938
42baa89d2156
8075703: jdk.javadoc module exports com.sun.tools.javadoc package which contains a lot of internal API.
jjg
parents:
37757
diff
changeset
|
26 |
package com.sun.tools.javadoc.main; |
10 | 27 |
|
8633
41311e88ffb7
6964914: javadoc does not output number of warnings using user written doclet
jjg
parents:
7681
diff
changeset
|
28 |
import java.io.File; |
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
29 |
import java.io.IOException; |
14258 | 30 |
import java.lang.reflect.InvocationTargetException; |
10 | 31 |
import java.lang.reflect.Method; |
32 |
import java.lang.reflect.Modifier; |
|
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
33 |
import java.net.MalformedURLException; |
8633
41311e88ffb7
6964914: javadoc does not output number of warnings using user written doclet
jjg
parents:
7681
diff
changeset
|
34 |
import java.net.URL; |
41311e88ffb7
6964914: javadoc does not output number of warnings using user written doclet
jjg
parents:
7681
diff
changeset
|
35 |
import java.net.URLClassLoader; |
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
36 |
import java.nio.file.Path; |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
37 |
import java.nio.file.Paths; |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
38 |
import java.util.ArrayList; |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
39 |
import java.util.regex.Pattern; |
10 | 40 |
|
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
41 |
import javax.tools.DocumentationTool; |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
42 |
import javax.tools.JavaFileManager; |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
43 |
|
14258 | 44 |
import com.sun.javadoc.*; |
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
45 |
import com.sun.tools.javac.util.ClientCodeException; |
14258 | 46 |
import com.sun.tools.javac.util.List; |
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
47 |
|
10 | 48 |
/** |
49 |
* Class creates, controls and invokes doclets. |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
50 |
* |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
51 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
52 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
53 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
54 |
* deletion without notice.</b> |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
55 |
* |
10 | 56 |
* @author Neal Gafter (rewrite) |
57 |
*/ |
|
38617 | 58 |
@Deprecated |
10 | 59 |
public class DocletInvoker { |
60 |
||
868 | 61 |
private final Class<?> docletClass; |
10 | 62 |
|
63 |
private final String docletClassName; |
|
64 |
||
65 |
private final ClassLoader appClassLoader; |
|
66 |
||
67 |
private final Messager messager; |
|
68 |
||
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
69 |
/** |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
70 |
* In API mode, exceptions thrown while calling the doclet are |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
71 |
* propagated using ClientCodeException. |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
72 |
*/ |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
73 |
private final boolean apiMode; |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
74 |
|
36526 | 75 |
/** |
76 |
* Whether javadoc internal API should be exported to doclets |
|
77 |
* and (indirectly) to taglets |
|
78 |
*/ |
|
79 |
private final boolean exportInternalAPI; |
|
80 |
||
10 | 81 |
private static class DocletInvokeException extends Exception { |
82 |
private static final long serialVersionUID = 0; |
|
83 |
} |
|
84 |
||
85 |
private String appendPath(String path1, String path2) { |
|
86 |
if (path1 == null || path1.length() == 0) { |
|
87 |
return path2 == null ? "." : path2; |
|
88 |
} else if (path2 == null || path2.length() == 0) { |
|
89 |
return path1; |
|
90 |
} else { |
|
91 |
return path1 + File.pathSeparator + path2; |
|
92 |
} |
|
93 |
} |
|
94 |
||
36526 | 95 |
public DocletInvoker(Messager messager, Class<?> docletClass, boolean apiMode, boolean exportInternalAPI) { |
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
96 |
this.messager = messager; |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
97 |
this.docletClass = docletClass; |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
98 |
docletClassName = docletClass.getName(); |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
99 |
appClassLoader = null; |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
100 |
this.apiMode = apiMode; |
36526 | 101 |
this.exportInternalAPI = exportInternalAPI; // for backdoor use by standard doclet for taglets |
102 |
||
103 |
// this may not be soon enough if the class has already been loaded |
|
104 |
if (exportInternalAPI) { |
|
105 |
exportInternalAPI(docletClass.getClassLoader()); |
|
106 |
} |
|
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
107 |
} |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
108 |
|
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
109 |
public DocletInvoker(Messager messager, JavaFileManager fileManager, |
1365 | 110 |
String docletClassName, String docletPath, |
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
111 |
ClassLoader docletParentClassLoader, |
36526 | 112 |
boolean apiMode, |
113 |
boolean exportInternalAPI) { |
|
10 | 114 |
this.messager = messager; |
115 |
this.docletClassName = docletClassName; |
|
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
116 |
this.apiMode = apiMode; |
36526 | 117 |
this.exportInternalAPI = exportInternalAPI; // for backdoor use by standard doclet for taglets |
10 | 118 |
|
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
119 |
if (fileManager != null && fileManager.hasLocation(DocumentationTool.Location.DOCLET_PATH)) { |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
120 |
appClassLoader = fileManager.getClassLoader(DocumentationTool.Location.DOCLET_PATH); |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
121 |
} else { |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
122 |
// construct class loader |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
123 |
String cpString = null; // make sure env.class.path defaults to dot |
10 | 124 |
|
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
125 |
// do prepends to get correct ordering |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
126 |
cpString = appendPath(System.getProperty("env.class.path"), cpString); |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
127 |
cpString = appendPath(System.getProperty("java.class.path"), cpString); |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
128 |
cpString = appendPath(docletPath, cpString); |
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
129 |
URL[] urls = pathToURLs(cpString); |
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
130 |
if (docletParentClassLoader == null) |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
131 |
appClassLoader = new URLClassLoader(urls, getDelegationClassLoader(docletClassName)); |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
132 |
else |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
133 |
appClassLoader = new URLClassLoader(urls, docletParentClassLoader); |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
134 |
} |
10 | 135 |
|
36526 | 136 |
if (exportInternalAPI) { |
137 |
exportInternalAPI(appClassLoader); |
|
138 |
} |
|
139 |
||
10 | 140 |
// attempt to find doclet |
1789
7ac8c0815000
6765045: Remove rawtypes warnings from langtools
mcimadamore
parents:
1365
diff
changeset
|
141 |
Class<?> dc = null; |
10 | 142 |
try { |
143 |
dc = appClassLoader.loadClass(docletClassName); |
|
144 |
} catch (ClassNotFoundException exc) { |
|
14543 | 145 |
messager.error(Messager.NOPOS, "main.doclet_class_not_found", docletClassName); |
10 | 146 |
messager.exit(); |
147 |
} |
|
148 |
docletClass = dc; |
|
149 |
} |
|
150 |
||
1990
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
151 |
/* |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
152 |
* Returns the delegation class loader to use when creating |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
153 |
* appClassLoader (used to load the doclet). The context class |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
154 |
* loader is the best choice, but legacy behavior was to use the |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
155 |
* default delegation class loader (aka system class loader). |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
156 |
* |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
157 |
* Here we favor using the context class loader. To ensure |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
158 |
* compatibility with existing apps, we revert to legacy |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
159 |
* behavior if either or both of the following conditions hold: |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
160 |
* |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
161 |
* 1) the doclet is loadable from the system class loader but not |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
162 |
* from the context class loader, |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
163 |
* |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
164 |
* 2) this.getClass() is loadable from the system class loader but not |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
165 |
* from the context class loader. |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
166 |
*/ |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
167 |
private ClassLoader getDelegationClassLoader(String docletClassName) { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
168 |
ClassLoader ctxCL = Thread.currentThread().getContextClassLoader(); |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
169 |
ClassLoader sysCL = ClassLoader.getSystemClassLoader(); |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
170 |
if (sysCL == null) |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
171 |
return ctxCL; |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
172 |
if (ctxCL == null) |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
173 |
return sysCL; |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
174 |
|
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
175 |
// Condition 1. |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
176 |
try { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
177 |
sysCL.loadClass(docletClassName); |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
178 |
try { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
179 |
ctxCL.loadClass(docletClassName); |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
180 |
} catch (ClassNotFoundException e) { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
181 |
return sysCL; |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
182 |
} |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
183 |
} catch (ClassNotFoundException e) { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
184 |
} |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
185 |
|
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
186 |
// Condition 2. |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
187 |
try { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
188 |
if (getClass() == sysCL.loadClass(getClass().getName())) { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
189 |
try { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
190 |
if (getClass() != ctxCL.loadClass(getClass().getName())) |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
191 |
return sysCL; |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
192 |
} catch (ClassNotFoundException e) { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
193 |
return sysCL; |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
194 |
} |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
195 |
} |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
196 |
} catch (ClassNotFoundException e) { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
197 |
} |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
198 |
|
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
199 |
return ctxCL; |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
200 |
} |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
201 |
|
10 | 202 |
/** |
203 |
* Generate documentation here. Return true on success. |
|
204 |
*/ |
|
205 |
public boolean start(RootDoc root) { |
|
206 |
Object retVal; |
|
207 |
String methodName = "start"; |
|
5850
6f095ff5b469
6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
5520
diff
changeset
|
208 |
Class<?>[] paramTypes = { RootDoc.class }; |
6f095ff5b469
6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
5520
diff
changeset
|
209 |
Object[] params = { root }; |
10 | 210 |
try { |
211 |
retVal = invoke(methodName, null, paramTypes, params); |
|
212 |
} catch (DocletInvokeException exc) { |
|
213 |
return false; |
|
214 |
} |
|
215 |
if (retVal instanceof Boolean) { |
|
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
216 |
return ((Boolean)retVal); |
10 | 217 |
} else { |
14543 | 218 |
messager.error(Messager.NOPOS, "main.must_return_boolean", |
10 | 219 |
docletClassName, methodName); |
220 |
return false; |
|
221 |
} |
|
222 |
} |
|
223 |
||
224 |
/** |
|
225 |
* Check for doclet added options here. Zero return means |
|
226 |
* option not known. Positive value indicates number of |
|
227 |
* arguments to option. Negative value means error occurred. |
|
228 |
*/ |
|
229 |
public int optionLength(String option) { |
|
230 |
Object retVal; |
|
231 |
String methodName = "optionLength"; |
|
5850
6f095ff5b469
6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
5520
diff
changeset
|
232 |
Class<?>[] paramTypes = { String.class }; |
6f095ff5b469
6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
5520
diff
changeset
|
233 |
Object[] params = { option }; |
10 | 234 |
try { |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
14545
diff
changeset
|
235 |
retVal = invoke(methodName, 0, paramTypes, params); |
10 | 236 |
} catch (DocletInvokeException exc) { |
237 |
return -1; |
|
238 |
} |
|
239 |
if (retVal instanceof Integer) { |
|
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
240 |
return ((Integer)retVal); |
10 | 241 |
} else { |
14543 | 242 |
messager.error(Messager.NOPOS, "main.must_return_int", |
10 | 243 |
docletClassName, methodName); |
244 |
return -1; |
|
245 |
} |
|
246 |
} |
|
247 |
||
248 |
/** |
|
249 |
* Let doclet check that all options are OK. Returning true means |
|
250 |
* options are OK. If method does not exist, assume true. |
|
251 |
*/ |
|
252 |
public boolean validOptions(List<String[]> optlist) { |
|
253 |
Object retVal; |
|
254 |
String options[][] = optlist.toArray(new String[optlist.length()][]); |
|
255 |
String methodName = "validOptions"; |
|
256 |
DocErrorReporter reporter = messager; |
|
5850
6f095ff5b469
6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
5520
diff
changeset
|
257 |
Class<?>[] paramTypes = { String[][].class, DocErrorReporter.class }; |
6f095ff5b469
6958836: javadoc should support -Xmaxerrs and -Xmaxwarns
jjg
parents:
5520
diff
changeset
|
258 |
Object[] params = { options, reporter }; |
10 | 259 |
try { |
260 |
retVal = invoke(methodName, Boolean.TRUE, paramTypes, params); |
|
261 |
} catch (DocletInvokeException exc) { |
|
262 |
return false; |
|
263 |
} |
|
264 |
if (retVal instanceof Boolean) { |
|
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
265 |
return ((Boolean)retVal); |
10 | 266 |
} else { |
14543 | 267 |
messager.error(Messager.NOPOS, "main.must_return_boolean", |
10 | 268 |
docletClassName, methodName); |
269 |
return false; |
|
270 |
} |
|
271 |
} |
|
272 |
||
273 |
/** |
|
274 |
* Return the language version supported by this doclet. |
|
275 |
* If the method does not exist in the doclet, assume version 1.1. |
|
276 |
*/ |
|
277 |
public LanguageVersion languageVersion() { |
|
278 |
try { |
|
279 |
Object retVal; |
|
280 |
String methodName = "languageVersion"; |
|
1789
7ac8c0815000
6765045: Remove rawtypes warnings from langtools
mcimadamore
parents:
1365
diff
changeset
|
281 |
Class<?>[] paramTypes = new Class<?>[0]; |
10 | 282 |
Object[] params = new Object[0]; |
283 |
try { |
|
38617 | 284 |
retVal = invoke(methodName, LanguageVersion.JAVA_1_1, paramTypes, params); |
10 | 285 |
} catch (DocletInvokeException exc) { |
38617 | 286 |
return LanguageVersion.JAVA_1_1; |
10 | 287 |
} |
288 |
if (retVal instanceof LanguageVersion) { |
|
289 |
return (LanguageVersion)retVal; |
|
290 |
} else { |
|
14543 | 291 |
messager.error(Messager.NOPOS, "main.must_return_languageversion", |
10 | 292 |
docletClassName, methodName); |
38617 | 293 |
return LanguageVersion.JAVA_1_1; |
10 | 294 |
} |
295 |
} catch (NoClassDefFoundError ex) { // for boostrapping, no Enum class. |
|
296 |
return null; |
|
297 |
} |
|
298 |
} |
|
299 |
||
300 |
/** |
|
301 |
* Utility method for calling doclet functionality |
|
302 |
*/ |
|
303 |
private Object invoke(String methodName, Object returnValueIfNonExistent, |
|
1789
7ac8c0815000
6765045: Remove rawtypes warnings from langtools
mcimadamore
parents:
1365
diff
changeset
|
304 |
Class<?>[] paramTypes, Object[] params) |
10 | 305 |
throws DocletInvokeException { |
306 |
Method meth; |
|
307 |
try { |
|
308 |
meth = docletClass.getMethod(methodName, paramTypes); |
|
309 |
} catch (NoSuchMethodException exc) { |
|
310 |
if (returnValueIfNonExistent == null) { |
|
14543 | 311 |
messager.error(Messager.NOPOS, "main.doclet_method_not_found", |
10 | 312 |
docletClassName, methodName); |
313 |
throw new DocletInvokeException(); |
|
314 |
} else { |
|
315 |
return returnValueIfNonExistent; |
|
316 |
} |
|
317 |
} catch (SecurityException exc) { |
|
14543 | 318 |
messager.error(Messager.NOPOS, "main.doclet_method_not_accessible", |
10 | 319 |
docletClassName, methodName); |
320 |
throw new DocletInvokeException(); |
|
321 |
} |
|
322 |
if (!Modifier.isStatic(meth.getModifiers())) { |
|
14543 | 323 |
messager.error(Messager.NOPOS, "main.doclet_method_must_be_static", |
10 | 324 |
docletClassName, methodName); |
325 |
throw new DocletInvokeException(); |
|
326 |
} |
|
1990
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
327 |
ClassLoader savedCCL = |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
328 |
Thread.currentThread().getContextClassLoader(); |
10 | 329 |
try { |
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
330 |
if (appClassLoader != null) // will be null if doclet class provided via API |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
331 |
Thread.currentThread().setContextClassLoader(appClassLoader); |
10 | 332 |
return meth.invoke(null , params); |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
14545
diff
changeset
|
333 |
} catch (IllegalArgumentException | NullPointerException exc) { |
14543 | 334 |
messager.error(Messager.NOPOS, "main.internal_error_exception_thrown", |
10 | 335 |
docletClassName, methodName, exc.toString()); |
336 |
throw new DocletInvokeException(); |
|
337 |
} catch (IllegalAccessException exc) { |
|
14543 | 338 |
messager.error(Messager.NOPOS, "main.doclet_method_not_accessible", |
10 | 339 |
docletClassName, methodName); |
340 |
throw new DocletInvokeException(); |
|
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
14545
diff
changeset
|
341 |
} |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
14545
diff
changeset
|
342 |
catch (InvocationTargetException exc) { |
10 | 343 |
Throwable err = exc.getTargetException(); |
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
344 |
if (apiMode) |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
345 |
throw new ClientCodeException(err); |
10 | 346 |
if (err instanceof java.lang.OutOfMemoryError) { |
14543 | 347 |
messager.error(Messager.NOPOS, "main.out.of.memory"); |
10 | 348 |
} else { |
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
349 |
messager.error(Messager.NOPOS, "main.exception_thrown", |
10 | 350 |
docletClassName, methodName, exc.toString()); |
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
351 |
exc.getTargetException().printStackTrace(System.err); |
10 | 352 |
} |
353 |
throw new DocletInvokeException(); |
|
1990
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
354 |
} finally { |
5d90be5d60bb
6176978: current Javadoc's invocation and extension (Doclet) mechanisms are problematic
jjg
parents:
1789
diff
changeset
|
355 |
Thread.currentThread().setContextClassLoader(savedCCL); |
10 | 356 |
} |
357 |
} |
|
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
358 |
|
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
359 |
/** |
36526 | 360 |
* Export javadoc internal API to the unnamed module for a classloader. |
361 |
* This is to support continued use of existing non-standard doclets that |
|
362 |
* use the internal toolkit API and related classes. |
|
363 |
* @param cl the classloader |
|
364 |
*/ |
|
365 |
private void exportInternalAPI(ClassLoader cl) { |
|
366 |
String[] packages = { |
|
367 |
"com.sun.tools.doclets", |
|
368 |
"com.sun.tools.doclets.standard", |
|
369 |
"com.sun.tools.doclets.internal.toolkit", |
|
370 |
"com.sun.tools.doclets.internal.toolkit.taglets", |
|
371 |
"com.sun.tools.doclets.internal.toolkit.builders", |
|
372 |
"com.sun.tools.doclets.internal.toolkit.util", |
|
373 |
"com.sun.tools.doclets.internal.toolkit.util.links", |
|
374 |
"com.sun.tools.doclets.formats.html", |
|
375 |
"com.sun.tools.doclets.formats.html.markup" |
|
376 |
}; |
|
377 |
||
378 |
try { |
|
379 |
Method getModuleMethod = Class.class.getDeclaredMethod("getModule"); |
|
380 |
Object thisModule = getModuleMethod.invoke(getClass()); |
|
381 |
||
382 |
Class<?> moduleClass = Class.forName("java.lang.reflect.Module"); |
|
383 |
Method addExportsMethod = moduleClass.getDeclaredMethod("addExports", String.class, moduleClass); |
|
384 |
||
385 |
Method getUnnamedModuleMethod = ClassLoader.class.getDeclaredMethod("getUnnamedModule"); |
|
386 |
Object target = getUnnamedModuleMethod.invoke(cl); |
|
387 |
||
388 |
for (String pack : packages) { |
|
389 |
addExportsMethod.invoke(thisModule, pack, target); |
|
390 |
} |
|
391 |
} catch (Exception e) { |
|
392 |
// do nothing |
|
393 |
} |
|
394 |
} |
|
395 |
||
396 |
/** |
|
28707
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
397 |
* Utility method for converting a search path string to an array of directory and JAR file |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
398 |
* URLs. |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
399 |
* |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
400 |
* Note that this method is called by the DocletInvoker. |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
401 |
* |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
402 |
* @param path the search path string |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
403 |
* @return the resulting array of directory and JAR file URLs |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
404 |
*/ |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
405 |
private static URL[] pathToURLs(String path) { |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
406 |
java.util.List<URL> urls = new ArrayList<>(); |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
407 |
for (String s: path.split(Pattern.quote(File.pathSeparator))) { |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
408 |
if (!s.isEmpty()) { |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
409 |
URL url = fileToURL(Paths.get(s)); |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
410 |
if (url != null) { |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
411 |
urls.add(url); |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
412 |
} |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
413 |
} |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
414 |
} |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
415 |
return urls.toArray(new URL[urls.size()]); |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
416 |
} |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
417 |
|
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
418 |
/** |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
419 |
* Returns the directory or JAR file URL corresponding to the specified local file name. |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
420 |
* |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
421 |
* @param file the Path object |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
422 |
* @return the resulting directory or JAR file URL, or null if unknown |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
423 |
*/ |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
424 |
private static URL fileToURL(Path file) { |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
425 |
Path p; |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
426 |
try { |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
427 |
p = file.toRealPath(); |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
428 |
} catch (IOException e) { |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
429 |
p = file.toAbsolutePath(); |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
430 |
} |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
431 |
try { |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
432 |
return p.normalize().toUri().toURL(); |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
433 |
} catch (MalformedURLException e) { |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
434 |
return null; |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
435 |
} |
2ec91c67b30b
8071617: move pathToURLs from javac.file.Locations to javadoc.DocletInvoker
jjg
parents:
25874
diff
changeset
|
436 |
} |
10 | 437 |
} |