RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.hugo/HugoPass

HugoPass

com.ossuminc.riddl.hugo.HugoPass

See theHugoPass companion object

case class HugoPass(input: PassInput, outputs: PassesOutput, options: Options, commonOptions: CommonOptions) extends Pass, TranslatingState[MarkdownWriter], Summarizer

Attributes

Companion: object
Source: HugoPass.scala
Graph
Supertypes: trait Serializable

trait Product

trait Equals

trait Summarizer

trait TranslatingState[MarkdownWriter]

class Pass

class Object

trait Matchable

class Any
Show all

Members list

Value members

Concrete methods

Attributes

Source: HugoPass.scala

A signal that the processing is complete and no more calls to process will be made.

A signal that the processing is complete and no more calls to process will be made. This also gives the Pass subclass a chance to do post-processing as some computations can only be done after collecting data from the entire AST

Value parameters

root: The root of the parsed model just as a convenience for post-processing

Attributes

Definition Classes: Pass
Source: HugoPass.scala

The main implementation of the Pass.

The main implementation of the Pass. The AST is walked in a depth first manner calling this function for each definition it encounters.

Value parameters

definition: The definition to be processed
parents: The stack of definitions that are the parents of com.ossuminc.riddl.language.AST.Definition. This stack goes from immediate parent towards the root. The root is deepest in the stack.

Attributes

Definition Classes: Pass
Source: HugoPass.scala

Generate the output of this Pass.

Generate the output of this Pass. This will only be called after all the calls to process have completed.

Value parameters

root: The new com.ossuminc.riddl.language.AST.Root of the model that the pass computed

Attributes

Returns: an instance of the output type
Definition Classes: Pass
Source: HugoPass.scala

Inherited methods

Attributes

Inherited from:: TranslatingState
Source: TranslatingState.scala

Attributes

Inherited from:: TranslatingState
Source: TranslatingState.scala

Close any resources used so this can be used with AutoCloseable or Using.Manager

Attributes

Inherited from:: Pass
Source: Pass.scala

Attributes

Inherited from:: TranslatingState
Source: TranslatingState.scala

Attributes

Inherited from:: TranslatingState
Source: TranslatingState.scala

Attributes

Inherited from:: Summarizer
Source: Summarizer.scala

Attributes

Inherited from:: TranslatingState
Source: TranslatingState.scala

Pre-process the root before actually traversing.

Pre-process the root before actually traversing. This is also a signal that the processing is about to start.

Value parameters

root: A com.ossuminc.riddl.language.AST.Root node which encapsulates the whole model. This is the state of the Root as of the last pass.

Attributes

Returns: Typically returns the same Root objects with changes in subsequent levels, but it entirely possibly to completely reorganize the hierarchy, including its root node.
Inherited from:: Pass
Source: Pass.scala

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

Attributes

Inherited from:: Summarizer
Source: Summarizer.scala

Attributes

Inherited from:: TranslatingState
Source: TranslatingState.scala

Concrete fields

THe name of the pass for inclusion in messages it produces.

THe name of the pass for inclusion in messages it produces. This must be implemented by the subclass

Attributes

Returns: A string value giving the name of this pass
Source: HugoPass.scala

Attributes

Source: HugoPass.scala

Inherited fields

Attributes

Inherited from:: TranslatingState
Source: TranslatingState.scala

Attributes

Inherited from:: TranslatingState
Source: TranslatingState.scala

Attributes

Inherited from:: Pass
Source: Pass.scala

Attributes

Inherited from:: Pass
Source: Pass.scala

In this article

Generated with