langtools/src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java
changeset 10 06bc494ca11e
child 731 1dd22bdb9ca5
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java	Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,111 @@
+/*
+ * Copyright 2001-2006 Sun Microsystems, Inc.  All Rights Reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Sun designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Sun in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ */
+
+package com.sun.tools.javadoc;
+
+import com.sun.tools.javac.code.Symbol.PackageSymbol;
+import com.sun.tools.javac.jvm.ClassReader;
+import com.sun.tools.javac.util.Context;
+import com.sun.tools.javac.util.JavacFileManager;
+import com.sun.tools.javac.util.Old199;
+
+import java.io.File;
+import java.util.EnumSet;
+import javax.tools.JavaFileObject;
+
+/** Javadoc uses an extended class reader that records package.html entries
+ *  @author Neal Gafter
+ */
+class JavadocClassReader extends ClassReader {
+
+    public static JavadocClassReader instance0(Context context) {
+        ClassReader instance = context.get(classReaderKey);
+        if (instance == null)
+            instance = new JavadocClassReader(context);
+        return (JavadocClassReader)instance;
+    }
+
+    public static void preRegister(final Context context) {
+        context.put(classReaderKey, new Context.Factory<ClassReader>() {
+            public ClassReader make() {
+                return new JavadocClassReader(context);
+            }
+        });
+    }
+
+    private DocEnv docenv;
+    private EnumSet<JavaFileObject.Kind> all = EnumSet.of(JavaFileObject.Kind.CLASS,
+                                                          JavaFileObject.Kind.SOURCE,
+                                                          JavaFileObject.Kind.HTML);
+    private EnumSet<JavaFileObject.Kind> noSource = EnumSet.of(JavaFileObject.Kind.CLASS,
+                                                               JavaFileObject.Kind.HTML);
+
+    private JavadocClassReader(Context context) {
+        super(context, true);
+        docenv = DocEnv.instance(context);
+    }
+
+    /**
+     * Override getPackageFileKinds to include search for package.html
+     */
+    @Override
+    protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() {
+        return docenv.docClasses ? noSource : all;
+    }
+
+    /**
+     * Override extraFileActions to check for package documentation
+     */
+    @Override
+    protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) {
+        CharSequence fileName = Old199.getName(fo);
+        if (docenv != null && fileName.equals("package.html")) {
+            if (fo instanceof JavacFileManager.ZipFileObject) {
+                JavacFileManager.ZipFileObject zfo = (JavacFileManager.ZipFileObject) fo;
+                String zipName = zfo.getZipName();
+                String entryName = zfo.getZipEntryName();
+                int lastSep = entryName.lastIndexOf("/");
+                String classPathName = entryName.substring(0, lastSep + 1);
+                docenv.getPackageDoc(pack).setDocPath(zipName, classPathName);
+            }
+            else if (fo instanceof JavacFileManager.ZipFileIndexFileObject) {
+                JavacFileManager.ZipFileIndexFileObject zfo = (JavacFileManager.ZipFileIndexFileObject) fo;
+                String zipName = zfo.getZipName();
+                String entryName = zfo.getZipEntryName();
+                if (File.separatorChar != '/') {
+                    entryName = entryName.replace(File.separatorChar, '/');
+                }
+
+                int lastSep = entryName.lastIndexOf("/");
+                String classPathName = entryName.substring(0, lastSep + 1);
+                docenv.getPackageDoc(pack).setDocPath(zipName, classPathName);
+            }
+            else {
+                File fileDir = new File(Old199.getPath(fo)).getParentFile();
+                docenv.getPackageDoc(pack).setDocPath(fileDir.getAbsolutePath());
+            }
+        }
+    }
+}