org.antlr.v4.tool

Enum ErrorType

java.lang.Object

java.lang.Enum<ErrorType>

org.antlr.v4.tool.ErrorType

All Implemented Interfaces:

Serializable, Comparable<ErrorType>

public enum ErrorType
extends Enum<ErrorType>

A complex enumeration of all the error messages that the tool can issue.

When adding error messages, also add a description of the message to the Wiki with a location under the Wiki page Errors Reported by the ANTLR Tool.

Since:

4.0

Author:

Jim Idle , Terence Parr

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION_REDEFINITION
ALL_OPS_NEED_SAME_ASSOC
ALT_LABEL_CONFLICTS_WITH_RULE
ALT_LABEL_REDEF
ARG_CONFLICTS_WITH_RULE
ARG_CONFLICTS_WITH_TOKEN
ASSIGNMENT_TO_LIST_LABEL
ATTRIBUTE_IN_LEXER_ACTION
BAD_OPTION_SET_SYNTAX
CANNOT_CREATE_TARGET_GENERATOR
CANNOT_FIND_ATTRIBUTE_NAME_IN_DECL
CANNOT_FIND_IMPORTED_GRAMMAR
CANNOT_FIND_TOKENS_FILE
CANNOT_OPEN_FILE
CANNOT_WRITE_FILE
CODE_GEN_TEMPLATES_INCOMPLETE
CODE_TEMPLATE_ARG_ISSUE
DIR_NOT_FOUND
EPSILON_CLOSURE A rule contains a closure ((...)*) or positive closure ((...)+) around an empty alternative.
EPSILON_LR_FOLLOW In left-recursive rules, all left-recursive alternatives must match at least one symbol following the recursive rule invocation.
EPSILON_OPTIONAL A rule contains an optional block ((...)?) around an empty alternative.
EPSILON_TOKEN All non-fragment lexer rules must match at least one character.
ERROR_READING_TOKENS_FILE
EXPECTED_NON_GREEDY_WILDCARD_BLOCK
FILE_AND_GRAMMAR_NAME_DIFFER
ILLEGAL_OPTION
ILLEGAL_OPTION_VALUE
IMPLICIT_STRING_DEFINITION
IMPLICIT_TOKEN_DEFINITION
IMPORT_NAME_CLASH
INTERNAL_ERROR
INVALID_CMDLINE_ARG
INVALID_IMPORT
INVALID_LEXER_COMMAND Each lexer command requires an explicit implementation in the target templates.
INVALID_LITERAL_IN_LEXER_SET
INVALID_RULE_PARAMETER_REF
ISOLATED_RULE_REF
LABEL_BLOCK_NOT_A_SET
LABEL_CONFLICTS_WITH_ARG
LABEL_CONFLICTS_WITH_LOCAL
LABEL_CONFLICTS_WITH_RETVAL
LABEL_CONFLICTS_WITH_RULE
LABEL_CONFLICTS_WITH_TOKEN
LABEL_TYPE_CONFLICT
LEFT_RECURSION_CYCLES
LEXER_ACTION_PLACEMENT_ISSUE
LEXER_COMMAND_PLACEMENT_ISSUE
LEXER_RULES_NOT_ALLOWED
LOCAL_CONFLICTS_WITH_ARG
LOCAL_CONFLICTS_WITH_RETVAL
LOCAL_CONFLICTS_WITH_RULE
LOCAL_CONFLICTS_WITH_TOKEN
MISSING_CODE_GEN_TEMPLATES
MISSING_LEXER_COMMAND_ARGUMENT Some lexer commands require an argument.
MISSING_RULE_ARGS
MODE_NOT_IN_LEXER
MODE_WITHOUT_RULES
NO_MODEL_TO_TEMPLATE_MAPPING
NO_NON_LR_ALTS Left-recursive rules must contain at least one alternative which is not left recursive.
NO_RULES
NO_SUCH_GRAMMAR_SCOPE
NO_SUCH_RULE_IN_SCOPE
OPTIONS_IN_DELEGATE
OUTPUT_DIR_IS_FILE
PARSER_RULES_NOT_ALLOWED
REPEATED_PREQUEL
RETVAL_CONFLICTS_WITH_ARG
RETVAL_CONFLICTS_WITH_RULE
RETVAL_CONFLICTS_WITH_TOKEN
RULE_HAS_NO_ARGS
RULE_REDEFINITION
RULE_WITH_TOO_FEW_ALT_LABELS
STRING_TEMPLATE_WARNING
SYNTAX_ERROR
TOKEN_NAME_REASSIGNMENT
TOKEN_NAMES_MUST_START_UPPER
TOKENS_FILE_SYNTAX_ERROR
UNDEFINED_RULE_IN_NONLOCAL_REF
UNDEFINED_RULE_REF
UNKNOWN_ATTRIBUTE_IN_SCOPE
UNKNOWN_RULE_ATTRIBUTE
UNKNOWN_SIMPLE_ATTRIBUTE
UNSUPPORTED_REFERENCE_IN_LEXER_SET
UNTERMINATED_STRING_LITERAL The parser contains an unterminated string literal.
UNWANTED_LEXER_COMMAND_ARGUMENT A lexer command which does not take parameters was invoked with an argument.
USE_OF_BAD_WORD
V3_ASSIGN_IN_TOKENS
V3_GATED_SEMPRED
V3_LEXER_LABEL
V3_SYNPRED
V3_TOKENS_SYNTAX
V3_TREE_GRAMMAR
WARNING_TREATED_AS_ERROR

Field Summary

Fields

Modifier and Type	Field and Description
int	code
String	msg
ErrorSeverity	severity

Method Summary

Methods

Modifier and Type	Method and Description
static ErrorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ErrorType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CANNOT_WRITE_FILE

public static final ErrorType CANNOT_WRITE_FILE

INVALID_CMDLINE_ARG

public static final ErrorType INVALID_CMDLINE_ARG

CANNOT_FIND_TOKENS_FILE

public static final ErrorType CANNOT_FIND_TOKENS_FILE

ERROR_READING_TOKENS_FILE

public static final ErrorType ERROR_READING_TOKENS_FILE

DIR_NOT_FOUND

public static final ErrorType DIR_NOT_FOUND

OUTPUT_DIR_IS_FILE

public static final ErrorType OUTPUT_DIR_IS_FILE

CANNOT_OPEN_FILE

public static final ErrorType CANNOT_OPEN_FILE

FILE_AND_GRAMMAR_NAME_DIFFER

public static final ErrorType FILE_AND_GRAMMAR_NAME_DIFFER

BAD_OPTION_SET_SYNTAX

public static final ErrorType BAD_OPTION_SET_SYNTAX

WARNING_TREATED_AS_ERROR

public static final ErrorType WARNING_TREATED_AS_ERROR

INTERNAL_ERROR

public static final ErrorType INTERNAL_ERROR

TOKENS_FILE_SYNTAX_ERROR

public static final ErrorType TOKENS_FILE_SYNTAX_ERROR

STRING_TEMPLATE_WARNING

public static final ErrorType STRING_TEMPLATE_WARNING

MISSING_CODE_GEN_TEMPLATES

public static final ErrorType MISSING_CODE_GEN_TEMPLATES

CANNOT_CREATE_TARGET_GENERATOR

public static final ErrorType CANNOT_CREATE_TARGET_GENERATOR

CODE_TEMPLATE_ARG_ISSUE

public static final ErrorType CODE_TEMPLATE_ARG_ISSUE

CODE_GEN_TEMPLATES_INCOMPLETE

public static final ErrorType CODE_GEN_TEMPLATES_INCOMPLETE

NO_MODEL_TO_TEMPLATE_MAPPING

public static final ErrorType NO_MODEL_TO_TEMPLATE_MAPPING

SYNTAX_ERROR

public static final ErrorType SYNTAX_ERROR

RULE_REDEFINITION

public static final ErrorType RULE_REDEFINITION

LEXER_RULES_NOT_ALLOWED

public static final ErrorType LEXER_RULES_NOT_ALLOWED

PARSER_RULES_NOT_ALLOWED

public static final ErrorType PARSER_RULES_NOT_ALLOWED

REPEATED_PREQUEL

public static final ErrorType REPEATED_PREQUEL

UNDEFINED_RULE_REF

public static final ErrorType UNDEFINED_RULE_REF

UNDEFINED_RULE_IN_NONLOCAL_REF

public static final ErrorType UNDEFINED_RULE_IN_NONLOCAL_REF

TOKEN_NAMES_MUST_START_UPPER

public static final ErrorType TOKEN_NAMES_MUST_START_UPPER

UNKNOWN_SIMPLE_ATTRIBUTE

public static final ErrorType UNKNOWN_SIMPLE_ATTRIBUTE

INVALID_RULE_PARAMETER_REF

public static final ErrorType INVALID_RULE_PARAMETER_REF

UNKNOWN_RULE_ATTRIBUTE

public static final ErrorType UNKNOWN_RULE_ATTRIBUTE

UNKNOWN_ATTRIBUTE_IN_SCOPE

public static final ErrorType UNKNOWN_ATTRIBUTE_IN_SCOPE

ISOLATED_RULE_REF

public static final ErrorType ISOLATED_RULE_REF

LABEL_CONFLICTS_WITH_RULE

public static final ErrorType LABEL_CONFLICTS_WITH_RULE

LABEL_CONFLICTS_WITH_TOKEN

public static final ErrorType LABEL_CONFLICTS_WITH_TOKEN

LABEL_CONFLICTS_WITH_ARG

public static final ErrorType LABEL_CONFLICTS_WITH_ARG

LABEL_CONFLICTS_WITH_RETVAL

public static final ErrorType LABEL_CONFLICTS_WITH_RETVAL

LABEL_CONFLICTS_WITH_LOCAL

public static final ErrorType LABEL_CONFLICTS_WITH_LOCAL

LABEL_TYPE_CONFLICT

public static final ErrorType LABEL_TYPE_CONFLICT

RETVAL_CONFLICTS_WITH_ARG

public static final ErrorType RETVAL_CONFLICTS_WITH_ARG

MISSING_RULE_ARGS

public static final ErrorType MISSING_RULE_ARGS

RULE_HAS_NO_ARGS

public static final ErrorType RULE_HAS_NO_ARGS

ILLEGAL_OPTION

public static final ErrorType ILLEGAL_OPTION

ILLEGAL_OPTION_VALUE

public static final ErrorType ILLEGAL_OPTION_VALUE

ACTION_REDEFINITION

public static final ErrorType ACTION_REDEFINITION

NO_RULES

public static final ErrorType NO_RULES

NO_SUCH_GRAMMAR_SCOPE

public static final ErrorType NO_SUCH_GRAMMAR_SCOPE

NO_SUCH_RULE_IN_SCOPE

public static final ErrorType NO_SUCH_RULE_IN_SCOPE

TOKEN_NAME_REASSIGNMENT

public static final ErrorType TOKEN_NAME_REASSIGNMENT

OPTIONS_IN_DELEGATE

public static final ErrorType OPTIONS_IN_DELEGATE

CANNOT_FIND_IMPORTED_GRAMMAR

public static final ErrorType CANNOT_FIND_IMPORTED_GRAMMAR

INVALID_IMPORT

public static final ErrorType INVALID_IMPORT

IMPORT_NAME_CLASH

public static final ErrorType IMPORT_NAME_CLASH

ALL_OPS_NEED_SAME_ASSOC

public static final ErrorType ALL_OPS_NEED_SAME_ASSOC

LEFT_RECURSION_CYCLES

public static final ErrorType LEFT_RECURSION_CYCLES

MODE_NOT_IN_LEXER

public static final ErrorType MODE_NOT_IN_LEXER

CANNOT_FIND_ATTRIBUTE_NAME_IN_DECL

public static final ErrorType CANNOT_FIND_ATTRIBUTE_NAME_IN_DECL

RULE_WITH_TOO_FEW_ALT_LABELS

public static final ErrorType RULE_WITH_TOO_FEW_ALT_LABELS

ALT_LABEL_REDEF

public static final ErrorType ALT_LABEL_REDEF

ALT_LABEL_CONFLICTS_WITH_RULE

public static final ErrorType ALT_LABEL_CONFLICTS_WITH_RULE

IMPLICIT_TOKEN_DEFINITION

public static final ErrorType IMPLICIT_TOKEN_DEFINITION

IMPLICIT_STRING_DEFINITION

public static final ErrorType IMPLICIT_STRING_DEFINITION

ATTRIBUTE_IN_LEXER_ACTION

public static final ErrorType ATTRIBUTE_IN_LEXER_ACTION

LABEL_BLOCK_NOT_A_SET

public static final ErrorType LABEL_BLOCK_NOT_A_SET

EXPECTED_NON_GREEDY_WILDCARD_BLOCK

public static final ErrorType EXPECTED_NON_GREEDY_WILDCARD_BLOCK

LEXER_ACTION_PLACEMENT_ISSUE

public static final ErrorType LEXER_ACTION_PLACEMENT_ISSUE

LEXER_COMMAND_PLACEMENT_ISSUE

public static final ErrorType LEXER_COMMAND_PLACEMENT_ISSUE

USE_OF_BAD_WORD

public static final ErrorType USE_OF_BAD_WORD

UNSUPPORTED_REFERENCE_IN_LEXER_SET

public static final ErrorType UNSUPPORTED_REFERENCE_IN_LEXER_SET

ASSIGNMENT_TO_LIST_LABEL

public static final ErrorType ASSIGNMENT_TO_LIST_LABEL

RETVAL_CONFLICTS_WITH_RULE

public static final ErrorType RETVAL_CONFLICTS_WITH_RULE

RETVAL_CONFLICTS_WITH_TOKEN

public static final ErrorType RETVAL_CONFLICTS_WITH_TOKEN

ARG_CONFLICTS_WITH_RULE

public static final ErrorType ARG_CONFLICTS_WITH_RULE

ARG_CONFLICTS_WITH_TOKEN

public static final ErrorType ARG_CONFLICTS_WITH_TOKEN

LOCAL_CONFLICTS_WITH_RULE

public static final ErrorType LOCAL_CONFLICTS_WITH_RULE

LOCAL_CONFLICTS_WITH_TOKEN

public static final ErrorType LOCAL_CONFLICTS_WITH_TOKEN

LOCAL_CONFLICTS_WITH_ARG

public static final ErrorType LOCAL_CONFLICTS_WITH_ARG

LOCAL_CONFLICTS_WITH_RETVAL

public static final ErrorType LOCAL_CONFLICTS_WITH_RETVAL

INVALID_LITERAL_IN_LEXER_SET

public static final ErrorType INVALID_LITERAL_IN_LEXER_SET

MODE_WITHOUT_RULES

public static final ErrorType MODE_WITHOUT_RULES

EPSILON_TOKEN

public static final ErrorType EPSILON_TOKEN

All non-fragment lexer rules must match at least one character.

The following example shows this error.

 Whitespace : [ \t]+;  // ok
 Whitespace : [ \t];   // ok

 fragment WS : [ \t]*; // ok

 Whitespace : [ \t]*;  // error 146
 

NO_NON_LR_ALTS

public static final ErrorType NO_NON_LR_ALTS

Left-recursive rules must contain at least one alternative which is not left recursive.

The following rule produces this error.

 // error 147:
 a : a ID
   | a INT
   ;
 

EPSILON_LR_FOLLOW

public static final ErrorType EPSILON_LR_FOLLOW

In left-recursive rules, all left-recursive alternatives must match at least one symbol following the recursive rule invocation.

The following rule produces this error.

 a : ID    // ok        (alternative is not left recursive)
   | a INT // ok        (a must be follow by INT)
   | a ID? // error 148 (the ID following a is optional)
   ;
 

INVALID_LEXER_COMMAND

public static final ErrorType INVALID_LEXER_COMMAND

Each lexer command requires an explicit implementation in the target templates. This error indicates that the command was incorrectly written or is not supported by the current target.

The following rule produces this error.

 X : 'foo' -> type(Foo);  // ok
 Y : 'foo' -> token(Foo); // error 149 (token is not a supported lexer command)
 

MISSING_LEXER_COMMAND_ARGUMENT

public static final ErrorType MISSING_LEXER_COMMAND_ARGUMENT

Some lexer commands require an argument.

The following rule produces this error.

 X : 'foo' -> type(Foo); // ok
 Y : 'foo' -> type;      // error 150 (the type command requires an argument)
 

UNWANTED_LEXER_COMMAND_ARGUMENT

public static final ErrorType UNWANTED_LEXER_COMMAND_ARGUMENT

A lexer command which does not take parameters was invoked with an argument.

The following rule produces this error.

 X : 'foo' -> popMode;    // ok
 Y : 'foo' -> popMode(A); // error 151 (the popMode command does not take an argument)
 

UNTERMINATED_STRING_LITERAL

public static final ErrorType UNTERMINATED_STRING_LITERAL

The parser contains an unterminated string literal.

The following rule produces this error.

 x : 'x'; // ok
 y : 'y;  // error 152
 

EPSILON_CLOSURE

public static final ErrorType EPSILON_CLOSURE

A rule contains a closure ((...)*) or positive closure ((...)+) around an empty alternative.

The following rule produces this error.

 x  : ;
 y  : x+;                                // error 153
 z1 : ('foo' | 'bar'? 'bar2'?)*;         // error 153
 z2 : ('foo' | 'bar' 'bar2'? | 'bar2')*; // ok
 

EPSILON_OPTIONAL

public static final ErrorType EPSILON_OPTIONAL

A rule contains an optional block ((...)?) around an empty alternative.

The following rule produces this warning.

 x  : ;
 y  : x?;                                // warning 154
 z1 : ('foo' | 'bar'? 'bar2'?)?;         // warning 154
 z2 : ('foo' | 'bar' 'bar2'? | 'bar2')?; // ok
 

V3_TREE_GRAMMAR

public static final ErrorType V3_TREE_GRAMMAR

V3_LEXER_LABEL

public static final ErrorType V3_LEXER_LABEL

V3_TOKENS_SYNTAX

public static final ErrorType V3_TOKENS_SYNTAX

V3_ASSIGN_IN_TOKENS

public static final ErrorType V3_ASSIGN_IN_TOKENS

V3_GATED_SEMPRED

public static final ErrorType V3_GATED_SEMPRED

V3_SYNPRED

public static final ErrorType V3_SYNPRED

Field Detail

msg

public final String msg

code

public final int code

severity

public final ErrorSeverity severity

Method Detail

values

public static ErrorType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ErrorType c : ErrorType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ErrorType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null