Doxygen
Loading...
Searching...
No Matches
DefinitionAliasMixin< Base > Class Template Reference

#include <src/definitionimpl.h>

Inheritance diagram for DefinitionAliasMixin< Base >:
Collaboration diagram for DefinitionAliasMixin< Base >:

Public Member Functions

 DefinitionAliasMixin (const Definition *scope, const Definition *alias)
 ~DefinitionAliasMixin () override=default
void init ()
void deinit ()
bool isAlias () const override
const DString & name () const override
bool isAnonymous () const override
const DString & localName () const override
DString qualifiedName () const override
DString symbolName () const override
DString getSourceFileBase () const override
DString getSourceAnchor () const override
DString documentation () const override
int docLine () const override
DString docFile () const override
DString briefDescription (bool abbreviate=false) const override
DString briefDescriptionAsTooltip () const override
int briefLine () const override
DString inbodyDocumentation () const override
DString inbodyFile () const override
int inbodyLine () const override
DString briefFile () const override
DString getDefFileName () const override
DString getDefFileExtension () const override
int getDefLine () const override
int getDefColumn () const override
bool hasDocumentation () const override
bool hasUserDocumentation () const override
bool isVisibleInProject () const override
bool isVisible () const override
bool isHidden () const override
bool isArtificial () const override
bool isExported () const override
DString getReference () const override
bool isReference () const override
DString externalReference (const DString &relPath) const override
int getStartDefLine () const override
int getStartBodyLine () const override
int getEndBodyLine () const override
const FileDef * getBodyDef () const override
SrcLangExt getLanguage () const override
const GroupList & partOfGroups () const override
bool isLinkableViaGroup () const override
const RefItemVector & xrefListItems () const override
const RequirementRefs & requirementReferences () const override
const Definition * findInnerCompound (const DString &name) const override
Definition * getOuterScope () const override
const MemberVector & getReferencesMembers () const override
const MemberVector & getReferencedByMembers () const override
bool hasSections () const override
bool hasSources () const override
bool hasBriefDescription () const override
DString id () const override
const SectionRefs & getSectionRefs () const override
DString navigationPathAsString () const override
DString pathFragment () const override

Protected Member Functions

const Definition * getAlias () const
const Definition * getScope () const

Private Member Functions

virtual Definition * toDefinition_ ()
DefinitionMutable * toDefinitionMutable_ () override
const DefinitionImpl * toDefinitionImpl_ () const override
void _setSymbolName (const DString &name) override
DString _symbolName () const override

Private Attributes

DefinitionAliasImpl m_impl
const Definition * m_scope
const Definition * m_alias
DString m_symbolName

Detailed Description

template<class Base>
class DefinitionAliasMixin< Base >

Definition at line 334 of file definitionimpl.h.

Constructor & Destructor Documentation

◆ DefinitionAliasMixin()

template<class Base>
DefinitionAliasMixin< Base >::DefinitionAliasMixin ( const Definition * scope,
const Definition * alias )
inline

Definition at line 337 of file definitionimpl.h.

338 : m_impl(this,scope,alias), m_scope(scope), m_alias(alias) {}
DefinitionAliasMixin::m_scope
const Definition * m_scope
Definition definitionimpl.h:464
DefinitionAliasMixin::m_alias
const Definition * m_alias
Definition definitionimpl.h:465
DefinitionAliasMixin::m_impl
DefinitionAliasImpl m_impl
Definition definitionimpl.h:463

References m_alias, m_impl, and m_scope.

Referenced by ~DefinitionAliasMixin().

◆ ~DefinitionAliasMixin()

template<class Base>
DefinitionAliasMixin< Base >::~DefinitionAliasMixin ( )
overridedefault

References DefinitionAliasMixin(), and NON_COPYABLE.

Member Function Documentation

◆ _setSymbolName()

template<class Base>
void DefinitionAliasMixin< Base >::_setSymbolName ( const DString & name)
inlineoverrideprivate

Definition at line 461 of file definitionimpl.h.

461{ m_symbolName = name; }
DefinitionAliasMixin::name
const DString & name() const override
Definition definitionimpl.h:349

References m_symbolName, and name().

◆ _symbolName()

template<class Base>
DString DefinitionAliasMixin< Base >::_symbolName ( ) const
inlineoverrideprivate

Definition at line 462 of file definitionimpl.h.

462{ return m_symbolName; }

References m_symbolName.

◆ briefDescription()

template<class Base>
DString DefinitionAliasMixin< Base >::briefDescription ( bool abbreviate = false) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 369 of file definitionimpl.h.

370 { return m_alias->briefDescription(abbreviate); }

References Definition::briefDescription(), and m_alias.

◆ briefDescriptionAsTooltip()

template<class Base>
DString DefinitionAliasMixin< Base >::briefDescriptionAsTooltip ( ) const
inlineoverride

Definition at line 371 of file definitionimpl.h.

372 { return m_alias->briefDescriptionAsTooltip(); }

References Definition::briefDescriptionAsTooltip(), and m_alias.

◆ briefFile()

template<class Base>
DString DefinitionAliasMixin< Base >::briefFile ( ) const
inlineoverride

Definition at line 381 of file definitionimpl.h.

382 { return m_alias->briefFile(); }

References Definition::briefFile(), and m_alias.

◆ briefLine()

template<class Base>
int DefinitionAliasMixin< Base >::briefLine ( ) const
inlineoverride

Definition at line 373 of file definitionimpl.h.

374 { return m_alias->briefLine(); }

References Definition::briefLine(), and m_alias.

◆ deinit()

template<class Base>
void DefinitionAliasMixin< Base >::deinit ( )
inline

Definition at line 343 of file definitionimpl.h.

343{ m_impl.deinit(); }

References DefinitionAliasImpl::deinit(), and m_impl.

◆ docFile()

template<class Base>
DString DefinitionAliasMixin< Base >::docFile ( ) const
inlineoverride

Definition at line 367 of file definitionimpl.h.

368 { return m_alias->docFile(); }

References Definition::docFile(), and m_alias.

◆ docLine()

template<class Base>
int DefinitionAliasMixin< Base >::docLine ( ) const
inlineoverride

Definition at line 365 of file definitionimpl.h.

366 { return m_alias->docLine(); }

References Definition::docLine(), and m_alias.

◆ documentation()

template<class Base>
DString DefinitionAliasMixin< Base >::documentation ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 363 of file definitionimpl.h.

364 { return m_alias->documentation(); }

References Definition::documentation(), and m_alias.

◆ externalReference()

template<class Base>
DString DefinitionAliasMixin< Base >::externalReference ( const DString & relPath) const
inlineoverride

Definition at line 409 of file definitionimpl.h.

410 { return m_alias->externalReference(relPath); }

References Definition::externalReference(), and m_alias.

◆ findInnerCompound()

template<class Base>
const Definition * DefinitionAliasMixin< Base >::findInnerCompound ( const DString & name) const
inlineoverride

Reimplemented in NamespaceDefAliasImpl.

Definition at line 429 of file definitionimpl.h.

430 { return m_alias->findInnerCompound(name); }

References Definition::findInnerCompound(), m_alias, and name().

◆ getAlias()

template<class Base>
const Definition * DefinitionAliasMixin< Base >::getAlias ( ) const
inlineprotected

Definition at line 453 of file definitionimpl.h.

453{ return m_alias; }

References m_alias.

◆ getBodyDef()

template<class Base>
const FileDef * DefinitionAliasMixin< Base >::getBodyDef ( ) const
inlineoverride

Definition at line 417 of file definitionimpl.h.

418 { return m_alias->getBodyDef(); }

References Definition::getBodyDef(), and m_alias.

◆ getDefColumn()

template<class Base>
int DefinitionAliasMixin< Base >::getDefColumn ( ) const
inlineoverride

Definition at line 389 of file definitionimpl.h.

390 { return m_alias->getDefColumn(); }

References Definition::getDefColumn(), and m_alias.

◆ getDefFileExtension()

template<class Base>
DString DefinitionAliasMixin< Base >::getDefFileExtension ( ) const
inlineoverride

Definition at line 385 of file definitionimpl.h.

386 { return m_alias->getDefFileExtension(); }

References Definition::getDefFileExtension(), and m_alias.

◆ getDefFileName()

template<class Base>
DString DefinitionAliasMixin< Base >::getDefFileName ( ) const
inlineoverride

Definition at line 383 of file definitionimpl.h.

384 { return m_alias->getDefFileName(); }

References Definition::getDefFileName(), and m_alias.

◆ getDefLine()

template<class Base>
int DefinitionAliasMixin< Base >::getDefLine ( ) const
inlineoverride

Definition at line 387 of file definitionimpl.h.

388 { return m_alias->getDefLine(); }

References Definition::getDefLine(), and m_alias.

◆ getEndBodyLine()

template<class Base>
int DefinitionAliasMixin< Base >::getEndBodyLine ( ) const
inlineoverride

Definition at line 415 of file definitionimpl.h.

416 { return m_alias->getEndBodyLine(); }

References Definition::getEndBodyLine(), and m_alias.

◆ getLanguage()

template<class Base>
SrcLangExt DefinitionAliasMixin< Base >::getLanguage ( ) const
inlineoverride

Definition at line 419 of file definitionimpl.h.

420 { return m_alias->getLanguage(); }

References Definition::getLanguage(), and m_alias.

◆ getOuterScope()

template<class Base>
Definition * DefinitionAliasMixin< Base >::getOuterScope ( ) const
inlineoverride

Definition at line 431 of file definitionimpl.h.

432 { return const_cast<Definition*>(m_scope); }

References m_scope.

◆ getReference()

template<class Base>
DString DefinitionAliasMixin< Base >::getReference ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 405 of file definitionimpl.h.

406 { return m_alias->getReference(); }

References Definition::getReference(), and m_alias.

◆ getReferencedByMembers()

template<class Base>
const MemberVector & DefinitionAliasMixin< Base >::getReferencedByMembers ( ) const
inlineoverride

Definition at line 435 of file definitionimpl.h.

436 { return m_alias->getReferencedByMembers(); }

References Definition::getReferencedByMembers(), and m_alias.

◆ getReferencesMembers()

template<class Base>
const MemberVector & DefinitionAliasMixin< Base >::getReferencesMembers ( ) const
inlineoverride

Definition at line 433 of file definitionimpl.h.

434 { return m_alias->getReferencesMembers(); }

References Definition::getReferencesMembers(), and m_alias.

◆ getScope()

template<class Base>
const Definition * DefinitionAliasMixin< Base >::getScope ( ) const
inlineprotected

Definition at line 454 of file definitionimpl.h.

454{ return m_scope; }

References m_scope.

◆ getSectionRefs()

template<class Base>
const SectionRefs & DefinitionAliasMixin< Base >::getSectionRefs ( ) const
inlineoverride

Definition at line 445 of file definitionimpl.h.

446 { return m_alias->getSectionRefs(); }

References Definition::getSectionRefs(), and m_alias.

◆ getSourceAnchor()

template<class Base>
DString DefinitionAliasMixin< Base >::getSourceAnchor ( ) const
inlineoverride

Definition at line 361 of file definitionimpl.h.

362 { return m_alias->getSourceAnchor(); }

References Definition::getSourceAnchor(), and m_alias.

◆ getSourceFileBase()

template<class Base>
DString DefinitionAliasMixin< Base >::getSourceFileBase ( ) const
inlineoverride

Definition at line 359 of file definitionimpl.h.

360 { return m_alias->getSourceFileBase(); }

References Definition::getSourceFileBase(), and m_alias.

◆ getStartBodyLine()

template<class Base>
int DefinitionAliasMixin< Base >::getStartBodyLine ( ) const
inlineoverride

Definition at line 413 of file definitionimpl.h.

414 { return m_alias->getStartBodyLine(); }

References Definition::getStartBodyLine(), and m_alias.

◆ getStartDefLine()

template<class Base>
int DefinitionAliasMixin< Base >::getStartDefLine ( ) const
inlineoverride

Definition at line 411 of file definitionimpl.h.

412 { return m_alias->getStartDefLine(); }

References Definition::getStartDefLine(), and m_alias.

◆ hasBriefDescription()

template<class Base>
bool DefinitionAliasMixin< Base >::hasBriefDescription ( ) const
inlineoverride

Definition at line 441 of file definitionimpl.h.

442 { return m_alias->hasBriefDescription(); }

References Definition::hasBriefDescription(), and m_alias.

◆ hasDocumentation()

template<class Base>
bool DefinitionAliasMixin< Base >::hasDocumentation ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 391 of file definitionimpl.h.

392 { return m_alias->hasDocumentation(); }

References Definition::hasDocumentation(), and m_alias.

◆ hasSections()

template<class Base>
bool DefinitionAliasMixin< Base >::hasSections ( ) const
inlineoverride

Definition at line 437 of file definitionimpl.h.

438 { return m_alias->hasSections(); }

References Definition::hasSections(), and m_alias.

◆ hasSources()

template<class Base>
bool DefinitionAliasMixin< Base >::hasSources ( ) const
inlineoverride

Definition at line 439 of file definitionimpl.h.

440 { return m_alias->hasSources(); }

References Definition::hasSources(), and m_alias.

◆ hasUserDocumentation()

template<class Base>
bool DefinitionAliasMixin< Base >::hasUserDocumentation ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 393 of file definitionimpl.h.

394 { return m_alias->hasUserDocumentation(); }

References Definition::hasUserDocumentation(), and m_alias.

◆ id()

template<class Base>
DString DefinitionAliasMixin< Base >::id ( ) const
inlineoverride

Definition at line 443 of file definitionimpl.h.

444 { return m_alias->id(); }

References Definition::id(), and m_alias.

◆ inbodyDocumentation()

template<class Base>
DString DefinitionAliasMixin< Base >::inbodyDocumentation ( ) const
inlineoverride

Definition at line 375 of file definitionimpl.h.

376 { return m_alias->inbodyDocumentation(); }

References Definition::inbodyDocumentation(), and m_alias.

◆ inbodyFile()

template<class Base>
DString DefinitionAliasMixin< Base >::inbodyFile ( ) const
inlineoverride

Definition at line 377 of file definitionimpl.h.

378 { return m_alias->inbodyFile(); }

References Definition::inbodyFile(), and m_alias.

◆ inbodyLine()

template<class Base>
int DefinitionAliasMixin< Base >::inbodyLine ( ) const
inlineoverride

Definition at line 379 of file definitionimpl.h.

380 { return m_alias->inbodyLine(); }

References Definition::inbodyLine(), and m_alias.

◆ init()

template<class Base>
void DefinitionAliasMixin< Base >::init ( )
inline

Definition at line 342 of file definitionimpl.h.

342{ m_impl.init(); }

References DefinitionAliasImpl::init(), init(), and m_impl.

Referenced by init().

◆ isAlias()

template<class Base>
bool DefinitionAliasMixin< Base >::isAlias ( ) const
inlineoverride

Definition at line 346 of file definitionimpl.h.

346{ return true; }

◆ isAnonymous()

template<class Base>
bool DefinitionAliasMixin< Base >::isAnonymous ( ) const
inlineoverride

Definition at line 351 of file definitionimpl.h.

352 { return m_alias->isAnonymous(); }

References Definition::isAnonymous(), and m_alias.

◆ isArtificial()

template<class Base>
bool DefinitionAliasMixin< Base >::isArtificial ( ) const
inlineoverride

Definition at line 401 of file definitionimpl.h.

402 { return m_alias->isArtificial(); }

References Definition::isArtificial(), and m_alias.

◆ isExported()

template<class Base>
bool DefinitionAliasMixin< Base >::isExported ( ) const
inlineoverride

Definition at line 403 of file definitionimpl.h.

404 { return m_alias->isExported(); }

References Definition::isExported(), and m_alias.

◆ isHidden()

template<class Base>
bool DefinitionAliasMixin< Base >::isHidden ( ) const
inlineoverride

Definition at line 399 of file definitionimpl.h.

400 { return m_alias->isHidden(); }

References Definition::isHidden(), and m_alias.

◆ isLinkableViaGroup()

template<class Base>
bool DefinitionAliasMixin< Base >::isLinkableViaGroup ( ) const
inlineoverride

Definition at line 423 of file definitionimpl.h.

424 { return m_alias->isLinkableViaGroup(); }

References Definition::isLinkableViaGroup(), and m_alias.

◆ isReference()

template<class Base>
bool DefinitionAliasMixin< Base >::isReference ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 407 of file definitionimpl.h.

408 { return m_alias->isReference(); }

References Definition::isReference(), and m_alias.

◆ isVisible()

template<class Base>
bool DefinitionAliasMixin< Base >::isVisible ( ) const
inlineoverride

Definition at line 397 of file definitionimpl.h.

398 { return m_alias->isVisible(); }

References Definition::isVisible(), and m_alias.

◆ isVisibleInProject()

template<class Base>
bool DefinitionAliasMixin< Base >::isVisibleInProject ( ) const
inlineoverride

Definition at line 395 of file definitionimpl.h.

396 { return m_alias->isVisibleInProject(); }

References Definition::isVisibleInProject(), and m_alias.

◆ localName()

template<class Base>
const DString & DefinitionAliasMixin< Base >::localName ( ) const
inlineoverride

Reimplemented in NamespaceDefAliasImpl.

Definition at line 353 of file definitionimpl.h.

354 { return m_alias->localName(); }

References Definition::localName(), and m_alias.

◆ name()

template<class Base>
const DString & DefinitionAliasMixin< Base >::name ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 349 of file definitionimpl.h.

350 { return m_impl.name(); }

References m_impl, and DefinitionAliasImpl::name().

Referenced by _setSymbolName(), and findInnerCompound().

◆ navigationPathAsString()

template<class Base>
DString DefinitionAliasMixin< Base >::navigationPathAsString ( ) const
inlineoverride

Definition at line 447 of file definitionimpl.h.

448 { return m_alias->navigationPathAsString(); }

References m_alias, and Definition::navigationPathAsString().

◆ partOfGroups()

template<class Base>
const GroupList & DefinitionAliasMixin< Base >::partOfGroups ( ) const
inlineoverride

Definition at line 421 of file definitionimpl.h.

422 { return m_alias->partOfGroups(); }

References m_alias, and Definition::partOfGroups().

◆ pathFragment()

template<class Base>
DString DefinitionAliasMixin< Base >::pathFragment ( ) const
inlineoverride

Definition at line 449 of file definitionimpl.h.

450 { return m_alias->pathFragment(); }

References m_alias, and Definition::pathFragment().

◆ qualifiedName()

template<class Base>
DString DefinitionAliasMixin< Base >::qualifiedName ( ) const
inlineoverride

Reimplemented in MemberDefAliasImpl.

Definition at line 355 of file definitionimpl.h.

356 { return m_impl.qualifiedName(); }

References m_impl, and DefinitionAliasImpl::qualifiedName().

◆ requirementReferences()

template<class Base>
const RequirementRefs & DefinitionAliasMixin< Base >::requirementReferences ( ) const
inlineoverride

Definition at line 427 of file definitionimpl.h.

428 { return m_alias->requirementReferences(); }

References m_alias, and Definition::requirementReferences().

◆ symbolName()

template<class Base>
DString DefinitionAliasMixin< Base >::symbolName ( ) const
inlineoverride

Definition at line 357 of file definitionimpl.h.

358 { return m_alias->symbolName(); }

References m_alias, and Definition::symbolName().

◆ toDefinition_()

template<class Base>
virtual Definition * DefinitionAliasMixin< Base >::toDefinition_ ( )
inlineprivatevirtual

Definition at line 457 of file definitionimpl.h.

457{ return this; }

◆ toDefinitionImpl_()

template<class Base>
const DefinitionImpl * DefinitionAliasMixin< Base >::toDefinitionImpl_ ( ) const
inlineoverrideprivate

Definition at line 459 of file definitionimpl.h.

459{ return nullptr; }

◆ toDefinitionMutable_()

template<class Base>
DefinitionMutable * DefinitionAliasMixin< Base >::toDefinitionMutable_ ( )
inlineoverrideprivate

Definition at line 458 of file definitionimpl.h.

458{ return nullptr; }

◆ xrefListItems()

template<class Base>
const RefItemVector & DefinitionAliasMixin< Base >::xrefListItems ( ) const
inlineoverride

Definition at line 425 of file definitionimpl.h.

426 { return m_alias->xrefListItems(); }

References m_alias, and Definition::xrefListItems().

Member Data Documentation

◆ m_alias

template<class Base>
const Definition* DefinitionAliasMixin< Base >::m_alias
private

Definition at line 465 of file definitionimpl.h.

Referenced by briefDescription(), briefDescriptionAsTooltip(), briefFile(), briefLine(), DefinitionAliasMixin(), docFile(), docLine(), documentation(), externalReference(), findInnerCompound(), getAlias(), getBodyDef(), getDefColumn(), getDefFileExtension(), getDefFileName(), getDefLine(), getEndBodyLine(), getLanguage(), getReference(), getReferencedByMembers(), getReferencesMembers(), getSectionRefs(), getSourceAnchor(), getSourceFileBase(), getStartBodyLine(), getStartDefLine(), hasBriefDescription(), hasDocumentation(), hasSections(), hasSources(), hasUserDocumentation(), id(), inbodyDocumentation(), inbodyFile(), inbodyLine(), isAnonymous(), isArtificial(), isExported(), isHidden(), isLinkableViaGroup(), isReference(), isVisible(), isVisibleInProject(), localName(), navigationPathAsString(), partOfGroups(), pathFragment(), requirementReferences(), symbolName(), and xrefListItems().

◆ m_impl

template<class Base>
DefinitionAliasImpl DefinitionAliasMixin< Base >::m_impl
private

Definition at line 463 of file definitionimpl.h.

Referenced by DefinitionAliasMixin(), deinit(), init(), name(), and qualifiedName().

◆ m_scope

template<class Base>
const Definition* DefinitionAliasMixin< Base >::m_scope
private

Definition at line 464 of file definitionimpl.h.

Referenced by DefinitionAliasMixin(), getOuterScope(), and getScope().

◆ m_symbolName

template<class Base>
DString DefinitionAliasMixin< Base >::m_symbolName
private

Definition at line 466 of file definitionimpl.h.

Referenced by _setSymbolName(), and _symbolName().

The documentation for this class was generated from the following file: