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