|
Packit Service |
50c9f2 |
/******************************************************************************
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
* Copyright (C) 1997-2015 by Dimitri van Heesch.
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
* Permission to use, copy, modify, and distribute this software and its
|
|
Packit Service |
50c9f2 |
* documentation under the terms of the GNU General Public License is hereby
|
|
Packit Service |
50c9f2 |
* granted. No representations are made about the suitability of this software
|
|
Packit Service |
50c9f2 |
* for any purpose. It is provided "as is" without express or implied warranty.
|
|
Packit Service |
50c9f2 |
* See the GNU General Public License for more details.
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
* Documents produced by Doxygen are derivative works derived from the
|
|
Packit Service |
50c9f2 |
* input used in their production; they are not affected by this license.
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
*/
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
#ifndef MEMBERGROUP_H
|
|
Packit Service |
50c9f2 |
#define MEMBERGROUP_H
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
#include <qlist.h>
|
|
Packit Service |
50c9f2 |
#include "sortdict.h"
|
|
Packit Service |
50c9f2 |
#include "types.h"
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
#define DOX_NOGROUP -1
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
class MemberList;
|
|
Packit Service |
50c9f2 |
class MemberDef;
|
|
Packit Service |
50c9f2 |
class ClassDef;
|
|
Packit Service |
50c9f2 |
class NamespaceDef;
|
|
Packit Service |
50c9f2 |
class FileDef;
|
|
Packit Service |
50c9f2 |
class GroupDef;
|
|
Packit Service |
50c9f2 |
class OutputList;
|
|
Packit Service |
50c9f2 |
class Definition;
|
|
Packit Service |
50c9f2 |
class StorageIntf;
|
|
Packit Service |
50c9f2 |
class FTextStream;
|
|
Packit Service |
50c9f2 |
struct ListItemInfo;
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** A class representing a group of members. */
|
|
Packit Service |
50c9f2 |
class MemberGroup
|
|
Packit Service |
50c9f2 |
{
|
|
Packit Service |
50c9f2 |
public:
|
|
Packit Service |
50c9f2 |
MemberGroup();
|
|
Packit Service |
50c9f2 |
MemberGroup(Definition *parent,int id,const char *header,
|
|
Packit Service |
50c9f2 |
const char *docs,const char *docFile,int docLine);
|
|
Packit Service |
50c9f2 |
~MemberGroup();
|
|
Packit Service |
50c9f2 |
QCString header() const { return grpHeader; }
|
|
Packit Service |
50c9f2 |
int groupId() const { return grpId; }
|
|
Packit Service |
50c9f2 |
void insertMember(MemberDef *md);
|
|
Packit Service |
50c9f2 |
void setAnchors();
|
|
Packit Service |
50c9f2 |
void writePlainDeclarations(OutputList &ol,
|
|
Packit Service |
50c9f2 |
ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd,
|
|
Packit Service |
50c9f2 |
ClassDef *inheritedFrom,const char *inheritId);
|
|
Packit Service |
50c9f2 |
void writeDeclarations(OutputList &ol,
|
|
Packit Service |
50c9f2 |
ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd,
|
|
Packit Service |
50c9f2 |
bool showInline=FALSE);
|
|
Packit Service |
50c9f2 |
void writeDocumentation(OutputList &ol,const char *scopeName,
|
|
Packit Service |
50c9f2 |
Definition *container,bool showEnumValues,bool showInline);
|
|
Packit Service |
50c9f2 |
void writeDocumentationPage(OutputList &ol,const char *scopeName,
|
|
Packit Service |
50c9f2 |
Definition *container);
|
|
Packit Service |
50c9f2 |
void writeTagFile(FTextStream &);
|
|
Packit Service |
50c9f2 |
void addGroupedInheritedMembers(OutputList &ol,ClassDef *cd,
|
|
Packit Service |
50c9f2 |
MemberListType lt,
|
|
Packit Service |
50c9f2 |
ClassDef *inheritedFrom,const QCString &inheritId);
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
const QCString &documentation() const { return doc; }
|
|
Packit Service |
50c9f2 |
bool allMembersInSameSection() const { return inSameSection; }
|
|
Packit Service |
50c9f2 |
void addToDeclarationSection();
|
|
Packit Service |
50c9f2 |
int countDecMembers(GroupDef *gd=0);
|
|
Packit Service |
50c9f2 |
int countDocMembers();
|
|
Packit Service |
50c9f2 |
int countGroupedInheritedMembers(MemberListType lt);
|
|
Packit Service |
50c9f2 |
void distributeMemberGroupDocumentation();
|
|
Packit Service |
50c9f2 |
void findSectionsInDocumentation();
|
|
Packit Service |
50c9f2 |
int varCount() const;
|
|
Packit Service |
50c9f2 |
int funcCount() const;
|
|
Packit Service |
50c9f2 |
int enumCount() const;
|
|
Packit Service |
50c9f2 |
int enumValueCount() const;
|
|
Packit Service |
50c9f2 |
int typedefCount() const;
|
|
Packit Service |
50c9f2 |
int protoCount() const;
|
|
Packit Service |
50c9f2 |
int defineCount() const;
|
|
Packit Service |
50c9f2 |
int friendCount() const;
|
|
Packit Service |
50c9f2 |
int numDecMembers() const;
|
|
Packit Service |
50c9f2 |
int numDocMembers() const;
|
|
Packit Service |
50c9f2 |
int countInheritableMembers(ClassDef *inheritedFrom) const;
|
|
Packit Service |
50c9f2 |
void setInGroup(bool b);
|
|
Packit Service |
50c9f2 |
void addListReferences(Definition *d);
|
|
Packit Service |
50c9f2 |
void setRefItems(const QList<ListItemInfo> *sli);
|
|
Packit Service |
50c9f2 |
MemberList *members() const { return memberList; }
|
|
Packit Service |
50c9f2 |
Definition *parent() const { return m_parent; }
|
|
Packit Service |
50c9f2 |
QCString anchor() const;
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
QCString docFile() const { return m_docFile; }
|
|
Packit Service |
50c9f2 |
int docLine() const { return m_docLine; }
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
void marshal(StorageIntf *s);
|
|
Packit Service |
50c9f2 |
void unmarshal(StorageIntf *s);
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
private:
|
|
Packit Service |
50c9f2 |
MemberList *memberList; // list of all members in the group
|
|
Packit Service |
50c9f2 |
MemberList *inDeclSection;
|
|
Packit Service |
50c9f2 |
int grpId;
|
|
Packit Service |
50c9f2 |
QCString grpHeader;
|
|
Packit Service |
50c9f2 |
QCString fileName; // base name of the generated file
|
|
Packit Service |
50c9f2 |
Definition *scope;
|
|
Packit Service |
50c9f2 |
QCString doc;
|
|
Packit Service |
50c9f2 |
bool inSameSection;
|
|
Packit Service |
50c9f2 |
int m_numDecMembers;
|
|
Packit Service |
50c9f2 |
int m_numDocMembers;
|
|
Packit Service |
50c9f2 |
Definition *m_parent;
|
|
Packit Service |
50c9f2 |
QCString m_docFile;
|
|
Packit Service |
50c9f2 |
int m_docLine;
|
|
Packit Service |
50c9f2 |
QList<ListItemInfo> *m_xrefListItems;
|
|
Packit Service |
50c9f2 |
};
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** A list of MemberGroup objects. */
|
|
Packit Service |
50c9f2 |
class MemberGroupList : public QList<MemberGroup>
|
|
Packit Service |
50c9f2 |
{
|
|
Packit Service |
50c9f2 |
};
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** An iterator for MemberGroup objects in a MemberGroupList. */
|
|
Packit Service |
50c9f2 |
class MemberGroupListIterator : public QListIterator<MemberGroup>
|
|
Packit Service |
50c9f2 |
{
|
|
Packit Service |
50c9f2 |
public:
|
|
Packit Service |
50c9f2 |
MemberGroupListIterator(const MemberGroupList &l) :
|
|
Packit Service |
50c9f2 |
QListIterator<MemberGroup>(l) {}
|
|
Packit Service |
50c9f2 |
};
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** A sorted dictionary of MemberGroup objects. */
|
|
Packit Service |
50c9f2 |
class MemberGroupSDict : public SIntDict<MemberGroup>
|
|
Packit Service |
50c9f2 |
{
|
|
Packit Service |
50c9f2 |
public:
|
|
Packit Service |
50c9f2 |
MemberGroupSDict(int size=17) : SIntDict<MemberGroup>(size) {}
|
|
Packit Service |
50c9f2 |
~MemberGroupSDict() {}
|
|
Packit Service |
50c9f2 |
private:
|
|
Packit Service |
50c9f2 |
int compareValues(const MemberGroup *item1,const MemberGroup *item2) const
|
|
Packit Service |
50c9f2 |
{
|
|
Packit Service |
50c9f2 |
return item1->groupId() - item2->groupId();
|
|
Packit Service |
50c9f2 |
}
|
|
Packit Service |
50c9f2 |
};
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** Data collected for a member group */
|
|
Packit Service |
50c9f2 |
struct MemberGroupInfo
|
|
Packit Service |
50c9f2 |
{
|
|
Packit Service |
50c9f2 |
MemberGroupInfo() : docLine(-1), m_sli(0) {}
|
|
Packit Service |
50c9f2 |
~MemberGroupInfo() { delete m_sli; m_sli=0; }
|
|
Packit Service |
50c9f2 |
void setRefItems(const QList<ListItemInfo> *sli);
|
|
Packit Service |
50c9f2 |
QCString header;
|
|
Packit Service |
50c9f2 |
QCString doc;
|
|
Packit Service |
50c9f2 |
QCString docFile;
|
|
Packit Service |
50c9f2 |
int docLine;
|
|
Packit Service |
50c9f2 |
QCString compoundName;
|
|
Packit Service |
50c9f2 |
QList<ListItemInfo> *m_sli;
|
|
Packit Service |
50c9f2 |
};
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
#endif
|