Package jetbrains.mps.generator.runtime

Interface TemplateContext

All Known Implementing Classes:

DefaultTemplateContext

public interface TemplateContext

Holds input and accompanying parameters (including mapping label) as we walk through template. Analogous to stack frames that keep method parameters; hierarchical with implicit access to outer scope (getVariable(String) looks up variable in super contexts) and explicit access to history of input nodes (getInputHistory()) TemplateContext represents the lowest-level context of generation, with Generator at the top, supervising model transformation, and TemplateExecutionEnvironment in the middle, responsible for thread/root generation and providing interaction with generation facilities.

Method Summary

Modifier and Type	Method	Description
TemplateExecutionEnvironment	getEnvironment()
SNode	getInput()
Iterable<SNode>	getInputHistory()
String	getInputName()
SNode	getNamedInput(String name)
Object	getPatternVariable(String name)
Object	getVariable(String name)
boolean	hasVariable(String name)
TemplateContext	subContext()	Reset input name, unlike subContext(String) and subContext(String, org.jetbrains.mps.openapi.model.SNode) that treat null input name as indicator to keep the old one.
TemplateContext	subContext(String inputName)
TemplateContext	subContext(String inputName, SNode inputNode)
TemplateContext	subContext(Map<String,Object> variables)
TemplateContext	subContext(GeneratedMatchingPattern pattern)
TemplateContext	subContext(SNode newInputNode)	Shorthand for ctx.subContext(ctx.getInputName(), newInputNode), to update input node while preserving current input name
TemplateContext	withVariable(String name, Object value)	Alternative to subContext(Map) as it's rarely required to inject more than 1 variable at once, and to get a new contract, which preserves mapping label.

Method Detail

getEnvironment

@NotNull
TemplateExecutionEnvironment getEnvironment()

getInput

SNode getInput()

getInputName

String getInputName()

getInputHistory

Iterable<SNode> getInputHistory()

getNamedInput

SNode getNamedInput(String name)

hasVariable

boolean hasVariable(String name)

getVariable

Object getVariable(String name)

getPatternVariable

Object getPatternVariable(String name)

subContext

TemplateContext subContext(String inputName,
                           SNode inputNode)

Parameters:

inputName - new name for input, or null to keep the old one

inputNode - new input node

Returns:

new context that updates both input and mapping label

subContext

TemplateContext subContext(String inputName)

Parameters:

inputName - new name for input, or null to keep the old one

Returns:

new context that preserves input and gives it a new name

subContext

TemplateContext subContext(Map<String,Object> variables)

Returns:

new context that preserves input, but discards mapping label

withVariable

TemplateContext withVariable(String name,
                             Object value)

Alternative to subContext(Map) as it's rarely required to inject more than 1 variable at once, and to get a new contract, which preserves mapping label.

Parameters:

name - variable name, getVariable(String), not null

value - varaible value, can be null

Returns:

new context that preserves input and mapping label, with new value for named variable.

Since:

3.3

subContext

TemplateContext subContext(GeneratedMatchingPattern pattern)

Returns:

new context that preserves input, but discards mapping label

subContext

TemplateContext subContext()

Reset input name, unlike subContext(String) and subContext(String, org.jetbrains.mps.openapi.model.SNode) that treat null input name as indicator to keep the old one.

Returns:

context with un-named input (same as current context), with hierarchy of contexts preserved (i.e. #getInputHistory() would provide one)

subContext

TemplateContext subContext(SNode newInputNode)

Shorthand for ctx.subContext(ctx.getInputName(), newInputNode), to update input node while preserving current input name

Parameters:

newInputNode - new input

Returns:

context with desired input and present input name