Package jetbrains.mps.generator.template

Class TemplateQueryContext

java.lang.Object

jetbrains.mps.generator.template.TemplateQueryContext

Direct Known Subclasses:

IfMacroContext, InsertMacroContext, MappingScriptContext, MapSrcMacroContext, MapSrcMacroPostProcContext, PropertyMacroContext, ReferenceMacroContext, SourceSubstituteMacroNodeContext, SourceSubstituteMacroNodesContext, TemplateArgumentContext, TemplateQueryContextWithRule, TemplateVarContext, WeavingAnchorContext

public class TemplateQueryContext
extends Object

Context for operations of genContext parameter in generator's concept functions. This is what generated code of template queries (like input nodes query, property and reference macro, etc) have access to. Igor Alshannikov Jul 21, 2008

Field Summary

Fields

Modifier and Type	Field	Description
protected TemplateContext	myContext

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TemplateQueryContext()	Cons for internal/tests use, generally subclasses shall not call it.
protected	TemplateQueryContext(SNodeReference templateNode, TemplateContext context)
	TemplateQueryContext(SNodeReference templateNode, ITemplateGenerator generator)	Context for queries when an input node is not known yet (queries of an MC or a script).

Method Summary

Modifier and Type	Method	Description
String	createIndexedName(String baseName, SNode contextNode, boolean noIndexForFirst)
String	createUniqueName(String baseName, SNode contextNode)
List<SNode>	getAllOutputNodesByInputNodeAndMappingLabel(SNode inputNode, String label)
SNode	getCopiedOutputNodeForInputNode(SNode inputNode)
Object	getGenerationParameter(String name)
ITemplateGenerator	getGenerator()	'generator' mapping
SModel	getInputModel()
SNode	getInputNode()
SNode	getNode()	'node' mapping
SNode	getOriginalCopiedInputNode(SNode node)
SModel	getOriginalInputModel()
SModel	getOutputModel()
SNode	getOutputNode()
SNode	getOutputNodeByInputNodeAndMappingLabel(SNode inputNode, String label)
SNode	getOutputNodeByMappingLabel(String label, SModel inputModel)	Find out conditional root with a given ML, created from specified model
Object	getPatternVariable(String name)
SNode	getPreviousInputNodeByMappingLabel(String label)
protected SNodeReference	getRuleNode()
Object	getSessionObject(Object key)
Object	getStepObject(Object key)
protected SNodeReference	getTemplateNodeRef()
SNodeReference	getTemplateReference()
Object	getTransientObject(Object key)
Object	getVariable(String name)
Object	putSessionObject(Object key, Object o)
Object	putStepObject(Object key, Object o)
Object	putTransientObject(Object key, Object o)
void	registerMappingLabel(SNode inputNode, String mappingName, SNode outputNode)
void	showErrorMessage(SNode node, String message)
void	showInformationMessage(SNode node, String message)
void	showWarningMessage(SNode node, String message)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myContext

protected TemplateContext myContext

Constructor Detail

TemplateQueryContext

public TemplateQueryContext(@NotNull
                            SNodeReference templateNode,
                            @NotNull
                            ITemplateGenerator generator)

Context for queries when an input node is not known yet (queries of an MC or a script).

Since:

3.3

TemplateQueryContext

protected TemplateQueryContext(@NotNull
                               SNodeReference templateNode,
                               @NotNull
                               TemplateContext context)

TemplateQueryContext

protected TemplateQueryContext()

Cons for internal/tests use, generally subclasses shall not call it.

Method Detail

getNode

public SNode getNode()

'node' mapping

getInputNode

public SNode getInputNode()

getOutputNode

public SNode getOutputNode()

getInputModel

public SModel getInputModel()

getOutputModel

public SModel getOutputModel()

getOriginalInputModel

public SModel getOriginalInputModel()

getGenerator

public ITemplateGenerator getGenerator()

'generator' mapping

getOutputNodeByMappingLabel

@Nullable
public SNode getOutputNodeByMappingLabel(String label,
                                         @Nullable
                                         SModel inputModel)

Find out conditional root with a given ML, created from specified model

Parameters:

label - generally shall not be null, as it's required in GenerationContextOp_GetOutputByLabel

inputModel - can be null, which indicates current input model. Otherwise, a model root was created from

Returns:

a node in a transient/checkpoint model if generator has any recorded.

Since:

3.4

getOutputNodeByInputNodeAndMappingLabel

public SNode getOutputNodeByInputNodeAndMappingLabel(SNode inputNode,
                                                     String label)

getAllOutputNodesByInputNodeAndMappingLabel

public List<SNode> getAllOutputNodesByInputNodeAndMappingLabel(SNode inputNode,
                                                               String label)

registerMappingLabel

public void registerMappingLabel(SNode inputNode,
                                 String mappingName,
                                 SNode outputNode)

getCopiedOutputNodeForInputNode

public SNode getCopiedOutputNodeForInputNode(SNode inputNode)

getPreviousInputNodeByMappingLabel

public SNode getPreviousInputNodeByMappingLabel(String label)

getOriginalCopiedInputNode

public SNode getOriginalCopiedInputNode(SNode node)

createUniqueName

public String createUniqueName(String baseName,
                               SNode contextNode)

Parameters:

baseName - prefix

contextNode - optional extra context node. Contributes (if a named node) a name fragment to further distinguish names, holds used names (IOW, defines name visibility context). If no contextNode is specified, scope is global.

Returns:

value baseName[_hash(contextNode)][_hash(getInputNode())][_counter]

createIndexedName

public String createIndexedName(String baseName,
                                SNode contextNode,
                                boolean noIndexForFirst)

Parameters:

baseName - prefix the name sequence would share

contextNode - optional context node to keep last used index for baseName.null means global (i.e. session) context.

noIndexForFirst - if true, the first value returned would be "baseName", second "baseName1", etc. When false, all names would get index, starting from 0.

Returns:

baseName[counter]

putTransientObject

public Object putTransientObject(Object key,
                                 Object o)

getTransientObject

public Object getTransientObject(Object key)

getVariable

public Object getVariable(String name)

getPatternVariable

public Object getPatternVariable(String name)

getGenerationParameter

public Object getGenerationParameter(String name)

putStepObject

public Object putStepObject(Object key,
                            Object o)

getStepObject

public Object getStepObject(Object key)

putSessionObject

public Object putSessionObject(Object key,
                               Object o)

getSessionObject

public Object getSessionObject(Object key)

showInformationMessage

public void showInformationMessage(SNode node,
                                   String message)

showWarningMessage

public void showWarningMessage(SNode node,
                               String message)

showErrorMessage

public void showErrorMessage(SNode node,
                             String message)

getTemplateReference

@Nullable
public final SNodeReference getTemplateReference()

Returns:

context template node where the query is evaluated, if known.

getTemplateNodeRef

@Nullable
protected SNodeReference getTemplateNodeRef()

Returns:

context template node where the query is evaluated

getRuleNode

@Nullable
protected SNodeReference getRuleNode()

Returns:

context rule, where query is being evaluated, if available