1 /*
2 * Copyright (c) 2012, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package jdk.javadoc.internal.tool;
27
28 import java.util.ArrayList;
29 import java.util.Arrays;
30 import java.util.EnumMap;
31 import java.util.LinkedHashMap;
32 import java.util.List;
33 import java.util.Map;
34
35 import javax.lang.model.element.ElementKind;
36
37 import com.sun.tools.javac.main.Option;
38 import com.sun.tools.javac.main.Option.InvalidValueException;
39 import com.sun.tools.javac.main.Option.OptionKind;
40 import com.sun.tools.javac.main.OptionHelper;
41 import com.sun.tools.javac.util.Options;
42
43 import static com.sun.tools.javac.main.Option.OptionKind.*;
44 import static jdk.javadoc.internal.tool.Main.Result.*;
45
46 /**
47 * javadoc tool options.
48 *
49 * <p><b>This is NOT part of any supported API.
50 * If you write code that depends on this, you do so at your own risk.
51 * This code and its internal interfaces are subject to change or
52 * deletion without notice.</b>
53 */
54 public enum ToolOption {
55
56 // ----- options for underlying compiler -----
57
58 BOOTCLASSPATH("-bootclasspath", STANDARD, true) {
59 @Override
60 public void process(Helper helper, String arg) throws InvalidValueException {
61 Option.BOOT_CLASS_PATH.process(helper.getOptionHelper(), primaryName, arg);
62 }
63 },
64
65 CLASS_PATH("--class-path -classpath -cp", STANDARD, true) {
66 @Override
67 public void process(Helper helper, String arg) throws InvalidValueException {
68 Option.CLASS_PATH.process(helper.getOptionHelper(), primaryName, arg);
69 }
70 },
71
72 EXTDIRS("-extdirs", STANDARD, true) {
73 @Override
74 public void process(Helper helper, String arg) throws InvalidValueException {
75 Option.EXTDIRS.process(helper.getOptionHelper(), primaryName, arg);
76 }
77 },
78
79 SOURCE_PATH("--source-path -sourcepath", STANDARD, true) {
80 @Override
81 public void process(Helper helper, String arg) throws InvalidValueException {
82 Option.SOURCE_PATH.process(helper.getOptionHelper(), primaryName, arg);
83 }
84 },
85
86 MODULE_SOURCE_PATH("--module-source-path", STANDARD, true) {
87 @Override
88 public void process(Helper helper, String arg) throws InvalidValueException {
89 Option.MODULE_SOURCE_PATH.process(helper.getOptionHelper(), primaryName, arg);
90 }
91 },
92
93 UPGRADE_MODULE_PATH("--upgrade-module-path", STANDARD, true) {
94 @Override
95 public void process(Helper helper, String arg) throws InvalidValueException {
96 Option.UPGRADE_MODULE_PATH.process(helper.getOptionHelper(), primaryName, arg);
97 }
98 },
99
100 SYSTEM("--system", STANDARD, true) {
101 @Override
102 public void process(Helper helper, String arg) throws InvalidValueException {
103 Option.SYSTEM.process(helper.getOptionHelper(), primaryName, arg);
104 }
105 },
106
107 MODULE_PATH("--module-path -p", STANDARD, true) {
108 @Override
109 public void process(Helper helper, String arg) throws InvalidValueException {
110 Option.MODULE_PATH.process(helper.getOptionHelper(), primaryName, arg);
111 }
112 },
113
114 ADD_MODULES("--add-modules", STANDARD, true) {
115 @Override
116 public void process(Helper helper, String arg) throws InvalidValueException {
117 Option.ADD_MODULES.process(helper.getOptionHelper(), primaryName, arg);
118 }
119 },
120
121 LIMIT_MODULES("--limit-modules", STANDARD, true) {
122 @Override
123 public void process(Helper helper, String arg) throws InvalidValueException {
124 Option.LIMIT_MODULES.process(helper.getOptionHelper(), primaryName, arg);
125 }
126 },
127
128 MODULE("--module", STANDARD, true) {
129 @Override
130 public void process(Helper helper, String arg) {
131 helper.addToList(this, ",", arg);
132 }
133 },
134
135 ENCODING("-encoding", STANDARD, true) {
136 @Override
137 public void process(Helper helper, String arg) throws InvalidValueException {
138 Option.ENCODING.process(helper.getOptionHelper(), primaryName, arg);
139 }
140 },
141
142 RELEASE("--release", STANDARD, true) {
143 @Override
144 public void process(Helper helper, String arg) throws InvalidValueException {
145 Option.RELEASE.process(helper.getOptionHelper(), primaryName, arg);
146 }
147 },
148
149 SOURCE("-source", STANDARD, true) {
150 @Override
151 public void process(Helper helper, String arg) throws InvalidValueException {
152 Option.SOURCE.process(helper.getOptionHelper(), primaryName, arg);
153 }
154 },
155
156 XMAXERRS("-Xmaxerrs", EXTENDED, true) {
157 @Override
158 public void process(Helper helper, String arg) throws InvalidValueException {
159 Option.XMAXERRS.process(helper.getOptionHelper(), primaryName, arg);
160 }
161 },
162
163 XMAXWARNS("-Xmaxwarns", EXTENDED, true) {
164 @Override
165 public void process(Helper helper, String arg) throws InvalidValueException {
166 Option.XMAXWARNS.process(helper.getOptionHelper(), primaryName, arg);
167 }
168 },
169
170 ADD_READS("--add-reads", EXTENDED, true) {
171 @Override
172 public void process(Helper helper, String arg) throws InvalidValueException {
173 Option.ADD_READS.process(helper.getOptionHelper(), primaryName, arg);
174 }
175 },
176
177 ADD_EXPORTS("--add-exports", EXTENDED, true) {
178 @Override
179 public void process(Helper helper, String arg) throws InvalidValueException {
180 Option.ADD_EXPORTS.process(helper.getOptionHelper(), primaryName, arg);
181 }
182 },
183
184 XMODULE("-Xmodule:", EXTENDED, false) {
185 @Override
186 public void process(Helper helper, String arg) throws InvalidValueException {
187 Option.XMODULE.process(helper.getOptionHelper(), arg);
188 }
189 },
190
191 PATCH_MODULE("--patch-module", EXTENDED, true) {
192 @Override
193 public void process(Helper helper, String arg) throws InvalidValueException {
194 Option.PATCH_MODULE.process(helper.getOptionHelper(), primaryName, arg);
195 }
196 },
197
198 // ----- doclet options -----
199
200 DOCLET("-doclet", STANDARD, true), // handled in setDocletInvoker
201
202 DOCLETPATH("-docletpath", STANDARD, true), // handled in setDocletInvoker
203
204 // ----- selection options -----
205
206 SUBPACKAGES("-subpackages", STANDARD, true) {
207 @Override
208 public void process(Helper helper, String arg) {
209 helper.addToList(this, ":", arg);
210 }
211 },
212
213 EXCLUDE("-exclude", STANDARD, true) {
214 @Override
215 public void process(Helper helper, String arg) {
216 helper.addToList(this, ":", arg);
217 }
218 },
219
220 // ----- filtering options -----
221
222 PACKAGE("-package", STANDARD) {
223 @Override
224 public void process(Helper helper) throws OptionException {
225 helper.setSimpleFilter("package");
226 }
227 },
228
229 PRIVATE("-private", STANDARD) {
230 @Override
231 public void process(Helper helper) throws OptionException {
232 helper.setSimpleFilter("private");
233 }
234 },
235
236 PROTECTED("-protected", STANDARD) {
237 @Override
238 public void process(Helper helper) throws OptionException {
239 helper.setSimpleFilter("protected");
240 }
241 },
242
243 PUBLIC("-public", STANDARD) {
244 @Override
245 public void process(Helper helper) throws OptionException {
246 helper.setSimpleFilter("public");
247 }
248 },
249
250 SHOW_MEMBERS("--show-members", STANDARD, true) {
251 @Override
252 public void process(Helper helper, String arg) throws OptionException {
253 helper.setFilter(this, arg);
254 }
255 },
256
257 SHOW_TYPES("--show-types", STANDARD, true) {
258 @Override
259 public void process(Helper helper, String arg) throws OptionException {
260 helper.setFilter(this, arg);
261 }
262 },
263
264 SHOW_PACKAGES("--show-packages", STANDARD, true) {
265 @Override
266 public void process(Helper helper, String arg) throws OptionException {
267 helper.setShowPackageAccess(SHOW_PACKAGES, arg);
268 }
269 },
270
271 SHOW_MODULE_CONTENTS("--show-module-contents", STANDARD, true) {
272 @Override
273 public void process(Helper helper, String arg) throws OptionException {
274 helper.setShowModuleContents(SHOW_MODULE_CONTENTS, arg);
275 }
276 },
277
278 EXPAND_REQUIRES("--expand-requires", STANDARD, true) {
279 @Override
280 public void process(Helper helper, String arg) throws OptionException {
281 helper.setExpandRequires(EXPAND_REQUIRES, arg);
282 }
283 },
284
285 // ----- output control options -----
286
287 QUIET("-quiet", STANDARD) {
288 @Override
289 public void process(Helper helper) {
290 helper.jdtoolOpts.put(QUIET, true);
291 }
292 },
293
294 VERBOSE("-verbose", STANDARD) {
295 @Override
296 public void process(Helper helper) {
297 helper.compOpts.put("-verbose", "");
298 }
299 },
300
301 XWERROR("-Xwerror", HIDDEN) {
302 @Override
303 public void process(Helper helper) {
304 helper.rejectWarnings = true;
305
306 }
307 },
308
309 // ----- other options -----
310
311 BREAKITERATOR("-breakiterator", STANDARD) {
312 @Override
313 public void process(Helper helper) {
314 helper.breakiterator = true;
315 }
316 },
317
318 LOCALE("-locale", STANDARD, true) {
319 @Override
320 public void process(Helper helper, String arg) {
321 helper.docLocale = arg;
322 }
323 },
324
325 XCLASSES("-Xclasses", HIDDEN) {
326 @Override
327 public void process(Helper helper) {
328 helper.jdtoolOpts.put(XCLASSES, true);
329 }
330 },
331
332 DUMPONERROR("--dump-on-error", HIDDEN) {
333 @Override
334 public void process(Helper helper) {
335 helper.dumpOnError = true;
336 }
337 },
338
339 // ----- help options -----
340
341 HELP("--help -help", STANDARD) {
342 @Override
343 public void process(Helper helper) throws OptionException {
344 throw new OptionException(OK, helper::usage);
345 }
346 },
347
348 X("-X", STANDARD) {
349 @Override
350 public void process(Helper helper) throws OptionException {
351 throw new OptionException(OK, helper::Xusage);
352 }
353 },
354
355 // This option exists only for the purpose of documenting itself.
356 // It's actually implemented by the launcher.
357 J("-J", STANDARD, true) {
358 @Override
359 public void process(Helper helper) {
360 throw new AssertionError("the -J flag should be caught by the launcher.");
361 }
362 },
363
364 // This option exists only for the purpose of documenting itself.
365 // It's actually implemented ahead of the normal option decoding loop.
366 Xold("-Xold", EXTENDED) {
367 @Override
368 public void process(Helper helper) {
369 throw new AssertionError("the -Xold flag should be handled earlier.");
370 }
371 };
372
373 public final String primaryName;
374 public final List<String> names;
375 public final OptionKind kind;
376 public final boolean hasArg;
377 public final boolean hasSuffix; // ex: foo:bar or -foo=bar
378
379 ToolOption(String opt, OptionKind kind) {
380 this(opt, kind, false);
381 }
382
383 ToolOption(String names, OptionKind kind, boolean hasArg) {
384 this.names = Arrays.asList(names.split("\\s+"));
385 this.primaryName = this.names.get(0);
386 this.kind = kind;
387 this.hasArg = hasArg;
388 char lastChar = names.charAt(names.length() - 1);
389 this.hasSuffix = lastChar == ':' || lastChar == '=';
390 }
391
392 void process(Helper helper, String arg) throws OptionException, Option.InvalidValueException { }
393
394 void process(Helper helper) throws OptionException { }
395
396 List<String> getNames() {
397 return names;
398 }
399
400 String getParameters(Messager messager) {
401 return (hasArg || primaryName.endsWith(":"))
402 ? messager.getText(getKey(primaryName, ".arg"))
403 : null;
404 }
405
406 String getDescription(Messager messager) {
407 return messager.getText(getKey(primaryName, ".desc"));
408 }
409
410 private String getKey(String optionName, String suffix) {
411 return "main.opt."
412 + optionName
413 .replaceAll("^-*", "") // remove leading '-'
414 .replaceAll("[^A-Za-z0-9]+$", "") // remove trailing non-alphanumeric
415 .replaceAll("[^A-Za-z0-9]", ".") // replace internal non-alphanumeric
416 + suffix;
417 }
418
419
420 static ToolOption get(String name) {
421 String oname = name;
422 if (name.contains(":")) {
423 oname = name.substring(0, name.indexOf(':') + 1);
424 } else if (name.contains("=")) {
425 oname = name.substring(0, name.indexOf('='));
426 }
427 for (ToolOption o : values()) {
428 for (String n : o.names) {
429 if (oname.equals(n)) {
430 return o;
431 }
432 }
433 }
434 return null;
435 }
436
437 static abstract class Helper {
438
439 // File manager options
440 final Map<Option, String> fileManagerOpts = new LinkedHashMap<>();
441
442 /** javac options, set by various options. */
443 Options compOpts; // = Options.instance(context)
444
445 /** Javadoc tool options */
446 final Map<ToolOption, Object> jdtoolOpts = new EnumMap<>(ToolOption.class);
447
448 /** dump stack traces for debugging etc.*/
449 boolean dumpOnError = false;
450
451 /** Set by -breakiterator. */
452 boolean breakiterator = false;
453
454 /** Set by -Xwerror. */
455 boolean rejectWarnings = false;
456
457 /** Set by -prompt. */
458 boolean promptOnError;
459
460 /** Set by -locale. */
461 String docLocale = "";
462
463 Helper() {
464 populateDefaultAccessMap();
465 }
466
467 abstract void usage();
468 abstract void Xusage();
469
470 abstract String getLocalizedMessage(String msg, Object... args);
471
472 abstract OptionHelper getOptionHelper();
473
474 @SuppressWarnings("unchecked")
475 void addToList(ToolOption opt, String delimiter, String str) {
476 List<String> list = (List<String>) jdtoolOpts.computeIfAbsent(opt, v -> new ArrayList<>());
477 list.addAll(Arrays.asList(str.split(delimiter)));
478 jdtoolOpts.put(opt, list);
479 }
480
481 void setExpandRequires(ToolOption opt, String arg) throws OptionException {
482 switch (arg) {
483 case "transitive":
484 jdtoolOpts.put(opt, AccessKind.PUBLIC);
485 break;
486 case "all":
487 jdtoolOpts.put(opt, AccessKind.PRIVATE);
488 break;
489 default:
490 String text = getLocalizedMessage("main.illegal_option_value", arg);
491 throw new IllegalOptionValue(this::usage, text);
492 }
493 }
494
495 void setShowModuleContents(ToolOption opt, String arg) throws OptionException {
496 switch (arg) {
497 case "api":
498 jdtoolOpts.put(opt, AccessKind.PUBLIC);
499 break;
500 case "all":
501 jdtoolOpts.put(opt, AccessKind.PRIVATE);
502 break;
503 default:
504 String text = getLocalizedMessage("main.illegal_option_value", arg);
505 throw new IllegalOptionValue(this::usage, text);
506 }
507 }
508
509 void setShowPackageAccess(ToolOption opt, String arg) throws OptionException {
510 switch (arg) {
511 case "exported":
512 jdtoolOpts.put(opt, AccessKind.PUBLIC);
513 break;
514 case "all":
515 jdtoolOpts.put(opt, AccessKind.PRIVATE);
516 break;
517 default:
518 String text = getLocalizedMessage("main.illegal_option_value", arg);
519 throw new IllegalOptionValue(this::usage, text);
520 }
521 }
522
523
524 void setFilter(ToolOption opt, String arg) throws OptionException {
525 jdtoolOpts.put(opt, getAccessValue(arg));
526 }
527
528 void setSimpleFilter(String arg) throws OptionException {
529 handleSimpleOption(arg);
530 }
531
532 void setFileManagerOpt(Option opt, String arg) {
533 fileManagerOpts.put(opt, arg);
534 }
535
536 void handleSimpleOption(String arg) throws OptionException {
537 populateSimpleAccessMap(getAccessValue(arg));
538 }
539
540 /*
541 * This method handles both the simple options -package,
542 * -private, so on, in addition to the new ones such as
543 * --show-types:public and so on.
544 */
545 private AccessKind getAccessValue(String arg) throws OptionException {
546 int colon = arg.indexOf(':');
547 String value = (colon > 0)
548 ? arg.substring(colon + 1)
549 : arg;
550 switch (value) {
551 case "public":
552 return AccessKind.PUBLIC;
553 case "protected":
554 return AccessKind.PROTECTED;
555 case "package":
556 return AccessKind.PACKAGE;
557 case "private":
558 return AccessKind.PRIVATE;
559 default:
560 String text = getLocalizedMessage("main.illegal_option_value", value);
561 throw new IllegalOptionValue(this::usage, text);
562 }
563 }
564
565 /*
566 * Sets the entire kind map to PROTECTED this is the default.
567 */
568 private void populateDefaultAccessMap() {
569 populateSimpleAccessMap(AccessKind.PROTECTED);
570 }
571
572 /*
573 * This sets access to all the allowed kinds in the
574 * access map.
575 */
576 void populateSimpleAccessMap(AccessKind accessValue) {
577 for (ElementKind kind : ElementsTable.ModifierFilter.ALLOWED_KINDS) {
578 switch (kind) {
579 case METHOD:
580 jdtoolOpts.put(SHOW_MEMBERS, accessValue);
581 break;
582 case CLASS:
583 jdtoolOpts.put(SHOW_TYPES, accessValue);
584 break;
585 case PACKAGE:
586 jdtoolOpts.put(SHOW_PACKAGES, accessValue);
587 break;
588 case MODULE:
589 jdtoolOpts.put(SHOW_MODULE_CONTENTS, accessValue);
590 break;
591 default:
592 throw new AssertionError("unknown element kind:" + kind);
593 }
594 }
595 }
596 }
597 }