-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
memberdef.cpp
6165 lines (5630 loc) · 189 KB
/
memberdef.cpp
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/******************************************************************************
*
* 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.
*
*/
#include <stdio.h>
#include <assert.h>
#include <mutex>
#include "md5.h"
#include "memberdef.h"
#include "membername.h"
#include "doxygen.h"
#include "util.h"
#include "code.h"
#include "message.h"
#include "htmlhelp.h"
#include "language.h"
#include "outputlist.h"
#include "example.h"
#include "membergroup.h"
#include "groupdef.h"
#include "defargs.h"
#include "docparser.h"
#include "dot.h"
#include "dotcallgraph.h"
#include "searchindex.h"
#include "parserintf.h"
#include "vhdldocgen.h"
#include "arguments.h"
#include "memberlist.h"
#include "namespacedef.h"
#include "filedef.h"
#include "config.h"
#include "definitionimpl.h"
#include "regex.h"
//-----------------------------------------------------------------------------
class MemberDefImpl : public DefinitionMixin<MemberDefMutable>
{
public:
MemberDefImpl(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);
virtual ~MemberDefImpl();
virtual DefType definitionType() const { return TypeMember; }
virtual MemberDef *resolveAlias() { return this; }
virtual const MemberDef *resolveAlias() const { return this; }
virtual CodeSymbolType codeSymbolType() const;
virtual MemberDef *deepCopy() const;
virtual void moveTo(Definition *);
virtual QCString getOutputFileBase() const;
virtual QCString getReference() const;
virtual QCString anchor() const;
virtual QCString declaration() const;
virtual QCString definition() const;
virtual QCString typeString() const;
virtual QCString argsString() const;
virtual QCString excpString() const;
virtual QCString bitfieldString() const;
virtual QCString extraTypeChars() const;
virtual const QCString &initializer() const;
virtual int initializerLines() const;
virtual uint64 getMemberSpecifiers() const;
virtual const MemberList *getSectionList(const Definition *) const;
virtual QCString displayDefinition() const;
virtual const ClassDef *getClassDef() const;
virtual const FileDef *getFileDef() const;
virtual const NamespaceDef* getNamespaceDef() const;
virtual const GroupDef *getGroupDef() const;
virtual ClassDef *accessorClass() const;
virtual QCString getReadAccessor() const;
virtual QCString getWriteAccessor() const;
virtual Grouping::GroupPri_t getGroupPri() const;
virtual QCString getGroupFileName() const;
virtual int getGroupStartLine() const;
virtual bool getGroupHasDocs() const;
virtual QCString qualifiedName() const;
virtual QCString objCMethodName(bool localLink,bool showStatic) const;
virtual Protection protection() const;
virtual Specifier virtualness(int count=0) const;
virtual MemberType memberType() const;
virtual QCString memberTypeName() const;
virtual bool isSignal() const;
virtual bool isSlot() const;
virtual bool isVariable() const;
virtual bool isEnumerate() const;
virtual bool isEnumValue() const;
virtual bool isTypedef() const;
virtual bool isSequence() const;
virtual bool isDictionary() const;
virtual bool isFunction() const;
virtual bool isFunctionPtr() const;
virtual bool isDefine() const;
virtual bool isFriend() const;
virtual bool isDCOP() const;
virtual bool isProperty() const;
virtual bool isEvent() const;
virtual bool isRelated() const;
virtual bool isForeign() const;
virtual bool isStatic() const;
virtual bool isInline() const;
virtual bool isExplicit() const;
virtual bool isMutable() const;
virtual bool isGettable() const;
virtual bool isPrivateGettable() const;
virtual bool isProtectedGettable() const;
virtual bool isSettable() const;
virtual bool isPrivateSettable() const;
virtual bool isProtectedSettable() const;
virtual bool isReadable() const;
virtual bool isWritable() const;
virtual bool isAddable() const;
virtual bool isRemovable() const;
virtual bool isRaisable() const;
virtual bool isFinal() const;
virtual bool isAbstract() const;
virtual bool isOverride() const;
virtual bool isInitonly() const;
virtual bool isOptional() const;
virtual bool isRequired() const;
virtual bool isNonAtomic() const;
virtual bool isCopy() const;
virtual bool isAssign() const;
virtual bool isRetain() const;
virtual bool isWeak() const;
virtual bool isStrong() const;
virtual bool isEnumStruct() const;
virtual bool isUnretained() const;
virtual bool isNew() const;
virtual bool isSealed() const;
virtual bool isImplementation() const;
virtual bool isExternal() const;
virtual bool isTypeAlias() const;
virtual bool isDefault() const;
virtual bool isDelete() const;
virtual bool isNoExcept() const;
virtual bool isAttribute() const;
virtual bool isUNOProperty() const;
virtual bool isReadonly() const;
virtual bool isBound() const;
virtual bool isConstrained() const;
virtual bool isTransient() const;
virtual bool isMaybeVoid() const;
virtual bool isMaybeDefault() const;
virtual bool isMaybeAmbiguous() const;
virtual bool isPublished() const;
virtual bool isTemplateSpecialization() const;
virtual bool isObjCMethod() const;
virtual bool isObjCProperty() const;
virtual bool isCSharpProperty() const;
virtual bool isConstructor() const;
virtual bool isDestructor() const;
virtual bool hasOneLineInitializer() const;
virtual bool hasMultiLineInitializer() const;
virtual bool showInCallGraph() const;
virtual bool isStrongEnumValue() const;
virtual bool livesInsideEnum() const;
virtual bool isSliceLocal() const;
virtual bool isConstExpr() const;
virtual int numberOfFlowKeyWords() const;
virtual bool isFriendToHide() const;
virtual bool isNotFriend() const;
virtual bool isFunctionOrSignalSlot() const;
virtual bool isRelatedOrFriend() const;
virtual bool isLinkableInProject() const;
virtual bool isLinkable() const;
virtual bool hasDocumentation() const;
virtual bool isDeleted() const;
virtual bool isBriefSectionVisible() const;
virtual bool isDetailedSectionVisible(MemberListContainer container) const;
virtual bool hasDetailedDescription() const;
virtual bool isFriendClass() const;
virtual bool isDocumentedFriendClass() const;
virtual const MemberDef *reimplements() const;
virtual const MemberVector &reimplementedBy() const;
virtual bool isReimplementedBy(const ClassDef *cd) const;
virtual ClassDef *relatedAlso() const;
virtual bool hasDocumentedEnumValues() const;
virtual const MemberDef *getAnonymousEnumType() const;
virtual bool isDocsForDefinition() const;
virtual const MemberDef *getEnumScope() const;
virtual const MemberVector &enumFieldList() const;
virtual void setEnumBaseType(const QCString &type);
virtual QCString enumBaseType() const;
virtual bool hasExamples() const;
virtual const ExampleList &getExamples() const;
virtual bool isPrototype() const;
virtual const ArgumentList &argumentList() const;
virtual ArgumentList &argumentList();
virtual const ArgumentList &declArgumentList() const;
virtual const ArgumentList &templateArguments() const;
virtual const ArgumentLists &definitionTemplateParameterLists() const;
virtual int getMemberGroupId() const;
virtual MemberGroup *getMemberGroup() const;
virtual bool fromAnonymousScope() const;
virtual bool anonymousDeclShown() const;
virtual MemberDef *fromAnonymousMember() const;
virtual bool hasCallGraph() const;
virtual bool hasCallerGraph() const;
virtual bool hasReferencesRelation() const;
virtual bool hasReferencedByRelation() const;
virtual const MemberDef *templateMaster() const;
virtual QCString getScopeString() const;
virtual ClassDef *getClassDefOfAnonymousType() const;
virtual bool isTypedefValCached() const;
virtual const ClassDef *getCachedTypedefVal() const;
virtual QCString getCachedTypedefTemplSpec() const;
virtual QCString getCachedResolvedTypedef() const;
virtual MemberDef *memberDefinition() const;
virtual MemberDef *memberDeclaration() const;
virtual const MemberDef *inheritsDocsFrom() const;
virtual const MemberDef *getGroupAlias() const;
virtual ClassDef *category() const;
virtual const MemberDef *categoryRelation() const;
virtual QCString displayName(bool=TRUE) const;
virtual QCString getDeclType() const;
virtual StringVector getLabels(const Definition *container) const;
virtual const ArgumentList &typeConstraints() const;
virtual QCString requiresClause() const;
virtual QCString documentation() const;
virtual QCString briefDescription(bool abbr=FALSE) const;
virtual QCString fieldType() const;
virtual bool isReference() const;
virtual QCString getDeclFileName() const;
virtual int getDeclLine() const;
virtual int getDeclColumn() const;
virtual void setMemberType(MemberType t);
virtual void setDefinition(const QCString &d);
virtual void setFileDef(const FileDef *fd);
virtual void setAnchor();
virtual void setProtection(Protection p);
virtual void setMemberSpecifiers(uint64 s);
virtual void mergeMemberSpecifiers(uint64 s);
virtual void setInitializer(const QCString &i);
virtual void setBitfields(const QCString &s);
virtual void setMaxInitLines(int lines);
virtual void setMemberClass(const ClassDef *cd);
virtual void setSectionList(const Definition *container,const MemberList *sl);
virtual void setGroupDef(const GroupDef *gd,Grouping::GroupPri_t pri,
const QCString &fileName,int startLine,bool hasDocs,
MemberDef *member=0);
virtual void setReadAccessor(const QCString &r);
virtual void setWriteAccessor(const QCString &w);
virtual void setTemplateSpecialization(bool b);
virtual void makeRelated();
virtual void makeForeign();
virtual void setInheritsDocsFrom(const MemberDef *md);
virtual void setTagInfo(const TagInfo *i);
virtual void setArgsString(const QCString &as);
virtual void setReimplements(const MemberDef *md);
virtual void insertReimplementedBy(const MemberDef *md);
virtual void setRelatedAlso(ClassDef *cd);
virtual void insertEnumField(const MemberDef *md);
virtual void setEnumScope(const MemberDef *md,bool livesInsideEnum=FALSE);
virtual void setEnumClassScope(const ClassDef *cd);
virtual void setDocumentedEnumValues(bool value);
virtual void setAnonymousEnumType(const MemberDef *md);
virtual bool addExample(const QCString &anchor,const QCString &name,const QCString &file);
virtual void setPrototype(bool p,const QCString &df,int line, int column);
virtual void setExplicitExternal(bool b,const QCString &df,int line,int column);
virtual void setDeclFile(const QCString &df,int line,int column);
virtual void moveArgumentList(std::unique_ptr<ArgumentList> al);
virtual void moveDeclArgumentList(std::unique_ptr<ArgumentList> al);
virtual void setDefinitionTemplateParameterLists(const ArgumentLists &lists);
virtual void setTypeConstraints(const ArgumentList &al);
virtual void setType(const QCString &t);
virtual void setAccessorType(ClassDef *cd,const QCString &t);
virtual void setNamespace(const NamespaceDef *nd);
virtual void setMemberGroup(MemberGroup *grp);
virtual void setMemberGroupId(int id);
virtual void makeImplementationDetail();
virtual void setFromAnonymousScope(bool b) const;
virtual void setFromAnonymousMember(MemberDef *m);
virtual void enableCallGraph(bool e);
virtual void enableCallerGraph(bool e);
virtual void enableReferencedByRelation(bool e);
virtual void enableReferencesRelation(bool e);
virtual void setTemplateMaster(const MemberDef *mt);
virtual void addListReference(Definition *d);
virtual void setDocsForDefinition(bool b);
virtual void setGroupAlias(const MemberDef *md);
virtual void cacheTypedefVal(const ClassDef *val,const QCString &templSpec,const QCString &resolvedType);
virtual void invalidateTypedefValCache();
virtual void invalidateCachedArgumentTypes();
virtual void setMemberDefinition(MemberDef *md);
virtual void setMemberDeclaration(MemberDef *md);
virtual void setAnonymousUsed() const;
virtual void copyArgumentNames(const MemberDef *bmd);
virtual void setCategory(ClassDef *);
virtual void setCategoryRelation(const MemberDef *);
virtual void setDocumentation(const QCString &d,const QCString &docFile,int docLine,bool stripWhiteSpace=TRUE);
virtual void setBriefDescription(const QCString &b,const QCString &briefFile,int briefLine);
virtual void setInbodyDocumentation(const QCString &d,const QCString &inbodyFile,int inbodyLine);
virtual void setHidden(bool b);
virtual void setRequiresClause(const QCString &req);
virtual void incrementFlowKeyWordCount();
virtual void writeDeclaration(OutputList &ol,
const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,
bool inGroup, int indentLevel,const ClassDef *inheritFrom=0,const QCString &inheritId=QCString()) const;
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;
virtual void writeMemberDocSimple(OutputList &ol,const Definition *container) const;
virtual void writeEnumDeclaration(OutputList &typeDecl,
const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd) const;
virtual void writeTagFile(TextStream &,bool useQualifiedName) const;
virtual void warnIfUndocumented() const;
virtual void warnIfUndocumentedParams() const;
virtual bool visibleInIndex() const;
virtual void detectUndocumentedParams(bool hasParamCommand,bool hasReturnCommand) const;
virtual MemberDefMutable *createTemplateInstanceMember(const ArgumentList &formalArgs,
const std::unique_ptr<ArgumentList> &actualArgs) const;
virtual void findSectionsInDocumentation();
virtual void writeLink(OutputList &ol,
const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,
bool onlyText=FALSE) const;
virtual void resolveUnnamedParameters(const MemberDef *md);
private:
void _computeLinkableInProject();
void _computeIsConstructor();
void _computeIsDestructor();
void _writeGroupInclude(OutputList &ol,bool inGroup) const;
void _writeMultiLineInitializer(OutputList &ol,const QCString &scopeName) const;
void _writeCallGraph(OutputList &ol) const;
void _writeCallerGraph(OutputList &ol) const;
void _writeReimplements(OutputList &ol) const;
bool _isReimplements() const;
void _writeReimplementedBy(OutputList &ol) const;
size_t _countReimplementedBy() const;
void _writeExamples(OutputList &ol) const;
void _writeTypeConstraints(OutputList &ol) const;
void _writeEnumValues(OutputList &ol,const Definition *container,
const QCString &cfname,const QCString &ciname,
const QCString &cname) const;
void _writeCategoryRelation(OutputList &ol) const;
void _writeTagData(const DefType) const;
void _writeTemplatePrefix(OutputList &ol, const Definition *def,
const ArgumentList &al, bool writeReqClause=true) const;
bool _hasVisibleCallGraph() const;
bool _hasVisibleCallerGraph() const;
// disable copying of member defs
MemberDefImpl(const MemberDefImpl &);
MemberDefImpl &operator=(const MemberDefImpl &);
// PIMPL idiom
class IMPL;
IMPL *m_impl;
uchar m_isLinkableCached; // 0 = not cached, 1=FALSE, 2=TRUE
uchar m_isConstructorCached; // 0 = not cached, 1=FALSE, 2=TRUE
uchar m_isDestructorCached; // 1 = not cached, 1=FALSE, 2=TRUE
};
MemberDefMutable *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)
{
return new MemberDefImpl(defFileName,defLine,defColumn,type,name,args,excp,prot,virt,
stat,related,t,tal,al,metaData);
}
//-----------------------------------------------------------------------------
class MemberDefAliasImpl : public DefinitionAliasMixin<MemberDef>
{
public:
MemberDefAliasImpl(const Definition *newScope,const MemberDef *md)
: DefinitionAliasMixin(newScope,md), m_memberGroup(0) { init(); }
virtual ~MemberDefAliasImpl() { deinit(); }
virtual DefType definitionType() const { return TypeMember; }
const MemberDef *getMdAlias() const { return toMemberDef(getAlias()); }
virtual MemberDef *resolveAlias() { return const_cast<MemberDef*>(getMdAlias()); }
virtual const MemberDef *resolveAlias() const { return getMdAlias(); }
virtual MemberDef *deepCopy() const {
return createMemberDefAlias(getScope(),getMdAlias());
}
virtual void moveTo(Definition *) {}
virtual QCString name() const
{ return getMdAlias()->name(); }
virtual CodeSymbolType codeSymbolType() const
{ return getMdAlias()->codeSymbolType(); }
virtual QCString getOutputFileBase() const
{ return getMdAlias()->getOutputFileBase(); }
virtual QCString getReference() const
{ return getMdAlias()->getReference(); }
virtual QCString anchor() const
{ return getMdAlias()->anchor(); }
virtual QCString declaration() const
{ return getMdAlias()->declaration(); }
virtual QCString definition() const
{ return getMdAlias()->definition(); }
virtual QCString typeString() const
{ return getMdAlias()->typeString(); }
virtual QCString argsString() const
{ return getMdAlias()->argsString(); }
virtual QCString excpString() const
{ return getMdAlias()->excpString(); }
virtual QCString bitfieldString() const
{ return getMdAlias()->bitfieldString(); }
virtual QCString extraTypeChars() const
{ return getMdAlias()->extraTypeChars(); }
virtual const QCString &initializer() const
{ return getMdAlias()->initializer(); }
virtual int initializerLines() const
{ return getMdAlias()->initializerLines(); }
virtual uint64 getMemberSpecifiers() const
{ return getMdAlias()->getMemberSpecifiers(); }
virtual const MemberList *getSectionList(const Definition *container) const
{ return getMdAlias()->getSectionList(container); }
virtual QCString displayDefinition() const
{ return getMdAlias()->displayDefinition(); }
virtual const ClassDef *getClassDef() const
{ return getMdAlias()->getClassDef(); }
virtual const FileDef *getFileDef() const
{ return getMdAlias()->getFileDef(); }
virtual const NamespaceDef* getNamespaceDef() const
{ return getMdAlias()->getNamespaceDef(); }
virtual const ClassDef *accessorClass() const
{ return getMdAlias()->accessorClass(); }
virtual QCString getReadAccessor() const
{ return getMdAlias()->getReadAccessor(); }
virtual QCString getWriteAccessor() const
{ return getMdAlias()->getWriteAccessor(); }
virtual const GroupDef *getGroupDef() const
{ return getMdAlias()->getGroupDef(); }
virtual Grouping::GroupPri_t getGroupPri() const
{ return getMdAlias()->getGroupPri(); }
virtual QCString getGroupFileName() const
{ return getMdAlias()->getGroupFileName(); }
virtual int getGroupStartLine() const
{ return getMdAlias()->getGroupStartLine(); }
virtual bool getGroupHasDocs() const
{ return getMdAlias()->getGroupHasDocs(); }
virtual QCString qualifiedName() const
{ return getMdAlias()->qualifiedName(); }
virtual QCString objCMethodName(bool localLink,bool showStatic) const
{ return getMdAlias()->objCMethodName(localLink,showStatic); }
virtual Protection protection() const
{ return getMdAlias()->protection(); }
virtual Specifier virtualness(int count) const
{ return getMdAlias()->virtualness(); }
virtual MemberType memberType() const
{ return getMdAlias()->memberType(); }
virtual QCString memberTypeName() const
{ return getMdAlias()->memberTypeName(); }
virtual bool isSignal() const
{ return getMdAlias()->isSignal(); }
virtual bool isSlot() const
{ return getMdAlias()->isSlot(); }
virtual bool isVariable() const
{ return getMdAlias()->isVariable(); }
virtual bool isEnumerate() const
{ return getMdAlias()->isEnumerate(); }
virtual bool isEnumValue() const
{ return getMdAlias()->isEnumValue(); }
virtual bool isTypedef() const
{ return getMdAlias()->isTypedef(); }
virtual bool isSequence() const
{ return getMdAlias()->isSequence(); }
virtual bool isDictionary() const
{ return getMdAlias()->isDictionary(); }
virtual bool isFunction() const
{ return getMdAlias()->isFunction(); }
virtual bool isFunctionPtr() const
{ return getMdAlias()->isFunctionPtr(); }
virtual bool isDefine() const
{ return getMdAlias()->isDefine(); }
virtual bool isFriend() const
{ return getMdAlias()->isFriend(); }
virtual bool isDCOP() const
{ return getMdAlias()->isDCOP(); }
virtual bool isProperty() const
{ return getMdAlias()->isProperty(); }
virtual bool isEvent() const
{ return getMdAlias()->isEvent(); }
virtual bool isRelated() const
{ return getMdAlias()->isRelated(); }
virtual bool isForeign() const
{ return getMdAlias()->isForeign(); }
virtual bool isStatic() const
{ return getMdAlias()->isStatic(); }
virtual bool isInline() const
{ return getMdAlias()->isInline(); }
virtual bool isExplicit() const
{ return getMdAlias()->isExplicit(); }
virtual bool isMutable() const
{ return getMdAlias()->isMutable(); }
virtual bool isGettable() const
{ return getMdAlias()->isGettable(); }
virtual bool isPrivateGettable() const
{ return getMdAlias()->isPrivateGettable(); }
virtual bool isProtectedGettable() const
{ return getMdAlias()->isProtectedGettable(); }
virtual bool isSettable() const
{ return getMdAlias()->isSettable(); }
virtual bool isPrivateSettable() const
{ return getMdAlias()->isPrivateSettable(); }
virtual bool isProtectedSettable() const
{ return getMdAlias()->isProtectedSettable(); }
virtual bool isReadable() const
{ return getMdAlias()->isReadable(); }
virtual bool isWritable() const
{ return getMdAlias()->isWritable(); }
virtual bool isAddable() const
{ return getMdAlias()->isAddable(); }
virtual bool isRemovable() const
{ return getMdAlias()->isRemovable(); }
virtual bool isRaisable() const
{ return getMdAlias()->isRaisable(); }
virtual bool isFinal() const
{ return getMdAlias()->isFinal(); }
virtual bool isAbstract() const
{ return getMdAlias()->isAbstract(); }
virtual bool isOverride() const
{ return getMdAlias()->isOverride(); }
virtual bool isInitonly() const
{ return getMdAlias()->isInitonly(); }
virtual bool isOptional() const
{ return getMdAlias()->isOptional(); }
virtual bool isRequired() const
{ return getMdAlias()->isRequired(); }
virtual bool isNonAtomic() const
{ return getMdAlias()->isNonAtomic(); }
virtual bool isCopy() const
{ return getMdAlias()->isCopy(); }
virtual bool isAssign() const
{ return getMdAlias()->isAssign(); }
virtual bool isRetain() const
{ return getMdAlias()->isRetain(); }
virtual bool isWeak() const
{ return getMdAlias()->isWeak(); }
virtual bool isStrong() const
{ return getMdAlias()->isStrong(); }
virtual bool isEnumStruct() const
{ return getMdAlias()->isEnumStruct(); }
virtual bool isUnretained() const
{ return getMdAlias()->isUnretained(); }
virtual bool isNew() const
{ return getMdAlias()->isNew(); }
virtual bool isSealed() const
{ return getMdAlias()->isSealed(); }
virtual bool isImplementation() const
{ return getMdAlias()->isImplementation(); }
virtual bool isExternal() const
{ return getMdAlias()->isExternal(); }
virtual bool isTypeAlias() const
{ return getMdAlias()->isTypeAlias(); }
virtual bool isDefault() const
{ return getMdAlias()->isDefault(); }
virtual bool isDelete() const
{ return getMdAlias()->isDelete(); }
virtual bool isNoExcept() const
{ return getMdAlias()->isNoExcept(); }
virtual bool isAttribute() const
{ return getMdAlias()->isAttribute(); }
virtual bool isUNOProperty() const
{ return getMdAlias()->isUNOProperty(); }
virtual bool isReadonly() const
{ return getMdAlias()->isReadable(); }
virtual bool isBound() const
{ return getMdAlias()->isBound(); }
virtual bool isConstrained() const
{ return getMdAlias()->isConstrained(); }
virtual bool isTransient() const
{ return getMdAlias()->isTransient(); }
virtual bool isMaybeVoid() const
{ return getMdAlias()->isMaybeVoid(); }
virtual bool isMaybeDefault() const
{ return getMdAlias()->isMaybeDefault(); }
virtual bool isMaybeAmbiguous() const
{ return getMdAlias()->isMaybeAmbiguous(); }
virtual bool isPublished() const
{ return getMdAlias()->isPublished(); }
virtual bool isTemplateSpecialization() const
{ return getMdAlias()->isTemplateSpecialization(); }
virtual bool isObjCMethod() const
{ return getMdAlias()->isObjCMethod(); }
virtual bool isObjCProperty() const
{ return getMdAlias()->isObjCProperty(); }
virtual bool isCSharpProperty() const
{ return getMdAlias()->isCSharpProperty(); }
virtual bool isConstructor() const
{ return getMdAlias()->isConstructor(); }
virtual bool isDestructor() const
{ return getMdAlias()->isDestructor(); }
virtual bool hasOneLineInitializer() const
{ return getMdAlias()->hasOneLineInitializer(); }
virtual bool hasMultiLineInitializer() const
{ return getMdAlias()->hasMultiLineInitializer(); }
virtual bool showInCallGraph() const
{ return getMdAlias()->showInCallGraph(); }
virtual bool isStrongEnumValue() const
{ return getMdAlias()->isStrongEnumValue(); }
virtual bool livesInsideEnum() const
{ return getMdAlias()->livesInsideEnum(); }
virtual bool isSliceLocal() const
{ return getMdAlias()->isSliceLocal(); }
virtual bool isConstExpr() const
{ return getMdAlias()->isConstExpr(); }
virtual int numberOfFlowKeyWords() const
{ return getMdAlias()->numberOfFlowKeyWords(); }
virtual bool isFriendToHide() const
{ return getMdAlias()->isFriendToHide(); }
virtual bool isNotFriend() const
{ return getMdAlias()->isNotFriend(); }
virtual bool isFunctionOrSignalSlot() const
{ return getMdAlias()->isFunctionOrSignalSlot(); }
virtual bool isRelatedOrFriend() const
{ return getMdAlias()->isRelatedOrFriend(); }
virtual bool isLinkableInProject() const
{ return getMdAlias()->isLinkableInProject(); }
virtual bool isLinkable() const
{ return getMdAlias()->isLinkable(); }
virtual bool hasDocumentation() const
{ return getMdAlias()->hasDocumentation(); }
virtual bool isDeleted() const
{ return getMdAlias()->isDeleted(); }
virtual bool isBriefSectionVisible() const
{ return getMdAlias()->isBriefSectionVisible(); }
virtual bool isDetailedSectionVisible(MemberListContainer container) const
{ return getMdAlias()->isDetailedSectionVisible(container); }
virtual bool hasDetailedDescription() const
{ return getMdAlias()->hasDetailedDescription(); }
virtual bool isFriendClass() const
{ return getMdAlias()->isFriendClass(); }
virtual bool isDocumentedFriendClass() const
{ return getMdAlias()->isDocumentedFriendClass(); }
virtual const MemberDef *reimplements() const
{ return getMdAlias()->reimplements(); }
virtual const MemberVector &reimplementedBy() const
{ return getMdAlias()->reimplementedBy(); }
virtual bool isReimplementedBy(const ClassDef *cd) const
{ return getMdAlias()->isReimplementedBy(cd); }
virtual ClassDef *relatedAlso() const
{ return getMdAlias()->relatedAlso(); }
virtual bool hasDocumentedEnumValues() const
{ return getMdAlias()->hasDocumentedEnumValues(); }
virtual const MemberDef *getAnonymousEnumType() const
{ return getMdAlias()->getAnonymousEnumType(); }
virtual bool isDocsForDefinition() const
{ return getMdAlias()->isDocsForDefinition(); }
virtual const MemberDef *getEnumScope() const
{ return getMdAlias()->getEnumScope(); }
virtual const MemberVector &enumFieldList() const
{ return getMdAlias()->enumFieldList(); }
virtual QCString enumBaseType() const
{ return getMdAlias()->enumBaseType(); }
virtual bool hasExamples() const
{ return getMdAlias()->hasExamples(); }
virtual const ExampleList &getExamples() const
{ return getMdAlias()->getExamples(); }
virtual bool isPrototype() const
{ return getMdAlias()->isPrototype(); }
virtual const ArgumentList &argumentList() const
{ return getMdAlias()->argumentList(); }
virtual const ArgumentList &declArgumentList() const
{ return getMdAlias()->declArgumentList(); }
virtual const ArgumentList &templateArguments() const
{ return getMdAlias()->templateArguments(); }
virtual const ArgumentLists &definitionTemplateParameterLists() const
{ return getMdAlias()->definitionTemplateParameterLists(); }
virtual int getMemberGroupId() const
{ return getMdAlias()->getMemberGroupId(); }
virtual MemberGroup *getMemberGroup() const
{ return m_memberGroup; }
virtual bool fromAnonymousScope() const
{ return getMdAlias()->fromAnonymousScope(); }
virtual bool anonymousDeclShown() const
{ return getMdAlias()->anonymousDeclShown(); }
virtual MemberDef *fromAnonymousMember() const
{ return getMdAlias()->fromAnonymousMember(); }
virtual bool hasCallGraph() const
{ return getMdAlias()->hasCallGraph(); }
virtual bool hasCallerGraph() const
{ return getMdAlias()->hasCallerGraph(); }
virtual bool hasReferencesRelation() const
{ return getMdAlias()->hasReferencesRelation(); }
virtual bool hasReferencedByRelation() const
{ return getMdAlias()->hasReferencedByRelation(); }
virtual const MemberDef *templateMaster() const
{ return getMdAlias()->templateMaster(); }
virtual QCString getScopeString() const
{ return getMdAlias()->getScopeString(); }
virtual ClassDef *getClassDefOfAnonymousType() const
{ return getMdAlias()->getClassDefOfAnonymousType(); }
virtual bool isTypedefValCached() const
{ return getMdAlias()->isTypedefValCached(); }
virtual const ClassDef *getCachedTypedefVal() const
{ return getMdAlias()->getCachedTypedefVal(); }
virtual QCString getCachedTypedefTemplSpec() const
{ return getMdAlias()->getCachedTypedefTemplSpec(); }
virtual QCString getCachedResolvedTypedef() const
{ return getMdAlias()->getCachedResolvedTypedef(); }
virtual MemberDef *memberDefinition() const
{ return getMdAlias()->memberDefinition(); }
virtual MemberDef *memberDeclaration() const
{ return getMdAlias()->memberDeclaration(); }
virtual const MemberDef *inheritsDocsFrom() const
{ return getMdAlias()->inheritsDocsFrom(); }
virtual const MemberDef *getGroupAlias() const
{ return getMdAlias()->getGroupAlias(); }
virtual ClassDef *category() const
{ return getMdAlias()->category(); }
virtual const MemberDef *categoryRelation() const
{ return getMdAlias()->categoryRelation(); }
virtual QCString displayName(bool b=TRUE) const
{ return getMdAlias()->displayName(b); }
virtual QCString getDeclType() const
{ return getMdAlias()->getDeclType(); }
virtual StringVector getLabels(const Definition *container) const
{ return getMdAlias()->getLabels(container); }
virtual const ArgumentList &typeConstraints() const
{ return getMdAlias()->typeConstraints(); }
virtual QCString documentation() const
{ return getMdAlias()->documentation(); }
virtual QCString briefDescription(bool abbr=FALSE) const
{ return getMdAlias()->briefDescription(); }
virtual QCString fieldType() const
{ return getMdAlias()->fieldType(); }
virtual bool isReference() const
{ return getMdAlias()->isReference(); }
virtual QCString getDeclFileName() const
{ return getMdAlias()->getDeclFileName(); }
virtual int getDeclLine() const
{ return getMdAlias()->getDeclLine(); }
virtual int getDeclColumn() const
{ return getMdAlias()->getDeclColumn(); }
virtual QCString requiresClause() const
{ return getMdAlias()->requiresClause(); }
virtual bool visibleInIndex() const
{ return getMdAlias()->visibleInIndex(); }
virtual void warnIfUndocumented() const {}
virtual void warnIfUndocumentedParams() const {}
virtual void detectUndocumentedParams(bool hasParamCommand,bool hasReturnCommand) const {}
virtual void setMemberGroup(MemberGroup *grp) { m_memberGroup = grp; }
virtual MemberDefMutable *createTemplateInstanceMember(const ArgumentList &formalArgs,
const std::unique_ptr<ArgumentList> &actualArgs) const
{ return getMdAlias()->createTemplateInstanceMember(formalArgs,actualArgs); }
virtual void writeDeclaration(OutputList &ol,
const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,
bool inGroup, int indentLevel, const ClassDef *inheritFrom=0,const QCString &inheritId=QCString()) const
{
getMdAlias()->writeDeclaration(ol,cd,nd,fd,gd,inGroup,indentLevel,inheritFrom,inheritId);
}
virtual void writeEnumDeclaration(OutputList &typeDecl,
const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd) const
{
getMdAlias()->writeEnumDeclaration(typeDecl,cd,nd,fd,gd);
}
private:
MemberGroup *m_memberGroup; // group's member definition
};
MemberDef *createMemberDefAlias(const Definition *newScope,const MemberDef *aliasMd)
{
MemberDef *amd = new MemberDefAliasImpl(newScope,aliasMd);
//printf("amd: name=%s displayName=%s\n",qPrint(amd->name()),qPrint(amd->displayName()));
return amd;
}
//-----------------------------------------------------------------------------
static QCString addTemplateNames(const QCString &s,const QCString &n,const QCString &t)
{
QCString result;
QCString clRealName=n;
int p=0,i;
if ((i=clRealName.find('<'))!=-1)
{
clRealName=clRealName.left(i); // strip template specialization
}
if ((i=clRealName.findRev("::"))!=-1)
{
clRealName=clRealName.right(clRealName.length()-i-2);
}
while ((i=s.find(clRealName,p))!=-1)
{
result+=s.mid(p,i-p);
uint j=clRealName.length()+i;
if (s.length()==j || (s.at(j)!='<' && !isId(s.at(j))))
{ // add template names
//printf("Adding %s+%s\n",qPrint(clRealName),qPrint(t));
result+=clRealName+t;
}
else
{ // template names already present
//printf("Adding %s\n",qPrint(clRealName));
result+=clRealName;
}
p=i+clRealName.length();
}
result+=s.right(s.length()-p);
//printf("addTemplateNames(%s,%s,%s)=%s\n",qPrint(s),qPrint(n),qPrint(t),qPrint(result));
return result;
}
// ol.startMemberDocName has already been done before this is called.
// when this function returns TRUE, ol.endParameterList will be called.
//
// typical sequence:
// ol.startMemberDoc
// ol.startMemberDocName
// --- enter writeDefArgumentList
// ol.endMemberDocName
// ol.startParameterList
// ...
// ol.startParameterType(first=TRUE)
// ol.endParameterType
// ol.startParameterName
// ol.endParameterName(last==FALSE)
// ...
// ol.startParameterType(first=FALSE)
// ol.endParameterType
// ol.startParameterName
// ol.endParameterName(last==TRUE)
// ...
// --- leave writeDefArgumentList with return value TRUE
// ol.endParameterList
// ol.endMemberDoc(hasArgs=TRUE)
//
// For an empty list the function should return FALSE, the sequence is
// ol.startMemberDoc
// ol.startMemberDocName
// --- enter writeDefArgumentList
// --- leave writeDefArgumentList with return value FALSE
// ol.endMemberDocName
// ol.endMemberDoc(hasArgs=FALSE);
//
static bool writeDefArgumentList(OutputList &ol,const Definition *scope,const MemberDef *md)
{
const ArgumentList &defArgList=(md->isDocsForDefinition()) ?
md->argumentList() : md->declArgumentList();
//printf("writeDefArgumentList '%s' isDocsForDefinition()=%d\n",qPrint(md->name()),md->isDocsForDefinition());
if (!defArgList.hasParameters() || md->isProperty() || md->isTypedef())
{
return FALSE; // member has no function like argument list
}
if (!md->isDefine()) ol.docify(" ");
//printf("writeDefArgList(%d)\n",defArgList->count());
ol.pushGeneratorState();
//ol.disableAllBut(OutputGenerator::Html);
bool htmlOn = ol.isEnabled(OutputGenerator::Html);
bool latexOn = ol.isEnabled(OutputGenerator::Latex);
bool docbookOn = ol.isEnabled(OutputGenerator::Docbook);
{
// html and latex
if (htmlOn) ol.enable(OutputGenerator::Html);
if (latexOn) ol.enable(OutputGenerator::Latex);
if (docbookOn) ol.enable(OutputGenerator::Docbook);
ol.endMemberDocName();
ol.startParameterList(!md->isObjCMethod());
}
ol.enableAll();
ol.disable(OutputGenerator::Html);
ol.disable(OutputGenerator::Latex);
ol.disable(OutputGenerator::Docbook);
{
// other formats
if (!md->isObjCMethod()) ol.docify("("); // start argument list
ol.endMemberDocName();
}
ol.popGeneratorState();
//printf("===> name=%s isDefine=%d\n",qPrint(md->name()),md->isDefine());
QCString cName;
if (scope)
{
cName=scope->name();
int il=cName.find('<');
int ir=cName.findRev('>');
if (il!=-1 && ir!=-1 && ir>il)
{
cName=cName.mid(il,ir-il+1);
//printf("1. cName=%s\n",qPrint(cName));
}
else if (scope->definitionType()==Definition::TypeClass)
{
cName=tempArgListToString((toClassDef(scope))->templateArguments(),
scope->getLanguage());
//printf("2. cName=%s\n",qPrint(cName));
}
else // no template specifier
{
cName.resize(0);
}
}
//printf("~~~ %s cName=%s\n",qPrint(md->name()),qPrint(cName));
bool first=TRUE;
bool paramTypeStarted=FALSE;
bool isDefine = md->isDefine();
auto alIt = defArgList.begin();
while (alIt!=defArgList.end())
{
Argument a = *alIt;
if (isDefine || first)
{
ol.startParameterType(first,QCString());
paramTypeStarted=TRUE;
if (isDefine)
{
ol.endParameterType();
ol.startParameterName(TRUE);
}
}
if (!a.attrib.isEmpty() && !md->isObjCMethod()) // argument has an IDL attribute
{
ol.docify(a.attrib+" ");
}
{
QCString n=a.type;
if (md->isObjCMethod()) { n.prepend("("); n.append(")"); }
if (a.type!="...")
{
if (!cName.isEmpty()) n=addTemplateNames(n,scope->name(),cName);
linkifyText(TextGeneratorOLImpl(ol),scope,md->getBodyDef(),md,n);
}
}
if (!isDefine)
{
if (paramTypeStarted)
{
ol.endParameterType();
paramTypeStarted=FALSE;
}
ol.startParameterName(defArgList.size()<2);
}
if (!a.name.isEmpty() || a.type=="...") // argument has a name
{
ol.disable(OutputGenerator::Latex);
ol.disable(OutputGenerator::Docbook);
ol.disable(OutputGenerator::Html);
ol.docify(" "); /* man page */
if (htmlOn) ol.enable(OutputGenerator::Html);
ol.disable(OutputGenerator::Man);
ol.startEmphasis();
ol.enable(OutputGenerator::Man);
if (latexOn) ol.enable(OutputGenerator::Latex);
if (docbookOn) ol.enable(OutputGenerator::Docbook);
if (a.name.isEmpty()) ol.docify(a.type); else ol.docify(a.name);
ol.disable(OutputGenerator::Man);
ol.disable(OutputGenerator::Latex);
ol.disable(OutputGenerator::Docbook);
ol.endEmphasis();
ol.enable(OutputGenerator::Man);
if (latexOn) ol.enable(OutputGenerator::Latex);
if (docbookOn) ol.enable(OutputGenerator::Docbook);
}
if (!a.array.isEmpty())
{
ol.docify(a.array);
}
if (!a.defval.isEmpty()) // write the default value
{
QCString n=a.defval;
if (!cName.isEmpty()) n=addTemplateNames(n,scope->name(),cName);
ol.docify(" = ");
ol.startTypewriter();
linkifyText(TextGeneratorOLImpl(ol),scope,md->getBodyDef(),md,n,FALSE,TRUE,TRUE);
ol.endTypewriter();
}
++alIt;
if (alIt!=defArgList.end())
{