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