SymbolType.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
// 
// ----------------------------------------------------------------------
//  Gold Parser engine.
//  See more details on http://www.devincook.com/goldparser/
//  
//  Original code is written in VB by Devin Cook (GOLDParser@DevinCook.com)
// 
//  This translation is done by Vladimir Morozov (vmoroz@hotmail.com)
//  
//  The translation is based on the other engine translations:
//  Delphi engine by Alexandre Rai (riccio@gmx.at)
//  C# engine by Marcus Klimstra (klimstra@home.nl)
// ----------------------------------------------------------------------
#region Using directives

using System;

#endregion

namespace GoldParser
{
    /// <summary>
    /// Type of symbol.
    /// </summary>
    internal enum SymbolType
    {
        /// <summary>
        /// Normal nonterminal
        /// </summary>
        NonTerminal = 0, 

        /// <summary>
        /// Normal terminal
        /// </summary>
        Terminal = 1,  
    
        /// <summary>
        /// This Whitespace symbols is a special terminal
        /// that is automatically ignored the the parsing engine.
        /// Any text accepted as whitespace is considered
        /// to be inconsequential and "meaningless".
        /// </summary>
        WhiteSpace = 2, 
    
        /// <summary>
        /// The End symbol is generated when the tokenizer
        /// reaches the end of the source text.
        /// </summary>
        End = 3, 
     
        /// <summary>
        /// This type of symbol designates the start of a block quote.
        /// </summary>
        CommentStart = 4,

        /// <summary>
        /// This type of symbol designates the end of a block quote.
        /// </summary>
        CommentEnd = 5,

        /// <summary>
        /// When the engine reads a token that is recognized as
        /// a line comment, the remaining characters on the line
        /// are automatically ignored by the parser.
        /// </summary>
        CommentLine = 6,
    
        /// <summary>
        /// The Error symbol is a general-purpose means
        /// of representing characters that were not recognized
        /// by the tokenizer. In other words, when the tokenizer
        /// reads a series of characters that is not accepted
        /// by the DFA engine, a token of this type is created.
        /// </summary>
        Error = 7
    }
}