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

Mon, 17 Dec 2012 07:47:05 -0800

author
jjg
date
Mon, 17 Dec 2012 07:47:05 -0800
changeset 1455
75ab654b5cd5
parent 1416
c0f0c41cafa0
child 1569
475eb15dfdad
child 1591
dc8b7aa7cef3
permissions
-rw-r--r--

8004832: Add new doclint package
Reviewed-by: mcimadamore

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

mercurial