1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java Sat Dec 01 00:00:00 2007 +0000
1.3 @@ -0,0 +1,111 @@
1.4 +/*
1.5 + * Copyright 2001-2006 Sun Microsystems, Inc. All Rights Reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Sun designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Sun in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
1.26 + * have any questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.javadoc;
1.30 +
1.31 +import com.sun.tools.javac.code.Symbol.PackageSymbol;
1.32 +import com.sun.tools.javac.jvm.ClassReader;
1.33 +import com.sun.tools.javac.util.Context;
1.34 +import com.sun.tools.javac.util.JavacFileManager;
1.35 +import com.sun.tools.javac.util.Old199;
1.36 +
1.37 +import java.io.File;
1.38 +import java.util.EnumSet;
1.39 +import javax.tools.JavaFileObject;
1.40 +
1.41 +/** Javadoc uses an extended class reader that records package.html entries
1.42 + * @author Neal Gafter
1.43 + */
1.44 +class JavadocClassReader extends ClassReader {
1.45 +
1.46 + public static JavadocClassReader instance0(Context context) {
1.47 + ClassReader instance = context.get(classReaderKey);
1.48 + if (instance == null)
1.49 + instance = new JavadocClassReader(context);
1.50 + return (JavadocClassReader)instance;
1.51 + }
1.52 +
1.53 + public static void preRegister(final Context context) {
1.54 + context.put(classReaderKey, new Context.Factory<ClassReader>() {
1.55 + public ClassReader make() {
1.56 + return new JavadocClassReader(context);
1.57 + }
1.58 + });
1.59 + }
1.60 +
1.61 + private DocEnv docenv;
1.62 + private EnumSet<JavaFileObject.Kind> all = EnumSet.of(JavaFileObject.Kind.CLASS,
1.63 + JavaFileObject.Kind.SOURCE,
1.64 + JavaFileObject.Kind.HTML);
1.65 + private EnumSet<JavaFileObject.Kind> noSource = EnumSet.of(JavaFileObject.Kind.CLASS,
1.66 + JavaFileObject.Kind.HTML);
1.67 +
1.68 + private JavadocClassReader(Context context) {
1.69 + super(context, true);
1.70 + docenv = DocEnv.instance(context);
1.71 + }
1.72 +
1.73 + /**
1.74 + * Override getPackageFileKinds to include search for package.html
1.75 + */
1.76 + @Override
1.77 + protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() {
1.78 + return docenv.docClasses ? noSource : all;
1.79 + }
1.80 +
1.81 + /**
1.82 + * Override extraFileActions to check for package documentation
1.83 + */
1.84 + @Override
1.85 + protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) {
1.86 + CharSequence fileName = Old199.getName(fo);
1.87 + if (docenv != null && fileName.equals("package.html")) {
1.88 + if (fo instanceof JavacFileManager.ZipFileObject) {
1.89 + JavacFileManager.ZipFileObject zfo = (JavacFileManager.ZipFileObject) fo;
1.90 + String zipName = zfo.getZipName();
1.91 + String entryName = zfo.getZipEntryName();
1.92 + int lastSep = entryName.lastIndexOf("/");
1.93 + String classPathName = entryName.substring(0, lastSep + 1);
1.94 + docenv.getPackageDoc(pack).setDocPath(zipName, classPathName);
1.95 + }
1.96 + else if (fo instanceof JavacFileManager.ZipFileIndexFileObject) {
1.97 + JavacFileManager.ZipFileIndexFileObject zfo = (JavacFileManager.ZipFileIndexFileObject) fo;
1.98 + String zipName = zfo.getZipName();
1.99 + String entryName = zfo.getZipEntryName();
1.100 + if (File.separatorChar != '/') {
1.101 + entryName = entryName.replace(File.separatorChar, '/');
1.102 + }
1.103 +
1.104 + int lastSep = entryName.lastIndexOf("/");
1.105 + String classPathName = entryName.substring(0, lastSep + 1);
1.106 + docenv.getPackageDoc(pack).setDocPath(zipName, classPathName);
1.107 + }
1.108 + else {
1.109 + File fileDir = new File(Old199.getPath(fo)).getParentFile();
1.110 + docenv.getPackageDoc(pack).setDocPath(fileDir.getAbsolutePath());
1.111 + }
1.112 + }
1.113 + }
1.114 +}
