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

Wed, 02 Jul 2008 12:56:02 -0700

author
xdono
date
Wed, 02 Jul 2008 12:56:02 -0700
changeset 54
eaf608c64fec
parent 50
b9bcea8bbe24
child 70
62fcf8d73dc5
permissions
-rw-r--r--

6719955: Update copyright year
Summary: Update copyright year for files that have been modified in 2008
Reviewed-by: ohair, tbell

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

mercurial