classdef.cpp 文件参考

#include <cstdio>
#include <algorithm>
#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"

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

浏览源代码.

类
class	ClassDefImpl
	Implementation of the ClassDef interface 更多...
class	ClassDefAliasImpl
class	ClassDefImpl::IMPL
	Private data associated with a ClassDef object. 更多...

函数
static QCString	makeQualifiedNameWithTemplateParameters (const ClassDef *cd, const ArgumentLists *actualParams, uint *actualParamIndex)
static QCString	makeDisplayName (const ClassDef *cd, bool includeScope)
ClassDefMutable *	createClassDef (const QCString &fileName, int startLine, int startColumn, const QCString &name, ClassDef::CompoundType ct, const QCString &ref, const QCString &fName, bool isSymbol, bool isJavaEnum)
	Factory method to create a new ClassDef object 更多...
ClassDef *	createClassDefAlias (const Definition *newScope, const ClassDef *cd)
static void	writeInheritanceSpecifier (OutputList &ol, const BaseClassDef &bcd)
static void	searchTemplateSpecs (const Definition *d, ArgumentLists &result, QCString &name, SrcLangExt lang)
static bool	isStandardFunc (const MemberDef *md)
ClassDef *	toClassDef (Definition *d)
ClassDef *	toClassDef (DefinitionMutable *md)
const ClassDef *	toClassDef (const Definition *d)
ClassDefMutable *	toClassDefMutable (Definition *d)
ClassDefMutable *	toClassDefMutable (const Definition *d)
ClassDef *	getClass (const QCString &n)
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)
Protection	classInheritedProtectionLevel (const ClassDef *cd, const ClassDef *bcd, Protection prot, int level)

函数说明

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,
		int	level
	)

在文件 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,
		const QCString &	fName,
		bool	isSymbol,
		bool	isJavaEnum
	)

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

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

isStandardFunc()

static bool isStandardFunc ( const MemberDef *  md )

static

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

{
  return md->name()=="operator=" || // assignment operator
         md->isConstructor() ||     // constructor
         md->isDestructor();        // destructor
}

引用了 MemberDef::isConstructor(), MemberDef::isDestructor() , 以及 Definition::name().

被这些函数引用 ClassDefImpl::mergeMembers().

makeDisplayName()

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

static

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

{
  //static bool optimizeOutputForJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
  SrcLangExt lang = cd->getLanguage();
  //static bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
  QCString n;
  if (lang==SrcLangExt_VHDL)
  {
    n = VhdlDocGen::getClassName(cd);
  }
  else
  {
    if (includeScope)
    {
      n=cd->qualifiedNameWithTemplateParameters();
    }
    else
    {
      n=cd->className();
    }
  }
  if (cd->isAnonymous())
  {
    n = removeAnonymousScopes(n);
  }
  QCString sep=getLanguageSpecificSeparator(lang);
  if (sep!="::")
  {
    n=substitute(n,"::",sep);
  }
  if (cd->compoundType()==ClassDef::Protocol && n.right(2)=="-p")
  {
    n="<"+n.left(n.length()-2)+">";
  }
  //else if (n.right(2)=="-g")
  //{
  //  n = n.left(n.length()-2);
  //}
  //printf("ClassDefImpl::displayName()=%s\n",qPrint(n));
  return n;
}

引用了 ClassDef::className(), ClassDef::compoundType(), VhdlDocGen::getClassName(), Definition::getLanguage(), getLanguageSpecificSeparator(), Definition::isAnonymous(), QCString::left(), QCString::length(), ClassDef::Protocol, ClassDef::qualifiedNameWithTemplateParameters(), removeAnonymousScopes(), QCString::right(), SrcLangExt_VHDL , 以及 substitute().

被这些函数引用 ClassDefImpl::displayName() , 以及 ClassDefAliasImpl::displayName().

makeQualifiedNameWithTemplateParameters()

static QCString makeQualifiedNameWithTemplateParameters ( const ClassDef *  cd, const ArgumentLists *  actualParams, uint *  actualParamIndex  )

static

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

{
  //static bool optimizeOutputJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
  bool hideScopeNames = Config_getBool(HIDE_SCOPE_NAMES);
  //printf("qualifiedNameWithTemplateParameters() localName=%s\n",qPrint(localName()));
  QCString scName;
  const Definition *d=cd->getOuterScope();
  if (d)
  {
    if (d->definitionType()==Definition::TypeClass)
    {
      const ClassDef *ocd=toClassDef(d);
      scName = ocd->qualifiedNameWithTemplateParameters(actualParams,actualParamIndex);
    }
    else if (!hideScopeNames)
    {
      scName = d->qualifiedName();
    }
  }
 
  SrcLangExt lang = cd->getLanguage();
  QCString scopeSeparator = getLanguageSpecificSeparator(lang);
  if (!scName.isEmpty()) scName+=scopeSeparator;
 
  bool isSpecialization = cd->localName().find('<')!=-1;
 
  QCString clName = cd->className();
  scName+=clName;
  if (!cd->templateArguments().empty())
  {
    if (actualParams && *actualParamIndex<actualParams->size())
    {
      const ArgumentList &al = actualParams->at(*actualParamIndex);
      if (!isSpecialization)
      {
        scName+=tempArgListToString(al,lang);
      }
      (*actualParamIndex)++;
    }
    else
    {
      if (!isSpecialization)
      {
        scName+=tempArgListToString(cd->templateArguments(),lang);
      }
    }
  }
  //printf("qualifiedNameWithTemplateParameters: scope=%s qualifiedName=%s\n",qPrint(name()),qPrint(scName));
  return scName;
}

引用了 ArgumentList::at(), ClassDef::className(), Config_getBool, Definition::definitionType(), ArgumentList::empty(), QCString::find(), Definition::getLanguage(), getLanguageSpecificSeparator(), Definition::getOuterScope(), QCString::isEmpty(), isSpecialization(), Definition::localName(), Definition::qualifiedName(), ClassDef::qualifiedNameWithTemplateParameters(), tempArgListToString(), ClassDef::templateArguments(), toClassDef() , 以及 Definition::TypeClass.

被这些函数引用 ClassDefImpl::qualifiedNameWithTemplateParameters() , 以及 ClassDefAliasImpl::qualifiedNameWithTemplateParameters().

minClassDistance()

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

在文件 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().

searchTemplateSpecs()

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

static

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

{
  if (d->definitionType()==Definition::TypeClass)
  {
    if (d->getOuterScope())
    {
      searchTemplateSpecs(d->getOuterScope(),result,name,lang);
    }
    const ClassDef *cd=toClassDef(d);
    if (!name.isEmpty()) name+="::";
    QCString clName = d->localName();
    if (/*clName.right(2)=="-g" ||*/ clName.right(2)=="-p")
    {
      clName = clName.left(clName.length()-2);
    }
    name+=clName;
    bool isSpecialization = d->localName().find('<')!=-1;
    if (!cd->templateArguments().empty())
    {
      result.push_back(cd->templateArguments());
      if (!isSpecialization)
      {
        name+=tempArgListToString(cd->templateArguments(),lang);
      }
    }
  }
  else
  {
    name+=d->qualifiedName();
  }
}

引用了 Definition::definitionType(), ArgumentList::empty(), QCString::find(), Definition::getOuterScope(), QCString::isEmpty(), isSpecialization(), QCString::left(), QCString::length(), Definition::localName(), Definition::qualifiedName(), QCString::right(), tempArgListToString(), ClassDef::templateArguments(), toClassDef() , 以及 Definition::TypeClass.

被这些函数引用 ClassDefImpl::writeTemplateSpec().

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 *

md

)

在文件 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().

writeInheritanceSpecifier()

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

static

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

{
  if (bcd.prot!=Public || bcd.virt!=Normal)
  {
    ol.startTypewriter();
    ol.docify(" [");
    StringVector sl;
    if      (bcd.prot==Protected) sl.push_back("protected");
    else if (bcd.prot==Private)   sl.push_back("private");
    if      (bcd.virt==Virtual)   sl.push_back("virtual");
    bool first=true;
    for (const auto &s : sl)
    {
      if (!first) ol.docify(", ");
      ol.docify(s.c_str());
      first=false;
    }
    ol.docify("]");
    ol.endTypewriter();
  }
}

引用了 OutputList::docify(), OutputList::endTypewriter(), Normal, Private, BaseClassDef::prot, Protected, Public, OutputList::startTypewriter(), BaseClassDef::virt , 以及 Virtual.

被这些函数引用 ClassDefImpl::writeInheritanceGraph().