Class AbstractCodeEntity

java.lang.Object

com.ibm.wala.cast.ir.translator.AbstractEntity

com.ibm.wala.cast.ir.translator.AbstractCodeEntity

All Implemented Interfaces:

CAstEntity

Direct Known Subclasses:

AbstractScriptEntity

public abstract class AbstractCodeEntity
extends AbstractEntity

Field Summary

Fields

Modifier and Type	Field	Description
protected CAstNode	Ast
protected final CAstControlFlowRecorder	cfg
protected final CAstSourcePositionRecorder	src
protected final CAstType	type
protected final CAstNodeTypeMapRecorder	types

Fields inherited from interface CAstEntity

FIELD_ENTITY, FILE_ENTITY, FUNCTION_ENTITY, GLOBAL_ENTITY, MACRO_ENTITY, RULE_ENTITY, SCRIPT_ENTITY, SUB_LANGUAGE_BASE, TYPE_ENTITY

Modifier and Type	Field	Description
static final int	FIELD_ENTITY	This entity is a field in an object-oriented language.
static final int	FILE_ENTITY	This entity is a source file (i.e.
static final int	FUNCTION_ENTITY	This entity is a function.
static final int	GLOBAL_ENTITY	This entity represents a global variable
static final int	MACRO_ENTITY	This entity is a macro.
static final int	RULE_ENTITY	This entity represents a rule in a logic language.
static final int	SCRIPT_ENTITY	This entity is a program script for a scripting language.
static final int	SUB_LANGUAGE_BASE	Languages that introduce new kinds of CAstEntity should use this number as the base of integers chosen to denote the new entity types.
static final int	TYPE_ENTITY	This entity is a type in an object-oriented language.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCodeEntity(CAstType type)

Method Summary

Modifier and Type	Method	Description
CAstNode	getAST()	The CAPA AST of this entity.
CAstControlFlowRecorder	getControlFlow()	The control flow map for the CAPA AST of this entity.
CAstNodeTypeMapRecorder	getNodeTypeMap()	The map from CAstNodes to types.
CAstSourcePositionRecorder	getSourceMap()	The map of CAstNodes to source positions for the CAPA AST of this entity.
CAstType	getType()	The CAst type of this entity.
void	setAst(CAstNode Ast)
void	setGotoTarget(CAstNode from, CAstNode to)
void	setLabelledGotoTarget(CAstNode from, CAstNode to, Object label)
void	setNodePosition(CAstNode n, CAstSourcePositionMap.Position pos)
void	setNodeType(CAstNode n, CAstType type)

Methods inherited from class AbstractEntity

addScopedEntity, getAllScopedEntities, getAnnotations, getPosition, getScopedEntities, getSignature, setPosition

Modifier and Type	Method	Description
void	addScopedEntity(CAstNode construct, CAstEntity child)
Map<CAstNode, @NonNull Collection<CAstEntity>>	getAllScopedEntities()	Some programming language constructs have a lexical structure.
Collection<CAstAnnotation>	getAnnotations()	Returns the set of any annotations this entity may have
CAstSourcePositionMap.Position	getPosition()	The source position of this entity.
Iterator<CAstEntity>	getScopedEntities(CAstNode construct)	Some programming language constructs have a lexical structure.
String	getSignature()	Some programming language constructs have signatures, which are like names but usually have some detail to distinguish the construct from others with the same name.
void	setPosition(CAstSourcePositionMap.Position pos)

Methods inherited from class Object

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

Methods inherited from interface CAstEntity

getArgumentCount, getArgumentDefaults, getArgumentNames, getKind, getName, getNamePosition, getOriginal, getPosition, getQualifiers

Modifier and Type	Method	Description
int	getArgumentCount()	Some programming language constructs have a specific number of arguments.
CAstNode[]	getArgumentDefaults()	Some programming language constructs allow arguments to have default values.
String[]	getArgumentNames()	Some programming language constructs have named arguments.
int	getKind()	What kind of entity is this? The answer should be one of the constants in this file.
String	getName()	Some programming language constructs have names.
CAstSourcePositionMap.Position	getNamePosition()	The source position of the token denoting this entity's name.
default CAstEntity	getOriginal()	Allow finding original entity after rewrites
CAstSourcePositionMap.Position	getPosition(int arg)	The source position of argument 'arg' this entity, if any;
Collection<CAstQualifier>	getQualifiers()	Returns an Iterator over the qualifiers of the given entity, if it has any, e.g., "final", "private".

Field Details

src

protected final CAstSourcePositionRecorder src

cfg

protected final CAstControlFlowRecorder cfg

types

protected final CAstNodeTypeMapRecorder types

type

protected final CAstType type

Ast

protected CAstNode Ast

Constructor Details

AbstractCodeEntity

protected AbstractCodeEntity(CAstType type)

Method Details

getAST

public CAstNode getAST()

Description copied from interface: CAstEntity

The CAPA AST of this entity.

getType

public CAstType getType()

Description copied from interface: CAstEntity

The CAst type of this entity.

getControlFlow

public CAstControlFlowRecorder getControlFlow()

Description copied from interface: CAstEntity

The control flow map for the CAPA AST of this entity.

getSourceMap

public CAstSourcePositionRecorder getSourceMap()

Description copied from interface: CAstEntity

The map of CAstNodes to source positions for the CAPA AST of this entity.

getNodeTypeMap

public CAstNodeTypeMapRecorder getNodeTypeMap()

Description copied from interface: CAstEntity

The map from CAstNodes to types. Valid for nodes that have an explicitly declared type (e.g. local vars).

setGotoTarget

public void setGotoTarget(CAstNode from,
 CAstNode to)

setLabelledGotoTarget

public void setLabelledGotoTarget(CAstNode from,
 CAstNode to,
 Object label)

setNodePosition

public void setNodePosition(CAstNode n,
 CAstSourcePositionMap.Position pos)

setNodeType

public void setNodeType(CAstNode n,
 CAstType type)

setAst

public void setAst(CAstNode Ast)