Alachisoft.NCache.Parser.ParseMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nc-parser Show documentation

Internal package of Alachisoft.

There is a newer version: 5.3.3

package Alachisoft.NCache.Parser;

// C# Translation of GoldParser, by Marcus Klimstra .
// Based on GOLDParser by Devin Cook .

/**
 * The result of the Parser.Parse method.
 */
public enum ParseMessage {
    /**
     * This message is returned each time a token is read.
     */
    TokenRead,

    /**
     * When the engine is able to reduce a rule, this message is returned.
     * The rule that was reduced is set in the Parser.Reduction property.
     * The tokens that are reduced and correspond to the rule's definition
     * can be acquired using the GetToken or GetTokens methods.
     */
    Reduction,

    /**
     * The engine will returns this message when the source text has been
     * accepted as both complete and correct. In other words, the source
     * text was successfully analyzed.
     */
    Accept,

    /**
     * The tokenizer will generate this message when it is unable to
     * recognize a series of characters as a valid token. To recover, pop the
     * invalid token from the input queue using Parser.PopInputToken.
     */
    LexicalError,

    /**
     * Often the parser will read a token that is not expected in the
     * grammar. When this happens, you can acquire the expected tokens using
     * the GetToken or GetTokens methods. To recover, push
     * one of the expected tokens onto the input queue.
     */
    SyntaxError,

    /**
     * The parser reached the end of the file while reading a comment.
     * This is caused when the source text contains a "run-away" comment,
     * or in other words, a block comment that lacks the end-delimiter.
     */
    CommentError,

    /**
     * Something is very wrong when this message is returned.
     */
    InternalError;

    public static ParseMessage forValue(int value) {
        return values()[value];
    }

    public int getValue() {
        return this.ordinal();
    }
}