Package jetbrains.mps.textgen.trace

Class DebugInfo

java.lang.Object

jetbrains.mps.textgen.trace.DebugInfo

public class DebugInfo
extends Object

Constructor Summary

Constructors

Constructor	Description
DebugInfo()

Method Summary

Modifier and Type	Method	Description
void	addPosition(TraceablePositionInfo position, SNode containingRoot)
void	addScopePosition(ScopePositionInfo position, SNode containingRoot)
void	addUnitPosition(UnitPositionInfo unitPosition, SNode containingRoot)
TraceablePositionInfo	getPositionForNode(SNode node)
Set<TraceablePositionInfo>	getPositions(SNode rootNode)
DebugInfoRoot	getRootInfo(SNode root)
DebugInfoRoot	getRootInfo(SNodeReference root)
Iterable<DebugInfoRoot>	getRoots()
List<SNodeReference>	getTracedNodesForPosition(String fileName, int line)
List<SNodeReference>	getTracedNodesForPosition(String fileName, int line, Consumer<List<TraceablePositionInfo>> extraProcessing)	Look up all TraceablePositionInfo that cover specified location, sort them by distance of starting line from the line specified (closes coming first), prepare SNodeReference and yield the list.
List<SNodeReference>	getUnitNodesForPosition(String fileName, int line)
List<UnitPositionInfo>	getUnitsForNode(SNode node)
List<SNodeReference>	getVariableNodesForPosition(String fileName, int line, String varName)	Look up for variable nodes within scope that covers specified line of the file.
void	putRootInfo(DebugInfoRoot root)

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugInfo

public DebugInfo()

Method Detail

addPosition

public void addPosition(TraceablePositionInfo position,
                        SNode containingRoot)

addScopePosition

public void addScopePosition(ScopePositionInfo position,
                             SNode containingRoot)

addUnitPosition

public void addUnitPosition(UnitPositionInfo unitPosition,
                            SNode containingRoot)

getRootInfo

public DebugInfoRoot getRootInfo(@Nullable
                                 SNode root)

getRootInfo

public DebugInfoRoot getRootInfo(@Nullable
                                 SNodeReference root)

putRootInfo

public void putRootInfo(DebugInfoRoot root)

getPositionForNode

@Nullable
public TraceablePositionInfo getPositionForNode(SNode node)

getPositions

public Set<TraceablePositionInfo> getPositions(SNode rootNode)

getUnitsForNode

@NotNull
public List<UnitPositionInfo> getUnitsForNode(SNode node)

getTracedNodesForPosition

@NotNull
public List<SNodeReference> getTracedNodesForPosition(@NotNull
                                                      String fileName,
                                                      int line)

See Also:

getTracedNodesForPosition(String, int, Consumer)

getTracedNodesForPosition

@NotNull
public List<SNodeReference> getTracedNodesForPosition(@NotNull
                                                      String fileName,
                                                      int line,
                                                      @Nullable
                                                      Consumer<List<TraceablePositionInfo>> extraProcessing)

Look up all TraceablePositionInfo that cover specified location, sort them by distance of starting line from the line specified (closes coming first), prepare SNodeReference and yield the list. Takes an optional code that may further filter out TraceablePositionInfo according to specific needs. Consumer can respect certain approaches to code generation, language differences and relation of line and position.

Parameters:

fileName - name of generated file with text

line - index of line in question

extraProcessing - optional code that takes sorted list of positions that span specified line, the one with closest start coming first. The list could be modified/augmented or even emptied, positions left in the list are translated to respective node references and constitute the outcome of the method. Consumer list argument is never null.

getVariableNodesForPosition

@NotNull
public List<SNodeReference> getVariableNodesForPosition(@NotNull
                                                        String fileName,
                                                        int line,
                                                        @NotNull
                                                        String varName)

Look up for variable nodes within scope that covers specified line of the file. List is sorted in reverse order, with variables from the bottom (most nested) coming first.

The reason I don't want to expose ScopePositionInfo and let clients filter positions themselves is that they'd need access to DebugInfoRoot as well (to find out container node/model), and the API would get too complicated.

getUnitNodesForPosition

@NotNull
public List<SNodeReference> getUnitNodesForPosition(String fileName,
                                                    int line)

Returns:

list of nodes known at the specified line, sorted in reversed order (with the node most close to the line coming first)

getRoots

public Iterable<DebugInfoRoot> getRoots()