ClassDefImpl Class Reference

Implementation of the ClassDef interface. More...

Inheritance diagram for ClassDefImpl:

Collaboration diagram for ClassDefImpl:

Public Member Functions
	ClassDefImpl (const DString &fileName, int startLine, size_t startColumn, const DString &name, CompoundType ct, const DString &ref=DString(), const DString &fName=DString(), bool isSymbol=true, bool isJavaEnum=false)
DefType	definitionType () const override
std::unique_ptr< ClassDef >	deepCopy (const DString &name) const override
void	moveTo (Definition *) override
CodeSymbolType	codeSymbolType () const override
DString	getOutputFileBase () const override
DString	getInstanceOutputFileBase () const override
DString	getSourceFileBase () const override
DString	getReference () const override
bool	isReference () const override
bool	isLocal () const override
	Returns true if this is a local class definition, see EXTRACT_LOCAL_CLASSES.
ClassLinkedRefMap	getClasses () const override
	returns the classes nested into this class
bool	hasDocumentation () const override
bool	hasDetailedDescription () const override
	returns true if this class has a non-empty detailed description
DString	collaborationGraphFileName () const override
	returns the file name to use for the collaboration graph
DString	inheritanceGraphFileName () const override
	returns the file name to use for the inheritance graph
DString	displayName (bool includeScope=true) const override
CompoundType	compoundType () const override
	Returns the type of compound this is, i.e. class/struct/union/...
DString	compoundTypeString () const override
	Returns the type of compound as a string.
const BaseClassList &	baseClasses () const override
	Returns the list of base classes from which this class directly inherits.
void	updateBaseClasses (const BaseClassList &bcd) override
	Update the list of base classes to the one passed.
const BaseClassList &	subClasses () const override
	Returns the list of sub classes that directly derive from this class.
void	updateSubClasses (const BaseClassList &bcd) override
	Update the list of sub classes to the one passed.
const MemberNameInfoLinkedMap &	memberNameInfoLinkedMap () const override
	Returns a dictionary of all members.
Protection	protection () const override
	Return the protection level (Public,Protected,Private) in which this compound was found.
bool	isLinkableInProject () const override
bool	isLinkable () const override
bool	isVisibleInHierarchy () const override
bool	visibleInParentsDeclList () const override
	show this class in the declaration section of its parent?
const ArgumentList &	templateArguments () const override
	Returns the template arguments of this class.
FileDef *	getFileDef () const override
	Returns the file in which this compound's definition can be found.
ModuleDef *	getModuleDef () const override
	Returns the C++20 module in which this compound's definition can be found.
const MemberDef *	getMemberByName (const DString &) const override
	Returns the member with the given name.
int	isBaseClass (const ClassDef *bcd, bool followInstances, const DString &templSpec) const override
	Returns true iff bcd is a direct or indirect base class of this class.
bool	isSubClass (ClassDef *bcd, int level=0) const override
	Returns true iff bcd is a direct or indirect sub class of this class.
bool	isAccessibleMember (const MemberDef *md) const override
	returns true iff md is a member of this class or of the the public/protected members of a base class
const TemplateInstanceList &	getTemplateInstances () const override
	Returns a sorted dictionary with all template instances found for this template class.
const ClassDef *	templateMaster () const override
	Returns the template master of which this class is an instance.
bool	isTemplate () const override
	Returns true if this class is a template.
const IncludeInfo *	includeInfo () const override
const UsesClassList &	usedImplementationClasses () const override
const UsesClassList &	usedByImplementationClasses () const override
const ConstraintClassList &	templateTypeConstraints () const override
bool	isTemplateArgument () const override
const Definition *	findInnerCompound (const DString &name) const override
ArgumentLists	getTemplateParameterLists () const override
	Returns the template parameter lists that form the template declaration of this class.
DString	qualifiedNameWithTemplateParameters (const ArgumentLists *actualParams=nullptr, uint32_t *actualParamIndex=nullptr) const override
bool	isAbstract () const override
	Returns true if there is at least one pure virtual member in this class.
bool	isObjectiveC () const override
	Returns true if this class is implemented in Objective-C.
bool	isFortran () const override
	Returns true if this class is implemented in Fortran.
bool	isCSharp () const override
	Returns true if this class is implemented in C#.
bool	isFinal () const override
	Returns true if this class is marked as final.
bool	isSealed () const override
	Returns true if this class is marked as sealed.
bool	isPublished () const override
	Returns true if this class is marked as published.
bool	isExtension () const override
	Returns true if this class represents an Objective-C 2.0 extension (nameless category).
bool	isForwardDeclared () const override
	Returns true if this class represents a forward declaration of a template class.
bool	isInterface () const override
	Returns true if this class represents an interface.
ClassDef *	categoryOf () const override
	Returns the class of which this is a category (Objective-C only).
DString	className () const override
	Returns the name of the class including outer classes, but not including namespaces.
MemberList *	getMemberList (MemberListType lt) const override
	Returns the members in the list identified by lt.
const MemberLists &	getMemberLists () const override
	Returns the list containing the list of members sorted per type.
const MemberGroupList &	getMemberGroups () const override
	Returns the member groups defined for this class.
const TemplateNameMap &	getTemplateBaseClassNames () const override
bool	isUsedOnly () const override
DString	anchor () const override
bool	isEmbeddedInOuterScope () const override
bool	isSimple () const override
const ClassDef *	taglessParent () const override
bool	hasNamedVariable () const override
const MemberDef *	isSmartPointer () const override
bool	isJavaEnum () const override
DString	title () const override
DString	generatedFromFiles () const override
const FileList &	usedFiles () const override
const ArgumentList &	typeConstraints () const override
const ExampleList &	getExamples () const override
bool	hasExamples () const override
DString	getMemberListFileName () const override
bool	subGrouping () const override
bool	isSliceLocal () const override
bool	hasNonReferenceSuperClass () const override
DString	requiresClause () const override
StringVector	getQualifiers () const override
bool	containsOverload (const MemberDef *md) const override
bool	isImplicitTemplateInstance () const override
ClassDef *	insertTemplateInstance (const DString &fileName, int startLine, size_t startColumn, const DString &templSpec, bool &freshInstance) override
void	insertBaseClass (ClassDef *, const DString &name, Protection p, Specifier s, const DString &t=DString()) override
void	insertSubClass (ClassDef *, Protection p, Specifier s, const DString &t=DString()) override
void	insertExplicitTemplateInstance (ClassDef *instance, const DString &spec) override
void	setIncludeFile (FileDef *fd, const DString &incName, bool local, bool force) override
void	insertMember (MemberDef *) override
void	insertUsedFile (const FileDef *) override
bool	addExample (const DString &anchor, const DString &name, const DString &file) override
void	mergeCategory (ClassDef *category) override
void	setFileDef (FileDef *fd) override
void	setModuleDef (ModuleDef *mod) override
void	setSubGrouping (bool enabled) override
void	setProtection (Protection p) override
void	setGroupDefForAllMembers (GroupDef *g, Grouping::GroupPri_t pri, const DString &fileName, int startLine, bool hasDocs) override
void	addInnerCompound (Definition *d) override
void	addUsedClass (ClassDef *cd, const DString &accessName, Protection prot) override
void	addUsedByClass (ClassDef *cd, const DString &accessName, Protection prot) override
void	setIsStatic (bool b) override
void	setCompoundType (CompoundType t) override
void	setClassName (const DString &name) override
void	setClassSpecifier (TypeSpecifier spec) override
void	addQualifiers (const StringVector &qualifiers) override
void	setTemplateArguments (const ArgumentList &al) override
void	setTemplateBaseClassNames (const TemplateNameMap &templateNames) override
void	setTemplateMaster (const ClassDef *tm) override
void	setImplicitTemplateInstance (bool b) override
void	setTypeConstraints (const ArgumentList &al) override
void	addMemberToTemplateInstance (const MemberDef *md, const ArgumentList &templateArguments, const DString &templSpec) override
void	addMembersToTemplateInstance (const ClassDef *cd, const ArgumentList &templateArguments, const DString &templSpec) override
void	makeTemplateArgument (bool b=true) override
void	setCategoryOf (ClassDef *cd) override
void	setUsedOnly (bool b) override
void	setTaglessParent (const ClassDef *cd) override
void	setHasNamedVariable (bool b) override
void	setMetaData (const DString &md) override
void	findSectionsInDocumentation () override
void	addMembersToMemberGroup () override
void	addListReferences () override
void	addRequirementReferences () override
void	addTypeConstraints () override
void	computeAnchors () override
void	mergeMembers () override
void	sortMemberLists () override
void	distributeMemberGroupDocumentation () override
void	writeDocumentation (OutputList &ol) const override
void	writeDocumentationForInnerClasses (OutputList &ol) const override
void	writeMemberPages (OutputList &ol) const override
void	writeMemberList (OutputList &ol) const override
void	writeDeclaration (OutputList &ol, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const DString &inheritId) const override
void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
void	writePageNavigation (OutputList &ol) const override
void	writeSummaryLinks (OutputList &ol) const override
void	reclassifyMember (MemberDefMutable *md, MemberType t) override
void	writeInlineDocumentation (OutputList &ol) const override
	Write class documentation inside another container (i.e. a group).
void	writeDeclarationLink (OutputList &ol, bool &found, const DString &header, bool localNames) const override
void	removeMemberFromLists (MemberDef *md) override
void	setAnonymousEnumType () override
void	countMembers () override
void	sortAllMembersList () override
void	addGroupedInheritedMembers (OutputList &ol, MemberListType lt, const ClassDef *inheritedFrom, const DString &inheritId) const override
void	writeTagFile (TextStream &) const override
int	countMembersIncludingGrouped (MemberListType lt, const ClassDef *inheritedFrom, bool additional) const override
int	countMemberDeclarations (MemberListType lt, const ClassDef *inheritedFrom, MemberListType lt2, bool invert, bool showAlways, ClassDefSet &visitedClasses) const override
void	writeMemberDeclarations (OutputList &ol, ClassDefSet &visitedClasses, MemberListType lt, const DString &title, const DString &subTitle=DString(), bool showInline=false, const ClassDef *inheritedFrom=nullptr, MemberListType lt2=MemberListType::Invalid(), bool invert=false, bool showAlways=false) const override
void	setRequiresClause (const DString &req) override
void	setPrimaryConstructorParams (const ArgumentList &list) override
CLASS_GRAPH_t	hasInheritanceGraph () const override
void	overrideInheritanceGraph (CLASS_GRAPH_t e) override
bool	hasCollaborationGraph () const override
void	overrideCollaborationGraph (bool e) override
Public Member Functions inherited from DefinitionMixin< ClassDefMutable >
	DefinitionMixin (const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
DefinitionMixin &	operator= (const DefinitionMixin &other)
	~DefinitionMixin () override=default
bool	isAlias () const override
const DString &	name () const override
bool	isAnonymous () const override
const DString &	localName () const override
DString	qualifiedName () const override
DString	symbolName () const override
DString	getSourceFileBase () const override
DString	getSourceAnchor () const override
DString	documentation () const override
int	docLine () const override
DString	docFile () const override
DString	briefDescription (bool abbreviate=false) const override
DString	briefDescriptionAsTooltip () const override
int	briefLine () const override
DString	inbodyDocumentation () const override
DString	inbodyFile () const override
int	inbodyLine () const override
DString	briefFile () const override
DString	getDefFileName () const override
DString	getDefFileExtension () const override
int	getDefLine () const override
size_t	getDefColumn () const override
bool	hasDocumentation () const override
bool	hasUserDocumentation () const override
bool	isVisibleInProject () const override
bool	isVisible () const override
bool	isHidden () const override
bool	isArtificial () const override
bool	isExported () const override
DString	getReference () const override
bool	isReference () const override
DString	externalReference (const DString &relPath) const override
int	getStartDefLine () const override
int	getStartBodyLine () const override
int	getEndBodyLine () const override
const FileDef *	getBodyDef () const override
SrcLangExt	getLanguage () const override
const GroupList &	partOfGroups () const override
bool	isLinkableViaGroup () const override
const RefItemVector &	xrefListItems () const override
const RequirementRefs &	requirementReferences () const override
const Definition *	findInnerCompound (const DString &name) const override
Definition *	getOuterScope () const override
const MemberVector &	getReferencesMembers () const override
const MemberVector &	getReferencedByMembers () const override
bool	hasSections () const override
bool	hasSources () const override
bool	hasBriefDescription () const override
DString	id () const override
const SectionRefs &	getSectionRefs () const override
void	setName (const DString &name) override
void	setId (const DString &name) override
void	setDefFile (const DString &df, int defLine, size_t defColumn) override
void	setDocumentation (const DString &doc, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
void	setBriefDescription (const DString &brief, const DString &briefFile, int briefLine) override
void	setInbodyDocumentation (const DString &doc, const DString &docFile, int docLine) override
void	setReference (const DString &r) override
void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override
void	setBodySegment (int defLine, int bls, int ble) override
void	setBodyDef (const FileDef *fd) override
void	addSourceReferencedBy (MemberDef *md, const DString &sourceRefName) override
void	addSourceReferences (MemberDef *md, const DString &sourceRefName) override
void	setRefItems (const RefItemVector &sli) override
void	setRequirementReferences (const RequirementRefs &rqli) override
void	mergeRefItems (Definition *def) override
void	mergeReferences (const Definition *other) override
void	mergeReferencedBy (const Definition *other) override
void	addInnerCompound (Definition *def) override
void	setOuterScope (Definition *def) override
void	setHidden (bool b) override
void	setArtificial (bool b) override
void	setExported (bool b) override
void	setLanguage (SrcLangExt lang) override
void	writeSourceDef (OutputList &ol) const override
void	writeInlineCode (OutputList &ol, const DString &scopeName) const override
bool	hasSourceRefs () const override
bool	hasSourceReffedBy () const override
void	writeSourceRefs (OutputList &ol, const DString &scopeName) const override
void	writeSourceReffedBy (OutputList &ol, const DString &scopeName) const override
bool	hasRequirementRefs () const override
void	writeRequirementRefs (OutputList &ol) const override
void	makePartOfGroup (GroupDef *gd) override
void	writeNavigationPath (OutputList &ol) const override
DString	navigationPathAsString () const override
void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const override
void	writeSummaryLinks (OutputList &ol) const override
void	writePageNavigation (OutputList &ol) const override
DString	pathFragment () const override
void	writeDocAnchorsToTagFile (TextStream &fs) const override
void	setLocalName (const DString &name) override
void	writeToc (OutputList &ol, const LocalToc &lt) const override
void	computeTooltip () override
void	_setSymbolName (const DString &name) override
DString	_symbolName () const override

Private Member Functions
int	countInheritedByNodes () const
int	countInheritsNodes () const
int	countInheritanceNodes () const
void	addUsedInterfaceClasses (MemberDef *md, const DString &typeStr)
void	showUsedFiles (OutputList &ol) const
void	writeDocumentationContents (OutputList &ol, const DString &pageTitle) const
void	internalInsertMember (MemberDef *md, Protection prot, bool addToAllList)
void	addMemberToList (MemberListType lt, MemberDef *md, bool isBrief)
void	writeInheritedMemberDeclarations (OutputList &ol, ClassDefSet &visitedClasses, MemberListType lt, MemberListType lt2, const DString &title, const ClassDef *inheritedFrom, bool invert, bool showAlways) const
void	writeMemberDocumentation (OutputList &ol, MemberListType lt, const DString &title, bool showInline=false) const
void	writeSimpleMemberDocumentation (OutputList &ol, MemberListType lt) const
void	writePlainMemberDeclaration (OutputList &ol, MemberListType lt, bool inGroup, int indentLevel, const ClassDef *inheritedFrom, const DString &inheritId) const
void	writeBriefDescription (OutputList &ol, bool exampleFlag) const
void	writeDetailedDescription (OutputList &ol, const DString &pageType, bool exampleFlag, const DString &title, const DString &anchor=DString()) const
void	writeIncludeFiles (OutputList &ol) const
void	writeIncludeFilesForSlice (OutputList &ol) const
void	writeInheritanceGraph (OutputList &ol) const
void	writeCollaborationGraph (OutputList &ol) const
void	writeMemberGroups (OutputList &ol, bool showInline=false) const
void	writeNestedClasses (OutputList &ol, const DString &title) const
void	writeInlineClasses (OutputList &ol) const
void	startMemberDeclarations (OutputList &ol) const
void	endMemberDeclarations (OutputList &ol) const
void	startMemberDocumentation (OutputList &ol) const
void	endMemberDocumentation (OutputList &ol) const
void	writeAuthorSection (OutputList &ol) const
void	writeMoreLink (OutputList &ol, const DString &anchor) const
void	writeDetailedDocumentationBody (OutputList &ol) const
int	countAdditionalInheritedMembers () const
void	writeAdditionalInheritedMembers (OutputList &ol) const
void	addClassAttributes (OutputList &ol) const
int	countInheritedDecMembers (MemberListType lt, const ClassDef *inheritedFrom, bool invert, bool showAlways, ClassDefSet &visitedClasses) const
void	getTitleForMemberListType (MemberListType type, DString &title, DString &subtitle) const
void	addTypeConstraint (const DString &typeConstraint, const DString &type)
void	writeTemplateSpec (OutputList &ol, const Definition *d, const DString &type, SrcLangExt lang) const
void	mergeMembersFromBaseClasses (bool mergeVirtualBaseClass)
void	hideDerivedVariablesInPython (ClassDefMutable *cls)

Private Attributes
DString	m_fileName
DString	m_memberListFileName
DString	m_collabFileName
DString	m_inheritFileName
std::unique_ptr< IncludeInfo >	m_incInfo
BaseClassList	m_inherits
BaseClassList	m_inheritedBy
FileDef *	m_fileDef = nullptr
ModuleDef *	m_moduleDef = nullptr
MemberNameInfoLinkedMap	m_allMemberNameInfoLinkedMap
ArgumentList	m_tempArgs
ArgumentList	m_typeConstraints
FileList	m_files
ExampleList	m_examples
ClassDef::CompoundType	m_compType
Protection	m_prot
ClassLinkedRefMap	m_innerClasses
UsesClassList	m_usesImplClassList
UsesClassList	m_usedByImplClassList
ConstraintClassList	m_constraintClassList
TemplateInstanceList	m_templateInstances
TemplateNameMap	m_templBaseClassNames
const ClassDef *	m_templateMaster = nullptr
DString	m_className
ClassDef *	m_categoryOf = nullptr
MemberLists	m_memberLists
MemberGroupList	m_memberGroups
bool	m_isAbstract = false
bool	m_isStatic = false
bool	m_membersMerged = false
bool	m_isLocal = false
bool	m_isTemplArg = false
bool	m_subGrouping = false
bool	m_usedOnly = false
	Reason of existence is a "use" relation.
StringSet	m_vhdlSummaryTitles
	List of titles to use for the summary.
bool	m_isSimple = false
	Is this a simple (non-nested) C structure?
const MemberDef *	m_arrowOperator = nullptr
	Does this class overloaded the -> operator?
const ClassDef *	m_taglessParent = nullptr
bool	m_hasNamedVariable = false
bool	m_isJavaEnum = false
	Does this class represent a Java style enum?
TypeSpecifier	m_spec
DString	m_metaData
DString	m_requiresClause
	C++20 requires clause.
StringVector	m_qualifiers
bool	m_hasCollaborationGraph = false
CLASS_GRAPH_t	m_typeInheritanceGraph = CLASS_GRAPH_t::NO
bool	m_implicitTemplateInstance = false
ArgumentList	m_primaryConstructorParams

Additional Inherited Members
Public Types inherited from ClassDef
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 }

Detailed Description

Implementation of the ClassDef interface.

Definition at line 200 of file classdef.cpp.

Constructor & Destructor Documentation

ClassDefImpl()

ClassDefImpl::ClassDefImpl	(	const DString &	fileName,
		int	startLine,
		size_t	startColumn,
		const DString &	name,
		CompoundType	ct,
		const DString &	ref = DString(),
		const DString &	fName = DString(),
		bool	isSymbol = true,
		bool	isJavaEnum = false )

Definition at line 825 of file classdef.cpp.

 : DefinitionMixin(defFileName,defLine,defColumn,removeRedundantWhiteSpace(nm),nullptr,nullptr,isSymbol)
{
  AUTO_TRACE("name={}",name());
  setReference(lref);
  m_compType = ct;
  m_isJavaEnum = isJavaEnum;
  DString compTypeString = getCompoundTypeString(getLanguage(),ct,isJavaEnum);
  if (!fName.empty())
  {
    m_fileName=stripExtension(fName);
  }
  else
  {
    m_fileName=compTypeString+name();
  }
  m_prot=Protection::Public;
  //nspace=nullptr;
  m_fileDef=nullptr;
  m_moduleDef=nullptr;
  m_subGrouping=Config_getBool(SUBGROUPING);
  m_templateMaster =nullptr;
  m_isAbstract = false;
  m_isStatic = false;
  m_isTemplArg = false;
  m_membersMerged = false;
  m_categoryOf = nullptr;
  m_usedOnly = false;
  m_isSimple = Config_getBool(INLINE_SIMPLE_STRUCTS);
  m_arrowOperator = nullptr;
  m_taglessParent = nullptr;
  m_hasNamedVariable = false;
  m_spec=TypeSpecifier();
  //DString ns;
  //extractNamespaceName(name,className,ns);
  //printf("m_name=%s m_className=%s ns=%s\n",qPrint(m_name),qPrint(m_className),qPrint(ns));
 
  // we cannot use getLanguage at this point, as setLanguage has not been called.
  SrcLangExt lang = getLanguageFromFileName(defFileName);
  if ((lang==SrcLangExt::Cpp || lang==SrcLangExt::ObjC) && EntryType::guessSection(defFileName).isSource())
  {
    m_isLocal=true;
  }
  else
  {
    m_isLocal=false;
  }
  m_hasCollaborationGraph = Config_getBool(COLLABORATION_GRAPH);
  m_typeInheritanceGraph = Config_getEnum(CLASS_GRAPH);
  m_memberListFileName = convertNameToFile(compTypeString+name()+"-members");
  m_collabFileName = convertNameToFile(m_fileName+"_coll_graph");
  m_inheritFileName = convertNameToFile(m_fileName+"_inherit_graph");
  if (lref.empty())
  {
    m_fileName = convertNameToFile(m_fileName);
  }
  AUTO_TRACE_EXIT("m_fileName='{}'",m_fileName);
}

References AUTO_TRACE, AUTO_TRACE_EXIT, Config_getBool, Config_getEnum, convertNameToFile(), DefinitionMixin< ClassDefMutable >::DefinitionMixin(), DString::empty(), getCompoundTypeString(), DefinitionMixin< ClassDefMutable >::getLanguage(), getLanguageFromFileName(), EntryType::guessSection(), isJavaEnum(), m_arrowOperator, m_categoryOf, m_collabFileName, m_compType, m_fileDef, m_fileName, m_hasCollaborationGraph, m_hasNamedVariable, m_inheritFileName, m_isAbstract, m_isJavaEnum, m_isLocal, m_isSimple, m_isStatic, m_isTemplArg, m_memberListFileName, m_membersMerged, m_moduleDef, m_prot, m_spec, m_subGrouping, m_taglessParent, m_templateMaster, m_typeInheritanceGraph, m_usedOnly, DefinitionMixin< ClassDefMutable >::name(), removeRedundantWhiteSpace(), DefinitionMixin< ClassDefMutable >::setReference(), and stripExtension().

Referenced by addTypeConstraint(), and insertTemplateInstance().

Member Function Documentation

addClassAttributes()

void ClassDefImpl::addClassAttributes ( OutputList & ol ) const

private

Definition at line 2756 of file classdef.cpp.

{
  StringVector sl;
  if (isFinal())    sl.emplace_back("final");
  if (isSealed())   sl.emplace_back("sealed");
  if (isAbstract()) sl.emplace_back("abstract");
  if (isExported()) sl.emplace_back("export");
  if (getLanguage()==SrcLangExt::IDL && isPublished()) sl.emplace_back("published");
 
  for (const auto &sx : m_qualifiers)
  {
    bool alreadyAdded = std::find(sl.begin(), sl.end(), sx) != sl.end();
    if (!alreadyAdded)
    {
      sl.push_back(sx);
    }
  }
 
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
  if (!sl.empty())
  {
    ol.startLabels();
    size_t i=0;
    for (const auto &s : sl)
    {
      i++;
      ol.writeLabel(s,i==sl.size());
    }
    ol.endLabels();
  }
  ol.popGeneratorState();
}

References OutputList::disableAllBut(), OutputList::endLabels(), DefinitionMixin< ClassDefMutable >::getLanguage(), Html, isAbstract(), DefinitionMixin< ClassDefMutable >::isExported(), isFinal(), isPublished(), isSealed(), m_qualifiers, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startLabels(), and OutputList::writeLabel().

Referenced by writeDocumentation().

addExample()

bool ClassDefImpl::addExample ( const DString & anchor, const DString & name, const DString & file )

overridevirtual

Implements ClassDefMutable.

Definition at line 3451 of file classdef.cpp.

{
  return m_examples.inSort(Example(anchor,nameStr,file));
}

References anchor(), ExampleList::inSort(), and m_examples.

addGroupedInheritedMembers()

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

overridevirtual

Implements ClassDef.

Definition at line 4994 of file classdef.cpp.

{
  //printf("** %s::addGroupedInheritedMembers() inheritId=%s\n",qPrint(name()),qPrint(inheritId));
  for (const auto &mg : m_memberGroups)
  {
    if (!mg->allMembersInSameSection() || !m_subGrouping) // group is in its own section
    {
      mg->addGroupedInheritedMembers(ol,this,lt,inheritedFrom,inheritId);
    }
  }
}

References m_memberGroups, and m_subGrouping.

addInnerCompound()

void ClassDefImpl::addInnerCompound ( Definition * d )

overridevirtual

Implements DefinitionMutable.

Definition at line 4373 of file classdef.cpp.

{
  //printf("**** %s::addInnerCompound(%s)\n",qPrint(name()),qPrint(d->name()));
  if (d->definitionType()==Definition::TypeClass) // only classes can be nested in classes.
  {
    ClassDef *cd = toClassDef(d);
    m_innerClasses.add(d->localName(),cd);
    if (cd && cd->isAnonymous())
    {
      m_isSimple = false;
    }
  }
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), Definition::definitionType(), Definition::isAnonymous(), Definition::localName(), m_innerClasses, m_isSimple, toClassDef(), and Definition::TypeClass.

addListReferences()

void ClassDefImpl::addListReferences ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 4585 of file classdef.cpp.

{
  if (!isLinkableInProject()) return;
  SrcLangExt lang = getLanguage();
  addRefItem(xrefListItems(),
             qualifiedName(),
             theTranslator->trCompoundType(compoundType(), lang),
             getOutputFileBase(),
             displayName(),
             DString(),
             this
            );
  for (const auto &mg : m_memberGroups)
  {
    mg->addListReferences(this);
  }
  for (auto &ml : m_memberLists)
  {
    if (ml->listType().isDetailed())
    {
      ml->addListReferences(this);
    }
  }
}

References addRefItem(), compoundType(), displayName(), DefinitionMixin< ClassDefMutable >::getLanguage(), getOutputFileBase(), isLinkableInProject(), m_memberGroups, m_memberLists, DefinitionMixin< ClassDefMutable >::qualifiedName(), theTranslator, Translator::trCompoundType(), and DefinitionMixin< ClassDefMutable >::xrefListItems().

addMembersToMemberGroup()

void ClassDefImpl::addMembersToMemberGroup ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 1044 of file classdef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    if (!ml->listType().isDetailed())
    {
      ::addMembersToMemberGroup(ml.get(),&m_memberGroups,this);
    }
  }
 
  // add members inside sections to their groups
  for (const auto &mg : m_memberGroups)
  {
    if (mg->allMembersInSameSection() && m_subGrouping)
    {
      //printf("addToDeclarationSection(%s)\n",qPrint(mg->header()));
      mg->addToDeclarationSection();
    }
  }
}

References addMembersToMemberGroup(), m_memberGroups, m_memberLists, and m_subGrouping.

Referenced by addMembersToMemberGroup().

addMembersToTemplateInstance()

void ClassDefImpl::addMembersToTemplateInstance ( const ClassDef * cd, const ArgumentList & templateArguments, const DString & templSpec )

overridevirtual

Implements ClassDefMutable.

Definition at line 4497 of file classdef.cpp.

{
  AUTO_TRACE("this={} cd={} templSpec={}",name(),cd->name(),templSpec);
  //printf("%s::addMembersToTemplateInstance(%s,%s)\n",qPrint(name()),qPrint(cd->name()),templSpec);
  for (const auto &mni : cd->memberNameInfoLinkedMap())
  {
    for (const auto &mi : *mni)
    {
      const MemberDef *md = mi->memberDef();
      if (m_allMemberNameInfoLinkedMap.find(md->name())==nullptr) // only insert the member if not hidden by one with the same name (#11541)
      {
        addMemberToTemplateInstance(md,templateArguments,templSpec);
      }
    }
  }
  // also instantiate members for nested classes
  for (const auto &innerCd : cd->getClasses())
  {
    ClassDefMutable *ncd = toClassDefMutable(m_innerClasses.find(innerCd->localName()));
    if (ncd)
    {
      ncd->addMembersToTemplateInstance(innerCd,cd->templateArguments(),templSpec);
    }
  }
}

References ClassDefMutable::addMembersToTemplateInstance(), addMemberToTemplateInstance(), AUTO_TRACE, LinkedMap< T, Hash, KeyEqual, Map >::find(), LinkedRefMap< T, Hash, KeyEqual, Map >::find(), ClassDef::getClasses(), m_allMemberNameInfoLinkedMap, m_innerClasses, ClassDef::memberNameInfoLinkedMap(), Definition::name(), DefinitionMixin< ClassDefMutable >::name(), ClassDef::templateArguments(), templateArguments(), and toClassDefMutable().

addMemberToList()

void ClassDefImpl::addMemberToList ( MemberListType lt, MemberDef * md, bool isBrief )

private

Definition at line 4669 of file classdef.cpp.

{
  AUTO_TRACE("{} md={} lt={} isBrief={}",name(),md->name(),lt,isBrief);
  bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
  bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
  const auto &ml = m_memberLists.get(lt,MemberListContainer::Class);
  ml->setNeedsSorting((isBrief && sortBriefDocs) || (!isBrief && sortMemberDocs));
  ml->push_back(md);
 
  // for members in the declaration lists we set the section, needed for member grouping
  if (!ml->listType().isDetailed())
  {
    MemberDefMutable *mdm = toMemberDefMutable(md);
    if (mdm)
    {
      mdm->setSectionList(this,ml.get());
    }
  }
}

References AUTO_TRACE, Class, Config_getBool, MemberLists::get(), m_memberLists, Definition::name(), DefinitionMixin< ClassDefMutable >::name(), MemberDefMutable::setSectionList(), and toMemberDefMutable().

Referenced by internalInsertMember().

addMemberToTemplateInstance()

void ClassDefImpl::addMemberToTemplateInstance ( const MemberDef * md, const ArgumentList & templateArguments, const DString & templSpec )

overridevirtual

Implements ClassDefMutable.

Definition at line 4471 of file classdef.cpp.

{
  AUTO_TRACE("this={} md={}",name(),md->name());
  auto actualArguments_p = stringToArgumentList(getLanguage(),templSpec);
  auto imd = md->createTemplateInstanceMember(templateArguments,actualArguments_p);
  auto mmd = toMemberDefMutable(imd.get());
  mmd->setMemberClass(this);
  mmd->setTemplateMaster(md);
  mmd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
  mmd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
  mmd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());
  mmd->setMemberSpecifiers(md->getMemberSpecifiers());
  mmd->setMemberGroupId(md->getMemberGroupId());
  mmd->setArtificial(true);
  insertMember(imd.get());
  //printf("Adding member=%s %s%s to class %s templSpec %s\n",
  //    imd->typeString(),qPrint(imd->name()),imd->argsString(),
  //    qPrint(imd->getClassDef()->name()),templSpec);
  // insert imd in the list of all members
  //printf("Adding member=%s class=%s\n",qPrint(imd->name()),qPrint(name()));
  MemberName *mn = Doxygen::memberNameLinkedMap->add(imd->name());
  mn->push_back(std::move(imd));
}

References LinkedMap< T, Hash, KeyEqual, Map >::add(), AUTO_TRACE, Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), MemberDef::createTemplateInstanceMember(), Definition::docFile(), Definition::docLine(), Definition::documentation(), DefinitionMixin< ClassDefMutable >::getLanguage(), MemberDef::getMemberGroupId(), MemberDef::getMemberSpecifiers(), Definition::inbodyDocumentation(), Definition::inbodyFile(), Definition::inbodyLine(), insertMember(), Doxygen::memberNameLinkedMap, Definition::name(), DefinitionMixin< ClassDefMutable >::name(), MemberName::push_back(), stringToArgumentList(), templateArguments(), and toMemberDefMutable().

Referenced by addMembersToTemplateInstance().

addQualifiers()

void ClassDefImpl::addQualifiers ( const StringVector & qualifiers )

overridevirtual

Implements ClassDefMutable.

Definition at line 5384 of file classdef.cpp.

{
  for (const auto &sx : qualifiers)
  {
    bool alreadyAdded = std::find(m_qualifiers.begin(), m_qualifiers.end(), sx) != m_qualifiers.end();
    if (!alreadyAdded)
    {
      m_qualifiers.push_back(sx);
    }
  }
}

References m_qualifiers.

addRequirementReferences()

void ClassDefImpl::addRequirementReferences ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 4610 of file classdef.cpp.

{
  if (!isLinkableInProject()) return;
  RequirementManager::instance().addRequirementRefsForSymbol(this);
  for (const auto &mg : m_memberGroups)
  {
    mg->addRequirementReferences(this);
  }
  for (auto &ml : m_memberLists)
  {
    if (ml->listType().isDetailed())
    {
      ml->addRequirementReferences(this);
    }
  }
}

References RequirementManager::addRequirementRefsForSymbol(), RequirementManager::instance(), isLinkableInProject(), m_memberGroups, and m_memberLists.

addTypeConstraint()

void ClassDefImpl::addTypeConstraint ( const DString & typeConstraint, const DString & type )

private

Definition at line 3462 of file classdef.cpp.

{
  //printf("addTypeConstraint(%s,%s)\n",qPrint(type),qPrint(typeConstraint));
  bool hideUndocRelation = Config_getBool(HIDE_UNDOC_RELATIONS);
  if (typeConstraint.empty() || type.empty()) return;
  SymbolResolver resolver(getFileDef());
  ClassDefMutable *cd = resolver.resolveClassMutable(this,typeConstraint);
  if (cd==nullptr && !hideUndocRelation)
  {
    cd = toClassDefMutable(
           Doxygen::hiddenClassLinkedMap->add(typeConstraint,
             std::unique_ptr<ClassDef>(
               new ClassDefImpl(
                 getDefFileName(),getDefLine(),
                 getDefColumn(),
                 typeConstraint,
                 ClassDef::Class))));
    if (cd)
    {
      cd->setUsedOnly(true);
      cd->setLanguage(getLanguage());
      //printf("Adding undocumented constraint '%s' to class %s on type %s\n",
      //       qPrint(typeConstraint),qPrint(name()),qPrint(type));
    }
  }
  if (cd)
  {
    auto it = std::find_if(m_constraintClassList.begin(),
                           m_constraintClassList.end(),
                           [&cd](const auto &ccd) { return ccd.classDef==cd; });
 
    if (it==m_constraintClassList.end())
    {
      m_constraintClassList.emplace_back(cd);
      it = m_constraintClassList.end()-1;
    }
    (*it).addAccessor(type);
    //printf("Adding constraint '%s' to class %s on type %s\n",
    //       qPrint(typeConstraint),qPrint(name()),qPrint(type));
  }
}

References ClassDef::Class, ClassDefImpl(), Config_getBool, DString::empty(), DefinitionMixin< ClassDefMutable >::getDefColumn(), DefinitionMixin< ClassDefMutable >::getDefFileName(), DefinitionMixin< ClassDefMutable >::getDefLine(), getFileDef(), DefinitionMixin< ClassDefMutable >::getLanguage(), Doxygen::hiddenClassLinkedMap, m_constraintClassList, SymbolResolver::resolveClassMutable(), DefinitionMutable::setLanguage(), ClassDefMutable::setUsedOnly(), and toClassDefMutable().

Referenced by addTypeConstraints().

addTypeConstraints()

void ClassDefImpl::addTypeConstraints ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 3505 of file classdef.cpp.

{
  for (const Argument &a : m_tempArgs)
  {
    if (!a.typeConstraint.empty())
    {
      DString typeConstraint;
      size_t i=0,p=0;
      while ((i=a.typeConstraint.find('&',p))!=DString::npos) // typeConstraint="A &I" for C<T extends A & I>
      {
        typeConstraint = a.typeConstraint.mid(p,i-p).stripWhiteSpace();
        addTypeConstraint(typeConstraint,a.type);
        p=i+1;
      }
      typeConstraint = a.typeConstraint.mid(p).stripWhiteSpace();
      addTypeConstraint(typeConstraint,a.type);
    }
  }
}

References addTypeConstraint(), m_tempArgs, DString::mid(), DString::npos, and DString::stripWhiteSpace().

addUsedByClass()

void ClassDefImpl::addUsedByClass ( ClassDef * cd, const DString & accessName, Protection prot )

overridevirtual

Implements ClassDefMutable.

Definition at line 4260 of file classdef.cpp.

{
  bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
  bool umlLook = Config_getBool(UML_LOOK);
  if (prot==Protection::Private && !extractPrivate) return;
  //printf("%s::addUsedByClass(%s,%s)\n",qPrint(name()),qPrint(cd->name()),accessName);
  //
  auto it = std::find_if(m_usedByImplClassList.begin(),
                         m_usedByImplClassList.end(),
                         [&cd](const auto &ucd) { return ucd.classDef==cd; });
  if (it==m_usedByImplClassList.end())
  {
     m_usedByImplClassList.emplace_back(cd);
     //printf("Adding used by class %s to class %s\n",
     //    qPrint(cd->name()),qPrint(name()));
     it = m_usedByImplClassList.end()-1;
  }
  DString acc = accessName;
  if (umlLook)
  {
    switch(prot)
    {
      case Protection::Public:    acc.prepend("+"); break;
      case Protection::Private:   acc.prepend("-"); break;
      case Protection::Protected: acc.prepend("#"); break;
      case Protection::Package:   acc.prepend("~"); break;
    }
  }
  (*it).addAccessor(acc);
}

References Config_getBool, m_usedByImplClassList, and DString::prepend().

addUsedClass()

void ClassDefImpl::addUsedClass ( ClassDef * cd, const DString & accessName, Protection prot )

overridevirtual

Implements ClassDefMutable.

Definition at line 4228 of file classdef.cpp.

{
  bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
  bool umlLook = Config_getBool(UML_LOOK);
  if (prot==Protection::Private && !extractPrivate) return;
  //printf("%s::addUsedClass(%s,%s)\n",qPrint(name()),qPrint(cd->name()),accessName);
 
  auto it = std::find_if(m_usesImplClassList.begin(),
                         m_usesImplClassList.end(),
                         [&cd](const auto &ucd) { return ucd.classDef==cd; });
  if (it==m_usesImplClassList.end())
  {
    m_usesImplClassList.emplace_back(cd);
    //printf("Adding used class %s to class %s via accessor %s\n",
    //    qPrint(cd->name()),qPrint(name()),accessName);
    it = m_usesImplClassList.end()-1;
  }
  DString acc = accessName;
  if (umlLook)
  {
    switch(prot)
    {
      case Protection::Public:    acc.prepend("+"); break;
      case Protection::Private:   acc.prepend("-"); break;
      case Protection::Protected: acc.prepend("#"); break;
      case Protection::Package:   acc.prepend("~"); break;
    }
  }
  (*it).addAccessor(acc);
}

References Config_getBool, m_usesImplClassList, and DString::prepend().

addUsedInterfaceClasses()

void ClassDefImpl::addUsedInterfaceClasses ( MemberDef * md, const DString & typeStr )

private

References anchor(), and title().

anchor()

DString ClassDefImpl::anchor ( ) const

overridevirtual

Returns the anchor within a page where this item can be found

Implements Definition.

Definition at line 5293 of file classdef.cpp.

{
  DString anc;
  if (isEmbeddedInOuterScope() && !Doxygen::generatingXmlOutput)
  {
    if (m_templateMaster && m_implicitTemplateInstance)
    {
      // point to the template of which this class is an instance
      anc = m_templateMaster->getOutputFileBase();
    }
    else
    {
      anc = m_fileName;
    }
  }
  return anc;
}

References Doxygen::generatingXmlOutput, Definition::getOutputFileBase(), isEmbeddedInOuterScope(), m_fileName, m_implicitTemplateInstance, and m_templateMaster.

Referenced by addExample(), addUsedInterfaceClasses(), writeBriefDescription(), writeDeclarationLink(), writeDetailedDescription(), writeInlineDocumentation(), writeMemberList(), writeMoreLink(), and writeTagFile().

baseClasses()

const BaseClassList & ClassDefImpl::baseClasses ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5048 of file classdef.cpp.

{
  return m_inherits;
}

References m_inherits.

Referenced by isBaseClass(), mergeMembers(), and mergeMembersFromBaseClasses().

categoryOf()

ClassDef * ClassDefImpl::categoryOf ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5198 of file classdef.cpp.

{
  return m_categoryOf;
}

References m_categoryOf.

className()

DString ClassDefImpl::className ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 4569 of file classdef.cpp.

{
  DString name = m_className.empty() ? localName() : m_className;
  auto lang = getLanguage();
  if (lang==SrcLangExt::CSharp)
  {
    name = demangleCSharpGenericName(name,tempArgListToString(templateArguments(),lang));
  }
  return name;
}

References demangleCSharpGenericName(), DString::empty(), DefinitionMixin< ClassDefMutable >::getLanguage(), DefinitionMixin< ClassDefMutable >::localName(), m_className, DefinitionMixin< ClassDefMutable >::name(), tempArgListToString(), and templateArguments().

codeSymbolType()

CodeSymbolType ClassDefImpl::codeSymbolType ( ) const

overridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 5487 of file classdef.cpp.

{
  switch (compoundType())
  {
    case Class:     return CodeSymbolType::Class;     break;
    case Struct:    return CodeSymbolType::Struct;    break;
    case Union:     return CodeSymbolType::Union;     break;
    case Interface: return CodeSymbolType::Interface; break;
    case Protocol:  return CodeSymbolType::Protocol;  break;
    case Category:  return CodeSymbolType::Category;  break;
    case Exception: return CodeSymbolType::Exception; break;
    case Service:   return CodeSymbolType::Service;   break;
    case Singleton: return CodeSymbolType::Singleton; break;
  }
  return CodeSymbolType::Class;
}

References ClassDef::Category, Category, ClassDef::Class, Class, compoundType(), ClassDef::Exception, Exception, ClassDef::Interface, Interface, ClassDef::Protocol, Protocol, ClassDef::Service, Service, ClassDef::Singleton, Singleton, ClassDef::Struct, Struct, ClassDef::Union, and Union.

collaborationGraphFileName()

DString ClassDefImpl::collaborationGraphFileName ( ) const

overridevirtual

returns the file name to use for the collaboration graph

Implements ClassDef.

Definition at line 5467 of file classdef.cpp.

{
  return m_collabFileName;
}

References m_collabFileName.

compoundType()

ClassDefImpl::CompoundType ClassDefImpl::compoundType ( ) const

overridevirtual

Returns the type of compound this is, i.e. class/struct/union/...

Implements ClassDef.

Definition at line 5043 of file classdef.cpp.

{
  return m_compType;
}

References m_compType.

Referenced by addListReferences(), codeSymbolType(), deepCopy(), writeDeclarationLink(), writeDocumentation(), and writeMemberList().

compoundTypeString()

DString ClassDefImpl::compoundTypeString ( ) const

overridevirtual

Returns the type of compound as a string.

Implements ClassDef.

Definition at line 4293 of file classdef.cpp.

{
  return getCompoundTypeString(getLanguage(),m_compType,isJavaEnum());
}

References getCompoundTypeString(), DefinitionMixin< ClassDefMutable >::getLanguage(), isJavaEnum(), and m_compType.

Referenced by writeDeclaration(), writeDeclarationLink(), writeDetailedDocumentationBody(), writeDocumentationContents(), writeInlineDocumentation(), and writeTagFile().

computeAnchors()

void ClassDefImpl::computeAnchors ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 1383 of file classdef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    if (!ml->listType().isDetailed())
    {
      ml->setAnchors();
    }
  }
 
  for (const auto &mg : m_memberGroups)
  {
    mg->setAnchors();
  }
}

References m_memberGroups, and m_memberLists.

containsOverload()

bool ClassDefImpl::containsOverload ( const MemberDef * md ) const

overridevirtual

Implements ClassDef.

Definition at line 5401 of file classdef.cpp.

{
  AUTO_TRACE("name={}",md->name());
  const auto &mni = m_allMemberNameInfoLinkedMap.find(md->name());
  if (mni)
  {
    for (const auto &mi : *mni)
    {
      const MemberDef *classMd = mi->memberDef();
      const ArgumentList &classAl = classMd->argumentList();
      const ArgumentList &al      = md->argumentList();
      bool found = matchArguments2(
          classMd->getOuterScope(),classMd->getFileDef(),classMd->typeString(),&classAl,
          md->getOuterScope(),md->getFileDef(),md->typeString(),&al,
          true,getLanguage()
          );
      if (found)
      {
        AUTO_TRACE_EXIT("true");
        return true;
      }
    }
  }
  AUTO_TRACE_EXIT("false");
  return false;
}

References MemberDef::argumentList(), AUTO_TRACE, AUTO_TRACE_EXIT, LinkedMap< T, Hash, KeyEqual, Map >::find(), MemberDef::getFileDef(), DefinitionMixin< ClassDefMutable >::getLanguage(), Definition::getOuterScope(), m_allMemberNameInfoLinkedMap, matchArguments2(), Definition::name(), and MemberDef::typeString().

countAdditionalInheritedMembers()

int ClassDefImpl::countAdditionalInheritedMembers ( ) const

private

Definition at line 4843 of file classdef.cpp.

{
  int totalCount=0;
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
  {
    if (lde->kind()==LayoutDocEntry::MemberDecl)
    {
      const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
      if (lmd && lmd->type!=MemberListType::Friends()) // friendship is not inherited
      {
        ClassDefSet visited;
        totalCount+=countInheritedDecMembers(lmd->type,this,true,false,visited);
      }
    }
  }
  //printf("countAdditionalInheritedMembers()=%d\n",totalCount);
  return totalCount;
}

References countInheritedDecMembers(), LayoutDocManager::instance(), and LayoutDocEntryMemberDecl::type.

Referenced by endMemberDeclarations().

countInheritanceNodes()

int ClassDefImpl::countInheritanceNodes ( ) const

private

Definition at line 1860 of file classdef.cpp.

{
  return countInheritedByNodes()+countInheritsNodes();
}

References countInheritedByNodes(), and countInheritsNodes().

Referenced by writeInheritanceGraph().

countInheritedByNodes()

int ClassDefImpl::countInheritedByNodes ( ) const

private

Definition at line 1838 of file classdef.cpp.

{
  int count=0;
  for (const auto &ibcd : m_inheritedBy)
  {
    const ClassDef *icd=ibcd.classDef;
    if ( icd->isVisibleInHierarchy()) count++;
  }
  return count;
}

References ClassDef::isVisibleInHierarchy(), and m_inheritedBy.

Referenced by countInheritanceNodes(), and writeInheritanceGraph().

countInheritedDecMembers()

int ClassDefImpl::countInheritedDecMembers ( MemberListType lt, const ClassDef * inheritedFrom, bool invert, bool showAlways, ClassDefSet & visitedClasses ) const

private

Definition at line 4786 of file classdef.cpp.

{
  int inhCount = 0;
  int count = countMembersIncludingGrouped(lt,inheritedFrom,false);
  bool process = count>0;
  //printf("%s: countInheritedDecMembers: lt=%s process=%d count=%d invert=%d\n",
  //    qPrint(name()),lt.to_string(),process,count,invert);
  if ((process^invert) || showAlways)
  {
    for (const auto &ibcd : m_inherits)
    {
      ClassDefMutable *icd = toClassDefMutable(ibcd.classDef);
      MemberListType lt1 = MemberListType::Invalid();
      MemberListType lt2 = MemberListType::Invalid();
      if (icd && icd->isLinkable())
      {
        convertProtectionLevel(lt,ibcd.prot,&lt1,&lt2);
        //printf("%s: convert %s->(%s,%s) prot=%d\n",
        //    qPrint(icd->name()),lt.to_string(),lt1.to_string(),lt2.to_string(),ibcd.prot);
        if (visitedClasses.find(icd)==visitedClasses.end())
        {
          visitedClasses.insert(icd); // guard for multiple virtual inheritance
          if (!lt1.isInvalid())
          {
            inhCount+=icd->countMemberDeclarations(lt1,inheritedFrom,lt2,false,true,visitedClasses);
          }
        }
      }
    }
  }
  //printf("%s: count=%d\n",qPrint(name()),inhCount);
  return inhCount;
}

References convertProtectionLevel(), ClassDef::countMemberDeclarations(), countMembersIncludingGrouped(), MemberListType::Invalid(), MemberListType::isInvalid(), Definition::isLinkable(), m_inherits, and toClassDefMutable().

Referenced by countAdditionalInheritedMembers(), and countMemberDeclarations().

countInheritsNodes()

int ClassDefImpl::countInheritsNodes ( ) const

private

Definition at line 1849 of file classdef.cpp.

{
  int count=0;
  for (const auto &ibcd : m_inherits)
  {
    const ClassDef *icd=ibcd.classDef;
    if ( icd->isVisibleInHierarchy()) count++;
  }
  return count;
}

References ClassDef::isVisibleInHierarchy(), and m_inherits.

Referenced by countInheritanceNodes(), and writeInheritanceGraph().

countMemberDeclarations()

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

overridevirtual

Implements ClassDef.

Definition at line 4708 of file classdef.cpp.

{
  //printf("%s: countMemberDeclarations for %s and %s\n",qPrint(name()),lt.to_string(),lt2.to_string());
  int count=0;
  MemberList * ml  = getMemberList(lt);
  MemberList * ml2 = getMemberList(lt2);
  if (getLanguage()!=SrcLangExt::VHDL) // use specific declarations function
  {
    if (ml)
    {
      count+=ml->numDecMembers(inheritedFrom);
      //printf("-> ml=%d\n",ml->numDecMembers());
    }
    if (ml2)
    {
      count+=ml2->numDecMembers(inheritedFrom);
      //printf("-> ml2=%d\n",ml2->numDecMembers());
    }
    // also include grouped members that have their own section in the class (see bug 722759)
    if (inheritedFrom)
    {
      for (const auto &mg : m_memberGroups)
      {
        count+=mg->countGroupedInheritedMembers(lt);
        if (!lt2.isInvalid()) count+=mg->countGroupedInheritedMembers(lt2);
      }
    }
    bool inlineInheritedMembers = Config_getBool(INLINE_INHERITED_MEMB);
    if (!inlineInheritedMembers) // show inherited members as separate lists
    {
      count+=countInheritedDecMembers(lt,inheritedFrom,invert,showAlways,visitedClasses);
    }
  }
  //printf("-> %d\n",count);
  return count;
}

References Config_getBool, countInheritedDecMembers(), DefinitionMixin< ClassDefMutable >::getLanguage(), getMemberList(), MemberListType::isInvalid(), m_memberGroups, and MemberList::numDecMembers().

countMembers()

void ClassDefImpl::countMembers ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 4772 of file classdef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    ml->countDecMembers();
    ml->countDocMembers();
  }
  for (const auto &mg : m_memberGroups)
  {
    mg->countDecMembers();
    mg->countDocMembers();
  }
}

References m_memberGroups, and m_memberLists.

countMembersIncludingGrouped()

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

overridevirtual

Implements ClassDef.

Definition at line 4879 of file classdef.cpp.

{
  int count=0;
  MemberList *ml = getMemberList(lt);
  if (ml)
  {
    count=ml->countInheritableMembers(inheritedFrom);
  }
  //printf("%s:countMembersIncludingGrouped: count=%d\n",qPrint(name()),count);
  for (const auto &mg : m_memberGroups)
  {
    bool hasOwnSection = !mg->allMembersInSameSection() ||
                         !m_subGrouping; // group is in its own section
    if ((additional && hasOwnSection) || (!additional && !hasOwnSection))
    {
      count+=mg->countGroupedInheritedMembers(lt);
    }
  }
  //printf("%s:countMembersIncludingGrouped(lt=%s,%s)=%d\n",
  //    qPrint(name()),qPrint(lt.to_string()),ml?qPrint(ml->listType().to_string()):"<none>",count);
  return count;
}

References MemberList::countInheritableMembers(), getMemberList(), m_memberGroups, and m_subGrouping.

Referenced by countInheritedDecMembers(), and writeInheritedMemberDeclarations().

deepCopy()

std::unique_ptr< ClassDef > ClassDefImpl::deepCopy ( const DString & name ) const

overridevirtual

Implements ClassDef.

Definition at line 888 of file classdef.cpp.

{
  AUTO_TRACE("name='{}'",name);
  auto result = std::make_unique<ClassDefImpl>(
        getDefFileName(),getDefLine(),getDefColumn(),name,compoundType(),
        std::string(),std::string(),true,m_isJavaEnum);
  result->setBriefDescription(briefDescription(),briefFile(),briefLine());
  result->setDocumentation(documentation(),docFile(),docLine());
  result->setInbodyDocumentation(inbodyDocumentation(),inbodyFile(),inbodyLine());
  result->setBodySegment(getStartDefLine(),getStartBodyLine(),getEndBodyLine());
  result->setBodyDef(getBodyDef());
  result->setLanguage(getLanguage());
 
  // copy other members
  result->m_memberListFileName = m_memberListFileName;
  result->m_collabFileName = m_collabFileName;
  result->m_inheritFileName = m_inheritFileName;
  if (m_incInfo)
  {
    result->m_incInfo = std::make_unique<IncludeInfo>();
    *(result->m_incInfo) = *m_incInfo;
  }
  result->m_inherits  = m_inherits;
  result->m_inheritedBy  = m_inheritedBy;
  result->m_fileDef = m_fileDef;
  result->m_moduleDef = m_moduleDef;
  result->m_tempArgs = m_tempArgs;
  result->m_typeConstraints = m_typeConstraints;
  result->m_files = m_files;
  result->m_examples = m_examples;
  result->m_compType = m_compType;
  result->m_prot = m_prot;
  result->m_usesImplClassList = m_usesImplClassList;
  result->m_usedByImplClassList = m_usedByImplClassList;
  result->m_constraintClassList = m_constraintClassList;
  result->m_templateInstances = m_templateInstances;
  result->m_templBaseClassNames = m_templBaseClassNames;
  result->m_templateMaster = m_templateMaster;
  result->m_className = m_className;
  result->m_categoryOf = m_categoryOf;
  result->m_isAbstract = m_isAbstract;
  result->m_isStatic = m_isStatic;
  result->m_membersMerged = m_membersMerged;
  result->m_isLocal = m_isLocal;
  result->m_isTemplArg = m_isTemplArg;
  result->m_subGrouping = m_subGrouping;
  result->m_usedOnly = m_usedOnly;
  result->m_vhdlSummaryTitles = m_vhdlSummaryTitles;
  result->m_isSimple = m_isSimple;
  result->m_arrowOperator = m_arrowOperator;
  result->m_taglessParent = m_taglessParent;
  result->m_hasNamedVariable = m_hasNamedVariable;
  result->m_isJavaEnum = m_isJavaEnum;
  result->m_spec = m_spec;
  result->m_metaData = m_metaData;
  result->m_requiresClause = m_requiresClause;
  result->m_qualifiers = m_qualifiers;
  result->m_hasCollaborationGraph = m_hasCollaborationGraph;
  result->m_typeInheritanceGraph = m_typeInheritanceGraph;
 
  // set new file name
  DString compTypeString = getCompoundTypeString(getLanguage(),m_compType,m_isJavaEnum);
  result->m_fileName = compTypeString+name;
  result->m_memberListFileName = convertNameToFile(compTypeString+name+"-members");
  result->m_collabFileName = convertNameToFile(result->m_fileName+"_coll_graph");
  result->m_inheritFileName = convertNameToFile(result->m_fileName+"_inherit_graph");
  result->m_fileName = convertNameToFile(result->m_fileName);
 
  // deep copy nested classes
  for (const auto &innerCd : m_innerClasses)
  {
    DString innerName = name+"::"+innerCd->localName();
    if (Doxygen::classLinkedMap->find(innerName)==nullptr)
    {
      auto cd = Doxygen::classLinkedMap->add(innerName,innerCd->deepCopy(innerName));
      result->addInnerCompound(cd);
      ClassDefMutable *cdm = toClassDefMutable(cd);
      if (cdm)
      {
        cdm->setOuterScope(result.get());
      }
    }
  }
 
  // copy all member list (and make deep copies of members)
  for (auto &mni : m_allMemberNameInfoLinkedMap)
  {
    for (auto &mi : *mni)
    {
      const MemberDef *md=mi->memberDef();
      auto newMd = md->deepCopy();
      if (newMd)
      {
        AUTO_TRACE_ADD("Copying member {}",newMd->name());
        auto mmd = toMemberDefMutable(newMd.get());
        if (mmd)
        {
          mmd->moveTo(result.get());
        }
 
        result->internalInsertMember(newMd.get(),newMd->protection(),true);
 
        // also add to the global list (which will own newMd)
        MemberName *mn = Doxygen::memberNameLinkedMap->add(newMd->name());
        mn->push_back(std::move(newMd));
      }
    }
  }
 
  return result;
}

References LinkedMap< T, Hash, KeyEqual, Map >::add(), AUTO_TRACE, AUTO_TRACE_ADD, DefinitionMixin< ClassDefMutable >::briefDescription(), DefinitionMixin< ClassDefMutable >::briefFile(), DefinitionMixin< ClassDefMutable >::briefLine(), Doxygen::classLinkedMap, compoundType(), convertNameToFile(), MemberDef::deepCopy(), DefinitionMixin< ClassDefMutable >::docFile(), DefinitionMixin< ClassDefMutable >::docLine(), DefinitionMixin< ClassDefMutable >::documentation(), DefinitionMixin< ClassDefMutable >::getBodyDef(), getCompoundTypeString(), DefinitionMixin< ClassDefMutable >::getDefColumn(), DefinitionMixin< ClassDefMutable >::getDefFileName(), DefinitionMixin< ClassDefMutable >::getDefLine(), DefinitionMixin< ClassDefMutable >::getEndBodyLine(), DefinitionMixin< ClassDefMutable >::getLanguage(), DefinitionMixin< ClassDefMutable >::getStartBodyLine(), DefinitionMixin< ClassDefMutable >::getStartDefLine(), DefinitionMixin< ClassDefMutable >::inbodyDocumentation(), DefinitionMixin< ClassDefMutable >::inbodyFile(), DefinitionMixin< ClassDefMutable >::inbodyLine(), m_allMemberNameInfoLinkedMap, m_arrowOperator, m_categoryOf, m_className, m_collabFileName, m_compType, m_constraintClassList, m_examples, m_fileDef, m_files, m_hasCollaborationGraph, m_hasNamedVariable, m_incInfo, m_inheritedBy, m_inheritFileName, m_inherits, m_innerClasses, m_isAbstract, m_isJavaEnum, m_isLocal, m_isSimple, m_isStatic, m_isTemplArg, m_memberListFileName, m_membersMerged, m_metaData, m_moduleDef, m_prot, m_qualifiers, m_requiresClause, m_spec, m_subGrouping, m_taglessParent, m_tempArgs, m_templateInstances, m_templateMaster, m_templBaseClassNames, m_typeConstraints, m_typeInheritanceGraph, m_usedByImplClassList, m_usedOnly, m_usesImplClassList, m_vhdlSummaryTitles, Doxygen::memberNameLinkedMap, DefinitionMixin< ClassDefMutable >::name(), MemberName::push_back(), DefinitionMutable::setOuterScope(), toClassDefMutable(), and toMemberDefMutable().

definitionType()

DefType ClassDefImpl::definitionType ( ) const

inlineoverridevirtual

Use this for dynamic inspection of the type of the derived class

Implements Definition.

Definition at line 208 of file classdef.cpp.

{ return TypeClass; }

References Definition::TypeClass.

displayName()

DString ClassDefImpl::displayName ( bool includeScope = true ) const

overridevirtual

Returns the name of the definition as it appears in the output

Implements Definition.

Definition at line 1019 of file classdef.cpp.

{
  return makeDisplayName(this,includeScope);
}

References makeDisplayName().

Referenced by addListReferences(), title(), writeCollaborationGraph(), writeDeclarationLink(), writeDocumentation(), writeInheritanceGraph(), writeMemberDocumentation(), writeMemberList(), writeMemberPages(), and writeTagFile().

distributeMemberGroupDocumentation()

void ClassDefImpl::distributeMemberGroupDocumentation ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 1399 of file classdef.cpp.

{
  for (const auto &mg : m_memberGroups)
  {
    mg->distributeMemberGroupDocumentation();
  }
}

References m_memberGroups.

endMemberDeclarations()

void ClassDefImpl::endMemberDeclarations ( OutputList & ol ) const

private

Definition at line 2255 of file classdef.cpp.

{
  //printf("%s: ClassDefImpl::endMemberDeclarations()\n",qPrint(name()));
  bool inlineInheritedMembers = Config_getBool(INLINE_INHERITED_MEMB);
  if (!inlineInheritedMembers && countAdditionalInheritedMembers()>0)
  {
    ol.startMemberHeader("inherited");
    ol.parseText(theTranslator->trAdditionalInheritedMembers());
    ol.endMemberHeader();
    writeAdditionalInheritedMembers(ol);
  }
  ol.endMemberSections();
}

References Config_getBool, countAdditionalInheritedMembers(), OutputList::endMemberHeader(), OutputList::endMemberSections(), OutputList::parseText(), OutputList::startMemberHeader(), theTranslator, Translator::trAdditionalInheritedMembers(), and writeAdditionalInheritedMembers().

Referenced by writeDocumentationContents(), and writeInlineDocumentation().

endMemberDocumentation()

void ClassDefImpl::endMemberDocumentation ( OutputList & ol ) const

private

Definition at line 2239 of file classdef.cpp.

{
  //printf("%s: ClassDefImpl::endMemberDocumentation()\n",qPrint(name()));
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    ol.enable(OutputType::Html);
    Doxygen::suppressDocWarnings = false;
  }
}

References Config_getBool, OutputList::enable(), Html, and Doxygen::suppressDocWarnings.

Referenced by writeDocumentationContents(), and writeInlineDocumentation().

findInnerCompound()

const Definition * ClassDefImpl::findInnerCompound ( const DString & name ) const

overridevirtual

Implements Definition.

Definition at line 4387 of file classdef.cpp.

{
  return m_innerClasses.find(name);
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::find(), m_innerClasses, and DefinitionMixin< ClassDefMutable >::name().

findSectionsInDocumentation()

void ClassDefImpl::findSectionsInDocumentation ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 1407 of file classdef.cpp.

{
  docFindSections(briefDescription(),this,docFile());
  docFindSections(documentation(),this,docFile());
  docFindSections(inbodyDocumentation(),this,docFile());
  for (const auto &mg : m_memberGroups)
  {
    mg->findSectionsInDocumentation(this);
  }
  for (auto &ml : m_memberLists)
  {
    if (!ml->listType().isDetailed())
    {
      ml->findSectionsInDocumentation(this);
    }
  }
}

References DefinitionMixin< ClassDefMutable >::briefDescription(), DefinitionMixin< ClassDefMutable >::docFile(), docFindSections(), DefinitionMixin< ClassDefMutable >::documentation(), DefinitionMixin< ClassDefMutable >::inbodyDocumentation(), m_memberGroups, and m_memberLists.

generatedFromFiles()

DString ClassDefImpl::generatedFromFiles ( ) const

overridevirtual

Implements ClassDef.

Definition at line 1728 of file classdef.cpp.

{
  DString result;
  SrcLangExt lang = getLanguage();
  size_t numFiles = m_files.size();
  if (lang==SrcLangExt::Fortran)
  {
    result = theTranslator->trGeneratedFromFilesFortran(
          getLanguage()==SrcLangExt::ObjC && m_compType==Interface ? Class : m_compType,
          numFiles==1);
  }
  else if (isJavaEnum())
  {
    result = theTranslator->trEnumGeneratedFromFiles(numFiles==1);
  }
  else if (m_compType==Service)
  {
    result = theTranslator->trServiceGeneratedFromFiles(numFiles==1);
  }
  else if (m_compType==Singleton)
  {
    result = theTranslator->trSingletonGeneratedFromFiles(numFiles==1);
  }
  else
  {
    result = theTranslator->trGeneratedFromFiles(
          getLanguage()==SrcLangExt::ObjC && m_compType==Interface ? Class : m_compType,
          numFiles==1);
  }
  return result;
}

References ClassDef::Class, DefinitionMixin< ClassDefMutable >::getLanguage(), ClassDef::Interface, isJavaEnum(), m_compType, m_files, ClassDef::Service, ClassDef::Singleton, theTranslator, Translator::trEnumGeneratedFromFiles(), Translator::trGeneratedFromFiles(), Translator::trGeneratedFromFilesFortran(), Translator::trServiceGeneratedFromFiles(), and Translator::trSingletonGeneratedFromFiles().

Referenced by showUsedFiles().

getClasses()

ClassLinkedRefMap ClassDefImpl::getClasses ( ) const

overridevirtual

returns the classes nested into this class

Implements ClassDef.

Definition at line 5038 of file classdef.cpp.

{
  return m_innerClasses;
}

References m_innerClasses.

getExamples()

const ExampleList & ClassDefImpl::getExamples ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5447 of file classdef.cpp.

{
  return m_examples;
}

References m_examples.

getFileDef()

FileDef * ClassDefImpl::getFileDef ( ) const

overridevirtual

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).

Implements ClassDef.

Definition at line 5093 of file classdef.cpp.

{
  return m_fileDef;
}

References m_fileDef.

Referenced by addTypeConstraint(), getOutputFileBase(), isEmbeddedInOuterScope(), and writeTemplateSpec().

getInstanceOutputFileBase()

DString ClassDefImpl::getInstanceOutputFileBase ( ) const

overridevirtual

Implements ClassDef.

Definition at line 4336 of file classdef.cpp.

{
  return m_fileName;
}

References m_fileName.

getMemberByName()

const MemberDef * ClassDefImpl::getMemberByName ( const DString & ) const

overridevirtual

Returns the member with the given name.

Implements ClassDef.

Definition at line 4627 of file classdef.cpp.

{
  const MemberDef *xmd = nullptr;
  const MemberNameInfo *mni = m_allMemberNameInfoLinkedMap.find(name);
  if (mni)
  {
    const int maxInheritanceDepth = 100000;
    int mdist=maxInheritanceDepth;
    for (auto &mi : *mni)
    {
      const ClassDef *mcd=mi->memberDef()->getClassDef();
      int m=minClassDistance(this,mcd);
      //printf("found member in %s linkable=%d m=%d\n",
      //    qPrint(mcd->name()),mcd->isLinkable(),m);
      if (m<mdist)
      {
        mdist=m;
        xmd=mi->memberDef();
      }
    }
  }
  //printf("getMemberByName(%s)=%p\n",qPrint(name),xmd);
  return xmd;
}

References LinkedMap< T, Hash, KeyEqual, Map >::find(), m_allMemberNameInfoLinkedMap, minClassDistance(), and DefinitionMixin< ClassDefMutable >::name().

getMemberGroups()

const MemberGroupList & ClassDefImpl::getMemberGroups ( ) const

overridevirtual

Returns the member groups defined for this class.

Implements ClassDef.

Definition at line 5208 of file classdef.cpp.

{
  return m_memberGroups;
}

References m_memberGroups.

getMemberList()

MemberList * ClassDefImpl::getMemberList ( MemberListType lt ) const

overridevirtual

Returns the members in the list identified by lt.

Implements ClassDef.

Definition at line 4657 of file classdef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    if (ml->listType()==lt)
    {
      return ml.get();
    }
  }
  return nullptr;
}

References m_memberLists.

Referenced by countMemberDeclarations(), countMembersIncludingGrouped(), setAnonymousEnumType(), writeMemberDeclarations(), writeMemberDocumentation(), writePlainMemberDeclaration(), writeSimpleMemberDocumentation(), writeSummaryLinks(), and writeTagFile().

getMemberListFileName()

DString ClassDefImpl::getMemberListFileName ( ) const

overridevirtual

Implements ClassDef.

Definition at line 1014 of file classdef.cpp.

{
  return m_memberListFileName;
}

References m_memberListFileName.

Referenced by writeDocumentation(), writeMemberList(), and writeSummaryLinks().

getMemberLists()

const MemberLists & ClassDefImpl::getMemberLists ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5203 of file classdef.cpp.

{
  return m_memberLists;
}

References m_memberLists.

getModuleDef()

ModuleDef * ClassDefImpl::getModuleDef ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5098 of file classdef.cpp.

{
  return m_moduleDef;
}

References m_moduleDef.

getOutputFileBase()

DString ClassDefImpl::getOutputFileBase ( ) const

overridevirtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements Definition.

Definition at line 4298 of file classdef.cpp.

{
  bool inlineGroupedClasses = Config_getBool(INLINE_GROUPED_CLASSES);
  bool inlineSimpleClasses = Config_getBool(INLINE_SIMPLE_STRUCTS);
  if (!Doxygen::generatingXmlOutput)
  {
    Definition *scope=nullptr;
    if (inlineGroupedClasses && !partOfGroups().empty())
    {
      // point to the group that embeds this class
      return partOfGroups().front()->getOutputFileBase();
    }
    else if (inlineSimpleClasses && m_isSimple && !partOfGroups().empty())
    {
      // point to simple struct inside a group
      return partOfGroups().front()->getOutputFileBase();
    }
    else if (inlineSimpleClasses && m_isSimple && (scope=getOuterScope()))
    {
      if (scope==Doxygen::globalScope && getFileDef() && getFileDef()->isLinkableInProject()) // simple struct embedded in file
      {
        return getFileDef()->getOutputFileBase();
      }
      else if (scope->isLinkableInProject()) // simple struct embedded in other container (namespace/group/class)
      {
        return getOuterScope()->getOutputFileBase();
      }
    }
  }
  AUTO_TRACE("name='{}' m_templateMaster={} m_implicitTemplateInstance={}",name(),(void*)m_templateMaster,m_implicitTemplateInstance);
  if (m_templateMaster && m_implicitTemplateInstance)
  {
    // point to the template of which this class is an instance
    return m_templateMaster->getOutputFileBase();
  }
  return m_fileName;
}

References AUTO_TRACE, Config_getBool, Doxygen::generatingXmlOutput, getFileDef(), DefinitionMixin< ClassDefMutable >::getOuterScope(), Definition::getOutputFileBase(), Doxygen::globalScope, isLinkableInProject(), Definition::isLinkableInProject(), m_fileName, m_implicitTemplateInstance, m_isSimple, m_templateMaster, DefinitionMixin< ClassDefMutable >::name(), and DefinitionMixin< ClassDefMutable >::partOfGroups().

Referenced by addListReferences(), writeDeclarationLink(), writeDetailedDescription(), writeDocumentation(), writeInheritanceGraph(), writeInlineDocumentation(), writeMemberList(), writeMoreLink(), and writeTagFile().

getQualifiers()

StringVector ClassDefImpl::getQualifiers ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5396 of file classdef.cpp.

{
  return m_qualifiers;
}

References m_qualifiers.

getReference()

DString ClassDefImpl::getReference ( ) const

overridevirtual

If this definition was imported via a tag file, this function returns the tagfile for the external project. This can be translated into an external link target via Doxygen::tagDestinationDict

Implements Definition.

Definition at line 4523 of file classdef.cpp.

{
  if (m_templateMaster && m_implicitTemplateInstance)
  {
    return m_templateMaster->getReference();
  }
  else
  {
    return DefinitionMixin::getReference();
  }
}

References Definition::getReference(), DefinitionMixin< Base >::getReference(), m_implicitTemplateInstance, and m_templateMaster.

Referenced by writeDeclarationLink(), and writeMemberList().

getSourceFileBase()

DString ClassDefImpl::getSourceFileBase ( ) const

overridevirtual

Returns the name of the source listing of this definition.

Implements Definition.

Definition at line 4341 of file classdef.cpp.

{
  if (m_templateMaster && m_implicitTemplateInstance)
  {
    return m_templateMaster->getSourceFileBase();
  }
  else
  {
    return DefinitionMixin::getSourceFileBase();
  }
}

References Definition::getSourceFileBase(), DefinitionMixin< Base >::getSourceFileBase(), m_implicitTemplateInstance, and m_templateMaster.

getTemplateBaseClassNames()

const TemplateNameMap & ClassDefImpl::getTemplateBaseClassNames ( ) const

overridevirtual

Implements ClassDef.

Definition at line 4466 of file classdef.cpp.

{
  return m_templBaseClassNames;
}

References m_templBaseClassNames.

getTemplateInstances()

const TemplateInstanceList & ClassDefImpl::getTemplateInstances ( ) const

overridevirtual

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

Returns 0 if not a template or no instances.

Implements ClassDef.

Definition at line 5103 of file classdef.cpp.

{
  return m_templateInstances;
}

References m_templateInstances.

Referenced by internalInsertMember().

getTemplateParameterLists()

ArgumentLists ClassDefImpl::getTemplateParameterLists ( ) const

overridevirtual

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".

Implements ClassDef.

Definition at line 4547 of file classdef.cpp.

{
  ArgumentLists result;
  Definition *d=getOuterScope();
  while (d && d->definitionType()==Definition::TypeClass)
  {
    result.insert(result.begin(),toClassDef(d)->templateArguments());
    d = d->getOuterScope();
  }
  if (!templateArguments().empty())
  {
    result.push_back(templateArguments());
  }
  return result;
}

References Definition::definitionType(), Definition::getOuterScope(), DefinitionMixin< ClassDefMutable >::getOuterScope(), templateArguments(), toClassDef(), and Definition::TypeClass.

getTitleForMemberListType()

void ClassDefImpl::getTitleForMemberListType ( MemberListType type, DString & title, DString & subtitle ) const

private

Definition at line 4822 of file classdef.cpp.

{
  SrcLangExt lang = getLanguage();
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
  {
    if (lde->kind()==LayoutDocEntry::MemberDecl)
    {
      const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
      if (lmd && lmd->type==type)
      {
        title = lmd->title(lang);
        subtitle = lmd->subtitle(lang);
        return;
      }
    }
  }
  title="";
  subtitle="";
}

References DefinitionMixin< ClassDefMutable >::getLanguage(), LayoutDocManager::instance(), LayoutDocEntryMemberDecl::subtitle(), title(), LayoutDocEntryMemberDecl::title(), and LayoutDocEntryMemberDecl::type.

hasCollaborationGraph()

bool ClassDefImpl::hasCollaborationGraph ( ) const

overridevirtual

Implements ClassDefMutable.

Definition at line 5509 of file classdef.cpp.

{
  return m_hasCollaborationGraph;
}

References m_hasCollaborationGraph.

hasDetailedDescription()

bool ClassDefImpl::hasDetailedDescription ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 1681 of file classdef.cpp.

{
  bool repeatBrief = Config_getBool(REPEAT_BRIEF);
  bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
  return ((!briefDescription().empty() && repeatBrief) ||
          (!documentation().empty() || m_tempArgs.hasTemplateDocumentation()) ||
          (sourceBrowser && getStartBodyLine()!=-1 && getBodyDef()) ||
          hasRequirementRefs());
}

References DefinitionMixin< ClassDefMutable >::briefDescription(), Config_getBool, DefinitionMixin< ClassDefMutable >::documentation(), DefinitionMixin< ClassDefMutable >::getBodyDef(), DefinitionMixin< ClassDefMutable >::getStartBodyLine(), DefinitionMixin< ClassDefMutable >::hasRequirementRefs(), ArgumentList::hasTemplateDocumentation(), and m_tempArgs.

Referenced by writeBriefDescription(), and writeDetailedDescription().

hasDocumentation()

bool ClassDefImpl::hasDocumentation ( ) const

overridevirtual

Returns true iff the definition is documented (which could be generated documentation)

See also

hasUserDocumentation()

Implements Definition.

Definition at line 3706 of file classdef.cpp.

{
  return DefinitionMixin::hasDocumentation();
}

References DefinitionMixin< Base >::hasDocumentation().

Referenced by isLinkableInProject(), and isVisibleInHierarchy().

hasExamples()

bool ClassDefImpl::hasExamples ( ) const

overridevirtual

Implements ClassDef.

Definition at line 3457 of file classdef.cpp.

{
  return !m_examples.empty();
}

References m_examples.

Referenced by writeDetailedDocumentationBody(), and writeDocumentationContents().

hasInheritanceGraph()

CLASS_GRAPH_t ClassDefImpl::hasInheritanceGraph ( ) const

overridevirtual

Implements ClassDefMutable.

Definition at line 5482 of file classdef.cpp.

{
  return m_typeInheritanceGraph;
}

References m_typeInheritanceGraph.

hasNamedVariable()

bool ClassDefImpl::hasNamedVariable ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5356 of file classdef.cpp.

{
  return m_hasNamedVariable;
}

References m_hasNamedVariable.

hasNonReferenceSuperClass()

bool ClassDefImpl::hasNonReferenceSuperClass ( ) const

overridevirtual

Returns true iff this class or a class inheriting from this class is not defined in an external tag file.

Implements ClassDef.

Definition at line 3574 of file classdef.cpp.

{
  return hasNonReferenceSuperClassRec(this,0);
}

References hasNonReferenceSuperClassRec().

Referenced by isVisibleInHierarchy().

hideDerivedVariablesInPython()

void ClassDefImpl::hideDerivedVariablesInPython ( ClassDefMutable * cls )

private

Definition at line 4017 of file classdef.cpp.

{
  //printf("hideDerivedVariableInPython()\n");
  if (bClass)
  {
    const MemberNameInfoLinkedMap &srcMnd  = bClass->memberNameInfoLinkedMap();
    MemberNameInfoLinkedMap &dstMnd        = m_allMemberNameInfoLinkedMap;
 
    // recurse up the inheritance hierarchy
    for (const auto &bcd : bClass->baseClasses())
    {
      hideDerivedVariablesInPython(toClassDefMutable(bcd.classDef));
    }
 
    for (auto &srcMni : srcMnd) // for each member in a base class
    {
      //printf("  candidate(%s)\n",qPrint(srcMni->memberName()));
      MemberNameInfo *dstMni=dstMnd.find(srcMni->memberName());
      if (dstMni) // that is also in this class
      {
        MemberNameInfo::iterator it;
        //printf("%s member in %s and %s\n",qPrint(name()),qPrint(bClass->name()),qPrint(name()));
        for (it=dstMni->begin();it!=dstMni->end();)
        {
          MemberDefMutable *dstMd = toMemberDefMutable((*it)->memberDef());
          if (dstMd && dstMd->isVariable() && !dstMd->name().startsWith("__"))
          {
            //printf("  hiding member %s\n",qPrint(dstMd->name()));
            // hide a member variable if it is already defined in a base class, unless
            // it is a __private variable
            removeMemberFromLists(dstMd);
            it = dstMni->erase(it);
          }
          else
          {
            ++it;
          }
        }
        if (dstMni->empty()) // if the list has become empty, remove the entry from the dictionary
        {
          dstMnd.del(srcMni->memberName());
        }
      }
    }
  }
}

References ClassDef::baseClasses(), MemberNameInfo::begin(), LinkedMap< T, Hash, KeyEqual, Map >::del(), MemberNameInfo::empty(), MemberNameInfo::end(), MemberNameInfo::erase(), LinkedMap< T, Hash, KeyEqual, Map >::find(), hideDerivedVariablesInPython(), MemberDef::isVariable(), m_allMemberNameInfoLinkedMap, ClassDef::memberNameInfoLinkedMap(), Definition::name(), removeMemberFromLists(), DString::startsWith(), toClassDefMutable(), and toMemberDefMutable().

Referenced by hideDerivedVariablesInPython(), and mergeMembers().

includeInfo()

const IncludeInfo * ClassDefImpl::includeInfo ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5128 of file classdef.cpp.

{
  return m_incInfo.get();
}

References m_incInfo.

inheritanceGraphFileName()

DString ClassDefImpl::inheritanceGraphFileName ( ) const

overridevirtual

returns the file name to use for the inheritance graph

Implements ClassDef.

Definition at line 5472 of file classdef.cpp.

{
  return m_inheritFileName;
}

References m_inheritFileName.

insertBaseClass()

void ClassDefImpl::insertBaseClass ( ClassDef * cd, const DString & name, Protection p, Specifier s, const DString & t = DString() )

overridevirtual

Implements ClassDefMutable.

Definition at line 1025 of file classdef.cpp.

{
  //printf("*** insert base class %s into %s\n",qPrint(cd->name()),qPrint(name()));
  m_inherits.emplace_back(cd,n,p,s,t);
  m_isSimple = false;
}

References m_inherits, and m_isSimple.

Referenced by mergeCategory().

insertExplicitTemplateInstance()

void ClassDefImpl::insertExplicitTemplateInstance ( ClassDef * instance, const DString & spec )

overridevirtual

Implements ClassDefMutable.

Definition at line 4455 of file classdef.cpp.

{
  AUTO_TRACE("this={} cd={} templSpec={}",name(),templateClass->name(),templSpec);
  m_templateInstances.emplace_back(templSpec,templateClass);
}

References AUTO_TRACE, m_templateInstances, Definition::name(), and DefinitionMixin< ClassDefMutable >::name().

insertMember()

void ClassDefImpl::insertMember ( MemberDef * md )

overridevirtual

Implements ClassDefMutable.

Definition at line 1377 of file classdef.cpp.

{
  internalInsertMember(md,md->protection(),true);
}

References internalInsertMember(), and MemberDef::protection().

Referenced by addMemberToTemplateInstance(), mergeMembersFromBaseClasses(), and reclassifyMember().

insertSubClass()

void ClassDefImpl::insertSubClass ( ClassDef * cd, Protection p, Specifier s, const DString & t = DString() )

overridevirtual

Implements ClassDefMutable.

Definition at line 1034 of file classdef.cpp.

{
  //printf("*** insert sub class %s into %s\n",qPrint(cd->name()),qPrint(name()));
  bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
  if (!extractPrivate && cd->protection()==Protection::Private) return;
  m_inheritedBy.emplace_back(cd,DString(),p,s,t);
  m_isSimple = false;
}

References Config_getBool, m_inheritedBy, m_isSimple, and ClassDef::protection().

insertTemplateInstance()

ClassDef * ClassDefImpl::insertTemplateInstance ( const DString & fileName, int startLine, size_t startColumn, const DString & templSpec, bool & freshInstance )

overridevirtual

Implements ClassDefMutable.

Definition at line 4392 of file classdef.cpp.

{
  freshInstance = false;
  auto it = std::find_if(m_templateInstances.begin(),
                         m_templateInstances.end(),
                         [&templSpec](const auto &ti) { return templSpec==ti.templSpec; });
  ClassDefMutable *templateClass=nullptr;
  if (it!=m_templateInstances.end())
  {
    templateClass = toClassDefMutable((*it).classDef);
  }
  if (templateClass==nullptr)
  {
    DString tcname = removeRedundantWhiteSpace(name()+templSpec);
    AUTO_TRACE("New template instance class name='{}' templSpec='{}' inside '{}' hidden={}",
        name(),templSpec,name(),isHidden());
 
    ClassDef *foundCd = Doxygen::classLinkedMap->find(tcname);
    if (foundCd)
    {
      return foundCd;
    }
    templateClass =
      toClassDefMutable(
          Doxygen::classLinkedMap->add(tcname,
            std::unique_ptr<ClassDef>(
              new ClassDefImpl(fileName,startLine,startColumn,tcname,ClassDef::Class))));
    if (templateClass)
    {
      templateClass->setTemplateMaster(this);
      ArgumentList tal = *stringToArgumentList(getLanguage(),templSpec);
      templateClass->setTemplateArguments(tal);
      templateClass->setOuterScope(getOuterScope());
      templateClass->setHidden(isHidden());
      templateClass->setArtificial(isArtificial());
      templateClass->setImplicitTemplateInstance(true);
      m_templateInstances.emplace_back(templSpec,templateClass);
 
      // also add nested classes
      for (const auto &innerCd : m_innerClasses)
      {
        DString innerName = tcname+"::"+innerCd->localName();
        ClassDefMutable *innerClass =
          toClassDefMutable(
              Doxygen::classLinkedMap->add(innerName,
                std::unique_ptr<ClassDef>(
                  new ClassDefImpl(fileName,startLine,startColumn,innerName,ClassDef::Class))));
        if (innerClass)
        {
          templateClass->addInnerCompound(innerClass);
          innerClass->setOuterScope(templateClass);
          innerClass->setHidden(isHidden());
          innerClass->setArtificial(true);
          innerClass->setImplicitTemplateInstance(true);
        }
      }
      freshInstance=true;
    }
  }
  return templateClass;
}

References DefinitionMutable::addInnerCompound(), AUTO_TRACE, ClassDef::Class, ClassDefImpl(), Doxygen::classLinkedMap, LinkedMap< T, Hash, KeyEqual, Map >::find(), DefinitionMixin< ClassDefMutable >::getLanguage(), DefinitionMixin< ClassDefMutable >::getOuterScope(), DefinitionMixin< ClassDefMutable >::isArtificial(), DefinitionMixin< ClassDefMutable >::isHidden(), m_innerClasses, m_templateInstances, DefinitionMixin< ClassDefMutable >::name(), removeRedundantWhiteSpace(), DefinitionMutable::setArtificial(), DefinitionMutable::setHidden(), ClassDefMutable::setImplicitTemplateInstance(), DefinitionMutable::setOuterScope(), ClassDefMutable::setTemplateArguments(), ClassDefMutable::setTemplateMaster(), stringToArgumentList(), and toClassDefMutable().

insertUsedFile()

void ClassDefImpl::insertUsedFile ( const FileDef * fd )

overridevirtual

Implements ClassDefMutable.

Definition at line 1427 of file classdef.cpp.

{
  if (fd == nullptr) return;
 
  if (std::find(m_files.begin(), m_files.end(), fd) == m_files.end()) m_files.push_back(fd);
 
  for (const auto &ti : m_templateInstances)
  {
    if (ClassDefMutable *cdm = toClassDefMutable(ti.classDef)) cdm->insertUsedFile(fd);
  }
}

References m_files, m_templateInstances, and toClassDefMutable().

internalInsertMember()

void ClassDefImpl::internalInsertMember ( MemberDef * md, Protection prot, bool addToAllList )

private

isReference()

Definition at line 1066 of file classdef.cpp.

{
  AUTO_TRACE("{} name={} isHidden={}",name(),md->name(),md->isHidden());
  if (md->isHidden()) return;
 
  if (getLanguage()==SrcLangExt::VHDL)
  {
    DString title=theTranslator->trVhdlType(md->getVhdlSpecifiers(),false);
    m_vhdlSummaryTitles.insert(title.str());
  }
 
  if (1 /*!isReference()*/) // changed to 1 for showing members of external
                            // classes when HAVE_DOT and UML_LOOK are enabled.
  {
    bool isSimple=false;
 
    /********************************************/
    /* insert member in the declaration section */
    /********************************************/
    if (md->isRelated() && protectionLevelVisible(prot))
    {
      addMemberToList(MemberListType::Related(),md,true);
    }
    else if (md->isFriend())
    {
      addMemberToList(MemberListType::Friends(),md,true);
    }
    else
    {
      switch (md->memberType())
      {
        case MemberType::Service: // UNO IDL
          addMemberToList(MemberListType::Services(),md,true);
          break;
        case MemberType::Interface: // UNO IDL
          addMemberToList(MemberListType::Interfaces(),md,true);
          break;
        case MemberType::Signal: // Qt specific
          addMemberToList(MemberListType::Signals(),md,true);
          break;
        case MemberType::DCOP:   // KDE2 specific
          addMemberToList(MemberListType::DcopMethods(),md,true);
          break;
        case MemberType::Property:
          addMemberToList(MemberListType::Properties(),md,true);
          break;
        case MemberType::Event:
          addMemberToList(MemberListType::Events(),md,true);
          break;
        case MemberType::Slot:   // Qt specific
          switch (prot)
          {
            case Protection::Protected:
            case Protection::Package: // slots in packages are not possible!
              addMemberToList(MemberListType::ProSlots(),md,true);
              break;
            case Protection::Public:
              addMemberToList(MemberListType::PubSlots(),md,true);
              break;
            case Protection::Private:
              addMemberToList(MemberListType::PriSlots(),md,true);
              break;
          }
          break;
        default: // any of the other members
          if (md->isStatic())
          {
            if (md->isVariable())
            {
              switch (prot)
              {
                case Protection::Protected:
                  addMemberToList(MemberListType::ProStaticAttribs(),md,true);
                  break;
                case Protection::Package:
                  addMemberToList(MemberListType::PacStaticAttribs(),md,true);
                  break;
                case Protection::Public:
                  addMemberToList(MemberListType::PubStaticAttribs(),md,true);
                  break;
                case Protection::Private:
                  addMemberToList(MemberListType::PriStaticAttribs(),md,true);
                  break;
              }
            }
            else // function
            {
              switch (prot)
              {
                case Protection::Protected:
                  addMemberToList(MemberListType::ProStaticMethods(),md,true);
                  break;
                case Protection::Package:
                  addMemberToList(MemberListType::PacStaticMethods(),md,true);
                  break;
                case Protection::Public:
                  addMemberToList(MemberListType::PubStaticMethods(),md,true);
                  break;
                case Protection::Private:
                  addMemberToList(MemberListType::PriStaticMethods(),md,true);
                  break;
              }
            }
          }
          else // not static
          {
            if (md->isVariable())
            {
              switch (prot)
              {
                case Protection::Protected:
                  addMemberToList(MemberListType::ProAttribs(),md,true);
                  break;
                case Protection::Package:
                  addMemberToList(MemberListType::PacAttribs(),md,true);
                  break;
                case Protection::Public:
                  {
                    if (md->anonymousMemberForDeclaration()==nullptr) // not a split member that has a separate declaration member
                    {
                      addMemberToList(MemberListType::PubAttribs(),md,true);
                      const int MAX_CELL_SIZE=60;
                      size_t typeLen = removeAnonymousScopes(md->typeString()).length();
                      isSimple = typeLen + md->name().length() + md->argsString().length() <= MAX_CELL_SIZE;
                    }
                  }
                  break;
                case Protection::Private:
                  addMemberToList(MemberListType::PriAttribs(),md,true);
                  break;
              }
            }
            else if (md->isTypedef() || md->isEnumerate() || md->isEnumValue())
            {
              switch (prot)
              {
                case Protection::Protected:
                  addMemberToList(MemberListType::ProTypes(),md,true);
                  break;
                case Protection::Package:
                  addMemberToList(MemberListType::PacTypes(),md,true);
                  break;
                case Protection::Public:
                  addMemberToList(MemberListType::PubTypes(),md,true);
                  isSimple=!md->isEnumerate() &&
                           !md->isEnumValue() &&
                           md->typeString().find(")(")==DString::npos; // func ptr typedef
                  break;
                case Protection::Private:
                  addMemberToList(MemberListType::PriTypes(),md,true);
                  break;
              }
            }
            else // member function
            {
              switch (prot)
              {
                case Protection::Protected:
                  addMemberToList(MemberListType::ProMethods(),md,true);
                  break;
                case Protection::Package:
                  addMemberToList(MemberListType::PacMethods(),md,true);
                  break;
                case Protection::Public:
                  addMemberToList(MemberListType::PubMethods(),md,true);
                  break;
                case Protection::Private:
                  addMemberToList(MemberListType::PriMethods(),md,true);
                  break;
              }
            }
          }
          break;
      }
    }
    if (!isSimple) // not a simple field -> not a simple struct
    {
      m_isSimple = false;
    }
    //printf("adding %s simple=%d total_simple=%d\n",qPrint(md->qualifiedName()),isSimple,m_isSimple);
    if ((!md->isEnumerate() && md->isAnonymous()) || // non-enum anonymous member (e.g. nameless member associated with anonymous struct/union)
        md->anonymousMemberForDetails()!=nullptr)
    {
      return; // The member is split in two, one for the declaration and one for the details.
              // Skip this member if it has an associated member for the details,
              // which implies this is the member for the declaration part only.
    }
 
    /*******************************************************/
    /* insert member in the detailed documentation section */
    /*******************************************************/
    if ((md->isRelated() && protectionLevelVisible(prot)) || md->isFriend())
    {
      addMemberToList(MemberListType::RelatedMembers(),md,false);
    }
    else if (md->isFunction() &&
             md->protection()==Protection::Private &&
             (md->virtualness()!=Specifier::Normal || md->isOverride() || md->isFinal()) &&
             Config_getBool(EXTRACT_PRIV_VIRTUAL))
    {
      addMemberToList(MemberListType::FunctionMembers(),md,false);
    }
    else
    {
      switch (md->memberType())
      {
        case MemberType::Service: // UNO IDL
          addMemberToList(MemberListType::ServiceMembers(),md,false);
          break;
        case MemberType::Interface: // UNO IDL
          addMemberToList(MemberListType::InterfaceMembers(),md,false);
          break;
        case MemberType::Property:
          addMemberToList(MemberListType::PropertyMembers(),md,false);
          break;
        case MemberType::Event:
          addMemberToList(MemberListType::EventMembers(),md,false);
          break;
        case MemberType::Signal: // fall through
        case MemberType::DCOP:
          addMemberToList(MemberListType::FunctionMembers(),md,false);
          break;
        case MemberType::Slot:
          if (protectionLevelVisible(prot))
          {
            addMemberToList(MemberListType::FunctionMembers(),md,false);
          }
          break;
        default: // any of the other members
          if (protectionLevelVisible(prot))
          {
            switch (md->memberType())
            {
              case MemberType::Typedef:
                addMemberToList(MemberListType::TypedefMembers(),md,false);
                break;
              case MemberType::Enumeration:
                addMemberToList(MemberListType::EnumMembers(),md,false);
                break;
              case MemberType::EnumValue:
                addMemberToList(MemberListType::EnumValMembers(),md,false);
                break;
              case MemberType::Function:
                if (md->isConstructor() || md->isDestructor())
                {
                  m_memberLists.get(MemberListType::Constructors(),MemberListContainer::Class)->push_back(md);
                }
                else
                {
                  addMemberToList(MemberListType::FunctionMembers(),md,false);
                }
                break;
              case MemberType::Variable:
                addMemberToList(MemberListType::VariableMembers(),md,false);
                break;
              case MemberType::Define:
                warn(md->getDefFileName(),md->getDefLine()-1,"A define ({}) cannot be made a member of {}",
                     md->name(), this->name());
                break;
              default:
                err("Unexpected member type '{}' found!\n",md->memberTypeName());
            }
          }
          break;
      }
    }
 
    /*************************************************/
    /* insert member in the appropriate member group */
    /*************************************************/
    // Note: this must be done AFTER inserting the member in the
    // regular groups
    //addMemberToGroup(md,groupId);
 
  }
 
  if (md->virtualness()==Specifier::Pure)
  {
    m_isAbstract=true;
  }
 
  if (md->name()=="operator->")
  {
    m_arrowOperator=md;
  }
 
  if (addToAllList && !(Config_getBool(HIDE_FRIEND_COMPOUNDS) && md->isFriend() && isTypeAClassFriend(md->typeString())))
  {
    //printf("=======> adding member %s to class %s\n",qPrint(md->name()),qPrint(name()));
 
    MemberNameInfo *mni = m_allMemberNameInfoLinkedMap.add(md->name());
    mni->push_back(std::make_unique<MemberInfo>(md,prot,md->virtualness(),false,false));
  }
 
  // if we already created template instances before inserting this member (i.e. due to a typedef or using statement)
  // then we also need to insert the member in the template instance.
  for (const auto &ti : getTemplateInstances())
  {
    AUTO_TRACE_ADD("member {} of class {} with template instance {}\n",md->name(),name(),ti.templSpec);
    ClassDefMutable *cdm = toClassDefMutable(ti.classDef);
    if (cdm)
    {
      cdm->addMemberToTemplateInstance(md,templateArguments(),ti.templSpec);
    }
  }
 
}

References LinkedMap< T, Hash, KeyEqual, Map >::add(), addMemberToList(), ClassDefMutable::addMemberToTemplateInstance(), MemberDef::anonymousMemberForDeclaration(), MemberDef::anonymousMemberForDetails(), MemberDef::argsString(), AUTO_TRACE, AUTO_TRACE_ADD, Class, Config_getBool, err, DString::find(), MemberLists::get(), Definition::getDefFileName(), Definition::getDefLine(), DefinitionMixin< ClassDefMutable >::getLanguage(), getTemplateInstances(), MemberDef::getVhdlSpecifiers(), Definition::isAnonymous(), MemberDef::isConstructor(), MemberDef::isDestructor(), MemberDef::isEnumerate(), MemberDef::isEnumValue(), MemberDef::isFinal(), MemberDef::isFriend(), MemberDef::isFunction(), Definition::isHidden(), MemberDef::isOverride(), MemberDef::isRelated(), isSimple(), MemberDef::isStatic(), isTypeAClassFriend(), MemberDef::isTypedef(), MemberDef::isVariable(), DString::length(), m_allMemberNameInfoLinkedMap, m_arrowOperator, m_isAbstract, m_isSimple, m_memberLists, m_vhdlSummaryTitles, MemberDef::memberType(), MemberDef::memberTypeName(), Definition::name(), DefinitionMixin< ClassDefMutable >::name(), DString::npos, MemberDef::protection(), protectionLevelVisible(), MemberNameInfo::push_back(), removeAnonymousScopes(), DString::str(), templateArguments(), theTranslator, title(), toClassDefMutable(), Translator::trVhdlType(), MemberDef::typeString(), MemberDef::virtualness(), and warn.

Referenced by insertMember(), mergeCategory(), and mergeMembersFromBaseClasses().

isAbstract()

bool ClassDefImpl::isAbstract ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5153 of file classdef.cpp.

{
  return m_isAbstract || m_spec.isAbstract();
}

References m_isAbstract, and m_spec.

Referenced by addClassAttributes().

isAccessibleMember()

bool ClassDefImpl::isAccessibleMember ( const MemberDef * md ) const

overridevirtual

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

Implements ClassDef.

Definition at line 4652 of file classdef.cpp.

{
  return md->getClassDef() && isBaseClass(md->getClassDef(),true,DString());
}

References MemberDef::getClassDef(), and isBaseClass().

isBaseClass()

int ClassDefImpl::isBaseClass ( const ClassDef * bcd, bool followInstances, const DString & templSpec ) const

overridevirtual

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.

Implements ClassDef.

Definition at line 3716 of file classdef.cpp.

{
  int distance=0;
  //printf("isBaseClass(cd=%s) looking for %s templSpec=%s\n",qPrint(name()),qPrint(bcd->name()),qPrint(templSpec));
  for (const auto &bclass : baseClasses())
  {
    const ClassDef *ccd = bclass.classDef;
    if (!followInstances && ccd->templateMaster())
    {
      ccd=ccd->templateMaster();
    }
    if (ccd==bcd && (templSpec.empty() || templSpec==bclass.templSpecifiers))
    {
      distance=1;
      break; // no shorter path possible
    }
    else
    {
      int d = ccd->isBaseClass(bcd,followInstances,templSpec);
      if (d>256)
      {
        err("Possible recursive class relation while inside {} and looking for base class {}\n",name(),bcd->name());
        return 0;
      }
      else if (d>0) // path found
      {
        if (distance==0 || d+1<distance) // update if no path found yet or shorter path found
        {
          distance=d+1;
        }
      }
    }
  }
  return distance;
}

References baseClasses(), DString::empty(), err, ClassDef::isBaseClass(), Definition::name(), DefinitionMixin< ClassDefMutable >::name(), and ClassDef::templateMaster().

Referenced by isAccessibleMember().

isCSharp()

bool ClassDefImpl::isCSharp ( ) const

overridevirtual

Returns true if this class is implemented in C#.

Implements ClassDef.

Definition at line 5193 of file classdef.cpp.

{
  return getLanguage()==SrcLangExt::CSharp;
}

References DefinitionMixin< ClassDefMutable >::getLanguage().

isEmbeddedInOuterScope()

bool ClassDefImpl::isEmbeddedInOuterScope ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5311 of file classdef.cpp.

{
  bool inlineGroupedClasses = Config_getBool(INLINE_GROUPED_CLASSES);
  bool inlineSimpleClasses = Config_getBool(INLINE_SIMPLE_STRUCTS);
 
  Definition *container = getOuterScope();
 
  bool containerLinkable =
    container &&
       (
        (container==Doxygen::globalScope && getFileDef() && getFileDef()->isLinkableInProject()) || // global class in documented file
        container->isLinkableInProject() // class in documented scope
       );
 
  if (isAnonymous())
  {
    return false; // don't inline an anonymous class
  }
 
  // inline because of INLINE_GROUPED_CLASSES=YES ?
  bool b1 = (inlineGroupedClasses && !partOfGroups().empty()); // a grouped class
  // inline because of INLINE_SIMPLE_STRUCTS=YES ?
  bool b2 = (inlineSimpleClasses && m_isSimple && // a simple class
             (containerLinkable || // in a documented container
              !partOfGroups().empty()    // or part of a group
             )
           );
  //printf("%s::isEmbeddedInOuterScope(): inlineGroupedClasses=%d "
  //       "inlineSimpleClasses=%d partOfGroups()=%d m_isSimple=%d "
  //       "getOuterScope()=%s b1=%d b2=%d\n",
  //    qPrint(name()),inlineGroupedClasses,inlineSimpleClasses,
  //    !partOfGroups().empty(),m_isSimple,getOuterScope()?qPrint(getOuterScope()->name()):"<none>",b1,b2);
  return b1 || b2;  // either reason will do
}

References Config_getBool, getFileDef(), DefinitionMixin< ClassDefMutable >::getOuterScope(), Doxygen::globalScope, DefinitionMixin< ClassDefMutable >::isAnonymous(), Definition::isLinkableInProject(), m_isSimple, and DefinitionMixin< ClassDefMutable >::partOfGroups().

Referenced by anchor().

isExtension()

bool ClassDefImpl::isExtension ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5428 of file classdef.cpp.

{
  DString n = name();
  size_t si = n.find('(');
  size_t ei = n.find(')');
  bool b = si!=DString::npos && ei!=DString::npos && ei>si && n.mid(si+1,ei-si-1).stripWhiteSpace().empty();
  return b;
}

References DString::empty(), DString::find(), DString::mid(), DefinitionMixin< ClassDefMutable >::name(), DString::npos, and DString::stripWhiteSpace().

Referenced by mergeCategory(), and visibleInParentsDeclList().

isFinal()

bool ClassDefImpl::isFinal ( ) const

overridevirtual

Returns true if this class is marked as final.

Implements ClassDef.

Definition at line 5158 of file classdef.cpp.

{
  return m_spec.isFinal();
}

References m_spec.

Referenced by addClassAttributes().

isFortran()

bool ClassDefImpl::isFortran ( ) const

overridevirtual

Returns true if this class is implemented in Fortran.

Implements ClassDef.

Definition at line 5188 of file classdef.cpp.

{
  return getLanguage()==SrcLangExt::Fortran;
}

References DefinitionMixin< ClassDefMutable >::getLanguage().

Referenced by writeTagFile().

isForwardDeclared()

bool ClassDefImpl::isForwardDeclared ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5173 of file classdef.cpp.

{
  return m_spec.isForwardDecl();
}

References m_spec.

isImplicitTemplateInstance()

bool ClassDefImpl::isImplicitTemplateInstance ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5113 of file classdef.cpp.

{
  return m_implicitTemplateInstance;
}

References m_implicitTemplateInstance.

isInterface()

bool ClassDefImpl::isInterface ( ) const

overridevirtual

Returns true if this class represents an interface.

Implements ClassDef.

Definition at line 5178 of file classdef.cpp.

{
  return m_spec.isInterface();
}

References m_spec.

isJavaEnum()

bool ClassDefImpl::isJavaEnum ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5374 of file classdef.cpp.

{
  return m_isJavaEnum;
}

References m_isJavaEnum.

Referenced by ClassDefImpl(), compoundTypeString(), generatedFromFiles(), and title().

isLinkable()

bool ClassDefImpl::isLinkable ( ) const

overridevirtual

Returns true iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements Definition.

Definition at line 3659 of file classdef.cpp.

{
  if (m_templateMaster && m_implicitTemplateInstance)
  {
    return m_templateMaster->isLinkable();
  }
  else
  {
    return isReference() || isLinkableInProject();
  }
}

References Definition::isLinkable(), isLinkableInProject(), isReference(), m_implicitTemplateInstance, and m_templateMaster.

Referenced by visibleInParentsDeclList(), and writeDeclarationLink().

isLinkableInProject()

bool ClassDefImpl::isLinkableInProject ( ) const

overridevirtual

a link to this class is possible within this project

Implements Definition.

Definition at line 3627 of file classdef.cpp.

{
  bool extractLocal   = Config_getBool(EXTRACT_LOCAL_CLASSES);
  bool extractStatic  = Config_getBool(EXTRACT_STATIC);
  bool hideUndoc      = Config_getBool(HIDE_UNDOC_CLASSES);
  if (m_templateMaster && m_implicitTemplateInstance)
  {
    return m_templateMaster->isLinkableInProject();
  }
  else
  {
    //printf("%s::isLinkableInProject() conditions: artificial=%d hidden=%d anonymous=%d protection=%d local=%d docs=%d static=%d ref=%d\n",
    //      qPrint(name()),
    //      !isArtificial(),
    //      !isHidden(),
    //      !isAnonymous(),
    //      protectionLevelVisible(m_prot),
    //      !m_isLocal   || extractLocal,
    //      hasDocumentation() ||  m_tempArgs.hasTemplateDocumentation() || !hideUndoc,
    //      !m_isStatic  || extractStatic,
    //      !isReference());
    return
      !isArtificial() && !isHidden() &&      /* not hidden */
      !isAnonymous() &&                      /* not anonymous */
      protectionLevelVisible(m_prot)      && /* private/internal */
      (!m_isLocal      || extractLocal)   && /* local */
      (hasDocumentation() || m_tempArgs.hasTemplateDocumentation() || !hideUndoc)     && /* documented */
      (!m_isStatic     || extractStatic)  && /* static */
      !isReference();                        /* not an external reference */
  }
}

References Config_getBool, hasDocumentation(), ArgumentList::hasTemplateDocumentation(), DefinitionMixin< ClassDefMutable >::isAnonymous(), DefinitionMixin< ClassDefMutable >::isArtificial(), DefinitionMixin< ClassDefMutable >::isHidden(), Definition::isLinkableInProject(), isReference(), m_implicitTemplateInstance, m_isLocal, m_isStatic, m_prot, m_tempArgs, m_templateMaster, and protectionLevelVisible().

Referenced by addListReferences(), addRequirementReferences(), getOutputFileBase(), isLinkable(), writeDeclarationLink(), and writeTagFile().

isLocal()

bool ClassDefImpl::isLocal ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5033 of file classdef.cpp.

{
  return m_isLocal;
}

References m_isLocal.

Referenced by visibleInParentsDeclList().

isObjectiveC()

bool ClassDefImpl::isObjectiveC ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5183 of file classdef.cpp.

{
  return getLanguage()==SrcLangExt::ObjC;
}

References DefinitionMixin< ClassDefMutable >::getLanguage().

Referenced by writeTagFile().

isPublished()

bool ClassDefImpl::isPublished ( ) const

overridevirtual

Returns true if this class is marked as published.

Implements ClassDef.

Definition at line 5168 of file classdef.cpp.

{
  return m_spec.isPublished();
}

References m_spec.

Referenced by addClassAttributes().

isReference()

bool ClassDefImpl::isReference ( ) const

overridevirtual

Returns true if this definition is imported via a tag file.

Implements Definition.

Definition at line 4535 of file classdef.cpp.

{
  if (m_templateMaster && m_implicitTemplateInstance)
  {
    return m_templateMaster->isReference();
  }
  else
  {
    return DefinitionMixin::isReference();
  }
}

References Definition::isReference(), DefinitionMixin< Base >::isReference(), m_implicitTemplateInstance, and m_templateMaster.

Referenced by isLinkable(), isLinkableInProject(), and isVisibleInHierarchy().

isSealed()

bool ClassDefImpl::isSealed ( ) const

overridevirtual

Returns true if this class is marked as sealed.

Implements ClassDef.

Definition at line 5163 of file classdef.cpp.

{
  return m_spec.isSealed();
}

References m_spec.

Referenced by addClassAttributes().

isSimple()

bool ClassDefImpl::isSimple ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5273 of file classdef.cpp.

{
  return m_isSimple;
}

References m_isSimple.

Referenced by internalInsertMember(), and writeInlineDocumentation().

isSliceLocal()

bool ClassDefImpl::isSliceLocal ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5457 of file classdef.cpp.

{
  return m_spec.isLocal();
}

References m_spec.

Referenced by title(), and writeDeclarationLink().

isSmartPointer()

const MemberDef * ClassDefImpl::isSmartPointer ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5278 of file classdef.cpp.

{
  return m_arrowOperator;
}

References m_arrowOperator.

isSubClass()

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

overridevirtual

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

Implements ClassDef.

Definition at line 3754 of file classdef.cpp.

{
  bool found=false;
  if (level>256)
  {
    err("Possible recursive class relation while inside {} and looking for derived class {}\n",name(),cd->name());
    return false;
  }
  for (const auto &iscd : subClasses())
  {
    ClassDef *ccd=iscd.classDef;
    found = (ccd==cd) || ccd->isSubClass(cd,level+1);
    if (found) break;
  }
  return found;
}

References err, ClassDef::isSubClass(), Definition::name(), DefinitionMixin< ClassDefMutable >::name(), and subClasses().

isTemplate()

bool ClassDefImpl::isTemplate ( ) const

overridevirtual

Returns true if this class is a template.

Implements ClassDef.

Definition at line 5123 of file classdef.cpp.

{
  return !m_tempArgs.empty();
}

References ArgumentList::empty(), and m_tempArgs.

isTemplateArgument()

bool ClassDefImpl::isTemplateArgument ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5148 of file classdef.cpp.

{
  return m_isTemplArg;
}

References m_isTemplArg.

isUsedOnly()

bool ClassDefImpl::isUsedOnly ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5268 of file classdef.cpp.

{
  return m_usedOnly;
}

References m_usedOnly.

isVisibleInHierarchy()

bool ClassDefImpl::isVisibleInHierarchy ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 3673 of file classdef.cpp.

{
  bool allExternals     = Config_getBool(ALLEXTERNALS);
  bool hideUndocClasses = Config_getBool(HIDE_UNDOC_CLASSES);
  bool extractStatic    = Config_getBool(EXTRACT_STATIC);
 
  //printf("%s: isArtificial=%d isAnonymous=%d protectionLevelVisible=%d hasDocumentation=%d templateInstance=%d static=%d\n",
  //       qPrint(name()),
  //       (allExternals && !isArtificial()) || hasNonReferenceSuperClass(),
  //       !isAnonymous(),
  //       protectionLevelVisible(m_prot),
  //       (hasDocumentation() || !hideUndocClasses || (m_templateMaster && m_templateMaster->hasDocumentation()) || isReference()),
  //       !m_implicitTemplateInstance || !m_inherits.empty() || !m_inheritedBy.empty(),
  //       !m_isStatic || extractStatic);
 
  return // show all classes or a subclass is visible
      ((allExternals && !isArtificial()) || hasNonReferenceSuperClass()) &&
      // and not an anonymous compound
      !isAnonymous() &&
      // and not privately inherited
      protectionLevelVisible(m_prot) &&
      // documented or shown anyway or documentation is external
      (hasDocumentation() ||
       !hideUndocClasses ||
       (m_templateMaster && m_templateMaster->hasDocumentation()) ||
       isReference()
      ) &&
      // if this is an implicit template instance then it most be part of the inheritance hierarchy
      (!m_implicitTemplateInstance || !m_inherits.empty() || !m_inheritedBy.empty()) &&
      // is not part of an unnamed namespace or shown anyway
      (!m_isStatic || extractStatic);
}

References Config_getBool, hasDocumentation(), Definition::hasDocumentation(), hasNonReferenceSuperClass(), DefinitionMixin< ClassDefMutable >::isAnonymous(), DefinitionMixin< ClassDefMutable >::isArtificial(), isReference(), m_implicitTemplateInstance, m_inheritedBy, m_inherits, m_isStatic, m_prot, m_templateMaster, and protectionLevelVisible().

makeTemplateArgument()

void ClassDefImpl::makeTemplateArgument ( bool b = true )

overridevirtual

Implements ClassDefMutable.

Definition at line 5253 of file classdef.cpp.

{
  m_isTemplArg = b;
}

References m_isTemplArg.

memberNameInfoLinkedMap()

const MemberNameInfoLinkedMap & ClassDefImpl::memberNameInfoLinkedMap ( ) const

overridevirtual

Returns a dictionary of all members.

This includes any inherited members. Members are sorted alphabetically.

Implements ClassDef.

Definition at line 5068 of file classdef.cpp.

{
  return m_allMemberNameInfoLinkedMap;
}

References m_allMemberNameInfoLinkedMap.

mergeCategory()

void ClassDefImpl::mergeCategory ( ClassDef * cat )

overridevirtual

Merges the members of a Objective-C category into this class.

Implements ClassDefMutable.

Definition at line 4110 of file classdef.cpp.

{
  AUTO_TRACE();
  ClassDefMutable *category = toClassDefMutable(cat);
  if (category)
  {
    bool extractLocalMethods = Config_getBool(EXTRACT_LOCAL_METHODS);
    bool makePrivate = category->isLocal();
    // in case extract local methods is not enabled we don't add the methods
    // of the category in case it is defined in the .m file.
    if (makePrivate && !extractLocalMethods) return;
    bool isExtension = category->isExtension();
 
    category->setCategoryOf(this);
    if (isExtension)
    {
      category->setArtificial(true);
 
      // copy base classes/protocols from extension
      for (const auto &bcd : category->baseClasses())
      {
        insertBaseClass(bcd.classDef,bcd.usedName,bcd.prot,bcd.virt,bcd.templSpecifiers);
        // correct bcd.classDef so that they do no longer derive from
        // category, but from this class!
        BaseClassList scl = bcd.classDef->subClasses();
        for (auto &scd : scl)
        {
          if (scd.classDef==category)
          {
            scd.classDef=this;
          }
        }
        bcd.classDef->updateSubClasses(scl);
      }
    }
    // make methods private for categories defined in the .m file
    //printf("%s::mergeCategory makePrivate=%d\n",qPrint(name()),makePrivate);
 
    const MemberNameInfoLinkedMap &srcMnd  = category->memberNameInfoLinkedMap();
    MemberNameInfoLinkedMap &dstMnd        = m_allMemberNameInfoLinkedMap;
 
    for (auto &srcMni : srcMnd)
    {
      MemberNameInfo *dstMni=dstMnd.find(srcMni->memberName());
      if (dstMni) // method is already defined in the class
      {
        AUTO_TRACE_ADD("Existing member {}",srcMni->memberName());
        const auto &dstMi = dstMni->front();
        const auto &srcMi = srcMni->front();
        if (srcMi && dstMi)
        {
          MemberDefMutable *smdm = toMemberDefMutable(srcMi->memberDef());
          MemberDefMutable *dmdm = toMemberDefMutable(dstMi->memberDef());
          if (smdm && dmdm)
          {
            combineDeclarationAndDefinition(smdm,dmdm);
            dmdm->setCategory(category);
            dmdm->setCategoryRelation(smdm);
            smdm->setCategoryRelation(dmdm);
          }
        }
      }
      else // new method name
      {
        AUTO_TRACE_ADD("New member {}",srcMni->memberName());
        // create a deep copy of the list
        MemberNameInfo *newMni = dstMnd.add(srcMni->memberName());
 
        // copy the member(s) from the category to this class
        for (auto &mi : *srcMni)
        {
          //printf("Adding '%s'\n",qPrint(mi->memberDef->name()));
          Protection prot = mi->prot();
          //if (makePrivate) prot = Private;
          auto newMd = mi->memberDef()->deepCopy();
          if (newMd)
          {
            auto mmd = toMemberDefMutable(newMd.get());
            AUTO_TRACE_ADD("Copying member {}",mmd->name());
            if (mmd)
            {
              mmd->moveTo(this);
            }
 
            auto newMi=std::make_unique<MemberInfo>(newMd.get(),prot,mi->virt(),mi->inherited(),mi->virtualBaseClass());
            newMi->setScopePath(mi->scopePath());
            newMi->setAmbigClass(mi->ambigClass());
            newMi->setAmbiguityResolutionScope(mi->ambiguityResolutionScope());
            newMni->push_back(std::move(newMi));
 
            // also add the newly created member to the global members list
 
            DString name = newMd->name();
            MemberName *mn = Doxygen::memberNameLinkedMap->add(name);
 
            if (mmd)
            {
              mmd->setCategory(category);
              mmd->setCategoryRelation(mi->memberDef());
            }
            auto miMmd = toMemberDefMutable(mi->memberDef());
            if (miMmd) miMmd->setCategoryRelation(newMd.get());
 
            if (mmd && (makePrivate || isExtension))
            {
              mmd->makeImplementationDetail();
            }
            internalInsertMember(newMd.get(),prot,false);
            mn->push_back(std::move(newMd));
          }
        }
      }
    }
  }
}

References LinkedMap< T, Hash, KeyEqual, Map >::add(), AUTO_TRACE, AUTO_TRACE_ADD, ClassDef::baseClasses(), combineDeclarationAndDefinition(), Config_getBool, LinkedMap< T, Hash, KeyEqual, Map >::find(), MemberNameInfo::front(), insertBaseClass(), internalInsertMember(), ClassDef::isExtension(), isExtension(), ClassDef::isLocal(), m_allMemberNameInfoLinkedMap, ClassDef::memberNameInfoLinkedMap(), Doxygen::memberNameLinkedMap, DefinitionMixin< ClassDefMutable >::name(), MemberName::push_back(), MemberNameInfo::push_back(), DefinitionMutable::setArtificial(), MemberDefMutable::setCategory(), ClassDefMutable::setCategoryOf(), MemberDefMutable::setCategoryRelation(), toClassDefMutable(), and toMemberDefMutable().

mergeMembers()

void ClassDefImpl::mergeMembers ( )

overridevirtual

recursively merges the 'all members' lists of a class base with that of this class. Must only be called for classes without subclasses!

Implements ClassDefMutable.

Definition at line 4069 of file classdef.cpp.

{
  if (m_membersMerged) return;
  if (getLanguage()==SrcLangExt::Python)
  {
    for (const auto &bcd : baseClasses())
    {
      ClassDefMutable *bClass=toClassDefMutable(bcd.classDef);
      hideDerivedVariablesInPython(bClass);
    }
  }
 
  //printf("> %s::mergeMembers()\n",qPrint(name()));
 
  m_membersMerged=true;
 
  // first merge the members of the base class recursively
  for (const auto &bcd : baseClasses())
  {
    ClassDefMutable *bClass=toClassDefMutable(bcd.classDef);
    if (bClass)
    {
      // merge the members in the base class of this inheritance branch first
      bClass->mergeMembers();
    }
  }
 
  // first merge the member that are not inherited via a virtual base class
  // (as this can end up reimplemented via multiple paths, see #10717 for examples)
  mergeMembersFromBaseClasses(false);
  // then process the member that are inherited via a virtual base class to add the
  // ones that are not reimplemented via any path
  mergeMembersFromBaseClasses(true);
 
  //printf("< %s::mergeMembers()\n",qPrint(name()));
}

References baseClasses(), DefinitionMixin< ClassDefMutable >::getLanguage(), hideDerivedVariablesInPython(), m_membersMerged, ClassDefMutable::mergeMembers(), mergeMembersFromBaseClasses(), and toClassDefMutable().

mergeMembersFromBaseClasses()

void ClassDefImpl::mergeMembersFromBaseClasses ( bool mergeVirtualBaseClass )

private

Definition at line 3780 of file classdef.cpp.

{
  SrcLangExt lang = getLanguage();
  DString sep=getLanguageSpecificSeparator(lang,true);
  size_t sepLen = sep.length();
  bool inlineInheritedMembers = Config_getBool(INLINE_INHERITED_MEMB);
  bool extractPrivate         = Config_getBool(EXTRACT_PRIVATE);
 
  auto insertMember = [&](const ClassDef *cd,MemberDef *md,Protection prot)
  {
    if (inlineInheritedMembers && !isStandardFunc(md))
    {
      //printf("      %s::insertMember(%s)\n",qPrint(name()),qPrint(srcMd->name()));
      internalInsertMember(md,prot,false);
      if (!cd->isLinkable()) // if the base is not linkable then move the member to this class
      {
        MemberDefMutable *mdm = toMemberDefMutable(md);
        mdm->moveTo(this);
        mdm->setExplicitInherited(true);
      }
    }
  };
 
  //printf("  mergeMembers for %s mergeVirtualBaseClass=%d\n",qPrint(name()),mergeVirtualBaseClass);
  // the merge the base members with this class' members
  for (const auto &bcd : baseClasses())
  {
    ClassDefMutable *bClass=toClassDefMutable(bcd.classDef);
    if (bClass)
    {
      const MemberNameInfoLinkedMap &srcMnd  = bClass->memberNameInfoLinkedMap();
      MemberNameInfoLinkedMap &dstMnd        = m_allMemberNameInfoLinkedMap;
 
      for (auto &srcMni : srcMnd)
      {
        MemberNameInfo *dstMni=dstMnd.find(srcMni->memberName());
        if (dstMni)
          // a member with that name is already in the class.
          // the member may hide or reimplement the one in the sub class
          // or there may be another path to the base class that is already
          // visited via another branch in the class hierarchy.
        {
          //printf("    %s hides member name %s\n",qPrint(bClass->name()),qPrint(srcMni->memberName()));
          for (auto &srcMi : *srcMni)
          {
            MemberDef *srcMd = srcMi->memberDef();
            bool found=false;
            bool ambiguous=false;
            bool hidden=false;
            const ClassDef *srcCd = srcMd->getClassDef();
            for (auto &dstMi : *dstMni)
            {
              const MemberDef *dstMd = dstMi->memberDef();
              if (srcMd!=dstMd) // different members
              {
                const ClassDef *dstCd = dstMd->getClassDef();
                //printf("  Is %s a base class of %s?\n",qPrint(srcCd->name()),qPrint(dstCd->name()));
                if (srcCd==dstCd || dstCd->isBaseClass(srcCd,true))
                  // member is in the same or a base class
                {
                  const ArgumentList &srcAl = srcMd->argumentList();
                  const ArgumentList &dstAl = dstMd->argumentList();
                  found=matchArguments2(
                      srcMd->getOuterScope(),srcMd->getFileDef(),srcMd->typeString(),&srcAl,
                      dstMd->getOuterScope(),dstMd->getFileDef(),dstMd->typeString(),&dstAl,
                      true,lang
                      );
                  //printf("      Yes, matching (%s<->%s): %d\n",
                  //    qPrint(argListToString(srcMd->argumentList())),
                  //    qPrint(argListToString(dstMd->argumentList())),
                  //    found);
                  hidden = hidden  || !found;
                }
                else // member is in a non base class => multiple inheritance
                     // using the same base class.
                {
                  //printf("       $$ Existing member %s %s add scope %s\n",
                  //    qPrint(dstMi->ambiguityResolutionScope()),
                  //    qPrint(dstMd->name()),
                  //    qPrint(dstMi->scopePath().left(dstMi->scopePath().find("::")+2)));
 
                  size_t scopeSepPos = dstMi->scopePath().find(sep);
                  DString scope = dstMi->scopePath().left(scopeSepPos!=DString::npos ? scopeSepPos+sepLen : 0);
                  if (scope!=dstMi->ambiguityResolutionScope().left(scope.length()))
                  {
                    dstMi->setAmbiguityResolutionScope(scope+dstMi->ambiguityResolutionScope());
                  }
                  ambiguous=true;
                }
              }
              else // same members
              {
                // do not add if base class is virtual or
                // if scope paths are equal or
                // if base class is an interface (and thus implicitly virtual).
                //printf("      same member found srcMi->virt=%d dstMi->virt=%d\n",srcMi->virt(),dstMi->virt());
                if ((srcMi->virt()!=Specifier::Normal && dstMi->virt()!=Specifier::Normal) ||
                    bClass->name()+sep+srcMi->scopePath() == dstMi->scopePath() ||
                    dstMd->getClassDef()->compoundType()==Interface
                   )
                {
                  found=true;
                }
                else // member can be reached via multiple paths in the
                     // inheritance tree
                {
                  //printf("      $$ Existing member %s %s add scope %s\n",
                  //    qPrint(dstMi->ambiguityResolutionScope()),
                  //    qPrint(dstMd->name()),
                  //    qPrint(dstMi->scopePath().left(dstMi->scopePath().find("::")+2)));
 
                  size_t scopeSepPos = dstMi->scopePath().find(sep);
                  DString scope = dstMi->scopePath().left(scopeSepPos!=DString::npos ? scopeSepPos+sepLen : 0);
                  if (scope!=dstMi->ambiguityResolutionScope().left(scope.length()))
                  {
                    dstMi->setAmbiguityResolutionScope(dstMi->ambiguityResolutionScope()+scope);
                  }
                  ambiguous=true;
                }
              }
              if (found) break;
            }
            //printf("      member %s::%s hidden %d ambiguous %d srcMi->ambigClass=%p found=%d\n",
            //    qPrint(srcCd->name()),qPrint(srcMd->name()),hidden,ambiguous,
            //    (void*)srcMi->ambigClass(),found);
 
            // TODO: fix the case where a member is hidden by inheritance
            //       of a member with the same name but with another prototype,
            //       while there is more than one path to the member in the
            //       base class due to multiple inheritance. In this case
            //       it seems that the member is not reachable by prefixing a
            //       scope name either (according to my compiler). Currently,
            //       this case is shown anyway.
            if (!found && srcMd->protection()!=Protection::Private && !srcMd->isFriend() &&
                srcMi->virtualBaseClass()==mergeVirtualBaseClass && lang!=SrcLangExt::Python)
            {
              Protection prot = srcMd->protection();
              if (bcd.prot==Protection::Protected && prot==Protection::Public)
              {
                prot = bcd.prot;
              }
              else if (bcd.prot==Protection::Private)
              {
                prot = bcd.prot;
              }
 
              insertMember(bClass,srcMd,prot);
 
              Specifier virt=srcMi->virt();
              if (virt==Specifier::Normal && bcd.virt!=Specifier::Normal) virt=bcd.virt;
              bool virtualBaseClass = bcd.virt!=Specifier::Normal;
 
              auto newMi = std::make_unique<MemberInfo>(srcMd,prot,virt,true,virtualBaseClass);
              newMi->setScopePath(bClass->name()+sep+srcMi->scopePath());
              if (ambiguous)
              {
                //printf("$$ New member %s %s add scope %s::\n",
                //     qPrint(srcMi->ambiguityResolutionScope),
                //     qPrint(srcMd->name()),
                //     qPrint(bClass->name()));
 
                DString scope=bClass->name()+sep;
                if (scope!=srcMi->ambiguityResolutionScope().left(scope.length()))
                {
                  newMi->setAmbiguityResolutionScope(scope+srcMi->ambiguityResolutionScope());
                }
              }
              if (hidden)
              {
                if (srcMi->ambigClass()==nullptr)
                {
                  newMi->setAmbigClass(bClass);
                  newMi->setAmbiguityResolutionScope(bClass->name()+sep);
                }
                else
                {
                  newMi->setAmbigClass(srcMi->ambigClass());
                  newMi->setAmbiguityResolutionScope(srcMi->ambigClass()->name()+sep);
                }
              }
              dstMni->push_back(std::move(newMi));
            }
          }
        }
        else // base class has a member that is not in the sub class => copy
        {
          //printf("    %s adds member name %s\n",qPrint(bClass->name()),qPrint(srcMni->memberName()));
          // create a deep copy of the list (only the MemberInfo's will be
          // copied, not the actual MemberDef's)
          MemberNameInfo *newMni = dstMnd.add(srcMni->memberName());
 
          // copy the member(s) from the base to the sub class
          for (auto &mi : *srcMni)
          {
            if (mi->virtualBaseClass()==mergeVirtualBaseClass && !mi->memberDef()->isFriend()) // don't inherit friends
            {
              Protection prot = mi->prot();
              if (bcd.prot==Protection::Protected)
              {
                if (prot==Protection::Public) prot=Protection::Protected;
              }
              else if (bcd.prot==Protection::Private)
              {
                prot=Protection::Private;
              }
              Specifier virt=mi->virt();
              bool virtualBaseClass = bcd.virt!=Specifier::Normal || mi->virtualBaseClass();
              if (virt==Specifier::Normal && bcd.virt!=Specifier::Normal) virt=bcd.virt;
              //printf("      %s::%s: [mi.prot=%d, bcd.prot=%d => prot=%d], [mi.virt=%d, bcd.virt=%d => virt=%d] virtualBase=%d\n",
              //    qPrint(name()),qPrint(mi->memberDef()->name()),
              //    mi->prot(),bcd.prot,prot,
              //    mi->virt(),bcd.virt,virt,
              //    virtualBaseClass
              //    );
 
              if (prot!=Protection::Private || extractPrivate)
              {
                insertMember(bClass,mi->memberDef(),prot);
 
                //printf("Adding!\n");
                std::unique_ptr<MemberInfo> newMi = std::make_unique<MemberInfo>(mi->memberDef(),prot,virt,true,virtualBaseClass);
                newMi->setScopePath(bClass->name()+sep+mi->scopePath());
                newMi->setAmbigClass(mi->ambigClass());
                newMi->setAmbiguityResolutionScope(mi->ambiguityResolutionScope());
                newMni->push_back(std::move(newMi));
              }
            }
          }
        }
      }
    }
  }
}

References LinkedMap< T, Hash, KeyEqual, Map >::add(), MemberDef::argumentList(), baseClasses(), ClassDef::compoundType(), Config_getBool, LinkedMap< T, Hash, KeyEqual, Map >::find(), MemberDef::getClassDef(), MemberDef::getFileDef(), DefinitionMixin< ClassDefMutable >::getLanguage(), getLanguageSpecificSeparator(), Definition::getOuterScope(), insertMember(), ClassDef::Interface, internalInsertMember(), ClassDef::isBaseClass(), MemberDef::isFriend(), Definition::isLinkable(), isStandardFunc(), DString::left(), DString::length(), m_allMemberNameInfoLinkedMap, matchArguments2(), ClassDef::memberNameInfoLinkedMap(), MemberDef::moveTo(), Definition::name(), DString::npos, MemberDef::protection(), MemberNameInfo::push_back(), MemberDefMutable::setExplicitInherited(), toClassDefMutable(), toMemberDefMutable(), and MemberDef::typeString().

Referenced by mergeMembers().

moveTo()

void ClassDefImpl::moveTo ( Definition * scope )

overridevirtual

Implements ClassDef.

Definition at line 1000 of file classdef.cpp.

{
  //printf("%s::moveTo(%s)\n",qPrint(name()),qPrint(scope->name()));
  setOuterScope(scope);
  if (scope->definitionType()==Definition::TypeFile)
  {
    m_fileDef = toFileDef(scope);
  }
  else if (scope->definitionType()==Definition::TypeModule)
  {
    m_moduleDef = toModuleDef(scope);
  }
}

References Definition::definitionType(), m_fileDef, m_moduleDef, DefinitionMixin< ClassDefMutable >::setOuterScope(), toFileDef(), toModuleDef(), Definition::TypeFile, and Definition::TypeModule.

overrideCollaborationGraph()

void ClassDefImpl::overrideCollaborationGraph ( bool e )

overridevirtual

Implements ClassDefMutable.

Definition at line 5504 of file classdef.cpp.

{
  m_hasCollaborationGraph=e;
}

References m_hasCollaborationGraph.

overrideInheritanceGraph()

void ClassDefImpl::overrideInheritanceGraph ( CLASS_GRAPH_t e )

overridevirtual

Implements ClassDefMutable.

Definition at line 5477 of file classdef.cpp.

{
  m_typeInheritanceGraph=e;
}

References m_typeInheritanceGraph.

protection()

Protection ClassDefImpl::protection ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5083 of file classdef.cpp.

{
  return m_prot;
}

References m_prot.

Referenced by visibleInParentsDeclList(), and writeDeclarationLink().

qualifiedNameWithTemplateParameters()

DString ClassDefImpl::qualifiedNameWithTemplateParameters ( const ArgumentLists * actualParams = nullptr, uint32_t * actualParamIndex = nullptr ) const

overridevirtual

Implements ClassDef.

Definition at line 4563 of file classdef.cpp.

{
  return makeQualifiedNameWithTemplateParameters(this,actualParams,actualParamIndex);
}

References makeQualifiedNameWithTemplateParameters().

reclassifyMember()

void ClassDefImpl::reclassifyMember ( MemberDefMutable * md, MemberType t )

overridevirtual

Implements ClassDefMutable.

Definition at line 5283 of file classdef.cpp.

{
  md->setMemberType(t);
  for (auto &ml : m_memberLists)
  {
    ml->remove(md);
  }
  insertMember(md);
}

References insertMember(), m_memberLists, and MemberDefMutable::setMemberType().

removeMemberFromLists()

void ClassDefImpl::removeMemberFromLists ( MemberDef * md )

overridevirtual

Implements ClassDefMutable.

Definition at line 5366 of file classdef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    ml->remove(md);
  }
}

References m_memberLists.

Referenced by hideDerivedVariablesInPython().

requiresClause()

DString ClassDefImpl::requiresClause ( ) const

overridevirtual

Implements ClassDef.

Definition at line 3579 of file classdef.cpp.

{
  return m_requiresClause;
}

References m_requiresClause.

setAnonymousEnumType()

void ClassDefImpl::setAnonymousEnumType ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 4746 of file classdef.cpp.

{
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
  {
    if (lde->kind()==LayoutDocEntry::MemberDecl)
    {
      const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
      if (lmd)
      {
        MemberList * ml = getMemberList(lmd->type);
        if (ml)
        {
          ml->setAnonymousEnumType();
        }
      }
    }
    else if (lde->kind()==LayoutDocEntry::MemberGroups)
    {
      for (const auto &mg : m_memberGroups)
      {
        mg->setAnonymousEnumType();
      }
    }
  }
}

References getMemberList(), LayoutDocManager::instance(), m_memberGroups, MemberList::setAnonymousEnumType(), and LayoutDocEntryMemberDecl::type.

setCategoryOf()

void ClassDefImpl::setCategoryOf ( ClassDef * cd )

overridevirtual

Implements ClassDefMutable.

Definition at line 5258 of file classdef.cpp.

{
  m_categoryOf = cd;
}

References m_categoryOf.

setClassName()

void ClassDefImpl::setClassName ( const DString & name )

overridevirtual

Implements ClassDefMutable.

Definition at line 4580 of file classdef.cpp.

{
  m_className = name;
}

References m_className, and DefinitionMixin< ClassDefMutable >::name().

setClassSpecifier()

void ClassDefImpl::setClassSpecifier ( TypeSpecifier spec )

overridevirtual

Implements ClassDefMutable.

Definition at line 5379 of file classdef.cpp.

{
  m_spec = spec;
}

References m_spec.

setCompoundType()

void ClassDefImpl::setCompoundType ( CompoundType t )

overridevirtual

Implements ClassDefMutable.

Definition at line 5242 of file classdef.cpp.

{
  m_compType = t;
}

References m_compType.

setFileDef()

void ClassDefImpl::setFileDef ( FileDef * fd )

overridevirtual

Implements ClassDefMutable.

Definition at line 5213 of file classdef.cpp.

{
  m_fileDef = fd;
}

References m_fileDef.

setGroupDefForAllMembers()

void ClassDefImpl::setGroupDefForAllMembers ( GroupDef * g, Grouping::GroupPri_t pri, const DString & fileName, int startLine, bool hasDocs )

overridevirtual

Implements ClassDefMutable.

Definition at line 4353 of file classdef.cpp.

{
  gd->addClass(this);
  //printf("ClassDefImpl::setGroupDefForAllMembers(%s)\n",qPrint(gd->name()));
  for (auto &mni : m_allMemberNameInfoLinkedMap)
  {
    for (auto &mi : *mni)
    {
      MemberDefMutable *md = toMemberDefMutable(mi->memberDef());
      if (md)
      {
        md->setGroupDef(gd,pri,fileName,startLine,hasDocs);
        gd->insertMember(md,true);
        ClassDefMutable *innerClass = toClassDefMutable(const_cast<ClassDef*>(md->getClassDefOfAnonymousType()));
        if (innerClass) innerClass->setGroupDefForAllMembers(gd,pri,fileName,startLine,hasDocs);
      }
    }
  }
}

References GroupDef::addClass(), MemberDef::getClassDefOfAnonymousType(), GroupDef::insertMember(), m_allMemberNameInfoLinkedMap, MemberDefMutable::setGroupDef(), ClassDefMutable::setGroupDefForAllMembers(), toClassDefMutable(), and toMemberDefMutable().

setHasNamedVariable()

void ClassDefImpl::setHasNamedVariable ( bool b )

overridevirtual

Implements ClassDefMutable.

Definition at line 5361 of file classdef.cpp.

{
  m_hasNamedVariable = b;
}

References m_hasNamedVariable.

setImplicitTemplateInstance()

void ClassDefImpl::setImplicitTemplateInstance ( bool b )

overridevirtual

Implements ClassDefMutable.

Definition at line 5118 of file classdef.cpp.

{
  m_implicitTemplateInstance = b;
}

References m_implicitTemplateInstance.

setIncludeFile()

void ClassDefImpl::setIncludeFile ( FileDef * fd, const DString & incName, bool local, bool force )

overridevirtual

Implements ClassDefMutable.

Definition at line 1461 of file classdef.cpp.

{
  //printf("ClassDefImpl::setIncludeFile(%p,%s,%d,%d)\n",fd,includeName,local,force);
  if (!m_incInfo) m_incInfo = std::make_unique<IncludeInfo>();
  if ((!includeName.empty() && m_incInfo->includeName.empty()) ||
      (fd!=nullptr && m_incInfo->fileDef==nullptr)
     )
  {
    //printf("Setting file info\n");
    m_incInfo->fileDef     = fd;
    m_incInfo->includeName = includeName;
    m_incInfo->kind        = local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem;
  }
  if (force && !includeName.empty())
  {
    m_incInfo->includeName = includeName;
    m_incInfo->kind        = local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem;
  }
}

References DString::empty(), IncludeLocal, IncludeSystem, and m_incInfo.

setIsStatic()

void ClassDefImpl::setIsStatic ( bool b )

overridevirtual

Implements ClassDefMutable.

Definition at line 5237 of file classdef.cpp.

{
  m_isStatic=b;
}

References m_isStatic.

setMetaData()

void ClassDefImpl::setMetaData ( const DString & md )

overridevirtual

Implements ClassDefMutable.

Definition at line 5462 of file classdef.cpp.

{
  m_metaData = md;
}

References m_metaData.

setModuleDef()

void ClassDefImpl::setModuleDef ( ModuleDef * mod )

overridevirtual

Implements ClassDefMutable.

Definition at line 5218 of file classdef.cpp.

{
  m_moduleDef = mod;
}

References m_moduleDef.

setPrimaryConstructorParams()

void ClassDefImpl::setPrimaryConstructorParams ( const ArgumentList & list )

overridevirtual

Implements ClassDefMutable.

Definition at line 3589 of file classdef.cpp.

{
  m_primaryConstructorParams = list;
}

References m_primaryConstructorParams.

setProtection()

void ClassDefImpl::setProtection ( Protection p )

overridevirtual

Implements ClassDefMutable.

Definition at line 5228 of file classdef.cpp.

{
  m_prot=p;
  if (getLanguage()==SrcLangExt::VHDL && VhdlDocGen::convert(p)==VhdlDocGen::ARCHITECTURECLASS)
  {
    m_className = name();
  }
}

References VhdlDocGen::ARCHITECTURECLASS, VhdlDocGen::convert(), DefinitionMixin< ClassDefMutable >::getLanguage(), m_className, m_prot, and DefinitionMixin< ClassDefMutable >::name().

setRequiresClause()

void ClassDefImpl::setRequiresClause ( const DString & req )

overridevirtual

Implements ClassDefMutable.

Definition at line 3584 of file classdef.cpp.

{
  m_requiresClause = req;
}

References m_requiresClause.

setSubGrouping()

void ClassDefImpl::setSubGrouping ( bool enabled )

overridevirtual

Implements ClassDefMutable.

Definition at line 5223 of file classdef.cpp.

{
  m_subGrouping = enabled;
}

References m_subGrouping.

setTaglessParent()

void ClassDefImpl::setTaglessParent ( const ClassDef * cd )

overridevirtual

Implements ClassDefMutable.

Definition at line 5351 of file classdef.cpp.

{
  m_taglessParent = cd;
}

References m_taglessParent.

setTemplateArguments()

void ClassDefImpl::setTemplateArguments ( const ArgumentList & al )

overridevirtual

Implements ClassDefMutable.

Definition at line 3531 of file classdef.cpp.

{
  m_tempArgs = al;
}

References m_tempArgs.

setTemplateBaseClassNames()

void ClassDefImpl::setTemplateBaseClassNames ( const TemplateNameMap & templateNames )

overridevirtual

Implements ClassDefMutable.

Definition at line 4461 of file classdef.cpp.

{
  m_templBaseClassNames = templateNames;
}

References m_templBaseClassNames.

setTemplateMaster()

void ClassDefImpl::setTemplateMaster ( const ClassDef * tm )

overridevirtual

Implements ClassDefMutable.

Definition at line 5247 of file classdef.cpp.

{
  ASSERT(tm!=this);
  m_templateMaster=tm;
}

References ASSERT, and m_templateMaster.

setTypeConstraints()

void ClassDefImpl::setTypeConstraints ( const ArgumentList & al )

overridevirtual

Implements ClassDefMutable.

Definition at line 3526 of file classdef.cpp.

{
  m_typeConstraints = al;
}

References m_typeConstraints.

setUsedOnly()

void ClassDefImpl::setUsedOnly ( bool b )

overridevirtual

Implements ClassDefMutable.

Definition at line 5263 of file classdef.cpp.

{
  m_usedOnly = b;
}

References m_usedOnly.

showUsedFiles()

void ClassDefImpl::showUsedFiles ( OutputList & ol ) const

private

Definition at line 1760 of file classdef.cpp.

{
  ol.pushGeneratorState();
  ol.disable(OutputType::Man);
 
 
  ol.writeRuler();
  ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Docbook);
    ol.startParagraph();
    ol.parseText(generatedFromFiles());
    ol.endParagraph();
  ol.popGeneratorState();
  ol.disable(OutputType::Docbook);
    ol.parseText(generatedFromFiles());
  ol.enable(OutputType::Docbook);
 
  bool first=true;
  for (const auto &fd : m_files)
  {
    if (first)
    {
      first=false;
      ol.startItemList();
    }
 
    ol.startItemListItem();
    DString path=fd->getPath();
    if (Config_getBool(FULL_PATH_NAMES))
    {
      ol.docify(stripFromPath(path));
    }
 
    DString fname = fd->name();
    if (!fd->getVersion().empty()) // append version if available
    {
      fname += " (" + fd->getVersion() + ")";
    }
 
    // for HTML
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Html);
    if (fd->generateSourceFile())
    {
      ol.writeObjectLink(DString(),fd->getSourceFileBase(),DString(),fname);
    }
    else if (fd->isLinkable())
    {
      ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),DString(),fname);
    }
    else
    {
      ol.startBold();
      ol.docify(fname);
      ol.endBold();
    }
    ol.popGeneratorState();
 
    // for other output formats
    ol.pushGeneratorState();
    ol.disable(OutputType::Html);
    if (fd->isLinkable())
    {
      ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),DString(),fname);
    }
    else
    {
      ol.docify(fname);
    }
    ol.popGeneratorState();
 
    ol.endItemListItem();
  }
  if (!first) ol.endItemList();
 
  ol.popGeneratorState();
}

References Config_getBool, OutputList::disable(), OutputList::disableAllBut(), Docbook, OutputList::docify(), OutputList::enable(), OutputList::endBold(), OutputList::endItemList(), OutputList::endItemListItem(), OutputList::endParagraph(), generatedFromFiles(), Html, m_files, Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startBold(), OutputList::startItemList(), OutputList::startItemListItem(), OutputList::startParagraph(), stripFromPath(), OutputList::writeObjectLink(), and OutputList::writeRuler().

Referenced by writeDocumentationContents().

sortAllMembersList()

void ClassDefImpl::sortAllMembersList ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 5073 of file classdef.cpp.

{
  std::stable_sort(m_allMemberNameInfoLinkedMap.begin(),
            m_allMemberNameInfoLinkedMap.end(),
            [](const auto &m1,const auto &m2)
            {
              return dstricmp_sort(m1->memberName(),m2->memberName())<0;
            });
}

References LinkedMap< T, Hash, KeyEqual, Map >::begin(), LinkedMap< T, Hash, KeyEqual, Map >::end(), and m_allMemberNameInfoLinkedMap.

sortMemberLists()

void ClassDefImpl::sortMemberLists ( )

overridevirtual

Implements ClassDefMutable.

Definition at line 4689 of file classdef.cpp.

{
  for (auto &ml : m_memberLists)
  {
    if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(false); }
  }
  if (Config_getBool(SORT_BRIEF_DOCS))
  {
    std::stable_sort(m_innerClasses.begin(),
              m_innerClasses.end(),
              [](const auto &c1,const auto &c2)
              {
                 return Config_getBool(SORT_BY_SCOPE_NAME)                ?
                        dstricmp_sort(c1->name(),      c2->name()     )<0 :
                        dstricmp_sort(c1->className(), c2->className())<0 ;
              });
  }
}

References LinkedRefMap< T, Hash, KeyEqual, Map >::begin(), Config_getBool, LinkedRefMap< T, Hash, KeyEqual, Map >::end(), m_innerClasses, and m_memberLists.

startMemberDeclarations()

void ClassDefImpl::startMemberDeclarations ( OutputList & ol ) const

private

Definition at line 2249 of file classdef.cpp.

{
  //printf("%s: ClassDefImpl::startMemberDeclarations()\n",qPrint(name()));
  ol.startMemberSections();
}

References OutputList::startMemberSections().

Referenced by writeDocumentationContents(), and writeInlineDocumentation().

startMemberDocumentation()

void ClassDefImpl::startMemberDocumentation ( OutputList & ol ) const

private

Definition at line 2229 of file classdef.cpp.

{
  //printf("%s: ClassDefImpl::startMemberDocumentation()\n",qPrint(name()));
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    ol.disable(OutputType::Html);
    Doxygen::suppressDocWarnings = true;
  }
}

References Config_getBool, OutputList::disable(), Html, and Doxygen::suppressDocWarnings.

Referenced by writeDocumentationContents(), and writeInlineDocumentation().

subClasses()

const BaseClassList & ClassDefImpl::subClasses ( ) const

overridevirtual

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

Implements ClassDef.

Definition at line 5058 of file classdef.cpp.

{
  return m_inheritedBy;
}

References m_inheritedBy.

Referenced by isSubClass().

subGrouping()

bool ClassDefImpl::subGrouping ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5452 of file classdef.cpp.

{
  return m_subGrouping;
}

References m_subGrouping.

taglessParent()

const ClassDef * ClassDefImpl::taglessParent ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5346 of file classdef.cpp.

{
  return m_taglessParent;
}

References m_taglessParent.

templateArguments()

const ArgumentList & ClassDefImpl::templateArguments ( ) const

overridevirtual

Returns the template arguments of this class.

Implements ClassDef.

Definition at line 5088 of file classdef.cpp.

{
  return m_tempArgs;
}

References m_tempArgs.

Referenced by addMembersToTemplateInstance(), addMemberToTemplateInstance(), className(), getTemplateParameterLists(), and internalInsertMember().

templateMaster()

const ClassDef * ClassDefImpl::templateMaster ( ) const

overridevirtual

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

Returns 0 if not applicable.

Implements ClassDef.

Definition at line 5108 of file classdef.cpp.

{
  return m_templateMaster;
}

References m_templateMaster.

templateTypeConstraints()

const ConstraintClassList & ClassDefImpl::templateTypeConstraints ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5143 of file classdef.cpp.

{
  return m_constraintClassList;
}

References m_constraintClassList.

title()

DString ClassDefImpl::title ( ) const

overridevirtual

Implements ClassDef.

Definition at line 2935 of file classdef.cpp.

{
  DString pageTitle;
  SrcLangExt lang = getLanguage();
 
  auto getReferenceTitle = [this](std::function<DString()> translateFunc) -> DString
  {
    return Config_getBool(HIDE_COMPOUND_REFERENCE) ? displayName() : translateFunc();
  };
 
  if (lang==SrcLangExt::Fortran)
  {
    pageTitle = getReferenceTitle([this](){
      return theTranslator->trCompoundReferenceFortran(displayName(), m_compType, !m_tempArgs.empty());
    });
  }
  else if (lang==SrcLangExt::Slice)
  {
    pageTitle = getReferenceTitle([this](){
      return theTranslator->trCompoundReferenceSlice(displayName(), m_compType, isSliceLocal());
    });
  }
  else if (lang==SrcLangExt::VHDL)
  {
    pageTitle = getReferenceTitle([this](){
      return theTranslator->trCustomReference(VhdlDocGen::getClassTitle(this));
    });
  }
  else if (lang==SrcLangExt::CSharp && !m_primaryConstructorParams.empty())
  {
    pageTitle = getReferenceTitle([this](){
      return theTranslator->trCompoundReference(displayName()+argListToString(m_primaryConstructorParams),
              m_compType,
              !m_tempArgs.empty());
    });
  }
  else if (isJavaEnum())
  {
    pageTitle = getReferenceTitle([this](){
      return theTranslator->trEnumReference(displayName());
    });
  }
  else if (m_compType==Service)
  {
    pageTitle = getReferenceTitle([this](){
      return theTranslator->trServiceReference(displayName());
    });
  }
  else if (m_compType==Singleton)
  {
    pageTitle = getReferenceTitle([this](){
      return theTranslator->trSingletonReference(displayName());
    });
  }
  else
  {
    pageTitle = getReferenceTitle([this](){
      return theTranslator->trCompoundReference(displayName(),
              m_compType == Interface && getLanguage()==SrcLangExt::ObjC ? Class : m_compType,
              !m_tempArgs.empty());
    });
  }
  return pageTitle;
}

References argListToString(), ClassDef::Class, Config_getBool, displayName(), ArgumentList::empty(), VhdlDocGen::getClassTitle(), DefinitionMixin< ClassDefMutable >::getLanguage(), ClassDef::Interface, isJavaEnum(), isSliceLocal(), m_compType, m_primaryConstructorParams, m_tempArgs, ClassDef::Service, ClassDef::Singleton, theTranslator, Translator::trCompoundReference(), Translator::trCompoundReferenceFortran(), Translator::trCompoundReferenceSlice(), Translator::trCustomReference(), Translator::trEnumReference(), Translator::trServiceReference(), and Translator::trSingletonReference().

Referenced by addUsedInterfaceClasses(), getTitleForMemberListType(), internalInsertMember(), writeDetailedDescription(), writeDocumentation(), writeInheritedMemberDeclarations(), writeMemberDeclarations(), writeMemberDocumentation(), and writeNestedClasses().

typeConstraints()

const ArgumentList & ClassDefImpl::typeConstraints ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5442 of file classdef.cpp.

{
  return m_typeConstraints;
}

References m_typeConstraints.

updateBaseClasses()

void ClassDefImpl::updateBaseClasses ( const BaseClassList & bcd )

overridevirtual

Update the list of base classes to the one passed.

Implements ClassDef.

Definition at line 5053 of file classdef.cpp.

{
  m_inherits = bcd;
}

References m_inherits.

updateSubClasses()

void ClassDefImpl::updateSubClasses ( const BaseClassList & bcd )

overridevirtual

Update the list of sub classes to the one passed.

Implements ClassDef.

Definition at line 5063 of file classdef.cpp.

{
  m_inheritedBy = bcd;
}

References m_inheritedBy.

usedByImplementationClasses()

const UsesClassList & ClassDefImpl::usedByImplementationClasses ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5138 of file classdef.cpp.

{
  return m_usedByImplClassList;
}

References m_usedByImplClassList.

usedFiles()

const FileList & ClassDefImpl::usedFiles ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5437 of file classdef.cpp.

{
  return m_files;
}

References m_files.

usedImplementationClasses()

const UsesClassList & ClassDefImpl::usedImplementationClasses ( ) const

overridevirtual

Implements ClassDef.

Definition at line 5133 of file classdef.cpp.

{
  return m_usesImplClassList;
}

References m_usesImplClassList.

visibleInParentsDeclList()

bool ClassDefImpl::visibleInParentsDeclList ( ) const

overridevirtual

show this class in the declaration section of its parent?

Implements ClassDef.

Definition at line 2626 of file classdef.cpp.

{
  bool extractPrivate      = Config_getBool(EXTRACT_PRIVATE);
  bool hideUndocClasses = Config_getBool(HIDE_UNDOC_CLASSES);
  bool extractLocalClasses = Config_getBool(EXTRACT_LOCAL_CLASSES);
  bool linkable = isLinkable();
  return (!isAnonymous() && !isExtension() &&
          (protection()!=Protection::Private || extractPrivate) &&
          (linkable || (!hideUndocClasses && (!isLocal() || extractLocalClasses)))
         );
}

References Config_getBool, DefinitionMixin< ClassDefMutable >::isAnonymous(), isExtension(), isLinkable(), isLocal(), and protection().

Referenced by writeDeclarationLink().

writeAdditionalInheritedMembers()

void ClassDefImpl::writeAdditionalInheritedMembers ( OutputList & ol ) const

private

Definition at line 4862 of file classdef.cpp.

{
  //printf("**** writeAdditionalInheritedMembers()\n");
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
  {
    if (lde->kind()==LayoutDocEntry::MemberDecl)
    {
      const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
      if (lmd && lmd->type!=MemberListType::Friends())
      {
        ClassDefSet visited;
        writeInheritedMemberDeclarations(ol,visited,lmd->type,MemberListType::Invalid(),lmd->title(getLanguage()),this,true,false);
      }
    }
  }
}

References DefinitionMixin< ClassDefMutable >::getLanguage(), LayoutDocManager::instance(), MemberListType::Invalid(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDecl::type, and writeInheritedMemberDeclarations().

Referenced by endMemberDeclarations().

writeAuthorSection()

void ClassDefImpl::writeAuthorSection ( OutputList & ol ) const

private

Definition at line 2269 of file classdef.cpp.

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Man);
  ol.writeString("\n");
  ol.startGroupHeader();
  ol.parseText(theTranslator->trAuthor(true,true));
  ol.endGroupHeader();
  ol.parseText(theTranslator->trGeneratedAutomatically(Config_getString(PROJECT_NAME)));
  ol.popGeneratorState();
}

References Config_getString, OutputList::disableAllBut(), OutputList::endGroupHeader(), Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), theTranslator, Translator::trAuthor(), Translator::trGeneratedAutomatically(), and OutputList::writeString().

Referenced by writeDocumentationContents().

writeBriefDescription()

void ClassDefImpl::writeBriefDescription ( OutputList & ol, bool exampleFlag ) const

private

Definition at line 1583 of file classdef.cpp.

{
  if (hasBriefDescription())
  {
    ol.startParagraph();
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Man);
    ol.writeString(" - ");
    ol.popGeneratorState();
    ol.generateDoc(briefFile(),
                   briefLine(),
                   this,
                   nullptr,
                   briefDescription(),
                   DocOptions()
                   .setIndexWords(true)
                   .setSingleLine(true));
    ol.pushGeneratorState();
    ol.disable(OutputType::RTF);
    ol.writeString(" \n");
    ol.enable(OutputType::RTF);
    ol.popGeneratorState();
 
    if (hasDetailedDescription() || exampleFlag)
    {
      writeMoreLink(ol,anchor());
    }
 
    ol.endParagraph();
  }
  ol.writeSynopsis();
}

References anchor(), DefinitionMixin< ClassDefMutable >::briefDescription(), DefinitionMixin< ClassDefMutable >::briefFile(), DefinitionMixin< ClassDefMutable >::briefLine(), OutputList::disable(), OutputList::disableAllBut(), OutputList::enable(), OutputList::endParagraph(), OutputList::generateDoc(), DefinitionMixin< ClassDefMutable >::hasBriefDescription(), hasDetailedDescription(), Man, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startParagraph(), writeMoreLink(), OutputList::writeString(), and OutputList::writeSynopsis().

Referenced by writeDocumentationContents().

writeCollaborationGraph()

void ClassDefImpl::writeCollaborationGraph ( OutputList & ol ) const

private

Definition at line 2000 of file classdef.cpp.

{
  if (Config_getBool(HAVE_DOT) && m_hasCollaborationGraph /*&& Config_getBool(COLLABORATION_GRAPH)*/)
  {
    DotClassGraph usageImplGraph(this,GraphType::Collaboration);
    if (usageImplGraph.isTooBig())
    {
       warn_uncond("Collaboration graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
           name(), usageImplGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
    }
    else if (!usageImplGraph.isTrivial())
    {
      ol.pushGeneratorState();
      ol.disable(OutputType::Man);
      ol.startDotGraph();
      ol.parseText(theTranslator->trCollaborationDiagram(displayName()));
      ol.endDotGraph(usageImplGraph);
      ol.popGeneratorState();
    }
  }
}

References Collaboration, Config_getBool, Config_getInt, OutputList::disable(), displayName(), OutputList::endDotGraph(), DotClassGraph::isTooBig(), DotClassGraph::isTrivial(), m_hasCollaborationGraph, Man, DefinitionMixin< ClassDefMutable >::name(), DotClassGraph::numNodes(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startDotGraph(), theTranslator, Translator::trCollaborationDiagram(), and warn_uncond.

Referenced by writeDocumentationContents(), and writeInlineDocumentation().

writeDeclaration()

void ClassDefImpl::writeDeclaration ( OutputList & ol, bool inGroup, int indentLevel, const ClassDef * inheritedFrom, const DString & inheritId ) const

overridevirtual

called from MemberDef::writeDeclaration() to (recursively) write the definition of an anonymous struct, union or class.

Implements ClassDef.

Definition at line 3597 of file classdef.cpp.

{
  //printf("ClassName='%s' inGroup=%d\n",qPrint(name()),inGroup);
 
  ol.docify(compoundTypeString());
  ol.docify(" {");
  ol.endMemberItem(OutputGenerator::MemberItemType::AnonymousStart);
  ol.endMemberDeclaration(DString(),inheritId);
 
  // write user defined member groups
  for (const auto &mg : m_memberGroups)
  {
    mg->writePlainDeclarations(ol,inGroup,this,nullptr,nullptr,nullptr,nullptr,indentLevel,inheritedFrom,inheritId);
  }
 
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
  {
    if (lde->kind()==LayoutDocEntry::MemberDecl)
    {
      const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
      if (lmd)
      {
        writePlainMemberDeclaration(ol,lmd->type,inGroup,indentLevel,inheritedFrom,inheritId);
      }
    }
  }
}

References OutputGenerator::AnonymousStart, compoundTypeString(), OutputList::docify(), OutputList::endMemberDeclaration(), OutputList::endMemberItem(), LayoutDocManager::instance(), m_memberGroups, LayoutDocEntryMemberDecl::type, and writePlainMemberDeclaration().

writeDeclarationLink()

void ClassDefImpl::writeDeclarationLink ( OutputList & ol, bool & found, const DString & header, bool localNames ) const

overridevirtual

Implements ClassDef.

Definition at line 2638 of file classdef.cpp.

{
  //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
  //bool vhdlOpt    = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
  bool sliceOpt   = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
  SrcLangExt lang = getLanguage();
  if (visibleInParentsDeclList())
  {
    if (!found) // first class
    {
      if (sliceOpt)
      {
        if (compoundType()==Interface)
        {
          ol.startMemberHeader("interfaces");
        }
        else if (compoundType()==Struct)
        {
          ol.startMemberHeader("structs");
        }
        else if (compoundType()==Exception)
        {
          ol.startMemberHeader("exceptions");
        }
        else // compoundType==Class
        {
          ol.startMemberHeader("nested-classes");
        }
      }
      else // non-Slice optimization: single header for class/struct/..
      {
        ol.startMemberHeader("nested-classes");
      }
      if (!header.empty())
      {
        ol.parseText(header);
      }
      else if (lang==SrcLangExt::VHDL)
      {
        ol.parseText(theTranslator->trVhdlType(VhdlSpecifier::ARCHITECTURE,false));
      }
      else
      {
        ol.parseText(lang==SrcLangExt::Fortran ?
            theTranslator->trDataTypes() :
            theTranslator->trCompounds());
      }
      ol.endMemberHeader();
      ol.startMemberList();
      found=true;
    }
    ol.startMemberDeclaration();
    DString ctype = compoundTypeString();
    DString cname = displayName(!localNames);
    DString anc = anchor();
    if (anc.empty()) anc = cname; else anc.prepend(cname+"_");
    ol.startMemberItem(anc,OutputGenerator::MemberItemType::Normal);
 
    if (lang!=SrcLangExt::VHDL) // for VHDL we swap the name and the type
    {
      if (isSliceLocal())
      {
        ol.writeString("local ");
      }
      ol.writeString(ctype);
      ol.writeString(" ");
      ol.insertMemberAlign();
    }
    if (isLinkable())
    {
      ol.writeObjectLink(getReference(),
          getOutputFileBase(),
          anchor(),
          cname
          );
    }
    else
    {
      ol.startBold();
      ol.docify(cname);
      ol.endBold();
    }
    if (lang==SrcLangExt::VHDL) // now write the type
    {
      ol.writeString(" ");
      ol.insertMemberAlign();
      ol.writeString(VhdlDocGen::getProtectionName(VhdlDocGen::convert(protection())));
    }
    ol.endMemberItem(OutputGenerator::MemberItemType::Normal);
 
    // add the brief description if available
    if (!briefDescription().empty() && Config_getBool(BRIEF_MEMBER_DESC))
    {
      auto parser { createDocParser() };
      auto ast    { validatingParseDoc(*parser.get(),
                                       briefFile(),
                                       briefLine(),
                                       this,
                                       nullptr,
                                       briefDescription(),
                                       DocOptions()
                                       .setSingleLine(true))
                  };
      if (!ast->empty())
      {
        ol.startMemberDescription(anchor());
        ol.writeDoc(ast.get(),this,nullptr);
        if (isLinkableInProject())
        {
          writeMoreLink(ol,anchor());
        }
        ol.endMemberDescription();
      }
    }
    ol.endMemberDeclaration(anchor(),DString());
  }
}

References anchor(), ARCHITECTURE, DefinitionMixin< ClassDefMutable >::briefDescription(), DefinitionMixin< ClassDefMutable >::briefFile(), DefinitionMixin< ClassDefMutable >::briefLine(), compoundType(), compoundTypeString(), Config_getBool, VhdlDocGen::convert(), createDocParser(), displayName(), OutputList::docify(), DString::empty(), OutputList::endBold(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), ClassDef::Exception, DefinitionMixin< ClassDefMutable >::getLanguage(), getOutputFileBase(), VhdlDocGen::getProtectionName(), getReference(), OutputList::insertMemberAlign(), ClassDef::Interface, isLinkable(), isLinkableInProject(), isSliceLocal(), OutputGenerator::Normal, OutputList::parseText(), DString::prepend(), protection(), OutputList::startBold(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), ClassDef::Struct, theTranslator, Translator::trCompounds(), Translator::trDataTypes(), Translator::trVhdlType(), validatingParseDoc(), visibleInParentsDeclList(), OutputList::writeDoc(), writeMoreLink(), OutputList::writeObjectLink(), and OutputList::writeString().

writeDetailedDescription()

void ClassDefImpl::writeDetailedDescription ( OutputList & ol, const DString & pageType, bool exampleFlag, const DString & title, const DString & anchor = DString() ) const

private

Definition at line 1692 of file classdef.cpp.

{
  if (hasDetailedDescription() || exampleFlag)
  {
    ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.writeRuler();
    ol.popGeneratorState();
 
    ol.pushGeneratorState();
      ol.disableAllBut(OutputType::Html);
      ol.writeAnchor(DString(),anchor.empty() ? DString("details") : anchor);
    ol.popGeneratorState();
 
    if (!anchor.empty())
    {
      ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.disable(OutputType::Man);
      ol.writeAnchor(getOutputFileBase(),anchor);
      ol.popGeneratorState();
    }
 
    ol.startGroupHeader("details");
    ol.parseText(title);
    ol.endGroupHeader();
 
    writeDetailedDocumentationBody(ol);
  }
  else
  {
    //writeTemplateSpec(ol,this,pageType);
  }
}

References anchor(), OutputList::disable(), OutputList::disableAllBut(), DString::empty(), OutputList::endGroupHeader(), getOutputFileBase(), hasDetailedDescription(), Html, Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), title(), OutputList::writeAnchor(), writeDetailedDocumentationBody(), and OutputList::writeRuler().

Referenced by writeDocumentationContents().

writeDetailedDocumentationBody()

void ClassDefImpl::writeDetailedDocumentationBody ( OutputList & ol ) const

private

Definition at line 1616 of file classdef.cpp.

{
  bool repeatBrief = Config_getBool(REPEAT_BRIEF);
 
  ol.startTextBlock();
 
  if (getLanguage()==SrcLangExt::Cpp)
  {
    writeTemplateSpec(ol,this,compoundTypeString(),SrcLangExt::Cpp);
  }
 
  // repeat brief description
  if (!briefDescription().empty() && repeatBrief)
  {
    ol.generateDoc(briefFile(),
                   briefLine(),
                   this,
                   nullptr,
                   briefDescription(),
                   DocOptions());
  }
  if (!briefDescription().empty() && repeatBrief &&
      !documentation().empty())
  {
    ol.pushGeneratorState();
    ol.disable(OutputType::Html);
    ol.writeString("\n\n");
    ol.popGeneratorState();
  }
  // write documentation
  if (!documentation().empty())
  {
    ol.generateDoc(docFile(),
                   docLine(),
                   this,
                   nullptr,
                   documentation(),
                   DocOptions()
                   .setIndexWords(true));
  }
  // write type constraints
  writeTypeConstraints(ol,this,m_typeConstraints);
 
  ol.generateDoc(
        docFile(),docLine(),
        this,
        nullptr,         // memberDef
        inlineTemplateArgListToDoc(m_tempArgs),    // docStr
        DocOptions()
        .setIndexWords(true));
 
  // write examples
  if (hasExamples())
  {
    ol.startExamples();
    ol.startDescForItem();
    writeExamples(ol,m_examples);
    ol.endDescForItem();
    ol.endExamples();
  }
  writeSourceDef(ol);
  if (hasRequirementRefs()) writeRequirementRefs(ol);
  ol.endTextBlock();
}

References DefinitionMixin< ClassDefMutable >::briefDescription(), DefinitionMixin< ClassDefMutable >::briefFile(), DefinitionMixin< ClassDefMutable >::briefLine(), compoundTypeString(), Config_getBool, OutputList::disable(), DefinitionMixin< ClassDefMutable >::docFile(), DefinitionMixin< ClassDefMutable >::docLine(), DefinitionMixin< ClassDefMutable >::documentation(), OutputList::endDescForItem(), OutputList::endExamples(), OutputList::endTextBlock(), OutputList::generateDoc(), DefinitionMixin< ClassDefMutable >::getLanguage(), hasExamples(), DefinitionMixin< ClassDefMutable >::hasRequirementRefs(), Html, inlineTemplateArgListToDoc(), m_examples, m_tempArgs, m_typeConstraints, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startDescForItem(), OutputList::startExamples(), OutputList::startTextBlock(), writeExamples(), DefinitionMixin< ClassDefMutable >::writeRequirementRefs(), DefinitionMixin< ClassDefMutable >::writeSourceDef(), OutputList::writeString(), writeTemplateSpec(), and writeTypeConstraints().

Referenced by writeDetailedDescription(), and writeInlineDocumentation().

writeDocumentation()

void ClassDefImpl::writeDocumentation ( OutputList & ol ) const

overridevirtual

Implements ClassDef.

Definition at line 3001 of file classdef.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
  //bool vhdlOpt    = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
  bool sliceOpt   = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
  DString pageTitle = title();
 
  HighlightedItem hli = HighlightedItem::None;
  if (sliceOpt)
  {
    if (compoundType()==Interface)
    {
      hli = HighlightedItem::InterfaceVisible;
    }
    else if (compoundType()==Struct)
    {
      hli = HighlightedItem::StructVisible;
    }
    else if (compoundType()==Exception)
    {
      hli = HighlightedItem::ExceptionVisible;
    }
    else
    {
      hli = HighlightedItem::ClassVisible;
    }
  }
  else
  {
    hli = HighlightedItem::ClassVisible;
  }
 
  AUTO_TRACE("name='{}' getOutputFileBase='{}'",name(),getOutputFileBase());
  bool hasAllMembersLink=false;
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
  {
    if (lde->kind()==LayoutDocEntry::ClassAllMembersLink)
    {
      hasAllMembersLink = true;
      break;
    }
  }
  DString memListFile;
  if (hasAllMembersLink && !m_allMemberNameInfoLinkedMap.empty() && !Config_getBool(OPTIMIZE_OUTPUT_FOR_C))
  {
    memListFile = getMemberListFileName();
  }
  startFile(ol,getOutputFileBase(),false,name(),pageTitle,hli,!generateTreeView,DString(),0,memListFile);
  if (!generateTreeView)
  {
    if (getOuterScope()!=Doxygen::globalScope)
    {
      writeNavigationPath(ol);
    }
    ol.endQuickIndices();
  }
 
  startTitle(ol,getOutputFileBase(),this);
  ol.parseText(pageTitle);
  addClassAttributes(ol);
  addGroupListToTitle(ol,this);
  endTitle(ol,getOutputFileBase(),displayName());
  writeDocumentationContents(ol,pageTitle);
 
  endFileWithNavPath(ol,this);
 
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    writeMemberPages(ol);
  }
}

References addClassAttributes(), addGroupListToTitle(), AUTO_TRACE, ClassVisible, compoundType(), Config_getBool, displayName(), LinkedMap< T, Hash, KeyEqual, Map >::empty(), endFileWithNavPath(), OutputList::endQuickIndices(), endTitle(), ClassDef::Exception, ExceptionVisible, getMemberListFileName(), DefinitionMixin< ClassDefMutable >::getOuterScope(), getOutputFileBase(), Doxygen::globalScope, LayoutDocManager::instance(), ClassDef::Interface, InterfaceVisible, m_allMemberNameInfoLinkedMap, DefinitionMixin< ClassDefMutable >::name(), None, OutputList::parseText(), startFile(), startTitle(), ClassDef::Struct, StructVisible, title(), writeDocumentationContents(), writeMemberPages(), and DefinitionMixin< ClassDefMutable >::writeNavigationPath().

writeDocumentationContents()

void ClassDefImpl::writeDocumentationContents ( OutputList & ol, const DString & pageTitle ) const

private

Definition at line 2790 of file classdef.cpp.

{
  ol.startContents();
 
  DString pageType = " ";
  pageType += compoundTypeString();
 
  bool exampleFlag=hasExamples();
 
  //---------------------------------------- start flexible part -------------------------------
 
  SrcLangExt lang = getLanguage();
 
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::BriefDesc:
        writeBriefDescription(ol,exampleFlag);
        break;
      case LayoutDocEntry::Includes:
        if (lang==SrcLangExt::Slice)
        {
          writeIncludeFilesForSlice(ol);
        }
        else
        {
          writeIncludeFiles(ol);
        }
        break;
      case LayoutDocEntry::ClassInheritanceGraph:
        writeInheritanceGraph(ol);
        break;
      case LayoutDocEntry::ClassCollaborationGraph:
        writeCollaborationGraph(ol);
        break;
      case LayoutDocEntry::ClassAllMembersLink:
        //writeAllMembersLink(ol); // this is now part of the summary links
        break;
      case LayoutDocEntry::MemberDeclStart:
        startMemberDeclarations(ol);
        break;
      case LayoutDocEntry::MemberGroups:
        writeMemberGroups(ol);
        break;
      case LayoutDocEntry::MemberDecl:
        {
          ClassDefSet visitedClasses;
          const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
          if (lmd)
          {
            writeMemberDeclarations(ol,visitedClasses,lmd->type,lmd->title(lang),lmd->subtitle(lang));
          }
        }
        break;
      case LayoutDocEntry::ClassNestedClasses:
        {
          const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
          if (ls)
          {
            writeNestedClasses(ol,ls->title(lang));
          }
        }
        break;
      case LayoutDocEntry::MemberDeclEnd:
        endMemberDeclarations(ol);
        break;
      case LayoutDocEntry::DetailedDesc:
        {
          const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
          if (ls)
          {
            writeDetailedDescription(ol,pageType,exampleFlag,ls->title(lang));
          }
        }
        break;
      case LayoutDocEntry::MemberDefStart:
        startMemberDocumentation(ol);
        break;
      case LayoutDocEntry::ClassInlineClasses:
        writeInlineClasses(ol);
        break;
      case LayoutDocEntry::MemberDef:
        {
          const LayoutDocEntryMemberDef *lmd = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get());
          if (lmd)
          {
            writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
          }
        }
        break;
      case LayoutDocEntry::MemberDefEnd:
        endMemberDocumentation(ol);
        break;
      case LayoutDocEntry::ClassUsedFiles:
        showUsedFiles(ol);
        break;
      case LayoutDocEntry::AuthorSection:
        writeAuthorSection(ol);
        break;
      case LayoutDocEntry::NamespaceNestedNamespaces:
      case LayoutDocEntry::NamespaceNestedConstantGroups:
      case LayoutDocEntry::NamespaceClasses:
      case LayoutDocEntry::NamespaceConcepts:
      case LayoutDocEntry::NamespaceInterfaces:
      case LayoutDocEntry::NamespaceStructs:
      case LayoutDocEntry::NamespaceExceptions:
      case LayoutDocEntry::NamespaceInlineClasses:
      case LayoutDocEntry::ConceptDefinition:
      case LayoutDocEntry::FileClasses:
      case LayoutDocEntry::FileConcepts:
      case LayoutDocEntry::FileInterfaces:
      case LayoutDocEntry::FileStructs:
      case LayoutDocEntry::FileExceptions:
      case LayoutDocEntry::FileNamespaces:
      case LayoutDocEntry::FileConstantGroups:
      case LayoutDocEntry::FileIncludeGraph:
      case LayoutDocEntry::FileIncludedByGraph:
      case LayoutDocEntry::FileSourceLink:
      case LayoutDocEntry::FileInlineClasses:
      case LayoutDocEntry::GroupClasses:
      case LayoutDocEntry::GroupConcepts:
      case LayoutDocEntry::GroupModules:
      case LayoutDocEntry::GroupInlineClasses:
      case LayoutDocEntry::GroupNamespaces:
      case LayoutDocEntry::GroupDirs:
      case LayoutDocEntry::GroupNestedGroups:
      case LayoutDocEntry::GroupFiles:
      case LayoutDocEntry::GroupGraph:
      case LayoutDocEntry::GroupPageDocs:
      case LayoutDocEntry::ModuleExports:
      case LayoutDocEntry::ModuleClasses:
      case LayoutDocEntry::ModuleConcepts:
      case LayoutDocEntry::ModuleUsedFiles:
      case LayoutDocEntry::DirSubDirs:
      case LayoutDocEntry::DirFiles:
      case LayoutDocEntry::DirGraph:
        err("Internal inconsistency: member '{}' should not be part of LayoutDocManager::Class entry list\n",lde->entryToString());
        break;
    }
  }
 
  ol.endContents();
}

References compoundTypeString(), OutputList::endContents(), endMemberDeclarations(), endMemberDocumentation(), err, DefinitionMixin< ClassDefMutable >::getLanguage(), hasExamples(), LayoutDocManager::instance(), showUsedFiles(), OutputList::startContents(), startMemberDeclarations(), startMemberDocumentation(), LayoutDocEntryMemberDecl::subtitle(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDef::title(), LayoutDocEntrySection::title(), LayoutDocEntryMemberDecl::type, LayoutDocEntryMemberDef::type, writeAuthorSection(), writeBriefDescription(), writeCollaborationGraph(), writeDetailedDescription(), writeIncludeFiles(), writeIncludeFilesForSlice(), writeInheritanceGraph(), writeInlineClasses(), writeMemberDeclarations(), writeMemberDocumentation(), writeMemberGroups(), and writeNestedClasses().

Referenced by writeDocumentation().

writeDocumentationForInnerClasses()

void ClassDefImpl::writeDocumentationForInnerClasses ( OutputList & ol ) const

overridevirtual

Implements ClassDef.

Definition at line 3139 of file classdef.cpp.

{
  // write inner classes after the parent, so the tag files contain
  // the definition in proper order!
  for (const auto &innerCd : m_innerClasses)
  {
    if (
        innerCd->isLinkableInProject() && !innerCd->isImplicitTemplateInstance() &&
        protectionLevelVisible(innerCd->protection()) &&
        !innerCd->isEmbeddedInOuterScope()
       )
    {
      msg("Generating docs for nested compound {}...\n",innerCd->displayName());
      innerCd->writeDocumentation(ol);
      innerCd->writeMemberList(ol);
    }
    innerCd->writeDocumentationForInnerClasses(ol);
  }
}

References m_innerClasses, msg, and protectionLevelVisible().

writeIncludeFiles()

void ClassDefImpl::writeIncludeFiles ( OutputList & ol ) const

private

Definition at line 2164 of file classdef.cpp.

{
  if (m_incInfo /*&& Config_getBool(SHOW_HEADERFILE)*/)
  {
    SrcLangExt lang = getLanguage();
    DString nm=m_incInfo->includeName.empty() ?
      (m_incInfo->fileDef ?
       m_incInfo->fileDef->docName() : DString()
      ) :
      m_incInfo->includeName;
    if (!nm.empty())
    {
      ol.startParagraph();
      ol.startTypewriter();
      ol.docify(::includeStatement(lang,m_incInfo->kind));
      ol.docify(::includeOpen(lang,m_incInfo->kind));
      ol.pushGeneratorState();
      ol.disable(OutputType::Html);
      ol.docify(nm);
      ol.disableAllBut(OutputType::Html);
      ol.enable(OutputType::Html);
      if (m_incInfo->fileDef)
      {
        ol.writeObjectLink(DString(),m_incInfo->fileDef->includeName(),DString(),nm);
      }
      else
      {
        ol.docify(nm);
      }
      ol.popGeneratorState();
      ol.docify(::includeClose(lang,m_incInfo->kind));
      ol.endTypewriter();
      ol.endParagraph();
    }
  }
}

References OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), DString::empty(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTypewriter(), DefinitionMixin< ClassDefMutable >::getLanguage(), Html, includeClose(), includeOpen(), includeStatement(), m_incInfo, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startParagraph(), OutputList::startTypewriter(), and OutputList::writeObjectLink().

Referenced by writeDocumentationContents().

writeIncludeFilesForSlice()

void ClassDefImpl::writeIncludeFilesForSlice ( OutputList & ol ) const

private

Definition at line 2023 of file classdef.cpp.

{
  if (m_incInfo)
  {
    DString nm;
    StringVector paths = Config_getList(STRIP_FROM_PATH);
    if (!paths.empty() && m_incInfo->fileDef)
    {
      DString abs = m_incInfo->fileDef->absFilePath();
      DString potential;
      size_t length = 0;
      for (const auto &s : paths)
      {
        FileInfo info(s);
        if (info.exists())
        {
          DString prefix = info.absFilePath();
          if (prefix.at(prefix.length() - 1) != '/')
          {
            prefix += '/';
          }
 
          if (prefix.length() > length &&
              dstricmp(abs.left(prefix.length()).data(), prefix.data()) == 0) // case insensitive compare
          {
            length = prefix.length();
            potential = abs.mid(prefix.length());
          }
        }
      }
 
      if (length > 0)
      {
        nm = potential;
      }
    }
 
    if (nm.empty())
    {
      nm = m_incInfo->includeName;
    }
 
    ol.startParagraph();
    ol.docify(theTranslator->trDefinedIn()+" ");
    ol.startTypewriter();
    ol.docify("<");
    if (m_incInfo->fileDef)
    {
      ol.writeObjectLink(DString(),m_incInfo->fileDef->includeName(),DString(),nm);
    }
    else
    {
      ol.docify(nm);
    }
    ol.docify(">");
    ol.endTypewriter();
    ol.endParagraph();
  }
 
  // Write a summary of the Slice definition including metadata.
  ol.startParagraph();
  ol.startTypewriter();
  if (!m_metaData.empty())
  {
    ol.docify(m_metaData);
    ol.lineBreak();
  }
  if (m_spec.isLocal())
  {
    ol.docify("local ");
  }
  if (m_spec.isInterface())
  {
    ol.docify("interface ");
  }
  else if (m_spec.isStruct())
  {
    ol.docify("struct ");
  }
  else if (m_spec.isException())
  {
    ol.docify("exception ");
  }
  else
  {
    ol.docify("class ");
  }
  ol.docify(stripScope(name()));
  if (!m_inherits.empty())
  {
    if (m_spec.isInterface() || m_spec.isException())
    {
      ol.docify(" extends ");
      bool first=true;
      for (const auto &ibcd : m_inherits)
      {
        if (!first) ol.docify(", ");
        ClassDef *icd = ibcd.classDef;
        ol.docify(icd->name());
        first=false;
      }
    }
    else
    {
      // Must be a class.
      bool implements = false;
      for (const auto &ibcd : m_inherits)
      {
        ClassDef *icd = ibcd.classDef;
        if (icd->isInterface())
        {
          implements = true;
        }
        else
        {
          ol.docify(" extends ");
          ol.docify(icd->name());
        }
      }
      if (implements)
      {
        ol.docify(" implements ");
        bool first = true;
        for (const auto &ibcd : m_inherits)
        {
          ClassDef *icd = ibcd.classDef;
          if (icd->isInterface())
          {
            if (!first) ol.docify(", ");
            first = false;
            ol.docify(icd->name());
          }
        }
      }
    }
  }
  ol.docify(" { ... }");
  ol.endTypewriter();
  ol.endParagraph();
}

References FileInfo::absFilePath(), Config_getList, DString::data(), OutputList::docify(), dstricmp(), DString::empty(), OutputList::endParagraph(), OutputList::endTypewriter(), FileInfo::exists(), ClassDef::isInterface(), DString::left(), OutputList::lineBreak(), m_incInfo, m_inherits, m_metaData, m_spec, DString::mid(), Definition::name(), DefinitionMixin< ClassDefMutable >::name(), prefix, OutputList::startParagraph(), OutputList::startTypewriter(), stripScope(), theTranslator, Translator::trDefinedIn(), and OutputList::writeObjectLink().

Referenced by writeDocumentationContents().

writeInheritanceGraph()

void ClassDefImpl::writeInheritanceGraph ( OutputList & ol ) const

private

Definition at line 1865 of file classdef.cpp.

{
  bool haveDot    = Config_getBool(HAVE_DOT);
  auto classGraph = m_typeInheritanceGraph;
 
  if (classGraph == CLASS_GRAPH_t::NO) return;
  // count direct inheritance relations
  int count=countInheritanceNodes();
 
  bool renderDiagram = false;
  if (haveDot && (classGraph==CLASS_GRAPH_t::YES || classGraph==CLASS_GRAPH_t::GRAPH))
    // write class diagram using dot
  {
    DotClassGraph inheritanceGraph(this,GraphType::Inheritance);
    if (inheritanceGraph.isTooBig())
    {
       warn_uncond("Inheritance graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
           name(), inheritanceGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
    }
    else if (!inheritanceGraph.isTrivial())
    {
      ol.pushGeneratorState();
      ol.disable(OutputType::Man);
      ol.startDotGraph();
      ol.parseText(theTranslator->trClassDiagram(displayName()));
      ol.endDotGraph(inheritanceGraph);
      ol.popGeneratorState();
      renderDiagram = true;
    }
  }
  else if ((classGraph==CLASS_GRAPH_t::YES || classGraph==CLASS_GRAPH_t::GRAPH || classGraph==CLASS_GRAPH_t::BUILTIN) && count>0)
    // write class diagram using built-in generator
  {
    ClassDiagram diagram(this); // create a diagram of this class.
    ol.startClassDiagram();
    ol.disable(OutputType::Man);
    ol.parseText(theTranslator->trClassDiagram(displayName()));
    ol.enable(OutputType::Man);
    ol.endClassDiagram(diagram,getOutputFileBase(),displayName());
    renderDiagram = true;
  }
 
  if (renderDiagram) // if we already show the inheritance relations graphically,
                     // then hide the text version
  {
    ol.disableAllBut(OutputType::Man);
  }
 
  count = countInheritsNodes();
  if (count>0)
  {
    auto replaceFunc = [this,&ol](size_t entryIndex)
    {
      for (size_t index=0; index<m_inherits.size() ; index++)
      {
        const BaseClassDef &bcd=m_inherits[index];
        const ClassDef *cd=bcd.classDef;
 
        if (cd->isVisibleInHierarchy()) // filter on the class we want to show
        {
          if (index==entryIndex) // found the requested index
          {
            // use the class name but with the template arguments as given
            // in the inheritance relation
            DString displayName = insertTemplateSpecifierInScope(
                cd->displayName(),bcd.templSpecifiers);
 
            if (cd->isLinkable())
            {
              ol.writeObjectLink(cd->getReference(),
                  cd->getOutputFileBase(),
                  cd->anchor(),
                  displayName);
            }
            else
            {
              ol.docify(displayName);
            }
            return;
          }
        }
      }
    };
 
    ol.startParagraph();
    writeMarkerList(ol,
                    theTranslator->trInheritsList(count).str(),
                    static_cast<size_t>(count),
                    replaceFunc);
    ol.endParagraph();
  }
 
  // write subclasses
  count = countInheritedByNodes();
  if (count>0)
  {
    auto replaceFunc = [this,&ol](size_t entryIndex)
    {
      for (size_t index=0; index<m_inheritedBy.size() ; index++)
      {
        const BaseClassDef &bcd=m_inheritedBy[index];
        const ClassDef *cd=bcd.classDef;
        if (cd->isVisibleInHierarchy()) // filter on the class we want to show
        {
          if (index==entryIndex) // found the requested index
          {
            if (cd->isLinkable())
            {
              ol.writeObjectLink(cd->getReference(),cd->getOutputFileBase(),cd->anchor(),cd->displayName());
              writeInheritanceSpecifier(ol,bcd);
            }
            else
            {
              ol.docify(cd->displayName());
            }
            return;
          }
        }
      }
    };
 
    ol.startParagraph();
    writeMarkerList(ol,
                    theTranslator->trInheritedByList(count).str(),
                    static_cast<size_t>(count),
                    replaceFunc);
    ol.endParagraph();
  }
 
  if (renderDiagram)
  {
    ol.enableAll();
  }
}

References Definition::anchor(), BaseClassDef::classDef, Config_getBool, Config_getInt, countInheritanceNodes(), countInheritedByNodes(), countInheritsNodes(), OutputList::disable(), OutputList::disableAllBut(), displayName(), Definition::displayName(), OutputList::docify(), OutputList::enable(), OutputList::enableAll(), OutputList::endClassDiagram(), OutputList::endDotGraph(), OutputList::endParagraph(), getOutputFileBase(), Definition::getOutputFileBase(), Definition::getReference(), Inheritance, insertTemplateSpecifierInScope(), Definition::isLinkable(), DotClassGraph::isTooBig(), DotClassGraph::isTrivial(), ClassDef::isVisibleInHierarchy(), m_inheritedBy, m_inherits, m_typeInheritanceGraph, Man, DefinitionMixin< ClassDefMutable >::name(), DotClassGraph::numNodes(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startClassDiagram(), OutputList::startDotGraph(), OutputList::startParagraph(), DString::str(), BaseClassDef::templSpecifiers, theTranslator, Translator::trClassDiagram(), Translator::trInheritedByList(), Translator::trInheritsList(), warn_uncond, writeInheritanceSpecifier(), writeMarkerList(), and OutputList::writeObjectLink().

Referenced by writeDocumentationContents(), and writeInlineDocumentation().

writeInheritedMemberDeclarations()

void ClassDefImpl::writeInheritedMemberDeclarations ( OutputList & ol, ClassDefSet & visitedClasses, MemberListType lt, MemberListType lt2, const DString & title, const ClassDef * inheritedFrom, bool invert, bool showAlways ) const

private

Definition at line 4904 of file classdef.cpp.

{
  int count = countMembersIncludingGrouped(lt,inheritedFrom,false);
  bool process = count>0;
  //printf("%s: writeInheritedMemberDec: lt=%s process=%d invert=%d always=%d\n",
  //    qPrint(name()),qPrint(lt.to_string()),process,invert,showAlways);
  if ((process^invert) || showAlways)
  {
    for (const auto &ibcd : m_inherits)
    {
      ClassDefMutable *icd=toClassDefMutable(ibcd.classDef);
      if (icd && icd->isLinkable())
      {
        MemberListType lt1 = MemberListType::Invalid();
        MemberListType lt3 = MemberListType::Invalid();
        convertProtectionLevel(lt,ibcd.prot,&lt1,&lt3);
        if (lt2.isInvalid() && !lt3.isInvalid())
        {
          lt2=lt3;
        }
        //printf("%s:convert %s->(%s,%s) prot=%d\n",qPrint(icd->name()),qPrint(lt.to_string()),
        //                                          qPrint(lt1.to_string()),qPrint(lt2.to_string()),ibcd.prot);
        if (visitedClasses.find(icd)==visitedClasses.end())
        {
          visitedClasses.insert(icd); // guard for multiple virtual inheritance
          if (!lt1.isInvalid())
          {
            //printf("--> writeMemberDeclarations for type %s\n",qPrint(lt1.to_string()));
            icd->writeMemberDeclarations(ol,visitedClasses,lt1,
                title,DString(),false,inheritedFrom,lt2,false,true);
          }
        }
        else
        {
          //printf("%s: class already visited!\n",qPrint(icd->name()));
        }
      }
    }
  }
}

References convertProtectionLevel(), countMembersIncludingGrouped(), MemberListType::Invalid(), MemberListType::isInvalid(), Definition::isLinkable(), m_inherits, title(), toClassDefMutable(), and ClassDef::writeMemberDeclarations().

Referenced by writeAdditionalInheritedMembers(), and writeMemberDeclarations().

writeInlineClasses()

void ClassDefImpl::writeInlineClasses ( OutputList & ol ) const

private

Definition at line 2224 of file classdef.cpp.

{
  m_innerClasses.writeDocumentation(ol,this);
}

References m_innerClasses, and ClassLinkedRefMap::writeDocumentation().

Referenced by writeDocumentationContents().

writeInlineDocumentation()

void ClassDefImpl::writeInlineDocumentation ( OutputList & ol ) const

overridevirtual

Write class documentation inside another container (i.e. a group).

Implements ClassDef.

Definition at line 2461 of file classdef.cpp.

{
  bool isSimple = m_isSimple;
 
  ol.addIndexItem(name(),DString());
  //printf("ClassDefImpl::writeInlineDocumentation(%s)\n",qPrint(name()));
 
  // part 1: anchor and title
  DString s = compoundTypeString()+" "+name();
 
  // part 1a
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
  { // only HTML only
    ol.writeAnchor(DString(),anchor());
    ol.startMemberDoc(DString(),DString(),anchor(),name(),1,1,false);
    ol.startMemberDocName(false);
    ol.parseText(s);
    ol.endMemberDocName();
    ol.endMemberDoc(false);
    ol.writeString("</div>");
    ol.startIndent();
  }
  ol.popGeneratorState();
 
  // part 1b
  ol.pushGeneratorState();
  ol.disable(OutputType::Html);
  ol.disable(OutputType::Man);
  { // for LaTeX/RTF only
    ol.writeAnchor(getOutputFileBase(),anchor());
  }
  ol.popGeneratorState();
 
  // part 1c
  ol.pushGeneratorState();
  ol.disable(OutputType::Html);
  {
    // for LaTeX/RTF/Man
    ol.startGroupHeader("",1);
    ol.parseText(s);
    ol.endGroupHeader(1);
  }
  ol.popGeneratorState();
 
  SrcLangExt lang=getLanguage();
 
  // part 2: the header and detailed description
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::BriefDesc:
        {
          // since we already shown the brief description in the
          // declaration part of the container, so we use this to
          // show the details on top.
          writeDetailedDocumentationBody(ol);
        }
        break;
      case LayoutDocEntry::ClassInheritanceGraph:
        writeInheritanceGraph(ol);
        break;
      case LayoutDocEntry::ClassCollaborationGraph:
        writeCollaborationGraph(ol);
        break;
      case LayoutDocEntry::MemberDeclStart:
        if (!isSimple) startMemberDeclarations(ol);
        break;
      case LayoutDocEntry::MemberDecl:
        {
          const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
          if (lmd)
          {
            ClassDefSet visitedClasses;
            if (!isSimple) writeMemberDeclarations(ol,visitedClasses,lmd->type,lmd->title(lang),lmd->subtitle(lang),true);
          }
        }
        break;
      case LayoutDocEntry::MemberGroups:
        if (!isSimple) writeMemberGroups(ol,true);
        break;
      case LayoutDocEntry::MemberDeclEnd:
        if (!isSimple) endMemberDeclarations(ol);
        break;
      case LayoutDocEntry::MemberDefStart:
        if (!isSimple) startMemberDocumentation(ol);
        break;
      case LayoutDocEntry::MemberDef:
        {
          const LayoutDocEntryMemberDef *lmd = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get());
          if (lmd)
          {
            if (isSimple)
            {
              writeSimpleMemberDocumentation(ol,lmd->type);
            }
            else
            {
              writeMemberDocumentation(ol,lmd->type,lmd->title(lang),true);
            }
          }
        }
        break;
      case LayoutDocEntry::MemberDefEnd:
        if (!isSimple) endMemberDocumentation(ol);
        break;
      default:
        break;
    }
  }
 
  // part 3: close the block
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
  { // HTML only
    ol.endIndent();
  }
  ol.popGeneratorState();
}

References OutputList::addIndexItem(), anchor(), compoundTypeString(), OutputList::disable(), OutputList::disableAllBut(), OutputList::endGroupHeader(), OutputList::endIndent(), endMemberDeclarations(), OutputList::endMemberDoc(), OutputList::endMemberDocName(), endMemberDocumentation(), DefinitionMixin< ClassDefMutable >::getLanguage(), getOutputFileBase(), Html, LayoutDocManager::instance(), isSimple(), m_isSimple, Man, DefinitionMixin< ClassDefMutable >::name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), OutputList::startIndent(), startMemberDeclarations(), OutputList::startMemberDoc(), OutputList::startMemberDocName(), startMemberDocumentation(), LayoutDocEntryMemberDecl::subtitle(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDef::title(), LayoutDocEntryMemberDecl::type, LayoutDocEntryMemberDef::type, OutputList::writeAnchor(), writeCollaborationGraph(), writeDetailedDocumentationBody(), writeInheritanceGraph(), writeMemberDeclarations(), writeMemberDocumentation(), writeMemberGroups(), writeSimpleMemberDocumentation(), and OutputList::writeString().

writeMemberDeclarations()

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

overridevirtual

Implements ClassDef.

Definition at line 4947 of file classdef.cpp.

{
  //printf("%s: ClassDefImpl::writeMemberDeclarations lt=%s lt2=%s\n",qPrint(name()),qPrint(lt.to_string()),qPrint(lt2.to_string()));
  MemberList * ml = getMemberList(lt);
  MemberList * ml2 = getMemberList(lt2);
  if (getLanguage()==SrcLangExt::VHDL) // use specific declarations function
  {
    static const ClassDef *cdef;
    if (cdef!=this)
    { // only one inline link
      VhdlDocGen::writeInlineClassLink(this,ol);
      cdef=this;
    }
    if (ml)
    {
      VhdlDocGen::writeVhdlDeclarations(ml,ol,nullptr,this,nullptr,nullptr,nullptr);
    }
  }
  else
  {
    //printf("%s::writeMemberDeclarations(%s) ml=%p ml2=%p\n",qPrint(name()),qPrint(title),(void*)ml,(void*)ml2);
    DString tt = title, st = subTitle;
    if (ml)
    {
      //printf("  writeDeclarations ml type=%s count=%d\n",qPrint(lt.to_string()),ml->numDecMembers(inheritedFrom));
      ml->writeDeclarations(ol,this,nullptr,nullptr,nullptr,nullptr,tt,st,false,showInline,inheritedFrom,lt,true);
      tt.clear();
      st.clear();
    }
    if (ml2)
    {
      //printf("  writeDeclarations ml2 type=%s count=%d\n",qPrint(lt2.to_string()),ml2->numDecMembers(inheritedFrom));
      ml2->writeDeclarations(ol,this,nullptr,nullptr,nullptr,nullptr,tt,st,false,showInline,inheritedFrom,lt,ml==nullptr);
    }
    bool inlineInheritedMembers = Config_getBool(INLINE_INHERITED_MEMB);
    if (!inlineInheritedMembers) // show inherited members as separate lists
    {
      writeInheritedMemberDeclarations(ol,visitedClasses,lt,lt2,title,
          inheritedFrom ? inheritedFrom : this,
          invert,showAlways);
    }
  }
}

References DString::clear(), Config_getBool, DefinitionMixin< ClassDefMutable >::getLanguage(), getMemberList(), title(), MemberList::writeDeclarations(), writeInheritedMemberDeclarations(), VhdlDocGen::writeInlineClassLink(), and VhdlDocGen::writeVhdlDeclarations().

Referenced by writeDocumentationContents(), and writeInlineDocumentation().

writeMemberDocumentation()

void ClassDefImpl::writeMemberDocumentation ( OutputList & ol, MemberListType lt, const DString & title, bool showInline = false ) const

private

Definition at line 5007 of file classdef.cpp.

{
  //printf("%s: ClassDefImpl::writeMemberDocumentation()\n",qPrint(name()));
  MemberList * ml = getMemberList(lt);
  if (ml) ml->writeDocumentation(ol,displayName(),this,title,ml->listType().toLabel(),false,showInline);
}

References displayName(), getMemberList(), MemberList::listType(), title(), MemberListType::toLabel(), and MemberList::writeDocumentation().

Referenced by writeDocumentationContents(), and writeInlineDocumentation().

writeMemberGroups()

void ClassDefImpl::writeMemberGroups ( OutputList & ol, bool showInline = false ) const

private

Definition at line 2201 of file classdef.cpp.

{
  // write user defined member groups
  for (const auto &mg : m_memberGroups)
  {
    if (!mg->allMembersInSameSection() || !m_subGrouping) // group is in its own section
    {
      mg->writeDeclarations(ol,this,nullptr,nullptr,nullptr,nullptr,showInline);
    }
    else // add this group to the corresponding member section
    {
      //printf("addToDeclarationSection(%s)\n",qPrint(mg->header()));
      //mg->addToDeclarationSection();
    }
  }
}

References m_memberGroups, and m_subGrouping.

Referenced by writeDocumentationContents(), and writeInlineDocumentation().

writeMemberList()

void ClassDefImpl::writeMemberList ( OutputList & ol ) const

overridevirtual

Implements ClassDef.

Definition at line 3160 of file classdef.cpp.

{
  bool cOpt    = Config_getBool(OPTIMIZE_OUTPUT_FOR_C);
  //bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
  bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  if (m_allMemberNameInfoLinkedMap.empty() || cOpt) return;
  // only for HTML
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
 
  HighlightedItem hli = HighlightedItem::None;
  if (sliceOpt)
  {
    if (compoundType()==Interface)
    {
      hli = HighlightedItem::InterfaceVisible;
    }
    else if (compoundType()==Struct)
    {
      hli = HighlightedItem::StructVisible;
    }
    else if (compoundType()==Exception)
    {
      hli = HighlightedItem::ExceptionVisible;
    }
    else
    {
      hli = HighlightedItem::ClassVisible;
    }
  }
  else
  {
    hli = HighlightedItem::ClassVisible;
  }
 
  DString memListFile = getMemberListFileName();
  startFile(ol,memListFile,false,memListFile,theTranslator->trMemberList(),hli,!generateTreeView,getOutputFileBase());
  if (!generateTreeView)
  {
    if (getOuterScope()!=Doxygen::globalScope)
    {
      writeNavigationPath(ol);
    }
    ol.endQuickIndices();
  }
  startTitle(ol,DString());
  ol.parseText(displayName()+" "+theTranslator->trMemberList());
  endTitle(ol,DString(),DString());
  ol.startContents();
  ol.startParagraph();
  ol.parseText(theTranslator->trThisIsTheListOfAllMembers());
  ol.docify(" ");
  ol.writeObjectLink(getReference(),getOutputFileBase(),anchor(),displayName());
  ol.parseText(theTranslator->trIncludingInheritedMembers());
  ol.endParagraph();
 
  //ol.startItemList();
 
  bool first = true; // to prevent empty table
  int idx=0;
  for (auto &mni : m_allMemberNameInfoLinkedMap)
  {
    for (auto &mi : *mni)
    {
      const MemberDef *md=mi->memberDef();
      const ClassDef  *cd=md->getClassDef();
      Protection prot = mi->prot();
      Specifier virt=md->virtualness();
 
      //printf("%s: Member %s of class %s md->protection()=%d mi->prot=%d prot=%d inherited=%d\n",
      //    qPrint(name()),qPrint(md->name()),qPrint(cd->name()),md->protection(),mi->prot,prot,mi->inherited);
 
      if (cd && !md->name().empty() && !md->isAnonymous())
      {
        bool memberWritten=false;
        if (cd->isLinkable() && md->isLinkable())
          // create a link to the documentation
        {
          DString name=mi->ambiguityResolutionScope()+md->name();
          //ol.writeListItem();
          if (first)
          {
            ol.writeString("<table class=\"directory\">\n");
            first = false;
          }
          ol.writeString("  <tr");
          if ((idx&1)==0) ol.writeString(" class=\"even\""); else ol.writeString(" class=\"odd\"");
          idx++;
          ol.writeString("><td class=\"entry\">");
          if (cd->isObjectiveC())
          {
            if (md->isObjCMethod())
            {
              if (md->isStatic())
                ol.writeString("+&#160;</td><td>");
              else
                ol.writeString("-&#160;</td><td>");
            }
            else
              ol.writeString("</td><td class=\"entry\">");
          }
          if (md->isObjCMethod())
          {
            ol.writeObjectLink(md->getReference(),
                md->getOutputFileBase(),
                md->anchor(),md->name());
          }
          else
          {
            //Definition *bd = md->getGroupDef();
            //if (bd==nullptr) bd=cd;
            ol.writeObjectLink(md->getReference(),
                md->getOutputFileBase(),
                md->anchor(),name);
 
            if ( md->isFunction() || md->isSignal() || md->isSlot() ||
                (md->isFriend() && !md->argsString().empty()))
              ol.docify(md->argsString());
            else if (md->isEnumerate())
              ol.parseText(" "+theTranslator->trEnumName());
            else if (md->isEnumValue())
              ol.parseText(" "+theTranslator->trEnumValue());
            else if (md->isTypedef())
              ol.docify(" typedef");
            else if (md->isFriend() && md->typeString()=="friend class")
              ol.docify(" class");
            else if (md->isFriend() && md->typeString()=="friend struct")
              ol.docify(" struct");
            else if (md->isFriend() && md->typeString()=="friend union")
              ol.docify(" union");
            //ol.writeString("\n");
          }
          ol.writeString("</td>");
          memberWritten=true;
        }
        else if (!cd->isArtificial() &&
                 !Config_getBool(HIDE_UNDOC_MEMBERS) &&
                  (protectionLevelVisible(md->protection()) || md->isFriend())
                ) // no documentation,
                  // generate link to the class instead.
        {
          //ol.writeListItem();
          if (first)
          {
            ol.writeString("<table class=\"directory\">\n");
            first = false;
          }
          ol.writeString("  <tr bgcolor=\"#f0f0f0\"");
          if ((idx&1)==0) ol.writeString(" class=\"even\""); else ol.writeString(" class=\"odd\"");
          idx++;
          ol.writeString("><td class=\"entry\">");
          if (cd->isObjectiveC())
          {
            if (md->isObjCMethod())
            {
              if (md->isStatic())
                ol.writeString("+&#160;</td><td class=\"entry\">");
              else
                ol.writeString("-&#160;</td><td class=\"entry\">");
            }
            else
              ol.writeString("</td><td class=\"entry\">");
          }
          ol.startBold();
          ol.docify(md->name());
          ol.endBold();
          if (!md->isObjCMethod())
          {
            if ( md->isFunction() || md->isSignal() || md->isSlot() )
              ol.docify(md->argsString());
            else if (md->isEnumerate())
              ol.parseText(" "+theTranslator->trEnumName());
            else if (md->isEnumValue())
              ol.parseText(" "+theTranslator->trEnumValue());
            else if (md->isTypedef())
              ol.docify(" typedef");
          }
          ol.writeString(" (");
          ol.parseText(theTranslator->trDefinedIn()+" ");
          if (cd->isLinkable())
          {
            ol.writeObjectLink(
                cd->getReference(),
                cd->getOutputFileBase(),
                cd->anchor(),
                cd->displayName());
          }
          else
          {
            ol.startBold();
            ol.docify(cd->displayName());
            ol.endBold();
          }
          ol.writeString(")");
          ol.writeString("</td>");
          memberWritten=true;
        }
        if (memberWritten)
        {
          ol.writeString("<td class=\"entry\">");
          ol.writeObjectLink(cd->getReference(),
                             cd->getOutputFileBase(),
                             cd->anchor(),
                             md->category() ?
                                md->category()->displayName() :
                                cd->displayName());
          ol.writeString("</td>");
          ol.writeString("<td class=\"entry\">");
        }
        SrcLangExt lang = md->getLanguage();
        if (
            (prot!=Protection::Public || (virt!=Specifier::Normal && getLanguage()!=SrcLangExt::ObjC) ||
             md->isFriend() || md->isRelated() || md->isExplicit() ||
             md->isMutable() || (md->isInline() && Config_getBool(INLINE_INFO)) ||
             md->isSignal() || md->isSlot() || md->isThreadLocal() ||
             (getLanguage()==SrcLangExt::IDL &&
              (md->isOptional() || md->isAttribute() || md->isUNOProperty())) ||
             md->isStatic() || lang==SrcLangExt::VHDL
            )
            && memberWritten)
        {
          StringVector sl;
          if (lang==SrcLangExt::VHDL)
          {
            sl.push_back(theTranslator->trVhdlType(md->getVhdlSpecifiers(),true).str()); //append vhdl type
          }
          else if (md->isFriend()) sl.emplace_back("friend");
          else if (md->isRelated()) sl.emplace_back("related");
          else
          {
            if (Config_getBool(INLINE_INFO) && md->isInline())
                                                   sl.emplace_back("inline");
            if (md->isExplicit())                  sl.emplace_back("explicit");
            if (md->isMutable())                   sl.emplace_back("mutable");
            if (md->isThreadLocal())               sl.emplace_back("thread_local");
            if (prot==Protection::Protected)       sl.emplace_back("protected");
            else if (prot==Protection::Private)    sl.emplace_back("private");
            else if (prot==Protection::Package)    sl.emplace_back("package");
            if (virt==Specifier::Virtual && getLanguage()!=SrcLangExt::ObjC)
                                                   sl.emplace_back("virtual");
            else if (virt==Specifier::Pure)        sl.emplace_back("pure virtual");
            if (md->isStatic())                    sl.emplace_back("static");
            if (md->isSignal())                    sl.emplace_back("signal");
            if (md->isSlot())                      sl.emplace_back("slot");
// this is the extra member page
            if (md->isOptional())                  sl.emplace_back("optional");
            if (md->isAttribute())                 sl.emplace_back("attribute");
            if (md->isUNOProperty())               sl.emplace_back("property");
            if (md->isReadonly())                  sl.emplace_back("readonly");
            if (md->isBound())                     sl.emplace_back("bound");
            if (md->isRemovable())                 sl.emplace_back("removable");
            if (md->isConstrained())               sl.emplace_back("constrained");
            if (md->isTransient())                 sl.emplace_back("transient");
            if (md->isMaybeVoid())                 sl.emplace_back("maybevoid");
            if (md->isMaybeDefault())              sl.emplace_back("maybedefault");
            if (md->isMaybeAmbiguous())            sl.emplace_back("maybeambiguous");
          }
          bool firstSpan=true;
          for (const auto &s : sl)
          {
            if (!firstSpan)
            {
              ol.writeString("</span><span class=\"mlabel\">");
            }
            else
            {
              ol.writeString("<span class=\"mlabel\">");
              firstSpan=false;
            }
            ol.docify(s);
          }
          if (!firstSpan) ol.writeString("</span>");
        }
        if (memberWritten)
        {
          ol.writeString("</td>");
          ol.writeString("</tr>\n");
        }
      }
    }
  }
  //ol.endItemList();
 
  if (!first) ol.writeString("</table>");
 
  endFile(ol);
  ol.popGeneratorState();
}

References anchor(), Definition::anchor(), MemberDef::argsString(), MemberDef::category(), ClassVisible, compoundType(), Config_getBool, OutputList::disableAllBut(), displayName(), Definition::displayName(), OutputList::docify(), DString::empty(), LinkedMap< T, Hash, KeyEqual, Map >::empty(), OutputList::endBold(), endFile(), OutputList::endParagraph(), OutputList::endQuickIndices(), endTitle(), ClassDef::Exception, ExceptionVisible, MemberDef::getClassDef(), Definition::getLanguage(), DefinitionMixin< ClassDefMutable >::getLanguage(), getMemberListFileName(), DefinitionMixin< ClassDefMutable >::getOuterScope(), getOutputFileBase(), Definition::getOutputFileBase(), getReference(), Definition::getReference(), MemberDef::getVhdlSpecifiers(), Doxygen::globalScope, Html, ClassDef::Interface, InterfaceVisible, Definition::isAnonymous(), Definition::isArtificial(), MemberDef::isAttribute(), MemberDef::isBound(), MemberDef::isConstrained(), MemberDef::isEnumerate(), MemberDef::isEnumValue(), MemberDef::isExplicit(), MemberDef::isFriend(), MemberDef::isFunction(), MemberDef::isInline(), Definition::isLinkable(), MemberDef::isMaybeAmbiguous(), MemberDef::isMaybeDefault(), MemberDef::isMaybeVoid(), MemberDef::isMutable(), MemberDef::isObjCMethod(), ClassDef::isObjectiveC(), MemberDef::isOptional(), MemberDef::isReadonly(), MemberDef::isRelated(), MemberDef::isRemovable(), MemberDef::isSignal(), MemberDef::isSlot(), MemberDef::isStatic(), MemberDef::isThreadLocal(), MemberDef::isTransient(), MemberDef::isTypedef(), MemberDef::isUNOProperty(), m_allMemberNameInfoLinkedMap, Definition::name(), DefinitionMixin< ClassDefMutable >::name(), None, OutputList::parseText(), OutputList::popGeneratorState(), MemberDef::protection(), protectionLevelVisible(), OutputList::pushGeneratorState(), OutputList::startBold(), OutputList::startContents(), startFile(), OutputList::startParagraph(), startTitle(), DString::str(), ClassDef::Struct, StructVisible, theTranslator, Translator::trDefinedIn(), Translator::trEnumName(), Translator::trEnumValue(), Translator::trIncludingInheritedMembers(), Translator::trMemberList(), Translator::trThisIsTheListOfAllMembers(), Translator::trVhdlType(), MemberDef::typeString(), MemberDef::virtualness(), DefinitionMixin< ClassDefMutable >::writeNavigationPath(), OutputList::writeObjectLink(), and OutputList::writeString().

writeMemberPages()

void ClassDefImpl::writeMemberPages ( OutputList & ol ) const

overridevirtual

Implements ClassDef.

Definition at line 3074 of file classdef.cpp.

{
  ///////////////////////////////////////////////////////////////////////////
  //// Member definitions on separate pages
  ///////////////////////////////////////////////////////////////////////////
 
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
 
  for (const auto &ml : m_memberLists)
  {
    if (ml->numDocMembers()>ml->numDocEnumValues() && ml->listType().isDetailed())
    {
      ml->writeDocumentationPage(ol,displayName(),this);
    }
  }
 
  ol.popGeneratorState();
}

References OutputList::disableAllBut(), displayName(), Html, m_memberLists, OutputList::popGeneratorState(), and OutputList::pushGeneratorState().

Referenced by writeDocumentation().

writeMoreLink()

void ClassDefImpl::writeMoreLink ( OutputList & ol, const DString & anchor ) const

private

Definition at line 2582 of file classdef.cpp.

{
  // TODO: clean up this mess by moving it to
  // the output generators...
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  bool rtfHyperlinks = Config_getBool(RTF_HYPERLINKS);
  bool usePDFLatex   = Config_getBool(USE_PDFLATEX);
 
  // HTML only
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
  ol.docify(" ");
  ol.startTextLink(getOutputFileBase(),
      anchor.empty() ? DString("details") : anchor);
  ol.parseText(theTranslator->trMore());
  ol.endTextLink();
  ol.popGeneratorState();
 
  if (!anchor.empty())
  {
    ol.pushGeneratorState();
    // LaTeX + RTF
    ol.disable(OutputType::Html);
    ol.disable(OutputType::Man);
    ol.disable(OutputType::Docbook);
    if (!(usePDFLatex && pdfHyperlinks))
    {
      ol.disable(OutputType::Latex);
    }
    if (!rtfHyperlinks)
    {
      ol.disable(OutputType::RTF);
    }
    ol.docify(" ");
    ol.startTextLink(getOutputFileBase(), anchor);
    ol.parseText(theTranslator->trMore());
    ol.endTextLink();
    // RTF only
    ol.disable(OutputType::Latex);
    ol.writeString("\\par");
    ol.popGeneratorState();
  }
}

References anchor(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), Docbook, OutputList::docify(), DString::empty(), OutputList::endTextLink(), getOutputFileBase(), Html, Latex, Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startTextLink(), theTranslator, Translator::trMore(), and OutputList::writeString().

Referenced by writeBriefDescription(), and writeDeclarationLink().

writeNestedClasses()

void ClassDefImpl::writeNestedClasses ( OutputList & ol, const DString & title ) const

private

Definition at line 2218 of file classdef.cpp.

{
  // nested classes
  m_innerClasses.writeDeclaration(ol,nullptr,title,true);
}

References m_innerClasses, title(), and ClassLinkedRefMap::writeDeclaration().

Referenced by writeDocumentationContents().

writePageNavigation()

void ClassDefImpl::writePageNavigation ( OutputList & ol ) const

overridevirtual

Implements DefinitionMutable.

Definition at line 2351 of file classdef.cpp.

{
  ol.writePageOutline();
}

References OutputList::writePageOutline().

writePlainMemberDeclaration()

void ClassDefImpl::writePlainMemberDeclaration ( OutputList & ol, MemberListType lt, bool inGroup, int indentLevel, const ClassDef * inheritedFrom, const DString & inheritId ) const

private

Definition at line 5021 of file classdef.cpp.

{
  //printf("%s: ClassDefImpl::writePlainMemberDeclaration()\n",qPrint(name()));
  MemberList * ml = getMemberList(lt);
  if (ml)
  {
    ml->writePlainDeclarations(ol,inGroup,this,nullptr,nullptr,nullptr,nullptr,indentLevel,inheritedFrom,inheritId);
  }
}

References getMemberList(), and MemberList::writePlainDeclarations().

Referenced by writeDeclaration().

writeQuickMemberLinks()

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

overridevirtual

Implements DefinitionMutable.

Definition at line 3094 of file classdef.cpp.

{
  bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
 
  ol.writeString("      <div class=\"navtab\">\n");
  ol.writeString("        <table>\n");
 
  for (auto &mni : m_allMemberNameInfoLinkedMap)
  {
    for (auto &mi : *mni)
    {
      const MemberDef *md=mi->memberDef();
      if (md->getClassDef()==this && md->isLinkable() && !md->isEnumValue())
      {
        if (md->isLinkableInProject())
        {
          if (md==currentMd) // selected item => highlight
          {
            ol.writeString("          <tr><td class=\"navtabHL\">");
          }
          else
          {
            ol.writeString("          <tr><td class=\"navtab\">");
          }
          ol.writeString("<span class=\"label\"><a ");
          ol.writeString("href=\"");
          if (createSubDirs) ol.writeString("../../");
          DString url = md->getOutputFileBase();
          addHtmlExtensionIfMissing(url);
          ol.writeString(url+"#"+md->anchor());
          ol.writeString("\">");
          ol.writeString(convertToHtml(md->name()));
          ol.writeString("</a></span>");
          ol.writeString("</td></tr>\n");
        }
      }
    }
  }
 
  ol.writeString("        </table>\n");
  ol.writeString("      </div>\n");
}

References addHtmlExtensionIfMissing(), Definition::anchor(), Config_getBool, convertToHtml(), createSubDirs(), MemberDef::getClassDef(), Definition::getOutputFileBase(), MemberDef::isEnumValue(), Definition::isLinkable(), Definition::isLinkableInProject(), m_allMemberNameInfoLinkedMap, Definition::name(), and OutputList::writeString().

writeSimpleMemberDocumentation()

void ClassDefImpl::writeSimpleMemberDocumentation ( OutputList & ol, MemberListType lt ) const

private

Definition at line 5014 of file classdef.cpp.

{
  //printf("%s: ClassDefImpl::writeSimpleMemberDocumentation()\n",qPrint(name()));
  MemberList * ml = getMemberList(lt);
  if (ml) ml->writeSimpleDocumentation(ol,this);
}

References getMemberList(), and MemberList::writeSimpleDocumentation().

Referenced by writeInlineDocumentation().

writeSummaryLinks()

void ClassDefImpl::writeSummaryLinks ( OutputList & ol ) const

overridevirtual

Implements DefinitionMutable.

Definition at line 2282 of file classdef.cpp.

{
  static bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
  bool first=true;
  SrcLangExt lang = getLanguage();
 
  if (lang!=SrcLangExt::VHDL)
  {
    for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
    {
      if (lde->kind()==LayoutDocEntry::ClassNestedClasses &&
          m_innerClasses.declVisible()
         )
      {
        for (const auto &innerCd : m_innerClasses)
        {
          if (!innerCd->isAnonymous() &&
              !innerCd->isExtension() &&
              (innerCd->protection()!=Protection::Private || extractPrivate) &&
              innerCd->visibleInParentsDeclList()
             )
          {
            const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection *>(lde.get());
            ol.writeSummaryLink(DString(),"nested-classes",ls->title(lang),first);
            first=false;
            break;
          }
        }
      }
      else if (lde->kind()==LayoutDocEntry::ClassAllMembersLink &&
               !m_allMemberNameInfoLinkedMap.empty() &&
               !Config_getBool(OPTIMIZE_OUTPUT_FOR_C)
              )
      {
        ol.writeSummaryLink(getMemberListFileName(),"all-members-list",theTranslator->trListOfAllMembers(),first);
        first=false;
      }
      else if (lde->kind()==LayoutDocEntry::MemberDecl)
      {
        const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
        if (lmd)
        {
          MemberList * ml = getMemberList(lmd->type);
          if (ml && ml->declVisible())
          {
            ol.writeSummaryLink(DString(),ml->listType().toLabel(),lmd->title(lang),first);
            first=false;
          }
        }
      }
    }
  }
  else // VDHL only
  {
    for (const auto &s : m_vhdlSummaryTitles)
    {
      ol.writeSummaryLink(DString(),convertToId(s),s,first);
      first=false;
    }
  }
  if (!first)
  {
    ol.writeString("  </div>\n");
  }
  ol.popGeneratorState();
}

References Config_getBool, convertToId(), ClassLinkedRefMap::declVisible(), MemberList::declVisible(), OutputList::disableAllBut(), LinkedMap< T, Hash, KeyEqual, Map >::empty(), DefinitionMixin< ClassDefMutable >::getLanguage(), getMemberList(), getMemberListFileName(), Html, LayoutDocManager::instance(), MemberList::listType(), m_allMemberNameInfoLinkedMap, m_innerClasses, m_vhdlSummaryTitles, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), theTranslator, LayoutDocEntryMemberDecl::title(), LayoutDocEntrySection::title(), MemberListType::toLabel(), Translator::trListOfAllMembers(), LayoutDocEntryMemberDecl::type, OutputList::writeString(), and OutputList::writeSummaryLink().

writeTagFile()

void ClassDefImpl::writeTagFile ( TextStream & tagFile ) const

overridevirtual

Implements ClassDef.

Definition at line 2356 of file classdef.cpp.

{
  if (!isLinkableInProject() || isArtificial()) return;
  tagFile << "  <compound kind=\"";
  if (isFortran() && (compoundTypeString() == "type"))
    tagFile << "struct";
  else
    tagFile << compoundTypeString();
  tagFile << "\"";
  if (isObjectiveC()) { tagFile << " objc=\"yes\""; }
  tagFile << ">\n";
  tagFile << "    <name>" << convertToXML(name()) << "</name>\n";
  DString fn = getOutputFileBase();
  addHtmlExtensionIfMissing(fn);
  tagFile << "    <filename>" << convertToXML(fn) << "</filename>\n";
  if (!anchor().empty())
  {
    tagFile << "    <anchor>" << convertToXML(anchor()) << "</anchor>\n";
  }
  DString idStr = id();
  if (!idStr.empty())
  {
    tagFile << "    <clangid>" << convertToXML(idStr) << "</clangid>\n";
  }
  for (const Argument &a : m_tempArgs)
  {
    tagFile << "    <templarg>" << convertToXML(a.type);
    if (!a.name.empty())
    {
      tagFile << " " << convertToXML(a.name);
    }
    tagFile << "</templarg>\n";
  }
  for (const auto &ibcd : m_inherits)
  {
    ClassDef *cd=ibcd.classDef;
    if (cd && cd->isLinkable())
    {
      tagFile << "    <base";
      if (ibcd.prot==Protection::Protected)
      {
        tagFile << " protection=\"protected\"";
      }
      else if (ibcd.prot==Protection::Private)
      {
        tagFile << " protection=\"private\"";
      }
      if (ibcd.virt==Specifier::Virtual)
      {
        tagFile << " virtualness=\"virtual\"";
      }
      DString displayName = insertTemplateSpecifierInScope(
          cd->displayName(),ibcd.templSpecifiers);
      tagFile << ">" << convertToXML(displayName) << "</base>\n";
    }
  }
  for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Class))
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::ClassNestedClasses:
        {
          for (const auto &innerCd : m_innerClasses)
          {
            if (innerCd->isLinkableInProject() && !innerCd->isImplicitTemplateInstance() &&
                protectionLevelVisible(innerCd->protection()) &&
                !innerCd->isEmbeddedInOuterScope()
               )
            {
              tagFile << "    <class kind=\"" << innerCd->compoundTypeString() <<
                "\">" << convertToXML(innerCd->name()) << "</class>\n";
            }
          }
        }
        break;
      case LayoutDocEntry::MemberDecl:
        {
          const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
          if (lmd)
          {
            MemberList * ml = getMemberList(lmd->type);
            if (ml)
            {
              ml->writeTagFile(tagFile);
            }
          }
        }
        break;
      case LayoutDocEntry::MemberGroups:
        {
          for (const auto &mg : m_memberGroups)
          {
            mg->writeTagFile(tagFile);
          }
        }
        break;
     default:
        break;
    }
  }
  writeDocAnchorsToTagFile(tagFile);
  tagFile << "  </compound>\n";
}

References addHtmlExtensionIfMissing(), anchor(), compoundTypeString(), convertToXML(), displayName(), Definition::displayName(), DString::empty(), getMemberList(), getOutputFileBase(), DefinitionMixin< ClassDefMutable >::id(), insertTemplateSpecifierInScope(), LayoutDocManager::instance(), DefinitionMixin< ClassDefMutable >::isArtificial(), isFortran(), Definition::isLinkable(), isLinkableInProject(), isObjectiveC(), m_inherits, m_innerClasses, m_memberGroups, m_tempArgs, DefinitionMixin< ClassDefMutable >::name(), protectionLevelVisible(), LayoutDocEntryMemberDecl::type, DefinitionMixin< ClassDefMutable >::writeDocAnchorsToTagFile(), and MemberList::writeTagFile().

writeTemplateSpec()

void ClassDefImpl::writeTemplateSpec ( OutputList & ol, const Definition * d, const DString & type, SrcLangExt lang ) const

private

Definition at line 1535 of file classdef.cpp.

{
  ArgumentLists specs;
  DString name;
  searchTemplateSpecs(d,specs,name,lang);
  if (!specs.empty()) // class has template scope specifiers
  {
    ol.startCompoundTemplateParams();
    for (const ArgumentList &al : specs)
    {
      ol.docify("template<");
      auto it = al.begin();
      while (it!=al.end())
      {
        Argument a = *it;
        linkifyText(TextGeneratorOLImpl(ol), // out
          a.type,                            // text
          LinkifyTextOptions().setScope(d).setFileScope(getFileDef()).setSelf(this));
        if (!a.name.empty())
        {
          ol.docify(" ");
          ol.docify(a.name);
        }
        if (a.defval.length()!=0)
        {
          ol.docify(" = ");
          ol.docify(a.defval);
        }
        ++it;
        if (it!=al.end()) ol.docify(", ");
      }
      ol.docify(">");
      ol.lineBreak();
    }
    if (!m_requiresClause.empty())
    {
      ol.docify("requires ");
      linkifyText(TextGeneratorOLImpl(ol), // out
          m_requiresClause,                // text
          LinkifyTextOptions().setScope(d).setFileScope(getFileDef()).setSelf(this));
      ol.lineBreak();
    }
    ol.docify(type.lower()+" "+name);
    ol.endCompoundTemplateParams();
  }
}

References Argument::defval, OutputList::docify(), DString::empty(), OutputList::endCompoundTemplateParams(), getFileDef(), DString::length(), OutputList::lineBreak(), linkifyText(), DString::lower(), m_requiresClause, Argument::name, DefinitionMixin< ClassDefMutable >::name(), searchTemplateSpecs(), OutputList::startCompoundTemplateParams(), and Argument::type.

Referenced by writeDetailedDocumentationBody().

Member Data Documentation

m_allMemberNameInfoLinkedMap

MemberNameInfoLinkedMap ClassDefImpl::m_allMemberNameInfoLinkedMap

private

List of all members (including inherited members)

Definition at line 470 of file classdef.cpp.

Referenced by addMembersToTemplateInstance(), containsOverload(), deepCopy(), getMemberByName(), hideDerivedVariablesInPython(), internalInsertMember(), memberNameInfoLinkedMap(), mergeCategory(), mergeMembersFromBaseClasses(), setGroupDefForAllMembers(), sortAllMembersList(), writeDocumentation(), writeMemberList(), writeQuickMemberLinks(), and writeSummaryLinks().

m_arrowOperator

const MemberDef* ClassDefImpl::m_arrowOperator = nullptr

private

Does this class overloaded the -> operator?

Definition at line 557 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), internalInsertMember(), and isSmartPointer().

m_categoryOf

ClassDef* ClassDefImpl::m_categoryOf = nullptr

private

If this class is a Objective-C category, then this points to the class which is extended.

Definition at line 520 of file classdef.cpp.

Referenced by categoryOf(), ClassDefImpl(), deepCopy(), and setCategoryOf().

m_className

DString ClassDefImpl::m_className

private

local class name which could be a typedef'ed alias name.

Definition at line 515 of file classdef.cpp.

Referenced by className(), deepCopy(), setClassName(), and setProtection().

m_collabFileName

DString ClassDefImpl::m_collabFileName

private

file name used for the collaboration diagram

Definition at line 439 of file classdef.cpp.

Referenced by ClassDefImpl(), collaborationGraphFileName(), and deepCopy().

m_compType

ClassDef::CompoundType ClassDefImpl::m_compType

private

Holds the kind of "class" this is.

Definition at line 485 of file classdef.cpp.

Referenced by ClassDefImpl(), compoundType(), compoundTypeString(), deepCopy(), generatedFromFiles(), setCompoundType(), and title().

m_constraintClassList

ConstraintClassList ClassDefImpl::m_constraintClassList

private

Definition at line 502 of file classdef.cpp.

Referenced by addTypeConstraint(), deepCopy(), and templateTypeConstraints().

m_examples

ExampleList ClassDefImpl::m_examples

private

Examples that use this class

Definition at line 482 of file classdef.cpp.

Referenced by addExample(), deepCopy(), getExamples(), hasExamples(), and writeDetailedDocumentationBody().

m_fileDef

FileDef* ClassDefImpl::m_fileDef = nullptr

private

Namespace this class is part of (this is the inner most namespace in case of nested namespaces)

File this class is defined in

Definition at line 464 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), getFileDef(), moveTo(), and setFileDef().

m_fileName

DString ClassDefImpl::m_fileName

private

file name that forms the base for the output file containing the class documentation. For compatibility with Qt (e.g. links via tag files) this name cannot be derived from the class name directly.

Definition at line 433 of file classdef.cpp.

Referenced by anchor(), ClassDefImpl(), getInstanceOutputFileBase(), and getOutputFileBase().

m_files

FileList ClassDefImpl::m_files

private

Files that were used for generating the class documentation.

Definition at line 479 of file classdef.cpp.

Referenced by deepCopy(), generatedFromFiles(), insertUsedFile(), showUsedFiles(), and usedFiles().

m_hasCollaborationGraph

bool ClassDefImpl::m_hasCollaborationGraph = false

private

Definition at line 574 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), hasCollaborationGraph(), overrideCollaborationGraph(), and writeCollaborationGraph().

m_hasNamedVariable

bool ClassDefImpl::m_hasNamedVariable = false

private

Definition at line 560 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), hasNamedVariable(), and setHasNamedVariable().

m_implicitTemplateInstance

bool ClassDefImpl::m_implicitTemplateInstance = false

private

Definition at line 577 of file classdef.cpp.

Referenced by anchor(), getOutputFileBase(), getReference(), getSourceFileBase(), isImplicitTemplateInstance(), isLinkable(), isLinkableInProject(), isReference(), isVisibleInHierarchy(), and setImplicitTemplateInstance().

m_incInfo

std::unique_ptr<IncludeInfo> ClassDefImpl::m_incInfo

private

Include information about the header file should be included in the documentation. 0 by default, set by setIncludeFile().

Definition at line 447 of file classdef.cpp.

Referenced by deepCopy(), includeInfo(), setIncludeFile(), writeIncludeFiles(), and writeIncludeFilesForSlice().

m_inheritedBy

BaseClassList ClassDefImpl::m_inheritedBy

private

List of sub-classes that directly derive from this class

Definition at line 456 of file classdef.cpp.

Referenced by countInheritedByNodes(), deepCopy(), insertSubClass(), isVisibleInHierarchy(), subClasses(), updateSubClasses(), and writeInheritanceGraph().

m_inheritFileName

DString ClassDefImpl::m_inheritFileName

private

file name used for the inheritance graph

Definition at line 442 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), and inheritanceGraphFileName().

m_inherits

BaseClassList ClassDefImpl::m_inherits

private

List of base class (or super-classes) from which this class derives directly.

Definition at line 452 of file classdef.cpp.

Referenced by baseClasses(), countInheritedDecMembers(), countInheritsNodes(), deepCopy(), insertBaseClass(), isVisibleInHierarchy(), updateBaseClasses(), writeIncludeFilesForSlice(), writeInheritanceGraph(), writeInheritedMemberDeclarations(), and writeTagFile().

m_innerClasses

ClassLinkedRefMap ClassDefImpl::m_innerClasses

private

The inner classes contained in this class. Will be 0 if there are no inner classes.

Definition at line 496 of file classdef.cpp.

Referenced by addInnerCompound(), addMembersToTemplateInstance(), deepCopy(), findInnerCompound(), getClasses(), insertTemplateInstance(), sortMemberLists(), writeDocumentationForInnerClasses(), writeInlineClasses(), writeNestedClasses(), writeSummaryLinks(), and writeTagFile().

m_isAbstract

bool ClassDefImpl::m_isAbstract = false

private

Is this an abstract class?

Definition at line 528 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), internalInsertMember(), and isAbstract().

m_isJavaEnum

bool ClassDefImpl::m_isJavaEnum = false

private

Does this class represent a Java style enum?

Definition at line 563 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), and isJavaEnum().

m_isLocal

bool ClassDefImpl::m_isLocal = false

private

true if the class is defined in a source file rather than a header file.

Definition at line 537 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), isLinkableInProject(), and isLocal().

m_isSimple

bool ClassDefImpl::m_isSimple = false

private

Is this a simple (non-nested) C structure?

Definition at line 554 of file classdef.cpp.

Referenced by addInnerCompound(), ClassDefImpl(), deepCopy(), getOutputFileBase(), insertBaseClass(), insertSubClass(), internalInsertMember(), isEmbeddedInOuterScope(), isSimple(), and writeInlineDocumentation().

m_isStatic

bool ClassDefImpl::m_isStatic = false

private

Is the class part of an unnamed namespace?

Definition at line 531 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), isLinkableInProject(), isVisibleInHierarchy(), and setIsStatic().

m_isTemplArg

bool ClassDefImpl::m_isTemplArg = false

private

Definition at line 539 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), isTemplateArgument(), and makeTemplateArgument().

m_memberGroups

MemberGroupList ClassDefImpl::m_memberGroups

private

Definition at line 525 of file classdef.cpp.

Referenced by addGroupedInheritedMembers(), addListReferences(), addMembersToMemberGroup(), addRequirementReferences(), computeAnchors(), countMemberDeclarations(), countMembers(), countMembersIncludingGrouped(), distributeMemberGroupDocumentation(), findSectionsInDocumentation(), getMemberGroups(), setAnonymousEnumType(), writeDeclaration(), writeMemberGroups(), and writeTagFile().

m_memberListFileName

DString ClassDefImpl::m_memberListFileName

private

file name used for the list of all members

Definition at line 436 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), and getMemberListFileName().

m_memberLists

MemberLists ClassDefImpl::m_memberLists

private

Definition at line 522 of file classdef.cpp.

Referenced by addListReferences(), addMembersToMemberGroup(), addMemberToList(), addRequirementReferences(), computeAnchors(), countMembers(), findSectionsInDocumentation(), getMemberList(), getMemberLists(), internalInsertMember(), reclassifyMember(), removeMemberFromLists(), sortMemberLists(), and writeMemberPages().

m_membersMerged

bool ClassDefImpl::m_membersMerged = false

private

true if classes members are merged with those of the base classes.

Definition at line 534 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), and mergeMembers().

m_metaData

DString ClassDefImpl::m_metaData

private

Definition at line 567 of file classdef.cpp.

Referenced by deepCopy(), setMetaData(), and writeIncludeFilesForSlice().

m_moduleDef

ModuleDef* ClassDefImpl::m_moduleDef = nullptr

private

Module this class is defined in

Definition at line 467 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), getModuleDef(), moveTo(), and setModuleDef().

m_primaryConstructorParams

ArgumentList ClassDefImpl::m_primaryConstructorParams

private

Definition at line 579 of file classdef.cpp.

Referenced by setPrimaryConstructorParams(), and title().

m_prot

Protection ClassDefImpl::m_prot

private

The protection level in which this class was found. Typically Public, but for nested classes this can also be Protected or Private.

Definition at line 491 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), isLinkableInProject(), isVisibleInHierarchy(), protection(), and setProtection().

m_qualifiers

StringVector ClassDefImpl::m_qualifiers

private

Definition at line 572 of file classdef.cpp.

Referenced by addClassAttributes(), addQualifiers(), deepCopy(), and getQualifiers().

m_requiresClause

DString ClassDefImpl::m_requiresClause

private

C++20 requires clause.

Definition at line 570 of file classdef.cpp.

Referenced by deepCopy(), requiresClause(), setRequiresClause(), and writeTemplateSpec().

m_spec

TypeSpecifier ClassDefImpl::m_spec

private

Definition at line 565 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), isAbstract(), isFinal(), isForwardDeclared(), isInterface(), isPublished(), isSealed(), isSliceLocal(), setClassSpecifier(), and writeIncludeFilesForSlice().

m_subGrouping

bool ClassDefImpl::m_subGrouping = false

private

Does this class group its user-grouped members as a sub-section of the normal (public/protected/..) groups?

Definition at line 545 of file classdef.cpp.

Referenced by addGroupedInheritedMembers(), addMembersToMemberGroup(), ClassDefImpl(), countMembersIncludingGrouped(), deepCopy(), setSubGrouping(), subGrouping(), and writeMemberGroups().

m_taglessParent

const ClassDef* ClassDefImpl::m_taglessParent = nullptr

private

Definition at line 559 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), setTaglessParent(), and taglessParent().

m_tempArgs

ArgumentList ClassDefImpl::m_tempArgs

private

Template arguments of this class

Definition at line 473 of file classdef.cpp.

Referenced by addTypeConstraints(), deepCopy(), hasDetailedDescription(), isLinkableInProject(), isTemplate(), setTemplateArguments(), templateArguments(), title(), writeDetailedDocumentationBody(), and writeTagFile().

m_templateInstances

TemplateInstanceList ClassDefImpl::m_templateInstances

private

Template instances that exists of this class, the key in the dictionary is the template argument list.

Definition at line 507 of file classdef.cpp.

Referenced by deepCopy(), getTemplateInstances(), insertExplicitTemplateInstance(), insertTemplateInstance(), and insertUsedFile().

m_templateMaster

const ClassDef* ClassDefImpl::m_templateMaster = nullptr

private

The class this class is an instance of.

Definition at line 512 of file classdef.cpp.

Referenced by anchor(), ClassDefImpl(), deepCopy(), getOutputFileBase(), getReference(), getSourceFileBase(), isLinkable(), isLinkableInProject(), isReference(), isVisibleInHierarchy(), setTemplateMaster(), and templateMaster().

m_templBaseClassNames

TemplateNameMap ClassDefImpl::m_templBaseClassNames

private

Definition at line 509 of file classdef.cpp.

Referenced by deepCopy(), getTemplateBaseClassNames(), and setTemplateBaseClassNames().

m_typeConstraints

ArgumentList ClassDefImpl::m_typeConstraints

private

Type constraints for template parameters

Definition at line 476 of file classdef.cpp.

Referenced by deepCopy(), setTypeConstraints(), typeConstraints(), and writeDetailedDocumentationBody().

m_typeInheritanceGraph

CLASS_GRAPH_t ClassDefImpl::m_typeInheritanceGraph = CLASS_GRAPH_t::NO

private

Definition at line 575 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), hasInheritanceGraph(), overrideInheritanceGraph(), and writeInheritanceGraph().

m_usedByImplClassList

UsesClassList ClassDefImpl::m_usedByImplClassList

private

Definition at line 500 of file classdef.cpp.

Referenced by addUsedByClass(), deepCopy(), and usedByImplementationClasses().

m_usedOnly

bool ClassDefImpl::m_usedOnly = false

private

Reason of existence is a "use" relation.

Definition at line 548 of file classdef.cpp.

Referenced by ClassDefImpl(), deepCopy(), isUsedOnly(), and setUsedOnly().

m_usesImplClassList

UsesClassList ClassDefImpl::m_usesImplClassList

private

Definition at line 499 of file classdef.cpp.

Referenced by addUsedClass(), deepCopy(), and usedImplementationClasses().

m_vhdlSummaryTitles

StringSet ClassDefImpl::m_vhdlSummaryTitles

private

List of titles to use for the summary.

Definition at line 551 of file classdef.cpp.

Referenced by deepCopy(), internalInsertMember(), and writeSummaryLinks().

---

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

• src/classdef.cpp