1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * [The "BSD licence"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Copyright (c) 2005-2008 Terence Parr 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Conversion to C#: 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Copyright (c) 2008-2009 Sam Harwell, Pixel Mine, Inc. 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All rights reserved. 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Redistribution and use in source and binary forms, with or without 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * modification, are permitted provided that the following conditions 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * are met: 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 1. Redistributions of source code must retain the above copyright 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer. 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 2. Redistributions in binary form must reproduce the above copyright 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer in the 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * documentation and/or other materials provided with the distribution. 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 3. The name of the author may not be used to endorse or promote products 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * derived from this software without specific prior written permission. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruvernamespace Antlr.Runtime.Tree { 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver using System.Collections.Generic; 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * What does a tree look like? ANTLR has a number of support classes 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * such as CommonTreeNodeStream that work on these kinds of trees. You 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * don't have to make your trees implement this interface, but if you do, 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * you'll be able to use more support code. 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * <remarks> 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * NOTE: When constructing trees, ANTLR can build any kind of tree; it can 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * even use Token objects as trees if you add a child list to your tokens. 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * This is a tree node without any payload; just navigation and factory stuff. 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </remarks> 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public interface ITree { 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ITree GetChild(int i); 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int ChildCount { 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver // Tree tracks parent and child index now > 3.0 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ITree Parent { 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Is there is a node above with token type ttype?</summary> */ 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bool HasAncestor(int ttype); 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Walk upwards and get first ancestor with this token type.</summary> */ 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ITree GetAncestor(int ttype); 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Return a list of all ancestors of this node. The first node of 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * list is the root and the last is the parent of this node. 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver IList<ITree> GetAncestors(); 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>This node is what child index? 0..n-1</summary> */ 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int ChildIndex { 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Set the parent and child index values for all children</summary> */ 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void FreshenParentAndChildIndexes(); 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Add t as a child to this node. If t is null, do nothing. If t 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * is nil, add all children of t to this' children. 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void AddChild(ITree t); 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Set ith child (0..n-1) to t; t must be non-null and non-nil node</summary> */ 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void SetChild(int i, ITree t); 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver object DeleteChild(int i); 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Delete children from start to stop and replace with t even if t is 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a list (nil-root tree). num of children can increase or decrease. 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * For huge child lists, inserting children can force walking rest of 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * children to set their childindex; could be slow. 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver void ReplaceChildren(int startChildIndex, int stopChildIndex, object t); 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Indicates the node is a nil node but may still have children, meaning 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * the tree is a flat list. 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 113324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver bool IsNil { 114324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 115324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 116324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 117324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 118324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * What is the smallest token index (indexing from 0) for this node 119324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and its children? 120324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 121324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 122324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int TokenStartIndex { 123324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 124324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 125324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 126324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 127324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 128324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * What is the largest token index (indexing from 0) for this node 129324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * and its children? 130324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 131324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 132324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int TokenStopIndex { 133324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 134324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver set; 135324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 136324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 137324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ITree DupNode(); 138324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 139324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>Return a token type; needed for tree parsing</summary> */ 140324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int Type { 141324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 142324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 143324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 144324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string Text { 145324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 146324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 147324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 148324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>In case we don't have a token payload, what is the line for errors?</summary> */ 149324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int Line { 150324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 151324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 152324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 153324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver int CharPositionInLine { 154324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver get; 155324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 156324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 157324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string ToStringTree(); 158324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 159324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver string ToString(); 160324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 161324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 162