1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/javadoc/JavadocClassReader.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,90 @@
1.4 +/*
1.5 + * Copyright (c) 2001, 2012, Oracle and/or its affiliates. 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. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.javadoc;
1.30 +
1.31 +import java.util.EnumSet;
1.32 +import javax.tools.JavaFileObject;
1.33 +
1.34 +import com.sun.tools.javac.code.Symbol.PackageSymbol;
1.35 +import com.sun.tools.javac.jvm.ClassReader;
1.36 +import com.sun.tools.javac.util.Context;
1.37 +
1.38 +/** Javadoc uses an extended class reader that records package.html entries
1.39 + *
1.40 + * <p><b>This is NOT part of any supported API.
1.41 + * If you write code that depends on this, you do so at your own risk.
1.42 + * This code and its internal interfaces are subject to change or
1.43 + * deletion without notice.</b>
1.44 + *
1.45 + * @author Neal Gafter
1.46 + */
1.47 +public class JavadocClassReader extends ClassReader {
1.48 +
1.49 + public static JavadocClassReader instance0(Context context) {
1.50 + ClassReader instance = context.get(classReaderKey);
1.51 + if (instance == null)
1.52 + instance = new JavadocClassReader(context);
1.53 + return (JavadocClassReader)instance;
1.54 + }
1.55 +
1.56 + public static void preRegister(Context context) {
1.57 + context.put(classReaderKey, new Context.Factory<ClassReader>() {
1.58 + public ClassReader make(Context c) {
1.59 + return new JavadocClassReader(c);
1.60 + }
1.61 + });
1.62 + }
1.63 +
1.64 + private DocEnv docenv;
1.65 + private EnumSet<JavaFileObject.Kind> all = EnumSet.of(JavaFileObject.Kind.CLASS,
1.66 + JavaFileObject.Kind.SOURCE,
1.67 + JavaFileObject.Kind.HTML);
1.68 + private EnumSet<JavaFileObject.Kind> noSource = EnumSet.of(JavaFileObject.Kind.CLASS,
1.69 + JavaFileObject.Kind.HTML);
1.70 +
1.71 + public JavadocClassReader(Context context) {
1.72 + super(context, true);
1.73 + docenv = DocEnv.instance(context);
1.74 + preferSource = true;
1.75 + }
1.76 +
1.77 + /**
1.78 + * Override getPackageFileKinds to include search for package.html
1.79 + */
1.80 + @Override
1.81 + protected EnumSet<JavaFileObject.Kind> getPackageFileKinds() {
1.82 + return docenv.docClasses ? noSource : all;
1.83 + }
1.84 +
1.85 + /**
1.86 + * Override extraFileActions to check for package documentation
1.87 + */
1.88 + @Override
1.89 + protected void extraFileActions(PackageSymbol pack, JavaFileObject fo) {
1.90 + if (fo.isNameCompatible("package", JavaFileObject.Kind.HTML))
1.91 + docenv.getPackageDoc(pack).setDocPath(fo);
1.92 + }
1.93 +}
