classdef.h 文件参考

#include <vector>
#include <set>
#include "containers.h"
#include "definition.h"
#include "arguments.h"
#include "membergroup.h"

classdef.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

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

类型定义
using	BaseClassList = std::vector< BaseClassDef >
using	TemplateInstanceList = std::vector< TemplateInstanceDef >
using	TemplateNameMap = std::map< std::string, int >
using	ClassDefSet = std::set< const ClassDef * >

函数
ClassDefMutable *	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 更多...
ClassDef *	createClassDefAlias (const Definition *newScope, const ClassDef *cd)
ClassDef *	toClassDef (Definition *d)
ClassDef *	toClassDef (DefinitionMutable *d)
const ClassDef *	toClassDef (const Definition *d)
ClassDefMutable *	toClassDefMutable (Definition *d)
ClassDefMutable *	toClassDefMutable (const Definition *d)
ClassDef *	getClass (const QCString &key)
ClassDefMutable *	getClassMutable (const QCString &key)
bool	hasVisibleRoot (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=Public, int level=0)

类型定义说明

BaseClassList

using BaseClassList = std::vector<BaseClassDef>

在文件 classdef.h 第 81 行定义.

ClassDefSet

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

在文件 classdef.h 第 95 行定义.

TemplateInstanceList

using TemplateInstanceList = std::vector<TemplateInstanceDef>

在文件 classdef.h 第 91 行定义.

TemplateNameMap

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

在文件 classdef.h 第 93 行定义.

函数说明

classHasVisibleChildren()

bool classHasVisibleChildren

(

const ClassDef *

cd

)

在文件 classdef.cpp 第 4991 行定义.

{
  BaseClassList bcl;
 
  if (cd->getLanguage()==SrcLangExt_VHDL) // reverse baseClass/subClass relation
  {
    if (cd->baseClasses().empty()) return FALSE;
    bcl=cd->baseClasses();
  }
  else
  {
    if (cd->subClasses().empty()) return FALSE;
    bcl=cd->subClasses();
  }
 
  for (const auto &bcd : bcl)
  {
    if (bcd.classDef->isVisibleInHierarchy())
    {
      return TRUE;
    }
  }
  return FALSE;
}

引用了 ClassDef::baseClasses(), FALSE, Definition::getLanguage(), SrcLangExt_VHDL, ClassDef::subClasses() , 以及 TRUE.

被这些函数引用 NestingNodeContext::Private::addClasses(), writeClassTreeForList() , 以及 writeClassTreeToOutput().

classInheritedProtectionLevel()

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

在文件 classdef.cpp 第 5051 行定义.

{
  if (bcd->categoryOf()) // use class that is being extended in case of
    // an Objective-C category
  {
    bcd=bcd->categoryOf();
  }
  if (cd==bcd)
  {
    goto exit;
  }
  if (level==256)
  {
    err("Internal inconsistency: found class %s seem to have a recursive "
        "inheritance relation! Please send a bug report to doxygen@gmail.com\n",qPrint(cd->name()));
  }
  else if (prot!=Private)
  {
    for (const auto &bcdi : cd->baseClasses())
    {
      Protection baseProt = classInheritedProtectionLevel(bcdi.classDef,bcd,bcdi.prot,level+1);
      if (baseProt==Private)        prot=Private;
      else if (baseProt==Protected) prot=Protected;
    }
  }
exit:
  //printf("classInheritedProtectionLevel(%s,%s)=%d\n",qPrint(cd->name()),qPrint(bcd->name()),prot);
  return prot;
}

引用了 ClassDef::baseClasses(), ClassDef::categoryOf(), classInheritedProtectionLevel(), err(), Definition::name(), Private, Protected , 以及 qPrint().

被这些函数引用 classInheritedProtectionLevel().

classVisibleInIndex()

bool classVisibleInIndex

(

const ClassDef *

cd

)

在文件 classdef.cpp 第 5016 行定义.

{
  bool allExternals = Config_getBool(ALLEXTERNALS);
  return (allExternals && cd->isLinkable()) || cd->isLinkableInProject();
}

引用了 Config_getBool, ClassDef::isLinkable() , 以及 ClassDef::isLinkableInProject().

被这些函数引用 NestingContext::Private::addClass() , 以及 writeClassTree().

createClassDef()

ClassDefMutable* 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

在文件 classdef.cpp 第 367 行定义.

{
  return new ClassDefImpl(fileName,startLine,startColumn,name,ct,ref,fName,isSymbol,isJavaEnum);
}

被这些函数引用 addClassToContext(), createTagLessInstance(), findClassRelation(), findUsedClassesForClass() , 以及 findUsingDeclarations().

createClassDefAlias()

ClassDef* createClassDefAlias	(	const Definition *	newScope,
		const ClassDef *	cd
	)

在文件 classdef.cpp 第 559 行定义.

{
  ClassDef *acd = new ClassDefAliasImpl(newScope,cd);
  //printf("cd name=%s localName=%s qualifiedName=%s qualifiedNameWith=%s displayName()=%s\n",
  //    qPrint(acd->name()),qPrint(acd->localName()),qPrint(acd->qualifiedName()),
  //    qPrint(acd->qualifiedNameWithTemplateParameters()),qPrint(acd->displayName()));
  return acd;
}

被这些函数引用 resolveClassNestingRelations().

getClass()

ClassDef* getClass

(

const QCString &

n

)

Get a class definition given its name. Returns 0 if the class is not found.

在文件 classdef.cpp 第 4974 行定义.

{
  if (n.isEmpty()) return 0;
  return Doxygen::classLinkedMap->find(n);
}

引用了 Doxygen::classLinkedMap, LinkedMap< T, Hash, KeyEqual, Map >::find() , 以及 QCString::isEmpty().

被这些函数引用 buildScopeFromQualifiedName(), extractNamespaceName(), findClassWithinClassContext(), findEnumDocumentation(), findEnums(), findInheritedTemplateInstances(), findMember(), findUsedTemplateInstances(), MemberDefImpl::getClassDefOfAnonymousType(), getClassMutable(), getScopeDefs(), getTemplateArgumentsFromName(), DocParser::handleLinkedWord(), insertTemplateSpecifierInScope(), MemberDefImpl::isDocumentedFriendClass(), linkifyText(), SymbolResolver::resolveClass(), resolveLink(), resolveRef(), stripTemplateSpecifiersFromScope() , 以及 MemberDefImpl::writeDeclaration().

getClassMutable()

ClassDefMutable* getClassMutable ( const QCString &  key )

inline

在文件 classdef.h 第 485 行定义.

{
  return toClassDefMutable(getClass(key));
}

引用了 getClass() , 以及 toClassDefMutable().

被这些函数引用 addClassToContext(), addEnumValuesToEnums(), addLocalObjCMethod(), addVariableToFile(), computeClassRelations(), computeTemplateClassRelations(), findClassRelation(), findEnums(), findMember(), findUsingDeclarations() , 以及 findUsingDeclImports().

hasVisibleRoot()

bool hasVisibleRoot

(

const BaseClassList &

bcl

)

在文件 classdef.cpp 第 4980 行定义.

{
  for (const auto &bcd : bcl)
  {
    const ClassDef *cd=bcd.classDef;
    if (cd->isVisibleInHierarchy()) return true;
    if (hasVisibleRoot(cd->baseClasses())) return true;
  }
  return false;
}

引用了 ClassDef::baseClasses(), hasVisibleRoot() , 以及 ClassDef::isVisibleInHierarchy().

被这些函数引用 NestingContext::Private::addClassHierarchy(), DotGfxHierarchyTable::addClassList(), NestingContext::Private::addDerivedClasses(), DotGfxHierarchyTable::addHierarchy(), countClassesInTreeList(), hasVisibleRoot(), writeClassTreeForList() , 以及 writeClassTreeToOutput().

minClassDistance()

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

在文件 classdef.cpp 第 5026 行定义.

{
  const int maxInheritanceDepth = 100000;
  if (bcd->categoryOf()) // use class that is being extended in case of
    // an Objective-C category
  {
    bcd=bcd->categoryOf();
  }
  if (cd==bcd) return level;
  if (level==256)
  {
    warn_uncond("class %s seem to have a recursive "
        "inheritance relation!\n",qPrint(cd->name()));
    return -1;
  }
  int m=maxInheritanceDepth;
  for (const auto &bcdi : cd->baseClasses())
  {
    int mc=minClassDistance(bcdi.classDef,bcd,level+1);
    if (mc<m) m=mc;
    if (m<0) break;
  }
  return m;
}

引用了 ClassDef::baseClasses(), ClassDef::categoryOf(), maxInheritanceDepth, minClassDistance(), Definition::name(), qPrint() , 以及 warn_uncond().

被这些函数引用 computeMemberRelations(), getDefs(), ClassDefImpl::getMemberByName() , 以及 minClassDistance().

toClassDef() [1/3]

const ClassDef* toClassDef

(

const Definition *

d

)

在文件 classdef.cpp 第 4932 行定义.

{
  if (d && (typeid(*d)==typeid(ClassDefImpl) || typeid(*d)==typeid(ClassDefAliasImpl)))
  {
    return static_cast<const ClassDef*>(d);
  }
  else
  {
    return 0;
  }
}

toClassDef() [2/3]

ClassDef* toClassDef

(

Definition *

d

)

在文件 classdef.cpp 第 4907 行定义.

{
  if (d && (typeid(*d)==typeid(ClassDefImpl) || typeid(*d)==typeid(ClassDefAliasImpl)))
  {
    return static_cast<ClassDef*>(d);
  }
  else
  {
    return 0;
  }
}

被这些函数引用 NestingNodeContext::Private::addClasses(), DocSets::addIndexItem(), NamespaceDefImpl::addInnerCompound(), ClassDefImpl::addInnerCompound(), MemberDefImpl::addListReference(), NestingNodeContext::Private::addMembers(), ClassContext::Private::addTemplateDecls(), NestingNodeContext::Private::createClass(), MemberListInfoContext::Private::createInherited(), definitionToName(), FTVHelp::generateTree(), ClassDefAliasImpl::getCdAlias(), SymbolResolver::Private::getResolvedSymbol(), ClassDefImpl::getTemplateParameterLists(), SymbolResolver::Private::isAccessibleFrom(), SymbolResolver::Private::isAccessibleFromWithExpScope(), makeQualifiedNameWithTemplateParameters(), MemberDefImpl::moveTo(), scopeIsTemplate(), searchTemplateSpecs(), SearchIndex::setCurrentDoc(), writeDefArgumentList(), writeJavaScriptSearchIndex(), MemberDefImpl::writeMemberDocSimple(), MemberList::writeSimpleDocumentation() , 以及 VhdlDocGen::writeVHDLTypeDocumentation().

toClassDef() [3/3]

ClassDef* toClassDef

(

DefinitionMutable *

d

)

在文件 classdef.cpp 第 4919 行定义.

{
  Definition *d = toDefinition(md);
  if (d && typeid(*d)==typeid(ClassDefImpl))
  {
    return static_cast<ClassDef*>(d);
  }
  else
  {
    return 0;
  }
}

引用了 toDefinition().

toClassDefMutable() [1/2]

ClassDefMutable* toClassDefMutable

(

const Definition *

d

)

在文件 classdef.cpp 第 4956 行定义.

{
  if (d && typeid(*d)==typeid(ClassDefImpl))
  {
    return const_cast<ClassDefMutable*>(static_cast<const ClassDefMutable*>(d));
  }
  else
  {
    return 0;
  }
}

toClassDefMutable() [2/2]

ClassDefMutable* toClassDefMutable

(

Definition *

d

)

在文件 classdef.cpp 第 4944 行定义.

{
  if (d && typeid(*d)==typeid(ClassDefImpl))
  {
    return static_cast<ClassDefMutable*>(d);
  }
  else
  {
    return 0;
  }
}

被这些函数引用 addClassToContext(), addClassToGroups(), addListReferences(), addMembersToMemberGroup(), ClassDefImpl::addMembersToTemplateInstance(), addMemberToGroups(), ClassDefImpl::addTypeConstraint(), buildCompleteMemberLists(), computeMemberReferences(), computeTemplateClassRelations(), VhdlDocGen::computeVhdlComponentRelations(), ClassDefImpl::countInheritedDecMembers(), countMembers(), createTagLessInstance(), createTemplateInstanceMembers(), distributeClassGroupRelations(), distributeMemberGroupDocumentation(), findClassRelation(), findInheritedTemplateInstances(), findSectionsInDocumentation(), findTagLessClasses(), findTemplateInstanceRelation(), findUsedClassesForClass(), findUsedTemplateInstances(), findUsingDeclarations(), generateClassList(), generateNamespaceClassDocs(), MemberDef::getClassDefMutable(), getClassMutable(), ClassDefImpl::insertTemplateInstance(), ClassDefImpl::insertUsedFile(), mergeCategories(), ClassDefImpl::mergeCategory(), ClassDefImpl::mergeMembers(), SymbolResolver::resolveClassMutable(), resolveClassNestingRelations(), setAnonymousEnumType(), ClassDefImpl::setGroupDefForAllMembers(), sortMemberLists(), writeClassTree(), MemberDefImpl::writeDeclaration(), MemberList::writeDeclarations(), ClassLinkedRefMap::writeDocumentation(), ClassDefImpl::writeDocumentationForInnerClasses(), ClassDefImpl::writeInheritedMemberDeclarations() , 以及 writeTagFile().