Option.java revision 3344:31c8b18fdc5b
1214501Srpaulo/* 2214501Srpaulo * Copyright (c) 2006, 2016, Oracle and/or its affiliates. All rights reserved. 3214501Srpaulo * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4214501Srpaulo * 5252726Srpaulo * This code is free software; you can redistribute it and/or modify it 6252726Srpaulo * under the terms of the GNU General Public License version 2 only, as 7214501Srpaulo * published by the Free Software Foundation. Oracle designates this 8214501Srpaulo * particular file as subject to the "Classpath" exception as provided 9214501Srpaulo * by Oracle in the LICENSE file that accompanied this code. 10214501Srpaulo * 11214501Srpaulo * This code is distributed in the hope that it will be useful, but WITHOUT 12252726Srpaulo * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13214501Srpaulo * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14214501Srpaulo * version 2 for more details (a copy is included in the LICENSE file that 15214501Srpaulo * accompanied this code). 16214501Srpaulo * 17214501Srpaulo * You should have received a copy of the GNU General Public License version 18214501Srpaulo * 2 along with this work; if not, write to the Free Software Foundation, 19214501Srpaulo * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20214501Srpaulo * 21214501Srpaulo * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22214501Srpaulo * or visit www.oracle.com if you need additional information or have any 23214501Srpaulo * questions. 24214501Srpaulo */ 25214501Srpaulo 26214501Srpaulopackage com.sun.tools.javac.main; 27214501Srpaulo 28214501Srpauloimport java.io.FileWriter; 29214501Srpauloimport java.io.PrintWriter; 30214501Srpauloimport java.nio.file.Files; 31214501Srpauloimport java.nio.file.Path; 32214501Srpauloimport java.nio.file.Paths; 33214501Srpauloimport java.util.Collections; 34214501Srpauloimport java.util.EnumSet; 35214501Srpauloimport java.util.LinkedHashMap; 36214501Srpauloimport java.util.Map; 37214501Srpauloimport java.util.ServiceLoader; 38214501Srpauloimport java.util.Set; 39214501Srpauloimport java.util.TreeSet; 40214501Srpauloimport java.util.stream.Collectors; 41214501Srpauloimport java.util.stream.StreamSupport; 42214501Srpaulo 43214501Srpauloimport javax.lang.model.SourceVersion; 44214501Srpaulo 45214501Srpauloimport com.sun.tools.doclint.DocLint; 46214501Srpauloimport com.sun.tools.javac.code.Lint; 47214501Srpauloimport com.sun.tools.javac.code.Lint.LintCategory; 48214501Srpauloimport com.sun.tools.javac.code.Source; 49214501Srpauloimport com.sun.tools.javac.code.Type; 50214501Srpauloimport com.sun.tools.javac.jvm.Profile; 51214501Srpauloimport com.sun.tools.javac.jvm.Target; 52214501Srpauloimport com.sun.tools.javac.platform.PlatformProvider; 53214501Srpauloimport com.sun.tools.javac.processing.JavacProcessingEnvironment; 54214501Srpauloimport com.sun.tools.javac.util.Log; 55214501Srpauloimport com.sun.tools.javac.util.Log.PrefixKind; 56214501Srpauloimport com.sun.tools.javac.util.Log.WriterKind; 57214501Srpauloimport com.sun.tools.javac.util.Options; 58214501Srpauloimport com.sun.tools.javac.util.StringUtils; 59214501Srpaulo 60214501Srpauloimport static com.sun.tools.javac.main.Option.ChoiceKind.*; 61214501Srpauloimport static com.sun.tools.javac.main.Option.OptionGroup.*; 62214501Srpauloimport static com.sun.tools.javac.main.Option.OptionKind.*; 63214501Srpaulo 64214501Srpaulo/** 65214501Srpaulo * Options for javac. The specific Option to handle a command-line option 66214501Srpaulo * is identified by searching the members of this enum in order, looking for 67214501Srpaulo * the first {@link #matches match}. The action for an Option is performed 68214501Srpaulo * by calling {@link #process process}, and by providing a suitable 69214501Srpaulo * {@link OptionHelper} to provide access the compiler state. 70214501Srpaulo * 71214501Srpaulo * <p><b>This is NOT part of any supported API. 72214501Srpaulo * If you write code that depends on this, you do so at your own 73214501Srpaulo * risk. This code and its internal interfaces are subject to change 74214501Srpaulo * or deletion without notice.</b></p> 75214501Srpaulo */ 76214501Srpaulopublic enum Option { 77214501Srpaulo G("-g", "opt.g", STANDARD, BASIC), 78214501Srpaulo 79214501Srpaulo G_NONE("-g:none", "opt.g.none", STANDARD, BASIC) { 80214501Srpaulo @Override 81214501Srpaulo public boolean process(OptionHelper helper, String option) { 82214501Srpaulo helper.put("-g:", "none"); 83214501Srpaulo return false; 84214501Srpaulo } 85214501Srpaulo }, 86214501Srpaulo 87214501Srpaulo G_CUSTOM("-g:", "opt.g.lines.vars.source", 88214501Srpaulo STANDARD, BASIC, ANYOF, "lines", "vars", "source"), 89214501Srpaulo 90214501Srpaulo XLINT("-Xlint", "opt.Xlint", EXTENDED, BASIC), 91214501Srpaulo 92214501Srpaulo XLINT_CUSTOM("-Xlint:", EXTENDED, BASIC, ANYOF, getXLintChoices()) { 93214501Srpaulo private static final String LINT_KEY_FORMAT = " %-19s %s"; 94214501Srpaulo @Override 95214501Srpaulo void help(Log log, OptionKind kind) { 96214501Srpaulo if (this.kind != kind) 97214501Srpaulo return; 98214501Srpaulo 99214501Srpaulo log.printRawLines(WriterKind.NOTICE, 100214501Srpaulo String.format(HELP_LINE_FORMAT, 101214501Srpaulo log.localize(PrefixKind.JAVAC, "opt.Xlint.subopts"), 102214501Srpaulo log.localize(PrefixKind.JAVAC, "opt.Xlint.suboptlist"))); 103214501Srpaulo log.printRawLines(WriterKind.NOTICE, 104214501Srpaulo String.format(LINT_KEY_FORMAT, 105214501Srpaulo "all", 106214501Srpaulo log.localize(PrefixKind.JAVAC, "opt.Xlint.all"))); 107214501Srpaulo for (LintCategory lc : LintCategory.values()) { 108214501Srpaulo if (lc.hidden) continue; 109214501Srpaulo log.printRawLines(WriterKind.NOTICE, 110214501Srpaulo String.format(LINT_KEY_FORMAT, 111214501Srpaulo lc.option, 112214501Srpaulo log.localize(PrefixKind.JAVAC, 113214501Srpaulo "opt.Xlint.desc." + lc.option))); 114214501Srpaulo } 115214501Srpaulo log.printRawLines(WriterKind.NOTICE, 116214501Srpaulo String.format(LINT_KEY_FORMAT, 117214501Srpaulo "none", 118252726Srpaulo log.localize(PrefixKind.JAVAC, "opt.Xlint.none"))); 119214501Srpaulo } 120214501Srpaulo }, 121214501Srpaulo 122214501Srpaulo XDOCLINT("-Xdoclint", "opt.Xdoclint", EXTENDED, BASIC), 123214501Srpaulo 124214501Srpaulo XDOCLINT_CUSTOM("-Xdoclint:", "opt.Xdoclint.subopts", "opt.Xdoclint.custom", EXTENDED, BASIC) { 125214501Srpaulo @Override 126214501Srpaulo public boolean matches(String option) { 127214501Srpaulo return DocLint.isValidOption( 128214501Srpaulo option.replace(XDOCLINT_CUSTOM.text, DocLint.XMSGS_CUSTOM_PREFIX)); 129214501Srpaulo } 130214501Srpaulo 131214501Srpaulo @Override 132214501Srpaulo public boolean process(OptionHelper helper, String option) { 133214501Srpaulo String prev = helper.get(XDOCLINT_CUSTOM); 134214501Srpaulo String next = (prev == null) ? option : (prev + " " + option); 135214501Srpaulo helper.put(XDOCLINT_CUSTOM.text, next); 136214501Srpaulo return false; 137214501Srpaulo } 138214501Srpaulo }, 139214501Srpaulo 140214501Srpaulo XDOCLINT_PACKAGE("-Xdoclint/package:", "opt.Xdoclint.package.args", "opt.Xdoclint.package.desc", EXTENDED, BASIC) { 141214501Srpaulo @Override 142214501Srpaulo public boolean matches(String option) { 143214501Srpaulo return DocLint.isValidOption( 144214501Srpaulo option.replace(XDOCLINT_PACKAGE.text, DocLint.XCHECK_PACKAGE)); 145214501Srpaulo } 146214501Srpaulo 147214501Srpaulo @Override 148214501Srpaulo public boolean process(OptionHelper helper, String option) { 149214501Srpaulo String prev = helper.get(XDOCLINT_PACKAGE); 150214501Srpaulo String next = (prev == null) ? option : (prev + " " + option); 151214501Srpaulo helper.put(XDOCLINT_PACKAGE.text, next); 152214501Srpaulo return false; 153214501Srpaulo } 154214501Srpaulo }, 155214501Srpaulo 156214501Srpaulo // -nowarn is retained for command-line backward compatibility 157214501Srpaulo NOWARN("-nowarn", "opt.nowarn", STANDARD, BASIC) { 158214501Srpaulo @Override 159214501Srpaulo public boolean process(OptionHelper helper, String option) { 160214501Srpaulo helper.put("-Xlint:none", option); 161214501Srpaulo return false; 162214501Srpaulo } 163214501Srpaulo }, 164214501Srpaulo 165214501Srpaulo VERBOSE("-verbose", "opt.verbose", STANDARD, BASIC), 166214501Srpaulo 167214501Srpaulo // -deprecation is retained for command-line backward compatibility 168214501Srpaulo DEPRECATION("-deprecation", "opt.deprecation", STANDARD, BASIC) { 169214501Srpaulo @Override 170214501Srpaulo public boolean process(OptionHelper helper, String option) { 171214501Srpaulo helper.put("-Xlint:deprecation", option); 172214501Srpaulo return false; 173214501Srpaulo } 174214501Srpaulo }, 175214501Srpaulo 176214501Srpaulo CLASSPATH("-classpath", "opt.arg.path", "opt.classpath", STANDARD, FILEMANAGER), 177214501Srpaulo 178214501Srpaulo CP("-cp", "opt.arg.path", "opt.classpath", STANDARD, FILEMANAGER) { 179214501Srpaulo @Override 180214501Srpaulo public boolean process(OptionHelper helper, String option, String arg) { 181214501Srpaulo return super.process(helper, "-classpath", arg); 182214501Srpaulo } 183214501Srpaulo }, 184214501Srpaulo 185214501Srpaulo SOURCEPATH("-sourcepath", "opt.arg.path", "opt.sourcepath", STANDARD, FILEMANAGER), 186214501Srpaulo 187214501Srpaulo MODULESOURCEPATH("-modulesourcepath", "opt.arg.mspath", "opt.modulesourcepath", STANDARD, FILEMANAGER), 188214501Srpaulo 189214501Srpaulo MODULEPATH("-modulepath", "opt.arg.path", "opt.modulepath", STANDARD, FILEMANAGER), 190214501Srpaulo 191214501Srpaulo MP("-mp", "opt.arg.path", "opt.modulepath", STANDARD, FILEMANAGER) { 192214501Srpaulo @Override 193214501Srpaulo public boolean process(OptionHelper helper, String option, String arg) { 194214501Srpaulo return super.process(helper, "-modulepath", arg); 195214501Srpaulo } 196214501Srpaulo }, 197214501Srpaulo 198214501Srpaulo UPGRADEMODULEPATH("-upgrademodulepath", "opt.arg.path", "opt.upgrademodulepath", STANDARD, FILEMANAGER), 199214501Srpaulo 200214501Srpaulo SYSTEM("-system", "opt.arg.jdk", "opt.system", STANDARD, FILEMANAGER), 201214501Srpaulo 202214501Srpaulo XPATCH("-Xpatch:", "opt.arg.path", "opt.Xpatch", EXTENDED, FILEMANAGER), 203214501Srpaulo 204214501Srpaulo BOOTCLASSPATH("-bootclasspath", "opt.arg.path", "opt.bootclasspath", STANDARD, FILEMANAGER) { 205214501Srpaulo @Override 206214501Srpaulo public boolean process(OptionHelper helper, String option, String arg) { 207214501Srpaulo helper.remove("-Xbootclasspath/p:"); 208214501Srpaulo helper.remove("-Xbootclasspath/a:"); 209214501Srpaulo return super.process(helper, option, arg); 210214501Srpaulo } 211214501Srpaulo }, 212214501Srpaulo 213214501Srpaulo XBOOTCLASSPATH_PREPEND("-Xbootclasspath/p:", "opt.arg.path", "opt.Xbootclasspath.p", EXTENDED, FILEMANAGER), 214214501Srpaulo 215214501Srpaulo XBOOTCLASSPATH_APPEND("-Xbootclasspath/a:", "opt.arg.path", "opt.Xbootclasspath.a", EXTENDED, FILEMANAGER), 216214501Srpaulo 217214501Srpaulo XBOOTCLASSPATH("-Xbootclasspath:", "opt.arg.path", "opt.bootclasspath", EXTENDED, FILEMANAGER) { 218214501Srpaulo @Override 219214501Srpaulo public boolean process(OptionHelper helper, String option, String arg) { 220214501Srpaulo helper.remove("-Xbootclasspath/p:"); 221214501Srpaulo helper.remove("-Xbootclasspath/a:"); 222214501Srpaulo return super.process(helper, "-bootclasspath", arg); 223214501Srpaulo } 224214501Srpaulo }, 225214501Srpaulo 226214501Srpaulo EXTDIRS("-extdirs", "opt.arg.dirs", "opt.extdirs", STANDARD, FILEMANAGER), 227214501Srpaulo 228214501Srpaulo DJAVA_EXT_DIRS("-Djava.ext.dirs=", "opt.arg.dirs", "opt.extdirs", EXTENDED, FILEMANAGER) { 229214501Srpaulo @Override 230214501Srpaulo public boolean process(OptionHelper helper, String option, String arg) { 231214501Srpaulo return super.process(helper, "-extdirs", arg); 232214501Srpaulo } 233214501Srpaulo }, 234214501Srpaulo 235214501Srpaulo ENDORSEDDIRS("-endorseddirs", "opt.arg.dirs", "opt.endorseddirs", STANDARD, FILEMANAGER), 236214501Srpaulo 237214501Srpaulo DJAVA_ENDORSED_DIRS("-Djava.endorsed.dirs=", "opt.arg.dirs", "opt.endorseddirs", EXTENDED, FILEMANAGER) { 238214501Srpaulo @Override 239214501Srpaulo public boolean process(OptionHelper helper, String option, String arg) { 240214501Srpaulo return super.process(helper, "-endorseddirs", arg); 241214501Srpaulo } 242214501Srpaulo }, 243214501Srpaulo 244214501Srpaulo PROC("-proc:", "opt.proc.none.only", STANDARD, BASIC, ONEOF, "none", "only"), 245214501Srpaulo 246214501Srpaulo PROCESSOR("-processor", "opt.arg.class.list", "opt.processor", STANDARD, BASIC), 247214501Srpaulo 248214501Srpaulo PROCESSORPATH("-processorpath", "opt.arg.path", "opt.processorpath", STANDARD, FILEMANAGER), 249214501Srpaulo 250214501Srpaulo PROCESSORMODULEPATH("-processormodulepath", "opt.arg.path", "opt.processormodulepath", STANDARD, FILEMANAGER), 251214501Srpaulo 252214501Srpaulo PARAMETERS("-parameters","opt.parameters", STANDARD, BASIC), 253214501Srpaulo 254214501Srpaulo D("-d", "opt.arg.directory", "opt.d", STANDARD, FILEMANAGER), 255214501Srpaulo 256214501Srpaulo S("-s", "opt.arg.directory", "opt.sourceDest", STANDARD, FILEMANAGER), 257214501Srpaulo 258214501Srpaulo H("-h", "opt.arg.directory", "opt.headerDest", STANDARD, FILEMANAGER), 259214501Srpaulo 260214501Srpaulo IMPLICIT("-implicit:", "opt.implicit", STANDARD, BASIC, ONEOF, "none", "class"), 261214501Srpaulo 262214501Srpaulo ENCODING("-encoding", "opt.arg.encoding", "opt.encoding", STANDARD, FILEMANAGER), 263214501Srpaulo 264214501Srpaulo SOURCE("-source", "opt.arg.release", "opt.source", STANDARD, BASIC) { 265214501Srpaulo @Override 266214501Srpaulo public boolean process(OptionHelper helper, String option, String operand) { 267214501Srpaulo Source source = Source.lookup(operand); 268214501Srpaulo if (source == null) { 269214501Srpaulo helper.error("err.invalid.source", operand); 270214501Srpaulo return true; 271214501Srpaulo } 272214501Srpaulo return super.process(helper, option, operand); 273214501Srpaulo } 274214501Srpaulo }, 275214501Srpaulo 276214501Srpaulo TARGET("-target", "opt.arg.release", "opt.target", STANDARD, BASIC) { 277214501Srpaulo @Override 278214501Srpaulo public boolean process(OptionHelper helper, String option, String operand) { 279214501Srpaulo Target target = Target.lookup(operand); 280214501Srpaulo if (target == null) { 281214501Srpaulo helper.error("err.invalid.target", operand); 282214501Srpaulo return true; 283214501Srpaulo } 284214501Srpaulo return super.process(helper, option, operand); 285214501Srpaulo } 286214501Srpaulo }, 287214501Srpaulo 288214501Srpaulo RELEASE("-release", "opt.arg.release", "opt.release", STANDARD, BASIC) { 289214501Srpaulo @Override 290214501Srpaulo void help(Log log, OptionKind kind) { 291214501Srpaulo if (this.kind != kind) 292214501Srpaulo return; 293214501Srpaulo 294214501Srpaulo Iterable<PlatformProvider> providers = 295214501Srpaulo ServiceLoader.load(PlatformProvider.class, Arguments.class.getClassLoader()); 296214501Srpaulo Set<String> platforms = StreamSupport.stream(providers.spliterator(), false) 297214501Srpaulo .flatMap(provider -> StreamSupport.stream(provider.getSupportedPlatformNames() 298214501Srpaulo .spliterator(), 299214501Srpaulo false)) 300214501Srpaulo .collect(Collectors.toCollection(TreeSet :: new)); 301214501Srpaulo 302214501Srpaulo StringBuilder targets = new StringBuilder(); 303214501Srpaulo String delim = ""; 304214501Srpaulo for (String platform : platforms) { 305214501Srpaulo targets.append(delim); 306214501Srpaulo targets.append(platform); 307214501Srpaulo delim = ", "; 308214501Srpaulo } 309214501Srpaulo 310214501Srpaulo log.printRawLines(WriterKind.NOTICE, 311214501Srpaulo String.format(HELP_LINE_FORMAT, 312214501Srpaulo super.helpSynopsis(log), 313214501Srpaulo log.localize(PrefixKind.JAVAC, descrKey, targets.toString()))); 314214501Srpaulo } 315214501Srpaulo }, 316214501Srpaulo 317214501Srpaulo PROFILE("-profile", "opt.arg.profile", "opt.profile", STANDARD, BASIC) { 318214501Srpaulo @Override 319214501Srpaulo public boolean process(OptionHelper helper, String option, String operand) { 320214501Srpaulo Profile profile = Profile.lookup(operand); 321214501Srpaulo if (profile == null) { 322214501Srpaulo helper.error("err.invalid.profile", operand); 323214501Srpaulo return true; 324214501Srpaulo } 325214501Srpaulo return super.process(helper, option, operand); 326214501Srpaulo } 327214501Srpaulo }, 328214501Srpaulo 329214501Srpaulo VERSION("-version", "opt.version", STANDARD, INFO) { 330214501Srpaulo @Override 331214501Srpaulo public boolean process(OptionHelper helper, String option) { 332214501Srpaulo Log log = helper.getLog(); 333214501Srpaulo String ownName = helper.getOwnName(); 334214501Srpaulo log.printLines(PrefixKind.JAVAC, "version", ownName, JavaCompiler.version()); 335214501Srpaulo return super.process(helper, option); 336214501Srpaulo } 337214501Srpaulo }, 338214501Srpaulo 339214501Srpaulo FULLVERSION("-fullversion", null, HIDDEN, INFO) { 340214501Srpaulo @Override 341214501Srpaulo public boolean process(OptionHelper helper, String option) { 342214501Srpaulo Log log = helper.getLog(); 343214501Srpaulo String ownName = helper.getOwnName(); 344214501Srpaulo log.printLines(PrefixKind.JAVAC, "fullVersion", ownName, JavaCompiler.fullVersion()); 345214501Srpaulo return super.process(helper, option); 346214501Srpaulo } 347214501Srpaulo }, 348214501Srpaulo 349214501Srpaulo DIAGS("-XDdiags=", null, HIDDEN, INFO) { 350214501Srpaulo @Override 351214501Srpaulo public boolean process(OptionHelper helper, String option) { 352214501Srpaulo option = option.substring(option.indexOf('=') + 1); 353214501Srpaulo String diagsOption = option.contains("%") ? 354214501Srpaulo "-XDdiagsFormat=" : 355214501Srpaulo "-XDdiags="; 356214501Srpaulo diagsOption += option; 357214501Srpaulo if (XD.matches(diagsOption)) 358214501Srpaulo return XD.process(helper, diagsOption); 359214501Srpaulo else 360214501Srpaulo return false; 361214501Srpaulo } 362214501Srpaulo }, 363214501Srpaulo 364214501Srpaulo HELP("-help", "opt.help", STANDARD, INFO) { 365214501Srpaulo @Override 366214501Srpaulo public boolean process(OptionHelper helper, String option) { 367214501Srpaulo Log log = helper.getLog(); 368214501Srpaulo String ownName = helper.getOwnName(); 369214501Srpaulo log.printLines(PrefixKind.JAVAC, "msg.usage.header", ownName); 370214501Srpaulo for (Option o: getJavaCompilerOptions()) { 371214501Srpaulo o.help(log, OptionKind.STANDARD); 372214501Srpaulo } 373214501Srpaulo log.printNewline(); 374214501Srpaulo return super.process(helper, option); 375214501Srpaulo } 376214501Srpaulo }, 377214501Srpaulo 378214501Srpaulo A("-A", "opt.arg.key.equals.value", "opt.A", STANDARD, BASIC, true) { 379214501Srpaulo @Override 380214501Srpaulo public boolean matches(String arg) { 381214501Srpaulo return arg.startsWith("-A"); 382214501Srpaulo } 383214501Srpaulo 384214501Srpaulo @Override 385214501Srpaulo public boolean hasArg() { 386214501Srpaulo return false; 387214501Srpaulo } 388214501Srpaulo // Mapping for processor options created in 389214501Srpaulo // JavacProcessingEnvironment 390214501Srpaulo @Override 391214501Srpaulo public boolean process(OptionHelper helper, String option) { 392214501Srpaulo int argLength = option.length(); 393214501Srpaulo if (argLength == 2) { 394214501Srpaulo helper.error("err.empty.A.argument"); 395214501Srpaulo return true; 396214501Srpaulo } 397214501Srpaulo int sepIndex = option.indexOf('='); 398214501Srpaulo String key = option.substring(2, (sepIndex != -1 ? sepIndex : argLength) ); 399214501Srpaulo if (!JavacProcessingEnvironment.isValidOptionName(key)) { 400214501Srpaulo helper.error("err.invalid.A.key", option); 401214501Srpaulo return true; 402214501Srpaulo } 403214501Srpaulo return process(helper, option, option); 404214501Srpaulo } 405214501Srpaulo }, 406214501Srpaulo 407214501Srpaulo X("-X", "opt.X", STANDARD, INFO) { 408214501Srpaulo @Override 409214501Srpaulo public boolean process(OptionHelper helper, String option) { 410214501Srpaulo Log log = helper.getLog(); 411214501Srpaulo for (Option o: getJavaCompilerOptions()) { 412214501Srpaulo o.help(log, OptionKind.EXTENDED); 413214501Srpaulo } 414214501Srpaulo log.printNewline(); 415214501Srpaulo log.printLines(PrefixKind.JAVAC, "msg.usage.nonstandard.footer"); 416214501Srpaulo return super.process(helper, option); 417214501Srpaulo } 418214501Srpaulo }, 419214501Srpaulo 420214501Srpaulo // This option exists only for the purpose of documenting itself. 421214501Srpaulo // It's actually implemented by the launcher. 422214501Srpaulo J("-J", "opt.arg.flag", "opt.J", STANDARD, INFO, true) { 423214501Srpaulo @Override 424214501Srpaulo public boolean process(OptionHelper helper, String option) { 425214501Srpaulo throw new AssertionError 426214501Srpaulo ("the -J flag should be caught by the launcher."); 427214501Srpaulo } 428214501Srpaulo }, 429214501Srpaulo 430214501Srpaulo MOREINFO("-moreinfo", null, HIDDEN, BASIC) { 431214501Srpaulo @Override 432214501Srpaulo public boolean process(OptionHelper helper, String option) { 433214501Srpaulo Type.moreInfo = true; 434214501Srpaulo return super.process(helper, option); 435214501Srpaulo } 436214501Srpaulo }, 437214501Srpaulo 438214501Srpaulo // treat warnings as errors 439214501Srpaulo WERROR("-Werror", "opt.Werror", STANDARD, BASIC), 440214501Srpaulo 441214501Srpaulo // prompt after each error 442214501Srpaulo // new Option("-prompt", "opt.prompt"), 443214501Srpaulo PROMPT("-prompt", null, HIDDEN, BASIC), 444214501Srpaulo 445214501Srpaulo // dump stack on error 446214501Srpaulo DOE("-doe", null, HIDDEN, BASIC), 447214501Srpaulo 448214501Srpaulo // output source after type erasure 449214501Srpaulo PRINTSOURCE("-printsource", null, HIDDEN, BASIC), 450214501Srpaulo 451214501Srpaulo // display warnings for generic unchecked operations 452214501Srpaulo WARNUNCHECKED("-warnunchecked", null, HIDDEN, BASIC) { 453214501Srpaulo @Override 454214501Srpaulo public boolean process(OptionHelper helper, String option) { 455214501Srpaulo helper.put("-Xlint:unchecked", option); 456214501Srpaulo return false; 457214501Srpaulo } 458214501Srpaulo }, 459214501Srpaulo 460214501Srpaulo XMAXERRS("-Xmaxerrs", "opt.arg.number", "opt.maxerrs", EXTENDED, BASIC), 461214501Srpaulo 462214501Srpaulo XMAXWARNS("-Xmaxwarns", "opt.arg.number", "opt.maxwarns", EXTENDED, BASIC), 463214501Srpaulo 464214501Srpaulo XSTDOUT("-Xstdout", "opt.arg.file", "opt.Xstdout", EXTENDED, INFO) { 465214501Srpaulo @Override 466214501Srpaulo public boolean process(OptionHelper helper, String option, String arg) { 467214501Srpaulo try { 468214501Srpaulo Log log = helper.getLog(); 469214501Srpaulo log.setWriters(new PrintWriter(new FileWriter(arg), true)); 470214501Srpaulo } catch (java.io.IOException e) { 471214501Srpaulo helper.error("err.error.writing.file", arg, e); 472214501Srpaulo return true; 473214501Srpaulo } 474214501Srpaulo return super.process(helper, option, arg); 475214501Srpaulo } 476214501Srpaulo }, 477214501Srpaulo 478214501Srpaulo XPRINT("-Xprint", "opt.print", EXTENDED, BASIC), 479214501Srpaulo 480214501Srpaulo XPRINTROUNDS("-XprintRounds", "opt.printRounds", EXTENDED, BASIC), 481214501Srpaulo 482214501Srpaulo XPRINTPROCESSORINFO("-XprintProcessorInfo", "opt.printProcessorInfo", EXTENDED, BASIC), 483214501Srpaulo 484214501Srpaulo XPREFER("-Xprefer:", "opt.prefer", EXTENDED, BASIC, ONEOF, "source", "newer"), 485214501Srpaulo 486214501Srpaulo XXUSERPATHSFIRST("-XXuserPathsFirst", "opt.userpathsfirst", HIDDEN, BASIC), 487214501Srpaulo 488214501Srpaulo // see enum PkgInfo 489214501Srpaulo XPKGINFO("-Xpkginfo:", "opt.pkginfo", EXTENDED, BASIC, ONEOF, "always", "legacy", "nonempty"), 490214501Srpaulo 491214501Srpaulo /* -O is a no-op, accepted for backward compatibility. */ 492214501Srpaulo O("-O", null, HIDDEN, BASIC), 493214501Srpaulo 494214501Srpaulo /* -Xjcov produces tables to support the code coverage tool jcov. */ 495214501Srpaulo XJCOV("-Xjcov", null, HIDDEN, BASIC), 496214501Srpaulo 497214501Srpaulo PLUGIN("-Xplugin:", "opt.arg.plugin", "opt.plugin", EXTENDED, BASIC) { 498214501Srpaulo @Override 499214501Srpaulo public boolean process(OptionHelper helper, String option) { 500214501Srpaulo String p = option.substring(option.indexOf(':') + 1).trim(); 501214501Srpaulo String prev = helper.get(PLUGIN); 502214501Srpaulo helper.put(PLUGIN.text, (prev == null) ? p : prev + '\0' + p); 503214501Srpaulo return false; 504214501Srpaulo } 505214501Srpaulo }, 506214501Srpaulo 507214501Srpaulo XDIAGS("-Xdiags:", "opt.diags", EXTENDED, BASIC, ONEOF, "compact", "verbose"), 508214501Srpaulo 509214501Srpaulo /* This is a back door to the compiler's option table. 510214501Srpaulo * -XDx=y sets the option x to the value y. 511214501Srpaulo * -XDx sets the option x to the value x. 512214501Srpaulo */ 513214501Srpaulo XD("-XD", null, HIDDEN, BASIC) { 514214501Srpaulo @Override 515214501Srpaulo public boolean matches(String s) { 516214501Srpaulo return s.startsWith(text); 517214501Srpaulo } 518214501Srpaulo @Override 519214501Srpaulo public boolean process(OptionHelper helper, String option) { 520214501Srpaulo option = option.substring(text.length()); 521214501Srpaulo int eq = option.indexOf('='); 522214501Srpaulo String key = (eq < 0) ? option : option.substring(0, eq); 523214501Srpaulo String value = (eq < 0) ? option : option.substring(eq+1); 524214501Srpaulo helper.put(key, value); 525214501Srpaulo return false; 526214501Srpaulo } 527214501Srpaulo }, 528214501Srpaulo 529214501Srpaulo XADDEXPORTS("-XaddExports:", "opt.arg.addExports", "opt.addExports", EXTENDED, BASIC) { 530214501Srpaulo @Override 531214501Srpaulo public boolean process(OptionHelper helper, String option) { 532214501Srpaulo if (option.matches(".*,.*=.*")) { // temporary, for backwards compatibility 533214501Srpaulo return processOldStyle(helper, option); 534214501Srpaulo } 535214501Srpaulo String p = option.substring(option.indexOf(':') + 1).trim(); 536214501Srpaulo String prev = helper.get(XADDEXPORTS); 537214501Srpaulo helper.put(XADDEXPORTS.text, (prev == null) ? p : prev + '\0' + p); 538214501Srpaulo return false; 539214501Srpaulo } 540214501Srpaulo 541214501Srpaulo // convert old style option into a series of new-style options 542214501Srpaulo private boolean processOldStyle(OptionHelper helper, String option) { 543214501Srpaulo String p = option.substring(option.indexOf(':') + 1).trim(); 544214501Srpaulo String[] entries = p.split("[ ,]+"); 545214501Srpaulo Map<String, String> map = new LinkedHashMap<>(); 546214501Srpaulo for (String e: entries) { 547214501Srpaulo // Each entry is of the form module/package=target 548214501Srpaulo // we must group values for the same module/package together 549214501Srpaulo int eq = e.indexOf('='); 550214501Srpaulo if (eq == -1) { 551214501Srpaulo // don't bother with error message for backwards compatible support 552214501Srpaulo continue; 553214501Srpaulo } 554214501Srpaulo String modPkg = e.substring(0, eq); 555214501Srpaulo String target = e.substring(eq + 1); 556214501Srpaulo String targets = map.get(modPkg); 557214501Srpaulo map.put(modPkg, (targets == null) ? target : targets + "," + target); 558214501Srpaulo } 559214501Srpaulo boolean ok = true; 560214501Srpaulo for (Map.Entry<String, String> e: map.entrySet()) { 561214501Srpaulo // process as new-style options 562214501Srpaulo String key = e.getKey(); 563214501Srpaulo String value = e.getValue(); 564214501Srpaulo ok = ok & process(helper, XADDEXPORTS.text + key + "=" + value); 565214501Srpaulo }; 566214501Srpaulo return ok; 567214501Srpaulo } 568214501Srpaulo }, 569214501Srpaulo 570214501Srpaulo XADDREADS("-XaddReads:", "opt.arg.addReads", "opt.addReads", EXTENDED, BASIC) { 571214501Srpaulo @Override 572214501Srpaulo public boolean process(OptionHelper helper, String option) { 573214501Srpaulo if (option.matches(".*,.*=.*")) { // temporary, for backwards compatibility 574214501Srpaulo return processOldStyle(helper, option); 575214501Srpaulo } 576214501Srpaulo String p = option.substring(option.indexOf(':') + 1).trim(); 577214501Srpaulo String prev = helper.get(XADDREADS); 578214501Srpaulo helper.put(XADDREADS.text, (prev == null) ? p : prev + '\0' + p); 579214501Srpaulo return false; 580214501Srpaulo } 581214501Srpaulo 582214501Srpaulo // convert old style option into a series of new-style options 583214501Srpaulo private boolean processOldStyle(OptionHelper helper, String option) { 584214501Srpaulo String p = option.substring(option.indexOf(':') + 1).trim(); 585214501Srpaulo String[] entries = p.split("[ ,]+"); 586214501Srpaulo Map<String, String> map = new LinkedHashMap<>(); 587214501Srpaulo for (String e: entries) { 588214501Srpaulo // Each entry is of the form module=target 589214501Srpaulo // we must group values for the same module together 590214501Srpaulo int eq = e.indexOf('='); 591214501Srpaulo if (eq == -1) { 592214501Srpaulo // don't bother with error message for backwards compatible support 593214501Srpaulo continue; 594214501Srpaulo } 595214501Srpaulo String modPkg = e.substring(0, eq); 596214501Srpaulo String target = e.substring(eq + 1); 597214501Srpaulo String targets = map.get(modPkg); 598214501Srpaulo map.put(modPkg, (targets == null) ? target : targets + "," + target); 599214501Srpaulo } 600214501Srpaulo boolean ok = true; 601214501Srpaulo for (Map.Entry<String, String> e: map.entrySet()) { 602214501Srpaulo // process as new-style options 603214501Srpaulo String key = e.getKey(); 604214501Srpaulo String value = e.getValue(); 605214501Srpaulo ok = ok & process(helper, XADDEXPORTS.text + key + "=" + value); 606214501Srpaulo }; 607214501Srpaulo return ok; 608214501Srpaulo } 609214501Srpaulo }, 610214501Srpaulo 611214501Srpaulo XMODULE("-Xmodule:", "opt.arg.module", "opt.module", EXTENDED, BASIC) { 612214501Srpaulo @Override 613214501Srpaulo public boolean process(OptionHelper helper, String option) { 614214501Srpaulo String prev = helper.get(XMODULE); 615214501Srpaulo if (prev != null) { 616214501Srpaulo helper.error("err.option.too.many", XMODULE.text); 617214501Srpaulo } 618214501Srpaulo String p = option.substring(option.indexOf(':') + 1); 619214501Srpaulo helper.put(XMODULE.text, p); 620214501Srpaulo return false; 621214501Srpaulo } 622214501Srpaulo }, 623214501Srpaulo 624214501Srpaulo M("-m", "opt.arg.m", "opt.m", STANDARD, BASIC), 625214501Srpaulo 626214501Srpaulo ADDMODS("-addmods", "opt.arg.addmods", "opt.addmods", STANDARD, BASIC), 627214501Srpaulo LIMITMODS("-limitmods", "opt.arg.limitmods", "opt.limitmods", STANDARD, BASIC), 628214501Srpaulo 629 // This option exists only for the purpose of documenting itself. 630 // It's actually implemented by the CommandLine class. 631 AT("@", "opt.arg.file", "opt.AT", STANDARD, INFO, true) { 632 @Override 633 public boolean process(OptionHelper helper, String option) { 634 throw new AssertionError("the @ flag should be caught by CommandLine."); 635 } 636 }, 637 638 // Standalone positional argument: source file or type name. 639 SOURCEFILE("sourcefile", null, HIDDEN, INFO) { 640 @Override 641 public boolean matches(String s) { 642 if (s.endsWith(".java")) // Java source file 643 return true; 644 int sep = s.indexOf('/'); 645 if (sep != -1) { 646 return SourceVersion.isName(s.substring(0, sep)) 647 && SourceVersion.isName(s.substring(sep + 1)); 648 } else { 649 return SourceVersion.isName(s); // Legal type name 650 } 651 } 652 @Override 653 public boolean process(OptionHelper helper, String option) { 654 if (option.endsWith(".java") ) { 655 Path p = Paths.get(option); 656 if (!Files.exists(p)) { 657 helper.error("err.file.not.found", p); 658 return true; 659 } 660 if (!Files.isRegularFile(p)) { 661 helper.error("err.file.not.file", p); 662 return true; 663 } 664 helper.addFile(p); 665 } else { 666 helper.addClassName(option); 667 } 668 return false; 669 } 670 }, 671 672 MULTIRELEASE("-multi-release", "opt.arg.multi-release", "opt.multi-release", HIDDEN, FILEMANAGER); 673 674 /** The kind of an Option. This is used by the -help and -X options. */ 675 public enum OptionKind { 676 /** A standard option, documented by -help. */ 677 STANDARD, 678 /** An extended option, documented by -X. */ 679 EXTENDED, 680 /** A hidden option, not documented. */ 681 HIDDEN, 682 } 683 684 /** The group for an Option. This determines the situations in which the 685 * option is applicable. */ 686 enum OptionGroup { 687 /** A basic option, available for use on the command line or via the 688 * Compiler API. */ 689 BASIC, 690 /** An option for javac's standard JavaFileManager. Other file managers 691 * may or may not support these options. */ 692 FILEMANAGER, 693 /** A command-line option that requests information, such as -help. */ 694 INFO, 695 /** A command-line "option" representing a file or class name. */ 696 OPERAND 697 } 698 699 /** The kind of choice for "choice" options. */ 700 enum ChoiceKind { 701 /** The expected value is exactly one of the set of choices. */ 702 ONEOF, 703 /** The expected value is one of more of the set of choices. */ 704 ANYOF 705 } 706 707 public final String text; 708 709 final OptionKind kind; 710 711 final OptionGroup group; 712 713 /** Documentation key for arguments. 714 */ 715 final String argsNameKey; 716 717 /** Documentation key for description. 718 */ 719 final String descrKey; 720 721 /** Suffix option (-foo=bar or -foo:bar) 722 */ 723 final boolean hasSuffix; 724 725 /** The kind of choices for this option, if any. 726 */ 727 final ChoiceKind choiceKind; 728 729 /** The choices for this option, if any, and whether or not the choices 730 * are hidden 731 */ 732 final Map<String,Boolean> choices; 733 734 735 Option(String text, String descrKey, 736 OptionKind kind, OptionGroup group) { 737 this(text, null, descrKey, kind, group, null, null, false); 738 } 739 740 Option(String text, String argsNameKey, String descrKey, 741 OptionKind kind, OptionGroup group) { 742 this(text, argsNameKey, descrKey, kind, group, null, null, false); 743 } 744 745 Option(String text, String argsNameKey, String descrKey, 746 OptionKind kind, OptionGroup group, boolean doHasSuffix) { 747 this(text, argsNameKey, descrKey, kind, group, null, null, doHasSuffix); 748 } 749 750 Option(String text, OptionKind kind, OptionGroup group, 751 ChoiceKind choiceKind, Map<String,Boolean> choices) { 752 this(text, null, null, kind, group, choiceKind, choices, false); 753 } 754 755 Option(String text, String descrKey, 756 OptionKind kind, OptionGroup group, 757 ChoiceKind choiceKind, String... choices) { 758 this(text, null, descrKey, kind, group, choiceKind, 759 createChoices(choices), false); 760 } 761 // where 762 private static Map<String,Boolean> createChoices(String... choices) { 763 Map<String,Boolean> map = new LinkedHashMap<>(); 764 for (String c: choices) 765 map.put(c, false); 766 return map; 767 } 768 769 private Option(String text, String argsNameKey, String descrKey, 770 OptionKind kind, OptionGroup group, 771 ChoiceKind choiceKind, Map<String,Boolean> choices, 772 boolean doHasSuffix) { 773 this.text = text; 774 this.argsNameKey = argsNameKey; 775 this.descrKey = descrKey; 776 this.kind = kind; 777 this.group = group; 778 this.choiceKind = choiceKind; 779 this.choices = choices; 780 char lastChar = text.charAt(text.length()-1); 781 this.hasSuffix = doHasSuffix || lastChar == ':' || lastChar == '='; 782 } 783 784 public String getText() { 785 return text; 786 } 787 788 public OptionKind getKind() { 789 return kind; 790 } 791 792 public boolean hasArg() { 793 return argsNameKey != null && !hasSuffix; 794 } 795 796 public boolean matches(String option) { 797 if (!hasSuffix) 798 return option.equals(text); 799 800 if (!option.startsWith(text)) 801 return false; 802 803 if (choices != null) { 804 String arg = option.substring(text.length()); 805 if (choiceKind == ChoiceKind.ONEOF) 806 return choices.keySet().contains(arg); 807 else { 808 for (String a: arg.split(",+")) { 809 if (!choices.keySet().contains(a)) 810 return false; 811 } 812 } 813 } 814 815 return true; 816 } 817 818 public boolean process(OptionHelper helper, String option, String arg) { 819 if (choices != null) { 820 if (choiceKind == ChoiceKind.ONEOF) { 821 // some clients like to see just one of option+choice set 822 for (String s: choices.keySet()) 823 helper.remove(option + s); 824 String opt = option + arg; 825 helper.put(opt, opt); 826 // some clients like to see option (without trailing ":") 827 // set to arg 828 String nm = option.substring(0, option.length() - 1); 829 helper.put(nm, arg); 830 } else { 831 // set option+word for each word in arg 832 for (String a: arg.split(",+")) { 833 String opt = option + a; 834 helper.put(opt, opt); 835 } 836 } 837 } 838 helper.put(option, arg); 839 if (group == OptionGroup.FILEMANAGER) 840 helper.handleFileManagerOption(this, arg); 841 return false; 842 } 843 844 public boolean process(OptionHelper helper, String option) { 845 if (hasSuffix) 846 return process(helper, text, option.substring(text.length())); 847 else 848 return process(helper, option, option); 849 } 850 851 private static final String HELP_LINE_FORMAT = " %-26s %s"; 852 853 void help(Log log, OptionKind kind) { 854 if (this.kind != kind) 855 return; 856 857 log.printRawLines(WriterKind.NOTICE, 858 String.format(HELP_LINE_FORMAT, 859 helpSynopsis(log), 860 log.localize(PrefixKind.JAVAC, descrKey))); 861 862 } 863 864 private String helpSynopsis(Log log) { 865 StringBuilder sb = new StringBuilder(); 866 sb.append(text); 867 if (argsNameKey == null) { 868 if (choices != null) { 869 String sep = "{"; 870 for (Map.Entry<String,Boolean> e: choices.entrySet()) { 871 if (!e.getValue()) { 872 sb.append(sep); 873 sb.append(e.getKey()); 874 sep = ","; 875 } 876 } 877 sb.append("}"); 878 } 879 } else { 880 if (!hasSuffix) 881 sb.append(" "); 882 sb.append(log.localize(PrefixKind.JAVAC, argsNameKey)); 883 884 } 885 886 return sb.toString(); 887 } 888 889 // For -XpkgInfo:value 890 public enum PkgInfo { 891 /** 892 * Always generate package-info.class for every package-info.java file. 893 * The file may be empty if there annotations with a RetentionPolicy 894 * of CLASS or RUNTIME. This option may be useful in conjunction with 895 * build systems (such as Ant) that expect javac to generate at least 896 * one .class file for every .java file. 897 */ 898 ALWAYS, 899 /** 900 * Generate a package-info.class file if package-info.java contains 901 * annotations. The file may be empty if all the annotations have 902 * a RetentionPolicy of SOURCE. 903 * This value is just for backwards compatibility with earlier behavior. 904 * Either of the other two values are to be preferred to using this one. 905 */ 906 LEGACY, 907 /** 908 * Generate a package-info.class file if and only if there are annotations 909 * in package-info.java to be written into it. 910 */ 911 NONEMPTY; 912 913 public static PkgInfo get(Options options) { 914 String v = options.get(XPKGINFO); 915 return (v == null 916 ? PkgInfo.LEGACY 917 : PkgInfo.valueOf(StringUtils.toUpperCase(v))); 918 } 919 } 920 921 private static Map<String,Boolean> getXLintChoices() { 922 Map<String,Boolean> choices = new LinkedHashMap<>(); 923 choices.put("all", false); 924 for (Lint.LintCategory c : Lint.LintCategory.values()) 925 choices.put(c.option, c.hidden); 926 for (Lint.LintCategory c : Lint.LintCategory.values()) 927 choices.put("-" + c.option, c.hidden); 928 choices.put("none", false); 929 return choices; 930 } 931 932 static Set<Option> getJavaCompilerOptions() { 933 return EnumSet.allOf(Option.class); 934 } 935 936 public static Set<Option> getJavacFileManagerOptions() { 937 return getOptions(EnumSet.of(FILEMANAGER)); 938 } 939 940 public static Set<Option> getJavacToolOptions() { 941 return getOptions(EnumSet.of(BASIC)); 942 } 943 944 static Set<Option> getOptions(Set<OptionGroup> desired) { 945 Set<Option> options = EnumSet.noneOf(Option.class); 946 for (Option option : Option.values()) 947 if (desired.contains(option.group)) 948 options.add(option); 949 return Collections.unmodifiableSet(options); 950 } 951 952} 953