Doxygen
Loading...
Searching...
No Matches
classdef.cpp File Reference
#include <cstdio>
#include <algorithm>
#include "types.h"
#include "classdef.h"
#include "classlist.h"
#include "entry.h"
#include "doxygen.h"
#include "membername.h"
#include "message.h"
#include "config.h"
#include "util.h"
#include "diagram.h"
#include "language.h"
#include "htmlhelp.h"
#include "example.h"
#include "outputlist.h"
#include "dot.h"
#include "dotclassgraph.h"
#include "dotrunner.h"
#include "defargs.h"
#include "debug.h"
#include "docparser.h"
#include "searchindex.h"
#include "vhdldocgen.h"
#include "layout.h"
#include "arguments.h"
#include "memberlist.h"
#include "groupdef.h"
#include "filedef.h"
#include "namespacedef.h"
#include "membergroup.h"
#include "definitionimpl.h"
#include "symbolresolver.h"
#include "fileinfo.h"
#include "trace.h"
#include "moduledef.h"
Include dependency graph for classdef.cpp:

Go to the source code of this file.

Classes

class  ClassDefImpl
 Implementation of the ClassDef interface. More...
class  ClassDefAliasImpl

Functions

static DString makeQualifiedNameWithTemplateParameters (const ClassDef *cd, const ArgumentLists *actualParams, uint32_t *actualParamIndex)
static DString makeDisplayName (const ClassDef *cd, bool includeScope)
static DString getCompoundTypeString (SrcLangExt lang, ClassDef::CompoundType compType, bool isJavaEnum)
std::unique_ptr< ClassDefcreateClassDef (const DString &fileName, int startLine, size_t startColumn, const DString &name, ClassDef::CompoundType ct, const DString &ref, const DString &fName, bool isSymbol, bool isJavaEnum)
 Factory method to create a new ClassDef object.
std::unique_ptr< ClassDefcreateClassDefAlias (const Definition *newScope, const ClassDef *cd)
static void writeInheritanceSpecifier (OutputList &ol, const BaseClassDef &bcd)
static void searchTemplateSpecs (const Definition *d, ArgumentLists &result, DString &name, SrcLangExt lang)
static bool hasNonReferenceSuperClassRec (const ClassDef *cd, int level)
static bool isStandardFunc (const MemberDef *md)
ClassDeftoClassDef (Definition *d)
ClassDeftoClassDef (DefinitionMutable *md)
const ClassDeftoClassDef (const Definition *d)
ClassDefMutabletoClassDefMutable (Definition *d)
ClassDefgetClass (const DString &n)
bool classHasVisibleRoot (const BaseClassList &bcl)
bool classHasVisibleChildren (const ClassDef *cd)
bool classVisibleInIndex (const ClassDef *cd)
int minClassDistance (const ClassDef *cd, const ClassDef *bcd, int level)
Protection classInheritedProtectionLevel (const ClassDef *cd, const ClassDef *bcd, Protection prot, int level)

Function Documentation

◆ classHasVisibleChildren()

bool classHasVisibleChildren ( const ClassDef * cd)

Definition at line 5518 of file classdef.cpp.

5519{
5520 BaseClassList bcl;
5521
5522 if (cd->getLanguage()==SrcLangExt::VHDL) // reverse baseClass/subClass relation
5523 {
5524 if (cd->baseClasses().empty()) return false;
5525 bcl=cd->baseClasses();
5526 }
5527 else
5528 {
5529 if (cd->subClasses().empty()) return false;
5530 bcl=cd->subClasses();
5531 }
5532
5533 for (const auto &bcd : bcl)
5534 {
5535 if (bcd.classDef->isVisibleInHierarchy())
5536 {
5537 return true;
5538 }
5539 }
5540 return false;
5541}
virtual const BaseClassList & baseClasses() const =0
Returns the list of base classes from which this class directly inherits.
virtual const BaseClassList & subClasses() const =0
Returns the list of sub classes that directly derive from this class.
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
std::vector< BaseClassDef > BaseClassList
Definition classdef.h:81

References ClassDef::baseClasses(), classHasVisibleChildren(), Definition::getLanguage(), and ClassDef::subClasses().

Referenced by classHasVisibleChildren(), writeClassTreeForList(), and writeClassTreeToOutput().

◆ classHasVisibleRoot()

bool classHasVisibleRoot ( const BaseClassList & bcl)

Definition at line 5507 of file classdef.cpp.

5508{
5509 for (const auto &bcd : bcl)
5510 {
5511 const ClassDef *cd=bcd.classDef;
5512 if (cd->isVisibleInHierarchy()) return true;
5513 if (classHasVisibleRoot(cd->baseClasses())) return true;
5514 }
5515 return false;
5516}
A abstract class representing of a compound symbol.
Definition classdef.h:104
virtual bool isVisibleInHierarchy() const =0
the class is visible in a class diagram, or class hierarchy
bool classHasVisibleRoot(const BaseClassList &bcl)

References ClassDef::baseClasses(), classHasVisibleRoot(), and ClassDef::isVisibleInHierarchy().

Referenced by DotGfxHierarchyTable::addClassList(), DotGfxHierarchyTable::addHierarchy(), classHasVisibleRoot(), countClassesInTreeList(), writeClassTreeForList(), and writeClassTreeToOutput().

◆ classInheritedProtectionLevel()

Protection classInheritedProtectionLevel ( const ClassDef * cd,
const ClassDef * bcd,
Protection prot,
int level )

Definition at line 5577 of file classdef.cpp.

5578{
5579 if (bcd->categoryOf()) // use class that is being extended in case of
5580 // an Objective-C category
5581 {
5582 bcd=bcd->categoryOf();
5583 }
5584 if (cd==bcd)
5585 {
5586 goto exit;
5587 }
5588 if (level==256)
5589 {
5590 err("Internal inconsistency: found class {} seem to have a recursive "
5591 "inheritance relation! Please send a bug report to doxygen@gmail.com\n",cd->name());
5592 }
5593 else if (prot!=Protection::Private)
5594 {
5595 for (const auto &bcdi : cd->baseClasses())
5596 {
5597 Protection baseProt = classInheritedProtectionLevel(bcdi.classDef,bcd,bcdi.prot,level+1);
5598 if (baseProt==Protection::Private) prot=Protection::Private;
5599 else if (baseProt==Protection::Protected) prot=Protection::Protected;
5600 }
5601 }
5602exit:
5603 //printf("classInheritedProtectionLevel(%s,%s)=%d\n",qPrint(cd->name()),qPrint(bcd->name()),prot);
5604 return prot;
5605}
virtual ClassDef * categoryOf() const =0
Returns the class of which this is a category (Objective-C only).
virtual const DString & name() const =0
Protection classInheritedProtectionLevel(const ClassDef *cd, const ClassDef *bcd, Protection prot, int level)
#define err(fmt,...)
Definition message.h:127
Protection
Definition types.h:32

References ClassDef::baseClasses(), ClassDef::categoryOf(), classInheritedProtectionLevel(), err, and Definition::name().

Referenced by classInheritedProtectionLevel().

◆ classVisibleInIndex()

bool classVisibleInIndex ( const ClassDef * cd)

Definition at line 5543 of file classdef.cpp.

5544{
5545 bool allExternals = Config_getBool(ALLEXTERNALS);
5546 return (allExternals && cd->isLinkable()) || cd->isLinkableInProject();
5547}
virtual bool isLinkable() const =0
virtual bool isLinkableInProject() const =0
#define Config_getBool(name)
Definition config.h:33

References classVisibleInIndex(), Config_getBool, Definition::isLinkable(), and Definition::isLinkableInProject().

Referenced by classVisibleInIndex(), and writeClassTree().

◆ createClassDef()

std::unique_ptr< ClassDef > createClassDef ( const DString & fileName,
int startLine,
size_t startColumn,
const DString & name,
ClassDef::CompoundType ct,
const DString & ref,
const DString & fName,
bool isSymbol,
bool isJavaEnum )

Factory method to create a new ClassDef object.

Definition at line 573 of file classdef.cpp.

578{
579 return std::make_unique<ClassDefImpl>(fileName,startLine,startColumn,name,ct,ref,fName,isSymbol,isJavaEnum);
580}

References createClassDef().

Referenced by addClassToContext(), createClassDef(), createTagLessInstance(), findClassRelation(), findUsedClassesForClass(), findUsingDeclarations(), and ClassDefMutable::setPrimaryConstructorParams().

◆ createClassDefAlias()

std::unique_ptr< ClassDef > createClassDefAlias ( const Definition * newScope,
const ClassDef * cd )

Definition at line 799 of file classdef.cpp.

800{
801 auto acd = std::make_unique<ClassDefAliasImpl>(newScope,cd);
802 //printf("cd name=%s localName=%s qualifiedName=%s qualifiedNameWith=%s displayName()=%s\n",
803 // qPrint(acd->name()),qPrint(acd->localName()),qPrint(acd->qualifiedName()),
804 // qPrint(acd->qualifiedNameWithTemplateParameters()),qPrint(acd->displayName()));
805 return acd;
806}

References createClassDefAlias().

Referenced by createClassDefAlias(), ClassDefAliasImpl::deepCopy(), findUsingDeclImports(), resolveClassNestingRelations(), and ClassDefMutable::setPrimaryConstructorParams().

◆ getClass()

◆ getCompoundTypeString()

DString getCompoundTypeString ( SrcLangExt lang,
ClassDef::CompoundType compType,
bool isJavaEnum )
static

Definition at line 158 of file classdef.cpp.

159{
160 if (lang==SrcLangExt::Fortran)
161 {
162 switch (compType)
163 {
164 case ClassDef::Class: return "module";
165 case ClassDef::Struct: return "type";
166 case ClassDef::Union: return "union";
167 case ClassDef::Interface: return "interface";
168 case ClassDef::Protocol: return "protocol";
169 case ClassDef::Category: return "category";
170 case ClassDef::Exception: return "exception";
171 default: return "unknown";
172 }
173 }
174 else
175 {
176 switch (compType)
177 {
178 case ClassDef::Class: return isJavaEnum ? "enum" : "class";
179 case ClassDef::Struct: return "struct";
180 case ClassDef::Union: return "union";
181 case ClassDef::Interface: return lang==SrcLangExt::ObjC ? "class" : "interface";
182 case ClassDef::Protocol: return "protocol";
183 case ClassDef::Category: return "category";
184 case ClassDef::Exception: return "exception";
185 case ClassDef::Service: return "service";
186 case ClassDef::Singleton: return "singleton";
187 default: return "unknown";
188 }
189 }
190}
@ Singleton
Definition classdef.h:117
@ Interface
Definition classdef.h:112
@ Exception
Definition classdef.h:115

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

Referenced by ClassDefImpl::ClassDefImpl(), ClassDefImpl::compoundTypeString(), ClassDefImpl::deepCopy(), and getCompoundTypeString().

◆ hasNonReferenceSuperClassRec()

bool hasNonReferenceSuperClassRec ( const ClassDef * cd,
int level )
static

Definition at line 3512 of file classdef.cpp.

3513{
3514 bool found=!cd->isReference() && cd->isLinkableInProject() && !cd->isHidden();
3515 if (found)
3516 {
3517 return true; // we're done if this class is not a reference
3518 }
3519 for (const auto &ibcd : cd->subClasses())
3520 {
3521 const ClassDef *bcd=ibcd.classDef;
3522 if (level>256)
3523 {
3524 err("Possible recursive class relation while inside {} and looking for base class {}\n",cd->name(),bcd->name());
3525 return false;
3526 }
3527 // recurse into the super class branch
3528 found = found || hasNonReferenceSuperClassRec(bcd,level+1);
3529 if (!found)
3530 {
3531 // look for template instances that might have non-reference super classes
3532 for (const auto &cil : bcd->getTemplateInstances())
3533 {
3534 // recurse into the template instance branch
3535 found = hasNonReferenceSuperClassRec(cil.classDef,level+1);
3536 if (found) break;
3537 }
3538 }
3539 else
3540 {
3541 break;
3542 }
3543 }
3544 return found;
3545}
virtual const TemplateInstanceList & getTemplateInstances() const =0
Returns a sorted dictionary with all template instances found for this template class.
virtual bool isHidden() const =0
virtual bool isReference() const =0
static bool hasNonReferenceSuperClassRec(const ClassDef *cd, int level)

References err, ClassDef::getTemplateInstances(), hasNonReferenceSuperClassRec(), Definition::isHidden(), Definition::isLinkableInProject(), Definition::isReference(), Definition::name(), and ClassDef::subClasses().

Referenced by ClassDefImpl::hasNonReferenceSuperClass(), and hasNonReferenceSuperClassRec().

◆ isStandardFunc()

bool isStandardFunc ( const MemberDef * md)
static

Definition at line 3717 of file classdef.cpp.

3718{
3719 return md->name()=="operator=" || // assignment operator
3720 md->isConstructor() || // constructor
3721 md->isDestructor(); // destructor
3722}
virtual bool isDestructor() const =0
virtual bool isConstructor() const =0

References MemberDef::isConstructor(), MemberDef::isDestructor(), isStandardFunc(), and Definition::name().

Referenced by isStandardFunc(), and ClassDefImpl::mergeMembersFromBaseClasses().

◆ makeDisplayName()

DString makeDisplayName ( const ClassDef * cd,
bool includeScope )
static

Definition at line 107 of file classdef.cpp.

108{
109 //bool optimizeOutputForJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
110 SrcLangExt lang = cd->getLanguage();
111 //bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
112 DString n;
113 if (lang==SrcLangExt::VHDL)
114 {
116 }
117 else
118 {
119 if (cd->tagLessReference())
120 {
121 size_t idx=cd->name().rfind("::");
122 if (includeScope || idx==DString::npos)
123 {
124 n=cd->name();
125 }
126 else
127 {
128 n=cd->name().mid(idx+2);
129 }
130 }
131 else if (includeScope)
132 {
134 }
135 else
136 {
137 n=cd->className();
138 }
139 }
140 if (cd->isAnonymous())
141 {
143 }
145 if (sep!="::")
146 {
147 n=substitute(n,"::",sep);
148 }
149 if (cd->compoundType()==ClassDef::Protocol && n.endsWith("-p"))
150 {
151 n="<"+n.left(n.length()-2)+">";
152 }
153 return n;
154}
virtual DString className() const =0
Returns the name of the class including outer classes, but not including namespaces.
virtual const ClassDef * tagLessReference() const =0
virtual DString qualifiedNameWithTemplateParameters(const ArgumentLists *actualParams=nullptr, uint32_t *actualParamIndex=nullptr) const =0
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e. class/struct/union/...
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:89
size_t rfind(char c, size_t pos=npos) const
Definition dstring.h:249
DString mid(size_t index, size_t len=npos) const
Definition dstring.h:323
static constexpr size_t npos
value used to indicate 'not found' or 'to the end of the string', matching std::string::npos
Definition dstring.h:183
DString left(size_t len) const
Definition dstring.h:311
bool endsWith(const char *s) const
Definition dstring.h:606
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition dstring.h:156
virtual bool isAnonymous() const =0
static DString getClassName(const ClassDef *)
DString substitute(const DString &s, const DString &src, const DString &dst)
substitute all occurrences of src in s by dst
Definition dstring.cpp:476
SrcLangExt
Definition types.h:207
DString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope)
Returns the scope separator to use given the programming language lang.
Definition util.cpp:5306
DString removeAnonymousScopes(const DString &str)
Definition util.cpp:114

References ClassDef::className(), ClassDef::compoundType(), DString::endsWith(), VhdlDocGen::getClassName(), Definition::getLanguage(), getLanguageSpecificSeparator(), Definition::isAnonymous(), DString::left(), DString::length(), makeDisplayName(), DString::mid(), Definition::name(), DString::npos, ClassDef::Protocol, ClassDef::qualifiedNameWithTemplateParameters(), removeAnonymousScopes(), DString::rfind(), substitute(), and ClassDef::tagLessReference().

Referenced by ClassDefAliasImpl::displayName(), ClassDefImpl::displayName(), and makeDisplayName().

◆ makeQualifiedNameWithTemplateParameters()

DString makeQualifiedNameWithTemplateParameters ( const ClassDef * cd,
const ArgumentLists * actualParams,
uint32_t * actualParamIndex )
static

Definition at line 56 of file classdef.cpp.

58{
59 //bool optimizeOutputJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
60 bool hideScopeNames = Config_getBool(HIDE_SCOPE_NAMES);
61 //printf("qualifiedNameWithTemplateParameters() localName=%s\n",qPrint(cd->localName()));
62 DString scName;
63 const Definition *d=cd->getOuterScope();
64 if (d)
65 {
67 {
68 const ClassDef *ocd=toClassDef(d);
69 scName = ocd->qualifiedNameWithTemplateParameters(actualParams,actualParamIndex);
70 }
71 else if (!hideScopeNames)
72 {
73 scName = d->qualifiedName();
74 }
75 }
76
77 SrcLangExt lang = cd->getLanguage();
78 DString scopeSeparator = getLanguageSpecificSeparator(lang);
79 if (!scName.empty()) scName+=scopeSeparator;
80
81 bool isSpecialization = cd->localName().find('<')!=DString::npos;
82 DString clName = cd->className();
83 scName+=clName;
84 if (lang!=SrcLangExt::CSharp && !cd->templateArguments().empty())
85 {
86 if (actualParams && *actualParamIndex<actualParams->size())
87 {
88 const ArgumentList &al = actualParams->at(*actualParamIndex);
89 if (!isSpecialization)
90 {
91 scName+=tempArgListToString(al,lang);
92 }
93 (*actualParamIndex)++;
94 }
95 else
96 {
97 if (!isSpecialization)
98 {
99 scName+=tempArgListToString(cd->templateArguments(),lang);
100 }
101 }
102 }
103 //printf("qualifiedNameWithTemplateParameters: scope=%s qualifiedName=%s\n",qPrint(name()),qPrint(scName));
104 return scName;
105}
This class represents an function or template argument list.
Definition arguments.h:65
bool empty() const
Definition arguments.h:99
virtual const ArgumentList & templateArguments() const =0
Returns the template arguments of this class.
size_t find(char c, size_t pos=0) const
Definition dstring.h:244
The common base class of all entity definitions found in the sources.
Definition definition.h:77
virtual DefType definitionType() const =0
virtual const DString & localName() const =0
virtual DString qualifiedName() const =0
virtual Definition * getOuterScope() const =0
ClassDef * toClassDef(Definition *d)
DString tempArgListToString(const ArgumentList &al, SrcLangExt lang, bool includeDefault)
Definition util.cpp:959

References ClassDef::className(), Config_getBool, Definition::definitionType(), ArgumentList::empty(), DString::empty(), DString::find(), Definition::getLanguage(), getLanguageSpecificSeparator(), Definition::getOuterScope(), Definition::localName(), makeQualifiedNameWithTemplateParameters(), DString::npos, Definition::qualifiedName(), ClassDef::qualifiedNameWithTemplateParameters(), tempArgListToString(), ClassDef::templateArguments(), toClassDef(), and Definition::TypeClass.

Referenced by makeQualifiedNameWithTemplateParameters(), ClassDefAliasImpl::qualifiedNameWithTemplateParameters(), and ClassDefImpl::qualifiedNameWithTemplateParameters().

◆ minClassDistance()

int minClassDistance ( const ClassDef * cd,
const ClassDef * bcd,
int level )

Definition at line 5553 of file classdef.cpp.

5554{
5555 const int maxInheritanceDepth = 100000;
5556 if (bcd->categoryOf()) // use class that is being extended in case of
5557 // an Objective-C category
5558 {
5559 bcd=bcd->categoryOf();
5560 }
5561 if (cd==bcd) return level;
5562 if (level==256)
5563 {
5564 warn_uncond("class {} seem to have a recursive inheritance relation!\n",cd->name());
5565 return -1;
5566 }
5567 int m=maxInheritanceDepth;
5568 for (const auto &bcdi : cd->baseClasses())
5569 {
5570 int mc=minClassDistance(bcdi.classDef,bcd,level+1);
5571 if (mc<m) m=mc;
5572 if (m<0) break;
5573 }
5574 return m;
5575}
int minClassDistance(const ClassDef *cd, const ClassDef *bcd, int level)
#define warn_uncond(fmt,...)
Definition message.h:122

References ClassDef::baseClasses(), ClassDef::categoryOf(), minClassDistance(), Definition::name(), and warn_uncond.

Referenced by ClassDefImpl::getMemberByName(), and minClassDistance().

◆ searchTemplateSpecs()

void searchTemplateSpecs ( const Definition * d,
ArgumentLists & result,
DString & name,
SrcLangExt lang )
static

Definition at line 1479 of file classdef.cpp.

1483{
1485 {
1486 if (d->getOuterScope())
1487 {
1488 searchTemplateSpecs(d->getOuterScope(),result,name,lang);
1489 }
1490 const ClassDef *cd=toClassDef(d);
1491 if (!name.empty()) name+="::";
1492 DString clName = d->localName();
1493 if (clName.endsWith("-p"))
1494 {
1495 clName = clName.left(clName.length()-2);
1496 }
1497 name+=clName;
1498 bool isSpecialization = d->localName().find('<')!=DString::npos;
1499 if (!cd->templateArguments().empty())
1500 {
1501 result.push_back(cd->templateArguments());
1502 if (!isSpecialization)
1503 {
1504 name+=tempArgListToString(cd->templateArguments(),lang);
1505 }
1506 }
1507 }
1508 else
1509 {
1510 name+=d->qualifiedName();
1511 }
1512}
static void searchTemplateSpecs(const Definition *d, ArgumentLists &result, DString &name, SrcLangExt lang)

References Definition::definitionType(), ArgumentList::empty(), DString::empty(), DString::endsWith(), DString::find(), Definition::getOuterScope(), DString::left(), DString::length(), Definition::localName(), DString::npos, Definition::qualifiedName(), searchTemplateSpecs(), tempArgListToString(), ClassDef::templateArguments(), toClassDef(), and Definition::TypeClass.

Referenced by searchTemplateSpecs(), and ClassDefImpl::writeTemplateSpec().

◆ toClassDef() [1/3]

const ClassDef * toClassDef ( const Definition * d)

Definition at line 5472 of file classdef.cpp.

5473{
5474 if (d && (typeid(*d)==typeid(ClassDefImpl) || typeid(*d)==typeid(ClassDefAliasImpl)))
5475 {
5476 return static_cast<const ClassDef*>(d);
5477 }
5478 else
5479 {
5480 return nullptr;
5481 }
5482}
Implementation of the ClassDef interface.
Definition classdef.cpp:197

References toClassDef().

◆ toClassDef() [2/3]

ClassDef * toClassDef ( Definition * d)

Definition at line 5447 of file classdef.cpp.

5448{
5449 if (d && (typeid(*d)==typeid(ClassDefImpl) || typeid(*d)==typeid(ClassDefAliasImpl)))
5450 {
5451 return static_cast<ClassDef*>(d);
5452 }
5453 else
5454 {
5455 return nullptr;
5456 }
5457}

References toClassDef().

Referenced by DocSets::addIndexItem(), ClassDefImpl::addInnerCompound(), NamespaceDefImpl::addInnerCompound(), MemberDefImpl::addListReference(), definitionToName(), findMemberLink(), findModuleDef(), findTagLessClasses(), findUsingDeclImports(), SymbolResolver::Private::followPath(), generateClassMemberLink(), generateClassOrGlobalLink(), generateClassOrGlobalLink(), FTVHelp::Private::generateTree(), ClassDefAliasImpl::getCdAlias(), getDefs(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedType(), SymbolResolver::Private::getResolvedTypeRec(), ClassDefImpl::getTemplateParameterLists(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), makeQualifiedNameWithTemplateParameters(), MemberDefImpl::moveTo(), DefinitionImpl::navigationPathAsString(), scopeIsTemplate(), searchTemplateSpecs(), SearchIndex::setCurrentDoc(), ClassDefMutable::setPrimaryConstructorParams(), toClassDef(), toClassDef(), toClassDef(), updateCallContextForSmartPointer(), writeDefArgumentList(), writeJavasScriptSearchDataPage(), MemberDefImpl::writeMemberDocSimple(), writeObjCMethodCall(), MemberList::writeSimpleDocumentation(), and VhdlDocGen::writeVHDLTypeDocumentation().

◆ toClassDef() [3/3]

ClassDef * toClassDef ( DefinitionMutable * md)

Definition at line 5459 of file classdef.cpp.

5460{
5461 Definition *d = toDefinition(md);
5462 if (d && typeid(*d)==typeid(ClassDefImpl))
5463 {
5464 return static_cast<ClassDef*>(d);
5465 }
5466 else
5467 {
5468 return nullptr;
5469 }
5470}
Definition * toDefinition(DefinitionMutable *dm)

References toClassDef(), and toDefinition().

◆ toClassDefMutable()

ClassDefMutable * toClassDefMutable ( Definition * d)

Definition at line 5484 of file classdef.cpp.

5485{
5486 if (d && typeid(*d)==typeid(ClassDefImpl))
5487 {
5488 return static_cast<ClassDefMutable*>(d);
5489 }
5490 else
5491 {
5492 return nullptr;
5493 }
5494}

References toClassDefMutable().

Referenced by addClassAndNestedClasses(), addClassToContext(), addClassToGroups(), ModuleDefImpl::addClassToModule(), ModuleManager::addClassToModule(), addMembersToMemberGroup(), ClassDefImpl::addMembersToTemplateInstance(), addMemberToGroups(), ClassDefImpl::addTypeConstraint(), applyToAllDefinitions(), buildCompleteMemberLists(), computeMemberReferences(), computeTemplateClassRelations(), VhdlDocGen::computeVhdlComponentRelations(), ClassDefImpl::countInheritedDecMembers(), countMembers(), createTagLessInstance(), createTemplateInstanceMembers(), ClassDefImpl::deepCopy(), distributeClassGroupRelations(), distributeMemberGroupDocumentation(), findClassRelation(), findSectionsInDocumentation(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsingDeclarations(), findUsingDeclImports(), generateClassDocs(), generateClassOrGlobalLink(), generateNamespaceClassDocs(), MemberDefImpl::getClassDefMutable(), getClassMutable(), ClassDefImpl::hideDerivedVariablesInPython(), insertMemberAlias(), ClassDefImpl::insertTemplateInstance(), ClassDefImpl::insertUsedFile(), ClassDefImpl::internalInsertMember(), mergeCategories(), ClassDefImpl::mergeCategory(), ClassDefImpl::mergeMembers(), ClassDefImpl::mergeMembersFromBaseClasses(), SymbolResolver::resolveClassMutable(), resolveClassNestingRelations(), setAnonymousEnumType(), ClassDefImpl::setGroupDefForAllMembers(), ClassDefMutable::setPrimaryConstructorParams(), sortMemberLists(), toClassDefMutable(), ClassDefImpl::writeInheritedMemberDeclarations(), and writeTagFile().

◆ writeInheritanceSpecifier()

void writeInheritanceSpecifier ( OutputList & ol,
const BaseClassDef & bcd )
static

Definition at line 1418 of file classdef.cpp.

1419{
1420 if (bcd.prot!=Protection::Public || bcd.virt!=Specifier::Normal)
1421 {
1422 ol.startTypewriter();
1423 ol.docify(" [");
1424 StringVector sl;
1425 if (bcd.prot==Protection::Protected) sl.emplace_back("protected");
1426 else if (bcd.prot==Protection::Private) sl.emplace_back("private");
1427 if (bcd.virt==Specifier::Virtual) sl.emplace_back("virtual");
1428 bool first=true;
1429 for (const auto &s : sl)
1430 {
1431 if (!first) ol.docify(", ");
1432 ol.docify(s);
1433 first=false;
1434 }
1435 ol.docify("]");
1436 ol.endTypewriter();
1437 }
1438}
void docify(const DString &s)
Definition outputlist.h:437
void startTypewriter()
Definition outputlist.h:449
void endTypewriter()
Definition outputlist.h:451
std::vector< std::string > StringVector
Definition containers.h:33
Specifier virt
Virtualness of the inheritance relation: Normal, or Virtual.
Definition classdef.h:75
Protection prot
Protection level of the inheritance relation: Public, Protected, or Private.
Definition classdef.h:70

References OutputList::docify(), OutputList::endTypewriter(), BaseClassDef::prot, OutputList::startTypewriter(), BaseClassDef::virt, and writeInheritanceSpecifier().

Referenced by ClassDefImpl::writeInheritanceGraph(), and writeInheritanceSpecifier().