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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/******************************************************************************
*
* Copyright (C) 1997-2019 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.
*
*/
#include <atomic>
#include "doxygen.h"
#include "util.h"
#include "entry.h"
#include "message.h"
#include "docgroup.h"
static std::atomic_int g_groupId;
void DocGroup::enterFile(const QCString &fileName,int)
{
m_openCount = 0;
m_autoGroupStack.clear();
m_memberGroupId = DOX_NOGROUP;
m_memberGroupDocs.resize(0);
m_memberGroupRelates.resize(0);
m_compoundName=fileName;
}
void DocGroup::leaveFile(const QCString &fileName,int line)
{
//if (m_memberGroupId!=DOX_NOGROUP)
//{
// warn(fileName,line,"end of file while inside a member group\n");
//}
m_memberGroupId=DOX_NOGROUP;
m_memberGroupRelates.resize(0);
m_memberGroupDocs.resize(0);
if (!m_autoGroupStack.empty())
{
warn(fileName,line,"end of file while inside a group");
}
else if (m_openCount > 0) // < 0 is already handled on close call
{
warn(fileName,line,"end of file with unbalanced grouping commands");
}
}
void DocGroup::enterCompound(const QCString &fileName,int line,const QCString &name)
{
if (m_memberGroupId!=DOX_NOGROUP)
{
warn(fileName,line,"try to put compound %s inside a member group\n",qPrint(name));
}
m_memberGroupId=DOX_NOGROUP;
m_memberGroupRelates.resize(0);
m_memberGroupDocs.resize(0);
m_compoundName = name;
int i = m_compoundName.find('(');
if (i!=-1)
{
m_compoundName=m_compoundName.left(i); // strip category (Obj-C)
}
if (m_compoundName.isEmpty())
{
m_compoundName=fileName;
}
//printf("groupEnterCompound(%s)\n",name);
}
void DocGroup::leaveCompound(const QCString &,int,const QCString & /*name*/)
{
//printf("groupLeaveCompound(%s)\n",name);
//if (m_memberGroupId!=DOX_NOGROUP)
//{
// warn(fileName,line,"end of compound %s while inside a member group\n",qPrint(name));
//}
m_memberGroupId=DOX_NOGROUP;
m_memberGroupRelates.resize(0);
m_memberGroupDocs.resize(0);
m_compoundName.resize(0);
}
int DocGroup::findExistingGroup(const MemberGroupInfo *info)
{
//printf("findExistingGroup %s:%s\n",qPrint(info->header),qPrint(info->compoundName));
for (const auto &kv : Doxygen::memberGroupInfoMap)
{
if (m_compoundName==kv.second->compoundName && // same file or scope
!kv.second->header.isEmpty() && // not a nameless group
qstricmp(kv.second->header,info->header)==0 // same header name
)
{
//printf("Found it!\n");
return kv.first; // put the item in this group
}
}
return ++g_groupId; // start new group
}
void DocGroup::open(Entry *e,const QCString &,int, bool implicit)
{
if (!implicit) m_openCount++;
//printf("==> openGroup(name=%s,sec=%x) m_autoGroupStack=%d\n",
// qPrint(e->name),e->section,m_autoGroupStack.size());
if (e->section==Entry::GROUPDOC_SEC) // auto group
{
m_autoGroupStack.push_back(Grouping(e->name,e->groupingPri()));
}
else // start of a member group
{
//printf(" membergroup id=%d %s\n",m_memberGroupId,qPrint(m_memberGroupHeader));
if (m_memberGroupId==DOX_NOGROUP) // no group started yet
{
auto info = std::make_unique<MemberGroupInfo>();
info->header = m_memberGroupHeader.stripWhiteSpace();
info->compoundName = m_compoundName;
m_memberGroupId = findExistingGroup(info.get());
auto it = Doxygen::memberGroupInfoMap.find(m_memberGroupId);
if (it==Doxygen::memberGroupInfoMap.end())
{
//printf(" use membergroup %d\n",m_memberGroupId);
Doxygen::memberGroupInfoMap.insert(std::make_pair(m_memberGroupId,std::move(info)));
}
m_memberGroupRelates = e->relates;
e->mGrpId = m_memberGroupId;
}
}
}
void DocGroup::close(Entry *e,const QCString &fileName,int line,bool foundInline,bool implicit)
{
if (!implicit)
{
if (m_openCount < 1)
{
warn(fileName,line,"unbalanced grouping commands");
}
else
{
m_openCount--;
}
}
//printf("==> closeGroup(name=%s,sec=%x,file=%s,line=%d) m_autoGroupStack=%d\n",
// qPrint(e->name),e->section,fileName,line,m_autoGroupStack.size());
if (m_memberGroupId!=DOX_NOGROUP) // end of member group
{
auto it = Doxygen::memberGroupInfoMap.find(m_memberGroupId);
if (it!=Doxygen::memberGroupInfoMap.end()) // known group
{
auto &info = it->second;
info->doc = m_memberGroupDocs;
info->docFile = fileName;
info->docLine = line;
}
m_memberGroupId=DOX_NOGROUP;
m_memberGroupRelates.resize(0);
m_memberGroupDocs.resize(0);
if (!foundInline) e->mGrpId=DOX_NOGROUP;
//printf("new group id=%d\n",m_memberGroupId);
}
else if (!m_autoGroupStack.empty()) // end of auto group
{
Grouping grp = m_autoGroupStack.back();
m_autoGroupStack.pop_back();
// see bug577005: we should not remove the last group for e
if (!foundInline && !e->groups.empty()) e->groups.pop_back();
//printf("Removing %s e=%p\n",qPrint(grp->groupname),e);
if (!foundInline) initGroupInfo(e);
}
}
void DocGroup::initGroupInfo(Entry *e)
{
//printf("==> initGroup(id=%d,related=%s,e=%p)\n",m_memberGroupId,
// qPrint(m_memberGroupRelates),e);
e->mGrpId = m_memberGroupId;
e->relates = m_memberGroupRelates;
if (!m_autoGroupStack.empty())
{
//printf("Appending group %s to %s: count=%d entry=%p\n",
// qPrint(m_autoGroupStack.top()->groupname),
// qPrint(e->name),e->groups->count(),e);
e->groups.push_back(Grouping(m_autoGroupStack.back()));
}
}
void DocGroup::addDocs(Entry *e)
{
if (e->section==Entry::MEMBERGRP_SEC)
{
m_memberGroupDocs=e->brief.stripWhiteSpace();
e->doc = stripLeadingAndTrailingEmptyLines(e->doc,e->docLine);
if (!m_memberGroupDocs.isEmpty() && !e->doc.isEmpty())
{
m_memberGroupDocs+="\n\n";
}
m_memberGroupDocs+=e->doc;
auto it =Doxygen::memberGroupInfoMap.find(m_memberGroupId);
if (it!=Doxygen::memberGroupInfoMap.end())
{
auto &info = it->second;
info->doc = m_memberGroupDocs;
info->docFile = e->docFile;
info->docLine = e->docLine;
info->setRefItems(e->sli);
}
e->doc.resize(0);
e->brief.resize(0);
}
}
bool DocGroup::isEmpty() const
{
return (m_memberGroupId==DOX_NOGROUP);
}
void DocGroup::clearHeader()
{
m_memberGroupHeader.resize(0);
}
void DocGroup::appendHeader(const char text)
{
m_memberGroupHeader += text;
}
|
