aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.javadoc;
aoqi@0: 
aoqi@0: import com.sun.javadoc.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Represents a documentation tag, e.g. @since, @author, @version.
aoqi@0:  * Given a tag (e.g. "@since 1.2"), holds tag name (e.g. "@since")
aoqi@0:  * and tag text (e.g. "1.2").  TagImpls with structure or which require
aoqi@0:  * special processing are handled by subclasses (ParamTagImpl, SeeTagImpl,
aoqi@0:  * and ThrowsTagImpl
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Robert Field
aoqi@0:  * @author Atul M Dambalkar
aoqi@0:  * @author Neal M Gafter
aoqi@0:  * @see SeeTagImpl
aoqi@0:  * @see ParamTagImpl
aoqi@0:  * @see ThrowsTagImpl
aoqi@0:  * @see Doc#tags()
aoqi@0:  *
aoqi@0:  */
aoqi@0: class TagImpl implements Tag {
aoqi@0: 
aoqi@0:     protected final String text;
aoqi@0:     protected final String name;
aoqi@0:     protected final DocImpl holder;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Cached first sentence.
aoqi@0:      */
aoqi@0:     private Tag[] firstSentence;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Cached inline tags.
aoqi@0:      */
aoqi@0:     private Tag[] inlineTags;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      *  Constructor
aoqi@0:      */
aoqi@0:     TagImpl(DocImpl holder, String name, String text) {
aoqi@0:         this.holder = holder;
aoqi@0:         this.name = name;
aoqi@0:         this.text = text;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the name of this tag.
aoqi@0:      */
aoqi@0:     public String name() {
aoqi@0:         return name;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the containing {@link Doc} of this Tag element.
aoqi@0:      */
aoqi@0:     public Doc holder() {
aoqi@0:         return holder;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the kind of this tag.
aoqi@0:      */
aoqi@0:     public String kind() {
aoqi@0:         return name;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the text of this tag, that is, portion beyond tag name.
aoqi@0:      */
aoqi@0:     public String text() {
aoqi@0:         return text;
aoqi@0:     }
aoqi@0: 
aoqi@0:     DocEnv docenv() {
aoqi@0:         return holder.env;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * for use by subclasses which have two part tag text.
aoqi@0:      */
aoqi@0:     String[] divideAtWhite() {
aoqi@0:         String[] sa = new String[2];
aoqi@0:         int len = text.length();
aoqi@0:         // if no white space found
aoqi@0:         sa[0] = text;
aoqi@0:         sa[1] = "";
aoqi@0:         for (int inx = 0; inx < len; ++inx) {
aoqi@0:             char ch = text.charAt(inx);
aoqi@0:             if (Character.isWhitespace(ch)) {
aoqi@0:                 sa[0] = text.substring(0, inx);
aoqi@0:                 for (; inx < len; ++inx) {
aoqi@0:                     ch = text.charAt(inx);
aoqi@0:                     if (!Character.isWhitespace(ch)) {
aoqi@0:                         sa[1] = text.substring(inx, len);
aoqi@0:                         break;
aoqi@0:                     }
aoqi@0:                 }
aoqi@0:                 break;
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return sa;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * convert this object to a string.
aoqi@0:      */
aoqi@0:     public String toString() {
aoqi@0:         return name + ":" + text;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * For documentation comment with embedded @link tags, return the array of
aoqi@0:      * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
aoqi@0:      * Within a comment string "This is an example of inline tags for a
aoqi@0:      * documentation comment {@link Doc {@link Doc commentlabel}}",
aoqi@0:      * where inside the inner braces, the first "Doc" carries exctly the same
aoqi@0:      * syntax as a SeeTagImpl and the second "commentlabel" is label for the Html
aoqi@0:      * Link, will return an array of TagImpl(s) with first element as TagImpl with
aoqi@0:      * comment text "This is an example of inline tags for a documentation
aoqi@0:      * comment" and second element as SeeTagImpl with referenced class as "Doc"
aoqi@0:      * and the label for the Html Link as "commentlabel".
aoqi@0:      *
aoqi@0:      * @return TagImpl[] Array of tags with inline SeeTagImpls.
aoqi@0:      * @see ParamTagImpl
aoqi@0:      * @see ThrowsTagImpl
aoqi@0:      */
aoqi@0:     public Tag[] inlineTags() {
aoqi@0:         if (inlineTags == null) {
aoqi@0:             inlineTags = Comment.getInlineTags(holder, text);
aoqi@0:         }
aoqi@0:         return inlineTags;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return array of tags for the first sentence in the doc comment text.
aoqi@0:      */
aoqi@0:     public Tag[] firstSentenceTags() {
aoqi@0:         if (firstSentence == null) {
aoqi@0:             //Parse all sentences first to avoid duplicate warnings.
aoqi@0:             inlineTags();
aoqi@0:             try {
aoqi@0:                 docenv().setSilent(true);
aoqi@0:                 firstSentence = Comment.firstSentenceTags(holder, text);
aoqi@0:             } finally {
aoqi@0:                 docenv().setSilent(false);
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return firstSentence;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the doc item to which this tag is attached.
aoqi@0:      * @return the doc item to which this tag is attached.
aoqi@0:      */
aoqi@0:     public SourcePosition position() {
aoqi@0:         return holder.position();
aoqi@0:     }
aoqi@0: }