forked from doxygen/doxygen
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassdef.cpp
More file actions
5134 lines (4730 loc) · 159 KB
/
Copy pathclassdef.cpp
File metadata and controls
5134 lines (4730 loc) · 159 KB
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 <cstdio>
#include <algorithm>
#include "types.h"
#include "classdef.h"
#include "classlist.h"
#include "entry.h"
#include "doxygen.h"
#include "membername.h"
#include "message.h"
#include "config.h"
#include "util.h"
#include "diagram.h"
#include "language.h"
#include "htmlhelp.h"
#include "example.h"
#include "outputlist.h"
#include "dot.h"
#include "dotclassgraph.h"
#include "dotrunner.h"
#include "defargs.h"
#include "debug.h"
#include "docparser.h"
#include "searchindex.h"
#include "vhdldocgen.h"
#include "layout.h"
#include "arguments.h"
#include "memberlist.h"
#include "groupdef.h"
#include "filedef.h"
#include "namespacedef.h"
#include "membergroup.h"
#include "definitionimpl.h"
#include "symbolresolver.h"
#include "fileinfo.h"
//-----------------------------------------------------------------------------
static QCString makeQualifiedNameWithTemplateParameters(const ClassDef *cd,
const ArgumentLists *actualParams,uint *actualParamIndex)
{
//bool optimizeOutputJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
bool hideScopeNames = Config_getBool(HIDE_SCOPE_NAMES);
//printf("qualifiedNameWithTemplateParameters() localName=%s\n",qPrint(localName()));
QCString scName;
const Definition *d=cd->getOuterScope();
if (d)
{
if (d->definitionType()==Definition::TypeClass)
{
const ClassDef *ocd=toClassDef(d);
scName = ocd->qualifiedNameWithTemplateParameters(actualParams,actualParamIndex);
}
else if (!hideScopeNames)
{
scName = d->qualifiedName();
}
}
SrcLangExt lang = cd->getLanguage();
QCString scopeSeparator = getLanguageSpecificSeparator(lang);
if (!scName.isEmpty()) scName+=scopeSeparator;
bool isSpecialization = cd->localName().find('<')!=-1;
QCString clName = cd->className();
scName+=clName;
if (!cd->templateArguments().empty())
{
if (actualParams && *actualParamIndex<actualParams->size())
{
const ArgumentList &al = actualParams->at(*actualParamIndex);
if (!isSpecialization)
{
scName+=tempArgListToString(al,lang);
}
(*actualParamIndex)++;
}
else
{
if (!isSpecialization)
{
scName+=tempArgListToString(cd->templateArguments(),lang);
}
}
}
//printf("qualifiedNameWithTemplateParameters: scope=%s qualifiedName=%s\n",qPrint(name()),qPrint(scName));
return scName;
}
static QCString makeDisplayName(const ClassDef *cd,bool includeScope)
{
//bool optimizeOutputForJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
SrcLangExt lang = cd->getLanguage();
//bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
QCString n;
if (lang==SrcLangExt_VHDL)
{
n = VhdlDocGen::getClassName(cd);
}
else
{
if (includeScope)
{
n=cd->qualifiedNameWithTemplateParameters();
}
else
{
n=cd->className();
}
}
if (cd->isAnonymous())
{
n = removeAnonymousScopes(n);
}
QCString sep=getLanguageSpecificSeparator(lang);
if (sep!="::")
{
n=substitute(n,"::",sep);
}
if (cd->compoundType()==ClassDef::Protocol && n.endsWith("-p"))
{
n="<"+n.left(n.length()-2)+">";
}
return n;
}
//-----------------------------------------------------------------------------
/** Implementation of the ClassDef interface */
class ClassDefImpl : public DefinitionMixin<ClassDefMutable>
{
public:
ClassDefImpl(const QCString &fileName,int startLine,int startColumn,
const QCString &name,CompoundType ct,
const QCString &ref=QCString(),const QCString &fName=QCString(),
bool isSymbol=TRUE,bool isJavaEnum=FALSE);
/** Destroys a compound definition. */
~ClassDefImpl();
virtual ClassDef *resolveAlias() { return this; }
virtual DefType definitionType() const { return TypeClass; }
virtual CodeSymbolType codeSymbolType() const;
virtual QCString getOutputFileBase() const;
virtual QCString getInstanceOutputFileBase() const;
virtual QCString getSourceFileBase() const;
virtual QCString getReference() const;
virtual bool isReference() const;
virtual bool isLocal() const;
virtual ClassLinkedRefMap getClasses() const;
virtual bool hasDocumentation() const;
virtual bool hasDetailedDescription() const;
virtual QCString collaborationGraphFileName() const;
virtual QCString inheritanceGraphFileName() const;
virtual QCString displayName(bool includeScope=TRUE) const;
virtual CompoundType compoundType() const;
virtual QCString compoundTypeString() const;
virtual const BaseClassList &baseClasses() const;
virtual void updateBaseClasses(const BaseClassList &bcd);
virtual const BaseClassList &subClasses() const;
virtual void updateSubClasses(const BaseClassList &bcd);
virtual const MemberNameInfoLinkedMap &memberNameInfoLinkedMap() const;
virtual Protection protection() const;
virtual bool isLinkableInProject() const;
virtual bool isLinkable() const;
virtual bool isVisibleInHierarchy() const;
virtual bool visibleInParentsDeclList() const;
virtual const ArgumentList &templateArguments() const;
virtual FileDef *getFileDef() const;
virtual const MemberDef *getMemberByName(const QCString &) const;
virtual int isBaseClass(const ClassDef *bcd,bool followInstances) const;
virtual bool isSubClass(ClassDef *bcd,int level=0) const;
virtual bool isAccessibleMember(const MemberDef *md) const;
virtual const TemplateInstanceList &getTemplateInstances() const;
virtual const ClassDef *templateMaster() const;
virtual bool isTemplate() const;
virtual const IncludeInfo *includeInfo() const;
virtual const UsesClassList &usedImplementationClasses() const;
virtual const UsesClassList &usedByImplementationClasses() const;
virtual const ConstraintClassList &templateTypeConstraints() const;
virtual bool isTemplateArgument() const;
virtual const Definition *findInnerCompound(const QCString &name) const;
virtual ArgumentLists getTemplateParameterLists() const;
virtual QCString qualifiedNameWithTemplateParameters(
const ArgumentLists *actualParams=0,uint *actualParamIndex=0) const;
virtual bool isAbstract() const;
virtual bool isObjectiveC() const;
virtual bool isFortran() const;
virtual bool isCSharp() const;
virtual bool isFinal() const;
virtual bool isSealed() const;
virtual bool isPublished() const;
virtual bool isExtension() const;
virtual bool isForwardDeclared() const;
virtual bool isInterface() const;
virtual ClassDef *categoryOf() const;
virtual QCString className() const;
virtual MemberList *getMemberList(MemberListType lt) const;
virtual const MemberLists &getMemberLists() const;
virtual const MemberGroupList &getMemberGroups() const;
virtual const TemplateNameMap &getTemplateBaseClassNames() const;
virtual bool isUsedOnly() const;
virtual QCString anchor() const;
virtual bool isEmbeddedInOuterScope() const;
virtual bool isSimple() const;
virtual const ClassDef *tagLessReference() const;
virtual const MemberDef *isSmartPointer() const;
virtual bool isJavaEnum() const;
virtual QCString title() const;
virtual QCString generatedFromFiles() const;
virtual const FileList &usedFiles() const;
virtual const ArgumentList &typeConstraints() const;
virtual const ExampleList &getExamples() const;
virtual bool hasExamples() const;
virtual QCString getMemberListFileName() const;
virtual bool subGrouping() const;
virtual bool isSliceLocal() const;
virtual bool hasNonReferenceSuperClass() const;
virtual QCString requiresClause() const;
virtual ClassDef *insertTemplateInstance(const QCString &fileName,int startLine,int startColumn,
const QCString &templSpec,bool &freshInstance) const;
virtual void insertBaseClass(ClassDef *,const QCString &name,Protection p,Specifier s,const QCString &t=QCString());
virtual void insertSubClass(ClassDef *,Protection p,Specifier s,const QCString &t=QCString());
virtual void setIncludeFile(FileDef *fd,const QCString &incName,bool local,bool force);
virtual void insertMember(MemberDef *);
virtual void insertUsedFile(const FileDef *);
virtual bool addExample(const QCString &anchor,const QCString &name, const QCString &file);
virtual void mergeCategory(ClassDef *category);
//virtual void setNamespace(NamespaceDef *nd);
virtual void setFileDef(FileDef *fd);
virtual void setSubGrouping(bool enabled);
virtual void setProtection(Protection p);
virtual void setGroupDefForAllMembers(GroupDef *g,Grouping::GroupPri_t pri,const QCString &fileName,int startLine,bool hasDocs);
virtual void addInnerCompound(const Definition *d);
virtual void addUsedClass(ClassDef *cd,const QCString &accessName,Protection prot);
virtual void addUsedByClass(ClassDef *cd,const QCString &accessName,Protection prot);
virtual void setIsStatic(bool b);
virtual void setCompoundType(CompoundType t);
virtual void setClassName(const QCString &name);
virtual void setClassSpecifier(uint64 spec);
virtual void setTemplateArguments(const ArgumentList &al);
virtual void setTemplateBaseClassNames(const TemplateNameMap &templateNames);
virtual void setTemplateMaster(const ClassDef *tm);
virtual void setTypeConstraints(const ArgumentList &al);
virtual void addMembersToTemplateInstance(const ClassDef *cd,const ArgumentList &templateArguments,const QCString &templSpec);
virtual void makeTemplateArgument(bool b=TRUE);
virtual void setCategoryOf(ClassDef *cd);
virtual void setUsedOnly(bool b);
virtual void setTagLessReference(const ClassDef *cd);
virtual void setName(const QCString &name);
virtual void setMetaData(const QCString &md);
virtual void findSectionsInDocumentation();
virtual void addMembersToMemberGroup();
virtual void addListReferences();
virtual void addTypeConstraints();
virtual void computeAnchors();
virtual void mergeMembers();
virtual void sortMemberLists();
virtual void distributeMemberGroupDocumentation();
virtual void writeDocumentation(OutputList &ol) const;
virtual void writeDocumentationForInnerClasses(OutputList &ol) const;
virtual void writeMemberPages(OutputList &ol) const;
virtual void writeMemberList(OutputList &ol) const;
virtual void writeDeclaration(OutputList &ol,const MemberDef *md,bool inGroup,int indentLevel,
const ClassDef *inheritedFrom,const QCString &inheritId) const;
virtual void writeQuickMemberLinks(OutputList &ol,const MemberDef *md) const;
virtual void writeSummaryLinks(OutputList &ol) const;
virtual void reclassifyMember(MemberDefMutable *md,MemberType t);
virtual void writeInlineDocumentation(OutputList &ol) const;
virtual void writeDeclarationLink(OutputList &ol,bool &found,
const QCString &header,bool localNames) const;
virtual void removeMemberFromLists(MemberDef *md);
virtual void setAnonymousEnumType();
virtual void countMembers();
virtual void sortAllMembersList();
virtual void addGroupedInheritedMembers(OutputList &ol,MemberListType lt,
const ClassDef *inheritedFrom,const QCString &inheritId) const;
virtual void writeTagFile(TextStream &);
virtual int countMembersIncludingGrouped(MemberListType lt,const ClassDef *inheritedFrom,bool additional) const;
virtual int countInheritanceNodes() const;
virtual int countMemberDeclarations(MemberListType lt,const ClassDef *inheritedFrom,
int lt2,bool invert,bool showAlways,ClassDefSet &visitedClasses) const;
virtual void writeMemberDeclarations(OutputList &ol,ClassDefSet &visitedClasses,
MemberListType lt,const QCString &title,
const QCString &subTitle=QCString(),
bool showInline=FALSE,const ClassDef *inheritedFrom=0,
int lt2=-1,bool invert=FALSE,bool showAlways=FALSE) const;
virtual void setRequiresClause(const QCString &req);
private:
void addUsedInterfaceClasses(MemberDef *md,const QCString &typeStr);
void showUsedFiles(OutputList &ol) const;
void writeDocumentationContents(OutputList &ol,const QCString &pageTitle) const;
void internalInsertMember(const MemberDef *md,Protection prot,bool addToAllList);
void addMemberToList(MemberListType lt,const MemberDef *md,bool isBrief);
void writeInheritedMemberDeclarations(OutputList &ol,ClassDefSet &visitedClasses,
MemberListType lt,int lt2,const QCString &title,
const ClassDef *inheritedFrom,bool invert,
bool showAlways) const;
void writeMemberDocumentation(OutputList &ol,MemberListType lt,const QCString &title,bool showInline=FALSE) const;
void writeSimpleMemberDocumentation(OutputList &ol,MemberListType lt) const;
void writePlainMemberDeclaration(OutputList &ol,MemberListType lt,bool inGroup,
int indentLevel,const ClassDef *inheritedFrom,const QCString &inheritId) const;
void writeBriefDescription(OutputList &ol,bool exampleFlag) const;
void writeDetailedDescription(OutputList &ol,const QCString &pageType,bool exampleFlag,
const QCString &title,const QCString &anchor=QCString()) const;
void writeIncludeFiles(OutputList &ol) const;
void writeIncludeFilesForSlice(OutputList &ol) const;
void writeInheritanceGraph(OutputList &ol) const;
void writeCollaborationGraph(OutputList &ol) const;
void writeMemberGroups(OutputList &ol,bool showInline=FALSE) const;
void writeNestedClasses(OutputList &ol,const QCString &title) const;
void writeInlineClasses(OutputList &ol) const;
void startMemberDeclarations(OutputList &ol) const;
void endMemberDeclarations(OutputList &ol) const;
void startMemberDocumentation(OutputList &ol) const;
void endMemberDocumentation(OutputList &ol) const;
void writeAuthorSection(OutputList &ol) const;
void writeMoreLink(OutputList &ol,const QCString &anchor) const;
void writeDetailedDocumentationBody(OutputList &ol) const;
int countAdditionalInheritedMembers() const;
void writeAdditionalInheritedMembers(OutputList &ol) const;
void addClassAttributes(OutputList &ol) const;
int countInheritedDecMembers(MemberListType lt,
const ClassDef *inheritedFrom,bool invert,bool showAlways,
ClassDefSet &visitedClasses) const;
void getTitleForMemberListType(MemberListType type,
QCString &title,QCString &subtitle) const;
QCString includeStatement() const;
void addTypeConstraint(const QCString &typeConstraint,const QCString &type);
void writeTemplateSpec(OutputList &ol,const Definition *d,
const QCString &type,SrcLangExt lang) const;
// PIMPL idiom
class IMPL;
IMPL *m_impl = 0;
};
ClassDefMutable *createClassDef(
const QCString &fileName,int startLine,int startColumn,
const QCString &name,ClassDef::CompoundType ct,
const QCString &ref,const QCString &fName,
bool isSymbol,bool isJavaEnum)
{
return new ClassDefImpl(fileName,startLine,startColumn,name,ct,ref,fName,isSymbol,isJavaEnum);
}
//-----------------------------------------------------------------------------
class ClassDefAliasImpl : public DefinitionAliasMixin<ClassDef>
{
public:
ClassDefAliasImpl(const Definition *newScope,const ClassDef *cd)
: DefinitionAliasMixin(newScope,cd) { init(); }
virtual ~ClassDefAliasImpl() { deinit(); }
virtual DefType definitionType() const { return TypeClass; }
const ClassDef *getCdAlias() const { return toClassDef(getAlias()); }
virtual ClassDef *resolveAlias() { return const_cast<ClassDef*>(getCdAlias()); }
virtual CodeSymbolType codeSymbolType() const
{ return getCdAlias()->codeSymbolType(); }
virtual QCString getOutputFileBase() const
{ return getCdAlias()->getOutputFileBase(); }
virtual QCString getInstanceOutputFileBase() const
{ return getCdAlias()->getInstanceOutputFileBase(); }
virtual QCString getSourceFileBase() const
{ return getCdAlias()->getSourceFileBase(); }
virtual QCString getReference() const
{ return getCdAlias()->getReference(); }
virtual bool isReference() const
{ return getCdAlias()->isReference(); }
virtual bool isLocal() const
{ return getCdAlias()->isLocal(); }
virtual ClassLinkedRefMap getClasses() const
{ return getCdAlias()->getClasses(); }
virtual bool hasDocumentation() const
{ return getCdAlias()->hasDocumentation(); }
virtual bool hasDetailedDescription() const
{ return getCdAlias()->hasDetailedDescription(); }
virtual QCString collaborationGraphFileName() const
{ return getCdAlias()->collaborationGraphFileName(); }
virtual QCString inheritanceGraphFileName() const
{ return getCdAlias()->inheritanceGraphFileName(); }
virtual QCString displayName(bool includeScope=TRUE) const
{ return makeDisplayName(this,includeScope); }
virtual CompoundType compoundType() const
{ return getCdAlias()->compoundType(); }
virtual QCString compoundTypeString() const
{ return getCdAlias()->compoundTypeString(); }
virtual const BaseClassList &baseClasses() const
{ return getCdAlias()->baseClasses(); }
virtual const BaseClassList &subClasses() const
{ return getCdAlias()->subClasses(); }
virtual const MemberNameInfoLinkedMap &memberNameInfoLinkedMap() const
{ return getCdAlias()->memberNameInfoLinkedMap(); }
virtual Protection protection() const
{ return getCdAlias()->protection(); }
virtual bool isLinkableInProject() const
{ return getCdAlias()->isLinkableInProject(); }
virtual bool isLinkable() const
{ return getCdAlias()->isLinkable(); }
virtual bool isVisibleInHierarchy() const
{ return getCdAlias()->isVisibleInHierarchy(); }
virtual bool visibleInParentsDeclList() const
{ return getCdAlias()->visibleInParentsDeclList(); }
virtual const ArgumentList &templateArguments() const
{ return getCdAlias()->templateArguments(); }
//virtual NamespaceDef *getNamespaceDef() const
//{ return getCdAlias()->getNamespaceDef(); }
virtual FileDef *getFileDef() const
{ return getCdAlias()->getFileDef(); }
virtual const MemberDef *getMemberByName(const QCString &s) const
{ return getCdAlias()->getMemberByName(s); }
virtual int isBaseClass(const ClassDef *bcd,bool followInstances) const
{ return getCdAlias()->isBaseClass(bcd,followInstances); }
virtual bool isSubClass(ClassDef *bcd,int level=0) const
{ return getCdAlias()->isSubClass(bcd,level); }
virtual bool isAccessibleMember(const MemberDef *md) const
{ return getCdAlias()->isAccessibleMember(md); }
virtual const TemplateInstanceList &getTemplateInstances() const
{ return getCdAlias()->getTemplateInstances(); }
virtual const ClassDef *templateMaster() const
{ return getCdAlias()->templateMaster(); }
virtual bool isTemplate() const
{ return getCdAlias()->isTemplate(); }
virtual const IncludeInfo *includeInfo() const
{ return getCdAlias()->includeInfo(); }
virtual const UsesClassList &usedImplementationClasses() const
{ return getCdAlias()->usedImplementationClasses(); }
virtual const UsesClassList &usedByImplementationClasses() const
{ return getCdAlias()->usedByImplementationClasses(); }
virtual const ConstraintClassList &templateTypeConstraints() const
{ return getCdAlias()->templateTypeConstraints(); }
virtual bool isTemplateArgument() const
{ return getCdAlias()->isTemplateArgument(); }
virtual const Definition *findInnerCompound(const QCString &name) const
{ return getCdAlias()->findInnerCompound(name); }
virtual ArgumentLists getTemplateParameterLists() const
{ return getCdAlias()->getTemplateParameterLists(); }
virtual QCString qualifiedNameWithTemplateParameters(
const ArgumentLists *actualParams=0,uint *actualParamIndex=0) const
{ return makeQualifiedNameWithTemplateParameters(this,actualParams,actualParamIndex); }
virtual bool isAbstract() const
{ return getCdAlias()->isAbstract(); }
virtual bool isObjectiveC() const
{ return getCdAlias()->isObjectiveC(); }
virtual bool isFortran() const
{ return getCdAlias()->isFortran(); }
virtual bool isCSharp() const
{ return getCdAlias()->isCSharp(); }
virtual bool isFinal() const
{ return getCdAlias()->isFinal(); }
virtual bool isSealed() const
{ return getCdAlias()->isSealed(); }
virtual bool isPublished() const
{ return getCdAlias()->isPublished(); }
virtual bool isExtension() const
{ return getCdAlias()->isExtension(); }
virtual bool isForwardDeclared() const
{ return getCdAlias()->isForwardDeclared(); }
virtual bool isInterface() const
{ return getCdAlias()->isInterface(); }
virtual ClassDef *categoryOf() const
{ return getCdAlias()->categoryOf(); }
virtual QCString className() const
{ return getCdAlias()->className(); }
virtual MemberList *getMemberList(MemberListType lt) const
{ return getCdAlias()->getMemberList(lt); }
virtual const MemberLists &getMemberLists() const
{ return getCdAlias()->getMemberLists(); }
virtual const MemberGroupList &getMemberGroups() const
{ return getCdAlias()->getMemberGroups(); }
virtual const TemplateNameMap &getTemplateBaseClassNames() const
{ return getCdAlias()->getTemplateBaseClassNames(); }
virtual bool isUsedOnly() const
{ return getCdAlias()->isUsedOnly(); }
virtual QCString anchor() const
{ return getCdAlias()->anchor(); }
virtual bool isEmbeddedInOuterScope() const
{ return getCdAlias()->isEmbeddedInOuterScope(); }
virtual bool isSimple() const
{ return getCdAlias()->isSimple(); }
virtual const ClassDef *tagLessReference() const
{ return getCdAlias()->tagLessReference(); }
virtual const MemberDef *isSmartPointer() const
{ return getCdAlias()->isSmartPointer(); }
virtual bool isJavaEnum() const
{ return getCdAlias()->isJavaEnum(); }
virtual QCString title() const
{ return getCdAlias()->title(); }
virtual QCString generatedFromFiles() const
{ return getCdAlias()->generatedFromFiles(); }
virtual const FileList &usedFiles() const
{ return getCdAlias()->usedFiles(); }
virtual const ArgumentList &typeConstraints() const
{ return getCdAlias()->typeConstraints(); }
virtual const ExampleList &getExamples() const
{ return getCdAlias()->getExamples(); }
virtual bool hasExamples() const
{ return getCdAlias()->hasExamples(); }
virtual QCString getMemberListFileName() const
{ return getCdAlias()->getMemberListFileName(); }
virtual bool subGrouping() const
{ return getCdAlias()->subGrouping(); }
virtual bool isSliceLocal() const
{ return getCdAlias()->isSliceLocal(); }
virtual bool hasNonReferenceSuperClass() const
{ return getCdAlias()->hasNonReferenceSuperClass(); }
virtual QCString requiresClause() const
{ return getCdAlias()->requiresClause(); }
virtual int countMembersIncludingGrouped(MemberListType lt,const ClassDef *inheritedFrom,bool additional) const
{ return getCdAlias()->countMembersIncludingGrouped(lt,inheritedFrom,additional); }
virtual int countInheritanceNodes() const
{ return getCdAlias()->countInheritanceNodes(); }
virtual int countMemberDeclarations(MemberListType lt,const ClassDef *inheritedFrom,
int lt2,bool invert,bool showAlways,ClassDefSet &visitedClasses) const
{ return getCdAlias()->countMemberDeclarations(lt,inheritedFrom,lt2,invert,showAlways,visitedClasses); }
virtual void writeDeclarationLink(OutputList &ol,bool &found,
const QCString &header,bool localNames) const
{ getCdAlias()->writeDeclarationLink(ol,found,header,localNames); }
virtual ClassDef *insertTemplateInstance(const QCString &fileName,int startLine,int startColumn,
const QCString &templSpec,bool &freshInstance) const
{ return getCdAlias()->insertTemplateInstance(fileName,startLine,startColumn,templSpec,freshInstance); }
virtual void updateBaseClasses(const BaseClassList &) {}
virtual void updateSubClasses(const BaseClassList &) {}
};
ClassDef *createClassDefAlias(const Definition *newScope,const ClassDef *cd)
{
ClassDef *acd = new ClassDefAliasImpl(newScope,cd);
//printf("cd name=%s localName=%s qualifiedName=%s qualifiedNameWith=%s displayName()=%s\n",
// qPrint(acd->name()),qPrint(acd->localName()),qPrint(acd->qualifiedName()),
// qPrint(acd->qualifiedNameWithTemplateParameters()),qPrint(acd->displayName()));
return acd;
}
//-----------------------------------------------------------------------------
/** Private data associated with a ClassDef object. */
class ClassDefImpl::IMPL
{
public:
IMPL();
~IMPL();
void init(const QCString &defFileName, const QCString &name,
const QCString &ctStr, const QCString &fName);
/*! file name that forms the base for the output file containing the
* class documentation. For compatibility with Qt (e.g. links via tag
* files) this name cannot be derived from the class name directly.
*/
QCString fileName;
/*! file name used for the list of all members */
QCString memberListFileName;
/*! file name used for the collaboration diagram */
QCString collabFileName;
/*! file name used for the inheritance graph */
QCString inheritFileName;
/*! Include information about the header file should be included
* in the documentation. 0 by default, set by setIncludeFile().
*/
std::unique_ptr<IncludeInfo> incInfo;
/*! List of base class (or super-classes) from which this class derives
* directly.
*/
BaseClassList inherits;
/*! List of sub-classes that directly derive from this class
*/
BaseClassList inheritedBy;
/*! Namespace this class is part of
* (this is the inner most namespace in case of nested namespaces)
*/
//NamespaceDef *nspace = 0;
/*! File this class is defined in */
FileDef *fileDef = 0;
/*! List of all members (including inherited members) */
MemberNameInfoLinkedMap allMemberNameInfoLinkedMap;
/*! Template arguments of this class */
ArgumentList tempArgs;
/*! Type constraints for template parameters */
ArgumentList typeConstraints;
/*! Files that were used for generating the class documentation. */
FileList files;
/*! Examples that use this class */
ExampleList examples;
/*! Holds the kind of "class" this is. */
ClassDef::CompoundType compType;
/*! The protection level in which this class was found.
* Typically Public, but for nested classes this can also be Protected
* or Private.
*/
Protection prot;
/*! The inner classes contained in this class. Will be 0 if there are
* no inner classes.
*/
ClassLinkedRefMap innerClasses;
/* classes for the collaboration diagram */
UsesClassList usesImplClassList;
UsesClassList usedByImplClassList;
ConstraintClassList constraintClassList;
/*! Template instances that exists of this class, the key in the
* dictionary is the template argument list.
*/
TemplateInstanceList templateInstances;
TemplateNameMap templBaseClassNames;
/*! The class this class is an instance of. */
const ClassDef *templateMaster = 0;
/*! local class name which could be a typedef'ed alias name. */
QCString className;
/*! If this class is a Objective-C category, then this points to the
* class which is extended.
*/
ClassDef *categoryOf = 0;
MemberLists memberLists;
/* user defined member groups */
MemberGroupList memberGroups;
/*! Is this an abstract class? */
bool isAbstract = false;
/*! Is the class part of an unnamed namespace? */
bool isStatic = false;
/*! TRUE if classes members are merged with those of the base classes. */
bool membersMerged = false;
/*! TRUE if the class is defined in a source file rather than a header file. */
bool isLocal = false;
bool isTemplArg = false;
/*! Does this class group its user-grouped members
* as a sub-section of the normal (public/protected/..)
* groups?
*/
bool subGrouping = false;
/** Reason of existence is a "use" relation */
bool usedOnly = false;
/** List of titles to use for the summary */
StringSet vhdlSummaryTitles;
/** Is this a simple (non-nested) C structure? */
bool isSimple = false;
/** Does this class overloaded the -> operator? */
const MemberDef *arrowOperator = 0;
const ClassDef *tagLessRef = 0;
/** Does this class represent a Java style enum? */
bool isJavaEnum = false;
uint64 spec = 0;
QCString metaData;
/** C++20 requires clause */
QCString requiresClause;
};
void ClassDefImpl::IMPL::init(const QCString &defFileName, const QCString &name,
const QCString &ctStr, const QCString &fName)
{
if (!fName.isEmpty())
{
fileName=stripExtension(fName);
}
else
{
fileName=ctStr+name;
}
prot=Public;
//nspace=0;
fileDef=0;
subGrouping=Config_getBool(SUBGROUPING);
templateMaster =0;
isAbstract = FALSE;
isStatic = FALSE;
isTemplArg = FALSE;
membersMerged = FALSE;
categoryOf = 0;
usedOnly = FALSE;
isSimple = Config_getBool(INLINE_SIMPLE_STRUCTS);
arrowOperator = 0;
tagLessRef = 0;
spec=0;
//QCString ns;
//extractNamespaceName(name,className,ns);
//printf("m_name=%s m_className=%s ns=%s\n",qPrint(m_name),qPrint(m_className),qPrint(ns));
// we cannot use getLanguage at this point, as setLanguage has not been called.
SrcLangExt lang = getLanguageFromFileName(defFileName);
if ((lang==SrcLangExt_Cpp || lang==SrcLangExt_ObjC) &&
guessSection(defFileName)==Entry::SOURCE_SEC)
{
isLocal=TRUE;
}
else
{
isLocal=FALSE;
}
}
ClassDefImpl::IMPL::IMPL()
{
}
ClassDefImpl::IMPL::~IMPL()
{
}
//-------------------------------------------------------------------------------------------
// constructs a new class definition
ClassDefImpl::ClassDefImpl(
const QCString &defFileName,int defLine,int defColumn,
const QCString &nm,CompoundType ct,
const QCString &lref,const QCString &fName,
bool isSymbol,bool isJavaEnum)
: DefinitionMixin(defFileName,defLine,defColumn,removeRedundantWhiteSpace(nm),0,0,isSymbol)
{
setReference(lref);
m_impl = new ClassDefImpl::IMPL;
m_impl->compType = ct;
m_impl->isJavaEnum = isJavaEnum;
m_impl->init(defFileName,name(),compoundTypeString(),fName);
m_impl->memberListFileName = convertNameToFile(compoundTypeString()+name()+"-members");
m_impl->collabFileName = convertNameToFile(m_impl->fileName+"_coll_graph");
m_impl->inheritFileName = convertNameToFile(m_impl->fileName+"_inherit_graph");
if (lref.isEmpty())
{
m_impl->fileName = convertNameToFile(m_impl->fileName);
}
}
// destroy the class definition
ClassDefImpl::~ClassDefImpl()
{
delete m_impl;
}
QCString ClassDefImpl::getMemberListFileName() const
{
return m_impl->memberListFileName;
}
QCString ClassDefImpl::displayName(bool includeScope) const
{
return makeDisplayName(this,includeScope);
}
// inserts a base/super class in the inheritance list
void ClassDefImpl::insertBaseClass(ClassDef *cd,const QCString &n,Protection p,
Specifier s,const QCString &t)
{
//printf("*** insert base class %s into %s\n",qPrint(cd->name()),qPrint(name()));
m_impl->inherits.push_back(BaseClassDef(cd,n,p,s,t));
m_impl->isSimple = FALSE;
}
// inserts a derived/sub class in the inherited-by list
void ClassDefImpl::insertSubClass(ClassDef *cd,Protection p,
Specifier s,const QCString &t)
{
//printf("*** insert sub class %s into %s\n",qPrint(cd->name()),qPrint(name()));
bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
if (!extractPrivate && cd->protection()==Private) return;
m_impl->inheritedBy.push_back(BaseClassDef(cd,QCString(),p,s,t));
m_impl->isSimple = FALSE;
}
void ClassDefImpl::addMembersToMemberGroup()
{
for (auto &ml : m_impl->memberLists)
{
if ((ml->listType()&MemberListType_detailedLists)==0)
{
::addMembersToMemberGroup(ml.get(),&m_impl->memberGroups,this);
}
}
// add members inside sections to their groups
for (const auto &mg : m_impl->memberGroups)
{
if (mg->allMembersInSameSection() && m_impl->subGrouping)
{
//printf("addToDeclarationSection(%s)\n",qPrint(mg->header()));
mg->addToDeclarationSection();
}
}
}
// adds new member definition to the class
void ClassDefImpl::internalInsertMember(const MemberDef *md,
Protection prot,
bool addToAllList
)
{
//printf("insertInternalMember(%s) isHidden()=%d\n",qPrint(md->name()),md->isHidden());
if (md->isHidden()) return;
if (getLanguage()==SrcLangExt_VHDL)
{
QCString title=theTranslator->trVhdlType(md->getMemberSpecifiers(),FALSE);
m_impl->vhdlSummaryTitles.insert(title.str());
}
if (1 /*!isReference()*/) // changed to 1 for showing members of external
// classes when HAVE_DOT and UML_LOOK are enabled.
{
bool isSimple=FALSE;
/********************************************/
/* insert member in the declaration section */
/********************************************/
if (md->isRelated() && protectionLevelVisible(prot))
{
addMemberToList(MemberListType_related,md,TRUE);
}
else if (md->isFriend())
{
addMemberToList(MemberListType_friends,md,TRUE);
}
else
{
switch (md->memberType())
{
case MemberType_Service: // UNO IDL
addMemberToList(MemberListType_services,md,TRUE);
break;
case MemberType_Interface: // UNO IDL
addMemberToList(MemberListType_interfaces,md,TRUE);
break;
case MemberType_Signal: // Qt specific
addMemberToList(MemberListType_signals,md,TRUE);
break;
case MemberType_DCOP: // KDE2 specific
addMemberToList(MemberListType_dcopMethods,md,TRUE);
break;
case MemberType_Property:
addMemberToList(MemberListType_properties,md,TRUE);
break;
case MemberType_Event:
addMemberToList(MemberListType_events,md,TRUE);
break;
case MemberType_Slot: // Qt specific
switch (prot)
{
case Protected:
case Package: // slots in packages are not possible!
addMemberToList(MemberListType_proSlots,md,TRUE);
break;
case Public:
addMemberToList(MemberListType_pubSlots,md,TRUE);
break;
case Private:
addMemberToList(MemberListType_priSlots,md,TRUE);
break;
}
break;
default: // any of the other members
if (md->isStatic())
{
if (md->isVariable())
{
switch (prot)
{
case Protected:
addMemberToList(MemberListType_proStaticAttribs,md,TRUE);
break;
case Package:
addMemberToList(MemberListType_pacStaticAttribs,md,TRUE);
break;
case Public:
addMemberToList(MemberListType_pubStaticAttribs,md,TRUE);
break;
case Private:
addMemberToList(MemberListType_priStaticAttribs,md,TRUE);
break;
}
}
else // function
{
switch (prot)
{
case Protected:
addMemberToList(MemberListType_proStaticMethods,md,TRUE);
break;
case Package:
addMemberToList(MemberListType_pacStaticMethods,md,TRUE);
break;
case Public:
addMemberToList(MemberListType_pubStaticMethods,md,TRUE);
break;
case Private:
addMemberToList(MemberListType_priStaticMethods,md,TRUE);
break;
}
}
}
else // not static
{
if (md->isVariable())
{
switch (prot)
{
case Protected:
addMemberToList(MemberListType_proAttribs,md,TRUE);
break;
case Package:
addMemberToList(MemberListType_pacAttribs,md,TRUE);
break;
case Public:
addMemberToList(MemberListType_pubAttribs,md,TRUE);
isSimple=!md->isFunctionPtr();
break;
case Private:
addMemberToList(MemberListType_priAttribs,md,TRUE);
break;
}
}
else if (md->isTypedef() || md->isEnumerate() || md->isEnumValue())
{
switch (prot)
{
case Protected:
addMemberToList(MemberListType_proTypes,md,TRUE);
break;
case Package:
addMemberToList(MemberListType_pacTypes,md,TRUE);
break;
case Public:
addMemberToList(MemberListType_pubTypes,md,TRUE);
isSimple=!md->isEnumerate() &&
!md->isEnumValue() &&
QCString(md->typeString()).find(")(")==-1; // func ptr typedef
break;
case Private:
addMemberToList(MemberListType_priTypes,md,TRUE);
break;
}
}
else // member function
{
switch (prot)
{