1/*
2 * [The "BSD licence"]
3 * Copyright (c) 2005-2008 Terence Parr
4 * All rights reserved.
5 *
6 * Conversion to C#:
7 * Copyright (c) 2008-2009 Sam Harwell, Pixel Mine, Inc.
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote products
19 *    derived from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33namespace Antlr.Runtime.Tree
34{
35    using IList = System.Collections.IList;
36    using NotSupportedException = System.NotSupportedException;
37
38    [System.Serializable]
39    public class RewriteRuleTokenStream : RewriteRuleElementStream
40    {
41
42        public RewriteRuleTokenStream( ITreeAdaptor adaptor, string elementDescription )
43            : base( adaptor, elementDescription )
44        {
45        }
46
47        /** <summary>Create a stream with one element</summary> */
48        public RewriteRuleTokenStream( ITreeAdaptor adaptor, string elementDescription, object oneElement )
49            : base( adaptor, elementDescription, oneElement )
50        {
51        }
52
53        /** <summary>Create a stream, but feed off an existing list</summary> */
54        public RewriteRuleTokenStream( ITreeAdaptor adaptor, string elementDescription, IList elements )
55            : base( adaptor, elementDescription, elements )
56        {
57        }
58
59        /** <summary>Get next token from stream and make a node for it</summary> */
60        public virtual object NextNode()
61        {
62            IToken t = (IToken)NextCore();
63            return adaptor.Create( t );
64        }
65
66        public virtual IToken NextToken()
67        {
68            return (IToken)NextCore();
69        }
70
71        /** <summary>
72         *  Don't convert to a tree unless they explicitly call nextTree.
73         *  This way we can do hetero tree nodes in rewrite.
74         *  </summary>
75         */
76        protected override object ToTree( object el )
77        {
78            return el;
79        }
80
81        protected override object Dup( object el )
82        {
83            throw new NotSupportedException( "dup can't be called for a token stream." );
84        }
85    }
86}
87