class DefaultErrorBuilder extends ErrorBuilder[String] with Revision1
This is the class used to build Parsley's default error messages.
While it compiles with the ErrorBuilder typeclass, it should not
be considered a stable contract: the formatting can be changed at any
time and without notice. The API, however, will remain stable.
- Since
3.0.0
- Alphabetic
- By Inheritance
- DefaultErrorBuilder
- Revision1
- ErrorBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new DefaultErrorBuilder()
Type Members
-
type
EndOfInput = String
Represents the end of the input.
Represents the end of the input.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
ErrorInfoLines = List[String]
The representation type of the main body within the error message
The representation type of the main body within the error message
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
ExpectedItems = Option[String]
The representation of all the different possible tokens that could have prevented an error.
The representation of all the different possible tokens that could have prevented an error.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
-
type
ExpectedLine = Option[String]
The representation of the information regarding the solving tokens.
The representation of the information regarding the solving tokens.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
Item = String
The base type of
Raw,NamedandEndOfInputthat represents the individual items within the error.The base type of
Raw,NamedandEndOfInputthat represents the individual items within the error.- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
LineInfo = List[String]
The representation of the line of input where the error occurred.
The representation of the line of input where the error occurred.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
Message = String
The representation of a reason or a message generated by the parser.
The representation of a reason or a message generated by the parser.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
Messages = List[Message]
The representation of the combined reasons or failure messages from the parser.
The representation of the combined reasons or failure messages from the parser.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
-
type
Named = String
This represents "named" tokens, which have been provided with a label.
This represents "named" tokens, which have been provided with a label.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
Position = String
The representation type of position information within the generated message
The representation type of position information within the generated message
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
Raw = String
This represents "raw" tokens, where are those without labels: i.e.
This represents "raw" tokens, where are those without labels: i.e. they come direct from the input, or the characters that the parser is trying to read.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
Source = Option[String]
The representation of the file information
The representation of the file information
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
type
UnexpectedLine = Option[String]
The representation of the information regarding the problematic token.
The representation of the information regarding the problematic token.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
combineExpectedItems(alts: Set[Item]): ExpectedItems
Details how to combine the various expected items into a single representation.
Details how to combine the various expected items into a single representation.
- alts
The possible items that fix the error
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
def
combineMessages(alts: Set[Message]): Messages
Details how to combine any reasons or messages generated within a single error.
Details how to combine any reasons or messages generated within a single error. Reasons are used by
vanillamessages and messages are used byspecialisedmessages.- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
val
endOfInput: EndOfInput
Value that represents the end of the input in the error message.
Value that represents the end of the input in the error message.
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
expected(alts: ExpectedItems): ExpectedLine
Describes how to handle the information about the tokens that could have avoided the error.
Describes how to handle the information about the tokens that could have avoided the error.
- alts
The tokens that could have prevented the error (see the
combineExpectedItemsmethod)
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
format(pos: Position, source: Source, lines: ErrorInfoLines): String
This is the top level function, which finally compiles all the formatted sub-parts into a finished value of type
Err.This is the top level function, which finally compiles all the formatted sub-parts into a finished value of type
Err.- pos
This is the representation of the position of the error in the input (see the
posmethod)- source
This is the representation of the filename (if it exists) (see the
sourcemethod)- lines
This is the main body of the error message (see
vanillaErrororspecialisedErrormethods)- returns
The final assembled error message
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
lineInfo(line: String, linesBefore: List[String], linesAfter: List[String], errorPointsAt: Int): LineInfo
Describes how to format the information about the line that the error occured on.
Describes how to format the information about the line that the error occured on.
- line
The full line of input that produced this error message
- linesBefore
The lines of input just before the one that produced this message (up to
numLinesBefore)- linesAfter
The lines of input just after the one that produced this message (up to
numLinesAfter)- errorPointsAt
The offset into the line that the error points at
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.1.0
-
def
message(msg: String): Message
Describes how to represent the messages produced by the
failcombinator (or any that are implemented using it).Describes how to represent the messages produced by the
failcombinator (or any that are implemented using it).- msg
The message produced by the parser
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
def
named(item: String): Named
Formats a named item generated by a label.
Formats a named item generated by a label.
- item
The name given to the label
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
numLinesAfter: Int
The number of lines of input to request after an error occured
The number of lines of input to request after an error occured
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.1.0
-
val
numLinesBefore: Int
The number of lines of input to request before an error occured
The number of lines of input to request before an error occured
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.1.0
-
def
pos(line: Int, col: Int): Position
Formats a position into the representation type given by
Position.Formats a position into the representation type given by
Position.- line
The line the error occurred at
- col
The column the error occurred at
- returns
A representation of the position
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
def
raw(item: String): Raw
Formats a raw item generated by either the input string or a input reading combinator without a label.
Formats a raw item generated by either the input string or a input reading combinator without a label.
- item
The raw, unprocessed input
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
def
reason(reason: String): Message
Describes how to represent the reasons behind a parser fail.
Describes how to represent the reasons behind a parser fail. These reasons originate from the
explaincombinator.- reason
The reason produced by the parser
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
def
source(sourceName: Option[String]): Source
Formats the name of the file if it exists into the type give by
SourceFormats the name of the file if it exists into the type give by
Source- sourceName
The source name of the file, if any
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
def
specialisedError(msgs: Messages, lines: LineInfo): ErrorInfoLines
Specialised errors are triggered by
failand any combinators that are implemented in terms offail.Specialised errors are triggered by
failand any combinators that are implemented in terms offail. These errors take precedence over the vanilla errors, and contain less, more specialised, information- msgs
Information detailing the error (see the
combineMessagesmethod)
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
unexpected(item: Option[Item]): UnexpectedLine
Describes how to handle the (potentially missing) information about what token(s) caused the error.
Describes how to handle the (potentially missing) information about what token(s) caused the error.
- item
The
Itemthat caused this error
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
def
vanillaError(unexpected: UnexpectedLine, expected: ExpectedLine, reasons: Messages, lines: LineInfo): ErrorInfoLines
Vanilla errors are those produced such that they have information about both
expectedandunexpectedtokens.Vanilla errors are those produced such that they have information about both
expectedandunexpectedtokens. These are usually the default, and are not produced byfail(or any derivative) combinators.- unexpected
Information about which token(s) caused the error (see the
unexpectedmethod)- expected
Information about which token(s) would have avoided the error (see the
expectedmethod)- reasons
Additional information about why the error occured (see the
combineMessagesmethod)
- Definition Classes
- DefaultErrorBuilder → ErrorBuilder
- Since
3.0.0
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
This is the documentation for Parsley.
Package structure
The parsley package contains the
Parsleyclass, as well as theResult,Success, andFailuretypes. In addition to these, it also contains the following packages and "modules" (a module is defined as being an object which mocks a package):parsley.Parsleycontains the bulk of the core "function-style" combinators, as well as the implicit classes which enable the "method-style" combinators.parsley.combinatorcontains many helpful combinators that simplify some common parser patterns.parsley.charactercontains the combinators needed to read characters and strings, as well as combinators to match specific sub-sets of characters.parsley.debugcontains debugging combinators, helpful for identifying faults in parsers.parsley.iocontains extension methods to run parsers with input sourced from IO sources.parsley.exprcontains the following sub modules:parsley.expr.chaincontains combinators used in expression parsingparsley.expr.precedenceis a builder for expression parsers built on a precedence table.parsley.implicitscontains several implicits to add syntactic sugar to the combinators. These are sub-categorised into the following sub modules:parsley.implicits.charactercontains implicits to allow you to use character and string literals as parsers.parsley.implicits.combinatorcontains implicits related to combinators, such as the ability to make any parser into aParsley[Unit]automatically.parsley.implicits.liftenables postfix application of the lift combinator onto a function (or value).parsley.implicits.zippedenables boths a reversed form of lift where the function appears on the right and is applied on a tuple (useful when type inference has failed) as well as a.zippedmethod for building tuples out of several combinators.parsley.errorscontains modules to deal with error messages, their refinement and generation.parsley.errors.combinatorprovides combinators that can be used to either produce more detailed errors as well as refine existing errors.parsley.liftcontains functions which lift functions that work on regular types to those which now combine the results of parsers returning those same types. these are ubiquitous.parsley.registerscontains combinators that interact with the context-sensitive functionality in the form of registers.parsley.tokencontains theLexerclass that provides a host of helpful lexing combinators when provided with the description of a language.parsley.unsafecontains unsafe (and not thread-safe) ways of speeding up the execution of a parser.