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