The groupdef.h File Reference

Included Headers

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

Classes Index

class	GroupDef
	A model of a group of symbols. More...
class	GroupLinkedMap
class	GroupList

Functions Index

std::unique_ptr< 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	addModuleToGroups (const Entry *root, ModuleDef *mod)
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)

Functions

addClassToGroups()

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

Declaration at line 133 of file groupdef.h, definition at line 1444 of file groupdef.cpp.

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

1445{

1446 for (const Grouping &g : root->groups)

1447 {

1448 GroupDef *gd=nullptr;

1449 if (!g.groupname.isEmpty()) gd=Doxygen::groupLinkedMap->find(g.groupname);

1450 if (gd && gd->addClass(cd))

1451 {

1452 ClassDefMutable *cdm = toClassDefMutable(cd);

1453 if (cdm)

1454 {

1455 cdm->makePartOfGroup(gd);

1456 }

1457 //printf("Compound %s: in group %s\n",qPrint(cd->name()),gd->groupTitle());

1458 }

1459 else if (!gd && g.pri == Grouping::GROUPING_INGROUP)

1460 {

1461 warn(root->fileName, root->startLine,

1462 "Found non-existing group '{}' for the command '{}', ignoring command",

1463 g.groupname, Grouping::getGroupPriName( g.pri )

1464 );

1465 }

1466 }

1467}

References GroupDef::addClass, Entry::fileName, Grouping::getGroupPriName, Grouping::GROUPING_INGROUP, Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, QCString::isEmpty, DefinitionMutable::makePartOfGroup, Grouping::pri, Entry::startLine, toClassDefMutable and warn.

Referenced by addClassToContext.

addConceptToGroups()

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

Declaration at line 134 of file groupdef.h, definition at line 1469 of file groupdef.cpp.

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

1470{

1471 for (const Grouping &g : root->groups)

1472 {

1473 GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);

1474 if (gd && gd->addConcept(cd))

1475 {

1476 ConceptDefMutable *cdm = toConceptDefMutable(cd);

1477 if (cdm)

1478 {

1479 cdm->makePartOfGroup(gd);

1480 }

1481 //printf("Compound %s: in group %s\n",qPrint(cd->name()),gd->groupTitle());

1482 }

1483 else if (!gd && g.pri == Grouping::GROUPING_INGROUP)

1484 {

1485 warn(root->fileName, root->startLine,

1486 "Found non-existing group '{}' for the command '{}', ignoring command",

1487 g.groupname, Grouping::getGroupPriName( g.pri )

1488 );

1489 }

1490 }

1491}

References GroupDef::addConcept, Entry::fileName, Grouping::getGroupPriName, Grouping::GROUPING_INGROUP, Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, DefinitionMutable::makePartOfGroup, Grouping::pri, Entry::startLine, toConceptDefMutable and warn.

Referenced by addConceptToContext.

addDirToGroups()

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

Declaration at line 141 of file groupdef.h, definition at line 1541 of file groupdef.cpp.

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

1542{

1543 //printf("*** root->groups.size()=%d\n",root->groups.size());

1544 for (const Grouping &g : root->groups)

1545 {

1546 GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);

1547 //printf("group '%s'\n",qPrint(g->groupname));

1548 if (gd)

1549 {

1550 gd->addDir(dd);

1551 dd->makePartOfGroup(gd);

1552 //printf("Dir %s: in group %s\n",qPrint(dd->name()),qPrint(g->groupname));

1553 }

1554 else if (!gd && g.pri == Grouping::GROUPING_INGROUP)

1555 {

1556 warn(root->fileName, root->startLine,

1557 "Found non-existing group '{}' for the command '{}', ignoring command",

1558 g.groupname, Grouping::getGroupPriName( g.pri )

1559 );

1560 }

1561 }

1562}

References GroupDef::addDir, Entry::fileName, Grouping::getGroupPriName, Grouping::GROUPING_INGROUP, Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, DefinitionMutable::makePartOfGroup, Grouping::pri, Entry::startLine and warn.

Referenced by findDirDocumentation.

addExampleToGroups()

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

Declaration at line 140 of file groupdef.h, definition at line 1724 of file groupdef.cpp.

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

1725{

1726 for (const Grouping &g : root->groups)

1727 {

1728 GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);

1729 if (gd)

1730 {

1731 gd->addExample(eg);

1732 eg->makePartOfGroup(gd);

1733 //printf("Example %s: in group %s\n",qPrint(eg->name()),s->data());

1734 }

1735 else if (!gd && g.pri == Grouping::GROUPING_INGROUP)

1736 {

1737 warn(root->fileName, root->startLine,

1738 "Found non-existing group '{}' for the command '{}', ignoring command",

1739 g.groupname, Grouping::getGroupPriName( g.pri )

1740 );

1741 }

1742 }

1743}

References GroupDef::addExample, Entry::fileName, Grouping::getGroupPriName, Grouping::GROUPING_INGROUP, Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, DefinitionMutable::makePartOfGroup, Grouping::pri, Entry::startLine and warn.

addGroupToGroups()

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

Declaration at line 137 of file groupdef.h, definition at line 1564 of file groupdef.cpp.

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

1565{

1566 //printf("addGroupToGroups for %s groups=%d\n",qPrint(root->name),root->groups.size());

1567 for (const Grouping &g : root->groups)

1568 {

1569 GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);

1570 if (gd)

1571 {

1572 if (gd==subGroup)

1573 {

1574 warn(root->fileName,root->startLine,"Refusing to add group {} to itself",

1575 gd->name());

1576 }

1577 else if (subGroup->findGroup(gd))

1578 {

1579 warn(root->fileName,root->startLine,"Refusing to add group {} to group {}, since the latter is already a "

1580 "subgroup of the former", subGroup->name(),gd->name());

1581 }

1582 else if (!gd->findGroup(subGroup))

1583 {

1584 gd->addGroup(subGroup);

1585 subGroup->makePartOfGroup(gd);

1586 }

1587 }

1588 else if (!gd && g.pri == Grouping::GROUPING_INGROUP)

1589 {

1590 warn(root->fileName, root->startLine,

1591 "Found non-existing group '{}' for the command '{}', ignoring command",

1592 g.groupname, Grouping::getGroupPriName( g.pri )

1593 );

1594 }

1595 }

1596}

References GroupDef::addGroup, Entry::fileName, GroupDef::findGroup, Grouping::getGroupPriName, Grouping::GROUPING_INGROUP, Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, DefinitionMutable::makePartOfGroup, Definition::name, Grouping::pri, Entry::startLine and warn.

Referenced by organizeSubGroupsFiltered.

addMemberToGroups()

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

Add a member to the group with the highest priority

Declaration at line 138 of file groupdef.h, definition at line 1599 of file groupdef.cpp.

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

1600{

1601 //printf("addMemberToGroups: Root %p = %s, md %p=%s groups=%zu\n",

1602 // root, qPrint(root->name), md, qPrint(md->name()), root->groups.size() );

1603

1604 // Search entry's group list for group with highest pri.

1605 Grouping::GroupPri_t pri = Grouping::GROUPING_LOWEST;

1606 GroupDef *fgd=nullptr;

1607 for (const Grouping &g : root->groups)

1608 {

1609 GroupDef *gd=nullptr;

1610 if (!g.groupname.isEmpty()) gd=Doxygen::groupLinkedMap->find(g.groupname);

1611 if (gd && g.pri >= pri)

1612 {

1613 if (fgd && gd!=fgd && g.pri==pri)

1614 {

1615 warn(root->fileName, root->startLine,

1616 "Member {} found in multiple {} groups! "

1617 "The member will be put in group {}, and not in group {}",

1618 md->name(), Grouping::getGroupPriName( pri ),

1619 gd->name(), fgd->name()

1620 );

1621 }

1622

1623 fgd = gd;

1624 pri = g.pri;

1625 }

1626 else if (!gd && g.pri == Grouping::GROUPING_INGROUP)

1627 {

1628 warn(root->fileName, root->startLine,

1629 "Found non-existing group '{}' for the command '{}', ignoring command",

1630 g.groupname, Grouping::getGroupPriName( g.pri )

1631 );

1632 }

1633 }

1634 //printf("fgd=%p\n",fgd);

1635

1636 // put member into group defined by this entry?

1637 if (fgd)

1638 {

1639 GroupDef *mgd = md->getGroupDef();

1640 //printf("mgd=%p\n",mgd);

1641 bool insertit = FALSE;

1642 if (mgd==nullptr)

1643 {

1644 insertit = TRUE;

1645 }

1646 else if (mgd!=fgd)

1647 {

1648 bool moveit = FALSE;

1649

1650 // move member from one group to another if

1651 // - the new one has a higher priority

1652 // - the new entry has the same priority, but with docs where the old one had no docs

1653 if (md->getGroupPri()<pri)

1654 {

1655 moveit = TRUE;

1656 }

1657 else

1658 {

1659 if (md->getGroupPri()==pri)

1660 {

1661 if (!root->doc.isEmpty() && !md->getGroupHasDocs())

1662 {

1663 moveit = TRUE;

1664 }

1665 else if (!root->doc.isEmpty() && md->getGroupHasDocs())

1666 {

1667 warn(md->getGroupFileName(),md->getGroupStartLine(),

1668 "Member documentation for {} found several times in {} groups!\n"

1669 "{}:{}: The member will remain in group {}, and won't be put into group {}",

1670 md->name(), Grouping::getGroupPriName( pri ),

1671 root->fileName, root->startLine,

1672 mgd->name(), fgd->name()

1673 );

1674 }

1675 }

1676 }

1677

1678 if (moveit)

1679 {

1680 //printf("removeMember\n");

1681 mgd->removeMember(md);

1682 insertit = TRUE;

1683 }

1684 }

1685

1686 if (insertit)

1687 {

1688 //printf("insertMember found at %s line %d: %s: related %s\n",

1689 // qPrint(md->getDefFileName()),md->getDefLine(),

1690 // qPrint(md->name()),qPrint(root->relates));

1691 bool success = fgd->insertMember(md);

1692 if (success)

1693 {

1694 MemberDefMutable *mdm = toMemberDefMutable(md);

1695 if (mdm)

1696 {

1697 //printf("insertMember successful\n");

1698 mdm->setGroupDef(fgd,pri,root->fileName,root->startLine,!root->doc.isEmpty());

1699 ClassDefMutable *cdm = toClassDefMutable(mdm->getClassDefOfAnonymousType());

1700 if (cdm)

1701 {

1702 cdm->setGroupDefForAllMembers(fgd,pri,root->fileName,root->startLine,root->doc.length() != 0);

1703 }

1704 if (mdm->isEnumerate() && mdm->getGroupDef() && md->isStrong())

1705 {

1706 for (const auto &emd : mdm->enumFieldList())

1707 {

1708 MemberDefMutable *emdm = toMemberDefMutable(emd);

1709 if (emdm && emdm->getGroupDef()==nullptr)

1710 {

1711 emdm->setGroupDef(mdm->getGroupDef(),mdm->getGroupPri(),

1712 mdm->getGroupFileName(),mdm->getGroupStartLine(),

1713 mdm->getGroupHasDocs());

1714 }

1715 }

1716 }

1717 }

1718 }

1719 }

1720 }

1721}

References Entry::doc, MemberDef::enumFieldList, FALSE, Entry::fileName, MemberDef::getClassDefOfAnonymousType, MemberDef::getGroupDef, MemberDef::getGroupFileName, MemberDef::getGroupHasDocs, MemberDef::getGroupPri, Grouping::getGroupPriName, MemberDef::getGroupStartLine, Grouping::GROUPING_INGROUP, Grouping::GROUPING_LOWEST, Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, GroupDef::insertMember, QCString::isEmpty, MemberDef::isEnumerate, MemberDef::isStrong, QCString::length, Definition::name, Grouping::pri, GroupDef::removeMember, MemberDefMutable::setGroupDef, ClassDefMutable::setGroupDefForAllMembers, Entry::startLine, toClassDefMutable, toMemberDefMutable, TRUE and warn.

Referenced by addDefineDoc, addEnumDocs, addGlobalFunction, addInterfaceOrServiceToServiceOrSingleton, addMemberDocs, addMethodToClass, addVariableToClass, addVariableToFile, buildFunctionList, buildTypedefList, findEnums and findMember.

addModuleToGroups()

void addModuleToGroups (const Entry * root, ModuleDef * mod)

Declaration at line 135 of file groupdef.h, definition at line 1493 of file groupdef.cpp.

1493void addModuleToGroups(const Entry *root,ModuleDef *mod)

1494{

1495 for (const Grouping &g : root->groups)

1496 {

1497 GroupDef *gd = Doxygen::groupLinkedMap->find(g.groupname);

1498 if (gd && gd->addModule(mod))

1499 {

1500 mod->makePartOfGroup(gd);

1501 //printf("Module %s: in group %s\n",qPrint(mod->name()),gd->groupTitle());

1502 }

1503 else if (!gd && g.pri == Grouping::GROUPING_INGROUP)

1504 {

1505 warn(root->fileName, root->startLine,

1506 "Found non-existing group '{}' for the command '{}', ignoring command",

1507 g.groupname, Grouping::getGroupPriName( g.pri )

1508 );

1509 }

1510 }

1511}

References GroupDef::addModule, Entry::fileName, Grouping::getGroupPriName, Grouping::GROUPING_INGROUP, Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, DefinitionMutable::makePartOfGroup, Grouping::pri, Entry::startLine and warn.

Referenced by ModuleManager::addDocs.

addNamespaceToGroups()

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

Declaration at line 136 of file groupdef.h, definition at line 1514 of file groupdef.cpp.

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

1515{

1516 //printf("root->groups.size()=%zu\n",root->groups.size());

1517 for (const Grouping &g : root->groups)

1518 {

1519 GroupDef *gd=nullptr;

1520 if (!g.groupname.isEmpty()) gd=Doxygen::groupLinkedMap->find(g.groupname);

1521 //printf("group '%s' gd=%p\n",qPrint(g.groupname),(void*)gd);

1522 if (gd && gd->addNamespace(nd))

1523 {

1524 NamespaceDefMutable *ndm = toNamespaceDefMutable(nd);

1525 if (ndm)

1526 {

1527 ndm->makePartOfGroup(gd);

1528 }

1529 //printf("Namespace %s: in group %s\n",qPrint(nd->name()),qPrint(gd->name()));

1530 }

1531 else if (!gd && g.pri == Grouping::GROUPING_INGROUP)

1532 {

1533 warn(root->fileName, root->startLine,

1534 "Found non-existing group '{}' for the command '{}', ignoring command",

1535 g.groupname, Grouping::getGroupPriName( g.pri )

1536 );

1537 }

1538 }

1539}

References GroupDef::addNamespace, Entry::fileName, Grouping::getGroupPriName, Grouping::GROUPING_INGROUP, Doxygen::groupLinkedMap, Grouping::groupname, Entry::groups, QCString::isEmpty, DefinitionMutable::makePartOfGroup, Grouping::pri, Entry::startLine, toNamespaceDefMutable and warn.

Referenced by buildNamespaceList.

addPageToGroups()

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

Definition at line 139 of file groupdef.h.

createGroupDef()

std::unique_ptr< GroupDef > createGroupDef (const QCString & fileName, int line, const QCString & name, const QCString & title, const QCString & refFileName=QCString())

Declaration at line 115 of file groupdef.h, definition at line 175 of file groupdef.cpp.

175std::unique_ptr<GroupDef> createGroupDef(const QCString &fileName,int line,const QCString &name,

176 const QCString &title,const QCString &refFileName)

177{

178 return std::make_unique<GroupDefImpl>(fileName,line,name,title,refFileName);

179}

Referenced by buildGroupListFiltered and GroupDef::overrideGroupGraph.

toGroupDef()

GroupDef * toGroupDef (Definition * d)

Declaration at line 120 of file groupdef.h, definition at line 1996 of file groupdef.cpp.

1996GroupDef *toGroupDef(Definition *d)

1997{

1998 if (d==nullptr) return nullptr;

1999 if (d && typeid(*d)==typeid(GroupDefImpl))

2000 {

2001 return static_cast<GroupDef*>(d);

2002 }

2003 else

2004 {

2005 return nullptr;

2006 }

2007}

Referenced by DocRef::DocRef, DocParser::handleLinkedWord, SearchTerm::makeTitle, DefinitionImpl::navigationPathAsString, GroupDef::overrideGroupGraph, DefinitionImpl::pathFragment, SearchIndex::setCurrentDoc, SearchIndexExternal::setCurrentDoc, validatingParseDoc, MemberDefImpl::writeDocumentation and writeJavasScriptSearchDataPage.

toGroupDef()

const GroupDef * toGroupDef (const Definition * d)

Declaration at line 121 of file groupdef.h, definition at line 2009 of file groupdef.cpp.

2009const GroupDef *toGroupDef(const Definition *d)

2010{

2011 if (d==nullptr) return nullptr;

2012 if (d && typeid(*d)==typeid(GroupDefImpl))

2013 {

2014 return static_cast<const GroupDef*>(d);

2015 }

2016 else

2017 {

2018 return nullptr;

2019 }

2020}

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.