A abstract class representing of a compound symbol. More...

#include <src/classdef.h>

Inheritance diagram for ClassDef:

Collaboration diagram for ClassDef:

Public Types
enum	CompoundType { Class , Struct , Union , Interface , Protocol , Category , Exception , Service , Singleton }
	The various compound types. More...

Public Types inherited from Definition
enum	DefType { TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 , TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 , TypeDir = 8 , TypeConcept = 9 }

Public Member Functions
virtual std::unique_ptr< ClassDef >	deepCopy (const QCString &name) const =0

virtual void	moveTo (Definition *)=0

virtual QCString	getInstanceOutputFileBase () const =0

virtual bool	isLocal () const =0
	Returns TRUE if this is a local class definition, see EXTRACT_LOCAL_CLASSES.

virtual ClassLinkedRefMap	getClasses () const =0
	returns the classes nested into this class

virtual bool	hasDetailedDescription () const =0
	returns TRUE if this class has a non-empty detailed description

virtual QCString	collaborationGraphFileName () const =0
	returns the file name to use for the collaboration graph

virtual QCString	inheritanceGraphFileName () const =0
	returns the file name to use for the inheritance graph

virtual CompoundType	compoundType () const =0
	Returns the type of compound this is, i.e.

virtual QCString	compoundTypeString () const =0
	Returns the type of compound as a string.

virtual const BaseClassList &	baseClasses () const =0
	Returns the list of base classes from which this class directly inherits.

virtual void	updateBaseClasses (const BaseClassList &bcd)=0
	Update the list of base classes to the one passed.

virtual const BaseClassList &	subClasses () const =0
	Returns the list of sub classes that directly derive from this class.

virtual void	updateSubClasses (const BaseClassList &bcd)=0
	Update the list of sub classes to the one passed.

virtual const MemberNameInfoLinkedMap &	memberNameInfoLinkedMap () const =0
	Returns a dictionary of all members.

virtual Protection	protection () const =0
	Return the protection level (Public,Protected,Private) in which this compound was found.

virtual bool	isVisibleInHierarchy () const =0
	the class is visible in a class diagram, or class hierarchy

virtual bool	visibleInParentsDeclList () const =0
	show this class in the declaration section of its parent?

virtual const ArgumentList &	templateArguments () const =0
	Returns the template arguments of this class.

virtual FileDef *	getFileDef () const =0
	Returns the namespace this compound is in, or 0 if it has a global scope.

virtual ModuleDef *	getModuleDef () const =0
	Returns the C++20 module in which this compound's definition can be found.

virtual const MemberDef *	getMemberByName (const QCString &) const =0
	Returns the member with the given name.

virtual int	isBaseClass (const ClassDef *bcd, bool followInstances, const QCString &templSpec=QCString()) const =0
	Returns TRUE iff bcd is a direct or indirect base class of this class.

virtual bool	isSubClass (ClassDef *bcd, int level=0) const =0
	Returns TRUE iff bcd is a direct or indirect sub class of this class.

virtual bool	isAccessibleMember (const MemberDef *md) const =0
	returns TRUE iff md is a member of this class or of the the public/protected members of a base class

virtual const TemplateInstanceList &	getTemplateInstances () const =0
	Returns a sorted dictionary with all template instances found for this template class.

virtual const ClassDef *	templateMaster () const =0
	Returns the template master of which this class is an instance.

virtual bool	isTemplate () const =0
	Returns TRUE if this class is a template.

virtual const IncludeInfo *	includeInfo () const =0

virtual const UsesClassList &	usedImplementationClasses () const =0

virtual const UsesClassList &	usedByImplementationClasses () const =0

virtual const ConstraintClassList &	templateTypeConstraints () const =0

virtual bool	isTemplateArgument () const =0

virtual ArgumentLists	getTemplateParameterLists () const =0
	Returns the template parameter lists that form the template declaration of this class.

virtual QCString	qualifiedNameWithTemplateParameters (const ArgumentLists actualParams=nullptr, uint32_t actualParamIndex=nullptr) const =0

virtual bool	isAbstract () const =0
	Returns TRUE if there is at least one pure virtual member in this class.

virtual bool	isObjectiveC () const =0
	Returns TRUE if this class is implemented in Objective-C.

virtual bool	isFortran () const =0
	Returns TRUE if this class is implemented in Fortran.

virtual bool	isCSharp () const =0
	Returns TRUE if this class is implemented in C#.

virtual bool	isFinal () const =0
	Returns TRUE if this class is marked as final.

virtual bool	isSealed () const =0
	Returns TRUE if this class is marked as sealed.

virtual bool	isPublished () const =0
	Returns TRUE if this class is marked as published.

virtual bool	isExtension () const =0
	Returns TRUE if this class represents an Objective-C 2.0 extension (nameless category)

virtual bool	isForwardDeclared () const =0
	Returns TRUE if this class represents a forward declaration of a template class.

virtual bool	isInterface () const =0
	Returns TRUE if this class represents an interface.

virtual ClassDef *	categoryOf () const =0
	Returns the class of which this is a category (Objective-C only)

virtual QCString	className () const =0
	Returns the name of the class including outer classes, but not including namespaces.

virtual MemberList *	getMemberList (MemberListType lt) const =0
	Returns the members in the list identified by lt.

virtual const MemberLists &	getMemberLists () const =0
	Returns the list containing the list of members sorted per type.

virtual const MemberGroupList &	getMemberGroups () const =0
	Returns the member groups defined for this class.

virtual const TemplateNameMap &	getTemplateBaseClassNames () const =0

virtual bool	isUsedOnly () const =0

virtual bool	isEmbeddedInOuterScope () const =0

virtual bool	isSimple () const =0

virtual const ClassDef *	tagLessReference () const =0

virtual const MemberDef *	isSmartPointer () const =0

virtual bool	isJavaEnum () const =0

virtual QCString	title () const =0

virtual QCString	generatedFromFiles () const =0

virtual const FileList &	usedFiles () const =0

virtual const ArgumentList &	typeConstraints () const =0

virtual const ExampleList &	getExamples () const =0

virtual bool	hasExamples () const =0

virtual QCString	getMemberListFileName () const =0

virtual bool	subGrouping () const =0

virtual bool	isSliceLocal () const =0

virtual bool	hasNonReferenceSuperClass () const =0

virtual QCString	requiresClause () const =0

virtual StringVector	getQualifiers () const =0

virtual bool	containsOverload (const MemberDef *md) const =0

virtual bool	isImplicitTemplateInstance () const =0

virtual int	countMembersIncludingGrouped (MemberListType lt, const ClassDef *inheritedFrom, bool additional) const =0

virtual int	countMemberDeclarations (MemberListType lt, const ClassDef *inheritedFrom, MemberListType lt2, bool invert, bool showAlways, ClassDefSet &visitedClasses) const =0

virtual ClassDef *	insertTemplateInstance (const QCString &fileName, int startLine, int startColumn, const QCString &templSpec, bool &freshInstance) const =0

virtual void	writeDeclarationLink (OutputList &ol, bool &found, const QCString &header, bool localNames) const =0

virtual void	writeDocumentation (OutputList &ol) const =0

virtual void	writeDocumentationForInnerClasses (OutputList &ol) const =0

virtual void	writeMemberPages (OutputList &ol) const =0

virtual void	writeMemberList (OutputList &ol) const =0

virtual void	writeDeclaration (OutputList &ol, const MemberDef md, bool inGroup, int indentLevel, const ClassDef inheritedFrom, const QCString &inheritId) const =0

virtual void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const =0

virtual void	writeSummaryLinks (OutputList &ol) const =0

virtual void	writeInlineDocumentation (OutputList &ol) const =0

virtual void	writeTagFile (TextStream &) const =0

virtual void	writeMemberDeclarations (OutputList &ol, ClassDefSet &visitedClasses, MemberListType lt, const QCString &title, const QCString &subTitle=QCString(), bool showInline=FALSE, const ClassDef *inheritedFrom=nullptr, MemberListType lt2=MemberListType::Invalid(), bool invert=FALSE, bool showAlways=FALSE) const =0

virtual void	addGroupedInheritedMembers (OutputList &ol, MemberListType lt, const ClassDef *inheritedFrom, const QCString &inheritId) const =0

Public Member Functions inherited from Definition
virtual DefType	definitionType () const =0

virtual CodeSymbolType	codeSymbolType () const =0

virtual bool	isAlias () const =0

virtual const QCString &	name () const =0

virtual bool	isAnonymous () const =0

virtual QCString	displayName (bool includeScope=TRUE) const =0

virtual const QCString &	localName () const =0

virtual QCString	qualifiedName () const =0

virtual QCString	symbolName () const =0

virtual QCString	getOutputFileBase () const =0

virtual QCString	anchor () const =0

virtual QCString	getSourceFileBase () const =0

virtual QCString	getSourceAnchor () const =0

virtual QCString	documentation () const =0

virtual int	docLine () const =0

virtual QCString	docFile () const =0

virtual QCString	briefDescription (bool abbreviate=FALSE) const =0

virtual QCString	briefDescriptionAsTooltip () const =0

virtual int	briefLine () const =0

virtual QCString	inbodyDocumentation () const =0

virtual QCString	inbodyFile () const =0

virtual int	inbodyLine () const =0

virtual QCString	briefFile () const =0

virtual QCString	getDefFileName () const =0

virtual QCString	getDefFileExtension () const =0

virtual int	getDefLine () const =0

virtual int	getDefColumn () const =0

virtual bool	hasDocumentation () const =0

virtual bool	hasUserDocumentation () const =0

virtual bool	isLinkableInProject () const =0

virtual bool	isLinkable () const =0

virtual bool	isVisibleInProject () const =0

virtual bool	isVisible () const =0

virtual bool	isHidden () const =0

virtual bool	isArtificial () const =0

virtual bool	isExported () const =0

virtual QCString	getReference () const =0

virtual bool	isReference () const =0

virtual QCString	externalReference (const QCString &relPath) const =0

virtual int	getStartDefLine () const =0

virtual int	getStartBodyLine () const =0

virtual int	getEndBodyLine () const =0

virtual const FileDef *	getBodyDef () const =0

virtual SrcLangExt	getLanguage () const =0
	Returns the programming language this definition was written in.

virtual const GroupList &	partOfGroups () const =0

virtual bool	isLinkableViaGroup () const =0

virtual const RefItemVector &	xrefListItems () const =0

virtual const Definition *	findInnerCompound (const QCString &name) const =0

virtual Definition *	getOuterScope () const =0

virtual const MemberVector &	getReferencesMembers () const =0

virtual const MemberVector &	getReferencedByMembers () const =0

virtual bool	hasSections () const =0

virtual bool	hasSources () const =0

virtual bool	hasBriefDescription () const =0
	returns TRUE if this class has a brief description

virtual QCString	id () const =0

virtual const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef

virtual QCString	navigationPathAsString () const =0

virtual QCString	pathFragment () const =0

virtual void	_setSymbolName (const QCString &name)=0

virtual QCString	_symbolName () const =0

Detailed Description

A abstract class representing of a compound symbol.

A compound can be a class, struct, union, interface, service, singleton, or exception.

Definition at line 103 of file classdef.h.

Member Enumeration Documentation

◆ CompoundType

enum ClassDef::CompoundType

The various compound types.

Enumerator
Class
Struct
Union
Interface
Protocol
Category
Exception
Service
Singleton

Definition at line 109 of file classdef.h.

                      { Class,     //=Entry::CLASS_SEC,
                        Struct,    //=Entry::STRUCT_SEC,
                        Union,     //=Entry::UNION_SEC,
                        Interface, //=Entry::INTERFACE_SEC,
                        Protocol,  //=Entry::PROTOCOL_SEC,
                        Category,  //=Entry::CATEGORY_SEC,
                        Exception, //=Entry::EXCEPTION_SEC
                        Service,   //=Entry::CLASS_SEC
                        Singleton, //=Entry::CLASS_SEC
                      };

Member Function Documentation

◆ addGroupedInheritedMembers()

virtual void ClassDef::addGroupedInheritedMembers	(	OutputList &	ol,
		MemberListType	lt,
		const ClassDef *	inheritedFrom,
		const QCString &	inheritId ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::addGroupedInheritedMembers(), and MemberList::writeDeclarations().

◆ baseClasses()

virtual const BaseClassList & ClassDef::baseClasses ( ) const

pure virtual

Returns the list of base classes from which this class directly inherits.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by VhdlDocGen::addBaseClass(), DotGfxHierarchyTable::addHierarchy(), ClassDefAliasImpl::baseClasses(), DotClassGraph::buildGraph(), classHasVisibleChildren(), classHasVisibleRoot(), classInheritedProtectionLevel(), computeMemberRelationsForBaseClass(), generateDEFForClass(), PerlModGenerator::generatePerlModForClass(), generateSqlite3ForClass(), generateXMLForClass(), DiagramRow::insertClass(), ClassDefImpl::mergeCategory(), minClassDistance(), trimBaseClassScope(), writeClassTreeToOutput(), and writeObjCMethodCall().

◆ categoryOf()

virtual ClassDef * ClassDef::categoryOf ( ) const

pure virtual

Returns the class of which this is a category (Objective-C only)

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by MemberDefImpl::_writeCategoryRelation(), ClassDefAliasImpl::categoryOf(), classInheritedProtectionLevel(), minClassDistance(), and writeObjCMethodCall().

◆ className()

virtual QCString ClassDef::className ( ) const

pure virtual

Returns the name of the class including outer classes, but not including namespaces.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::className(), VhdlDocGen::findAllArchitectures(), VhdlDocGen::getClassName(), makeDisplayName(), makeQualifiedNameWithTemplateParameters(), FileDefImpl::sortMemberLists(), GroupDefImpl::sortMemberLists(), ModuleDefImpl::sortMemberLists(), NamespaceDefImpl::sortMemberLists(), and VhdlDocGen::writeInlineClassLink().

◆ collaborationGraphFileName()

virtual QCString ClassDef::collaborationGraphFileName ( ) const

pure virtual

returns the file name to use for the collaboration graph

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::collaborationGraphFileName(), and DotClassGraph::DotClassGraph().

◆ compoundType()

virtual CompoundType ClassDef::compoundType ( ) const

pure virtual

Returns the type of compound this is, i.e.

class/struct/union/..

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by MemberDefImpl::_writeReimplements(), DocSets::addIndexItem(), buildInterfaceAndServiceList(), compoundIcon(), ClassDefAliasImpl::compoundType(), computeMemberRelationsForBaseClass(), createTagLessInstance(), generateLink(), FileDefImpl::insertClass(), NamespaceDefImpl::insertClass(), makeDisplayName(), ClassDefImpl::mergeMembersFromBaseClasses(), and writeClassTree().

◆ compoundTypeString()

virtual QCString ClassDef::compoundTypeString ( ) const

pure virtual

Returns the type of compound as a string.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext(), ClassDefAliasImpl::compoundTypeString(), generateDEFForClass(), PerlModGenerator::generatePerlModForClass(), generateSqlite3ForClass(), generateXMLForClass(), SearchIndex::setCurrentDoc(), MemberDefImpl::warnIfUndocumented(), and MemberDefImpl::writeDocumentation().

◆ containsOverload()

virtual bool ClassDef::containsOverload ( const MemberDef * md ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::containsOverload(), and findUsingDeclImports().

◆ countMemberDeclarations()

virtual int ClassDef::countMemberDeclarations	(	MemberListType	lt,
		const ClassDef *	inheritedFrom,
		MemberListType	lt2,
		bool	invert,
		bool	showAlways,
		ClassDefSet &	visitedClasses ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefImpl::countInheritedDecMembers(), and ClassDefAliasImpl::countMemberDeclarations().

◆ countMembersIncludingGrouped()

virtual int ClassDef::countMembersIncludingGrouped	(	MemberListType	lt,
		const ClassDef *	inheritedFrom,
		bool	additional ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::countMembersIncludingGrouped().

◆ deepCopy()

virtual std::unique_ptr< ClassDef > ClassDef::deepCopy ( const QCString & name ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

References Definition::name().

Referenced by findUsingDeclImports().

◆ generatedFromFiles()

virtual QCString ClassDef::generatedFromFiles ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::generatedFromFiles().

◆ getClasses()

virtual ClassLinkedRefMap ClassDef::getClasses ( ) const

pure virtual

returns the classes nested into this class

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassAndNestedClasses(), ClassDefImpl::addMembersToTemplateInstance(), findTagLessClasses(), PerlModGenerator::generatePerlModForClass(), generateSqlite3ForClass(), generateXMLForClass(), ClassDefAliasImpl::getClasses(), processTagLessClasses(), and writeClassTree().

◆ getExamples()

virtual const ExampleList & ClassDef::getExamples ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::getExamples().

◆ getFileDef()

virtual FileDef * ClassDef::getFileDef ( ) const

pure virtual

Returns the namespace this compound is in, or 0 if it has a global scope.

Returns the file in which this compound's definition can be found. Should not return 0 (but it might be a good idea to check anyway).

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addInstance(), createTagLessInstance(), findClassRelation(), findClassWithinClassContext(), findModuleDef(), findUsedClassesForClass(), generateClassOrGlobalLink(), generateXMLForClass(), getDefsOld(), ClassDefAliasImpl::getFileDef(), SymbolResolver::Private::isAccessibleFrom(), writeTemplateList(), and writeTemplateList().

◆ getInstanceOutputFileBase()

virtual QCString ClassDef::getInstanceOutputFileBase ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::getInstanceOutputFileBase().

◆ getMemberByName()

virtual const MemberDef * ClassDef::getMemberByName ( const QCString & ) const

pure virtual

Returns the member with the given name.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by buildFunctionList(), SymbolResolver::Private::followPath(), generateClassMemberLink(), generateClassOrGlobalLink(), ClassDefAliasImpl::getMemberByName(), setCallContextForVar(), and writeObjCMethodCall().

◆ getMemberGroups()

virtual const MemberGroupList & ClassDef::getMemberGroups ( ) const

pure virtual

Returns the member groups defined for this class.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by PerlModGenerator::generatePerlModForClass(), generateSqlite3ForClass(), generateXMLForClass(), and ClassDefAliasImpl::getMemberGroups().

◆ getMemberList()

virtual MemberList * ClassDef::getMemberList ( MemberListType lt ) const

pure virtual

Returns the members in the list identified by lt.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by createTagLessInstance(), VhdlDocGen::findAllPackages(), VhdlDocGen::findFunction(), VhdlDocGen::findMemberDef(), generateDEFForClass(), PerlModGenerator::generatePerlModForClass(), ClassDefAliasImpl::getMemberList(), and processTagLessClasses().

◆ getMemberListFileName()

virtual QCString ClassDef::getMemberListFileName ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::getMemberListFileName().

◆ getMemberLists()

virtual const MemberLists & ClassDef::getMemberLists ( ) const

pure virtual

Returns the list containing the list of members sorted per type.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateDEFForClass(), generateSqlite3ForClass(), generateXMLForClass(), and ClassDefAliasImpl::getMemberLists().

◆ getModuleDef()

virtual ModuleDef * ClassDef::getModuleDef ( ) const

pure virtual

Returns the C++20 module in which this compound's definition can be found.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::getModuleDef().

◆ getQualifiers()

virtual StringVector ClassDef::getQualifiers ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateXMLForClass(), and ClassDefAliasImpl::getQualifiers().

◆ getTemplateBaseClassNames()

virtual const TemplateNameMap & ClassDef::getTemplateBaseClassNames ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by computeTemplateClassRelations(), and ClassDefAliasImpl::getTemplateBaseClassNames().

◆ getTemplateInstances()

virtual const TemplateInstanceList & ClassDef::getTemplateInstances ( ) const

pure virtual

Returns a sorted dictionary with all template instances found for this template class.

Returns 0 if not a template or no instances.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DotClassGraph::buildGraph(), computeTemplateClassRelations(), ClassDefAliasImpl::getTemplateInstances(), and hasNonReferenceSuperClassRec().

◆ getTemplateParameterLists()

virtual ArgumentLists ClassDef::getTemplateParameterLists ( ) const

pure virtual

Returns the template parameter lists that form the template declaration of this class.

Example: template<class T> class TC {} = 0; will return a list with one ArgumentList containing one argument with type="class" and name="T".

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addMemberFunction(), ClassDefAliasImpl::getTemplateParameterLists(), and MemberDefImpl::writeDocumentation().

◆ hasDetailedDescription()

virtual bool ClassDef::hasDetailedDescription ( ) const

pure virtual

returns TRUE if this class has a non-empty detailed description

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::hasDetailedDescription().

◆ hasExamples()

virtual bool ClassDef::hasExamples ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::hasExamples().

◆ hasNonReferenceSuperClass()

virtual bool ClassDef::hasNonReferenceSuperClass ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::hasNonReferenceSuperClass().

◆ includeInfo()

virtual const IncludeInfo * ClassDef::includeInfo ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DocSets::addIndexItem(), PerlModGenerator::generatePerlModForClass(), generateSqlite3ForClass(), generateXMLForClass(), and ClassDefAliasImpl::includeInfo().

◆ inheritanceGraphFileName()

virtual QCString ClassDef::inheritanceGraphFileName ( ) const

pure virtual

returns the file name to use for the inheritance graph

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DotClassGraph::DotClassGraph(), and ClassDefAliasImpl::inheritanceGraphFileName().

◆ insertTemplateInstance()

virtual ClassDef * ClassDef::insertTemplateInstance	(	const QCString &	fileName,
		int	startLine,
		int	startColumn,
		const QCString &	templSpec,
		bool &	freshInstance ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by findTemplateInstanceRelation(), and ClassDefAliasImpl::insertTemplateInstance().

◆ isAbstract()

virtual bool ClassDef::isAbstract ( ) const

pure virtual

Returns TRUE if there is at least one pure virtual member in this class.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateXMLForClass(), and ClassDefAliasImpl::isAbstract().

◆ isAccessibleMember()

virtual bool ClassDef::isAccessibleMember ( const MemberDef * md ) const

pure virtual

returns TRUE iff md is a member of this class or of the the public/protected members of a base class

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isAccessibleMember().

◆ isBaseClass()

virtual int ClassDef::isBaseClass	(	const ClassDef *	bcd,
		bool	followInstances,
		const QCString &	templSpec = QCString() ) const

pure virtual

Returns TRUE iff bcd is a direct or indirect base class of this class.

This function will recursively traverse all branches of the inheritance tree.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addInstance(), findClassRelation(), findMemberLink(), ClassDefAliasImpl::isBaseClass(), ClassDefImpl::isBaseClass(), MemberDefImpl::isReimplementedBy(), VhdlDocGen::isSubClass(), and ClassDefImpl::mergeMembersFromBaseClasses().

◆ isCSharp()

virtual bool ClassDef::isCSharp ( ) const

pure virtual

Returns TRUE if this class is implemented in C#.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by findClassRelation(), and ClassDefAliasImpl::isCSharp().

◆ isEmbeddedInOuterScope()

virtual bool ClassDef::isEmbeddedInOuterScope ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassAndNestedClasses(), and ClassDefAliasImpl::isEmbeddedInOuterScope().

◆ isExtension()

virtual bool ClassDef::isExtension ( ) const

pure virtual

Returns TRUE if this class represents an Objective-C 2.0 extension (nameless category)

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isExtension(), and ClassDefImpl::mergeCategory().

◆ isFinal()

virtual bool ClassDef::isFinal ( ) const

pure virtual

Returns TRUE if this class is marked as final.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateXMLForClass(), and ClassDefAliasImpl::isFinal().

◆ isFortran()

virtual bool ClassDef::isFortran ( ) const

pure virtual

Returns TRUE if this class is implemented in Fortran.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isFortran().

◆ isForwardDeclared()

virtual bool ClassDef::isForwardDeclared ( ) const

pure virtual

Returns TRUE if this class represents a forward declaration of a template class.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext(), and ClassDefAliasImpl::isForwardDeclared().

◆ isImplicitTemplateInstance()

virtual bool ClassDef::isImplicitTemplateInstance ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by Index::addClassMemberNameToIndex(), ClassDefAliasImpl::isImplicitTemplateInstance(), and writeClassTree().

◆ isInterface()

virtual bool ClassDef::isInterface ( ) const

pure virtual

Returns TRUE if this class represents an interface.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isInterface(), and ClassDefImpl::writeIncludeFilesForSlice().

◆ isJavaEnum()

virtual bool ClassDef::isJavaEnum ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isJavaEnum(), ClassDefMutable::sortAllMembersList(), and MemberList::writeSimpleDocumentation().

◆ isLocal()

virtual bool ClassDef::isLocal ( ) const

pure virtual

Returns TRUE if this is a local class definition, see EXTRACT_LOCAL_CLASSES.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isLocal(), and ClassDefImpl::mergeCategory().

◆ isObjectiveC()

virtual bool ClassDef::isObjectiveC ( ) const

pure virtual

Returns TRUE if this class is implemented in Objective-C.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by MemberDefImpl::displayDefinition(), ClassDefAliasImpl::isObjectiveC(), MemberDefImpl::writeDocumentation(), and ClassDefImpl::writeMemberList().

◆ isPublished()

virtual bool ClassDef::isPublished ( ) const

pure virtual

Returns TRUE if this class is marked as published.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isPublished().

◆ isSealed()

virtual bool ClassDef::isSealed ( ) const

pure virtual

Returns TRUE if this class is marked as sealed.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateXMLForClass(), and ClassDefAliasImpl::isSealed().

◆ isSimple()

virtual bool ClassDef::isSimple ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by MemberDefImpl::getOutputFileBase(), MemberDefImpl::isDetailedSectionVisible(), ClassDefAliasImpl::isSimple(), and writeClassTree().

◆ isSliceLocal()

virtual bool ClassDef::isSliceLocal ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isSliceLocal().

◆ isSmartPointer()

virtual const MemberDef * ClassDef::isSmartPointer ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::isSmartPointer().

◆ isSubClass()

virtual bool ClassDef::isSubClass	(	ClassDef *	bcd,
		int	level = 0 ) const

pure virtual

Returns TRUE iff bcd is a direct or indirect sub class of this class.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by findClassRelation(), ClassDefAliasImpl::isSubClass(), and ClassDefImpl::isSubClass().

◆ isTemplate()

virtual bool ClassDef::isTemplate ( ) const

pure virtual

Returns TRUE if this class is a template.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DocSets::addIndexItem(), flushCachedTemplateRelations(), getCanonicalTypeForIdentifier(), ClassDefAliasImpl::isTemplate(), and SymbolResolver::Private::newResolveTypedef().

◆ isTemplateArgument()

virtual bool ClassDef::isTemplateArgument ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedType(), and ClassDefAliasImpl::isTemplateArgument().

◆ isUsedOnly()

virtual bool ClassDef::isUsedOnly ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by getCanonicalTypeForIdentifier(), and ClassDefAliasImpl::isUsedOnly().

◆ isVisibleInHierarchy()

virtual bool ClassDef::isVisibleInHierarchy ( ) const

pure virtual

the class is visible in a class diagram, or class hierarchy

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DotGfxHierarchyTable::addHierarchy(), classHasVisibleRoot(), ClassDefImpl::countInheritedByNodes(), ClassDefImpl::countInheritsNodes(), DiagramRow::insertClass(), ClassDefAliasImpl::isVisibleInHierarchy(), writeClassTreeToOutput(), and ClassDefImpl::writeInheritanceGraph().

◆ memberNameInfoLinkedMap()

virtual const MemberNameInfoLinkedMap & ClassDef::memberNameInfoLinkedMap ( ) const

pure virtual

Returns a dictionary of all members.

This includes any inherited members. Members are sorted alphabetically.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by PerlModGenerator::addListOfAllMembers(), ClassDefImpl::addMembersToTemplateInstance(), associateAllClassMembers(), computeClassRelations(), computeMemberRelationsForBaseClass(), findUsedClassesForClass(), findUsingDeclImports(), ClassDefAliasImpl::memberNameInfoLinkedMap(), ClassDefImpl::mergeCategory(), ClassDefImpl::mergeMembersFromBaseClasses(), and writeListOfAllMembers().

◆ moveTo()

virtual void ClassDef::moveTo ( Definition * )

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by findUsingDeclImports().

◆ protection()

virtual Protection ClassDef::protection ( ) const

pure virtual

Return the protection level (Public,Protected,Private) in which this compound was found.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassAndNestedClasses(), VhdlDocGen::findMember(), generateMemLink(), generateSqlite3ForClass(), generateXMLForClass(), VhdlDocGen::getClassName(), getSpecifierTypeFromClass(), ClassDefImpl::insertSubClass(), ClassDefAliasImpl::protection(), writeClassTree(), writeClassTreeToOutput(), VhdlDocGen::writeInlineClassLink(), and VhdlDocGen::writeVHDLDeclaration().

◆ qualifiedNameWithTemplateParameters()

virtual QCString ClassDef::qualifiedNameWithTemplateParameters	(	const ArgumentLists *	actualParams = nullptr,
		uint32_t *	actualParamIndex = nullptr ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addMemberFunction(), addMethodToClass(), addVariableToClass(), findMember(), getCanonicalTypeForIdentifier(), makeDisplayName(), and makeQualifiedNameWithTemplateParameters().

◆ requiresClause()

virtual QCString ClassDef::requiresClause ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext(), generateXMLForClass(), and ClassDefAliasImpl::requiresClause().

◆ subClasses()

virtual const BaseClassList & ClassDef::subClasses ( ) const

pure virtual

Returns the list of sub classes that directly derive from this class.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DotGfxHierarchyTable::addHierarchy(), DotClassGraph::buildGraph(), classHasVisibleChildren(), generateDEFForClass(), PerlModGenerator::generatePerlModForClass(), generateSqlite3ForClass(), generateXMLForClass(), hasNonReferenceSuperClassRec(), DiagramRow::insertClass(), VhdlDocGen::isSubClass(), ClassDefAliasImpl::subClasses(), and writeClassTreeToOutput().

◆ subGrouping()

virtual bool ClassDef::subGrouping ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::subGrouping().

◆ tagLessReference()

virtual const ClassDef * ClassDef::tagLessReference ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::tagLessReference().

◆ templateArguments()

virtual const ArgumentList & ClassDef::templateArguments ( ) const

pure virtual

Returns the template arguments of this class.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassToContext(), ClassDefImpl::addMembersToTemplateInstance(), ClassDefMutable::addMembersToTemplateInstance(), addTemplateList(), computeTemplateClassRelations(), findBaseClassesForClass(), findTemplateInstanceRelation(), findUsedClassesForClass(), getTemplateArgumentsFromName(), insertTemplateSpecifierInScope(), makeQualifiedNameWithTemplateParameters(), SymbolResolver::Private::newResolveTypedef(), resolveTemplateInstanceInType(), searchTemplateSpecs(), ClassDefAliasImpl::templateArguments(), writeTemplateList(), and writeTemplateList().

◆ templateMaster()

virtual const ClassDef * ClassDef::templateMaster ( ) const

pure virtual

Returns the template master of which this class is an instance.

Returns 0 if not applicable.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by addClassAndNestedClasses(), addMemberToSearchIndex(), DotClassGraph::buildGraph(), generateDEFForClass(), PerlModGenerator::generatePerlModForClass(), generateSqlite3ForClass(), generateXMLForClass(), ClassDefImpl::isBaseClass(), VhdlDocGen::isSubClass(), makeTemplateInstanceRelation(), and ClassDefAliasImpl::templateMaster().

◆ templateTypeConstraints()

virtual const ConstraintClassList & ClassDef::templateTypeConstraints ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DotClassGraph::buildGraph(), and ClassDefAliasImpl::templateTypeConstraints().

◆ title()

virtual QCString ClassDef::title ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateSqlite3ForClass(), ClassDefAliasImpl::title(), and writeMemberDeclarations().

◆ typeConstraints()

virtual const ArgumentList & ClassDef::typeConstraints ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::typeConstraints().

◆ updateBaseClasses()

virtual void ClassDef::updateBaseClasses ( const BaseClassList & bcd )

pure virtual

Update the list of base classes to the one passed.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by VhdlDocGen::addBaseClass().

◆ updateSubClasses()

virtual void ClassDef::updateSubClasses ( const BaseClassList & bcd )

pure virtual

Update the list of sub classes to the one passed.

Implemented in ClassDefAliasImpl, and ClassDefImpl.

◆ usedByImplementationClasses()

virtual const UsesClassList & ClassDef::usedByImplementationClasses ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DotClassGraph::buildGraph(), and ClassDefAliasImpl::usedByImplementationClasses().

◆ usedFiles()

virtual const FileList & ClassDef::usedFiles ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::usedFiles().

◆ usedImplementationClasses()

virtual const UsesClassList & ClassDef::usedImplementationClasses ( ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by DotClassGraph::buildGraph(), and ClassDefAliasImpl::usedImplementationClasses().

◆ visibleInParentsDeclList()

virtual bool ClassDef::visibleInParentsDeclList ( ) const

pure virtual

show this class in the declaration section of its parent?

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::visibleInParentsDeclList().

◆ writeDeclaration()

virtual void ClassDef::writeDeclaration	(	OutputList &	ol,
		const MemberDef *	md,
		bool	inGroup,
		int	indentLevel,
		const ClassDef *	inheritedFrom,
		const QCString &	inheritId ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::writeDeclaration(), and MemberDefImpl::writeDeclaration().

◆ writeDeclarationLink()

virtual void ClassDef::writeDeclarationLink	(	OutputList &	ol,
		bool &	found,
		const QCString &	header,
		bool	localNames ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

References found.

Referenced by ClassDefAliasImpl::writeDeclarationLink().

◆ writeDocumentation()

virtual void ClassDef::writeDocumentation ( OutputList & ol ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateNamespaceClassDocs(), and ClassDefAliasImpl::writeDocumentation().

◆ writeDocumentationForInnerClasses()

virtual void ClassDef::writeDocumentationForInnerClasses ( OutputList & ol ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateNamespaceClassDocs(), and ClassDefAliasImpl::writeDocumentationForInnerClasses().

◆ writeInlineDocumentation()

virtual void ClassDef::writeInlineDocumentation ( OutputList & ol ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::writeInlineDocumentation().

◆ writeMemberDeclarations()

virtual void ClassDef::writeMemberDeclarations	(	OutputList &	ol,
		ClassDefSet &	visitedClasses,
		MemberListType	lt,
		const QCString &	title,
		const QCString &	subTitle = QCString(),
		bool	showInline = FALSE,
		const ClassDef *	inheritedFrom = nullptr,
		MemberListType	lt2 = MemberListType::Invalid(),
		bool	invert = FALSE,
		bool	showAlways = FALSE ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

References FALSE, MemberListType::Invalid(), and title().

Referenced by ClassDefImpl::writeInheritedMemberDeclarations(), and ClassDefAliasImpl::writeMemberDeclarations().

◆ writeMemberList()

virtual void ClassDef::writeMemberList ( OutputList & ol ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by generateNamespaceClassDocs(), and ClassDefAliasImpl::writeMemberList().

◆ writeMemberPages()

virtual void ClassDef::writeMemberPages ( OutputList & ol ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::writeMemberPages().

◆ writeQuickMemberLinks()

virtual void ClassDef::writeQuickMemberLinks	(	OutputList &	ol,
		const MemberDef *	md ) const

pure virtual

Implemented in ClassDefAliasImpl, ClassDefImpl, and DefinitionMixin< ClassDefMutable >.

Referenced by ClassDefAliasImpl::writeQuickMemberLinks().

◆ writeSummaryLinks()

virtual void ClassDef::writeSummaryLinks ( OutputList & ol ) const

pure virtual

Implemented in ClassDefAliasImpl, ClassDefImpl, and DefinitionMixin< ClassDefMutable >.

Referenced by ClassDefAliasImpl::writeSummaryLinks().

◆ writeTagFile()

virtual void ClassDef::writeTagFile ( TextStream & ) const

pure virtual

Implemented in ClassDefAliasImpl, and ClassDefImpl.

Referenced by ClassDefAliasImpl::writeTagFile(), and writeTagFile().

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

src/classdef.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ CompoundType

Member Function Documentation

◆ addGroupedInheritedMembers()

◆ baseClasses()

◆ categoryOf()

◆ className()

◆ collaborationGraphFileName()

◆ compoundType()

◆ compoundTypeString()

◆ containsOverload()

◆ countMemberDeclarations()

◆ countMembersIncludingGrouped()

◆ deepCopy()

◆ generatedFromFiles()

◆ getClasses()

◆ getExamples()

◆ getFileDef()

◆ getInstanceOutputFileBase()

◆ getMemberByName()

◆ getMemberGroups()

◆ getMemberList()

◆ getMemberListFileName()

◆ getMemberLists()

◆ getModuleDef()

◆ getQualifiers()

◆ getTemplateBaseClassNames()

◆ getTemplateInstances()

◆ getTemplateParameterLists()

◆ hasDetailedDescription()

◆ hasExamples()

◆ hasNonReferenceSuperClass()

◆ includeInfo()

◆ inheritanceGraphFileName()

◆ insertTemplateInstance()

◆ isAbstract()

◆ isAccessibleMember()

◆ isBaseClass()

◆ isCSharp()

◆ isEmbeddedInOuterScope()

◆ isExtension()

◆ isFinal()

◆ isFortran()

◆ isForwardDeclared()

◆ isImplicitTemplateInstance()

◆ isInterface()

◆ isJavaEnum()

◆ isLocal()

◆ isObjectiveC()

◆ isPublished()

◆ isSealed()

◆ isSimple()

◆ isSliceLocal()

◆ isSmartPointer()

◆ isSubClass()

◆ isTemplate()

◆ isTemplateArgument()

◆ isUsedOnly()

◆ isVisibleInHierarchy()

◆ memberNameInfoLinkedMap()

◆ moveTo()

◆ protection()

◆ qualifiedNameWithTemplateParameters()

◆ requiresClause()

◆ subClasses()

◆ subGrouping()

◆ tagLessReference()

◆ templateArguments()

◆ templateMaster()

◆ templateTypeConstraints()

◆ title()

◆ typeConstraints()

◆ updateBaseClasses()

◆ updateSubClasses()

◆ usedByImplementationClasses()

◆ usedFiles()

◆ usedImplementationClasses()