src/share/classes/com/sun/tools/javac/api/JavacTaskImpl.java

Tue, 23 Sep 2008 10:44:51 -0700

author
jjg
date
Tue, 23 Sep 2008 10:44:51 -0700
changeset 119
1e83972f53fb
parent 111
a92b756a888f
child 136
8eafba4f61be
permissions
-rw-r--r--

6420151: need to improve byfile compile policy to eliminate footprint issues
Reviewed-by: mcimadamore

duke@1 1 /*
xdono@54 2 * Copyright 2005-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.api;
duke@1 27
duke@1 28 import java.io.File;
duke@1 29 import java.io.IOException;
jjg@111 30 import java.nio.CharBuffer;
duke@1 31 import java.util.*;
duke@1 32 import java.util.concurrent.atomic.AtomicBoolean;
duke@1 33
duke@1 34 import javax.annotation.processing.Processor;
duke@1 35 import javax.lang.model.element.Element;
duke@1 36 import javax.lang.model.element.TypeElement;
duke@1 37 import javax.lang.model.type.TypeMirror;
duke@1 38 import javax.tools.*;
duke@1 39
duke@1 40 import com.sun.source.tree.*;
duke@1 41 import com.sun.source.util.*;
duke@1 42 import com.sun.tools.javac.code.*;
duke@1 43 import com.sun.tools.javac.code.Symbol.*;
duke@1 44 import com.sun.tools.javac.comp.*;
jjg@50 45 import com.sun.tools.javac.file.JavacFileManager;
duke@1 46 import com.sun.tools.javac.main.*;
duke@1 47 import com.sun.tools.javac.model.*;
duke@1 48 import com.sun.tools.javac.parser.Parser;
jjg@111 49 import com.sun.tools.javac.parser.ParserFactory;
duke@1 50 import com.sun.tools.javac.tree.*;
duke@1 51 import com.sun.tools.javac.tree.JCTree.*;
duke@1 52 import com.sun.tools.javac.util.*;
duke@1 53 import com.sun.tools.javac.util.List;
duke@1 54 import com.sun.tools.javac.main.JavaCompiler;
duke@1 55
duke@1 56 /**
duke@1 57 * Provides access to functionality specific to the Sun Java Compiler, javac.
duke@1 58 *
duke@1 59 * <p><b>This is NOT part of any API supported by Sun Microsystems.
duke@1 60 * If you write code that depends on this, you do so at your own
duke@1 61 * risk. This code and its internal interfaces are subject to change
duke@1 62 * or deletion without notice.</b></p>
duke@1 63 *
duke@1 64 * @author Peter von der Ah&eacute;
duke@1 65 * @author Jonathan Gibbons
duke@1 66 */
duke@1 67 public class JavacTaskImpl extends JavacTask {
duke@1 68 private JavacTool tool;
duke@1 69 private Main compilerMain;
duke@1 70 private JavaCompiler compiler;
duke@1 71 private String[] args;
duke@1 72 private Context context;
duke@1 73 private List<JavaFileObject> fileObjects;
duke@1 74 private Map<JavaFileObject, JCCompilationUnit> notYetEntered;
duke@1 75 private ListBuffer<Env<AttrContext>> genList;
duke@1 76 private TaskListener taskListener;
duke@1 77 private AtomicBoolean used = new AtomicBoolean();
duke@1 78 private Iterable<? extends Processor> processors;
duke@1 79
duke@1 80 private Integer result = null;
duke@1 81
duke@1 82 JavacTaskImpl(JavacTool tool,
duke@1 83 Main compilerMain,
duke@1 84 String[] args,
duke@1 85 Context context,
duke@1 86 List<JavaFileObject> fileObjects) {
duke@1 87 this.tool = tool;
duke@1 88 this.compilerMain = compilerMain;
duke@1 89 this.args = args;
duke@1 90 this.context = context;
duke@1 91 this.fileObjects = fileObjects;
duke@1 92 // null checks
duke@1 93 compilerMain.getClass();
duke@1 94 args.getClass();
duke@1 95 context.getClass();
duke@1 96 fileObjects.getClass();
jjg@111 97
jjg@111 98 // force the use of the scanner that captures Javadoc comments
jjg@111 99 com.sun.tools.javac.parser.DocCommentScanner.Factory.preRegister(context);
duke@1 100 }
duke@1 101
duke@1 102 JavacTaskImpl(JavacTool tool,
duke@1 103 Main compilerMain,
duke@1 104 Iterable<String> flags,
duke@1 105 Context context,
duke@1 106 Iterable<String> classes,
duke@1 107 Iterable<? extends JavaFileObject> fileObjects) {
duke@1 108 this(tool, compilerMain, toArray(flags, classes), context, toList(fileObjects));
duke@1 109 }
duke@1 110
duke@1 111 static private String[] toArray(Iterable<String> flags, Iterable<String> classes) {
duke@1 112 ListBuffer<String> result = new ListBuffer<String>();
duke@1 113 if (flags != null)
duke@1 114 for (String flag : flags)
duke@1 115 result.append(flag);
duke@1 116 if (classes != null)
duke@1 117 for (String cls : classes)
duke@1 118 result.append(cls);
duke@1 119 return result.toArray(new String[result.length()]);
duke@1 120 }
duke@1 121
duke@1 122 static private List<JavaFileObject> toList(Iterable<? extends JavaFileObject> fileObjects) {
duke@1 123 if (fileObjects == null)
duke@1 124 return List.nil();
duke@1 125 ListBuffer<JavaFileObject> result = new ListBuffer<JavaFileObject>();
duke@1 126 for (JavaFileObject fo : fileObjects)
duke@1 127 result.append(fo);
duke@1 128 return result.toList();
duke@1 129 }
duke@1 130
duke@1 131 public Boolean call() {
duke@1 132 if (!used.getAndSet(true)) {
duke@1 133 beginContext();
duke@1 134 try {
duke@1 135 compilerMain.setFatalErrors(true);
duke@1 136 result = compilerMain.compile(args, context, fileObjects, processors);
duke@1 137 } finally {
duke@1 138 endContext();
duke@1 139 }
duke@1 140 compilerMain = null;
duke@1 141 args = null;
duke@1 142 context = null;
duke@1 143 fileObjects = null;
duke@1 144 return result == 0;
duke@1 145 } else {
duke@1 146 throw new IllegalStateException("multiple calls to method 'call'");
duke@1 147 }
duke@1 148 }
duke@1 149
duke@1 150 public void setProcessors(Iterable<? extends Processor> processors) {
duke@1 151 processors.getClass(); // null check
duke@1 152 // not mt-safe
duke@1 153 if (used.get())
duke@1 154 throw new IllegalStateException();
duke@1 155 this.processors = processors;
duke@1 156 }
duke@1 157
duke@1 158 public void setLocale(Locale locale) {
duke@1 159 // locale argument is ignored, see RFE 6443132
duke@1 160 if (used.get())
duke@1 161 throw new IllegalStateException();
duke@1 162 }
duke@1 163
duke@1 164 private void prepareCompiler() throws IOException {
duke@1 165 if (!used.getAndSet(true)) {
duke@1 166 beginContext();
duke@1 167 compilerMain.setOptions(Options.instance(context));
duke@1 168 compilerMain.filenames = new ListBuffer<File>();
duke@1 169 List<File> filenames = compilerMain.processArgs(CommandLine.parse(args));
duke@1 170 if (!filenames.isEmpty())
duke@1 171 throw new IllegalArgumentException("Malformed arguments " + filenames.toString(" "));
duke@1 172 compiler = JavaCompiler.instance(context);
duke@1 173 compiler.keepComments = true;
duke@1 174 compiler.genEndPos = true;
duke@1 175 // NOTE: this value will be updated after annotation processing
duke@1 176 compiler.initProcessAnnotations(processors);
duke@1 177 notYetEntered = new HashMap<JavaFileObject, JCCompilationUnit>();
duke@1 178 for (JavaFileObject file: fileObjects)
duke@1 179 notYetEntered.put(file, null);
duke@1 180 genList = new ListBuffer<Env<AttrContext>>();
duke@1 181 // endContext will be called when all classes have been generated
duke@1 182 // TODO: should handle the case after each phase if errors have occurred
duke@1 183 args = null;
duke@1 184 }
duke@1 185 }
duke@1 186
duke@1 187 private void beginContext() {
duke@1 188 context.put(JavacTaskImpl.class, this);
duke@1 189 if (context.get(TaskListener.class) != null)
duke@1 190 context.put(TaskListener.class, (TaskListener)null);
duke@1 191 if (taskListener != null)
duke@1 192 context.put(TaskListener.class, wrap(taskListener));
duke@1 193 tool.beginContext(context);
duke@1 194 }
duke@1 195 // where
duke@1 196 private TaskListener wrap(final TaskListener tl) {
duke@1 197 tl.getClass(); // null check
duke@1 198 return new TaskListener() {
duke@1 199 public void started(TaskEvent e) {
duke@1 200 try {
duke@1 201 tl.started(e);
duke@1 202 } catch (Throwable t) {
duke@1 203 throw new ClientCodeException(t);
duke@1 204 }
duke@1 205 }
duke@1 206
duke@1 207 public void finished(TaskEvent e) {
duke@1 208 try {
duke@1 209 tl.finished(e);
duke@1 210 } catch (Throwable t) {
duke@1 211 throw new ClientCodeException(t);
duke@1 212 }
duke@1 213 }
duke@1 214
duke@1 215 };
duke@1 216 }
duke@1 217
duke@1 218 private void endContext() {
duke@1 219 tool.endContext();
duke@1 220 }
duke@1 221
duke@1 222 /**
duke@1 223 * Construct a JavaFileObject from the given file.
duke@1 224 *
duke@1 225 * <p><b>TODO: this method is useless here</b></p>
duke@1 226 *
duke@1 227 * @param file a file
duke@1 228 * @return a JavaFileObject from the standard file manager.
duke@1 229 */
duke@1 230 public JavaFileObject asJavaFileObject(File file) {
duke@1 231 JavacFileManager fm = (JavacFileManager)context.get(JavaFileManager.class);
duke@1 232 return fm.getRegularFile(file);
duke@1 233 }
duke@1 234
duke@1 235 public void setTaskListener(TaskListener taskListener) {
duke@1 236 this.taskListener = taskListener;
duke@1 237 }
duke@1 238
duke@1 239 /**
duke@1 240 * Parse the specified files returning a list of abstract syntax trees.
duke@1 241 *
duke@1 242 * @throws java.io.IOException TODO
duke@1 243 * @return a list of abstract syntax trees
duke@1 244 */
duke@1 245 public Iterable<? extends CompilationUnitTree> parse() throws IOException {
duke@1 246 try {
duke@1 247 prepareCompiler();
duke@1 248 List<JCCompilationUnit> units = compiler.parseFiles(fileObjects);
duke@1 249 for (JCCompilationUnit unit: units) {
duke@1 250 JavaFileObject file = unit.getSourceFile();
duke@1 251 if (notYetEntered.containsKey(file))
duke@1 252 notYetEntered.put(file, unit);
duke@1 253 }
duke@1 254 return units;
duke@1 255 }
duke@1 256 finally {
duke@1 257 parsed = true;
duke@1 258 if (compiler != null && compiler.log != null)
duke@1 259 compiler.log.flush();
duke@1 260 }
duke@1 261 }
duke@1 262
duke@1 263 private boolean parsed = false;
duke@1 264
duke@1 265 /**
duke@1 266 * Translate all the abstract syntax trees to elements.
duke@1 267 *
duke@1 268 * @throws IOException TODO
duke@1 269 * @return a list of elements corresponding to the top level
duke@1 270 * classes in the abstract syntax trees
duke@1 271 */
duke@1 272 public Iterable<? extends TypeElement> enter() throws IOException {
duke@1 273 return enter(null);
duke@1 274 }
duke@1 275
duke@1 276 /**
duke@1 277 * Translate the given abstract syntax trees to elements.
duke@1 278 *
duke@1 279 * @param trees a list of abstract syntax trees.
duke@1 280 * @throws java.io.IOException TODO
duke@1 281 * @return a list of elements corresponding to the top level
duke@1 282 * classes in the abstract syntax trees
duke@1 283 */
duke@1 284 public Iterable<? extends TypeElement> enter(Iterable<? extends CompilationUnitTree> trees)
duke@1 285 throws IOException
duke@1 286 {
duke@1 287 prepareCompiler();
duke@1 288
duke@1 289 ListBuffer<JCCompilationUnit> roots = null;
duke@1 290
duke@1 291 if (trees == null) {
duke@1 292 // If there are still files which were specified to be compiled
duke@1 293 // (i.e. in fileObjects) but which have not yet been entered,
duke@1 294 // then we make sure they have been parsed and add them to the
duke@1 295 // list to be entered.
duke@1 296 if (notYetEntered.size() > 0) {
duke@1 297 if (!parsed)
duke@1 298 parse(); // TODO would be nice to specify files needed to be parsed
duke@1 299 for (JavaFileObject file: fileObjects) {
duke@1 300 JCCompilationUnit unit = notYetEntered.remove(file);
duke@1 301 if (unit != null) {
duke@1 302 if (roots == null)
duke@1 303 roots = new ListBuffer<JCCompilationUnit>();
duke@1 304 roots.append(unit);
duke@1 305 }
duke@1 306 }
duke@1 307 notYetEntered.clear();
duke@1 308 }
duke@1 309 }
duke@1 310 else {
duke@1 311 for (CompilationUnitTree cu : trees) {
duke@1 312 if (cu instanceof JCCompilationUnit) {
duke@1 313 if (roots == null)
duke@1 314 roots = new ListBuffer<JCCompilationUnit>();
duke@1 315 roots.append((JCCompilationUnit)cu);
duke@1 316 notYetEntered.remove(cu.getSourceFile());
duke@1 317 }
duke@1 318 else
duke@1 319 throw new IllegalArgumentException(cu.toString());
duke@1 320 }
duke@1 321 }
duke@1 322
duke@1 323 if (roots == null)
duke@1 324 return List.nil();
duke@1 325
duke@1 326 try {
duke@1 327 List<JCCompilationUnit> units = compiler.enterTrees(roots.toList());
duke@1 328
duke@1 329 if (notYetEntered.isEmpty())
duke@1 330 compiler = compiler.processAnnotations(units);
duke@1 331
duke@1 332 ListBuffer<TypeElement> elements = new ListBuffer<TypeElement>();
duke@1 333 for (JCCompilationUnit unit : units) {
duke@1 334 for (JCTree node : unit.defs)
duke@1 335 if (node.getTag() == JCTree.CLASSDEF)
duke@1 336 elements.append(((JCTree.JCClassDecl) node).sym);
duke@1 337 }
duke@1 338 return elements.toList();
duke@1 339 }
duke@1 340 finally {
duke@1 341 compiler.log.flush();
duke@1 342 }
duke@1 343 }
duke@1 344
duke@1 345 /**
duke@1 346 * Complete all analysis.
duke@1 347 * @throws IOException TODO
duke@1 348 */
duke@1 349 @Override
duke@1 350 public Iterable<? extends Element> analyze() throws IOException {
duke@1 351 return analyze(null);
duke@1 352 }
duke@1 353
duke@1 354 /**
duke@1 355 * Complete all analysis on the given classes.
duke@1 356 * This can be used to ensure that all compile time errors are reported.
duke@1 357 * The classes must have previously been returned from {@link #enter}.
duke@1 358 * If null is specified, all outstanding classes will be analyzed.
duke@1 359 *
duke@1 360 * @param classes a list of class elements
duke@1 361 */
duke@1 362 // This implementation requires that we open up privileges on JavaCompiler.
duke@1 363 // An alternative implementation would be to move this code to JavaCompiler and
duke@1 364 // wrap it here
duke@1 365 public Iterable<? extends Element> analyze(Iterable<? extends TypeElement> classes) throws IOException {
duke@1 366 enter(null); // ensure all classes have been entered
duke@1 367
duke@1 368 final ListBuffer<Element> results = new ListBuffer<Element>();
duke@1 369 try {
duke@1 370 if (classes == null) {
duke@1 371 handleFlowResults(compiler.flow(compiler.attribute(compiler.todo)), results);
duke@1 372 } else {
duke@1 373 Filter f = new Filter() {
duke@1 374 public void process(Env<AttrContext> env) {
duke@1 375 handleFlowResults(compiler.flow(compiler.attribute(env)), results);
duke@1 376 }
duke@1 377 };
duke@1 378 f.run(compiler.todo, classes);
duke@1 379 }
duke@1 380 } finally {
duke@1 381 compiler.log.flush();
duke@1 382 }
duke@1 383 return results;
duke@1 384 }
duke@1 385 // where
jjg@70 386 private void handleFlowResults(Queue<Env<AttrContext>> queue, ListBuffer<Element> elems) {
jjg@70 387 for (Env<AttrContext> env: queue) {
duke@1 388 switch (env.tree.getTag()) {
duke@1 389 case JCTree.CLASSDEF:
duke@1 390 JCClassDecl cdef = (JCClassDecl) env.tree;
duke@1 391 if (cdef.sym != null)
duke@1 392 elems.append(cdef.sym);
duke@1 393 break;
duke@1 394 case JCTree.TOPLEVEL:
duke@1 395 JCCompilationUnit unit = (JCCompilationUnit) env.tree;
duke@1 396 if (unit.packge != null)
duke@1 397 elems.append(unit.packge);
duke@1 398 break;
duke@1 399 }
duke@1 400 }
jjg@70 401 genList.addAll(queue);
duke@1 402 }
duke@1 403
duke@1 404
duke@1 405 /**
duke@1 406 * Generate code.
duke@1 407 * @throws IOException TODO
duke@1 408 */
duke@1 409 @Override
duke@1 410 public Iterable<? extends JavaFileObject> generate() throws IOException {
duke@1 411 return generate(null);
duke@1 412 }
duke@1 413
duke@1 414 /**
duke@1 415 * Generate code corresponding to the given classes.
duke@1 416 * The classes must have previously been returned from {@link #enter}.
duke@1 417 * If there are classes outstanding to be analyzed, that will be done before
duke@1 418 * any classes are generated.
duke@1 419 * If null is specified, code will be generated for all outstanding classes.
duke@1 420 *
duke@1 421 * @param classes a list of class elements
duke@1 422 */
duke@1 423 public Iterable<? extends JavaFileObject> generate(Iterable<? extends TypeElement> classes) throws IOException {
duke@1 424 final ListBuffer<JavaFileObject> results = new ListBuffer<JavaFileObject>();
duke@1 425 try {
duke@1 426 analyze(null); // ensure all classes have been parsed, entered, and analyzed
duke@1 427
duke@1 428 if (classes == null) {
jjg@70 429 compiler.generate(compiler.desugar(genList), results);
duke@1 430 genList.clear();
duke@1 431 }
duke@1 432 else {
duke@1 433 Filter f = new Filter() {
duke@1 434 public void process(Env<AttrContext> env) {
jjg@70 435 compiler.generate(compiler.desugar(ListBuffer.of(env)), results);
duke@1 436 }
duke@1 437 };
duke@1 438 f.run(genList, classes);
duke@1 439 }
duke@1 440 if (genList.isEmpty()) {
duke@1 441 compiler.reportDeferredDiagnostics();
duke@1 442 compiler.log.flush();
duke@1 443 endContext();
duke@1 444 }
duke@1 445 }
duke@1 446 finally {
duke@1 447 compiler.log.flush();
duke@1 448 }
duke@1 449 return results;
duke@1 450 }
duke@1 451
duke@1 452 public TypeMirror getTypeMirror(Iterable<? extends Tree> path) {
duke@1 453 // TODO: Should complete attribution if necessary
duke@1 454 Tree last = null;
duke@1 455 for (Tree node : path)
duke@1 456 last = node;
duke@1 457 return ((JCTree)last).type;
duke@1 458 }
duke@1 459
duke@1 460 public JavacElements getElements() {
duke@1 461 if (context == null)
duke@1 462 throw new IllegalStateException();
duke@1 463 return JavacElements.instance(context);
duke@1 464 }
duke@1 465
duke@1 466 public JavacTypes getTypes() {
duke@1 467 if (context == null)
duke@1 468 throw new IllegalStateException();
duke@1 469 return JavacTypes.instance(context);
duke@1 470 }
duke@1 471
duke@1 472 public Iterable<? extends Tree> pathFor(CompilationUnitTree unit, Tree node) {
duke@1 473 return TreeInfo.pathFor((JCTree) node, (JCTree.JCCompilationUnit) unit).reverse();
duke@1 474 }
duke@1 475
duke@1 476 abstract class Filter {
jjg@119 477 void run(Queue<Env<AttrContext>> list, Iterable<? extends TypeElement> classes) {
duke@1 478 Set<TypeElement> set = new HashSet<TypeElement>();
duke@1 479 for (TypeElement item: classes)
duke@1 480 set.add(item);
duke@1 481
jjg@119 482 ListBuffer<Env<AttrContext>> defer = ListBuffer.<Env<AttrContext>>lb();
jjg@119 483 while (list.peek() != null) {
jjg@119 484 Env<AttrContext> env = list.remove();
duke@1 485 ClassSymbol csym = env.enclClass.sym;
duke@1 486 if (csym != null && set.contains(csym.outermostClass()))
duke@1 487 process(env);
duke@1 488 else
jjg@119 489 defer = defer.append(env);
duke@1 490 }
duke@1 491
jjg@119 492 list.addAll(defer);
duke@1 493 }
duke@1 494
duke@1 495 abstract void process(Env<AttrContext> env);
duke@1 496 }
duke@1 497
duke@1 498 /**
duke@1 499 * For internal use by Sun Microsystems only. This method will be
duke@1 500 * removed without warning.
duke@1 501 */
duke@1 502 public Context getContext() {
duke@1 503 return context;
duke@1 504 }
duke@1 505
duke@1 506 /**
duke@1 507 * For internal use by Sun Microsystems only. This method will be
duke@1 508 * removed without warning.
duke@1 509 */
duke@1 510 public void updateContext(Context newContext) {
duke@1 511 context = newContext;
duke@1 512 }
duke@1 513
duke@1 514 /**
duke@1 515 * For internal use by Sun Microsystems only. This method will be
duke@1 516 * removed without warning.
duke@1 517 */
duke@1 518 public Type parseType(String expr, TypeElement scope) {
duke@1 519 if (expr == null || expr.equals(""))
duke@1 520 throw new IllegalArgumentException();
duke@1 521 compiler = JavaCompiler.instance(context);
duke@1 522 JavaFileObject prev = compiler.log.useSource(null);
jjg@111 523 ParserFactory parserFactory = ParserFactory.instance(context);
duke@1 524 Attr attr = Attr.instance(context);
duke@1 525 try {
jjg@111 526 CharBuffer buf = CharBuffer.wrap((expr+"\u0000").toCharArray(), 0, expr.length());
jjg@111 527 Parser parser = parserFactory.newParser(buf, false, false, false);
jjg@111 528 JCTree tree = parser.parseType();
duke@1 529 return attr.attribType(tree, (Symbol.TypeSymbol)scope);
duke@1 530 } finally {
duke@1 531 compiler.log.useSource(prev);
duke@1 532 }
duke@1 533 }
duke@1 534
duke@1 535 }

mercurial