TableParser
API
Generated with
TableParser/com.phasmidsoftware.tableparser/com.phasmidsoftware.tableparser.core/com.phasmidsoftware.tableparser.core.parse/LineParser

LineParser

com.phasmidsoftware.tableparser.core.parse.LineParser
See theLineParser companion object
class LineParser(delimiter: Regex, string: Regex, enclosures: String, listSeparator: Char, quote: Char, verbose: Boolean = ...) extends JavaTokenParsers

LineParser: class to parse lines of a CSV file. NOTE: list elements always appear as a string in the form { element0 , element1 , ... }

Value parameters

delimiter

a Regex used to match a delimiter between cells in a row.

enclosures

the enclosure characters around a list (if any).

listSeparator

the list separator character.

quote

the quote character which is able to preempt the string regex: between two quote characters, there can be any number of any character (other than quote).

string

a Regex used to match the content of a cell.

verbose

will print the various parameters.

Attributes

Companion
object
Graph
Supertypes
trait JavaTokenParsers
trait RegexParsers
trait Parsers
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

case class Error(msg: String, next: Parsers.this.Input) extends NoSuccess

The fatal failure case of ParseResult: contains an error-message and the remaining input. No back-tracking is done when a parser returns an Error.

The fatal failure case of ParseResult: contains an error-message and the remaining input. No back-tracking is done when a parser returns an Error.

Value parameters

msg

An error message string describing the error.

next

The parser's unconsumed input at the point where the error occurred.

Attributes

Inherited from:
Parsers
Supertypes
trait Serializable
trait Product
trait Equals
class Parsers.this.NoSuccess
class Parsers.this.ParseResult[Nothing]
class Object
trait Matchable
class Any
Show all
case class Failure(msg: String, next: Parsers.this.Input) extends NoSuccess

The failure case of ParseResult: contains an error-message and the remaining input. Parsing will back-track when a failure occurs.

The failure case of ParseResult: contains an error-message and the remaining input. Parsing will back-track when a failure occurs.

Value parameters

msg

An error message string describing the failure.

next

The parser's unconsumed input at the point where the failure occurred.

Attributes

Inherited from:
Parsers
Supertypes
trait Serializable
trait Product
trait Equals
class Parsers.this.NoSuccess
class Parsers.this.ParseResult[Nothing]
class Object
trait Matchable
class Any
Show all
object NoSuccess

An extractor so case NoSuccess(msg, next) can be used in matches.

An extractor so case NoSuccess(msg, next) can be used in matches.

Note: On Scala 2.13, using this extractor leads to an exhaustivity warning:

 def m(r: ParseResult[Int]) = r match {
   case Success(i) => ...
   case NoSuccess(msg, _) => ... // "warning: match may not be exhaustive"

To eliminate this warning, use the irrefutable NoSuccess.I extractor. Due to binary compatibility, NoSuccess itself cannot be changed.

Attributes

Inherited from:
Parsers
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
trait OnceParser[+T] extends Parser[T]

A parser whose ~ combinator disallows back-tracking.

A parser whose ~ combinator disallows back-tracking.

Attributes

Inherited from:
Parsers
Supertypes
class Parsers.this.Parser[T]
trait Parsers.this.Input => Parsers.this.ParseResult[T]
class Object
trait Matchable
class Any
case class Success[+T](result: T, next: Parsers.this.Input) extends ParseResult[T]

The success case of ParseResult: contains the result and the remaining input.

The success case of ParseResult: contains the result and the remaining input.

Value parameters

next

The parser's remaining input

result

The parser's output

Attributes

Inherited from:
Parsers
Supertypes
trait Serializable
trait Product
trait Equals
class Parsers.this.ParseResult[T]
class Object
trait Matchable
class Any
Show all
case class ~[+a, +b](_1: a, _2: b)

A wrapper over sequence of matches.

A wrapper over sequence of matches.

Given p1: Parser[A] and p2: Parser[B], a parser composed with p1 ~ p2 will have type Parser[~[A, B]]. The successful result of the parser can be extracted from this case class.

It also enables pattern matching, so something like this is possible:

def concat(p1: Parser[String], p2: Parser[String]): Parser[String] =
  p1 ~ p2 ^^ { case a ~ b => a + b }

Attributes

Inherited from:
Parsers
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited and Abstract classlikes

sealed abstract class NoSuccess(val msg: String, val next: Parsers.this.Input) extends ParseResult[Nothing]

A common super-class for unsuccessful parse results.

A common super-class for unsuccessful parse results.

Attributes

Inherited from:
Parsers
Supertypes
class Parsers.this.ParseResult[Nothing]
class Object
trait Matchable
class Any
Known subtypes
class Parsers.this.Error
class Parsers.this.Failure
sealed abstract class ParseResult[+T]

A base class for parser results. A result is either successful or not (failure may be fatal, i.e., an Error, or not, i.e., a Failure). On success, provides a result of type T which consists of some result (and the rest of the input).

A base class for parser results. A result is either successful or not (failure may be fatal, i.e., an Error, or not, i.e., a Failure). On success, provides a result of type T which consists of some result (and the rest of the input).

Attributes

Inherited from:
Parsers
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Parsers.this.NoSuccess
class Parsers.this.Error
class Parsers.this.Failure
class Parsers.this.Success[T]
abstract class Parser[+T] extends Input => ParseResult[T]

The root class of parsers. Parsers are functions from the Input type to ParseResult.

The root class of parsers. Parsers are functions from the Input type to ParseResult.

Attributes

Inherited from:
Parsers
Supertypes
trait Parsers.this.Input => Parsers.this.ParseResult[T]
class Object
trait Matchable
class Any
Known subtypes
trait Parsers.this.OnceParser[T]

Inherited types

type Elem = Char

the type of input elements the provided parsers consume (When consuming invidual characters, a parser is typically called a ''scanner'', which produces ''tokens'' that are consumed by what is normally called a ''parser''. Nonetheless, the same principles apply, regardless of the input type.)

the type of input elements the provided parsers consume (When consuming invidual characters, a parser is typically called a ''scanner'', which produces ''tokens'' that are consumed by what is normally called a ''parser''. Nonetheless, the same principles apply, regardless of the input type.)

Attributes

Inherited from:
RegexParsers
type Input = Reader[Elem]

The parser input is an abstract reader of input elements, i.e. the type of input the parsers in this component expect.

The parser input is an abstract reader of input elements, i.e. the type of input the parsers in this component expect.

Attributes

Inherited from:
Parsers

Value members

Concrete methods

def parseRow(indexedString: (String, Int)): Try[Strings]

Method to parse a Row.

Method to parse a Row.

NOTE: the expressions "end of input expected" and "end of input" are defined in (trait) Parsers: def phrase[T](p: Parser[T]): Parser[T] def acceptMatch[U]... def acceptIf... It's a shame that they didn't make it a constant in Parsers!

CONSIDER checking that sequential lines really are sequential. Currently, no use is made of indexedString._2

Value parameters

indexedString

a tuple of String and Int denoting the line and its index in the file.

Attributes

Returns

a Try[Strings].

override def skipWhitespace: Boolean

Attributes

Definition Classes
RegexParsers
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any

Inherited methods

def OnceParser[T](f: Input => ParseResult[T]): Parser[T] & OnceParser[T]

Attributes

Inherited from:
Parsers
def Parser[T](f: Input => ParseResult[T]): Parser[T]

Attributes

Inherited from:
Parsers
def accept[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

The parser that matches an element in the domain of the partial function f.

The parser that matches an element in the domain of the partial function f.

If f is defined on the first element in the input, f is applied to it to produce this parser's result.

Example: The parser accept("name", {case Identifier(n) => Name(n)}) accepts an Identifier(n) and returns a Name(n)

Value parameters

expected

a description of the kind of element this parser expects (for error messages)

f

a partial function that determines when this parser is successful and what its output is

Attributes

Returns

A parser that succeeds if f is applicable to the first element of the input, applying f to it to produce the result.

Inherited from:
Parsers
def accept[ES](es: ES)(implicit f: ES => List[Elem]): Parser[List[Elem]]

A parser that matches only the given list of element es.

A parser that matches only the given list of element es.

accept(es) succeeds if the input subsequently provides the elements in the list es.

Value parameters

es

the list of expected elements

Attributes

Returns

a Parser that recognizes a specified list of elements

Inherited from:
Parsers
def acceptIf(p: Elem => Boolean)(err: Elem => String): Parser[Elem]

A parser matching input elements that satisfy a given predicate.

A parser matching input elements that satisfy a given predicate.

acceptIf(p)(el => "Unexpected "+el) succeeds if the input starts with an element e for which p(e) is true.

Value parameters

err

A function from the received element into an error message.

p

A predicate that determines which elements match.

Attributes

Returns

A parser for elements satisfying p(e).

Inherited from:
Parsers
def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

The parser that matches an element in the domain of the partial function f.

The parser that matches an element in the domain of the partial function f.

If f is defined on the first element in the input, f is applied to it to produce this parser's result.

Example: The parser acceptMatch("name", {case Identifier(n) => Name(n)}) accepts an Identifier(n) and returns a Name(n)

Value parameters

expected

a description of the kind of element this parser expects (for error messages)

f

a partial function that determines when this parser is successful and what its output is

Attributes

Returns

A parser that succeeds if f is applicable to the first element of the input, applying f to it to produce the result.

Inherited from:
Parsers
def acceptSeq[ES](es: ES)(implicit f: ES => Iterable[Elem]): Parser[List[Elem]]

A parser that matches only the given scala.collection.Iterable collection of elements es.

A parser that matches only the given scala.collection.Iterable collection of elements es.

acceptSeq(es) succeeds if the input subsequently provides the elements in the iterable es.

Value parameters

es

the list of expected elements

Attributes

Returns

a Parser that recognizes a specified list of elements

Inherited from:
Parsers
def chainl1[T, U](first: => Parser[T], p: => Parser[U], q: => Parser[(T, U) => T]): Parser[T]

A parser generator that, roughly, generalises the rep1sep generator so that q, which parses the separator, produces a left-associative function that combines the elements it separates.

A parser generator that, roughly, generalises the rep1sep generator so that q, which parses the separator, produces a left-associative function that combines the elements it separates.

Value parameters

first

a parser that parses the first element

p

a parser that parses the subsequent elements

q

a parser that parses the token(s) separating the elements, yielding a left-associative function that combines two elements into one

Attributes

Inherited from:
Parsers
def chainl1[T](p: => Parser[T], q: => Parser[(T, T) => T]): Parser[T]

A parser generator that, roughly, generalises the rep1sep generator so that q, which parses the separator, produces a left-associative function that combines the elements it separates.

A parser generator that, roughly, generalises the rep1sep generator so that q, which parses the separator, produces a left-associative function that combines the elements it separates.

''From: J. Fokker. Functional parsers. In J. Jeuring and E. Meijer, editors, Advanced Functional Programming, volume 925 of Lecture Notes in Computer Science, pages 1--23. Springer, 1995.''

Value parameters

p

a parser that parses the elements

q

a parser that parses the token(s) separating the elements, yielding a left-associative function that combines two elements into one

Attributes

Inherited from:
Parsers
def chainr1[T, U](p: => Parser[T], q: => Parser[(T, U) => U], combine: (T, U) => U, first: U): Parser[U]

A parser generator that generalises the rep1sep generator so that q, which parses the separator, produces a right-associative function that combines the elements it separates. Additionally, the right-most (last) element and the left-most combining function have to be supplied.

A parser generator that generalises the rep1sep generator so that q, which parses the separator, produces a right-associative function that combines the elements it separates. Additionally, the right-most (last) element and the left-most combining function have to be supplied.

rep1sep(p: Parser[T], q) corresponds to chainr1(p, q ^^ cons, cons, Nil) (where val cons = (x: T, y: List[T]) => x :: y)

Value parameters

combine

the "last" (left-most) combination function to be applied

first

the "first" (right-most) element to be combined

p

a parser that parses the elements

q

a parser that parses the token(s) separating the elements, yielding a right-associative function that combines two elements into one

Attributes

Inherited from:
Parsers
def commit[T](p: => Parser[T]): Parser[T]

Wrap a parser so that its failures become errors (the | combinator will give up as soon as it encounters an error, on failure it simply tries the next alternative).

Wrap a parser so that its failures become errors (the | combinator will give up as soon as it encounters an error, on failure it simply tries the next alternative).

Attributes

Inherited from:
Parsers
def decimalNumber: Parser[String]

Number following one of these rules:

Number following one of these rules:

  • An integer. For example: 13
  • An integer followed by a decimal point. For example: 3.
  • An integer followed by a decimal point and fractional part. For example: 3.14
  • A decimal point followed by a fractional part. For example: .1

Attributes

Inherited from:
JavaTokenParsers
def elem(e: Elem): Parser[Elem]

A parser that matches only the given element e.

A parser that matches only the given element e.

elem(e) succeeds if the input starts with an element e.

Value parameters

e

the Elem that must be the next piece of input for the returned parser to succeed

Attributes

Returns

a Parser that succeeds if e is the next available input (and returns it).

Inherited from:
Parsers
def elem(kind: String, p: Elem => Boolean): Parser[Elem]

A parser matching input elements that satisfy a given predicate.

A parser matching input elements that satisfy a given predicate.

elem(kind, p) succeeds if the input starts with an element e for which p(e) is true.

Value parameters

kind

The element kind, used for error messages

p

A predicate that determines which elements match.

Attributes

Inherited from:
Parsers
override def err(msg: String): Parser[Nothing]

A parser that results in an error.

A parser that results in an error.

This parser additionally skips whitespace if skipWhitespace returns true.

Attributes

Definition Classes
RegexParsers -> Parsers
Inherited from:
RegexParsers
def failure(msg: String): Parser[Nothing]

A parser that always fails.

A parser that always fails.

Value parameters

msg

The error message describing the failure.

Attributes

Returns

A parser that always fails with the specified error message.

Inherited from:
Parsers
def floatingPointNumber: Parser[String]

A number following the rules of decimalNumber, with the following optional additions:

A number following the rules of decimalNumber, with the following optional additions:

  • Preceded by a negative sign
  • Followed by e or E and an optionally signed integer
  • Followed by f, f, d or D (after the above rule, if both are used)

Attributes

Inherited from:
JavaTokenParsers
def guard[T](p: => Parser[T]): Parser[T]

A parser generator for guard expressions. The resulting parser will fail or succeed just like the one given as parameter but it will not consume any input.

A parser generator for guard expressions. The resulting parser will fail or succeed just like the one given as parameter but it will not consume any input.

Value parameters

p

a Parser that is to be applied to the input

Attributes

Returns

A parser that returns success if and only if p succeeds but never consumes any input

Inherited from:
Parsers
protected def handleWhiteSpace(source: CharSequence, offset: Int): Int

Method called to handle whitespace before parsers.

Method called to handle whitespace before parsers.

It checks skipWhitespace and, if true, skips anything matching whiteSpace starting from the current offset.

Value parameters

offset

The offset into source from which to match.

source

The input being parsed.

Attributes

Returns

The offset to be used for the next parser.

Inherited from:
RegexParsers
def ident: Parser[String]

Anything that is a valid Java identifier, according to The Java Language Spec. Generally, this means a letter, followed by zero or more letters or numbers.

Anything that is a valid Java identifier, according to The Java Language Spec. Generally, this means a letter, followed by zero or more letters or numbers.

Attributes

Inherited from:
JavaTokenParsers
def log[T](p: => Parser[T])(name: String): Parser[T]

A helper method that turns a Parser into one that will print debugging information to stdout before and after being applied.

A helper method that turns a Parser into one that will print debugging information to stdout before and after being applied.

Attributes

Inherited from:
Parsers
def mkList[T]: (T ~ List[T]) => List[T]

Given a concatenation with a repetition (list), move the concatenated element into the list

Given a concatenation with a repetition (list), move the concatenated element into the list

Attributes

Inherited from:
Parsers
def not[T](p: => Parser[T]): Parser[Unit]

Wrap a parser so that its failures and errors become success and vice versa -- it never consumes any input.

Wrap a parser so that its failures and errors become success and vice versa -- it never consumes any input.

Attributes

Inherited from:
Parsers
def opt[T](p: => Parser[T]): Parser[Option[T]]

A parser generator for optional sub-phrases.

A parser generator for optional sub-phrases.

opt(p) is a parser that returns Some(x) if p returns x and None if p fails.

Value parameters

p

A Parser that is tried on the input

Attributes

Returns

a Parser that always succeeds: either with the result provided by p or with the empty result

Inherited from:
Parsers
def parse[T](p: Parser[T], in: Reader): ParseResult[T]

Parse some prefix of reader in with parser p.

Parse some prefix of reader in with parser p.

Attributes

Inherited from:
RegexParsers
def parse[T](p: Parser[T], in: CharSequence): ParseResult[T]

Parse some prefix of character sequence in with parser p.

Parse some prefix of character sequence in with parser p.

Attributes

Inherited from:
RegexParsers
def parse[T](p: Parser[T], in: Reader[Char]): ParseResult[T]

Parse some prefix of reader in with parser p.

Parse some prefix of reader in with parser p.

Attributes

Inherited from:
RegexParsers
def parseAll[T](p: Parser[T], in: CharSequence): ParseResult[T]

Parse all of character sequence in with parser p.

Parse all of character sequence in with parser p.

Attributes

Inherited from:
RegexParsers
def parseAll[T](p: Parser[T], in: Reader): ParseResult[T]

Parse all of reader in with parser p.

Parse all of reader in with parser p.

Attributes

Inherited from:
RegexParsers
def parseAll[T](p: Parser[T], in: Reader[Char]): ParseResult[T]

Parse all of reader in with parser p.

Parse all of reader in with parser p.

Attributes

Inherited from:
RegexParsers
override def phrase[T](p: Parser[T]): Parser[T]

A parser generator delimiting whole phrases (i.e. programs).

A parser generator delimiting whole phrases (i.e. programs).

phrase(p) succeeds if p succeeds and no input is left over after p.

Value parameters

p

the parser that must consume all input for the resulting parser to succeed.

Attributes

Returns

a parser that has the same result as p, but that only succeeds if p consumed all the input.

Definition Classes
RegexParsers -> Parsers
Inherited from:
RegexParsers
override def positioned[T <: Positional](p: => Parser[T]): Parser[T]

positioned decorates a parser's result with the start position of the input it consumed. If whitespace is being skipped, then it is skipped before the start position is recorded.

positioned decorates a parser's result with the start position of the input it consumed. If whitespace is being skipped, then it is skipped before the start position is recorded.

Value parameters

p

a Parser whose result conforms to Positional.

Attributes

Returns

A parser that has the same behaviour as p, but which marks its result with the start position of the input it consumed after whitespace has been skipped, if it didn't already have a position.

Definition Classes
RegexParsers -> Parsers
Inherited from:
RegexParsers
def rep[T](p: => Parser[T]): Parser[List[T]]

A parser generator for repetitions.

A parser generator for repetitions.

rep(p) repeatedly uses p to parse the input until p fails (the result is a List of the consecutive results of p).

Value parameters

p

a Parser that is to be applied successively to the input

Attributes

Returns

A parser that returns a list of results produced by repeatedly applying p to the input.

Inherited from:
Parsers
def rep1[T](first: => Parser[T], p0: => Parser[T]): Parser[List[T]]

A parser generator for non-empty repetitions.

A parser generator for non-empty repetitions.

rep1(f, p) first uses f (which must succeed) and then repeatedly uses p to parse the input until p fails (the result is a List of the consecutive results of f and p)

Value parameters

first

a Parser that parses the first piece of input

p0

a Parser that is to be applied successively to the rest of the input (if any) -- evaluated at most once, and only when necessary

Attributes

Returns

A parser that returns a list of results produced by first applying f and then repeatedly p to the input (it only succeeds if f matches).

Inherited from:
Parsers
def rep1[T](p: => Parser[T]): Parser[List[T]]

A parser generator for non-empty repetitions.

A parser generator for non-empty repetitions.

rep1(p) repeatedly uses p to parse the input until p fails -- p must succeed at least once (the result is a List of the consecutive results of p)

Value parameters

p

a Parser that is to be applied successively to the input

Attributes

Returns

A parser that returns a list of results produced by repeatedly applying p to the input (and that only succeeds if p matches at least once).

Inherited from:
Parsers
def rep1sep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]

A parser generator for non-empty repetitions.

A parser generator for non-empty repetitions.

rep1sep(p, q) repeatedly applies p interleaved with q to parse the input, until p fails. The parser p must succeed at least once.

Value parameters

p

a Parser that is to be applied successively to the input

q

a Parser that parses the elements that separate the elements parsed by p (interleaved with q)

Attributes

Returns

A parser that returns a list of results produced by repeatedly applying p to the input (and that only succeeds if p matches at least once). The results of p are collected in a list. The results of q are discarded.

Inherited from:
Parsers
def repN[T](num: Int, p: => Parser[T]): Parser[List[T]]

A parser generator for a specified number of repetitions.

A parser generator for a specified number of repetitions.

repN(n, p) uses p exactly n time to parse the input (the result is a List of the n consecutive results of p).

Value parameters

num

the exact number of times p must succeed

p

a Parser that is to be applied successively to the input

Attributes

Returns

A parser that returns a list of results produced by repeatedly applying p to the input (and that only succeeds if p matches exactly n times).

Inherited from:
Parsers
def repNM[T](n: Int, m: Int, p: Parser[T], sep: Parser[Any] = ...): Parser[List[T]]

A parser generator for a specified range of repetitions interleaved by a separator.

A parser generator for a specified range of repetitions interleaved by a separator.

repNM(n, m, p, s) uses p at least n times and up to m times, interleaved with separator s, to parse the input (the result is a List of at least n consecutive results of p and up to m results).

Value parameters

m

maximum number of repetitions

n

minimum number of repetitions

p

a Parser that is to be applied successively to the input

sep

a Parser that interleaves with p

Attributes

Returns

A parser that returns a list of results produced by repeatedly applying p interleaved with sep to the input. The list has a size between n and up to m (and that only succeeds if p matches at least n times).

Inherited from:
Parsers
def repsep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]

A parser generator for interleaved repetitions.

A parser generator for interleaved repetitions.

repsep(p, q) repeatedly uses p interleaved with q to parse the input, until p fails. (The result is a List of the results of p.)

Example: repsep(term, ",") parses a comma-separated list of term's, yielding a list of these terms.

Value parameters

p

a Parser that is to be applied successively to the input

q

a Parser that parses the elements that separate the elements parsed by p

Attributes

Returns

A parser that returns a list of results produced by repeatedly applying p (interleaved with q) to the input. The results of p are collected in a list. The results of q are discarded.

Inherited from:
Parsers
def stringLiteral: Parser[String]

Double quotes (") enclosing a sequence of:

Double quotes (") enclosing a sequence of:

  • Any character except double quotes, control characters or backslash (\)
  • A backslash followed by another backslash, a single or double quote, or one of the letters b, f, n, r or t
  • \ followed by u followed by four hexadecimal digits

Attributes

Inherited from:
JavaTokenParsers
def success[T](v: T): Parser[T]

A parser that always succeeds.

A parser that always succeeds.

Value parameters

v

The result for the parser

Attributes

Returns

A parser that always succeeds, with the given result v

Inherited from:
Parsers
def wholeNumber: Parser[String]

An integer, without sign or with a negative sign.

An integer, without sign or with a negative sign.

Attributes

Inherited from:
JavaTokenParsers

Concrete fields

lazy val cell: Parser[String]

A Parser that attempts to parse a cell value in a variety of forms.

A Parser that attempts to parse a cell value in a variety of forms.

The cell parser evaluates different parsing strategies in sequence:

  • quotedString: Parses a string enclosed in quotation marks.
  • list: Parses a list structure.
  • string: Parses a generic string.
  • failure("invalid string"): Returns a parsing failure with the message "invalid string" if none of the other parsers are successful.

This parser is declared as lazy to allow it to be initialized when first accessed, enabling any dependencies it might have to be resolved at runtime.

Attributes

lazy val list: Parser[String]

A lazy val for a Parser that parses a list-like structure encapsulated by open and close characters.

A lazy val for a Parser that parses a list-like structure encapsulated by open and close characters.

The parser works as follows:

  1. It expects an opening character (getOpenChar).
  2. It parses a component followed by a listSeparator, and one or more components separated by listSeparator using rep1sep.
  3. It concludes by expecting a closing character (getCloseChar).
  4. Finally, it transforms the parsed elements into a String representation where the components are encapsulated by curly braces and separated by commas, e.g., "{component1,component2,...}".

Attributes

Returns

A Parser[String] that produces the string representation of the parsed list.

lazy val pureQuotedString: Parser[String]

A Parser that extracts a quoted string from the input.

A Parser that extracts a quoted string from the input.

The parser is defined as a combination of three elements:

  • quote: Matches the opening quote character.
  • stringInQuotes: Parses the content inside the quotes.
  • quote: Matches the closing quote character.

This parser uses the sequence combinators (~> and &lt;~) to drop the quote characters themselves.

Attributes

Returns

a Parser[String] that successfully parses a string enclosed in quotes and returns the content within the quotes as a String.

lazy val quotedString: Parser[String]

A parser for quoted strings in the input, using a combination of possible parsing strategies.

A parser for quoted strings in the input, using a combination of possible parsing strategies.

The quotedString method combines three different parsers to handle quoted strings:

  1. quotedStringWithQuotes: Parses quoted strings that include surrounding quotation marks.
  2. pureQuotedString: Parses quoted strings but may apply stricter conditions (e.g., specific delimiters or special characters).
  3. failure("invalid quoted string"): Ensures that any string not following the valid quoted string format results in a failure.

This is defined as a lazy val, meaning the parser's initialization is deferred until it is first accessed.

Attributes

Returns

A Parser[String] that matches valid quoted strings in the input.

lazy val quotedStringWithQuotes: Parser[String]

Parser for quoted strings that includes the surrounding quotes as part of the result.

Parser for quoted strings that includes the surrounding quotes as part of the result.

This lazy value utilizes quotedStringWithQuotesAsList, which parses the string components into a list of strings. It then combines those components into a single string by adding the surrounding quotes (as defined by the quote variable).

The resulting parsed string includes both the content of the quoted string and the enclosing quote characters.

For example: Input: "Hello, World!" Output: "Hello, World!" (as a single string, including the quotation marks)

Attributes

Returns

a parser that yields the entire quoted string, including the enclosing quotes.

lazy val quotedStringWithQuotesAsList: Parser[Strings]

A parser that extracts a sequence of strings (Strings) from a quoted string, interpreting quotes and escaped quotes appropriately.

A parser that extracts a sequence of strings (Strings) from a quoted string, interpreting quotes and escaped quotes appropriately.

The input is expected to start and end with a quote character. Inside the quotes, delimited substrings can be separated by pairs of quote characters.

Example Input: "abc""def""ghi" Parsed Output: Seq("abc", "def", "ghi")

The parser works as follows:

  • quote ~> ensures that the input starts with a single opening quote.
  • repsep(stringInQuotes, s"$quote$quote") parses a repetition of strings defined by stringInQuotes, with consecutive strings separated by double quotes ("").
  • &lt;~ quote ensures the input ends with a single closing quote.

Attributes

Returns

a Parser[Strings] capable of parsing a quoted string into a sequence of substrings.

lazy val row: Parser[Strings]

A parser for parsing a single row consisting of multiple cells separated by a delimiter.

A parser for parsing a single row consisting of multiple cells separated by a delimiter.

This parser matches and extracts repetitions of cells (parsed by the cell parser) separated by the specified delimiter. The result is returned as a sequence of strings (Strings).

  • The rep1sep combinator ensures that at least one cell is expected in the row.
  • The delimiter parser defines the separator between cells.

This parser can be used in conjunction with other parsers to process row-based data with a specific format or structure.

Attributes

lazy val stringInQuotes: Parser[String]

A Parser that matches a string that includes zero or more characters (other than quote characters as defined by the quote parameter).

A Parser that matches a string that includes zero or more characters (other than quote characters as defined by the quote parameter).

This parser specifically matches a sequence of characters that does not include the quote character ("). The quote character in this context is expected to be defined elsewhere in the class or inherited scope.

Usage: This parser can be used to identify and extract substrings within a larger input that are enclosed in quotes, as part of a more complex parsing process.

Attributes

Returns

a string that matches the defined regular expression.

Inherited fields

protected val whiteSpace: Regex

Attributes

Inherited from:
RegexParsers

Implicits

Inherited implicits

implicit def accept(e: Elem): Parser[Elem]

A parser that matches only the given element e.

A parser that matches only the given element e.

The method is implicit so that elements can automatically be lifted to their parsers. For example, when parsing Tokens, Identifier("new") (which is a Token) can be used directly, instead of first creating a Parser using accept(Identifier("new")).

Value parameters

e

the Elem that must be the next piece of input for the returned parser to succeed

Attributes

Returns

a tParser that succeeds if e is the next available input.

Inherited from:
Parsers
implicit def literal(s: String): Parser[String]

A parser that matches a literal string

A parser that matches a literal string

Attributes

Inherited from:
RegexParsers
implicit def regex(r: Regex): Parser[String]

A parser that matches a regex string

A parser that matches a regex string

Attributes

Inherited from:
RegexParsers
Generated with