Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java@b9bcea8bbe24 (annotated)
src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java
Mon, 16 Jun 2008 13:28:00 -0700
- author
- jjg
- date
- Mon, 16 Jun 2008 13:28:00 -0700
- changeset 50
- b9bcea8bbe24
- parent 1
- 9a66ca7c79fa
- child 54
- eaf608c64fec
- child 57
- aa67a5da66e3
- permissions
- -rw-r--r--
6714364: refactor javac File handling code into new javac.file package
Reviewed-by: mcimadamore
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 2001-2006 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.javadoc; |
| duke@1 | 27 | |
| duke@1 | 28 | import com.sun.tools.javac.code.Symbol.PackageSymbol; |
| jjg@50 | 29 | import com.sun.tools.javac.file.JavacFileManager; |
| jjg@50 | 30 | import com.sun.tools.javac.file.Old199; |
| duke@1 | 31 | import com.sun.tools.javac.jvm.ClassReader; |
| duke@1 | 32 | import com.sun.tools.javac.util.Context; |
| duke@1 | 33 | |
| duke@1 | 34 | import java.io.File; |
| duke@1 | 35 | import java.util.EnumSet; |
| duke@1 | 36 | import javax.tools.JavaFileObject; |
| duke@1 | 37 | |
| duke@1 | 38 | /** Javadoc uses an extended class reader that records package.html entries |
| duke@1 | 39 | * @author Neal Gafter |
| duke@1 | 40 | */ |
| duke@1 | 41 | class JavadocClassReader extends ClassReader { |
| duke@1 | 42 | |
| duke@1 | 43 | public static JavadocClassReader instance0(Context context) { |
| duke@1 | 44 | ClassReader instance = context.get(classReaderKey); |
| duke@1 | 45 | if (instance == null) |
| duke@1 | 46 | instance = new JavadocClassReader(context); |
| duke@1 | 47 | return (JavadocClassReader)instance; |
| duke@1 | 48 | } |
| duke@1 | 49 | |
| duke@1 | 50 | public static void preRegister(final Context context) { |
| duke@1 | 51 | context.put(classReaderKey, new Context.Factory<ClassReader>() { |
| duke@1 | 52 | public ClassReader make() { |
| duke@1 | 53 | return new JavadocClassReader(context); |
| duke@1 | 54 | } |
| duke@1 | 55 | }); |
| duke@1 | 56 | } |
| duke@1 | 57 | |
| duke@1 | 58 | private DocEnv docenv; |
| duke@1 | 59 | private EnumSet<JavaFileObject.Kind> all = EnumSet.of(JavaFileObject.Kind.CLASS, |
| duke@1 | 60 | JavaFileObject.Kind.SOURCE, |
| duke@1 | 61 | JavaFileObject.Kind.HTML); |
| duke@1 | 62 | private EnumSet<JavaFileObject.Kind> noSource = EnumSet.of(JavaFileObject.Kind.CLASS, |
| duke@1 | 63 | JavaFileObject.Kind.HTML); |
| duke@1 | 64 | |
| duke@1 | 65 | private JavadocClassReader(Context context) { |
| duke@1 | 66 | super(context, true); |
| duke@1 | 67 | docenv = DocEnv.instance(context); |
| duke@1 | 68 | } |
| duke@1 | 69 | |
| duke@1 | 70 | /** |
| duke@1 | 71 | * Override getPackageFileKinds to include search for package.html |
| duke@1 | 72 | */ |
| duke@1 | 73 | @Override |
| duke@1 | 74 | protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() { |
| duke@1 | 75 | return docenv.docClasses ? noSource : all; |
| duke@1 | 76 | } |
| duke@1 | 77 | |
| duke@1 | 78 | /** |
| duke@1 | 79 | * Override extraFileActions to check for package documentation |
| duke@1 | 80 | */ |
| duke@1 | 81 | @Override |
| duke@1 | 82 | protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) { |
| duke@1 | 83 | CharSequence fileName = Old199.getName(fo); |
| duke@1 | 84 | if (docenv != null && fileName.equals("package.html")) { |
| duke@1 | 85 | if (fo instanceof JavacFileManager.ZipFileObject) { |
| duke@1 | 86 | JavacFileManager.ZipFileObject zfo = (JavacFileManager.ZipFileObject) fo; |
| duke@1 | 87 | String zipName = zfo.getZipName(); |
| duke@1 | 88 | String entryName = zfo.getZipEntryName(); |
| duke@1 | 89 | int lastSep = entryName.lastIndexOf("/"); |
| duke@1 | 90 | String classPathName = entryName.substring(0, lastSep + 1); |
| duke@1 | 91 | docenv.getPackageDoc(pack).setDocPath(zipName, classPathName); |
| duke@1 | 92 | } |
| duke@1 | 93 | else if (fo instanceof JavacFileManager.ZipFileIndexFileObject) { |
| duke@1 | 94 | JavacFileManager.ZipFileIndexFileObject zfo = (JavacFileManager.ZipFileIndexFileObject) fo; |
| duke@1 | 95 | String zipName = zfo.getZipName(); |
| duke@1 | 96 | String entryName = zfo.getZipEntryName(); |
| duke@1 | 97 | if (File.separatorChar != '/') { |
| duke@1 | 98 | entryName = entryName.replace(File.separatorChar, '/'); |
| duke@1 | 99 | } |
| duke@1 | 100 | |
| duke@1 | 101 | int lastSep = entryName.lastIndexOf("/"); |
| duke@1 | 102 | String classPathName = entryName.substring(0, lastSep + 1); |
| duke@1 | 103 | docenv.getPackageDoc(pack).setDocPath(zipName, classPathName); |
| duke@1 | 104 | } |
| duke@1 | 105 | else { |
| duke@1 | 106 | File fileDir = new File(Old199.getPath(fo)).getParentFile(); |
| duke@1 | 107 | docenv.getPackageDoc(pack).setDocPath(fileDir.getAbsolutePath()); |
| duke@1 | 108 | } |
| duke@1 | 109 | } |
| duke@1 | 110 | } |
| duke@1 | 111 | } |
