Option.java revision 3643:589ff4d43428
1/* 2 * Copyright (c) 2006, 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 26package com.sun.tools.javac.main; 27 28import java.io.FileWriter; 29import java.io.PrintWriter; 30import java.nio.file.Files; 31import java.nio.file.Path; 32import java.nio.file.Paths; 33import java.text.Collator; 34import java.util.Arrays; 35import java.util.Collections; 36import java.util.Comparator; 37import java.util.EnumSet; 38import java.util.Iterator; 39import java.util.LinkedHashMap; 40import java.util.Locale; 41import java.util.Map; 42import java.util.ServiceLoader; 43import java.util.Set; 44import java.util.TreeSet; 45import java.util.stream.Collectors; 46import java.util.stream.StreamSupport; 47 48import javax.lang.model.SourceVersion; 49 50import com.sun.tools.doclint.DocLint; 51import com.sun.tools.javac.code.Lint; 52import com.sun.tools.javac.code.Lint.LintCategory; 53import com.sun.tools.javac.code.Source; 54import com.sun.tools.javac.code.Type; 55import com.sun.tools.javac.jvm.Profile; 56import com.sun.tools.javac.jvm.Target; 57import com.sun.tools.javac.platform.PlatformProvider; 58import com.sun.tools.javac.processing.JavacProcessingEnvironment; 59import com.sun.tools.javac.resources.CompilerProperties.Errors; 60import com.sun.tools.javac.util.Assert; 61import com.sun.tools.javac.util.JDK9Wrappers; 62import com.sun.tools.javac.util.Log; 63import com.sun.tools.javac.util.Log.PrefixKind; 64import com.sun.tools.javac.util.Log.WriterKind; 65import com.sun.tools.javac.util.Options; 66import com.sun.tools.javac.util.StringUtils; 67 68import static com.sun.tools.javac.main.Option.ChoiceKind.*; 69import static com.sun.tools.javac.main.Option.OptionGroup.*; 70import static com.sun.tools.javac.main.Option.OptionKind.*; 71 72/** 73 * Options for javac. 74 * The specific Option to handle a command-line option can be found by calling 75 * {@link #lookup}, which search some or all of the members of this enum in order, 76 * looking for the first {@link #matches match}. 77 * The action for an Option is performed {@link #handleOption}, which determines 78 * whether an argument is needed and where to find it; 79 * {@code handleOption} then calls {@link #process process} providing a suitable 80 * {@link OptionHelper} to provide access the compiler state. 81 * 82 * <p><b>This is NOT part of any supported API. 83 * If you write code that depends on this, you do so at your own 84 * risk. This code and its internal interfaces are subject to change 85 * or deletion without notice.</b></p> 86 */ 87public enum Option { 88 G("-g", "opt.g", STANDARD, BASIC), 89 90 G_NONE("-g:none", "opt.g.none", STANDARD, BASIC) { 91 @Override 92 public boolean process(OptionHelper helper, String option) { 93 helper.put("-g:", "none"); 94 return false; 95 } 96 }, 97 98 G_CUSTOM("-g:", "opt.g.lines.vars.source", 99 STANDARD, BASIC, ANYOF, "lines", "vars", "source"), 100 101 XLINT("-Xlint", "opt.Xlint", EXTENDED, BASIC), 102 103 XLINT_CUSTOM("-Xlint:", "opt.arg.Xlint", "opt.Xlint.custom", EXTENDED, BASIC, ANYOF, getXLintChoices()) { 104 private final String LINT_KEY_FORMAT = LARGE_INDENT + " %-" + 105 (DEFAULT_SYNOPSIS_WIDTH + SMALL_INDENT.length() - LARGE_INDENT.length() - 2) + "s %s"; 106 @Override 107 protected void help(Log log) { 108 super.help(log); 109 log.printRawLines(WriterKind.STDOUT, 110 String.format(LINT_KEY_FORMAT, 111 "all", 112 log.localize(PrefixKind.JAVAC, "opt.Xlint.all"))); 113 for (LintCategory lc : LintCategory.values()) { 114 if (lc.hidden) continue; 115 log.printRawLines(WriterKind.STDOUT, 116 String.format(LINT_KEY_FORMAT, 117 lc.option, 118 log.localize(PrefixKind.JAVAC, 119 "opt.Xlint.desc." + lc.option))); 120 } 121 log.printRawLines(WriterKind.STDOUT, 122 String.format(LINT_KEY_FORMAT, 123 "none", 124 log.localize(PrefixKind.JAVAC, "opt.Xlint.none"))); 125 } 126 }, 127 128 XDOCLINT("-Xdoclint", "opt.Xdoclint", EXTENDED, BASIC), 129 130 XDOCLINT_CUSTOM("-Xdoclint:", "opt.Xdoclint.subopts", "opt.Xdoclint.custom", EXTENDED, BASIC) { 131 @Override 132 public boolean matches(String option) { 133 return DocLint.isValidOption( 134 option.replace(XDOCLINT_CUSTOM.primaryName, DocLint.XMSGS_CUSTOM_PREFIX)); 135 } 136 137 @Override 138 public boolean process(OptionHelper helper, String option) { 139 String prev = helper.get(XDOCLINT_CUSTOM); 140 String next = (prev == null) ? option : (prev + " " + option); 141 helper.put(XDOCLINT_CUSTOM.primaryName, next); 142 return false; 143 } 144 }, 145 146 XDOCLINT_PACKAGE("-Xdoclint/package:", "opt.Xdoclint.package.args", "opt.Xdoclint.package.desc", EXTENDED, BASIC) { 147 @Override 148 public boolean matches(String option) { 149 return DocLint.isValidOption( 150 option.replace(XDOCLINT_PACKAGE.primaryName, DocLint.XCHECK_PACKAGE)); 151 } 152 153 @Override 154 public boolean process(OptionHelper helper, String option) { 155 String prev = helper.get(XDOCLINT_PACKAGE); 156 String next = (prev == null) ? option : (prev + " " + option); 157 helper.put(XDOCLINT_PACKAGE.primaryName, next); 158 return false; 159 } 160 }, 161 162 // -nowarn is retained for command-line backward compatibility 163 NOWARN("-nowarn", "opt.nowarn", STANDARD, BASIC) { 164 @Override 165 public boolean process(OptionHelper helper, String option) { 166 helper.put("-Xlint:none", option); 167 return false; 168 } 169 }, 170 171 VERBOSE("-verbose", "opt.verbose", STANDARD, BASIC), 172 173 // -deprecation is retained for command-line backward compatibility 174 DEPRECATION("-deprecation", "opt.deprecation", STANDARD, BASIC) { 175 @Override 176 public boolean process(OptionHelper helper, String option) { 177 helper.put("-Xlint:deprecation", option); 178 return false; 179 } 180 }, 181 182 CLASS_PATH("--class-path -classpath -cp", "opt.arg.path", "opt.classpath", STANDARD, FILEMANAGER), 183 184 SOURCE_PATH("--source-path -sourcepath", "opt.arg.path", "opt.sourcepath", STANDARD, FILEMANAGER), 185 186 MODULE_SOURCE_PATH("--module-source-path", "opt.arg.mspath", "opt.modulesourcepath", STANDARD, FILEMANAGER), 187 188 MODULE_PATH("--module-path -p", "opt.arg.path", "opt.modulepath", STANDARD, FILEMANAGER), 189 190 UPGRADE_MODULE_PATH("--upgrade-module-path", "opt.arg.path", "opt.upgrademodulepath", STANDARD, FILEMANAGER), 191 192 SYSTEM("--system", "opt.arg.jdk", "opt.system", STANDARD, FILEMANAGER), 193 194 PATCH_MODULE("--patch-module", "opt.arg.patch", "opt.patch", EXTENDED, FILEMANAGER) { 195 // The deferred filemanager diagnostics mechanism assumes a single value per option, 196 // but --patch-module can be used multiple times, once per module. Therefore we compose 197 // a value for the option containing the last value specified for each module, and separate 198 // the the module=path pairs by an invalid path character, NULL. 199 // The standard file manager code knows to split apart the NULL-separated components. 200 @Override 201 public boolean process(OptionHelper helper, String option, String arg) { 202 if (!arg.contains("=")) { // could be more strict regeex, e.g. "(?i)[a-z0-9_.]+=.*" 203 helper.error(Errors.LocnInvalidArgForXpatch(arg)); 204 } 205 206 String previous = helper.get(this); 207 if (previous == null) { 208 return super.process(helper, option, arg); 209 } 210 211 Map<String,String> map = new LinkedHashMap<>(); 212 for (String s : previous.split("\0")) { 213 int sep = s.indexOf('='); 214 map.put(s.substring(0, sep), s.substring(sep + 1)); 215 } 216 217 int sep = arg.indexOf('='); 218 map.put(arg.substring(0, sep), arg.substring(sep + 1)); 219 220 StringBuilder sb = new StringBuilder(); 221 map.forEach((m, p) -> { 222 if (sb.length() > 0) 223 sb.append('\0'); 224 sb.append(m).append('=').append(p); 225 }); 226 return super.process(helper, option, sb.toString()); 227 } 228 }, 229 230 BOOT_CLASS_PATH("--boot-class-path -bootclasspath", "opt.arg.path", "opt.bootclasspath", STANDARD, FILEMANAGER) { 231 @Override 232 public boolean process(OptionHelper helper, String option, String arg) { 233 helper.remove("-Xbootclasspath/p:"); 234 helper.remove("-Xbootclasspath/a:"); 235 return super.process(helper, option, arg); 236 } 237 }, 238 239 XBOOTCLASSPATH_PREPEND("-Xbootclasspath/p:", "opt.arg.path", "opt.Xbootclasspath.p", EXTENDED, FILEMANAGER), 240 241 XBOOTCLASSPATH_APPEND("-Xbootclasspath/a:", "opt.arg.path", "opt.Xbootclasspath.a", EXTENDED, FILEMANAGER), 242 243 XBOOTCLASSPATH("-Xbootclasspath:", "opt.arg.path", "opt.bootclasspath", EXTENDED, FILEMANAGER) { 244 @Override 245 public boolean process(OptionHelper helper, String option, String arg) { 246 helper.remove("-Xbootclasspath/p:"); 247 helper.remove("-Xbootclasspath/a:"); 248 return super.process(helper, "-bootclasspath", arg); 249 } 250 }, 251 252 EXTDIRS("-extdirs", "opt.arg.dirs", "opt.extdirs", STANDARD, FILEMANAGER), 253 254 DJAVA_EXT_DIRS("-Djava.ext.dirs=", "opt.arg.dirs", "opt.extdirs", EXTENDED, FILEMANAGER) { 255 @Override 256 public boolean process(OptionHelper helper, String option, String arg) { 257 return EXTDIRS.process(helper, "-extdirs", arg); 258 } 259 }, 260 261 ENDORSEDDIRS("-endorseddirs", "opt.arg.dirs", "opt.endorseddirs", STANDARD, FILEMANAGER), 262 263 DJAVA_ENDORSED_DIRS("-Djava.endorsed.dirs=", "opt.arg.dirs", "opt.endorseddirs", EXTENDED, FILEMANAGER) { 264 @Override 265 public boolean process(OptionHelper helper, String option, String arg) { 266 return ENDORSEDDIRS.process(helper, "-endorseddirs", arg); 267 } 268 }, 269 270 PROC("-proc:", "opt.proc.none.only", STANDARD, BASIC, ONEOF, "none", "only"), 271 272 PROCESSOR("-processor", "opt.arg.class.list", "opt.processor", STANDARD, BASIC), 273 274 PROCESSOR_PATH("--processor-path -processorpath", "opt.arg.path", "opt.processorpath", STANDARD, FILEMANAGER), 275 276 PROCESSOR_MODULE_PATH("--processor-module-path", "opt.arg.path", "opt.processormodulepath", STANDARD, FILEMANAGER), 277 278 PARAMETERS("-parameters","opt.parameters", STANDARD, BASIC), 279 280 D("-d", "opt.arg.directory", "opt.d", STANDARD, FILEMANAGER), 281 282 S("-s", "opt.arg.directory", "opt.sourceDest", STANDARD, FILEMANAGER), 283 284 H("-h", "opt.arg.directory", "opt.headerDest", STANDARD, FILEMANAGER), 285 286 IMPLICIT("-implicit:", "opt.implicit", STANDARD, BASIC, ONEOF, "none", "class"), 287 288 ENCODING("-encoding", "opt.arg.encoding", "opt.encoding", STANDARD, FILEMANAGER), 289 290 SOURCE("-source", "opt.arg.release", "opt.source", STANDARD, BASIC) { 291 @Override 292 public boolean process(OptionHelper helper, String option, String operand) { 293 Source source = Source.lookup(operand); 294 if (source == null) { 295 helper.error("err.invalid.source", operand); 296 return true; 297 } 298 return super.process(helper, option, operand); 299 } 300 }, 301 302 TARGET("-target", "opt.arg.release", "opt.target", STANDARD, BASIC) { 303 @Override 304 public boolean process(OptionHelper helper, String option, String operand) { 305 Target target = Target.lookup(operand); 306 if (target == null) { 307 helper.error("err.invalid.target", operand); 308 return true; 309 } 310 return super.process(helper, option, operand); 311 } 312 }, 313 314 RELEASE("--release", "opt.arg.release", "opt.release", STANDARD, BASIC) { 315 @Override 316 protected void help(Log log) { 317 Iterable<PlatformProvider> providers = 318 ServiceLoader.load(PlatformProvider.class, Arguments.class.getClassLoader()); 319 Set<String> platforms = StreamSupport.stream(providers.spliterator(), false) 320 .flatMap(provider -> StreamSupport.stream(provider.getSupportedPlatformNames() 321 .spliterator(), 322 false)) 323 .collect(Collectors.toCollection(TreeSet :: new)); 324 325 StringBuilder targets = new StringBuilder(); 326 String delim = ""; 327 for (String platform : platforms) { 328 targets.append(delim); 329 targets.append(platform); 330 delim = ", "; 331 } 332 333 super.help(log, log.localize(PrefixKind.JAVAC, descrKey, targets.toString())); 334 } 335 }, 336 337 PROFILE("-profile", "opt.arg.profile", "opt.profile", STANDARD, BASIC) { 338 @Override 339 public boolean process(OptionHelper helper, String option, String operand) { 340 Profile profile = Profile.lookup(operand); 341 if (profile == null) { 342 helper.error("err.invalid.profile", operand); 343 return true; 344 } 345 return super.process(helper, option, operand); 346 } 347 }, 348 349 VERSION("-version", "opt.version", STANDARD, INFO) { 350 @Override 351 public boolean process(OptionHelper helper, String option) { 352 Log log = helper.getLog(); 353 String ownName = helper.getOwnName(); 354 log.printLines(WriterKind.STDOUT, PrefixKind.JAVAC, "version", ownName, JavaCompiler.version()); 355 return super.process(helper, option); 356 } 357 }, 358 359 FULLVERSION("-fullversion", null, HIDDEN, INFO) { 360 @Override 361 public boolean process(OptionHelper helper, String option) { 362 Log log = helper.getLog(); 363 String ownName = helper.getOwnName(); 364 log.printLines(WriterKind.STDOUT, PrefixKind.JAVAC, "fullVersion", ownName, JavaCompiler.fullVersion()); 365 return super.process(helper, option); 366 } 367 }, 368 369 // Note: -h is already taken for "native header output directory". 370 HELP("--help -help", "opt.help", STANDARD, INFO) { 371 @Override 372 public boolean process(OptionHelper helper, String option) { 373 Log log = helper.getLog(); 374 String ownName = helper.getOwnName(); 375 log.printLines(WriterKind.STDOUT, PrefixKind.JAVAC, "msg.usage.header", ownName); 376 showHelp(log, OptionKind.STANDARD); 377 log.printNewline(WriterKind.STDOUT); 378 return super.process(helper, option); 379 } 380 }, 381 382 A("-A", "opt.arg.key.equals.value", "opt.A", STANDARD, BASIC, ArgKind.ADJACENT) { 383 @Override 384 public boolean matches(String arg) { 385 return arg.startsWith("-A"); 386 } 387 388 @Override 389 public boolean hasArg() { 390 return false; 391 } 392 // Mapping for processor options created in 393 // JavacProcessingEnvironment 394 @Override 395 public boolean process(OptionHelper helper, String option) { 396 int argLength = option.length(); 397 if (argLength == 2) { 398 helper.error("err.empty.A.argument"); 399 return true; 400 } 401 int sepIndex = option.indexOf('='); 402 String key = option.substring(2, (sepIndex != -1 ? sepIndex : argLength) ); 403 if (!JavacProcessingEnvironment.isValidOptionName(key)) { 404 helper.error("err.invalid.A.key", option); 405 return true; 406 } 407 helper.put(option, option); 408 return false; 409 } 410 }, 411 412 X("-X", "opt.X", STANDARD, INFO) { 413 @Override 414 public boolean process(OptionHelper helper, String option) { 415 Log log = helper.getLog(); 416 showHelp(log, OptionKind.EXTENDED); 417 log.printNewline(WriterKind.STDOUT); 418 log.printLines(WriterKind.STDOUT, PrefixKind.JAVAC, "msg.usage.nonstandard.footer"); 419 return super.process(helper, option); 420 } 421 }, 422 423 // This option exists only for the purpose of documenting itself. 424 // It's actually implemented by the launcher. 425 J("-J", "opt.arg.flag", "opt.J", STANDARD, INFO, ArgKind.ADJACENT) { 426 @Override 427 public boolean process(OptionHelper helper, String option) { 428 throw new AssertionError 429 ("the -J flag should be caught by the launcher."); 430 } 431 }, 432 433 MOREINFO("-moreinfo", null, HIDDEN, BASIC) { 434 @Override 435 public boolean process(OptionHelper helper, String option) { 436 Type.moreInfo = true; 437 return super.process(helper, option); 438 } 439 }, 440 441 // treat warnings as errors 442 WERROR("-Werror", "opt.Werror", STANDARD, BASIC), 443 444 // prompt after each error 445 // new Option("-prompt", "opt.prompt"), 446 PROMPT("-prompt", null, HIDDEN, BASIC), 447 448 // dump stack on error 449 DOE("-doe", null, HIDDEN, BASIC), 450 451 // output source after type erasure 452 PRINTSOURCE("-printsource", null, HIDDEN, BASIC), 453 454 // display warnings for generic unchecked operations 455 WARNUNCHECKED("-warnunchecked", null, HIDDEN, BASIC) { 456 @Override 457 public boolean process(OptionHelper helper, String option) { 458 helper.put("-Xlint:unchecked", option); 459 return false; 460 } 461 }, 462 463 XMAXERRS("-Xmaxerrs", "opt.arg.number", "opt.maxerrs", EXTENDED, BASIC), 464 465 XMAXWARNS("-Xmaxwarns", "opt.arg.number", "opt.maxwarns", EXTENDED, BASIC), 466 467 XSTDOUT("-Xstdout", "opt.arg.file", "opt.Xstdout", EXTENDED, INFO) { 468 @Override 469 public boolean process(OptionHelper helper, String option, String arg) { 470 try { 471 Log log = helper.getLog(); 472 log.setWriters(new PrintWriter(new FileWriter(arg), true)); 473 } catch (java.io.IOException e) { 474 helper.error("err.error.writing.file", arg, e); 475 return true; 476 } 477 return super.process(helper, option, arg); 478 } 479 }, 480 481 XPRINT("-Xprint", "opt.print", EXTENDED, BASIC), 482 483 XPRINTROUNDS("-XprintRounds", "opt.printRounds", EXTENDED, BASIC), 484 485 XPRINTPROCESSORINFO("-XprintProcessorInfo", "opt.printProcessorInfo", EXTENDED, BASIC), 486 487 XPREFER("-Xprefer:", "opt.prefer", EXTENDED, BASIC, ONEOF, "source", "newer"), 488 489 XXUSERPATHSFIRST("-XXuserPathsFirst", "opt.userpathsfirst", HIDDEN, BASIC), 490 491 // see enum PkgInfo 492 XPKGINFO("-Xpkginfo:", "opt.pkginfo", EXTENDED, BASIC, ONEOF, "always", "legacy", "nonempty"), 493 494 /* -O is a no-op, accepted for backward compatibility. */ 495 O("-O", null, HIDDEN, BASIC), 496 497 /* -Xjcov produces tables to support the code coverage tool jcov. */ 498 XJCOV("-Xjcov", null, HIDDEN, BASIC), 499 500 PLUGIN("-Xplugin:", "opt.arg.plugin", "opt.plugin", EXTENDED, BASIC) { 501 @Override 502 public boolean process(OptionHelper helper, String option) { 503 String p = option.substring(option.indexOf(':') + 1).trim(); 504 String prev = helper.get(PLUGIN); 505 helper.put(PLUGIN.primaryName, (prev == null) ? p : prev + '\0' + p); 506 return false; 507 } 508 }, 509 510 XDIAGS("-Xdiags:", "opt.diags", EXTENDED, BASIC, ONEOF, "compact", "verbose"), 511 512 DEBUG("--debug:", null, HIDDEN, BASIC) { 513 @Override 514 public boolean process(OptionHelper helper, String option) { 515 return HiddenGroup.DEBUG.process(helper, option); 516 } 517 }, 518 519 SHOULDSTOP("--should-stop:", null, HIDDEN, BASIC) { 520 @Override 521 public boolean process(OptionHelper helper, String option) { 522 return HiddenGroup.SHOULDSTOP.process(helper, option); 523 } 524 }, 525 526 DIAGS("--diags:", null, HIDDEN, BASIC) { 527 @Override 528 public boolean process(OptionHelper helper, String option) { 529 return HiddenGroup.DIAGS.process(helper, option); 530 } 531 }, 532 533 /* This is a back door to the compiler's option table. 534 * -XDx=y sets the option x to the value y. 535 * -XDx sets the option x to the value x. 536 */ 537 XD("-XD", null, HIDDEN, BASIC) { 538 @Override 539 public boolean matches(String s) { 540 return s.startsWith(primaryName); 541 } 542 @Override 543 public boolean process(OptionHelper helper, String option) { 544 return process(helper, option, option.substring(primaryName.length())); 545 } 546 547 @Override 548 public boolean process(OptionHelper helper, String option, String arg) { 549 int eq = arg.indexOf('='); 550 String key = (eq < 0) ? arg : arg.substring(0, eq); 551 String value = (eq < 0) ? arg : arg.substring(eq+1); 552 helper.put(key, value); 553 return false; 554 } 555 }, 556 557 ADD_EXPORTS("--add-exports", "opt.arg.addExports", "opt.addExports", EXTENDED, BASIC) { 558 @Override 559 public boolean process(OptionHelper helper, String option, String arg) { 560 String prev = helper.get(ADD_EXPORTS); 561 helper.put(ADD_EXPORTS.primaryName, (prev == null) ? arg : prev + '\0' + arg); 562 return false; 563 } 564 }, 565 566 ADD_READS("--add-reads", "opt.arg.addReads", "opt.addReads", EXTENDED, BASIC) { 567 @Override 568 public boolean process(OptionHelper helper, String option, String arg) { 569 String prev = helper.get(ADD_READS); 570 helper.put(ADD_READS.primaryName, (prev == null) ? arg : prev + '\0' + arg); 571 return false; 572 } 573 }, 574 575 XMODULE("-Xmodule:", "opt.arg.module", "opt.module", EXTENDED, BASIC) { 576 @Override 577 public boolean process(OptionHelper helper, String option, String arg) { 578 String prev = helper.get(XMODULE); 579 if (prev != null) { 580 helper.error("err.option.too.many", XMODULE.primaryName); 581 } 582 helper.put(XMODULE.primaryName, arg); 583 return false; 584 } 585 }, 586 587 MODULE("--module -m", "opt.arg.m", "opt.m", STANDARD, BASIC), 588 589 ADD_MODULES("--add-modules", "opt.arg.addmods", "opt.addmods", STANDARD, BASIC), 590 591 LIMIT_MODULES("--limit-modules", "opt.arg.limitmods", "opt.limitmods", STANDARD, BASIC), 592 593 // This option exists only for the purpose of documenting itself. 594 // It's actually implemented by the CommandLine class. 595 AT("@", "opt.arg.file", "opt.AT", STANDARD, INFO, ArgKind.ADJACENT) { 596 @Override 597 public boolean process(OptionHelper helper, String option) { 598 throw new AssertionError("the @ flag should be caught by CommandLine."); 599 } 600 }, 601 602 // Standalone positional argument: source file or type name. 603 SOURCEFILE("sourcefile", null, HIDDEN, INFO) { 604 @Override 605 public boolean matches(String s) { 606 if (s.endsWith(".java")) // Java source file 607 return true; 608 int sep = s.indexOf('/'); 609 if (sep != -1) { 610 return SourceVersion.isName(s.substring(0, sep)) 611 && SourceVersion.isName(s.substring(sep + 1)); 612 } else { 613 return SourceVersion.isName(s); // Legal type name 614 } 615 } 616 @Override 617 public boolean process(OptionHelper helper, String option) { 618 if (option.endsWith(".java") ) { 619 Path p = Paths.get(option); 620 if (!Files.exists(p)) { 621 helper.error("err.file.not.found", p); 622 return true; 623 } 624 if (!Files.isRegularFile(p)) { 625 helper.error("err.file.not.file", p); 626 return true; 627 } 628 helper.addFile(p); 629 } else { 630 helper.addClassName(option); 631 } 632 return false; 633 } 634 }, 635 636 MULTIRELEASE("--multi-release", "opt.arg.multi-release", "opt.multi-release", HIDDEN, FILEMANAGER), 637 638 INHERIT_RUNTIME_ENVIRONMENT("--inherit-runtime-environment", "opt.inherit_runtime_environment", 639 EXTENDED, BASIC) { 640 @Override 641 public boolean process(OptionHelper helper, String option) { 642 try { 643 Class.forName(JDK9Wrappers.VMHelper.VM_CLASSNAME); 644 String[] runtimeArgs = JDK9Wrappers.VMHelper.getRuntimeArguments(); 645 for (String arg : runtimeArgs) { 646 // Handle any supported runtime options; ignore all others. 647 // The runtime arguments always use the single token form, e.g. "--name=value". 648 for (Option o : getSupportedRuntimeOptions()) { 649 if (o.matches(arg)) { 650 o.handleOption(helper, arg, Collections.emptyIterator()); 651 break; 652 } 653 } 654 } 655 } catch (ClassNotFoundException | SecurityException e) { 656 helper.error("err.cannot.access.runtime.env"); 657 } 658 return false; 659 } 660 661 private Option[] getSupportedRuntimeOptions() { 662 Option[] supportedRuntimeOptions = { 663 ADD_EXPORTS, 664 ADD_MODULES, 665 LIMIT_MODULES, 666 MODULE_PATH, 667 UPGRADE_MODULE_PATH, 668 PATCH_MODULE 669 }; 670 return supportedRuntimeOptions; 671 } 672 }; 673 674 /** 675 * The kind of argument, if any, accepted by this option. The kind is augmented 676 * by characters in the name of the option. 677 */ 678 public enum ArgKind { 679 /** This option does not take any argument. */ 680 NONE, 681 682// Not currently supported 683// /** 684// * This option takes an optional argument, which may be provided directly after an '=' 685// * separator, or in the following argument position if that word does not itself appear 686// * to be the name of an option. 687// */ 688// OPTIONAL, 689 690 /** 691 * This option takes an argument. 692 * If the name of option ends with ':' or '=', the argument must be provided directly 693 * after that separator. 694 * Otherwise, if may appear after an '=' or in the following argument position. 695 */ 696 REQUIRED, 697 698 /** 699 * This option takes an argument immediately after the option name, with no separator 700 * character. 701 */ 702 ADJACENT 703 } 704 705 /** 706 * The kind of an Option. This is used by the -help and -X options. 707 */ 708 public enum OptionKind { 709 /** A standard option, documented by -help. */ 710 STANDARD, 711 /** An extended option, documented by -X. */ 712 EXTENDED, 713 /** A hidden option, not documented. */ 714 HIDDEN, 715 } 716 717 /** 718 * The group for an Option. This determines the situations in which the 719 * option is applicable. 720 */ 721 enum OptionGroup { 722 /** A basic option, available for use on the command line or via the 723 * Compiler API. */ 724 BASIC, 725 /** An option for javac's standard JavaFileManager. Other file managers 726 * may or may not support these options. */ 727 FILEMANAGER, 728 /** A command-line option that requests information, such as -help. */ 729 INFO, 730 /** A command-line "option" representing a file or class name. */ 731 OPERAND 732 } 733 734 /** 735 * The kind of choice for "choice" options. 736 */ 737 enum ChoiceKind { 738 /** The expected value is exactly one of the set of choices. */ 739 ONEOF, 740 /** The expected value is one of more of the set of choices. */ 741 ANYOF 742 } 743 744 enum HiddenGroup { 745 DIAGS("diags"), 746 DEBUG("debug"), 747 SHOULDSTOP("should-stop"); 748 749 static final Set<String> skipSet = new java.util.HashSet<>( 750 Arrays.asList("--diags:", "--debug:", "--should-stop:")); 751 752 final String text; 753 754 HiddenGroup(String text) { 755 this.text = text; 756 } 757 758 public boolean process(OptionHelper helper, String option) { 759 String p = option.substring(option.indexOf(':') + 1).trim(); 760 String[] subOptions = p.split(";"); 761 for (String subOption : subOptions) { 762 subOption = text + "." + subOption.trim(); 763 XD.process(helper, subOption, subOption); 764 } 765 return false; 766 } 767 768 static boolean skip(String name) { 769 return skipSet.contains(name); 770 } 771 } 772 773 /** 774 * The "primary name" for this option. 775 * This is the name that is used to put values in the {@link Options} table. 776 */ 777 public final String primaryName; 778 779 /** 780 * The set of names (primary name and aliases) for this option. 781 * Note that some names may end in a separator, to indicate that an argument must immediately 782 * follow the separator (and cannot appear in the following argument position. 783 */ 784 public final String[] names; 785 786 /** Documentation key for arguments. */ 787 protected final String argsNameKey; 788 789 /** Documentation key for description. 790 */ 791 protected final String descrKey; 792 793 /** The kind of this option. */ 794 private final OptionKind kind; 795 796 /** The group for this option. */ 797 private final OptionGroup group; 798 799 /** The kind of argument for this option. */ 800 private final ArgKind argKind; 801 802 /** The kind of choices for this option, if any. */ 803 private final ChoiceKind choiceKind; 804 805 /** The choices for this option, if any, and whether or not the choices are hidden. */ 806 private final Map<String,Boolean> choices; 807 808 /** 809 * Looks up the first option matching the given argument in the full set of options. 810 * @param arg the argument to be matches 811 * @return the first option that matches, or null if none. 812 */ 813 public static Option lookup(String arg) { 814 return lookup(arg, EnumSet.allOf(Option.class)); 815 } 816 817 /** 818 * Looks up the first option matching the given argument within a set of options. 819 * @param arg the argument to be matches 820 * @return the first option that matches, or null if none. 821 */ 822 public static Option lookup(String arg, Set<Option> options) { 823 for (Option option: options) { 824 if (option.matches(arg)) 825 return option; 826 } 827 return null; 828 } 829 830 /** 831 * Writes the "command line help" for given kind of option to the log. 832 * @param log the log 833 * @param kind the kind of options to select 834 */ 835 private static void showHelp(Log log, OptionKind kind) { 836 Comparator<Option> comp = new Comparator<Option>() { 837 final Collator collator = Collator.getInstance(Locale.US); 838 { collator.setStrength(Collator.PRIMARY); } 839 840 @Override 841 public int compare(Option o1, Option o2) { 842 return collator.compare(o1.primaryName, o2.primaryName); 843 } 844 }; 845 846 getJavaCompilerOptions() 847 .stream() 848 .filter(o -> o.kind == kind) 849 .sorted(comp) 850 .forEach(o -> { 851 o.help(log); 852 }); 853 } 854 855 Option(String text, String descrKey, 856 OptionKind kind, OptionGroup group) { 857 this(text, null, descrKey, kind, group, null, null, ArgKind.NONE); 858 } 859 860 Option(String text, String argsNameKey, String descrKey, 861 OptionKind kind, OptionGroup group) { 862 this(text, argsNameKey, descrKey, kind, group, null, null, ArgKind.REQUIRED); 863 } 864 865 Option(String text, String argsNameKey, String descrKey, 866 OptionKind kind, OptionGroup group, ArgKind ak) { 867 this(text, argsNameKey, descrKey, kind, group, null, null, ak); 868 } 869 870 Option(String text, String argsNameKey, String descrKey, OptionKind kind, OptionGroup group, 871 ChoiceKind choiceKind, Map<String,Boolean> choices) { 872 this(text, argsNameKey, descrKey, kind, group, choiceKind, choices, ArgKind.REQUIRED); 873 } 874 875 Option(String text, String descrKey, 876 OptionKind kind, OptionGroup group, 877 ChoiceKind choiceKind, String... choices) { 878 this(text, null, descrKey, kind, group, choiceKind, 879 createChoices(choices), ArgKind.REQUIRED); 880 } 881 // where 882 private static Map<String,Boolean> createChoices(String... choices) { 883 Map<String,Boolean> map = new LinkedHashMap<>(); 884 for (String c: choices) 885 map.put(c, false); 886 return map; 887 } 888 889 private Option(String text, String argsNameKey, String descrKey, 890 OptionKind kind, OptionGroup group, 891 ChoiceKind choiceKind, Map<String,Boolean> choices, 892 ArgKind argKind) { 893 this.names = text.trim().split("\\s+"); 894 Assert.check(names.length >= 1); 895 this.primaryName = names[0]; 896 this.argsNameKey = argsNameKey; 897 this.descrKey = descrKey; 898 this.kind = kind; 899 this.group = group; 900 this.choiceKind = choiceKind; 901 this.choices = choices; 902 this.argKind = argKind; 903 } 904 905 public String getPrimaryName() { 906 return primaryName; 907 } 908 909 public OptionKind getKind() { 910 return kind; 911 } 912 913 public ArgKind getArgKind() { 914 return argKind; 915 } 916 917 public boolean hasArg() { 918 return (argKind != ArgKind.NONE); 919 } 920 921 public boolean matches(String option) { 922 for (String name: names) { 923 if (matches(option, name)) 924 return true; 925 } 926 return false; 927 } 928 929 private boolean matches(String option, String name) { 930 if (name.startsWith("--") && !HiddenGroup.skip(name)) { 931 return option.equals(name) 932 || hasArg() && option.startsWith(name + "="); 933 } 934 935 boolean hasSuffix = (argKind == ArgKind.ADJACENT) 936 || name.endsWith(":") || name.endsWith("="); 937 938 if (!hasSuffix) 939 return option.equals(name); 940 941 if (!option.startsWith(name)) 942 return false; 943 944 if (choices != null) { 945 String arg = option.substring(name.length()); 946 if (choiceKind == ChoiceKind.ONEOF) 947 return choices.keySet().contains(arg); 948 else { 949 for (String a: arg.split(",+")) { 950 if (!choices.keySet().contains(a)) 951 return false; 952 } 953 } 954 } 955 956 return true; 957 } 958 959 /** 960 * Handles an option. 961 * If an argument for the option is required, depending on spec of the option, it will be found 962 * as part of the current arg (following ':' or '=') or in the following argument. 963 * This is the recommended way to handle an option directly, instead of calling the underlying 964 * {@link #process process} methods. 965 * @param helper a helper to provide access to the environment 966 * @param arg the arg string that identified this option 967 * @param rest the remaining strings to be analysed 968 * @return true if the operation was successful, and false otherwise 969 * @implNote The return value is the opposite of that used by {@link #process}. 970 */ 971 public boolean handleOption(OptionHelper helper, String arg, Iterator<String> rest) { 972 if (hasArg()) { 973 String operand; 974 int sep = findSeparator(arg); 975 if (getArgKind() == Option.ArgKind.ADJACENT) { 976 operand = arg.substring(primaryName.length()); 977 } else if (sep > 0) { 978 operand = arg.substring(sep + 1); 979 } else { 980 if (!rest.hasNext()) { 981 helper.error("err.req.arg", arg); 982 return false; 983 } 984 operand = rest.next(); 985 } 986 return !process(helper, arg, operand); 987 } else { 988 return !process(helper, arg); 989 } 990 } 991 992 /** 993 * Processes an option that either does not need an argument, 994 * or which contains an argument within it, following a separator. 995 * @param helper a helper to provide access to the environment 996 * @param option the option to be processed 997 * @return true if an error occurred 998 */ 999 public boolean process(OptionHelper helper, String option) { 1000 if (argKind == ArgKind.NONE) { 1001 return process(helper, primaryName, option); 1002 } else { 1003 int sep = findSeparator(option); 1004 return process(helper, primaryName, option.substring(sep + 1)); 1005 } 1006 } 1007 1008 /** 1009 * Processes an option by updating the environment via a helper object. 1010 * @param helper a helper to provide access to the environment 1011 * @param option the option to be processed 1012 * @param arg the value to associate with the option, or a default value 1013 * to be used if the option does not otherwise take an argument. 1014 * @return true if an error occurred 1015 */ 1016 public boolean process(OptionHelper helper, String option, String arg) { 1017 if (choices != null) { 1018 if (choiceKind == ChoiceKind.ONEOF) { 1019 // some clients like to see just one of option+choice set 1020 for (String s: choices.keySet()) 1021 helper.remove(primaryName + s); 1022 String opt = primaryName + arg; 1023 helper.put(opt, opt); 1024 // some clients like to see option (without trailing ":") 1025 // set to arg 1026 String nm = primaryName.substring(0, primaryName.length() - 1); 1027 helper.put(nm, arg); 1028 } else { 1029 // set option+word for each word in arg 1030 for (String a: arg.split(",+")) { 1031 String opt = primaryName + a; 1032 helper.put(opt, opt); 1033 } 1034 } 1035 } 1036 helper.put(primaryName, arg); 1037 if (group == OptionGroup.FILEMANAGER) 1038 helper.handleFileManagerOption(this, arg); 1039 return false; 1040 } 1041 1042 /** 1043 * Scans a word to find the first separator character, either colon or equals. 1044 * @param word the word to be scanned 1045 * @return the position of the first':' or '=' character in the word, 1046 * or -1 if none found 1047 */ 1048 private static int findSeparator(String word) { 1049 for (int i = 0; i < word.length(); i++) { 1050 switch (word.charAt(i)) { 1051 case ':': case '=': 1052 return i; 1053 } 1054 } 1055 return -1; 1056 } 1057 1058 /** The indent for the option synopsis. */ 1059 private static final String SMALL_INDENT = " "; 1060 /** The automatic indent for the description. */ 1061 private static final String LARGE_INDENT = " "; 1062 /** The space allowed for the synopsis, if the description is to be shown on the same line. */ 1063 private static final int DEFAULT_SYNOPSIS_WIDTH = 28; 1064 /** The nominal maximum line length, when seeing if text will fit on a line. */ 1065 private static final int DEFAULT_MAX_LINE_LENGTH = 80; 1066 /** The format for a single-line help entry. */ 1067 private static final String COMPACT_FORMAT = SMALL_INDENT + "%-" + DEFAULT_SYNOPSIS_WIDTH + "s %s"; 1068 1069 /** 1070 * Writes help text for this option to the log. 1071 * @param log the log 1072 */ 1073 protected void help(Log log) { 1074 help(log, log.localize(PrefixKind.JAVAC, descrKey)); 1075 } 1076 1077 protected void help(Log log, String descr) { 1078 String synopses = Arrays.stream(names) 1079 .map(s -> helpSynopsis(s, log)) 1080 .collect(Collectors.joining(", ")); 1081 1082 // If option synopses and description fit on a single line of reasonable length, 1083 // display using COMPACT_FORMAT 1084 if (synopses.length() < DEFAULT_SYNOPSIS_WIDTH 1085 && !descr.contains("\n") 1086 && (SMALL_INDENT.length() + DEFAULT_SYNOPSIS_WIDTH + 1 + descr.length() <= DEFAULT_MAX_LINE_LENGTH)) { 1087 log.printRawLines(WriterKind.STDOUT, String.format(COMPACT_FORMAT, synopses, descr)); 1088 return; 1089 } 1090 1091 // If option synopses fit on a single line of reasonable length, show that; 1092 // otherwise, show 1 per line 1093 if (synopses.length() <= DEFAULT_MAX_LINE_LENGTH) { 1094 log.printRawLines(WriterKind.STDOUT, SMALL_INDENT + synopses); 1095 } else { 1096 for (String name: names) { 1097 log.printRawLines(WriterKind.STDOUT, SMALL_INDENT + helpSynopsis(name, log)); 1098 } 1099 } 1100 1101 // Finally, show the description 1102 log.printRawLines(WriterKind.STDOUT, LARGE_INDENT + descr.replace("\n", "\n" + LARGE_INDENT)); 1103 } 1104 1105 /** 1106 * Composes the initial synopsis of one of the forms for this option. 1107 * @param name the name of this form of the option 1108 * @param log the log used to localize the description of the arguments 1109 * @return the synopsis 1110 */ 1111 private String helpSynopsis(String name, Log log) { 1112 StringBuilder sb = new StringBuilder(); 1113 sb.append(name); 1114 if (argsNameKey == null) { 1115 if (choices != null) { 1116 String sep = "{"; 1117 for (Map.Entry<String,Boolean> e: choices.entrySet()) { 1118 if (!e.getValue()) { 1119 sb.append(sep); 1120 sb.append(e.getKey()); 1121 sep = ","; 1122 } 1123 } 1124 sb.append("}"); 1125 } 1126 } else { 1127 if (!name.matches(".*[=:]$") && argKind != ArgKind.ADJACENT) 1128 sb.append(" "); 1129 sb.append(log.localize(PrefixKind.JAVAC, argsNameKey)); 1130 } 1131 1132 return sb.toString(); 1133 } 1134 1135 // For -XpkgInfo:value 1136 public enum PkgInfo { 1137 /** 1138 * Always generate package-info.class for every package-info.java file. 1139 * The file may be empty if there annotations with a RetentionPolicy 1140 * of CLASS or RUNTIME. This option may be useful in conjunction with 1141 * build systems (such as Ant) that expect javac to generate at least 1142 * one .class file for every .java file. 1143 */ 1144 ALWAYS, 1145 /** 1146 * Generate a package-info.class file if package-info.java contains 1147 * annotations. The file may be empty if all the annotations have 1148 * a RetentionPolicy of SOURCE. 1149 * This value is just for backwards compatibility with earlier behavior. 1150 * Either of the other two values are to be preferred to using this one. 1151 */ 1152 LEGACY, 1153 /** 1154 * Generate a package-info.class file if and only if there are annotations 1155 * in package-info.java to be written into it. 1156 */ 1157 NONEMPTY; 1158 1159 public static PkgInfo get(Options options) { 1160 String v = options.get(XPKGINFO); 1161 return (v == null 1162 ? PkgInfo.LEGACY 1163 : PkgInfo.valueOf(StringUtils.toUpperCase(v))); 1164 } 1165 } 1166 1167 private static Map<String,Boolean> getXLintChoices() { 1168 Map<String,Boolean> choices = new LinkedHashMap<>(); 1169 choices.put("all", false); 1170 for (Lint.LintCategory c : Lint.LintCategory.values()) 1171 choices.put(c.option, c.hidden); 1172 for (Lint.LintCategory c : Lint.LintCategory.values()) 1173 choices.put("-" + c.option, c.hidden); 1174 choices.put("none", false); 1175 return choices; 1176 } 1177 1178 /** 1179 * Returns the set of options supported by the command line tool. 1180 * @return the set of options. 1181 */ 1182 static Set<Option> getJavaCompilerOptions() { 1183 return EnumSet.allOf(Option.class); 1184 } 1185 1186 /** 1187 * Returns the set of options supported by the built-in file manager. 1188 * @return the set of options. 1189 */ 1190 public static Set<Option> getJavacFileManagerOptions() { 1191 return getOptions(FILEMANAGER); 1192 } 1193 1194 /** 1195 * Returns the set of options supported by this implementation of 1196 * the JavaCompiler API, via {@link JavaCompiler#getTask}. 1197 * @return the set of options. 1198 */ 1199 public static Set<Option> getJavacToolOptions() { 1200 return getOptions(BASIC); 1201 } 1202 1203 private static Set<Option> getOptions(OptionGroup group) { 1204 return Arrays.stream(Option.values()) 1205 .filter(o -> o.group == group) 1206 .collect(Collectors.toCollection(() -> EnumSet.noneOf(Option.class))); 1207 } 1208 1209} 1210