duke@1: /*
ohair@554:  * Copyright (c) 2001, 2003, 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.doclets.internal.toolkit.taglets;
duke@1: 
duke@1: import com.sun.javadoc.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.Configuration;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: import java.util.*;
duke@1: 
duke@1: /**
duke@1:  * An inline Taglet representing the value tag. This tag should only be used with
duke@1:  * constant fields that have a value.  It is used to access the value of constant
duke@1:  * fields.  This inline tag has an optional field name parameter.  If the name is
duke@1:  * specified, the constant value is retrieved from the specified field.  A link
duke@1:  * is also created to the specified field.  If a name is not specified, the value
duke@1:  * is retrieved for the field that the inline tag appears on.  The name is specifed
duke@1:  * in the following format:  [fully qualified class name]#[constant field name].
duke@1:  *
duke@1:  * This code is not part of an API.
duke@1:  * It is implementation that is subject to change.
duke@1:  * Do not use it as an API
duke@1:  *
duke@1:  * @author Jamie Ho
duke@1:  * @since 1.4
duke@1:  */
duke@1: 
duke@1: public class ValueTaglet extends BaseInlineTaglet {
duke@1: 
duke@1:     /**
duke@1:      * Construct a new ValueTaglet.
duke@1:      */
duke@1:     public ValueTaglet() {
duke@1:         name = "value";
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Will return false because this inline tag may
duke@1:      * only appear in Fields.
duke@1:      * @return false since this is not a method.
duke@1:      */
duke@1:     public boolean inMethod() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Will return false because this inline tag may
duke@1:      * only appear in Fields.
duke@1:      * @return false since this is not a method.
duke@1:      */
duke@1:     public boolean inConstructor() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Will return false because this inline tag may
duke@1:      * only appear in Fields.
duke@1:      * @return false since this is not a method.
duke@1:      */
duke@1:     public boolean inOverview() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Will return false because this inline tag may
duke@1:      * only appear in Fields.
duke@1:      * @return false since this is not a method.
duke@1:      */
duke@1:     public boolean inPackage() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Will return false because this inline tag may
duke@1:      * only appear in Fields.
duke@1:      * @return false since this is not a method.
duke@1:      */
duke@1:     public boolean inType() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Given the name of the field, return the corresponding FieldDoc.
duke@1:      *
duke@1:      * @param config the current configuration of the doclet.
duke@1:      * @param tag the value tag.
duke@1:      * @param name the name of the field to search for.  The name should be in
duke@1:      * <qualified class name>#<field name> format. If the class name is omitted,
duke@1:      * it is assumed that the field is in the current class.
duke@1:      *
duke@1:      * @return the corresponding FieldDoc. If the name is null or empty string,
duke@1:      * return field that the value tag was used in.
duke@1:      *
duke@1:      * @throws DocletAbortException if the value tag does not specify a name to
duke@1:      * a value field and it is not used within the comments of a valid field.
duke@1:      */
duke@1:     private FieldDoc getFieldDoc(Configuration config, Tag tag, String name) {
duke@1:         if (name == null || name.length() == 0) {
duke@1:             //Base case: no label.
duke@1:             if (tag.holder() instanceof FieldDoc) {
duke@1:                 return (FieldDoc) tag.holder();
duke@1:             } else {
duke@1:                 //This should never ever happen.
duke@1:                 throw new DocletAbortException();
duke@1:             }
duke@1:         }
duke@1:         StringTokenizer st = new StringTokenizer(name, "#");
duke@1:         String memberName = null;
duke@1:         ClassDoc cd = null;
duke@1:         if (st.countTokens() == 1) {
duke@1:             //Case 2:  @value in same class.
duke@1:             Doc holder = tag.holder();
duke@1:             if (holder instanceof MemberDoc) {
duke@1:                 cd = ((MemberDoc) holder).containingClass();
duke@1:             } else if (holder instanceof ClassDoc) {
duke@1:                 cd = (ClassDoc) holder;
duke@1:             }
duke@1:             memberName = st.nextToken();
duke@1:         } else {
duke@1:             //Case 3: @value in different class.
duke@1:             cd = config.root.classNamed(st.nextToken());
duke@1:             memberName = st.nextToken();
duke@1:         }
duke@1:         if (cd == null) {
duke@1:             return null;
duke@1:         }
duke@1:         FieldDoc[] fields = cd.fields();
duke@1:         for (int i = 0; i < fields.length; i++) {
duke@1:             if (fields[i].name().equals(memberName)) {
duke@1:                 return fields[i];
duke@1:             }
duke@1:         }
duke@1:         return null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) {
duke@1:         FieldDoc field = getFieldDoc(
duke@1:             writer.configuration(), tag, tag.text());
duke@1:         if (field == null) {
duke@1:             //Reference is unknown.
duke@1:             writer.getMsgRetriever().warning(tag.holder().position(),
duke@1:                 "doclet.value_tag_invalid_reference", tag.text());
duke@1:         } else if (field.constantValue() != null) {
duke@1:             return writer.valueTagOutput(field,
duke@1:                 Util.escapeHtmlChars(field.constantValueExpression()),
duke@1:                 ! field.equals(tag.holder()));
duke@1:         } else {
duke@1:             //Referenced field is not a constant.
duke@1:             writer.getMsgRetriever().warning(tag.holder().position(),
duke@1:                 "doclet.value_tag_invalid_constant", field.name());
duke@1:         }
duke@1:         return writer.getOutputInstance();
duke@1:     }
duke@1: }