• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/javadoc/JavadocMemberEnter.java@959103a6100f (annotated)

src/share/classes/com/sun/tools/javadoc/JavadocMemberEnter.java

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.javadoc;
aoqi@0	27
aoqi@0	28	import com.sun.source.util.TreePath;
aoqi@0	29	import com.sun.tools.javac.code.Flags;
aoqi@0	30	import com.sun.tools.javac.code.Kinds;
aoqi@0	31	import com.sun.tools.javac.code.Symbol.*;
aoqi@0	32	import com.sun.tools.javac.comp.MemberEnter;
aoqi@0	33	import com.sun.tools.javac.tree.JCTree;
aoqi@0	34	import com.sun.tools.javac.tree.JCTree.*;
aoqi@0	35	import com.sun.tools.javac.util.Context;
aoqi@0	36
aoqi@0	37	import static com.sun.tools.javac.code.Flags.*;
aoqi@0	38
aoqi@0	39	/**
aoqi@0	40	* Javadoc's own memberEnter phase does a few things above and beyond that
aoqi@0	41	* done by javac.
aoqi@0	42	*
aoqi@0	43	* <p><b>This is NOT part of any supported API.
aoqi@0	44	* If you write code that depends on this, you do so at your own risk.
aoqi@0	45	* This code and its internal interfaces are subject to change or
aoqi@0	46	* deletion without notice.</b>
aoqi@0	47	*
aoqi@0	48	* @author Neal Gafter
aoqi@0	49	*/
aoqi@0	50	public class JavadocMemberEnter extends MemberEnter {
aoqi@0	51	public static JavadocMemberEnter instance0(Context context) {
aoqi@0	52	MemberEnter instance = context.get(memberEnterKey);
aoqi@0	53	if (instance == null)
aoqi@0	54	instance = new JavadocMemberEnter(context);
aoqi@0	55	return (JavadocMemberEnter)instance;
aoqi@0	56	}
aoqi@0	57
aoqi@0	58	public static void preRegister(Context context) {
aoqi@0	59	context.put(memberEnterKey, new Context.Factory<MemberEnter>() {
aoqi@0	60	public MemberEnter make(Context c) {
aoqi@0	61	return new JavadocMemberEnter(c);
aoqi@0	62	}
aoqi@0	63	});
aoqi@0	64	}
aoqi@0	65
aoqi@0	66	final DocEnv docenv;
aoqi@0	67
aoqi@0	68	protected JavadocMemberEnter(Context context) {
aoqi@0	69	super(context);
aoqi@0	70	docenv = DocEnv.instance(context);
aoqi@0	71	}
aoqi@0	72
aoqi@0	73	@Override
aoqi@0	74	public void visitMethodDef(JCMethodDecl tree) {
aoqi@0	75	super.visitMethodDef(tree);
aoqi@0	76	MethodSymbol meth = tree.sym;
aoqi@0	77	if (meth == null || meth.kind != Kinds.MTH) return;
aoqi@0	78	TreePath treePath = docenv.getTreePath(env.toplevel, env.enclClass, tree);
aoqi@0	79	if (meth.isConstructor())
aoqi@0	80	docenv.makeConstructorDoc(meth, treePath);
aoqi@0	81	else if (isAnnotationTypeElement(meth))
aoqi@0	82	docenv.makeAnnotationTypeElementDoc(meth, treePath);
aoqi@0	83	else
aoqi@0	84	docenv.makeMethodDoc(meth, treePath);
aoqi@0	85
aoqi@0	86	// release resources
aoqi@0	87	tree.body = null;
aoqi@0	88	}
aoqi@0	89
aoqi@0	90	@Override
aoqi@0	91	public void visitVarDef(JCVariableDecl tree) {
aoqi@0	92	if (tree.init != null) {
aoqi@0	93	boolean isFinal = (tree.mods.flags & FINAL) != 0
aoqi@0	94	|| (env.enclClass.mods.flags & INTERFACE) != 0;
aoqi@0	95	if (!isFinal || containsNonConstantExpression(tree.init)) {
aoqi@0	96	// Avoid unnecessary analysis and release resources.
aoqi@0	97	// In particular, remove non-constant expressions
aoqi@0	98	// which may trigger Attr.attribClass, since
aoqi@0	99	// method bodies are also removed, in visitMethodDef.
aoqi@0	100	tree.init = null;
aoqi@0	101	}
aoqi@0	102	}
aoqi@0	103	super.visitVarDef(tree);
aoqi@0	104	if (tree.sym != null &&
aoqi@0	105	tree.sym.kind == Kinds.VAR &&
aoqi@0	106	!isParameter(tree.sym)) {
aoqi@0	107	docenv.makeFieldDoc(tree.sym, docenv.getTreePath(env.toplevel, env.enclClass, tree));
aoqi@0	108	}
aoqi@0	109	}
aoqi@0	110
aoqi@0	111	private static boolean isAnnotationTypeElement(MethodSymbol meth) {
aoqi@0	112	return ClassDocImpl.isAnnotationType(meth.enclClass());
aoqi@0	113	}
aoqi@0	114
aoqi@0	115	private static boolean isParameter(VarSymbol var) {
aoqi@0	116	return (var.flags() & Flags.PARAMETER) != 0;
aoqi@0	117	}
aoqi@0	118
aoqi@0	119	/**
aoqi@0	120	* Simple analysis of an expression tree to see if it contains tree nodes
aoqi@0	121	* for any non-constant expression. This does not include checking references
aoqi@0	122	* to other fields which may or may not be constant.
aoqi@0	123	*/
aoqi@0	124	private static boolean containsNonConstantExpression(JCExpression tree) {
aoqi@0	125	return new MaybeConstantExpressionScanner().containsNonConstantExpression(tree);
aoqi@0	126	}
aoqi@0	127
aoqi@0	128	/**
aoqi@0	129	* See JLS 15.18, Constant Expression
aoqi@0	130	*/
aoqi@0	131	private static class MaybeConstantExpressionScanner extends JCTree.Visitor {
aoqi@0	132	boolean maybeConstantExpr = true;
aoqi@0	133
aoqi@0	134	public boolean containsNonConstantExpression(JCExpression tree) {
aoqi@0	135	scan(tree);
aoqi@0	136	return !maybeConstantExpr;
aoqi@0	137	}
aoqi@0	138
aoqi@0	139	public void scan(JCTree tree) {
aoqi@0	140	// short circuit scan when end result is definitely false
aoqi@0	141	if (maybeConstantExpr && tree != null)
aoqi@0	142	tree.accept(this);
aoqi@0	143	}
aoqi@0	144
aoqi@0	145	@Override
aoqi@0	146	/** default for any non-overridden visit method. */
aoqi@0	147	public void visitTree(JCTree tree) {
aoqi@0	148	maybeConstantExpr = false;
aoqi@0	149	}
aoqi@0	150
aoqi@0	151	@Override
aoqi@0	152	public void visitBinary(JCBinary tree) {
aoqi@0	153	switch (tree.getTag()) {
aoqi@0	154	case MUL: case DIV: case MOD:
aoqi@0	155	case PLUS: case MINUS:
aoqi@0	156	case SL: case SR: case USR:
aoqi@0	157	case LT: case LE: case GT: case GE:
aoqi@0	158	case EQ: case NE:
aoqi@0	159	case BITAND: case BITXOR: case BITOR:
aoqi@0	160	case AND: case OR:
aoqi@0	161	break;
aoqi@0	162	default:
aoqi@0	163	maybeConstantExpr = false;
aoqi@0	164	}
aoqi@0	165	}
aoqi@0	166
aoqi@0	167	@Override
aoqi@0	168	public void visitConditional(JCConditional tree) {
aoqi@0	169	scan(tree.cond);
aoqi@0	170	scan(tree.truepart);
aoqi@0	171	scan(tree.falsepart);
aoqi@0	172	}
aoqi@0	173
aoqi@0	174	@Override
aoqi@0	175	public void visitIdent(JCIdent tree) { }
aoqi@0	176
aoqi@0	177	@Override
aoqi@0	178	public void visitLiteral(JCLiteral tree) { }
aoqi@0	179
aoqi@0	180	@Override
aoqi@0	181	public void visitParens(JCParens tree) {
aoqi@0	182	scan(tree.expr);
aoqi@0	183	}
aoqi@0	184
aoqi@0	185	@Override
aoqi@0	186	public void visitSelect(JCTree.JCFieldAccess tree) {
aoqi@0	187	scan(tree.selected);
aoqi@0	188	}
aoqi@0	189
aoqi@0	190	@Override
aoqi@0	191	public void visitTypeCast(JCTypeCast tree) {
aoqi@0	192	scan(tree.clazz);
aoqi@0	193	scan(tree.expr);
aoqi@0	194	}
aoqi@0	195
aoqi@0	196	@Override
aoqi@0	197	public void visitTypeIdent(JCPrimitiveTypeTree tree) { }
aoqi@0	198
aoqi@0	199	@Override
aoqi@0	200	public void visitUnary(JCUnary tree) {
aoqi@0	201	switch (tree.getTag()) {
aoqi@0	202	case POS: case NEG: case COMPL: case NOT:
aoqi@0	203	break;
aoqi@0	204	default:
aoqi@0	205	maybeConstantExpr = false;
aoqi@0	206	}
aoqi@0	207	}
aoqi@0	208	}
aoqi@0	209	}