aboutsummaryrefslogtreecommitdiff
path: root/runtime/CSharp3/Sources/Antlr3.Runtime/Tree/ParseTree.cs
blob: 149269a281093abc5458925540ac6b6bc0bd388c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*
 * [The "BSD licence"]
 * Copyright (c) 2005-2008 Terence Parr
 * All rights reserved.
 *
 * Conversion to C#:
 * Copyright (c) 2008-2009 Sam Harwell, Pixel Mine, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace Antlr.Runtime.Tree
{
    using System.Collections.Generic;

    using StringBuilder = System.Text.StringBuilder;

    /** <summary>
     *  A record of the rules used to match a token sequence.  The tokens
     *  end up as the leaves of this tree and rule nodes are the interior nodes.
     *  This really adds no functionality, it is just an alias for CommonTree
     *  that is more meaningful (specific) and holds a String to display for a node.
     *  </summary>
     */
    [System.Serializable]
    public class ParseTree : BaseTree
    {
        public object payload;
        public List<IToken> hiddenTokens;

        public ParseTree( object label )
        {
            this.payload = label;
        }

        #region Properties
        public override string Text
        {
            get
            {
                return ToString();
            }
            set
            {
            }
        }
        public override int TokenStartIndex
        {
            get
            {
                return 0;
            }
            set
            {
            }
        }
        public override int TokenStopIndex
        {
            get
            {
                return 0;
            }
            set
            {
            }
        }
        public override int Type
        {
            get
            {
                return 0;
            }
            set
            {
            }
        }
        #endregion

        public override ITree DupNode()
        {
            return null;
        }

        public override string ToString()
        {
            if ( payload is IToken )
            {
                IToken t = (IToken)payload;
                if ( t.Type == TokenTypes.EndOfFile )
                {
                    return "<EOF>";
                }
                return t.Text;
            }
            return payload.ToString();
        }

        /** <summary>
         *  Emit a token and all hidden nodes before.  EOF node holds all
         *  hidden tokens after last real token.
         *  </summary>
         */
        public virtual string ToStringWithHiddenTokens()
        {
            StringBuilder buf = new StringBuilder();
            if ( hiddenTokens != null )
            {
                for ( int i = 0; i < hiddenTokens.Count; i++ )
                {
                    IToken hidden = (IToken)hiddenTokens[i];
                    buf.Append( hidden.Text );
                }
            }
            string nodeText = this.ToString();
            if ( !nodeText.Equals( "<EOF>" ) )
                buf.Append( nodeText );
            return buf.ToString();
        }

        /** <summary>
         *  Print out the leaves of this tree, which means printing original
         *  input back out.
         *  </summary>
         */
        public virtual string ToInputString()
        {
            StringBuilder buf = new StringBuilder();
            ToStringLeaves( buf );
            return buf.ToString();
        }

        protected virtual void ToStringLeaves( StringBuilder buf )
        {
            if ( payload is IToken )
            { // leaf node token?
                buf.Append( this.ToStringWithHiddenTokens() );
                return;
            }
            for ( int i = 0; Children != null && i < Children.Count; i++ )
            {
                ParseTree t = (ParseTree)Children[i];
                t.ToStringLeaves( buf );
            }
        }
    }
}