Puma::CTemplateParamInfo Class Reference

#include <Puma/CTemplateParamInfo.h>

Inheritance diagram for Puma::CTemplateParamInfo:

Description

Semantic information about a template parameter.

There are three kinds of template parameter: type, non-type, and template template parameter.

// T is a type template parameter
// I is a non-type template parameter
// TT is a template template parameter
template<class T, int I, template<typename,int> class TT> 
class X {
  TT<T,I> x;
};

Public Member Functions
	CTemplateParamInfo ()
	Constructor. More...
	~CTemplateParamInfo ()
	Destructor. More...
bool	match (const CTemplateParamInfo &tp) const
	Check if this template parameter matches the given. More...
bool	isTemplate () const
	Check if this is a template template parameter. More...
bool	isTypeParam () const
	Check if this is a type template parameter. More...
CTemplateInfo *	TemplateInfo () const
	Get the template this parameter belongs to. More...
CTemplateInfo *	TemplateTemplate () const
	Get the template information of a template template parameter. More...
CT_TemplateParamDecl *	Tree () const
	Get the syntax tree node representing the template parameter. More...
CTree *	DefaultArgument () const
	Get the default argument of the template parameter. More...
CTypeTemplateParam *	TypeInfo () const
	Get the template parameter type. More...
CTypeInfo *	ValueType () const
	Get the value type of a type template parameter. More...
CTemplateInstance *	TemplateInstance () const
	Get the template instance information for an instantiated template template parameter. More...
int	getPosition () const
	Get the position/index of this parameter in the template parameter list. More...
void	isTypeParam (bool v)
	Set whether this is a type template parameter. More...
void	ValueType (CTypeInfo *type)
	Set the value type of a type template parameter. More...
void	TemplateInfo (CTemplateInfo *info)
	Set the template parameter list information for a template template parameter. More...
void	TemplateTemplate (CTemplateInfo *info)
	Set the template information for a template template parameter. More...
void	TemplateInstance (CTemplateInstance *inst)
	Set the template instance information for an instantiated template template parameter. More...
Public Member Functions inherited from Puma::CObjectInfo
	~CObjectInfo ()
	Destructor. More...
bool	operator== (const CObjectInfo &) const
	Compare the addresses of this object and all objects linked to this object with the address of the given object. More...
bool	operator!= (const CObjectInfo &) const
	Compare the addresses of this object and all objects linked to this object with the address of the given object. More...
CObjectInfo *	ObjectInfo () const
	Get a pointer to CObjectInfo for any semantic object type. More...
CLabelInfo *	LabelInfo () const
	Return a pointer to CLabelInfo if the entity is a label. More...
CMemberAliasInfo *	MemberAliasInfo () const
	Return a pointer to CMemberAliasInfo if the entity is a member alias. More...
CBaseClassInfo *	BaseClassInfo () const
	Return a pointer to CBaseClassInfo if the entity is a base class specifier. More...
CUsingInfo *	UsingInfo () const
	Return a pointer to CUsingInfo if the entity is a using-directive. More...
CTypedefInfo *	TypedefInfo () const
	Return a pointer to CTypedefInfo if the entity is a typedef. More...
CArgumentInfo *	ArgumentInfo () const
	Return a pointer to CArgumentInfo if the entity is a function parameter. More...
CAttributeInfo *	AttributeInfo () const
	Return a pointer to CAttributeInfo if the entity is an object or enumeration constant. More...
CTemplateParamInfo *	TemplateParamInfo () const
	Return a pointer to CTemplateParemInfo if the entity is a template parameter. More...
CStructure *	Structure () const
	Return a pointer to CStructure if the entity is a namespace, class, function, or any other construct that can contain other entities. More...
CFileInfo *	FileInfo () const
	Return a pointer to CFileInfo if this is the file scope. More...
CRecord *	Record () const
	Return a pointer to CRecord if the entity is a class or union. More...
CLocalScope *	LocalScope () const
	Return a pointer to CLocalScope if the entity is a local scope (block scope). More...
CScopeInfo *	ScopeInfo () const
	Return a pointer to CScopeInfo if the entity defines a scope. More...
CClassInfo *	ClassInfo () const
	Return a pointer to CClassInfo if the entity is a class. More...
CUnionInfo *	UnionInfo () const
	Return a pointer to CUnionInfo if the entity is a union. More...
CEnumInfo *	EnumInfo () const
	Return a pointer to CEnumInfo if the entity is an enumeration. More...
CFunctionInfo *	FunctionInfo () const
	Return a pointer to CFunctionInfo if the entity is a function, method, or overloaded operator. More...
CNamespaceInfo *	NamespaceInfo () const
	Return a pointer to CNamespaceInfo if the entity is a namespace. More...
CEnumeratorInfo *	EnumeratorInfo () const
	Return a pointer to CEnumeratorInfo if the entity is an enumeration constant. More...
CTemplateInfo *	TemplateInfo () const
	Return a pointer to CTemplateInfo if the entity is a template. More...
CClassInstance *	ClassInstance () const
	Return a pointer to CClassInstance if the entity is an instance of a class template. More...
CFctInstance *	FctInstance () const
	Return a pointer to CFctInstance if the entity is an instance of a function template. More...
CUnionInstance *	UnionInstance () const
	Return a pointer to CUnionInstance if the entity is an instance of a union template. More...
CTemplateInfo *	Template () const
	Return a pointer to CTemplateInfo if the entity is a template. More...
CTemplateInstance *	TemplateInstance () const
	Return a pointer to CTemplateInstance if the entity is an instance of a class or function template. More...
CScopeInfo *	Scope () const
	Get the scope in which the entity was declared. More...
CStructure *	QualifiedScope () const
	Get the scope of qualified names. More...
CRecord *	ClassScope () const
	Get the class containing the class member described by this object. More...
CStructure *	AssignedScope () const
	Get the scope of a friend class or function. More...
ObjectId	Id () const
	Get the type of this semantic object. More...
const DString &	Name () const
	Get the name of entity described by this semantic object. More...
const char *	QualName (bool abs=false, bool tdef=false, bool unnamed=false)
	Get the qualified name of the entity described by this semantic object. More...
CObjectInfo *	DefObject () const
	Get the semantic information object for the definition of an entity. More...
CTypeInfo *	TypeInfo () const
	Get the data type of the entity. More...
CSourceInfo *	SourceInfo () const
	Get the source file information. More...
CSemDatabase *	ClassDB () const
	Get the semantic information database object containing this semantic object. More...
CSemDatabase *	SemDB () const
	Get the semantic information database object containing this semantic object. More...
CTree *	Tree () const
	Get the syntax tree node for the entity described by this semantic object. More...
CObjectInfo *	NextObject () const
	Get the next semantic object linked with this object. More...
CObjectInfo *	PrevObject () const
	Get the previous semantic object linked with this object. More...
CObjectInfo *	BaseObject () const
	Get the semantic object for the base class entity this entity is overloading. More...
CTree *	Init () const
	Get the initializer of the entity. More...
CProtection::Type	Protection () const
	Get the member protection of the entity, if it is a class member. More...
CLinkage::Type	Linkage () const
	Get the linkage of the entity. More...
CStorage::Type	Storage () const
	Get the storage class of the entity. More...
const CLanguage &	Language () const
	Get the entity encoding language. More...
CLanguage &	Language ()
	Get the entity encoding language. More...
const CSpecifiers &	Specifiers () const
	Get the declaration specifiers. More...
bool	isType () const
	Check if the entity is a type. More...
bool	isObject () const
	Check if the entity is an object. More...
bool	isAnonymous () const
	Check if the entity is anonymous (has no explicit name). More...
bool	isTemplate () const
	Check if the entity is a class or function template, or a template template parameter. More...
bool	isTemplateInstance () const
	Check if the entity is a class or function template instance. More...
bool	isBuiltin () const
	Check if the entity describes a built-in type or function. More...
bool	isClassMember () const
	Check if the entity is a method or data member of a class. More...
bool	isVirtual () const
	Check if the entity is declared virtual. More...
bool	isStatic () const
	Check if the entity is declared static. More...
bool	isThreadLocal () const
	Check if the entity is declared __thread. More...
bool	isExtern () const
	Check if the entity is declared extern. More...
bool	isMutable () const
	Check if the entity is declared mutable. More...
bool	isRegister () const
	Check if the entity is declared register. More...
bool	isExplicit () const
	Check if the entity is declared explicit. More...
bool	isInline () const
	Check if the entity is declared inline. More...
bool	isAuto () const
	Check if the entity is declared auto. More...
bool	isRegistered (const CStructure *s) const
	Check if the given semantic object is registered as being connected to this semantic object in any way. More...
bool	isLocal () const
	Check if the entity is local. More...
void	Name (const char *s)
	Set the name of the entity. More...
void	Name (const DString &ds)
	Set the name of the entity. More...
void	TypeInfo (CTypeInfo *type)
	Set the type of the entity. More...
void	BaseObject (CObjectInfo *base)
	Set the base class object for the entity this entity overloads. More...
void	Protection (CProtection::Type p)
	Set the member access protection of the entity. More...
void	Linkage (CLinkage::Type l)
	Set the linkage of the entity. More...
void	Storage (CStorage::Type s)
	Set the storage class of the entity. More...
void	Specifiers (const CSpecifiers &)
	Set the declaration specifiers. More...
void	FileInfo (CFileInfo *finfo)
	Set the source file information for the entity. More...
void	Tree (CTree *tree)
	Set the syntax tree node of the entity. More...
void	ClassDB (CSemDatabase *db)
	Set the semantic information database object containing this semantic object. More...
void	SemDB (CSemDatabase *db)
	Set the semantic information database object containing this semantic object. More...
void	NextObject (CObjectInfo *obj)
	Set the link to next semantic object. More...
void	PrevObject (CObjectInfo *obj)
	Set the link to next semantic object. More...
void	Unlink ()
	Unlink this semantic object. More...
void	Register (CStructure *s)
	Register the given semantic object as being connected to this semantic object in any way. More...
void	Unregister (CStructure *s)
	Unregister the given semantic object as being connected to this semantic object in any way. More...
void	isVirtual (bool v)
	Set whether the entity was declared virtual. More...
void	isStatic (bool v)
	Set whether the entity was declared static. More...
void	isThreadLocal (bool v)
	Set whether the entity was declared __thread. More...
void	isExtern (bool v)
	Set whether the entity was declared extern. More...
void	isMutable (bool v)
	Set whether the entity was declared mutable. More...
void	isRegister (bool v)
	Set whether the entity was declared register. More...
void	isExplicit (bool v)
	Set whether the entity was declared explicit. More...
void	isInline (bool v)
	Set whether the entity was declared inline. More...
void	isAuto (bool v)
	Set whether the entity was declared auto. More...
void	AssignedScope (CStructure *s)
	Set the assigned scope of the entity. More...

Additional Inherited Members
Public Types inherited from Puma::CObjectInfo
enum	ObjectId {   FILE_INFO ,   UNION_INFO ,   CLASS_INFO ,   BASECLASS_INFO ,   MEMBERALIAS_INFO ,   ENUM_INFO ,   TYPEDEF_INFO ,   FUNCTION_INFO ,   LABEL_INFO ,   ENUMERATOR_INFO ,   ATTRIBUTE_INFO ,   TEMPLATE_PARAM_INFO ,   TEMPLATE_INFO ,   CLASS_INSTANCE_INFO ,   UNION_INSTANCE_INFO ,   FCT_INSTANCE_INFO ,   ARGUMENT_INFO ,   LOCAL_INFO ,   NAMESPACE_INFO ,   USING_INFO }
	Semantic information object types. More...
Protected Member Functions inherited from Puma::CObjectInfo
	CObjectInfo (ObjectId id)
	Constructor. More...
Protected Attributes inherited from Puma::CObjectInfo
CStructure *	_QualScope
	Qualified name scope. More...
CStructure *	_AssignedScope
	The scope of a friend class or function. More...
Array< CStructure * >	_Registered
	Set of semantic objects connected to this object in any way. More...

Constructor & Destructor Documentation

CTemplateParamInfo()

Puma::CTemplateParamInfo::CTemplateParamInfo ( )

inline

Constructor.

~CTemplateParamInfo()

Puma::CTemplateParamInfo::~CTemplateParamInfo

(

)

Destructor.

If the object type is CObjectInfo::TEMPLATE_PARAM_INFO, then CObjectInfo::CleanUp() is called and the template instance information object of a template template parameter is destroyed.

Member Function Documentation

DefaultArgument()

CTree * Puma::CTemplateParamInfo::DefaultArgument

(

)

const

Get the default argument of the template parameter.

Returns

The default argument expression or NULL if no default argument.

getPosition()

int Puma::CTemplateParamInfo::getPosition

(

)

const

Get the position/index of this parameter in the template parameter list.

isTemplate()

bool Puma::CTemplateParamInfo::isTemplate ( ) const

inline

Check if this is a template template parameter.

isTypeParam() [1/2]

bool Puma::CTemplateParamInfo::isTypeParam ( ) const

inline

Check if this is a type template parameter.

isTypeParam() [2/2]

void Puma::CTemplateParamInfo::isTypeParam ( bool  v )

inline

Set whether this is a type template parameter.

Parameters

v	True for yes, false for no.

match()

bool Puma::CTemplateParamInfo::match

(

const CTemplateParamInfo &

tp

)

const

Check if this template parameter matches the given.

Must be same kind of parameter, same type and value.

TemplateInfo() [1/2]

CTemplateInfo * Puma::CTemplateParamInfo::TemplateInfo ( ) const

inline

Get the template this parameter belongs to.

TemplateInfo() [2/2]

void Puma::CTemplateParamInfo::TemplateInfo ( CTemplateInfo *  info )

inline

Set the template parameter list information for a template template parameter.

Parameters

info	The template parameter list information.

TemplateInstance() [1/2]

CTemplateInstance * Puma::CTemplateParamInfo::TemplateInstance ( ) const

inline

Get the template instance information for an instantiated template template parameter.

TemplateInstance() [2/2]

void Puma::CTemplateParamInfo::TemplateInstance ( CTemplateInstance *  inst )

inline

Set the template instance information for an instantiated template template parameter.

Parameters

inst	The template instance.

TemplateTemplate() [1/2]

CTemplateInfo * Puma::CTemplateParamInfo::TemplateTemplate ( ) const

inline

Get the template information of a template template parameter.

TemplateTemplate() [2/2]

void Puma::CTemplateParamInfo::TemplateTemplate ( CTemplateInfo *  info )

inline

Set the template information for a template template parameter.

Parameters

info	The template information.

Tree()

CT_TemplateParamDecl * Puma::CTemplateParamInfo::Tree ( ) const

inline

Get the syntax tree node representing the template parameter.

TypeInfo()

CTypeTemplateParam * Puma::CTemplateParamInfo::TypeInfo ( ) const

inline

Get the template parameter type.

ValueType() [1/2]

CTypeInfo * Puma::CTemplateParamInfo::ValueType ( ) const

inline

Get the value type of a type template parameter.

ValueType() [2/2]

void Puma::CTemplateParamInfo::ValueType ( CTypeInfo *  type )

inline

Set the value type of a type template parameter.

Parameters

type	The value type.