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