SymbolsOutput

com.reactific.riddl.passes.symbols.SymbolsOutput
case class SymbolsOutput(messages: Messages, symTab: SymTab, parentage: Parentage) extends PassOutput

Output from the Symbols Pass

Value parameters

messages

The error messages generated by the pass

symTab

The SymbolTable that handles identifier translation to definitions

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class PassOutput
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

The result of a lookupSymbol request A lookupSymbol request returns a list of tuples that contain the generic definition, as a Definition, and, if the definition matches the type of interest, D, then an Option[D] for convenience.

The result of a lookupSymbol request A lookupSymbol request returns a list of tuples that contain the generic definition, as a Definition, and, if the definition matches the type of interest, D, then an Option[D] for convenience.

Attributes

Value members

Concrete methods

def contextOf(definition: Definition): Option[Context]
def lookup[D <: Definition : ClassTag](ref: Reference[D]): List[D]
def lookup[D <: Definition : ClassTag](id: Seq[String]): List[D]

Look up a symbol in the table

Look up a symbol in the table

Value parameters

names

The multi-part identifier of the symbol, from leaf to root, that is from most nested to least nested.

Attributes

Returns

A list of matching definitions of 2-tuples giving the definition as a Definition type and optionally as the requested type

Look up a symbol in the table

Look up a symbol in the table

Type parameters

D

The expected type of definition

Value parameters

id

The multi-part identifier of the symbol, from leaf to root, that is from most nested to least nested.

Attributes

Returns

A list of matching definitions of 2-tuples giving the definition as a Definition type and optionally as the requested type

def parentOf(definition: Definition): Option[Definition]

Get the parent of a definition

Get the parent of a definition

Value parameters

definition

The definition whose parent is to be sought.

Attributes

Returns

optionally, the parent definition of the given definition

def parentsOf(definition: Definition): Seq[Definition]

Get all parents of a definition

Get all parents of a definition

Value parameters

definition

The defintiion whose parents are to be sought.

Attributes

Returns

the sequence of ParentDefOf parents or empty if none.

def pathOf(definition: Definition): Seq[String]

Get the full path of a definition

Get the full path of a definition

Value parameters

definition

The definition for which the path name is sought.

Attributes

Returns

A list of strings from leaf to root giving the names of the definition and its parents.

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product