PUMA Library Reference Manual
Puma::CFileInfo Class Reference

#include <Puma/CFileInfo.h>

+ Inheritance diagram for Puma::CFileInfo:

Description

Semantic information about a source file (translation unit). A source file has its own scope, the so-called file scope.

Public Member Functions

 CFileInfo ()
 Constructor. More...
 
 ~CFileInfo ()
 Destructor. More...
 
UnitPrimary () const
 Get the token chain of the source file. More...
 
void Primary (Unit *unit)
 Set the token chain of the source file. More...
 
bool haveCBuiltins () const
 Check if C compiler build-in functions are defined for the source file. More...
 
bool haveCCBuiltins () const
 Check if C++ compiler build-in functions are defined for the source file. More...
 
void haveCBuiltins (bool v)
 Set whether C compiler build-in functions are defined for the source file. More...
 
void haveCCBuiltins (bool v)
 Set whether C++ compiler build-in functions are defined for the source file. More...
 
- Public Member Functions inherited from Puma::CNamespaceInfo
 CNamespaceInfo ()
 Constructor. More...
 
 ~CNamespaceInfo ()
 Destructor. More...
 
bool isAlias () const
 Check if this is a namespace alias. More...
 
void isAlias (bool v)
 Set whether this is a namespace alias. More...
 
bool aroundInstantiation () const
 Check if this is a special internal namespace around template instantiations. More...
 
void aroundInstantiation (bool v)
 Set whether this is a special internal namespace around template instantiations. More...
 
- Public Member Functions inherited from Puma::CStructure
 ~CStructure ()
 Destructor. More...
 
ObjectsByNameObjectInfoMap ()
 Get the entity name to semantic object map. More...
 
const ObjectInfoSetObjectInfos () const
 Get the entity name to semantic object map. More...
 
unsigned Objects () const
 Get the number of contained semantic objects. More...
 
unsigned Objects (const DString &name) const
 Get the number of contained semantic objects for entities with the given name. More...
 
unsigned Types () const
 Get the number of contained semantic objects for type declarations. More...
 
unsigned Types (const DString &name) const
 Get the number of contained semantic objects for declarations of types with the given name. More...
 
unsigned Attributes () const
 Get the number of contained semantic objects for object declarations. More...
 
unsigned Attributes (const DString &name) const
 Get the number of contained semantic objects for declarations of objects with the given name. More...
 
unsigned TemplateParams () const
 Get the number of contained semantic objects for template parameter declarations. More...
 
unsigned TemplateParams (const DString &name) const
 Get the number of contained semantic objects for declarations of template parameters with the given name. More...
 
unsigned Functions () const
 Get the number of contained semantic objects for function declarations. More...
 
unsigned Functions (const DString &name) const
 Get the number of contained semantic objects for declarations of functions with the given name. More...
 
unsigned Usings () const
 Get the number of contained semantic objects for used members. More...
 
unsigned Usings (const DString &name) const
 Get the number of contained semantic objects for used members with the given name. More...
 
unsigned Namespaces () const
 Get the number of contained semantic objects for namespace declarations. More...
 
unsigned Namespaces (const DString &name) const
 Get the number of contained semantic objects for declarations of namespaces with the given name. More...
 
unsigned Friends () const
 Get the number of contained semantic objects for friend declarations. More...
 
unsigned Friends (const DString &name) const
 Get the number of contained semantic objects for declarations of friends with the given name. More...
 
CObjectInfoObject (unsigned n) const
 Get the n-th contained semantic object. More...
 
CObjectInfoObject (const DString &name, unsigned n=0) const
 Get the n-th contained semantic object for entities with the given name. More...
 
CObjectInfoType (unsigned n) const
 Get the n-th contained semantic object for a type. More...
 
CObjectInfoType (const DString &name, unsigned n=0) const
 Get the n-th contained semantic object for types with the given name. More...
 
CTypedefInfoTypedef (const DString &name, unsigned n=0) const
 Get the n-th contained semantic object for typedefs with the given name. More...
 
CUsingInfoUsing (unsigned n) const
 Get the n-th contained semantic object for a using-directive. More...
 
CUsingInfoUsing (const DString &name, unsigned n=0) const
 Get the n-th contained semantic object for used members with the given name. More...
 
CNamespaceInfoNamespace (unsigned n) const
 Get the n-th contained semantic object for a namespace. More...
 
CNamespaceInfoNamespace (const DString &name, unsigned n=0) const
 Get the n-th contained semantic object for namespaces with the given name. More...
 
CRecordFriend (unsigned n) const
 Get the n-th contained semantic object for a friend. More...
 
CRecordFriend (const DString &name, unsigned n=0) const
 Get the n-th contained semantic object for friends with the given name. More...
 
CAttributeInfoAttribute (unsigned n) const
 Get the n-th contained semantic object for an object. More...
 
CAttributeInfoAttribute (const DString &name, unsigned n=0) const
 Get the n-th contained semantic object for objects with the given name. More...
 
CTemplateParamInfoTemplateParam (unsigned n) const
 Get the n-th contained semantic object for a template parameter. More...
 
CTemplateParamInfoTemplateParam (const DString &name, unsigned n=0) const
 Get the n-th contained semantic object for template parameters with the given name. More...
 
CFunctionInfoFunction (unsigned n) const
 Get the n-th contained semantic object for a function. More...
 
CFunctionInfoFunction (const DString &name, unsigned n=0) const
 Get the n-th contained semantic object for functions with the given name. More...
 
CFunctionInfoFunction (const DString &name, CTypeInfo *type) const
 Get the contained semantic object for functions with the given name and type. More...
 
bool isMemberAlias (const CObjectInfo *info) const
 Check if an alias exists for the given entity in this scope. More...
 
CMemberAliasInfoMemberAlias (const CObjectInfo *info) const
 Get the member alias information for the aliased entity. More...
 
void setShared (CStructure *share)
 Set a common data object for the linked semantic objects. More...
 
void addObject (CObjectInfo *info)
 Add a semantic object. More...
 
void addAttribute (CAttributeInfo *info)
 Add a semantic object for an object. More...
 
void addTemplateParam (CTemplateParamInfo *info)
 Add a semantic object for a template parameter. More...
 
void addFunction (CFunctionInfo *info)
 Add a semantic object for a function. More...
 
void addType (CObjectInfo *info)
 Add a semantic object for a type. More...
 
void addUsing (CUsingInfo *info)
 Add a semantic object for a using-directive. More...
 
void addNamespace (CNamespaceInfo *info)
 Add a semantic object for a namespace. More...
 
void addFriend (CRecord *info)
 Add a semantic object for a friend. More...
 
void removeObject (const CObjectInfo *info)
 Remove the semantic object. More...
 
void removeAttribute (const CAttributeInfo *info)
 Remove the semantic object for an object. More...
 
void removeTemplateParam (const CTemplateParamInfo *info)
 Remove the semantic object for a template parameter. More...
 
void removeFunction (const CFunctionInfo *info)
 Remove the semantic object for a function. More...
 
void removeType (const CObjectInfo *info)
 Remove the semantic object for a type. More...
 
void removeUsing (const CUsingInfo *info)
 Remove the semantic object for a using-directive. More...
 
void removeNamespace (const CNamespaceInfo *info)
 Remove the semantic object for a namespace. More...
 
void removeFriend (const CRecord *info)
 Remove the semantic object for a friend. More...
 
void removeMemberAlias (const CMemberAliasInfo *info)
 Remove the semantic object for a member alias. More...
 
void removeRegisterEntry ()
 Unregister this semantic object at all contained semantic objects. More...
 
void addNamedObject (CObjectInfo *info)
 Add a semantic object to the name map. More...
 
void removeNamedObject (const DString &name, CObjectInfo *info)
 Remove the given semantic object for the entity with the given name from the name map. More...
 
CAttributeInfonewAttribute ()
 Create a new semantic object for an object declaration. More...
 
CEnumInfonewEnum ()
 Create a new semantic object for an enumeration. More...
 
CUsingInfonewUsing ()
 Create a new semantic object for a using-directive. More...
 
CTypedefInfonewTypedef ()
 Create a new semantic object for a typedef. More...
 
CMemberAliasInfonewMemberAlias (CObjectInfo *member, bool direct_member=false)
 Create a new semantic object for a member alias. More...
 
void deleteAttribute (const CAttributeInfo *info)
 Remove and destroy the given semantic object for an object. More...
 
void deleteEnum (const CEnumInfo *info)
 Remove and destroy the given semantic object for an enumeration. More...
 
void deleteUsing (const CUsingInfo *info)
 Remove and destroy the given semantic object for a using-directive. More...
 
void deleteTypedef (const CTypedefInfo *info)
 Remove and destroy the given semantic object for a typedef. More...
 
void deleteMemberAlias (const CMemberAliasInfo *info)
 Remove and destroy the given semantic object for a member alias. More...
 
- Public Member Functions inherited from Puma::CScopeInfo
 ~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...
 

Additional Inherited Members

- Public Types inherited from Puma::CStructure
typedef std::list< CObjectInfo * > ObjectInfoList
 List type for semantic objects. More...
 
typedef std::map< DString, ObjectInfoListObjectsByName
 Map type for entity name to semantic object mapping. More...
 
typedef std::set< CObjectInfo * > ObjectInfoSet
 Set type for semantic objects. More...
 
- 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::CNamespaceInfo
 CNamespaceInfo (ObjectId id)
 Constructor. More...
 
- Protected Member Functions inherited from Puma::CStructure
 CStructure (ObjectId id)
 Constructor. More...
 
- Protected Member Functions inherited from Puma::CScopeInfo
 CScopeInfo (ObjectId id)
 Constructor. 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

◆ CFileInfo()

Puma::CFileInfo::CFileInfo ( )
inline

Constructor.

◆ ~CFileInfo()

Puma::CFileInfo::~CFileInfo ( )
inline

Destructor.

If the object type is CObjectInfo::FILE_INFO, then CObjectInfo::CleanUp() is called.

Member Function Documentation

◆ haveCBuiltins() [1/2]

bool Puma::CFileInfo::haveCBuiltins ( ) const
inline

Check if C compiler build-in functions are defined for the source file.

◆ haveCBuiltins() [2/2]

void Puma::CFileInfo::haveCBuiltins ( bool  v)
inline

Set whether C compiler build-in functions are defined for the source file.

Parameters
vtrue if C build-in functions are defined.

◆ haveCCBuiltins() [1/2]

bool Puma::CFileInfo::haveCCBuiltins ( ) const
inline

Check if C++ compiler build-in functions are defined for the source file.

◆ haveCCBuiltins() [2/2]

void Puma::CFileInfo::haveCCBuiltins ( bool  v)
inline

Set whether C++ compiler build-in functions are defined for the source file.

Parameters
vtrue if C++ build-in functions are defined.

◆ Primary() [1/2]

Unit * Puma::CFileInfo::Primary ( ) const
inline

Get the token chain of the source file.

◆ Primary() [2/2]

void Puma::CFileInfo::Primary ( Unit unit)
inline

Set the token chain of the source file.

Parameters
unitThe token chain.