author | ksrini |
Wed, 20 Jul 2016 12:49:32 -0700 | |
changeset 39917 | c51a8950f278 |
parent 38619 | 27c0007bb28d |
child 40311 | bb76098875c8 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
36526 | 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 |
||
37938
42baa89d2156
8075703: jdk.javadoc module exports com.sun.tools.javadoc package which contains a lot of internal API.
jjg
parents:
36526
diff
changeset
|
26 |
package com.sun.tools.javadoc.main; |
10 | 27 |
|
1869 | 28 |
import java.io.File; |
29 |
import java.io.IOException; |
|
10 | 30 |
import java.util.Collection; |
39917
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
31 |
import java.util.Collections; |
1869 | 32 |
import java.util.EnumSet; |
23116
4c134ccd6b8d
8029145: javadoc fails with java.lang.IllegalStateException: endPosTable already set
ksrini
parents:
22163
diff
changeset
|
33 |
import java.util.HashSet; |
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
34 |
import java.util.LinkedHashMap; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
35 |
import java.util.LinkedHashSet; |
1869 | 36 |
import java.util.Map; |
37 |
import java.util.Set; |
|
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
23973
diff
changeset
|
38 |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
39 |
import javax.tools.JavaFileManager; |
1869 | 40 |
import javax.tools.JavaFileManager.Location; |
41 |
import javax.tools.JavaFileObject; |
|
42 |
import javax.tools.StandardJavaFileManager; |
|
43 |
import javax.tools.StandardLocation; |
|
10 | 44 |
|
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
23973
diff
changeset
|
45 |
import com.sun.tools.javac.code.ClassFinder; |
30066
d74c06a92bd8
8078600: Infinite loop when compiling annotations with -XDcompletionDeps
alundblad
parents:
25874
diff
changeset
|
46 |
import com.sun.tools.javac.code.Symbol.Completer; |
36526 | 47 |
import com.sun.tools.javac.code.Symbol.ModuleSymbol; |
39917
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
48 |
import com.sun.tools.javac.code.Symbol.PackageSymbol; |
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
23973
diff
changeset
|
49 |
import com.sun.tools.javac.comp.Enter; |
1869 | 50 |
import com.sun.tools.javac.tree.JCTree; |
51 |
import com.sun.tools.javac.tree.JCTree.JCClassDecl; |
|
52 |
import com.sun.tools.javac.tree.JCTree.JCCompilationUnit; |
|
53 |
import com.sun.tools.javac.util.Abort; |
|
54 |
import com.sun.tools.javac.util.Context; |
|
55 |
import com.sun.tools.javac.util.List; |
|
56 |
import com.sun.tools.javac.util.ListBuffer; |
|
39917
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
57 |
import com.sun.tools.javac.util.Name; |
10 | 58 |
|
59 |
||
60 |
/** |
|
61 |
* This class could be the main entry point for Javadoc when Javadoc is used as a |
|
62 |
* component in a larger software system. It provides operations to |
|
63 |
* construct a new javadoc processor, and to run it on a set of source |
|
64 |
* files. |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14259
diff
changeset
|
65 |
* |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14259
diff
changeset
|
66 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14259
diff
changeset
|
67 |
* 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:
14259
diff
changeset
|
68 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14259
diff
changeset
|
69 |
* deletion without notice.</b> |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14259
diff
changeset
|
70 |
* |
10 | 71 |
* @author Neal Gafter |
72 |
*/ |
|
38617 | 73 |
@Deprecated |
10 | 74 |
public class JavadocTool extends com.sun.tools.javac.main.JavaCompiler { |
75 |
DocEnv docenv; |
|
76 |
||
77 |
final Messager messager; |
|
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
23973
diff
changeset
|
78 |
final ClassFinder javadocFinder; |
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
23973
diff
changeset
|
79 |
final Enter javadocEnter; |
23973
4b5f3a297142
8037484: [javadoc] fails with java.lang.IllegalStateException: endPosTable already set
ksrini
parents:
23116
diff
changeset
|
80 |
final Set<JavaFileObject> uniquefiles; |
10 | 81 |
|
82 |
/** |
|
83 |
* Construct a new JavaCompiler processor, using appropriately |
|
84 |
* extended phases of the underlying compiler. |
|
85 |
*/ |
|
86 |
protected JavadocTool(Context context) { |
|
87 |
super(context); |
|
88 |
messager = Messager.instance0(context); |
|
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
23973
diff
changeset
|
89 |
javadocFinder = JavadocClassFinder.instance(context); |
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
23973
diff
changeset
|
90 |
javadocEnter = JavadocEnter.instance(context); |
23973
4b5f3a297142
8037484: [javadoc] fails with java.lang.IllegalStateException: endPosTable already set
ksrini
parents:
23116
diff
changeset
|
91 |
uniquefiles = new HashSet<>(); |
10 | 92 |
} |
93 |
||
94 |
/** |
|
95 |
* For javadoc, the parser needs to keep comments. Overrides method from JavaCompiler. |
|
96 |
*/ |
|
36526 | 97 |
@Override |
10 | 98 |
protected boolean keepComments() { |
99 |
return true; |
|
100 |
} |
|
101 |
||
102 |
/** |
|
103 |
* Construct a new javadoc tool. |
|
104 |
*/ |
|
105 |
public static JavadocTool make0(Context context) { |
|
36526 | 106 |
// force the use of Javadoc's class finder |
107 |
JavadocClassFinder.preRegister(context); |
|
10 | 108 |
|
36526 | 109 |
// force the use of Javadoc's own enter phase |
110 |
JavadocEnter.preRegister(context); |
|
10 | 111 |
|
36526 | 112 |
// force the use of Javadoc's own member enter phase |
113 |
JavadocMemberEnter.preRegister(context); |
|
10 | 114 |
|
36526 | 115 |
// force the use of Javadoc's own todo phase |
116 |
JavadocTodo.preRegister(context); |
|
117 |
||
118 |
// force the use of Messager as a Log |
|
119 |
Messager.instance0(context); |
|
120 |
||
121 |
return new JavadocTool(context); |
|
10 | 122 |
} |
123 |
||
124 |
public RootDocImpl getRootDocImpl(String doclocale, |
|
125 |
String encoding, |
|
126 |
ModifierFilter filter, |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
127 |
List<String> args, |
10 | 128 |
List<String[]> options, |
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
129 |
Iterable<? extends JavaFileObject> fileObjects, |
10 | 130 |
boolean breakiterator, |
131 |
List<String> subPackages, |
|
132 |
List<String> excludedPackages, |
|
133 |
boolean docClasses, |
|
134 |
boolean legacyDoclet, |
|
135 |
boolean quiet) throws IOException { |
|
136 |
docenv = DocEnv.instance(context); |
|
137 |
docenv.showAccess = filter; |
|
1869 | 138 |
docenv.quiet = quiet; |
10 | 139 |
docenv.breakiterator = breakiterator; |
140 |
docenv.setLocale(doclocale); |
|
141 |
docenv.setEncoding(encoding); |
|
142 |
docenv.docClasses = docClasses; |
|
143 |
docenv.legacyDoclet = legacyDoclet; |
|
24604
7f68545b5128
8041422: Split javac ClassReader into ClassReader+ClassFinder
jjg
parents:
23973
diff
changeset
|
144 |
|
30066
d74c06a92bd8
8078600: Infinite loop when compiling annotations with -XDcompletionDeps
alundblad
parents:
25874
diff
changeset
|
145 |
javadocFinder.sourceCompleter = docClasses ? Completer.NULL_COMPLETER : sourceCompleter; |
10 | 146 |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
147 |
if (docClasses) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
148 |
// If -Xclasses is set, the args should be a series of class names |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
149 |
for (String arg: args) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
150 |
if (!isValidPackageName(arg)) // checks |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
151 |
docenv.error(null, "main.illegal_class_name", arg); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
152 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
153 |
if (messager.nerrors() != 0) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
154 |
return null; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
155 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
156 |
return new RootDocImpl(docenv, args, options); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
157 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
158 |
|
22163 | 159 |
ListBuffer<JCCompilationUnit> classTrees = new ListBuffer<>(); |
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
160 |
Set<String> includedPackages = new LinkedHashSet<>(); |
10 | 161 |
|
162 |
try { |
|
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
163 |
StandardJavaFileManager fm = docenv.fileManager instanceof StandardJavaFileManager |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
164 |
? (StandardJavaFileManager) docenv.fileManager : null; |
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
165 |
Set<String> packageNames = new LinkedHashSet<>(); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
166 |
// Normally, the args should be a series of package names or file names. |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
167 |
// Parse the files and collect the package names. |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
168 |
for (String arg: args) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
169 |
if (fm != null && arg.endsWith(".java") && new File(arg).exists()) { |
36526 | 170 |
if (new File(arg).getName().equals("module-info.java")) { |
171 |
docenv.warning(null, "main.file_ignored", arg); |
|
172 |
} else { |
|
173 |
parse(fm.getJavaFileObjects(arg), classTrees, true); |
|
174 |
} |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
175 |
} else if (isValidPackageName(arg)) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
176 |
packageNames.add(arg); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
177 |
} else if (arg.endsWith(".java")) { |
14545
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
178 |
if (fm == null) |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
179 |
throw new IllegalArgumentException(); |
2e7bab0639b8
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
14543
diff
changeset
|
180 |
else |
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
181 |
docenv.error(null, "main.file_not_found", arg); |
10 | 182 |
} else { |
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
183 |
docenv.error(null, "main.illegal_package_name", arg); |
10 | 184 |
} |
185 |
} |
|
186 |
||
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
187 |
// Parse file objects provide via the DocumentationTool API |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
188 |
parse(fileObjects, classTrees, true); |
36526 | 189 |
|
39917
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
190 |
modules.initModules(classTrees.toList(), Collections.emptySet(), Collections.emptySet()); |
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
191 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
192 |
// Build up the complete list of any packages to be documented |
38619 | 193 |
Location location = modules.multiModuleMode ? StandardLocation.MODULE_SOURCE_PATH |
36526 | 194 |
: docenv.fileManager.hasLocation(StandardLocation.SOURCE_PATH) ? StandardLocation.SOURCE_PATH |
195 |
: StandardLocation.CLASS_PATH; |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
196 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
197 |
PackageTable t = new PackageTable(docenv.fileManager, location) |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
198 |
.packages(packageNames) |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
199 |
.subpackages(subPackages, excludedPackages); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
200 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
201 |
includedPackages = t.getIncludedPackages(); |
10 | 202 |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
203 |
// Parse the files in the packages to be documented |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
204 |
ListBuffer<JCCompilationUnit> packageTrees = new ListBuffer<>(); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
205 |
for (String packageName: includedPackages) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
206 |
List<JavaFileObject> files = t.getFiles(packageName); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
207 |
docenv.notice("main.Loading_source_files_for_package", packageName); |
10 | 208 |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
209 |
if (files.isEmpty()) |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
210 |
messager.warning(Messager.NOPOS, "main.no_source_files_for_package", packageName); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
211 |
parse(files, packageTrees, false); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
212 |
} |
36526 | 213 |
modules.enter(packageTrees.toList(), null); |
10 | 214 |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
215 |
if (messager.nerrors() != 0) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
216 |
return null; |
10 | 217 |
} |
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
218 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
219 |
// Enter symbols for all files |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
220 |
docenv.notice("main.Building_tree"); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
221 |
javadocEnter.main(classTrees.toList().appendList(packageTrees.toList())); |
36526 | 222 |
enterDone = true; |
10 | 223 |
} catch (Abort ex) {} |
224 |
||
1869 | 225 |
if (messager.nerrors() != 0) |
226 |
return null; |
|
10 | 227 |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
228 |
return new RootDocImpl(docenv, listClasses(classTrees.toList()), List.from(includedPackages), options); |
10 | 229 |
} |
230 |
||
231 |
/** Is the given string a valid package name? */ |
|
232 |
boolean isValidPackageName(String s) { |
|
233 |
int index; |
|
234 |
while ((index = s.indexOf('.')) != -1) { |
|
235 |
if (!isValidClassName(s.substring(0, index))) return false; |
|
236 |
s = s.substring(index+1); |
|
237 |
} |
|
238 |
return isValidClassName(s); |
|
239 |
} |
|
240 |
||
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
241 |
private void parse(Iterable<? extends JavaFileObject> files, ListBuffer<JCCompilationUnit> trees, |
23973
4b5f3a297142
8037484: [javadoc] fails with java.lang.IllegalStateException: endPosTable already set
ksrini
parents:
23116
diff
changeset
|
242 |
boolean trace) { |
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
243 |
for (JavaFileObject fo: files) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
244 |
if (uniquefiles.add(fo)) { // ignore duplicates |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
245 |
if (trace) |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
246 |
docenv.notice("main.Loading_source_file", fo.getName()); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
247 |
trees.append(parse(fo)); |
1869 | 248 |
} |
249 |
} |
|
250 |
} |
|
251 |
||
10 | 252 |
/** Are surrogates supported? |
253 |
*/ |
|
254 |
final static boolean surrogatesSupported = surrogatesSupported(); |
|
255 |
private static boolean surrogatesSupported() { |
|
256 |
try { |
|
257 |
boolean b = Character.isHighSurrogate('a'); |
|
258 |
return true; |
|
259 |
} catch (NoSuchMethodError ex) { |
|
260 |
return false; |
|
261 |
} |
|
262 |
} |
|
263 |
||
264 |
/** |
|
265 |
* Return true if given file name is a valid class name |
|
266 |
* (including "package-info"). |
|
14259 | 267 |
* @param s the name of the class to check. |
10 | 268 |
* @return true if given class name is a valid class name |
269 |
* and false otherwise. |
|
270 |
*/ |
|
271 |
public static boolean isValidClassName(String s) { |
|
272 |
if (s.length() < 1) return false; |
|
273 |
if (s.equals("package-info")) return true; |
|
274 |
if (surrogatesSupported) { |
|
275 |
int cp = s.codePointAt(0); |
|
276 |
if (!Character.isJavaIdentifierStart(cp)) |
|
277 |
return false; |
|
278 |
for (int j=Character.charCount(cp); j<s.length(); j+=Character.charCount(cp)) { |
|
279 |
cp = s.codePointAt(j); |
|
280 |
if (!Character.isJavaIdentifierPart(cp)) |
|
281 |
return false; |
|
282 |
} |
|
283 |
} else { |
|
284 |
if (!Character.isJavaIdentifierStart(s.charAt(0))) |
|
285 |
return false; |
|
286 |
for (int j=1; j<s.length(); j++) |
|
287 |
if (!Character.isJavaIdentifierPart(s.charAt(j))) |
|
288 |
return false; |
|
289 |
} |
|
290 |
return true; |
|
291 |
} |
|
292 |
||
293 |
/** |
|
294 |
* From a list of top level trees, return the list of contained class definitions |
|
295 |
*/ |
|
296 |
List<JCClassDecl> listClasses(List<JCCompilationUnit> trees) { |
|
22163 | 297 |
ListBuffer<JCClassDecl> result = new ListBuffer<>(); |
10 | 298 |
for (JCCompilationUnit t : trees) { |
299 |
for (JCTree def : t.defs) { |
|
10950 | 300 |
if (def.hasTag(JCTree.Tag.CLASSDEF)) |
10 | 301 |
result.append((JCClassDecl)def); |
302 |
} |
|
303 |
} |
|
304 |
return result.toList(); |
|
305 |
} |
|
306 |
||
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
307 |
/** |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
308 |
* A table to manage included and excluded packages. |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
309 |
*/ |
36526 | 310 |
class PackageTable { |
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
311 |
private final Map<String, Entry> entries = new LinkedHashMap<>(); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
312 |
private final Set<String> includedPackages = new LinkedHashSet<>(); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
313 |
private final JavaFileManager fm; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
314 |
private final Location location; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
315 |
private final Set<JavaFileObject.Kind> sourceKinds = EnumSet.of(JavaFileObject.Kind.SOURCE); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
316 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
317 |
/** |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
318 |
* Creates a table to manage included and excluded packages. |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
319 |
* @param fm The file manager used to locate source files |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
320 |
* @param locn the location used to locate source files |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
321 |
*/ |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
322 |
PackageTable(JavaFileManager fm, Location locn) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
323 |
this.fm = fm; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
324 |
this.location = locn; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
325 |
getEntry("").excluded = false; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
326 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
327 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
328 |
PackageTable packages(Collection<String> packageNames) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
329 |
includedPackages.addAll(packageNames); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
330 |
return this; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
331 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
332 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
333 |
PackageTable subpackages(Collection<String> packageNames, Collection<String> excludePackageNames) |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
334 |
throws IOException { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
335 |
for (String p: excludePackageNames) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
336 |
getEntry(p).excluded = true; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
337 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
338 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
339 |
for (String packageName: packageNames) { |
36526 | 340 |
Location packageLocn = getLocation(packageName); |
341 |
for (JavaFileObject fo: fm.list(packageLocn, packageName, sourceKinds, true)) { |
|
342 |
String binaryName = fm.inferBinaryName(packageLocn, fo); |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
343 |
String pn = getPackageName(binaryName); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
344 |
String simpleName = getSimpleName(binaryName); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
345 |
Entry e = getEntry(pn); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
346 |
if (!e.isExcluded() && isValidClassName(simpleName)) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
347 |
includedPackages.add(pn); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
348 |
e.files = (e.files == null ? List.of(fo) : e.files.prepend(fo)); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
349 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
350 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
351 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
352 |
return this; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
353 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
354 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
355 |
/** |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
356 |
* Returns the aggregate set of included packages. |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
357 |
* @return the aggregate set of included packages |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
358 |
*/ |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
359 |
Set<String> getIncludedPackages() { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
360 |
return includedPackages; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
361 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
362 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
363 |
/** |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
364 |
* Returns the set of source files for a package. |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
365 |
* @param packageName the specified package |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
366 |
* @return the set of file objects for the specified package |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
367 |
* @throws IOException if an error occurs while accessing the files |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
368 |
*/ |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
369 |
List<JavaFileObject> getFiles(String packageName) throws IOException { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
370 |
Entry e = getEntry(packageName); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
371 |
// The files may have been found as a side effect of searching for subpackages |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
372 |
if (e.files != null) |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
373 |
return e.files; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
374 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
375 |
ListBuffer<JavaFileObject> lb = new ListBuffer<>(); |
36526 | 376 |
Location packageLocn = getLocation(packageName); |
377 |
for (JavaFileObject fo: fm.list(packageLocn, packageName, sourceKinds, false)) { |
|
378 |
String binaryName = fm.inferBinaryName(packageLocn, fo); |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
379 |
String simpleName = getSimpleName(binaryName); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
380 |
if (isValidClassName(simpleName)) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
381 |
lb.append(fo); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
382 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
383 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
384 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
385 |
return lb.toList(); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
386 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
387 |
|
36526 | 388 |
private Location getLocation(String packageName) throws IOException { |
389 |
if (location == StandardLocation.MODULE_SOURCE_PATH) { |
|
390 |
// TODO: handle invalid results |
|
39917
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
391 |
Name pack = names.fromString(packageName); |
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
392 |
|
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
393 |
for (ModuleSymbol msym : modules.allModules()) { |
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
394 |
PackageSymbol p = syms.getPackage(msym, pack); |
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
395 |
if (p != null && !p.members().isEmpty()) { |
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
396 |
return fm.getModuleLocation(location, msym.name.toString()); |
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
397 |
} |
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
398 |
} |
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
399 |
|
c51a8950f278
8154705: invalid use of ALL-MODULE-PATH causes crash
ksrini
parents:
38619
diff
changeset
|
400 |
return null; |
36526 | 401 |
} else { |
402 |
return location; |
|
403 |
} |
|
404 |
} |
|
32163
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
405 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
406 |
private Entry getEntry(String name) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
407 |
Entry e = entries.get(name); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
408 |
if (e == null) |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
409 |
entries.put(name, e = new Entry(name)); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
410 |
return e; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
411 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
412 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
413 |
private String getPackageName(String name) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
414 |
int lastDot = name.lastIndexOf("."); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
415 |
return (lastDot == -1 ? "" : name.substring(0, lastDot)); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
416 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
417 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
418 |
private String getSimpleName(String name) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
419 |
int lastDot = name.lastIndexOf("."); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
420 |
return (lastDot == -1 ? name : name.substring(lastDot + 1)); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
421 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
422 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
423 |
class Entry { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
424 |
final String name; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
425 |
Boolean excluded; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
426 |
List<JavaFileObject> files; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
427 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
428 |
Entry(String name) { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
429 |
this.name = name; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
430 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
431 |
|
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
432 |
boolean isExcluded() { |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
433 |
if (excluded == null) |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
434 |
excluded = getEntry(getPackageName(name)).isExcluded(); |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
435 |
return excluded; |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
436 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
437 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
438 |
} |
2bdcabf14e91
8133223: Clean up package handling code in JavadocTool
jjg
parents:
30066
diff
changeset
|
439 |
|
10 | 440 |
} |