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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
|
/******************************************************************************
*
*
*
* 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.
*
*/
#ifndef DEFINITIONIMPL_H
#define DEFINITIONIMPL_H
#include <unordered_map>
#include <string>
#include "definition.h"
class DefinitionImpl
{
public:
DefinitionImpl(
Definition *def,
const char *defFileName,int defLine,int defColumn,
const char *name,const char *b=0,const char *d=0,
bool isSymbol=TRUE);
virtual ~DefinitionImpl();
QCString name() const;
bool isAnonymous() const;
QCString localName() const;
QCString qualifiedName() const;
QCString symbolName() const;
QCString getSourceFileBase() const;
QCString getSourceAnchor() const;
QCString documentation() const;
int docLine() const;
QCString docFile() const;
QCString briefDescription(bool abbreviate=FALSE) const;
QCString briefDescriptionAsTooltip() const;
int briefLine() const;
QCString inbodyDocumentation() const;
QCString inbodyFile() const;
int inbodyLine() const;
QCString briefFile() const;
QCString getDefFileName() const;
QCString getDefFileExtension() const;
int getDefLine() const;
int getDefColumn() const;
bool hasDocumentation() const;
bool hasUserDocumentation() const;
bool isVisibleInProject() const;
bool isVisible() const;
bool isHidden() const;
bool isArtificial() const;
QCString getReference() const;
bool isReference() const;
QCString externalReference(const QCString &relPath) const;
int getStartDefLine() const;
int getStartBodyLine() const;
int getEndBodyLine() const;
FileDef *getBodyDef() const;
SrcLangExt getLanguage() const;
const GroupList &partOfGroups() const;
bool isLinkableViaGroup() const;
const RefItemVector &xrefListItems() const;
const Definition *findInnerCompound(const char *name) const;
Definition *getOuterScope() const;
std::vector<const MemberDef *> getReferencesMembers() const;
std::vector<const MemberDef *> getReferencedByMembers() const;
bool hasSections() const;
bool hasSources() const;
bool hasBriefDescription() const;
QCString id() const;
const SectionRefs &getSectionRefs() const;
void setName(const char *name);
void setId(const char *name);
void setDefFile(const QCString& df,int defLine,int defColumn);
void setDocumentation(const char *d,const char *docFile,int docLine,bool stripWhiteSpace=TRUE);
void setBriefDescription(const char *b,const char *briefFile,int briefLine);
void setInbodyDocumentation(const char *d,const char *docFile,int docLine);
void setReference(const char *r);
void addSectionsToDefinition(const std::vector<const SectionInfo*> &anchorList);
void setBodySegment(int defLine,int bls,int ble);
void setBodyDef(FileDef *fd);
void addSourceReferencedBy(const MemberDef *d);
void addSourceReferences(const MemberDef *d);
void setRefItems(const RefItemVector &sli);
void mergeRefItems(Definition *d);
void mergeReferences(const Definition *other);
void mergeReferencedBy(const Definition *other);
void addInnerCompound(const Definition *d);
void setOuterScope(Definition *d);
void setHidden(bool b);
void setArtificial(bool b);
void setLanguage(SrcLangExt lang);
void writeSourceDef(OutputList &ol,const char *scopeName) const;
void writeInlineCode(OutputList &ol,const char *scopeName) const;
void writeSourceRefs(OutputList &ol,const char *scopeName) const;
void writeSourceReffedBy(OutputList &ol,const char *scopeName) const;
void makePartOfGroup(const GroupDef *gd);
void writeNavigationPath(OutputList &ol) const;
QCString navigationPathAsString() const;
void writeQuickMemberLinks(OutputList &,const MemberDef *) const;
void writeSummaryLinks(OutputList &) const;
QCString pathFragment() const;
void writeDocAnchorsToTagFile(FTextStream &) const;
void setLocalName(const QCString name);
void addSectionsToIndex();
void writeToc(OutputList &ol, const LocalToc <) const;
void setCookie(Definition::Cookie *cookie) const;
Definition::Cookie *cookie() const;
void computeTooltip();
void _setSymbolName(const QCString &name);
QCString _symbolName() const;
DefinitionImpl(const DefinitionImpl &d);
private:
int _getXRefListId(const char *listName) const;
void _writeSourceRefList(OutputList &ol,const char *scopeName,const QCString &text,
const std::unordered_map<std::string,const MemberDef *> &members,bool) const;
void _setBriefDescription(const char *b,const char *briefFile,int briefLine);
void _setDocumentation(const char *d,const char *docFile,int docLine,bool stripWhiteSpace,bool atTop);
void _setInbodyDocumentation(const char *d,const char *docFile,int docLine);
bool _docsAlreadyAdded(const QCString &doc,QCString &sigList);
// PIMPL idiom
class IMPL;
IMPL *m_impl; // internal structure holding all private data
};
template<class Base>
class DefinitionMixin : public Base
{
public:
/*! Create a new definition */
DefinitionMixin(
const char *defFileName,int defLine,int defColumn,
const char *name,const char *b=0,const char *d=0,
bool isSymbol=TRUE) : m_impl(this,defFileName,defLine,defColumn,name,b,d,isSymbol) {}
virtual ~DefinitionMixin() {}
virtual bool isAlias() const { return FALSE; }
//======== Definition
virtual QCString name() const { return m_impl.name(); }
virtual bool isAnonymous() const { return m_impl.isAnonymous(); }
virtual QCString localName() const { return m_impl.localName(); }
virtual QCString qualifiedName() const { return m_impl.qualifiedName(); }
virtual QCString symbolName() const { return m_impl.symbolName(); }
virtual QCString getSourceFileBase() const { return m_impl.getSourceFileBase(); }
virtual QCString getSourceAnchor() const { return m_impl.getSourceAnchor(); }
virtual QCString documentation() const { return m_impl.documentation(); }
virtual int docLine() const { return m_impl.docLine(); }
virtual QCString docFile() const { return m_impl.docFile(); }
virtual QCString briefDescription(bool abbreviate=FALSE) const { return m_impl.briefDescription(abbreviate); }
virtual QCString briefDescriptionAsTooltip() const { return m_impl.briefDescriptionAsTooltip(); }
virtual int briefLine() const { return m_impl.briefLine(); }
virtual QCString inbodyDocumentation() const { return m_impl.inbodyDocumentation(); }
virtual QCString inbodyFile() const { return m_impl.inbodyFile(); }
virtual int inbodyLine() const { return m_impl.inbodyLine(); }
virtual QCString briefFile() const { return m_impl.briefFile(); }
virtual QCString getDefFileName() const { return m_impl.getDefFileName(); }
virtual QCString getDefFileExtension() const { return m_impl.getDefFileExtension(); }
virtual int getDefLine() const { return m_impl.getDefLine(); }
virtual int getDefColumn() const { return m_impl.getDefColumn(); }
virtual bool hasDocumentation() const { return m_impl.hasDocumentation(); }
virtual bool hasUserDocumentation() const { return m_impl.hasUserDocumentation(); }
virtual bool isVisibleInProject() const { return m_impl.isVisibleInProject(); }
virtual bool isVisible() const { return m_impl.isVisible(); }
virtual bool isHidden() const { return m_impl.isHidden(); }
virtual bool isArtificial() const { return m_impl.isArtificial(); }
virtual QCString getReference() const { return m_impl.getReference(); }
virtual bool isReference() const { return m_impl.isReference(); }
virtual QCString externalReference(const QCString &relPath) const { return m_impl.externalReference(relPath); }
virtual int getStartDefLine() const { return m_impl.getStartDefLine(); }
virtual int getStartBodyLine() const { return m_impl.getStartBodyLine(); }
virtual int getEndBodyLine() const { return m_impl.getEndBodyLine(); }
virtual FileDef *getBodyDef() const { return m_impl.getBodyDef(); }
virtual SrcLangExt getLanguage() const { return m_impl.getLanguage(); }
virtual const GroupList &partOfGroups() const { return m_impl.partOfGroups(); }
virtual bool isLinkableViaGroup() const { return m_impl.isLinkableViaGroup(); }
virtual const RefItemVector &xrefListItems() const { return m_impl.xrefListItems(); }
virtual const Definition *findInnerCompound(const char *name) const { return m_impl.findInnerCompound(name); }
virtual Definition *getOuterScope() const { return m_impl.getOuterScope(); }
virtual std::vector<const MemberDef *> getReferencesMembers() const { return m_impl.getReferencesMembers(); }
virtual std::vector<const MemberDef *> getReferencedByMembers() const { return m_impl.getReferencedByMembers(); }
virtual bool hasSections() const { return m_impl.hasSections(); }
virtual bool hasSources() const { return m_impl.hasSources(); }
virtual bool hasBriefDescription() const { return m_impl.hasBriefDescription(); }
virtual QCString id() const { return m_impl.id(); }
virtual const SectionRefs &getSectionRefs() const { return m_impl.getSectionRefs(); }
//======== DefinitionMutable
virtual void setName(const char *name) { m_impl.setName(name); }
virtual void setId(const char *name) { m_impl.setId(name); }
virtual void setDefFile(const QCString& df,int defLine,int defColumn)
{ m_impl.setDefFile(df,defLine,defColumn); }
virtual void setDocumentation(const char *doc,const char *docFile,int docLine,bool stripWhiteSpace=TRUE)
{ m_impl.setDocumentation(doc,docFile,docLine,stripWhiteSpace); }
virtual void setBriefDescription(const char *brief,const char *briefFile,int briefLine)
{ m_impl.setBriefDescription(brief,briefFile,briefLine); }
virtual void setInbodyDocumentation(const char *doc,const char *docFile,int docLine)
{ m_impl.setInbodyDocumentation(doc,docFile,docLine); }
virtual void setReference(const char *r)
{ m_impl.setReference(r); }
virtual void addSectionsToDefinition(const std::vector<const SectionInfo*> &anchorList)
{ m_impl.addSectionsToDefinition(anchorList); }
virtual void setBodySegment(int defLine,int bls,int ble)
{ m_impl.setBodySegment(defLine,bls,ble); }
virtual void setBodyDef(FileDef *fd)
{ m_impl.setBodyDef(fd); }
virtual void addSourceReferencedBy(const MemberDef *md)
{ m_impl.addSourceReferencedBy(md); }
virtual void addSourceReferences(const MemberDef *md)
{ m_impl.addSourceReferences(md); }
virtual void setRefItems(const RefItemVector &sli)
{ m_impl.setRefItems(sli); }
virtual void mergeRefItems(Definition *def)
{ m_impl.mergeRefItems(def); }
virtual void mergeReferences(const Definition *other)
{ m_impl.mergeReferences(other); }
virtual void mergeReferencedBy(const Definition *other)
{ m_impl.mergeReferencedBy(other); }
virtual void addInnerCompound(const Definition *def)
{ m_impl.addInnerCompound(def); }
virtual void setOuterScope(Definition *def)
{ m_impl.setOuterScope(def); }
virtual void setHidden(bool b)
{ m_impl.setHidden(b); }
virtual void setArtificial(bool b)
{ m_impl.setArtificial(b); }
virtual void setLanguage(SrcLangExt lang)
{ m_impl.setLanguage(lang); }
virtual void writeSourceDef(OutputList &ol,const char *scopeName) const
{ m_impl.writeSourceDef(ol,scopeName); }
virtual void writeInlineCode(OutputList &ol,const char *scopeName) const
{ m_impl.writeInlineCode(ol,scopeName); }
virtual void writeSourceRefs(OutputList &ol,const char *scopeName) const
{ m_impl.writeSourceRefs(ol,scopeName); }
virtual void writeSourceReffedBy(OutputList &ol,const char *scopeName) const
{ m_impl.writeSourceReffedBy(ol,scopeName); }
virtual void makePartOfGroup(const GroupDef *gd)
{ m_impl.makePartOfGroup(gd); }
virtual void writeNavigationPath(OutputList &ol) const
{ m_impl.writeNavigationPath(ol); }
virtual QCString navigationPathAsString() const
{ return m_impl.navigationPathAsString(); }
virtual void writeQuickMemberLinks(OutputList &ol,const MemberDef *md) const
{ m_impl.writeQuickMemberLinks(ol,md); }
virtual void writeSummaryLinks(OutputList &ol) const
{ m_impl.writeSummaryLinks(ol); }
virtual QCString pathFragment() const
{ return m_impl.pathFragment(); }
virtual void writeDocAnchorsToTagFile(FTextStream &fs) const
{ m_impl.writeDocAnchorsToTagFile(fs); }
virtual void setLocalName(const QCString name)
{ m_impl.setLocalName(name); }
virtual void addSectionsToIndex()
{ m_impl.addSectionsToIndex(); }
virtual void writeToc(OutputList &ol, const LocalToc <) const
{ m_impl.writeToc(ol,lt); }
virtual void setCookie(Definition::Cookie *cookie) const
{ m_impl.setCookie(cookie); }
virtual Definition::Cookie *cookie() const
{ return m_impl.cookie(); }
virtual void computeTooltip()
{ m_impl.computeTooltip(); }
virtual void _setSymbolName(const QCString &name)
{ m_impl._setSymbolName(name); }
virtual QCString _symbolName() const
{ return m_impl._symbolName(); }
protected:
DefinitionMixin(const DefinitionMixin &def) = default;
private:
virtual Definition *toDefinition_() { return this; }
virtual DefinitionMutable *toDefinitionMutable_() { return this; }
virtual const DefinitionImpl *toDefinitionImpl_() const { return &m_impl; }
DefinitionImpl m_impl;
};
class DefinitionAliasImpl
{
public:
DefinitionAliasImpl(Definition *def,const Definition *scope,const Definition *alias);
virtual ~DefinitionAliasImpl();
void init();
void deinit();
QCString name() const;
QCString qualifiedName() const;
private:
Definition *m_def;
const Definition *m_scope;
QCString m_symbolName;
QCString m_qualifiedName;
};
template<class Base>
class DefinitionAliasMixin : public Base
{
public:
DefinitionAliasMixin(const Definition *scope,const Definition *alias)
: m_impl(this,scope,alias), m_scope(scope), m_alias(alias), m_cookie(0) {}
void init() { m_impl.init(); }
void deinit() { m_impl.deinit(); }
virtual ~DefinitionAliasMixin() = default;
virtual bool isAlias() const { return TRUE; }
//======== Definition
virtual QCString name() const
{ return m_impl.name(); }
virtual bool isAnonymous() const
{ return m_alias->isAnonymous(); }
virtual QCString localName() const
{ return m_alias->localName(); }
virtual QCString qualifiedName() const
{ return m_impl.qualifiedName(); }
virtual QCString symbolName() const
{ return m_alias->symbolName(); }
virtual QCString getSourceFileBase() const
{ return m_alias->getSourceFileBase(); }
virtual QCString getSourceAnchor() const
{ return m_alias->getSourceAnchor(); }
virtual QCString documentation() const
{ return m_alias->documentation(); }
virtual int docLine() const
{ return m_alias->docLine(); }
virtual QCString docFile() const
{ return m_alias->docFile(); }
virtual QCString briefDescription(bool abbreviate=FALSE) const
{ return m_alias->briefDescription(abbreviate); }
virtual QCString briefDescriptionAsTooltip() const
{ return m_alias->briefDescriptionAsTooltip(); }
virtual int briefLine() const
{ return m_alias->briefLine(); }
virtual QCString inbodyDocumentation() const
{ return m_alias->inbodyDocumentation(); }
virtual QCString inbodyFile() const
{ return m_alias->inbodyFile(); }
virtual int inbodyLine() const
{ return m_alias->inbodyLine(); }
virtual QCString briefFile() const
{ return m_alias->briefFile(); }
virtual QCString getDefFileName() const
{ return m_alias->getDefFileName(); }
virtual QCString getDefFileExtension() const
{ return m_alias->getDefFileExtension(); }
virtual int getDefLine() const
{ return m_alias->getDefLine(); }
virtual int getDefColumn() const
{ return m_alias->getDefColumn(); }
virtual bool hasDocumentation() const
{ return m_alias->hasDocumentation(); }
virtual bool hasUserDocumentation() const
{ return m_alias->hasUserDocumentation(); }
virtual bool isVisibleInProject() const
{ return m_alias->isVisibleInProject(); }
virtual bool isVisible() const
{ return m_alias->isVisible(); }
virtual bool isHidden() const
{ return m_alias->isHidden(); }
virtual bool isArtificial() const
{ return m_alias->isArtificial(); }
virtual QCString getReference() const
{ return m_alias->getReference(); }
virtual bool isReference() const
{ return m_alias->isReference(); }
virtual QCString externalReference(const QCString &relPath) const
{ return m_alias->externalReference(relPath); }
virtual int getStartDefLine() const
{ return m_alias->getStartDefLine(); }
virtual int getStartBodyLine() const
{ return m_alias->getStartBodyLine(); }
virtual int getEndBodyLine() const
{ return m_alias->getEndBodyLine(); }
virtual FileDef *getBodyDef() const
{ return m_alias->getBodyDef(); }
virtual SrcLangExt getLanguage() const
{ return m_alias->getLanguage(); }
virtual const GroupList &partOfGroups() const
{ return m_alias->partOfGroups(); }
virtual bool isLinkableViaGroup() const
{ return m_alias->isLinkableViaGroup(); }
virtual const RefItemVector &xrefListItems() const
{ return m_alias->xrefListItems(); }
virtual const Definition *findInnerCompound(const char *name) const
{ return m_alias->findInnerCompound(name); }
virtual Definition *getOuterScope() const
{ return const_cast<Definition*>(m_scope); }
virtual std::vector<const MemberDef *> getReferencesMembers() const
{ return m_alias->getReferencesMembers(); }
virtual std::vector<const MemberDef *> getReferencedByMembers() const
{ return m_alias->getReferencedByMembers(); }
virtual bool hasSections() const
{ return m_alias->hasSections(); }
virtual bool hasSources() const
{ return m_alias->hasSources(); }
virtual bool hasBriefDescription() const
{ return m_alias->hasBriefDescription(); }
virtual QCString id() const
{ return m_alias->id(); }
virtual const SectionRefs &getSectionRefs() const
{ return m_alias->getSectionRefs(); }
virtual QCString navigationPathAsString() const
{ return m_alias->navigationPathAsString(); }
virtual QCString pathFragment() const
{ return m_alias->pathFragment(); }
protected:
const Definition *getAlias() const { return m_alias; }
const Definition *getScope() const { return m_scope; }
private:
virtual Definition *toDefinition_() { return this; }
virtual DefinitionMutable *toDefinitionMutable_() { return 0; }
virtual const DefinitionImpl *toDefinitionImpl_() const { return 0; }
virtual void setCookie(Definition::Cookie *cookie) const { delete m_cookie; m_cookie = cookie; }
virtual Definition::Cookie *cookie() const { return m_cookie; }
virtual void _setSymbolName(const QCString &name) { m_symbolName = name; }
virtual QCString _symbolName() const { return m_symbolName; }
DefinitionAliasImpl m_impl;
const Definition *m_scope;
const Definition *m_alias;
mutable Definition::Cookie *m_cookie;
QCString m_symbolName;
};
#endif
|
