Otawa  0.10
otawa::ast::AST Class Referenceabstract

This is the base class for the representation of programs as Abstract Syntax Trees. More...

#include <otawa/ast/AST.h>

Inheritance diagram for otawa::ast::AST:
elm::Lock otawa::PropList otawa::ast::BlockAST otawa::ast::DoWhileAST otawa::ast::ForAST otawa::ast::IfAST otawa::ast::SeqAST otawa::ast::WhileAST otawa::ast::CallAST

Public Member Functions

virtual ast_kind_t kind (void) const =0
 Get the kind of the AST. More...
 
virtual Instfirst (void)=0
 
virtual void release (void)
 Deletion of AST can only be performed using this method. More...
 
virtual bool isNOP (void)
 Test if the AST is the NOP AST. More...
 
virtual bool isUndef (void)
 Test if the AST is the undefined AST. More...
 
virtual BlockASTtoBlock (void)
 Get the block AST if this AST is a block, null else. More...
 
virtual CallASTtoCall (void)
 Get the call AST if this AST is a call, null else. More...
 
virtual SeqASTtoSeq (void)
 Get the sequence AST if this AST is a sequence, null else. More...
 
virtual IfASTtoIf (void)
 Get the selection AST if this AST is a selection, null else. More...
 
virtual WhileASTtoWhile (void)
 Get the repetition AST if this AST is a repeatition, null else. More...
 
virtual DoWhileASTtoDoWhile (void)
 Get the repetition AST if this AST is a repetition, null else. More...
 
virtual ForASTtoFor (void)
 Get the repetition AST if this AST is a repetition, null else. More...
 
virtual int countInstructions (void) const =0
 Count the number of instructions in the ast block. More...
 
void lock (void)
 
void unlock ()
 
PropertygetProp (const AbstractIdentifier *id) const
 Find a property by its identifier. More...
 
void setProp (Property *prop)
 Set the property in the property list removing any double. More...
 
void setProp (const AbstractIdentifier *id)
 
void removeProp (const AbstractIdentifier *id)
 Remove a property matching the given identifier. More...
 
void removeProp (const AbstractIdentifier &id)
 
PropertyextractProp (const AbstractIdentifier *id)
 Remove a property matching the given identifier and return it. More...
 
PropertyextractProp (const AbstractIdentifier &id)
 Remove a property matching the given identifier and return it. More...
 
void addProp (Property *prop)
 Add property to the list without checking of duplication. More...
 
void removeAllProp (const AbstractIdentifier *id)
 Remove all the properties matching the given identifier. More...
 
bool hasProp (const AbstractIdentifier &id) const
 Test if the property list contains a property matching the given identifier. More...
 
void clearProps (void)
 Remove all properties from the list. More...
 
void addProps (const PropList &props)
 Add all properties from the given property list, in a reverse order. More...
 
void print (elm::io::Output &out) const
 Display the current property list. More...
 

Static Public Attributes

static ASTNOP = nop_inst
 Unique instance of the NOP AST. More...
 
static ASTUNDEF = undef_inst
 Unique instance of the Undef AST. More...
 
static const PropList EMPTY
 This is an empty proplist for convenience. More...
 

Protected Member Functions

virtual ~AST (void)
 

Friends

class FunAST
 

Detailed Description

This is the base class for the representation of programs as Abstract Syntax Trees.

Constructor & Destructor Documentation

virtual otawa::ast::AST::~AST ( void  )
inlineprotectedvirtual

Member Function Documentation

void otawa::PropList::clearProps ( void  )
inherited
int otawa::ast::AST::countInstructions ( void  ) const
pure virtual
Property * otawa::PropList::extractProp ( const AbstractIdentifier id)
inherited

Remove a property matching the given identifier and return it.

Caller is responsible of the management of the obtained property.

Parameters
idIdentifier of the property to extract.

References otawa::Property::_next, and otawa::Property::next().

Referenced by otawa::script::Script::makeConfig().

Property * otawa::PropList::extractProp ( const AbstractIdentifier id)
inlineinherited

Remove a property matching the given identifier and return it.

Caller is responsible of the management of the obtained property.

Parameters
idIdentifier of the property to extract.

References otawa::PropList::extractProp().

Referenced by otawa::PropList::extractProp().

bool otawa::PropList::hasProp ( const AbstractIdentifier id) const
inlineinherited

Test if the property list contains a property matching the given identifier.

Parameters
idProperty identifier to look for.
Returns
True if the list contains the matching property, false else.

References otawa::PropList::getProp().

Referenced by otawa::ipet::BasicConstraintsBuilder::addEntryConstraint(), otawa::Monitor::configure(), otawa::ImmutableRef< T, I >::exists(), and otawa::Manager::setVerbosity().

bool otawa::ast::AST::isNOP ( void  )
inlinevirtual

Test if the AST is the NOP AST.

Returns
True if it is the NOP AST, false else.
bool otawa::ast::AST::isUndef ( void  )
inlinevirtual

Test if the AST is the undefined AST.

Returns
True if it is the undefined AST, false else.
void otawa::PropList::print ( elm::io::Output out) const
inherited

Display the current property list.

Parameters
outOutput to use.

Referenced by otawa::operator<<(), and otawa::ContextualProperty::print().

void otawa::ast::AST::release ( void  )
virtual
void otawa::PropList::removeAllProp ( const AbstractIdentifier id)
inherited

Remove all the properties matching the given identifier.

Parameters
idIdentifier of properties to remove.

References otawa::Property::_next, and otawa::Property::next().

Referenced by otawa::LoopUnroller::unroll().

void otawa::PropList::removeProp ( const AbstractIdentifier id)
inherited
void otawa::PropList::removeProp ( const AbstractIdentifier id)
inlineinherited
void otawa::PropList::setProp ( Property prop)
inherited

Set the property in the property list removing any double.

Parameters
propProperty to set.

References otawa::Property::_next, otawa::Property::id(), and otawa::Property::next().

void otawa::PropList::setProp ( const AbstractIdentifier id)
inlineinherited

Friends And Related Function Documentation

friend class FunAST
friend

Member Data Documentation

const PropList otawa::PropList::EMPTY
staticinherited

This is an empty proplist for convenience.

AST & otawa::ast::AST::NOP = nop_inst
static

Unique instance of the NOP AST.

AST & otawa::ast::AST::UNDEF = undef_inst
static

Unique instance of the Undef AST.


The documentation for this class was generated from the following files: