Doxygen
Loading...
Searching...
No Matches
definitionimpl.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * Copyright (C) 1997-2026 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#ifndef DEFINITIONIMPL_H
17#define DEFINITIONIMPL_H
18
19#include <memory>
20#include <string>
21#include <unordered_map>
22
23#include "definition.h"
24
25class DefinitionImpl
26{
27 public:
28 DefinitionImpl(
29 Definition *def,
30 const DString &defFileName,int defLine,size_t defColumn,
31 const DString &name,const char *b=nullptr,const char *d=nullptr,
32 bool isSymbol=true);
33 ~DefinitionImpl();
34 DefinitionImpl(const DefinitionImpl &d);
35 DefinitionImpl &operator=(const DefinitionImpl &d);
36 DefinitionImpl(DefinitionImpl &&d) = delete;
37 DefinitionImpl &operator=(DefinitionImpl &&d) = delete;
38
39 const DString &name() const;
40 bool isAnonymous() const;
41 const DString &localName() const;
42 DString qualifiedName() const;
43 DString symbolName() const;
44 DString getSourceFileBase() const;
45 DString getSourceAnchor() const;
46 DString documentation() const;
47 int docLine() const;
48 DString docFile() const;
49 DString briefDescription(bool abbreviate=false) const;
50 DString briefDescriptionAsTooltip() const;
51 int briefLine() const;
52 DString inbodyDocumentation() const;
53 DString inbodyFile() const;
54 int inbodyLine() const;
55 DString briefFile() const;
56 DString getDefFileName() const;
57 DString getDefFileExtension() const;
58 int getDefLine() const;
59 size_t getDefColumn() const;
60 bool hasDocumentation() const;
61 bool hasUserDocumentation() const;
62 bool isVisibleInProject() const;
63 bool isVisible() const;
64 bool isHidden() const;
65 bool isArtificial() const;
66 bool isExported() const;
67 DString getReference() const;
68 bool isReference() const;
69 DString externalReference(const DString &relPath) const;
70 int getStartDefLine() const;
71 int getStartBodyLine() const;
72 int getEndBodyLine() const;
73 const FileDef *getBodyDef() const;
74 SrcLangExt getLanguage() const;
75 const GroupList &partOfGroups() const;
76 bool isLinkableViaGroup() const;
77 const RefItemVector &xrefListItems() const;
78 const RequirementRefs &requirementReferences() const;
79 const Definition *findInnerCompound(const DString &name) const;
80 Definition *getOuterScope() const;
81 const MemberVector &getReferencesMembers() const;
82 const MemberVector &getReferencedByMembers() const;
83 bool hasSections() const;
84 bool hasSources() const;
85 bool hasBriefDescription() const;
86 DString id() const;
87 const SectionRefs &getSectionRefs() const;
88 void setName(const DString &name);
89 void setId(const DString &name);
90 void setDefFile(const DString& df,int defLine,size_t defColumn);
91 void setDocumentation(const DString &d,const DString &docFile,int docLine,bool stripWhiteSpace=true);
92 void setBriefDescription(const DString &b,const DString &briefFile,int briefLine);
93 void setInbodyDocumentation(const DString &d,const DString &docFile,int docLine);
94 void setReference(const DString &r);
95 void addSectionsToDefinition(const std::vector<const SectionInfo*> &anchorList);
96 void setBodySegment(int defLine,int bls,int ble);
97 void setBodyDef(const FileDef *fd);
98 void addSourceReferencedBy(MemberDef *d,const DString &sourceRefName);
99 void addSourceReferences(MemberDef *d,const DString &sourceRefName);
100 void setRefItems(const RefItemVector &sli);
101 void setRequirementReferences(const RequirementRefs &rqli);
102 void mergeRefItems(Definition *d);
103 void mergeReferences(const Definition *other);
104 void mergeReferencedBy(const Definition *other);
105 void addInnerCompound(Definition *d);
106 void setOuterScope(Definition *d);
107 void setHidden(bool b);
108 void setArtificial(bool b);
109 void setExported(bool b);
110 void setLanguage(SrcLangExt lang);
111 void writeSourceDef(OutputList &ol) const;
112 void writeInlineCode(OutputList &ol,const DString &scopeName) const;
113 bool hasSourceRefs() const;
114 bool hasSourceReffedBy() const;
115 void writeSourceRefs(OutputList &ol,const DString &scopeName) const;
116 void writeSourceReffedBy(OutputList &ol,const DString &scopeName) const;
117 bool hasRequirementRefs() const;
118 void writeRequirementRefs(OutputList &ol) const;
119 void makePartOfGroup(GroupDef *gd);
120 void writeNavigationPath(OutputList &ol) const;
121 DString navigationPathAsString() const;
122 void writeQuickMemberLinks(OutputList &,const MemberDef *) const;
123 void writeSummaryLinks(OutputList &) const;
124 void writePageNavigation(OutputList &ol) const;
125 DString pathFragment() const;
126 void writeDocAnchorsToTagFile(TextStream &) const;
127 void setLocalName(const DString &name);
128 void writeToc(OutputList &ol, const LocalToc &lt) const;
129 void computeTooltip();
130 void _setSymbolName(const DString &name);
131 DString _symbolName() const;
132
133
134 private:
135
136 int _getXRefListId(const DString &listName) const;
137 void _writeSourceRefList(OutputList &ol,const DString &scopeName,const DString &text,
138 const std::unordered_map<std::string,MemberDef *> &members,bool) const;
139 void _setBriefDescription(const DString &b,const DString &briefFile,int briefLine);
140 void _setDocumentation(const DString &d,const DString &docFile,int docLine,bool stripWhiteSpace,bool atTop);
141 void _setInbodyDocumentation(const DString &d,const DString &docFile,int docLine);
142 bool _docsAlreadyAdded(const DString &doc,DString &sigList);
143
144 // PIMPL idiom
145 class Private;
146 std::unique_ptr<Private> p; // internal structure holding all private data
147};
148
149template<class Base>
150class DefinitionMixin : public Base
151{
152 public:
153 /*! Create a new definition */
154 DefinitionMixin(
155 const DString &defFileName,int defLine,size_t defColumn,
156 const DString &name,const char *b=nullptr,const char *d=nullptr,
157 bool isSymbol=true) : m_impl(this,defFileName,defLine,defColumn,name,b,d,isSymbol) {}
158 DefinitionMixin(const DefinitionMixin &other) : Base(other), m_impl(other.m_impl) {}
159 DefinitionMixin &operator=(const DefinitionMixin &other) { if (this!=&other) { m_impl = other.m_impl; }; return *this; }
160 DefinitionMixin(DefinitionMixin &&) = delete;
161 DefinitionMixin &operator=(DefinitionMixin &&) = delete;
162 ~DefinitionMixin() override = default;
163
164 bool isAlias() const override { return false; }
165
166 //======== Definition
167 const DString &name() const override { return m_impl.name(); }
168 bool isAnonymous() const override { return m_impl.isAnonymous(); }
169 const DString &localName() const override { return m_impl.localName(); }
170 DString qualifiedName() const override { return m_impl.qualifiedName(); }
171 DString symbolName() const override { return m_impl.symbolName(); }
172 DString getSourceFileBase() const override { return m_impl.getSourceFileBase(); }
173 DString getSourceAnchor() const override { return m_impl.getSourceAnchor(); }
174 DString documentation() const override { return m_impl.documentation(); }
175 int docLine() const override { return m_impl.docLine(); }
176 DString docFile() const override { return m_impl.docFile(); }
177 DString briefDescription(bool abbreviate=false) const override { return m_impl.briefDescription(abbreviate); }
178 DString briefDescriptionAsTooltip() const override { return m_impl.briefDescriptionAsTooltip(); }
179 int briefLine() const override { return m_impl.briefLine(); }
180 DString inbodyDocumentation() const override { return m_impl.inbodyDocumentation(); }
181 DString inbodyFile() const override { return m_impl.inbodyFile(); }
182 int inbodyLine() const override { return m_impl.inbodyLine(); }
183 DString briefFile() const override { return m_impl.briefFile(); }
184 DString getDefFileName() const override { return m_impl.getDefFileName(); }
185 DString getDefFileExtension() const override { return m_impl.getDefFileExtension(); }
186 int getDefLine() const override { return m_impl.getDefLine(); }
187 size_t getDefColumn() const override { return m_impl.getDefColumn(); }
188 bool hasDocumentation() const override { return m_impl.hasDocumentation(); }
189 bool hasUserDocumentation() const override { return m_impl.hasUserDocumentation(); }
190 bool isVisibleInProject() const override { return m_impl.isVisibleInProject(); }
191 bool isVisible() const override { return m_impl.isVisible(); }
192 bool isHidden() const override { return m_impl.isHidden(); }
193 bool isArtificial() const override { return m_impl.isArtificial(); }
194 bool isExported() const override { return m_impl.isExported(); }
195 DString getReference() const override { return m_impl.getReference(); }
196 bool isReference() const override { return m_impl.isReference(); }
197 DString externalReference(const DString &relPath) const override { return m_impl.externalReference(relPath); }
198 int getStartDefLine() const override { return m_impl.getStartDefLine(); }
199 int getStartBodyLine() const override { return m_impl.getStartBodyLine(); }
200 int getEndBodyLine() const override { return m_impl.getEndBodyLine(); }
201 const FileDef *getBodyDef() const override { return m_impl.getBodyDef(); }
202 SrcLangExt getLanguage() const override { return m_impl.getLanguage(); }
203 const GroupList &partOfGroups() const override { return m_impl.partOfGroups(); }
204 bool isLinkableViaGroup() const override { return m_impl.isLinkableViaGroup(); }
205 const RefItemVector &xrefListItems() const override { return m_impl.xrefListItems(); }
206 const RequirementRefs &requirementReferences() const override { return m_impl.requirementReferences(); }
207 const Definition *findInnerCompound(const DString &name) const override { return m_impl.findInnerCompound(name); }
208 Definition *getOuterScope() const override { return m_impl.getOuterScope(); }
209 const MemberVector &getReferencesMembers() const override { return m_impl.getReferencesMembers(); }
210 const MemberVector &getReferencedByMembers() const override { return m_impl.getReferencedByMembers(); }
211 bool hasSections() const override { return m_impl.hasSections(); }
212 bool hasSources() const override { return m_impl.hasSources(); }
213 bool hasBriefDescription() const override { return m_impl.hasBriefDescription(); }
214 DString id() const override { return m_impl.id(); }
215 const SectionRefs &getSectionRefs() const override { return m_impl.getSectionRefs(); }
216
217 //======== DefinitionMutable
218 void setName(const DString &name) override { m_impl.setName(name); }
219 void setId(const DString &name) override { m_impl.setId(name); }
220 void setDefFile(const DString& df,int defLine,size_t defColumn) override
221 { m_impl.setDefFile(df,defLine,defColumn); }
228 void setReference(const DString &r) override
229 { m_impl.setReference(r); }
230 void addSectionsToDefinition(const std::vector<const SectionInfo*> &anchorList) override
231 { m_impl.addSectionsToDefinition(anchorList); }
232 void setBodySegment(int defLine,int bls,int ble) override
233 { m_impl.setBodySegment(defLine,bls,ble); }
234 void setBodyDef(const FileDef *fd) override
235 { m_impl.setBodyDef(fd); }
236 void addSourceReferencedBy(MemberDef *md,const DString &sourceRefName) override
237 { m_impl.addSourceReferencedBy(md,sourceRefName); }
238 void addSourceReferences(MemberDef *md,const DString &sourceRefName) override
239 { m_impl.addSourceReferences(md,sourceRefName); }
240 void setRefItems(const RefItemVector &sli) override
241 { m_impl.setRefItems(sli); }
244 void mergeRefItems(Definition *def) override
245 { m_impl.mergeRefItems(def); }
246 void mergeReferences(const Definition *other) override
247 { m_impl.mergeReferences(other); }
248 void mergeReferencedBy(const Definition *other) override
249 { m_impl.mergeReferencedBy(other); }
250 void addInnerCompound(Definition *def) override
251 { m_impl.addInnerCompound(def); }
252 void setOuterScope(Definition *def) override
253 { m_impl.setOuterScope(def); }
254 void setHidden(bool b) override
255 { m_impl.setHidden(b); }
256 void setArtificial(bool b) override
257 { m_impl.setArtificial(b); }
258 void setExported(bool b) override
259 { m_impl.setExported(b); }
260 void setLanguage(SrcLangExt lang) override
261 { m_impl.setLanguage(lang); }
262 void writeSourceDef(OutputList &ol) const override
263 { m_impl.writeSourceDef(ol); }
264 void writeInlineCode(OutputList &ol,const DString &scopeName) const override
265 { m_impl.writeInlineCode(ol,scopeName); }
266 bool hasSourceRefs() const override
267 { return m_impl.hasSourceRefs(); }
268 bool hasSourceReffedBy() const override
269 { return m_impl.hasSourceReffedBy(); }
270 void writeSourceRefs(OutputList &ol,const DString &scopeName) const override
271 { m_impl.writeSourceRefs(ol,scopeName); }
272 void writeSourceReffedBy(OutputList &ol,const DString &scopeName) const override
273 { m_impl.writeSourceReffedBy(ol,scopeName); }
274 bool hasRequirementRefs() const override
275 { return m_impl.hasRequirementRefs(); }
276 void writeRequirementRefs(OutputList &ol) const override
277 { m_impl.writeRequirementRefs(ol); }
278 void makePartOfGroup(GroupDef *gd) override
279 { m_impl.makePartOfGroup(gd); }
280 void writeNavigationPath(OutputList &ol) const override
281 { m_impl.writeNavigationPath(ol); }
284 void writeQuickMemberLinks(OutputList &ol,const MemberDef *md) const override
285 { m_impl.writeQuickMemberLinks(ol,md); }
286 void writeSummaryLinks(OutputList &ol) const override
287 { m_impl.writeSummaryLinks(ol); }
288 void writePageNavigation(OutputList &ol) const override
289 { m_impl.writePageNavigation(ol); }
290 DString pathFragment() const override
291 { return m_impl.pathFragment(); }
294 void setLocalName(const DString &name) override
295 { m_impl.setLocalName(name); }
296 void writeToc(OutputList &ol, const LocalToc &lt) const override
297 { m_impl.writeToc(ol,lt); }
298 void computeTooltip() override
299 { m_impl.computeTooltip(); }
300 void _setSymbolName(const DString &name) override
301 { m_impl._setSymbolName(name); }
302 DString _symbolName() const override
303 { return m_impl._symbolName(); }
304
305 private:
306 Definition *toDefinition_() override { return this; }
307 DefinitionMutable *toDefinitionMutable_() override { return this; }
308 const DefinitionImpl *toDefinitionImpl_() const override { return &m_impl; }
309
310 DefinitionImpl m_impl;
311};
312
313class DefinitionAliasImpl
314{
315 public:
316 DefinitionAliasImpl(Definition *def,const Definition *scope,const Definition *alias);
317 virtual ~DefinitionAliasImpl();
318 NON_COPYABLE(DefinitionAliasImpl)
319
320 void init();
321 void deinit();
322 const DString &name() const;
323 DString qualifiedName() const;
324 private:
325 Definition *m_def;
326 const Definition *m_scope;
327 DString m_symbolName;
328 DString m_qualifiedName;
329};
330
331template<class Base>
332class DefinitionAliasMixin : public Base
333{
334 public:
335 DefinitionAliasMixin(const Definition *scope,const Definition *alias)
336 : m_impl(this,scope,alias), m_scope(scope), m_alias(alias) {}
337 ~DefinitionAliasMixin() override = default;
338 NON_COPYABLE(DefinitionAliasMixin)
339
340 void init() { m_impl.init(); }
341 void deinit() { m_impl.deinit(); }
342
343
344 bool isAlias() const override { return true; }
345
346 //======== Definition
347 const DString &name() const override
348 { return m_impl.name(); }
349 bool isAnonymous() const override
350 { return m_alias->isAnonymous(); }
351 const DString &localName() const override
352 { return m_alias->localName(); }
353 DString qualifiedName() const override
354 { return m_impl.qualifiedName(); }
355 DString symbolName() const override
356 { return m_alias->symbolName(); }
357 DString getSourceFileBase() const override
358 { return m_alias->getSourceFileBase(); }
359 DString getSourceAnchor() const override
360 { return m_alias->getSourceAnchor(); }
361 DString documentation() const override
362 { return m_alias->documentation(); }
363 int docLine() const override
364 { return m_alias->docLine(); }
365 DString docFile() const override
366 { return m_alias->docFile(); }
367 DString briefDescription(bool abbreviate=false) const override
368 { return m_alias->briefDescription(abbreviate); }
371 int briefLine() const override
372 { return m_alias->briefLine(); }
373 DString inbodyDocumentation() const override
374 { return m_alias->inbodyDocumentation(); }
375 DString inbodyFile() const override
376 { return m_alias->inbodyFile(); }
377 int inbodyLine() const override
378 { return m_alias->inbodyLine(); }
379 DString briefFile() const override
380 { return m_alias->briefFile(); }
381 DString getDefFileName() const override
382 { return m_alias->getDefFileName(); }
383 DString getDefFileExtension() const override
384 { return m_alias->getDefFileExtension(); }
385 int getDefLine() const override
386 { return m_alias->getDefLine(); }
387 size_t getDefColumn() const override
388 { return m_alias->getDefColumn(); }
389 bool hasDocumentation() const override
390 { return m_alias->hasDocumentation(); }
391 bool hasUserDocumentation() const override
392 { return m_alias->hasUserDocumentation(); }
393 bool isVisibleInProject() const override
394 { return m_alias->isVisibleInProject(); }
395 bool isVisible() const override
396 { return m_alias->isVisible(); }
397 bool isHidden() const override
398 { return m_alias->isHidden(); }
399 bool isArtificial() const override
400 { return m_alias->isArtificial(); }
401 bool isExported() const override
402 { return m_alias->isExported(); }
403 DString getReference() const override
404 { return m_alias->getReference(); }
405 bool isReference() const override
406 { return m_alias->isReference(); }
407 DString externalReference(const DString &relPath) const override
408 { return m_alias->externalReference(relPath); }
409 int getStartDefLine() const override
410 { return m_alias->getStartDefLine(); }
411 int getStartBodyLine() const override
412 { return m_alias->getStartBodyLine(); }
413 int getEndBodyLine() const override
414 { return m_alias->getEndBodyLine(); }
415 const FileDef *getBodyDef() const override
416 { return m_alias->getBodyDef(); }
417 SrcLangExt getLanguage() const override
418 { return m_alias->getLanguage(); }
419 const GroupList &partOfGroups() const override
420 { return m_alias->partOfGroups(); }
421 bool isLinkableViaGroup() const override
422 { return m_alias->isLinkableViaGroup(); }
423 const RefItemVector &xrefListItems() const override
424 { return m_alias->xrefListItems(); }
425 const RequirementRefs &requirementReferences() const override
426 { return m_alias->requirementReferences(); }
427 const Definition *findInnerCompound(const DString &name) const override
428 { return m_alias->findInnerCompound(name); }
429 Definition *getOuterScope() const override
430 { return const_cast<Definition*>(m_scope); }
431 const MemberVector &getReferencesMembers() const override
432 { return m_alias->getReferencesMembers(); }
433 const MemberVector &getReferencedByMembers() const override
434 { return m_alias->getReferencedByMembers(); }
435 bool hasSections() const override
436 { return m_alias->hasSections(); }
437 bool hasSources() const override
438 { return m_alias->hasSources(); }
439 bool hasBriefDescription() const override
440 { return m_alias->hasBriefDescription(); }
441 DString id() const override
442 { return m_alias->id(); }
443 const SectionRefs &getSectionRefs() const override
444 { return m_alias->getSectionRefs(); }
447 DString pathFragment() const override
448 { return m_alias->pathFragment(); }
449
450 protected:
451 const Definition *getAlias() const { return m_alias; }
452 const Definition *getScope() const { return m_scope; }
453
454 private:
455 virtual Definition *toDefinition_() { return this; }
456 DefinitionMutable *toDefinitionMutable_() override { return nullptr; }
457 const DefinitionImpl *toDefinitionImpl_() const override { return nullptr; }
458
459 void _setSymbolName(const DString &name) override { m_symbolName = name; }
460 DString _symbolName() const override { return m_symbolName; }
461 DefinitionAliasImpl m_impl;
462 const Definition *m_scope;
463 const Definition *m_alias;
464 DString m_symbolName;
465};
466
467#endif
DString
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:88
DefinitionAliasImpl::DefinitionAliasImpl
DefinitionAliasImpl(Definition *def, const Definition *scope, const Definition *alias)
Definition definition.cpp:1943
DefinitionAliasImpl::m_scope
const Definition * m_scope
Definition definitionimpl.h:326
DefinitionAliasImpl::qualifiedName
DString qualifiedName() const
Definition definition.cpp:1973
DefinitionAliasImpl::~DefinitionAliasImpl
virtual ~DefinitionAliasImpl()
Definition definition.cpp:1948
DefinitionAliasImpl::name
const DString & name() const
Definition definition.cpp:1978
DefinitionAliasMixin::_setSymbolName
void _setSymbolName(const DString &name) override
Definition definitionimpl.h:459
DefinitionAliasMixin::getDefLine
int getDefLine() const override
Definition definitionimpl.h:385
DefinitionAliasMixin::hasSections
bool hasSections() const override
Definition definitionimpl.h:435
DefinitionAliasMixin::toDefinitionMutable_
DefinitionMutable * toDefinitionMutable_() override
Definition definitionimpl.h:456
DefinitionAliasMixin::getReferencesMembers
const MemberVector & getReferencesMembers() const override
Definition definitionimpl.h:431
DefinitionAliasMixin::inbodyLine
int inbodyLine() const override
Definition definitionimpl.h:377
DefinitionAliasMixin::localName
const DString & localName() const override
Definition definitionimpl.h:351
DefinitionAliasMixin::briefLine
int briefLine() const override
Definition definitionimpl.h:371
DefinitionAliasMixin::toDefinition_
virtual Definition * toDefinition_()
Definition definitionimpl.h:455
DefinitionAliasMixin::symbolName
DString symbolName() const override
Definition definitionimpl.h:355
DefinitionAliasMixin::_symbolName
DString _symbolName() const override
Definition definitionimpl.h:460
DefinitionAliasMixin::~DefinitionAliasMixin
~DefinitionAliasMixin() override=default
DefinitionAliasMixin::toDefinitionImpl_
const DefinitionImpl * toDefinitionImpl_() const override
Definition definitionimpl.h:457
DefinitionAliasMixin::pathFragment
DString pathFragment() const override
Definition definitionimpl.h:447
DefinitionAliasMixin::getLanguage
SrcLangExt getLanguage() const override
Definition definitionimpl.h:417
DefinitionAliasMixin::isLinkableViaGroup
bool isLinkableViaGroup() const override
Definition definitionimpl.h:421
DefinitionAliasMixin::navigationPathAsString
DString navigationPathAsString() const override
Definition definitionimpl.h:445
DefinitionAliasMixin::getSourceAnchor
DString getSourceAnchor() const override
Definition definitionimpl.h:359
DefinitionAliasMixin::m_scope
const Definition * m_scope
Definition definitionimpl.h:462
DefinitionAliasMixin::isExported
bool isExported() const override
Definition definitionimpl.h:401
DefinitionAliasMixin::name
const DString & name() const override
Definition definitionimpl.h:347
DefinitionAliasMixin::getSectionRefs
const SectionRefs & getSectionRefs() const override
Definition definitionimpl.h:443
DefinitionAliasMixin::getOuterScope
Definition * getOuterScope() const override
Definition definitionimpl.h:429
DefinitionAliasMixin::xrefListItems
const RefItemVector & xrefListItems() const override
Definition definitionimpl.h:423
DefinitionAliasMixin::hasSources
bool hasSources() const override
Definition definitionimpl.h:437
DefinitionAliasMixin::getStartBodyLine
int getStartBodyLine() const override
Definition definitionimpl.h:411
DefinitionAliasMixin::docLine
int docLine() const override
Definition definitionimpl.h:363
DefinitionAliasMixin::findInnerCompound
const Definition * findInnerCompound(const DString &name) const override
Definition definitionimpl.h:427
DefinitionAliasMixin::externalReference
DString externalReference(const DString &relPath) const override
Definition definitionimpl.h:407
DefinitionAliasMixin::getAlias
const Definition * getAlias() const
Definition definitionimpl.h:451
DefinitionAliasMixin::isVisible
bool isVisible() const override
Definition definitionimpl.h:395
DefinitionAliasMixin::m_alias
const Definition * m_alias
Definition definitionimpl.h:463
DefinitionAliasMixin::partOfGroups
const GroupList & partOfGroups() const override
Definition definitionimpl.h:419
DefinitionAliasMixin::briefFile
DString briefFile() const override
Definition definitionimpl.h:379
DefinitionAliasMixin::qualifiedName
DString qualifiedName() const override
Definition definitionimpl.h:353
DefinitionAliasMixin::getEndBodyLine
int getEndBodyLine() const override
Definition definitionimpl.h:413
DefinitionAliasMixin::getReference
DString getReference() const override
Definition definitionimpl.h:403
DefinitionAliasMixin::isReference
bool isReference() const override
Definition definitionimpl.h:405
DefinitionAliasMixin::getDefFileExtension
DString getDefFileExtension() const override
Definition definitionimpl.h:383
DefinitionAliasMixin::getScope
const Definition * getScope() const
Definition definitionimpl.h:452
DefinitionAliasMixin::briefDescriptionAsTooltip
DString briefDescriptionAsTooltip() const override
Definition definitionimpl.h:369
DefinitionAliasMixin::briefDescription
DString briefDescription(bool abbreviate=false) const override
Definition definitionimpl.h:367
DefinitionAliasMixin::getDefFileName
DString getDefFileName() const override
Definition definitionimpl.h:381
DefinitionAliasMixin::hasDocumentation
bool hasDocumentation() const override
Definition definitionimpl.h:389
DefinitionAliasMixin::getDefColumn
size_t getDefColumn() const override
Definition definitionimpl.h:387
DefinitionAliasMixin::getReferencedByMembers
const MemberVector & getReferencedByMembers() const override
Definition definitionimpl.h:433
DefinitionAliasMixin::id
DString id() const override
Definition definitionimpl.h:441
DefinitionAliasMixin::docFile
DString docFile() const override
Definition definitionimpl.h:365
DefinitionAliasMixin::isHidden
bool isHidden() const override
Definition definitionimpl.h:397
DefinitionAliasMixin::hasBriefDescription
bool hasBriefDescription() const override
Definition definitionimpl.h:439
DefinitionAliasMixin::documentation
DString documentation() const override
Definition definitionimpl.h:361
DefinitionAliasMixin::getStartDefLine
int getStartDefLine() const override
Definition definitionimpl.h:409
DefinitionAliasMixin::isVisibleInProject
bool isVisibleInProject() const override
Definition definitionimpl.h:393
DefinitionAliasMixin::inbodyFile
DString inbodyFile() const override
Definition definitionimpl.h:375
DefinitionAliasMixin::isAlias
bool isAlias() const override
Definition definitionimpl.h:344
DefinitionAliasMixin::hasUserDocumentation
bool hasUserDocumentation() const override
Definition definitionimpl.h:391
DefinitionAliasMixin::requirementReferences
const RequirementRefs & requirementReferences() const override
Definition definitionimpl.h:425
DefinitionAliasMixin::isAnonymous
bool isAnonymous() const override
Definition definitionimpl.h:349
DefinitionAliasMixin::isArtificial
bool isArtificial() const override
Definition definitionimpl.h:399
DefinitionAliasMixin::getSourceFileBase
DString getSourceFileBase() const override
Definition definitionimpl.h:357
DefinitionAliasMixin::inbodyDocumentation
DString inbodyDocumentation() const override
Definition definitionimpl.h:373
DefinitionAliasMixin::m_impl
DefinitionAliasImpl m_impl
Definition definitionimpl.h:461
DefinitionAliasMixin::getBodyDef
const FileDef * getBodyDef() const override
Definition definitionimpl.h:415
DefinitionAliasMixin::DefinitionAliasMixin
DefinitionAliasMixin(const Definition *scope, const Definition *alias)
Definition definitionimpl.h:335
Definition
The common base class of all entity definitions found in the sources.
Definition definition.h:77
Definition::briefDescription
virtual DString briefDescription(bool abbreviate=false) const =0
Definition::inbodyFile
virtual DString inbodyFile() const =0
Definition::isVisible
virtual bool isVisible() const =0
Definition::getEndBodyLine
virtual int getEndBodyLine() const =0
Definition::briefFile
virtual DString briefFile() const =0
Definition::getLanguage
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
Definition::externalReference
virtual DString externalReference(const DString &relPath) const =0
Definition::getDefFileExtension
virtual DString getDefFileExtension() const =0
Definition::hasSections
virtual bool hasSections() const =0
Definition::pathFragment
virtual DString pathFragment() const =0
Definition::isVisibleInProject
virtual bool isVisibleInProject() const =0
Definition::docLine
virtual int docLine() const =0
Definition::xrefListItems
virtual const RefItemVector & xrefListItems() const =0
Definition::getDefFileName
virtual DString getDefFileName() const =0
Definition::documentation
virtual DString documentation() const =0
Definition::inbodyDocumentation
virtual DString inbodyDocumentation() const =0
Definition::isLinkableViaGroup
virtual bool isLinkableViaGroup() const =0
Definition::getSourceAnchor
virtual DString getSourceAnchor() const =0
Definition::getDefLine
virtual int getDefLine() const =0
Definition::hasBriefDescription
virtual bool hasBriefDescription() const =0
returns true if this class has a brief description
Definition::getSectionRefs
virtual const SectionRefs & getSectionRefs() const =0
returns the section dictionary, only of importance for pagedef
Definition::localName
virtual const DString & localName() const =0
Definition::id
virtual DString id() const =0
Definition::briefDescriptionAsTooltip
virtual DString briefDescriptionAsTooltip() 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::symbolName
virtual DString symbolName() const =0
Definition::isExported
virtual bool isExported() const =0
Definition::getDefColumn
virtual size_t getDefColumn() const =0
Definition::hasSources
virtual bool hasSources() const =0
Definition::hasUserDocumentation
virtual bool hasUserDocumentation() const =0
Definition::isAnonymous
virtual bool isAnonymous() const =0
Definition::requirementReferences
virtual const RequirementRefs & requirementReferences() const =0
Definition::navigationPathAsString
virtual DString navigationPathAsString() const =0
Definition::isHidden
virtual bool isHidden() const =0
Definition::getStartDefLine
virtual int getStartDefLine() const =0
Definition::getReference
virtual DString getReference() const =0
Definition::partOfGroups
virtual const GroupList & partOfGroups() const =0
Definition::isArtificial
virtual bool isArtificial() const =0
Definition::docFile
virtual DString docFile() const =0
Definition::getSourceFileBase
virtual DString getSourceFileBase() const =0
Definition::getReferencedByMembers
virtual const MemberVector & getReferencedByMembers() const =0
Definition::getStartBodyLine
virtual int getStartBodyLine() const =0
Definition::isReference
virtual bool isReference() const =0
Definition::findInnerCompound
virtual const Definition * findInnerCompound(const DString &name) const =0
Definition::getReferencesMembers
virtual const MemberVector & getReferencesMembers() const =0
DefinitionImpl::Private
Private data associated with a Symbol DefinitionImpl object.
Definition definition.cpp:69
DefinitionImpl::addSourceReferencedBy
void addSourceReferencedBy(MemberDef *d, const DString &sourceRefName)
Definition definition.cpp:1254
DefinitionImpl::requirementReferences
const RequirementRefs & requirementReferences() const
Definition definition.cpp:1384
DefinitionImpl::setBodySegment
void setBodySegment(int defLine, int bls, int ble)
Definition definition.cpp:1016
DefinitionImpl::setExported
void setExported(bool b)
Definition definition.cpp:1855
DefinitionImpl::pathFragment
DString pathFragment() const
Definition definition.cpp:1389
DefinitionImpl::getDefLine
int getDefLine() const
Definition definition.cpp:1919
DefinitionImpl::setBriefDescription
void setBriefDescription(const DString &b, const DString &briefFile, int briefLine)
Definition definition.cpp:508
DefinitionImpl::isHidden
bool isHidden() const
Definition definition.cpp:1706
DefinitionImpl::writeSourceReffedBy
void writeSourceReffedBy(OutputList &ol, const DString &scopeName) const
Definition definition.cpp:1178
DefinitionImpl::mergeRefItems
void mergeRefItems(Definition *d)
Definition definition.cpp:1341
DefinitionImpl::hasRequirementRefs
bool hasRequirementRefs() const
Definition definition.cpp:1225
DefinitionImpl::navigationPathAsString
DString navigationPathAsString() const
Definition definition.cpp:1427
DefinitionImpl::writeInlineCode
void writeInlineCode(OutputList &ol, const DString &scopeName) const
Definition definition.cpp:1045
DefinitionImpl::DefinitionImpl
DefinitionImpl(Definition *def, const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
Definition definition.cpp:250
DefinitionImpl::getSourceAnchor
DString getSourceAnchor() const
Definition definition.cpp:947
DefinitionImpl::xrefListItems
const RefItemVector & xrefListItems() const
Definition definition.cpp:1379
DefinitionImpl::findInnerCompound
const Definition * findInnerCompound(const DString &name) const
Definition definition.cpp:1270
DefinitionImpl::writeSummaryLinks
void writeSummaryLinks(OutputList &) const
Definition definition.cpp:1933
DefinitionImpl::setHidden
void setHidden(bool b)
Definition definition.cpp:1845
DefinitionImpl::isReference
bool isReference() const
Definition definition.cpp:1736
DefinitionImpl::isVisible
bool isVisible() const
Definition definition.cpp:1716
DefinitionImpl::briefLine
int briefLine() const
Definition definition.cpp:1666
DefinitionImpl::_writeSourceRefList
void _writeSourceRefList(OutputList &ol, const DString &scopeName, const DString &text, const std::unordered_map< std::string, MemberDef * > &members, bool) const
Definition definition.cpp:1110
DefinitionImpl::externalReference
DString externalReference(const DString &relPath) const
Definition definition.cpp:1887
DefinitionImpl::addSectionsToDefinition
void addSectionsToDefinition(const std::vector< const SectionInfo * > &anchorList)
Definition definition.cpp:319
DefinitionImpl::isAnonymous
bool isAnonymous() const
Definition definition.cpp:1914
DefinitionImpl::isLinkableViaGroup
bool isLinkableViaGroup() const
Definition definition.cpp:1766
DefinitionImpl::_setInbodyDocumentation
void _setInbodyDocumentation(const DString &d, const DString &docFile, int docLine)
Definition definition.cpp:514
DefinitionImpl::briefDescriptionAsTooltip
DString briefDescriptionAsTooltip() const
Definition definition.cpp:1661
DefinitionImpl::getLanguage
SrcLangExt getLanguage() const
Definition definition.cpp:1840
DefinitionImpl::inbodyFile
DString inbodyFile() const
Definition definition.cpp:1688
DefinitionImpl::addInnerCompound
void addInnerCompound(Definition *d)
Definition definition.cpp:1275
DefinitionImpl::setArtificial
void setArtificial(bool b)
Definition definition.cpp:1850
DefinitionImpl::hasSourceReffedBy
bool hasSourceReffedBy() const
Definition definition.cpp:1215
DefinitionImpl::writeNavigationPath
void writeNavigationPath(OutputList &ol) const
Definition definition.cpp:1486
DefinitionImpl::setRefItems
void setRefItems(const RefItemVector &sli)
Definition definition.cpp:1331
DefinitionImpl::getStartBodyLine
int getStartBodyLine() const
Definition definition.cpp:1746
DefinitionImpl::writeSourceRefs
void writeSourceRefs(OutputList &ol, const DString &scopeName) const
Definition definition.cpp:1183
DefinitionImpl::setOuterScope
void setOuterScope(Definition *d)
Definition definition.cpp:1300
DefinitionImpl::getDefFileName
DString getDefFileName() const
Definition definition.cpp:1696
DefinitionImpl::operator=
DefinitionImpl & operator=(DefinitionImpl &&d)=delete
DefinitionImpl::_symbolName
DString _symbolName() const
Definition definition.cpp:1876
DefinitionImpl::getReferencesMembers
const MemberVector & getReferencesMembers() const
Definition definition.cpp:1782
DefinitionImpl::setBodyDef
void setBodyDef(const FileDef *fd)
Definition definition.cpp:1028
DefinitionImpl::symbolName
DString symbolName() const
Definition definition.cpp:1571
DefinitionImpl::docLine
int docLine() const
Definition definition.cpp:1583
DefinitionImpl::setDocumentation
void setDocumentation(const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace=true)
Definition definition.cpp:445
DefinitionImpl::getSourceFileBase
DString getSourceFileBase() const
Definition definition.cpp:934
DefinitionImpl::_setBriefDescription
void _setBriefDescription(const DString &b, const DString &briefFile, int briefLine)
Definition definition.cpp:451
DefinitionImpl::isArtificial
bool isArtificial() const
Definition definition.cpp:1721
DefinitionImpl::isExported
bool isExported() const
Definition definition.cpp:1726
DefinitionImpl::setId
void setId(const DString &name)
Definition definition.cpp:303
DefinitionImpl::id
DString id() const
Definition definition.cpp:314
DefinitionImpl::setLocalName
void setLocalName(const DString &name)
Definition definition.cpp:1860
DefinitionImpl::_getXRefListId
int _getXRefListId(const DString &listName) const
Definition definition.cpp:1367
DefinitionImpl::writeQuickMemberLinks
void writeQuickMemberLinks(OutputList &, const MemberDef *) const
Definition definition.cpp:1929
DefinitionImpl::partOfGroups
const GroupList & partOfGroups() const
Definition definition.cpp:1761
DefinitionImpl::hasUserDocumentation
bool hasUserDocumentation() const
Definition definition.cpp:1245
DefinitionImpl::setReference
void setReference(const DString &r)
Definition definition.cpp:1835
DefinitionImpl::docFile
DString docFile() const
Definition definition.cpp:1588
DefinitionImpl::localName
const DString & localName() const
Definition definition.cpp:1321
DefinitionImpl::inbodyLine
int inbodyLine() const
Definition definition.cpp:1683
DefinitionImpl::inbodyDocumentation
DString inbodyDocumentation() const
Definition definition.cpp:1678
DefinitionImpl::hasBriefDescription
bool hasBriefDescription() const
Definition definition.cpp:1881
DefinitionImpl::hasSources
bool hasSources() const
Definition definition.cpp:1037
DefinitionImpl::_docsAlreadyAdded
bool _docsAlreadyAdded(const DString &doc, DString &sigList)
Definition definition.cpp:379
DefinitionImpl::getSectionRefs
const SectionRefs & getSectionRefs() const
Definition definition.cpp:1566
DefinitionImpl::DefinitionImpl
DefinitionImpl(DefinitionImpl &&d)=delete
DefinitionImpl::operator=
DefinitionImpl & operator=(const DefinitionImpl &d)
Definition definition.cpp:277
DefinitionImpl::isVisibleInProject
bool isVisibleInProject() const
Definition definition.cpp:1711
DefinitionImpl::getDefFileExtension
DString getDefFileExtension() const
Definition definition.cpp:1701
DefinitionImpl::qualifiedName
DString qualifiedName() const
Definition definition.cpp:1280
DefinitionImpl::_setSymbolName
void _setSymbolName(const DString &name)
Definition definition.cpp:1871
DefinitionImpl::makePartOfGroup
void makePartOfGroup(GroupDef *gd)
Definition definition.cpp:1326
DefinitionImpl::setDefFile
void setDefFile(const DString &df, int defLine, size_t defColumn)
Definition definition.cpp:160
DefinitionImpl::mergeReferencedBy
void mergeReferencedBy(const Definition *other)
Definition definition.cpp:1818
DefinitionImpl::getStartDefLine
int getStartDefLine() const
Definition definition.cpp:1741
DefinitionImpl::documentation
DString documentation() const
Definition definition.cpp:1578
DefinitionImpl::setName
void setName(const DString &name)
Definition definition.cpp:294
DefinitionImpl::getReference
DString getReference() const
Definition definition.cpp:1731
DefinitionImpl::hasSourceRefs
bool hasSourceRefs() const
Definition definition.cpp:1220
DefinitionImpl::writeToc
void writeToc(OutputList &ol, const LocalToc &lt) const
Definition definition.cpp:1502
DefinitionImpl::addSourceReferences
void addSourceReferences(MemberDef *d, const DString &sourceRefName)
Definition definition.cpp:1262
DefinitionImpl::writePageNavigation
void writePageNavigation(OutputList &ol) const
Definition definition.cpp:1937
DefinitionImpl::getBodyDef
const FileDef * getBodyDef() const
Definition definition.cpp:1756
DefinitionImpl::writeSourceDef
void writeSourceDef(OutputList &ol) const
Definition definition.cpp:967
DefinitionImpl::_setDocumentation
void _setDocumentation(const DString &d, const DString &docFile, int docLine, bool stripWhiteSpace, bool atTop)
Definition definition.cpp:398
DefinitionImpl::setLanguage
void setLanguage(SrcLangExt lang)
Definition definition.cpp:1865
DefinitionImpl::name
const DString & name() const
Definition definition.cpp:1909
DefinitionImpl::mergeReferences
void mergeReferences(const Definition *other)
Definition definition.cpp:1802
DefinitionImpl::p
std::unique_ptr< Private > p
Definition definitionimpl.h:146
DefinitionImpl::hasSections
bool hasSections() const
Definition definition.cpp:341
DefinitionImpl::getDefColumn
size_t getDefColumn() const
Definition definition.cpp:1924
DefinitionImpl::setRequirementReferences
void setRequirementReferences(const RequirementRefs &rqli)
Definition definition.cpp:1336
DefinitionImpl::hasDocumentation
bool hasDocumentation() const
Definition definition.cpp:1230
DefinitionImpl::setInbodyDocumentation
void setInbodyDocumentation(const DString &d, const DString &docFile, int docLine)
Definition definition.cpp:536
DefinitionImpl::briefDescription
DString briefDescription(bool abbreviate=false) const
Definition definition.cpp:1642
DefinitionImpl::getOuterScope
Definition * getOuterScope() const
Definition definition.cpp:1775
DefinitionImpl::briefFile
DString briefFile() const
Definition definition.cpp:1671
DefinitionImpl::getReferencedByMembers
const MemberVector & getReferencedByMembers() const
Definition definition.cpp:1792
DefinitionImpl::getEndBodyLine
int getEndBodyLine() const
Definition definition.cpp:1751
DefinitionImpl::writeDocAnchorsToTagFile
void writeDocAnchorsToTagFile(TextStream &) const
Definition definition.cpp:355
DefinitionImpl::writeRequirementRefs
void writeRequirementRefs(OutputList &ol) const
Definition definition.cpp:1188
DefinitionMixin::getDefLine
int getDefLine() const override
Definition definitionimpl.h:186
DefinitionMixin::isReference
bool isReference() const override
Definition definitionimpl.h:196
DefinitionMixin::docFile
DString docFile() const override
Definition definitionimpl.h:176
DefinitionMixin::writeSourceDef
void writeSourceDef(OutputList &ol) const override
Definition definitionimpl.h:262
DefinitionMixin::setBodySegment
void setBodySegment(int defLine, int bls, int ble) override
Definition definitionimpl.h:232
DefinitionMixin::hasUserDocumentation
bool hasUserDocumentation() const override
Definition definitionimpl.h:189
DefinitionMixin::toDefinitionMutable_
DefinitionMutable * toDefinitionMutable_() override
Definition definitionimpl.h:307
DefinitionMixin::qualifiedName
DString qualifiedName() const override
Definition definitionimpl.h:170
DefinitionMixin::requirementReferences
const RequirementRefs & requirementReferences() const override
Definition definitionimpl.h:206
DefinitionMixin::setId
void setId(const DString &name) override
Definition definitionimpl.h:219
DefinitionMixin::_setSymbolName
void _setSymbolName(const DString &name) override
Definition definitionimpl.h:300
DefinitionMixin::isVisibleInProject
bool isVisibleInProject() const override
Definition definitionimpl.h:190
DefinitionMixin::writeNavigationPath
void writeNavigationPath(OutputList &ol) const override
Definition definitionimpl.h:280
DefinitionMixin::isLinkableViaGroup
bool isLinkableViaGroup() const override
Definition definitionimpl.h:204
DefinitionMixin::isExported
bool isExported() const override
Definition definitionimpl.h:194
DefinitionMixin::getSourceAnchor
DString getSourceAnchor() const override
Definition definitionimpl.h:173
DefinitionMixin::addSectionsToDefinition
void addSectionsToDefinition(const std::vector< const SectionInfo * > &anchorList) override
Definition definitionimpl.h:230
DefinitionMixin::operator=
DefinitionMixin & operator=(DefinitionMixin &&)=delete
DefinitionMixin::hasBriefDescription
bool hasBriefDescription() const override
Definition definitionimpl.h:213
DefinitionMixin::operator=
DefinitionMixin & operator=(const DefinitionMixin &other)
Definition definitionimpl.h:159
DefinitionMixin::setDefFile
void setDefFile(const DString &df, int defLine, size_t defColumn) override
Definition definitionimpl.h:220
DefinitionMixin::id
DString id() const override
Definition definitionimpl.h:214
DefinitionMixin::briefFile
DString briefFile() const override
Definition definitionimpl.h:183
DefinitionMixin::addInnerCompound
void addInnerCompound(Definition *def) override
Definition definitionimpl.h:250
DefinitionMixin::addSourceReferencedBy
void addSourceReferencedBy(MemberDef *md, const DString &sourceRefName) override
Definition definitionimpl.h:236
DefinitionMixin::hasSources
bool hasSources() const override
Definition definitionimpl.h:212
DefinitionMixin::hasRequirementRefs
bool hasRequirementRefs() const override
Definition definitionimpl.h:274
DefinitionMixin::briefDescription
DString briefDescription(bool abbreviate=false) const override
Definition definitionimpl.h:177
DefinitionMixin::name
const DString & name() const override
Definition definitionimpl.h:167
DefinitionMixin::setName
void setName(const DString &name) override
Definition definitionimpl.h:218
DefinitionMixin::writePageNavigation
void writePageNavigation(OutputList &ol) const override
Definition definitionimpl.h:288
DefinitionMixin::isAnonymous
bool isAnonymous() const override
Definition definitionimpl.h:168
DefinitionMixin::setLanguage
void setLanguage(SrcLangExt lang) override
Definition definitionimpl.h:260
DefinitionMixin::_symbolName
DString _symbolName() const override
Definition definitionimpl.h:302
DefinitionMixin::inbodyFile
DString inbodyFile() const override
Definition definitionimpl.h:181
DefinitionMixin::setOuterScope
void setOuterScope(Definition *def) override
Definition definitionimpl.h:252
DefinitionMixin::getReferencedByMembers
const MemberVector & getReferencedByMembers() const override
Definition definitionimpl.h:210
DefinitionMixin::addSourceReferences
void addSourceReferences(MemberDef *md, const DString &sourceRefName) override
Definition definitionimpl.h:238
DefinitionMixin::getReference
DString getReference() const override
Definition definitionimpl.h:195
DefinitionMixin::makePartOfGroup
void makePartOfGroup(GroupDef *gd) override
Definition definitionimpl.h:278
DefinitionMixin::writeRequirementRefs
void writeRequirementRefs(OutputList &ol) const override
Definition definitionimpl.h:276
DefinitionMixin::~DefinitionMixin
~DefinitionMixin() override=default
DefinitionMixin::setInbodyDocumentation
void setInbodyDocumentation(const DString &doc, const DString &docFile, int docLine) override
Definition definitionimpl.h:226
DefinitionMixin::mergeReferences
void mergeReferences(const Definition *other) override
Definition definitionimpl.h:246
DefinitionMixin::setArtificial
void setArtificial(bool b) override
Definition definitionimpl.h:256
DefinitionMixin::xrefListItems
const RefItemVector & xrefListItems() const override
Definition definitionimpl.h:205
DefinitionMixin::setExported
void setExported(bool b) override
Definition definitionimpl.h:258
DefinitionMixin::getReferencesMembers
const MemberVector & getReferencesMembers() const override
Definition definitionimpl.h:209
DefinitionMixin::hasSourceReffedBy
bool hasSourceReffedBy() const override
Definition definitionimpl.h:268
DefinitionMixin::toDefinitionImpl_
const DefinitionImpl * toDefinitionImpl_() const override
Definition definitionimpl.h:308
DefinitionMixin::getDefColumn
size_t getDefColumn() const override
Definition definitionimpl.h:187
DefinitionMixin::navigationPathAsString
DString navigationPathAsString() const override
Definition definitionimpl.h:282
DefinitionMixin::getOuterScope
Definition * getOuterScope() const override
Definition definitionimpl.h:208
DefinitionMixin::findInnerCompound
const Definition * findInnerCompound(const DString &name) const override
Definition definitionimpl.h:207
DefinitionMixin::setBriefDescription
void setBriefDescription(const DString &brief, const DString &briefFile, int briefLine) override
Definition definitionimpl.h:224
DefinitionMixin::DefinitionMixin
DefinitionMixin(const DefinitionMixin &other)
Definition definitionimpl.h:158
DefinitionMixin::externalReference
DString externalReference(const DString &relPath) const override
Definition definitionimpl.h:197
DefinitionMixin::mergeReferencedBy
void mergeReferencedBy(const Definition *other) override
Definition definitionimpl.h:248
DefinitionMixin::getEndBodyLine
int getEndBodyLine() const override
Definition definitionimpl.h:200
DefinitionMixin::setBodyDef
void setBodyDef(const FileDef *fd) override
Definition definitionimpl.h:234
DefinitionMixin::setDocumentation
void setDocumentation(const DString &doc, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
Definition definitionimpl.h:222
DefinitionMixin::localName
const DString & localName() const override
Definition definitionimpl.h:169
DefinitionMixin::hasSourceRefs
bool hasSourceRefs() const override
Definition definitionimpl.h:266
DefinitionMixin::setReference
void setReference(const DString &r) override
Definition definitionimpl.h:228
DefinitionMixin::isVisible
bool isVisible() const override
Definition definitionimpl.h:191
DefinitionMixin::isHidden
bool isHidden() const override
Definition definitionimpl.h:192
DefinitionMixin::toDefinition_
Definition * toDefinition_() override
Definition definitionimpl.h:306
DefinitionMixin::computeTooltip
void computeTooltip() override
Definition definitionimpl.h:298
DefinitionMixin::mergeRefItems
void mergeRefItems(Definition *def) override
Definition definitionimpl.h:244
DefinitionMixin::getDefFileExtension
DString getDefFileExtension() const override
Definition definitionimpl.h:185
DefinitionMixin::getDefFileName
DString getDefFileName() const override
Definition definitionimpl.h:184
DefinitionMixin::documentation
DString documentation() const override
Definition definitionimpl.h:174
DefinitionMixin::partOfGroups
const GroupList & partOfGroups() const override
Definition definitionimpl.h:203
DefinitionMixin::DefinitionMixin
DefinitionMixin(const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
Definition definitionimpl.h:154
DefinitionMixin::isAlias
bool isAlias() const override
Definition definitionimpl.h:164
DefinitionMixin::getBodyDef
const FileDef * getBodyDef() const override
Definition definitionimpl.h:201
DefinitionMixin::inbodyDocumentation
DString inbodyDocumentation() const override
Definition definitionimpl.h:180
DefinitionMixin::getStartBodyLine
int getStartBodyLine() const override
Definition definitionimpl.h:199
DefinitionMixin::writeSourceReffedBy
void writeSourceReffedBy(OutputList &ol, const DString &scopeName) const override
Definition definitionimpl.h:272
DefinitionMixin::writeToc
void writeToc(OutputList &ol, const LocalToc &lt) const override
Definition definitionimpl.h:296
DefinitionMixin::getStartDefLine
int getStartDefLine() const override
Definition definitionimpl.h:198
DefinitionMixin::writeQuickMemberLinks
void writeQuickMemberLinks(OutputList &ol, const MemberDef *md) const override
Definition definitionimpl.h:284
DefinitionMixin::m_impl
DefinitionImpl m_impl
Definition definitionimpl.h:310
DefinitionMixin::hasSections
bool hasSections() const override
Definition definitionimpl.h:211
DefinitionMixin::setLocalName
void setLocalName(const DString &name) override
Definition definitionimpl.h:294
DefinitionMixin::docLine
int docLine() const override
Definition definitionimpl.h:175
DefinitionMixin::inbodyLine
int inbodyLine() const override
Definition definitionimpl.h:182
DefinitionMixin::writeInlineCode
void writeInlineCode(OutputList &ol, const DString &scopeName) const override
Definition definitionimpl.h:264
DefinitionMixin::writeSummaryLinks
void writeSummaryLinks(OutputList &ol) const override
Definition definitionimpl.h:286
DefinitionMixin::setHidden
void setHidden(bool b) override
Definition definitionimpl.h:254
DefinitionMixin::getSectionRefs
const SectionRefs & getSectionRefs() const override
Definition definitionimpl.h:215
DefinitionMixin::isArtificial
bool isArtificial() const override
Definition definitionimpl.h:193
DefinitionMixin::setRequirementReferences
void setRequirementReferences(const RequirementRefs &rqli) override
Definition definitionimpl.h:242
DefinitionMixin::pathFragment
DString pathFragment() const override
Definition definitionimpl.h:290
DefinitionMixin::briefLine
int briefLine() const override
Definition definitionimpl.h:179
DefinitionMixin::symbolName
DString symbolName() const override
Definition definitionimpl.h:171
DefinitionMixin::getSourceFileBase
DString getSourceFileBase() const override
Definition definitionimpl.h:172
DefinitionMixin::DefinitionMixin
DefinitionMixin(DefinitionMixin &&)=delete
DefinitionMixin::setRefItems
void setRefItems(const RefItemVector &sli) override
Definition definitionimpl.h:240
DefinitionMixin::briefDescriptionAsTooltip
DString briefDescriptionAsTooltip() const override
Definition definitionimpl.h:178
DefinitionMixin::writeDocAnchorsToTagFile
void writeDocAnchorsToTagFile(TextStream &fs) const override
Definition definitionimpl.h:292
DefinitionMixin::hasDocumentation
bool hasDocumentation() const override
Definition definitionimpl.h:188
DefinitionMixin::writeSourceRefs
void writeSourceRefs(OutputList &ol, const DString &scopeName) const override
Definition definitionimpl.h:270
DefinitionMixin::getLanguage
SrcLangExt getLanguage() const override
Definition definitionimpl.h:202
FileDef
A model of a file symbol.
Definition filedef.h:97
GroupDef
A model of a group of symbols.
Definition groupdef.h:48
MemberDef
A model of a class/file/namespace member symbol.
Definition memberdef.h:45
MemberVector
A vector of MemberDef object.
Definition memberlist.h:35
OutputList
Class representing a list of output generators that are written to in parallel.
Definition outputlist.h:311
SectionRefs
class that represents a list of constant references to sections.
Definition section.h:103
TextStream
Text streaming class that buffers data.
Definition textstream.h:36
NON_COPYABLE
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
Definition construct.h:37
RefItemVector
std::vector< RefItem * > RefItemVector
Definition reflist.h:132
RequirementRefs
std::vector< RequirementRef > RequirementRefs
List of requirement references.
Definition requirement.h:56
stripWhiteSpace
std::string_view stripWhiteSpace(std::string_view s)
Given a string view s, returns a new, narrower view on that string, skipping over any leading or trai...
Definition stringutil.h:75
SrcLangExt
SrcLangExt
Definition types.h:207