PUMA Library Reference Manual
Puma::CScopeInfo Class Reference

#include <Puma/CScopeInfo.h>

+ Inheritance diagram for Puma::CScopeInfo:

Description

Semantic information about a scope. Several syntactic constructs have its own scope, such as class definitions, functions, and compound statements.

Public Member Functions

 ~CScopeInfo ()
 Destructor. More...
 
unsigned Children () const
 Get the number of child scopes (nested scopes). More...
 
CScopeInfoChild (unsigned) const
 Get the n-th child scope. More...
 
CScopeInfoParent () const
 Get the parent scope of this scope. More...
 
bool isFile () const
 Check if this is a file (file scope). More...
 
bool isNamespace () const
 Check if this is namespace. More...
 
bool isRecord () const
 Check if this is class or union. More...
 
bool isClass () const
 Check if this is a class. More...
 
bool isUnion () const
 Check if this is a union. More...
 
bool isFunction () const
 Check if this is a function. More...
 
bool isMethod () const
 Check if this is a class method. More...
 
bool isClassTemplate () const
 Check if this is a class template. More...
 
bool isFctTemplate () const
 Check if this is a function template. More...
 
bool isLocalScope () const
 Check if this is a local scope. More...
 
bool isLocalRecord () const
 Check if this is a local class or union. More...
 
bool isLocalClass () const
 Check if this is a local class. More...
 
bool isLocalUnion () const
 Check if this is a local union. More...
 
bool GlobalScope () const
 Check if this is the global (file) scope. More...
 
bool insideTemplate () const
 Check if this scope is inside a class or function template scope. More...
 
bool insideRecord () const
 Check if this scope is inside a class or union scope. More...
 
bool insideClass () const
 Check if this scope is inside a class scope. More...
 
bool insideUnion () const
 Check if this scope is inside a union scope. More...
 
bool insideFunction () const
 Check if this scope is inside a function scope. More...
 
bool insideMethod () const
 Check if this scope is inside a class method scope. More...
 
void Parent (const CScopeInfo *scope)
 Set the parent scope of this scope. More...
 
void addChild (CScopeInfo *scope)
 Add a child scope to this scope. More...
 
void removeChild (const CScopeInfo *scope)
 Remove a child scope. More...
 
CLocalScopenewLocalScope ()
 Create a new local scope information object. More...
 
CFunctionInfonewFunction (bool inst=false)
 Create a new function or function template instance semantic object. More...
 
CClassInfonewClass (bool inst=false)
 Create a new class or class template instance semantic object. More...
 
CUnionInfonewUnion (bool inst=false)
 Create a new union or union template instance semantic object. More...
 
CNamespaceInfonewNamespace ()
 Create a new namespace semantic object. More...
 
CTemplateInfonewTemplate ()
 Create a new template semantic object. More...
 
void deleteLocalScope (const CLocalScope *scope)
 Delete the given local scope semantic object. More...
 
void deleteFunction (const CFunctionInfo *fct)
 Delete the given function semantic object. More...
 
void deleteClass (const CClassInfo *c)
 Delete the given class semantic object. More...
 
void deleteUnion (const CUnionInfo *u)
 Delete the given union semantic object. More...
 
void deleteNamespace (const CNamespaceInfo *ns)
 Delete the given namespace semantic object. More...
 
void deleteTemplate (const CTemplateInfo *tpl)
 Delete the given template semantic object. 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...
 
CObjectInfoObjectInfo () const
 Get a pointer to CObjectInfo for any semantic object type. More...
 
CLabelInfoLabelInfo () const
 Return a pointer to CLabelInfo if the entity is a label. More...
 
CMemberAliasInfoMemberAliasInfo () const
 Return a pointer to CMemberAliasInfo if the entity is a member alias. More...
 
CBaseClassInfoBaseClassInfo () const
 Return a pointer to CBaseClassInfo if the entity is a base class specifier. More...
 
CUsingInfoUsingInfo () const
 Return a pointer to CUsingInfo if the entity is a using-directive. More...
 
CTypedefInfoTypedefInfo () const
 Return a pointer to CTypedefInfo if the entity is a typedef. More...
 
CArgumentInfoArgumentInfo () const
 Return a pointer to CArgumentInfo if the entity is a function parameter. More...
 
CAttributeInfoAttributeInfo () const
 Return a pointer to CAttributeInfo if the entity is an object or enumeration constant. More...
 
CTemplateParamInfoTemplateParamInfo () const
 Return a pointer to CTemplateParemInfo if the entity is a template parameter. More...
 
CStructureStructure () const
 Return a pointer to CStructure if the entity is a namespace, class, function, or any other construct that can contain other entities. More...
 
CFileInfoFileInfo () const
 Return a pointer to CFileInfo if this is the file scope. More...
 
CRecordRecord () const
 Return a pointer to CRecord if the entity is a class or union. More...
 
CLocalScopeLocalScope () const
 Return a pointer to CLocalScope if the entity is a local scope (block scope). More...
 
CScopeInfoScopeInfo () const
 Return a pointer to CScopeInfo if the entity defines a scope. More...
 
CClassInfoClassInfo () const
 Return a pointer to CClassInfo if the entity is a class. More...
 
CUnionInfoUnionInfo () const
 Return a pointer to CUnionInfo if the entity is a union. More...
 
CEnumInfoEnumInfo () const
 Return a pointer to CEnumInfo if the entity is an enumeration. More...
 
CFunctionInfoFunctionInfo () const
 Return a pointer to CFunctionInfo if the entity is a function, method, or overloaded operator. More...
 
CNamespaceInfoNamespaceInfo () const
 Return a pointer to CNamespaceInfo if the entity is a namespace. More...
 
CEnumeratorInfoEnumeratorInfo () const
 Return a pointer to CEnumeratorInfo if the entity is an enumeration constant. More...
 
CTemplateInfoTemplateInfo () const
 Return a pointer to CTemplateInfo if the entity is a template. More...
 
CClassInstanceClassInstance () const
 Return a pointer to CClassInstance if the entity is an instance of a class template. More...
 
CFctInstanceFctInstance () const
 Return a pointer to CFctInstance if the entity is an instance of a function template. More...
 
CUnionInstanceUnionInstance () const
 Return a pointer to CUnionInstance if the entity is an instance of a union template. More...
 
CTemplateInfoTemplate () const
 Return a pointer to CTemplateInfo if the entity is a template. More...
 
CTemplateInstanceTemplateInstance () const
 Return a pointer to CTemplateInstance if the entity is an instance of a class or function template. More...
 
CScopeInfoScope () const
 Get the scope in which the entity was declared. More...
 
CStructureQualifiedScope () const
 Get the scope of qualified names. More...
 
CRecordClassScope () const
 Get the class containing the class member described by this object. More...
 
CStructureAssignedScope () const
 Get the scope of a friend class or function. More...
 
ObjectId Id () const
 Get the type of this semantic object. More...
 
const DStringName () 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...
 
CObjectInfoDefObject () const
 Get the semantic information object for the definition of an entity. More...
 
CTypeInfoTypeInfo () const
 Get the data type of the entity. More...
 
CSourceInfoSourceInfo () const
 Get the source file information. More...
 
CSemDatabaseClassDB () const
 Get the semantic information database object containing this semantic object. More...
 
CSemDatabaseSemDB () const
 Get the semantic information database object containing this semantic object. More...
 
CTreeTree () const
 Get the syntax tree node for the entity described by this semantic object. More...
 
CObjectInfoNextObject () const
 Get the next semantic object linked with this object. More...
 
CObjectInfoPrevObject () const
 Get the previous semantic object linked with this object. More...
 
CObjectInfoBaseObject () const
 Get the semantic object for the base class entity this entity is overloading. More...
 
CTreeInit () 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 CLanguageLanguage () const
 Get the entity encoding language. More...
 
CLanguageLanguage ()
 Get the entity encoding language. More...
 
const CSpecifiersSpecifiers () 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...
 

Protected Member Functions

 CScopeInfo (ObjectId id)
 Constructor. More...
 
- Protected Member Functions inherited from Puma::CObjectInfo
 CObjectInfo (ObjectId id)
 Constructor. 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 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

◆ CScopeInfo()

Puma::CScopeInfo::CScopeInfo ( CObjectInfo::ObjectId  id)
inlineprotected

Constructor.

Parameters
idThe object type.

◆ ~CScopeInfo()

Puma::CScopeInfo::~CScopeInfo ( )

Destructor.

Member Function Documentation

◆ addChild()

void Puma::CScopeInfo::addChild ( CScopeInfo scope)

Add a child scope to this scope.

Parameters
scopeThe child scope.

◆ Child()

CScopeInfo * Puma::CScopeInfo::Child ( unsigned  n) const
inline

Get the n-th child scope.

Parameters
nThe index of the child scope.
Returns
The n-th child scope or NULL.

◆ Children()

unsigned Puma::CScopeInfo::Children ( ) const
inline

Get the number of child scopes (nested scopes).

◆ deleteClass()

void Puma::CScopeInfo::deleteClass ( const CClassInfo c)

Delete the given class semantic object.

Parameters
cThe class.

◆ deleteFunction()

void Puma::CScopeInfo::deleteFunction ( const CFunctionInfo fct)

Delete the given function semantic object.

Parameters
fctThe function.

◆ deleteLocalScope()

void Puma::CScopeInfo::deleteLocalScope ( const CLocalScope scope)

Delete the given local scope semantic object.

Parameters
scopeThe local scope.

◆ deleteNamespace()

void Puma::CScopeInfo::deleteNamespace ( const CNamespaceInfo ns)

Delete the given namespace semantic object.

Parameters
nsThe namespace.

◆ deleteTemplate()

void Puma::CScopeInfo::deleteTemplate ( const CTemplateInfo tpl)

Delete the given template semantic object.

Parameters
tplThe template.

◆ deleteUnion()

void Puma::CScopeInfo::deleteUnion ( const CUnionInfo u)

Delete the given union semantic object.

Parameters
uThe union.

◆ GlobalScope()

bool Puma::CScopeInfo::GlobalScope ( ) const
inline

Check if this is the global (file) scope.

◆ insideClass()

bool Puma::CScopeInfo::insideClass ( ) const
inline

Check if this scope is inside a class scope.

◆ insideFunction()

bool Puma::CScopeInfo::insideFunction ( ) const
inline

Check if this scope is inside a function scope.

◆ insideMethod()

bool Puma::CScopeInfo::insideMethod ( ) const
inline

Check if this scope is inside a class method scope.

◆ insideRecord()

bool Puma::CScopeInfo::insideRecord ( ) const
inline

Check if this scope is inside a class or union scope.

◆ insideTemplate()

bool Puma::CScopeInfo::insideTemplate ( ) const
inline

Check if this scope is inside a class or function template scope.

◆ insideUnion()

bool Puma::CScopeInfo::insideUnion ( ) const
inline

Check if this scope is inside a union scope.

◆ isClass()

bool Puma::CScopeInfo::isClass ( ) const
inline

Check if this is a class.

◆ isClassTemplate()

bool Puma::CScopeInfo::isClassTemplate ( ) const

Check if this is a class template.

◆ isFctTemplate()

bool Puma::CScopeInfo::isFctTemplate ( ) const

Check if this is a function template.

◆ isFile()

bool Puma::CScopeInfo::isFile ( ) const
inline

Check if this is a file (file scope).

◆ isFunction()

bool Puma::CScopeInfo::isFunction ( ) const
inline

Check if this is a function.

◆ isLocalClass()

bool Puma::CScopeInfo::isLocalClass ( ) const
inline

Check if this is a local class.

◆ isLocalRecord()

bool Puma::CScopeInfo::isLocalRecord ( ) const
inline

Check if this is a local class or union.

◆ isLocalScope()

bool Puma::CScopeInfo::isLocalScope ( ) const
inline

Check if this is a local scope.

◆ isLocalUnion()

bool Puma::CScopeInfo::isLocalUnion ( ) const
inline

Check if this is a local union.

◆ isMethod()

bool Puma::CScopeInfo::isMethod ( ) const

Check if this is a class method.

◆ isNamespace()

bool Puma::CScopeInfo::isNamespace ( ) const
inline

Check if this is namespace.

◆ isRecord()

bool Puma::CScopeInfo::isRecord ( ) const
inline

Check if this is class or union.

◆ isUnion()

bool Puma::CScopeInfo::isUnion ( ) const
inline

Check if this is a union.

◆ newClass()

CClassInfo* Puma::CScopeInfo::newClass ( bool  inst = false)

Create a new class or class template instance semantic object.

Parameters
insttrue if to a class template instance.

◆ newFunction()

CFunctionInfo* Puma::CScopeInfo::newFunction ( bool  inst = false)

Create a new function or function template instance semantic object.

Parameters
insttrue if to a function template instance.

◆ newLocalScope()

CLocalScope* Puma::CScopeInfo::newLocalScope ( )

Create a new local scope information object.

◆ newNamespace()

CNamespaceInfo* Puma::CScopeInfo::newNamespace ( )

Create a new namespace semantic object.

◆ newTemplate()

CTemplateInfo* Puma::CScopeInfo::newTemplate ( )

Create a new template semantic object.

◆ newUnion()

CUnionInfo* Puma::CScopeInfo::newUnion ( bool  inst = false)

Create a new union or union template instance semantic object.

Parameters
insttrue if to a union template instance.

◆ Parent() [1/2]

CScopeInfo * Puma::CScopeInfo::Parent ( ) const
inline

Get the parent scope of this scope.

The top scope is the file scope.

Returns
The parent scope, or this scope if no parent.

◆ Parent() [2/2]

void Puma::CScopeInfo::Parent ( const CScopeInfo scope)

Set the parent scope of this scope.

Parameters
scopeThe parent scope.

◆ removeChild()

void Puma::CScopeInfo::removeChild ( const CScopeInfo scope)

Remove a child scope.

Parameters
scopeThe child scope.