Wed, 20 Jun 2012 13:23:26 -0700
7174143: encapsulate doc comment table
Reviewed-by: ksrini, mcimadamore
duke@1 | 1 | /* |
jjg@1092 | 2 | * Copyright (c) 2005, 2011, 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.processing; |
duke@1 | 27 | |
duke@1 | 28 | import java.io.Closeable; |
jjg@655 | 29 | import java.io.FileNotFoundException; |
duke@1 | 30 | import java.io.InputStream; |
duke@1 | 31 | import java.io.OutputStream; |
duke@1 | 32 | import java.io.FilterOutputStream; |
duke@1 | 33 | import java.io.Reader; |
duke@1 | 34 | import java.io.Writer; |
duke@1 | 35 | import java.io.FilterWriter; |
duke@1 | 36 | import java.io.PrintWriter; |
duke@1 | 37 | import java.io.IOException; |
jjg@700 | 38 | import java.util.*; |
duke@1 | 39 | |
duke@1 | 40 | import static java.util.Collections.*; |
duke@1 | 41 | |
jjg@700 | 42 | import javax.annotation.processing.*; |
jjg@700 | 43 | import javax.lang.model.SourceVersion; |
jjg@700 | 44 | import javax.lang.model.element.NestingKind; |
jjg@700 | 45 | import javax.lang.model.element.Modifier; |
jjg@700 | 46 | import javax.lang.model.element.Element; |
jjg@700 | 47 | import javax.tools.*; |
duke@1 | 48 | import javax.tools.JavaFileManager.Location; |
jjg@700 | 49 | |
duke@1 | 50 | import static javax.tools.StandardLocation.SOURCE_OUTPUT; |
duke@1 | 51 | import static javax.tools.StandardLocation.CLASS_OUTPUT; |
duke@1 | 52 | |
jjg@700 | 53 | import com.sun.tools.javac.code.Lint; |
jjg@700 | 54 | import com.sun.tools.javac.util.*; |
jjg@700 | 55 | |
jjg@700 | 56 | import static com.sun.tools.javac.code.Lint.LintCategory.PROCESSING; |
jjg@700 | 57 | |
duke@1 | 58 | /** |
duke@1 | 59 | * The FilerImplementation class must maintain a number of |
duke@1 | 60 | * constraints. First, multiple attempts to open the same path within |
duke@1 | 61 | * the same invocation of the tool results in an IOException being |
duke@1 | 62 | * thrown. For example, trying to open the same source file twice: |
duke@1 | 63 | * |
duke@1 | 64 | * <pre> |
duke@1 | 65 | * createSourceFile("foo.Bar") |
duke@1 | 66 | * ... |
duke@1 | 67 | * createSourceFile("foo.Bar") |
duke@1 | 68 | * </pre> |
duke@1 | 69 | * |
duke@1 | 70 | * is disallowed as is opening a text file that happens to have |
duke@1 | 71 | * the same name as a source file: |
duke@1 | 72 | * |
duke@1 | 73 | * <pre> |
duke@1 | 74 | * createSourceFile("foo.Bar") |
duke@1 | 75 | * ... |
duke@1 | 76 | * createTextFile(SOURCE_TREE, "foo", new File("Bar"), null) |
duke@1 | 77 | * </pre> |
duke@1 | 78 | * |
duke@1 | 79 | * <p>Additionally, creating a source file that corresponds to an |
duke@1 | 80 | * already created class file (or vice versa) also results in an |
duke@1 | 81 | * IOException since each type can only be created once. However, if |
duke@1 | 82 | * the Filer is used to create a text file named *.java that happens |
duke@1 | 83 | * to correspond to an existing class file, a warning is *not* |
duke@1 | 84 | * generated. Similarly, a warning is not generated for a binary file |
duke@1 | 85 | * named *.class and an existing source file. |
duke@1 | 86 | * |
duke@1 | 87 | * <p>The reason for this difference is that source files and class |
duke@1 | 88 | * files are registered with the tool and can get passed on as |
duke@1 | 89 | * declarations to the next round of processing. Files that are just |
duke@1 | 90 | * named *.java and *.class are not processed in that manner; although |
duke@1 | 91 | * having extra source files and class files on the source path and |
duke@1 | 92 | * class path can alter the behavior of the tool and any final |
duke@1 | 93 | * compile. |
duke@1 | 94 | * |
jjg@581 | 95 | * <p><b>This is NOT part of any supported API. |
duke@1 | 96 | * If you write code that depends on this, you do so at your own risk. |
duke@1 | 97 | * This code and its internal interfaces are subject to change or |
duke@1 | 98 | * deletion without notice.</b> |
duke@1 | 99 | */ |
duke@1 | 100 | public class JavacFiler implements Filer, Closeable { |
duke@1 | 101 | // TODO: Implement different transaction model for updating the |
duke@1 | 102 | // Filer's record keeping on file close. |
duke@1 | 103 | |
duke@1 | 104 | private static final String ALREADY_OPENED = |
duke@1 | 105 | "Output stream or writer has already been opened."; |
duke@1 | 106 | private static final String NOT_FOR_READING = |
duke@1 | 107 | "FileObject was not opened for reading."; |
duke@1 | 108 | private static final String NOT_FOR_WRITING = |
duke@1 | 109 | "FileObject was not opened for writing."; |
duke@1 | 110 | |
duke@1 | 111 | /** |
duke@1 | 112 | * Wrap a JavaFileObject to manage writing by the Filer. |
duke@1 | 113 | */ |
duke@1 | 114 | private class FilerOutputFileObject extends ForwardingFileObject<FileObject> { |
duke@1 | 115 | private boolean opened = false; |
duke@1 | 116 | private String name; |
duke@1 | 117 | |
duke@1 | 118 | FilerOutputFileObject(String name, FileObject fileObject) { |
duke@1 | 119 | super(fileObject); |
duke@1 | 120 | this.name = name; |
duke@1 | 121 | } |
duke@1 | 122 | |
duke@1 | 123 | @Override |
duke@1 | 124 | public synchronized OutputStream openOutputStream() throws IOException { |
duke@1 | 125 | if (opened) |
duke@1 | 126 | throw new IOException(ALREADY_OPENED); |
duke@1 | 127 | opened = true; |
duke@1 | 128 | return new FilerOutputStream(name, fileObject); |
duke@1 | 129 | } |
duke@1 | 130 | |
duke@1 | 131 | @Override |
duke@1 | 132 | public synchronized Writer openWriter() throws IOException { |
duke@1 | 133 | if (opened) |
duke@1 | 134 | throw new IOException(ALREADY_OPENED); |
duke@1 | 135 | opened = true; |
duke@1 | 136 | return new FilerWriter(name, fileObject); |
duke@1 | 137 | } |
duke@1 | 138 | |
duke@1 | 139 | // Three anti-literacy methods |
duke@1 | 140 | @Override |
duke@1 | 141 | public InputStream openInputStream() throws IOException { |
duke@1 | 142 | throw new IllegalStateException(NOT_FOR_READING); |
duke@1 | 143 | } |
duke@1 | 144 | |
duke@1 | 145 | @Override |
duke@1 | 146 | public Reader openReader(boolean ignoreEncodingErrors) throws IOException { |
duke@1 | 147 | throw new IllegalStateException(NOT_FOR_READING); |
duke@1 | 148 | } |
duke@1 | 149 | |
duke@1 | 150 | @Override |
duke@1 | 151 | public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException { |
duke@1 | 152 | throw new IllegalStateException(NOT_FOR_READING); |
duke@1 | 153 | } |
duke@1 | 154 | |
duke@1 | 155 | @Override |
duke@1 | 156 | public boolean delete() { |
duke@1 | 157 | return false; |
duke@1 | 158 | } |
duke@1 | 159 | } |
duke@1 | 160 | |
duke@1 | 161 | private class FilerOutputJavaFileObject extends FilerOutputFileObject implements JavaFileObject { |
duke@1 | 162 | private final JavaFileObject javaFileObject; |
duke@1 | 163 | FilerOutputJavaFileObject(String name, JavaFileObject javaFileObject) { |
duke@1 | 164 | super(name, javaFileObject); |
duke@1 | 165 | this.javaFileObject = javaFileObject; |
duke@1 | 166 | } |
duke@1 | 167 | |
duke@1 | 168 | public JavaFileObject.Kind getKind() { |
duke@1 | 169 | return javaFileObject.getKind(); |
duke@1 | 170 | } |
duke@1 | 171 | |
duke@1 | 172 | public boolean isNameCompatible(String simpleName, |
duke@1 | 173 | JavaFileObject.Kind kind) { |
duke@1 | 174 | return javaFileObject.isNameCompatible(simpleName, kind); |
duke@1 | 175 | } |
duke@1 | 176 | |
duke@1 | 177 | public NestingKind getNestingKind() { |
duke@1 | 178 | return javaFileObject.getNestingKind(); |
duke@1 | 179 | } |
duke@1 | 180 | |
duke@1 | 181 | public Modifier getAccessLevel() { |
duke@1 | 182 | return javaFileObject.getAccessLevel(); |
duke@1 | 183 | } |
duke@1 | 184 | } |
duke@1 | 185 | |
duke@1 | 186 | /** |
duke@1 | 187 | * Wrap a JavaFileObject to manage reading by the Filer. |
duke@1 | 188 | */ |
duke@1 | 189 | private class FilerInputFileObject extends ForwardingFileObject<FileObject> { |
duke@1 | 190 | FilerInputFileObject(FileObject fileObject) { |
duke@1 | 191 | super(fileObject); |
duke@1 | 192 | } |
duke@1 | 193 | |
duke@1 | 194 | @Override |
duke@1 | 195 | public OutputStream openOutputStream() throws IOException { |
duke@1 | 196 | throw new IllegalStateException(NOT_FOR_WRITING); |
duke@1 | 197 | } |
duke@1 | 198 | |
duke@1 | 199 | @Override |
duke@1 | 200 | public Writer openWriter() throws IOException { |
duke@1 | 201 | throw new IllegalStateException(NOT_FOR_WRITING); |
duke@1 | 202 | } |
duke@1 | 203 | |
duke@1 | 204 | @Override |
duke@1 | 205 | public boolean delete() { |
duke@1 | 206 | return false; |
duke@1 | 207 | } |
duke@1 | 208 | } |
duke@1 | 209 | |
duke@1 | 210 | private class FilerInputJavaFileObject extends FilerInputFileObject implements JavaFileObject { |
duke@1 | 211 | private final JavaFileObject javaFileObject; |
duke@1 | 212 | FilerInputJavaFileObject(JavaFileObject javaFileObject) { |
duke@1 | 213 | super(javaFileObject); |
duke@1 | 214 | this.javaFileObject = javaFileObject; |
duke@1 | 215 | } |
duke@1 | 216 | |
duke@1 | 217 | public JavaFileObject.Kind getKind() { |
duke@1 | 218 | return javaFileObject.getKind(); |
duke@1 | 219 | } |
duke@1 | 220 | |
duke@1 | 221 | public boolean isNameCompatible(String simpleName, |
duke@1 | 222 | JavaFileObject.Kind kind) { |
duke@1 | 223 | return javaFileObject.isNameCompatible(simpleName, kind); |
duke@1 | 224 | } |
duke@1 | 225 | |
duke@1 | 226 | public NestingKind getNestingKind() { |
duke@1 | 227 | return javaFileObject.getNestingKind(); |
duke@1 | 228 | } |
duke@1 | 229 | |
duke@1 | 230 | public Modifier getAccessLevel() { |
duke@1 | 231 | return javaFileObject.getAccessLevel(); |
duke@1 | 232 | } |
duke@1 | 233 | } |
duke@1 | 234 | |
duke@1 | 235 | |
duke@1 | 236 | /** |
duke@1 | 237 | * Wrap a {@code OutputStream} returned from the {@code |
duke@1 | 238 | * JavaFileManager} to properly register source or class files |
duke@1 | 239 | * when they are closed. |
duke@1 | 240 | */ |
duke@1 | 241 | private class FilerOutputStream extends FilterOutputStream { |
duke@1 | 242 | String typeName; |
duke@1 | 243 | FileObject fileObject; |
duke@1 | 244 | boolean closed = false; |
duke@1 | 245 | |
duke@1 | 246 | /** |
duke@1 | 247 | * @param typeName name of class or {@code null} if just a |
duke@1 | 248 | * binary file |
duke@1 | 249 | */ |
duke@1 | 250 | FilerOutputStream(String typeName, FileObject fileObject) throws IOException { |
duke@1 | 251 | super(fileObject.openOutputStream()); |
duke@1 | 252 | this.typeName = typeName; |
duke@1 | 253 | this.fileObject = fileObject; |
duke@1 | 254 | } |
duke@1 | 255 | |
duke@1 | 256 | public synchronized void close() throws IOException { |
duke@1 | 257 | if (!closed) { |
duke@1 | 258 | closed = true; |
duke@1 | 259 | /* |
duke@1 | 260 | * If an IOException occurs when closing the underlying |
duke@1 | 261 | * stream, still try to process the file. |
duke@1 | 262 | */ |
duke@1 | 263 | |
duke@1 | 264 | closeFileObject(typeName, fileObject); |
duke@1 | 265 | out.close(); |
duke@1 | 266 | } |
duke@1 | 267 | } |
duke@1 | 268 | } |
duke@1 | 269 | |
duke@1 | 270 | /** |
duke@1 | 271 | * Wrap a {@code Writer} returned from the {@code JavaFileManager} |
duke@1 | 272 | * to properly register source or class files when they are |
duke@1 | 273 | * closed. |
duke@1 | 274 | */ |
duke@1 | 275 | private class FilerWriter extends FilterWriter { |
duke@1 | 276 | String typeName; |
duke@1 | 277 | FileObject fileObject; |
duke@1 | 278 | boolean closed = false; |
duke@1 | 279 | |
duke@1 | 280 | /** |
duke@1 | 281 | * @param fileObject the fileObject to be written to |
duke@1 | 282 | * @param typeName name of source file or {@code null} if just a |
duke@1 | 283 | * text file |
duke@1 | 284 | */ |
duke@1 | 285 | FilerWriter(String typeName, FileObject fileObject) throws IOException { |
duke@1 | 286 | super(fileObject.openWriter()); |
duke@1 | 287 | this.typeName = typeName; |
duke@1 | 288 | this.fileObject = fileObject; |
duke@1 | 289 | } |
duke@1 | 290 | |
duke@1 | 291 | public synchronized void close() throws IOException { |
duke@1 | 292 | if (!closed) { |
duke@1 | 293 | closed = true; |
duke@1 | 294 | /* |
duke@1 | 295 | * If an IOException occurs when closing the underlying |
duke@1 | 296 | * Writer, still try to process the file. |
duke@1 | 297 | */ |
duke@1 | 298 | |
duke@1 | 299 | closeFileObject(typeName, fileObject); |
duke@1 | 300 | out.close(); |
duke@1 | 301 | } |
duke@1 | 302 | } |
duke@1 | 303 | } |
duke@1 | 304 | |
duke@1 | 305 | JavaFileManager fileManager; |
duke@1 | 306 | Log log; |
duke@1 | 307 | Context context; |
duke@1 | 308 | boolean lastRound; |
duke@1 | 309 | |
duke@1 | 310 | private final boolean lint; |
duke@1 | 311 | |
duke@1 | 312 | /** |
duke@1 | 313 | * Logical names of all created files. This set must be |
duke@1 | 314 | * synchronized. |
duke@1 | 315 | */ |
duke@1 | 316 | private final Set<FileObject> fileObjectHistory; |
duke@1 | 317 | |
duke@1 | 318 | /** |
duke@1 | 319 | * Names of types that have had files created but not closed. |
duke@1 | 320 | */ |
duke@1 | 321 | private final Set<String> openTypeNames; |
duke@1 | 322 | |
duke@1 | 323 | /** |
duke@1 | 324 | * Names of source files closed in this round. This set must be |
duke@1 | 325 | * synchronized. Its iterators should preserve insertion order. |
duke@1 | 326 | */ |
duke@1 | 327 | private Set<String> generatedSourceNames; |
duke@1 | 328 | |
duke@1 | 329 | /** |
duke@1 | 330 | * Names and class files of the class files closed in this round. |
duke@1 | 331 | * This set must be synchronized. Its iterators should preserve |
duke@1 | 332 | * insertion order. |
duke@1 | 333 | */ |
duke@1 | 334 | private final Map<String, JavaFileObject> generatedClasses; |
duke@1 | 335 | |
duke@1 | 336 | /** |
duke@1 | 337 | * JavaFileObjects for source files closed in this round. This |
duke@1 | 338 | * set must be synchronized. Its iterators should preserve |
duke@1 | 339 | * insertion order. |
duke@1 | 340 | */ |
duke@1 | 341 | private Set<JavaFileObject> generatedSourceFileObjects; |
duke@1 | 342 | |
duke@1 | 343 | /** |
duke@1 | 344 | * Names of all created source files. Its iterators should |
duke@1 | 345 | * preserve insertion order. |
duke@1 | 346 | */ |
duke@1 | 347 | private final Set<String> aggregateGeneratedSourceNames; |
duke@1 | 348 | |
duke@1 | 349 | /** |
duke@1 | 350 | * Names of all created class files. Its iterators should |
duke@1 | 351 | * preserve insertion order. |
duke@1 | 352 | */ |
duke@1 | 353 | private final Set<String> aggregateGeneratedClassNames; |
duke@1 | 354 | |
duke@1 | 355 | |
duke@1 | 356 | JavacFiler(Context context) { |
duke@1 | 357 | this.context = context; |
duke@1 | 358 | fileManager = context.get(JavaFileManager.class); |
duke@1 | 359 | |
duke@1 | 360 | log = Log.instance(context); |
duke@1 | 361 | |
duke@1 | 362 | fileObjectHistory = synchronizedSet(new LinkedHashSet<FileObject>()); |
duke@1 | 363 | generatedSourceNames = synchronizedSet(new LinkedHashSet<String>()); |
duke@1 | 364 | generatedSourceFileObjects = synchronizedSet(new LinkedHashSet<JavaFileObject>()); |
duke@1 | 365 | |
duke@1 | 366 | generatedClasses = synchronizedMap(new LinkedHashMap<String, JavaFileObject>()); |
duke@1 | 367 | |
duke@1 | 368 | openTypeNames = synchronizedSet(new LinkedHashSet<String>()); |
duke@1 | 369 | |
duke@1 | 370 | aggregateGeneratedSourceNames = new LinkedHashSet<String>(); |
duke@1 | 371 | aggregateGeneratedClassNames = new LinkedHashSet<String>(); |
duke@1 | 372 | |
jjg@700 | 373 | lint = (Lint.instance(context)).isEnabled(PROCESSING); |
duke@1 | 374 | } |
duke@1 | 375 | |
duke@1 | 376 | public JavaFileObject createSourceFile(CharSequence name, |
duke@1 | 377 | Element... originatingElements) throws IOException { |
duke@1 | 378 | return createSourceOrClassFile(true, name.toString()); |
duke@1 | 379 | } |
duke@1 | 380 | |
duke@1 | 381 | public JavaFileObject createClassFile(CharSequence name, |
duke@1 | 382 | Element... originatingElements) throws IOException { |
duke@1 | 383 | return createSourceOrClassFile(false, name.toString()); |
duke@1 | 384 | } |
duke@1 | 385 | |
duke@1 | 386 | private JavaFileObject createSourceOrClassFile(boolean isSourceFile, String name) throws IOException { |
jjg@618 | 387 | if (lint) { |
jjg@618 | 388 | int periodIndex = name.lastIndexOf("."); |
jjg@618 | 389 | if (periodIndex != -1) { |
jjg@618 | 390 | String base = name.substring(periodIndex); |
jjg@618 | 391 | String extn = (isSourceFile ? ".java" : ".class"); |
jjg@618 | 392 | if (base.equals(extn)) |
jjg@618 | 393 | log.warning("proc.suspicious.class.name", name, extn); |
jjg@618 | 394 | } |
jjg@618 | 395 | } |
duke@1 | 396 | checkNameAndExistence(name, isSourceFile); |
duke@1 | 397 | Location loc = (isSourceFile ? SOURCE_OUTPUT : CLASS_OUTPUT); |
duke@1 | 398 | JavaFileObject.Kind kind = (isSourceFile ? |
duke@1 | 399 | JavaFileObject.Kind.SOURCE : |
duke@1 | 400 | JavaFileObject.Kind.CLASS); |
duke@1 | 401 | |
duke@1 | 402 | JavaFileObject fileObject = |
duke@1 | 403 | fileManager.getJavaFileForOutput(loc, name, kind, null); |
duke@1 | 404 | checkFileReopening(fileObject, true); |
duke@1 | 405 | |
duke@1 | 406 | if (lastRound) |
duke@1 | 407 | log.warning("proc.file.create.last.round", name); |
duke@1 | 408 | |
duke@1 | 409 | if (isSourceFile) |
duke@1 | 410 | aggregateGeneratedSourceNames.add(name); |
duke@1 | 411 | else |
duke@1 | 412 | aggregateGeneratedClassNames.add(name); |
duke@1 | 413 | openTypeNames.add(name); |
duke@1 | 414 | |
duke@1 | 415 | return new FilerOutputJavaFileObject(name, fileObject); |
duke@1 | 416 | } |
duke@1 | 417 | |
duke@1 | 418 | public FileObject createResource(JavaFileManager.Location location, |
duke@1 | 419 | CharSequence pkg, |
duke@1 | 420 | CharSequence relativeName, |
duke@1 | 421 | Element... originatingElements) throws IOException { |
duke@1 | 422 | locationCheck(location); |
duke@1 | 423 | |
duke@1 | 424 | String strPkg = pkg.toString(); |
duke@1 | 425 | if (strPkg.length() > 0) |
duke@1 | 426 | checkName(strPkg); |
duke@1 | 427 | |
duke@1 | 428 | FileObject fileObject = |
duke@1 | 429 | fileManager.getFileForOutput(location, strPkg, |
duke@1 | 430 | relativeName.toString(), null); |
duke@1 | 431 | checkFileReopening(fileObject, true); |
duke@1 | 432 | |
duke@1 | 433 | if (fileObject instanceof JavaFileObject) |
duke@1 | 434 | return new FilerOutputJavaFileObject(null, (JavaFileObject)fileObject); |
duke@1 | 435 | else |
duke@1 | 436 | return new FilerOutputFileObject(null, fileObject); |
duke@1 | 437 | } |
duke@1 | 438 | |
duke@1 | 439 | private void locationCheck(JavaFileManager.Location location) { |
duke@1 | 440 | if (location instanceof StandardLocation) { |
duke@1 | 441 | StandardLocation stdLoc = (StandardLocation) location; |
duke@1 | 442 | if (!stdLoc.isOutputLocation()) |
duke@1 | 443 | throw new IllegalArgumentException("Resource creation not supported in location " + |
duke@1 | 444 | stdLoc); |
duke@1 | 445 | } |
duke@1 | 446 | } |
duke@1 | 447 | |
duke@1 | 448 | public FileObject getResource(JavaFileManager.Location location, |
duke@1 | 449 | CharSequence pkg, |
duke@1 | 450 | CharSequence relativeName) throws IOException { |
duke@1 | 451 | String strPkg = pkg.toString(); |
duke@1 | 452 | if (strPkg.length() > 0) |
duke@1 | 453 | checkName(strPkg); |
duke@1 | 454 | |
duke@1 | 455 | // TODO: Only support reading resources in selected output |
duke@1 | 456 | // locations? Only allow reading of non-source, non-class |
duke@1 | 457 | // files from the supported input locations? |
jjg@1092 | 458 | |
jjg@1092 | 459 | // In the following, getFileForInput is the "obvious" method |
jjg@1092 | 460 | // to use, but it does not have the "obvious" semantics for |
jjg@1092 | 461 | // SOURCE_OUTPUT and CLASS_OUTPUT. Conversely, getFileForOutput |
jjg@1092 | 462 | // does not have the correct semantics for any "path" location |
jjg@1092 | 463 | // with more than one component. So, for now, we use a hybrid |
jjg@1092 | 464 | // invocation. |
jjg@1092 | 465 | FileObject fileObject; |
jjg@1092 | 466 | if (location.isOutputLocation()) { |
jjg@1092 | 467 | fileObject = fileManager.getFileForOutput(location, |
jjg@1092 | 468 | pkg.toString(), |
jjg@1092 | 469 | relativeName.toString(), |
jjg@1092 | 470 | null); |
jjg@1092 | 471 | } else { |
jjg@1092 | 472 | fileObject = fileManager.getFileForInput(location, |
jjg@655 | 473 | pkg.toString(), |
jjg@655 | 474 | relativeName.toString()); |
jjg@1092 | 475 | } |
jjg@655 | 476 | if (fileObject == null) { |
jjg@655 | 477 | String name = (pkg.length() == 0) |
jjg@655 | 478 | ? relativeName.toString() : (pkg + "/" + relativeName); |
jjg@655 | 479 | throw new FileNotFoundException(name); |
jjg@655 | 480 | } |
jjg@655 | 481 | |
duke@1 | 482 | // If the path was already opened for writing, throw an exception. |
duke@1 | 483 | checkFileReopening(fileObject, false); |
duke@1 | 484 | return new FilerInputFileObject(fileObject); |
duke@1 | 485 | } |
duke@1 | 486 | |
duke@1 | 487 | private void checkName(String name) throws FilerException { |
duke@1 | 488 | checkName(name, false); |
duke@1 | 489 | } |
duke@1 | 490 | |
duke@1 | 491 | private void checkName(String name, boolean allowUnnamedPackageInfo) throws FilerException { |
duke@1 | 492 | if (!SourceVersion.isName(name) && !isPackageInfo(name, allowUnnamedPackageInfo)) { |
duke@1 | 493 | if (lint) |
duke@1 | 494 | log.warning("proc.illegal.file.name", name); |
duke@1 | 495 | throw new FilerException("Illegal name " + name); |
duke@1 | 496 | } |
duke@1 | 497 | } |
duke@1 | 498 | |
duke@1 | 499 | private boolean isPackageInfo(String name, boolean allowUnnamedPackageInfo) { |
duke@1 | 500 | // Is the name of the form "package-info" or |
duke@1 | 501 | // "foo.bar.package-info"? |
duke@1 | 502 | final String PKG_INFO = "package-info"; |
duke@1 | 503 | int periodIndex = name.lastIndexOf("."); |
duke@1 | 504 | if (periodIndex == -1) { |
duke@1 | 505 | return allowUnnamedPackageInfo ? name.equals(PKG_INFO) : false; |
duke@1 | 506 | } else { |
duke@1 | 507 | // "foo.bar.package-info." illegal |
duke@1 | 508 | String prefix = name.substring(0, periodIndex); |
duke@1 | 509 | String simple = name.substring(periodIndex+1); |
duke@1 | 510 | return SourceVersion.isName(prefix) && simple.equals(PKG_INFO); |
duke@1 | 511 | } |
duke@1 | 512 | } |
duke@1 | 513 | |
duke@1 | 514 | private void checkNameAndExistence(String typename, boolean allowUnnamedPackageInfo) throws FilerException { |
duke@1 | 515 | // TODO: Check if type already exists on source or class path? |
duke@1 | 516 | // If so, use warning message key proc.type.already.exists |
duke@1 | 517 | checkName(typename, allowUnnamedPackageInfo); |
duke@1 | 518 | if (aggregateGeneratedSourceNames.contains(typename) || |
duke@1 | 519 | aggregateGeneratedClassNames.contains(typename)) { |
duke@1 | 520 | if (lint) |
duke@1 | 521 | log.warning("proc.type.recreate", typename); |
duke@1 | 522 | throw new FilerException("Attempt to recreate a file for type " + typename); |
duke@1 | 523 | } |
duke@1 | 524 | } |
duke@1 | 525 | |
duke@1 | 526 | /** |
duke@1 | 527 | * Check to see if the file has already been opened; if so, throw |
duke@1 | 528 | * an exception, otherwise add it to the set of files. |
duke@1 | 529 | */ |
duke@1 | 530 | private void checkFileReopening(FileObject fileObject, boolean addToHistory) throws FilerException { |
duke@1 | 531 | for(FileObject veteran : fileObjectHistory) { |
duke@1 | 532 | if (fileManager.isSameFile(veteran, fileObject)) { |
duke@1 | 533 | if (lint) |
duke@1 | 534 | log.warning("proc.file.reopening", fileObject.getName()); |
duke@1 | 535 | throw new FilerException("Attempt to reopen a file for path " + fileObject.getName()); |
duke@1 | 536 | } |
duke@1 | 537 | } |
duke@1 | 538 | if (addToHistory) |
duke@1 | 539 | fileObjectHistory.add(fileObject); |
duke@1 | 540 | } |
duke@1 | 541 | |
duke@1 | 542 | public boolean newFiles() { |
duke@1 | 543 | return (!generatedSourceNames.isEmpty()) |
duke@1 | 544 | || (!generatedClasses.isEmpty()); |
duke@1 | 545 | } |
duke@1 | 546 | |
duke@1 | 547 | public Set<String> getGeneratedSourceNames() { |
duke@1 | 548 | return generatedSourceNames; |
duke@1 | 549 | } |
duke@1 | 550 | |
duke@1 | 551 | public Set<JavaFileObject> getGeneratedSourceFileObjects() { |
duke@1 | 552 | return generatedSourceFileObjects; |
duke@1 | 553 | } |
duke@1 | 554 | |
duke@1 | 555 | public Map<String, JavaFileObject> getGeneratedClasses() { |
duke@1 | 556 | return generatedClasses; |
duke@1 | 557 | } |
duke@1 | 558 | |
duke@1 | 559 | public void warnIfUnclosedFiles() { |
duke@1 | 560 | if (!openTypeNames.isEmpty()) |
duke@1 | 561 | log.warning("proc.unclosed.type.files", openTypeNames.toString()); |
duke@1 | 562 | } |
duke@1 | 563 | |
duke@1 | 564 | /** |
duke@1 | 565 | * Update internal state for a new round. |
duke@1 | 566 | */ |
jjg@620 | 567 | public void newRound(Context context) { |
duke@1 | 568 | this.context = context; |
duke@1 | 569 | this.log = Log.instance(context); |
jjg@620 | 570 | clearRoundState(); |
jjg@620 | 571 | } |
jjg@620 | 572 | |
jjg@620 | 573 | void setLastRound(boolean lastRound) { |
duke@1 | 574 | this.lastRound = lastRound; |
duke@1 | 575 | } |
duke@1 | 576 | |
duke@1 | 577 | public void close() { |
duke@1 | 578 | clearRoundState(); |
duke@1 | 579 | // Cross-round state |
duke@1 | 580 | fileObjectHistory.clear(); |
duke@1 | 581 | openTypeNames.clear(); |
duke@1 | 582 | aggregateGeneratedSourceNames.clear(); |
duke@1 | 583 | aggregateGeneratedClassNames.clear(); |
duke@1 | 584 | } |
duke@1 | 585 | |
duke@1 | 586 | private void clearRoundState() { |
duke@1 | 587 | generatedSourceNames.clear(); |
duke@1 | 588 | generatedSourceFileObjects.clear(); |
duke@1 | 589 | generatedClasses.clear(); |
duke@1 | 590 | } |
duke@1 | 591 | |
duke@1 | 592 | /** |
duke@1 | 593 | * Debugging function to display internal state. |
duke@1 | 594 | */ |
duke@1 | 595 | public void displayState() { |
duke@1 | 596 | PrintWriter xout = context.get(Log.outKey); |
duke@1 | 597 | xout.println("File Object History : " + fileObjectHistory); |
duke@1 | 598 | xout.println("Open Type Names : " + openTypeNames); |
duke@1 | 599 | xout.println("Gen. Src Names : " + generatedSourceNames); |
duke@1 | 600 | xout.println("Gen. Cls Names : " + generatedClasses.keySet()); |
duke@1 | 601 | xout.println("Agg. Gen. Src Names : " + aggregateGeneratedSourceNames); |
duke@1 | 602 | xout.println("Agg. Gen. Cls Names : " + aggregateGeneratedClassNames); |
duke@1 | 603 | } |
duke@1 | 604 | |
duke@1 | 605 | public String toString() { |
duke@1 | 606 | return "javac Filer"; |
duke@1 | 607 | } |
duke@1 | 608 | |
duke@1 | 609 | /** |
duke@1 | 610 | * Upon close, register files opened by create{Source, Class}File |
duke@1 | 611 | * for annotation processing. |
duke@1 | 612 | */ |
duke@1 | 613 | private void closeFileObject(String typeName, FileObject fileObject) { |
duke@1 | 614 | /* |
duke@1 | 615 | * If typeName is non-null, the file object was opened as a |
duke@1 | 616 | * source or class file by the user. If a file was opened as |
duke@1 | 617 | * a resource, typeName will be null and the file is *not* |
duke@1 | 618 | * subject to annotation processing. |
duke@1 | 619 | */ |
duke@1 | 620 | if ((typeName != null)) { |
duke@1 | 621 | if (!(fileObject instanceof JavaFileObject)) |
duke@1 | 622 | throw new AssertionError("JavaFileOject not found for " + fileObject); |
duke@1 | 623 | JavaFileObject javaFileObject = (JavaFileObject)fileObject; |
duke@1 | 624 | switch(javaFileObject.getKind()) { |
duke@1 | 625 | case SOURCE: |
duke@1 | 626 | generatedSourceNames.add(typeName); |
duke@1 | 627 | generatedSourceFileObjects.add(javaFileObject); |
duke@1 | 628 | openTypeNames.remove(typeName); |
duke@1 | 629 | break; |
duke@1 | 630 | |
duke@1 | 631 | case CLASS: |
duke@1 | 632 | generatedClasses.put(typeName, javaFileObject); |
duke@1 | 633 | openTypeNames.remove(typeName); |
duke@1 | 634 | break; |
duke@1 | 635 | |
duke@1 | 636 | default: |
duke@1 | 637 | break; |
duke@1 | 638 | } |
duke@1 | 639 | } |
duke@1 | 640 | } |
duke@1 | 641 | |
duke@1 | 642 | } |