Class NodeFactory<Source, Output>

constructor

• new NodeFactory<Source, Output>(constructorFunction, children?, finalizer?, skipChildren?, childrenSetAtConstruction?): NodeFactory<Source, Output>

• Type Parameters

  • Source
  • Output extends Node

  Parameters

  • constructorFunction: ((s, t, f) => Output[])
    • • (s, t, f): Output[]

      • Parameters

        • s: Source
        • t: ASTTransformer
        • f: NodeFactory<Source, Output>

        Returns Output[]

  • children: Map<string, undefined | ChildNodeFactory<Source, any, any>> = ...
  • finalizer: ((node) => void) = ...
    • • (node): void

      • Parameters

        • node: Output

        Returns void

  • skipChildren: boolean = false
  • childrenSetAtConstruction: boolean = false

  Returns NodeFactory<Source, Output>

children

childrenSetAtConstruction

constructorFunction

finalizer

skipChildren

getChildNodeFactory

• getChildNodeFactory(prefix, propertyName): undefined | ChildNodeFactory<Source, any, any>

• Parameters

  • prefix: string
  • propertyName: string

  Returns undefined | ChildNodeFactory<Source, any, any>

setSkipChildren

• setSkipChildren(skip?): NodeFactory<Source, Output>

• Tells the transformer whether this factory already takes care of the node's children and no further computation is desired on that subtree. E.g., when we're mapping an ANTLR parse tree, and we have a context that is only a wrapper over several alternatives, and for some reason those are not labeled alternatives in ANTLR (subclasses), we may configure the transformer as follows:

  transformer.registerNodeFactory(XYZContext) { ctx => transformer.transform(ctx.children[0]) }
  Copy

  However, if the result of transformer.transform(ctx.children[0]) is an instance of a Node with a child for which withChild was configured, the transformer will think that it has to populate that child, according to the configuration determined by reflection. When it tries to do so, the "source" of the node will be an instance of XYZContext that may not have a child with a corresponding name, and the transformation will fail – or worse, it will map an unrelated node.

  Note: this method is called skipChildren in StarLasu, but skipChildren is already the name of a property, and the TypeScript and JavaScript languages don't allow to have a property with the same name as a method.

  Parameters

  • skip: boolean = true

  Returns NodeFactory<Source, Output>

withChild

• withChild<Target, Child>(child): NodeFactory<Source, Output>

• Specify how to convert a child. The value obtained from the conversion could either be used as a constructor parameter when instantiating the parent, or be used to set the value after the parent has been instantiated.

  Type Parameters

  • Target
  • Child

  Parameters

  • child: ChildDef<Source, Target, Child>

  Returns NodeFactory<Source, Output>

withFinalizer

• withFinalizer(finalizer): void

• Parameters

  • finalizer: ((o) => void)
    • • (o): void

      • Parameters

        • o: Output

        Returns void

  Returns void

Static single

• single<Source, Output>(singleConstructor, children?, finalizer?, skipChildren?, childrenSetAtConstruction?): NodeFactory<Source, Output>

• Type Parameters

  • Source
  • Output extends Node

  Parameters

  • singleConstructor: ((s, t, f) => undefined | Output)
    • • (s, t, f): undefined | Output

      • Parameters

        • s: Source
        • t: ASTTransformer
        • f: NodeFactory<Source, Output>

        Returns undefined | Output

  • children: Map<string, undefined | ChildNodeFactory<Source, any, any>> = ...
  • finalizer: ((node) => void) = ...
    • • (node): void

      • Parameters

        • node: Output

        Returns void

  • skipChildren: boolean = false
  • childrenSetAtConstruction: boolean = false

  Returns NodeFactory<Source, Output>