antlr.v4.runtime.tree.SyntaxTree source code

1 /*
2  * [The "BSD license"]
3  *  Copyright (c) 2012 Terence Parr
4  *  Copyright (c) 2012 Sam Harwell
5  *  All rights reserved.
6  *
7  *  Redistribution and use in source and binary forms, with or without
8  *  modification, are permitted provided that the following conditions
9  *  are met:
10  *
11  *  1. Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer.
13  *  2. Redistributions in binary form must reproduce the above copyright
14  *     notice, this list of conditions and the following disclaimer in the
15  *     documentation and/or other materials provided with the distribution.
16  *  3. The name of the author may not be used to endorse or promote products
17  *     derived from this software without specific prior written permission.
18  *
19  *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  *  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  *  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 module antlr.v4.runtime.tree.SyntaxTree;
32 
33 import antlr.v4.runtime.tree.Tree;
34 import antlr.v4.runtime.misc.Interval;
35 
36 /**
37  * TODO add interface description
38  * @uml
39  * A tree that knows about an interval in a token stream
40  * is some kind of syntax tree. Subinterfaces distinguish
41  * between parse trees and other kinds of syntax trees we might want to create.
42  */
43 interface SyntaxTree : Tree
44 {
45 
46     /**
47      * @uml
48      * Return an {@link Interval} indicating the index in the
49      * {@link TokenStream} of the first and last token associated with this
50      * subtree. If this node is a leaf, then the interval represents a single
51      * token and has interval i..i for token index i.
52      *
53      * <p>An interval of i..i-1 indicates an empty interval at position
54      * i in the input stream, where 0 &lt;= i &lt;= the size of the input
55      * token stream.  Currently, the code base can only have i=0..n-1 but
56      * in concept one could have an empty interval after EOF. </p>
57      *
58      * <p>If source interval is unknown, this returns {@link Interval#INVALID}.</p>
59      *
60      * <p>As a weird special case, the source interval for rules matched after
61      * EOF is unspecified.</p>
62      */
63     public Interval getSourceInterval();
64 
65 }