RIDDL API Documentation
0.0.0-1-1f99f002
API
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.
RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.language/com.ossuminc.riddl.language.parsing/TopLevelParser

TopLevelParser

com.ossuminc.riddl.language.parsing.TopLevelParser
See theTopLevelParser companion object
case class TopLevelParser(input: RiddlParserInput, withVerboseFailures: Boolean)(using io: PlatformContext) extends ExtensibleTopLevelParser

The TopLevel (Root) parser. This class munges all the individual parsers together and provides top level parsing functionality.

Value parameters

input

The RiddlParserInput that contains the data to parse

withVerboseFailures

For the utility of RIDDL implementers.

Attributes

Companion
object
Source
TopLevelParser.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait RootParser
trait Readability
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

enum StatementsSet

Attributes

Inherited from:
StatementParser (hidden)
Source
StatementParser.scala
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Inherited methods

def `for`[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def `with`[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def adaptor[u : ParsingRun]: ParsingRun[Adaptor]

Attributes

Inherited from:
AdaptorParser (hidden)
Source
AdaptorParser.scala
def aggregation[u : ParsingRun]: ParsingRun[Aggregation]

Attributes

Inherited from:
TypeParser (hidden)
Source
TypeParser.scala
def and[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def anyInteractionRef[u : ParsingRun]: ParsingRun[Reference[Definition]]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def appInput[u : ParsingRun]: ParsingRun[Input]

Attributes

Inherited from:
ApplicationParser (hidden)
Source
ApplicationParser.scala
def appOutput[u : ParsingRun]: ParsingRun[Output]

Attributes

Inherited from:
ApplicationParser (hidden)
Source
ApplicationParser.scala
def application[u : ParsingRun]: ParsingRun[Application]

Attributes

Inherited from:
ApplicationParser (hidden)
Source
ApplicationParser.scala
def are[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def arguments[u : ParsingRun]: ParsingRun[Seq[MethodArgument]]

Attributes

Inherited from:
TypeParser (hidden)
Source
TypeParser.scala
def as[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def at[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def author[u : ParsingRun]: ParsingRun[Author]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def authorRef[u : ParsingRun]: ParsingRun[AuthorRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def briefDescription[u : ParsingRun]: ParsingRun[BriefDescription]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def by[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def byAs[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def checkForDuplicateIncludes[CT <: RiddlValue](contents: Seq[CT]): Unit

Attributes

Inherited from:
ParsingContext
Source
ParsingContext.scala
def close[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def comment[u : ParsingRun]: ParsingRun[Comment]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def comments[u : ParsingRun]: ParsingRun[Seq[Comment]]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def connector[u : ParsingRun]: ParsingRun[Connector]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def constant[u : ParsingRun]: ParsingRun[Constant]

Attributes

Inherited from:
TypeParser (hidden)
Source
TypeParser.scala
def constantRef[u : ParsingRun]: ParsingRun[ConstantRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def containedGroup[u : ParsingRun]: ParsingRun[ContainedGroup]

Attributes

Inherited from:
ApplicationParser (hidden)
Source
ApplicationParser.scala
def context[u : ParsingRun]: ParsingRun[Context]

Attributes

Inherited from:
ContextParser (hidden)
Source
ContextParser.scala
def contextRef[u : ParsingRun]: ParsingRun[ContextRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def description[u : ParsingRun](implicit evidence$1: ParsingRun[u], ctx: ParsingRun[_]): ParsingRun[Description]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def doImport(loc: At, domainName: Identifier, url: LiteralString)(implicit ctx: ParsingRun[_]): Domain

Attributes

Inherited from:
ParsingContext
Source
ParsingContext.scala
def doIncludeParsing[CT <: RiddlValue](loc: At, path: String, rule: (ParsingRun[_]) => ParsingRun[Seq[CT]])(implicit ctx: ParsingRun[_]): Include[CT]

Attributes

Inherited from:
ParsingContext
Source
ParsingContext.scala
def domain[u : ParsingRun]: ParsingRun[Domain]

Attributes

Inherited from:
DomainParser (hidden)
Source
DomainParser.scala
def entity[u : ParsingRun]: ParsingRun[Entity]

Attributes

Inherited from:
EntityParser (hidden)
Source
EntityParser.scala
def entityRef[u : ParsingRun]: ParsingRun[EntityRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def enumeration[u : ParsingRun]: ParsingRun[Enumeration]

Attributes

Inherited from:
TypeParser (hidden)
Source
TypeParser.scala
def enumerator[u : ParsingRun]: ParsingRun[Enumerator]

Attributes

Inherited from:
TypeParser (hidden)
Source
TypeParser.scala
def epic[u : ParsingRun]: ParsingRun[Epic]

Attributes

Inherited from:
EpicParser (hidden)
Source
EpicParser.scala
def epicRef[u : ParsingRun]: ParsingRun[EpicRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def error(loc: At, message: String, context: String): Unit

Attributes

Inherited from:
ParsingErrors
Source
ParsingErrors.scala
def error(message: String): Unit

Attributes

Inherited from:
ParsingErrors
Source
ParsingErrors.scala
def escape[u : ParsingRun]: ParsingRun[String]

Attributes

Inherited from:
NoWhiteSpaceParsers (hidden)
Source
NoWhiteSpaceParsers.scala
def field[u : ParsingRun]: ParsingRun[Field]

Attributes

Inherited from:
TypeParser (hidden)
Source
TypeParser.scala
def fieldRef[u : ParsingRun]: ParsingRun[FieldRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def fileAttachment[u : ParsingRun]: ParsingRun[FileAttachment]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def flow[u : ParsingRun]: ParsingRun[Streamlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def from[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def funcInput[u : ParsingRun]: ParsingRun[Aggregation]

Attributes

Inherited from:
FunctionParser (hidden)
Source
FunctionParser.scala
def funcOutput[u : ParsingRun]: ParsingRun[Aggregation]

Attributes

Inherited from:
FunctionParser (hidden)
Source
FunctionParser.scala
def function[u : ParsingRun]: ParsingRun[Function]

Parses function literals, i.e.

Parses function literals, i.e.

function myFunction is {
  requires is Boolean
  returns is Integer
  statements | comments | functions | terms
}

Attributes

Inherited from:
FunctionParser (hidden)
Source
FunctionParser.scala
def functionRef[u : ParsingRun]: ParsingRun[FunctionRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def getURLs: Seq[URL]

Attributes

Inherited from:
ParsingContext
Source
ParsingContext.scala
def group[u : ParsingRun]: ParsingRun[Group]

Attributes

Inherited from:
ApplicationParser (hidden)
Source
ApplicationParser.scala
def groupAliases[u : ParsingRun]: ParsingRun[String]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def groupRef[u : ParsingRun]: ParsingRun[GroupRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def handler[u : ParsingRun](set: StatementsSet): ParsingRun[Handler]

Attributes

Inherited from:
HandlerParser (hidden)
Source
HandlerParser.scala
def handlerRef[u : ParsingRun]: ParsingRun[HandlerRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def handlers[u : ParsingRun](set: StatementsSet): ParsingRun[Seq[Handler]]

Attributes

Inherited from:
HandlerParser (hidden)
Source
HandlerParser.scala
def httpUrl[u : ParsingRun]: ParsingRun[URL]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def identifier[u : ParsingRun]: ParsingRun[Identifier]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def importDef[u : ParsingRun]: ParsingRun[OccursInDomain]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def in[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def include[u : ParsingRun, CT <: RiddlValue](parser: (ParsingRun[_]) => ParsingRun[Seq[CT]]): ParsingRun[Include[CT]]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def inlet[u : ParsingRun]: ParsingRun[Inlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def inletRef[u : ParsingRun]: ParsingRun[InletRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def inputAliases[u : ParsingRun]: ParsingRun[String]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def inputRef[u : ParsingRun]: ParsingRun[InputRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def integer[u : ParsingRun]: ParsingRun[Long]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def invariant[u : ParsingRun]: ParsingRun[Invariant]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def is[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def literalString[u : ParsingRun]: ParsingRun[LiteralString]

Attributes

Inherited from:
NoWhiteSpaceParsers (hidden)
Source
NoWhiteSpaceParsers.scala
def literalStrings[u : ParsingRun]: ParsingRun[Seq[LiteralString]]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def location[u : ParsingRun](implicit evidence$1: ParsingRun[u], ctx: ParsingRun[_]): ParsingRun[At]

Attributes

Inherited from:
ParsingContext
Source
ParsingContext.scala
def makeParseFailureError(failure: Failure, input: RiddlParserInput): Unit

Attributes

Inherited from:
ParsingErrors
Source
ParsingErrors.scala
def markdownLine[u : ParsingRun]: ParsingRun[LiteralString]

Attributes

Inherited from:
NoWhiteSpaceParsers (hidden)
Source
NoWhiteSpaceParsers.scala
def maybe[u : ParsingRun](keyword: String): ParsingRun[Unit]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def maybeDescription[u : ParsingRun]: ParsingRun[Option[Description]]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def merge[u : ParsingRun]: ParsingRun[Streamlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def messageRef[u : ParsingRun]: ParsingRun[MessageRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
protected def messagesAsList: Messages

Attributes

Inherited from:
ParsingErrors
Source
ParsingErrors.scala
protected def messagesNonEmpty: Boolean

Attributes

Inherited from:
ParsingErrors
Source
ParsingErrors.scala
def metaData[u : ParsingRun]: ParsingRun[MetaData]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def method[u : ParsingRun]: ParsingRun[Method]

Attributes

Inherited from:
TypeParser (hidden)
Source
TypeParser.scala
def mimeType[u : ParsingRun]: ParsingRun[String]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def module[u : ParsingRun]: ParsingRun[Module]

Attributes

Inherited from:
ModuleParser (hidden)
Source
ModuleParser.scala
def moduleContent[u : ParsingRun]: ParsingRun[ModuleContents]

Attributes

Inherited from:
ModuleParser (hidden)
Source
ModuleParser.scala
def moduleContents[u : ParsingRun]: ParsingRun[Seq[ModuleContents]]

Attributes

Inherited from:
ModuleParser (hidden)
Source
ModuleParser.scala
def nebula[u : ParsingRun]: ParsingRun[Nebula]

Attributes

Inherited from:
NebulaParser (hidden)
Source
NebulaParser.scala
def of[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def onClause[u : ParsingRun](set: StatementsSet): ParsingRun[OnClause]

Attributes

Inherited from:
HandlerParser (hidden)
Source
HandlerParser.scala
def open[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def option[u : ParsingRun]: ParsingRun[OptionValue]

Attributes

Inherited from:
ProcessorParser
Source
ProcessorParser.scala
def outlet[u : ParsingRun]: ParsingRun[Outlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def outletRef[u : ParsingRun]: ParsingRun[OutletRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def outputAliases[u : ParsingRun]: ParsingRun[String]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def outputRef[u : ParsingRun]: ParsingRun[OutputRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def parseRule[RESULT <: RiddlValue](rpi: RiddlParserInput, rule: (ParsingRun[_]) => ParsingRun[RESULT], withVerboseFailures: Boolean)(validate: (result: Either[Messages, RESULT], input: RiddlParserInput, index: Int) => Either[Messages, RESULT]): Either[Messages, RESULT]

Attributes

Inherited from:
ParsingContext
Source
ParsingContext.scala
def pathIdentifier[u : ParsingRun]: ParsingRun[PathIdentifier]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def processorDefinitionContents[u : ParsingRun](statementsSet: StatementsSet): ParsingRun[OccursInProcessor]

Attributes

Inherited from:
ProcessorParser
Source
ProcessorParser.scala
def processorRef[u : ParsingRun]: ParsingRun[ProcessorRef[Processor[_]]]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def projector[u : ParsingRun]: ParsingRun[Projector]

Parses projector definitions, e.g.

Parses projector definitions, e.g.

projector myView is {
  foo: Boolean
  bar: Integer
}

Attributes

Inherited from:
ProjectorParser (hidden)
Source
ProjectorParser.scala
def pseudoCodeBlock[u : ParsingRun](set: StatementsSet): ParsingRun[Seq[Statements]]

Attributes

Inherited from:
StatementParser (hidden)
Source
StatementParser.scala
def relationship[u : ParsingRun]: ParsingRun[Relationship]

Attributes

Inherited from:
ProcessorParser
Source
ProcessorParser.scala
def relationshipCardinality[u : ParsingRun]: ParsingRun[RelationshipCardinality]

Attributes

Inherited from:
ProcessorParser
Source
ProcessorParser.scala
def repository[u : ParsingRun]: ParsingRun[Repository]

Attributes

Inherited from:
RepositoryParser (hidden)
Source
RepositoryParser.scala
def repositoryRef[u : ParsingRun]: ParsingRun[RepositoryRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def root[u : ParsingRun]: ParsingRun[Root]

Attributes

Inherited from:
RootParser
Source
RootParser.scala
def router[u : ParsingRun]: ParsingRun[Streamlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def saga[u : ParsingRun]: ParsingRun[Saga]

Attributes

Inherited from:
SagaParser (hidden)
Source
SagaParser.scala
def sagaStep[u : ParsingRun]: ParsingRun[SagaStep]

Attributes

Inherited from:
SagaParser (hidden)
Source
SagaParser.scala
def schema[u : ParsingRun]: ParsingRun[Schema]

Attributes

Inherited from:
RepositoryParser (hidden)
Source
RepositoryParser.scala
def setOfStatements[u : ParsingRun](set: StatementsSet): ParsingRun[Seq[Statements]]

Attributes

Inherited from:
StatementParser (hidden)
Source
StatementParser.scala
def shownBy[u : ParsingRun]: ParsingRun[ShownBy]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def sink[u : ParsingRun]: ParsingRun[Streamlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def so[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def source[u : ParsingRun]: ParsingRun[Streamlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def split[u : ParsingRun]: ParsingRun[Streamlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def state[u : ParsingRun]: ParsingRun[State]

Attributes

Inherited from:
EntityParser (hidden)
Source
EntityParser.scala
def stateRef[u : ParsingRun]: ParsingRun[StateRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def statement[u : ParsingRun](set: StatementsSet): ParsingRun[Statements]

Attributes

Inherited from:
StatementParser (hidden)
Source
StatementParser.scala
def streamlet[u : ParsingRun]: ParsingRun[Streamlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def stringAttachment[u : ParsingRun]: ParsingRun[StringAttachment]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def term[u : ParsingRun]: ParsingRun[Term]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def that[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def to[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def toEndOfLine[u : ParsingRun]: ParsingRun[String]

Attributes

Inherited from:
NoWhiteSpaceParsers (hidden)
Source
NoWhiteSpaceParsers.scala
def typeDef[u : ParsingRun]: ParsingRun[Type]

Attributes

Inherited from:
TypeParser (hidden)
Source
TypeParser.scala
def typeRef[u : ParsingRun]: ParsingRun[TypeRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def ulidAttachment[u : ParsingRun]: ParsingRun[ULIDAttachment]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def undefined[u : ParsingRun, RT](f: => RT): ParsingRun[RT]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
def until[u : ParsingRun](first: Char, second: Char): ParsingRun[String]

Attributes

Inherited from:
NoWhiteSpaceParsers (hidden)
Source
NoWhiteSpaceParsers.scala
def until3[u : ParsingRun](first: Char, second: Char, third: Char): ParsingRun[String]

Attributes

Inherited from:
NoWhiteSpaceParsers (hidden)
Source
NoWhiteSpaceParsers.scala
def useCase[u : ParsingRun]: ParsingRun[UseCase]

Attributes

Inherited from:
EpicParser (hidden)
Source
EpicParser.scala
def user[u : ParsingRun]: ParsingRun[User]

Attributes

Inherited from:
DomainParser (hidden)
Source
DomainParser.scala
def userRef[u : ParsingRun]: ParsingRun[UserRef]

Attributes

Inherited from:
ReferenceParser (hidden)
Source
ReferenceParser.scala
def userStory[u : ParsingRun]: ParsingRun[UserStory]

Attributes

Inherited from:
EpicParser (hidden)
Source
EpicParser.scala
def vitalDefinitionContents[u : ParsingRun]: ParsingRun[OccursInVitalDefinition]

Attributes

Inherited from:
VitalDefinitionParser
Source
VitalDefinitionParser.scala
def void[u : ParsingRun]: ParsingRun[Streamlet]

Attributes

Inherited from:
StreamingParser (hidden)
Source
StreamingParser.scala
def wants[u : ParsingRun]: ParsingRun[Unit]

Attributes

Inherited from:
Readability
Source
Readability.scala
def warning(loc: At, message: String, context: String): Unit

Attributes

Inherited from:
ParsingErrors
Source
ParsingErrors.scala
def withMetaData[u : ParsingRun]: ParsingRun[Seq[MetaData]]

Attributes

Inherited from:
CommonParser (hidden)
Source
CommonParser.scala
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.