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