Doxygen
Loading...
Searching...
No Matches
classdef.h File Reference
#include <memory>
#include <vector>
#include <unordered_set>
#include "containers.h"
#include "definition.h"
#include "arguments.h"
#include "membergroup.h"
#include "configvalues.h"
Include dependency graph for classdef.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  BaseClassDef
 Class that contains information about an inheritance relation. More...
struct  TemplateInstanceDef
 Class that contains information about a template instance relation. More...
class  ClassDef
 A abstract class representing of a compound symbol. More...
class  ClassDefMutable
struct  UsesClassDef
 Class that contains information about a usage relation. More...
class  UsesClassList
struct  ConstraintClassDef
 Class that contains information about a type constraint relations. More...
class  ConstraintClassList

Typedefs

using BaseClassList = std::vector<BaseClassDef>
using TemplateInstanceList = std::vector<TemplateInstanceDef>
using TemplateNameMap = std::map<std::string,int>
using ClassDefSet = std::unordered_set<const ClassDef*>

Functions

std::unique_ptr< ClassDefcreateClassDef (const QCString &fileName, int startLine, int startColumn, const QCString &name, ClassDef::CompoundType ct, const QCString &ref=QCString(), const QCString &fName=QCString(), bool isSymbol=TRUE, bool isJavaEnum=FALSE)
 Factory method to create a new ClassDef object.
std::unique_ptr< ClassDefcreateClassDefAlias (const Definition *newScope, const ClassDef *cd)
ClassDeftoClassDef (Definition *d)
ClassDeftoClassDef (DefinitionMutable *d)
const ClassDeftoClassDef (const Definition *d)
ClassDefMutabletoClassDefMutable (Definition *d)
ClassDefgetClass (const QCString &key)
ClassDefMutablegetClassMutable (const QCString &key)
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=0)
Protection classInheritedProtectionLevel (const ClassDef *cd, const ClassDef *bcd, Protection prot=Protection::Public, int level=0)

Typedef Documentation

◆ BaseClassList

using BaseClassList = std::vector<BaseClassDef>

Definition at line 81 of file classdef.h.

◆ ClassDefSet

using ClassDefSet = std::unordered_set<const ClassDef*>

Definition at line 95 of file classdef.h.

◆ TemplateInstanceList

Definition at line 91 of file classdef.h.

◆ TemplateNameMap

using TemplateNameMap = std::map<std::string,int>

Definition at line 93 of file classdef.h.

Function Documentation

◆ classHasVisibleChildren()

bool classHasVisibleChildren ( const ClassDef * cd)

Definition at line 5510 of file classdef.cpp.

5511{
5512 BaseClassList bcl;
5513
5514 if (cd->getLanguage()==SrcLangExt::VHDL) // reverse baseClass/subClass relation
5515 {
5516 if (cd->baseClasses().empty()) return FALSE;
5517 bcl=cd->baseClasses();
5518 }
5519 else
5520 {
5521 if (cd->subClasses().empty()) return FALSE;
5522 bcl=cd->subClasses();
5523 }
5524
5525 for (const auto &bcd : bcl)
5526 {
5527 if (bcd.classDef->isVisibleInHierarchy())
5528 {
5529 return TRUE;
5530 }
5531 }
5532 return FALSE;
5533}
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
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34

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

Referenced by writeClassTreeForList(), and writeClassTreeToOutput().

◆ classHasVisibleRoot()

bool classHasVisibleRoot ( const BaseClassList & bcl)

Definition at line 5499 of file classdef.cpp.

5500{
5501 for (const auto &bcd : bcl)
5502 {
5503 const ClassDef *cd=bcd.classDef;
5504 if (cd->isVisibleInHierarchy()) return true;
5505 if (classHasVisibleRoot(cd->baseClasses())) return true;
5506 }
5507 return false;
5508}
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 = Protection::Public,
int level = 0 )

Definition at line 5569 of file classdef.cpp.

5570{
5571 if (bcd->categoryOf()) // use class that is being extended in case of
5572 // an Objective-C category
5573 {
5574 bcd=bcd->categoryOf();
5575 }
5576 if (cd==bcd)
5577 {
5578 goto exit;
5579 }
5580 if (level==256)
5581 {
5582 err("Internal inconsistency: found class {} seem to have a recursive "
5583 "inheritance relation! Please send a bug report to doxygen@gmail.com\n",cd->name());
5584 }
5585 else if (prot!=Protection::Private)
5586 {
5587 for (const auto &bcdi : cd->baseClasses())
5588 {
5589 Protection baseProt = classInheritedProtectionLevel(bcdi.classDef,bcd,bcdi.prot,level+1);
5590 if (baseProt==Protection::Private) prot=Protection::Private;
5591 else if (baseProt==Protection::Protected) prot=Protection::Protected;
5592 }
5593 }
5594exit:
5595 //printf("classInheritedProtectionLevel(%s,%s)=%d\n",qPrint(cd->name()),qPrint(bcd->name()),prot);
5596 return prot;
5597}
virtual ClassDef * categoryOf() const =0
Returns the class of which this is a category (Objective-C only).
virtual const QCString & 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 5535 of file classdef.cpp.

5536{
5537 bool allExternals = Config_getBool(ALLEXTERNALS);
5538 return (allExternals && cd->isLinkable()) || cd->isLinkableInProject();
5539}
virtual bool isLinkable() const =0
virtual bool isLinkableInProject() const =0
#define Config_getBool(name)
Definition config.h:33

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

Referenced by writeClassTree().

◆ createClassDef()

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

Factory method to create a new ClassDef object.

Definition at line 559 of file classdef.cpp.

564{
565 return std::make_unique<ClassDefImpl>(fileName,startLine,startColumn,name,ct,ref,fName,isSymbol,isJavaEnum);
566}

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

◆ createClassDefAlias()

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

Definition at line 788 of file classdef.cpp.

789{
790 auto acd = std::make_unique<ClassDefAliasImpl>(newScope,cd);
791 //printf("cd name=%s localName=%s qualifiedName=%s qualifiedNameWith=%s displayName()=%s\n",
792 // qPrint(acd->name()),qPrint(acd->localName()),qPrint(acd->qualifiedName()),
793 // qPrint(acd->qualifiedNameWithTemplateParameters()),qPrint(acd->displayName()));
794 return acd;
795}

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

◆ getClass()

◆ getClassMutable()

◆ minClassDistance()

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

Definition at line 5545 of file classdef.cpp.

5546{
5547 const int maxInheritanceDepth = 100000;
5548 if (bcd->categoryOf()) // use class that is being extended in case of
5549 // an Objective-C category
5550 {
5551 bcd=bcd->categoryOf();
5552 }
5553 if (cd==bcd) return level;
5554 if (level==256)
5555 {
5556 warn_uncond("class {} seem to have a recursive inheritance relation!\n",cd->name());
5557 return -1;
5558 }
5559 int m=maxInheritanceDepth;
5560 for (const auto &bcdi : cd->baseClasses())
5561 {
5562 int mc=minClassDistance(bcdi.classDef,bcd,level+1);
5563 if (mc<m) m=mc;
5564 if (m<0) break;
5565 }
5566 return m;
5567}
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().

◆ toClassDef() [1/3]

const ClassDef * toClassDef ( const Definition * d)

Definition at line 5464 of file classdef.cpp.

5465{
5466 if (d && (typeid(*d)==typeid(ClassDefImpl) || typeid(*d)==typeid(ClassDefAliasImpl)))
5467 {
5468 return static_cast<const ClassDef*>(d);
5469 }
5470 else
5471 {
5472 return nullptr;
5473 }
5474}
Implementation of the ClassDef interface.
Definition classdef.cpp:185

◆ toClassDef() [2/3]

◆ toClassDef() [3/3]

ClassDef * toClassDef ( DefinitionMutable * d)

Definition at line 5451 of file classdef.cpp.

5452{
5453 Definition *d = toDefinition(md);
5454 if (d && typeid(*d)==typeid(ClassDefImpl))
5455 {
5456 return static_cast<ClassDef*>(d);
5457 }
5458 else
5459 {
5460 return nullptr;
5461 }
5462}
The common base class of all entity definitions found in the sources.
Definition definition.h:76
Definition * toDefinition(DefinitionMutable *dm)

References toDefinition().

◆ toClassDefMutable()

ClassDefMutable * toClassDefMutable ( Definition * d)

Definition at line 5476 of file classdef.cpp.

5477{
5478 if (d && typeid(*d)==typeid(ClassDefImpl))
5479 {
5480 return static_cast<ClassDefMutable*>(d);
5481 }
5482 else
5483 {
5484 return nullptr;
5485 }
5486}

Referenced by addClassAndNestedClasses(), addClassToContext(), addClassToGroups(), ModuleDefImpl::addClassToModule(), ModuleManager::addClassToModule(), addListReferences(), addMembersToMemberGroup(), ClassDefImpl::addMembersToTemplateInstance(), addMemberToGroups(), ClassDefImpl::addTypeConstraint(), buildCompleteMemberLists(), computeMemberReferences(), computeTemplateClassRelations(), VhdlDocGen::computeVhdlComponentRelations(), ClassDefImpl::countInheritedDecMembers(), countMembers(), createTagLessInstance(), createTemplateInstanceMembers(), ClassDefImpl::deepCopy(), distributeClassGroupRelations(), distributeMemberGroupDocumentation(), findClassRelation(), findSectionsInDocumentation(), findTagLessClasses(), 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::sortAllMembersList(), sortMemberLists(), ClassDefImpl::writeInheritedMemberDeclarations(), and writeTagFile().