groupdef.h 文件参考

#include <memory>
#include "definition.h"
#include "dirdef.h"
#include "layout.h"
#include "membergroup.h"
#include "linkedmap.h"

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

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

浏览源代码.

类
class	GroupDef
	A model of a group of symbols. 更多...
class	GroupLinkedMap
class	GroupList

函数
GroupDef *	createGroupDef (const QCString &fileName, int line, const QCString &name, const QCString &title, const QCString &refFileName=QCString())
GroupDef *	toGroupDef (Definition *d)
const GroupDef *	toGroupDef (const Definition *d)
void	addClassToGroups (const Entry *root, ClassDef *cd)
void	addConceptToGroups (const Entry *root, ConceptDef *cd)
void	addNamespaceToGroups (const Entry *root, NamespaceDef *nd)
void	addGroupToGroups (const Entry *root, GroupDef *subGroup)
void	addMemberToGroups (const Entry *root, MemberDef *md)
void	addPageToGroups (const Entry *root, PageDef *pd)
void	addExampleToGroups (const Entry *root, PageDef *eg)
void	addDirToGroups (const Entry *root, DirDef *dd)

函数说明

addClassToGroups()

void addClassToGroups	(	const Entry *	root,
		ClassDef *	cd
	)

在文件 groupdef.cpp 第 1322 行定义.

{
  for (const Grouping &g : root->groups)
  {
    GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);
    if (gd && gd->addClass(cd))
    {
      ClassDefMutable *cdm = toClassDefMutable(cd);
      if (cdm)
      {
        cdm->makePartOfGroup(gd);
      }
      //printf("Compound %s: in group %s\n",qPrint(cd->name()),gd->groupTitle());
    }
  }
}

引用了 GroupDef::addClass(), LinkedMap< T, Hash, KeyEqual, Map >::find(), Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, DefinitionMutable::makePartOfGroup() , 以及 toClassDefMutable().

被这些函数引用 addClassToContext().

addConceptToGroups()

void addConceptToGroups	(	const Entry *	root,
		ConceptDef *	cd
	)

在文件 groupdef.cpp 第 1339 行定义.

{
  for (const Grouping &g : root->groups)
  {
    GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);
    if (gd && gd->addConcept(cd))
    {
      ConceptDefMutable *cdm = toConceptDefMutable(cd);
      if (cdm)
      {
        cdm->makePartOfGroup(gd);
      }
      //printf("Compound %s: in group %s\n",qPrint(cd->name()),gd->groupTitle());
    }
  }
}

引用了 GroupDef::addConcept(), LinkedMap< T, Hash, KeyEqual, Map >::find(), Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, DefinitionMutable::makePartOfGroup() , 以及 toConceptDefMutable().

被这些函数引用 addConceptToContext().

addDirToGroups()

void addDirToGroups	(	const Entry *	root,
		DirDef *	dd
	)

在文件 groupdef.cpp 第 1376 行定义.

{
  //printf("*** root->groups.size()=%d\n",root->groups.size());
  for (const Grouping &g : root->groups)
  {
    GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);
    //printf("group '%s'\n",qPrint(g->groupname));
    if (gd)
    {
      gd->addDir(dd);
      dd->makePartOfGroup(gd);
      //printf("Dir %s: in group %s\n",qPrint(dd->name()),qPrint(g->groupname));
    }
  }
}

引用了 GroupDef::addDir(), LinkedMap< T, Hash, KeyEqual, Map >::find(), Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups , 以及 DefinitionMutable::makePartOfGroup().

被这些函数引用 findDirDocumentation().

addExampleToGroups()

void addExampleToGroups	(	const Entry *	root,
		PageDef *	eg
	)

在文件 groupdef.cpp 第 1540 行定义.

{
  for (const Grouping &g : root->groups)
  {
    GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);
    if (gd)
    {
      gd->addExample(eg);
      eg->makePartOfGroup(gd);
      //printf("Example %s: in group %s\n",qPrint(eg->name()),s->data());
    }
  }
}

引用了 GroupDef::addExample(), LinkedMap< T, Hash, KeyEqual, Map >::find(), Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups , 以及 DefinitionMutable::makePartOfGroup().

addGroupToGroups()

void addGroupToGroups	(	const Entry *	root,
		GroupDef *	subGroup
	)

在文件 groupdef.cpp 第 1392 行定义.

{
  //printf("addGroupToGroups for %s groups=%d\n",qPrint(root->name),root->groups.size());
  for (const Grouping &g : root->groups)
  {
    GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);
    if (gd)
    {
      if (gd==subGroup)
      {
        warn(root->fileName,root->startLine,"Refusing to add group %s to itself",
            qPrint(gd->name()));
      }
      else if (subGroup->findGroup(gd))
      {
        warn(root->fileName,root->startLine,"Refusing to add group %s to group %s, since the latter is already a "
                                            "subgroup of the former\n", qPrint(subGroup->name()),qPrint(gd->name()));
      }
      else if (!gd->findGroup(subGroup))
      {
        gd->addGroup(subGroup);
        subGroup->makePartOfGroup(gd);
      }
    }
  }
}

引用了 GroupDef::addGroup(), Entry::fileName, LinkedMap< T, Hash, KeyEqual, Map >::find(), GroupDef::findGroup(), Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, DefinitionMutable::makePartOfGroup(), Definition::name(), qPrint(), Entry::startLine , 以及 warn().

被这些函数引用 organizeSubGroupsFiltered().

addMemberToGroups()

void addMemberToGroups	(	const Entry *	root,
		MemberDef *	md
	)

Add a member to the group with the highest priority

在文件 groupdef.cpp 第 1420 行定义.

{
  //printf("addMemberToGroups:  Root %p = %s, md %p=%s groups=%zu\n",
  //    root, qPrint(root->name), md, qPrint(md->name()), root->groups.size() );
 
  // Search entry's group list for group with highest pri.
  Grouping::GroupPri_t pri = Grouping::GROUPING_LOWEST;
  GroupDef *fgd=0;
  for (const Grouping &g : root->groups)
  {
    GroupDef *gd=0;
    if (!g.groupname.isEmpty() &&
        (gd=Doxygen::groupLinkedMap->find(g.groupname)) &&
        g.pri >= pri)
    {
      if (fgd && gd!=fgd && g.pri==pri)
      {
        warn(root->fileName, root->startLine,
            "Member %s found in multiple %s groups! "
            "The member will be put in group %s, and not in group %s",
            qPrint(md->name()), Grouping::getGroupPriName( pri ),
            qPrint(gd->name()), qPrint(fgd->name())
            );
      }
 
      fgd = gd;
      pri = g.pri;
    }
  }
  //printf("fgd=%p\n",fgd);
 
  // put member into group defined by this entry?
  if (fgd)
  {
    GroupDef *mgd = const_cast<GroupDef*>(md->getGroupDef());
    //printf("mgd=%p\n",mgd);
    bool insertit = FALSE;
    if (mgd==0)
    {
      insertit = TRUE;
    }
    else if (mgd!=fgd)
    {
      bool moveit = FALSE;
 
      // move member from one group to another if
      // - the new one has a higher priority
      // - the new entry has the same priority, but with docs where the old one had no docs
      if (md->getGroupPri()<pri)
      {
        moveit = TRUE;
      }
      else
      {
        if (md->getGroupPri()==pri)
        {
          if (!root->doc.isEmpty() && !md->getGroupHasDocs())
          {
            moveit = TRUE;
          }
          else if (!root->doc.isEmpty() && md->getGroupHasDocs())
          {
            warn(md->getGroupFileName(),md->getGroupStartLine(),
                "Member documentation for %s found several times in %s groups!\n"
                "%s:%d: The member will remain in group %s, and won't be put into group %s",
                qPrint(md->name()), Grouping::getGroupPriName( pri ),
                qPrint(root->fileName), root->startLine,
                qPrint(mgd->name()),
                qPrint(fgd->name())
                );
          }
        }
      }
 
      if (moveit)
      {
        //printf("removeMember\n");
        mgd->removeMember(md);
        insertit = TRUE;
      }
    }
 
    if (insertit)
    {
      //printf("insertMember found at %s line %d: %s: related %s\n",
      //    qPrint(md->getDefFileName()),md->getDefLine(),
      //    qPrint(md->name()),qPrint(root->relates));
      bool success = fgd->insertMember(md);
      if (success)
      {
        MemberDefMutable *mdm = toMemberDefMutable(md);
        if (mdm)
        {
          //printf("insertMember successful\n");
          mdm->setGroupDef(fgd,pri,root->fileName,root->startLine,!root->doc.isEmpty());
          ClassDefMutable *cdm = toClassDefMutable(mdm->getClassDefOfAnonymousType());
          if (cdm)
          {
            cdm->setGroupDefForAllMembers(fgd,pri,root->fileName,root->startLine,root->doc.length() != 0);
          }
          if (mdm->isEnumerate() && mdm->getGroupDef() && md->isStrong())
          {
            for (const auto &emd : mdm->enumFieldList())
            {
              MemberDefMutable *emdm = toMemberDefMutable(emd);
              if (emdm && emdm->getGroupDef()==0)
              {
                emdm->setGroupDef(mdm->getGroupDef(),mdm->getGroupPri(),
                                 mdm->getGroupFileName(),mdm->getGroupStartLine(),
                                 mdm->getGroupHasDocs());
              }
            }
          }
        }
      }
    }
  }
}

引用了 Entry::doc, MemberDef::enumFieldList(), FALSE, Entry::fileName, LinkedMap< T, Hash, KeyEqual, Map >::find(), MemberDef::getClassDefOfAnonymousType(), MemberDef::getGroupDef(), MemberDef::getGroupFileName(), MemberDef::getGroupHasDocs(), MemberDef::getGroupPri(), Grouping::getGroupPriName(), MemberDef::getGroupStartLine(), Grouping::GROUPING_LOWEST, Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, GroupDef::insertMember(), QCString::isEmpty(), MemberDef::isEnumerate(), MemberDef::isStrong(), QCString::length(), Definition::name(), Grouping::pri, qPrint(), GroupDef::removeMember(), MemberDefMutable::setGroupDef(), ClassDefMutable::setGroupDefForAllMembers(), Entry::startLine, toClassDefMutable(), toMemberDefMutable(), TRUE , 以及 warn().

被这些函数引用 addEnumDocs(), addMemberDocs(), addVariableToClass(), addVariableToFile(), findDefineDocumentation(), findEnums() , 以及 findMember().

addNamespaceToGroups()

void addNamespaceToGroups	(	const Entry *	root,
		NamespaceDef *	nd
	)

在文件 groupdef.cpp 第 1357 行定义.

{
  //printf("root->groups.size()=%zu\n",root->groups.size());
  for (const Grouping &g : root->groups)
  {
    GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);
    //printf("group '%s' gd=%p\n",qPrint(g.groupname),(void*)gd);
    if (gd && gd->addNamespace(nd))
    {
      NamespaceDefMutable *ndm = toNamespaceDefMutable(nd);
      if (ndm)
      {
        ndm->makePartOfGroup(gd);
      }
      //printf("Namespace %s: in group %s\n",qPrint(nd->name()),qPrint(gd->name()));
    }
  }
}

引用了 GroupDef::addNamespace(), LinkedMap< T, Hash, KeyEqual, Map >::find(), Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, DefinitionMutable::makePartOfGroup() , 以及 toNamespaceDefMutable().

被这些函数引用 buildNamespaceList().

addPageToGroups()

void addPageToGroups	(	const Entry *	root,
		PageDef *	pd
	)

createGroupDef()

GroupDef* createGroupDef	(	const QCString &	fileName,
		int	line,
		const QCString &	name,
		const QCString &	title,
		const QCString &	refFileName = QCString()
	)

在文件 groupdef.cpp 第 162 行定义.

{
  return new GroupDefImpl(fileName,line,name,title,refFileName);
}

被这些函数引用 buildGroupListFiltered().

toGroupDef() [1/2]

const GroupDef* toGroupDef

(

const Definition *

d

)

在文件 groupdef.cpp 第 1779 行定义.

{
  if (d==0) return 0;
  if (d && typeid(*d)==typeid(GroupDefImpl))
  {
    return static_cast<const GroupDef*>(d);
  }
  else
  {
    return 0;
  }
}

toGroupDef() [2/2]

GroupDef* toGroupDef

(

Definition *

d

)

在文件 groupdef.cpp 第 1766 行定义.

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

被这些函数引用 NestingNodeContext::Private::addClasses(), NestingNodeContext::Private::addConcepts(), NestingNodeContext::Private::addDirFiles(), NestingNodeContext::Private::addMembers(), NestingNodeContext::Private::addModules(), NestingNodeContext::Private::addNamespaces(), NestingNodeContext::Private::addPages(), NestingNodeContext::Private::createModule(), DocRef::DocRef(), generateLink(), DocParser::handleLinkedWord(), DefinitionImpl::navigationPathAsString(), DefinitionImpl::pathFragment(), searchName(), SearchIndex::setCurrentDoc(), NavPathElemContext::Private::text(), validatingParseDoc() , 以及 MemberDefImpl::writeDocumentation().