sbt.complete

Parser

object Parser extends ParserMain

Contains Parser implementation helper methods not typically needed for using parsers.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Parser
  2. ParserMain
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. final class Failure extends Result[Nothing]

  2. sealed abstract class Result[+T] extends AnyRef

  3. final case class Value[+T](value: T) extends Result[T] with Product with Serializable

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def and[T](a: Parser[T], b: Parser[_]): Parser[T]

  7. def apply[T](p: Parser[T])(s: String): Parser[T]

    Applies parser p to input s.

    Applies parser p to input s.

    Definition Classes
    ParserMain
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def bindParser[A, B](a: Parser[A], f: (A) ⇒ Parser[B]): Parser[B]

  10. def charClass(f: (Char) ⇒ Boolean, label: String = "<unspecified>"): Parser[Char]

    Defines a Parser that parses a single character only if the predicate f returns true for that character.

    Defines a Parser that parses a single character only if the predicate f returns true for that character. If this parser fails, label is used as the failure message.

    Definition Classes
    ParserMain
  11. def chars(legal: String): Parser[Char]

    Defines a Parser that parses a single character only if it is contained in legal.

    Defines a Parser that parses a single character only if it is contained in legal.

    Definition Classes
    ParserMain
  12. def choiceParser[A, B](a: Parser[A], b: Parser[B]): Parser[Either[A, B]]

  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def completions(p: Parser[_], s: String, level: Int): Completions

    Applies parser p to input s and returns the completions at verbosity level.

    Applies parser p to input s and returns the completions at verbosity level. The interpretation of level is up to parser definitions, but 0 is the default by convention, with increasing positive numbers corresponding to increasing verbosity. Typically no more than a few levels are defined.

    Definition Classes
    ParserMain
  15. def derive1[T](p: Parser[T], c: Char): Parser[T]

    Applies parser p to a single character of input.

    Applies parser p to a single character of input.

    Definition Classes
    ParserMain
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def examples[A](a: Parser[A], completions: ExampleSource, maxNumberOfExamples: Int, removeInvalidExamples: Boolean): Parser[A]

    A

    the type of values that are returned by the parser.

    a

    the parser to decorate with a source of examples. All validation and parsing is delegated to this parser, only Parser.completions is modified.

    completions

    the source of examples when displaying completions to the user.

    maxNumberOfExamples

    limits the number of examples that the source of examples should return. This can prevent lengthy pauses and avoids bad interactive user experience.

    removeInvalidExamples

    indicates whether completion examples should be checked for validity (against the given parser). An exception is thrown if the example source contains no valid completion suggestions.

    returns

    Definition Classes
    ParserMain
  19. def examples[A](a: Parser[A], completions: Set[String], check: Boolean = false): Parser[A]

    Definition Classes
    ParserMain
  20. def failure(msg: ⇒ String, definitive: Boolean = false): Parser[Nothing]

    Defines a parser that always fails on any input with message msg.

    Defines a parser that always fails on any input with message msg. If definitive is true, any failures by later alternatives are discarded.

    Definition Classes
    ParserMain
  21. def filterParser[T](a: Parser[T], f: (T) ⇒ Boolean, seen: String, msg: (String) ⇒ String): Parser[T]

  22. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  25. def homParser[A](a: Parser[A], b: Parser[A]): Parser[A]

    Definition Classes
    ParserMain
  26. def invalid(msgs: ⇒ Seq[String], definitive: Boolean = false): Parser[Nothing]

    Defines a parser that always fails on any input with messages msgs.

    Defines a parser that always fails on any input with messages msgs. If definitive is true, any failures by later alternatives are discarded.

    Definition Classes
    ParserMain
  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  28. implicit def literal(s: String): Parser[String]

    Presents a literal String s as a Parser that only parses that exact text and provides it as the result.

    Presents a literal String s as a Parser that only parses that exact text and provides it as the result.

    Definition Classes
    ParserMain
  29. implicit def literal(ch: Char): Parser[Char]

    Presents a single Char ch as a Parser that only parses that exact character.

    Presents a single Char ch as a Parser that only parses that exact character.

    Definition Classes
    ParserMain
  30. implicit def literalRichCharParser(c: Char): RichParser[Char]

    Definition Classes
    ParserMain
  31. implicit def literalRichStringParser(s: String): RichParser[String]

    Definition Classes
    ParserMain
  32. def mapParser[A, B](a: Parser[A], f: (A) ⇒ B): Parser[B]

  33. def matched(t: Parser[_], seen: Vector[Char] = Vector.empty, partial: Boolean = false): Parser[String]

    Definition Classes
    ParserMain
  34. def mkFailure(error: ⇒ String, definitive: Boolean = false): Failure

  35. def mkFailures(errors: ⇒ Seq[String], definitive: Boolean = false): Failure

  36. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  37. def not(p: Parser[_], failMessage: String): Parser[Unit]

    Definition Classes
    ParserMain
  38. final def notify(): Unit

    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  40. def onFailure[T](delegate: Parser[T], msg: String): Parser[T]

  41. def oneOf[T](p: Seq[Parser[T]]): Parser[T]

    Definition Classes
    ParserMain
  42. def oneOrMore[T](p: Parser[T]): Parser[Seq[T]]

  43. def opt[T](a: Parser[T]): Parser[Option[T]]

  44. def parse[T](str: String, parser: Parser[T]): Either[String, T]

    Parses input str using parser.

    Parses input str using parser. If successful, the result is provided wrapped in Right. If unsuccessful, an error message is provided in Left.

    Definition Classes
    ParserMain
  45. implicit def range(r: NumericRange[Char]): Parser[Char]

    Presents a Char range as a Parser.

    Presents a Char range as a Parser. A single Char is parsed only if it is in the given range.

    Definition Classes
    ParserMain
  46. def repeat[T](p: Parser[T], min: Int = 0, max: UpperBound = Infinite): Parser[Seq[T]]

  47. def result[T](p: Parser[T], s: String): Either[() ⇒ (Seq[String], Int), T]

    Definition Classes
    ParserMain
  48. implicit def richParser[A](a: Parser[A]): RichParser[A]

    Provides combinators for Parsers.

    Provides combinators for Parsers.

    Definition Classes
    ParserMain
  49. def sample(str: String, parser: Parser[_], completions: Boolean = false): Unit

    Convenience method to use when developing a parser.

    Convenience method to use when developing a parser. parser is applied to the input str. If completions is true, the available completions for the input are displayed. Otherwise, the result of parsing is printed using the result's toString method. If parsing fails, the error message is displayed.

    See also sampleParse and sampleCompletions.

    Definition Classes
    ParserMain
  50. def sampleCompletions(str: String, parser: Parser[_], level: Int = 1): Unit

    Convenience method to use when developing a parser.

    Convenience method to use when developing a parser. parser is applied to the input str and the available completions are displayed on separate lines. If parsing fails, the error message is displayed.

    Definition Classes
    ParserMain
  51. def sampleParse(str: String, parser: Parser[_]): Unit

    Convenience method to use when developing a parser.

    Convenience method to use when developing a parser. parser is applied to the input str and the result of parsing is printed using the result's toString method. If parsing fails, the error message is displayed.

    Definition Classes
    ParserMain
  52. def seq[T](p: Seq[Parser[T]]): Parser[Seq[T]]

    Definition Classes
    ParserMain
  53. def seq0[T](p: Seq[Parser[T]], errors: ⇒ Seq[String]): Parser[Seq[T]]

    Definition Classes
    ParserMain
  54. def seqParser[A, B](a: Parser[A], b: Parser[B]): Parser[(A, B)]

  55. def stringLiteral(s: String, start: Int): Parser[String]

    Definition Classes
    ParserMain
  56. def success[T](value: T): Parser[T]

    Defines a parser that always succeeds on empty input with the result value.

    Defines a parser that always succeeds on empty input with the result value.

    Definition Classes
    ParserMain
  57. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  58. def toString(): String

    Definition Classes
    AnyRef → Any
  59. def token[T](t: Parser[T], complete: TokenCompletions): Parser[T]

    Definition Classes
    ParserMain
  60. def token[T](t: Parser[T], description: String): Parser[T]

    Establishes delegate parser t as a single token of tab completion.

    Establishes delegate parser t as a single token of tab completion. When tab completion of part of this token is requested, description is displayed for suggestions and no completions are ever performed.

    Definition Classes
    ParserMain
  61. def token[T](t: Parser[T], hide: (Int) ⇒ Boolean): Parser[T]

    Establishes delegate parser t as a single token of tab completion.

    Establishes delegate parser t as a single token of tab completion. When tab completion of part of this token is requested, no completions are returned if hide returns true for the current tab completion level. Otherwise, the completions provided by the delegate t or a later derivative are appended to the prefix String already seen by this parser.

    Definition Classes
    ParserMain
  62. def token[T](t: Parser[T]): Parser[T]

    Establishes delegate parser t as a single token of tab completion.

    Establishes delegate parser t as a single token of tab completion. When tab completion of part of this token is requested, the completions provided by the delegate t or a later derivative are appended to the prefix String already seen by this parser.

    Definition Classes
    ParserMain
  63. def tokenDisplay[T](t: Parser[T], display: String): Parser[T]

    Establishes delegate parser t as a single token of tab completion.

    Establishes delegate parser t as a single token of tab completion. When tab completion of part of this token is requested, display is used as the printed suggestion, but the completions from the delegate parser t are used to complete if unambiguous.

    Definition Classes
    ParserMain
  64. def trapAndFail[T](delegate: Parser[T]): Parser[T]

  65. def tuple[A, B](a: Option[A], b: Option[B]): Option[(A, B)]

  66. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. def zeroOrMore[T](p: Parser[T]): Parser[Seq[T]]

  70. object ~

    See unapply.

Deprecated Value Members

  1. def checkMatches(a: Parser[_], completions: Seq[String]): Unit

    Annotations
    @deprecated
    Deprecated

    (Since version 0.13.2) This method is deprecated and will be removed in the next major version. Use the parser directly to check for invalid completions.

  2. def not(p: Parser[_]): Parser[Unit]

    Definition Classes
    ParserMain
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.2) Explicitly specify the failure message.

  3. def sub[T](a: Parser[T], b: Parser[_]): Parser[T]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.2) Explicitly call and and not to provide the failure message.

  4. def token[T](t: Parser[T], seen: String, track: Boolean, hide: (Int) ⇒ Boolean): Parser[T]

    Definition Classes
    ParserMain
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.1) Use a different token overload.

Inherited from ParserMain

Inherited from AnyRef

Inherited from Any

Ungrouped