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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
/******************************************************************************
*
*
*
* 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.
*
*/
/*! \file
* This class represents a list of output generators that work in "parallel".
* The class only knows about the abstract base class OutputGenerators.
* All output is produced by calling a method of this class, which forwards
* the call to all output generators.
*/
#include "outputlist.h"
#include "outputgen.h"
#include "config.h"
#include "message.h"
#include "definition.h"
#include "docparser.h"
#include "vhdldocgen.h"
OutputList::OutputList(bool)
{
//printf("OutputList::OutputList()\n");
m_outputs.setAutoDelete(TRUE);
}
OutputList::~OutputList()
{
//printf("OutputList::~OutputList()\n");
}
void OutputList::add(const OutputGenerator *og)
{
if (og) m_outputs.append(og);
}
void OutputList::disableAllBut(OutputGenerator::OutputType o)
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->disableIfNot(o);
}
}
void OutputList::enableAll()
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->enable();
}
}
void OutputList::disableAll()
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->disable();
}
}
void OutputList::disable(OutputGenerator::OutputType o)
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->disableIf(o);
}
}
void OutputList::enable(OutputGenerator::OutputType o)
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->enableIf(o);
}
}
bool OutputList::isEnabled(OutputGenerator::OutputType o)
{
bool result=FALSE;
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
result=result || og->isEnabled(o);
}
return result;
}
void OutputList::pushGeneratorState()
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->pushGeneratorState();
}
}
void OutputList::popGeneratorState()
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
og->popGeneratorState();
}
}
void OutputList::generateDoc(const char *fileName,int startLine,
const Definition *ctx,const MemberDef * md,
const QCString &docStr,bool indexWords,
bool isExample,const char *exampleName,
bool singleLine,bool linkFromIndex)
{
int count=0;
if (docStr.isEmpty()) return;
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
if (og->isEnabled()) count++;
}
// we want to validate irrespective of the number of output formats
// specified as:
// - when only XML format there should be warnings as well (XML has its own write routines)
// - no formats there should be warnings as well
DocRoot *root=0;
root = validatingParseDoc(fileName,startLine,
ctx,md,docStr,indexWords,isExample,exampleName,
singleLine,linkFromIndex);
if (count>0) writeDoc(root,ctx,md);
delete root;
}
void OutputList::writeDoc(DocRoot *root,const Definition *ctx,const MemberDef *md)
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
//printf("og->printDoc(extension=%s)\n",
// ctx?ctx->getDefFileExtension().data():"<null>");
if (og->isEnabled()) og->writeDoc(root,ctx,md);
}
VhdlDocGen::setFlowMember(0);
}
void OutputList::parseText(const QCString &textStr)
{
int count=0;
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
if (og->isEnabled()) count++;
}
// we want to validate irrespective of the number of output formats
// specified as:
// - when only XML format there should be warnings as well (XML has its own write routines)
// - no formats there should be warnings as well
DocText *root = validatingParseText(textStr);
if (count>0)
{
for (it.toFirst();(og=it.current());++it)
{
if (og->isEnabled()) og->writeDoc(root,0,0);
}
}
delete root;
}
//--------------------------------------------------------------------------
// Create some overloaded definitions of the forall function.
// Using template functions here would have made it a little less
// portable (I guess).
// zero arguments
void OutputList::forall(void (OutputGenerator::*func)())
{
QListIterator<OutputGenerator> it(m_outputs);
OutputGenerator *og;
for (it.toFirst();(og=it.current());++it)
{
if (og->isEnabled()) (og->*func)();
}
}
// one argument
#define FORALL1(a1,p1) \
void OutputList::forall(void (OutputGenerator::*func)(a1),a1) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1); \
} \
}
// two arguments
#define FORALL2(a1,a2,p1,p2) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2),a1,a2) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2); \
} \
}
// three arguments
#define FORALL3(a1,a2,a3,p1,p2,p3) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3),a1,a2,a3) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3); \
} \
}
// four arguments
#define FORALL4(a1,a2,a3,a4,p1,p2,p3,p4) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4),a1,a2,a3,a4) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4); \
} \
}
// five arguments
#define FORALL5(a1,a2,a3,a4,a5,p1,p2,p3,p4,p5) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4,a5),a1,a2,a3,a4,a5) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4,p5); \
} \
}
// six arguments
#define FORALL6(a1,a2,a3,a4,a5,a6,p1,p2,p3,p4,p5,p6) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4,a5,a6),a1,a2,a3,a4,a5,a6) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4,p5,p6); \
} \
}
// seven arguments
#define FORALL7(a1,a2,a3,a4,a5,a6,a7,p1,p2,p3,p4,p5,p6,p7) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4,a5,a6,a7),a1,a2,a3,a4,a5,a6,a7) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4,p5,p6,p7); \
} \
}
// eight arguments
#define FORALL8(a1,a2,a3,a4,a5,a6,a7,a8,p1,p2,p3,p4,p5,p6,p7,p8) \
void OutputList::forall(void (OutputGenerator::*func)(a1,a2,a3,a4,a5,a6,a7,a8),a1,a2,a3,a4,a5,a6,a7,a8) \
{ \
QListIterator<OutputGenerator> it(m_outputs); \
OutputGenerator *og; \
for (it.toFirst();(og=it.current());++it) \
{ \
if (og->isEnabled()) (og->*func)(p1,p2,p3,p4,p5,p6,p7,p8); \
} \
}
// now instantiate only the ones we need.
FORALL1(const char *a1,a1)
FORALL1(char a1,a1)
FORALL1(int a1,a1)
FORALL1(DotClassGraph &a1,a1)
FORALL1(DotInclDepGraph &a1,a1)
FORALL1(DotCallGraph &a1,a1)
FORALL1(DotDirDeps &a1,a1)
FORALL1(DotGfxHierarchyTable &a1,a1)
FORALL1(DotGroupCollaboration &a1,a1)
FORALL1(SectionTypes a1,a1)
#if defined(HAS_BOOL_TYPE) || defined(Q_HAS_BOOL_TYPE)
FORALL1(bool a1,a1)
FORALL2(bool a1,int a2,a1,a2)
FORALL2(bool a1,bool a2,a1,a2)
FORALL2(const char *a1,bool a2,a1,a2)
FORALL4(const char *a1,const char *a2,const char *a3,bool a4,a1,a2,a3,a4)
#endif
FORALL2(int a1,bool a2,a1,a2)
FORALL2(bool a1,const char *a2,a1,a2)
FORALL2(ParamListTypes a1,const char *a2,a1,a2)
FORALL1(IndexSections a1,a1)
FORALL2(const char *a1,const char *a2,a1,a2)
FORALL2(const char *a1,int a2,a1,a2)
FORALL2(const char *a1,SectionInfo::SectionType a2,a1,a2)
FORALL3(bool a1,HighlightedItem a2,const char *a3,a1,a2,a3)
FORALL3(bool a1,bool a2,bool a3,a1,a2,a3)
FORALL3(const ClassDiagram &a1,const char *a2,const char *a3,a1,a2,a3)
FORALL3(const char *a1,const char *a2,const char *a3,a1,a2,a3)
FORALL3(const char *a1,const char *a2,bool a3,a1,a2,a3)
FORALL3(const char *a1,int a2,const char *a3,a1,a2,a3)
FORALL3(const char *a1,const char *a2,SectionInfo::SectionType a3,a1,a2,a3)
FORALL3(uchar a1,uchar a2,uchar a3,a1,a2,a3)
FORALL3(const Definition *a1,const char *a2,bool a3,a1,a2,a3)
FORALL4(SectionTypes a1,const char *a2,const char *a3,const char *a4,a1,a2,a3,a4)
FORALL4(const char *a1,const char *a2,const char *a3,const char *a4,a1,a2,a3,a4)
FORALL4(const char *a1,const char *a2,const char *a3,int a4,a1,a2,a3,a4)
FORALL5(const char *a1,const char *a2,const char *a3,const char *a4,const char *a5,a1,a2,a3,a4,a5)
FORALL5(const char *a1,const char *a2,const char *a3,const char *a4,bool a5,a1,a2,a3,a4,a5)
FORALL6(const char *a1,const char *a2,const char *a3,const char *a4,const char *a5,const char *a6,a1,a2,a3,a4,a5,a6)
FORALL6(const char *a1,const DocLinkInfo &a2,const char *a3,const char *a4,const SourceLinkInfo &a5,const SourceLinkInfo &a6,a1,a2,a3,a4,a5,a6)
FORALL7(const char *a1,const char *a2,const char *a3,const char *a4,int a5,int a6,bool a7,a1,a2,a3,a4,a5,a6,a7)
//--------------------------------------------------------------------------
|
