TopLevelParser

com.ossuminc.riddl.language.parsing.TopLevelParser
See theTopLevelParser companion class

Attributes

Companion
class
Source
TopLevelParser.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

Alternate, non-asynchronous interface to parsing.

Alternate, non-asynchronous interface to parsing. If you have your data already, you can just make your own RiddlParserInput from a string and call this to start parsing.

Value parameters

input

The RiddlParserInput that contains the data to parse

withVerboseFailures

For the utility of RIDDL implementers.

Attributes

Returns
Source
TopLevelParser.scala

Parse an arbitrary (nebulous) set of definitions in any order

Parse an arbitrary (nebulous) set of definitions in any order

Value parameters

input

The input to parse

withVerboseFailures

For the utility of RIDDL implementers.

Attributes

Returns

  • Left(messages) -> messages indicaitng the error

  • Right(nebula) -> the nebula containing the list of things that were parsed

Source
TopLevelParser.scala

Parse a string directly

Parse a string directly

Value parameters

input

The input string to parse

withVerboseFailures

For the utility of RIDDL implementers.

Attributes

Returns

Left(messages) -> messages indicaitng the error Right(root) -> the resulting AST.Root from the parse

Source
TopLevelParser.scala

Parse the input to a list of tokens.

Parse the input to a list of tokens. This is aimed to making highlighting in editors quick and simple. The input is not validate for syntactic correctness and likely succeeds on most input.

Value parameters

input

The input to be parsed

withVerboseFailures

Set to true to debug parsing failures. Probably of interest only to the implementors. The default, false, causes no functional difference.

Attributes

Source
TopLevelParser.scala

Main entry point into parsing.

Main entry point into parsing. This sets up the asynchronous (but maybe not parallel) parsing of the input to the parser.

Value parameters

url

A file:// or https:// based url to specify the source of the parser input

withVerboseFailures

Control whether parse failures are diagnosed verbosely or not. Typically only useful to maintainers of RIDDL, or test cases

Attributes

Source
TopLevelParser.scala