1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver [The "BSD licence"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Copyright (c) 2005-2007 Terence Parr 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Redistribution and use in source and binary forms, with or without 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver modification, are permitted provided that the following conditions 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver are met: 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 1. Redistributions of source code must retain the above copyright 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer. 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 2. Redistributions in binary form must reproduce the above copyright 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver notice, this list of conditions and the following disclaimer in the 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver documentation and/or other materials provided with the distribution. 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 3. The name of the author may not be used to endorse or promote products 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver derived from this software without specific prior written permission. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver*/ 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpackage org.antlr.runtime.tree { 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver import org.antlr.runtime.*; 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** How to create and navigate trees. Rather than have a separate factory 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and adaptor, I've merged them. Makes sense to encapsulate. 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This takes the place of the tree construction code generated in the 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * generated code in 2.x and the ASTFactory. 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * I do not need to know the type of a tree at all so they are all 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * generic Objects. This may increase the amount of typecasting needed. :( 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public interface TreeAdaptor { 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // C o n s t r u c t i o n 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Create a tree node from Token object; for CommonTree type trees, 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * then the token just becomes the payload. This is the most 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * common create call. 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Override if you want another kind of node to be built. 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function createWithPayload(payload:Token):Object; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Duplicate a single tree node. 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Override if you want another kind of node to be built. 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function dupNode(treeNode:Object):Object; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Duplicate tree recursively, using dupNode() for each node */ 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function dupTree(tree:Object):Object; 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Return a nil node (an empty but non-null node) that can hold 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a list of element as the children. If you want a flat tree (a list) 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * use "t=adaptor.nil(); t.addChild(x); t.addChild(y);" 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function nil():Object; 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Return a tree node representing an error. This node records the 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * tokens consumed during error recovery. The start token indicates the 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * input symbol at which the error was detected. The stop token indicates 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the last symbol consumed during recovery. 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * You must specify the input stream so that the erroneous text can 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * be packaged up in the error node. The exception could be useful 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * to some applications; default implementation stores ptr to it in 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the CommonErrorNode. 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This only makes sense during token parsing, not tree parsing. 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Tree parsing should happen only when parsing and tree construction 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * succeed. 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function errorNode(input:TokenStream, start:Token, stop:Token, e:RecognitionException):Object; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Is tree considered a nil node used to make lists of child nodes? */ 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function isNil(tree:Object):Boolean; 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Add a child to the tree t. If child is a flat tree (a list), make all 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * in list children of t. Warning: if t has no children, but child does 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and child isNil then you can decide it is ok to move children to t via 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * t.children = child.children; i.e., without copying the array. Just 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * make sure that this is consistent with have the user will build 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * ASTs. Do nothing if t or child is null. 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function addChild(t:Object, child:Object):void; 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** If oldRoot is a nil root, just copy or move the children to newRoot. 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If not a nil root, make oldRoot a child of newRoot. 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * old=^(nil a b c), new=r yields ^(r a b c) 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * old=^(a b c), new=r yields ^(r ^(a b c)) 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If newRoot is a nil-rooted single child tree, use the single 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * child as the new root node. 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * old=^(nil a b c), new=^(nil r) yields ^(r a b c) 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * old=^(a b c), new=^(nil r) yields ^(r ^(a b c)) 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If oldRoot was null, it's ok, just return newRoot (even if isNil). 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * old=null, new=r yields r 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * old=null, new=^(nil r) yields ^(nil r) 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Return newRoot. Throw an exception if newRoot is not a 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * simple node or nil root with a single child node--it must be a root 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * node. If newRoot is ^(nil x) return x as newRoot. 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Be advised that it's ok for newRoot to point at oldRoot's 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * children; i.e., you don't have to copy the list. We are 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * constructing these nodes so we should have this control for 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * efficiency. 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function becomeRoot(newRoot:Object, oldRoot:Object):Object; 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Given the root of the subtree created for this rule, post process 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * it to do any simplifications or whatever you want. A required 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * behavior is to convert ^(nil singleSubtree) to singleSubtree 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * as the setting of start/stop indexes relies on a single non-nil root 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * for non-flat trees. 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Flat trees such as for lists like "idlist : ID+ ;" are left alone 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * unless there is only one ID. For a list, the start/stop indexes 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * are set in the nil node. 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This method is executed after all rule tree construction and right 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * before setTokenBoundaries(). 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function rulePostProcessing(root:Object):Object; 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** For identifying trees. 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * How to identify nodes so we can say "add node to a prior node"? 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Even becomeRoot is an issue. Use System.identityHashCode(node) 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * usually. 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getUniqueID(node:Object):int; 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // R e w r i t e R u l e s 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Create a new node derived from a token, with a new token type. 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This is invoked from an imaginary node ref on right side of a 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * rewrite rule as IMAG[$tokenLabel] or IMAG[$tokenLabel, "IMAG"]. 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This should invoke createToken(Token). 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function createFromToken(tokenType:int, fromToken:Token, text:String = null):Object; 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Create a new node derived from a token, with a new token type. 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This is invoked from an imaginary node ref on right side of a 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * rewrite rule as IMAG["IMAG"]. 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This should invoke createToken(int,String). 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 162324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function createFromType(tokenType:int, text:String):Object; 163324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 164324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 165324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // C o n t e n t 166324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 167324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** For tree parsing, I need to know the token type of a node */ 168324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getType(t:Object):int; 169324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 170324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Node constructors can set the type of a node */ 171324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function setType(t:Object, type:int):void; 172324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 173324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getText(t:Object):String; 174324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 175324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Node constructors can set the text of a node */ 176324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function setText(t:Object, text:String):void; 177324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 178324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Return the token object from which this node was created. 179324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Currently used only for printing an error message. 180324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * The error display routine in BaseRecognizer needs to 181324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * display where the input the error occurred. If your 182324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * tree of limitation does not store information that can 183324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * lead you to the token, you can create a token filled with 184324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the appropriate information and pass that back. See 185324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * BaseRecognizer.getErrorMessage(). 186324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 187324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getToken(t:Object):Token; 188324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 189324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Where are the bounds in the input token stream for this node and 190324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * all children? Each rule that creates AST nodes will call this 191324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * method right before returning. Flat trees (i.e., lists) will 192324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * still usually have a nil root node just to hold the children list. 193324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * That node would contain the start/stop indexes then. 194324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 195324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function setTokenBoundaries(t:Object, startToken:Token, stopToken:Token):void; 196324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 197324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Get the token start index for this subtree; return -1 if no such index */ 198324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getTokenStartIndex(t:Object):int; 199324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 200324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Get the token stop index for this subtree; return -1 if no such index */ 201324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getTokenStopIndex(t:Object):int; 202324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 203324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 204324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // N a v i g a t i o n / T r e e P a r s i n g 205324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 206324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Get a child 0..n-1 node */ 207324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getChild(t:Object, i:int):Object; 208324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 209324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Set ith child (0..n-1) to t; t must be non-null and non-nil node */ 210324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function setChild(t:Object, i:int, child:Object):void; 211324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 212324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Remove ith child and shift children down from right. */ 213324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function deleteChild(t:Object, i:int):Object; 214324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 215324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** How many children? If 0, then this is a leaf node */ 216324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getChildCount(t:Object):int; 217324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 218324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Who is the parent node of this node; if null, implies node is root. 219324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If your node type doesn't handle this, it's ok but the tree rewrites 220324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * in tree parsers need this functionality. 221324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 222324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getParent(t:Object):Object; 223324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function setParent(t:Object, parent:Object):void; 224324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 225324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** What index is this node in the child list? Range: 0..n-1 226324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If your node type doesn't handle this, it's ok but the tree rewrites 227324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * in tree parsers need this functionality. 228324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 229324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function getChildIndex(t:Object):int; 230324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function setChildIndex(t:Object, index:int):void; 231324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 232324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Replace from start to stop child index of parent with t, which might 233324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * be a list. Number of children may be different 234324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * after this call. 235324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 236324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * If parent is null, don't do anything; must be at root of overall tree. 237324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Can't replace whatever points to the parent externally. Do nothing. 238324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 239324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function replaceChildren(parent:Object, startChildIndex:int, stopChildIndex:int, t:Object):void; 240324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 241324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 242324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Code - generator support - TODO place in separate namespace 243324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 244324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** 245324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Private method used by generated code. Based on type and number of arguments will call one of: 246324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 247324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * * createWithPayload 248324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * * createFromToken 249324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * * createFromType 250324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 251324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver function create(... args):Object; 252324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 253324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver}