Base class for describing declaration objects. More...

#include <cdecl.h>

Inheritance diagram for CDecl:

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

Public Member Functions
virtual CDecl *	Clone (CObstack *heap)=0
	Create a deep copy of declaration. More...

virtual void	SetDataType (CDataType *dt)
	Set declartion's data type property. More...

virtual CDataType *	GetDataType ()
	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 CNode *	GetWidthExp (void) const
	Get expression representing width of declaration. More...

virtual CNode *	GetMsb () const
	Get expression for declaration's msb. More...

virtual CNode *	GetLsb () 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 CNode *	GetUnpackedMsi (INT32 dim)
	Get expression tree for upper limit of given packed array dimension. More...

virtual CNode *	GetUnpackedLsi (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 CNode *	GetUnpackedRange (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...

CNode *	GetAttributes ()
	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_t *	GetCoord (void)
	Get file coordinates for declaration. More...

virtual void	Dump (FILE *f)
	Dump declaration info to file descriptor. 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...

CSymbol *	GetSymbol (void)
	Get declaration's symbol. More...

void	SetPragmas (CNode *p)
	Set declaration pragmas. More...

CNode *	GetPragmas ()
	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 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
	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...

Detailed Description

Base class for describing declaration objects.

Member Enumeration Documentation

◆ Flag

enum CDecl::Flag

Enumerator
eFLAG_NONE	no support flags
eFLAG_PRAGMA	declaration accepts pragmas
eFLAG_ARRAY	declaration can be unpacked array
eFLAG_DATATYPE	declaration has datatype

Constructor & Destructor Documentation

◆ CDecl()

CDecl::CDecl	(	CSymbol *	aSymbol,
		Coord_t *	aLoc,
		Decl_t	aType,
		CDataType *	dataType,
		Flag	flags
	)

inlineprotected

Create instance of declaration.

This should never be call directly.

Parameters

aSymbol	declaration for symbol.
aLoc	file coordinates of declaration.
aType	declaration type.
dataType	declaration data type
flags	list of supported constructs.

Member Function Documentation

◆ Clone()

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

pure virtual

Create a deep copy of declaration.

Parameters

heap	heap to use for allocation.

Returns: new declaration.

Implemented in CModule, CBlock, CFref, CInstance, CMacro, CNet, CGate, CVar, CAttr, CParam, CPortDir, CPort, and CGenvar.

◆ Copy()

void CDecl::Copy	(	CObstack *	heap,
		const CDecl &	o
	)

protected

Perform deep copy of given object to this one This should never be call directly, only by subclasses.

Parameters

heap	heap to use for allocation.
o	declaration to copy.

◆ DeclStatementCreated()

int CDecl::DeclStatementCreated ( void )

inline

Get declaration statement create attibute.

Returns: non-zero if declaration statement has been created.

◆ Dump()

virtual void CDecl::Dump ( FILE * f )

inlinevirtual

Dump declaration info to file descriptor.

Parameters

f	file descriptor.

Reimplemented in CFref, CModule, CBlock, CNet, CParam, CMacro, CAttr, CInstance, CGenvar, CGate, CVar, CFunction, CPortDir, CPort, and CSpecify.

◆ DumpDeclInfo()

virtual void CDecl::DumpDeclInfo ( FILE * f )

inlinevirtual

Dump declaration name, type and location to file descriptor.

Parameters

f	file descriptor.

◆ GetAttributes()

CNode* CDecl::GetAttributes ( )

inline

Get declaration's attributes.

Returns: attribute list.

◆ GetAutomatic()

virtual int CDecl::GetAutomatic ( )

inlinevirtual

Get declaration's automatic property.

Returns: value of automatic property.

Reimplemented in CFunction.

◆ GetClass()

Decl_t CDecl::GetClass ( void )

inline

Get class of declaration.

Returns: declaration class for this object.

◆ GetConstAttr()

virtual int CDecl::GetConstAttr ( )

inlinevirtual

Get declaration's const attribute.

Returns: value of const attribute.

◆ GetCoord()

Coord_t* CDecl::GetCoord ( void )

inline

Get file coordinates for declaration.

Returns: file coordinates.

◆ GetDataType()

virtual CDataType* CDecl::GetDataType ( )

inlinevirtual

Get declartion's data type property.

Returns: value of data type property.

◆ GetLsb()

virtual CNode* CDecl::GetLsb ( void ) const

inlinevirtual

Get expression for declaration's lsb.

Returns: lsb expression, NULL if scalar.

Reimplemented in CParam, and CFref.

◆ GetMembers()

static void CDecl::GetMembers	(	Decl_t	type,
		list< Decl_t > &	result
	)

inlinestatic

Get a list of members of the given declaration class/type.

Parameters

type	type/class of declaration.
result	list to return members.

◆ GetMsb()

virtual CNode* CDecl::GetMsb ( void ) const

inlinevirtual

Get expression for declaration's msb.

Returns: msb expression, NULL if scalar.

Reimplemented in CParam, and CFref.

◆ GetName()

const char* CDecl::GetName ( void )

inline

Shortcut to get declaration's name.

Returns: char pointer to name.

◆ GetNodeType()

NodeType_t CDecl::GetNodeType ( void )

inline

Get node type of decl.

Returns: node type of decl.

◆ GetNumberOfUnpackedDimensions()

virtual INT32 CDecl::GetNumberOfUnpackedDimensions ( void )

inlinevirtual

Get number of unpacked dimensions of declaration.

Returns: number of dimensions, 0 if non-array.

◆ GetPragmas()

CNode* CDecl::GetPragmas ( )

inline

Get declaration pragmas.

Returns: declaration's pragma list.

◆ GetScalared()

virtual int CDecl::GetScalared ( )

inlinevirtual

Get declartion's scalared property.

Returns: value of scalared property.

Reimplemented in CNet.

◆ GetSymbol()

CSymbol* CDecl::GetSymbol ( void )

inline

Get declaration's symbol.

Returns: declaration's symbol.

◆ GetType()

Decl_t CDecl::GetType ( void )

inline

Get declaration type.

Returns: declaration type.

◆ GetTypeName()

const char* CDecl::GetTypeName ( void )

inline

Get declaration type as a string.

Returns: declaration type.

◆ GetUnpackedLsi()

virtual CNode* CDecl::GetUnpackedLsi ( INT32 dim )

virtual

Get expression tree for lower limit of unpacked array dimension.

Parameters

dim	dimension.

Returns: expression tree for unpacked lower limit.

◆ GetUnpackedMsi()

virtual CNode* CDecl::GetUnpackedMsi ( INT32 dim )

virtual

Get expression tree for upper limit of given packed array dimension.

Parameters

dim	dimension.

Returns: expression tree for unpacked upper limit.

◆ GetUnpackedRange()

virtual CNode* CDecl::GetUnpackedRange ( INT32 dim )

inlinevirtual

Get expression for range of array for dimension.

Parameters

dim	dimension to get.

Returns: range expression for limit.

◆ GetVarAttr()

virtual int CDecl::GetVarAttr ( )

inlinevirtual

Get declaration's var attribute.

Returns: value of var attribute.

◆ GetVectored()

virtual int CDecl::GetVectored ( )

inlinevirtual

Get declartion's vectored property.

Returns: value of vectored property.

Reimplemented in CNet.

◆ GetWidth()

virtual INT32 CDecl::GetWidth ( void ) const

inlinevirtual

Evaluate packed width of declaration.

Returns: packed width of declaration.

◆ GetWidthExp()

virtual CNode* CDecl::GetWidthExp ( void ) const

inlinevirtual

Get expression representing width of declaration.

Returns: expression representing width of declaration.

Reimplemented in CGenvar.

◆ GetWireAttr()

virtual Wire_t CDecl::GetWireAttr ( )

inlinevirtual

Get declartion's wire type property.

Returns: value of wire type property.

◆ HasAttribute()

int CDecl::HasAttribute	(	char *	name,
		CNode *	n = `NULL`,
		int	init = `1`
	)

Determine if declaration has the given attribute.

Parameters

name	name of attribute to search for.
n	don't supply this argument.
init	don't supply this argument.

◆ IsWidthConstant()

virtual int CDecl::IsWidthConstant ( void ) const

inlinevirtual

Determine if packed width of declaration is constant, ie dependent upon only constants and parameters.

Returns: non-zero of packed width of declaration is constant.

◆ IsWidthEvaluateable()

virtual int CDecl::IsWidthEvaluateable ( void ) const

inlinevirtual

Determine if packed width of declaration can be evaluated.

Returns: non-zero of packed width of declaration can be evaluated.

Reimplemented in CGenvar.

◆ IsWidthVolatile()

virtual int CDecl::IsWidthVolatile ( void ) const

inlinevirtual

Determine if packed width of declaration is volatile, ie depend upon parameters or variables.

Returns: non-zero of packed width of declaration is volatile.

◆ Or() [1/2]

static Flag CDecl::Or	(	Flag	f1,
		Flag	f2
	)

inlinestatic

◆ Or() [2/2]

static Flag CDecl::Or	(	Flag	f1,
		Flag	f2,
		Flag	f3
	)

inlinestatic

◆ PostSubVisit1()

virtual void CDecl::PostSubVisit1	(	CNode ()(CNode , void )	func,
		void *	data
	)

virtual

Reimplemented in CPortDir.

◆ PostVisit1()

virtual void CDecl::PostVisit1	(	void()(CNode , void *)	func,
		void *	data
	)

virtual

Reimplemented in CPortDir.

◆ PreVisit1()

virtual void CDecl::PreVisit1	(	int()(CNode , void *)	func,
		void *	data
	)

virtual

Reimplemented in CPortDir.

◆ SetAttributes()

void CDecl::SetAttributes ( CNode * attr )

inline

Set declarations's attributes.

Parameters

attr	attribute list.

◆ SetAutomatic()

virtual void CDecl::SetAutomatic ( int v )

inlinevirtual

Set declaration's automatic property.

Use to indicate type is a automatic variable.

Parameters

v	value to automatic property.

◆ SetConstAttr()

virtual void CDecl::SetConstAttr ( int v )

inlinevirtual

Set declaration's const attribute.

Use to indicate type is a constant variable.

Parameters

v	value to const attribute.

◆ SetCoord()

void CDecl::SetCoord ( Coord_t * aLoc )

inline

Set declaration coordinate.

Parameters

aLoc	set file coordinates for declaration

◆ SetDataType()

virtual void CDecl::SetDataType ( CDataType * dt )

inlinevirtual

Set declartion's data type property.

Parameters

dt	new data type property.

◆ SetDeclStatementCreated()

void CDecl::SetDeclStatementCreated ( void )

inline

Set declaration statement created attribute.

Todo:: This call will be deprecated when the Block:Add(*) is removed.

◆ SetNumberOfUnpackedDimensions()

virtual void CDecl::SetNumberOfUnpackedDimensions ( INT32 dim )

inlinevirtual

Set number of unpacked dimensions for declaration.

Parameters

dim	number of unpacked dimensions.

◆ SetPragmas()

void CDecl::SetPragmas ( CNode * p )

inline

Set declaration pragmas.

Parameters

p	pragma list.

◆ SetScalared()

virtual void CDecl::SetScalared ( int v )

inlinevirtual

Set declartion's scalared property.

Parameters

v	value of scalared property.

Reimplemented in CNet.

◆ SetSymbol()

void CDecl::SetSymbol ( CSymbol * aSymbol )

inline

Set declaration's symbol.

Parameters

aSymbol new symbol for declaration.

◆ SetUnpackedRange()

virtual void CDecl::SetUnpackedRange	(	INT32	dim,
		CNode *	v
	)

inlinevirtual

Set expression for range of unpacked array for declaration.

Parameters

dim	dimension to set.
v	range expression for limit.

◆ SetVarAttr()

virtual void CDecl::SetVarAttr ( int v )

inlinevirtual

Set declaration's var attribute.

Use to indicate type was declared with var keyword.

Parameters

v	value to var attribute.

◆ SetVectored()

virtual void CDecl::SetVectored ( int v )

inlinevirtual

Set declartion's vectored property.

Parameters

v	value of vectored property.

Reimplemented in CNet.

◆ SetWireAttr()

virtual void CDecl::SetWireAttr ( Wire_t v )

inlinevirtual

Set declaration's wire attribute.

Parameters

v wire type

◆ WidthDirection()

virtual int CDecl::WidthDirection ( void ) const

inlinevirtual

Evaluate current decl width direction.

Expression must be constant.

Returns: 1 - big endian, -1 - little endian, 0 - cannot be determined

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

/home/mdh/Projects/vrq/vrq/src/cdecl.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Flag

Constructor & Destructor Documentation

◆ CDecl()

Member Function Documentation

◆ Clone()

◆ Copy()

◆ DeclStatementCreated()

◆ Dump()

◆ DumpDeclInfo()

◆ GetAttributes()

◆ GetAutomatic()

◆ GetClass()

◆ GetConstAttr()

◆ GetCoord()

◆ GetDataType()

◆ GetLsb()

◆ GetMembers()

◆ GetMsb()

◆ GetName()

◆ GetNodeType()

◆ GetNumberOfUnpackedDimensions()

◆ GetPragmas()

◆ GetScalared()

◆ GetSymbol()

◆ GetType()

◆ GetTypeName()

◆ GetUnpackedLsi()

◆ GetUnpackedMsi()

◆ GetUnpackedRange()

◆ GetVarAttr()

◆ GetVectored()

◆ GetWidth()

◆ GetWidthExp()

◆ GetWireAttr()

◆ HasAttribute()

◆ IsWidthConstant()

◆ IsWidthEvaluateable()

◆ IsWidthVolatile()

◆ Or() [1/2]

◆ Or() [2/2]

◆ PostSubVisit1()

◆ PostVisit1()

◆ PreVisit1()

◆ SetAttributes()

◆ SetAutomatic()

◆ SetConstAttr()

◆ SetCoord()

◆ SetDataType()

◆ SetDeclStatementCreated()

◆ SetNumberOfUnpackedDimensions()

◆ SetPragmas()

◆ SetScalared()

◆ SetSymbol()

◆ SetUnpackedRange()

◆ SetVarAttr()

◆ SetVectored()

◆ SetWireAttr()

◆ WidthDirection()