src/share/classes/com/sun/tools/javac/main/Main.java

Thu, 24 Jul 2008 19:06:57 +0100

author
mcimadamore
date
Thu, 24 Jul 2008 19:06:57 +0100
changeset 80
5c9cdeb740f2
parent 54
eaf608c64fec
child 106
ceaa6549687a
permissions
-rw-r--r--

6717241: some diagnostic argument is prematurely converted into a String object
Summary: removed early toString() conversions applied to diagnostic arguments
Reviewed-by: jjg

duke@1 1 /*
xdono@54 2 * Copyright 1999-2008 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.javac.main;
duke@1 27
duke@1 28 import java.io.File;
duke@1 29 import java.io.IOException;
duke@1 30 import java.io.PrintWriter;
duke@1 31 import java.util.MissingResourceException;
duke@1 32
duke@1 33 import com.sun.tools.javac.code.Source;
jjg@50 34 import com.sun.tools.javac.file.JavacFileManager;
duke@1 35 import com.sun.tools.javac.jvm.Target;
duke@1 36 import com.sun.tools.javac.main.JavacOption.Option;
duke@1 37 import com.sun.tools.javac.main.RecognizedOptions.OptionHelper;
duke@1 38 import com.sun.tools.javac.util.*;
duke@1 39 import com.sun.tools.javac.processing.AnnotationProcessingError;
duke@1 40 import javax.tools.JavaFileManager;
duke@1 41 import javax.tools.JavaFileObject;
duke@1 42 import javax.annotation.processing.Processor;
duke@1 43
duke@1 44 /** This class provides a commandline interface to the GJC compiler.
duke@1 45 *
duke@1 46 * <p><b>This is NOT part of any API supported by Sun Microsystems. If
duke@1 47 * you write code that depends on this, you do so at your own risk.
duke@1 48 * This code and its internal interfaces are subject to change or
duke@1 49 * deletion without notice.</b>
duke@1 50 */
duke@1 51 public class Main {
duke@1 52
duke@1 53 /** The name of the compiler, for use in diagnostics.
duke@1 54 */
duke@1 55 String ownName;
duke@1 56
duke@1 57 /** The writer to use for diagnostic output.
duke@1 58 */
duke@1 59 PrintWriter out;
duke@1 60
duke@1 61 /**
duke@1 62 * If true, any command line arg errors will cause an exception.
duke@1 63 */
duke@1 64 boolean fatalErrors;
duke@1 65
duke@1 66 /** Result codes.
duke@1 67 */
duke@1 68 static final int
duke@1 69 EXIT_OK = 0, // Compilation completed with no errors.
duke@1 70 EXIT_ERROR = 1, // Completed but reported errors.
duke@1 71 EXIT_CMDERR = 2, // Bad command-line arguments
duke@1 72 EXIT_SYSERR = 3, // System error or resource exhaustion.
duke@1 73 EXIT_ABNORMAL = 4; // Compiler terminated abnormally
duke@1 74
duke@1 75 private Option[] recognizedOptions = RecognizedOptions.getJavaCompilerOptions(new OptionHelper() {
duke@1 76
duke@1 77 public void setOut(PrintWriter out) {
duke@1 78 Main.this.out = out;
duke@1 79 }
duke@1 80
duke@1 81 public void error(String key, Object... args) {
duke@1 82 Main.this.error(key, args);
duke@1 83 }
duke@1 84
duke@1 85 public void printVersion() {
duke@1 86 Log.printLines(out, getLocalizedString("version", ownName, JavaCompiler.version()));
duke@1 87 }
duke@1 88
duke@1 89 public void printFullVersion() {
duke@1 90 Log.printLines(out, getLocalizedString("fullVersion", ownName, JavaCompiler.fullVersion()));
duke@1 91 }
duke@1 92
duke@1 93 public void printHelp() {
duke@1 94 help();
duke@1 95 }
duke@1 96
duke@1 97 public void printXhelp() {
duke@1 98 xhelp();
duke@1 99 }
duke@1 100
duke@1 101 public void addFile(File f) {
duke@1 102 if (!filenames.contains(f))
duke@1 103 filenames.append(f);
duke@1 104 }
duke@1 105
duke@1 106 public void addClassName(String s) {
duke@1 107 classnames.append(s);
duke@1 108 }
duke@1 109
duke@1 110 });
duke@1 111
duke@1 112 /**
duke@1 113 * Construct a compiler instance.
duke@1 114 */
duke@1 115 public Main(String name) {
duke@1 116 this(name, new PrintWriter(System.err, true));
duke@1 117 }
duke@1 118
duke@1 119 /**
duke@1 120 * Construct a compiler instance.
duke@1 121 */
duke@1 122 public Main(String name, PrintWriter out) {
duke@1 123 this.ownName = name;
duke@1 124 this.out = out;
duke@1 125 }
duke@1 126 /** A table of all options that's passed to the JavaCompiler constructor. */
duke@1 127 private Options options = null;
duke@1 128
duke@1 129 /** The list of source files to process
duke@1 130 */
duke@1 131 public ListBuffer<File> filenames = null; // XXX sb protected
duke@1 132
duke@1 133 /** List of class files names passed on the command line
duke@1 134 */
duke@1 135 public ListBuffer<String> classnames = null; // XXX sb protected
duke@1 136
duke@1 137 /** Print a string that explains usage.
duke@1 138 */
duke@1 139 void help() {
duke@1 140 Log.printLines(out, getLocalizedString("msg.usage.header", ownName));
duke@1 141 for (int i=0; i<recognizedOptions.length; i++) {
duke@1 142 recognizedOptions[i].help(out);
duke@1 143 }
duke@1 144 out.println();
duke@1 145 }
duke@1 146
duke@1 147 /** Print a string that explains usage for X options.
duke@1 148 */
duke@1 149 void xhelp() {
duke@1 150 for (int i=0; i<recognizedOptions.length; i++) {
duke@1 151 recognizedOptions[i].xhelp(out);
duke@1 152 }
duke@1 153 out.println();
duke@1 154 Log.printLines(out, getLocalizedString("msg.usage.nonstandard.footer"));
duke@1 155 }
duke@1 156
duke@1 157 /** Report a usage error.
duke@1 158 */
duke@1 159 void error(String key, Object... args) {
duke@1 160 if (fatalErrors) {
duke@1 161 String msg = getLocalizedString(key, args);
duke@1 162 throw new PropagatedException(new IllegalStateException(msg));
duke@1 163 }
duke@1 164 warning(key, args);
duke@1 165 Log.printLines(out, getLocalizedString("msg.usage", ownName));
duke@1 166 }
duke@1 167
duke@1 168 /** Report a warning.
duke@1 169 */
duke@1 170 void warning(String key, Object... args) {
duke@1 171 Log.printLines(out, ownName + ": "
duke@1 172 + getLocalizedString(key, args));
duke@1 173 }
duke@1 174
duke@1 175 public Option getOption(String flag) {
duke@1 176 for (Option option : recognizedOptions) {
duke@1 177 if (option.matches(flag))
duke@1 178 return option;
duke@1 179 }
duke@1 180 return null;
duke@1 181 }
duke@1 182
duke@1 183 public void setOptions(Options options) {
duke@1 184 if (options == null)
duke@1 185 throw new NullPointerException();
duke@1 186 this.options = options;
duke@1 187 }
duke@1 188
duke@1 189 public void setFatalErrors(boolean fatalErrors) {
duke@1 190 this.fatalErrors = fatalErrors;
duke@1 191 }
duke@1 192
duke@1 193 /** Process command line arguments: store all command line options
duke@1 194 * in `options' table and return all source filenames.
duke@1 195 * @param flags The array of command line arguments.
duke@1 196 */
duke@1 197 public List<File> processArgs(String[] flags) { // XXX sb protected
duke@1 198 int ac = 0;
duke@1 199 while (ac < flags.length) {
duke@1 200 String flag = flags[ac];
duke@1 201 ac++;
duke@1 202
duke@1 203 Option option = null;
duke@1 204
duke@1 205 if (flag.length() > 0) {
duke@1 206 // quick hack to speed up file processing:
duke@1 207 // if the option does not begin with '-', there is no need to check
duke@1 208 // most of the compiler options.
duke@1 209 int firstOptionToCheck = flag.charAt(0) == '-' ? 0 : recognizedOptions.length-1;
duke@1 210 for (int j=firstOptionToCheck; j<recognizedOptions.length; j++) {
duke@1 211 if (recognizedOptions[j].matches(flag)) {
duke@1 212 option = recognizedOptions[j];
duke@1 213 break;
duke@1 214 }
duke@1 215 }
duke@1 216 }
duke@1 217
duke@1 218 if (option == null) {
duke@1 219 error("err.invalid.flag", flag);
duke@1 220 return null;
duke@1 221 }
duke@1 222
duke@1 223 if (option.hasArg()) {
duke@1 224 if (ac == flags.length) {
duke@1 225 error("err.req.arg", flag);
duke@1 226 return null;
duke@1 227 }
duke@1 228 String operand = flags[ac];
duke@1 229 ac++;
duke@1 230 if (option.process(options, flag, operand))
duke@1 231 return null;
duke@1 232 } else {
duke@1 233 if (option.process(options, flag))
duke@1 234 return null;
duke@1 235 }
duke@1 236 }
duke@1 237
duke@1 238 if (!checkDirectory("-d"))
duke@1 239 return null;
duke@1 240 if (!checkDirectory("-s"))
duke@1 241 return null;
duke@1 242
duke@1 243 String sourceString = options.get("-source");
duke@1 244 Source source = (sourceString != null)
duke@1 245 ? Source.lookup(sourceString)
duke@1 246 : Source.DEFAULT;
duke@1 247 String targetString = options.get("-target");
duke@1 248 Target target = (targetString != null)
duke@1 249 ? Target.lookup(targetString)
duke@1 250 : Target.DEFAULT;
duke@1 251 // We don't check source/target consistency for CLDC, as J2ME
duke@1 252 // profiles are not aligned with J2SE targets; moreover, a
duke@1 253 // single CLDC target may have many profiles. In addition,
duke@1 254 // this is needed for the continued functioning of the JSR14
duke@1 255 // prototype.
duke@1 256 if (Character.isDigit(target.name.charAt(0))) {
duke@1 257 if (target.compareTo(source.requiredTarget()) < 0) {
duke@1 258 if (targetString != null) {
duke@1 259 if (sourceString == null) {
duke@1 260 warning("warn.target.default.source.conflict",
duke@1 261 targetString,
duke@1 262 source.requiredTarget().name);
duke@1 263 } else {
duke@1 264 warning("warn.source.target.conflict",
duke@1 265 sourceString,
duke@1 266 source.requiredTarget().name);
duke@1 267 }
duke@1 268 return null;
duke@1 269 } else {
duke@1 270 options.put("-target", source.requiredTarget().name);
duke@1 271 }
duke@1 272 } else {
duke@1 273 if (targetString == null && !source.allowGenerics()) {
duke@1 274 options.put("-target", Target.JDK1_4.name);
duke@1 275 }
duke@1 276 }
duke@1 277 }
duke@1 278 return filenames.toList();
duke@1 279 }
duke@1 280 // where
duke@1 281 private boolean checkDirectory(String optName) {
duke@1 282 String value = options.get(optName);
duke@1 283 if (value == null)
duke@1 284 return true;
duke@1 285 File file = new File(value);
duke@1 286 if (!file.exists()) {
duke@1 287 error("err.dir.not.found", value);
duke@1 288 return false;
duke@1 289 }
duke@1 290 if (!file.isDirectory()) {
duke@1 291 error("err.file.not.directory", value);
duke@1 292 return false;
duke@1 293 }
duke@1 294 return true;
duke@1 295 }
duke@1 296
duke@1 297 /** Programmatic interface for main function.
duke@1 298 * @param args The command line parameters.
duke@1 299 */
duke@1 300 public int compile(String[] args) {
duke@1 301 Context context = new Context();
duke@1 302 JavacFileManager.preRegister(context); // can't create it until Log has been set up
duke@1 303 int result = compile(args, context);
duke@1 304 if (fileManager instanceof JavacFileManager) {
duke@1 305 // A fresh context was created above, so jfm must be a JavacFileManager
duke@1 306 ((JavacFileManager)fileManager).close();
duke@1 307 }
duke@1 308 return result;
duke@1 309 }
duke@1 310
duke@1 311 public int compile(String[] args, Context context) {
duke@1 312 return compile(args, context, List.<JavaFileObject>nil(), null);
duke@1 313 }
duke@1 314
duke@1 315 /** Programmatic interface for main function.
duke@1 316 * @param args The command line parameters.
duke@1 317 */
duke@1 318 public int compile(String[] args,
duke@1 319 Context context,
duke@1 320 List<JavaFileObject> fileObjects,
duke@1 321 Iterable<? extends Processor> processors)
duke@1 322 {
duke@1 323 if (options == null)
duke@1 324 options = Options.instance(context); // creates a new one
duke@1 325
duke@1 326 filenames = new ListBuffer<File>();
duke@1 327 classnames = new ListBuffer<String>();
duke@1 328 JavaCompiler comp = null;
duke@1 329 /*
duke@1 330 * TODO: Logic below about what is an acceptable command line
duke@1 331 * should be updated to take annotation processing semantics
duke@1 332 * into account.
duke@1 333 */
duke@1 334 try {
duke@1 335 if (args.length == 0 && fileObjects.isEmpty()) {
duke@1 336 help();
duke@1 337 return EXIT_CMDERR;
duke@1 338 }
duke@1 339
duke@1 340 List<File> filenames;
duke@1 341 try {
duke@1 342 filenames = processArgs(CommandLine.parse(args));
duke@1 343 if (filenames == null) {
duke@1 344 // null signals an error in options, abort
duke@1 345 return EXIT_CMDERR;
duke@1 346 } else if (filenames.isEmpty() && fileObjects.isEmpty() && classnames.isEmpty()) {
duke@1 347 // it is allowed to compile nothing if just asking for help or version info
duke@1 348 if (options.get("-help") != null
duke@1 349 || options.get("-X") != null
duke@1 350 || options.get("-version") != null
duke@1 351 || options.get("-fullversion") != null)
duke@1 352 return EXIT_OK;
duke@1 353 error("err.no.source.files");
duke@1 354 return EXIT_CMDERR;
duke@1 355 }
duke@1 356 } catch (java.io.FileNotFoundException e) {
duke@1 357 Log.printLines(out, ownName + ": " +
duke@1 358 getLocalizedString("err.file.not.found",
duke@1 359 e.getMessage()));
duke@1 360 return EXIT_SYSERR;
duke@1 361 }
duke@1 362
duke@1 363 boolean forceStdOut = options.get("stdout") != null;
duke@1 364 if (forceStdOut) {
duke@1 365 out.flush();
duke@1 366 out = new PrintWriter(System.out, true);
duke@1 367 }
duke@1 368
duke@1 369 context.put(Log.outKey, out);
duke@1 370
duke@1 371 fileManager = context.get(JavaFileManager.class);
duke@1 372
duke@1 373 comp = JavaCompiler.instance(context);
duke@1 374 if (comp == null) return EXIT_SYSERR;
duke@1 375
duke@1 376 if (!filenames.isEmpty()) {
duke@1 377 // add filenames to fileObjects
duke@1 378 comp = JavaCompiler.instance(context);
duke@1 379 List<JavaFileObject> otherFiles = List.nil();
duke@1 380 JavacFileManager dfm = (JavacFileManager)fileManager;
duke@1 381 for (JavaFileObject fo : dfm.getJavaFileObjectsFromFiles(filenames))
duke@1 382 otherFiles = otherFiles.prepend(fo);
duke@1 383 for (JavaFileObject fo : otherFiles)
duke@1 384 fileObjects = fileObjects.prepend(fo);
duke@1 385 }
duke@1 386 comp.compile(fileObjects,
duke@1 387 classnames.toList(),
duke@1 388 processors);
duke@1 389
duke@1 390 if (comp.errorCount() != 0 ||
duke@1 391 options.get("-Werror") != null && comp.warningCount() != 0)
duke@1 392 return EXIT_ERROR;
duke@1 393 } catch (IOException ex) {
duke@1 394 ioMessage(ex);
duke@1 395 return EXIT_SYSERR;
duke@1 396 } catch (OutOfMemoryError ex) {
duke@1 397 resourceMessage(ex);
duke@1 398 return EXIT_SYSERR;
duke@1 399 } catch (StackOverflowError ex) {
duke@1 400 resourceMessage(ex);
duke@1 401 return EXIT_SYSERR;
duke@1 402 } catch (FatalError ex) {
duke@1 403 feMessage(ex);
duke@1 404 return EXIT_SYSERR;
duke@1 405 } catch(AnnotationProcessingError ex) {
duke@1 406 apMessage(ex);
duke@1 407 return EXIT_SYSERR;
duke@1 408 } catch (ClientCodeException ex) {
duke@1 409 // as specified by javax.tools.JavaCompiler#getTask
duke@1 410 // and javax.tools.JavaCompiler.CompilationTask#call
duke@1 411 throw new RuntimeException(ex.getCause());
duke@1 412 } catch (PropagatedException ex) {
duke@1 413 throw ex.getCause();
duke@1 414 } catch (Throwable ex) {
duke@1 415 // Nasty. If we've already reported an error, compensate
duke@1 416 // for buggy compiler error recovery by swallowing thrown
duke@1 417 // exceptions.
duke@1 418 if (comp == null || comp.errorCount() == 0 ||
duke@1 419 options == null || options.get("dev") != null)
duke@1 420 bugMessage(ex);
duke@1 421 return EXIT_ABNORMAL;
duke@1 422 } finally {
duke@1 423 if (comp != null) comp.close();
duke@1 424 filenames = null;
duke@1 425 options = null;
duke@1 426 }
duke@1 427 return EXIT_OK;
duke@1 428 }
duke@1 429
duke@1 430 /** Print a message reporting an internal error.
duke@1 431 */
duke@1 432 void bugMessage(Throwable ex) {
duke@1 433 Log.printLines(out, getLocalizedString("msg.bug",
duke@1 434 JavaCompiler.version()));
duke@1 435 ex.printStackTrace(out);
duke@1 436 }
duke@1 437
duke@1 438 /** Print a message reporting an fatal error.
duke@1 439 */
duke@1 440 void feMessage(Throwable ex) {
duke@1 441 Log.printLines(out, ex.getMessage());
duke@1 442 }
duke@1 443
duke@1 444 /** Print a message reporting an input/output error.
duke@1 445 */
duke@1 446 void ioMessage(Throwable ex) {
duke@1 447 Log.printLines(out, getLocalizedString("msg.io"));
duke@1 448 ex.printStackTrace(out);
duke@1 449 }
duke@1 450
duke@1 451 /** Print a message reporting an out-of-resources error.
duke@1 452 */
duke@1 453 void resourceMessage(Throwable ex) {
duke@1 454 Log.printLines(out, getLocalizedString("msg.resource"));
duke@1 455 // System.out.println("(name buffer len = " + Name.names.length + " " + Name.nc);//DEBUG
duke@1 456 ex.printStackTrace(out);
duke@1 457 }
duke@1 458
duke@1 459 /** Print a message reporting an uncaught exception from an
duke@1 460 * annotation processor.
duke@1 461 */
duke@1 462 void apMessage(AnnotationProcessingError ex) {
duke@1 463 Log.printLines(out,
duke@1 464 getLocalizedString("msg.proc.annotation.uncaught.exception"));
duke@1 465 ex.getCause().printStackTrace();
duke@1 466 }
duke@1 467
duke@1 468 private JavaFileManager fileManager;
duke@1 469
duke@1 470 /* ************************************************************************
duke@1 471 * Internationalization
duke@1 472 *************************************************************************/
duke@1 473
duke@1 474 /** Find a localized string in the resource bundle.
duke@1 475 * @param key The key for the localized string.
duke@1 476 */
duke@1 477 public static String getLocalizedString(String key, Object... args) { // FIXME sb private
duke@1 478 try {
duke@1 479 if (messages == null)
duke@1 480 messages = new Messages(javacBundleName);
duke@1 481 return messages.getLocalizedString("javac." + key, args);
duke@1 482 }
duke@1 483 catch (MissingResourceException e) {
duke@1 484 throw new Error("Fatal Error: Resource for javac is missing", e);
duke@1 485 }
duke@1 486 }
duke@1 487
duke@1 488 public static void useRawMessages(boolean enable) {
duke@1 489 if (enable) {
duke@1 490 messages = new Messages(javacBundleName) {
duke@1 491 public String getLocalizedString(String key, Object... args) {
duke@1 492 return key;
duke@1 493 }
duke@1 494 };
duke@1 495 } else {
duke@1 496 messages = new Messages(javacBundleName);
duke@1 497 }
duke@1 498 }
duke@1 499
duke@1 500 private static final String javacBundleName =
duke@1 501 "com.sun.tools.javac.resources.javac";
duke@1 502
duke@1 503 private static Messages messages;
duke@1 504 }

mercurial