MemberGroup Class Reference

#include <membergroup.h>

Public Member Functions
	MemberGroup ()
	MemberGroup (Definition *parent, int id, const char *header, const char *docs, const char *docFile, int docLine)
	~MemberGroup ()
QCString	header () const
int	groupId () const
void	insertMember (MemberDef *md)
void	setAnchors ()
void	writePlainDeclarations (OutputList &ol, ClassDef *cd, NamespaceDef *nd, FileDef *fd, GroupDef *gd, ClassDef *inheritedFrom, const char *inheritId)
void	writeDeclarations (OutputList &ol, ClassDef *cd, NamespaceDef *nd, FileDef *fd, GroupDef *gd, bool showInline=FALSE)
void	writeDocumentation (OutputList &ol, const char *scopeName, Definition *container, bool showEnumValues, bool showInline)
void	writeDocumentationPage (OutputList &ol, const char *scopeName, Definition *container)
void	writeTagFile (FTextStream &)
void	addGroupedInheritedMembers (OutputList &ol, ClassDef *cd, MemberListType lt, ClassDef *inheritedFrom, const QCString &inheritId)
const QCString &	documentation () const
bool	allMembersInSameSection () const
void	addToDeclarationSection ()
int	countDecMembers (GroupDef *gd=0)
int	countDocMembers ()
int	countGroupedInheritedMembers (MemberListType lt)
void	distributeMemberGroupDocumentation ()
void	findSectionsInDocumentation ()
int	varCount () const
int	funcCount () const
int	enumCount () const
int	enumValueCount () const
int	typedefCount () const
int	protoCount () const
int	defineCount () const
int	friendCount () const
int	numDecMembers () const
int	numDocMembers () const
int	countInheritableMembers (ClassDef *inheritedFrom) const
void	setInGroup (bool b)
void	addListReferences (Definition *d)
void	setRefItems (const QList< ListItemInfo > *sli)
MemberList *	members () const
Definition *	parent () const
QCString	anchor () const
QCString	docFile () const
int	docLine () const
void	marshal (StorageIntf *s)
void	unmarshal (StorageIntf *s)

Private Attributes
MemberList *	memberList
MemberList *	inDeclSection
int	grpId
QCString	grpHeader
QCString	fileName
Definition *	scope
QCString	doc
bool	inSameSection
int	m_numDecMembers
int	m_numDocMembers
Definition *	m_parent
QCString	m_docFile
int	m_docLine
QList< ListItemInfo > *	m_xrefListItems

Detailed Description

A class representing a group of members.

Definition at line 40 of file membergroup.h.

Constructor & Destructor Documentation

MemberGroup::MemberGroup

(

)

Definition at line 40 of file membergroup.cpp.

{
}

MemberGroup::MemberGroup	(	Definition *	parent,
		int	id,
		const char *	header,
		const char *	docs,
		const char *	docFile,
		int	docLine
	)

Definition at line 44 of file membergroup.cpp.

{
  //printf("New member group id=%d header=%s desc=%s\n",id,hdr,d);
  memberList      = new MemberList(MemberListType_memberGroup);
  grpId           = id;
  grpHeader       = hdr;
  doc             = d;
  scope           = 0;
  inSameSection   = TRUE;
  inDeclSection   = 0;
  m_numDecMembers = -1;
  m_numDocMembers = -1;
  m_parent        = parent;
  m_docFile       = docFile;
  m_docLine       = docLine;
  m_xrefListItems = 0;
  //printf("Member group docs=`%s'\n",doc.data());
}

MemberGroup::~MemberGroup

(

)

Definition at line 64 of file membergroup.cpp.

{
  delete memberList;
}

Member Function Documentation

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

Definition at line 140 of file membergroup.cpp.

{
  //printf("** addGroupedInheritedMembers()\n");
  MemberListIterator li(*memberList);
  MemberDef *md;
  for (li.toFirst();(md=li.current());++li)
  {
    //printf("matching %d == %d\n",lt,md->getSectionList(m_parent)->listType());
    if (lt==md->getSectionList(m_parent)->listType())
    {
      MemberList ml(lt);
      ml.append(md);
      ml.writePlainDeclarations(ol,cd,0,0,0,inheritedFrom,inheritId);
    }
  }
}

void MemberGroup::addListReferences

(

Definition *

d

)

Definition at line 320 of file membergroup.cpp.

{
  memberList->addListReferences(def);
  if (m_xrefListItems && def)
  {
    QCString name = def->getOutputFileBase()+"#"+anchor();
    addRefItem(m_xrefListItems,
        name,
        theTranslator->trGroup(TRUE,TRUE),
        name,
        grpHeader,0,def);
  }
}

void MemberGroup::addToDeclarationSection

(

)

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

Definition at line 180 of file membergroup.cpp.

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

bool MemberGroup::allMembersInSameSection ( ) const

inline

Definition at line 67 of file membergroup.h.

{ return inSameSection; }

QCString MemberGroup::anchor

(

)

const

Definition at line 309 of file membergroup.cpp.

{
  uchar md5_sig[16];
  QCString sigStr(33);
  QCString locHeader = grpHeader;
  if (locHeader.isEmpty()) locHeader="[NOHEADER]";
  MD5Buffer((const unsigned char *)locHeader.data(),locHeader.length(),md5_sig);
  MD5SigToString(md5_sig,sigStr.rawData(),33);
  return "amgrp"+sigStr;
}

int MemberGroup::countDecMembers

(

GroupDef *

gd = 0

)

Definition at line 190 of file membergroup.cpp.

{
  if (m_numDecMembers==-1) /* number of member not cached */
  {
    memberList->countDecMembers(gd);
    m_numDecMembers = memberList->numDecMembers();
  }
  return m_numDecMembers;
}

int MemberGroup::countDocMembers

(

)

Definition at line 200 of file membergroup.cpp.

{
  if (m_numDocMembers==-1)
  {
    memberList->countDocMembers();
    m_numDocMembers = memberList->numDocMembers();
  }
  return m_numDocMembers;
}

int MemberGroup::countGroupedInheritedMembers

(

MemberListType

lt

)

Definition at line 159 of file membergroup.cpp.

{
  //printf("** countGroupedInheritedMembers()\n");
  int count=0;
  MemberListIterator li(*memberList);
  MemberDef *md;
  for (li.toFirst();(md=li.current());++li)
  {
    //printf("matching %d == %d\n",lt,md->getSectionList(m_parent)->listType());
    if (lt==md->getSectionList(m_parent)->listType())
    {
      count++;
    }
  }
  return count;
}

int MemberGroup::countInheritableMembers

(

ClassDef *

inheritedFrom

)

const

Definition at line 210 of file membergroup.cpp.

{
  return memberList->countInheritableMembers(inheritedFrom);
}

int MemberGroup::defineCount

(

)

const

Definition at line 284 of file membergroup.cpp.

{ 
  return memberList->defineCount(); 
}

void MemberGroup::distributeMemberGroupDocumentation

(

)

Definition at line 216 of file membergroup.cpp.

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

QCString MemberGroup::docFile ( ) const

inline

Definition at line 92 of file membergroup.h.

{ return m_docFile; }

int MemberGroup::docLine ( ) const

inline

Definition at line 93 of file membergroup.h.

{ return m_docLine; }

const QCString& MemberGroup::documentation ( ) const

inline

Definition at line 66 of file membergroup.h.

{ return doc; }

int MemberGroup::enumCount

(

)

const

Definition at line 264 of file membergroup.cpp.

{ 
  return memberList->enumCount(); 
}

int MemberGroup::enumValueCount

(

)

const

Definition at line 269 of file membergroup.cpp.

{ 
  return memberList->enumValueCount(); 
}

void MemberGroup::findSectionsInDocumentation

(

)

Definition at line 334 of file membergroup.cpp.

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

int MemberGroup::friendCount

(

)

const

Definition at line 289 of file membergroup.cpp.

{ 
  return memberList->friendCount(); 
}

int MemberGroup::funcCount

(

)

const

Definition at line 259 of file membergroup.cpp.

{ 
  return memberList->funcCount(); 
}

int MemberGroup::groupId ( ) const

inline

Definition at line 48 of file membergroup.h.

{ return grpId; }

QCString MemberGroup::header ( ) const

inline

Definition at line 47 of file membergroup.h.

{ return grpHeader; }

void MemberGroup::insertMember

(

MemberDef *

md

)

Definition at line 69 of file membergroup.cpp.

{
  //printf("MemberGroup::insertMember m_parent=%s memberList=%p count=%d"
  //       " member section list: %p: md=%p:%s\n",
  //       m_parent ? m_parent->name().data() : "<null>",
  //       memberList->first() ? memberList->first()->getSectionList(m_parent) : 0,
  //       memberList->count(),
  //       md->getSectionList(m_parent),
  //       md,md->name().data());

  MemberDef *firstMd = memberList->getFirst();
  if (inSameSection && firstMd &&
      firstMd->getSectionList(m_parent)!=md->getSectionList(m_parent))
  {
    inSameSection=FALSE;
  }
  else if (inDeclSection==0)
  {
    inDeclSection = md->getSectionList(m_parent);
    //printf("inDeclSection=%p type=%d\n",inDeclSection,inDeclSection->listType());
  }
  memberList->append(md);

  // copy the group of the first member in the memberGroup
  GroupDef *gd;
  if (firstMd && (gd=firstMd->getGroupDef()))
  {
    md->setGroupDef(gd, firstMd->getGroupPri(), 
                    firstMd->getGroupFileName(), firstMd->getGroupStartLine(), 
                    firstMd->getGroupHasDocs());
    gd->insertMember(md);
  }
}

void MemberGroup::marshal

(

StorageIntf *

s

)

Definition at line 340 of file membergroup.cpp.

{
  marshalMemberList(s,memberList);
  marshalObjPointer(s,inDeclSection); // reference only
  marshalInt(s,grpId);
  marshalQCString(s,grpHeader);
  marshalQCString(s,fileName);
  marshalObjPointer(s,scope);
  marshalQCString(s,doc);
  marshalBool(s,inSameSection);
  marshalInt(s,m_numDecMembers);
  marshalInt(s,m_numDocMembers);
  marshalObjPointer(s,m_parent);
  marshalQCString(s,m_docFile);
  marshalItemInfoList (Doxygen::symbolStorage,m_xrefListItems);
}

MemberList* MemberGroup::members ( ) const

inline

Definition at line 88 of file membergroup.h.

{ return memberList; }

int MemberGroup::numDecMembers

(

)

const

Definition at line 294 of file membergroup.cpp.

{ 
  return memberList->numDecMembers(); 
}

int MemberGroup::numDocMembers

(

)

const

Definition at line 299 of file membergroup.cpp.

{ 
  return memberList->numDocMembers(); 
}

Definition* MemberGroup::parent ( ) const

inline

Definition at line 89 of file membergroup.h.

{ return m_parent; }

int MemberGroup::protoCount

(

)

const

Definition at line 279 of file membergroup.cpp.

{ 
  return memberList->protoCount(); 
}

void MemberGroup::setAnchors

(

)

Definition at line 104 of file membergroup.cpp.

{
  ::setAnchors(memberList);
}

void MemberGroup::setInGroup

(

bool

b

)

Definition at line 304 of file membergroup.cpp.

{
  memberList->setInGroup(b);
}

void MemberGroup::setRefItems

(

const QList< ListItemInfo > *

sli

)

Definition at line 374 of file membergroup.cpp.

{
  if (sli)
  {
    // deep copy the list
    if (m_xrefListItems==0) 
    {
      m_xrefListItems=new QList<ListItemInfo>;
      m_xrefListItems->setAutoDelete(TRUE);
    }
    QListIterator<ListItemInfo> slii(*sli);
    ListItemInfo *lii;
    for (slii.toFirst();(lii=slii.current());++slii)
    {
      m_xrefListItems->append(new ListItemInfo(*lii));
    } 
  }
}

int MemberGroup::typedefCount

(

)

const

Definition at line 274 of file membergroup.cpp.

{ 
  return memberList->typedefCount(); 
}

void MemberGroup::unmarshal

(

StorageIntf *

s

)

Definition at line 357 of file membergroup.cpp.

{
  memberList      = unmarshalMemberList(s);
  inDeclSection   = (MemberList *)unmarshalObjPointer(s); 
  grpId           = unmarshalInt(s);
  grpHeader       = unmarshalQCString(s);
  fileName        = unmarshalQCString(s);
  scope           = (Definition *)unmarshalObjPointer(s);
  doc             = unmarshalQCString(s);
  inSameSection   = unmarshalBool(s);
  m_numDecMembers = unmarshalInt(s);
  m_numDocMembers = unmarshalInt(s);
  m_parent        = (Definition *)unmarshalObjPointer(s);
  m_docFile       = unmarshalQCString(s);
  m_xrefListItems = unmarshalItemInfoList (Doxygen::symbolStorage);
}

int MemberGroup::varCount

(

)

const

Definition at line 254 of file membergroup.cpp.

{
  return memberList->varCount();
}

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

Definition at line 109 of file membergroup.cpp.

{
  //printf("MemberGroup::writeDeclarations() %s\n",grpHeader.data());
  QCString ldoc = doc;
  if (!ldoc.isEmpty()) ldoc.prepend("<a name=\""+anchor()+"\" id=\""+anchor()+"\"></a>");
  memberList->writeDeclarations(ol,cd,nd,fd,gd,grpHeader,ldoc,FALSE,showInline);
}

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

Definition at line 128 of file membergroup.cpp.

{
  memberList->writeDocumentation(ol,scopeName,container,0,showEnumValues,showInline);
}

void MemberGroup::writeDocumentationPage	(	OutputList &	ol,
		const char *	scopeName,
		Definition *	container
	)

Definition at line 134 of file membergroup.cpp.

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

void MemberGroup::writePlainDeclarations	(	OutputList &	ol,
		ClassDef *	cd,
		NamespaceDef *	nd,
		FileDef *	fd,
		GroupDef *	gd,
		ClassDef *	inheritedFrom,
		const char *	inheritId
	)

Definition at line 119 of file membergroup.cpp.

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

void MemberGroup::writeTagFile

(

FTextStream &

tagFile

)

Definition at line 393 of file membergroup.cpp.

{
  memberList->writeTagFile(tagFile);
}

Member Data Documentation

QCString MemberGroup::doc

private

Definition at line 105 of file membergroup.h.

QCString MemberGroup::fileName

private

Definition at line 103 of file membergroup.h.

QCString MemberGroup::grpHeader

private

Definition at line 102 of file membergroup.h.

int MemberGroup::grpId

private

Definition at line 101 of file membergroup.h.

MemberList* MemberGroup::inDeclSection

private

Definition at line 100 of file membergroup.h.

bool MemberGroup::inSameSection

private

Definition at line 106 of file membergroup.h.

QCString MemberGroup::m_docFile

private

Definition at line 110 of file membergroup.h.

int MemberGroup::m_docLine

private

Definition at line 111 of file membergroup.h.

int MemberGroup::m_numDecMembers

private

Definition at line 107 of file membergroup.h.

int MemberGroup::m_numDocMembers

private

Definition at line 108 of file membergroup.h.

Definition* MemberGroup::m_parent

private

Definition at line 109 of file membergroup.h.

QList<ListItemInfo>* MemberGroup::m_xrefListItems

private

Definition at line 112 of file membergroup.h.

MemberList* MemberGroup::memberList

private

Definition at line 99 of file membergroup.h.

Definition* MemberGroup::scope

private

Definition at line 104 of file membergroup.h.

---

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

• doxygen-1.8.11/src/membergroup.h
• doxygen-1.8.11/src/membergroup.cpp