Package jetbrains.mps.textgen.trace

Class TracingUtil

java.lang.Object

jetbrains.mps.textgen.trace.TracingUtil

public final class TracingUtil
extends Object

Mechanism Generator uses to keep trace of origin for transformed nodes. As the package name suggests, it's rather part of [debuginfo-api] module, however, generated code uses this class in runtime, and as long as [debuginfo-api] is auxiliary (not part of the [kernel]/mps-core), it's better to keep this class here. After all, [debuginfo-api] is not the only client of the trace. Perhaps, shall push this class even further, down to [smodel], as it's quite generic. Meanwhile, there's CopyUtil that got quite some dependencies to [kernel]. Once either CopyUtil's dependencies are in [smodel], or there's simplified alternative (I don't need too much from CopyUtil here, in fact), consider moving the class further.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ORIGINAL_INPUT_NODE

Constructor Summary

Constructors

Constructor	Description
TracingUtil()

Method Summary

Modifier and Type	Method	Description
static List<SNode>	copyWithTrace(List<SNode> nodes)
static SNode	copyWithTrace(SNode node)
static void	deriveOriginalNode(SNode inputNode, Collection<SNode> outputNodes, boolean force)	Derive original input node from a transient input node, if any.
static void	deriveOriginalNode(SNode inputNode, SNode outputNode)	Derive original input node from a transient input node, if any.
static void	fillOriginalNode(SNode inputNode, SNode outputNode, boolean originalInput)	Deprecated. code branching done with boolean flag.
static SNodeReference	getInput(SNode output)
static SNode	getInputNode(SNode output, SRepository repo)
static void	putInput(SNode output, SNodeReference input)
static void	putInputNode(SNode output, SNode input)

Methods inherited from class java.lang.Object

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

Field Detail

ORIGINAL_INPUT_NODE

public static final String ORIGINAL_INPUT_NODE

See Also:

Constant Field Values

Constructor Detail

TracingUtil

public TracingUtil()

Method Detail

copyWithTrace

public static SNode copyWithTrace(SNode node)

copyWithTrace

public static List<SNode> copyWithTrace(List<SNode> nodes)

getInput

@Nullable
public static SNodeReference getInput(@NotNull
                                      SNode output)

putInput

public static void putInput(@NotNull
                            SNode output,
                            SNodeReference input)

getInputNode

@Nullable
public static SNode getInputNode(@NotNull
                                 SNode output,
                                 @NotNull
                                 SRepository repo)

putInputNode

public static void putInputNode(@NotNull
                                SNode output,
                                @NotNull
                                SNode input)

fillOriginalNode

@Deprecated
public static void fillOriginalNode(@NotNull
                                    SNode inputNode,
                                    @NotNull
                                    SNode outputNode,
                                    boolean originalInput)

Deprecated.

code branching done with boolean flag.

deriveOriginalNode

public static void deriveOriginalNode(SNode inputNode,
                                      SNode outputNode)

Derive original input node from a transient input node, if any. Doesn't override origin trace if already set

Parameters:

inputNode - shall never be null, the one we take origin from

outputNode - node to receive same origin as the inputNode (unless already has one), not null.

deriveOriginalNode

public static void deriveOriginalNode(SNode inputNode,
                                      Collection<SNode> outputNodes,
                                      boolean force)

Derive original input node from a transient input node, if any. Optionally doesn't override origin trace if already set

Parameters:

inputNode - shall never be null, the one we take origin from

outputNodes - nodes to receive same origin as the inputNode (unless they already has one)