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 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver{ 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static class TokenChannels 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All tokens go to the parser (unless skip() is called in that rule) 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * on a particular "channel". The parser tunes to a particular channel 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * so that whitespace etc... can go to the parser on a "hidden" channel. 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int Default = 0; 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Anything on different channel than DEFAULT_CHANNEL is not parsed 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * by parser. 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int Hidden = 99; 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static class TokenTypes 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int EndOfFile = (int)CharStreamConstants.EndOfFile; 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int Invalid = 0; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int EndOfRule = 1; 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>imaginary tree navigation type; traverse "get child" link</summary> */ 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int Down = 2; 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary>imaginary tree navigation type; finish with a child list</summary> */ 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int Up = 3; 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public const int Min = Up + 1; 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static class Tokens 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static readonly IToken EndOfFile = Tokens<CommonToken>.EndOfFile; 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static readonly IToken Invalid = new CommonToken( TokenTypes.Invalid ); 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** <summary> 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * In an action, a lexer rule can set token to this SKIP_TOKEN and ANTLR 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * will avoid creating a token for this symbol and try to fetch another. 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * </summary> 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static readonly IToken Skip = new CommonToken( TokenTypes.Invalid ); 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static class Tokens<T> 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver where T : IToken, new() 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static readonly T EndOfFile = new T() 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Type = TokenTypes.EndOfFile 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver }; 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static readonly T Invalid = new T() 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Type = TokenTypes.Invalid 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver }; 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public static readonly T Skip = new T() 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver { 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver Type = TokenTypes.Invalid 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver }; 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 98