com.ossuminc.riddl.language

Members list

Type members

Classlikes

object AST

Abstract Syntax Tree This object defines the model for representing RIDDL as an Abstract Syntax Tree.

Abstract Syntax Tree This object defines the model for representing RIDDL as an Abstract Syntax Tree. This raw AST has no referential integrity, it just results from applying the parsing rules to the input. The RawAST models produced from parsing are syntactically correct but have no semantic validation.

Attributes

Source
AST.scala
Supertypes
class Object
trait Matchable
class Any
Self type
AST.type
case class At(source: RiddlParserInput, offset: Int) extends Ordered[At]

A location of an item in the input

A location of an item in the input

Value parameters

offset

The offset in that file/stream the defines the location

source

The parsing.RiddlParserInput instance from which the location as derived

Attributes

Companion
object
Source
At.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Ordered[At]
trait Comparable[At]
class Object
trait Matchable
class Any
Show all
object At

Attributes

Companion
class
Source
At.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
At.type

The common options available to any pass.

The common options available to any pass. Common options occur before the command name on the riddlc command line

Value parameters

debug

Controls whether debug output should be printed out (this goes into the iterative data that verbose doesn't print)

dryRun

Controls whether everything should be done except the requested action (useful with verbose)

groupMessagesByKind

When set to true, the messages put out will be grouped by their kind and sorted with the most severe first.

maxIncludeWait

Provides the maximum amount of time that the parser should wait for a parallel include to finish processing. The default is 5 seconds.

maxParallelParsing

Provides the maximum number of threads to use when parsing in parallel. The default is the number of CPU cores on the machine the program is running on.

noANSIMessages

When set to true, ANSI coloring is not used in the output

pluginsDir

Provides the path to a directory in which plugins can be found. Plugins should contain a command

quiet

Controls whether riddlc should not print anything out but just do the requested action (opposite of dryRun)

showIncludeTimes

Controls whether include processing timing is printed out

showInfoMessages

Controls whether any informative messages are printed out

showMissingWarnings

Controls whether any missing Warnings are printed out

showStyleWarnings

Controls whether any style Warnings are printed out

showTimes

Controls whether pass timing is printed out

showUsageWarnings

Controls whether any usage Warnings are printed out

showWarnings

Controls whether any warnings, of any kind, are printed out

sortMessagesByLocation

When set to true, the messages put out will be sorted by their location in the model (file, line, column)

verbose

Controls whether verbose steps taken are printed out (useful to implementors of riddlc)

warningsAreFatal

When set to true, any warnings are handled as if they were errors and terminate riddlc with a non-zero status

Attributes

Companion
object
Source
CommonOptions.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CommonOptions

Attributes

Companion
class
Source
CommonOptions.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Finder[CV <: ContentValues](root: Container[CV])

The context for finding things within a given Container of com.ossuminc.riddl.language.AST.RiddlValue as found in the AST model.

The context for finding things within a given Container of com.ossuminc.riddl.language.AST.RiddlValue as found in the AST model. This provides the ability to find values in the model by traversing it and looking for the matching condition.

Value parameters

root

The container of RiddlValues to traverse for the sought condition

Attributes

Companion
object
Source
Finder.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Finder

Attributes

Companion
class
Source
Finder.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Finder.type
object Folding

An object for distinguishing several functions as ways to fold the model

An object for distinguishing several functions as ways to fold the model

Attributes

Source
Folding.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Folding.type
object KnownOption

Attributes

Source
KnownOptions.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object KnownOptions

AN object that defines the names of the known options

AN object that defines the names of the known options

Attributes

Source
KnownOptions.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object Messages

This module handles everything needed to deal with the message output of the riddlc compiler

This module handles everything needed to deal with the message output of the riddlc compiler

Attributes

Source
Messages.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Messages.type