Interface CAstSourcePositionMap

All Known Implementing Classes:

CAstSourcePositionRecorder

public interface CAstSourcePositionMap

The assumption is that a typical CAst is derived from some kind of textual source file, for which it makes sense to record source position in terms of line and column numbers. This interface encapsulates a mapping from CAstNodes of the an ast to such source positions.

Author:

Julian Dolby (dolby@us.ibm.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CAstSourcePositionMap.Position	This interface encapsulates the source position of an ast node in its source file.

Field Summary

Fields

Modifier and Type	Field	Description
static final CAstSourcePositionMap.Position	NO_INFORMATION

Method Summary

Modifier and Type	Method	Description
Iterator<CAstNode>	getMappedNodes()	Returns an iterator of all CAstNodes for which this map contains source mapping information.
CAstSourcePositionMap.Position	getPosition(CAstNode n)	Returns the position of a given node in its source file, or null if the position is not known or does not exist.
NavigableSet<CAstSourcePositionMap.Position>	positions()	Returns an ordered set of all positions in this map.

Field Details

NO_INFORMATION

static final CAstSourcePositionMap.Position NO_INFORMATION

Method Details

getPosition

CAstSourcePositionMap.Position getPosition(CAstNode n)

Returns the position of a given node in its source file, or null if the position is not known or does not exist.

getMappedNodes

Iterator<CAstNode> getMappedNodes()

Returns an iterator of all CAstNodes for which this map contains source mapping information.

positions

NavigableSet<CAstSourcePositionMap.Position> positions()

Returns an ordered set of all positions in this map.