Doxygen
Loading...
Searching...
No Matches
memberdef.cpp
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * Copyright (C) 1997-2015 by Dimitri van Heesch.
4 *
5 * Permission to use, copy, modify, and distribute this software and its
6 * documentation under the terms of the GNU General Public License is hereby
7 * granted. No representations are made about the suitability of this software
8 * for any purpose. It is provided "as is" without express or implied warranty.
9 * See the GNU General Public License for more details.
10 *
11 * Documents produced by Doxygen are derivative works derived from the
12 * input used in their production; they are not affected by this license.
13 *
14 */
15
16
17#include <stdio.h>
18#include <assert.h>
19#include <mutex>
20
21#include "md5hash.h"
22#include "memberdef.h"
23#include "membername.h"
24#include "doxygen.h"
25#include "util.h"
26#include "code.h"
27#include "message.h"
28#include "htmlhelp.h"
29#include "language.h"
30#include "outputlist.h"
31#include "example.h"
32#include "membergroup.h"
33#include "groupdef.h"
34#include "defargs.h"
35#include "docparser.h"
36#include "dot.h"
37#include "dotcallgraph.h"
38#include "searchindex.h"
39#include "parserintf.h"
40#include "vhdldocgen.h"
41#include "arguments.h"
42#include "memberlist.h"
43#include "namespacedef.h"
44#include "moduledef.h"
45#include "filedef.h"
46#include "config.h"
47#include "definitionimpl.h"
48#include "regex.h"
49#include "trace.h"
50
51//-----------------------------------------------------------------------------
52
53class MemberDefImpl final : public DefinitionMixin<MemberDefMutable>
54{
55 public:
56 MemberDefImpl(const DString &defFileName,int defLine,size_t defColumn,
57 const DString &type,const DString &name,const DString &args,
58 const DString &excp,Protection prot,Specifier virt,bool stat,
59 Relationship related,MemberType t,const ArgumentList &tal,
60 const ArgumentList &al,const DString &metaData);
61 ~MemberDefImpl() override = default;
62 NON_COPYABLE(MemberDefImpl)
63
64 DefType definitionType() const override { return TypeMember; }
65 MemberDef *resolveAlias() override { return this; }
66 const MemberDef *resolveAlias() const override { return this; }
67 CodeSymbolType codeSymbolType() const override;
68 std::unique_ptr<MemberDef> deepCopy() const override;
69 void moveTo(Definition *) override;
70 DString getOutputFileBase() const override;
71 DString getReference() const override;
72 DString anchor() const override;
73 DString declaration() const override;
74 DString definition() const override;
75 DString typeString() const override;
76 DString argsString() const override;
77 DString excpString() const override;
78 DString bitfieldString() const override;
79 DString extraTypeChars() const override;
80 const DString &initializer() const override;
81 int initializerLines() const override;
82 TypeSpecifier getMemberSpecifiers() const override;
83 VhdlSpecifier getVhdlSpecifiers() const override;
84 const MemberList *getSectionList(const Definition *) const override;
85 DString displayDefinition() const override;
86 const ClassDef *getClassDef() const override;
87 ClassDef *getClassDef() override;
88 const FileDef *getFileDef() const override;
89 FileDef *getFileDef() override;
90 const NamespaceDef* getNamespaceDef() const override;
91 NamespaceDef* getNamespaceDef() override;
92 const GroupDef *getGroupDef() const override;
93 GroupDef *getGroupDef() override;
94 const ModuleDef *getModuleDef() const override;
95 DString getReadAccessor() const override;
96 DString getWriteAccessor() const override;
97 Grouping::GroupPri_t getGroupPri() const override;
98 DString getGroupFileName() const override;
99 int getGroupStartLine() const override;
100 bool getGroupHasDocs() const override;
101 DString qualifiedName() const override;
102 DString objCMethodName(bool localLink,bool showStatic) const override;
103 Protection protection() const override;
104 Specifier virtualness(int count=0) const override;
105 MemberType memberType() const override;
106 DString memberTypeName() const override;
107 bool isSignal() const override;
108 bool isSlot() const override;
109 bool isVariable() const override;
110 bool isEnumerate() const override;
111 bool isEnumValue() const override;
112 bool isTypedef() const override;
113 bool isSequence() const override;
114 bool isDictionary() const override;
115 bool isFunction() const override;
116 bool isFunctionPtr() const override;
117 bool isDefine() const override;
118 bool isFriend() const override;
119 bool isDCOP() const override;
120 bool isProperty() const override;
121 bool isEvent() const override;
122 bool isRelated() const override;
123 bool isForeign() const override;
124 bool isStatic() const override;
125 bool isInline() const override;
126 bool isExplicit() const override;
127 bool isMutable() const override;
128 bool isThreadLocal() const override;
129 bool isGettable() const override;
130 bool isPrivateGettable() const override;
131 bool isProtectedGettable() const override;
132 bool isSettable() const override;
133 bool isPrivateSettable() const override;
134 bool isProtectedSettable() const override;
135 bool isReadable() const override;
136 bool isWritable() const override;
137 bool isAddable() const override;
138 bool isRemovable() const override;
139 bool isRaisable() const override;
140 bool isFinal() const override;
141 bool isAbstract() const override;
142 bool isOverride() const override;
143 bool isInitonly() const override;
144 bool isOptional() const override;
145 bool isRequired() const override;
146 bool isNonAtomic() const override;
147 bool isCopy() const override;
148 bool isAssign() const override;
149 bool isRetain() const override;
150 bool isWeak() const override;
151 bool isStrong() const override;
152 bool isEnumStruct() const override;
153 bool isUnretained() const override;
154 bool isNew() const override;
155 bool isSealed() const override;
156 bool isImplementation() const override;
157 bool isExternal() const override;
158 bool isTypeAlias() const override;
159 bool isDefault() const override;
160 bool isDelete() const override;
161 bool isNoExcept() const override;
162 bool isAttribute() const override;
163 bool isUNOProperty() const override;
164 bool isReadonly() const override;
165 bool isBound() const override;
166 bool isConstrained() const override;
167 bool isTransient() const override;
168 bool isMaybeVoid() const override;
169 bool isMaybeDefault() const override;
170 bool isMaybeAmbiguous() const override;
171 bool isPublished() const override;
172 bool isTemplateSpecialization() const override;
173 bool isObjCMethod() const override;
174 bool isObjCProperty() const override;
175 bool isCSharpProperty() const override;
176 bool isConstructor() const override;
177 bool isDestructor() const override;
178 bool hasOneLineInitializer() const override;
179 bool hasMultiLineInitializer() const override;
180 bool isCallable() const override;
181 bool isStrongEnumValue() const override;
182 bool livesInsideEnum() const override;
183 bool isSliceLocal() const override;
184 bool isNoDiscard() const override;
185 bool isConstExpr() const override;
186 bool isConstEval() const override;
187 bool isConstInit() const override;
188 int numberOfFlowKeyWords() const override;
189 bool isFriendToHide() const override;
190 bool isNotFriend() const override;
191 bool isFunctionOrSignalSlot() const override;
192 bool isRelatedOrFriend() const override;
193 bool isLinkableInProject() const override;
194 bool isLinkable() const override;
195 bool hasDocumentation() const override;
196 bool hasUserDocumentation() const override;
197 bool isDeleted() const override;
198 bool isBriefSectionVisible() const override;
199 bool isDetailedSectionVisible(MemberListContainer container) const override;
200 bool hasDetailedDescription() const override;
201 bool isFriendClass() const override;
202 bool isDocumentedFriendClass() const override;
203 const MemberDef *reimplements() const override;
204 const MemberVector &reimplementedBy() const override;
205 bool isReimplementedBy(const ClassDef *cd) const override;
206 ClassDef *relatedAlso() const override;
207 bool hasDocumentedEnumValues() const override;
208 const MemberDef *getAnonymousEnumType() const override;
209 bool isDocsForDefinition() const override;
210 const MemberDef *getEnumScope() const override;
211 const MemberVector &enumFieldList() const override;
212 void setEnumBaseType(const DString &type) override;
213 DString enumBaseType() const override;
214 bool hasExamples() const override;
215 const ExampleList &getExamples() const override;
216 bool isPrototype() const override;
217 const ArgumentList &argumentList() const override;
218 const ArgumentList &declArgumentList() const override;
219 const ArgumentList &templateArguments() const override;
220 const ArgumentLists &definitionTemplateParameterLists() const override;
221 std::optional<ArgumentList> formalTemplateArguments() const override;
222 int getMemberGroupId() const override;
223 MemberGroup *getMemberGroup() const override;
224 bool hasCallGraph() const override;
225 bool hasCallerGraph() const override;
226 bool hasReferencesRelation() const override;
227 bool hasReferencedByRelation() const override;
228 bool hasEnumValues() const override;
229 bool hasInlineSource() const override;
230 bool isDocTransferDone() const override;
231 DString sourceRefName() const override;
232 const MemberDef *templateMaster() const override;
233 DString getScopeString() const override;
234 const ClassDef *getClassDefOfAnonymousType() const override;
235 bool isTypedefValCached() const override;
236 const ClassDef *getCachedTypedefVal() const override;
237 DString getCachedTypedefTemplSpec() const override;
238 DString getCachedResolvedTypedef() const override;
239 MemberDef *memberDefinition() const override;
240 MemberDef *memberDeclaration() const override;
241 const MemberDef *inheritsDocsFrom() const override;
242 const MemberDef *getGroupAlias() const override;
243 ClassDef *category() const override;
244 const MemberDef *categoryRelation() const override;
245 DString displayName(bool=true) const override;
246 DString getDeclType() const override;
247 StringVector getLabels(const Definition *container) const override;
248 const ArgumentList &typeConstraints() const override;
249 DString requiresClause() const override;
250 DString documentation() const override;
251 DString briefDescription(bool abbr=false) const override;
252 DString fieldType() const override;
253 bool isReference() const override;
254 DString getDeclFileName() const override;
255 int getDeclLine() const override;
256 size_t getDeclColumn() const override;
257 void setMemberType(MemberType t) override;
258 void setDefinition(const DString &d) override;
259 void setFileDef(FileDef *fd) override;
260 void setAnchor() override;
261 void setProtection(Protection p) override;
262 void setMemberSpecifiers(TypeSpecifier s) override;
263 void setVhdlSpecifiers(VhdlSpecifier s) override;
264 void mergeMemberSpecifiers(TypeSpecifier s) override;
265 void setInitializer(const DString &i) override;
266 void setBitfields(const DString &s) override;
267 void setMaxInitLines(int lines) override;
268 void setMemberClass(ClassDef *cd) override;
269 void setSectionList(const Definition *container,const MemberList *sl) override;
270 void setGroupDef(GroupDef *gd,Grouping::GroupPri_t pri,
271 const DString &fileName,int startLine,bool hasDocs,
272 MemberDef *member=nullptr) override;
273 void setReadAccessor(const DString &r) override;
274 void setWriteAccessor(const DString &w) override;
275 void setTemplateSpecialization(bool b) override;
276 void makeRelated() override;
277 void makeForeign() override;
278 void setInheritsDocsFrom(const MemberDef *md) override;
279 void setTagInfo(const TagInfo *i) override;
280 void setArgsString(const DString &as) override;
281 void setReimplements(MemberDef *md) override;
282 void insertReimplementedBy(MemberDef *md) override;
283 void setRelatedAlso(ClassDef *cd) override;
284 void insertEnumField(MemberDef *md) override;
285 void setEnumScope(MemberDef *md,bool livesInsideEnum=false) override;
286 void setEnumClassScope(ClassDef *cd) override;
287 void setDocumentedEnumValues(bool value) override;
288 void setAnonymousEnumType(const MemberDef *md) override;
289 bool addExample(const DString &anchor,const DString &name,const DString &file) override;
290 void setPrototype(bool p,const DString &df,int line, size_t column) override;
291 void setExplicitExternal(bool b,const DString &df,int line,size_t column) override;
292 void setDeclFile(const DString &df,int line,size_t column) override;
293 void moveArgumentList(std::unique_ptr<ArgumentList> al) override;
294 void moveDeclArgumentList(std::unique_ptr<ArgumentList> al) override;
295 void setDefinitionTemplateParameterLists(const ArgumentLists &lists) override;
296 void setTypeConstraints(const ArgumentList &al) override;
297 void setType(const DString &t) override;
298 void setNamespace(NamespaceDef *nd) override;
299 void setMemberGroup(MemberGroup *grp) override;
300 void setMemberGroupId(int id) override;
301 void makeImplementationDetail() override;
302 void overrideCallGraph(bool e) override;
303 void overrideCallerGraph(bool e) override;
304 void overrideReferencedByRelation(bool e) override;
305 void overrideReferencesRelation(bool e) override;
306 void overrideEnumValues(bool e) override;
307 void overrideInlineSource(bool e) override;
308 void setTemplateMaster(const MemberDef *mt) override;
309 void setFormalTemplateArguments(const ArgumentList &al) override;
310 void addListReference(const Definition *) override;
311 void addRequirementReferences(const Definition *) override;
312 void setDocsForDefinition(bool b) override;
313 void setGroupAlias(const MemberDef *md) override;
314 void cacheTypedefVal(const ClassDef *val,const DString &templSpec,const DString &resolvedType) override;
315 void invalidateTypedefValCache() override;
316 void invalidateCachedArgumentTypes() override;
317 void setMemberDefinition(MemberDef *md) override;
318 void setMemberDeclaration(MemberDef *md) override;
319 void copyArgumentNames(const MemberDef *bmd) override;
320 void setCategory(ClassDef *) override;
321 void setCategoryRelation(const MemberDef *) override;
322 void setDocumentation(const DString &d,const DString &docFile,int docLine,bool stripWhiteSpace=true) override;
323 void setBriefDescription(const DString &b,const DString &briefFile,int briefLine) override;
324 void setInbodyDocumentation(const DString &d,const DString &inbodyFile,int inbodyLine) override;
325 void setHidden(bool b) override;
326 void setDocTransferDone() override;
327 void setExplicitInherited(bool b) override;
328 void setRequiresClause(const DString &req) override;
329 void incrementFlowKeyWordCount() override;
330 void writeDeclaration(OutputList &ol,
331 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod,
332 bool inGroup, int indentLevel,const ClassDef *inheritFrom=nullptr,const DString &inheritId=DString()) const override;
333 void writeDocumentation(const MemberList *ml,int memCount,int memTotal,OutputList &ol,
334 const DString &scopeName,const Definition *container,
335 bool inGroup,bool showEnumValues=false,bool
336 showInline=false) const override;
337 void writeMemberDocSimple(OutputList &ol,const Definition *container) const override;
338 void writeEnumDeclaration(OutputList &typeDecl,
339 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod) const override;
340 void writeTagFile(TextStream &,bool useQualifiedName,bool showNamespaceMembers) const override;
341 void warnIfUndocumented() const override;
342 void warnIfUndocumentedParams() const override;
343 bool visibleInIndex() const override;
344 void detectUndocumentedParams(bool hasParamCommand,bool hasReturnCommand) const override;
345 std::unique_ptr<MemberDef> createTemplateInstanceMember(const ArgumentList &formalArgs,
346 const std::unique_ptr<ArgumentList> &actualArgs) const override;
347 void findSectionsInDocumentation() override;
348 void writeLink(OutputList &ol,
349 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod,
350 bool onlyText=false) const override;
351 void resolveUnnamedParameters(const MemberDef *md) override;
352 void addQualifiers(const StringVector &qualifiers) override;
353 StringVector getQualifiers() const override;
354 ClassDefMutable *getClassDefMutable() override;
355 void setModuleDef(ModuleDef *mod) override;
356 int redefineCount() const override;
357 void setRedefineCount(int) override;
358 void setClassDefOfAnonymousType(const ClassDef *cd) override;
359
360 private:
361 void _computeLinkableInProject();
362 void _computeIsConstructor();
363 void _computeIsDestructor();
364 void _writeGroupInclude(OutputList &ol,bool inGroup) const;
365 void _writeMultiLineInitializer(OutputList &ol,const DString &scopeName) const;
366 void _writeCallGraph(OutputList &ol) const;
367 void _writeCallerGraph(OutputList &ol) const;
368 void _writeReimplements(OutputList &ol) const;
369 bool _isReimplements() const;
370 void _writeReimplementedBy(OutputList &ol) const;
371 size_t _countReimplementedBy() const;
372 void _writeExamples(OutputList &ol) const;
373 void _writeTypeConstraints(OutputList &ol) const;
374 void _writeEnumValues(OutputList &ol,const Definition *container,
375 const DString &cfname,const DString &ciname,
376 const DString &cname) const;
377 void _writeCategoryRelation(OutputList &ol) const;
378 void _writeTagData(const DefType) const;
379 void _writeTemplatePrefix(OutputList &ol, const Definition *def,
380 const ArgumentList &al, bool writeReqClause=true) const;
381 bool _hasVisibleCallGraph() const;
382 bool _hasVisibleCallerGraph() const;
383 bool _isAnonymousBitField() const;
384
385
386 void init(Definition *def,const DString &t,const DString &a,const DString &e,
387 Protection p,Specifier v,bool s,Relationship r,
388 MemberType mt,const ArgumentList &tal,
389 const ArgumentList &al,const DString &meta
390 );
391
392 uint8_t m_isLinkableCached; // 0 = not cached, 1=false, 2=true
393 uint8_t m_isConstructorCached; // 0 = not cached, 1=false, 2=true
394 uint8_t m_isDestructorCached; // 1 = not cached, 1=false, 2=true
395
396 ClassDef *m_classDef = nullptr; // member of or related to
397 FileDef *m_fileDef = nullptr; // member of file definition
398 NamespaceDef *m_nspace = nullptr; // the namespace this member is in.
399 ModuleDef *m_moduleDef = nullptr;
400
401 const MemberDef *m_enumScope = nullptr; // the enclosing scope, if this is an enum field
402 bool m_livesInsideEnum = false;
403 const MemberDef *m_annEnumType = nullptr; // the anonymous enum that is the type of this member
404 MemberVector m_enumFields; // enumeration fields
405
406 MemberDef *m_redefines = nullptr; // the members that this member redefines
407 MemberVector m_redefinedBy; // the list of members that redefine this one
408
409 MemberDef *m_memDef = nullptr; // member definition for this declaration
410 MemberDef *m_memDec = nullptr; // member declaration for this definition
411 ClassDef *m_relatedAlso = nullptr; // points to class marked by relatedAlso
412
413 ExampleList m_examples; // a dictionary of all examples for quick access
414
415 DString m_type; // return actual type
416 DString m_args; // function arguments/variable array specifiers
417 DString m_def; // member definition in code (fully qualified name)
418 DString m_anc; // HTML anchor name
419 Specifier m_virt = Specifier::Normal; // normal/virtual/pure virtual
420 Protection m_prot = Protection::Public; // protection type [Public/Protected/Private]
421 DString m_decl; // member declaration in class
422
423 DString m_bitfields; // struct member bitfields
424 DString m_read; // property read accessor
425 DString m_write; // property write accessor
426 DString m_exception; // exceptions that can be thrown
427 DString m_initializer; // initializer
428 DString m_extraTypeChars; // extra type info found after the argument list
429 DString m_enumBaseType; // base type of the enum (C++11)
430 DString m_requiresClause; // requires clause (C++20)
431 int m_initLines = 0; // number of lines in the initializer
432 bool m_docTransferDone = false;
433
434 TypeSpecifier m_memSpec; // The specifiers present for this member
435 VhdlSpecifier m_vhdlSpec;
436 MemberType m_mtype = MemberType::Define; // returns the kind of member
437 int m_maxInitLines = 0; // when the initializer will be displayed
438 int m_userInitLines = 0; // result of explicit \hideinitializer or \showinitializer
439
440 ArgumentList m_defArgList; // argument list of this member definition
441 ArgumentList m_declArgList; // argument list of this member declaration
442
443 ArgumentList m_tArgList; // template argument list of function template
444 ArgumentList m_typeConstraints; // type constraints for template parameters
445 const MemberDef *m_templateMaster = nullptr;
446 std::optional<ArgumentList> m_formalTemplateArguments;
447 ArgumentLists m_defTmpArgLists; // lists of template argument lists
448 // (for template functions in nested template classes)
449
450 DString m_metaData; // Slice metadata.
451
452 const ClassDef *m_anonymousType = nullptr; // if the member has an anonymous compound
453 // as its type then this is computed by
454 // getClassDefOfAnonymousType() and
455 // cached here.
456 std::map<const Definition *,const MemberList *> m_sectionMap;
457
458 const MemberDef *m_groupAlias = nullptr; // Member containing the definition
459 int m_grpId = 0; // group id
460 MemberGroup *m_memberGroup = nullptr; // group's member definition
461 GroupDef *m_group = nullptr; // group in which this member is in
462 Grouping::GroupPri_t m_grouppri = Grouping::GROUPING_AUTO_DEF; // priority of this definition
463 DString m_groupFileName; // file where this grouping was defined
464 int m_groupStartLine = 0; // line " " " " "
465 MemberDef *m_groupMember = nullptr;
466
467 bool m_isTypedefValCached = false;
468 const ClassDef *m_cachedTypedefValue = nullptr;
469 DString m_cachedTypedefTemplSpec;
470 DString m_cachedResolvedType;
471
472 // documentation inheritance
473 const MemberDef *m_docProvider = nullptr;
474
475 // to store the output file base from tag files
476 DString m_explicitOutputFileBase;
477 bool m_explicitInherited = false;
478
479 // to store extra qualifiers
480 StringVector m_qualifiers;
481
482 // objective-c
483 bool m_implOnly = false; // function found in implementation but not
484 // in the interface
485 mutable bool m_hasDocumentedParams = false; // guard to show only the first warning, acts as cache
486 mutable bool m_hasDocumentedReturnType = false; // guard to show only the first warning, acts as cache
487 bool m_isDMember = false;
488 Relationship m_related = Relationship::Member; // relationship of this to the class
489 bool m_stat = false; // is it a static function?
490 bool m_proto = false; // is it a prototype?
491 bool m_docEnumValues = false; // is an enum with documented enum values.
492
493 mutable bool m_hasDetailedDescriptionCached = false;
494 mutable bool m_detailedDescriptionCachedValue = false;
495 // const member.
496 bool m_hasCallGraph = false;
497 bool m_hasCallerGraph = false;
498 bool m_hasReferencedByRelation = false;
499 bool m_hasReferencesRelation = false;
500 bool m_hasInlineSource = false;
501 bool m_hasEnumValues = false;
502 bool m_explExt = false; // member was explicitly declared external
503 bool m_tspec = false; // member is a template specialization
504 bool m_groupHasDocs = false; // true if the entry that caused the grouping was documented
505 bool m_docsForDefinition = false; // true => documentation block is put before
506 // definition.
507 // false => block is put before declaration.
508 ClassDef *m_category = nullptr;
509 const MemberDef *m_categoryRelation = nullptr;
510 DString m_declFileName;
511 int m_declLine = -1;
512 size_t m_declColumn = 1;
513 int m_numberOfFlowKW = 0;
514 int m_redefineCount = 0;
515};
516
517std::unique_ptr<MemberDef> createMemberDef(const DString &defFileName,int defLine,size_t defColumn,
518 const DString &type,const DString &name,const DString &args,
519 const DString &excp,Protection prot,Specifier virt,bool stat,
520 Relationship related,MemberType t,const ArgumentList &tal,
521 const ArgumentList &al,const DString &metaData)
522{
523 return std::make_unique<MemberDefImpl>(defFileName,defLine,defColumn,type,name,args,excp,prot,virt,
524 stat,related,t,tal,al,metaData);
525}
526
527//-----------------------------------------------------------------------------
528
529class MemberDefAliasImpl final : public DefinitionAliasMixin<MemberDef>
530{
531 public:
532 MemberDefAliasImpl(const Definition *newScope,const MemberDef *md)
533 : DefinitionAliasMixin(newScope,md), m_memberGroup(nullptr) { init(); }
534 ~MemberDefAliasImpl() override { deinit(); }
535 NON_COPYABLE(MemberDefAliasImpl)
536
537 DefType definitionType() const override { return TypeMember; }
538
539 const MemberDef *getMdAlias() const { return toMemberDef(getAlias()); }
540 MemberDef *getMdAlias() { return toMemberDef(const_cast<Definition*>(getAlias())); }
541 MemberDef *resolveAlias() override { return const_cast<MemberDef*>(getMdAlias()); }
542 const MemberDef *resolveAlias() const override { return getMdAlias(); }
543
544 std::unique_ptr<MemberDef> deepCopy() const override {
545 return createMemberDefAlias(getScope(),getMdAlias());
546 }
547 void moveTo(Definition *) override {}
548
549 const DString &name() const override
550 { return getMdAlias()->name(); }
551 CodeSymbolType codeSymbolType() const override
552 { return getMdAlias()->codeSymbolType(); }
553 DString getOutputFileBase() const override
554 { return getMdAlias()->getOutputFileBase(); }
555 DString getReference() const override
556 { return getMdAlias()->getReference(); }
557 DString anchor() const override
558 { return getMdAlias()->anchor(); }
559 DString declaration() const override
560 { return getMdAlias()->declaration(); }
561 DString definition() const override
562 { return getMdAlias()->definition(); }
563 DString typeString() const override
564 { return getMdAlias()->typeString(); }
565 DString argsString() const override
566 { return getMdAlias()->argsString(); }
567 DString excpString() const override
568 { return getMdAlias()->excpString(); }
569 DString bitfieldString() const override
570 { return getMdAlias()->bitfieldString(); }
571 DString extraTypeChars() const override
572 { return getMdAlias()->extraTypeChars(); }
573 const DString &initializer() const override
574 { return getMdAlias()->initializer(); }
575 int initializerLines() const override
576 { return getMdAlias()->initializerLines(); }
579 VhdlSpecifier getVhdlSpecifiers() const override
580 { return getMdAlias()->getVhdlSpecifiers(); }
581 const MemberList *getSectionList(const Definition *container) const override
582 { return getMdAlias()->getSectionList(container); }
583 DString displayDefinition() const override
584 { return getMdAlias()->displayDefinition(); }
585
586 const ClassDef *getClassDef() const override
587 { return getMdAlias()->getClassDef(); }
588 ClassDef *getClassDef() override
589 { return getMdAlias()->getClassDef(); }
590
591 const FileDef *getFileDef() const override
592 { return getMdAlias()->getFileDef(); }
593 FileDef *getFileDef() override
594 { return getMdAlias()->getFileDef(); }
595
596 const ModuleDef *getModuleDef() const override
597 { return getMdAlias()->getModuleDef(); }
598
599 const NamespaceDef* getNamespaceDef() const override
600 { return getMdAlias()->getNamespaceDef(); }
601 NamespaceDef* getNamespaceDef() override
602 { return getMdAlias()->getNamespaceDef(); }
603
604 DString getReadAccessor() const override
605 { return getMdAlias()->getReadAccessor(); }
606 DString getWriteAccessor() const override
607 { return getMdAlias()->getWriteAccessor(); }
608 const GroupDef *getGroupDef() const override
609 { return getMdAlias()->getGroupDef(); }
610 GroupDef *getGroupDef() override
611 { return getMdAlias()->getGroupDef(); }
612 Grouping::GroupPri_t getGroupPri() const override
613 { return getMdAlias()->getGroupPri(); }
614 DString getGroupFileName() const override
615 { return getMdAlias()->getGroupFileName(); }
616 int getGroupStartLine() const override
617 { return getMdAlias()->getGroupStartLine(); }
618 bool getGroupHasDocs() const override
619 { return getMdAlias()->getGroupHasDocs(); }
620 DString qualifiedName() const override
621 { return getMdAlias()->qualifiedName(); }
622 DString objCMethodName(bool localLink,bool showStatic) const override
623 { return getMdAlias()->objCMethodName(localLink,showStatic); }
624 Protection protection() const override
625 { return getMdAlias()->protection(); }
626 Specifier virtualness(int /* count */) const override
627 { return getMdAlias()->virtualness(); }
628 MemberType memberType() const override
629 { return getMdAlias()->memberType(); }
630 DString memberTypeName() const override
631 { return getMdAlias()->memberTypeName(); }
632 bool isSignal() const override
633 { return getMdAlias()->isSignal(); }
634 bool isSlot() const override
635 { return getMdAlias()->isSlot(); }
636 bool isVariable() const override
637 { return getMdAlias()->isVariable(); }
638 bool isEnumerate() const override
639 { return getMdAlias()->isEnumerate(); }
640 bool isEnumValue() const override
641 { return getMdAlias()->isEnumValue(); }
642 bool isTypedef() const override
643 { return getMdAlias()->isTypedef(); }
644 bool isSequence() const override
645 { return getMdAlias()->isSequence(); }
646 bool isDictionary() const override
647 { return getMdAlias()->isDictionary(); }
648 bool isFunction() const override
649 { return getMdAlias()->isFunction(); }
650 bool isFunctionPtr() const override
651 { return getMdAlias()->isFunctionPtr(); }
652 bool isDefine() const override
653 { return getMdAlias()->isDefine(); }
654 bool isFriend() const override
655 { return getMdAlias()->isFriend(); }
656 bool isDCOP() const override
657 { return getMdAlias()->isDCOP(); }
658 bool isProperty() const override
659 { return getMdAlias()->isProperty(); }
660 bool isEvent() const override
661 { return getMdAlias()->isEvent(); }
662 bool isRelated() const override
663 { return getMdAlias()->isRelated(); }
664 bool isForeign() const override
665 { return getMdAlias()->isForeign(); }
666 bool isStatic() const override
667 { return getMdAlias()->isStatic(); }
668 bool isInline() const override
669 { return getMdAlias()->isInline(); }
670 bool isExplicit() const override
671 { return getMdAlias()->isExplicit(); }
672 bool isMutable() const override
673 { return getMdAlias()->isMutable(); }
674 bool isThreadLocal() const override
675 { return getMdAlias()->isThreadLocal(); }
676 bool isGettable() const override
677 { return getMdAlias()->isGettable(); }
678 bool isPrivateGettable() const override
679 { return getMdAlias()->isPrivateGettable(); }
680 bool isProtectedGettable() const override
681 { return getMdAlias()->isProtectedGettable(); }
682 bool isSettable() const override
683 { return getMdAlias()->isSettable(); }
684 bool isPrivateSettable() const override
685 { return getMdAlias()->isPrivateSettable(); }
686 bool isProtectedSettable() const override
687 { return getMdAlias()->isProtectedSettable(); }
688 bool isReadable() const override
689 { return getMdAlias()->isReadable(); }
690 bool isWritable() const override
691 { return getMdAlias()->isWritable(); }
692 bool isAddable() const override
693 { return getMdAlias()->isAddable(); }
694 bool isRemovable() const override
695 { return getMdAlias()->isRemovable(); }
696 bool isRaisable() const override
697 { return getMdAlias()->isRaisable(); }
698 bool isFinal() const override
699 { return getMdAlias()->isFinal(); }
700 bool isAbstract() const override
701 { return getMdAlias()->isAbstract(); }
702 bool isOverride() const override
703 { return getMdAlias()->isOverride(); }
704 bool isInitonly() const override
705 { return getMdAlias()->isInitonly(); }
706 bool isOptional() const override
707 { return getMdAlias()->isOptional(); }
708 bool isRequired() const override
709 { return getMdAlias()->isRequired(); }
710 bool isNonAtomic() const override
711 { return getMdAlias()->isNonAtomic(); }
712 bool isCopy() const override
713 { return getMdAlias()->isCopy(); }
714 bool isAssign() const override
715 { return getMdAlias()->isAssign(); }
716 bool isRetain() const override
717 { return getMdAlias()->isRetain(); }
718 bool isWeak() const override
719 { return getMdAlias()->isWeak(); }
720 bool isStrong() const override
721 { return getMdAlias()->isStrong(); }
722 bool isEnumStruct() const override
723 { return getMdAlias()->isEnumStruct(); }
724 bool isUnretained() const override
725 { return getMdAlias()->isUnretained(); }
726 bool isNew() const override
727 { return getMdAlias()->isNew(); }
728 bool isSealed() const override
729 { return getMdAlias()->isSealed(); }
730 bool isImplementation() const override
731 { return getMdAlias()->isImplementation(); }
732 bool isExternal() const override
733 { return getMdAlias()->isExternal(); }
734 bool isTypeAlias() const override
735 { return getMdAlias()->isTypeAlias(); }
736 bool isDefault() const override
737 { return getMdAlias()->isDefault(); }
738 bool isDelete() const override
739 { return getMdAlias()->isDelete(); }
740 bool isNoExcept() const override
741 { return getMdAlias()->isNoExcept(); }
742 bool isAttribute() const override
743 { return getMdAlias()->isAttribute(); }
744 bool isUNOProperty() const override
745 { return getMdAlias()->isUNOProperty(); }
746 bool isReadonly() const override
747 { return getMdAlias()->isReadable(); }
748 bool isBound() const override
749 { return getMdAlias()->isBound(); }
750 bool isConstrained() const override
751 { return getMdAlias()->isConstrained(); }
752 bool isTransient() const override
753 { return getMdAlias()->isTransient(); }
754 bool isMaybeVoid() const override
755 { return getMdAlias()->isMaybeVoid(); }
756 bool isMaybeDefault() const override
757 { return getMdAlias()->isMaybeDefault(); }
758 bool isMaybeAmbiguous() const override
759 { return getMdAlias()->isMaybeAmbiguous(); }
760 bool isPublished() const override
761 { return getMdAlias()->isPublished(); }
762 bool isTemplateSpecialization() const override
763 { return getMdAlias()->isTemplateSpecialization(); }
764 bool isObjCMethod() const override
765 { return getMdAlias()->isObjCMethod(); }
766 bool isObjCProperty() const override
767 { return getMdAlias()->isObjCProperty(); }
768 bool isCSharpProperty() const override
769 { return getMdAlias()->isCSharpProperty(); }
770 bool isConstructor() const override
771 { return getMdAlias()->isConstructor(); }
772 bool isDestructor() const override
773 { return getMdAlias()->isDestructor(); }
774 bool hasOneLineInitializer() const override
775 { return getMdAlias()->hasOneLineInitializer(); }
776 bool hasMultiLineInitializer() const override
777 { return getMdAlias()->hasMultiLineInitializer(); }
778 bool isCallable() const override
779 { return getMdAlias()->isCallable(); }
780 bool isStrongEnumValue() const override
781 { return getMdAlias()->isStrongEnumValue(); }
782 bool livesInsideEnum() const override
783 { return getMdAlias()->livesInsideEnum(); }
784 bool isSliceLocal() const override
785 { return getMdAlias()->isSliceLocal(); }
786 bool isNoDiscard() const override
787 { return getMdAlias()->isNoDiscard(); }
788 bool isConstExpr() const override
789 { return getMdAlias()->isConstExpr(); }
790 bool isConstEval() const override
791 { return getMdAlias()->isConstEval(); }
792 bool isConstInit() const override
793 { return getMdAlias()->isConstInit(); }
794 int numberOfFlowKeyWords() const override
795 { return getMdAlias()->numberOfFlowKeyWords(); }
796 bool isFriendToHide() const override
797 { return getMdAlias()->isFriendToHide(); }
798 bool isNotFriend() const override
799 { return getMdAlias()->isNotFriend(); }
800 bool isFunctionOrSignalSlot() const override
801 { return getMdAlias()->isFunctionOrSignalSlot(); }
802 bool isRelatedOrFriend() const override
803 { return getMdAlias()->isRelatedOrFriend(); }
804 bool isLinkableInProject() const override
805 { return getMdAlias()->isLinkableInProject(); }
806 bool isLinkable() const override
807 { return getMdAlias()->isLinkable(); }
808 bool hasDocumentation() const override
809 { return getMdAlias()->hasDocumentation(); }
810 bool hasUserDocumentation() const override
811 { return getMdAlias()->hasUserDocumentation(); }
812 bool isDeleted() const override
813 { return getMdAlias()->isDeleted(); }
814 bool isBriefSectionVisible() const override
815 { return getMdAlias()->isBriefSectionVisible(); }
816 bool isDetailedSectionVisible(MemberListContainer container) const override
817 { return getMdAlias()->isDetailedSectionVisible(container); }
818 bool hasDetailedDescription() const override
819 { return getMdAlias()->hasDetailedDescription(); }
820 bool isFriendClass() const override
821 { return getMdAlias()->isFriendClass(); }
822 bool isDocumentedFriendClass() const override
823 { return getMdAlias()->isDocumentedFriendClass(); }
824 const MemberDef *reimplements() const override
825 { return getMdAlias()->reimplements(); }
826 const MemberVector &reimplementedBy() const override
827 { return getMdAlias()->reimplementedBy(); }
828 bool isReimplementedBy(const ClassDef *cd) const override
829 { return getMdAlias()->isReimplementedBy(cd); }
830 ClassDef *relatedAlso() const override
831 { return getMdAlias()->relatedAlso(); }
832 bool hasDocumentedEnumValues() const override
833 { return getMdAlias()->hasDocumentedEnumValues(); }
834 const MemberDef *getAnonymousEnumType() const override
835 { return getMdAlias()->getAnonymousEnumType(); }
836 bool isDocsForDefinition() const override
837 { return getMdAlias()->isDocsForDefinition(); }
838 const MemberDef *getEnumScope() const override
839 { return getMdAlias()->getEnumScope(); }
840 const MemberVector &enumFieldList() const override
841 { return getMdAlias()->enumFieldList(); }
842 DString enumBaseType() const override
843 { return getMdAlias()->enumBaseType(); }
844 bool hasExamples() const override
845 { return getMdAlias()->hasExamples(); }
846 const ExampleList &getExamples() const override
847 { return getMdAlias()->getExamples(); }
848 bool isPrototype() const override
849 { return getMdAlias()->isPrototype(); }
850 const ArgumentList &argumentList() const override
851 { return getMdAlias()->argumentList(); }
852 const ArgumentList &declArgumentList() const override
853 { return getMdAlias()->declArgumentList(); }
854 const ArgumentList &templateArguments() const override
855 { return getMdAlias()->templateArguments(); }
858 std::optional<ArgumentList> formalTemplateArguments() const override
859 { return getMdAlias()->formalTemplateArguments(); }
860 int getMemberGroupId() const override
861 { return getMdAlias()->getMemberGroupId(); }
862 MemberGroup *getMemberGroup() const override
863 { return m_memberGroup; }
864 bool hasCallGraph() const override
865 { return getMdAlias()->hasCallGraph(); }
866 bool hasCallerGraph() const override
867 { return getMdAlias()->hasCallerGraph(); }
868 bool hasReferencesRelation() const override
869 { return getMdAlias()->hasReferencesRelation(); }
870 bool hasReferencedByRelation() const override
871 { return getMdAlias()->hasReferencedByRelation(); }
872 bool hasInlineSource() const override
873 { return getMdAlias()->hasInlineSource(); }
874 bool isDocTransferDone() const override
875 { return getMdAlias()->isDocTransferDone(); }
876 DString sourceRefName() const override
877 { return getMdAlias()->sourceRefName(); }
878 bool hasEnumValues() const override
879 { return getMdAlias()->hasEnumValues(); }
880 StringVector getQualifiers() const override
881 { return getMdAlias()->getQualifiers(); }
882 const MemberDef *templateMaster() const override
883 { return getMdAlias()->templateMaster(); }
884 DString getScopeString() const override
885 { return getMdAlias()->getScopeString(); }
886 const ClassDef *getClassDefOfAnonymousType() const override
887 { return getMdAlias()->getClassDefOfAnonymousType(); }
888 bool isTypedefValCached() const override
889 { return getMdAlias()->isTypedefValCached(); }
890 const ClassDef *getCachedTypedefVal() const override
891 { return getMdAlias()->getCachedTypedefVal(); }
896 MemberDef *memberDefinition() const override
897 { return getMdAlias()->memberDefinition(); }
898 MemberDef *memberDeclaration() const override
899 { return getMdAlias()->memberDeclaration(); }
900 const MemberDef *inheritsDocsFrom() const override
901 { return getMdAlias()->inheritsDocsFrom(); }
902 const MemberDef *getGroupAlias() const override
903 { return getMdAlias()->getGroupAlias(); }
904 ClassDef *category() const override
905 { return getMdAlias()->category(); }
906 const MemberDef *categoryRelation() const override
907 { return getMdAlias()->categoryRelation(); }
908 DString displayName(bool b=true) const override
909 { return getMdAlias()->displayName(b); }
910 DString getDeclType() const override
911 { return getMdAlias()->getDeclType(); }
912 StringVector getLabels(const Definition *container) const override
913 { return getMdAlias()->getLabels(container); }
914 const ArgumentList &typeConstraints() const override
915 { return getMdAlias()->typeConstraints(); }
916 DString documentation() const override
917 { return getMdAlias()->documentation(); }
918 DString briefDescription(bool /* abbr=false */) const override
919 { return getMdAlias()->briefDescription(); }
920 DString fieldType() const override
921 { return getMdAlias()->fieldType(); }
922 bool isReference() const override
923 { return getMdAlias()->isReference(); }
924 DString getDeclFileName() const override
925 { return getMdAlias()->getDeclFileName(); }
926 int getDeclLine() const override
927 { return getMdAlias()->getDeclLine(); }
928 size_t getDeclColumn() const override
929 { return getMdAlias()->getDeclColumn(); }
930 DString requiresClause() const override
931 { return getMdAlias()->requiresClause(); }
932 bool visibleInIndex() const override
933 { return getMdAlias()->visibleInIndex(); }
934 int redefineCount() const override
935 { return getMdAlias()->redefineCount(); }
936
937 void warnIfUndocumented() const override {}
938 void warnIfUndocumentedParams() const override {}
939 void detectUndocumentedParams(bool /* hasParamCommand */,bool /* hasReturnCommand */) const override {}
940 void setMemberGroup(MemberGroup *grp) override { m_memberGroup = grp; }
941 std::unique_ptr<MemberDef> createTemplateInstanceMember(const ArgumentList &formalArgs,
942 const std::unique_ptr<ArgumentList> &actualArgs) const override
943 { return getMdAlias()->createTemplateInstanceMember(formalArgs,actualArgs); }
944
945 void writeDeclaration(OutputList &ol,
946 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod,
947 bool inGroup, int indentLevel, const ClassDef *inheritFrom=nullptr,const DString &inheritId=DString()) const override
948 {
949 getMdAlias()->writeDeclaration(ol,cd,nd,fd,gd,mod,inGroup,indentLevel,inheritFrom,inheritId);
950 }
951 void writeEnumDeclaration(OutputList &typeDecl,
952 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod) const override
953 {
954 getMdAlias()->writeEnumDeclaration(typeDecl,cd,nd,fd,gd,mod);
955 }
956 void writeLink(OutputList &ol,
957 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod,
958 bool onlyText=false) const override
959 {
960 getMdAlias()->writeLink(ol,cd,nd,fd,gd,mod,onlyText);
961 }
962 private:
963 MemberGroup *m_memberGroup; // group's member definition
964};
965
966
967std::unique_ptr<MemberDef> createMemberDefAlias(const Definition *newScope,const MemberDef *aliasMd)
968{
969 auto amd = std::make_unique<MemberDefAliasImpl>(newScope,aliasMd);
970 //printf("amd: name=%s displayName=%s\n",qPrint(amd->name()),qPrint(amd->displayName()));
971 return amd;
972}
973
974//-----------------------------------------------------------------------------
975
976static void writePageRef(OutputList &ol,const DString &cn,const DString &mn)
977{
978 ol.pushGeneratorState();
979
980 ol.disable(OutputType::Html);
981 ol.disable(OutputType::Man);
982 ol.disable(OutputType::Docbook);
983 if (Config_getBool(PDF_HYPERLINKS)) ol.disable(OutputType::Latex);
984 if (Config_getBool(RTF_HYPERLINKS)) ol.disable(OutputType::RTF);
985 ol.startPageRef();
986 ol.docify(theTranslator->trPageAbbreviation());
987 ol.endPageRef(cn,mn);
988
989 ol.popGeneratorState();
990}
991
992
993//-----------------------------------------------------------------------------
994
995static DString addTemplateNames(const DString &s,const DString &n,const DString &t)
996{
997 DString result;
998 DString clRealName=n;
999 size_t p=0,i=0;
1000 if ((i=clRealName.find('<'))!=DString::npos)
1001 {
1002 clRealName=clRealName.left(i); // strip template specialization
1003 }
1004 if ((i=clRealName.rfind("::"))!=DString::npos)
1005 {
1006 clRealName=clRealName.mid(i+2);
1007 }
1008 while ((i=s.find(clRealName,p))!=DString::npos)
1009 {
1010 result+=s.mid(p,i-p);
1011 size_t j=clRealName.length()+i;
1012 if (s.length()==j || (s.at(j)!='<' && !isId(s.at(j))))
1013 { // add template names
1014 //printf("Adding %s+%s\n",qPrint(clRealName),qPrint(t));
1015 result+=clRealName+t;
1016 }
1017 else
1018 { // template names already present
1019 //printf("Adding %s\n",qPrint(clRealName));
1020 result+=clRealName;
1021 }
1022 p=i+clRealName.length();
1023 }
1024 result+=s.mid(p);
1025 //printf("addTemplateNames(%s,%s,%s)=%s\n",qPrint(s),qPrint(n),qPrint(t),qPrint(result));
1026 return result;
1027}
1028
1029// ol.startMemberDocName has already been done before this is called.
1030// when this function returns true, ol.endParameterList will be called.
1031//
1032// typical sequence:
1033// ol.startMemberDoc
1034// ol.startMemberDocName
1035// --- enter writeDefArgumentList
1036// ol.endMemberDocName
1037// ol.startParameterList
1038// ...
1039// ol.startParameterType(first=true)
1040// ol.endParameterType
1041// ol.startParameterName
1042// ol.endParameterName
1043// ol.startParameterExtra
1044// ol.startParameterDefVal [optional]
1045// ol.endParameterDefVal [optional]
1046// ol.endParameterExtra(last==false)
1047// ...
1048// ol.startParameterType(first=false)
1049// ol.endParameterType
1050// ol.startParameterName
1051// ol.endParameterName
1052// ol.startParameterExtra
1053// ol.endParameterExtra(last==true)
1054// ...
1055// --- leave writeDefArgumentList with return value true
1056// ol.endParameterList
1057// ol.endMemberDoc(hasArgs=true)
1058//
1059// For an empty list the function should return false, the sequence is
1060// ol.startMemberDoc
1061// ol.startMemberDocName
1062// --- enter writeDefArgumentList
1063// --- leave writeDefArgumentList with return value false
1064// ol.endMemberDocName
1065// ol.endMemberDoc(hasArgs=false);
1066//
1067
1068static bool writeDefArgumentList(OutputList &ol,const Definition *scope,const MemberDef *md)
1069{
1070 const ArgumentList &defArgList=(md->isDocsForDefinition()) ?
1071 md->argumentList() : md->declArgumentList();
1072 //printf("writeDefArgumentList '%s' isDocsForDefinition()=%d hasParameters()=%d (%s)\n",
1073 // qPrint(md->name()),md->isDocsForDefinition(),defArgList.hasParameters(),qPrint(argListToString(defArgList)));
1074 if (!defArgList.hasParameters() || md->isProperty() || md->isTypedef())
1075 {
1076 return false; // member has no function like argument list
1077 }
1078
1079 bool isDefine = md->isDefine();
1080 if (!isDefine) ol.docify(" ");
1081
1082 //printf("writeDefArgList(%d)\n",defArgList->count());
1083 ol.endMemberDocName();
1084 ol.startParameterList(!md->isObjCMethod());
1085 //printf("===> name=%s isDefine=%d\n",qPrint(md->name()),md->isDefine());
1086
1087 DString cName;
1088 if (scope)
1089 {
1090 cName=scope->name();
1091 size_t il=cName.find('<');
1092 size_t ir=cName.rfind('>');
1093 if (il!=DString::npos && ir!=DString::npos && ir>il)
1094 {
1095 cName=cName.mid(il,ir-il+1);
1096 //printf("1. cName=%s\n",qPrint(cName));
1097 }
1098 else if (scope->definitionType()==Definition::TypeClass)
1099 {
1100 cName=tempArgListToString((toClassDef(scope))->templateArguments(),
1101 scope->getLanguage());
1102 //printf("2. cName=%s\n",qPrint(cName));
1103 }
1104 else // no template specifier
1105 {
1106 cName.clear();
1107 }
1108 }
1109 //printf("~~~ %s cName=%s\n",qPrint(md->name()),qPrint(cName));
1110
1111 DString sep = getLanguageSpecificSeparator(md->getLanguage(),true);
1112
1113 LinkifyTextOptions options;
1114 options.setScope(scope).setFileScope(md->getBodyDef()).setSelf(md);
1115
1116 bool first=true;
1117 bool paramTypeStarted=false;
1118 auto alIt = defArgList.begin();
1119 while (alIt!=defArgList.end())
1120 {
1121 Argument a = *alIt;
1122 if (isDefine || first)
1123 {
1124 ol.startParameterType(first,DString());
1125 paramTypeStarted=true;
1126 if (isDefine)
1127 {
1128 ol.endParameterType();
1129 ol.startParameterName(true);
1130 }
1131 }
1132
1133 if (!a.attrib.empty() && !md->isObjCMethod()) // argument has an IDL attribute
1134 {
1135 ol.docify(a.attrib+" ");
1136 }
1137
1138 DString atype = a.type;
1139 if (sep!="::") { atype=substitute(atype,"::",sep); }
1140
1141 size_t funcPtrPos=DString::npos;
1142 {
1143 if (md->isObjCMethod()) { atype.prepend("("); atype.append(")"); }
1144 if (atype!="...")
1145 {
1146 if (!cName.empty() && scope && scope!=Doxygen::globalScope)
1147 {
1148 atype=addTemplateNames(atype,scope->name(),cName);
1149 }
1150 // 1. split ...*)(... -> '*' + name + ')(...'
1151 // 2. split ...*[some thing])(... -> '*' + name + '[some thing])(...'
1152 size_t starPos = atype.find('*'); // find pointer
1153 if (starPos==DString::npos) starPos = atype.find('&'); // can also be reference
1154 funcPtrPos = atype.find(")(");
1155 if (starPos!=DString::npos && funcPtrPos!=DString::npos && funcPtrPos>starPos)
1156 {
1157 funcPtrPos=starPos+1;
1158 }
1159 else
1160 {
1161 funcPtrPos=DString::npos;
1162 }
1163 linkifyText(TextGeneratorOLImpl(ol),
1164 funcPtrPos==DString::npos ? atype : atype.left(funcPtrPos),
1165 options);
1166 }
1167 }
1168
1169 if (!isDefine)
1170 {
1171 if (paramTypeStarted)
1172 {
1173 ol.endParameterType();
1174 paramTypeStarted=false;
1175 }
1176 ol.startParameterName(defArgList.size()<2);
1177 }
1178 else
1179 {
1180 ol.endParameterName();
1181 }
1182
1183 if (atype=="...")
1184 {
1185 ol.docify(atype);
1186 }
1187 else if (!a.name.empty()) // argument has a name
1188 {
1189 ol.docify(a.name);
1190 }
1191 if (!isDefine)
1192 {
1193 if (funcPtrPos!=DString::npos)
1194 {
1195 ol.writeNonBreakableSpace(1);
1196 }
1197 ol.endParameterName();
1198 }
1199 ol.startParameterExtra();
1200 if (funcPtrPos!=DString::npos)
1201 {
1202 linkifyText(TextGeneratorOLImpl(ol),atype.mid(funcPtrPos),options);
1203 }
1204 if (!a.array.empty())
1205 {
1206 ol.docify(a.array);
1207 }
1208 if (!a.defval.empty()) // write the default value
1209 {
1210 DString n=a.defval;
1211 if (scope && scope!=Doxygen::globalScope && !cName.empty())
1212 {
1213 n=addTemplateNames(n,scope->name(),cName);
1214 }
1215 ol.startParameterDefVal(" = ");
1216 linkifyText(TextGeneratorOLImpl(ol),n,LinkifyTextOptions(options).setKeepSpaces(true));
1217 ol.endParameterDefVal();
1218 }
1219 ++alIt;
1220 if (alIt!=defArgList.end())
1221 {
1222 a = *alIt;
1223 if (!md->isObjCMethod()) ol.docify(", "); // there are more arguments
1224 if (!isDefine)
1225 {
1226 DString key;
1227 if (md->isObjCMethod() && a.attrib.length()>=2)
1228 {
1229 //printf("Found parameter keyword %s\n",a.qPrint(attrib));
1230 // strip [ and ]
1231 key=a.attrib.mid(1,a.attrib.length()-2);
1232 if (key!=",") key+=":"; // for normal keywords add colon
1233 }
1234 ol.endParameterExtra(false,false,!md->isObjCMethod());
1235 ol.startParameterType(false,key);
1236 paramTypeStarted=true;
1237 }
1238 else // isDefine
1239 {
1240 ol.endParameterExtra(false,false,true);
1241 }
1242 }
1243 first=false;
1244 }
1245 if (first)
1246 {
1247 ol.startParameterName(defArgList.size()<2);
1248 ol.endParameterName();
1249 ol.startParameterExtra();
1250 }
1251 ol.endParameterExtra(true,defArgList.size()<2,!md->isObjCMethod());
1252 if (!md->extraTypeChars().empty())
1253 {
1254 ol.docify(md->extraTypeChars());
1255 }
1256 if (defArgList.constSpecifier())
1257 {
1258 ol.docify(" const");
1259 }
1260 if (defArgList.volatileSpecifier())
1261 {
1262 ol.docify(" volatile");
1263 }
1264 if (defArgList.refQualifier()==RefQualifierType::LValue)
1265 {
1266 ol.docify(" &");
1267 }
1268 else if (defArgList.refQualifier()==RefQualifierType::RValue)
1269 {
1270 ol.docify(" &&");
1271 }
1272 if (!defArgList.trailingReturnType().empty())
1273 {
1274 linkifyText(TextGeneratorOLImpl(ol), defArgList.trailingReturnType(), options);
1275 }
1276 return true;
1277}
1278
1279static void writeExceptionListImpl(
1280 OutputList &ol, const ClassDef *cd, const MemberDef *md, DString const& exception)
1281{
1282 // this is ordinary exception spec - there must be a '('
1283 //printf("exception='%s'\n",qPrint(exception));
1284 size_t index = exception.find('(');
1285 LinkifyTextOptions options;
1286 options.setScope(cd).setFileScope(md->getBodyDef()).setSelf(md);
1287 if (index!=DString::npos)
1288 {
1289 ol.exceptionEntry(exception.left(index),false);
1290 ++index; // paren in second column so skip it here
1291 for (size_t comma = exception.find(',', index); comma!=DString::npos; )
1292 {
1293 ++comma; // include comma
1294 linkifyText(TextGeneratorOLImpl(ol),exception.mid(index,comma-index),options);
1295 ol.exceptionEntry(DString(),false);
1296 index=comma;
1297 comma = exception.find(',', index);
1298 }
1299 if (size_t close = exception.find(')', index); close!=DString::npos)
1300 {
1301 DString type=removeRedundantWhiteSpace(exception.mid(index,close-index));
1302 linkifyText(TextGeneratorOLImpl(ol),type,options);
1303 ol.exceptionEntry(DString(),true);
1304 }
1305 else
1306 {
1307 warn(md->getDefFileName(),md->getDefLine(),
1308 "missing ) in exception list on member {}",md->name());
1309 }
1310 }
1311 else // Java Exception
1312 {
1313 ol.docify(" ");
1314 linkifyText(TextGeneratorOLImpl(ol),exception,options);
1315 }
1316}
1317
1318static void writeExceptionList(OutputList &ol, const ClassDef *cd, const MemberDef *md)
1319{
1320 DString exception = md->excpString().stripWhiteSpace();
1321 if (exception.at(0)=='{')
1322 {
1323 // this is an UNO IDL attribute - need special handling
1324 size_t index = exception.find(';');
1325 size_t oldIndex = 1;
1326 while (index!=DString::npos) // there should be no more than 2 (set / get)
1327 {
1328 // omit '{' and ';' -> "set raises (...)"
1329 writeExceptionListImpl(ol,cd,md,exception.mid(oldIndex,index-oldIndex));
1330 oldIndex = index+1;
1331 index = exception.find(';',oldIndex);
1332 }
1333 // the rest is now just '}' - omit that
1334 }
1335 else
1336 {
1337 writeExceptionListImpl(ol,cd,md,exception);
1338 }
1339}
1340
1341//-----------------------------------------------------------------------------
1342//-----------------------------------------------------------------------------
1343//-----------------------------------------------------------------------------
1344
1345void MemberDefImpl::init(Definition *d,
1346 const DString &t,const DString &a,const DString &e,
1347 Protection p,Specifier v,bool s,Relationship r,
1348 MemberType mt,const ArgumentList &tal,
1349 const ArgumentList &al,const DString &meta
1350 )
1351{
1352 m_classDef=nullptr;
1353 m_fileDef=nullptr;
1354 m_moduleDef=nullptr;
1355 m_redefines=nullptr;
1356 m_relatedAlso=nullptr;
1357 m_nspace=nullptr;
1358 m_memDef=nullptr;
1359 m_memDec=nullptr;
1360 m_group=nullptr;
1361 m_grpId=-1;
1362 m_enumScope=nullptr;
1363 m_livesInsideEnum=false;
1364 m_hasCallGraph = Config_getBool(CALL_GRAPH);
1365 m_hasCallerGraph = Config_getBool(CALLER_GRAPH);
1366 m_hasReferencedByRelation = Config_getBool(REFERENCED_BY_RELATION);
1367 m_hasReferencesRelation = Config_getBool(REFERENCES_RELATION);
1368 m_hasEnumValues = Config_getBool(SHOW_ENUM_VALUES);
1369 m_hasInlineSource = Config_getBool(INLINE_SOURCES);
1370 m_initLines=0;
1371 m_type=t;
1372 if (mt==MemberType::Typedef) m_type.stripPrefix("typedef ");
1373 // type.stripPrefix("struct ");
1374 // type.stripPrefix("class " );
1375 // type.stripPrefix("union " );
1376 m_type=removeRedundantWhiteSpace(m_type);
1377 m_args=a;
1378 m_args=removeRedundantWhiteSpace(m_args);
1379 if (m_type.empty()) m_decl=d->name()+m_args; else m_decl=m_type+" "+d->name()+m_args;
1380
1381 m_memberGroup=nullptr;
1382 m_virt=v;
1383 m_prot=p;
1384 m_related=r;
1385 m_stat=s;
1386 m_mtype=mt;
1387 m_exception=e;
1388 m_proto=false;
1389 m_memSpec=TypeSpecifier();
1390 m_vhdlSpec=VhdlSpecifier::UNKNOWN;
1391 m_annEnumType=nullptr;
1392 m_groupAlias=nullptr;
1393 m_explExt=false;
1394 m_tspec=false;
1395 m_anonymousType=nullptr;
1396 m_maxInitLines=Config_getInt(MAX_INITIALIZER_LINES);
1397 m_userInitLines=-1;
1398 m_docEnumValues=false;
1399 // copy function template arguments (if any)
1400 m_tArgList = tal;
1401 //printf("new member al=%p\n",al);
1402 // copy function definition arguments (if any)
1403 m_defArgList = al;
1404 // convert function declaration arguments (if any)
1405 if (!m_args.empty())
1406 {
1407 m_declArgList = *stringToArgumentList(d->getLanguage(),m_args,&m_extraTypeChars);
1408 //printf("setDeclArgList %s to %s const=%d\n",qPrint(args),
1409 // qPrint(argListToString(declArgList)),declArgList->constSpecifier);
1410 }
1411 m_metaData = meta;
1412 m_templateMaster = nullptr;
1413 m_docsForDefinition = true;
1414 m_isTypedefValCached = false;
1415 m_cachedTypedefValue = nullptr;
1416 m_implOnly=false;
1417 m_groupMember = nullptr;
1418 m_hasDocumentedParams = false;
1419 m_hasDocumentedReturnType = false;
1420 m_docProvider = nullptr;
1421 m_isDMember = d->getDefFileName().lower().endsWith(".d");
1422}
1423
1424
1425//-----------------------------------------------------------------------------
1426//-----------------------------------------------------------------------------
1427//-----------------------------------------------------------------------------
1428
1429/*! Creates a new member definition.
1430 *
1431 * \param df File containing the definition of this member.
1432 * \param dl Line at which the member definition was found.
1433 * \param dc Column at which the member definition was found.
1434 * \param t A string representing the type of the member.
1435 * \param na A string representing the name of the member.
1436 * \param a A string representing the arguments of the member.
1437 * \param e A string representing the throw clause of the members.
1438 * \param p The protection context of the member, possible values are:
1439 * \c Public, \c Protected, \c Private.
1440 * \param v The degree of 'virtualness' of the member, possible values are:
1441 * \c Normal, \c Virtual, \c Pure.
1442 * \param s A boolean that is true iff the member is static.
1443 * \param r The relationship between the class and the member.
1444 * \param mt The kind of member. See #MemberType for a list of
1445 * all types.
1446 * \param tal The template arguments of this member.
1447 * \param al The arguments of this member. This is a structured form of
1448 * the string past as argument \a a.
1449 * \param meta Slice metadata.
1450 */
1451
1452MemberDefImpl::MemberDefImpl(const DString &df,int dl,size_t dc,
1453 const DString &t,const DString &na,const DString &a,const DString &e,
1454 Protection p,Specifier v,bool s,Relationship r,MemberType mt,
1455 const ArgumentList &tal,const ArgumentList &al,const DString &meta
1456 ) : DefinitionMixin(df,dl,dc,removeRedundantWhiteSpace(na))
1457{
1458 //printf("MemberDefImpl::MemberDef(%s)\n",qPrint(na));
1459 init(this,t,a,e,p,v,s,r,mt,tal,al,meta);
1460 m_isLinkableCached = 0;
1461 m_isConstructorCached = 0;
1462 m_isDestructorCached = 0;
1463}
1464
1465std::unique_ptr<MemberDef> MemberDefImpl::deepCopy() const
1466{
1467 std::unique_ptr<MemberDefImpl> result(new MemberDefImpl(
1468 getDefFileName(),getDefLine(),getDefColumn(),m_type,localName(),m_args,m_exception,
1469 m_prot,m_virt,m_stat,m_related,m_mtype,m_tArgList,m_defArgList,m_metaData));
1470 // first copy base members
1471 result->DefinitionMixin<MemberDefMutable>::operator=(*this);
1472 // then copy other members
1473 result->m_typeConstraints = m_typeConstraints ;
1474 result->m_declArgList = m_declArgList ;
1475 result->m_classDef = m_classDef ;
1476 result->m_fileDef = m_fileDef ;
1477 result->m_moduleDef = m_moduleDef ;
1478 result->m_nspace = m_nspace ;
1479 result->m_enumScope = m_enumScope ;
1480 result->m_livesInsideEnum = m_livesInsideEnum ;
1481 result->m_annEnumType = m_annEnumType ;
1482 result->m_enumFields = m_enumFields ;
1483 result->m_redefines = m_redefines ;
1484 result->m_redefinedBy = m_redefinedBy ;
1485 result->m_memDef = m_memDef ;
1486 result->m_memDec = m_memDec ;
1487 result->m_relatedAlso = m_relatedAlso ;
1488 result->m_examples = m_examples ;
1489 result->m_def = m_def ;
1490 result->m_anc = m_anc ;
1491 result->m_decl = m_decl ;
1492 result->m_bitfields = m_bitfields ;
1493 result->m_read = m_read ;
1494 result->m_write = m_write ;
1495 result->m_exception = m_exception ;
1496 result->m_initializer = m_initializer ;
1497 result->m_extraTypeChars = m_extraTypeChars ;
1498 result->m_enumBaseType = m_enumBaseType ;
1499 result->m_requiresClause = m_requiresClause ;
1500 result->m_initLines = m_initLines ;
1501 result->m_memSpec = m_memSpec ;
1502 result->m_vhdlSpec = m_vhdlSpec ;
1503 result->m_maxInitLines = m_maxInitLines ;
1504 result->m_userInitLines = m_userInitLines ;
1505 result->m_defArgList = m_defArgList ;
1506 result->m_declArgList = m_declArgList ;
1507 result->m_tArgList = m_tArgList ;
1508 result->m_typeConstraints = m_typeConstraints ;
1509 result->m_templateMaster = m_templateMaster ;
1510 result->m_formalTemplateArguments = m_formalTemplateArguments ;
1511 result->m_defTmpArgLists = m_defTmpArgLists ;
1512 result->m_anonymousType = m_anonymousType ;
1513 result->m_sectionMap = m_sectionMap ;
1514 result->m_groupAlias = m_groupAlias ;
1515 result->m_grpId = m_grpId ;
1516 result->m_memberGroup = m_memberGroup ;
1517 result->m_group = m_group ;
1518 result->m_grouppri = m_grouppri ;
1519 result->m_groupFileName = m_groupFileName ;
1520 result->m_groupStartLine = m_groupStartLine ;
1521 result->m_groupMember = m_groupMember ;
1522 result->m_isTypedefValCached = m_isTypedefValCached ;
1523 result->m_cachedTypedefValue = m_cachedTypedefValue ;
1524 result->m_cachedTypedefTemplSpec = m_cachedTypedefTemplSpec ;
1525 result->m_cachedResolvedType = m_cachedResolvedType ;
1526 result->m_docProvider = m_docProvider ;
1527 result->m_explicitOutputFileBase = m_explicitOutputFileBase ;
1528 result->m_qualifiers = m_qualifiers ;
1529 result->m_implOnly = m_implOnly ;
1530 result->m_hasDocumentedParams = m_hasDocumentedParams ;
1531 result->m_hasDocumentedReturnType = m_hasDocumentedReturnType ;
1532 result->m_isDMember = m_isDMember ;
1533 result->m_proto = m_proto ;
1534 result->m_docEnumValues = m_docEnumValues ;
1535 result->m_hasDetailedDescriptionCached = m_hasDetailedDescriptionCached ;
1536 result->m_detailedDescriptionCachedValue = m_detailedDescriptionCachedValue ;
1537 result->m_hasCallGraph = m_hasCallGraph ;
1538 result->m_hasCallerGraph = m_hasCallerGraph ;
1539 result->m_hasReferencedByRelation = m_hasReferencedByRelation ;
1540 result->m_hasReferencesRelation = m_hasReferencesRelation ;
1541 result->m_hasEnumValues = m_hasEnumValues ;
1542 result->m_hasInlineSource = m_hasInlineSource ;
1543 result->m_explExt = m_explExt ;
1544 result->m_tspec = m_tspec ;
1545 result->m_groupHasDocs = m_groupHasDocs ;
1546 result->m_docsForDefinition = m_docsForDefinition ;
1547 result->m_category = m_category ;
1548 result->m_categoryRelation = m_categoryRelation ;
1549 result->m_declFileName = m_declFileName ;
1550 result->m_declLine = m_declLine ;
1551 result->m_declColumn = m_declColumn ;
1552 result->m_numberOfFlowKW = m_numberOfFlowKW ;
1553 result->setDefinitionTemplateParameterLists(m_defTmpArgLists);
1554
1555 result->m_isLinkableCached = 0;
1556 result->m_isConstructorCached = 0;
1557 result->m_isDestructorCached = 0;
1558 return result;
1559}
1560
1561void MemberDefImpl::moveTo(Definition *scope)
1562{
1563 setOuterScope(scope);
1564 if (scope->definitionType()==Definition::TypeClass)
1565 {
1566 m_classDef = toClassDef(scope);
1567 }
1568 else if (scope->definitionType()==Definition::TypeFile)
1569 {
1570 m_fileDef = toFileDef(scope);
1571 }
1572 else if (scope->definitionType()==Definition::TypeModule)
1573 {
1574 m_moduleDef = toModuleDef(scope);
1575 }
1576 else if (scope->definitionType()==Definition::TypeNamespace)
1577 {
1578 m_nspace = toNamespaceDef(scope);
1579 }
1580 m_isLinkableCached = 0;
1581 m_isConstructorCached = 0;
1582}
1583
1584
1589
1590void MemberDefImpl::insertReimplementedBy(MemberDef *md)
1591{
1592 if (m_templateMaster)
1593 {
1594 MemberDefMutable *mdm = toMemberDefMutable(const_cast<MemberDef *>(m_templateMaster));
1595 if (mdm)
1596 {
1597 mdm->insertReimplementedBy(md);
1598 }
1599 }
1600 if (!m_redefinedBy.contains(md))
1601 {
1602 m_redefinedBy.inSort(md);
1603 }
1604}
1605
1606const MemberDef *MemberDefImpl::reimplements() const
1607{
1608 return m_redefines;
1609}
1610
1611const MemberVector &MemberDefImpl::reimplementedBy() const
1612{
1613 return m_redefinedBy;
1614}
1615
1616bool MemberDefImpl::isReimplementedBy(const ClassDef *cd) const
1617{
1618 if (cd)
1619 {
1620 for (const auto &md : m_redefinedBy)
1621 {
1622 const ClassDef *mcd = md->getClassDef();
1623 if (mcd)
1624 {
1625 if (cd==mcd || cd->isBaseClass(mcd,true))
1626 {
1627 return true;
1628 }
1629 }
1630 }
1631 }
1632 return false;
1633}
1634
1639
1640bool MemberDefImpl::addExample(const DString &anchor,const DString &nameStr, const DString &file)
1641{
1642 //printf("%s::addExample(%s,%s,%s)\n",qPrint(name()),anchor,nameStr,file);
1643 return m_examples.inSort(Example(anchor,nameStr,file));
1644}
1645
1646bool MemberDefImpl::hasExamples() const
1647{
1648 return !m_examples.empty();
1649}
1650
1651DString MemberDefImpl::sourceRefName() const
1652{
1653 DString n = name();
1654 DString s = getScopeString();
1655
1656 if (!s.empty())
1657 {
1658 n.prepend(s+"::");
1659 }
1660 else if (isStatic() && getFileDef())
1661 {
1662 n.prepend(getFileDef()->name()+":");
1663 }
1664 if (isCallable())
1665 {
1666 n.append(argsString());
1667 }
1668 return n;
1669}
1670
1671DString MemberDefImpl::getOutputFileBase() const
1672{
1673 bool separateMemberPages = Config_getBool(SEPARATE_MEMBER_PAGES);
1674 bool inlineSimpleClasses = Config_getBool(INLINE_SIMPLE_STRUCTS);
1675 DString baseName;
1676
1677 //printf("Member: %s: templateMaster=%p group=%p classDef=%p nspace=%p fileDef=%p\n",
1678 // qPrint(name()),m_templateMaster,m_group,m_classDef,
1679 // m_nspace,m_fileDef);
1680 const NamespaceDef *nspace = getNamespaceDef();
1681 const FileDef *fileDef = getFileDef();
1682 const ClassDef *classDef = getClassDef();
1683 const ModuleDef *moduleDef = getModuleDef();
1684 const GroupDef *groupDef = getGroupDef();
1685 if (!m_explicitOutputFileBase.empty())
1686 {
1687 return m_explicitOutputFileBase;
1688 }
1689 else if (templateMaster())
1690 {
1691 return templateMaster()->getOutputFileBase();
1692 }
1693 else if (groupDef)
1694 {
1695 baseName=groupDef->getOutputFileBase();
1696 }
1697 else if (classDef)
1698 {
1699 baseName=classDef->getOutputFileBase();
1700 if (inlineSimpleClasses && classDef->isSimple())
1701 {
1702 return baseName;
1703 }
1704 }
1705 else if (nspace && (nspace->isLinkable() || nspace->isAnonymous()))
1706 {
1707 baseName=nspace->getOutputFileBase();
1708 }
1709 else if (fileDef)
1710 {
1711 baseName=fileDef->getOutputFileBase();
1712 }
1713 else if (moduleDef)
1714 {
1715 baseName=moduleDef->getOutputFileBase();
1716 }
1717
1718 if (baseName.empty())
1719 {
1720 warn(getDefFileName(),getDefLine(),
1721 "Internal inconsistency: member {} does not belong to any container!",name()
1722 );
1723 return "dummy";
1724 }
1725 else if (separateMemberPages && hasDetailedDescription())
1726 {
1727 if (getEnumScope()) // enum value, which is part of enum's documentation
1728 {
1729 baseName+="_"+getEnumScope()->anchor();
1730 }
1731 else
1732 {
1733 baseName+="_"+anchor();
1734 }
1735 }
1736 return baseName;
1737}
1738
1739DString MemberDefImpl::getReference() const
1740{
1741 DString ref = DefinitionMixin::getReference();
1742 if (!ref.empty())
1743 {
1744 return ref;
1745 }
1746 const NamespaceDef *nspace = getNamespaceDef();
1747 const FileDef *fileDef = getFileDef();
1748 const ClassDef *classDef = getClassDef();
1749 const ModuleDef *moduleDef = getModuleDef();
1750 const GroupDef *groupDef = getGroupDef();
1751 if (templateMaster())
1752 {
1753 return templateMaster()->getReference();
1754 }
1755 else if (groupDef)
1756 {
1757 return groupDef->getReference();
1758 }
1759 else if (classDef)
1760 {
1761 return classDef->getReference();
1762 }
1763 else if (nspace)
1764 {
1765 return nspace->getReference();
1766 }
1767 else if (moduleDef)
1768 {
1769 return moduleDef->getReference();
1770 }
1771 else if (fileDef)
1772 {
1773 return fileDef->getReference();
1774 }
1775 return "";
1776}
1777
1778DString MemberDefImpl::anchor() const
1779{
1780 DString result=m_anc;
1781 if (m_groupAlias) return m_groupAlias->anchor();
1782 if (m_templateMaster) return m_templateMaster->anchor();
1783 if (m_enumScope && m_enumScope!=this) // avoid recursion for C#'s public enum E { E, F }
1784 {
1785 result.prepend(m_enumScope->anchor());
1786 }
1787 if (getGroupDef())
1788 {
1789 if (m_groupMember)
1790 {
1791 result=m_groupMember->anchor();
1792 }
1793 else if (getReference().empty())
1794 {
1795 result.prepend("g");
1796 }
1797 }
1798 return result;
1799}
1800
1801void MemberDefImpl::_computeLinkableInProject()
1802{
1803 AUTO_TRACE("name={}",qualifiedName());
1804 bool extractStatic = Config_getBool(EXTRACT_STATIC);
1805 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
1806 m_isLinkableCached = 2; // linkable
1807 //printf("MemberDefImpl::isLinkableInProject(name=%s)\n",qPrint(name()));
1808 if (isHidden())
1809 {
1810 AUTO_TRACE_ADD("is hidden");
1811 m_isLinkableCached = 1;
1812 return;
1813 }
1814 if (templateMaster())
1815 {
1816 AUTO_TRACE_ADD("has master template");
1817 m_isLinkableCached = templateMaster()->isLinkableInProject() ? 2 : 1;
1818 return;
1819 }
1820 if (isAnonymous())
1821 {
1822 AUTO_TRACE_ADD("name invalid");
1823 m_isLinkableCached = 1; // not a valid or a dummy name
1824 return;
1825 }
1826 if (!hasDocumentation() || isReference())
1827 {
1828 AUTO_TRACE_ADD("no docs or reference");
1829 m_isLinkableCached = 1; // no documentation
1830 return;
1831 }
1832 const GroupDef *groupDef = getGroupDef();
1833 const ClassDef *classDef = getClassDef();
1834 if (groupDef && !groupDef->isLinkableInProject())
1835 {
1836 AUTO_TRACE_ADD("in not linkable group");
1837 m_isLinkableCached = 1; // group but group not linkable
1838 return;
1839 }
1840 if (!groupDef && classDef && !classDef->isLinkableInProject())
1841 {
1842 AUTO_TRACE_ADD("in not linkable class");
1843 m_isLinkableCached = 1; // in class but class not linkable
1844 return;
1845 }
1846 const NamespaceDef *nspace = getNamespaceDef();
1847 const FileDef *fileDef = getFileDef();
1848 if (!groupDef && nspace /*&& m_related==Relationship::Member*/ && !nspace->isLinkableInProject()
1849 && (fileDef==nullptr || !fileDef->isLinkableInProject()))
1850 {
1851 AUTO_TRACE_ADD("in not linkable namespace");
1852 m_isLinkableCached = 1; // in namespace but namespace not linkable
1853 return;
1854 }
1855 if (!groupDef && !nspace &&
1856 /*m_related==Relationship::Member &&*/ !classDef &&
1857 fileDef && !fileDef->isLinkableInProject())
1858 {
1859 AUTO_TRACE_ADD("in not linkable file");
1860 m_isLinkableCached = 1; // in file (and not in namespace) but file not linkable
1861 return;
1862 }
1863 if ((!protectionLevelVisible(m_prot) && m_mtype!=MemberType::Friend) &&
1864 !(m_prot==Protection::Private && (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual))
1865 {
1866 AUTO_TRACE_ADD("private and invisible");
1867 m_isLinkableCached = 1; // hidden due to protection
1868 return;
1869 }
1870 if (m_stat && classDef==nullptr && !extractStatic)
1871 {
1872 AUTO_TRACE_ADD("static and invisible");
1873 m_isLinkableCached = 1; // hidden due to staticness
1874 return;
1875 }
1876 AUTO_TRACE_ADD("linkable");
1877 return; // linkable!
1878}
1879
1885
1891
1896
1901
1907
1913
1914bool MemberDefImpl::isLinkableInProject() const
1915{
1916 if (m_isLinkableCached==0)
1917 {
1918 MemberDefImpl *that = const_cast<MemberDefImpl*>(this);
1919 that->_computeLinkableInProject();
1920 }
1921 ASSERT(m_isLinkableCached>0);
1922 return m_isLinkableCached==2;
1923}
1924
1925bool MemberDefImpl::isLinkable() const
1926{
1927 if (m_templateMaster)
1928 {
1929 return m_templateMaster->isLinkable();
1930 }
1931 else
1932 {
1933 return isLinkableInProject() || isReference();
1934 }
1935}
1936
1937
1942
1943void MemberDefImpl::writeLink(OutputList &ol,
1944 const ClassDef *,const NamespaceDef *,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod,
1945 bool onlyText) const
1946{
1947 SrcLangExt lang = getLanguage();
1948 bool hideScopeNames = Config_getBool(HIDE_SCOPE_NAMES);
1949 DString sep = getLanguageSpecificSeparator(lang,true);
1950 DString n = name();
1951 const ClassDef *classDef = getClassDef();
1952 const NamespaceDef *nspace = getNamespaceDef();
1953 if (!hideScopeNames)
1954 {
1955 if (m_enumScope && m_livesInsideEnum && getGroupDef()!=nullptr)
1956 {
1957 n.prepend(m_enumScope->displayName()+sep);
1958 }
1959 if (classDef && (gd || mod) && !isRelated())
1960 {
1961 n.prepend(classDef->displayName()+sep);
1962 }
1963 else if (nspace && (gd || fd || mod))
1964 {
1965 n.prepend(nspace->displayName()+sep);
1966 }
1967 }
1968
1969 if (isObjCMethod())
1970 {
1971 if (isStatic()) ol.docify("+ "); else ol.docify("- ");
1972 }
1973 if (!onlyText && (isLinkable() || hasDetailedDescription())) // write link
1974 {
1975 if (m_mtype==MemberType::EnumValue && getGroupDef()==nullptr && // enum value is not grouped
1976 getEnumScope() && getEnumScope()->getGroupDef()) // but its container is
1977 {
1978 const GroupDef *enumValGroup = getEnumScope()->getGroupDef();
1979 ol.writeObjectLink(enumValGroup->getReference(),
1980 enumValGroup->getOutputFileBase(),
1981 anchor(),n);
1982 }
1983 else
1984 {
1985 ol.writeObjectLink(getReference(),getOutputFileBase(),anchor(),n);
1986 }
1987 }
1988 else // write only text
1989 {
1990 ol.startBold();
1991 ol.docify(n);
1992 ol.endBold();
1993 }
1994}
1995
1996static std::mutex g_cachedAnonymousTypeMutex;
1997
2002
2003/*! If this member has an anonymous class/struct/union as its type, then
2004 * this method will return the ClassDef that describes this return type.
2005 */
2010
2011/*! This methods returns true iff the brief section (also known as
2012 * declaration section) is visible in the documentation.
2013 */
2014bool MemberDefImpl::isBriefSectionVisible() const
2015{
2016 bool extractStatic = Config_getBool(EXTRACT_STATIC);
2017 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
2018 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
2019 bool briefMemberDesc = Config_getBool(BRIEF_MEMBER_DESC);
2020 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
2021 bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
2022
2023 //printf("Member %s grpId=%d docs=%s file=%s args=%s\n",
2024 // qPrint(name()),
2025 // 0,"", //grpId,grpId==-1?"<none>":Doxygen::memberDocDict[grpId]->data(),
2026 // "", //qPrint(getFileDef()->name()),
2027 // argsString());
2028
2029 bool hasDocs = hasDocumentation();
2030
2031 // only include static members with file/namespace scope if
2032 // explicitly enabled in the config file
2033 bool visibleIfStatic = !(getClassDef()==nullptr &&
2034 isStatic() &&
2035 !extractStatic
2036 );
2037
2038 // only include members is the are documented or
2039 // HIDE_UNDOC_MEMBERS is NO in the config file
2040 bool visibleIfDocumented = (!hideUndocMembers ||
2041 hasDocs ||
2042 isDocumentedFriendClass()
2043 );
2044
2045 // hide members with no detailed description and brief descriptions
2046 // explicitly disabled.
2047 bool visibleIfEnabled = !(hideUndocMembers &&
2048 documentation().empty() &&
2049 !briefMemberDesc &&
2050 !repeatBrief
2051 );
2052
2053 // Hide friend (class|struct|union) declarations if HIDE_FRIEND_COMPOUNDS is true
2054 bool visibleIfFriendCompound = !(hideFriendCompounds &&
2055 isFriend() /*&&
2056 (m_type=="friend class" ||
2057 m_type=="friend struct" ||
2058 m_type=="friend union"
2059 )*/
2060 );
2061
2062 // only include members that are non-private unless EXTRACT_PRIVATE is
2063 // set to YES or the member is part of a group. And as a special case,
2064 // private *documented* virtual members are shown if EXTRACT_PRIV_VIRTUAL
2065 // is set to YES
2066 bool visibleIfPrivate = (protectionLevelVisible(protection()) ||
2067 m_mtype==MemberType::Friend ||
2068 (m_prot==Protection::Private &&
2069 (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual && hasDocs)
2070 );
2071
2072 // hide member if it overrides a member in a superclass and has no
2073 // documentation of its own
2074 //bool visibleIfDocVirtual = !reimplements() ||
2075 // !Config_getBool(INHERIT_DOCS) ||
2076 // hasDocs;
2077
2078 // true if this member is a constructor or destructor
2079 bool cOrDTor = isConstructor() || isDestructor();
2080
2081 // hide default constructors or destructors (no args) without
2082 // documentation
2083 bool visibleIfNotDefaultCDTor = !(cOrDTor &&
2084 (m_defArgList.empty() ||
2085 m_defArgList.front().type == "void"
2086 ) &&
2087 !hasDocs
2088 );
2089
2090
2091 //printf("visibleIfStatic=%d visibleIfDocumented=%d visibleIfEnabled=%d "
2092 // "visibleIfPrivate=%d visibleIfNotDefaultCDTor=%d "
2093 // "visibleIfFriendCompound=%d\n",
2094 // visibleIfStatic,visibleIfDocumented,
2095 // visibleIfEnabled,visibleIfPrivate,visibleIfNotDefaultCDTor,
2096 // visibleIfFriendCompound);
2097
2098 bool visible = visibleIfStatic && visibleIfDocumented &&
2099 visibleIfEnabled && visibleIfPrivate &&
2100 /*visibleIfDocVirtual &&*/ visibleIfNotDefaultCDTor &&
2101 visibleIfFriendCompound &&
2102 !isHidden();
2103 //printf("MemberDefImpl::isBriefSectionVisible() %d\n",visible);
2104 return visible;
2105}
2106
2107DString MemberDefImpl::getDeclType() const
2108{
2109 SrcLangExt lang = getLanguage();
2110 DString ltype(m_type);
2111 if (lang==SrcLangExt::Cpp && isEnumerate() && isStrong())
2112 {
2113 if (isEnumStruct())
2114 {
2115 ltype+=" struct";
2116 }
2117 else
2118 {
2119 ltype+=" class";
2120 }
2121 }
2122 if (isTypedef() && getLanguage() != SrcLangExt::Slice)
2123 {
2124 ltype.prepend("typedef ");
2125 }
2126 if (isTypeAlias())
2127 {
2128 if (lang==SrcLangExt::Python)
2129 {
2130 ltype="type";
2131 }
2132 else
2133 {
2134 ltype="using";
2135 }
2136 }
2137 // strip 'friend' keyword from ltype
2138 ltype.stripPrefix("friend ");
2139 if (ltype=="@") // rename type from enum values
2140 {
2141 ltype="";
2142 }
2143 else
2144 {
2145 if (isObjCMethod())
2146 {
2147 ltype.prepend("(");
2148 ltype.append(")");
2149 }
2150 }
2151 return ltype;
2152}
2153
2154void MemberDefImpl::_writeTemplatePrefix(OutputList &ol, const Definition *def,
2155 const ArgumentList &al, bool writeReqClause) const
2156{
2157 ol.docify("template<");
2158 LinkifyTextOptions options;
2159 options.setScope(def).setFileScope(getFileDef()).setSelf(this);
2160 for (auto it = al.begin(); it!=al.end();)
2161 {
2162 Argument a = *it;
2163 linkifyText(TextGeneratorOLImpl(ol),a.type,options);
2164 if (!a.name.empty())
2165 {
2166 ol.docify(" ");
2167 ol.docify(a.name);
2168 }
2169 if (!a.defval.empty())
2170 {
2171 ol.docify(" = ");
2172 ol.docify(a.defval);
2173 }
2174 ++it;
2175 if (it!=al.end()) ol.docify(", ");
2176 }
2177 ol.docify("> ");
2178 if (writeReqClause && !m_requiresClause.empty())
2179 {
2180 ol.lineBreak();
2181 ol.docify("requires ");
2182 linkifyText(TextGeneratorOLImpl(ol), // out
2183 m_requiresClause, // text
2184 LinkifyTextOptions(options).setAutoBreak(true).setBreakThreshold(120));
2185 }
2186}
2187
2188static DString combineArgsAndException(DString args,DString exception)
2189{
2190 if (exception.empty()) return args; // no exception, nothing to combine args
2191 size_t pos = args.rfind(')');
2192 size_t eqPos = pos!=DString::npos ? args.find('=',pos) : DString::npos; // look for '=' in '(args) = something'
2193 if (eqPos==DString::npos) return args+" "+exception; // append exception at the end
2194 return args.left(eqPos)+" "+exception+" "+args.mid(eqPos); // insert exception before =
2195}
2196
2197bool MemberDefImpl::_isAnonymousBitField() const
2198{
2199 return !m_bitfields.empty() && name().startsWith("__pad"); // anonymous bitfield
2200}
2201
2202void MemberDefImpl::writeDeclaration(OutputList &ol,
2203 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod,
2204 bool inGroup, int indentLevel, const ClassDef *inheritedFrom,const DString &inheritId) const
2205{
2206 //printf("> %s MemberDefImpl::writeDeclaration() inGroup=%d inheritId=%s\n",qPrint(qualifiedName()),inGroup,qPrint(inheritId));
2207
2208 // hide enum value, since they appear already as part of the enum, unless they
2209 // are explicitly grouped.
2210 if (!inGroup && m_mtype==MemberType::EnumValue) return;
2211
2212 const Definition *d=nullptr;
2213 ASSERT (cd!=nullptr || nd!=nullptr || fd!=nullptr || gd!=nullptr || mod!=nullptr); // member should belong to something
2214 if (cd) d=cd;
2215 else if (nd) d=nd;
2216 else if (fd) d=fd;
2217 else d=gd;
2218 if (d==gd || d==mod) // see bug 753608
2219 {
2220 if (getClassDef()) d = getClassDef();
2221 else if (getNamespaceDef()) d = getNamespaceDef();
2222 else if (getFileDef()) d = getFileDef();
2223 }
2224 else if (d==fd) // see issue #9850, namespace member can be shown in file scope as well
2225 {
2226 if (getNamespaceDef()) d = getNamespaceDef();
2227 }
2228 if (d==nullptr)
2229 {
2230 err("No context could be derived for member '{}'\n",name());
2231 return; // should not happen
2232 }
2233
2234 DString cname = d->name();
2235 DString cdname = d->displayName();
2236 DString cfname = getOutputFileBase();
2237
2238 // search for the last anonymous scope in the member type
2239 const ClassDef *annoClassDef=getClassDefOfAnonymousType();
2240
2241 ol.startMemberDeclaration();
2242
2243 // start a new member declaration
2244 OutputGenerator::MemberItemType anonType = !m_tArgList.empty() ? OutputGenerator::MemberItemType::Templated :
2245 OutputGenerator::MemberItemType::Normal;
2246 ol.startMemberItem(annoClassDef ? DString() : anchor(), anonType, inheritId);
2247
2248
2249 // If there is no detailed description we need to write the anchor here.
2250 bool detailsVisible = hasDetailedDescription();
2251 bool writeAnchor = (inGroup || getGroupDef()==nullptr) && // only write anchors for member that have no details and are
2252 !detailsVisible && // rendered inside the group page or are not grouped at all
2253 inheritId.empty();
2254
2255 if (writeAnchor)
2256 {
2257 DString doxyArgs=argsString();
2258 DString doxyName=name();
2259 if (!cname.empty())
2260 {
2261 doxyName.prepend(cdname+getLanguageSpecificSeparator(getLanguage()));
2262 }
2263 ol.startDoxyAnchor(cfname,cname,anchor(),doxyName,doxyArgs);
2264 ol.addLabel(cfname,anchor());
2265 }
2266
2267 if (!detailsVisible)
2268 {
2269 ol.pushGeneratorState();
2270 ol.disable(OutputType::Man);
2271 ol.disable(OutputType::Latex);
2272 ol.disable(OutputType::Docbook);
2273 ol.docify("\n");
2274 ol.popGeneratorState();
2275 }
2276
2277 if (annoClassDef)
2278 {
2279 for (int j=0;j<indentLevel;j++)
2280 {
2281 ol.writeNonBreakableSpace(3);
2282 }
2283 }
2284
2285 // *** write template lists
2286 if (m_tArgList.hasParameters() && getLanguage()==SrcLangExt::Cpp)
2287 {
2288 ol.startMemberTemplateParams();
2289 _writeTemplatePrefix(ol,d,m_tArgList);
2290 ol.endMemberTemplateParams(anchor(),inheritId);
2291 }
2292
2293
2294 // *** write type
2295 DString ltype(m_type);
2296 auto lang = getLanguage();
2297 if (isTypedef() && lang != SrcLangExt::Slice)
2298 {
2299 ltype.prepend("typedef ");
2300 }
2301 if (isTypeAlias())
2302 {
2303 if (lang==SrcLangExt::Python)
2304 {
2305 ltype="type";
2306 }
2307 else
2308 {
2309 ltype="using";
2310 }
2311 }
2312 // strip 'friend' keyword from ltype
2313 ltype.stripPrefix("friend ");
2314 static const reg::Ex r(R"(@\d+)"); // anonymous type marker
2315 reg::Match match;
2316 std::string stype = ltype.str();
2317 bool endAnonScopeNeeded=false;
2318 LinkifyTextOptions options;
2319 options.setScope(d).setFileScope(getBodyDef()).setSelf(this);
2320 if (reg::search(stype,match,r)) // member has an anonymous type marker
2321 {
2322 //printf("name=%s annoClassDef=%p stype='%s' scopeName='%s'\n",
2323 // qPrint(name()),(void*)annoClassDef,qPrint(stype),qPrint(cname));
2324
2325 static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)"); // anonymous type marker(s) including scope
2326 reg::Match amatch;
2327 reg::search(stype,amatch,ar);
2328 size_t ai = amatch.position();
2329 size_t al = amatch.length();
2330 const MemberDef *amd = getAnonymousEnumType();
2331 if (annoClassDef && amd==nullptr) // type is an anonymous compound
2332 {
2333 ol.writeObjectLink(annoClassDef->getReference(),annoClassDef->getOutputFileBase(),
2334 annoClassDef->anchor(),ltype.left(ai)+ltype.mid(ai+al));
2335 }
2336 else if (amd) // type is an anonymous enum
2337 {
2338 DString typePlaceholder = " { ... } ";
2339 if (lang==SrcLangExt::Cpp)
2340 {
2341 if (amd->isEnumStruct()) typePlaceholder.prepend(" struct");
2342 else if (amd->isStrong()) typePlaceholder.prepend(" class");
2343 }
2344 ol.writeObjectLink(amd->getReference(),amd->getOutputFileBase(),
2345 amd->anchor(),ltype.left(ai)+typePlaceholder+ltype.mid(ai+al));
2346 }
2347 else // fallback if anonymous type is not found
2348 {
2349 size_t i = match.position();
2350 size_t l = match.length();
2351 ltype = ltype.left(i) + " { ... } " + removeAnonymousScopes(ltype.mid(i+l));
2352 linkifyText(TextGeneratorOLImpl(ol), ltype, options);
2353 }
2354 }
2355 else if (ltype=="@") // rename type from enum values
2356 {
2357 ltype="";
2358 }
2359 else
2360 {
2361 if (isObjCMethod())
2362 {
2363 ltype.prepend("(");
2364 ltype.append(")");
2365 }
2366 linkifyText(TextGeneratorOLImpl(ol),ltype,options);
2367 }
2368
2369 if (!ltype.empty())
2370 {
2371 ol.pushGeneratorState();
2372 ol.disable(OutputType::Html);
2373 ol.docify(" ");
2374 ol.popGeneratorState();
2375 }
2376
2377 ol.insertMemberAlign(m_tArgList.hasParameters());
2378
2379 // *** write name
2380 if (!isAnonymous() && !_isAnonymousBitField()) // hide anonymous stuff
2381 {
2382 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
2383 bool extractStatic = Config_getBool(EXTRACT_STATIC);
2384 bool visibleIfPrivate = (protectionLevelVisible(protection()) ||
2385 m_mtype==MemberType::Friend ||
2386 (m_prot==Protection::Private &&
2387 (m_virt!=Specifier::Normal || isOverride() || isFinal()) &&
2388 extractPrivateVirtual && hasDocumentation()
2389 ));
2390 //printf("Member name=`%s gd=%p md->groupDef=%p inGroup=%d isLinkable()=%d hasDocumentation=%d\n",qPrint(name()),gd,getGroupDef(),inGroup,isLinkable(),hasDocumentation());
2391 if (!name().empty() && // name valid
2392 (hasDetailedDescription() || isReference()) && // has docs
2393 visibleIfPrivate &&
2394 !(isStatic() && getClassDef()==nullptr && !extractStatic) // hidden due to static-ness
2395 )
2396 {
2397 //printf("writeLink %s->%d\n",qPrint(name),hasDocumentation());
2398 const ClassDef *rcd = cd;
2399 if (isReference() && getClassDef()) rcd = getClassDef();
2400 writeLink(ol,rcd,nd,fd,gd,mod);
2401 }
2402 else if (isDocumentedFriendClass())
2403 // if the member is an undocumented friend declaration for some class,
2404 // then maybe we can link to the class
2405 {
2406 writeLink(ol,getClass(name()),nullptr,nullptr,nullptr,nullptr);
2407 }
2408 else
2409 // there is a brief member description and brief member
2410 // descriptions are enabled or there is no detailed description.
2411 {
2412 const ClassDef *rcd = cd;
2413 if (isReference() && getClassDef()) rcd = getClassDef();
2414 writeLink(ol,rcd,nd,fd,gd,mod,true);
2415 }
2416 }
2417
2418 // *** write arguments
2419 if (!argsString().empty() && !isObjCMethod())
2420 {
2421 if (!isDefine() && !isTypedef()) ol.writeString(" ");
2422 linkifyText(TextGeneratorOLImpl(ol), // out
2423 isDefine() ?
2424 substitute(argsString(),",",", ") :
2425 isTypedef() ?
2426 substitute(argsString(),")(",") (") :
2427 combineArgsAndException(argsString(),excpString()), // text
2428 LinkifyTextOptions(options)
2429 .setArgumentList(&m_defArgList)
2430 .setAutoBreak(false)
2431 .setIndentLevel(indentLevel)
2432 );
2433 }
2434
2435 // *** write bitfields
2436 if (!m_bitfields.empty()) // add bitfields
2437 {
2438 linkifyText(TextGeneratorOLImpl(ol),m_bitfields,options);
2439 }
2440 else if (hasOneLineInitializer()
2441 //!init.empty() && initLines==0 && // one line initializer
2442 //((maxInitLines>0 && userInitLines==-1) || userInitLines>0) // enabled by default or explicitly
2443 ) // add initializer
2444 {
2445 if (isTypeAlias()) // using statement
2446 {
2447 ol.writeString(" = ");
2448 linkifyText(TextGeneratorOLImpl(ol),m_initializer.simplifyWhiteSpace(),options);
2449 }
2450 else if (!isDefine())
2451 {
2452 //ol.writeString(" = ");
2453 ol.writeString(" ");
2454 linkifyText(TextGeneratorOLImpl(ol),m_initializer.simplifyWhiteSpace(),options);
2455 }
2456 else
2457 {
2458 ol.writeNonBreakableSpace(3);
2459 linkifyText(TextGeneratorOLImpl(ol),m_initializer,options);
2460 }
2461 }
2462
2463
2464 if ((isObjCMethod() || isObjCProperty()) && isImplementation())
2465 {
2466 ol.startTypewriter();
2467 ol.docify(" [implementation]");
2468 ol.endTypewriter();
2469 }
2470
2471 bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
2472
2473 if (isProperty() && (isSettable() || isGettable() ||
2474 isPrivateSettable() || isPrivateGettable() ||
2475 isProtectedSettable() || isProtectedGettable()))
2476 {
2477 ol.writeLatexSpacing();
2478 ol.startTypewriter();
2479 ol.docify(" [");
2480 StringVector sl;
2481
2482 if (isGettable()) sl.emplace_back("get");
2483 if (isProtectedGettable()) sl.emplace_back("protected get");
2484 if (isSettable()) sl.emplace_back("set");
2485 if (isProtectedSettable()) sl.emplace_back("protected set");
2486 if (extractPrivate)
2487 {
2488 if (isPrivateGettable()) sl.emplace_back("private get");
2489 if (isPrivateSettable()) sl.emplace_back("private set");
2490 }
2491 bool first=true;
2492 for (const auto &s : sl)
2493 {
2494 if (!first)
2495 {
2496 ol.docify(", ");
2497 }
2498 first=false;
2499 ol.docify(s);
2500 }
2501 ol.docify("]");
2502 ol.endTypewriter();
2503 }
2504
2505 if (isEvent() && (isAddable() || isRemovable() || isRaisable()))
2506 {
2507 ol.writeLatexSpacing();
2508 ol.startTypewriter();
2509 ol.docify(" [");
2510 StringVector sl;
2511 if (isAddable()) sl.emplace_back("add");
2512 if (isRemovable()) sl.emplace_back("remove");
2513 if (isRaisable()) sl.emplace_back("raise");
2514 bool first=true;
2515 for (const auto &s : sl)
2516 {
2517 if (!first)
2518 {
2519 ol.docify(", ");
2520 }
2521 first=false;
2522 ol.docify(s);
2523 }
2524 ol.docify("]");
2525 ol.endTypewriter();
2526 }
2527
2528 if (writeAnchor)
2529 {
2530 ol.endDoxyAnchor(cfname,anchor());
2531 }
2532
2533 //printf("endMember %s annoClassDef=%p annEnumType=%p\n",
2534 // qPrint(name()),annoClassDef,annEnumType);
2535 ol.endMemberItem(anonType);
2536 if (endAnonScopeNeeded)
2537 {
2538 ol.endAnonTypeScope(indentLevel);
2539 }
2540
2541 // write brief description
2542 if (!briefDescription().empty() &&
2543 Config_getBool(BRIEF_MEMBER_DESC)
2544 )
2545 {
2546 auto parser { createDocParser() };
2547 auto ast { validatingParseDoc(*parser.get(),
2548 briefFile(),
2549 briefLine(),
2550 getOuterScope()?getOuterScope():d,
2551 this,
2552 briefDescription(),
2553 DocOptions()
2554 .setIndexWords(inheritedFrom==nullptr)
2555 .setSingleLine(true))
2556 };
2557 if (!ast->empty())
2558 {
2559 ol.startMemberDescription(anchor(),inheritId);
2560 ol.writeDoc(ast.get(),getOuterScope()?getOuterScope():d,this);
2561 if (detailsVisible) // add More.. link only when both brief and details are visible
2562 {
2563 if (!isAnonymous()) // hide anonymous stuff
2564 {
2565 ol.pushGeneratorState();
2566 ol.disableAllBut(OutputType::Html);
2567 ol.docify(" ");
2568 ol.popGeneratorState();
2569 }
2570 }
2571 // for RTF we need to add an extra empty paragraph
2572 ol.pushGeneratorState();
2573 ol.disableAllBut(OutputType::RTF);
2574 ol.startParagraph();
2575 ol.endParagraph();
2576 ol.popGeneratorState();
2577 ol.endMemberDescription();
2578 }
2579 }
2580
2581 ol.endMemberDeclaration(anchor(),inheritId);
2582
2583 warnIfUndocumented();
2584 //printf("< %s MemberDefImpl::writeDeclaration() inGroup=%d\n",qPrint(qualifiedName()),inGroup);
2585}
2586
2587static std::mutex g_hasDetailedDescriptionMutex;
2588
2589bool MemberDefImpl::hasDetailedDescription() const
2590{
2591 std::lock_guard<std::mutex> lock(g_hasDetailedDescriptionMutex);
2592 //printf(">hasDetailedDescription(cached=%d)\n",m_hasDetailedDescriptionCached);
2593 if (!m_hasDetailedDescriptionCached)
2594 {
2595 bool extractAll = Config_getBool(EXTRACT_ALL);
2596 bool alwaysDetailedSec = Config_getBool(ALWAYS_DETAILED_SEC);
2597 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
2598 bool briefMemberDesc = Config_getBool(BRIEF_MEMBER_DESC);
2599 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
2600 bool extractStatic = Config_getBool(EXTRACT_STATIC);
2601 bool extractPrivateVirtual = Config_getBool(EXTRACT_PRIV_VIRTUAL);
2602 bool inlineSources = hasInlineSource();
2603
2604 // the member has detailed documentation because the user added some comments
2605 bool docFilter =
2606 // extract all is enabled
2607 extractAll ||
2608 // has detailed docs
2609 !documentation().empty() ||
2610 // has inbody docs
2611 !inbodyDocumentation().empty() ||
2612 // is an enum with values that are documented
2613 (isEnumerate() && hasDocumentedEnumValues()) ||
2614 // is documented enum value
2615 (m_mtype==MemberType::EnumValue && !briefDescription().empty()) ||
2616 // has brief description that is part of the detailed description
2617 (!briefDescription().empty() && // has brief docs
2618 (alwaysDetailedSec && // they are visible in
2619 (repeatBrief || // detailed section or
2620 !briefMemberDesc // they are explicitly not
2621 ) // shown in brief section
2622 )
2623 ) ||
2624 // has one or more documented arguments
2625 (m_templateMaster ?
2626 m_templateMaster->argumentList().hasDocumentation() :
2627 m_defArgList.hasDocumentation()) ||
2628 (m_templateMaster ?
2629 m_templateMaster->templateArguments().hasTemplateDocumentation() :
2630 m_tArgList.hasTemplateDocumentation()) ||
2631 // user-specified qualifiers
2632 !m_qualifiers.empty();
2633
2634 // generate function guard
2635 // ================== =======
2636 // _writeGroupInclude -> ignored in calculation
2637 // multiLineInitializer() -> hasMultiLineInitializer()
2638 // _writeReimplements -> _isReimplements()
2639 // _writeReimplementedBy -> _countReimplementedBy()>0
2640 // _writeExamples -> hasExamples()
2641 // _writeTypeConstraints -> m_typeConstraints.hasParameters()
2642 // writeSourceDef -> !getSourceFileBase().empty();
2643 // writeInlineCode -> hasInlineSource() && hasSources()
2644 // writeSourceRefs -> hasReferencesRelation() && hasSourceRefs()
2645 // writeSourceReffedBy -> hasReferencedByRelation() && hasSourceReffedBy()
2646 // _writeCallGraph -> _hasVisibleCallGraph()
2647 // _writeCallerGraph -> _hasVisibleCallerGraph()
2648
2649 // the member has detailed documentation because there is some generated info
2650 bool docInfo =
2651 // has a multi-line initialization block
2652 (hasMultiLineInitializer()) ||
2653 // reimplements / reimplemented by
2654 _isReimplements() || (_countReimplementedBy() > 0) ||
2655 // examples
2656 hasExamples() ||
2657 // type constraints
2658 m_typeConstraints.hasParameters() ||
2659 // has source definition
2660 !getSourceFileBase().empty() ||
2661 // has inline sources
2662 (inlineSources && hasSources()) ||
2663 // has references
2664 (hasReferencesRelation() && hasSourceRefs()) ||
2665 (hasReferencedByRelation() && hasSourceReffedBy()) ||
2666 // call graph
2667 _hasVisibleCallGraph() ||
2668 // caller graph
2669 _hasVisibleCallerGraph() ||
2670 // requirement references
2671 hasRequirementRefs();
2672
2673 if (!hideUndocMembers) // if HIDE_UNDOC_MEMBERS is NO we also show the detailed section
2674 // if there is only some generated info
2675 {
2676 docFilter = docFilter || docInfo;
2677 }
2678
2679 // this is not a global static or global statics should be extracted
2680 bool staticFilter = getClassDef()!=nullptr || !isStatic() || extractStatic;
2681
2682 // a module does not contain details for members, so either the namespace or file should be linkable
2683 bool moduleFilter = getModuleDef()==nullptr || (getFileDef() && getFileDef()->isLinkable()) ||
2684 (getNamespaceDef() && getNamespaceDef()->isLinkable());
2685
2686 // only include members that are non-private unless EXTRACT_PRIVATE is
2687 // set to YES or the member is part of a group
2688 bool privateFilter = protectionLevelVisible(protection()) || m_mtype==MemberType::Friend ||
2689 (m_prot==Protection::Private && (m_virt!=Specifier::Normal || isOverride() || isFinal()) && extractPrivateVirtual);
2690
2691 // hide friend (class|struct|union) member if HIDE_FRIEND_COMPOUNDS
2692 // is true
2693 bool friendCompoundFilter = !(Config_getBool(HIDE_FRIEND_COMPOUNDS) && isFriend());
2694
2695 m_detailedDescriptionCachedValue =
2696 (docFilter && staticFilter && moduleFilter && privateFilter && friendCompoundFilter && !isHidden());
2697 //printf("docFilter=%d docInfo=%d staticFilter=%d privateFilter=%d friendCompoundFilter=%d !isHidden()=%d",
2698 // docFilter,docInfo,staticFilter,privateFilter,friendCompoundFilter,!isHidden());
2699 m_hasDetailedDescriptionCached = true;
2700 }
2701 //printf("<hasDetailedDescription(cached=%d)\n",m_hasDetailedDescriptionCached);
2702 return m_detailedDescriptionCachedValue;
2703}
2704
2705bool MemberDefImpl::isDetailedSectionVisible(MemberListContainer container) const
2706{
2707 bool separateMemPages = Config_getBool(SEPARATE_MEMBER_PAGES);
2708 bool inlineSimpleStructs = Config_getBool(INLINE_SIMPLE_STRUCTS);
2709 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
2710 bool groupFilter = getGroupDef()==nullptr || container==MemberListContainer::Group || separateMemPages;
2711 bool fileFilter = getNamespaceDef()==nullptr || !getNamespaceDef()->isLinkable() || container!=MemberListContainer::File;
2712 bool simpleFilter = (hasBriefDescription() || !hideUndocMembers) && inlineSimpleStructs &&
2713 getClassDef()!=nullptr && getClassDef()->isSimple();
2714
2715 bool visible = hasDetailedDescription() && groupFilter && fileFilter &&
2716 !isReference();
2717 bool result = visible || simpleFilter;
2718 //printf("%s::isDetailedSectionVisible: %d groupFilter=%d fileFilter=%d\n",
2719 // qPrint(name()),result,groupFilter,fileFilter);
2720 return result;
2721}
2722
2723StringVector MemberDefImpl::getLabels(const Definition *container) const
2724{
2725 StringVector sl;
2726 bool inlineInfo = Config_getBool(INLINE_INFO);
2727 bool inherited = getClassDef() &&
2728 (getClassDef()!=container || m_explicitInherited) &&
2729 container->definitionType()==TypeClass &&
2730 !isRelated();
2731 Specifier lvirt=virtualness();
2732 if ((!isObjCMethod() || isOptional() || isRequired()) &&
2733 (protection()!=Protection::Public || lvirt!=Specifier::Normal ||
2734 isFriend() || isRelated() ||
2735 (isInline() && inlineInfo) ||
2736 isSignal() || isSlot() ||
2737 isStatic() || isExternal() ||
2738 isExported() ||
2739 inherited ||
2740 TypeSpecifier(m_memSpec).setInline(false)!=TypeSpecifier()
2741 )
2742 )
2743 {
2744 // write the member specifier list
2745 //ol.writeLatexSpacing();
2746 //ol.startTypewriter();
2747 //ol.docify(" [");
2748 SrcLangExt lang = getLanguage();
2749 bool optVhdl = lang==SrcLangExt::VHDL;
2750 bool extractPrivate = Config_getBool(EXTRACT_PRIVATE);
2751 if (optVhdl)
2752 {
2753 sl.push_back(theTranslator->trVhdlType(getVhdlSpecifiers(),true).str());
2754 }
2755 else
2756 {
2757 if (isFriend()) sl.emplace_back("friend");
2758 else if (isRelated()) sl.emplace_back("related");
2759 else
2760 {
2761 if (isExternal()) sl.emplace_back("extern");
2762 if (inlineInfo && isInline()) sl.emplace_back("inline");
2763 if (isExplicit()) sl.emplace_back("explicit");
2764 if (isMutable()) sl.emplace_back("mutable");
2765 if (isThreadLocal()) sl.emplace_back("thread_local");
2766 if (isStatic()) sl.emplace_back("static");
2767 if (isGettable()) sl.emplace_back("get");
2768 if (isProtectedGettable()) sl.emplace_back("protected get");
2769 if (isSettable()) sl.emplace_back("set");
2770 if (isProtectedSettable()) sl.emplace_back("protected set");
2771 if (extractPrivate)
2772 {
2773 if (isPrivateGettable()) sl.emplace_back("private get");
2774 if (isPrivateSettable()) sl.emplace_back("private set");
2775 }
2776 if (isNoDiscard()) sl.emplace_back("nodiscard");
2777 if (isConstExpr()) sl.emplace_back("constexpr");
2778 if (isConstEval()) sl.emplace_back("consteval");
2779 if (isConstInit()) sl.emplace_back("constinit");
2780 if (isAddable()) sl.emplace_back("add");
2781 if (!isUNOProperty() && isRemovable()) sl.emplace_back("remove");
2782 if (isRaisable()) sl.emplace_back("raise");
2783 if (isReadable()) sl.emplace_back("read");
2784 if (isWritable()) sl.emplace_back("write");
2785 if (isFinal()) sl.emplace_back("final");
2786 if (isAbstract()) sl.emplace_back("abstract");
2787 if (isOverride()) sl.emplace_back("override");
2788 if (isInitonly()) sl.emplace_back("initonly");
2789 if (isSealed()) sl.emplace_back("sealed");
2790 if (isNew()) sl.emplace_back("new");
2791 if (isOptional()) sl.emplace_back("optional");
2792 if (isRequired()) sl.emplace_back("required");
2793 if (isExported()) sl.emplace_back("export");
2794
2795 if (isNonAtomic()) sl.emplace_back("nonatomic");
2796 else if (isObjCProperty()) sl.emplace_back("atomic");
2797
2798 // mutual exclusive Objective 2.0 property attributes
2799 if (isAssign()) sl.emplace_back("assign");
2800 else if (isCopy()) sl.emplace_back("copy");
2801 else if (isRetain()) sl.emplace_back("retain");
2802 else if (isWeak()) sl.emplace_back("weak");
2803 else if (lang!=SrcLangExt::CSharp && isStrong()) sl.emplace_back("strong");
2804 else if (isUnretained()) sl.emplace_back("unsafe_unretained");
2805
2806 if (!isObjCMethod())
2807 {
2808 if (protection()==Protection::Protected) sl.emplace_back("protected");
2809 else if (protection()==Protection::Private) sl.emplace_back("private");
2810 else if (protection()==Protection::Package) sl.emplace_back("package");
2811
2812 if (lvirt==Specifier::Virtual) sl.emplace_back("virtual");
2813 else if (lvirt==Specifier::Pure) sl.emplace_back("pure virtual");
2814 if (isSignal()) sl.emplace_back("signal");
2815 if (isSlot()) sl.emplace_back("slot");
2816 if (isDefault()) sl.emplace_back("default");
2817 if (isDelete()) sl.emplace_back("delete");
2818 if (isNoExcept()) sl.emplace_back("noexcept");
2819 if (isAttribute()) sl.emplace_back("attribute");
2820 if (isUNOProperty()) sl.emplace_back("property");
2821 if (isReadonly()) sl.emplace_back("readonly");
2822 if (isBound()) sl.emplace_back("bound");
2823 if (isUNOProperty() && isRemovable()) sl.emplace_back("removable");
2824 if (isConstrained()) sl.emplace_back("constrained");
2825 if (isTransient()) sl.emplace_back("transient");
2826 if (isMaybeVoid()) sl.emplace_back("maybevoid");
2827 if (isMaybeDefault()) sl.emplace_back("maybedefault");
2828 if (isMaybeAmbiguous()) sl.emplace_back("maybeambiguous");
2829 if (isPublished()) sl.emplace_back("published"); // enum
2830 }
2831 if (isObjCProperty() && isImplementation())
2832 {
2833 sl.emplace_back("implementation");
2834 }
2835 }
2836 if (inherited)
2837 {
2838 sl.emplace_back("inherited");
2839 }
2840 }
2841 }
2842 else if (isObjCMethod() && isImplementation())
2843 {
2844 sl.emplace_back("implementation");
2845 }
2846
2847 for (const auto &sx : m_qualifiers)
2848 {
2849 bool alreadyAdded = std::find(sl.begin(), sl.end(), sx) != sl.end();
2850 if (!alreadyAdded)
2851 {
2852 sl.push_back(sx);
2853 }
2854 }
2855
2856 return sl;
2857}
2858
2859void MemberDefImpl::_writeCallGraph(OutputList &ol) const
2860{
2861 // write call graph
2862 if (_hasVisibleCallGraph())
2863 {
2864 DotCallGraph callGraph(this,false);
2865 if (callGraph.isTooBig())
2866 {
2867 warn_uncond("Call graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2868 qualifiedName(), callGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
2869 }
2870 else if (!callGraph.isTrivial())
2871 {
2872 msg("Generating call graph for function {}\n",qualifiedName());
2873 ol.disable(OutputType::Man);
2874 ol.startCallGraph();
2875 ol.parseText(theTranslator->trCallGraph());
2876 ol.endCallGraph(callGraph);
2877 ol.enableAll();
2878 }
2879 }
2880}
2881
2882void MemberDefImpl::_writeCallerGraph(OutputList &ol) const
2883{
2884 if (_hasVisibleCallerGraph())
2885 {
2886 DotCallGraph callerGraph(this, true);
2887 if (callerGraph.isTooBig())
2888 {
2889 warn_uncond("Caller graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
2890 qualifiedName(), callerGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
2891 }
2892 else if (!callerGraph.isTrivial())
2893 {
2894 msg("Generating caller graph for function {}\n",qualifiedName());
2895 ol.disable(OutputType::Man);
2896 ol.startCallGraph();
2897 ol.parseText(theTranslator->trCallerGraph());
2898 ol.endCallGraph(callerGraph);
2899 ol.enableAll();
2900 }
2901 }
2902}
2903
2904bool MemberDefImpl::_isReimplements() const
2905{
2906 const MemberDef *bmd=reimplements();
2907 const ClassDef *bcd=nullptr;
2908 if (bmd && (bcd=bmd->getClassDef()))
2909 {
2910 // write class that contains a member that is reimplemented by this one
2911 if (bcd->isLinkable())
2912 {
2913 return true;
2914 }
2915 }
2916 return false;
2917}
2918void MemberDefImpl::_writeReimplements(OutputList &ol) const
2919{
2920 const MemberDef *bmd=reimplements();
2921 const ClassDef *bcd=nullptr;
2922 if (bmd && (bcd=bmd->getClassDef()))
2923 {
2924 // write class that contains a member that is reimplemented by this one
2925 if (bcd->isLinkable())
2926 {
2927 ol.startParagraph();
2928 DString reimplFromLine;
2929 if (bmd->virtualness()!=Specifier::Pure && bcd->compoundType()!=ClassDef::Interface)
2930 {
2931 reimplFromLine = theTranslator->trReimplementedFromList(1);
2932 }
2933 else
2934 {
2935 reimplFromLine = theTranslator->trImplementedFromList(1);
2936 }
2937 if (size_t markerPos = reimplFromLine.find("@0"); markerPos!=DString::npos) // should always pass this.
2938 {
2939 ol.parseText(reimplFromLine.left(markerPos)); //text left from marker
2940 if (bmd->isLinkable()) // replace marker with link
2941 {
2942 //Definition *bd=bmd->group;
2943 //if (bd==0) bd=bcd;
2944 ol.writeObjectLink(bmd->getReference(),bmd->getOutputFileBase(),
2945 bmd->anchor(),bcd->displayName());
2946
2947 //ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
2948 // bmd->anchor(),bcd->name());
2949 if ( bmd->isLinkableInProject() )
2950 {
2951 writePageRef(ol,bmd->getOutputFileBase(),bmd->anchor());
2952 }
2953 }
2954 else
2955 {
2956 ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
2957 DString(),bcd->displayName());
2958 if (bcd->isLinkableInProject()/* && !Config_getBool(PDF_HYPERLINKS)*/ )
2959 {
2960 writePageRef(ol,bcd->getOutputFileBase(),bcd->anchor());
2961 }
2962 }
2963 ol.parseText(reimplFromLine.right(
2964 reimplFromLine.length()-markerPos-2)); // text right from marker
2965
2966 }
2967 else
2968 {
2969 err("translation error: no marker in trReimplementsFromList()\n");
2970 }
2971 ol.endParagraph();
2972 }
2973 }
2974}
2975
2976size_t MemberDefImpl::_countReimplementedBy() const
2977{
2978 const MemberVector &bml=reimplementedBy();
2979 size_t count=0;
2980 for (const auto &bmd : bml)
2981 {
2982 const ClassDef *bcd=bmd->getClassDef();
2983 // count the members that directly inherit from md and for
2984 // which the member and class are visible in the docs.
2985 if ( bcd && bmd->isLinkable() && bcd->isLinkable() )
2986 {
2987 count++;
2988 }
2989 }
2990 return count;
2991}
2992
2993void MemberDefImpl::_writeReimplementedBy(OutputList &ol) const
2994{
2995 const MemberVector &bml=reimplementedBy();
2996 size_t count = _countReimplementedBy();
2997 if (count>0)
2998 {
2999 auto replaceFunc = [&bml,&ol](size_t entryIndex)
3000 {
3001 size_t cnt=0;
3002 auto it = bml.begin();
3003 // find the entryIndex-th documented entry in the inheritance list.
3004 const MemberDef *bmd = nullptr;
3005 const ClassDef *bcd = nullptr;
3006 while (it!=bml.end())
3007 {
3008 bmd = *it;
3009 bcd = bmd->getClassDef();
3010 if ( bmd->isLinkable() && bcd->isLinkable())
3011 {
3012 if (cnt==entryIndex) break;
3013 cnt++;
3014 }
3015 ++it;
3016 }
3017
3018 if (bcd && bmd) // write link for marker
3019 {
3020 //ol.writeObjectLink(bcd->getReference(),bcd->getOutputFileBase(),
3021 // bmd->anchor(),bcd->name());
3022 ol.writeObjectLink(bmd->getReference(),bmd->getOutputFileBase(),
3023 bmd->anchor(),bcd->displayName());
3024
3025 if (bmd->isLinkableInProject() )
3026 {
3027 writePageRef(ol,bmd->getOutputFileBase(),bmd->anchor());
3028 }
3029 }
3030 };
3031
3032 DString reimplInLine;
3033 if (m_virt==Specifier::Pure || (getClassDef() && getClassDef()->compoundType()==ClassDef::Interface))
3034 {
3035 reimplInLine = theTranslator->trImplementedInList(static_cast<int>(count));
3036 }
3037 else
3038 {
3039 reimplInLine = theTranslator->trReimplementedInList(static_cast<int>(count));
3040 }
3041
3042 // write the list of classes that overwrite this member
3043 ol.startParagraph();
3044 writeMarkerList(ol,
3045 reimplInLine.str(),
3046 count,
3047 replaceFunc);
3048 ol.endParagraph();
3049 }
3050}
3051
3052void MemberDefImpl::_writeCategoryRelation(OutputList &ol) const
3053{
3054 if (getClassDef()) // this should be a member of a class/category
3055 {
3056 //printf("%s: category %s relation %s class=%s categoryOf=%s\n",
3057 // qPrint(name()),
3058 // m_category ? qPrint(m_category->name()) : "<none>",
3059 // m_categoryRelation ? qPrint(m_categoryRelation->name()) : "<none>",
3060 // qPrint(m_classDef->name()),
3061 // m_classDef->categoryOf() ? qPrint(m_classDef->categoryOf()->name()) : "<none>"
3062 // );
3063 DString text;
3064 DString ref;
3065 DString file;
3066 DString anc;
3067 DString name;
3068 size_t i=DString::npos;
3069 if (m_categoryRelation && m_categoryRelation->isLinkable())
3070 {
3071 if (m_category)
3072 {
3073 // this member is in a normal class and implements method categoryRelation from category
3074 // so link to method 'categoryRelation' with 'provided by category 'category' text.
3075 text = theTranslator->trProvidedByCategory();
3076 name = m_category->displayName();
3077 }
3078 else if (getClassDef()->categoryOf())
3079 {
3080 // this member is part of a category so link to the corresponding class member of the class we extend
3081 // so link to method 'categoryRelation' with 'extends class 'classDef->categoryOf()'
3082 text = theTranslator->trExtendsClass();
3083 name = getClassDef()->categoryOf()->displayName();
3084 }
3085 i=text.find("@0");
3086 if (i!=DString::npos)
3087 {
3088 const MemberDef *md = m_categoryRelation;
3089 ref = md->getReference();
3090 file = md->getOutputFileBase();
3091 anc = md->anchor();
3092 }
3093 }
3094 if (i!=DString::npos && !name.empty())
3095 {
3096 ol.startParagraph();
3097 ol.parseText(text.left(i));
3098 ol.writeObjectLink(ref,file,anc,name);
3099 ol.parseText(text.mid(i+2));
3100 ol.endParagraph();
3101 }
3102 }
3103}
3104
3105void MemberDefImpl::_writeExamples(OutputList &ol) const
3106{
3107 // write the list of examples that use this member
3108 if (hasExamples())
3109 {
3110 ol.startExamples();
3111 ol.startDescForItem();
3112 writeExamples(ol,m_examples);
3113 ol.endDescForItem();
3114 ol.endExamples();
3115 }
3116}
3117
3125
3126void MemberDefImpl::_writeEnumValues(OutputList &ol,const Definition *container,
3127 const DString &cfname,const DString &ciname,
3128 const DString &cname) const
3129{
3130 // For enum, we also write the documented enum values
3131 if (isEnumerate())
3132 {
3133 bool first=true;
3134 //printf("** %s: enum values=%zu\n",qPrint(name()),enumFieldList().size());
3135 bool hasInits = false;
3136 if (hasEnumValues())
3137 {
3138 for (const auto &fmd : enumFieldList())
3139 {
3140 if (fmd->isLinkable())
3141 {
3142 if (!fmd->initializer().empty())
3143 {
3144 hasInits = true;
3145 break;
3146 }
3147 }
3148 }
3149 }
3150 for (const auto &fmd : enumFieldList())
3151 {
3152 //printf("Enum %p: isLinkable()=%d\n",fmd,fmd->isLinkable());
3153 if (fmd->isLinkable())
3154 {
3155 if (first)
3156 {
3157 ol.startDescTable(theTranslator->trEnumerationValues(),hasInits);
3158 first=false;
3159 }
3160
3161 ol.startDescTableRow();
3162 ol.addIndexItem(fmd->name(),ciname);
3163 ol.addIndexItem(ciname,fmd->name());
3164
3165 ol.startDescTableTitle();
3166 ol.startDoxyAnchor(cfname,cname,fmd->anchor(),fmd->name(),fmd->argsString());
3167 ol.addLabel(cfname,fmd->anchor());
3168 ol.docify(fmd->name());
3169 ol.disableAllBut(OutputType::Man);
3170 ol.writeString(" ");
3171 ol.enableAll();
3172 ol.endDoxyAnchor(cfname,fmd->anchor());
3173 ol.endDescTableTitle();
3174 if (hasInits)
3175 {
3176 ol.startDescTableInit();
3177 if (!fmd->initializer().empty())
3178 {
3179 DString initStr = fmd->initializer().stripWhiteSpace();
3180 if (initStr.startsWith("=")) initStr = initStr.mid(1).stripWhiteSpace();
3181 ol.disableAllBut(OutputType::Man);
3182 ol.writeString("(");
3183 ol.enableAll();
3184 ol.docify(initStr);
3185 ol.disableAllBut(OutputType::Man);
3186 ol.writeString(")");
3187 ol.enableAll();
3188 }
3189 ol.endDescTableInit();
3190 }
3191 ol.startDescTableData();
3192
3193 bool hasBrief = !fmd->briefDescription().empty();
3194 bool hasDetails = !fmd->documentation().empty();
3195
3196 if (hasBrief)
3197 {
3198 ol.generateDoc(fmd->briefFile(),
3199 fmd->briefLine(),
3200 getOuterScope()?getOuterScope():container,
3201 fmd,
3202 fmd->briefDescription(),
3203 DocOptions()
3204 .setIndexWords(true));
3205 }
3206 if (hasDetails)
3207 {
3208 ol.generateDoc(fmd->docFile(),
3209 fmd->docLine(),
3210 getOuterScope()?getOuterScope():container,
3211 fmd,
3212 fmd->documentation()+"\n",
3213 DocOptions()
3214 .setIndexWords(true));
3215 }
3216 ol.endDescTableData();
3217 ol.endDescTableRow();
3218 }
3219 }
3220 if (!first)
3221 {
3222 ol.endDescTable();
3223 }
3224 }
3225}
3226
3227// match from the start of the scope until the last marker
3228static const reg::Ex reAnonymous(R"([\w:@]*@\d+)");
3229
3230DString MemberDefImpl::displayDefinition() const
3231{
3232 DString ldef = definition();
3233 DString title = name();
3234 if (isEnumerate())
3235 {
3236 if (isAnonymous())
3237 {
3238 ldef = title = "anonymous enum";
3239 if (!m_enumBaseType.empty())
3240 {
3241 ldef+=" : "+m_enumBaseType;
3242 }
3243 }
3244 else
3245 {
3246 ldef.prepend("enum ");
3247 if (isSliceLocal())
3248 {
3249 ldef.prepend("local ");
3250 }
3251 }
3252 }
3253 else if (isEnumValue())
3254 {
3255 if (isAnonymous())
3256 {
3257 ldef=ldef.mid(2);
3258 }
3259 }
3260
3261 std::string sdef = ldef.str();
3262 reg::Match match;
3263 if (reg::search(sdef,match,reAnonymous))
3264 {
3265 const ClassDef *annoClassDef=getClassDefOfAnonymousType();
3266 if (annoClassDef)
3267 {
3268 static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)");
3269 reg::Match amatch;
3270 reg::search(sdef,amatch,ar);
3271 ldef = amatch.prefix().str() + annoClassDef->displayName() + amatch.suffix().str();
3272 }
3273 else
3274 {
3275 ldef = match.prefix().str() + " { ... } " + removeAnonymousScopes(match.suffix().str());
3276 }
3277 }
3278
3279 const ClassDef *cd=getClassDef();
3280 if (cd && cd->isObjectiveC())
3281 {
3282 // strip scope name
3283 if (size_t ep = ldef.find("::"); ep!=DString::npos)
3284 {
3285 if (size_t sp=ldef.rfind(' ',ep); sp!=DString::npos)
3286 {
3287 ldef=ldef.left(sp+1)+ldef.mid(ep+2);
3288 }
3289 }
3290 // strip keywords
3291 if (size_t dp = ldef.find(':'); dp!=DString::npos)
3292 {
3293 ldef=ldef.left(dp+1);
3294 }
3295 int l=static_cast<int>(ldef.length());
3296 //printf("start >%s<\n",qPrint(ldef));
3297 int i=l-1;
3298 while (i>=0 && (isId(ldef.at(i)) || ldef.at(i)==':')) i--;
3299 while (i>=0 && isspace(static_cast<uint8_t>(ldef.at(i)))) i--;
3300 if (i>0)
3301 {
3302 // insert branches around the type
3303 ldef = "("+ldef.left(i+1)+")"+ldef.mid(i+1);
3304 }
3305 //printf("end >%s< i=%d\n",qPrint(ldef),i);
3306 if (isStatic()) ldef.prepend("+ "); else ldef.prepend("- ");
3307 }
3308 SrcLangExt lang = getLanguage();
3309 DString sep = getLanguageSpecificSeparator(lang,true);
3310 return substitute(ldef,"::",sep);
3311}
3312
3313void MemberDefImpl::_writeGroupInclude(OutputList &ol,bool inGroup) const
3314{
3315 // only write out the include file if this is not part of a class or file
3316 // definition
3317 bool showGroupedMembInc = Config_getBool(SHOW_GROUPED_MEMB_INC);
3318 bool forceLocalIncludes = Config_getBool(FORCE_LOCAL_INCLUDES);
3319 const FileDef *fd = getFileDef();
3320 DString nm;
3321 if (inGroup && fd && showGroupedMembInc)
3322 {
3323 if (!Config_getList(STRIP_FROM_INC_PATH).empty())
3324 {
3325 nm = stripFromIncludePath(fd->absFilePath());
3326 }
3327 else
3328 {
3329 nm = fd->name();
3330 }
3331 }
3332 if (!nm.empty())
3333 {
3334 ol.startParagraph();
3335 ol.startTypewriter();
3336 SrcLangExt lang = getLanguage();
3337 bool isIDLorJava = lang==SrcLangExt::IDL || lang==SrcLangExt::Java;
3338 if (isIDLorJava)
3339 {
3340 ol.docify("import ");
3341 }
3342 else
3343 {
3344 ol.docify("#include ");
3345 }
3346
3347 if (isIDLorJava || forceLocalIncludes) ol.docify("\""); else ol.docify("<");
3348
3349 if (fd && fd->isLinkable())
3350 {
3351 ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),fd->anchor(),nm);
3352 }
3353 else
3354 {
3355 ol.docify(nm);
3356 }
3357
3358 if (isIDLorJava || forceLocalIncludes) ol.docify("\""); else ol.docify(">");
3359
3360 ol.endTypewriter();
3361 ol.endParagraph();
3362 }
3363}
3364
3365void MemberDefImpl::_writeMultiLineInitializer(OutputList &ol,const DString &scopeName) const
3366{
3367 //printf("md=%s initLines=%d init='%s'\n",qPrint(name()),initLines,qPrint(init));
3368 ol.startBold();
3369 if (m_mtype==MemberType::Define)
3370 ol.parseText(theTranslator->trDefineValue());
3371 else
3372 ol.parseText(theTranslator->trInitialValue());
3373 ol.endBold();
3374 DString langCorrected = getDefFileExtension();
3375 SrcLangExt srcLangExt = getLanguageFromFileName(getDefFileExtension());
3376 if (srcLangExt == SrcLangExt::Lex)
3377 {
3378 langCorrected = ".doxygen_lex_c";
3379 srcLangExt = SrcLangExt::Cpp;
3380 }
3381 auto intf = Doxygen::parserManager->getCodeParser(langCorrected);
3382 intf->resetCodeParserState();
3383 auto &codeOL = ol.codeGenerators();
3384 codeOL.startCodeFragment("DoxyCode");
3385 intf->parseCode(codeOL,scopeName,m_initializer,srcLangExt,Config_getBool(STRIP_CODE_COMMENTS),
3386 CodeParserOptions()
3387 .setFileDef(getFileDef())
3388 .setInlineFragment(true)
3389 .setMemberDef(this)
3390 .setShowLineNumbers(false)
3391 .setSearchCtx(this)
3392 );
3393 codeOL.endCodeFragment("DoxyCode");
3394}
3395
3396/*! Writes the "detailed documentation" section of this member to
3397 * all active output formats.
3398 */
3399void MemberDefImpl::writeDocumentation(const MemberList *ml,
3400 int memCount,int memTotal,
3401 OutputList &ol,
3402 const DString &scName,
3403 const Definition *container,
3404 bool inGroup,
3405 bool /* showEnumValues */,
3406 bool showInline
3407 ) const
3408{
3409 // if this member is in a group find the real scope name.
3410 bool hasParameterList = false;
3411
3412 //printf("MemberDefImpl::writeDocumentation(): name='%s' hasDocs='%d' containerType=%d inGroup=%d sectionLinkable=%d\n",
3413 // qPrint(name()),hasDocs,container->definitionType(),inGroup,hasDetailedDescription());
3414
3415 //if ( !hasDocs ) return;
3416 //if (isEnumValue() && !showEnumValues) return;
3417
3418 SrcLangExt lang = getLanguage();
3419 //printf("member=%s lang=%d\n",qPrint(name()),lang);
3420 bool optVhdl = lang==SrcLangExt::VHDL;
3421 DString sep = getLanguageSpecificSeparator(lang,true);
3422
3423 DString scopeName = scName;
3424 DString memAnchor = anchor();
3425 DString ciname = container->displayName();
3426 const Definition *scopedContainer = container; // see bug 753608
3427 if (container->definitionType()==TypeGroup)
3428 {
3429 if (getClassDef()) { scopeName=getClassDef()->displayName(); scopedContainer=getClassDef(); }
3430 else if (getNamespaceDef()) { scopeName=getNamespaceDef()->displayName(); scopedContainer=getNamespaceDef(); }
3431 else if (getFileDef()) { scopeName=getFileDef()->displayName(); scopedContainer=getFileDef(); }
3432 ciname = (toGroupDef(container))->groupTitle();
3433 }
3434 else if (container->definitionType()==TypeFile && getNamespaceDef() && getNamespaceDef()->isLinkable())
3435 { // member is in a namespace, but is written as part of the file documentation
3436 // as well, so we need to make sure its anchor is unique (it is not really used).
3437 memAnchor.prepend("file_");
3438 }
3439
3440 DString cname = container->name();
3441 DString cfname = getOutputFileBase();
3442
3443 // get member name
3444 DString doxyName=name();
3445 // prepend scope if there is any. TODO: make this optional for C only docs
3446 if (!scopeName.empty())
3447 {
3448 doxyName.prepend(scopeName+sep);
3449 }
3450 DString doxyArgs=argsString();
3451
3452 DString ldef = definition();
3453 DString title = name();
3454
3455 //printf("member '%s' def='%s'\n",qPrint(name()),qPrint(ldef));
3456 if (isEnumerate())
3457 {
3458 if (title.at(0)=='@')
3459 {
3460 ldef = title = "anonymous enum";
3461 if (isSliceLocal())
3462 {
3463 ldef.prepend("local ");
3464 }
3465 if (lang==SrcLangExt::Cpp)
3466 {
3467 if (isEnumStruct()) ldef.append(" struct");
3468 else if (isStrong()) ldef.append(" class");
3469 }
3470 if (!m_enumBaseType.empty())
3471 {
3472 ldef+=" : "+m_enumBaseType;
3473 }
3474 }
3475 else
3476 {
3477 if (lang==SrcLangExt::Cpp)
3478 {
3479 if (isEnumStruct()) ldef.prepend("struct ");
3480 else if (isStrong()) ldef.prepend("class ");
3481 }
3482 ldef.prepend("enum ");
3483 if (isSliceLocal())
3484 {
3485 ldef.prepend("local ");
3486 }
3487 }
3488 }
3489 else if (isEnumValue())
3490 {
3491 if (ldef.at(0)=='@')
3492 {
3493 ldef=ldef.mid(2);
3494 }
3495 }
3496 else if (isFunction() && !isObjCMethod())
3497 {
3498 title += "()";
3499 }
3500 if (lang == SrcLangExt::Slice)
3501 {
3502 // Remove the container scope from the member name.
3503 DString prefix = scName + sep;
3504 if (size_t pos = ldef.rfind(prefix); pos != DString::npos)
3505 {
3506 ldef.remove(pos, prefix.length());
3507 }
3508 }
3509 ldef.stripPrefix("constexpr ");
3510 ldef.stripPrefix("consteval ");
3511 ldef.stripPrefix("constinit ");
3512 ldef.stripPrefix("static ");
3513
3514 //----------------------------------------
3515
3516 ol.pushGeneratorState();
3517
3518 bool htmlEndLabelTable=false;
3519 StringVector sl = getLabels(scopedContainer);
3520
3521 static const reg::Ex r(R"(@\d+)");
3522 reg::Match match;
3523 std::string sdef = ldef.str();
3524 LinkifyTextOptions options;
3525 options.setScope(scopedContainer).setFileScope(getBodyDef()).setSelf(this);
3526 if ((isVariable() || isTypedef()) && reg::search(sdef,match,r))
3527 {
3528 // find enum type and insert it in the definition
3529 bool found=false;
3530 for (const auto &vmd : *ml)
3531 {
3532 if (vmd->isEnumerate() && match.str()==vmd->name())
3533 {
3534 ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
3535 ol.startMemberDoc(ciname,name(),memAnchor,name(),memCount,memTotal,showInline);
3536 ol.addLabel(cfname, memAnchor);
3537 DString prefix = match.prefix().str();
3538 DString suffix = match.suffix().str();
3539 linkifyText(TextGeneratorOLImpl(ol),prefix,options);
3540 vmd->writeEnumDeclaration(ol,getClassDef(),getNamespaceDef(),getFileDef(),getGroupDef(),getModuleDef());
3541 linkifyText(TextGeneratorOLImpl(ol),suffix,options);
3542
3543 found=true;
3544 break;
3545 }
3546 }
3547 if (!found) // anonymous compound
3548 {
3549 const ClassDef *annoClassDef=getClassDefOfAnonymousType();
3550 DString typeName;
3551 if (annoClassDef) typeName=annoClassDef->compoundTypeString();
3552 ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
3553 ol.startMemberDoc(ciname,name(),memAnchor,title,memCount,memTotal,showInline);
3554 ol.addLabel(cfname, memAnchor);
3555 // search for the last anonymous compound name in the definition
3556
3557 ol.startMemberDocName(isObjCMethod());
3558 if (reg::search(sdef,match,reAnonymous))
3559 {
3560 static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)");
3561 reg::Match amatch;
3562 reg::search(sdef,amatch,ar);
3563 DString prefix = amatch.prefix().str();
3564 DString suffix = removeAnonymousScopes(amatch.suffix().str());
3565 //printf("writeDocumentation(): anonymous compound in definition: sdef='%s' prefix='%s' suffix='%s' annoClassDef=%p\n",
3566 // qPrint(sdef), qPrint(prefix),qPrint(suffix),(void*)annoClassDef);
3567 const MemberDef *amd = getAnonymousEnumType();
3568 if (annoClassDef && amd==nullptr)
3569 {
3570 ol.docify(prefix);
3571 DString annTypeName = annoClassDef->displayName(true);
3572 if (suffix.empty())
3573 {
3574 suffix=" "+localName();
3575 }
3576 ol.writeObjectLink(annoClassDef->getReference(),annoClassDef->getOutputFileBase(),
3577 annoClassDef->anchor(),annTypeName);
3578 linkifyText(TextGeneratorOLImpl(ol),suffix,options);
3579 }
3580 else if (amd) // type is an anonymous enum
3581 {
3582 DString typePlaceholder = " { ... } ";
3583 if (lang==SrcLangExt::Cpp)
3584 {
3585 if (amd->isEnumStruct()) typePlaceholder.prepend(" struct");
3586 else if (amd->isStrong()) typePlaceholder.prepend(" class");
3587 }
3588 ol.writeObjectLink(amd->getReference(),amd->getOutputFileBase(),amd->anchor(),prefix+typePlaceholder+suffix);
3589 }
3590 else
3591 {
3592 prefix = match.prefix().str();
3593 suffix = removeAnonymousScopes(match.suffix().str());
3594 ol.docify(prefix);
3595 ol.docify(" { ... } ");
3596 linkifyText(TextGeneratorOLImpl(ol),suffix,options);
3597 }
3598 }
3599 else
3600 {
3601 linkifyText(TextGeneratorOLImpl(ol),ldef,options);
3602 }
3603 }
3604 }
3605 else // not an enum value or anonymous compound
3606 {
3607 ol.startDoxyAnchor(cfname, cname, memAnchor, doxyName, doxyArgs);
3608 ol.startMemberDoc(ciname,name(),memAnchor,title,memCount,memTotal,showInline);
3609 ol.addLabel(cfname, memAnchor);
3610
3611 if (!m_metaData.empty() && getLanguage()==SrcLangExt::Slice)
3612 {
3613 ol.startMemberDocPrefixItem();
3614 ol.docify(m_metaData);
3615 ol.endMemberDocPrefixItem();
3616 }
3617
3618 const ClassDef *cd=getClassDef();
3619 const NamespaceDef *nd=getNamespaceDef();
3620 if (!m_defTmpArgLists.empty() && lang==SrcLangExt::Cpp)
3621 // definition has explicit template parameter declarations
3622 {
3623 for (const ArgumentList &tal : m_defTmpArgLists)
3624 {
3625 if (!tal.empty())
3626 {
3627 ol.startMemberDocPrefixItem();
3628 _writeTemplatePrefix(ol,scopedContainer,tal);
3629 ol.endMemberDocPrefixItem();
3630 }
3631 }
3632 }
3633 else // definition gets it template parameters from its class
3634 // (since no definition was found)
3635 {
3636 if (cd && lang==SrcLangExt::Cpp && !isTemplateSpecialization())
3637 {
3638 for (const ArgumentList &tal : cd->getTemplateParameterLists())
3639 {
3640 if (!tal.empty())
3641 {
3642 ol.startMemberDocPrefixItem();
3643 _writeTemplatePrefix(ol,scopedContainer,tal,false);
3644 ol.endMemberDocPrefixItem();
3645 }
3646 }
3647 }
3648 if (m_tArgList.hasParameters() && lang==SrcLangExt::Cpp) // function template prefix
3649 {
3650 ol.startMemberDocPrefixItem();
3651 _writeTemplatePrefix(ol,scopedContainer,m_tArgList);
3652 ol.endMemberDocPrefixItem();
3653 }
3654 }
3655
3656 if (!sl.empty())
3657 {
3658 ol.pushGeneratorState();
3659 ol.disableAll();
3660 ol.enable(OutputType::Html);
3661 ol.writeString("<table class=\"mlabels\">\n");
3662 ol.writeString(" <tr>\n");
3663 ol.writeString(" <td class=\"mlabels-left\">\n");
3664 ol.popGeneratorState();
3665 htmlEndLabelTable=true;
3666 }
3667
3668 ol.startMemberDocName(isObjCMethod());
3669 if (cd && cd->isObjectiveC())
3670 {
3671 // strip scope name
3672 if (size_t ep = ldef.find("::"); ep!=DString::npos)
3673 {
3674 if (size_t sp=ldef.rfind(' ',ep); sp!=DString::npos)
3675 {
3676 ldef=ldef.left(sp+1)+ldef.mid(ep+2);
3677 } else {
3678 ldef=ldef.mid(ep+2);
3679 }
3680 }
3681 // strip keywords
3682 if (size_t dp = ldef.find(':'); dp!=DString::npos)
3683 {
3684 ldef=ldef.left(dp+1);
3685 }
3686 int dl=static_cast<int>(ldef.length());
3687 //printf("start >%s<\n",qPrint(ldef));
3688 int i=dl-1;
3689 while (i>=0 && (isId(ldef.at(i)) || ldef.at(i)==':')) i--;
3690 while (i>=0 && isspace(static_cast<uint8_t>(ldef.at(i)))) i--;
3691 if (i>0)
3692 {
3693 // insert branches around the type
3694 ldef="("+ldef.left(i+1)+")"+ldef.mid(i+1);
3695 }
3696 //printf("end >%s< i=%d\n",qPrint(ldef),i);
3697 if (isStatic()) ldef.prepend("+ "); else ldef.prepend("- ");
3698 }
3699
3700 if (optVhdl)
3701 {
3702 hasParameterList=VhdlDocGen::writeVHDLTypeDocumentation(this,scopedContainer,ol);
3703 }
3704 else if (lang==SrcLangExt::Slice)
3705 {
3706 // Eliminate the self-reference.
3707 size_t pos = ldef.rfind(' ');
3708 if (pos==DString::npos) pos=0;
3709 if (pos>0)
3710 {
3711 linkifyText(TextGeneratorOLImpl(ol),ldef.left(pos),options);
3712 }
3713 ol.docify(ldef.mid(pos));
3714 const Definition *scope = cd;
3715 if (scope==nullptr) scope = nd;
3716 hasParameterList=writeDefArgumentList(ol,scope,this);
3717 }
3718 else
3719 {
3720 linkifyText(TextGeneratorOLImpl(ol),substitute(ldef,"::",sep),options);
3721 const Definition *scope = cd;
3722 if (scope==nullptr) scope = nd;
3723 hasParameterList=writeDefArgumentList(ol,scope,this);
3724 }
3725
3726 if (hasOneLineInitializer()) // add initializer
3727 {
3728 if (isTypeAlias())
3729 {
3730 ol.docify(" = ");
3731 DString init = m_initializer.simplifyWhiteSpace();
3732 linkifyText(TextGeneratorOLImpl(ol),init,options);
3733 }
3734 else if (!isDefine())
3735 {
3736 ol.docify(" ");
3737 DString init = m_initializer.simplifyWhiteSpace();
3738 linkifyText(TextGeneratorOLImpl(ol),init,options);
3739 }
3740 else
3741 {
3742 ol.writeNonBreakableSpace(3);
3743 linkifyText(TextGeneratorOLImpl(ol),m_initializer,options);
3744 }
3745 }
3746 if (!excpString().empty()) // add exception list
3747 {
3748 writeExceptionList(ol,cd,this);
3749 hasParameterList=true; // call endParameterList below
3750 }
3751 }
3752
3753 ol.pushGeneratorState();
3754 ol.disable(OutputType::Html);
3755 if (!sl.empty())
3756 {
3757 ol.startLabels();
3758 size_t count=0;
3759 for (const auto &s : sl)
3760 {
3761 count++;
3762 ol.writeLabel(s,count==sl.size());
3763 }
3764 ol.endLabels();
3765 }
3766 ol.popGeneratorState();
3767
3768 if (hasParameterList)
3769 {
3770 ol.endParameterList();
3771 ol.endMemberDoc(true);
3772 }
3773 else
3774 {
3775 ol.endMemberDocName();
3776 ol.endMemberDoc(false);
3777 }
3778
3779 // for HTML write the labels here
3780 ol.pushGeneratorState();
3781 ol.disableAll();
3782 ol.enable(OutputType::Html);
3783 if (htmlEndLabelTable)
3784 {
3785 ol.writeString(" </td>\n");
3786 ol.writeString(" <td class=\"mlabels-right\">\n");
3787 ol.startLabels();
3788 size_t count=0;
3789 for (const auto &s : sl)
3790 {
3791 count++;
3792 ol.writeLabel(s,count==sl.size());
3793 }
3794 ol.endLabels();
3795 ol.writeString(" </td>\n");
3796 ol.writeString(" </tr>\n");
3797 ol.writeString("</table>\n");
3798 }
3799 ol.writeString("</div>");
3800 ol.popGeneratorState();
3801
3802
3803 ol.endDoxyAnchor(cfname,memAnchor);
3804 ol.startIndent();
3805
3806 _writeGroupInclude(ol,inGroup);
3807
3808 /* write multi-line initializer (if any) */
3809 if (hasMultiLineInitializer()) _writeMultiLineInitializer(ol,scopeName);
3810
3811 /* write brief description */
3812 DString brief = briefDescription();
3813 if (!brief.empty() &&
3814 (Config_getBool(REPEAT_BRIEF) ||
3815 !Config_getBool(BRIEF_MEMBER_DESC)
3816 )
3817 )
3818 {
3819 ol.startParagraph();
3820 ol.generateDoc(briefFile(),
3821 briefLine(),
3822 scopedContainer,
3823 this,
3824 brief,
3825 DocOptions()
3826 .setSingleLine(true));
3827 ol.endParagraph();
3828 }
3829
3830 /* write detailed description */
3831 DString detailed = documentation();
3832 if (!detailed.empty() ||
3833 !inbodyDocumentation().empty())
3834 {
3835 // write vhdl inline code with or without option INLINE_SOURCE
3836 if (optVhdl && VhdlDocGen::isMisc(this))
3837 {
3838 VhdlDocGen::writeSource(this,ol,cname);
3839 return;
3840 }
3841 else
3842 {
3843 ol.generateDoc(docFile(),
3844 docLine(),
3845 scopedContainer,
3846 this,
3847 detailed+"\n",
3848 DocOptions()
3849 .setIndexWords(true));
3850 }
3851
3852 if (!inbodyDocumentation().empty())
3853 {
3854 ol.generateDoc(inbodyFile(),
3855 inbodyLine(),
3856 scopedContainer,
3857 this,
3858 inbodyDocumentation()+"\n",
3859 DocOptions()
3860 .setIndexWords(true));
3861 }
3862 }
3863 else if (!brief.empty() && (Config_getBool(REPEAT_BRIEF) || !Config_getBool(BRIEF_MEMBER_DESC)))
3864 {
3865 if (!inbodyDocumentation().empty())
3866 {
3867 ol.generateDoc(inbodyFile(),
3868 inbodyLine(),
3869 scopedContainer,
3870 this,
3871 inbodyDocumentation()+"\n",
3872 DocOptions()
3873 .setIndexWords(true));
3874 }
3875 }
3876
3877
3878 //printf("***** defArgList=%p name=%s docs=%s hasDocs=%d\n",
3879 // defArgList,
3880 // defArgList?defArgList->hasDocumentation():-1);
3881 const ArgumentList &docArgList = m_templateMaster ?
3882 m_templateMaster->argumentList() :
3883 m_defArgList;
3884 ol.generateDoc(docFile(),
3885 docLine(),
3886 scopedContainer,
3887 this, // memberDef
3888 inlineArgListToDoc(docArgList), // docStr
3889 DocOptions()
3890 .setIndexWords(true));
3891
3892 const ArgumentList &docTemplateArgList = m_templateMaster ?
3893 m_templateMaster->templateArguments() :
3894 m_tArgList;
3895 ol.generateDoc(docFile(),
3896 docLine(),
3897 scopedContainer,
3898 this, // memberDef
3899 inlineTemplateArgListToDoc(docTemplateArgList), // docStr
3900 DocOptions()
3901 .setIndexWords(true));
3902
3903 _writeEnumValues(ol,scopedContainer,cfname,ciname,cname);
3904 _writeReimplements(ol);
3905 _writeReimplementedBy(ol);
3906 _writeCategoryRelation(ol);
3907 _writeExamples(ol);
3908 _writeTypeConstraints(ol);
3909 DString scopeStr = getScopeString();
3910 writeSourceDef(ol);
3911 writeInlineCode(ol,scopeStr);
3912 if (hasReferencesRelation()) writeSourceRefs(ol,scopeStr);
3913 if (hasReferencedByRelation()) writeSourceReffedBy(ol,scopeStr);
3914 _writeCallGraph(ol);
3915 _writeCallerGraph(ol);
3916 if (hasRequirementRefs()) writeRequirementRefs(ol);
3917
3918 ol.endIndent();
3919
3920 // enable LaTeX again
3921 //if (Config_getBool(EXTRACT_ALL) && !hasDocs) ol.enable(OutputType::Latex);
3922 ol.popGeneratorState();
3923
3924 warnIfUndocumentedParams();
3925}
3926
3927// strip scope and field name from the type
3928// example: "struct N<K::J>::S.v.c" will become "struct v"
3929static DString simplifyTypeForTable(const DString &s)
3930{
3931 DString ts=removeAnonymousScopes(s);
3932 if (ts.endsWith("::")) ts = ts.left(ts.length()-2);
3933 static const reg::Ex re1(R"(\a\w*::)"); // non-template version
3934 static const reg::Ex re2(R"(\a\w*<[^>]*>::)"); // template version
3935 reg::Match match;
3936 std::string t = ts.str();
3937 while (reg::search(t,match,re2) || reg::search(t,match,re1))
3938 {
3939 t = match.prefix().str() + match.suffix().str(); // remove the matched part
3940 }
3941 //printf("simplifyTypeForTable(%s)->%s\n",qPrint(s),qPrint(t));
3942 return t;
3943}
3944
3945DString MemberDefImpl::fieldType() const
3946{
3947 DString type = m_type;
3948 if (isTypedef() && getLanguage() != SrcLangExt::Slice) type.prepend("typedef ");
3949 return simplifyTypeForTable(type);
3950}
3951
3952void MemberDefImpl::writeMemberDocSimple(OutputList &ol, const Definition *container) const
3953{
3954 Definition *scope = getOuterScope();
3955 DString doxyName = name();
3956 DString doxyArgs = argsString();
3957 DString memAnchor = anchor();
3958 DString cfname = getOutputFileBase();
3959 DString cname;
3960 if (scope) cname = scope->name();
3961 if (doxyName.at(0)=='@')
3962 {
3963 doxyName="__unnamed__";
3964 }
3965
3966 LinkifyTextOptions options;
3967 options.setScope(scope).setFileScope(getBodyDef()).setSelf(this);
3968
3969 if (container && container->definitionType()==Definition::TypeClass &&
3970 !(toClassDef(container))->isJavaEnum())
3971 {
3972 ol.startInlineMemberType();
3973 ol.startDoxyAnchor(cfname,cname,memAnchor,doxyName,doxyArgs);
3974 ol.addLabel(cfname,memAnchor);
3975
3976 bool written=false;
3977 const ClassDef *annoClassDef=getClassDefOfAnonymousType();
3978 if (annoClassDef)
3979 {
3980 static const reg::Ex ar(R"([\w@:]*@\d+[\w@:]*)"); // anonymous type marker(s) including scope
3981 reg::Match amatch;
3982 std::string stype = m_type.str();
3983 if (reg::search(stype,amatch,ar))
3984 {
3985 size_t ai = amatch.position();
3986 size_t al = amatch.length();
3987 ol.writeObjectLink(annoClassDef->getReference(),annoClassDef->getOutputFileBase(),
3988 annoClassDef->anchor(),m_type.left(ai)+m_type.mid(ai+al));
3989 written=true;
3990 }
3991 }
3992 if (!written)
3993 {
3994 DString ts;
3995 if (isFunctionPtr())
3996 {
3997 ts = m_type + m_args;
3998 }
3999 else
4000 {
4001 ts = fieldType();
4002 }
4003 linkifyText(TextGeneratorOLImpl(ol),ts,options);
4004 }
4005 ol.endDoxyAnchor(cfname,memAnchor);
4006 ol.endInlineMemberType();
4007 }
4008
4009 ol.startInlineMemberName();
4010 ol.docify(doxyName);
4011 if (isVariable() && !argsString().empty() && !isObjCMethod() && !isFunctionPtr())
4012 {
4013 linkifyText(TextGeneratorOLImpl(ol),argsString(),LinkifyTextOptions(options).setArgumentList(&m_defArgList));
4014 }
4015 if (!m_bitfields.empty()) // add bitfields
4016 {
4017 linkifyText(TextGeneratorOLImpl(ol),m_bitfields,options);
4018 }
4019 if (hasOneLineInitializer() && !isDefine())
4020 {
4021 ol.writeString(" ");
4022 linkifyText(TextGeneratorOLImpl(ol),m_initializer.simplifyWhiteSpace(),options);
4023 }
4024 ol.endInlineMemberName();
4025
4026 ol.startInlineMemberDoc();
4027
4028 DString brief = briefDescription();
4029 DString detailed = documentation();
4030
4031 /* write brief description */
4032 if (!brief.empty())
4033 {
4034 ol.generateDoc(briefFile(),
4035 briefLine(),
4036 getOuterScope()?getOuterScope():container,this,
4037 brief,
4038 DocOptions()
4039 .setSingleLine(true));
4040 }
4041
4042 /* write detailed description */
4043 if (!detailed.empty())
4044 {
4045 if (!brief.empty())
4046 {
4047 ol.disable(OutputType::Html);
4048 ol.lineBreak();
4049 ol.enable(OutputType::Html);
4050 }
4051 ol.generateDoc(docFile(),
4052 docLine(),
4053 getOuterScope()?getOuterScope():container,this,
4054 detailed+"\n",
4055 DocOptions());
4056 }
4057
4058 ol.endInlineMemberDoc();
4059}
4060
4061DString MemberDefImpl::memberTypeName() const
4062{
4063 if (m_mtype == MemberType::Define)
4064 {
4065 return "macro definition";
4066 }
4067 else if (m_mtype == MemberType::Enumeration)
4068 {
4069 return "enumeration";
4070 }
4071 return to_string_lower(m_mtype);
4072}
4073
4074void MemberDefImpl::warnIfUndocumented() const
4075{
4076 /*
4077 * Removed bug_303020:
4078 * if (m_memberGroup) return;
4079 */
4080 const ClassDef *cd = getClassDef();
4081 const NamespaceDef *nd = getNamespaceDef();
4082 const FileDef *fd = getFileDef();
4083 const GroupDef *gd = getGroupDef();
4084 const Definition *d=nullptr;
4085 DString t;
4086 if (cd)
4087 {
4088 t=cd->compoundTypeString();
4089 d=cd;
4090 }
4091 else if (nd)
4092 {
4093 t=nd->compoundTypeString();
4094 d=nd;
4095 }
4096 else if (gd)
4097 {
4098 t="group";
4099 d=gd;
4100 }
4101 else
4102 {
4103 t="file";
4104 d=fd;
4105 }
4106 bool extractAll = Config_getBool(EXTRACT_ALL);
4107
4108 //printf("%s:warnIfUndoc: hasUserDocs=%d isFriendClass=%d protection=%d isRef=%d isDel=%d\n",
4109 // qPrint(name()),
4110 // hasUserDocumentation(),isFriendClass(),protectionLevelVisible(m_prot),isReference(),isDeleted());
4111 if ((!hasUserDocumentation() && !extractAll) &&
4112 !isFriendClass() &&
4113 name().find('@')==DString::npos && d && d->name().find('@')==DString::npos &&
4114 !_isAnonymousBitField() &&
4115 protectionLevelVisible(m_prot) &&
4116 !isReference() && !isDeleted()
4117 )
4118 {
4119 SrcLangExt lang = getLanguage();
4120 DString sep = getLanguageSpecificSeparator(lang,true);
4121 warn_undoc(getDefFileName(),getDefLine(),"Member {}{} ({}) of {} {} is not documented.",
4122 name(),argsString(),memberTypeName(),t,
4123 substitute(d->name(),"::",sep));
4124 }
4125 else if (!hasDetailedDescription())
4126 {
4127 warnIfUndocumentedParams();
4128 }
4129
4130 // if it is an enum, we check that its members are documented
4131 if (!extractAll && isEnumerate() && Config_getBool(WARN_IF_UNDOC_ENUM_VAL))
4132 {
4133 for (const auto &fmd : enumFieldList())
4134 {
4135 if (!fmd->isLinkableInProject())
4136 {
4137 SrcLangExt lang = getLanguage();
4138 DString sep = getLanguageSpecificSeparator(lang,true);
4139 warn(fmd->getDefFileName(),fmd->getDefLine(), "Documentation for enum member '{}{}{}' is missing.",
4140 qualifiedName(),sep,fmd->name());
4141 }
4142 }
4143 }
4144}
4145
4146bool MemberDefImpl::visibleInIndex() const
4147{
4148 bool hideUndocMembers = Config_getBool(HIDE_UNDOC_MEMBERS);
4149 bool extractStatic = Config_getBool(EXTRACT_STATIC);
4150 return (!isAnonymous() &&
4151 (!hideUndocMembers || hasDocumentation()) &&
4152 (!isStatic() || extractStatic) &&
4153 isLinkable()
4154 );
4155}
4156
4157static DString stripTrailingReturn(const DString &trailRet)
4158{
4159 DString ret = trailRet;
4160
4161 ret = ret.stripWhiteSpace();
4162 if (ret.startsWith("->"))
4163 {
4164 ret = ret.mid(2).stripWhiteSpace();
4165 return ret;
4166 }
4167 return trailRet;
4168}
4169
4170static std::mutex g_detectUndocumentedParamsMutex;
4171
4172void MemberDefImpl::detectUndocumentedParams(bool hasParamCommand,bool hasReturnCommand) const
4173{
4174 //printf("%s:detectUndocumentedParams(%d,%d)\n",qPrint(name()),hasParamCommand,hasReturnCommand);
4175 bool isPython = getLanguage()==SrcLangExt::Python;
4176
4177 // this function is called while parsing the documentation. A member can have multiple
4178 // documentation blocks, which could be handled by multiple threads, hence this guard.
4179 std::lock_guard<std::mutex> lock(g_detectUndocumentedParamsMutex);
4180
4181 if (!m_hasDocumentedParams && hasParamCommand)
4182 {
4183 //printf("%s:hasDocumentedParams=true;\n",qPrint(name()));
4184 m_hasDocumentedParams = true;
4185 }
4186 else if (!m_hasDocumentedParams)
4187 {
4188 const ArgumentList &al = argumentList();
4189 const ArgumentList &declAl = declArgumentList();
4190 bool allDoc=true; // no parameter => all parameters are documented
4191 if ( // member has parameters
4192 al.hasParameters() // with at least one parameter (that is not void)
4193 )
4194 {
4195 // see if all parameters have documentation
4196 for (auto it = al.begin(); it!=al.end() && allDoc; ++it)
4197 {
4198 const Argument &a = *it;
4199 if (!a.name.empty() && a.type!="void" && a.name!="..." &&
4200 !(isPython && (a.name=="self" || a.name=="cls"))
4201 )
4202 {
4203 allDoc = !a.docs.empty();
4204 }
4205 //printf("a.type=%s a.name=%s doc=%s\n",
4206 // qPrint(a.type),qPrint(a.name),qPrint(a.docs));
4207 }
4208 if (!allDoc && declAl.empty()) // try declaration arguments as well
4209 {
4210 allDoc=true;
4211 for (auto it = al.begin(); it!=al.end() && allDoc; ++it)
4212 {
4213 const Argument &a = *it;
4214 if (!a.name.empty() && a.type!="void" && a.name!="..." &&
4215 !(isPython && (a.name=="self" || a.name=="cls"))
4216 )
4217 {
4218 allDoc = !a.docs.empty();
4219 }
4220 //printf("a.name=%s doc=%s\n",qPrint(a.name),qPrint(a.docs));
4221 }
4222 }
4223 }
4224 if (allDoc)
4225 {
4226 //printf("%s:hasDocumentedParams=true;\n",qPrint(name()));
4227 m_hasDocumentedParams = true;
4228 }
4229 }
4230
4231 //printf("Member %s hasDocumentedReturnType=%d hasReturnCommand=%d\n",
4232 // qPrint(name()),m_hasDocumentedReturnType,hasReturnCommand);
4233 m_hasDocumentedReturnType = m_hasDocumentedReturnType || hasReturnCommand;
4234}
4235
4236void MemberDefImpl::warnIfUndocumentedParams() const
4237{
4238 DString returnType = typeString();
4239 bool isFortran = getLanguage()==SrcLangExt::Fortran;
4240 bool isFortranSubroutine = isFortran && returnType.find("subroutine")!=DString::npos;
4241
4242 bool isVoidReturn = returnType=="void" || returnType.endsWith(" void");
4243 if (!isVoidReturn && (returnType=="auto" || returnType.endsWith(" auto")))
4244 {
4245 const ArgumentList &defArgList=isDocsForDefinition() ? argumentList() : declArgumentList();
4246 if (!defArgList.trailingReturnType().empty())
4247 {
4248 DString strippedTrailingReturn = stripTrailingReturn(defArgList.trailingReturnType());
4249 isVoidReturn = (strippedTrailingReturn=="void") || (strippedTrailingReturn.endsWith(" void"));
4250 }
4251 }
4252 if (!Config_getBool(EXTRACT_ALL) &&
4253 Config_getBool(WARN_IF_UNDOCUMENTED) &&
4254 Config_getBool(WARN_NO_PARAMDOC) &&
4255 isFunction() &&
4256 !isDeleted() &&
4257 !isReference() &&
4258 !Doxygen::suppressDocWarnings)
4259 {
4260 if (!m_hasDocumentedParams)
4261 {
4262 warn_doc_error(docFile(),docLine(),
4263 "parameters of member {} are not documented",
4264 qualifiedName());
4265 }
4266 if (!m_hasDocumentedReturnType &&
4267 hasDocumentation() && !returnType.empty() &&
4268 !( // not one of the cases where nothing is returned
4269 isVoidReturn || // void return type
4270 isFortranSubroutine || // fortran subroutine
4271 isConstructor() || // a constructor
4272 isDestructor() || // or a destructor
4273 isFriend() // or a friend
4274 )
4275 )
4276 {
4277 warn_doc_error(docFile(),docLine(),
4278 "return type of member {} is not documented",
4279 qualifiedName());
4280 }
4281 }
4282 if (Config_getBool(WARN_IF_DOC_ERROR) &&
4283 m_hasDocumentedReturnType &&
4284 (isVoidReturn || // void return type
4285 isFortranSubroutine || // fortran subroutine
4286 isConstructor() || // a constructor
4287 isDestructor())) // or destructor
4288 {
4289 warn_doc_error(docFile(),docLine(),"found documented return type for {} that does not return anything",
4290 qualifiedName());
4291 }
4292}
4293
4294bool MemberDefImpl::isDocumentedFriendClass() const
4295{
4296 ClassDef *fcd=nullptr;
4297 DString baseName=name();
4298 if (size_t i=baseName.find('<'); i!=DString::npos) baseName=baseName.left(i);
4299 return (isFriendClass() &&
4300 (fcd=getClass(baseName)) && fcd->isLinkable());
4301}
4302
4303bool MemberDefImpl::isDeleted() const
4304{
4305 return m_defArgList.isDeleted();
4306}
4307
4308bool MemberDefImpl::hasDocumentation() const
4309{
4310 return DefinitionMixin::hasDocumentation() ||
4311 (m_mtype==MemberType::Enumeration && m_docEnumValues) || // has enum values
4312 (m_defArgList.hasDocumentation()|| m_tArgList.hasTemplateDocumentation()); // has doc (template) arguments
4313}
4314
4315
4320
4321DString MemberDefImpl::getScopeString() const
4322{
4323 DString result;
4324 if (isStrong()) result=name();
4325 else if (getClassDef()) result=getClassDef()->displayName();
4326 else if (getNamespaceDef()) result=getNamespaceDef()->displayName();
4327 return result;
4328}
4329
4330void MemberDefImpl::setAnchor()
4331{
4332 DString memAnchor = name();
4333 if (!m_args.empty()) memAnchor+=m_args;
4334 if (m_memSpec.isAlias()) // this is for backward compatibility
4335 {
4336 memAnchor.prepend(" = "+m_initializer);
4337 }
4338 memAnchor.prepend(definition()); // actually the method name is now included
4339 // twice, which is silly, but we keep it this way for backward
4340 // compatibility.
4341
4342 // include number of template arguments as well,
4343 // to distinguish between two template
4344 // specializations that only differ in the template parameters.
4345 if (m_tArgList.hasParameters())
4346 {
4347 char buf[20];
4348 snprintf(buf,20,"%d:",static_cast<int>(m_tArgList.size()));
4349 buf[19]='\0';
4350 memAnchor.prepend(buf);
4351 }
4352 if (!m_requiresClause.empty())
4353 {
4354 memAnchor+=" "+m_requiresClause;
4355 }
4356 if (m_redefineCount>0)
4357 {
4358 char buf[20];
4359 snprintf(buf,20,":%d",m_redefineCount);
4360 buf[19]='\0';
4361 memAnchor.append(buf);
4362 }
4363
4364 // convert to md5 hash
4365 m_anc = "a"+md5str(memAnchor.view());
4366}
4367
4368void MemberDefImpl::setGroupDef(GroupDef *gd,Grouping::GroupPri_t pri,
4369 const DString &fileName,int startLine,
4370 bool hasDocs,MemberDef *member)
4371{
4372 //printf("%s MemberDefImpl::setGroupDef(%s)\n",qPrint(name()),qPrint(gd->name()));
4373 m_group=gd;
4374 m_grouppri=pri;
4375 m_groupFileName=fileName;
4376 m_groupStartLine=startLine;
4377 m_groupHasDocs=hasDocs;
4378 m_groupMember=member;
4379 m_isLinkableCached = 0;
4380}
4381
4396
4404
4405void MemberDefImpl::setNamespace(NamespaceDef *nd)
4406{
4407 m_nspace=nd;
4408 setOuterScope(nd);
4409}
4410
4411std::unique_ptr<MemberDef> MemberDefImpl::createTemplateInstanceMember(
4412 const ArgumentList &formalArgs,const std::unique_ptr<ArgumentList> &actualArgs) const
4413{
4414 //printf(" Member %s %s %s\n",qPrint(typeString()),qPrint(name()),qPrint(argsString()));
4415 std::unique_ptr<ArgumentList> actualArgList = std::make_unique<ArgumentList>(m_defArgList);
4416 if (!m_defArgList.empty())
4417 {
4418 // replace formal arguments with actuals
4419 for (Argument &arg : *actualArgList)
4420 {
4421 arg.type = substituteTemplateArgumentsInString(arg.type,formalArgs,actualArgs.get());
4422 }
4423 actualArgList->setTrailingReturnType(
4424 substituteTemplateArgumentsInString(actualArgList->trailingReturnType(),formalArgs,actualArgs.get()));
4425 }
4426
4427 DString methodName=name();
4428 if (methodName.startsWith("operator ")) // conversion operator
4429 {
4430 methodName=substituteTemplateArgumentsInString(methodName,formalArgs,actualArgs.get());
4431 }
4432
4433 auto imd = createMemberDef(
4434 getDefFileName(),getDefLine(),getDefColumn(),
4435 substituteTemplateArgumentsInString(m_type,formalArgs,actualArgs.get()),
4436 methodName,
4437 substituteTemplateArgumentsInString(m_args,formalArgs,actualArgs.get()),
4438 m_exception, m_prot,
4439 m_virt, m_stat, m_related, m_mtype,
4440 ArgumentList(), ArgumentList(), ""
4441 );
4442 auto mmd = toMemberDefMutable(imd.get());
4443 mmd->moveArgumentList(std::move(actualArgList));
4444 mmd->setDefinition(substituteTemplateArgumentsInString(m_def,formalArgs,actualArgs.get()));
4445 mmd->setBodyDef(getBodyDef());
4446 mmd->setBodySegment(getDefLine(),getStartBodyLine(),getEndBodyLine());
4447 mmd->setFormalTemplateArguments(formalArgs);
4448
4449 // TODO: init other member variables (if needed).
4450 // TODO: reimplemented info
4451 return imd;
4452}
4453
4454bool MemberDefImpl::hasOneLineInitializer() const
4455{
4456 //printf("%s: init=%s, initLines=%d maxInitLines=%d userInitLines=%d\n",
4457 // qPrint(name()),qPrint(m_initializer),m_initLines,
4458 // m_maxInitLines,m_userInitLines);
4459 bool isFuncLikeMacro = m_mtype==MemberType::Define && m_defArgList.hasParameters();
4460 return !m_initializer.empty() && m_initLines==0 && // one line initializer
4461 !isFuncLikeMacro &&
4462 ((m_maxInitLines>0 && m_userInitLines==-1) || m_userInitLines>0); // enabled by default or explicitly
4463}
4464
4465bool MemberDefImpl::hasMultiLineInitializer() const
4466{
4467 //printf("initLines=%d userInitLines=%d maxInitLines=%d\n",
4468 // initLines,userInitLines,maxInitLines);
4469 bool isFuncLikeMacro = m_mtype==MemberType::Define && m_defArgList.hasParameters();
4470 return (m_initLines>0 || (!m_initializer.empty() && isFuncLikeMacro)) &&
4471 ((m_initLines<m_maxInitLines && m_userInitLines==-1) // implicitly enabled
4472 || m_initLines<m_userInitLines // explicitly enabled
4473 );
4474}
4475
4476void MemberDefImpl::setInitializer(const DString &initializer)
4477{
4478 size_t indent=0;
4479 m_initializer=detab(initializer,indent);
4480 int l=static_cast<int>(m_initializer.length());
4481 int p=l-1;
4482 while (p>=0 && isspace(static_cast<uint8_t>(m_initializer.at(p)))) p--;
4483 m_initializer=m_initializer.left(p+1);
4484 m_initLines=m_initializer.contains('\n');
4485 stripIndentationVerbatim(m_initializer,indent, false);
4486
4487 //printf("%s::setInitializer(%s)\n",qPrint(name()),qPrint(m_initializer));
4488}
4489
4490void MemberDefImpl::addListReference(const Definition *)
4491{
4492 bool optimizeOutputForC = Config_getBool(OPTIMIZE_OUTPUT_FOR_C);
4493 SrcLangExt lang = getLanguage();
4494 if (!isLinkableInProject()) return;
4495 DString memLabel;
4496 if (optimizeOutputForC)
4497 {
4498 memLabel=theTranslator->trGlobal(true,true);
4499 }
4500 else if (lang==SrcLangExt::Fortran)
4501 {
4502 memLabel=theTranslator->trSubprogram(true,true);
4503 }
4504 else
4505 {
4506 memLabel=theTranslator->trMember(true,true);
4507 }
4508 DString memName = name();
4509 Definition *pd=getOuterScope();
4510 DString pdName = pd->definitionType()==Definition::TypeClass ?
4511 (toClassDef(pd))->displayName() : pd->name();
4512 DString sep = getLanguageSpecificSeparator(lang,true);
4513 DString memArgs;
4514 if (!isRelated())
4515 {
4516 if (isObjCMethod())
4517 {
4518 memName = "[" + pd->name() + " " + name() + "]";
4519 }
4520 else
4521 {
4522 if (pd!=Doxygen::globalScope) memName.prepend(pdName+sep);
4523 memArgs = argsString();
4524 }
4525 }
4526 const RefItemVector &xrefItems = xrefListItems();
4527 if (sep!="::")
4528 {
4529 memName = substitute(memName,"::",sep);
4530 }
4531 addRefItem(xrefItems,
4532 qualifiedName()+argsString(), // argsString is needed for overloaded functions (see bug 609624)
4533 memLabel,
4534 getOutputFileBase()+"#"+anchor(),memName,memArgs,pd);
4535}
4536
4541
4542const MemberList *MemberDefImpl::getSectionList(const Definition *container) const
4543{
4544 auto it = m_sectionMap.find(container);
4545 return it!=m_sectionMap.end() ? it->second : nullptr;
4546}
4547
4548void MemberDefImpl::setSectionList(const Definition *container,const MemberList *sl)
4549{
4550 //printf("MemberDefImpl::setSectionList(%s,%p) name=%s\n",qPrint(d->name()),sl,qPrint(name()));
4551 m_sectionMap.emplace(container,sl);
4552}
4553
4554Specifier MemberDefImpl::virtualness(int count) const
4555{
4556 if (count>25)
4557 {
4558 warn(getDefFileName(),getDefLine(),
4559 "Internal inconsistency: recursion detected in overload relation for member {}!",name());
4560 return Specifier::Normal;
4561 }
4562 Specifier v = m_virt;
4563 const MemberDef *rmd = reimplements();
4564 while (rmd && v==Specifier::Normal)
4565 {
4566 v = rmd->virtualness(count+1)==Specifier::Normal ? Specifier::Normal : Specifier::Virtual;
4567 rmd = rmd->reimplements();
4568 }
4569 return v;
4570}
4571
4572void MemberDefImpl::writeTagFile(TextStream &tagFile,bool useQualifiedName,bool showNamespaceMembers) const
4573{
4574 if (!isLinkableInProject()) return;
4575 if (!showNamespaceMembers && getNamespaceDef()) return;
4576 tagFile << " <member kind=\"";
4577 if (m_mtype == MemberType::Enumeration)
4578 {
4579 tagFile << "enumeration";
4580 }
4581 else
4582 {
4583 tagFile << to_string_lower(m_mtype);
4584 }
4585 if (m_prot!=Protection::Public)
4586 {
4587 tagFile << "\" protection=\"";
4588 if (m_prot==Protection::Protected) tagFile << "protected";
4589 else if (m_prot==Protection::Package) tagFile << "package";
4590 else /* Private */ tagFile << "private";
4591 }
4592 if (m_virt!=Specifier::Normal)
4593 {
4594 tagFile << "\" virtualness=\"";
4595 if (m_virt==Specifier::Virtual) tagFile << "virtual";
4596 else /* Pure */ tagFile << "pure";
4597 }
4598 if (isStatic())
4599 {
4600 tagFile << "\" static=\"yes";
4601 }
4602 tagFile << "\">\n";
4603 if (typeString()!=DString("@"))
4604 {
4605 tagFile << " <type>" << convertToXML(typeString()) << "</type>\n";
4606 }
4607 DString fn = getOutputFileBase();
4608 addHtmlExtensionIfMissing(fn);
4609 tagFile << " <name>" << convertToXML(useQualifiedName ? qualifiedName() : name()) << "</name>\n";
4610 tagFile << " <anchorfile>" << convertToXML(fn) << "</anchorfile>\n";
4611 tagFile << " <anchor>" << convertToXML(anchor()) << "</anchor>\n";
4612 DString idStr = id();
4613 if (!idStr.empty())
4614 {
4615 tagFile << " <clangid>" << convertToXML(idStr) << "</clangid>\n";
4616 }
4617 tagFile << " <arglist>" << convertToXML(argsString()) << "</arglist>\n";
4618 if (isStrong())
4619 {
4620 for (const auto &fmd : m_enumFields)
4621 {
4622 if (!fmd->isReference())
4623 {
4624 tagFile << " <enumvalue file=\"" << convertToXML(fn);
4625 tagFile << "\" anchor=\"" << convertToXML(fmd->anchor());
4626 idStr = fmd->id();
4627 if (!idStr.empty())
4628 {
4629 tagFile << "\" clangid=\"" << convertToXML(idStr);
4630 }
4631 tagFile << "\">" << convertToXML(fmd->name()) << "</enumvalue>\n";
4632 }
4633 }
4634 }
4635 writeDocAnchorsToTagFile(tagFile);
4636 tagFile << " </member>\n";
4637}
4638
4639void MemberDefImpl::_computeIsConstructor()
4640{
4641 m_isConstructorCached=1; // false
4642 if (getClassDef())
4643 {
4644 if (m_isDMember) // for D
4645 {
4646 m_isConstructorCached = name()=="this" ? 2 : 1;
4647 return;
4648 }
4649 else if (getLanguage()==SrcLangExt::PHP) // for PHP
4650 {
4651 m_isConstructorCached = name()=="__construct" ? 2 : 1;
4652 return;
4653 }
4654 else if (name()=="__init__" &&
4655 getLanguage()==SrcLangExt::Python) // for Python
4656 {
4657 m_isConstructorCached = 2; // true
4658 return;
4659 }
4660 else // for other languages
4661 {
4662 DString locName = getClassDef()->localName();
4663 size_t i=locName.find('<');
4664 if (i==DString::npos) // not a template class
4665 {
4666 m_isConstructorCached = name()==locName ? 2 : 1;
4667 }
4668 else
4669 {
4670 m_isConstructorCached = name()==locName.left(i) ? 2 : 1;
4671 }
4672 return;
4673 }
4674 }
4675}
4676
4677bool MemberDefImpl::isConstructor() const
4678{
4679 if (m_isConstructorCached==0)
4680 {
4681 MemberDefImpl *that = const_cast<MemberDefImpl*>(this);
4682 that->_computeIsConstructor();
4683 }
4684 ASSERT(m_isConstructorCached>0);
4685 return m_isConstructorCached==2;
4686
4687}
4688
4689void MemberDefImpl::_computeIsDestructor()
4690{
4691 bool isDestructor = false;
4692 if (m_isDMember) // for D
4693 {
4694 isDestructor = name()=="~this";
4695 }
4696 else if (getLanguage()==SrcLangExt::PHP) // for PHP
4697 {
4698 isDestructor = name()=="__destruct";
4699 }
4700 else if (name()=="__del__" &&
4701 getLanguage()==SrcLangExt::Python) // for Python
4702 {
4703 isDestructor = true;
4704 }
4705 else if (getLanguage()==SrcLangExt::Fortran) // for Fortran
4706 {
4707 isDestructor = typeString()=="final";
4708 }
4709 else // other languages
4710 {
4711 isDestructor =
4712 (name().find('~')!=DString::npos || name().find('!')!=DString::npos) // The ! is for C++/CLI
4713 && name().find("operator")==DString::npos;
4714 }
4715 m_isDestructorCached = isDestructor ? 2 : 1;
4716}
4717
4718bool MemberDefImpl::isDestructor() const
4719{
4720 if (m_isDestructorCached==0)
4721 {
4722 MemberDefImpl *that=const_cast<MemberDefImpl*>(this);
4723 that->_computeIsDestructor();
4724 }
4725 ASSERT(m_isDestructorCached>0);
4726 return m_isDestructorCached==2;
4727}
4728
4729void MemberDefImpl::writeEnumDeclaration(OutputList &typeDecl,
4730 const ClassDef *cd,const NamespaceDef *nd,const FileDef *fd,const GroupDef *gd,const ModuleDef *mod) const
4731{
4732 int enumMemCount=0;
4733
4734 uint32_t numVisibleEnumValues=0;
4735 for (const auto &fmd : m_enumFields)
4736 {
4737 if (fmd->isBriefSectionVisible()) numVisibleEnumValues++;
4738 }
4739 if (numVisibleEnumValues==0 && !isBriefSectionVisible())
4740 {
4741 return;
4742 }
4743
4744 DString n = name();
4745 if (size_t i=n.rfind("::"); i!=DString::npos) n=n.mid(i+2); // strip scope (TODO: is this needed?)
4746 if (n[0]!='@') // not an anonymous enum
4747 {
4748 if (isLinkableInProject() || hasDocumentedEnumValues())
4749 {
4750 //_writeTagData(compoundType);
4751 writeLink(typeDecl,cd,nd,fd,gd,mod);
4752 }
4753 else
4754 {
4755 typeDecl.startBold();
4756 typeDecl.docify(n);
4757 typeDecl.endBold();
4758 }
4759 typeDecl.writeChar(' ');
4760 }
4761 if (!m_enumBaseType.empty())
4762 {
4763 typeDecl.writeChar(':');
4764 typeDecl.writeChar(' ');
4765 typeDecl.docify(m_enumBaseType);
4766 typeDecl.writeChar(' ');
4767 }
4768
4769 uint32_t enumValuesPerLine = static_cast<uint32_t>(Config_getInt(ENUM_VALUES_PER_LINE));
4770 if (numVisibleEnumValues>0 && enumValuesPerLine>0)
4771 {
4772 typeDecl.docify("{ ");
4773
4774 auto it = m_enumFields.begin();
4775 if (it!=m_enumFields.end())
4776 {
4777 const MemberDef *fmd=*it;
4778 bool fmdVisible = fmd->isBriefSectionVisible();
4779 bool first=true;
4780 while (fmd)
4781 {
4782 if (fmdVisible)
4783 {
4784 if (!first)
4785 {
4786 typeDecl.writeString(", ");
4787 }
4788 /* in html we start a new line after a number of items */
4789 if (numVisibleEnumValues>enumValuesPerLine
4790 && (enumMemCount%enumValuesPerLine)==0
4791 )
4792 {
4793 typeDecl.pushGeneratorState();
4794 typeDecl.disableAllBut(OutputType::Html);
4795 typeDecl.enable(OutputType::Latex);
4796 typeDecl.enable(OutputType::Docbook);
4797 typeDecl.lineBreak();
4798 typeDecl.disable(OutputType::Latex);
4799 typeDecl.disable(OutputType::Docbook);
4800 typeDecl.writeString("&#160;&#160;");
4801 typeDecl.popGeneratorState();
4802 }
4803
4804 if (fmd->hasDocumentation()) // enum value has docs
4805 {
4806 fmd->writeLink(typeDecl,cd,nd,fd,gd,mod);
4807 }
4808 else // no docs for this enum value
4809 {
4810 typeDecl.startBold();
4811 typeDecl.docify(fmd->name());
4812 typeDecl.endBold();
4813 }
4814 if (fmd->hasOneLineInitializer()) // enum value has initializer
4815 {
4816 //typeDecl.writeString(" = ");
4817 typeDecl.writeString(" ");
4818 typeDecl.parseText(fmd->initializer());
4819 }
4820 first=false;
4821 }
4822
4823 bool prevVisible = fmdVisible;
4824 ++it;
4825 if (it!=m_enumFields.end())
4826 {
4827 fmd=*it;
4828 }
4829 else
4830 {
4831 fmd=nullptr;
4832 }
4833 if (prevVisible)
4834 {
4835 typeDecl.disable(OutputType::Man);
4836 typeDecl.writeString("\n"); // to prevent too long lines in LaTeX
4837 typeDecl.enable(OutputType::Man);
4838 enumMemCount++;
4839 }
4840 }
4841 if (numVisibleEnumValues>enumValuesPerLine)
4842 {
4843 typeDecl.pushGeneratorState();
4844 typeDecl.disableAllBut(OutputType::Html);
4845 typeDecl.lineBreak();
4846 typeDecl.popGeneratorState();
4847 }
4848 }
4849 typeDecl.docify(" }");
4850 }
4851}
4852
4853void MemberDefImpl::moveArgumentList(std::unique_ptr<ArgumentList> al)
4854{
4855 m_defArgList = *al;
4856}
4857
4858void MemberDefImpl::moveDeclArgumentList(std::unique_ptr<ArgumentList> al)
4859{
4860 m_declArgList = *al;
4861}
4862
4867
4868void MemberDefImpl::setType(const DString &t)
4869{
4870 m_type = t;
4871}
4872
4879
4880void MemberDefImpl::overrideCallGraph(bool e)
4881{
4882 m_hasCallGraph=e;
4883 if (e) Doxygen::parseSourcesNeeded = true;
4884}
4885
4886void MemberDefImpl::overrideCallerGraph(bool e)
4887{
4888 m_hasCallerGraph=e;
4889 if (e) Doxygen::parseSourcesNeeded = true;
4890}
4891
4897
4903
4908
4913
4914bool MemberDefImpl::isObjCMethod() const
4915{
4916 if (getClassDef() && getClassDef()->isObjectiveC() && isFunction()) return true;
4917 return false;
4918}
4919
4920bool MemberDefImpl::isObjCProperty() const
4921{
4922 if (getClassDef() && getClassDef()->isObjectiveC() && isProperty()) return true;
4923 return false;
4924}
4925
4926bool MemberDefImpl::isCSharpProperty() const
4927{
4928 if (getClassDef() && getClassDef()->isCSharp() && isProperty()) return true;
4929 return false;
4930}
4931
4932DString MemberDefImpl::qualifiedName() const
4933{
4934 if (isObjCMethod())
4935 {
4936 DString qm;
4937 if (isStatic()) qm="+"; else qm="-";
4938 qm+="[";
4939 qm+=getClassDef()->name()+" ";
4940 qm+=name();
4941 qm+="]";
4942 return qm;
4943 }
4944 else if (m_enumScope && m_enumScope->isStrong())
4945 {
4946 return m_enumScope->qualifiedName()+
4947 getLanguageSpecificSeparator(getLanguage())+
4948 localName();
4949 }
4950 else
4951 {
4952 return DefinitionMixin::qualifiedName();
4953 }
4954}
4955
4956void MemberDefImpl::setTagInfo(const TagInfo *ti)
4957{
4958 if (ti)
4959 {
4960 //printf("%s: Setting tag name=%s anchor=%s\n",qPrint(name()),qPrint(ti->tagName),qPrint(ti->anchor));
4961 m_anc=ti->anchor;
4962 setReference(ti->tagName);
4963 m_explicitOutputFileBase = stripExtension(ti->fileName);
4964 }
4965}
4966
4967DString MemberDefImpl::objCMethodName(bool localLink,bool showStatic) const
4968{
4969 DString qm;
4970 if (showStatic)
4971 {
4972 if (isStatic()) qm="+ "; else qm="- ";
4973 }
4974 qm+=name();
4975 if (!localLink) // link to method of same class
4976 {
4977 qm+=" (";
4978 qm+=getClassDef()->name();
4979 qm+=")";
4980 }
4981 return qm;
4982}
4983
4984DString MemberDefImpl::declaration() const
4985{
4986 return m_decl;
4987}
4988
4989DString MemberDefImpl::definition() const
4990{
4991 return m_def;
4992}
4993
4998
4999DString MemberDefImpl::typeString() const
5000{
5001 return m_type;
5002}
5003
5004DString MemberDefImpl::argsString() const
5005{
5006 return m_args;
5007}
5008
5009DString MemberDefImpl::excpString() const
5010{
5011 return m_exception;
5012}
5013
5014DString MemberDefImpl::bitfieldString() const
5015{
5016 return m_bitfields;
5017}
5018
5019const DString &MemberDefImpl::initializer() const
5020{
5021 return m_initializer;
5022}
5023
5024int MemberDefImpl::initializerLines() const
5025{
5026 return m_initLines;
5027}
5028
5029bool MemberDefImpl::isDocTransferDone() const
5030{
5031 return m_docTransferDone;
5032}
5033
5038
5043
5044const ClassDef *MemberDefImpl::getClassDef() const
5045{
5046 return m_classDef;
5047}
5048
5053
5058
5059const FileDef *MemberDefImpl::getFileDef() const
5060{
5061 return m_fileDef;
5062}
5063
5064FileDef *MemberDefImpl::getFileDef()
5065{
5066 return m_fileDef;
5067}
5068
5069const NamespaceDef* MemberDefImpl::getNamespaceDef() const
5070{
5071 return m_nspace;
5072}
5073
5078
5079DString MemberDefImpl::getReadAccessor() const
5080{
5081 return m_read;
5082}
5083
5084DString MemberDefImpl::getWriteAccessor() const
5085{
5086 return m_write;
5087}
5088
5089const GroupDef *MemberDefImpl::getGroupDef() const
5090{
5091 return m_group;
5092}
5093
5094GroupDef *MemberDefImpl::getGroupDef()
5095{
5096 return m_group;
5097}
5098
5099const ModuleDef *MemberDefImpl::getModuleDef() const
5100{
5101 return m_moduleDef;
5102}
5103
5108
5113
5114int MemberDefImpl::getGroupStartLine() const
5115{
5116 return m_groupStartLine;
5117}
5118
5119bool MemberDefImpl::getGroupHasDocs() const
5120{
5121 return m_groupHasDocs;
5122}
5123
5124Protection MemberDefImpl::protection() const
5125{
5126 return m_prot;
5127}
5128
5129MemberType MemberDefImpl::memberType() const
5130{
5131 return m_mtype;
5132}
5133
5134bool MemberDefImpl::isSignal() const
5135{
5136 return m_mtype==MemberType::Signal;
5137}
5138
5139bool MemberDefImpl::isSlot() const
5140{
5141 return m_mtype==MemberType::Slot;
5142}
5143
5144bool MemberDefImpl::isVariable() const
5145{
5146 return m_mtype==MemberType::Variable;
5147}
5148
5149bool MemberDefImpl::isEnumerate() const
5150{
5151 return m_mtype==MemberType::Enumeration;
5152}
5153
5154bool MemberDefImpl::isEnumValue() const
5155{
5156 return m_mtype==MemberType::EnumValue;
5157}
5158
5159bool MemberDefImpl::isTypedef() const
5160{
5161 return m_mtype==MemberType::Typedef;
5162}
5163
5164bool MemberDefImpl::isSequence() const
5165{
5166 return m_mtype==MemberType::Sequence;
5167}
5168
5169bool MemberDefImpl::isDictionary() const
5170{
5171 return m_mtype==MemberType::Dictionary;
5172}
5173
5174bool MemberDefImpl::isFunction() const
5175{
5176 return m_mtype==MemberType::Function;
5177}
5178
5179bool MemberDefImpl::isFunctionPtr() const
5180{
5181 return m_mtype==MemberType::Variable &&
5182 DString(argsString()).find(")(")!=DString::npos;
5183}
5184
5185bool MemberDefImpl::isDefine() const
5186{
5187 return m_mtype==MemberType::Define;
5188}
5189
5190bool MemberDefImpl::isFriend() const
5191{
5192 return m_mtype==MemberType::Friend;
5193}
5194
5195bool MemberDefImpl::isDCOP() const
5196{
5197 return m_mtype==MemberType::DCOP;
5198}
5199
5200bool MemberDefImpl::isProperty() const
5201{
5202 return m_mtype==MemberType::Property;
5203}
5204
5205bool MemberDefImpl::isEvent() const
5206{
5207 return m_mtype==MemberType::Event;
5208}
5209
5210bool MemberDefImpl::isRelated() const
5211{
5212 return m_related == Relationship::Related;
5213}
5214
5215bool MemberDefImpl::isForeign() const
5216{
5217 return m_related == Relationship::Foreign;
5218}
5219
5220bool MemberDefImpl::isStatic() const
5221{
5222 return m_stat;
5223}
5224
5225bool MemberDefImpl::isInline() const
5226{
5227 return m_memSpec.isInline();
5228}
5229
5230bool MemberDefImpl::isExplicit() const
5231{
5232 return m_memSpec.isExplicit();
5233}
5234
5235bool MemberDefImpl::isMutable() const
5236{
5237 return m_memSpec.isMutable();
5238}
5239
5240bool MemberDefImpl::isThreadLocal() const
5241{
5242 return m_memSpec.isThreadLocal();
5243}
5244
5245bool MemberDefImpl::isGettable() const
5246{
5247 return m_memSpec.isGettable();
5248}
5249
5250bool MemberDefImpl::isPrivateGettable() const
5251{
5252 return m_memSpec.isPrivateGettable();
5253}
5254
5255bool MemberDefImpl::isProtectedGettable() const
5256{
5257 return m_memSpec.isProtectedGettable();
5258}
5259
5260bool MemberDefImpl::isSettable() const
5261{
5262 return m_memSpec.isSettable();
5263}
5264
5265bool MemberDefImpl::isPrivateSettable() const
5266{
5267 return m_memSpec.isPrivateSettable();
5268}
5269
5270bool MemberDefImpl::isProtectedSettable() const
5271{
5272 return m_memSpec.isProtectedSettable();
5273}
5274
5275bool MemberDefImpl::isAddable() const
5276{
5277 return m_memSpec.isAddable();
5278}
5279
5280bool MemberDefImpl::isRemovable() const
5281{
5282 return m_memSpec.isRemovable();
5283}
5284
5285bool MemberDefImpl::isRaisable() const
5286{
5287 return m_memSpec.isRaisable();
5288}
5289
5290bool MemberDefImpl::isReadable() const
5291{
5292 return m_memSpec.isReadable();
5293}
5294
5295bool MemberDefImpl::isWritable() const
5296{
5297 return m_memSpec.isWritable();
5298}
5299
5300bool MemberDefImpl::isFinal() const
5301{
5302 return m_memSpec.isFinal();
5303}
5304
5305bool MemberDefImpl::isNew() const
5306{
5307 return m_memSpec.isNew();
5308}
5309
5310bool MemberDefImpl::isSealed() const
5311{
5312 return m_memSpec.isSealed();
5313}
5314
5315bool MemberDefImpl::isOverride() const
5316{
5317 return m_memSpec.isOverride();
5318}
5319
5320bool MemberDefImpl::isInitonly() const
5321{
5322 return m_memSpec.isInitonly();
5323}
5324
5325bool MemberDefImpl::isAbstract() const
5326{
5327 return m_memSpec.isAbstract();
5328}
5329
5330bool MemberDefImpl::isOptional() const
5331{
5332 return m_memSpec.isOptional();
5333}
5334
5335bool MemberDefImpl::isRequired() const
5336{
5337 return m_memSpec.isRequired();
5338}
5339
5340bool MemberDefImpl::isNonAtomic() const
5341{
5342 return m_memSpec.isNonAtomic();
5343}
5344
5345bool MemberDefImpl::isCopy() const
5346{
5347 return m_memSpec.isCopy();
5348}
5349
5350bool MemberDefImpl::isAssign() const
5351{
5352 return m_memSpec.isAssign();
5353}
5354
5355bool MemberDefImpl::isRetain() const
5356{
5357 return m_memSpec.isRetain();
5358}
5359
5360bool MemberDefImpl::isWeak() const
5361{
5362 return m_memSpec.isWeak();
5363}
5364
5365bool MemberDefImpl::isStrong() const
5366{
5367 return m_memSpec.isStrong();
5368}
5369
5370bool MemberDefImpl::isEnumStruct() const
5371{
5372 return m_memSpec.isEnumStruct();
5373}
5374
5375bool MemberDefImpl::isStrongEnumValue() const
5376{
5377 return m_mtype==MemberType::EnumValue &&
5378 m_enumScope &&
5379 m_enumScope->isStrong();
5380}
5381
5382bool MemberDefImpl::isUnretained() const
5383{
5384 return m_memSpec.isUnretained();
5385}
5386
5387bool MemberDefImpl::isTypeAlias() const
5388{
5389 return m_memSpec.isAlias();
5390}
5391
5392bool MemberDefImpl::isDefault() const
5393{
5394 return m_memSpec.isDefault();
5395}
5396
5397bool MemberDefImpl::isDelete() const
5398{
5399 return m_memSpec.isDelete();
5400}
5401
5402bool MemberDefImpl::isNoExcept() const
5403{
5404 return m_memSpec.isNoExcept();
5405}
5406
5407bool MemberDefImpl::isAttribute() const
5408{
5409 return m_memSpec.isAttribute();
5410}
5411
5412bool MemberDefImpl::isUNOProperty() const
5413{
5414 return m_memSpec.isProperty();
5415}
5416
5417bool MemberDefImpl::isReadonly() const
5418{
5419 return m_memSpec.isReadonly();
5420}
5421
5422bool MemberDefImpl::isBound() const
5423{
5424 return m_memSpec.isBound();
5425}
5426
5427bool MemberDefImpl::isConstrained() const
5428{
5429 return m_memSpec.isConstrained();
5430}
5431
5432bool MemberDefImpl::isTransient() const
5433{
5434 return m_memSpec.isTransient();
5435}
5436
5437bool MemberDefImpl::isMaybeVoid() const
5438{
5439 return m_memSpec.isMaybeVoid();
5440}
5441
5442bool MemberDefImpl::isMaybeDefault() const
5443{
5444 return m_memSpec.isMaybeDefault();
5445}
5446
5447bool MemberDefImpl::isMaybeAmbiguous() const
5448{
5449 return m_memSpec.isMaybeAmbiguous();
5450}
5451
5452bool MemberDefImpl::isPublished() const
5453{
5454 return m_memSpec.isPublished();
5455}
5456
5457
5458bool MemberDefImpl::isImplementation() const
5459{
5460 return m_implOnly;
5461}
5462
5463bool MemberDefImpl::isExternal() const
5464{
5465 return m_explExt;
5466}
5467
5468bool MemberDefImpl::isTemplateSpecialization() const
5469{
5470 return m_tspec;
5471}
5472
5473bool MemberDefImpl::isCallable() const
5474{
5475 return isFunction() ||
5476 isSlot() ||
5477 isSignal() ||
5478 isConstructor() ||
5479 isDestructor() ||
5480 isObjCMethod() ||
5481 isFriend();
5482}
5483
5484ClassDef *MemberDefImpl::relatedAlso() const
5485{
5486 return m_relatedAlso;
5487}
5488
5489bool MemberDefImpl::hasDocumentedEnumValues() const
5490{
5491 return m_docEnumValues;
5492}
5493
5494const MemberDef *MemberDefImpl::getAnonymousEnumType() const
5495{
5496 return m_annEnumType;
5497}
5498
5499bool MemberDefImpl::isDocsForDefinition() const
5500{
5501 return m_docsForDefinition;
5502}
5503
5504const MemberDef *MemberDefImpl::getEnumScope() const
5505{
5506 return m_enumScope;
5507}
5508
5509bool MemberDefImpl::livesInsideEnum() const
5510{
5511 return m_livesInsideEnum;
5512}
5513
5514bool MemberDefImpl::isSliceLocal() const
5515{
5516 return m_memSpec.isLocal();
5517}
5518
5519bool MemberDefImpl::isNoDiscard() const
5520{
5521 return m_memSpec.isNoDiscard();
5522}
5523
5524bool MemberDefImpl::isConstExpr() const
5525{
5526 return m_memSpec.isConstExpr();
5527}
5528
5529bool MemberDefImpl::isConstEval() const
5530{
5531 return m_memSpec.isConstEval();
5532}
5533
5534bool MemberDefImpl::isConstInit() const
5535{
5536 return m_memSpec.isConstInit();
5537}
5538
5539const MemberVector &MemberDefImpl::enumFieldList() const
5540{
5541 return m_enumFields;
5542}
5543
5544const ExampleList &MemberDefImpl::getExamples() const
5545{
5546 return m_examples;
5547}
5548
5549bool MemberDefImpl::isPrototype() const
5550{
5551 return m_proto;
5552}
5553
5554const ArgumentList &MemberDefImpl::argumentList() const
5555{
5556 return m_defArgList;
5557}
5558
5559const ArgumentList &MemberDefImpl::declArgumentList() const
5560{
5561 return m_declArgList;
5562}
5563
5564void MemberDefImpl::resolveUnnamedParameters(const MemberDef *md)
5565{
5566 ArgumentList &decAl = m_declArgList;
5567 ArgumentList &defAl = m_defArgList;
5568 const ArgumentList &decAlSrc = md->declArgumentList();
5569 const ArgumentList &defAlSrc = md->argumentList();
5570 auto decSrc = decAlSrc.begin(), defSrc = defAlSrc.begin();
5571 for (auto decIt = decAl.begin(), defIt = defAl.begin();
5572 decIt != decAl.end() && defIt != defAl.end() && decSrc != decAlSrc.end() && defSrc != defAlSrc.end();
5573 ++decIt, ++defIt, ++decSrc, ++defSrc++)
5574 {
5575 Argument &decA = *decIt;
5576 Argument &defA = *defIt;
5577 const Argument &decAS = *decSrc;
5578 const Argument &defAS = *defSrc;
5579 if (decA.name.empty())
5580 {
5581 if (!defA.name.empty())
5582 {
5583 decA.name = defA.name;
5584 }
5585 else if (!decAS.name.empty())
5586 {
5587 decA.name = decAS.name;
5588 }
5589 else if (!defAS.name.empty())
5590 {
5591 decA.name = defAS.name;
5592 }
5593 }
5594 if (defA.name.empty())
5595 {
5596 if (!decA.name.empty())
5597 {
5598 defA.name = decA.name;
5599 }
5600 else if (!decAS.name.empty())
5601 {
5602 defA.name = decAS.name;
5603 }
5604 else if (!defAS.name.empty())
5605 {
5606 defA.name = defAS.name;
5607 }
5608 }
5609 }
5610}
5611
5612const ArgumentList &MemberDefImpl::templateArguments() const
5613{
5614 return m_tArgList;
5615}
5616
5621
5622int MemberDefImpl::getMemberGroupId() const
5623{
5624 return m_grpId;
5625}
5626
5631
5632bool MemberDefImpl::hasCallGraph() const
5633{
5634 return m_hasCallGraph;
5635}
5636
5637bool MemberDefImpl::_hasVisibleCallGraph() const
5638{
5639 bool enabled = m_hasCallGraph &&
5640 (isFunction() || isSlot() || isSignal()) &&
5641 Config_getBool(HAVE_DOT);
5642 if (enabled)
5643 {
5644 bool trivial = DotCallGraph::isTrivial(this,false);
5645 return !trivial;
5646 }
5647 return false;
5648}
5649
5650bool MemberDefImpl::hasCallerGraph() const
5651{
5652 return m_hasCallerGraph;
5653}
5654
5655bool MemberDefImpl::_hasVisibleCallerGraph() const
5656{
5657 bool enabled = m_hasCallerGraph &&
5658 (isFunction() || isSlot() || isSignal()) &&
5659 Config_getBool(HAVE_DOT);
5660 if (enabled)
5661 {
5662 bool trivial = DotCallGraph::isTrivial(this,true);
5663 return !trivial;
5664 }
5665 return false;
5666}
5667
5672
5677
5678bool MemberDefImpl::hasInlineSource() const
5679{
5680 return m_hasInlineSource;
5681}
5682
5683bool MemberDefImpl::hasEnumValues() const
5684{
5685 return m_hasEnumValues;
5686}
5687
5688const MemberDef *MemberDefImpl::templateMaster() const
5689{
5690 return m_templateMaster;
5691}
5692
5693std::optional<ArgumentList> MemberDefImpl::formalTemplateArguments() const
5694{
5695 return m_formalTemplateArguments;
5696}
5697
5698bool MemberDefImpl::isTypedefValCached() const
5699{
5700 return m_isTypedefValCached;
5701}
5702
5707
5712
5713DString MemberDefImpl::getCachedResolvedTypedef() const
5714{
5715 //printf("MemberDefImpl::getCachedResolvedTypedef()=%s\n",qPrint(m_cachedResolvedType));
5716 return m_cachedResolvedType;
5717}
5718
5719MemberDef *MemberDefImpl::memberDefinition() const
5720{
5721 return m_memDef;
5722}
5723
5724MemberDef *MemberDefImpl::memberDeclaration() const
5725{
5726 return m_memDec;
5727}
5728
5729const MemberDef *MemberDefImpl::inheritsDocsFrom() const
5730{
5731 return m_docProvider;
5732}
5733
5734const MemberDef *MemberDefImpl::getGroupAlias() const
5735{
5736 return m_groupAlias;
5737}
5738
5743
5744int MemberDefImpl::getDeclLine() const
5745{
5746 return m_declLine;
5747}
5748
5749size_t MemberDefImpl::getDeclColumn() const
5750{
5751 return m_declColumn;
5752}
5753
5754
5755//----------------------------------------------
5756
5762
5763void MemberDefImpl::setDefinition(const DString &d)
5764{
5765 m_def=d;
5766}
5767
5775
5776void MemberDefImpl::setModuleDef(ModuleDef *mod)
5777{
5778 m_moduleDef=mod;
5779}
5780
5786
5791
5796
5801
5806
5807void MemberDefImpl::addQualifiers(const StringVector &qualifiers)
5808{
5809 for (const auto &sx : qualifiers)
5810 {
5811 bool alreadyAdded = std::find(m_qualifiers.begin(), m_qualifiers.end(), sx) != m_qualifiers.end();
5812 if (!alreadyAdded)
5813 {
5814 m_qualifiers.push_back(sx);
5815 }
5816 }
5817}
5818
5823
5824void MemberDefImpl::setMaxInitLines(int lines)
5825{
5826 if (lines!=-1)
5827 {
5828 m_userInitLines=lines;
5829 }
5830}
5831
5832void MemberDefImpl::setReadAccessor(const DString &r)
5833{
5834 m_read=r;
5835}
5836
5837void MemberDefImpl::setWriteAccessor(const DString &w)
5838{
5839 m_write=w;
5840}
5841
5842void MemberDefImpl::setTemplateSpecialization(bool b)
5843{
5844 m_tspec=b;
5845}
5846
5847void MemberDefImpl::makeRelated()
5848{
5849 m_related = Relationship::Related;
5850 m_isLinkableCached = 0;
5851}
5852
5853void MemberDefImpl::makeForeign()
5854{
5855 m_related = Relationship::Foreign;
5856 m_isLinkableCached = 0;
5857}
5858
5859void MemberDefImpl::setInheritsDocsFrom(const MemberDef *md)
5860{
5861 m_docProvider = md;
5862}
5863
5864void MemberDefImpl::setArgsString(const DString &as)
5865{
5866 m_args = as;
5867}
5868
5873
5880
5881void MemberDefImpl::setDocumentedEnumValues(bool value)
5882{
5883 m_docEnumValues=value;
5884}
5885
5886void MemberDefImpl::setAnonymousEnumType(const MemberDef *md)
5887{
5888 m_annEnumType = md;
5889}
5890
5891void MemberDefImpl::setPrototype(bool p,const DString &df,int line,size_t column)
5892{
5893 m_proto=p;
5894 if (p)
5895 {
5896 setDeclFile(df,line,column);
5897 }
5898 else
5899 {
5900 setDefFile(df,line,column);
5901 }
5902}
5903
5904void MemberDefImpl::setExplicitExternal(bool b,const DString &df,int line,size_t column)
5905{
5906 m_explExt=b;
5907 if (b)
5908 {
5909 setDeclFile(df,line,column);
5910 }
5911 else
5912 {
5913 setDefFile(df,line,column);
5914 }
5915}
5916
5917void MemberDefImpl::setDeclFile(const DString &df,int line,size_t column)
5918{
5919 m_declFileName = df;
5920 m_declLine = line;
5921 m_declColumn = column;
5922}
5923
5924void MemberDefImpl::setMemberGroupId(int id)
5925{
5926 m_grpId=id;
5927}
5928
5933
5939
5944
5949
5950void MemberDefImpl::setGroupAlias(const MemberDef *md)
5951{
5952 m_groupAlias = md;
5953}
5954
5959
5964
5969
5970ClassDef *MemberDefImpl::category() const
5971{
5972 return m_category;
5973}
5974
5975void MemberDefImpl::setCategory(ClassDef *def)
5976{
5977 m_category = def;
5978}
5979
5980const MemberDef *MemberDefImpl::categoryRelation() const
5981{
5982 return m_categoryRelation;
5983}
5984
5989
5990void MemberDefImpl::setEnumBaseType(const DString &type)
5991{
5992 m_enumBaseType = type;
5993}
5994
5995DString MemberDefImpl::enumBaseType() const
5996{
5997 return m_enumBaseType;
5998}
5999
6000void MemberDefImpl::setRequiresClause(const DString &req)
6001{
6002 m_requiresClause = req;
6003}
6004
6009
6010void MemberDefImpl::cacheTypedefVal(const ClassDef*val, const DString & templSpec, const DString &resolvedType)
6011{
6012 m_isTypedefValCached=true;
6013 m_cachedTypedefValue=val;
6014 m_cachedTypedefTemplSpec=templSpec;
6015 m_cachedResolvedType=resolvedType;
6016 //printf("MemberDefImpl::cacheTypedefVal=%s m_impl=%p\n",qPrint(m_cachedResolvedType),m_impl);
6017}
6018
6019void MemberDefImpl::copyArgumentNames(const MemberDef *bmd)
6020{
6021 {
6022 const ArgumentList &srcAl = bmd->argumentList();
6023 ArgumentList &dstAl = m_defArgList;
6024 auto srcIt = srcAl.begin();
6025 auto dstIt = dstAl.begin();
6026 while ( srcIt!=srcAl.end() && dstIt!=dstAl.end())
6027 {
6028 Argument &argDst = *dstIt;
6029 const Argument &argSrc = *srcIt;
6030 if (!argSrc.name.empty())
6031 {
6032 argDst.name = argSrc.name;
6033 }
6034 argDst.docs = argSrc.docs;
6035 ++srcIt;
6036 ++dstIt;
6037 }
6038 }
6039
6040 {
6041 const ArgumentList &srcAl = bmd->declArgumentList();
6042 ArgumentList &dstAl = m_declArgList;
6043 auto srcIt = srcAl.begin();
6044 auto dstIt = dstAl.begin();
6045
6046 while ( srcIt!=srcAl.end() && dstIt!=dstAl.end())
6047 {
6048 Argument &argDst = *dstIt;
6049 const Argument &argSrc = *srcIt;
6050 if (!argSrc.name.empty())
6051 {
6052 argDst.name = argSrc.name;
6053 }
6054 argDst.docs = argSrc.docs;
6055 ++srcIt;
6056 ++dstIt;
6057 }
6058 }
6059}
6060
6061static void invalidateCachedTypesInArgumentList(ArgumentList &al)
6062{
6063 for (Argument &a : al)
6064 {
6065 a.canType.clear();
6066 }
6067}
6068
6074
6079
6080int MemberDefImpl::numberOfFlowKeyWords() const
6081{
6082 return m_numberOfFlowKW;
6083}
6084
6085//----------------
6086
6087DString MemberDefImpl::displayName(bool) const
6088{
6089 return DefinitionMixin::name();
6090}
6091
6092//----------------
6093
6094static void transferArgumentDocumentation(ArgumentList &decAl,ArgumentList &defAl)
6095{
6096 for (auto decIt = decAl.begin(), defIt = defAl.begin();
6097 decIt!= decAl.end() && defIt!= defAl.end();
6098 ++decIt, ++defIt)
6099 {
6100 Argument &decA = *decIt;
6101 Argument &defA = *defIt;
6102 if (decA.docs.empty() && !defA.docs.empty())
6103 {
6104 decA.docs = defA.docs;
6105 }
6106 else if (defA.docs.empty() && !decA.docs.empty())
6107 {
6108 defA.docs = decA.docs;
6109 }
6110 //printf("transferArgumentDocumentation(%s<->%s)\n",qPrint(decA.name),qPrint(defA.name));
6111 if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
6112 {
6113 if (decA.name.empty() && !defA.name.empty())
6114 {
6115 decA.name = defA.name;
6116 }
6117 else if (defA.name.empty() && !decA.name.empty())
6118 {
6119 defA.name = decA.name;
6120 }
6121 }
6122 }
6123}
6124
6125void combineDeclarationAndDefinition(MemberDefMutable *mdec,MemberDefMutable *mdef)
6126{
6127 AUTO_TRACE("mdec='{}' mdef='{}' mdec.isPrototype={} mdef.isPrototype={}",
6128 mdec->name(), mdef->name(), mdec->isPrototype(), mdef->isPrototype());
6129 if (
6130 (!mdef->isDocTransferDone() || !mdec->isDocTransferDone()) &&
6131 (
6132 (mdef->isFunction() && !mdef->isStatic() && !mdef->isPrototype()) ||
6133 (mdef->isVariable() && !mdef->isExternal() && !mdef->isStatic())
6134 )
6135 )
6136 {
6137 bool sameNumTemplateArgs = mdef->templateArguments().size()==mdec->templateArguments().size();
6138
6139 ArgumentList &mdefAl = const_cast<ArgumentList&>(mdef->argumentList());
6140 ArgumentList &mdecAl = const_cast<ArgumentList&>(mdec->argumentList());
6141 if (sameNumTemplateArgs &&
6142 matchArguments2(mdef->getOuterScope(),mdef->getFileDef(),mdef->typeString(),&mdefAl,
6143 mdec->getOuterScope(),mdec->getFileDef(),mdec->typeString(),&mdecAl,
6144 true,mdef->getLanguage()
6145 )
6146 ) /* match found */
6147 {
6148 AUTO_TRACE_ADD("combining definition and declaration");
6149
6150 if (Config_getBool(RESOLVE_UNNAMED_PARAMS))
6151 {
6152 mdec->resolveUnnamedParameters(mdef);
6153 }
6154
6155 // first merge argument documentation
6156 transferArgumentDocumentation(mdecAl,mdefAl);
6157
6158 // copy brief description between definition and declaration
6159 DString mdefBrief = mdef->briefDescription();
6160 DString mdecBrief = mdec->briefDescription();
6161 DString mdefBriefFile = mdef->briefFile();
6162 DString mdecBriefFile = mdec->briefFile();
6163 int mdefBriefLine = mdef->briefLine();
6164 int mdecBriefLine = mdec->briefLine();
6165 if (!mdef->isDocTransferDone() && !mdecBrief.empty())
6166 {
6167 mdef->setBriefDescription(mdecBrief,mdecBriefFile,mdecBriefLine);
6168 }
6169 if (!mdec->isDocTransferDone() && !mdefBrief.empty())
6170 {
6171 mdec->setBriefDescription(mdefBrief,mdefBriefFile,mdefBriefLine);
6172 }
6173
6174 // copy detailed description between definition and declaration
6175 DString mdefDocs = mdef->documentation();
6176 DString mdecDocs = mdec->documentation();
6177 DString mdefFile = mdef->docFile();
6178 DString mdecFile = mdec->docFile();
6179 int mdefLine = mdef->docLine();
6180 int mdecLine = mdec->docLine();
6181 bool mdefDocsForDef = mdef->isDocsForDefinition();
6182 bool mdecDocsForDef = mdec->isDocsForDefinition();
6183 if (!mdec->isDocTransferDone() && !mdefDocs.empty())
6184 {
6185 //printf("transferring docs mdef->mdec (%s->%s)\n",mdef->argsString(),mdec->argsString());
6186 mdec->setDocumentation(mdefDocs,mdefFile,mdefLine);
6187 mdec->setDocsForDefinition(mdefDocsForDef);
6188 if (mdefAl.hasParameters())
6189 {
6190 auto mdefAlComb = stringToArgumentList(mdef->getLanguage(),mdef->argsString());
6191 transferArgumentDocumentation(mdefAl,*mdefAlComb);
6192 mdec->moveArgumentList(std::move(mdefAlComb));
6193 }
6194 }
6195 if (!mdef->isDocTransferDone() && !mdecDocs.empty())
6196 {
6197 //printf("transferring docs mdec->mdef (%s->%s)\n",mdec->argsString(),mdef->argsString());
6198 mdef->setDocumentation(mdecDocs,mdecFile,mdecLine);
6199 mdef->setDocsForDefinition(mdecDocsForDef);
6200 if (mdecAl.hasParameters())
6201 {
6202 auto mdecAlComb = stringToArgumentList(mdec->getLanguage(),mdec->argsString());
6203 transferArgumentDocumentation(mdecAl,*mdecAlComb);
6204 mdef->moveDeclArgumentList(std::move(mdecAlComb));
6205 }
6206 }
6207
6208 // copy inbody documentation between definition and declaration
6209 DString mdefInbodyDocs = mdef->inbodyDocumentation();
6210 DString mdecInbodyDocs = mdec->inbodyDocumentation();
6211 DString mdefInbodyFile = mdef->inbodyFile();
6212 DString mdecInbodyFile = mdec->inbodyFile();
6213 int mdefInbodyLine = mdef->inbodyLine();
6214 int mdecInbodyLine = mdec->inbodyLine();
6215 if (!mdec->isDocTransferDone() && !mdefInbodyDocs.empty())
6216 {
6217 mdec->setInbodyDocumentation(mdefInbodyDocs,mdefInbodyFile,mdefInbodyLine);
6218 }
6219 if (!mdef->isDocTransferDone() && !mdecInbodyDocs.empty())
6220 {
6221 mdef->setInbodyDocumentation(mdecInbodyDocs,mdecInbodyFile,mdecInbodyLine);
6222 }
6223
6224 if (mdec->getStartBodyLine()!=-1 && mdef->getStartBodyLine()==-1)
6225 {
6226 //printf("body mdec->mdef %d-%d\n",mdec->getStartBodyLine(),mdef->getEndBodyLine());
6227 mdef->setBodySegment(mdec->getDefLine(),mdec->getStartBodyLine(),mdec->getEndBodyLine());
6228 mdef->setBodyDef(mdec->getBodyDef());
6229 //mdef->setBodyMember(mdec);
6230 }
6231 else if (mdef->getStartBodyLine()!=-1 && mdec->getStartBodyLine()==-1)
6232 {
6233 //printf("body mdef->mdec %d-%d\n",mdef->getStartBodyLine(),mdec->getEndBodyLine());
6234 mdec->setBodySegment(mdef->getDefLine(),mdef->getStartBodyLine(),mdef->getEndBodyLine());
6235 mdec->setBodyDef(mdef->getBodyDef());
6236 //mdec->setBodyMember(mdef);
6237 }
6238 mdec->mergeMemberSpecifiers(mdef->getMemberSpecifiers());
6239 mdef->mergeMemberSpecifiers(mdec->getMemberSpecifiers());
6240
6241 // copy group info.
6242 if (mdec->getGroupDef()==nullptr && mdef->getGroupDef()!=nullptr)
6243 {
6244 mdec->setGroupDef(mdef->getGroupDef(),
6245 mdef->getGroupPri(),
6246 mdef->docFile(),
6247 mdef->docLine(),
6248 mdef->hasDocumentation(),
6249 mdef
6250 );
6251 }
6252 else if (mdef->getGroupDef()==nullptr && mdec->getGroupDef()!=nullptr)
6253 {
6254 mdef->setGroupDef(mdec->getGroupDef(),
6255 mdec->getGroupPri(),
6256 mdec->docFile(),
6257 mdec->docLine(),
6258 mdec->hasDocumentation(),
6259 mdec
6260 );
6261 }
6262
6263
6264 mdec->mergeRefItems(mdef);
6265 mdef->mergeRefItems(mdec);
6266
6267 mdef->setMemberDeclaration(mdec);
6268 mdec->setMemberDefinition(mdef);
6269
6270 mergeMemberOverrideOptions(mdec,mdef);
6271
6272 mdef->addQualifiers(mdec->getQualifiers());
6273 mdec->addQualifiers(mdef->getQualifiers());
6274
6275 mdef->setDocTransferDone();
6276 mdec->setDocTransferDone();
6277 }
6278 }
6279}
6280
6281void mergeMemberOverrideOptions(MemberDefMutable *md1,MemberDefMutable *md2)
6282{
6283 if (Config_getBool(CALL_GRAPH) !=md1->hasCallGraph()) md2->overrideCallGraph(md1->hasCallGraph());
6284 if (Config_getBool(CALLER_GRAPH)!=md1->hasCallerGraph()) md2->overrideCallerGraph(md1->hasCallerGraph());
6285 if (Config_getBool(CALL_GRAPH) !=md2->hasCallGraph()) md1->overrideCallGraph( md2->hasCallGraph());
6286 if (Config_getBool(CALLER_GRAPH)!=md2->hasCallerGraph()) md1->overrideCallerGraph(md2->hasCallerGraph());
6287
6288 if (Config_getBool(SHOW_ENUM_VALUES) !=md1->hasEnumValues()) md2->overrideEnumValues(md1->hasEnumValues());
6289 if (Config_getBool(SHOW_ENUM_VALUES) !=md2->hasEnumValues()) md1->overrideEnumValues( md2->hasEnumValues());
6290
6291 if (Config_getBool(REFERENCED_BY_RELATION)!=md1->hasReferencedByRelation()) md2->overrideReferencedByRelation(md1->hasReferencedByRelation());
6292 if (Config_getBool(REFERENCES_RELATION) !=md1->hasReferencesRelation()) md2->overrideReferencesRelation(md1->hasReferencesRelation());
6293 if (Config_getBool(REFERENCED_BY_RELATION)!=md2->hasReferencedByRelation()) md1->overrideReferencedByRelation(md2->hasReferencedByRelation());
6294 if (Config_getBool(REFERENCES_RELATION) !=md2->hasReferencesRelation()) md1->overrideReferencesRelation(md2->hasReferencesRelation());
6295
6296 if (Config_getBool(INLINE_SOURCES)!=md1->hasInlineSource()) md2->overrideInlineSource(md1->hasInlineSource());
6297 if (Config_getBool(INLINE_SOURCES)!=md2->hasInlineSource()) md1->overrideInlineSource(md2->hasInlineSource());
6298}
6299
6300DString MemberDefImpl::briefDescription(bool abbr) const
6301{
6302 if (m_templateMaster)
6303 {
6304 return m_templateMaster->briefDescription(abbr);
6305 }
6306 else
6307 {
6308 return DefinitionMixin::briefDescription(abbr);
6309 }
6310}
6311
6312DString MemberDefImpl::documentation() const
6313{
6314 if (m_templateMaster)
6315 {
6316 return m_templateMaster->documentation();
6317 }
6318 else
6319 {
6320 return DefinitionMixin::documentation();
6321 }
6322}
6323
6324bool MemberDefImpl::hasUserDocumentation() const
6325{
6326 if (m_templateMaster)
6327 {
6328 return m_templateMaster->hasUserDocumentation();
6329 }
6330 else
6331 {
6332 return DefinitionMixin::hasUserDocumentation();
6333 }
6334}
6335
6336const ArgumentList &MemberDefImpl::typeConstraints() const
6337{
6338 return m_typeConstraints;
6339}
6340
6341bool MemberDefImpl::isFriendToHide() const
6342{
6343 bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);
6344 bool isFriendToHide = hideFriendCompounds &&
6345 (m_type=="friend class" ||
6346 m_type=="friend struct" ||
6347 m_type=="friend union");
6348 return isFriendToHide;
6349}
6350
6351bool MemberDefImpl::isFriendClass() const
6352{
6353 return (isFriend() &&
6354 (m_type=="friend class" || m_type=="friend struct" ||
6355 m_type=="friend union"));
6356}
6357
6358
6359bool MemberDefImpl::isNotFriend() const
6360{
6361 return !(isFriend() && isFriendToHide());
6362}
6363
6364bool MemberDefImpl::isFunctionOrSignalSlot() const
6365{
6366 return isFunction() || isSlot() || isSignal();
6367}
6368
6369bool MemberDefImpl::isRelatedOrFriend() const
6370{
6371 return isRelated() || isForeign() || (isFriend() && !isFriendToHide());
6372}
6373
6379
6380CodeSymbolType MemberDefImpl::codeSymbolType() const
6381{
6382 switch (memberType())
6383 {
6384 case MemberType::Define: return CodeSymbolType::Define;
6385 case MemberType::Function: return CodeSymbolType::Function;
6386 case MemberType::Variable: return CodeSymbolType::Variable;
6387 case MemberType::Typedef: return CodeSymbolType::Typedef;
6388 case MemberType::Enumeration: return CodeSymbolType::Enumeration;
6389 case MemberType::EnumValue: return CodeSymbolType::EnumValue;
6390 case MemberType::Signal: return CodeSymbolType::Signal;
6391 case MemberType::Slot: return CodeSymbolType::Slot;
6392 case MemberType::Friend: return CodeSymbolType::Friend;
6393 case MemberType::DCOP: return CodeSymbolType::DCOP;
6394 case MemberType::Property: return CodeSymbolType::Property;
6395 case MemberType::Event: return CodeSymbolType::Event;
6396 case MemberType::Interface: return CodeSymbolType::Interface;
6397 case MemberType::Service: return CodeSymbolType::Service;
6398 case MemberType::Sequence: return CodeSymbolType::Sequence;
6399 case MemberType::Dictionary: return CodeSymbolType::Dictionary;
6400 }
6401 return CodeSymbolType::Default;
6402}
6403
6404int MemberDefImpl::redefineCount() const
6405{
6406 return m_redefineCount;
6407}
6408
6409void MemberDefImpl::setRedefineCount(int count)
6410{
6411 m_redefineCount=count;
6412}
6413
6414//-------------------------------------------------------------------------------
6415// Helpers
6416
6417static std::mutex g_docCrossReferenceMutex;
6418
6419void addDocCrossReference(const MemberDef *s,const MemberDef *d)
6420{
6421 MemberDefMutable *src = toMemberDefMutable(const_cast<MemberDef*>(s));
6422 MemberDefMutable *dst = toMemberDefMutable(const_cast<MemberDef*>(d));
6423 if (src==nullptr || dst==nullptr) return;
6424 //printf("--> addDocCrossReference src=%s,dst=%s\n",qPrint(src->name()),qPrint(dst->name()));
6425 if (dst->isTypedef() || dst->isEnumerate()) return; // don't add types
6426 if ((dst->hasReferencedByRelation() || dst->hasCallerGraph()) &&
6427 src->isCallable()
6428 )
6429 {
6430 DString sourceRefName = src->sourceRefName();
6431 MemberDefMutable *mdDef = toMemberDefMutable(dst->memberDefinition());
6432 MemberDefMutable *mdDecl = toMemberDefMutable(dst->memberDeclaration());
6433
6434 // ---- critical section
6435 std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
6436 dst->addSourceReferencedBy(src,sourceRefName);
6437 if (mdDef)
6438 {
6439 mdDef->addSourceReferencedBy(src,sourceRefName);
6440 }
6441 if (mdDecl)
6442 {
6443 mdDecl->addSourceReferencedBy(src,sourceRefName);
6444 }
6445 // ---- end critical section
6446 }
6447 if ((src->hasReferencesRelation() || src->hasCallGraph()) &&
6448 src->isCallable()
6449 )
6450 {
6451 DString sourceRefName = dst->sourceRefName();
6452 MemberDefMutable *mdDef = toMemberDefMutable(src->memberDefinition());
6453 MemberDefMutable *mdDecl = toMemberDefMutable(src->memberDeclaration());
6454
6455 // ---- critical section
6456 std::lock_guard<std::mutex> lock(g_docCrossReferenceMutex);
6457 src->addSourceReferences(dst,sourceRefName);
6458 if (mdDef)
6459 {
6460 mdDef->addSourceReferences(dst,sourceRefName);
6461 }
6462 if (mdDecl)
6463 {
6464 mdDecl->addSourceReferences(dst,sourceRefName);
6465 }
6466 // ---- end critical section
6467 }
6468}
6469
6470// --- Cast functions
6471//
6472MemberDef *toMemberDef(Definition *d)
6473{
6474 if (d && (typeid(*d)==typeid(MemberDefImpl) || typeid(*d)==typeid(MemberDefAliasImpl)))
6475 {
6476 return static_cast<MemberDef*>(d);
6477 }
6478 else
6479 {
6480 return nullptr;
6481 }
6482}
6483
6484MemberDef *toMemberDef(DefinitionMutable *md)
6485{
6486 Definition *d = toDefinition(md);
6487 if (d && typeid(*d)==typeid(MemberDefImpl))
6488 {
6489 return static_cast<MemberDef*>(d);
6490 }
6491 else
6492 {
6493 return nullptr;
6494 }
6495}
6496
6497const MemberDef *toMemberDef(const Definition *d)
6498{
6499 if (d && (typeid(*d)==typeid(MemberDefImpl) || typeid(*d)==typeid(MemberDefAliasImpl)))
6500 {
6501 return static_cast<const MemberDef*>(d);
6502 }
6503 else
6504 {
6505 return nullptr;
6506 }
6507}
6508
6509MemberDefMutable *toMemberDefMutable(Definition *d)
6510{
6511 if (d && typeid(*d)==typeid(MemberDefImpl))
6512 {
6513 return static_cast<MemberDefMutable*>(d);
6514 }
6515 else
6516 {
6517 return nullptr;
6518 }
6519}
6520
6521
prefix
constexpr auto prefix
Definition anchor.cpp:44
Argument
This class contains the information about the argument of a function or template.
Definition arguments.h:27
Argument::docs
DString docs
Definition arguments.h:48
Argument::attrib
DString attrib
Definition arguments.h:42
Argument::defval
DString defval
Definition arguments.h:47
Argument::array
DString array
Definition arguments.h:46
Argument::name
DString name
Definition arguments.h:45
Argument::type
DString type
Definition arguments.h:43
ArgumentList
This class represents an function or template argument list.
Definition arguments.h:66
ArgumentList::refQualifier
RefQualifierType refQualifier() const
Definition arguments.h:117
ArgumentList::end
iterator end()
Definition arguments.h:95
ArgumentList::hasParameters
bool hasParameters() const
Definition arguments.h:77
ArgumentList::front
Argument & front()
Definition arguments.h:106
ArgumentList::trailingReturnType
DString trailingReturnType() const
Definition arguments.h:115
ArgumentList::isDeleted
bool isDeleted() const
Definition arguments.h:116
ArgumentList::size
size_t size() const
Definition arguments.h:101
ArgumentList::constSpecifier
bool constSpecifier() const
Definition arguments.h:112
ArgumentList::hasDocumentation
bool hasDocumentation(bool allowEmptyNames=false) const
Definition arguments.cpp:22
ArgumentList::empty
bool empty() const
Definition arguments.h:100
ArgumentList::hasTemplateDocumentation
bool hasTemplateDocumentation() const
Definition arguments.cpp:30
ArgumentList::begin
iterator begin()
Definition arguments.h:94
ArgumentList::volatileSpecifier
bool volatileSpecifier() const
Definition arguments.h:113
ClassDef
A abstract class representing of a compound symbol.
Definition classdef.h:100
ClassDef::isBaseClass
virtual int isBaseClass(const ClassDef *bcd, bool followInstances, const DString &templSpec=DString()) const =0
Returns true iff bcd is a direct or indirect base class of this class.
ClassDef::getTemplateParameterLists
virtual ArgumentLists getTemplateParameterLists() const =0
Returns the template parameter lists that form the template declaration of this class.
ClassDef::isObjectiveC
virtual bool isObjectiveC() const =0
Returns true if this class is implemented in Objective-C.
ClassDef::isSimple
virtual bool isSimple() const =0
ClassDef::compoundTypeString
virtual DString compoundTypeString() const =0
Returns the type of compound as a string.
ClassDef::categoryOf
virtual ClassDef * categoryOf() const =0
Returns the class of which this is a category (Objective-C only).
ClassDef::Interface
@ Interface
Definition classdef.h:108
ClassDef::compoundType
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e. class/struct/union/...
DString
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:88
DString::clear
void clear()
Definition dstring.h:218
DString::rfind
size_t rfind(char c, size_t pos=npos) const
Definition dstring.h:248
DString::mid
DString mid(size_t index, size_t len=npos) const
Definition dstring.h:322
DString::lower
DString lower() const
Definition dstring.h:330
DString::simplifyWhiteSpace
DString simplifyWhiteSpace() const
return a copy of this string with leading and trailing whitespace removed and multiple internal white...
Definition dstring.cpp:123
DString::empty
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:152
DString::view
std::string_view view() const
Definition dstring.h:166
DString::remove
DString & remove(size_t index, size_t len)
Definition dstring.h:539
DString::npos
static constexpr size_t npos
value used to indicate 'not found' or 'to the end of the string', matching std::string::npos
Definition dstring.h:182
DString::at
char & at(size_t i)
Returns a reference to the character at index i.
Definition dstring.h:690
DString::append
DString & append(char c)
Definition dstring.h:493
DString::right
DString right(size_t len) const
Definition dstring.h:315
DString::prepend
DString & prepend(const char *s)
Definition dstring.h:519
DString::contains
int contains(char c, bool cs=true) const
Definition dstring.cpp:81
DString::find
size_t find(char c, size_t pos=0) const
Definition dstring.h:243
DString::stripWhiteSpace
DString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition dstring.h:341
DString::left
DString left(size_t len) const
Definition dstring.h:310
DString::str
const std::string & str() const
Definition dstring.h:649
DString::stripPrefix
bool stripPrefix(const DString &prefix)
Definition dstring.h:294
DString::startsWith
bool startsWith(const char *s) const
Definition dstring.h:604
DString::endsWith
bool endsWith(const char *s) const
Definition dstring.h:621
DString::length
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition dstring.h:155
DefinitionAliasMixin< MemberDef >::getAlias
const Definition * getAlias() const
Definition definitionimpl.h:451
DefinitionAliasMixin< MemberDef >::getScope
const Definition * getScope() const
Definition definitionimpl.h:452
DefinitionAliasMixin< MemberDef >::DefinitionAliasMixin
DefinitionAliasMixin(const Definition *scope, const Definition *alias)
Definition definitionimpl.h:335
Definition
The common base class of all entity definitions found in the sources.
Definition definition.h:77
Definition::briefDescription
virtual DString briefDescription(bool abbreviate=false) const =0
Definition::inbodyFile
virtual DString inbodyFile() const =0
Definition::getEndBodyLine
virtual int getEndBodyLine() const =0
Definition::briefFile
virtual DString briefFile() const =0
Definition::getLanguage
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
Definition::docLine
virtual int docLine() const =0
Definition::getDefFileName
virtual DString getDefFileName() const =0
Definition::documentation
virtual DString documentation() const =0
Definition::isLinkable
virtual bool isLinkable() const =0
Definition::inbodyDocumentation
virtual DString inbodyDocumentation() const =0
Definition::getDefLine
virtual int getDefLine() const =0
Definition::definitionType
virtual DefType definitionType() const =0
Definition::name
virtual const DString & name() const =0
Definition::localName
virtual const DString & localName() const =0
Definition::inbodyLine
virtual int inbodyLine() const =0
Definition::getBodyDef
virtual const FileDef * getBodyDef() const =0
Definition::briefLine
virtual int briefLine() const =0
Definition::hasDocumentation
virtual bool hasDocumentation() const =0
Definition::isLinkableInProject
virtual bool isLinkableInProject() const =0
Definition::hasUserDocumentation
virtual bool hasUserDocumentation() const =0
Definition::isAnonymous
virtual bool isAnonymous() const =0
Definition::displayName
virtual DString displayName(bool includeScope=true) const =0
Definition::qualifiedName
virtual DString qualifiedName() const =0
Definition::anchor
virtual DString anchor() const =0
Definition::getReference
virtual DString getReference() const =0
Definition::codeSymbolType
virtual CodeSymbolType codeSymbolType() const =0
Definition::getOuterScope
virtual Definition * getOuterScope() const =0
Definition::docFile
virtual DString docFile() const =0
Definition::getStartBodyLine
virtual int getStartBodyLine() const =0
Definition::isReference
virtual bool isReference() const =0
Definition::getOutputFileBase
virtual DString getOutputFileBase() const =0
DefinitionMixin::isReference
bool isReference() const override
Definition definitionimpl.h:196
DefinitionMixin< MemberDefMutable >::docFile
DString docFile() const override
Definition definitionimpl.h:176
DefinitionMixin< MemberDefMutable >::writeSourceDef
void writeSourceDef(OutputList &ol) const override
Definition definitionimpl.h:262
DefinitionMixin::hasUserDocumentation
bool hasUserDocumentation() const override
Definition definitionimpl.h:189
DefinitionMixin::qualifiedName
DString qualifiedName() const override
Definition definitionimpl.h:170
DefinitionMixin< MemberDefMutable >::hasBriefDescription
bool hasBriefDescription() const override
Definition definitionimpl.h:213
DefinitionMixin< MemberDefMutable >::setDefFile
void setDefFile(const DString &df, int defLine, size_t defColumn) override
Definition definitionimpl.h:220
DefinitionMixin< MemberDefMutable >::briefFile
DString briefFile() const override
Definition definitionimpl.h:183
DefinitionMixin< MemberDefMutable >::hasRequirementRefs
bool hasRequirementRefs() const override
Definition definitionimpl.h:274
DefinitionMixin::briefDescription
DString briefDescription(bool abbreviate=false) const override
Definition definitionimpl.h:177
DefinitionMixin< MemberDefMutable >::name
const DString & name() const override
Definition definitionimpl.h:167
DefinitionMixin< MemberDefMutable >::inbodyFile
DString inbodyFile() const override
Definition definitionimpl.h:181
DefinitionMixin< MemberDefMutable >::setOuterScope
void setOuterScope(Definition *def) override
Definition definitionimpl.h:252
DefinitionMixin::getReference
DString getReference() const override
Definition definitionimpl.h:195
DefinitionMixin< MemberDefMutable >::writeRequirementRefs
void writeRequirementRefs(OutputList &ol) const override
Definition definitionimpl.h:276
DefinitionMixin::setInbodyDocumentation
void setInbodyDocumentation(const DString &doc, const DString &docFile, int docLine) override
Definition definitionimpl.h:226
DefinitionMixin< MemberDefMutable >::xrefListItems
const RefItemVector & xrefListItems() const override
Definition definitionimpl.h:205
DefinitionMixin< MemberDefMutable >::hasSourceReffedBy
bool hasSourceReffedBy() const override
Definition definitionimpl.h:268
DefinitionMixin< MemberDefMutable >::getDefColumn
size_t getDefColumn() const override
Definition definitionimpl.h:187
DefinitionMixin< MemberDefMutable >::getOuterScope
Definition * getOuterScope() const override
Definition definitionimpl.h:208
DefinitionMixin::setBriefDescription
void setBriefDescription(const DString &brief, const DString &briefFile, int briefLine) override
Definition definitionimpl.h:224
DefinitionMixin::setDocumentation
void setDocumentation(const DString &doc, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
Definition definitionimpl.h:222
DefinitionMixin< MemberDefMutable >::localName
const DString & localName() const override
Definition definitionimpl.h:169
DefinitionMixin< MemberDefMutable >::setReference
void setReference(const DString &r) override
Definition definitionimpl.h:228
DefinitionMixin< MemberDefMutable >::getDefFileExtension
DString getDefFileExtension() const override
Definition definitionimpl.h:185
DefinitionMixin< MemberDefMutable >::getDefFileName
DString getDefFileName() const override
Definition definitionimpl.h:184
DefinitionMixin::documentation
DString documentation() const override
Definition definitionimpl.h:174
DefinitionMixin< MemberDefMutable >::DefinitionMixin
DefinitionMixin(const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
Definition definitionimpl.h:154
DefinitionMixin< MemberDefMutable >::getBodyDef
const FileDef * getBodyDef() const override
Definition definitionimpl.h:201
DefinitionMixin< MemberDefMutable >::inbodyDocumentation
DString inbodyDocumentation() const override
Definition definitionimpl.h:180
DefinitionMixin< MemberDefMutable >::writeSourceReffedBy
void writeSourceReffedBy(OutputList &ol, const DString &scopeName) const override
Definition definitionimpl.h:272
DefinitionMixin< MemberDefMutable >::writeInlineCode
void writeInlineCode(OutputList &ol, const DString &scopeName) const override
Definition definitionimpl.h:264
DefinitionMixin::setHidden
void setHidden(bool b) override
Definition definitionimpl.h:254
DefinitionMixin< MemberDefMutable >::getSourceFileBase
DString getSourceFileBase() const override
Definition definitionimpl.h:172
DefinitionMixin< MemberDefMutable >::writeDocAnchorsToTagFile
void writeDocAnchorsToTagFile(TextStream &fs) const override
Definition definitionimpl.h:292
DefinitionMixin::hasDocumentation
bool hasDocumentation() const override
Definition definitionimpl.h:188
DefinitionMixin< MemberDefMutable >::writeSourceRefs
void writeSourceRefs(OutputList &ol, const DString &scopeName) const override
Definition definitionimpl.h:270
DefinitionMixin< MemberDefMutable >::getLanguage
SrcLangExt getLanguage() const override
Definition definitionimpl.h:202
DefinitionMutable::setBodySegment
virtual void setBodySegment(int defLine, int bls, int ble)=0
DefinitionMutable::setInbodyDocumentation
virtual void setInbodyDocumentation(const DString &d, const DString &docFile, int docLine)=0
DefinitionMutable::setDocumentation
virtual void setDocumentation(const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true)=0
DefinitionMutable::addSourceReferences
virtual void addSourceReferences(MemberDef *d, const DString &sourceRefName)=0
DefinitionMutable::addSourceReferencedBy
virtual void addSourceReferencedBy(MemberDef *d, const DString &sourceRefName)=0
DefinitionMutable::setBriefDescription
virtual void setBriefDescription(const DString &b, const DString &briefFile, int briefLine)=0
DefinitionMutable::mergeRefItems
virtual void mergeRefItems(Definition *d)=0
DefinitionMutable::setBodyDef
virtual void setBodyDef(const FileDef *fd)=0
DotCallGraph
Representation of an call graph.
Definition dotcallgraph.h:29
DotCallGraph::numNodes
int numNodes() const
Definition dotcallgraph.cpp:207
DotCallGraph::isTooBig
bool isTooBig() const
Definition dotcallgraph.cpp:202
DotCallGraph::isTrivial
bool isTrivial() const
Definition dotcallgraph.cpp:197
Doxygen::suppressDocWarnings
static bool suppressDocWarnings
Definition doxygen.h:123
Doxygen::parseSourcesNeeded
static bool parseSourcesNeeded
Definition doxygen.h:116
Doxygen::parserManager
static ParserManager * parserManager
Definition doxygen.h:122
Doxygen::globalScope
static NamespaceDefMutable * globalScope
Definition doxygen.h:114
ExampleList::inSort
bool inSort(const Example &ex)
Definition example.h:39
FileDef
A model of a file symbol.
Definition filedef.h:97
FileDef::absFilePath
virtual DString absFilePath() const =0
GroupDef
A model of a group of symbols.
Definition groupdef.h:48
MemberDefAliasImpl::hasEnumValues
bool hasEnumValues() const override
Definition memberdef.cpp:878
MemberDefAliasImpl::isConstEval
bool isConstEval() const override
Definition memberdef.cpp:790
MemberDefAliasImpl::getCachedTypedefVal
const ClassDef * getCachedTypedefVal() const override
Definition memberdef.cpp:890
MemberDefAliasImpl::getNamespaceDef
NamespaceDef * getNamespaceDef() override
Definition memberdef.cpp:601
MemberDefAliasImpl::writeDeclaration
void writeDeclaration(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool inGroup, int indentLevel, const ClassDef *inheritFrom=nullptr, const DString &inheritId=DString()) const override
Definition memberdef.cpp:945
MemberDefAliasImpl::getNamespaceDef
const NamespaceDef * getNamespaceDef() const override
Definition memberdef.cpp:599
MemberDefAliasImpl::hasExamples
bool hasExamples() const override
Definition memberdef.cpp:844
MemberDefAliasImpl::getGroupFileName
DString getGroupFileName() const override
Definition memberdef.cpp:614
MemberDefAliasImpl::getGroupDef
GroupDef * getGroupDef() override
Definition memberdef.cpp:610
MemberDefAliasImpl::isSettable
bool isSettable() const override
Definition memberdef.cpp:682
MemberDefAliasImpl::isConstrained
bool isConstrained() const override
Definition memberdef.cpp:750
MemberDefAliasImpl::getGroupHasDocs
bool getGroupHasDocs() const override
Definition memberdef.cpp:618
MemberDefAliasImpl::getClassDef
const ClassDef * getClassDef() const override
Definition memberdef.cpp:586
MemberDefAliasImpl::inheritsDocsFrom
const MemberDef * inheritsDocsFrom() const override
Definition memberdef.cpp:900
MemberDefAliasImpl::hasCallerGraph
bool hasCallerGraph() const override
Definition memberdef.cpp:866
MemberDefAliasImpl::isConstInit
bool isConstInit() const override
Definition memberdef.cpp:792
MemberDefAliasImpl::isFinal
bool isFinal() const override
Definition memberdef.cpp:698
MemberDefAliasImpl::writeLink
void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool onlyText=false) const override
Definition memberdef.cpp:956
MemberDefAliasImpl::reimplements
const MemberDef * reimplements() const override
Definition memberdef.cpp:824
MemberDefAliasImpl::argsString
DString argsString() const override
Definition memberdef.cpp:565
MemberDefAliasImpl::initializer
const DString & initializer() const override
Definition memberdef.cpp:573
MemberDefAliasImpl::isOptional
bool isOptional() const override
Definition memberdef.cpp:706
MemberDefAliasImpl::getClassDefOfAnonymousType
const ClassDef * getClassDefOfAnonymousType() const override
Definition memberdef.cpp:886
MemberDefAliasImpl::isTypeAlias
bool isTypeAlias() const override
Definition memberdef.cpp:734
MemberDefAliasImpl::isRequired
bool isRequired() const override
Definition memberdef.cpp:708
MemberDefAliasImpl::isRemovable
bool isRemovable() const override
Definition memberdef.cpp:694
MemberDefAliasImpl::setMemberGroup
void setMemberGroup(MemberGroup *grp) override
Definition memberdef.cpp:940
MemberDefAliasImpl::isDeleted
bool isDeleted() const override
Definition memberdef.cpp:812
MemberDefAliasImpl::isPrivateGettable
bool isPrivateGettable() const override
Definition memberdef.cpp:678
MemberDefAliasImpl::isSignal
bool isSignal() const override
Definition memberdef.cpp:632
MemberDefAliasImpl::memberDeclaration
MemberDef * memberDeclaration() const override
Definition memberdef.cpp:898
MemberDefAliasImpl::getDeclColumn
size_t getDeclColumn() const override
Definition memberdef.cpp:928
MemberDefAliasImpl::isFriendClass
bool isFriendClass() const override
Definition memberdef.cpp:820
MemberDefAliasImpl::getGroupAlias
const MemberDef * getGroupAlias() const override
Definition memberdef.cpp:902
MemberDefAliasImpl::isStrongEnumValue
bool isStrongEnumValue() const override
Definition memberdef.cpp:780
MemberDefAliasImpl::isAssign
bool isAssign() const override
Definition memberdef.cpp:714
MemberDefAliasImpl::typeString
DString typeString() const override
Definition memberdef.cpp:563
MemberDefAliasImpl::getGroupStartLine
int getGroupStartLine() const override
Definition memberdef.cpp:616
MemberDefAliasImpl::deepCopy
std::unique_ptr< MemberDef > deepCopy() const override
Definition memberdef.cpp:544
MemberDefAliasImpl::isUNOProperty
bool isUNOProperty() const override
Definition memberdef.cpp:744
MemberDefAliasImpl::warnIfUndocumented
void warnIfUndocumented() const override
Definition memberdef.cpp:937
MemberDefAliasImpl::hasUserDocumentation
bool hasUserDocumentation() const override
Definition memberdef.cpp:810
MemberDefAliasImpl::getOutputFileBase
DString getOutputFileBase() const override
Definition memberdef.cpp:553
MemberDefAliasImpl::isSliceLocal
bool isSliceLocal() const override
Definition memberdef.cpp:784
MemberDefAliasImpl::definitionTemplateParameterLists
const ArgumentLists & definitionTemplateParameterLists() const override
Definition memberdef.cpp:856
MemberDefAliasImpl::isPublished
bool isPublished() const override
Definition memberdef.cpp:760
MemberDefAliasImpl::isSequence
bool isSequence() const override
Definition memberdef.cpp:644
MemberDefAliasImpl::isDictionary
bool isDictionary() const override
Definition memberdef.cpp:646
MemberDefAliasImpl::isVariable
bool isVariable() const override
Definition memberdef.cpp:636
MemberDefAliasImpl::getFileDef
FileDef * getFileDef() override
Definition memberdef.cpp:593
MemberDefAliasImpl::templateMaster
const MemberDef * templateMaster() const override
Definition memberdef.cpp:882
MemberDefAliasImpl::warnIfUndocumentedParams
void warnIfUndocumentedParams() const override
Definition memberdef.cpp:938
MemberDefAliasImpl::isExternal
bool isExternal() const override
Definition memberdef.cpp:732
MemberDefAliasImpl::excpString
DString excpString() const override
Definition memberdef.cpp:567
MemberDefAliasImpl::isProperty
bool isProperty() const override
Definition memberdef.cpp:658
MemberDefAliasImpl::isWritable
bool isWritable() const override
Definition memberdef.cpp:690
MemberDefAliasImpl::isDocumentedFriendClass
bool isDocumentedFriendClass() const override
Definition memberdef.cpp:822
MemberDefAliasImpl::redefineCount
int redefineCount() const override
Definition memberdef.cpp:934
MemberDefAliasImpl::isConstExpr
bool isConstExpr() const override
Definition memberdef.cpp:788
MemberDefAliasImpl::initializerLines
int initializerLines() const override
Definition memberdef.cpp:575
MemberDefAliasImpl::isMaybeVoid
bool isMaybeVoid() const override
Definition memberdef.cpp:754
MemberDefAliasImpl::getMemberGroupId
int getMemberGroupId() const override
Definition memberdef.cpp:860
MemberDefAliasImpl::objCMethodName
DString objCMethodName(bool localLink, bool showStatic) const override
Definition memberdef.cpp:622
MemberDefAliasImpl::isInitonly
bool isInitonly() const override
Definition memberdef.cpp:704
MemberDefAliasImpl::getExamples
const ExampleList & getExamples() const override
Definition memberdef.cpp:846
MemberDefAliasImpl::hasOneLineInitializer
bool hasOneLineInitializer() const override
Definition memberdef.cpp:774
MemberDefAliasImpl::isProtectedGettable
bool isProtectedGettable() const override
Definition memberdef.cpp:680
MemberDefAliasImpl::hasDocumentation
bool hasDocumentation() const override
Definition memberdef.cpp:808
MemberDefAliasImpl::livesInsideEnum
bool livesInsideEnum() const override
Definition memberdef.cpp:782
MemberDefAliasImpl::hasCallGraph
bool hasCallGraph() const override
Definition memberdef.cpp:864
MemberDefAliasImpl::isCopy
bool isCopy() const override
Definition memberdef.cpp:712
MemberDefAliasImpl::displayDefinition
DString displayDefinition() const override
Definition memberdef.cpp:583
MemberDefAliasImpl::getWriteAccessor
DString getWriteAccessor() const override
Definition memberdef.cpp:606
MemberDefAliasImpl::getDeclLine
int getDeclLine() const override
Definition memberdef.cpp:926
MemberDefAliasImpl::isEnumerate
bool isEnumerate() const override
Definition memberdef.cpp:638
MemberDefAliasImpl::getReference
DString getReference() const override
Definition memberdef.cpp:555
MemberDefAliasImpl::isReference
bool isReference() const override
Definition memberdef.cpp:922
MemberDefAliasImpl::getMemberSpecifiers
TypeSpecifier getMemberSpecifiers() const override
Definition memberdef.cpp:577
MemberDefAliasImpl::isThreadLocal
bool isThreadLocal() const override
Definition memberdef.cpp:674
MemberDefAliasImpl::hasMultiLineInitializer
bool hasMultiLineInitializer() const override
Definition memberdef.cpp:776
MemberDefAliasImpl::isDocsForDefinition
bool isDocsForDefinition() const override
Definition memberdef.cpp:836
MemberDefAliasImpl::getGroupPri
Grouping::GroupPri_t getGroupPri() const override
Definition memberdef.cpp:612
MemberDefAliasImpl::isTypedefValCached
bool isTypedefValCached() const override
Definition memberdef.cpp:888
MemberDefAliasImpl::isRaisable
bool isRaisable() const override
Definition memberdef.cpp:696
MemberDefAliasImpl::isUnretained
bool isUnretained() const override
Definition memberdef.cpp:724
MemberDefAliasImpl::isGettable
bool isGettable() const override
Definition memberdef.cpp:676
MemberDefAliasImpl::enumFieldList
const MemberVector & enumFieldList() const override
Definition memberdef.cpp:840
MemberDefAliasImpl::anchor
DString anchor() const override
Definition memberdef.cpp:557
MemberDefAliasImpl::isObjCProperty
bool isObjCProperty() const override
Definition memberdef.cpp:766
MemberDefAliasImpl::qualifiedName
DString qualifiedName() const override
Definition memberdef.cpp:620
MemberDefAliasImpl::declArgumentList
const ArgumentList & declArgumentList() const override
Definition memberdef.cpp:852
MemberDefAliasImpl::briefDescription
DString briefDescription(bool) const override
Definition memberdef.cpp:918
MemberDefAliasImpl::isCallable
bool isCallable() const override
Definition memberdef.cpp:778
MemberDefAliasImpl::isDefine
bool isDefine() const override
Definition memberdef.cpp:652
MemberDefAliasImpl::isLinkableInProject
bool isLinkableInProject() const override
Definition memberdef.cpp:804
MemberDefAliasImpl::hasDetailedDescription
bool hasDetailedDescription() const override
Definition memberdef.cpp:818
MemberDefAliasImpl::isFriendToHide
bool isFriendToHide() const override
Definition memberdef.cpp:796
MemberDefAliasImpl::getCachedTypedefTemplSpec
DString getCachedTypedefTemplSpec() const override
Definition memberdef.cpp:892
MemberDefAliasImpl::getGroupDef
const GroupDef * getGroupDef() const override
Definition memberdef.cpp:608
MemberDefAliasImpl::isDestructor
bool isDestructor() const override
Definition memberdef.cpp:772
MemberDefAliasImpl::isNoDiscard
bool isNoDiscard() const override
Definition memberdef.cpp:786
MemberDefAliasImpl::hasDocumentedEnumValues
bool hasDocumentedEnumValues() const override
Definition memberdef.cpp:832
MemberDefAliasImpl::isBound
bool isBound() const override
Definition memberdef.cpp:748
MemberDefAliasImpl::detectUndocumentedParams
void detectUndocumentedParams(bool, bool) const override
Definition memberdef.cpp:939
MemberDefAliasImpl::requiresClause
DString requiresClause() const override
Definition memberdef.cpp:930
MemberDefAliasImpl::isFunctionPtr
bool isFunctionPtr() const override
Definition memberdef.cpp:650
MemberDefAliasImpl::getLabels
StringVector getLabels(const Definition *container) const override
Definition memberdef.cpp:912
MemberDefAliasImpl::createTemplateInstanceMember
std::unique_ptr< MemberDef > createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const override
Definition memberdef.cpp:941
MemberDefAliasImpl::isAddable
bool isAddable() const override
Definition memberdef.cpp:692
MemberDefAliasImpl::argumentList
const ArgumentList & argumentList() const override
Definition memberdef.cpp:850
MemberDefAliasImpl::typeConstraints
const ArgumentList & typeConstraints() const override
Definition memberdef.cpp:914
MemberDefAliasImpl::virtualness
Specifier virtualness(int) const override
Definition memberdef.cpp:626
MemberDefAliasImpl::isFunctionOrSignalSlot
bool isFunctionOrSignalSlot() const override
Definition memberdef.cpp:800
MemberDefAliasImpl::isDefault
bool isDefault() const override
Definition memberdef.cpp:736
MemberDefAliasImpl::isPrototype
bool isPrototype() const override
Definition memberdef.cpp:848
MemberDefAliasImpl::isAttribute
bool isAttribute() const override
Definition memberdef.cpp:742
MemberDefAliasImpl::memberDefinition
MemberDef * memberDefinition() const override
Definition memberdef.cpp:896
MemberDefAliasImpl::isTypedef
bool isTypedef() const override
Definition memberdef.cpp:642
MemberDefAliasImpl::isNoExcept
bool isNoExcept() const override
Definition memberdef.cpp:740
MemberDefAliasImpl::isInline
bool isInline() const override
Definition memberdef.cpp:668
MemberDefAliasImpl::isRelatedOrFriend
bool isRelatedOrFriend() const override
Definition memberdef.cpp:802
MemberDefAliasImpl::hasReferencesRelation
bool hasReferencesRelation() const override
Definition memberdef.cpp:868
MemberDefAliasImpl::isStrong
bool isStrong() const override
Definition memberdef.cpp:720
MemberDefAliasImpl::getMdAlias
const MemberDef * getMdAlias() const
Definition memberdef.cpp:539
MemberDefAliasImpl::isObjCMethod
bool isObjCMethod() const override
Definition memberdef.cpp:764
MemberDefAliasImpl::name
const DString & name() const override
Definition memberdef.cpp:549
MemberDefAliasImpl::isAbstract
bool isAbstract() const override
Definition memberdef.cpp:700
MemberDefAliasImpl::extraTypeChars
DString extraTypeChars() const override
Definition memberdef.cpp:571
MemberDefAliasImpl::isStatic
bool isStatic() const override
Definition memberdef.cpp:666
MemberDefAliasImpl::isPrivateSettable
bool isPrivateSettable() const override
Definition memberdef.cpp:684
MemberDefAliasImpl::isSealed
bool isSealed() const override
Definition memberdef.cpp:728
MemberDefAliasImpl::isRelated
bool isRelated() const override
Definition memberdef.cpp:662
MemberDefAliasImpl::getMdAlias
MemberDef * getMdAlias()
Definition memberdef.cpp:540
MemberDefAliasImpl::memberTypeName
DString memberTypeName() const override
Definition memberdef.cpp:630
MemberDefAliasImpl::isOverride
bool isOverride() const override
Definition memberdef.cpp:702
MemberDefAliasImpl::isForeign
bool isForeign() const override
Definition memberdef.cpp:664
MemberDefAliasImpl::isImplementation
bool isImplementation() const override
Definition memberdef.cpp:730
MemberDefAliasImpl::reimplementedBy
const MemberVector & reimplementedBy() const override
Definition memberdef.cpp:826
MemberDefAliasImpl::getVhdlSpecifiers
VhdlSpecifier getVhdlSpecifiers() const override
Definition memberdef.cpp:579
MemberDefAliasImpl::isMaybeDefault
bool isMaybeDefault() const override
Definition memberdef.cpp:756
MemberDefAliasImpl::memberType
MemberType memberType() const override
Definition memberdef.cpp:628
MemberDefAliasImpl::isLinkable
bool isLinkable() const override
Definition memberdef.cpp:806
MemberDefAliasImpl::getDeclFileName
DString getDeclFileName() const override
Definition memberdef.cpp:924
MemberDefAliasImpl::isProtectedSettable
bool isProtectedSettable() const override
Definition memberdef.cpp:686
MemberDefAliasImpl::isReadonly
bool isReadonly() const override
Definition memberdef.cpp:746
MemberDefAliasImpl::declaration
DString declaration() const override
Definition memberdef.cpp:559
MemberDefAliasImpl::getCachedResolvedTypedef
DString getCachedResolvedTypedef() const override
Definition memberdef.cpp:894
MemberDefAliasImpl::categoryRelation
const MemberDef * categoryRelation() const override
Definition memberdef.cpp:906
MemberDefAliasImpl::getClassDef
ClassDef * getClassDef() override
Definition memberdef.cpp:588
MemberDefAliasImpl::documentation
DString documentation() const override
Definition memberdef.cpp:916
MemberDefAliasImpl::MemberDefAliasImpl
MemberDefAliasImpl(const Definition *newScope, const MemberDef *md)
Definition memberdef.cpp:532
MemberDefAliasImpl::getEnumScope
const MemberDef * getEnumScope() const override
Definition memberdef.cpp:838
MemberDefAliasImpl::getReadAccessor
DString getReadAccessor() const override
Definition memberdef.cpp:604
MemberDefAliasImpl::protection
Protection protection() const override
Definition memberdef.cpp:624
MemberDefAliasImpl::isSlot
bool isSlot() const override
Definition memberdef.cpp:634
MemberDefAliasImpl::displayName
DString displayName(bool b=true) const override
Definition memberdef.cpp:908
MemberDefAliasImpl::isDelete
bool isDelete() const override
Definition memberdef.cpp:738
MemberDefAliasImpl::isReadable
bool isReadable() const override
Definition memberdef.cpp:688
MemberDefAliasImpl::isEvent
bool isEvent() const override
Definition memberdef.cpp:660
MemberDefAliasImpl::isNonAtomic
bool isNonAtomic() const override
Definition memberdef.cpp:710
MemberDefAliasImpl::definitionType
DefType definitionType() const override
Definition memberdef.cpp:537
MemberDefAliasImpl::getScopeString
DString getScopeString() const override
Definition memberdef.cpp:884
MemberDefAliasImpl::isReimplementedBy
bool isReimplementedBy(const ClassDef *cd) const override
Definition memberdef.cpp:828
MemberDefAliasImpl::isDCOP
bool isDCOP() const override
Definition memberdef.cpp:656
MemberDefAliasImpl::bitfieldString
DString bitfieldString() const override
Definition memberdef.cpp:569
MemberDefAliasImpl::writeEnumDeclaration
void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const override
Definition memberdef.cpp:951
MemberDefAliasImpl::isDocTransferDone
bool isDocTransferDone() const override
Definition memberdef.cpp:874
MemberDefAliasImpl::isDetailedSectionVisible
bool isDetailedSectionVisible(MemberListContainer container) const override
Definition memberdef.cpp:816
MemberDefAliasImpl::isNotFriend
bool isNotFriend() const override
Definition memberdef.cpp:798
MemberDefAliasImpl::getSectionList
const MemberList * getSectionList(const Definition *container) const override
Definition memberdef.cpp:581
MemberDefAliasImpl::isTemplateSpecialization
bool isTemplateSpecialization() const override
Definition memberdef.cpp:762
MemberDefAliasImpl::getModuleDef
const ModuleDef * getModuleDef() const override
Definition memberdef.cpp:596
MemberDefAliasImpl::isExplicit
bool isExplicit() const override
Definition memberdef.cpp:670
MemberDefAliasImpl::enumBaseType
DString enumBaseType() const override
Definition memberdef.cpp:842
MemberDefAliasImpl::codeSymbolType
CodeSymbolType codeSymbolType() const override
Definition memberdef.cpp:551
MemberDefAliasImpl::isConstructor
bool isConstructor() const override
Definition memberdef.cpp:770
MemberDefAliasImpl::isTransient
bool isTransient() const override
Definition memberdef.cpp:752
MemberDefAliasImpl::numberOfFlowKeyWords
int numberOfFlowKeyWords() const override
Definition memberdef.cpp:794
MemberDefAliasImpl::isFriend
bool isFriend() const override
Definition memberdef.cpp:654
MemberDefAliasImpl::isWeak
bool isWeak() const override
Definition memberdef.cpp:718
MemberDefAliasImpl::isMutable
bool isMutable() const override
Definition memberdef.cpp:672
MemberDefAliasImpl::resolveAlias
MemberDef * resolveAlias() override
Definition memberdef.cpp:541
MemberDefAliasImpl::getFileDef
const FileDef * getFileDef() const override
Definition memberdef.cpp:591
MemberDefAliasImpl::formalTemplateArguments
std::optional< ArgumentList > formalTemplateArguments() const override
Definition memberdef.cpp:858
MemberDefAliasImpl::sourceRefName
DString sourceRefName() const override
Definition memberdef.cpp:876
MemberDefAliasImpl::definition
DString definition() const override
Definition memberdef.cpp:561
MemberDefAliasImpl::resolveAlias
const MemberDef * resolveAlias() const override
Definition memberdef.cpp:542
MemberDefAliasImpl::isEnumValue
bool isEnumValue() const override
Definition memberdef.cpp:640
MemberDefAliasImpl::isNew
bool isNew() const override
Definition memberdef.cpp:726
MemberDefAliasImpl::getAnonymousEnumType
const MemberDef * getAnonymousEnumType() const override
Definition memberdef.cpp:834
MemberDefAliasImpl::isMaybeAmbiguous
bool isMaybeAmbiguous() const override
Definition memberdef.cpp:758
MemberDefAliasImpl::hasReferencedByRelation
bool hasReferencedByRelation() const override
Definition memberdef.cpp:870
MemberDefAliasImpl::fieldType
DString fieldType() const override
Definition memberdef.cpp:920
MemberDefAliasImpl::isCSharpProperty
bool isCSharpProperty() const override
Definition memberdef.cpp:768
MemberDefAliasImpl::hasInlineSource
bool hasInlineSource() const override
Definition memberdef.cpp:872
MemberDefAliasImpl::category
ClassDef * category() const override
Definition memberdef.cpp:904
MemberDefAliasImpl::moveTo
void moveTo(Definition *) override
Definition memberdef.cpp:547
MemberDefAliasImpl::getMemberGroup
MemberGroup * getMemberGroup() const override
Definition memberdef.cpp:862
MemberDefAliasImpl::m_memberGroup
MemberGroup * m_memberGroup
Definition memberdef.cpp:963
MemberDefAliasImpl::isFunction
bool isFunction() const override
Definition memberdef.cpp:648
MemberDefAliasImpl::getDeclType
DString getDeclType() const override
Definition memberdef.cpp:910
MemberDefAliasImpl::visibleInIndex
bool visibleInIndex() const override
Definition memberdef.cpp:932
MemberDefAliasImpl::relatedAlso
ClassDef * relatedAlso() const override
Definition memberdef.cpp:830
MemberDefAliasImpl::isRetain
bool isRetain() const override
Definition memberdef.cpp:716
MemberDefAliasImpl::isEnumStruct
bool isEnumStruct() const override
Definition memberdef.cpp:722
MemberDefAliasImpl::isBriefSectionVisible
bool isBriefSectionVisible() const override
Definition memberdef.cpp:814
MemberDefAliasImpl::templateArguments
const ArgumentList & templateArguments() const override
Definition memberdef.cpp:854
MemberDefAliasImpl::~MemberDefAliasImpl
~MemberDefAliasImpl() override
Definition memberdef.cpp:534
MemberDefAliasImpl::getQualifiers
StringVector getQualifiers() const override
Definition memberdef.cpp:880
MemberDef
A model of a class/file/namespace member symbol.
Definition memberdef.h:45
MemberDef::isConstExpr
virtual bool isConstExpr() const =0
MemberDef::getGroupHasDocs
virtual bool getGroupHasDocs() const =0
MemberDef::getAnonymousEnumType
virtual const MemberDef * getAnonymousEnumType() const =0
MemberDef::isConstEval
virtual bool isConstEval() const =0
MemberDef::isInitonly
virtual bool isInitonly() const =0
MemberDef::isSignal
virtual bool isSignal() const =0
MemberDef::isNoExcept
virtual bool isNoExcept() const =0
MemberDef::isDestructor
virtual bool isDestructor() const =0
MemberDef::getDeclType
virtual DString getDeclType() const =0
MemberDef::hasDetailedDescription
virtual bool hasDetailedDescription() const =0
MemberDef::isAssign
virtual bool isAssign() const =0
MemberDef::isExplicit
virtual bool isExplicit() const =0
MemberDef::memberDefinition
virtual MemberDef * memberDefinition() const =0
MemberDef::isNew
virtual bool isNew() const =0
MemberDef::isObjCMethod
virtual bool isObjCMethod() const =0
MemberDef::hasDocumentedEnumValues
virtual bool hasDocumentedEnumValues() const =0
MemberDef::memberDeclaration
virtual MemberDef * memberDeclaration() const =0
MemberDef::requiresClause
virtual DString requiresClause() const =0
MemberDef::isMaybeVoid
virtual bool isMaybeVoid() const =0
MemberDef::isConstructor
virtual bool isConstructor() const =0
MemberDef::isFriend
virtual bool isFriend() const =0
MemberDef::writeEnumDeclaration
virtual void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const =0
MemberDef::argsString
virtual DString argsString() const =0
MemberDef::isForeign
virtual bool isForeign() const =0
MemberDef::isSealed
virtual bool isSealed() const =0
MemberDef::hasExamples
virtual bool hasExamples() const =0
MemberDef::isDelete
virtual bool isDelete() const =0
MemberDef::numberOfFlowKeyWords
virtual int numberOfFlowKeyWords() const =0
MemberDef::inheritsDocsFrom
virtual const MemberDef * inheritsDocsFrom() const =0
MemberDef::isDefault
virtual bool isDefault() const =0
MemberDef::objCMethodName
virtual DString objCMethodName(bool localLink, bool showStatic) const =0
MemberDef::isRelated
virtual bool isRelated() const =0
MemberDef::isDocumentedFriendClass
virtual bool isDocumentedFriendClass() const =0
MemberDef::isConstInit
virtual bool isConstInit() const =0
MemberDef::isDeleted
virtual bool isDeleted() const =0
MemberDef::definition
virtual DString definition() const =0
MemberDef::getCachedTypedefVal
virtual const ClassDef * getCachedTypedefVal() const =0
MemberDef::isRelatedOrFriend
virtual bool isRelatedOrFriend() const =0
MemberDef::writeDeclaration
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=nullptr, const DString &inheritId=DString()) const =0
MemberDef::isSequence
virtual bool isSequence() const =0
MemberDef::isEnumStruct
virtual bool isEnumStruct() const =0
MemberDef::getClassDef
virtual const ClassDef * getClassDef() const =0
MemberDef::visibleInIndex
virtual bool visibleInIndex() const =0
MemberDef::getGroupAlias
virtual const MemberDef * getGroupAlias() const =0
MemberDef::isOverride
virtual bool isOverride() const =0
MemberDef::hasReferencesRelation
virtual bool hasReferencesRelation() const =0
MemberDef::declaration
virtual DString declaration() const =0
MemberDef::excpString
virtual DString excpString() const =0
MemberDef::getCachedResolvedTypedef
virtual DString getCachedResolvedTypedef() const =0
MemberDef::templateArguments
virtual const ArgumentList & templateArguments() const =0
MemberDef::getDeclFileName
virtual DString getDeclFileName() const =0
MemberDef::initializer
virtual const DString & initializer() const =0
MemberDef::getGroupDef
virtual GroupDef * getGroupDef()=0
MemberDef::isSettable
virtual bool isSettable() const =0
MemberDef::isCSharpProperty
virtual bool isCSharpProperty() const =0
MemberDef::isRetain
virtual bool isRetain() const =0
MemberDef::isAddable
virtual bool isAddable() const =0
MemberDef::isTypedef
virtual bool isTypedef() const =0
MemberDef::category
virtual ClassDef * category() const =0
MemberDef::isSlot
virtual bool isSlot() const =0
MemberDef::enumFieldList
virtual const MemberVector & enumFieldList() const =0
MemberDef::hasCallGraph
virtual bool hasCallGraph() const =0
MemberDef::getFileDef
virtual const FileDef * getFileDef() const =0
MemberDef::isInline
virtual bool isInline() const =0
MemberDef::isEvent
virtual bool isEvent() const =0
MemberDef::getReadAccessor
virtual DString getReadAccessor() const =0
MemberDef::argumentList
virtual const ArgumentList & argumentList() const =0
MemberDef::isWritable
virtual bool isWritable() const =0
MemberDef::isMaybeAmbiguous
virtual bool isMaybeAmbiguous() const =0
MemberDef::isPrivateGettable
virtual bool isPrivateGettable() const =0
MemberDef::isStrongEnumValue
virtual bool isStrongEnumValue() const =0
MemberDef::getVhdlSpecifiers
virtual VhdlSpecifier getVhdlSpecifiers() const =0
MemberDef::reimplementedBy
virtual const MemberVector & reimplementedBy() const =0
MemberDef::getGroupStartLine
virtual int getGroupStartLine() const =0
MemberDef::isFunction
virtual bool isFunction() const =0
MemberDef::isRequired
virtual bool isRequired() const =0
MemberDef::isAttribute
virtual bool isAttribute() const =0
MemberDef::isExternal
virtual bool isExternal() const =0
MemberDef::isCopy
virtual bool isCopy() const =0
MemberDef::getMemberGroupId
virtual int getMemberGroupId() const =0
MemberDef::isDictionary
virtual bool isDictionary() const =0
MemberDef::bitfieldString
virtual DString bitfieldString() const =0
MemberDef::getDeclLine
virtual int getDeclLine() const =0
MemberDef::isTypeAlias
virtual bool isTypeAlias() const =0
MemberDef::isStatic
virtual bool isStatic() const =0
MemberDef::reimplements
virtual const MemberDef * reimplements() const =0
MemberDef::isMaybeDefault
virtual bool isMaybeDefault() const =0
MemberDef::livesInsideEnum
virtual bool livesInsideEnum() const =0
MemberDef::hasInlineSource
virtual bool hasInlineSource() const =0
MemberDef::isTemplateSpecialization
virtual bool isTemplateSpecialization() const =0
MemberDef::isPrivateSettable
virtual bool isPrivateSettable() const =0
MemberDef::displayDefinition
virtual DString displayDefinition() const =0
MemberDef::getQualifiers
virtual StringVector getQualifiers() const =0
MemberDef::isRaisable
virtual bool isRaisable() const =0
MemberDef::isRemovable
virtual bool isRemovable() const =0
MemberDef::isTypedefValCached
virtual bool isTypedefValCached() const =0
MemberDef::isConstrained
virtual bool isConstrained() const =0
MemberDef::getWriteAccessor
virtual DString getWriteAccessor() const =0
MemberDef::isDocsForDefinition
virtual bool isDocsForDefinition() const =0
MemberDef::isBound
virtual bool isBound() const =0
MemberDef::hasEnumValues
virtual bool hasEnumValues() const =0
MemberDef::isFriendToHide
virtual bool isFriendToHide() const =0
MemberDef::isReimplementedBy
virtual bool isReimplementedBy(const ClassDef *cd) const =0
MemberDef::isNonAtomic
virtual bool isNonAtomic() const =0
MemberDef::getModuleDef
virtual const ModuleDef * getModuleDef() const =0
MemberDef::isThreadLocal
virtual bool isThreadLocal() const =0
MemberDef::isDefine
virtual bool isDefine() const =0
MemberDef::extraTypeChars
virtual DString extraTypeChars() const =0
MemberDef::getNamespaceDef
virtual const NamespaceDef * getNamespaceDef() const =0
MemberDef::isPublished
virtual bool isPublished() const =0
MemberDef::getScopeString
virtual DString getScopeString() const =0
MemberDef::isFunctionPtr
virtual bool isFunctionPtr() const =0
MemberDef::sourceRefName
virtual DString sourceRefName() const =0
MemberDef::createTemplateInstanceMember
virtual std::unique_ptr< MemberDef > createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const =0
MemberDef::hasCallerGraph
virtual bool hasCallerGraph() const =0
MemberDef::getGroupPri
virtual Grouping::GroupPri_t getGroupPri() const =0
MemberDef::typeConstraints
virtual const ArgumentList & typeConstraints() const =0
MemberDef::getDeclColumn
virtual size_t getDeclColumn() const =0
MemberDef::isProtectedSettable
virtual bool isProtectedSettable() const =0
MemberDef::getClassDefOfAnonymousType
virtual const ClassDef * getClassDefOfAnonymousType() const =0
MemberDef::isImplementation
virtual bool isImplementation() const =0
MemberDef::isProtectedGettable
virtual bool isProtectedGettable() const =0
MemberDef::hasOneLineInitializer
virtual bool hasOneLineInitializer() const =0
MemberDef::templateMaster
virtual const MemberDef * templateMaster() const =0
MemberDef::formalTemplateArguments
virtual std::optional< ArgumentList > formalTemplateArguments() const =0
MemberDef::isObjCProperty
virtual bool isObjCProperty() const =0
MemberDef::isTransient
virtual bool isTransient() const =0
MemberDef::getSectionList
virtual const MemberList * getSectionList(const Definition *container) const =0
MemberDef::hasMultiLineInitializer
virtual bool hasMultiLineInitializer() const =0
MemberDef::protection
virtual Protection protection() const =0
MemberDef::getMemberSpecifiers
virtual TypeSpecifier getMemberSpecifiers() const =0
MemberDef::isOptional
virtual bool isOptional() const =0
MemberDef::getCachedTypedefTemplSpec
virtual DString getCachedTypedefTemplSpec() const =0
MemberDef::isEnumerate
virtual bool isEnumerate() const =0
MemberDef::isGettable
virtual bool isGettable() const =0
MemberDef::memberType
virtual MemberType memberType() const =0
MemberDef::hasReferencedByRelation
virtual bool hasReferencedByRelation() const =0
MemberDef::isFunctionOrSignalSlot
virtual bool isFunctionOrSignalSlot() const =0
MemberDef::fieldType
virtual DString fieldType() const =0
MemberDef::isReadable
virtual bool isReadable() const =0
MemberDef::isWeak
virtual bool isWeak() const =0
MemberDef::isDocTransferDone
virtual bool isDocTransferDone() const =0
MemberDef::isNoDiscard
virtual bool isNoDiscard() const =0
MemberDef::enumBaseType
virtual DString enumBaseType() const =0
MemberDef::isUnretained
virtual bool isUnretained() const =0
MemberDef::relatedAlso
virtual ClassDef * relatedAlso() const =0
MemberDef::isBriefSectionVisible
virtual bool isBriefSectionVisible() const =0
MemberDef::definitionTemplateParameterLists
virtual const ArgumentLists & definitionTemplateParameterLists() const =0
MemberDef::getLabels
virtual StringVector getLabels(const Definition *container) const =0
MemberDef::isVariable
virtual bool isVariable() const =0
MemberDef::isNotFriend
virtual bool isNotFriend() const =0
MemberDef::getGroupFileName
virtual DString getGroupFileName() const =0
MemberDef::isDCOP
virtual bool isDCOP() const =0
MemberDef::isStrong
virtual bool isStrong() const =0
MemberDef::typeString
virtual DString typeString() const =0
MemberDef::isSliceLocal
virtual bool isSliceLocal() const =0
MemberDef::virtualness
virtual Specifier virtualness(int count=0) const =0
MemberDef::isUNOProperty
virtual bool isUNOProperty() const =0
MemberDef::redefineCount
virtual int redefineCount() const =0
MemberDef::categoryRelation
virtual const MemberDef * categoryRelation() const =0
MemberDef::initializerLines
virtual int initializerLines() const =0
MemberDef::isFinal
virtual bool isFinal() const =0
MemberDef::declArgumentList
virtual const ArgumentList & declArgumentList() const =0
MemberDef::getExamples
virtual const ExampleList & getExamples() const =0
MemberDef::isAbstract
virtual bool isAbstract() const =0
MemberDef::memberTypeName
virtual DString memberTypeName() const =0
MemberDef::isMutable
virtual bool isMutable() const =0
MemberDef::isFriendClass
virtual bool isFriendClass() const =0
MemberDef::isCallable
virtual bool isCallable() const =0
MemberDef::isDetailedSectionVisible
virtual bool isDetailedSectionVisible(MemberListContainer container) const =0
MemberDef::getEnumScope
virtual const MemberDef * getEnumScope() const =0
MemberDef::isEnumValue
virtual bool isEnumValue() const =0
MemberDef::isPrototype
virtual bool isPrototype() const =0
MemberDef::writeLink
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
MemberDef::isProperty
virtual bool isProperty() const =0
MemberDefImpl::_hasVisibleCallerGraph
bool _hasVisibleCallerGraph() const
Definition memberdef.cpp:5655
MemberDefImpl::getCachedTypedefTemplSpec
DString getCachedTypedefTemplSpec() const override
Definition memberdef.cpp:5708
MemberDefImpl::_writeCallerGraph
void _writeCallerGraph(OutputList &ol) const
Definition memberdef.cpp:2882
MemberDefImpl::insertReimplementedBy
void insertReimplementedBy(MemberDef *md) override
Definition memberdef.cpp:1590
MemberDefImpl::isDCOP
bool isDCOP() const override
Definition memberdef.cpp:5195
MemberDefImpl::enumBaseType
DString enumBaseType() const override
Definition memberdef.cpp:5995
MemberDefImpl::m_vhdlSpec
VhdlSpecifier m_vhdlSpec
Definition memberdef.cpp:435
MemberDefImpl::isDetailedSectionVisible
bool isDetailedSectionVisible(MemberListContainer container) const override
Definition memberdef.cpp:2705
MemberDefImpl::_isReimplements
bool _isReimplements() const
Definition memberdef.cpp:2904
MemberDefImpl::isFunction
bool isFunction() const override
Definition memberdef.cpp:5174
MemberDefImpl::cacheTypedefVal
void cacheTypedefVal(const ClassDef *val, const DString &templSpec, const DString &resolvedType) override
Definition memberdef.cpp:6010
MemberDefImpl::overrideReferencesRelation
void overrideReferencesRelation(bool e) override
Definition memberdef.cpp:4898
MemberDefImpl::reimplements
const MemberDef * reimplements() const override
Definition memberdef.cpp:1606
MemberDefImpl::m_mtype
MemberType m_mtype
Definition memberdef.cpp:436
MemberDefImpl::getMemberGroupId
int getMemberGroupId() const override
Definition memberdef.cpp:5622
MemberDefImpl::isProperty
bool isProperty() const override
Definition memberdef.cpp:5200
MemberDefImpl::visibleInIndex
bool visibleInIndex() const override
Definition memberdef.cpp:4146
MemberDefImpl::argumentList
const ArgumentList & argumentList() const override
Definition memberdef.cpp:5554
MemberDefImpl::writeDocumentation
void writeDocumentation(const MemberList *ml, int memCount, int memTotal, OutputList &ol, const DString &scopeName, const Definition *container, bool inGroup, bool showEnumValues=false, bool showInline=false) const override
Definition memberdef.cpp:3399
MemberDefImpl::setDocumentedEnumValues
void setDocumentedEnumValues(bool value) override
Definition memberdef.cpp:5881
MemberDefImpl::m_detailedDescriptionCachedValue
bool m_detailedDescriptionCachedValue
Definition memberdef.cpp:494
MemberDefImpl::isTypedefValCached
bool isTypedefValCached() const override
Definition memberdef.cpp:5698
MemberDefImpl::objCMethodName
DString objCMethodName(bool localLink, bool showStatic) const override
Definition memberdef.cpp:4967
MemberDefImpl::isInline
bool isInline() const override
Definition memberdef.cpp:5225
MemberDefImpl::getExamples
const ExampleList & getExamples() const override
Definition memberdef.cpp:5544
MemberDefImpl::m_defTmpArgLists
ArgumentLists m_defTmpArgLists
Definition memberdef.cpp:447
MemberDefImpl::getWriteAccessor
DString getWriteAccessor() const override
Definition memberdef.cpp:5084
MemberDefImpl::isFriendToHide
bool isFriendToHide() const override
Definition memberdef.cpp:6341
MemberDefImpl::invalidateTypedefValCache
void invalidateTypedefValCache() override
Definition memberdef.cpp:5955
MemberDefImpl::isFriendClass
bool isFriendClass() const override
Definition memberdef.cpp:6351
MemberDefImpl::setNamespace
void setNamespace(NamespaceDef *nd) override
Definition memberdef.cpp:4405
MemberDefImpl::setProtection
void setProtection(Protection p) override
Definition memberdef.cpp:5781
MemberDefImpl::getNamespaceDef
const NamespaceDef * getNamespaceDef() const override
Definition memberdef.cpp:5069
MemberDefImpl::writeDeclaration
void writeDeclaration(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool inGroup, int indentLevel, const ClassDef *inheritFrom=nullptr, const DString &inheritId=DString()) const override
Definition memberdef.cpp:2202
MemberDefImpl::setHidden
void setHidden(bool b) override
Definition memberdef.cpp:1908
MemberDefImpl::_writeTypeConstraints
void _writeTypeConstraints(OutputList &ol) const
Definition memberdef.cpp:3118
MemberDefImpl::isSliceLocal
bool isSliceLocal() const override
Definition memberdef.cpp:5514
MemberDefImpl::makeRelated
void makeRelated() override
Definition memberdef.cpp:5847
MemberDefImpl::getGroupStartLine
int getGroupStartLine() const override
Definition memberdef.cpp:5114
MemberDefImpl::warnIfUndocumented
void warnIfUndocumented() const override
Definition memberdef.cpp:4074
MemberDefImpl::m_hasReferencedByRelation
bool m_hasReferencedByRelation
Definition memberdef.cpp:498
MemberDefImpl::setMemberType
void setMemberType(MemberType t) override
Definition memberdef.cpp:5757
MemberDefImpl::typeConstraints
const ArgumentList & typeConstraints() const override
Definition memberdef.cpp:6336
MemberDefImpl::setRequiresClause
void setRequiresClause(const DString &req) override
Definition memberdef.cpp:6000
MemberDefImpl::definitionType
DefType definitionType() const override
Definition memberdef.cpp:64
MemberDefImpl::isDestructor
bool isDestructor() const override
Definition memberdef.cpp:4718
MemberDefImpl::getQualifiers
StringVector getQualifiers() const override
Definition memberdef.cpp:5802
MemberDefImpl::m_virt
Specifier m_virt
Definition memberdef.cpp:419
MemberDefImpl::getDeclFileName
DString getDeclFileName() const override
Definition memberdef.cpp:5739
MemberDefImpl::setRedefineCount
void setRedefineCount(int) override
Definition memberdef.cpp:6409
MemberDefImpl::setAnonymousEnumType
void setAnonymousEnumType(const MemberDef *md) override
Definition memberdef.cpp:5886
MemberDefImpl::isOptional
bool isOptional() const override
Definition memberdef.cpp:5330
MemberDefImpl::_writeExamples
void _writeExamples(OutputList &ol) const
Definition memberdef.cpp:3105
MemberDefImpl::moveTo
void moveTo(Definition *) override
Definition memberdef.cpp:1561
MemberDefImpl::isCallable
bool isCallable() const override
Definition memberdef.cpp:5473
MemberDefImpl::setBriefDescription
void setBriefDescription(const DString &b, const DString &briefFile, int briefLine) override
Definition memberdef.cpp:1886
MemberDefImpl::getScopeString
DString getScopeString() const override
Definition memberdef.cpp:4321
MemberDefImpl::m_docTransferDone
bool m_docTransferDone
Definition memberdef.cpp:432
MemberDefImpl::isBriefSectionVisible
bool isBriefSectionVisible() const override
Definition memberdef.cpp:2014
MemberDefImpl::m_categoryRelation
const MemberDef * m_categoryRelation
Definition memberdef.cpp:509
MemberDefImpl::setCategoryRelation
void setCategoryRelation(const MemberDef *) override
Definition memberdef.cpp:5985
MemberDefImpl::isReference
bool isReference() const override
Definition memberdef.cpp:6374
MemberDefImpl::m_cachedResolvedType
DString m_cachedResolvedType
Definition memberdef.cpp:470
MemberDefImpl::m_prot
Protection m_prot
Definition memberdef.cpp:420
MemberDefImpl::warnIfUndocumentedParams
void warnIfUndocumentedParams() const override
Definition memberdef.cpp:4236
MemberDefImpl::getVhdlSpecifiers
VhdlSpecifier getVhdlSpecifiers() const override
Definition memberdef.cpp:5039
MemberDefImpl::_hasVisibleCallGraph
bool _hasVisibleCallGraph() const
Definition memberdef.cpp:5637
MemberDefImpl::setFormalTemplateArguments
void setFormalTemplateArguments(const ArgumentList &al) override
Definition memberdef.cpp:5940
MemberDefImpl::m_category
ClassDef * m_category
Definition memberdef.cpp:508
MemberDefImpl::extraTypeChars
DString extraTypeChars() const override
Definition memberdef.cpp:4994
MemberDefImpl::setClassDefOfAnonymousType
void setClassDefOfAnonymousType(const ClassDef *cd) override
Definition memberdef.cpp:1998
MemberDefImpl::isDefine
bool isDefine() const override
Definition memberdef.cpp:5185
MemberDefImpl::findSectionsInDocumentation
void findSectionsInDocumentation() override
Definition memberdef.cpp:4873
MemberDefImpl::m_exception
DString m_exception
Definition memberdef.cpp:426
MemberDefImpl::displayDefinition
DString displayDefinition() const override
Definition memberdef.cpp:3230
MemberDefImpl::setFileDef
void setFileDef(FileDef *fd) override
Definition memberdef.cpp:5768
MemberDefImpl::resolveAlias
const MemberDef * resolveAlias() const override
Definition memberdef.cpp:66
MemberDefImpl::m_declArgList
ArgumentList m_declArgList
Definition memberdef.cpp:441
MemberDefImpl::deepCopy
std::unique_ptr< MemberDef > deepCopy() const override
Definition memberdef.cpp:1465
MemberDefImpl::makeForeign
void makeForeign() override
Definition memberdef.cpp:5853
MemberDefImpl::m_memDec
MemberDef * m_memDec
Definition memberdef.cpp:410
MemberDefImpl::m_isConstructorCached
uint8_t m_isConstructorCached
Definition memberdef.cpp:393
MemberDefImpl::hasMultiLineInitializer
bool hasMultiLineInitializer() const override
Definition memberdef.cpp:4465
MemberDefImpl::hasCallGraph
bool hasCallGraph() const override
Definition memberdef.cpp:5632
MemberDefImpl::_writeReimplementedBy
void _writeReimplementedBy(OutputList &ol) const
Definition memberdef.cpp:2993
MemberDefImpl::isNew
bool isNew() const override
Definition memberdef.cpp:5305
MemberDefImpl::setMaxInitLines
void setMaxInitLines(int lines) override
Definition memberdef.cpp:5824
MemberDefImpl::isDocsForDefinition
bool isDocsForDefinition() const override
Definition memberdef.cpp:5499
MemberDefImpl::definition
DString definition() const override
Definition memberdef.cpp:4989
MemberDefImpl::setEnumClassScope
void setEnumClassScope(ClassDef *cd) override
Definition memberdef.cpp:5874
MemberDefImpl::setReadAccessor
void setReadAccessor(const DString &r) override
Definition memberdef.cpp:5832
MemberDefImpl::isUnretained
bool isUnretained() const override
Definition memberdef.cpp:5382
MemberDefImpl::isGettable
bool isGettable() const override
Definition memberdef.cpp:5245
MemberDefImpl::getMemberGroup
MemberGroup * getMemberGroup() const override
Definition memberdef.cpp:5627
MemberDefImpl::hasUserDocumentation
bool hasUserDocumentation() const override
Definition memberdef.cpp:6324
MemberDefImpl::formalTemplateArguments
std::optional< ArgumentList > formalTemplateArguments() const override
Definition memberdef.cpp:5693
MemberDefImpl::m_sectionMap
std::map< const Definition *, const MemberList * > m_sectionMap
Definition memberdef.cpp:456
MemberDefImpl::isEnumValue
bool isEnumValue() const override
Definition memberdef.cpp:5154
MemberDefImpl::isObjCMethod
bool isObjCMethod() const override
Definition memberdef.cpp:4914
MemberDefImpl::memberDefinition
MemberDef * memberDefinition() const override
Definition memberdef.cpp:5719
MemberDefImpl::m_isTypedefValCached
bool m_isTypedefValCached
Definition memberdef.cpp:467
MemberDefImpl::m_hasDocumentedReturnType
bool m_hasDocumentedReturnType
Definition memberdef.cpp:486
MemberDefImpl::anchor
DString anchor() const override
Definition memberdef.cpp:1778
MemberDefImpl::m_qualifiers
StringVector m_qualifiers
Definition memberdef.cpp:480
MemberDefImpl::overrideCallGraph
void overrideCallGraph(bool e) override
Definition memberdef.cpp:4880
MemberDefImpl::setInheritsDocsFrom
void setInheritsDocsFrom(const MemberDef *md) override
Definition memberdef.cpp:5859
MemberDefImpl::addExample
bool addExample(const DString &anchor, const DString &name, const DString &file) override
Definition memberdef.cpp:1640
MemberDefImpl::virtualness
Specifier virtualness(int count=0) const override
Definition memberdef.cpp:4554
MemberDefImpl::getClassDefMutable
ClassDefMutable * getClassDefMutable() override
Definition memberdef.cpp:5054
MemberDefImpl::hasDetailedDescription
bool hasDetailedDescription() const override
Definition memberdef.cpp:2589
MemberDefImpl::setMemberGroupId
void setMemberGroupId(int id) override
Definition memberdef.cpp:5924
MemberDefImpl::getReference
DString getReference() const override
Definition memberdef.cpp:1739
MemberDefImpl::isCSharpProperty
bool isCSharpProperty() const override
Definition memberdef.cpp:4926
MemberDefImpl::m_groupFileName
DString m_groupFileName
Definition memberdef.cpp:463
MemberDefImpl::setSectionList
void setSectionList(const Definition *container, const MemberList *sl) override
Definition memberdef.cpp:4548
MemberDefImpl::isRaisable
bool isRaisable() const override
Definition memberdef.cpp:5285
MemberDefImpl::setTemplateMaster
void setTemplateMaster(const MemberDef *mt) override
Definition memberdef.cpp:5934
MemberDefImpl::m_declColumn
size_t m_declColumn
Definition memberdef.cpp:512
MemberDefImpl::createTemplateInstanceMember
std::unique_ptr< MemberDef > createTemplateInstanceMember(const ArgumentList &formalArgs, const std::unique_ptr< ArgumentList > &actualArgs) const override
Definition memberdef.cpp:4411
MemberDefImpl::m_explicitInherited
bool m_explicitInherited
Definition memberdef.cpp:477
MemberDefImpl::getGroupDef
const GroupDef * getGroupDef() const override
Definition memberdef.cpp:5089
MemberDefImpl::m_enumBaseType
DString m_enumBaseType
Definition memberdef.cpp:429
MemberDefImpl::isRelatedOrFriend
bool isRelatedOrFriend() const override
Definition memberdef.cpp:6369
MemberDefImpl::insertEnumField
void insertEnumField(MemberDef *md) override
Definition memberdef.cpp:1635
MemberDefImpl::isMutable
bool isMutable() const override
Definition memberdef.cpp:5235
MemberDefImpl::isPublished
bool isPublished() const override
Definition memberdef.cpp:5452
MemberDefImpl::isLinkableInProject
bool isLinkableInProject() const override
Definition memberdef.cpp:1914
MemberDefImpl::isProtectedSettable
bool isProtectedSettable() const override
Definition memberdef.cpp:5270
MemberDefImpl::setMemberGroup
void setMemberGroup(MemberGroup *grp) override
Definition memberdef.cpp:4316
MemberDefImpl::setMemberDeclaration
void setMemberDeclaration(MemberDef *md) override
Definition memberdef.cpp:5965
MemberDefImpl::setDeclFile
void setDeclFile(const DString &df, int line, size_t column) override
Definition memberdef.cpp:5917
MemberDefImpl::isUNOProperty
bool isUNOProperty() const override
Definition memberdef.cpp:5412
MemberDefImpl::m_hasDocumentedParams
bool m_hasDocumentedParams
Definition memberdef.cpp:485
MemberDefImpl::m_moduleDef
ModuleDef * m_moduleDef
Definition memberdef.cpp:399
MemberDefImpl::m_hasReferencesRelation
bool m_hasReferencesRelation
Definition memberdef.cpp:499
MemberDefImpl::_computeIsConstructor
void _computeIsConstructor()
Definition memberdef.cpp:4639
MemberDefImpl::_countReimplementedBy
size_t _countReimplementedBy() const
Definition memberdef.cpp:2976
MemberDefImpl::isRequired
bool isRequired() const override
Definition memberdef.cpp:5335
MemberDefImpl::reimplementedBy
const MemberVector & reimplementedBy() const override
Definition memberdef.cpp:1611
MemberDefImpl::isStrong
bool isStrong() const override
Definition memberdef.cpp:5365
MemberDefImpl::m_hasInlineSource
bool m_hasInlineSource
Definition memberdef.cpp:500
MemberDefImpl::moveDeclArgumentList
void moveDeclArgumentList(std::unique_ptr< ArgumentList > al) override
Definition memberdef.cpp:4858
MemberDefImpl::isTypeAlias
bool isTypeAlias() const override
Definition memberdef.cpp:5387
MemberDefImpl::setMemberClass
void setMemberClass(ClassDef *cd) override
Definition memberdef.cpp:4397
MemberDefImpl::templateMaster
const MemberDef * templateMaster() const override
Definition memberdef.cpp:5688
MemberDefImpl::setDocsForDefinition
void setDocsForDefinition(bool b) override
Definition memberdef.cpp:5945
MemberDefImpl::getCachedTypedefVal
const ClassDef * getCachedTypedefVal() const override
Definition memberdef.cpp:5703
MemberDefImpl::initializerLines
int initializerLines() const override
Definition memberdef.cpp:5024
MemberDefImpl::getGroupHasDocs
bool getGroupHasDocs() const override
Definition memberdef.cpp:5119
MemberDefImpl::getEnumScope
const MemberDef * getEnumScope() const override
Definition memberdef.cpp:5504
MemberDefImpl::m_hasCallerGraph
bool m_hasCallerGraph
Definition memberdef.cpp:497
MemberDefImpl::isMaybeDefault
bool isMaybeDefault() const override
Definition memberdef.cpp:5442
MemberDefImpl::m_nspace
NamespaceDef * m_nspace
Definition memberdef.cpp:398
MemberDefImpl::isReimplementedBy
bool isReimplementedBy(const ClassDef *cd) const override
Definition memberdef.cpp:1616
MemberDefImpl::getLabels
StringVector getLabels(const Definition *container) const override
Definition memberdef.cpp:2723
MemberDefImpl::isTransient
bool isTransient() const override
Definition memberdef.cpp:5432
MemberDefImpl::m_defArgList
ArgumentList m_defArgList
Definition memberdef.cpp:440
MemberDefImpl::m_docsForDefinition
bool m_docsForDefinition
Definition memberdef.cpp:505
MemberDefImpl::m_write
DString m_write
Definition memberdef.cpp:425
MemberDefImpl::memberDeclaration
MemberDef * memberDeclaration() const override
Definition memberdef.cpp:5724
MemberDefImpl::m_formalTemplateArguments
std::optional< ArgumentList > m_formalTemplateArguments
Definition memberdef.cpp:446
MemberDefImpl::isInitonly
bool isInitonly() const override
Definition memberdef.cpp:5320
MemberDefImpl::isAddable
bool isAddable() const override
Definition memberdef.cpp:5275
MemberDefImpl::setWriteAccessor
void setWriteAccessor(const DString &w) override
Definition memberdef.cpp:5837
MemberDefImpl::isRelated
bool isRelated() const override
Definition memberdef.cpp:5210
MemberDefImpl::moveArgumentList
void moveArgumentList(std::unique_ptr< ArgumentList > al) override
Definition memberdef.cpp:4853
MemberDefImpl::qualifiedName
DString qualifiedName() const override
Definition memberdef.cpp:4932
MemberDefImpl::m_cachedTypedefValue
const ClassDef * m_cachedTypedefValue
Definition memberdef.cpp:468
MemberDefImpl::m_redefines
MemberDef * m_redefines
Definition memberdef.cpp:406
MemberDefImpl::setCategory
void setCategory(ClassDef *) override
Definition memberdef.cpp:5975
MemberDefImpl::m_isDestructorCached
uint8_t m_isDestructorCached
Definition memberdef.cpp:394
MemberDefImpl::memberType
MemberType memberType() const override
Definition memberdef.cpp:5129
MemberDefImpl::sourceRefName
DString sourceRefName() const override
Definition memberdef.cpp:1651
MemberDefImpl::m_anonymousType
const ClassDef * m_anonymousType
Definition memberdef.cpp:452
MemberDefImpl::protection
Protection protection() const override
Definition memberdef.cpp:5124
MemberDefImpl::isConstructor
bool isConstructor() const override
Definition memberdef.cpp:4677
MemberDefImpl::setGroupAlias
void setGroupAlias(const MemberDef *md) override
Definition memberdef.cpp:5950
MemberDefImpl::setPrototype
void setPrototype(bool p, const DString &df, int line, size_t column) override
Definition memberdef.cpp:5891
MemberDefImpl::isEnumerate
bool isEnumerate() const override
Definition memberdef.cpp:5149
MemberDefImpl::templateArguments
const ArgumentList & templateArguments() const override
Definition memberdef.cpp:5612
MemberDefImpl::isCopy
bool isCopy() const override
Definition memberdef.cpp:5345
MemberDefImpl::setType
void setType(const DString &t) override
Definition memberdef.cpp:4868
MemberDefImpl::declaration
DString declaration() const override
Definition memberdef.cpp:4984
MemberDefImpl::m_metaData
DString m_metaData
Definition memberdef.cpp:450
MemberDefImpl::isReadonly
bool isReadonly() const override
Definition memberdef.cpp:5417
MemberDefImpl::setTagInfo
void setTagInfo(const TagInfo *i) override
Definition memberdef.cpp:4956
MemberDefImpl::definitionTemplateParameterLists
const ArgumentLists & definitionTemplateParameterLists() const override
Definition memberdef.cpp:5617
MemberDefImpl::_writeTemplatePrefix
void _writeTemplatePrefix(OutputList &ol, const Definition *def, const ArgumentList &al, bool writeReqClause=true) const
Definition memberdef.cpp:2154
MemberDefImpl::isStatic
bool isStatic() const override
Definition memberdef.cpp:5220
MemberDefImpl::writeTagFile
void writeTagFile(TextStream &, bool useQualifiedName, bool showNamespaceMembers) const override
Definition memberdef.cpp:4572
MemberDefImpl::m_classDef
ClassDef * m_classDef
Definition memberdef.cpp:396
MemberDefImpl::_writeMultiLineInitializer
void _writeMultiLineInitializer(OutputList &ol, const DString &scopeName) const
Definition memberdef.cpp:3365
MemberDefImpl::resolveAlias
MemberDef * resolveAlias() override
Definition memberdef.cpp:65
MemberDefImpl::isFinal
bool isFinal() const override
Definition memberdef.cpp:5300
MemberDefImpl::isAttribute
bool isAttribute() const override
Definition memberdef.cpp:5407
MemberDefImpl::m_enumScope
const MemberDef * m_enumScope
Definition memberdef.cpp:401
MemberDefImpl::m_explicitOutputFileBase
DString m_explicitOutputFileBase
Definition memberdef.cpp:476
MemberDefImpl::redefineCount
int redefineCount() const override
Definition memberdef.cpp:6404
MemberDefImpl::setExplicitExternal
void setExplicitExternal(bool b, const DString &df, int line, size_t column) override
Definition memberdef.cpp:5904
MemberDefImpl::isDictionary
bool isDictionary() const override
Definition memberdef.cpp:5169
MemberDefImpl::isSlot
bool isSlot() const override
Definition memberdef.cpp:5139
MemberDefImpl::bitfieldString
DString bitfieldString() const override
Definition memberdef.cpp:5014
MemberDefImpl::memberTypeName
DString memberTypeName() const override
Definition memberdef.cpp:4061
MemberDefImpl::hasInlineSource
bool hasInlineSource() const override
Definition memberdef.cpp:5678
MemberDefImpl::setAnchor
void setAnchor() override
Definition memberdef.cpp:4330
MemberDefImpl::m_related
Relationship m_related
Definition memberdef.cpp:488
MemberDefImpl::m_memberGroup
MemberGroup * m_memberGroup
Definition memberdef.cpp:460
MemberDefImpl::m_groupAlias
const MemberDef * m_groupAlias
Definition memberdef.cpp:458
MemberDefImpl::isRetain
bool isRetain() const override
Definition memberdef.cpp:5355
MemberDefImpl::m_redefinedBy
MemberVector m_redefinedBy
Definition memberdef.cpp:407
MemberDefImpl::category
ClassDef * category() const override
Definition memberdef.cpp:5970
MemberDefImpl::overrideEnumValues
void overrideEnumValues(bool e) override
Definition memberdef.cpp:4904
MemberDefImpl::isDocTransferDone
bool isDocTransferDone() const override
Definition memberdef.cpp:5029
MemberDefImpl::isDocumentedFriendClass
bool isDocumentedFriendClass() const override
Definition memberdef.cpp:4294
MemberDefImpl::isConstEval
bool isConstEval() const override
Definition memberdef.cpp:5529
MemberDefImpl::hasReferencesRelation
bool hasReferencesRelation() const override
Definition memberdef.cpp:5673
MemberDefImpl::_writeTagData
void _writeTagData(const DefType) const
MemberDefImpl::overrideReferencedByRelation
void overrideReferencedByRelation(bool e) override
Definition memberdef.cpp:4892
MemberDefImpl::isEnumStruct
bool isEnumStruct() const override
Definition memberdef.cpp:5370
MemberDefImpl::hasEnumValues
bool hasEnumValues() const override
Definition memberdef.cpp:5683
MemberDefImpl::m_declFileName
DString m_declFileName
Definition memberdef.cpp:510
MemberDefImpl::isExplicit
bool isExplicit() const override
Definition memberdef.cpp:5230
MemberDefImpl::_writeCategoryRelation
void _writeCategoryRelation(OutputList &ol) const
Definition memberdef.cpp:3052
MemberDefImpl::setTemplateSpecialization
void setTemplateSpecialization(bool b) override
Definition memberdef.cpp:5842
MemberDefImpl::isTemplateSpecialization
bool isTemplateSpecialization() const override
Definition memberdef.cpp:5468
MemberDefImpl::typeString
DString typeString() const override
Definition memberdef.cpp:4999
MemberDefImpl::inheritsDocsFrom
const MemberDef * inheritsDocsFrom() const override
Definition memberdef.cpp:5729
MemberDefImpl::getDeclLine
int getDeclLine() const override
Definition memberdef.cpp:5744
MemberDefImpl::setTypeConstraints
void setTypeConstraints(const ArgumentList &al) override
Definition memberdef.cpp:4863
MemberDefImpl::setVhdlSpecifiers
void setVhdlSpecifiers(VhdlSpecifier s) override
Definition memberdef.cpp:5792
MemberDefImpl::isImplementation
bool isImplementation() const override
Definition memberdef.cpp:5458
MemberDefImpl::m_extraTypeChars
DString m_extraTypeChars
Definition memberdef.cpp:428
MemberDefImpl::livesInsideEnum
bool livesInsideEnum() const override
Definition memberdef.cpp:5509
MemberDefImpl::isDelete
bool isDelete() const override
Definition memberdef.cpp:5397
MemberDefImpl::getCachedResolvedTypedef
DString getCachedResolvedTypedef() const override
Definition memberdef.cpp:5713
MemberDefImpl::m_bitfields
DString m_bitfields
Definition memberdef.cpp:423
MemberDefImpl::excpString
DString excpString() const override
Definition memberdef.cpp:5009
MemberDefImpl::fieldType
DString fieldType() const override
Definition memberdef.cpp:3945
MemberDefImpl::isNoExcept
bool isNoExcept() const override
Definition memberdef.cpp:5402
MemberDefImpl::argsString
DString argsString() const override
Definition memberdef.cpp:5004
MemberDefImpl::isWeak
bool isWeak() const override
Definition memberdef.cpp:5360
MemberDefImpl::getAnonymousEnumType
const MemberDef * getAnonymousEnumType() const override
Definition memberdef.cpp:5494
MemberDefImpl::setDocumentation
void setDocumentation(const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
Definition memberdef.cpp:1880
MemberDefImpl::getModuleDef
const ModuleDef * getModuleDef() const override
Definition memberdef.cpp:5099
MemberDefImpl::setDocTransferDone
void setDocTransferDone() override
Definition memberdef.cpp:1892
MemberDefImpl::isNoDiscard
bool isNoDiscard() const override
Definition memberdef.cpp:5519
MemberDefImpl::m_group
GroupDef * m_group
Definition memberdef.cpp:461
MemberDefImpl::incrementFlowKeyWordCount
void incrementFlowKeyWordCount() override
Definition memberdef.cpp:6075
MemberDefImpl::getGroupAlias
const MemberDef * getGroupAlias() const override
Definition memberdef.cpp:5734
MemberDefImpl::isConstInit
bool isConstInit() const override
Definition memberdef.cpp:5534
MemberDefImpl::setModuleDef
void setModuleDef(ModuleDef *mod) override
Definition memberdef.cpp:5776
MemberDefImpl::m_memSpec
TypeSpecifier m_memSpec
Definition memberdef.cpp:434
MemberDefImpl::getDeclType
DString getDeclType() const override
Definition memberdef.cpp:2107
MemberDefImpl::getMemberSpecifiers
TypeSpecifier getMemberSpecifiers() const override
Definition memberdef.cpp:5034
MemberDefImpl::hasReferencedByRelation
bool hasReferencedByRelation() const override
Definition memberdef.cpp:5668
MemberDefImpl::m_requiresClause
DString m_requiresClause
Definition memberdef.cpp:430
MemberDefImpl::makeImplementationDetail
void makeImplementationDetail() override
Definition memberdef.cpp:5929
MemberDefImpl::getGroupPri
Grouping::GroupPri_t getGroupPri() const override
Definition memberdef.cpp:5104
MemberDefImpl::isLinkable
bool isLinkable() const override
Definition memberdef.cpp:1925
MemberDefImpl::hasDocumentation
bool hasDocumentation() const override
Definition memberdef.cpp:4308
MemberDefImpl::numberOfFlowKeyWords
int numberOfFlowKeyWords() const override
Definition memberdef.cpp:6080
MemberDefImpl::isProtectedGettable
bool isProtectedGettable() const override
Definition memberdef.cpp:5255
MemberDefImpl::m_hasDetailedDescriptionCached
bool m_hasDetailedDescriptionCached
Definition memberdef.cpp:493
MemberDefImpl::MemberDefImpl
MemberDefImpl(const DString &defFileName, int defLine, size_t defColumn, const DString &type, const DString &name, const DString &args, const DString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const DString &metaData)
Definition memberdef.cpp:1452
MemberDefImpl::setDefinitionTemplateParameterLists
void setDefinitionTemplateParameterLists(const ArgumentLists &lists) override
Definition memberdef.cpp:1938
MemberDefImpl::m_examples
ExampleList m_examples
Definition memberdef.cpp:413
MemberDefImpl::declArgumentList
const ArgumentList & declArgumentList() const override
Definition memberdef.cpp:5559
MemberDefImpl::invalidateCachedArgumentTypes
void invalidateCachedArgumentTypes() override
Definition memberdef.cpp:6069
MemberDefImpl::_isAnonymousBitField
bool _isAnonymousBitField() const
Definition memberdef.cpp:2197
MemberDefImpl::getDeclColumn
size_t getDeclColumn() const override
Definition memberdef.cpp:5749
MemberDefImpl::detectUndocumentedParams
void detectUndocumentedParams(bool hasParamCommand, bool hasReturnCommand) const override
Definition memberdef.cpp:4172
MemberDefImpl::m_relatedAlso
ClassDef * m_relatedAlso
Definition memberdef.cpp:411
MemberDefImpl::m_annEnumType
const MemberDef * m_annEnumType
Definition memberdef.cpp:403
MemberDefImpl::isWritable
bool isWritable() const override
Definition memberdef.cpp:5295
MemberDefImpl::m_cachedTypedefTemplSpec
DString m_cachedTypedefTemplSpec
Definition memberdef.cpp:469
MemberDefImpl::m_templateMaster
const MemberDef * m_templateMaster
Definition memberdef.cpp:445
MemberDefImpl::isSealed
bool isSealed() const override
Definition memberdef.cpp:5310
MemberDefImpl::isAbstract
bool isAbstract() const override
Definition memberdef.cpp:5325
MemberDefImpl::isPrivateSettable
bool isPrivateSettable() const override
Definition memberdef.cpp:5265
MemberDefImpl::setInitializer
void setInitializer(const DString &i) override
Definition memberdef.cpp:4476
MemberDefImpl::isSequence
bool isSequence() const override
Definition memberdef.cpp:5164
MemberDefImpl::_computeLinkableInProject
void _computeLinkableInProject()
Definition memberdef.cpp:1801
MemberDefImpl::m_grouppri
Grouping::GroupPri_t m_grouppri
Definition memberdef.cpp:462
MemberDefImpl::setRelatedAlso
void setRelatedAlso(ClassDef *cd) override
Definition memberdef.cpp:5869
MemberDefImpl::addRequirementReferences
void addRequirementReferences(const Definition *) override
Definition memberdef.cpp:4537
MemberDefImpl::hasExamples
bool hasExamples() const override
Definition memberdef.cpp:1646
MemberDefImpl::resolveUnnamedParameters
void resolveUnnamedParameters(const MemberDef *md) override
Definition memberdef.cpp:5564
MemberDefImpl::setMemberDefinition
void setMemberDefinition(MemberDef *md) override
Definition memberdef.cpp:5960
MemberDefImpl::isThreadLocal
bool isThreadLocal() const override
Definition memberdef.cpp:5240
MemberDefImpl::writeMemberDocSimple
void writeMemberDocSimple(OutputList &ol, const Definition *container) const override
Definition memberdef.cpp:3952
MemberDefImpl::setGroupDef
void setGroupDef(GroupDef *gd, Grouping::GroupPri_t pri, const DString &fileName, int startLine, bool hasDocs, MemberDef *member=nullptr) override
Definition memberdef.cpp:4368
MemberDefImpl::isSignal
bool isSignal() const override
Definition memberdef.cpp:5134
MemberDefImpl::isMaybeVoid
bool isMaybeVoid() const override
Definition memberdef.cpp:5437
MemberDefImpl::init
void init(Definition *def, const DString &t, const DString &a, const DString &e, Protection p, Specifier v, bool s, Relationship r, MemberType mt, const ArgumentList &tal, const ArgumentList &al, const DString &meta)
Definition memberdef.cpp:1345
MemberDefImpl::_writeReimplements
void _writeReimplements(OutputList &ol) const
Definition memberdef.cpp:2918
MemberDefImpl::isMaybeAmbiguous
bool isMaybeAmbiguous() const override
Definition memberdef.cpp:5447
MemberDefImpl::hasOneLineInitializer
bool hasOneLineInitializer() const override
Definition memberdef.cpp:4454
MemberDefImpl::getSectionList
const MemberList * getSectionList(const Definition *) const override
Definition memberdef.cpp:4542
MemberDefImpl::isForeign
bool isForeign() const override
Definition memberdef.cpp:5215
MemberDefImpl::addQualifiers
void addQualifiers(const StringVector &qualifiers) override
Definition memberdef.cpp:5807
MemberDefImpl::setEnumBaseType
void setEnumBaseType(const DString &type) override
Definition memberdef.cpp:5990
MemberDefImpl::isAssign
bool isAssign() const override
Definition memberdef.cpp:5350
MemberDefImpl::isStrongEnumValue
bool isStrongEnumValue() const override
Definition memberdef.cpp:5375
MemberDefImpl::getReadAccessor
DString getReadAccessor() const override
Definition memberdef.cpp:5079
MemberDefImpl::_computeIsDestructor
void _computeIsDestructor()
Definition memberdef.cpp:4689
MemberDefImpl::isNotFriend
bool isNotFriend() const override
Definition memberdef.cpp:6359
MemberDefImpl::getClassDefOfAnonymousType
const ClassDef * getClassDefOfAnonymousType() const override
Definition memberdef.cpp:2006
MemberDefImpl::copyArgumentNames
void copyArgumentNames(const MemberDef *bmd) override
Definition memberdef.cpp:6019
MemberDefImpl::isRemovable
bool isRemovable() const override
Definition memberdef.cpp:5280
MemberDefImpl::setExplicitInherited
void setExplicitInherited(bool b) override
Definition memberdef.cpp:1897
MemberDefImpl::isDeleted
bool isDeleted() const override
Definition memberdef.cpp:4303
MemberDefImpl::getGroupFileName
DString getGroupFileName() const override
Definition memberdef.cpp:5109
MemberDefImpl::m_memDef
MemberDef * m_memDef
Definition memberdef.cpp:409
MemberDefImpl::m_groupMember
MemberDef * m_groupMember
Definition memberdef.cpp:465
MemberDefImpl::initializer
const DString & initializer() const override
Definition memberdef.cpp:5019
MemberDefImpl::isFriend
bool isFriend() const override
Definition memberdef.cpp:5190
MemberDefImpl::documentation
DString documentation() const override
Definition memberdef.cpp:6312
MemberDefImpl::m_livesInsideEnum
bool m_livesInsideEnum
Definition memberdef.cpp:402
MemberDefImpl::setArgsString
void setArgsString(const DString &as) override
Definition memberdef.cpp:5864
MemberDefImpl::m_typeConstraints
ArgumentList m_typeConstraints
Definition memberdef.cpp:444
MemberDefImpl::relatedAlso
ClassDef * relatedAlso() const override
Definition memberdef.cpp:5484
MemberDefImpl::m_initializer
DString m_initializer
Definition memberdef.cpp:427
MemberDefImpl::setReimplements
void setReimplements(MemberDef *md) override
Definition memberdef.cpp:1585
MemberDefImpl::writeLink
void writeLink(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, bool onlyText=false) const override
Definition memberdef.cpp:1943
MemberDefImpl::m_enumFields
MemberVector m_enumFields
Definition memberdef.cpp:404
MemberDefImpl::writeEnumDeclaration
void writeEnumDeclaration(OutputList &typeDecl, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod) const override
Definition memberdef.cpp:4729
MemberDefImpl::isConstExpr
bool isConstExpr() const override
Definition memberdef.cpp:5524
MemberDefImpl::isExternal
bool isExternal() const override
Definition memberdef.cpp:5463
MemberDefImpl::getFileDef
const FileDef * getFileDef() const override
Definition memberdef.cpp:5059
MemberDefImpl::isNonAtomic
bool isNonAtomic() const override
Definition memberdef.cpp:5340
MemberDefImpl::categoryRelation
const MemberDef * categoryRelation() const override
Definition memberdef.cpp:5980
MemberDefImpl::enumFieldList
const MemberVector & enumFieldList() const override
Definition memberdef.cpp:5539
MemberDefImpl::getClassDef
const ClassDef * getClassDef() const override
Definition memberdef.cpp:5044
MemberDefImpl::setDefinition
void setDefinition(const DString &d) override
Definition memberdef.cpp:5763
MemberDefImpl::isFunctionOrSignalSlot
bool isFunctionOrSignalSlot() const override
Definition memberdef.cpp:6364
MemberDefImpl::overrideInlineSource
void overrideInlineSource(bool e) override
Definition memberdef.cpp:4909
MemberDefImpl::overrideCallerGraph
void overrideCallerGraph(bool e) override
Definition memberdef.cpp:4886
MemberDefImpl::isPrivateGettable
bool isPrivateGettable() const override
Definition memberdef.cpp:5250
MemberDefImpl::isEvent
bool isEvent() const override
Definition memberdef.cpp:5205
MemberDefImpl::setMemberSpecifiers
void setMemberSpecifiers(TypeSpecifier s) override
Definition memberdef.cpp:5787
MemberDefImpl::isFunctionPtr
bool isFunctionPtr() const override
Definition memberdef.cpp:5179
MemberDefImpl::hasCallerGraph
bool hasCallerGraph() const override
Definition memberdef.cpp:5650
MemberDefImpl::isObjCProperty
bool isObjCProperty() const override
Definition memberdef.cpp:4920
MemberDefImpl::setEnumScope
void setEnumScope(MemberDef *md, bool livesInsideEnum=false) override
Definition memberdef.cpp:4382
MemberDefImpl::isPrototype
bool isPrototype() const override
Definition memberdef.cpp:5549
MemberDefImpl::requiresClause
DString requiresClause() const override
Definition memberdef.cpp:6005
MemberDefImpl::isTypedef
bool isTypedef() const override
Definition memberdef.cpp:5159
MemberDefImpl::_writeGroupInclude
void _writeGroupInclude(OutputList &ol, bool inGroup) const
Definition memberdef.cpp:3313
MemberDefImpl::m_fileDef
FileDef * m_fileDef
Definition memberdef.cpp:397
MemberDefImpl::hasDocumentedEnumValues
bool hasDocumentedEnumValues() const override
Definition memberdef.cpp:5489
MemberDefImpl::~MemberDefImpl
~MemberDefImpl() override=default
MemberDefImpl::_writeEnumValues
void _writeEnumValues(OutputList &ol, const Definition *container, const DString &cfname, const DString &ciname, const DString &cname) const
Definition memberdef.cpp:3126
MemberDefImpl::m_isLinkableCached
uint8_t m_isLinkableCached
Definition memberdef.cpp:392
MemberDefImpl::isVariable
bool isVariable() const override
Definition memberdef.cpp:5144
MemberDefImpl::mergeMemberSpecifiers
void mergeMemberSpecifiers(TypeSpecifier s) override
Definition memberdef.cpp:5797
MemberDefImpl::displayName
DString displayName(bool=true) const override
Definition memberdef.cpp:6087
MemberDefImpl::m_tArgList
ArgumentList m_tArgList
Definition memberdef.cpp:443
MemberDefImpl::isConstrained
bool isConstrained() const override
Definition memberdef.cpp:5427
MemberDefImpl::isReadable
bool isReadable() const override
Definition memberdef.cpp:5290
MemberDefImpl::getOutputFileBase
DString getOutputFileBase() const override
Definition memberdef.cpp:1671
MemberDefImpl::addListReference
void addListReference(const Definition *) override
Definition memberdef.cpp:4490
MemberDefImpl::isDefault
bool isDefault() const override
Definition memberdef.cpp:5392
MemberDefImpl::_writeCallGraph
void _writeCallGraph(OutputList &ol) const
Definition memberdef.cpp:2859
MemberDefImpl::briefDescription
DString briefDescription(bool abbr=false) const override
Definition memberdef.cpp:6300
MemberDefImpl::isOverride
bool isOverride() const override
Definition memberdef.cpp:5315
MemberDefImpl::m_docProvider
const MemberDef * m_docProvider
Definition memberdef.cpp:473
MemberDefImpl::isSettable
bool isSettable() const override
Definition memberdef.cpp:5260
MemberDefImpl::isBound
bool isBound() const override
Definition memberdef.cpp:5422
MemberDefImpl::codeSymbolType
CodeSymbolType codeSymbolType() const override
Definition memberdef.cpp:6380
MemberDefImpl::setBitfields
void setBitfields(const DString &s) override
Definition memberdef.cpp:5819
MemberDefImpl::setInbodyDocumentation
void setInbodyDocumentation(const DString &d, const DString &inbodyFile, int inbodyLine) override
Definition memberdef.cpp:1902
MemberDefMutable::setMemberDeclaration
virtual void setMemberDeclaration(MemberDef *md)=0
MemberDefMutable::setDocTransferDone
virtual void setDocTransferDone()=0
MemberDefMutable::resolveUnnamedParameters
virtual void resolveUnnamedParameters(const MemberDef *md)=0
MemberDefMutable::overrideReferencesRelation
virtual void overrideReferencesRelation(bool e)=0
MemberDefMutable::overrideReferencedByRelation
virtual void overrideReferencedByRelation(bool e)=0
MemberDefMutable::setDocsForDefinition
virtual void setDocsForDefinition(bool b)=0
MemberDefMutable::overrideCallGraph
virtual void overrideCallGraph(bool e)=0
MemberDefMutable::overrideInlineSource
virtual void overrideInlineSource(bool e)=0
MemberDefMutable::overrideEnumValues
virtual void overrideEnumValues(bool e)=0
MemberDefMutable::mergeMemberSpecifiers
virtual void mergeMemberSpecifiers(TypeSpecifier s)=0
MemberDefMutable::addQualifiers
virtual void addQualifiers(const StringVector &qualifiers)=0
MemberDefMutable::moveDeclArgumentList
virtual void moveDeclArgumentList(std::unique_ptr< ArgumentList > al)=0
MemberDefMutable::overrideCallerGraph
virtual void overrideCallerGraph(bool e)=0
MemberDefMutable::setMemberDefinition
virtual void setMemberDefinition(MemberDef *md)=0
MemberDefMutable::moveArgumentList
virtual void moveArgumentList(std::unique_ptr< ArgumentList > al)=0
MemberDefMutable::insertReimplementedBy
virtual void insertReimplementedBy(MemberDef *md)=0
MemberDefMutable::setGroupDef
virtual void setGroupDef(GroupDef *gd, Grouping::GroupPri_t pri, const DString &fileName, int startLine, bool hasDocs, MemberDef *member=nullptr)=0
MemberGroup
A class representing a group of members.
Definition membergroup.h:42
MemberList
A list of MemberDef objects as shown in documentation sections.
Definition memberlist.h:125
MemberVector
A vector of MemberDef object.
Definition memberlist.h:35
MemberVector::end
iterator end() noexcept
Definition memberlist.h:56
MemberVector::contains
bool contains(const MemberDef *md) const
Definition memberlist.h:89
MemberVector::inSort
void inSort(MemberDef *md)
Definition memberlist.h:80
MemberVector::begin
iterator begin() noexcept
Definition memberlist.h:54
MemberVector::push_back
void push_back(const T &value)
Definition memberlist.h:48
NamespaceDef
An abstract interface of a namespace symbol.
Definition namespacedef.h:55
NamespaceDef::compoundTypeString
virtual DString compoundTypeString() const =0
OutputCodeList::startCodeFragment
void startCodeFragment(const DString &style)
Definition outputlist.h:276
OutputList
Class representing a list of output generators that are written to in parallel.
Definition outputlist.h:311
OutputList::writeDoc
void writeDoc(const IDocNodeAST *ast, const Definition *ctx, const MemberDef *md, int sectionLevel=-1)
Definition outputlist.h:379
OutputList::endIndent
void endIndent()
Definition outputlist.h:580
OutputList::startMemberDeclaration
void startMemberDeclaration()
Definition outputlist.h:565
OutputList::parseText
void parseText(const DString &textStr)
Definition outputlist.cpp:199
OutputList::endDescTableRow
void endDescTableRow()
Definition outputlist.h:630
OutputList::startMemberDocName
void startMemberDocName(bool align)
Definition outputlist.h:676
OutputList::endParameterExtra
void endParameterExtra(bool last, bool one, bool bracket)
Definition outputlist.h:690
OutputList::writeChar
void writeChar(char c)
Definition outputlist.h:525
OutputList::disable
void disable(OutputType o)
Definition outputlist.cpp:115
OutputList::startParagraph
void startParagraph(const DString &classDef=DString())
Definition outputlist.h:403
OutputList::writeObjectLink
void writeObjectLink(const DString &ref, const DString &file, const DString &anchor, const DString &name)
Definition outputlist.h:435
OutputList::endMemberDocName
void endMemberDocName()
Definition outputlist.h:678
OutputList::endMemberDoc
void endMemberDoc(bool hasArgs)
Definition outputlist.h:531
OutputList::startDescTableInit
void startDescTableInit()
Definition outputlist.h:636
OutputList::startCallGraph
void startCallGraph()
Definition outputlist.h:652
OutputList::addIndexItem
void addIndexItem(const DString &s1, const DString &s2)
Definition outputlist.h:586
OutputList::endDescTable
void endDescTable()
Definition outputlist.h:626
OutputList::startParameterExtra
void startParameterExtra()
Definition outputlist.h:688
OutputList::endPageRef
void endPageRef(const DString &c, const DString &a)
Definition outputlist.h:596
OutputList::codeGenerators
const OutputCodeList & codeGenerators() const
Definition outputlist.h:354
OutputList::startParameterList
void startParameterList(bool openBracket)
Definition outputlist.h:696
OutputList::writeLatexSpacing
void writeLatexSpacing()
Definition outputlist.h:541
OutputList::enable
void enable(OutputType o)
Definition outputlist.cpp:125
OutputList::endInlineMemberType
void endInlineMemberType()
Definition outputlist.h:724
OutputList::endMemberDescription
void endMemberDescription()
Definition outputlist.h:563
OutputList::endMemberDeclaration
void endMemberDeclaration(const DString &anchor, const DString &inheritId)
Definition outputlist.h:567
OutputList::startInlineMemberType
void startInlineMemberType()
Definition outputlist.h:722
OutputList::docify
void docify(const DString &s)
Definition outputlist.h:433
OutputList::startInlineMemberDoc
void startInlineMemberDoc()
Definition outputlist.h:730
OutputList::endMemberTemplateParams
void endMemberTemplateParams(const DString &anchor, const DString &inheritId)
Definition outputlist.h:495
OutputList::lineBreak
void lineBreak(const DString &style=DString())
Definition outputlist.h:555
OutputList::startMemberDoc
void startMemberDoc(const DString &clName, const DString &memName, const DString &anchor, const DString &title, int memCount, int memTotal, bool showInline)
Definition outputlist.h:527
OutputList::endDescTableTitle
void endDescTableTitle()
Definition outputlist.h:634
OutputList::insertMemberAlign
void insertMemberAlign(bool templ=false)
Definition outputlist.h:513
OutputList::startIndent
void startIndent()
Definition outputlist.h:578
OutputList::writeString
void writeString(const DString &text)
Definition outputlist.h:407
OutputList::endDescForItem
void endDescForItem()
Definition outputlist.h:545
OutputList::endExamples
void endExamples()
Definition outputlist.h:576
OutputList::endDoxyAnchor
void endDoxyAnchor(const DString &fn, const DString &anchor)
Definition outputlist.h:537
OutputList::startDescTable
void startDescTable(const DString &title, const bool hasInits)
Definition outputlist.h:624
OutputList::endParagraph
void endParagraph()
Definition outputlist.h:405
OutputList::endDescTableData
void endDescTableData()
Definition outputlist.h:642
OutputList::disableAll
void disableAll()
Definition outputlist.cpp:105
OutputList::startDescTableTitle
void startDescTableTitle()
Definition outputlist.h:632
OutputList::startPageRef
void startPageRef()
Definition outputlist.h:594
OutputList::startExamples
void startExamples()
Definition outputlist.h:574
OutputList::endInlineMemberDoc
void endInlineMemberDoc()
Definition outputlist.h:732
OutputList::endMemberDocPrefixItem
void endMemberDocPrefixItem()
Definition outputlist.h:674
OutputList::startParameterDefVal
void startParameterDefVal(const char *separator)
Definition outputlist.h:692
OutputList::addLabel
void addLabel(const DString &fName, const DString &anchor)
Definition outputlist.h:539
OutputList::startBold
void startBold()
Definition outputlist.h:557
OutputList::endMemberItem
void endMemberItem(OutputGenerator::MemberItemType type)
Definition outputlist.h:491
OutputList::startTypewriter
void startTypewriter()
Definition outputlist.h:445
OutputList::startDescTableData
void startDescTableData()
Definition outputlist.h:640
OutputList::pushGeneratorState
void pushGeneratorState()
Definition outputlist.cpp:144
OutputList::startDescForItem
void startDescForItem()
Definition outputlist.h:543
OutputList::endParameterDefVal
void endParameterDefVal()
Definition outputlist.h:694
OutputList::disableAllBut
void disableAllBut(OutputType o)
Definition outputlist.cpp:85
OutputList::exceptionEntry
void exceptionEntry(const DString &prefix, bool closeBracket)
Definition outputlist.h:700
OutputList::endParameterName
void endParameterName()
Definition outputlist.h:686
OutputList::popGeneratorState
void popGeneratorState()
Definition outputlist.cpp:154
OutputList::endBold
void endBold()
Definition outputlist.h:559
OutputList::writeLabel
void writeLabel(const DString &l, bool isLast)
Definition outputlist.h:736
OutputList::endLabels
void endLabels()
Definition outputlist.h:738
OutputList::startMemberItem
void startMemberItem(const DString &anchor, OutputGenerator::MemberItemType type, const DString &id=DString())
Definition outputlist.h:489
OutputList::startMemberDescription
void startMemberDescription(const DString &anchor, const DString &inheritId=DString(), bool typ=false)
Definition outputlist.h:561
OutputList::endParameterList
void endParameterList()
Definition outputlist.h:698
OutputList::endCallGraph
void endCallGraph(DotCallGraph &g)
Definition outputlist.h:654
OutputList::startInlineMemberName
void startInlineMemberName()
Definition outputlist.h:726
OutputList::generateDoc
void generateDoc(const DString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const DString &docStr, const DocOptions &options)
Definition outputlist.cpp:168
OutputList::startLabels
void startLabels()
Definition outputlist.h:734
OutputList::endParameterType
void endParameterType()
Definition outputlist.h:682
OutputList::startMemberDocPrefixItem
void startMemberDocPrefixItem()
Definition outputlist.h:672
OutputList::endAnonTypeScope
void endAnonTypeScope(int i1)
Definition outputlist.h:487
OutputList::startParameterName
void startParameterName(bool one)
Definition outputlist.h:684
OutputList::enableAll
void enableAll()
Definition outputlist.cpp:95
OutputList::startParameterType
void startParameterType(bool first, const DString &key)
Definition outputlist.h:680
OutputList::endTypewriter
void endTypewriter()
Definition outputlist.h:447
OutputList::endInlineMemberName
void endInlineMemberName()
Definition outputlist.h:728
OutputList::writeNonBreakableSpace
void writeNonBreakableSpace(int num)
Definition outputlist.h:622
OutputList::startDoxyAnchor
void startDoxyAnchor(const DString &fName, const DString &manName, const DString &anchor, const DString &name, const DString &args)
Definition outputlist.h:533
OutputList::endDescTableInit
void endDescTableInit()
Definition outputlist.h:638
OutputList::startDescTableRow
void startDescTableRow()
Definition outputlist.h:628
OutputList::startMemberTemplateParams
void startMemberTemplateParams()
Definition outputlist.h:493
ParserManager::getCodeParser
std::unique_ptr< CodeParserInterface > getCodeParser(const DString &extension)
Gets the interface to the parser associated with a given extension.
Definition parserintf.h:253
RequirementManager::instance
static RequirementManager & instance()
Definition requirement.cpp:97
RequirementManager::addRequirementRefsForSymbol
void addRequirementRefsForSymbol(const Definition *symbol)
Definition requirement.cpp:333
TagInfo
This struct is used to capture the tag file information for an Entry.
Definition entry.h:101
TagInfo::tagName
DString tagName
Definition entry.h:103
TagInfo::anchor
DString anchor
Definition entry.h:105
TagInfo::fileName
DString fileName
Definition entry.h:104
TextGeneratorOLImpl
Implements TextGeneratorIntf for an OutputDocInterface stream.
Definition outputlist.h:786
TextStream
Text streaming class that buffers data.
Definition textstream.h:36
Translator::trProvidedByCategory
virtual DString trProvidedByCategory()=0
Translator::trReimplementedFromList
virtual DString trReimplementedFromList(int numEntries)=0
Translator::trDefineValue
virtual DString trDefineValue()=0
Translator::trSubprogram
virtual DString trSubprogram(bool first_capital, bool singular)=0
Translator::trImplementedInList
virtual DString trImplementedInList(int numEntries)=0
Translator::trInitialValue
virtual DString trInitialValue()=0
Translator::trImplementedFromList
virtual DString trImplementedFromList(int numEntries)=0
Translator::trVhdlType
virtual DString trVhdlType(VhdlSpecifier type, bool single)=0
Translator::trPageAbbreviation
virtual DString trPageAbbreviation()=0
Translator::trReimplementedInList
virtual DString trReimplementedInList(int numEntries)=0
Translator::trExtendsClass
virtual DString trExtendsClass()=0
Translator::trCallerGraph
virtual DString trCallerGraph()=0
Translator::trMember
virtual DString trMember(bool first_capital, bool singular)=0
Translator::trEnumerationValues
virtual DString trEnumerationValues()=0
Translator::trCallGraph
virtual DString trCallGraph()=0
Translator::trGlobal
virtual DString trGlobal(bool first_capital, bool singular)=0
TypeSpecifier
Wrapper class for a number of boolean properties.
Definition types.h:694
VhdlDocGen::writeVHDLTypeDocumentation
static bool writeVHDLTypeDocumentation(const MemberDef *mdef, const Definition *d, OutputList &ol)
Definition vhdldocgen.cpp:1260
VhdlDocGen::isMisc
static bool isMisc(const MemberDef *mdef)
Definition vhdldocgen.cpp:2486
VhdlDocGen::writeSource
static void writeSource(const MemberDef *mdef, OutputList &ol, const DString &cname)
Definition vhdldocgen.cpp:1850
toClassDefMutable
ClassDefMutable * toClassDefMutable(Definition *d)
Definition classdef.cpp:5484
getClass
ClassDef * getClass(const DString &n)
Definition classdef.cpp:5501
toClassDef
ClassDef * toClassDef(Definition *d)
Definition classdef.cpp:5447
reg::Ex
Class representing a regular expression.
Definition regex.h:39
reg::Match
Object representing the matching results.
Definition regex.h:154
reg::Match::prefix
SubMatch prefix() const
Return the part of the string before the match.
Definition regex.h:169
reg::Match::position
size_t position() const
Returns the position of the match or std::string::npos if no position is set.
Definition regex.h:160
reg::Match::suffix
SubMatch suffix() const
Return the part of the string after the match.
Definition regex.h:172
reg::Match::length
size_t length() const
Returns the position of the match or std::string::npos if no length is set.
Definition regex.h:163
reg::SubMatch::str
std::string str() const
Returns the matching part as a string.
Definition regex.h:132
Config_getInt
#define Config_getInt(name)
Definition config.h:34
Config_getList
#define Config_getList(name)
Definition config.h:38
Config_getBool
#define Config_getBool(name)
Definition config.h:33
NON_COPYABLE
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
Definition construct.h:37
StringVector
std::vector< std::string > StringVector
Definition containers.h:33
stringToArgumentList
std::unique_ptr< ArgumentList > stringToArgumentList(SrcLangExt lang, const DString &argsString, DString *extraTypeChars=nullptr)
Definition defargs.l:828
toDefinition
Definition * toDefinition(DefinitionMutable *dm)
Definition definition.cpp:1985
AUTO_TRACE_ADD
#define AUTO_TRACE_ADD(...)
Definition docnode.cpp:52
AUTO_TRACE
#define AUTO_TRACE(...)
Definition docnode.cpp:51
createDocParser
IDocParserPtr createDocParser()
factory function to create a parser
Definition docparser.cpp:59
docFindSections
void docFindSections(const DString &input, const Definition *d, const DString &fileName)
Definition docparser.cpp:2459
validatingParseDoc
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const DString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const DString &input, const DocOptions &options)
Definition docparser.cpp:2191
substitute
DString substitute(const DString &s, const DString &src, const DString &dst)
substitute all occurrences of src in s by dst
Definition dstring.cpp:481
ASSERT
#define ASSERT(x)
Definition dstring.h:28
isId
bool isId(int c)
Returns true if c is a valid character for an identifier.
Definition dstring.h:899
toFileDef
FileDef * toFileDef(Definition *d)
Definition filedef.cpp:1976
toGroupDef
GroupDef * toGroupDef(Definition *d)
Definition groupdef.cpp:2083
theTranslator
Translator * theTranslator
Definition language.cpp:71
linkifyText
void linkifyText(const TextGeneratorIntf &out, const DString &text, const LinkifyTextOptions &options)
Definition linkifytext.cpp:25
md5str
DString md5str(const std::string_view &str)
Definition md5hash.h:33
simplifyTypeForTable
static DString simplifyTypeForTable(const DString &s)
Definition memberdef.cpp:3929
addTemplateNames
static DString addTemplateNames(const DString &s, const DString &n, const DString &t)
Definition memberdef.cpp:995
writeExceptionListImpl
static void writeExceptionListImpl(OutputList &ol, const ClassDef *cd, const MemberDef *md, DString const &exception)
Definition memberdef.cpp:1279
writeExceptionList
static void writeExceptionList(OutputList &ol, const ClassDef *cd, const MemberDef *md)
Definition memberdef.cpp:1318
writePageRef
static void writePageRef(OutputList &ol, const DString &cn, const DString &mn)
Definition memberdef.cpp:976
combineArgsAndException
static DString combineArgsAndException(DString args, DString exception)
Definition memberdef.cpp:2188
writeDefArgumentList
static bool writeDefArgumentList(OutputList &ol, const Definition *scope, const MemberDef *md)
Definition memberdef.cpp:1068
g_hasDetailedDescriptionMutex
static std::mutex g_hasDetailedDescriptionMutex
Definition memberdef.cpp:2587
createMemberDef
std::unique_ptr< MemberDef > createMemberDef(const DString &defFileName, int defLine, size_t defColumn, const DString &type, const DString &name, const DString &args, const DString &excp, Protection prot, Specifier virt, bool stat, Relationship related, MemberType t, const ArgumentList &tal, const ArgumentList &al, const DString &metaData)
Factory method to create a new instance of a MemberDef.
Definition memberdef.cpp:517
g_docCrossReferenceMutex
static std::mutex g_docCrossReferenceMutex
Definition memberdef.cpp:6417
createMemberDefAlias
std::unique_ptr< MemberDef > createMemberDefAlias(const Definition *newScope, const MemberDef *aliasMd)
Definition memberdef.cpp:967
invalidateCachedTypesInArgumentList
static void invalidateCachedTypesInArgumentList(ArgumentList &al)
Definition memberdef.cpp:6061
g_detectUndocumentedParamsMutex
static std::mutex g_detectUndocumentedParamsMutex
Definition memberdef.cpp:4170
transferArgumentDocumentation
static void transferArgumentDocumentation(ArgumentList &decAl, ArgumentList &defAl)
Definition memberdef.cpp:6094
addDocCrossReference
void addDocCrossReference(const MemberDef *s, const MemberDef *d)
Definition memberdef.cpp:6419
g_cachedAnonymousTypeMutex
static std::mutex g_cachedAnonymousTypeMutex
Definition memberdef.cpp:1996
toMemberDefMutable
MemberDefMutable * toMemberDefMutable(Definition *d)
Definition memberdef.cpp:6509
mergeMemberOverrideOptions
void mergeMemberOverrideOptions(MemberDefMutable *md1, MemberDefMutable *md2)
Definition memberdef.cpp:6281
stripTrailingReturn
static DString stripTrailingReturn(const DString &trailRet)
Definition memberdef.cpp:4157
combineDeclarationAndDefinition
void combineDeclarationAndDefinition(MemberDefMutable *mdec, MemberDefMutable *mdef)
Definition memberdef.cpp:6125
toMemberDef
MemberDef * toMemberDef(Definition *d)
Definition memberdef.cpp:6472
reAnonymous
static const reg::Ex reAnonymous(R"([\w:@]*@\d+)")
warn_undoc
#define warn_undoc(file, line, fmt,...)
Definition message.h:102
warn_uncond
#define warn_uncond(fmt,...)
Definition message.h:122
warn
#define warn(file, line, fmt,...)
Definition message.h:97
msg
#define msg(fmt,...)
Definition message.h:94
err
#define err(fmt,...)
Definition message.h:127
warn_doc_error
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
toModuleDef
ModuleDef * toModuleDef(Definition *d)
Definition moduledef.cpp:1206
toNamespaceDef
NamespaceDef * toNamespaceDef(Definition *d)
Definition namespacedef.cpp:1692
reg::search
bool search(std::string_view str, Match &match, const Ex &re, size_t pos)
Search in a given string str starting at position pos for a match against regular expression re.
Definition regex.cpp:847
addRefItem
void addRefItem(const RefItemVector &sli, const DString &key, const DString &prefix, const DString &name, const DString &title, const DString &args, const Definition *scope)
Definition reflist.h:134
RefItemVector
std::vector< RefItem * > RefItemVector
Definition reflist.h:132
searchindex.h
Web server based search engine.
stripWhiteSpace
std::string_view stripWhiteSpace(std::string_view s)
Given a string view s, returns a new, narrower view on that string, skipping over any leading or trai...
Definition stringutil.h:75
CodeParserOptions
Options to configure the code parser.
Definition parserintf.h:77
DocOptions
Helper class to pass options when calling OutputList::generateDoc().
Definition docoptions.h:24
Example
Data associated with an example.
Definition example.h:29
Grouping::GroupPri_t
GroupPri_t
Grouping priority.
Definition types.h:230
Grouping::GROUPING_AUTO_DEF
@ GROUPING_AUTO_DEF
membership in group was defined via @defgroup
Definition types.h:234
LinkifyTextOptions
Definition linkifytext.h:44
LinkifyTextOptions::setScope
LinkifyTextOptions & setScope(const Definition *scope)
Definition linkifytext.h:58
LinkifyTextOptions::setSelf
LinkifyTextOptions & setSelf(const Definition *self)
Definition linkifytext.h:64
LinkifyTextOptions::setFileScope
LinkifyTextOptions & setFileScope(const FileDef *fileScope)
Definition linkifytext.h:61
CodeSymbolType
CodeSymbolType
Definition types.h:481
MemberType
MemberType
Definition types.h:569
MemberListContainer
MemberListContainer
Definition types.h:472
Protection
Protection
Definition types.h:32
SrcLangExt
SrcLangExt
Definition types.h:207
Relationship
Relationship
Definition types.h:167
Specifier
Specifier
Definition types.h:80
VhdlSpecifier
VhdlSpecifier
Definition types.h:770
stripExtension
DString stripExtension(const DString &fName)
Definition util.cpp:3957
substituteTemplateArgumentsInString
DString substituteTemplateArgumentsInString(const DString &nm, const ArgumentList &formalArgs, const ArgumentList *actualArgs)
Definition util.cpp:3526
inlineArgListToDoc
DString inlineArgListToDoc(const ArgumentList &al)
Definition util.cpp:4867
protectionLevelVisible
bool protectionLevelVisible(Protection prot)
Definition util.cpp:4673
stripFromIncludePath
DString stripFromIncludePath(const DString &path)
Definition util.cpp:229
detab
DString detab(const DString &s, size_t &refIndent)
Definition util.cpp:5181
stripIndentationVerbatim
void stripIndentationVerbatim(DString &doc, size_t indentationLevel, bool skipFirstLine)
Definition util.cpp:4774
writeTypeConstraints
void writeTypeConstraints(OutputList &ol, const Definition *d, const ArgumentList &al)
Definition util.cpp:4285
removeRedundantWhiteSpace
DString removeRedundantWhiteSpace(const DString &s)
Definition util.cpp:428
tempArgListToString
DString tempArgListToString(const ArgumentList &al, SrcLangExt lang, bool includeDefault)
Definition util.cpp:905
getLanguageFromFileName
SrcLangExt getLanguageFromFileName(const DString &fileName, SrcLangExt defLang)
Definition util.cpp:4170
matchArguments2
bool matchArguments2(const Definition *srcScope, const FileDef *srcFileScope, const DString &srcReturnType, const ArgumentList *srcAl, const Definition *dstScope, const FileDef *dstFileScope, const DString &dstReturnType, const ArgumentList *dstAl, bool checkCV, SrcLangExt lang)
Definition util.cpp:1591
addHtmlExtensionIfMissing
void addHtmlExtensionIfMissing(DString &fName)
Definition util.cpp:3933
convertToXML
DString convertToXML(const DString &s, bool keepEntities, const bool citeEntry)
Definition util.cpp:3234
getLanguageSpecificSeparator
DString getLanguageSpecificSeparator(SrcLangExt lang, bool classScope)
Definition util.cpp:4631
removeAnonymousScopes
DString removeAnonymousScopes(const DString &str)
Definition util.cpp:100
writeMarkerList
void writeMarkerList(OutputList &ol, const std::string &markerText, size_t numMarkers, std::function< void(size_t)> replaceFunc)
Definition util.cpp:755
inlineTemplateArgListToDoc
DString inlineTemplateArgListToDoc(const ArgumentList &al)
Definition util.cpp:834
writeExamples
void writeExamples(OutputList &ol, const ExampleList &list)
Definition util.cpp:806
util.h
A bunch of utility functions.