aoqi@0: /*
aoqi@0:  * Copyright (c) 2013, 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.source.util;
aoqi@0: 
aoqi@0: import com.sun.source.doctree.DocCommentTree;
aoqi@0: import com.sun.source.doctree.DocTree;
aoqi@0: import com.sun.source.tree.CompilationUnitTree;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Provides methods to obtain the position of a DocTree within a javadoc comment.
aoqi@0:  * A position is defined as a simple character offset from the start of a
aoqi@0:  * CompilationUnit where the first character is at offset 0.
aoqi@0:  *
aoqi@0:  * @since 1.8
aoqi@0:  */
aoqi@0: @jdk.Exported
aoqi@0: public interface DocSourcePositions extends SourcePositions {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the starting position of the tree within the comment within the file.  If tree is not found within
aoqi@0:      * file, or if the starting position is not available,
aoqi@0:      * return {@link javax.tools.Diagnostic#NOPOS}.
aoqi@0:      * The given tree should be under the given comment tree, and the given documentation
aoqi@0:      * comment tree should be returned from a {@link DocTrees#getDocCommentTree(com.sun.source.util.TreePath) }
aoqi@0:      * for a tree under the given file.
aoqi@0:      * The returned position must be at the start of the yield of this tree, that
aoqi@0:      * is for any sub-tree of this tree, the following must hold:
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * {@code tree.getStartPosition() <= subtree.getStartPosition()} or <br>
aoqi@0:      * {@code tree.getStartPosition() == NOPOS} or <br>
aoqi@0:      * {@code subtree.getStartPosition() == NOPOS}
aoqi@0:      * </p>
aoqi@0:      *
aoqi@0:      * @param file CompilationUnit in which to find tree.
aoqi@0:      * @param comment the comment tree that encloses the tree for which the
aoqi@0:      *                position is being sought
aoqi@0:      * @param tree tree for which a position is sought.
aoqi@0:      * @return the start position of tree.
aoqi@0:      */
aoqi@0:     long getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets the ending position of the tree within the comment within the file.  If tree is not found within
aoqi@0:      * file, or if the ending position is not available,
aoqi@0:      * return {@link javax.tools.Diagnostic#NOPOS}.
aoqi@0:      * The given tree should be under the given comment tree, and the given documentation
aoqi@0:      * comment tree should be returned from a {@link DocTrees#getDocCommentTree(com.sun.source.util.TreePath) }
aoqi@0:      * for a tree under the given file.
aoqi@0:      * The returned position must be at the end of the yield of this tree,
aoqi@0:      * that is for any sub-tree of this tree, the following must hold:
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * {@code tree.getEndPosition() >= subtree.getEndPosition()} or <br>
aoqi@0:      * {@code tree.getEndPosition() == NOPOS} or <br>
aoqi@0:      * {@code subtree.getEndPosition() == NOPOS}
aoqi@0:      * </p>
aoqi@0:      *
aoqi@0:      * In addition, the following must hold:
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * {@code tree.getStartPosition() <= tree.getEndPosition()}  or <br>
aoqi@0:      * {@code tree.getStartPosition() == NOPOS} or <br>
aoqi@0:      * {@code tree.getEndPosition() == NOPOS}
aoqi@0:      * </p>
aoqi@0:      *
aoqi@0:      * @param file CompilationUnit in which to find tree.
aoqi@0:      * @param comment the comment tree that encloses the tree for which the
aoqi@0:      *                position is being sought
aoqi@0:      * @param tree tree for which a position is sought.
aoqi@0:      * @return the start position of tree.
aoqi@0:      */
aoqi@0:     long getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree);
aoqi@0: 
aoqi@0: }