org.parboiled.errors

Class ErrorUtils

java.lang.Object

org.parboiled.errors.ErrorUtils

public final class ErrorUtils
extends java.lang.Object

General utility methods regarding parse errors.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.RuntimeException	UnderneathTestNot

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ErrorUtils()

Method Summary

Modifier and Type	Method and Description
(package private) static Matcher	findProperLabelMatcher(MatcherPath path, int errorIndex) Finds the Matcher in the given failedMatcherPath whose label is best for presentation in "expected" strings of parse error messages, given the provided lastMatchPath.
private static Matcher	findProperLabelMatcher0(MatcherPath path, int errorIndex)
static java.lang.String	printErrorMessage(java.lang.String format, java.lang.String errorMessage, int errorIndex, InputBuffer inputBuffer) Prints an error message showing a location in the given InputBuffer.
static java.lang.String	printErrorMessage(java.lang.String format, java.lang.String errorMessage, int startIndex, int endIndex, InputBuffer inputBuffer) Prints an error message showing a location in the given InputBuffer.
static java.lang.String	printParseError(ParseError error) Pretty prints the given parse error showing its location in the given input buffer.
static java.lang.String	printParseError(ParseError error, Formatter<InvalidInputError> formatter) Pretty prints the given parse error showing its location in the given input buffer.
static java.lang.String	printParseErrors(java.util.List<ParseError> errors) Pretty prints the given parse errors showing their location in the given input buffer.
static java.lang.String	printParseErrors(ParsingResult<?> parsingResult) Pretty prints the parse errors of the given ParsingResult showing their location in the given input buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UnderneathTestNot

private static java.lang.RuntimeException UnderneathTestNot

Constructor Detail

ErrorUtils

private ErrorUtils()

Method Detail

findProperLabelMatcher

static Matcher findProperLabelMatcher(MatcherPath path,
                                      int errorIndex)

Finds the Matcher in the given failedMatcherPath whose label is best for presentation in "expected" strings of parse error messages, given the provided lastMatchPath.

Parameters:

path - the path to the failed matcher

errorIndex - the start index of the respective parse error

Returns:

the matcher whose label is best for presentation in "expected" strings

findProperLabelMatcher0

private static Matcher findProperLabelMatcher0(MatcherPath path,
                                               int errorIndex)

printParseErrors

public static java.lang.String printParseErrors(ParsingResult<?> parsingResult)

Pretty prints the parse errors of the given ParsingResult showing their location in the given input buffer.

Parameters:

parsingResult - the parsing result

Returns:

the pretty print text

printParseErrors

public static java.lang.String printParseErrors(java.util.List<ParseError> errors)

Pretty prints the given parse errors showing their location in the given input buffer.

Parameters:

errors - the parse errors

Returns:

the pretty print text

printParseError

public static java.lang.String printParseError(ParseError error)

Pretty prints the given parse error showing its location in the given input buffer.

Parameters:

error - the parse error

Returns:

the pretty print text

printParseError

public static java.lang.String printParseError(ParseError error,
                                               Formatter<InvalidInputError> formatter)

Pretty prints the given parse error showing its location in the given input buffer.

Parameters:

error - the parse error

formatter - the formatter for InvalidInputErrors

Returns:

the pretty print text

printErrorMessage

public static java.lang.String printErrorMessage(java.lang.String format,
                                                 java.lang.String errorMessage,
                                                 int errorIndex,
                                                 InputBuffer inputBuffer)

Prints an error message showing a location in the given InputBuffer.

Parameters:

format - the format string, must include three placeholders for a string (the error message) and two integers (the error line / column respectively)

errorMessage - the error message

errorIndex - the error location as an index into the inputBuffer

inputBuffer - the underlying InputBuffer

Returns:

the error message including the relevant line from the underlying input plus location indicator

printErrorMessage

public static java.lang.String printErrorMessage(java.lang.String format,
                                                 java.lang.String errorMessage,
                                                 int startIndex,
                                                 int endIndex,
                                                 InputBuffer inputBuffer)

Prints an error message showing a location in the given InputBuffer.

Parameters:

format - the format string, must include three placeholders for a string (the error message) and two integers (the error line / column respectively)

errorMessage - the error message

startIndex - the start location of the error as an index into the inputBuffer

endIndex - the end location of the error as an index into the inputBuffer

inputBuffer - the underlying InputBuffer

Returns:

the error message including the relevant line from the underlying input plus location indicators