vrq
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
CMacro Class Reference

Declaration object for preprocessor macros. More...

#include <cmacro.h>

Inheritance diagram for CMacro:
CDecl CObject

Public Member Functions

 CMacro (CSymbol *aSymbol, Coord_t *aLoc)
 Create a macro declaration object. More...
 
virtual CDeclClone (CObstack *heap)
 Create a clone of this declaration. More...
 
char * GetBody (void)
 Get body of macro. More...
 
void SetBody (char *aBody)
 Set body of macro. More...
 
int GetZone (void)
 Get preprocessor zone number for last macro definition. More...
 
void SetZone (int aZone)
 Set preprocessor zone number. More...
 
void SetComplex (int aComplex)
 Set complex flag. More...
 
int IsComplex (void)
 Get complex flag. More...
 
char ** GetArgList (void)
 Get macro arguments. More...
 
void SetArgList (char **argList)
 Set macro arguments. More...
 
virtual void Dump (FILE *f)
 Dump macro info to file descriptor. More...
 
int IsDefined (void)
 Get defined flag. More...
 
void SetDefined (int aDefined)
 Set defined flag. More...
 
- Public Member Functions inherited from CDecl
virtual void SetDataType (CDataType *dt)
 Set declartion's data type property. More...
 
virtual CDataTypeGetDataType ()
 Get declartion's data type property. More...
 
virtual void SetWireAttr (Wire_t v)
 Set declaration's wire attribute. More...
 
virtual Wire_t GetWireAttr ()
 Get declartion's wire type property. More...
 
virtual int IsWidthConstant (void) const
 Determine if packed width of declaration is constant, ie dependent upon only constants and parameters. More...
 
virtual int IsWidthVolatile (void) const
 Determine if packed width of declaration is volatile, ie depend upon parameters or variables. More...
 
virtual int IsWidthEvaluateable (void) const
 Determine if packed width of declaration can be evaluated. More...
 
virtual INT32 GetWidth (void) const
 Evaluate packed width of declaration. More...
 
virtual CNodeGetWidthExp (void) const
 Get expression representing width of declaration. More...
 
virtual CNodeGetMsb () const
 Get expression for declaration's msb. More...
 
virtual CNodeGetLsb () const
 Get expression for declaration's lsb. More...
 
virtual int WidthDirection (void) const
 Evaluate current decl width direction. More...
 
virtual INT32 GetNumberOfUnpackedDimensions (void)
 Get number of unpacked dimensions of declaration. More...
 
virtual CNodeGetUnpackedMsi (INT32 dim)
 Get expression tree for upper limit of given packed array dimension. More...
 
virtual CNodeGetUnpackedLsi (INT32 dim)
 Get expression tree for lower limit of unpacked array dimension. More...
 
virtual void SetNumberOfUnpackedDimensions (INT32 dim)
 Set number of unpacked dimensions for declaration. More...
 
virtual CNodeGetUnpackedRange (INT32 dim)
 Get expression for range of array for dimension. More...
 
virtual void SetUnpackedRange (INT32 dim, CNode *v)
 Set expression for range of unpacked array for declaration. More...
 
virtual void SetConstAttr (int v)
 Set declaration's const attribute. More...
 
virtual int GetConstAttr ()
 Get declaration's const attribute. More...
 
virtual void SetVarAttr (int v)
 Set declaration's var attribute. More...
 
virtual int GetVarAttr ()
 Get declaration's var attribute. More...
 
virtual void SetAutomatic (int v)
 Set declaration's automatic property. More...
 
virtual int GetAutomatic ()
 Get declaration's automatic property. More...
 
virtual void SetVectored (int v)
 Set declartion's vectored property. More...
 
virtual int GetVectored ()
 Get declartion's vectored property. More...
 
virtual void SetScalared (int v)
 Set declartion's scalared property. More...
 
virtual int GetScalared ()
 Get declartion's scalared property. More...
 
void SetAttributes (CNode *attr)
 Set declarations's attributes. More...
 
CNodeGetAttributes ()
 Get declaration's attributes. More...
 
int HasAttribute (char *name, CNode *n=NULL, int init=1)
 Determine if declaration has the given attribute. More...
 
NodeType_t GetNodeType (void)
 Get node type of decl. More...
 
Decl_t GetClass (void)
 Get class of declaration. More...
 
void SetDeclStatementCreated (void)
 Set declaration statement created attribute. More...
 
int DeclStatementCreated (void)
 Get declaration statement create attibute. More...
 
Decl_t GetType (void)
 Get declaration type. More...
 
const char * GetTypeName (void)
 Get declaration type as a string. More...
 
void SetCoord (Coord_t *aLoc)
 Set declaration coordinate. More...
 
Coord_tGetCoord (void)
 Get file coordinates for declaration. More...
 
virtual void DumpDeclInfo (FILE *f)
 Dump declaration name, type and location to file descriptor. More...
 
const char * GetName (void)
 Shortcut to get declaration's name. More...
 
void SetSymbol (CSymbol *aSymbol)
 Set declaration's symbol. More...
 
CSymbolGetSymbol (void)
 Get declaration's symbol. More...
 
void SetPragmas (CNode *p)
 Set declaration pragmas. More...
 
CNodeGetPragmas ()
 Get declaration pragmas. More...
 
virtual void PreVisit1 (int(*func)(CNode *, void *), void *data)
 
virtual void PostVisit1 (void(*func)(CNode *, void *), void *data)
 
virtual void PostSubVisit1 (CNode *(*func)(CNode *, void *), void *data)
 
- Public Member Functions inherited from CObject
void * operator new (size_t size, CObstack *stack)
 Allocate object on CObstack heap. More...
 
void operator delete (void *object)
 Destroy object. More...
 

Static Public Member Functions

static CMacroLookupMacro (const char *aName)
 Find macro definition. More...
 
- Static Public Member Functions inherited from CDecl
static Flag Or (Flag f1, Flag f2)
 
static Flag Or (Flag f1, Flag f2, Flag f3)
 
static void GetMembers (Decl_t type, list< Decl_t > &result)
 Get a list of members of the given declaration class/type. More...
 

Protected Member Functions

void Copy (CObstack *heap, CMacro &d)
 Deep copy of declaration. More...
 
- Protected Member Functions inherited from CDecl
 CDecl (CSymbol *aSymbol, Coord_t *aLoc, Decl_t aType, CDataType *dataType, Flag flags)
 Create instance of declaration. More...
 
void Copy (CObstack *heap, const CDecl &o)
 Perform deep copy of given object to this one This should never be call directly, only by subclasses. More...
 

Additional Inherited Members

- Public Types inherited from CDecl
enum  Flag { eFLAG_NONE = 0, eFLAG_PRAGMA = 1, eFLAG_ARRAY = 2, eFLAG_DATATYPE = 4 }
 

Detailed Description

Declaration object for preprocessor macros.

Constructor & Destructor Documentation

CMacro::CMacro ( CSymbol aSymbol,
Coord_t aLoc 
)

Create a macro declaration object.

Parameters
aSymbolname of macro.
aLocfile coordinate of definition.

Member Function Documentation

virtual CDecl* CMacro::Clone ( CObstack heap)
virtual

Create a clone of this declaration.

Parameters
heapheap to use for allocation.
Returns
new declaration.

Implements CDecl.

void CMacro::Copy ( CObstack heap,
CMacro d 
)
protected

Deep copy of declaration.

Parameters
heapheap to use for allocation.
ddeclaration to copy.
virtual void CMacro::Dump ( FILE *  f)
virtual

Dump macro info to file descriptor.

Parameters
ffile descriptor.

Reimplemented from CDecl.

char** CMacro::GetArgList ( void  )

Get macro arguments.

Returns
pointer to array of macro arguments.
char* CMacro::GetBody ( void  )

Get body of macro.

Returns
macro body.
int CMacro::GetZone ( void  )
inline

Get preprocessor zone number for last macro definition.

Returns
preprocessor zone number.
int CMacro::IsComplex ( void  )

Get complex flag.

Returns
non-zero if macro has arguments.
int CMacro::IsDefined ( void  )

Get defined flag.

Returns
non-zero if macro has been defined.
static CMacro* CMacro::LookupMacro ( const char *  aName)
static

Find macro definition.

Create an undefined entry if it doesn't exist.

Parameters
aNamechar pointer to macro name.
Returns
macro object.
void CMacro::SetArgList ( char **  argList)

Set macro arguments.

Parameters
argListpointer to array of macro arguments. Array is not copied.
void CMacro::SetBody ( char *  aBody)

Set body of macro.

Parameters
aBodybody of macro.
void CMacro::SetComplex ( int  aComplex)

Set complex flag.

Parameters
aComplexnon-zero if macro has arguments.
void CMacro::SetDefined ( int  aDefined)

Set defined flag.

Parameters
aDefinednon-zero if macro has been defined.
void CMacro::SetZone ( int  aZone)
inline

Set preprocessor zone number.

Parameters
aZonepreprocessor zone number.

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