DepthFirstPass

com.ossuminc.riddl.passes.DepthFirstPass

Attributes

Source
Pass.scala
Graph
Supertypes
class Pass
class Object
trait Matchable
class Any
Known subtypes
class FlattenPass

Members list

Value members

Concrete methods

override protected def traverse(definition: RiddlValue, parents: ParentStack): Unit

A method for the traversal of the AST hierarchy.

A method for the traversal of the AST hierarchy. This implementation traverses nodes in a depth first fashion.

Value parameters

definition

The root (starting point) of the traversal

parents

The parents of the definition

Attributes

Definition Classes
Source
Pass.scala

Inherited methods

def close(): Unit

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

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

Attributes

Inherited from:
Pass
Source
Pass.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

Inherited from:
Pass
Source
Pass.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

Inherited and Abstract methods

def name: String

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

Inherited from:
Pass
Source
Pass.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

Inherited from:
Pass
Source
Pass.scala

Inherited fields

val in: PassInput

Attributes

Inherited from:
Pass
Source
Pass.scala

Attributes

Inherited from:
Pass
Source
Pass.scala