/
memberdef.h
470 lines (388 loc) · 19.3 KB
/
memberdef.h
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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
/******************************************************************************
*
*
*
* 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 MEMBERDEF_H
#define MEMBERDEF_H
#include <vector>
#include <memory>
#include <sys/types.h>
#include "types.h"
#include "definition.h"
#include "arguments.h"
#include "classdef.h"
class NamespaceDef;
class GroupDef;
class FileDef;
class MemberList;
class MemberGroup;
class ExampleList;
class OutputList;
class GroupDef;
struct TagInfo;
class MemberDefMutable;
class MemberGroupList;
class MemberVector;
class ModuleDef;
/** A model of a class/file/namespace member symbol. */
class MemberDef : public Definition
{
public:
virtual DefType definitionType() const = 0;
// move this member into a different scope
virtual std::unique_ptr<MemberDef> deepCopy() const =0;
virtual void moveTo(Definition *) = 0;
virtual MemberDef *resolveAlias() = 0;
virtual const MemberDef *resolveAlias() const = 0;
//-----------------------------------------------------------------------------------
// ---- getters -----
//-----------------------------------------------------------------------------------
// link id
virtual QCString getOutputFileBase() const = 0;
virtual QCString getReference() const = 0;
virtual QCString anchor() const = 0;
virtual QCString declaration() const = 0;
virtual QCString definition() const = 0;
virtual QCString typeString() const = 0;
virtual QCString argsString() const = 0;
virtual QCString excpString() const = 0;
virtual QCString bitfieldString() const = 0;
virtual QCString extraTypeChars() const = 0;
virtual const QCString &initializer() const = 0;
virtual int initializerLines() const = 0;
virtual TypeSpecifier getMemberSpecifiers() const = 0;
virtual VhdlSpecifier getVhdlSpecifiers() const = 0;
virtual const MemberList *getSectionList(const Definition *container) const = 0;
virtual QCString displayDefinition() const = 0;
// scope query members
virtual const FileDef * getFileDef() const = 0;
virtual FileDef * getFileDef() = 0;
virtual const ClassDef * getClassDef() const = 0;
virtual ClassDef * getClassDef() = 0;
virtual const NamespaceDef* getNamespaceDef() const = 0;
virtual NamespaceDef* getNamespaceDef() = 0;
virtual const ModuleDef* getModuleDef() const = 0;
virtual const ClassDef *accessorClass() const = 0;
// grabbing the property read/write accessor names
virtual QCString getReadAccessor() const = 0;
virtual QCString getWriteAccessor() const = 0;
// querying the grouping definition
virtual const GroupDef *getGroupDef() const = 0;
virtual Grouping::GroupPri_t getGroupPri() const = 0;
virtual QCString getGroupFileName() const = 0;
virtual int getGroupStartLine() const = 0;
virtual bool getGroupHasDocs() const = 0;
virtual QCString qualifiedName() const = 0;
virtual QCString objCMethodName(bool localLink,bool showStatic) const = 0;
// direct kind info
virtual Protection protection() const = 0;
virtual Specifier virtualness(int count=0) const = 0;
virtual MemberType memberType() const = 0;
virtual QCString memberTypeName() const = 0;
// getter methods
virtual bool isSignal() const = 0;
virtual bool isSlot() const = 0;
virtual bool isVariable() const = 0;
virtual bool isEnumerate() const = 0;
virtual bool isEnumValue() const = 0;
virtual bool isTypedef() const = 0;
virtual bool isSequence() const = 0;
virtual bool isDictionary() const = 0;
virtual bool isFunction() const = 0;
virtual bool isFunctionPtr() const = 0;
virtual bool isDefine() const = 0;
virtual bool isFriend() const = 0;
virtual bool isDCOP() const = 0;
virtual bool isProperty() const = 0;
virtual bool isEvent() const = 0;
virtual bool isRelated() const = 0;
virtual bool isForeign() const = 0;
virtual bool isStatic() const = 0;
virtual bool isInline() const = 0;
virtual bool isExplicit() const = 0;
virtual bool isMutable() const = 0;
virtual bool isGettable() const = 0;
virtual bool isPrivateGettable() const = 0;
virtual bool isProtectedGettable() const = 0;
virtual bool isSettable() const = 0;
virtual bool isPrivateSettable() const = 0;
virtual bool isProtectedSettable() const = 0;
virtual bool isReadable() const = 0;
virtual bool isWritable() const = 0;
virtual bool isAddable() const = 0;
virtual bool isRemovable() const = 0;
virtual bool isRaisable() const = 0;
virtual bool isFinal() const = 0;
virtual bool isAbstract() const = 0;
virtual bool isOverride() const = 0;
virtual bool isInitonly() const = 0;
virtual bool isOptional() const = 0;
virtual bool isRequired() const = 0;
virtual bool isNonAtomic() const = 0;
virtual bool isCopy() const = 0;
virtual bool isAssign() const = 0;
virtual bool isRetain() const = 0;
virtual bool isWeak() const = 0;
virtual bool isStrong() const = 0;
virtual bool isEnumStruct() const = 0;
virtual bool isUnretained() const = 0;
virtual bool isNew() const = 0;
virtual bool isSealed() const = 0;
virtual bool isImplementation() const = 0;
virtual bool isExternal() const = 0;
virtual bool isTypeAlias() const = 0;
virtual bool isDefault() const = 0;
virtual bool isDelete() const = 0;
virtual bool isNoExcept() const = 0;
virtual bool isAttribute() const = 0; // UNO IDL attribute
virtual bool isUNOProperty() const = 0; // UNO IDL property
virtual bool isReadonly() const = 0;
virtual bool isBound() const = 0;
virtual bool isConstrained() const = 0;
virtual bool isTransient() const = 0;
virtual bool isMaybeVoid() const = 0;
virtual bool isMaybeDefault() const = 0;
virtual bool isMaybeAmbiguous() const = 0;
virtual bool isPublished() const = 0; // UNO IDL published
virtual bool isTemplateSpecialization() const = 0;
virtual bool isObjCMethod() const = 0;
virtual bool isObjCProperty() const = 0;
virtual bool isCSharpProperty() const = 0;
virtual bool isConstructor() const = 0;
virtual bool isDestructor() const = 0;
virtual bool hasOneLineInitializer() const = 0;
virtual bool hasMultiLineInitializer() const = 0;
virtual bool isCallable() const = 0;
virtual bool isStrongEnumValue() const = 0;
virtual bool livesInsideEnum() const = 0;
virtual bool isSliceLocal() const = 0;
virtual bool isConstExpr() const = 0;
virtual int numberOfFlowKeyWords() const = 0;
// derived getters
virtual bool isFriendToHide() const = 0;
virtual bool isNotFriend() const = 0;
virtual bool isFunctionOrSignalSlot() const = 0;
virtual bool isRelatedOrFriend() const = 0;
// output info
virtual bool isLinkableInProject() const = 0;
virtual bool isLinkable() const = 0;
virtual bool hasDocumentation() const = 0; // overrides hasDocumentation in definition.h
//bool hasUserDocumentation() const = 0; // overrides hasUserDocumentation
virtual bool isDeleted() const = 0;
virtual bool isBriefSectionVisible() const = 0;
virtual bool isDetailedSectionVisible(MemberListContainer container) const = 0;
virtual bool hasDetailedDescription() const = 0;
virtual bool isFriendClass() const = 0;
virtual bool isDocumentedFriendClass() const = 0;
virtual const MemberDef *reimplements() const = 0;
virtual const MemberVector &reimplementedBy() const = 0;
virtual bool isReimplementedBy(const ClassDef *cd) const = 0;
virtual ClassDef *relatedAlso() const = 0;
virtual bool hasDocumentedEnumValues() const = 0;
virtual const MemberDef *getAnonymousEnumType() const = 0;
virtual bool isDocsForDefinition() const = 0;
virtual const MemberDef *getEnumScope() const = 0;
virtual const MemberVector &enumFieldList() const = 0;
virtual QCString enumBaseType() const = 0;
virtual bool hasExamples() const = 0;
virtual const ExampleList &getExamples() const = 0;
virtual bool isPrototype() const = 0;
// argument related members
virtual const ArgumentList &argumentList() const = 0;
virtual const ArgumentList &declArgumentList() const = 0;
virtual const ArgumentList &templateArguments() const = 0;
virtual const ArgumentLists &definitionTemplateParameterLists() const = 0;
// member group related members
virtual int getMemberGroupId() const = 0;
virtual MemberGroup *getMemberGroup() const = 0;
virtual bool fromAnonymousScope() const = 0;
virtual MemberDef *fromAnonymousMember() const = 0;
// callgraph related members
virtual bool hasCallGraph() const = 0;
virtual bool hasCallerGraph() const = 0;
// referenced related members
virtual bool hasReferencesRelation() const = 0;
virtual bool hasReferencedByRelation() const = 0;
virtual const MemberDef *templateMaster() const = 0;
virtual QCString getScopeString() const = 0;
virtual ClassDef *getClassDefOfAnonymousType() const = 0;
// cached typedef functions
virtual bool isTypedefValCached() const = 0;
virtual const ClassDef *getCachedTypedefVal() const = 0;
virtual QCString getCachedTypedefTemplSpec() const = 0;
virtual QCString getCachedResolvedTypedef() const = 0;
virtual MemberDef *memberDefinition() const = 0;
virtual MemberDef *memberDeclaration() const = 0;
virtual const MemberDef *inheritsDocsFrom() const = 0;
virtual const MemberDef *getGroupAlias() const = 0;
virtual ClassDef *category() const = 0;
virtual const MemberDef *categoryRelation() const = 0;
virtual QCString displayName(bool=TRUE) const = 0;
virtual QCString getDeclType() const = 0;
virtual StringVector getLabels(const Definition *container) const = 0;
virtual StringVector getQualifiers() const = 0;
virtual const ArgumentList &typeConstraints() const = 0;
virtual QCString requiresClause() const = 0;
// overrules
virtual QCString documentation() const = 0;
virtual QCString briefDescription(bool abbr=FALSE) const = 0;
virtual QCString fieldType() const = 0;
virtual bool isReference() const = 0;
virtual QCString getDeclFileName() const = 0;
virtual int getDeclLine() const = 0;
virtual int getDeclColumn() const = 0;
virtual std::unique_ptr<MemberDef> createTemplateInstanceMember(const ArgumentList &formalArgs,
const std::unique_ptr<ArgumentList> &actualArgs) const = 0;
virtual void writeDeclaration(OutputList &ol,
const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *md,
bool inGroup, int indentLevel=0, const ClassDef *inheritFrom=0,const QCString &inheritId=QCString()) const = 0;
virtual void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd,
const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod) const = 0;
virtual void writeLink(OutputList &ol,
const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *md,
bool onlyText=FALSE) const = 0;
virtual void detectUndocumentedParams(bool hasParamCommand,bool hasReturnCommand) const = 0;
virtual void warnIfUndocumented() const = 0;
virtual void warnIfUndocumentedParams() const = 0;
virtual bool visibleInIndex() const = 0;
// TODO: this is not a getter, should be passed at construction
virtual void setMemberGroup(MemberGroup *grp) = 0;
};
class MemberDefMutable : public DefinitionMutable, public MemberDef
{
public:
//-----------------------------------------------------------------------------------
// ---- setters -----
//-----------------------------------------------------------------------------------
// set functions
virtual void setMemberType(MemberType t) = 0;
virtual void setDefinition(const QCString &d) = 0;
virtual void setFileDef(FileDef *fd) = 0;
virtual void setAnchor() = 0;
virtual void setProtection(Protection p) = 0;
virtual void setMemberSpecifiers(TypeSpecifier s) = 0;
virtual void setVhdlSpecifiers(VhdlSpecifier s) = 0;
virtual void mergeMemberSpecifiers(TypeSpecifier s) = 0;
virtual void setInitializer(const QCString &i) = 0;
virtual void setBitfields(const QCString &s) = 0;
virtual void setMaxInitLines(int lines) = 0;
virtual void setMemberClass(ClassDef *cd) = 0;
virtual void setSectionList(const Definition *container,const MemberList *sl) = 0;
virtual void setGroupDef(const GroupDef *gd,Grouping::GroupPri_t pri,
const QCString &fileName,int startLine,bool hasDocs,
MemberDef *member=0) = 0;
virtual void setReadAccessor(const QCString &r) = 0;
virtual void setWriteAccessor(const QCString &w) = 0;
virtual void setTemplateSpecialization(bool b) = 0;
virtual void makeRelated() = 0;
virtual void makeForeign() = 0;
virtual void setInheritsDocsFrom(const MemberDef *md) = 0;
virtual void setTagInfo(const TagInfo *i) = 0;
virtual void setArgsString(const QCString &as) = 0;
virtual void incrementFlowKeyWordCount() = 0;
virtual void setEnumBaseType(const QCString &type) = 0;
// relation to other members
virtual void setReimplements(MemberDef *md) = 0;
virtual void insertReimplementedBy(MemberDef *md) = 0;
virtual void setRelatedAlso(ClassDef *cd) = 0;
// enumeration specific members
virtual void insertEnumField(MemberDef *md) = 0;
virtual void setEnumScope(const MemberDef *md,bool livesInsideEnum=FALSE) = 0;
virtual void setEnumClassScope(ClassDef *cd) = 0;
virtual void setDocumentedEnumValues(bool value) = 0;
virtual void setAnonymousEnumType(const MemberDef *md) = 0;
// example related members
virtual bool addExample(const QCString &anchor,const QCString &name,const QCString &file) = 0;
// prototype related members
virtual void setPrototype(bool p,const QCString &df,int line, int column) = 0;
virtual void setExplicitExternal(bool b,const QCString &df,int line,int column) = 0;
virtual void setDeclFile(const QCString &df,int line,int column) = 0;
// argument related members
virtual void moveArgumentList(std::unique_ptr<ArgumentList> al) = 0;
virtual void moveDeclArgumentList(std::unique_ptr<ArgumentList> al) = 0;
virtual void resolveUnnamedParameters(const MemberDef *md) = 0;
virtual void setDefinitionTemplateParameterLists(const ArgumentLists &lists) = 0;
virtual void setTypeConstraints(const ArgumentList &al) = 0;
virtual void setType(const QCString &t) = 0;
virtual void setAccessorType(ClassDef *cd,const QCString &t) = 0;
// namespace related members
virtual void setNamespace(NamespaceDef *nd) = 0;
// member group related members
virtual void setMemberGroupId(int id) = 0;
virtual void makeImplementationDetail() = 0;
// anonymous scope members
virtual void setFromAnonymousMember(MemberDef *m) = 0;
virtual void enableCallGraph(bool e) = 0;
virtual void mergeEnableCallGraph(bool other) = 0;
virtual void enableCallerGraph(bool e) = 0;
virtual void mergeEnableCallerGraph(bool other) = 0;
virtual void enableReferencedByRelation(bool e) = 0;
virtual void mergeEnableReferencedByRelation(bool other) = 0;
virtual void enableReferencesRelation(bool e) = 0;
virtual void mergeEnableReferencesRelation(bool other) = 0;
virtual void setTemplateMaster(MemberDef *mt) = 0;
virtual void addListReference(Definition *d) = 0;
virtual void setDocsForDefinition(bool b) = 0;
virtual void setGroupAlias(const MemberDef *md) = 0;
virtual void cacheTypedefVal(const ClassDef *val,const QCString &templSpec,const QCString &resolvedType) = 0;
virtual void invalidateTypedefValCache() = 0;
virtual void invalidateCachedArgumentTypes() = 0;
// declaration <-> definition relation
virtual void setMemberDefinition(MemberDef *md) = 0;
virtual void setMemberDeclaration(MemberDef *md) = 0;
virtual void copyArgumentNames(const MemberDef *bmd) = 0;
virtual void setCategory(ClassDef *) = 0;
virtual void setCategoryRelation(const MemberDef *) = 0;
virtual void setDocumentation(const QCString &d,const QCString &docFile,int docLine,bool stripWhiteSpace=TRUE) = 0;
virtual void setBriefDescription(const QCString &b,const QCString &briefFile,int briefLine) = 0;
virtual void setInbodyDocumentation(const QCString &d,const QCString &inbodyFile,int inbodyLine) = 0;
virtual void setHidden(bool b) = 0;
virtual void setRequiresClause(const QCString &req) = 0;
virtual void addQualifiers(const StringVector &qualifiers) = 0;
virtual void setModuleDef(ModuleDef *mod) = 0;
//-----------------------------------------------------------------------------------
// --- actions ----
//-----------------------------------------------------------------------------------
virtual void findSectionsInDocumentation() = 0;
//virtual void addToSearchIndex() const = 0;
virtual ClassDefMutable *getClassDefMutable() = 0;
//-----------------------------------------------------------------------------------
// --- write output ----
//-----------------------------------------------------------------------------------
virtual void writeDocumentation(const MemberList *ml,int memCount,int memTotal,OutputList &ol,
const QCString &scopeName,const Definition *container,
bool inGroup,bool showEnumValues=FALSE,bool
showInline=FALSE) const = 0;
virtual void writeMemberDocSimple(OutputList &ol,const Definition *container) const = 0;
virtual void writeTagFile(TextStream &,bool useQualifiedName,bool showNamespaceMembers) const = 0;
// write helpers
virtual void setFromAnonymousScope(bool b) = 0;
};
// --- Cast functions
MemberDef *toMemberDef(Definition *d);
MemberDef *toMemberDef(DefinitionMutable *d);
const MemberDef *toMemberDef(const Definition *d);
MemberDefMutable *toMemberDefMutable(Definition *d);
//------------------------------------------------------------------------
/** Factory method to create a new instance of a MemberDef */
std::unique_ptr<MemberDef> createMemberDef(const QCString &defFileName,int defLine,int defColumn,
const QCString &type,const QCString &name,const QCString &args,
const QCString &excp,Protection prot,Specifier virt,bool stat,
Relationship related,MemberType t,const ArgumentList &tal,
const ArgumentList &al,const QCString &metaData);
std::unique_ptr<MemberDef> createMemberDefAlias(const Definition *newScope,const MemberDef *aliasMd);
void combineDeclarationAndDefinition(MemberDefMutable *mdec,MemberDefMutable *mdef);
void addDocCrossReference(const MemberDef *src,const MemberDef *dst);
#endif