trait Parsers extends AnyRef
- Alphabetic
- By Inheritance
- Parsers
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- case class Failure (loc: Location, expected: Set[String], found: Token, completions: Set[ICompletion]) extends ParseResult[Nothing] with Product with Serializable
- abstract class ParseResult [+Result] extends AnyRef
- trait Parser [+Result] extends AnyRef
- case class Success [Result](loc: Location, result: Result, completions: Set[ICompletion], expectedAfter: Set[String]) extends ParseResult[Result] with Product with Serializable
- case class Suggestion (fullToken: String, replacementString: String, docString: Option[String]) extends Product with Serializable
Concrete 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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
completionTokenDelimiter: String
Delimiter that is inserted before the completion when a completion creates a completely new token and no other delimiter is already present (and we're not at the beginning of the file).
Delimiter that is inserted before the completion when a completion creates a completely new token and no other delimiter is already present (and we're not at the beginning of the file).
The purpose of this is to make '"if", ctrl+space, select "myCond"' complete to "if myCond" rather than "ifmyCond" (in a language where "myCond" would be a valid token after "if").
If a space is not a suitable token delimiter in your language, override this to something that is.
-
def
describeAs[Result](description: String)(parser: Parser[Result]): Parser[Result]
Set a custom description for the given parser.
Set a custom description for the given parser. This will show up in "Expected X, but got Y" error messages instead of the token list generated by default.
-
def
eof: Parser[Some[EOF.type]]
Matches at the end of file.
Matches at the end of file. Using this rule instead of
token(EOF)prevents an empty string from being added to the completions list. -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
fail: Parser[Nothing]
Parser that fails unconditionally.
Parser that fails unconditionally.
This is useful as a default when combining a possibly-empty list of parsers with
|for example. -
def
fail(expected: String): Parser[Nothing]
Parser that fails unconditionally.
Parser that fails unconditionally.
This is useful as a default when combining a possibly-empty list of parsers with
|for example.- expected
The message associated with this rule in "X expected, but Y found" error messages.
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
matchToken[Result](description: String, suggestions: ⇒ Set[Suggestion] = Set())(f: PartialFunction[WithLocation[Token], Result]): Parser[Result]
This rule matches a token if the given function is defined for that function.
This rule matches a token if the given function is defined for that function. If so the result is a
Successwhose value is the return value of the function. Otherwise the rule fails. -
def
matchTokenAlt[Result](description: Set[String], suggestions: ⇒ Set[Suggestion] = Set())(f: PartialFunction[WithLocation[Token], Result]): Parser[Result]
This rule matches a token if the given function is defined for that function.
This rule matches a token if the given function is defined for that function. If so the result is a
Successwhose value is the return value of the function. Otherwise the rule fails. -
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- def parseAll[Result](p: ⇒ Parser[Result], s: String): ParseResult[Result]
- def parseAll[Result](p: ⇒ Parser[Result], s: Source): ParseResult[Result]
- def parseAll[Result](p: ⇒ Parser[Result], s: LookaheadSource): ParseResult[Result]
- def parseAll[Result](p: ⇒ Parser[Result], tokenIterator: TokenIterator): ParseResult[Result]
- def parseMany[Result](p: ⇒ Parser[Result], s: Source): Iterator[ParseResult[Result]]
-
def
parseMany[Result](p: ⇒ Parser[Result], input: TokenIterator): Iterator[ParseResult[Result]]
Lazily apply the given parser on the given input repeatedly until the parse fails or the end of the file is reached.
Lazily apply the given parser on the given input repeatedly until the parse fails or the end of the file is reached.
- returns
An iterator containing the ParseResults. All results except the last one are guaranteed to be successful.
-
def
rep1sep[T](rep: Parser[T], sep: Parser[Any]): Parser[Seq[T]]
Matches one or more occurrences of
repseparated bysepand produces a list of the results if successful. -
def
repsep[T](rep: Parser[T], sep: Parser[Any]): Parser[Seq[T]]
Matches zero or more occurrences of
repseparated bysepand produces a list of the results. -
def
success[Result](result: ⇒ Result): Parser[Result] { def parse(input: Parsers.this.tokenizer.TokenIterator): Parsers.this.Success[Result] }
Succeeds unconditionally and without consuming tokens.
Succeeds unconditionally and without consuming tokens. The resulitng
Successobject will containresultas its result value. -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
implicit
def
token[T <: Token](tok: T): Parser[WithLocation[T]]
This rule matches the given token and fails on any other token.
-
def
token[T <: Token](tok: T, docString: String): Parser[WithLocation[T]]
This rule matches the given token and fails on any other token.
This rule matches the given token and fails on any other token.
The given docstring will be used as the documentation for the completion produced for this token.
-
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( ... )
-
def
when[T](condition: Boolean)(thenParser: ⇒ Parser[T]): Parser[T]
Only use the given parser when the given condition is met.
Only use the given parser when the given condition is met. When the condition is not met, this parser fails unconditionally.
- object Suggestion extends Serializable