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