Class CompositeGeneratorNode

Implementation of GeneratorNode serving as container for string segments, newline indicators, and further CompositeGeneratorNodes, esp. IndentNodes.

See usage examples in the append... methods' documentations for details.

Hierarchy (view full)

CompositeGeneratorNode
- IndentNode

Index

Constructors

constructor

new CompositeGeneratorNode(...content): CompositeGeneratorNode
Constructor.
Parameters
- Rest...content: Generated[]
  a var arg mixture of strings and GeneratorNodes describing the initial content of this CompositeGeneratorNode
Returns CompositeGeneratorNode
Example
```
new CompositeGeneratorNode(
     'Hello World!', NL
  );
```
- Defined in packages/langium/src/generate/generator-node.ts:93

Properties

`Readonly`contents

contents: (string | GeneratorNode)[] = []

`Optional`tracedSource

tracedSource?: TraceSourceSpec | SourceRegion | SourceRegion[]

Methods

append

append(...content): this
Appends strings and instances of GeneratorNode to this generator node.
Parameters
- Rest...content: (Generated | ((node: this) => void))[]
  a var arg mixture of strings, GeneratorNodes, or single param functions that are immediately called with this node as argument, and which may append elements themselves.
Returns this
this CompositeGeneratorNode for convenience.
Example
```
new CompositeGeneratorNode().append(
     'Hello', ' ', `${name}!`, NL, someOtherNode, 'NL', node => generateContent(node)
  ).append(
     'The end!'
  );
```
- Defined in packages/langium/src/generate/generator-node.ts:189

appendIf

appendIf(condition, ...content): this
Appends strings and instances of GeneratorNode to this generator node, if condition is equal to true.

If condition is satisfied this method delegates to append, otherwise it returns just this.
Parameters
- condition: boolean
  a boolean value indicating whether to append the elements of args to this.
- Rest...content: (Generated | ((node: CompositeGeneratorNode) => void))[]
  a var arg mixture of strings, GeneratorNodes, or single param functions that are immediately called with this node as argument, and which may append elements themselves.
Returns this
this CompositeGeneratorNode for convenience.
Example
```
new CompositeGeneratorNode().append(
     'Hello World!'
  ).appendNewLine().appendIf(
     entity !== undefined, `Hello ${entity?.name}!`
  ).appendNewLineIfNotEmpty();
```
- Defined in packages/langium/src/generate/generator-node.ts:219

appendNewLine

appendNewLine(): this
Appends a strict NewLineNode to this node. Strict NewLineNodes yield mandatory linebreaks in the derived generated text.

Returns this
this CompositeGeneratorNode for convenience.
Example
```
new CompositeGeneratorNode().append(
     'Hello World!'
  ).appendNewLine();
```
- Defined in packages/langium/src/generate/generator-node.ts:234

appendNewLineIf

appendNewLineIf(condition): this
Appends a strict NewLineNode to this node, if condition is equal to true. Strict NewLineNodes yield mandatory linebreaks in the derived generated text.
Parameters
- condition: boolean
  a boolean value indicating whether to append a NewLineNode to this.
Returns this
this CompositeGeneratorNode for convenience.
Example
```
new CompositeGeneratorNode().append(
     'Hello World!'
  ).appendNewLineIf(entity !== undefined).appendIf(
     entity !== undefined, `Hello ${entity?.name}!`
  )
```
- Defined in packages/langium/src/generate/generator-node.ts:253

appendNewLineIfNotEmpty

appendNewLineIfNotEmpty(): this
Appends a soft NewLineNode to this node. Soft NewLineNodes yield linebreaks in the derived generated text only if the preceding line is non-empty, i.e. there are non-whitespace characters added to the generated text since the last linebreak.

Returns this
this CompositeGeneratorNode for convenience.
Example
```
new CompositeGeneratorNode().appendIf(
     entity !== undefined, `Hello ${entity?.name}!`
  ).appendNewLineIfNotEmpty();
```
- Defined in packages/langium/src/generate/generator-node.ts:269

appendNewLineIfNotEmptyIf

appendNewLineIfNotEmptyIf(condition): this
Appends a soft NewLineNode to this node, if condition is equal to true. Soft NewLineNodes yield linebreaks in the derived generated text only if the preceding line is non-empty, i.e. there are non-whitespace characters added to the generated text since the last linebreak.
Parameters
- condition: boolean
  a boolean value indicating whether to append a NewLineNode to this.
Returns this
this CompositeGeneratorNode for convenience.
Example
```
new CompositeGeneratorNode().append(
     entity.label ?? ''
  ).appendNewLineIfNotEmptyIf(entity.description !== undefined).append(
     entity.description
  )
```
- Defined in packages/langium/src/generate/generator-node.ts:289

appendTemplate

appendTemplate(staticParts, ...substitutions): this
Convenience method for appending content in form of a template to this generation node.

See expandToNode for details.
Parameters
- staticParts: TemplateStringsArray
- Rest...substitutions: unknown[]
Returns this
this CompositeGeneratorNode for convenience.
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine()
```
- Defined in packages/langium/src/generate/generator-node.ts:305

appendTemplateIf

appendTemplateIf(condition): ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
Convenience method for appending content in form of a template to this generator node, if condition is equal to true.

This method returns a tag function that takes the desired template and does the processing.

If condition is satisfied the tagged template delegates to appendTemplate, otherwise it returns just this.

See expandToNode for details.
Parameters
- condition: boolean
  a boolean value indicating whether to append the template content to this.
Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
a tag function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (staticParts, ...substitutions): this
  - Parameters
    - staticParts: TemplateStringsArray
    - Rest...substitutions: unknown[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendTemplateIf(entity !== undefined)
      `Hello ${entity?.name}!`
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:331

appendTraced

appendTraced<T>(astNode, property?): ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
Convenience method for appending content to this generator node including tracing information in form of {astNode, property?, index: undefined}.

This method returns a helper function that takes the desired content and does the processing. The returned function delegates to append, with the provided content being wrapped by an additional CompositeGeneratorNode configured with the tracing information.
Type Parameters
- T extends AstNode
Parameters
- astNode: T
  the AstNode corresponding to the appended content
- Optionalproperty: Properties<T>
  the value property name (string) corresponding to the appended content, if e.g. the content corresponds to some string or number property of astNode, is optional
Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
a function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (...content): this
  - Parameters
    - Rest...content: (Generated | ((node: CompositeGeneratorNode) => void))[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().append('Hello ').appendTraced(entity, 'name')(entity.name)
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:404
appendTraced<T>(astNode, property, index): ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
Convenience method for appending content to this generator node including tracing information in form of {astNode, property, index}.

This method returns a helper function that takes the desired content and does the processing. The returned function delegates to append, with the provided content being wrapped by an additional CompositeGeneratorNode configured with the tracing information.
Type Parameters
- T extends AstNode
Parameters
- astNode: T
  the AstNode corresponding to the appended content
- property: Properties<T>
  the value property name (string) corresponding to the appended content, if e.g. the content corresponds to some string or number property of astNode
- index: undefined | number
  the index of the value within a list property corresponding to the appended content, if the property contains a list of elements, is ignored otherwise
Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
a function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (...content): this
  - Parameters
    - Rest...content: (Generated | ((node: CompositeGeneratorNode) => void))[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().append('Hello ').appendTraced(entity, 'name')(entity.name)
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:430
appendTraced(sourceRegion): ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
Convenience method for appending content to this generator node including tracing information in form of concrete coordinates.

This method returns a helper function that takes the desired content and does the processing. The returned function delegates to append, with the provided content being wrapped by an additional CompositeGeneratorNode configured with the tracing information.
Parameters
- sourceRegion: undefined | SourceRegion
  a text region within some file in form of concrete coordinates, if undefined no tracing will happen
Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
a function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (...content): this
  - Parameters
    - Rest...content: (Generated | ((node: CompositeGeneratorNode) => void))[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().append('Hello ').appendTraced(findNodeForProperty(entity.$cstNode, 'name'))(entity.name)
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:451
appendTraced(sourceRegions): ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
Convenience method for appending content to this generator node including tracing information in form of a list of concrete coordinates.

This method returns a helper function that takes the desired content and does the processing. The returned function delegates to append, with the provided content being wrapped by an additional CompositeGeneratorNode configured with the tracing information.

The list of regions in sourceRegions will later be reduced to the smallest encompassing region of all the contained source regions.
Parameters
- sourceRegions: SourceRegion[]
  a list of text regions within some file in form of concrete coordinates, if empty no tracing will happen
Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
a function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (...content): this
  - Parameters
    - Rest...content: (Generated | ((node: CompositeGeneratorNode) => void))[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().append('Hello ').appendTraced([ findNodeForProperty(entity.$cstNode, 'name') ])(entity.name)
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:475

appendTracedIf

appendTracedIf<T>(condition, astNode, property?): ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
Convenience method for appending content to this generator node including tracing information in form of {astNode, property?, index: undefined}, if condition is equal to true.

This method returns a tag function that takes the desired template and does the processing.

If condition is satisfied the returned function delegates to appendTraced, otherwise it returns just this.
Type Parameters
- T extends AstNode
Parameters
- condition: boolean
  a boolean value indicating whether to append the template content to this.
- astNode: T
  the AstNode corresponding to the appended content
- Optionalproperty: Properties<T>
  the value property name (string) corresponding to the appended content, if e.g. the content corresponds to some string or number property of astNode, is optional
Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
a function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (...content): this
  - Parameters
    - Rest...content: (Generated | ((node: CompositeGeneratorNode) => void))[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendIf(entity !== undefined, 'Hello ').appendTracedIf(entity !== undefined, entity, 'name')(entity?.name)
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:509
appendTracedIf<T>(condition, astNode, property, index): ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
Convenience method for appending content to this generator node including tracing information in form of {astNode, property, index}, if condition is equal to true.

This method returns a tag function that takes the desired template and does the processing.

If condition is satisfied the returned function delegates to appendTraced, otherwise it returns just this.
Type Parameters
- T extends AstNode
Parameters
- condition: boolean
  a boolean value indicating whether to append the template content to this.
- astNode: T
  the AstNode corresponding to the appended content
- property: Properties<T>
  the value property name (string) corresponding to the appended content, if e.g. the content corresponds to some string or number property of astNode
- index: undefined | number
  the index of the value within a list property corresponding to the appended content, if the property contains a list of elements, is ignored otherwise
Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
a function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (...content): this
  - Parameters
    - Rest...content: (Generated | ((node: CompositeGeneratorNode) => void))[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendIf(entity !== undefined, 'Hello ').appendTracedIf(entity !== undefined, entity, 'name')(entity?.name)
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:537
appendTracedIf(condition, sourceRegion): ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
Convenience method for appending content to this generator node including tracing information in form of concrete coordinates, if condition is equal to true.

This method returns a tag function that takes the desired template and does the processing.

If condition is satisfied the returned function delegates to appendTraced, otherwise it returns just this.

If sourceRegion is a function supplying the corresponding region, it's only called if condition is satisfied.
Parameters
- condition: boolean
  a boolean value indicating whether to append the template content to this.
- sourceRegion: undefined | SourceRegion | (() => SourceRegion | undefined)
  a text region within some file in form of concrete coordinates, if undefined no tracing will happen
Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
a function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (...content): this
  - Parameters
    - Rest...content: (Generated | ((node: CompositeGeneratorNode) => void))[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendIf(entity !== undefined, 'Hello ').appendTracedIf(entity !== undefined, () => findNodeForProperty(entity.$cstNode, 'name'))(entity?.name)
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:562
appendTracedIf(condition, sourceRegions): ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
Convenience method for appending content to this generator node including tracing information in form of a list of concrete coordinates, if condition is equal to true.

This method returns a tag function that takes the desired template and does the processing.

If condition is satisfied the returned function delegates to appendTraced, otherwise it returns just this.

The list of regions in sourceRegions will later be reduced to the smallest encompassing region of all the contained source regions. If sourceRegions is a function supplying the corresponding regions, it's only called if condition is satisfied.
Parameters
- condition: boolean
  a boolean value indicating whether to append the template content to this.
- sourceRegions: SourceRegion[] | (() => SourceRegion[])
  a list of text regions within some file in form of concrete coordinates, if empty no tracing will happen
Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)
a function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (...content): this
  - Parameters
    - Rest...content: (Generated | ((node: CompositeGeneratorNode) => void))[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendIf(entity !== undefined, 'Hello ').appendTracedIf(entity !== undefined, () => [ findNodeForProperty(entity.$cstNode, 'name') ])(entity?.name)
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:589

appendTracedTemplate

appendTracedTemplate<T>(astNode, property?): ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
Convenience method for appending content in form of a template to this generator node including tracing information in form of {astNode, property?, index: undefined}.

This method returns a tag function that takes the desired template and does the processing by delegating to expandTracedToNode.
Type Parameters
- T extends AstNode
Parameters
- astNode: T
  the AstNode corresponding to the appended content
- Optionalproperty: Properties<T>
  the value property name (string) corresponding to the appended content, if e.g. the content corresponds to some string or number property of astNode, is optional
Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
a tag function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (staticParts, ...substitutions): this
  - Parameters
    - staticParts: TemplateStringsArray
    - Rest...substitutions: unknown[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendTracedTemplate(entity, 'name')
      `Hello ${entity?.name}!`
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:617
appendTracedTemplate<T>(astNode, property, index): ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
Convenience method for appending content in form of a template to this generator node including tracing information in form of {astNode, property, index}.

This method returns a tag function that takes the desired template and does the processing by delegating to expandTracedToNode.
Type Parameters
- T extends AstNode
Parameters
- astNode: T
  the AstNode corresponding to the appended content
- property: Properties<T>
  the value property name (string) corresponding to the appended content, if e.g. the content corresponds to some string or number property of astNode
- index: undefined | number
  the index of the value within a list property corresponding to the appended content, if the property contains a list of elements, is ignored otherwise, is optinal
Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
a tag function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (staticParts, ...substitutions): this
  - Parameters
    - staticParts: TemplateStringsArray
    - Rest...substitutions: unknown[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendTracedTemplate(entity, 'name')
      `Hello ${entity?.name}!`
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:643
appendTracedTemplate(sourceRegion): ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
Convenience method for appending content in form of a template to this generator node including tracing information in form of concrete coordinates.

This method returns a tag function that takes the desired template and does the processing by delegating to expandTracedToNode.
Parameters
- sourceRegion: undefined | SourceRegion
  a text region within some file in form of concrete coordinates, if undefined no tracing will happen
Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
a tag function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (staticParts, ...substitutions): this
  - Parameters
    - staticParts: TemplateStringsArray
    - Rest...substitutions: unknown[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendTracedTemplate(findNodeForProperty(entity.$cstNode, 'name'))
      `Hello ${entity?.name}!`
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:664
appendTracedTemplate(sourceRegions): ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
Convenience method for appending content in form of a template to this generator node including tracing information in form of concrete coordinates.

This method returns a tag function that takes the desired template and does the processing by delegating to expandTracedToNode.

The list of regions in sourceRegions will later be reduced to the smallest encompassing region of all the contained source regions.
Parameters
- sourceRegions: SourceRegion[]
  a list of text regions within some file in form of concrete coordinates, if empty no tracing will happen
Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
a tag function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (staticParts, ...substitutions): this
  - Parameters
    - staticParts: TemplateStringsArray
    - Rest...substitutions: unknown[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendTracedTemplate( findNodesForProperty(entity.$cstNode, 'name'))
      `Hello ${entity?.name}!`
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:688

appendTracedTemplateIf

appendTracedTemplateIf<T>(condition, astNode, property?): ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
Convenience method for appending content in form of a template to this generator node including tracing information in form of {astNode, property?, index: undefined}, if condition is equal to true.

This method returns a tag function that takes the desired template and does the processing.

If condition is satisfied the tagged template delegates to appendTracedTemplate, otherwise it returns just this. See also expandTracedToNode for details.
Type Parameters
- T extends AstNode
Parameters
- condition: boolean
  a boolean value indicating whether to append the template content to this.
- astNode: T
  the AstNode corresponding to the appended content
- Optionalproperty: Properties<T>
  the value property name (string) corresponding to the appended content, if e.g. the content corresponds to some string or number property of astNode, is optional
Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
a tag function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (staticParts, ...substitutions): this
  - Parameters
    - staticParts: TemplateStringsArray
    - Rest...substitutions: unknown[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendTracedTemplateIf(entity?.name !== undefined, entity)
      `Hello ${entity?.name}!`
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:724
appendTracedTemplateIf<T>(condition, astNode, property, index): ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
Convenience method for appending content in form of a template to this generator node including tracing information in form of {astNode, property, index}, if condition is equal to true.

This method returns a tag function that takes the desired template and does the processing.

If condition is satisfied the tagged template delegates to appendTracedTemplate, otherwise it returns just this. See also expandTracedToNode for details.
Type Parameters
- T extends AstNode
Parameters
- condition: boolean
  a boolean value indicating whether to append the template content to this.
- astNode: T
  the AstNode corresponding to the appended content
- property: Properties<T>
  the value property name (string) corresponding to the appended content, if e.g. the content corresponds to some string or number property of astNode
- index: undefined | number
  the index of the value within a list property corresponding to the appended content, if the property contains a list of elements, is ignored otherwise
Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
a tag function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (staticParts, ...substitutions): this
  - Parameters
    - staticParts: TemplateStringsArray
    - Rest...substitutions: unknown[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendTracedTemplateIf(entity?.name !== undefined, entity)
      `Hello ${entity?.name}!`
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:754
appendTracedTemplateIf(condition, sourceRegion): ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
Convenience method for appending content in form of a template to this generator node including tracing information in form of concrete coordinates, if condition is equal to true.

This method returns a tag function that takes the desired template and does the processing.

If condition is satisfied the tagged template delegates to appendTracedTemplate, otherwise it returns just this. See also expandTracedToNode for details.
- If sourceRegion is a function supplying the corresponding region, it's only called if condition is satisfied.
Parameters
- condition: boolean
  a boolean value indicating whether to append the template content to this.
- sourceRegion: undefined | SourceRegion | (() => SourceRegion | undefined)
  a text region within some file in form of concrete coordinates, if undefined no tracing will happen
Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
a tag function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (staticParts, ...substitutions): this
  - Parameters
    - staticParts: TemplateStringsArray
    - Rest...substitutions: unknown[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendTracedTemplateIf(entity?.name !== undefined, entity.$cstNode)
      `Hello ${entity?.name}!`
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:781
appendTracedTemplateIf(condition, sourceRegions): ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
Convenience method for appending content in form of a template to this generator node including tracing information in form of a list of concrete coordinates, if condition is equal to true.

This method returns a tag function that takes the desired template and does the processing.

If condition is satisfied the tagged template delegates to appendTracedTemplate, otherwise it returns just this. See also expandTracedToNode for details.

The list of regions in sourceRegions will later be reduced to the smallest encompassing region of all the contained source regions. If sourceRegions is a function supplying the corresponding regions, it's only called if condition is satisfied.
Parameters
- condition: boolean
  a boolean value indicating whether to append the template content to this.
- sourceRegions: SourceRegion[] | (() => SourceRegion[])
  a list of text regions within some file in form of concrete coordinates, if empty no tracing will happen
Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)
a tag function behaving as described above, which in turn returns this CompositeGeneratorNode for convenience.
- - (staticParts, ...substitutions): this
  - Parameters
    - staticParts: TemplateStringsArray
    - Rest...substitutions: unknown[]
    Returns this
Example
```
new CompositeGeneratorNode().appendTemplate
      `Hello World!`
  .appendNewLine().appendTracedTemplateIf(entity?.name !== undefined, () => [ findNodeForProperty(entity.$cstNode, 'name')! ])
      `Hello ${entity?.name}!`
  .appendNewLineIfNotEmpty()
```
- Defined in packages/langium/src/generate/generator-node.ts:810

indent

indent(childrenOrConfig?): this
Adds an area of indented text output. The content to be indented can be provided as an array consisting of strings and/or generation nodes (undefined is permitted), or via a callback offering the indentingNode to which the content shall be appended. Alternatively, an object satisfying IndentConfig can be provided taking the children as Array or via a callback as described previously via the indentedChildren property.

The remaining properties of IndentConfig have the following effects:
- indentation: a specific indentation length or string, defaults to the global indentation setting if omitted, see toString,
- indentEmptyLines: apply indentation to empty lines, defaults to false
- indentImmediately: apply the indentation immediately starting at the first line, defaults to true, might be set to false if preceding content is not terminated by any newline. If false the indentation is inserted only after child newline nodes followed by further content.
Parameters
- OptionalchildrenOrConfig: Generated[] | ((indented: IndentNode) => void) | IndentConfig
  an Array or callback contributing the children, or a config object satisfying IndentConfig alternatively.
Returns this
this CompositeGeneratorNode for convenience.
Example
```
new CompositeGeneratorNode().append(
      '{'
  ).indent(indentingNode =>
      indentingNode.append(
          'name:', name, ','
      ).appendNewLine().appendIf(description !== undefined,
          'description:', description
      ).appendNewLineIfNotEmpty()
  ).append(
      '}'
  );
```
- Defined in packages/langium/src/generate/generator-node.ts:366

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in packages/langium/src/generate/generator-node.ts:97

trace

trace<T>(astNode, property?): this
Adds tracing information in form of {astNode, property?, index: undefined} to this generator node. Overwrites existing trace data, if set previously.

The given data are kept as they are, the actual resolution of text positions within the DSL text is done at the final processing of this node as part of ().
Type Parameters
- T extends AstNode
Parameters
- astNode: T
  the AstNode corresponding to this node's content
- Optionalproperty: Properties<T>
  the value property name (string) corresponding to this node's content, e.g. if this node's content corresponds to some string or number property; is optional
Returns this
this CompositeGeneratorNode for convenience.
- Defined in packages/langium/src/generate/generator-node.ts:115
trace<T>(astNode, property, index): this
Adds tracing information in form of {astNode, property, index} to this generator node. Overwrites existing trace data, if set previously.

The given data are kept as they are, the actual resolution of text positions within the DSL text is done at the final processing of this node as part of ().
Type Parameters
- T extends AstNode
Parameters
- astNode: T
  the AstNode corresponding to this node's content
- property: Properties<T>
  the value property name (string) corresponding to this node's content, e.g. if this node's content corresponds to some string or number property
- index: undefined | number
  the index of the value within a list property corresponding to this node's content, if the property contains a list of elements, is ignored otherwise
Returns this
this CompositeGeneratorNode for convenience.
- Defined in packages/langium/src/generate/generator-node.ts:134
trace(sourceRegion): this
Adds tracing information in form of concrete coordinates to this generator node. Complete coordinates are provided by the AstNodes' corresponding AstNode.$cstNodes. Overwrites existing trace data, if set previously.
Parameters
- sourceRegion: undefined | SourceRegion
  a text region within some file in form of concrete coordinates, if undefined no tracing will happen
Returns this
this CompositeGeneratorNode for convenience.
- Defined in packages/langium/src/generate/generator-node.ts:146
trace(sourceRegion): this
Adds tracing information in form of a list of concrete coordinates to this generator node. Overwrites existing trace data, if set previously.

The list of regions in sourceRegion is reduced to the smallest encompassing region of all the contained source regions.
Parameters
- sourceRegion: SourceRegion[]
  a list of text regions within some file in form of concrete coordinates, if empty no tracing will happen
Returns this
this CompositeGeneratorNode for convenience.
- Defined in packages/langium/src/generate/generator-node.ts:160

Class CompositeGeneratorNode

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CompositeGeneratorNode

Example

Properties

Readonlycontents

OptionaltracedSource

Methods

append

Parameters

Returns this

Example

appendIf

Parameters

Returns this

Example

appendNewLine

Returns this

Example

appendNewLineIf

Parameters

Returns this

Example

appendNewLineIfNotEmpty

Returns this

Example

appendNewLineIfNotEmptyIf

Parameters

Returns this

Example

appendTemplate

Parameters

Returns this

Example

appendTemplateIf

Parameters

Returns ((staticParts: TemplateStringsArray, ...substitutions: unknown[]) => this)

Parameters

Returns this

Example

appendTraced

Type Parameters

Parameters

Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)

Parameters

Returns this

Example

Type Parameters

Parameters

Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)

Parameters

Returns this

Example

Parameters

Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)

Parameters

Returns this

Example

Parameters

Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)

Parameters

Returns this

Example

appendTracedIf

Type Parameters

Parameters

Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)

Parameters

Returns this

Example

Type Parameters

Parameters

Returns ((...content: (Generated | ((node: CompositeGeneratorNode) => void))[]) => this)

`Readonly`contents

`Optional`tracedSource