1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/******************************************************************************
*
*
*
* Copyright (C) 1997-2015 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
* granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* Documents produced by Doxygen are derivative works derived from the
* input used in their production; they are not affected by this license.
*
*/
#ifndef MEMBERGROUP_H
#define MEMBERGROUP_H
#include <vector>
#include <map>
#include <memory>
#include "types.h"
#include "reflist.h"
#define DOX_NOGROUP -1
class MemberList;
class MemberDef;
class ClassDef;
class NamespaceDef;
class FileDef;
class GroupDef;
class OutputList;
class Definition;
class DefinitionMutable;
class RefItem;
/** A class representing a group of members. */
class MemberGroup
{
public:
//MemberGroup();
MemberGroup(const Definition *container,int id,const char *header,
const char *docs,const char *docFile,int docLine);
~MemberGroup();
QCString header() const { return grpHeader; }
int groupId() const { return grpId; }
void insertMember(const MemberDef *md);
void setAnchors();
void writePlainDeclarations(OutputList &ol,
const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,
const ClassDef *inheritedFrom,const char *inheritId) const;
void writeDeclarations(OutputList &ol,
const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,
bool showInline=FALSE) const;
void writeDocumentation(OutputList &ol,const char *scopeName,
const Definition *container,bool showEnumValues,bool showInline) const;
void writeDocumentationPage(OutputList &ol,const char *scopeName,
const DefinitionMutable *container) const;
void writeTagFile(std::ostream &);
void addGroupedInheritedMembers(OutputList &ol,const ClassDef *cd,
MemberListType lt,
const ClassDef *inheritedFrom,const QCString &inheritId) const;
void setAnonymousEnumType();
const QCString &documentation() const { return doc; }
bool allMembersInSameSection() const { return inSameSection; }
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;
int countInheritableMembers(const ClassDef *inheritedFrom) const;
void setInGroup(bool b);
void addListReferences(Definition *d);
void setRefItems(const RefItemVector &sli);
const MemberList &members() const { return *memberList.get(); }
QCString anchor() const;
QCString docFile() const { return m_docFile; }
int docLine() const { return m_docLine; }
private:
const Definition *m_container;
std::unique_ptr<MemberList> memberList; // list of all members in the group
MemberList *inDeclSection = 0;
int grpId = 0;
QCString grpHeader;
QCString fileName; // base name of the generated file
QCString doc;
bool inSameSection = true;
QCString m_docFile;
int m_docLine;
RefItemVector m_xrefListItems;
};
class MemberGroupRefList : public std::vector<MemberGroup *>
{
};
class MemberGroupList : public std::vector< std::unique_ptr<MemberGroup> >
{
};
/** Data collected for a member group */
struct MemberGroupInfo
{
void setRefItems(const RefItemVector &sli);
QCString header;
QCString doc;
QCString docFile;
int docLine = -1;
QCString compoundName;
RefItemVector m_sli;
};
using MemberGroupInfoMap = std::unordered_map< int,std::unique_ptr<MemberGroupInfo> >;
#endif
|
