duke@1: /*
xdono@117: * Copyright 1997-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.util.*;
duke@1:
duke@1: import com.sun.javadoc.*;
duke@1:
duke@1: /**
duke@1: * Represents a see also documentation tag.
duke@1: * The @see tag can be plain text, or reference a class or member.
duke@1: *
duke@1: * @author Kaiyang Liu (original)
duke@1: * @author Robert Field (rewrite)
duke@1: * @author Atul M Dambalkar
duke@1: *
duke@1: */
duke@1: class SeeTagImpl extends TagImpl implements SeeTag, LayoutCharacters {
duke@1:
duke@1: //### TODO: Searching for classes, fields, and methods
duke@1: //### should follow the normal rules applied by the compiler.
duke@1:
duke@1: /**
duke@1: * where of where#what - i.e. the class name (may be empty)
duke@1: */
duke@1: private String where;
duke@1:
duke@1: /**
duke@1: * what of where#what - i.e. the member (may be null)
duke@1: */
duke@1: private String what;
duke@1:
duke@1: private PackageDoc referencedPackage;
duke@1: private ClassDoc referencedClass;
duke@1: private MemberDoc referencedMember;
duke@1:
duke@1: String label = "";
duke@1:
duke@1: SeeTagImpl(DocImpl holder, String name, String text) {
duke@1: super(holder, name, text);
duke@1: parseSeeString();
duke@1: if (where != null) {
duke@1: ClassDocImpl container = null;
duke@1: if (holder instanceof MemberDoc) {
duke@1: container =
duke@1: (ClassDocImpl)((ProgramElementDoc)holder).containingClass();
duke@1: } else if (holder instanceof ClassDoc) {
duke@1: container = (ClassDocImpl)holder;
duke@1: }
duke@1: findReferenced(container);
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * get the class name part of @see, For instance,
duke@1: * if the comment is @see String#startsWith(java.lang.String) .
duke@1: * This function returns String.
duke@1: * Returns null if format was not that of java reference.
duke@1: * Return empty string if class name was not specified..
duke@1: */
duke@1: public String referencedClassName() {
duke@1: return where;
duke@1: }
duke@1:
duke@1: /**
duke@1: * get the package referenced by @see. For instance,
duke@1: * if the comment is @see java.lang
duke@1: * This function returns a PackageDocImpl for java.lang
duke@1: * Returns null if no known package found.
duke@1: */
duke@1: public PackageDoc referencedPackage() {
duke@1: return referencedPackage;
duke@1: }
duke@1:
duke@1: /**
duke@1: * get the class referenced by the class name part of @see, For instance,
duke@1: * if the comment is @see String#startsWith(java.lang.String) .
duke@1: * This function returns a ClassDocImpl for java.lang.String.
duke@1: * Returns null if class is not a class specified on the javadoc command line..
duke@1: */
duke@1: public ClassDoc referencedClass() {
duke@1: return referencedClass;
duke@1: }
duke@1:
duke@1: /**
duke@1: * get the name of the member referenced by the prototype part of @see,
duke@1: * For instance,
duke@1: * if the comment is @see String#startsWith(java.lang.String) .
duke@1: * This function returns "startsWith(java.lang.String)"
duke@1: * Returns null if format was not that of java reference.
duke@1: * Return empty string if member name was not specified..
duke@1: */
duke@1: public String referencedMemberName() {
duke@1: return what;
duke@1: }
duke@1:
duke@1: /**
duke@1: * get the member referenced by the prototype part of @see,
duke@1: * For instance,
duke@1: * if the comment is @see String#startsWith(java.lang.String) .
duke@1: * This function returns a MethodDocImpl for startsWith.
duke@1: * Returns null if member could not be determined.
duke@1: */
duke@1: public MemberDoc referencedMember() {
duke@1: return referencedMember;
duke@1: }
duke@1:
duke@1:
duke@1: /**
duke@1: * parse @see part of comment. Determine 'where' and 'what'
duke@1: */
duke@1: private void parseSeeString() {
duke@1: int len = text.length();
duke@1: if (len == 0) {
duke@1: return;
duke@1: }
duke@1: switch (text.charAt(0)) {
duke@1: case '<':
duke@1: if (text.charAt(len-1) != '>') {
duke@1: docenv().warning(holder,
duke@1: "tag.see.no_close_bracket_on_url",
duke@1: name, text);
duke@1: }
duke@1: return;
duke@1: case '"':
duke@1: if (len == 1 || text.charAt(len-1) != '"') {
duke@1: docenv().warning(holder,
duke@1: "tag.see.no_close_quote",
duke@1: name, text);
duke@1: } else {
duke@1: // text = text.substring(1,len-1); // strip quotes
duke@1: }
duke@1: return;
duke@1: }
duke@1:
duke@1: // check that the text is one word, with possible parentheses
duke@1: // this part of code doesn't allow
duke@1: // @see asfd
duke@1: // comment it.
duke@1:
duke@1: // the code assumes that there is no initial white space.
duke@1: int parens = 0;
duke@1: int commentstart = 0;
duke@1: int start = 0;
duke@1: int cp;
duke@1: for (int i = start; i < len ; i += Character.charCount(cp)) {
duke@1: cp = text.codePointAt(i);
duke@1: switch (cp) {
duke@1: case '(': parens++; break;
duke@1: case ')': parens--; break;
duke@1: case '[': case ']': case '.': case '#': break;
duke@1: case ',':
duke@1: if (parens <= 0) {
duke@1: docenv().warning(holder,
duke@1: "tag.see.malformed_see_tag",
duke@1: name, text);
duke@1: return;
duke@1: }
duke@1: break;
duke@1: case ' ': case '\t': case '\n': case CR:
duke@1: if (parens == 0) { //here onwards the comment starts.
duke@1: commentstart = i;
duke@1: i = len;
duke@1: }
duke@1: break;
duke@1: default:
duke@1: if (!Character.isJavaIdentifierPart(cp)) {
duke@1: docenv().warning(holder,
duke@1: "tag.see.illegal_character",
duke@1: name, ""+cp, text);
duke@1: }
duke@1: break;
duke@1: }
duke@1: }
duke@1: if (parens != 0) {
duke@1: docenv().warning(holder,
duke@1: "tag.see.malformed_see_tag",
duke@1: name, text);
duke@1: return;
duke@1: }
duke@1:
duke@1: String seetext = "";
duke@1: String labeltext = "";
duke@1:
duke@1: if (commentstart > 0) {
duke@1: seetext = text.substring(start, commentstart);
duke@1: labeltext = text.substring(commentstart + 1);
duke@1: // strip off the white space which can be between seetext and the
duke@1: // actual label.
duke@1: for (int i = 0; i < labeltext.length(); i++) {
duke@1: char ch2 = labeltext.charAt(i);
duke@1: if (!(ch2 == ' ' || ch2 == '\t' || ch2 == '\n')) {
duke@1: label = labeltext.substring(i);
duke@1: break;
duke@1: }
duke@1: }
duke@1: } else {
duke@1: seetext = text;
duke@1: label = "";
duke@1: }
duke@1:
duke@1: int sharp = seetext.indexOf('#');
duke@1: if (sharp >= 0) {
duke@1: // class#member
duke@1: where = seetext.substring(0, sharp);
duke@1: what = seetext.substring(sharp + 1);
duke@1: } else {
duke@1: if (seetext.indexOf('(') >= 0) {
duke@1: docenv().warning(holder,
duke@1: "tag.see.missing_sharp",
duke@1: name, text);
duke@1: where = "";
duke@1: what = seetext;
duke@1: }
duke@1: else {
duke@1: // no member specified, text names class
duke@1: where = seetext;
duke@1: what = null;
duke@1: }
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * Find what is referenced by the see also. If possible, sets
duke@1: * referencedClass and referencedMember.
duke@1: *
duke@1: * @param containingClass the class containing the comment containing
duke@1: * the tag. May be null, if, for example, it is a package comment.
duke@1: */
duke@1: private void findReferenced(ClassDocImpl containingClass) {
duke@1: if (where.length() > 0) {
duke@1: if (containingClass != null) {
duke@1: referencedClass = containingClass.findClass(where);
duke@1: } else {
duke@1: referencedClass = docenv().lookupClass(where);
duke@1: }
duke@1: if (referencedClass == null && holder() instanceof ProgramElementDoc) {
duke@1: referencedClass = docenv().lookupClass(
duke@1: ((ProgramElementDoc) holder()).containingPackage().name() + "." + where);
duke@1: }
duke@1:
duke@1: if (referencedClass == null) { /* may just not be in this run */
duke@1: // docenv().warning(holder, "tag.see.class_not_found",
duke@1: // where, text);
duke@1: // check if it's a package name
duke@1: referencedPackage = docenv().lookupPackage(where);
duke@1: return;
duke@1: }
duke@1: } else {
duke@1: if (containingClass == null) {
duke@1: docenv().warning(holder,
duke@1: "tag.see.class_not_specified",
duke@1: name, text);
duke@1: return;
duke@1: } else {
duke@1: referencedClass = containingClass;
duke@1: }
duke@1: }
duke@1: where = referencedClass.qualifiedName();
duke@1:
duke@1: if (what == null) {
duke@1: return;
duke@1: } else {
duke@1: int paren = what.indexOf('(');
duke@1: String memName = (paren >= 0 ? what.substring(0, paren) : what);
duke@1: String[] paramarr;
duke@1: if (paren > 0) {
duke@1: // has parameter list -- should be method or constructor
duke@1: paramarr = new ParameterParseMachine(what.
duke@1: substring(paren, what.length())).parseParameters();
duke@1: if (paramarr != null) {
duke@1: referencedMember = findExecutableMember(memName, paramarr,
duke@1: referencedClass);
duke@1: } else {
duke@1: referencedMember = null;
duke@1: }
duke@1: } else {
duke@1: // no parameter list -- should be field
duke@1: referencedMember = findExecutableMember(memName, null,
duke@1: referencedClass);
duke@1: FieldDoc fd = ((ClassDocImpl)referencedClass).
duke@1: findField(memName);
duke@1: // when no args given, prefer fields over methods
duke@1: if (referencedMember == null ||
duke@1: (fd != null &&
duke@1: fd.containingClass()
duke@1: .subclassOf(referencedMember.containingClass()))) {
duke@1: referencedMember = fd;
duke@1: }
duke@1: }
duke@1: if (referencedMember == null) {
duke@1: docenv().warning(holder,
duke@1: "tag.see.can_not_find_member",
duke@1: name, what, where);
duke@1: }
duke@1: }
duke@1: }
duke@1:
duke@1: private MemberDoc findReferencedMethod(String memName, String[] paramarr,
duke@1: ClassDoc referencedClass) {
duke@1: MemberDoc meth = findExecutableMember(memName, paramarr, referencedClass);
duke@1: ClassDoc[] nestedclasses = referencedClass.innerClasses();
duke@1: if (meth == null) {
duke@1: for (int i = 0; i < nestedclasses.length; i++) {
duke@1: meth = findReferencedMethod(memName, paramarr, nestedclasses[i]);
duke@1: if (meth != null) {
duke@1: return meth;
duke@1: }
duke@1: }
duke@1: }
duke@1: return null;
duke@1: }
duke@1:
duke@1: private MemberDoc findExecutableMember(String memName, String[] paramarr,
duke@1: ClassDoc referencedClass) {
duke@1: if (memName.equals(referencedClass.name())) {
duke@1: return ((ClassDocImpl)referencedClass).findConstructor(memName,
duke@1: paramarr);
duke@1: } else { // it's a method.
duke@1: return ((ClassDocImpl)referencedClass).findMethod(memName,
duke@1: paramarr);
duke@1: }
duke@1: }
duke@1:
duke@1: // separate "int, String" from "(int, String)"
duke@1: // (int i, String s) ==> [0] = "int", [1] = String
duke@1: // (int[][], String[]) ==> [0] = "int[][]" // [1] = "String[]"
duke@1: class ParameterParseMachine {
duke@1: final int START = 0;
duke@1: final int TYPE = 1;
duke@1: final int NAME = 2;
duke@1: final int TNSPACE = 3; // space between type and name
duke@1: final int ARRAYDECORATION = 4;
duke@1: final int ARRAYSPACE = 5;
duke@1:
duke@1: String parameters;
duke@1:
duke@1: StringBuffer typeId;
duke@1:
duke@1: ListBuffer paramList;
duke@1:
duke@1: ParameterParseMachine(String parameters) {
duke@1: this.parameters = parameters;
duke@1: this.paramList = new ListBuffer();
duke@1: typeId = new StringBuffer();
duke@1: }
duke@1:
duke@1: public String[] parseParameters() {
duke@1: if (parameters.equals("()")) {
duke@1: return new String[0];
duke@1: } // now strip off '(' and ')'
duke@1: int state = START;
duke@1: int prevstate = START;
duke@1: parameters = parameters.substring(1, parameters.length() - 1);
duke@1: int cp;
duke@1: for (int index = 0; index < parameters.length(); index += Character.charCount(cp)) {
duke@1: cp = parameters.codePointAt(index);
duke@1: switch (state) {
duke@1: case START:
duke@1: if (Character.isJavaIdentifierStart(cp)) {
duke@1: typeId.append(Character.toChars(cp));
duke@1: state = TYPE;
duke@1: }
duke@1: prevstate = START;
duke@1: break;
duke@1: case TYPE:
duke@1: if (Character.isJavaIdentifierPart(cp) || cp == '.') {
duke@1: typeId.append(Character.toChars(cp));
duke@1: } else if (cp == '[') {
duke@1: typeId.append('[');
duke@1: state = ARRAYDECORATION;
duke@1: } else if (Character.isWhitespace(cp)) {
duke@1: state = TNSPACE;
duke@1: } else if (cp == ',') { // no name, just type
duke@1: addTypeToParamList();
duke@1: state = START;
duke@1: }
duke@1: prevstate = TYPE;
duke@1: break;
duke@1: case TNSPACE:
duke@1: if (Character.isJavaIdentifierStart(cp)) { // name
duke@1: if (prevstate == ARRAYDECORATION) {
duke@1: docenv().warning(holder,
duke@1: "tag.missing_comma_space",
duke@1: name,
duke@1: "(" + parameters + ")");
duke@1: return (String[])null;
duke@1: }
duke@1: addTypeToParamList();
duke@1: state = NAME;
duke@1: } else if (cp == '[') {
duke@1: typeId.append('[');
duke@1: state = ARRAYDECORATION;
duke@1: } else if (cp == ',') { // just the type
duke@1: addTypeToParamList();
duke@1: state = START;
duke@1: } // consume rest all
duke@1: prevstate = TNSPACE;
duke@1: break;
duke@1: case ARRAYDECORATION:
duke@1: if (cp == ']') {
duke@1: typeId.append(']');
duke@1: state = TNSPACE;
duke@1: } else if (!Character.isWhitespace(cp)) {
duke@1: docenv().warning(holder,
duke@1: "tag.illegal_char_in_arr_dim",
duke@1: name,
duke@1: "(" + parameters + ")");
duke@1: return (String[])null;
duke@1: }
duke@1: prevstate = ARRAYDECORATION;
duke@1: break;
duke@1: case NAME:
duke@1: if (cp == ',') { // just consume everything till ','
duke@1: state = START;
duke@1: }
duke@1: prevstate = NAME;
duke@1: break;
duke@1: }
duke@1: }
duke@1: if (state == ARRAYDECORATION ||
duke@1: (state == START && prevstate == TNSPACE)) {
duke@1: docenv().warning(holder,
duke@1: "tag.illegal_see_tag",
duke@1: "(" + parameters + ")");
duke@1: }
duke@1: if (typeId.length() > 0) {
duke@1: paramList.append(typeId.toString());
duke@1: }
jjg@74: return paramList.toArray(new String[paramList.length()]);
duke@1: }
duke@1:
duke@1: void addTypeToParamList() {
duke@1: if (typeId.length() > 0) {
duke@1: paramList.append(typeId.toString());
duke@1: typeId.setLength(0);
duke@1: }
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the kind of this tag.
duke@1: */
duke@1: public String kind() {
duke@1: return "@see";
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the label of the see tag.
duke@1: */
duke@1: public String label() {
duke@1: return label;
duke@1: }
duke@1: }