duke@1: /*
jjg@1359:  * Copyright (c) 2001, 2012, Oracle and/or its affiliates. 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
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle 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:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javadoc;
duke@1: 
jjg@197: import java.util.EnumSet;
jjg@197: import javax.tools.JavaFileObject;
jjg@197: 
duke@1: import com.sun.tools.javac.code.Symbol.PackageSymbol;
duke@1: import com.sun.tools.javac.jvm.ClassReader;
duke@1: import com.sun.tools.javac.util.Context;
duke@1: 
duke@1: /** Javadoc uses an extended class reader that records package.html entries
jjg@1359:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
jjg@1359:  *
duke@1:  *  @author Neal Gafter
duke@1:  */
ksrini@1051: public 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: 
jjg@893:     public static void preRegister(Context context) {
duke@1:         context.put(classReaderKey, new Context.Factory<ClassReader>() {
jjg@893:             public ClassReader make(Context c) {
jjg@893:                 return new JavadocClassReader(c);
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: 
ksrini@1051:     public JavadocClassReader(Context context) {
duke@1:         super(context, true);
duke@1:         docenv = DocEnv.instance(context);
jjg@754:         preferSource = true;
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) {
jjg@197:         if (fo.isNameCompatible("package", JavaFileObject.Kind.HTML))
jjg@197:             docenv.getPackageDoc(pack).setDocPath(fo);
duke@1:     }
duke@1: }