A class representing a group of members. More...

#include <src/membergroup.h>

Collaboration diagram for MemberGroup:

Public Member Functions
	MemberGroup (const Definition *container, int id, const DString &header, const DString &docs, const DString &docFile, int docLine, MemberListContainer con)
DString	header () const
int	groupId () const
void	insertMember (MemberDef *md)
void	setAnchors ()
void	writePlainDeclarations (OutputList &ol, bool inGroup, const ClassDef cd, const NamespaceDef nd, const FileDef fd, const GroupDef gd, const ModuleDef mod, int indentLevel, const ClassDef inheritedFrom, const DString &inheritId) const
void	writeDeclarations (OutputList &ol, const ClassDef cd, const NamespaceDef nd, const FileDef fd, const GroupDef gd, const ModuleDef *mod, bool showInline=false) const
void	writeDocumentation (OutputList &ol, const DString &scopeName, const Definition *container, bool showEnumValues, bool showInline) const
void	writeDocumentationPage (OutputList &ol, const DString &scopeName, const DefinitionMutable *container) const
void	writeTagFile (TextStream &, bool qualifiedName=false)
void	addGroupedInheritedMembers (OutputList &ol, const ClassDef cd, MemberListType lt, const ClassDef inheritedFrom, const DString &inheritId) const
void	setAnonymousEnumType ()
const DString &	documentation () const
bool	allMembersInSameSection () const
void	addToDeclarationSection ()
void	countDecMembers ()
void	countDocMembers ()
int	countGroupedInheritedMembers (MemberListType lt)
void	distributeMemberGroupDocumentation ()
void	findSectionsInDocumentation (const Definition *d)
int	numDecMembers () const
int	numDecEnumValues () const
int	numDocMembers () const
int	numDocEnumValues () const
const Definition *	container () const
const Definition *	memberContainer () const
int	countInheritableMembers (const ClassDef *inheritedFrom) const
void	addListReferences (const Definition *def)
void	addRequirementReferences (const Definition *def)
void	setRefItems (const RefItemVector &sli)
void	setRequirementReferences (const RequirementRefs &rqli)
const MemberList &	members () const
DString	docFile () const
int	docLine () const

Private Attributes
const Definition *	m_container
std::unique_ptr< MemberList >	memberList
MemberList *	inDeclSection = nullptr
int	grpId = 0
DString	grpHeader
DString	fileName
DString	doc
bool	inSameSection = true
DString	m_docFile
int	m_docLine
RefItemVector	m_xrefListItems
RequirementRefs	m_requirementRefs

Detailed Description

A class representing a group of members.

Definition at line 41 of file membergroup.h.

Constructor & Destructor Documentation

◆ MemberGroup()

MemberGroup::MemberGroup	(	const Definition *	container,
		int	id,
		const DString &	header,
		const DString &	docs,
		const DString &	docFile,
		int	docLine,
		MemberListContainer	con )

Definition at line 32 of file membergroup.cpp.

  : m_container(container),
    memberList(std::make_unique<MemberList>(MemberListType::MemberGroup(),con)),
    grpId(id), grpHeader(hdr), doc(d), m_docFile(docFile), m_docLine(docLine)
{
  //printf("New member group id=%d header=%s desc=%s\n",id,hdr,d);
  memberList->setNeedsSorting(Config_getBool(SORT_BRIEF_DOCS)); // detailed sections are already sorted elsewhere.
  //printf("Member group docs='%s'\n",qPrint(doc));
}

References Config_getBool, container(), doc, docFile(), docLine(), grpHeader, grpId, m_container, m_docFile, m_docLine, MemberGroup(), and memberList.

Referenced by MemberGroup().

Member Function Documentation

◆ addGroupedInheritedMembers()

void MemberGroup::addGroupedInheritedMembers	(	OutputList &	ol,
		const ClassDef *	cd,
		MemberListType	lt,
		const ClassDef *	inheritedFrom,
		const DString &	inheritId ) const

Definition at line 121 of file membergroup.cpp.

{
  //printf("** addGroupedInheritedMembers()\n");
  for (const auto &md : *memberList)
  {
    //printf("matching %d == %d\n",lt,md->getSectionList()->listType());
    const MemberList *ml = md->getSectionList(m_container);
    if (ml && lt==ml->listType())
    {
      MemberList mml(lt,MemberListContainer::Class);
      mml.push_back(md);
      mml.countDecMembers();
      mml.writePlainDeclarations(ol,false,cd,nullptr,nullptr,nullptr,nullptr,0,inheritedFrom,inheritId);
    }
  }
}

References Class, MemberList::countDecMembers(), MemberList::listType(), m_container, memberList, MemberVector::push_back(), and MemberList::writePlainDeclarations().

◆ addListReferences()

void MemberGroup::addListReferences ( const Definition * def )

Definition at line 267 of file membergroup.cpp.

{
  memberList->addListReferences(def);
}

References memberList.

◆ addRequirementReferences()

void MemberGroup::addRequirementReferences ( const Definition * def )

Definition at line 272 of file membergroup.cpp.

{
  memberList->addRequirementReferences(def);
}

References memberList.

◆ addToDeclarationSection()

void MemberGroup::addToDeclarationSection ( )

Add this group as a subsection of the declaration section, instead of rendering it in its own section

Definition at line 160 of file membergroup.cpp.

{
  if (inDeclSection)
  {
    //printf("Adding group %p to list %p (type=%d) memberList=%p\n",this,
    //                             inDeclSection,inDeclSection->listType(),memberList);
    inDeclSection->addMemberGroup(this);
  }
}

References MemberList::addMemberGroup(), and inDeclSection.

◆ allMembersInSameSection()

bool MemberGroup::allMembersInSameSection ( ) const

inline

Definition at line 68 of file membergroup.h.

68{ return inSameSection; }

MemberGroup::inSameSection

bool inSameSection

Definition membergroup.h:100

References inSameSection.

◆ container()

const Definition * MemberGroup::container ( ) const

Definition at line 180 of file membergroup.cpp.

{
  return m_container;
}

References m_container.

Referenced by MemberGroup(), writeDocumentation(), and writeDocumentationPage().

◆ countDecMembers()

void MemberGroup::countDecMembers ( )

Definition at line 170 of file membergroup.cpp.

{
  memberList->countDecMembers();
}

References memberList.

◆ countDocMembers()

void MemberGroup::countDocMembers ( )

Definition at line 175 of file membergroup.cpp.

{
  memberList->countDocMembers();
}

References memberList.

◆ countGroupedInheritedMembers()

int MemberGroup::countGroupedInheritedMembers ( MemberListType lt )

Definition at line 140 of file membergroup.cpp.

{
  //printf("** countGroupedInheritedMembers()\n");
  int count=0;
  for (const auto &md : *memberList)
  {
    //printf("matching %d == %d\n",lt,md->getSectionList()->listType());
    const MemberList *ml = md->getSectionList(m_container);
    if (ml && lt==ml->listType())
    {
      count++;
    }
  }
  return count;
}

References MemberList::listType(), m_container, and memberList.

◆ countInheritableMembers()

int MemberGroup::countInheritableMembers ( const ClassDef * inheritedFrom ) const

Definition at line 202 of file membergroup.cpp.

{
  return memberList->countInheritableMembers(inheritedFrom);
}

References memberList.

◆ distributeMemberGroupDocumentation()

void MemberGroup::distributeMemberGroupDocumentation ( )

Definition at line 208 of file membergroup.cpp.

{
  //printf("MemberGroup::distributeMemberGroupDocumentation() %s\n",qPrint(grpHeader));
  const MemberDef *md = nullptr;
  for (const auto &smd : *memberList)
  {
    //printf("checking md=%s\n",qPrint(md->name()));
    // find the first member of the group with documentation
    if (!smd->documentation().empty()       ||
        !smd->briefDescription().empty()    ||
        !smd->inbodyDocumentation().empty()
       )
    {
      //printf("found it!\n");
      md = smd;
      break;
    }
  }
  if (md) // distribute docs of md to other members of the list
  {
    //printf("Member %s has documentation!\n",qPrint(md->name()));
    for (const auto &iomd : *memberList)
    {
      MemberDefMutable *omd = toMemberDefMutable(iomd);
      if (omd && md!=omd && omd->documentation().empty() &&
                            omd->briefDescription().empty() &&
                            omd->inbodyDocumentation().empty()
         )
      {
        //printf("Copying documentation to member %s\n",qPrint(omd->name()));
        omd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
        omd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
        omd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());
      }
    }
  }
}

References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Definition::docFile(), Definition::docLine(), Definition::documentation(), DString::empty(), Definition::inbodyDocumentation(), Definition::inbodyFile(), Definition::inbodyLine(), memberList, DefinitionMutable::setBriefDescription(), DefinitionMutable::setDocumentation(), DefinitionMutable::setInbodyDocumentation(), and toMemberDefMutable().

◆ docFile()

DString MemberGroup::docFile ( ) const

inline

Definition at line 89 of file membergroup.h.

89{ return m_docFile; }

References m_docFile.

Referenced by MemberGroup().

◆ docLine()

int MemberGroup::docLine ( ) const

inline

Definition at line 90 of file membergroup.h.

90{ return m_docLine; }

References m_docLine.

Referenced by MemberGroup().

◆ documentation()

const DString & MemberGroup::documentation ( ) const

inline

Definition at line 67 of file membergroup.h.

67{ return doc; }

References doc.

◆ findSectionsInDocumentation()

void MemberGroup::findSectionsInDocumentation ( const Definition * d )

Definition at line 277 of file membergroup.cpp.

{
  docFindSections(doc,d,m_docFile);
  memberList->findSectionsInDocumentation(d);
}

References doc, docFindSections(), m_docFile, and memberList.

◆ groupId()

int MemberGroup::groupId ( ) const

inline

Definition at line 48 of file membergroup.h.

48{ return grpId; }

References grpId.

◆ header()

DString MemberGroup::header ( ) const

inline

Definition at line 47 of file membergroup.h.

47{ return grpHeader; }

References grpHeader.

◆ insertMember()

void MemberGroup::insertMember ( MemberDef * md )

Definition at line 44 of file membergroup.cpp.

{
  //printf("MemberGroup::insertMember(%s) inSameSection=%d md->getSectionList()=%s\n",qPrint(md->name()),
  //    inSameSection,qPrint(md->getSectionList(m_container)->listType().to_string()));
 
  MemberDef *firstMd = memberList->empty() ? nullptr : memberList->front();
  if (inSameSection && firstMd &&
      firstMd->getSectionList(m_container)!=md->getSectionList(m_container))
  {
    //printf("inSameSection=false\n");
    inSameSection=false;
  }
  else if (inDeclSection==nullptr)
  {
    inDeclSection = const_cast<MemberList*>(md->getSectionList(m_container));
    //printf("inDeclSection=%p type=%d\n",inDeclSection,inDeclSection->listType());
  }
  memberList->push_back(md);
 
  // copy the group of the first member in the memberGroup
  GroupDef *gd = nullptr;
  if (firstMd && !firstMd->isAlias() && (gd=firstMd->getGroupDef()))
  {
    MemberDefMutable *mdm = toMemberDefMutable(md);
    if (mdm)
    {
      mdm->setGroupDef(gd, firstMd->getGroupPri(),
                       firstMd->getGroupFileName(),
                       firstMd->getGroupStartLine(),
                       firstMd->getGroupHasDocs());
    }
    gd->insertMember(md);
  }
}

References MemberDef::getGroupDef(), MemberDef::getGroupFileName(), MemberDef::getGroupHasDocs(), MemberDef::getGroupPri(), MemberDef::getGroupStartLine(), MemberDef::getSectionList(), inDeclSection, inSameSection, GroupDef::insertMember(), Definition::isAlias(), m_container, memberList, MemberDefMutable::setGroupDef(), and toMemberDefMutable().

Referenced by addMembersToMemberGroup().

◆ memberContainer()

const Definition * MemberGroup::memberContainer ( ) const

Definition at line 185 of file membergroup.cpp.

{
  // return the container for the first member.
  // Note this can be different from container() in case
  // the member is rendered as part of a file but the members
  // are actually of a namespace.
  const Definition *ctx = nullptr;
  if (memberList && !memberList->empty())
  {
    const MemberDef *md = memberList->front();
    ctx = md->getClassDef();
    if (ctx==nullptr) ctx = md->getNamespaceDef();
    if (ctx==nullptr) ctx = md->getFileDef();
  }
  return ctx==nullptr ? m_container : ctx;
}

References MemberDef::getClassDef(), MemberDef::getFileDef(), MemberDef::getNamespaceDef(), m_container, and memberList.

◆ members()

const MemberList & MemberGroup::members ( ) const

inline

Definition at line 87 of file membergroup.h.

87{ return *memberList.get(); }

References memberList.

◆ numDecEnumValues()

int MemberGroup::numDecEnumValues ( ) const

Definition at line 252 of file membergroup.cpp.

{
  return memberList->numDecEnumValues();
}

References memberList.

◆ numDecMembers()

int MemberGroup::numDecMembers ( ) const

Definition at line 247 of file membergroup.cpp.

{
  return memberList->numDecMembers();
}

References memberList.

◆ numDocEnumValues()

int MemberGroup::numDocEnumValues ( ) const

Definition at line 262 of file membergroup.cpp.

{
  return memberList->numDocEnumValues();
}

References memberList.

◆ numDocMembers()

int MemberGroup::numDocMembers ( ) const

Definition at line 257 of file membergroup.cpp.

{
  return memberList->numDocMembers();
}

References memberList.

◆ setAnchors()

void MemberGroup::setAnchors ( )

Definition at line 80 of file membergroup.cpp.

{
  memberList->setAnchors();
}

References memberList.

◆ setAnonymousEnumType()

void MemberGroup::setAnonymousEnumType ( )

Definition at line 116 of file membergroup.cpp.

{
  memberList->setAnonymousEnumType();
}

References memberList.

◆ setRefItems()

void MemberGroup::setRefItems ( const RefItemVector & sli )

Definition at line 283 of file membergroup.cpp.

{
  m_xrefListItems.insert(m_xrefListItems.end(), sli.cbegin(), sli.cend());
}

References m_xrefListItems.

◆ setRequirementReferences()

void MemberGroup::setRequirementReferences ( const RequirementRefs & rqli )

Definition at line 288 of file membergroup.cpp.

{
  m_requirementRefs.insert(m_requirementRefs.end(), rqli.cbegin(), rqli.cend());
}

References m_requirementRefs.

◆ writeDeclarations()

void MemberGroup::writeDeclarations	(	OutputList &	ol,
		const ClassDef *	cd,
		const NamespaceDef *	nd,
		const FileDef *	fd,
		const GroupDef *	gd,
		const ModuleDef *	mod,
		bool	showInline = false ) const

Definition at line 85 of file membergroup.cpp.

{
  //printf("MemberGroup::writeDeclarations() %s\n",qPrint(grpHeader));
  DString ldoc = doc;
  memberList->writeDeclarations(ol,cd,nd,fd,gd,mod,grpHeader,ldoc,false,showInline);
}

References doc, grpHeader, and memberList.

◆ writeDocumentation()

void MemberGroup::writeDocumentation	(	OutputList &	ol,
		const DString &	scopeName,
		const Definition *	container,
		bool	showEnumValues,
		bool	showInline ) const

Definition at line 103 of file membergroup.cpp.

{
  //printf("MemberGroup::writeDocumentation() %s\n",qPrint(grpHeader));
  memberList->writeDocumentation(ol,scopeName,container,DString(),memberList->listType().toLabel(),showEnumValues,showInline);
}

References container(), and memberList.

◆ writeDocumentationPage()

void MemberGroup::writeDocumentationPage	(	OutputList &	ol,
		const DString &	scopeName,
		const DefinitionMutable *	container ) const

Definition at line 110 of file membergroup.cpp.

{
  memberList->writeDocumentationPage(ol,scopeName,container);
}

References container(), and memberList.

◆ writePlainDeclarations()

void MemberGroup::writePlainDeclarations	(	OutputList &	ol,
		bool	inGroup,
		const ClassDef *	cd,
		const NamespaceDef *	nd,
		const FileDef *	fd,
		const GroupDef *	gd,
		const ModuleDef *	mod,
		int	indentLevel,
		const ClassDef *	inheritedFrom,
		const DString &	inheritId ) const

Definition at line 94 of file membergroup.cpp.

{
  //printf("MemberGroup::writePlainDeclarations() memberList->count()=%d\n",memberList->count());
  memberList->writePlainDeclarations(ol,inGroup,cd,nd,fd,gd,mod,indentLevel,inheritedFrom,inheritId);
}

References memberList.

◆ writeTagFile()

void MemberGroup::writeTagFile	(	TextStream &	tagFile,
		bool	qualifiedName = false )

Definition at line 293 of file membergroup.cpp.

{
  memberList->writeTagFile(tagFile,qualifiedName);
}

References memberList.

Member Data Documentation

◆ doc

DString MemberGroup::doc

private

Definition at line 99 of file membergroup.h.

Referenced by documentation(), findSectionsInDocumentation(), MemberGroup(), and writeDeclarations().

◆ fileName

DString MemberGroup::fileName

private

Definition at line 98 of file membergroup.h.

◆ grpHeader

DString MemberGroup::grpHeader

private

Definition at line 97 of file membergroup.h.

Referenced by header(), MemberGroup(), and writeDeclarations().

◆ grpId

int MemberGroup::grpId = 0

private

Definition at line 96 of file membergroup.h.

Referenced by groupId(), and MemberGroup().

◆ inDeclSection

MemberList* MemberGroup::inDeclSection = nullptr

private

Definition at line 95 of file membergroup.h.

Referenced by addToDeclarationSection(), and insertMember().

◆ inSameSection

bool MemberGroup::inSameSection = true

private

Definition at line 100 of file membergroup.h.

Referenced by allMembersInSameSection(), and insertMember().

◆ m_container

const Definition* MemberGroup::m_container

private

Definition at line 93 of file membergroup.h.

Referenced by addGroupedInheritedMembers(), container(), countGroupedInheritedMembers(), insertMember(), memberContainer(), and MemberGroup().

◆ m_docFile

DString MemberGroup::m_docFile

private

Definition at line 101 of file membergroup.h.

Referenced by docFile(), findSectionsInDocumentation(), and MemberGroup().

◆ m_docLine

int MemberGroup::m_docLine

private

Definition at line 102 of file membergroup.h.

Referenced by docLine(), and MemberGroup().

◆ m_requirementRefs

RequirementRefs MemberGroup::m_requirementRefs

private

Definition at line 104 of file membergroup.h.

Referenced by setRequirementReferences().

◆ m_xrefListItems

RefItemVector MemberGroup::m_xrefListItems

private

Definition at line 103 of file membergroup.h.

Referenced by setRefItems().

◆ memberList

std::unique_ptr<MemberList> MemberGroup::memberList

private

The documentation for this class was generated from the following files:

src/membergroup.h
src/membergroup.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MemberGroup()

Member Function Documentation

◆ addGroupedInheritedMembers()

◆ addListReferences()

◆ addRequirementReferences()

◆ addToDeclarationSection()

◆ allMembersInSameSection()

◆ container()

◆ countDecMembers()

◆ countDocMembers()

◆ countGroupedInheritedMembers()

◆ countInheritableMembers()

◆ distributeMemberGroupDocumentation()

◆ docFile()

◆ docLine()

◆ documentation()

◆ findSectionsInDocumentation()

◆ groupId()

◆ header()

◆ insertMember()

◆ memberContainer()

◆ members()

◆ numDecEnumValues()

◆ numDecMembers()

◆ numDocEnumValues()

◆ numDocMembers()

◆ setAnchors()

◆ setAnonymousEnumType()

◆ setRefItems()

◆ setRequirementReferences()

◆ writeDeclarations()

◆ writeDocumentation()

◆ writeDocumentationPage()

◆ writePlainDeclarations()

◆ writeTagFile()

Member Data Documentation

◆ doc

◆ fileName

◆ grpHeader

◆ grpId

◆ inDeclSection

◆ inSameSection

◆ m_container

◆ m_docFile

◆ m_docLine

◆ m_requirementRefs

◆ m_xrefListItems

◆ memberList