Doxygen
Loading...
Searching...
No Matches
NamespaceDefImpl Class Referencefinal
Inheritance diagram for NamespaceDefImpl:
Collaboration diagram for NamespaceDefImpl:

Public Member Functions

 NamespaceDefImpl (const DString &defFileName, int defLine, size_t defColumn, const DString &name, const DString &ref=DString(), const DString &refFile=DString(), const DString &type=DString(), bool isPublished=false)
 ~NamespaceDefImpl () override
DefType definitionType () const override
CodeSymbolType codeSymbolType () const override
DString getOutputFileBase () const override
DString anchor () const override
void insertUsedFile (FileDef *fd) override
void writeDocumentation (OutputList &ol) override
void writeMemberPages (OutputList &ol) override
void writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const override
void writeTagFile (TextStream &) override
void insertClass (ClassDef *cd) override
void insertConcept (ConceptDef *cd) override
void insertNamespace (NamespaceDef *nd) override
void insertMember (MemberDef *md) override
void computeAnchors () override
void countMembers () override
int numDocMembers () const override
void addUsingDirective (NamespaceDef *nd) override
const LinkedRefMap< NamespaceDef > & getUsedNamespaces () const override
void addUsingDeclaration (const Definition *cd) override
const LinkedRefMap< const Definition > & getUsedDefinitions () const override
void combineUsingRelations (NamespaceDefSet &visitedNamespace) override
DString displayName (bool=true) const override
void setInline (bool isInline) override
bool isConstantGroup () const override
bool isModule () const override
bool isLibrary () const override
bool isInline () const override
bool isLinkableInProject () const override
bool isLinkable () const override
bool isVisibleInHierarchy () const override
bool hasDetailedDescription () const override
void addMembersToMemberGroup () override
void distributeMemberGroupDocumentation () override
void findSectionsInDocumentation () override
void sortMemberLists () override
const Definition * findInnerCompound (const DString &name) const override
void addInnerCompound (Definition *d) override
void addListReferences () override
void addRequirementReferences () override
void setFileName (const DString &fn) override
bool subGrouping () const override
MemberList * getMemberList (MemberListType lt) const override
const MemberLists & getMemberLists () const override
const MemberDef * getMemberByName (const DString &) const override
const MemberGroupList & getMemberGroups () const override
ClassLinkedRefMap getClasses () const override
ClassLinkedRefMap getInterfaces () const override
ClassLinkedRefMap getStructs () const override
ClassLinkedRefMap getRecords () const override
ClassLinkedRefMap getExceptions () const override
NamespaceLinkedRefMap getNamespaces () const override
ConceptLinkedRefMap getConcepts () const override
void setName (const DString &name) override
DString title () const override
DString compoundTypeString () const override
void setIncludeFile (FileDef *fd, const DString &incName, bool local, bool force) override
void setMetaData (const DString &m) override
int countVisibleMembers () const override
void writeSummaryLinks (OutputList &ol) const override
void writePageNavigation (OutputList &ol) const override
Public Member Functions inherited from DefinitionMixin< NamespaceDefMutable >
 DefinitionMixin (const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
DefinitionMixin & operator= (const DefinitionMixin &other)
 ~DefinitionMixin () override=default
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
size_t 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
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
void setId (const DString &name) override
void setDefFile (const DString &df, int defLine, size_t defColumn) override
void setDocumentation (const DString &doc, const DString &docFile, int docLine, bool stripWhiteSpace=true) override
void setBriefDescription (const DString &brief, const DString &briefFile, int briefLine) override
void setInbodyDocumentation (const DString &doc, const DString &docFile, int docLine) override
void setReference (const DString &r) override
void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList) override
void setBodySegment (int defLine, int bls, int ble) override
void setBodyDef (const FileDef *fd) override
void addSourceReferencedBy (MemberDef *md, const DString &sourceRefName) override
void addSourceReferences (MemberDef *md, const DString &sourceRefName) override
void setRefItems (const RefItemVector &sli) override
void setRequirementReferences (const RequirementRefs &rqli) override
void mergeRefItems (Definition *def) override
void mergeReferences (const Definition *other) override
void mergeReferencedBy (const Definition *other) override
void setOuterScope (Definition *def) override
void setHidden (bool b) override
void setArtificial (bool b) override
void setExported (bool b) override
void setLanguage (SrcLangExt lang) override
void writeSourceDef (OutputList &ol) const override
void writeInlineCode (OutputList &ol, const DString &scopeName) const override
bool hasSourceRefs () const override
bool hasSourceReffedBy () const override
void writeSourceRefs (OutputList &ol, const DString &scopeName) const override
void writeSourceReffedBy (OutputList &ol, const DString &scopeName) const override
bool hasRequirementRefs () const override
void writeRequirementRefs (OutputList &ol) const override
void makePartOfGroup (GroupDef *gd) override
void writeNavigationPath (OutputList &ol) const override
DString navigationPathAsString () const override
DString pathFragment () const override
void writeDocAnchorsToTagFile (TextStream &fs) const override
void setLocalName (const DString &name) override
void writeToc (OutputList &ol, const LocalToc &lt) const override
void computeTooltip () override
void _setSymbolName (const DString &name) override
DString _symbolName () const override

Private Types

enum  { NAMESPACE , MODULE , CONSTANT_GROUP , LIBRARY }

Private Member Functions

void addMemberToList (MemberListType lt, MemberDef *md)
void writeMemberDeclarations (OutputList &ol, MemberListType lt, const DString &title)
void writeMemberDocumentation (OutputList &ol, MemberListType lt, const DString &title)
void writeDetailedDescription (OutputList &ol, const DString &title)
void writeBriefDescription (OutputList &ol)
void startMemberDeclarations (OutputList &ol)
void endMemberDeclarations (OutputList &ol)
void writeClassDeclarations (OutputList &ol, const DString &title, const ClassLinkedRefMap &d)
void writeConcepts (OutputList &ol, const DString &title)
void writeInlineClasses (OutputList &ol)
void writeMemberGroups (OutputList &ol)
void writeAuthorSection (OutputList &ol)
void startMemberDocumentation (OutputList &ol)
void endMemberDocumentation (OutputList &ol)
void addNamespaceAttributes (OutputList &ol)
void writeClassesToTagFile (TextStream &, const ClassLinkedRefMap &d)
void writeConceptsToTagFile (TextStream &)
void setFileNameLocal (const DString &fn)
void writeIncludeFiles (OutputList &ol) const
void writeNamespaceDeclarations (OutputList &ol, const DString &title, bool isConstantGroup=false)
void updateLocalName ()

Private Attributes

DString fileName
FileList files
LinkedRefMap< NamespaceDef > m_usingDirList
LinkedRefMap< const Definition > m_usingDeclList
LinkedRefMap< const Definition > m_innerCompounds
std::map< std::string, IncludeInfo > m_incInfo
MemberLinkedRefMap m_allMembers
MemberLists m_memberLists
MemberGroupList m_memberGroups
ClassLinkedRefMap m_classes
ClassLinkedRefMap m_interfaces
ClassLinkedRefMap m_structs
ClassLinkedRefMap m_records
ClassLinkedRefMap m_exceptions
ConceptLinkedRefMap m_concepts
NamespaceLinkedRefMap m_namespaces
bool m_subGrouping = false
enum { ... }  m_type
bool m_isPublished = false
DString metaData
bool m_inline = false

Additional Inherited Members

Public Types inherited from Definition
enum  DefType {
  TypeClass = 0 , TypeFile = 1 , TypeNamespace = 2 , TypeModule = 3 ,
  TypeMember = 4 , TypeGroup = 5 , TypePackage = 6 , TypePage = 7 ,
  TypeDir = 8 , TypeConcept = 9
}

Detailed Description

Definition at line 58 of file namespacedef.cpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
NAMESPACE 
MODULE 
CONSTANT_GROUP 
LIBRARY 

Definition at line 176 of file namespacedef.cpp.

enum NamespaceDefImpl::@152056333015234071026257214045103374127312105332 m_type

Constructor & Destructor Documentation

◆ NamespaceDefImpl()

NamespaceDefImpl::NamespaceDefImpl ( const DString & defFileName,
int defLine,
size_t defColumn,
const DString & name,
const DString & ref = DString(),
const DString & refFile = DString(),
const DString & type = DString(),
bool isPublished = false )

Definition at line 283 of file namespacedef.cpp.

286 :
287 DefinitionMixin(df,dl,dc,name)
288 ,m_isPublished(isPublished)
289{
290 if (!fName.empty())
291 {
292 if (!lref.empty())
293 {
294 fileName = stripExtension(fName);
295 }
296 else
297 {
299 }
300 }
301 else
302 {
304 }
305 setReference(lref);
306 m_inline=false;
307 m_subGrouping=Config_getBool(SUBGROUPING);
308 if (type=="module")
309 {
310 m_type = MODULE;
311 }
312 else if (type=="constants")
313 {
315 }
316 else if (type=="library")
317 {
318 m_type = LIBRARY;
319 }
320 else
321 {
323 }
324
326}
virtual const DString & name() const =0
void setReference(const DString &r) override
DefinitionMixin(const DString &defFileName, int defLine, size_t defColumn, const DString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=true)
void setFileNameLocal(const DString &fn)
#define Config_getBool(name)
Definition config.h:33
DString stripExtension(const DString &fName)
Definition util.cpp:3964
DString convertNameToFile(const DString &name, bool allowDots, bool allowUnderscore)
Definition util.cpp:2872

References DefinitionMixin< NamespaceDefMutable >::DefinitionMixin(), DString::empty(), m_isPublished, and DefinitionMixin< NamespaceDefMutable >::name().

◆ ~NamespaceDefImpl()

NamespaceDefImpl::~NamespaceDefImpl ( )
override

Definition at line 341 of file namespacedef.cpp.

342{
343}

Member Function Documentation

◆ addInnerCompound()

void NamespaceDefImpl::addInnerCompound ( Definition * d)
overridevirtual

Reimplemented from DefinitionMixin< NamespaceDefMutable >.

Definition at line 398 of file namespacedef.cpp.

399{
400 //printf("%s:NamespaceDefImpl::addInnerCompound(%s)\n",qPrint(name()),qPrint(d->name()));
403 {
405 }
407 {
409 }
411 {
413 }
414}
virtual DefType definitionType() const =0
virtual const DString & localName() const =0
bool add(const char *k, T *obj)
Definition linkedmap.h:284
void insertNamespace(NamespaceDef *nd) override
void insertClass(ClassDef *cd) override
void insertConcept(ConceptDef *cd) override
LinkedRefMap< const Definition > m_innerCompounds
ClassDef * toClassDef(Definition *d)
ConceptDef * toConceptDef(Definition *d)
NamespaceDef * toNamespaceDef(Definition *d)

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), Definition::definitionType(), insertClass(), insertConcept(), insertNamespace(), Definition::localName(), m_innerCompounds, toClassDef(), toConceptDef(), toNamespaceDef(), Definition::TypeClass, Definition::TypeConcept, and Definition::TypeNamespace.

◆ addListReferences()

void NamespaceDefImpl::addListReferences ( )
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1354 of file namespacedef.cpp.

1355{
1357 qualifiedName(),
1358 getLanguage()==SrcLangExt::Fortran ?
1359 theTranslator->trModule(true,true) :
1360 theTranslator->trNamespace(true,true),
1362 DString(),
1363 this
1364 );
1365 for (const auto &mg : m_memberGroups)
1366 {
1367 mg->addListReferences(this);
1368 }
1369 for (auto &ml : m_memberLists)
1370 {
1371 if (ml->listType().isDocumentation())
1372 {
1373 ml->addListReferences(this);
1374 }
1375 }
1376}
DString qualifiedName() const override
const RefItemVector & xrefListItems() const override
SrcLangExt getLanguage() const override
MemberGroupList m_memberGroups
DString getOutputFileBase() const override
DString displayName(bool=true) const override
MemberLists m_memberLists
virtual DString trNamespace(bool first_capital, bool singular)=0
virtual DString trModule(bool first_capital, bool singular)=0
Translator * theTranslator
Definition language.cpp:76
void addRefItem(const RefItemVector &sli, const DString &key, const DString &prefix, const DString &name, const DString &title, const DString &args, const Definition *scope)
Definition reflist.h:136

References addRefItem(), displayName(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), getOutputFileBase(), m_memberGroups, m_memberLists, DefinitionMixin< NamespaceDefMutable >::qualifiedName(), theTranslator, Translator::trModule(), Translator::trNamespace(), and DefinitionMixin< NamespaceDefMutable >::xrefListItems().

◆ addMembersToMemberGroup()

void NamespaceDefImpl::addMembersToMemberGroup ( )
overridevirtual

Implements NamespaceDefMutable.

Definition at line 505 of file namespacedef.cpp.

506{
507 for (auto &ml : m_memberLists)
508 {
509 if (ml->listType().isDeclaration())
510 {
512 }
513 }
514
515 // add members inside sections to their groups
516 for (const auto &mg : m_memberGroups)
517 {
518 if (mg->allMembersInSameSection() && m_subGrouping)
519 {
520 //printf("----> addToDeclarationSection(%s)\n",qPrint(mg->header()));
521 mg->addToDeclarationSection();
522 }
523 }
524}
void addMembersToMemberGroup() override

References addMembersToMemberGroup(), m_memberGroups, m_memberLists, and m_subGrouping.

Referenced by addMembersToMemberGroup().

◆ addMemberToList()

void NamespaceDefImpl::addMemberToList ( MemberListType lt,
MemberDef * md )
private

Definition at line 1550 of file namespacedef.cpp.

1551{
1552 bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
1553 bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
1555 ml->setNeedsSorting(
1556 (ml->listType().isDeclaration() && sortBriefDocs) ||
1557 (ml->listType().isDocumentation() && sortMemberDocs));
1558 ml->push_back(md);
1559
1560 if (ml->listType().isDeclaration())
1561 {
1562 MemberDefMutable *mdm = toMemberDefMutable(md);
1563 if (mdm)
1564 {
1565 mdm->setSectionList(this,ml.get());
1566 }
1567 }
1568}
virtual void setSectionList(const Definition *container, const MemberList *sl)=0
const std::unique_ptr< MemberList > & get(MemberListType lt, MemberListContainer con)
Definition memberlist.h:192
MemberDefMutable * toMemberDefMutable(Definition *d)

References Config_getBool, MemberLists::get(), m_memberLists, Namespace, MemberDefMutable::setSectionList(), and toMemberDefMutable().

Referenced by insertMember().

◆ addNamespaceAttributes()

void NamespaceDefImpl::addNamespaceAttributes ( OutputList & ol)
private

Definition at line 1023 of file namespacedef.cpp.

1024{
1025 // UNO IDL constant groups may be published
1026 if (getLanguage()==SrcLangExt::IDL && isConstantGroup() && m_isPublished)
1027 {
1028 ol.pushGeneratorState();
1030 ol.startLabels();
1031 ol.writeLabel("published",false);
1032 ol.endLabels();
1033 ol.popGeneratorState();
1034 }
1035 else if (isExported())
1036 {
1037 ol.pushGeneratorState();
1039 ol.startLabels();
1040 ol.writeLabel("export",false);
1041 ol.endLabels();
1042 ol.popGeneratorState();
1043 }
1044}
bool isConstantGroup() const override
void pushGeneratorState()
void disableAllBut(OutputType o)
void popGeneratorState()
void writeLabel(const DString &l, bool isLast)
Definition outputlist.h:736
void endLabels()
Definition outputlist.h:738
void startLabels()
Definition outputlist.h:734

References OutputList::disableAllBut(), OutputList::endLabels(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), Html, isConstantGroup(), DefinitionMixin< NamespaceDefMutable >::isExported(), m_isPublished, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startLabels(), and OutputList::writeLabel().

Referenced by writeDocumentation().

◆ addRequirementReferences()

void NamespaceDefImpl::addRequirementReferences ( )
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1378 of file namespacedef.cpp.

1379{
1381 for (const auto &mg : m_memberGroups)
1382 {
1383 mg->addRequirementReferences(this);
1384 }
1385 for (auto &ml : m_memberLists)
1386 {
1387 if (ml->listType().isDocumentation())
1388 {
1389 ml->addRequirementReferences(this);
1390 }
1391 }
1392}
static RequirementManager & instance()
void addRequirementRefsForSymbol(const Definition *symbol)

References RequirementManager::addRequirementRefsForSymbol(), RequirementManager::instance(), m_memberGroups, and m_memberLists.

◆ addUsingDeclaration()

void NamespaceDefImpl::addUsingDeclaration ( const Definition * cd)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1326 of file namespacedef.cpp.

1327{
1328 m_usingDeclList.add(d->qualifiedName(),d);
1329}
LinkedRefMap< const Definition > m_usingDeclList

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_usingDeclList, and Definition::qualifiedName().

Referenced by combineUsingRelations().

◆ addUsingDirective()

void NamespaceDefImpl::addUsingDirective ( NamespaceDef * nd)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1320 of file namespacedef.cpp.

1321{
1323 //printf("%s: NamespaceDefImpl::addUsingDirective: %s:%zu\n",qPrint(name()),qPrint(nd->qualifiedName()),m_usingDirList.size());
1324}
virtual DString qualifiedName() const =0
LinkedRefMap< NamespaceDef > m_usingDirList

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_usingDirList, and Definition::qualifiedName().

Referenced by combineUsingRelations().

◆ anchor()

DString NamespaceDefImpl::anchor ( ) const
inlineoverridevirtual

Returns the anchor within a page where this item can be found

Implements Definition.

Definition at line 72 of file namespacedef.cpp.

72{ return DString(); }

◆ codeSymbolType()

CodeSymbolType NamespaceDefImpl::codeSymbolType ( ) const
inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 69 of file namespacedef.cpp.

70 { return getLanguage()==SrcLangExt::Java ? CodeSymbolType::Package : CodeSymbolType::Namespace; }

References DefinitionMixin< NamespaceDefMutable >::getLanguage(), Namespace, and Package.

◆ combineUsingRelations()

void NamespaceDefImpl::combineUsingRelations ( NamespaceDefSet & visitedNamespace)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1399 of file namespacedef.cpp.

1400{
1401 if (visitedNamespaces.find(this)!=visitedNamespaces.end()) return; // already processed
1402 visitedNamespaces.insert(this);
1403
1404 LinkedRefMap<NamespaceDef> usingDirList = m_usingDirList;
1405 for (auto &nd : usingDirList)
1406 {
1407 NamespaceDefMutable *ndm = toNamespaceDefMutable(nd);
1408 if (ndm)
1409 {
1410 ndm->combineUsingRelations(visitedNamespaces);
1411 }
1412 }
1413
1414 for (auto &nd : usingDirList)
1415 {
1416 // add used namespaces of namespace nd to this namespace
1417 for (const auto &und : nd->getUsedNamespaces())
1418 {
1419 addUsingDirective(und);
1420 }
1421 // add used classes of namespace nd to this namespace
1422 for (const auto &ud : nd->getUsedDefinitions())
1423 {
1425 }
1426 }
1427}
void addUsingDirective(NamespaceDef *nd) override
void addUsingDeclaration(const Definition *cd) override
virtual void combineUsingRelations(NamespaceDefSet &visitedNamespace)=0
NamespaceDefMutable * toNamespaceDefMutable(Definition *d)

References addUsingDeclaration(), addUsingDirective(), NamespaceDefMutable::combineUsingRelations(), m_usingDirList, and toNamespaceDefMutable().

◆ compoundTypeString()

DString NamespaceDefImpl::compoundTypeString ( ) const
overridevirtual

Implements NamespaceDef.

Definition at line 1747 of file namespacedef.cpp.

1748{
1749 SrcLangExt lang = getLanguage();
1750 if (lang==SrcLangExt::Java)
1751 {
1752 return "package";
1753 }
1754 else if(lang==SrcLangExt::CSharp)
1755 {
1756 return "namespace";
1757 }
1758 else if (lang==SrcLangExt::Fortran)
1759 {
1760 return "module";
1761 }
1762 else if (lang==SrcLangExt::IDL)
1763 {
1764 if (isModule())
1765 {
1766 return "module";
1767 }
1768 else if (isConstantGroup())
1769 {
1770 return "constants";
1771 }
1772 else if (isLibrary())
1773 {
1774 return "library";
1775 }
1776 else
1777 {
1778 err_full(getDefFileName(),getDefLine(),"Internal inconsistency: namespace in IDL not module, library or constant group");
1779 }
1780 }
1781 return "namespace";
1782}
DString getDefFileName() const override
bool isLibrary() const override
bool isModule() const override
#define err_full(file, line, fmt,...)
Definition message.h:132
SrcLangExt
Definition types.h:207

References err_full, DefinitionMixin< NamespaceDefMutable >::getDefFileName(), DefinitionMixin< NamespaceDefMutable >::getDefLine(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), isConstantGroup(), isLibrary(), and isModule().

◆ computeAnchors()

void NamespaceDefImpl::computeAnchors ( )
overridevirtual

Implements NamespaceDefMutable.

Definition at line 655 of file namespacedef.cpp.

656{
657 MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
658 if (allMemberList) allMemberList->setAnchors();
659}
void setAnchors()
MemberList * getMemberList(MemberListType lt) const override

References getMemberList(), and MemberList::setAnchors().

◆ countMembers()

void NamespaceDefImpl::countMembers ( )
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1300 of file namespacedef.cpp.

1301{
1302 for (auto &ml : m_memberLists)
1303 {
1304 ml->countDecMembers();
1305 ml->countDocMembers();
1306 }
1307 for (const auto &mg : m_memberGroups)
1308 {
1309 mg->countDecMembers();
1310 mg->countDocMembers();
1311 }
1312}

References m_memberGroups, and m_memberLists.

◆ countVisibleMembers()

int NamespaceDefImpl::countVisibleMembers ( ) const
overridevirtual

Implements NamespaceDef.

Definition at line 1429 of file namespacedef.cpp.

1430{
1431 int count=0;
1432 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Namespace))
1433 {
1434 if (lde->kind()==LayoutDocEntry::MemberDef)
1435 {
1436 const LayoutDocEntryMemberDef *lmd = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get());
1437 if (lmd)
1438 {
1439 MemberList *ml = getMemberList(lmd->type);
1440 if (ml)
1441 {
1442 for (const auto &md : *ml)
1443 {
1444 if (md->visibleInIndex())
1445 {
1446 count++;
1447 }
1448 }
1449 }
1450 }
1451 }
1452 }
1453 return count;
1454}
static LayoutDocManager & instance()
Returns a reference to this singleton.
Definition layout.cpp:1476
MemberListType type
Definition layout.h:137

References getMemberList(), LayoutDocManager::instance(), and LayoutDocEntryMemberDef::type.

◆ definitionType()

DefType NamespaceDefImpl::definitionType ( ) const
inlineoverridevirtual

Use this for dynamic inspection of the type of the derived class

Implements Definition.

Definition at line 68 of file namespacedef.cpp.

68{ return TypeNamespace; }

References definitionType(), and Definition::TypeNamespace.

Referenced by definitionType().

◆ displayName()

DString NamespaceDefImpl::displayName ( bool includeScope = true) const
overridevirtual

Returns the name of the definition as it appears in the output

Implements Definition.

Definition at line 1394 of file namespacedef.cpp.

1395{
1396 return makeDisplayName(this,includeScope);
1397}
static DString makeDisplayName(const NamespaceDef *nd, bool includeScope)

References makeDisplayName().

Referenced by addListReferences(), title(), writeDocumentation(), writeMemberDocumentation(), and writeMemberPages().

◆ distributeMemberGroupDocumentation()

void NamespaceDefImpl::distributeMemberGroupDocumentation ( )
overridevirtual

Implements NamespaceDefMutable.

Definition at line 362 of file namespacedef.cpp.

363{
364 for (const auto &mg : m_memberGroups)
365 {
366 mg->distributeMemberGroupDocumentation();
367 }
368}

References m_memberGroups.

◆ endMemberDeclarations()

void NamespaceDefImpl::endMemberDeclarations ( OutputList & ol)
private

Definition at line 872 of file namespacedef.cpp.

873{
875}
void endMemberSections()
Definition outputlist.h:459

References OutputList::endMemberSections().

Referenced by writeDocumentation().

◆ endMemberDocumentation()

void NamespaceDefImpl::endMemberDocumentation ( OutputList & ol)
private

Definition at line 886 of file namespacedef.cpp.

887{
888 if (Config_getBool(SEPARATE_MEMBER_PAGES))
889 {
892 }
893}
static bool suppressDocWarnings
Definition doxygen.h:123
void enable(OutputType o)

References Config_getBool, OutputList::enable(), Html, and Doxygen::suppressDocWarnings.

Referenced by writeDocumentation().

◆ findInnerCompound()

const Definition * NamespaceDefImpl::findInnerCompound ( const DString & name) const
overridevirtual

Reimplemented from DefinitionMixin< NamespaceDefMutable >.

Definition at line 1336 of file namespacedef.cpp.

1337{
1338 if (n==nullptr) return nullptr;
1339 const Definition *d = m_innerCompounds.find(n);
1340 if (d==nullptr)
1341 {
1342 if (!m_usingDirList.empty())
1343 {
1344 d = m_usingDirList.find(n);
1345 }
1346 if (d==nullptr && !m_usingDeclList.empty())
1347 {
1348 d = m_usingDeclList.find(n);
1349 }
1350 }
1351 return d;
1352}
const T * find(const std::string &key) const
Definition linkedmap.h:243
bool empty() const
Definition linkedmap.h:374

References LinkedRefMap< T, Hash, KeyEqual, Map >::empty(), LinkedRefMap< T, Hash, KeyEqual, Map >::find(), m_innerCompounds, m_usingDeclList, and m_usingDirList.

◆ findSectionsInDocumentation()

void NamespaceDefImpl::findSectionsInDocumentation ( )
overridevirtual

Implements NamespaceDefMutable.

Definition at line 370 of file namespacedef.cpp.

371{
375 for (const auto &mg : m_memberGroups)
376 {
377 mg->findSectionsInDocumentation(this);
378 }
379 for (auto &ml : m_memberLists)
380 {
381 if (ml->listType().isDeclaration())
382 {
383 ml->findSectionsInDocumentation(this);
384 }
385 }
386}
DString briefDescription(bool abbreviate=false) const override
DString documentation() const override
DString inbodyDocumentation() const override
void docFindSections(const DString &input, const Definition *d, const DString &fileName)

References DefinitionMixin< NamespaceDefMutable >::briefDescription(), DefinitionMixin< NamespaceDefMutable >::docFile(), docFindSections(), DefinitionMixin< NamespaceDefMutable >::documentation(), DefinitionMixin< NamespaceDefMutable >::inbodyDocumentation(), m_memberGroups, and m_memberLists.

◆ getClasses()

ClassLinkedRefMap NamespaceDefImpl::getClasses ( ) const
inlineoverridevirtual

Returns the classes contained in this namespace

Implements NamespaceDef.

Definition at line 114 of file namespacedef.cpp.

114{ return m_classes; }
ClassLinkedRefMap m_classes

References m_classes.

◆ getConcepts()

ConceptLinkedRefMap NamespaceDefImpl::getConcepts ( ) const
inlineoverridevirtual

Returns the concepts contained in this namespace

Implements NamespaceDef.

Definition at line 120 of file namespacedef.cpp.

120{ return m_concepts; }
ConceptLinkedRefMap m_concepts

References m_concepts.

◆ getExceptions()

ClassLinkedRefMap NamespaceDefImpl::getExceptions ( ) const
inlineoverridevirtual

Returns the Slice exceptions contained in this namespace

Implements NamespaceDef.

Definition at line 118 of file namespacedef.cpp.

118{ return m_exceptions; }
ClassLinkedRefMap m_exceptions

References m_exceptions.

◆ getInterfaces()

ClassLinkedRefMap NamespaceDefImpl::getInterfaces ( ) const
inlineoverridevirtual

Returns the Slice interfaces contained in this namespace

Implements NamespaceDef.

Definition at line 115 of file namespacedef.cpp.

115{ return m_interfaces; }
ClassLinkedRefMap m_interfaces

References m_interfaces.

◆ getMemberByName()

const MemberDef * NamespaceDefImpl::getMemberByName ( const DString & n) const
overridevirtual

Implements NamespaceDef.

Definition at line 1701 of file namespacedef.cpp.

1702{
1703 return m_allMembers.find(n);
1704}
MemberLinkedRefMap m_allMembers

References LinkedRefMap< T, Hash, KeyEqual, Map >::find(), and m_allMembers.

◆ getMemberGroups()

const MemberGroupList & NamespaceDefImpl::getMemberGroups ( ) const
inlineoverridevirtual

Returns the user defined member groups

Implements NamespaceDef.

Definition at line 113 of file namespacedef.cpp.

113{ return m_memberGroups; }

References m_memberGroups.

◆ getMemberList()

MemberList * NamespaceDefImpl::getMemberList ( MemberListType lt) const
overridevirtual

Implements NamespaceDef.

Definition at line 1624 of file namespacedef.cpp.

1625{
1626 for (auto &ml : m_memberLists)
1627 {
1628 if (ml->listType()==lt)
1629 {
1630 return ml.get();
1631 }
1632 }
1633 return nullptr;
1634}

References m_memberLists.

Referenced by computeAnchors(), countVisibleMembers(), insertMember(), numDocMembers(), writeDocumentation(), writeMemberDeclarations(), writeMemberDocumentation(), writeQuickMemberLinks(), writeSummaryLinks(), and writeTagFile().

◆ getMemberLists()

const MemberLists & NamespaceDefImpl::getMemberLists ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 111 of file namespacedef.cpp.

111{ return m_memberLists; }

References m_memberLists.

◆ getNamespaces()

NamespaceLinkedRefMap NamespaceDefImpl::getNamespaces ( ) const
inlineoverridevirtual

Returns the namespaces contained in this namespace

Implements NamespaceDef.

Definition at line 119 of file namespacedef.cpp.

119{ return m_namespaces; }
NamespaceLinkedRefMap m_namespaces

References m_namespaces.

◆ getOutputFileBase()

DString NamespaceDefImpl::getOutputFileBase ( ) const
overridevirtual

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements Definition.

Definition at line 1331 of file namespacedef.cpp.

1332{
1333 return fileName;
1334}

References fileName.

Referenced by addListReferences(), writeBriefDescription(), writeDocumentation(), and writeTagFile().

◆ getRecords()

ClassLinkedRefMap NamespaceDefImpl::getRecords ( ) const
inlineoverridevirtual

Returns the recods contained in this namespace

Implements NamespaceDef.

Definition at line 117 of file namespacedef.cpp.

117{ return m_records; }
ClassLinkedRefMap m_records

References m_records.

◆ getStructs()

ClassLinkedRefMap NamespaceDefImpl::getStructs ( ) const
inlineoverridevirtual

Returns the Slice structs contained in this namespace

Implements NamespaceDef.

Definition at line 116 of file namespacedef.cpp.

116{ return m_structs; }
ClassLinkedRefMap m_structs

References m_structs.

◆ getUsedDefinitions()

const LinkedRefMap< const Definition > & NamespaceDefImpl::getUsedDefinitions ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 88 of file namespacedef.cpp.

88{ return m_usingDeclList; }

References m_usingDeclList.

◆ getUsedNamespaces()

const LinkedRefMap< NamespaceDef > & NamespaceDefImpl::getUsedNamespaces ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 86 of file namespacedef.cpp.

86{ return m_usingDirList; }

References m_usingDirList.

◆ hasDetailedDescription()

bool NamespaceDefImpl::hasDetailedDescription ( ) const
overridevirtual

Implements NamespaceDef.

Definition at line 661 of file namespacedef.cpp.

662{
663 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
664 return ((!briefDescription().empty() && repeatBrief) ||
665 !documentation().empty());
666}

References DefinitionMixin< NamespaceDefMutable >::briefDescription(), Config_getBool, and DefinitionMixin< NamespaceDefMutable >::documentation().

Referenced by writeBriefDescription(), and writeDetailedDescription().

◆ insertClass()

void NamespaceDefImpl::insertClass ( ClassDef * cd)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 416 of file namespacedef.cpp.

417{
418 ClassLinkedRefMap *d = &m_classes;
419
420 if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
421 {
423 {
424 d = &m_interfaces;
425 }
426 else if (cd->compoundType()==ClassDef::Struct)
427 {
428 d = &m_structs;
429 }
430 else if (cd->compoundType()==ClassDef::Record)
431 {
432 d = &m_records;
433 }
434 else if (cd->compoundType()==ClassDef::Exception)
435 {
436 d = &m_exceptions;
437 }
438 }
439
440 d->add(cd->name(),cd);
441}
@ Interface
Definition classdef.h:109
@ Exception
Definition classdef.h:112
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e. class/struct/union/...

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), ClassDef::compoundType(), Config_getBool, ClassDef::Exception, ClassDef::Interface, m_classes, m_exceptions, m_interfaces, m_records, m_structs, Definition::name(), ClassDef::Record, and ClassDef::Struct.

Referenced by addInnerCompound().

◆ insertConcept()

void NamespaceDefImpl::insertConcept ( ConceptDef * cd)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 443 of file namespacedef.cpp.

444{
445 m_concepts.add(cd->name(),cd);
446}

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_concepts, and Definition::name().

Referenced by addInnerCompound().

◆ insertMember()

void NamespaceDefImpl::insertMember ( MemberDef * md)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 526 of file namespacedef.cpp.

527{
528 //printf("%s::insertMember(%s) isInline=%d hasDocs=%d\n",qPrint(name()),qPrint(md->name()),
529 // isInline(),hasDocumentation());
530 if (md->isHidden()) return;
531 MemberDefMutable *mdm = toMemberDefMutable(md);
532
533 // if this is an inline namespace that is not documented, then insert the
534 // member in the parent scope instead
535 if (isInline() && !hasDocumentation())
536 {
537 Definition *outerScope = getOuterScope();
538 if (outerScope)
539 {
540 if (outerScope->definitionType()==Definition::TypeNamespace)
541 {
542 NamespaceDefMutable *nd = toNamespaceDefMutable(outerScope);
543 if (nd && nd!=Doxygen::globalScope)
544 {
545 nd->insertMember(md);
546 if (mdm)
547 {
548 mdm->setNamespace(nd);
549 }
550 }
551 }
552 else if (outerScope->definitionType()==Definition::TypeFile)
553 {
554 FileDef *fd = toFileDef(outerScope);
555 fd->insertMember(md);
556 if (mdm)
557 {
558 mdm->setFileDef(fd);
559 mdm->setOuterScope(fd);
560 }
561 }
562 }
563 }
564 else // member is a non-inline namespace or a documented inline namespace
565 {
566 MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
567 if (allMemberList==nullptr)
568 {
569 m_memberLists.emplace_back(std::make_unique<MemberList>(MemberListType::AllMembersList(),MemberListContainer::Namespace));
570 allMemberList = m_memberLists.back().get();
571 }
572 allMemberList->push_back(md);
573 //printf("%s::m_allMembersDict->append(%s)\n",qPrint(name()),qPrint(md->localName()));
574 m_allMembers.add(md->localName(),md);
575 switch(md->memberType())
576 {
577 case MemberType::Variable:
578 if (md->anonymousMemberForDeclaration()==nullptr) // not a split member that has a separate declaration member
579 {
580 addMemberToList(MemberListType::DecVarMembers(),md);
581 }
582 if (!md->isAnonymous() && md->anonymousMemberForDetails()==nullptr) // not a split member that has a separate details member
583 {
584 addMemberToList(MemberListType::DocVarMembers(),md);
585 }
586 break;
587 case MemberType::Function:
588 addMemberToList(MemberListType::DecFuncMembers(),md);
589 addMemberToList(MemberListType::DocFuncMembers(),md);
590 break;
591 case MemberType::Typedef:
592 addMemberToList(MemberListType::DecTypedefMembers(),md);
593 addMemberToList(MemberListType::DocTypedefMembers(),md);
594 break;
595 case MemberType::Sequence:
596 addMemberToList(MemberListType::DecSequenceMembers(),md);
597 addMemberToList(MemberListType::DocSequenceMembers(),md);
598 break;
599 case MemberType::Dictionary:
600 addMemberToList(MemberListType::DecDictionaryMembers(),md);
601 addMemberToList(MemberListType::DocDictionaryMembers(),md);
602 break;
603 case MemberType::Enumeration:
604 addMemberToList(MemberListType::DecEnumMembers(),md);
605 addMemberToList(MemberListType::DocEnumMembers(),md);
606 break;
607 case MemberType::EnumValue:
608 break;
609 case MemberType::Define:
610 addMemberToList(MemberListType::DecDefineMembers(),md);
611 addMemberToList(MemberListType::DocDefineMembers(),md);
612 break;
613 case MemberType::Property:
614 if (md->getLanguage() == SrcLangExt::Python)
615 {
616 addMemberToList(MemberListType::PropertyMembers(),md);
617 addMemberToList(MemberListType::Properties(),md);
618 break;
619 }
620 // fallthrough, explicitly no break here
621 default:
622 err("NamespaceDefImpl::insertMembers(): "
623 "member '{}' with unexpected type '{}' and class scope '{}' inserted in namespace scope '{}'!\n",
624 md->name(), md->memberTypeName(), md->getClassDef() ? md->getClassDef()->name() : "", name());
625 }
626 // if this is an inline namespace, then insert an alias of this member in the outer scope.
627 if (isInline())
628 {
629 Definition *outerScope = getOuterScope();
630 if (outerScope)
631 {
632 std::unique_ptr<MemberDef> aliasMd = createMemberDefAlias(outerScope,md);
633 if (outerScope->definitionType()==Definition::TypeNamespace)
634 {
635 NamespaceDefMutable *ndm = toNamespaceDefMutable(outerScope);
636 if (ndm)
637 {
638 ndm->insertMember(aliasMd.get());
639 }
640 }
641 else if (outerScope->definitionType()==Definition::TypeFile)
642 {
643 toFileDef(outerScope)->insertMember(aliasMd.get());
644 }
645 if (aliasMd)
646 {
647 MemberName *mn = Doxygen::functionNameLinkedMap->add(md->name());
648 mn->push_back(std::move(aliasMd));
649 }
650 }
651 }
652 }
653}
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual bool isAnonymous() const =0
virtual bool isHidden() const =0
Definition * getOuterScope() const override
virtual void setOuterScope(Definition *d)=0
static MemberNameLinkedMap * functionNameLinkedMap
Definition doxygen.h:105
static NamespaceDefMutable * globalScope
Definition doxygen.h:114
virtual void insertMember(MemberDef *md)=0
T * add(const char *k, Args &&... args)
Definition linkedmap.h:90
virtual const ClassDef * getClassDef() const =0
virtual const MemberDef * anonymousMemberForDeclaration() const =0
virtual const MemberDef * anonymousMemberForDetails() const =0
virtual MemberType memberType() const =0
virtual DString memberTypeName() const =0
virtual void setFileDef(FileDef *fd)=0
virtual void setNamespace(NamespaceDef *nd)=0
void push_back(Ptr &&p)
Definition membername.h:52
void push_back(const T &value)
Definition memberlist.h:49
bool isInline() const override
void addMemberToList(MemberListType lt, MemberDef *md)
virtual void insertMember(MemberDef *md)=0
FileDef * toFileDef(Definition *d)
Definition filedef.cpp:2054
std::unique_ptr< MemberDef > createMemberDefAlias(const Definition *newScope, const MemberDef *aliasMd)
#define err(fmt,...)
Definition message.h:127

References LinkedMap< T, Hash, KeyEqual, Map >::add(), LinkedRefMap< T, Hash, KeyEqual, Map >::add(), addMemberToList(), MemberDef::anonymousMemberForDeclaration(), MemberDef::anonymousMemberForDetails(), createMemberDefAlias(), Definition::definitionType(), err, Doxygen::functionNameLinkedMap, MemberLists::get(), MemberDef::getClassDef(), Definition::getLanguage(), getMemberList(), DefinitionMixin< NamespaceDefMutable >::getOuterScope(), Doxygen::globalScope, DefinitionMixin< NamespaceDefMutable >::hasDocumentation(), FileDef::insertMember(), NamespaceDefMutable::insertMember(), Definition::isAnonymous(), Definition::isHidden(), isInline(), Definition::localName(), m_allMembers, m_memberLists, MemberDef::memberType(), MemberDef::memberTypeName(), Definition::name(), DefinitionMixin< NamespaceDefMutable >::name(), Namespace, MemberName::push_back(), MemberVector::push_back(), MemberDefMutable::setFileDef(), MemberDefMutable::setNamespace(), DefinitionMutable::setOuterScope(), toFileDef(), toMemberDefMutable(), toNamespaceDefMutable(), Definition::TypeFile, and Definition::TypeNamespace.

◆ insertNamespace()

void NamespaceDefImpl::insertNamespace ( NamespaceDef * nd)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 448 of file namespacedef.cpp.

449{
450 m_namespaces.add(nd->name(),nd);
451}

References LinkedRefMap< T, Hash, KeyEqual, Map >::add(), m_namespaces, and Definition::name().

Referenced by addInnerCompound().

◆ insertUsedFile()

void NamespaceDefImpl::insertUsedFile ( FileDef * fd)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 388 of file namespacedef.cpp.

389{
390 if (fd==nullptr) return;
391 auto it = std::find(files.begin(),files.end(),fd);
392 if (it==files.end())
393 {
394 files.push_back(fd);
395 }
396}

References files.

◆ isConstantGroup()

bool NamespaceDefImpl::isConstantGroup ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 92 of file namespacedef.cpp.

92{ return CONSTANT_GROUP == m_type; }

References CONSTANT_GROUP, and m_type.

Referenced by addNamespaceAttributes(), compoundTypeString(), title(), and writeNamespaceDeclarations().

◆ isInline()

bool NamespaceDefImpl::isInline ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 95 of file namespacedef.cpp.

95{ return m_inline; }

References m_inline.

Referenced by insertMember(), setInline(), and title().

◆ isLibrary()

bool NamespaceDefImpl::isLibrary ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 94 of file namespacedef.cpp.

94{ return LIBRARY == m_type; }

References LIBRARY, and m_type.

Referenced by compoundTypeString().

◆ isLinkable()

bool NamespaceDefImpl::isLinkable ( ) const
overridevirtual

Returns true iff it is possible to link to this item. This can be a link to another project imported via a tag file.

Implements Definition.

Definition at line 1696 of file namespacedef.cpp.

1697{
1698 return isLinkableInProject() || isReference();
1699}
bool isLinkableInProject() const override

References isLinkableInProject(), and DefinitionMixin< NamespaceDefMutable >::isReference().

Referenced by isVisibleInHierarchy().

◆ isLinkableInProject()

bool NamespaceDefImpl::isLinkableInProject ( ) const
overridevirtual

Returns true iff it is possible to link to this item within this project.

Implements Definition.

Definition at line 1677 of file namespacedef.cpp.

1678{
1679 size_t i = name().rfind("::");
1680 if (i==DString::npos) i=0; else i+=2;
1681 bool extractAnonNs = Config_getBool(EXTRACT_ANON_NSPACES);
1682 bool hideUndoc = Config_getBool(HIDE_UNDOC_NAMESPACES);
1683 if (extractAnonNs && // extract anonymous ns
1684 name().mid(i,20)=="anonymous_namespace{" // correct prefix
1685 ) // not disabled by config
1686 {
1687 return true;
1688 }
1689 return !name().empty() && name().at(i)!='@' && // not anonymous
1690 (hasDocumentation() || !hideUndoc || getLanguage()==SrcLangExt::CSharp) && // documented
1691 !isReference() && // not an external reference
1692 !isHidden() && // not hidden
1693 !isArtificial(); // or artificial
1694}
size_t rfind(char c, size_t pos=npos) const
Definition dstring.h:244
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:148
static constexpr size_t npos
value used to indicate 'not found' or 'to the end of the string', matching std::string::npos
Definition dstring.h:178
char & at(size_t i)
Returns a reference to the character at index i.
Definition dstring.h:686
const DString & name() const override

References DString::at(), Config_getBool, DString::empty(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), DefinitionMixin< NamespaceDefMutable >::hasDocumentation(), DefinitionMixin< NamespaceDefMutable >::isArtificial(), DefinitionMixin< NamespaceDefMutable >::isHidden(), DefinitionMixin< NamespaceDefMutable >::isReference(), DefinitionMixin< NamespaceDefMutable >::name(), DString::npos, and DString::rfind().

Referenced by isLinkable().

◆ isModule()

bool NamespaceDefImpl::isModule ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 93 of file namespacedef.cpp.

93{ return NAMESPACE == m_type || MODULE == m_type; }

References m_type, MODULE, and NAMESPACE.

Referenced by compoundTypeString().

◆ isVisibleInHierarchy()

bool NamespaceDefImpl::isVisibleInHierarchy ( ) const
overridevirtual

Implements NamespaceDef.

Definition at line 1671 of file namespacedef.cpp.

1672{
1673 bool allExternals = Config_getBool(ALLEXTERNALS);
1674 return allExternals || hasNonReferenceNestedNamespaceRec(this,0) || isLinkable();
1675}
bool isLinkable() const override
static bool hasNonReferenceNestedNamespaceRec(const NamespaceDef *nd, int level)

References Config_getBool, hasNonReferenceNestedNamespaceRec(), and isLinkable().

◆ numDocMembers()

int NamespaceDefImpl::numDocMembers ( ) const
overridevirtual

Implements NamespaceDef.

Definition at line 1314 of file namespacedef.cpp.

1315{
1316 MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
1317 return (allMemberList ? allMemberList->numDocMembers() : 0) + static_cast<int>(m_innerCompounds.size());
1318}
size_t size() const
Definition linkedmap.h:375
int numDocMembers() const
Definition memberlist.h:139

References getMemberList(), m_innerCompounds, MemberList::numDocMembers(), and LinkedRefMap< T, Hash, KeyEqual, Map >::size().

◆ setFileName()

void NamespaceDefImpl::setFileName ( const DString & fn)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 357 of file namespacedef.cpp.

358{
360}

References setFileNameLocal().

◆ setFileNameLocal()

void NamespaceDefImpl::setFileNameLocal ( const DString & fn)
private

Definition at line 345 of file namespacedef.cpp.

346{
347 if (isReference())
348 {
349 fileName = "namespace"+fn;
350 }
351 else
352 {
353 fileName = convertNameToFile("namespace"+fn);
354 }
355}

References convertNameToFile(), fileName, and DefinitionMixin< NamespaceDefMutable >::isReference().

Referenced by setFileName().

◆ setIncludeFile()

void NamespaceDefImpl::setIncludeFile ( FileDef * fd,
const DString & incName,
bool local,
bool force )
overridevirtual

Implements NamespaceDefMutable.

Definition at line 453 of file namespacedef.cpp.

455{
456 //printf("NamespaceDefImpl::setIncludeFile(%p,%s,%d,%d)\n",fd,qPrint(includeName),local,force);
457 if (!force || includeName.empty()) return; // only use header provided via \headerfile
458 auto it = m_incInfo.find(includeName.str());
459 if (it == m_incInfo.end())
460 {
461 m_incInfo.insert(std::make_pair(includeName.str(), IncludeInfo(fd,includeName,local ? IncludeKind::IncludeLocal : IncludeKind::IncludeSystem)));
462 }
463}
std::map< std::string, IncludeInfo > m_incInfo
@ IncludeLocal
Definition filedef.h:47
@ IncludeSystem
Definition filedef.h:46

References DString::empty(), IncludeLocal, IncludeSystem, m_incInfo, and DString::str().

◆ setInline()

void NamespaceDefImpl::setInline ( bool isInline)
inlineoverridevirtual

Implements NamespaceDefMutable.

Definition at line 91 of file namespacedef.cpp.

91{ m_inline = isInline; }

References isInline(), and m_inline.

◆ setMetaData()

void NamespaceDefImpl::setMetaData ( const DString & m)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1784 of file namespacedef.cpp.

1785{
1786 metaData = m;
1787}

References metaData.

◆ setName()

void NamespaceDefImpl::setName ( const DString & name)
overridevirtual

Sets a new name for the definition

Reimplemented from DefinitionMixin< NamespaceDefMutable >.

Definition at line 335 of file namespacedef.cpp.

336{
339}
void setName(const DString &name) override

References DefinitionMixin< NamespaceDefMutable >::name(), DefinitionMixin< Base >::setName(), and updateLocalName().

◆ sortMemberLists()

void NamespaceDefImpl::sortMemberLists ( )
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1588 of file namespacedef.cpp.

1589{
1590 for (auto &ml : m_memberLists)
1591 {
1592 if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(false); }
1593 }
1594
1595 auto classComp = [](const ClassLinkedRefMap::Ptr &c1,const ClassLinkedRefMap::Ptr &c2)
1596 {
1597 return Config_getBool(SORT_BY_SCOPE_NAME) ?
1598 dstricmp_sort(c1->name(), c2->name())<0 :
1599 dstricmp_sort(c1->className(), c2->className())<0;
1600 };
1601
1602 if (needsSorting(m_classes)) std::stable_sort(m_classes.begin(), m_classes.end(), classComp);
1603 if (needsSorting(m_interfaces)) std::stable_sort(m_interfaces.begin(),m_interfaces.end(),classComp);
1604 if (needsSorting(m_structs)) std::stable_sort(m_structs.begin(), m_structs.end(), classComp);
1605 if (needsSorting(m_records)) std::stable_sort(m_records.begin(), m_records.end(), classComp);
1606 if (needsSorting(m_exceptions)) std::stable_sort(m_exceptions.begin(),m_exceptions.end(),classComp);
1607
1608 auto conceptComp = [](const ConceptLinkedRefMap::Ptr &c1,const ConceptLinkedRefMap::Ptr &c2)
1609 {
1610 return dstricmp_sort(c1->name(),c2->name())<0;
1611 };
1612
1613 if (needsSorting(m_concepts)) std::stable_sort(m_concepts.begin(), m_concepts.end(), conceptComp);
1614
1615 auto namespaceComp = [](const NamespaceLinkedRefMap::Ptr &n1,const NamespaceLinkedRefMap::Ptr &n2)
1616 {
1617 return dstricmp_sort(n1->name(),n2->name())<0;
1618 };
1619
1620 if (needsSorting(m_namespaces)) std::stable_sort(m_namespaces.begin(),m_namespaces.end(),namespaceComp);
1621
1622}
virtual DString className() const =0
Returns the name of the class including outer classes, but not including namespaces.
iterator end()
Definition linkedmap.h:367
iterator begin()
Definition linkedmap.h:366
int dstricmp_sort(const char *str1, const char *str2)
Definition dstring.h:67
bool needsSorting(const Container &container)

References LinkedRefMap< T, Hash, KeyEqual, Map >::begin(), ClassDef::className(), Config_getBool, dstricmp_sort(), LinkedRefMap< T, Hash, KeyEqual, Map >::end(), m_classes, m_concepts, m_exceptions, m_interfaces, m_memberLists, m_namespaces, m_records, m_structs, Definition::name(), and needsSorting().

◆ startMemberDeclarations()

void NamespaceDefImpl::startMemberDeclarations ( OutputList & ol)
private

Definition at line 867 of file namespacedef.cpp.

868{
870}
void startMemberSections()
Definition outputlist.h:457

References OutputList::startMemberSections().

Referenced by writeDocumentation().

◆ startMemberDocumentation()

void NamespaceDefImpl::startMemberDocumentation ( OutputList & ol)
private

Definition at line 877 of file namespacedef.cpp.

878{
879 if (Config_getBool(SEPARATE_MEMBER_PAGES))
880 {
883 }
884}
void disable(OutputType o)

References Config_getBool, OutputList::disable(), Html, and Doxygen::suppressDocWarnings.

Referenced by writeDocumentation().

◆ subGrouping()

bool NamespaceDefImpl::subGrouping ( ) const
inlineoverridevirtual

Implements NamespaceDef.

Definition at line 109 of file namespacedef.cpp.

109{ return m_subGrouping; }

References m_subGrouping.

◆ title()

DString NamespaceDefImpl::title ( ) const
overridevirtual

Implements NamespaceDef.

Definition at line 1706 of file namespacedef.cpp.

1707{
1708 DString pageTitle;
1709 SrcLangExt lang = getLanguage();
1710
1711 auto getReferenceTitle = [this](std::function<DString()> translateFunc) -> DString
1712 {
1713 return Config_getBool(HIDE_COMPOUND_REFERENCE) ? displayName() : translateFunc();
1714 };
1715
1716 if (lang==SrcLangExt::Java)
1717 {
1718 pageTitle = theTranslator->trPackage(displayName());
1719 }
1720 else if (lang==SrcLangExt::Fortran || lang==SrcLangExt::Slice)
1721 {
1722 pageTitle = getReferenceTitle([this](){
1724 });
1725 }
1726 else if (lang==SrcLangExt::IDL)
1727 {
1728 pageTitle = getReferenceTitle([this](){
1729 return isConstantGroup()
1732 });
1733 }
1734 else
1735 {
1736 if (isInline())
1737 {
1738 pageTitle = "inline ";
1739 }
1740 pageTitle += getReferenceTitle([this](){
1742 });
1743 }
1744 return pageTitle;
1745}
virtual DString trPackage(const DString &name)=0
virtual DString trModuleReference(const DString &namespaceName)=0
virtual DString trNamespaceReference(const DString &namespaceName)=0
virtual DString trConstantGroupReference(const DString &namespaceName)=0

References Config_getBool, displayName(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), isConstantGroup(), isInline(), theTranslator, Translator::trConstantGroupReference(), Translator::trModuleReference(), Translator::trNamespaceReference(), and Translator::trPackage().

Referenced by writeClassDeclarations(), writeConcepts(), writeDetailedDescription(), writeDocumentation(), writeMemberDeclarations(), writeMemberDocumentation(), and writeNamespaceDeclarations().

◆ updateLocalName()

void NamespaceDefImpl::updateLocalName ( )
private

Definition at line 328 of file namespacedef.cpp.

329{
330 DString locName=name();
331 if (size_t i=locName.rfind("::"); i!=DString::npos) locName=locName.mid(i+2);
332 setLocalName(locName);
333}
DString mid(size_t index, size_t len=npos) const
Definition dstring.h:318
void setLocalName(const DString &name) override

References DString::mid(), DefinitionMixin< NamespaceDefMutable >::name(), DString::npos, DString::rfind(), and DefinitionMixin< NamespaceDefMutable >::setLocalName().

Referenced by setName().

◆ writeAuthorSection()

void NamespaceDefImpl::writeAuthorSection ( OutputList & ol)
private

Definition at line 928 of file namespacedef.cpp.

929{
930 // write Author section (Man only)
933 ol.startGroupHeader();
934 ol.parseText(theTranslator->trAuthor(true,true));
935 ol.endGroupHeader();
938}
void parseText(const DString &textStr)
void endGroupHeader(int extraLevels=0)
Definition outputlist.h:451
void startGroupHeader(const DString &id=DString(), int extraLevels=0)
Definition outputlist.h:449
virtual DString trAuthor(bool first_capital, bool singular)=0
virtual DString trGeneratedAutomatically(const DString &s)=0
#define Config_getString(name)
Definition config.h:32

References Config_getString, OutputList::disableAllBut(), OutputList::endGroupHeader(), Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), theTranslator, Translator::trAuthor(), and Translator::trGeneratedAutomatically().

Referenced by writeDocumentation().

◆ writeBriefDescription()

void NamespaceDefImpl::writeBriefDescription ( OutputList & ol)
private

Definition at line 807 of file namespacedef.cpp.

808{
810 {
811 auto parser { createDocParser() };
812 auto ast { validatingParseDoc(*parser.get(),
813 briefFile(),
814 briefLine(),
815 this,
816 nullptr,
818 DocOptions()
819 .setIndexWords(true)
820 .setSingleLine(true))
821 };
822 if (!ast->empty())
823 {
824 ol.startParagraph();
827 ol.writeString(" - ");
829 ol.writeDoc(ast.get(),this,nullptr);
832 ol.writeString(" \n");
834
836 {
838 ol.startTextLink(getOutputFileBase(),"details");
840 ol.endTextLink();
841 }
843 ol.endParagraph();
844 }
845 }
846
847 // Write a summary of the Slice definition including metadata.
848 if (getLanguage() == SrcLangExt::Slice)
849 {
850 ol.startParagraph();
851 ol.startTypewriter();
852 if (!metaData.empty())
853 {
854 ol.docify(metaData);
855 ol.lineBreak();
856 }
857 ol.docify("module ");
858 ol.docify(stripScope(name()));
859 ol.docify(" { ... }");
860 ol.endTypewriter();
861 ol.endParagraph();
862 }
863
864 ol.writeSynopsis();
865}
virtual DString briefFile() const =0
bool hasDetailedDescription() const override
void writeDoc(const IDocNodeAST *ast, const Definition *ctx, const MemberDef *md, int sectionLevel=-1)
Definition outputlist.h:379
void startParagraph(const DString &classDef=DString())
Definition outputlist.h:403
void docify(const DString &s)
Definition outputlist.h:433
void lineBreak(const DString &style=DString())
Definition outputlist.h:555
void writeString(const DString &text)
Definition outputlist.h:407
void endParagraph()
Definition outputlist.h:405
void endTextLink()
Definition outputlist.h:440
void writeSynopsis()
Definition outputlist.h:588
void startTypewriter()
Definition outputlist.h:445
void startTextLink(const DString &file, const DString &anchor)
Definition outputlist.h:438
void endTypewriter()
Definition outputlist.h:447
virtual DString trMore()=0
IDocParserPtr createDocParser()
factory function to create a parser
Definition docparser.cpp:59
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const DString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const DString &input, const DocOptions &options)
DString stripScope(const DString &name)
Definition util.cpp:3118

References DefinitionMixin< NamespaceDefMutable >::briefDescription(), DefinitionMixin< NamespaceDefMutable >::briefFile(), DefinitionMixin< NamespaceDefMutable >::briefLine(), createDocParser(), OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), DString::empty(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), OutputList::endTypewriter(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), getOutputFileBase(), DefinitionMixin< NamespaceDefMutable >::hasBriefDescription(), hasDetailedDescription(), Html, OutputList::lineBreak(), Man, metaData, DefinitionMixin< NamespaceDefMutable >::name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startParagraph(), OutputList::startTextLink(), OutputList::startTypewriter(), stripScope(), theTranslator, Translator::trMore(), validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString(), and OutputList::writeSynopsis().

Referenced by writeDocumentation().

◆ writeClassDeclarations()

void NamespaceDefImpl::writeClassDeclarations ( OutputList & ol,
const DString & title,
const ClassLinkedRefMap & d )
private

Definition at line 895 of file namespacedef.cpp.

896{
897 d.writeDeclaration(ol,nullptr,title,true);
898}
void writeDeclaration(OutputList &ol, const ClassDef::CompoundType *filter, const DString &header, bool localNames) const
Definition classlist.cpp:51
DString title() const override

References title(), and ClassLinkedRefMap::writeDeclaration().

Referenced by writeDocumentation().

◆ writeClassesToTagFile()

void NamespaceDefImpl::writeClassesToTagFile ( TextStream & tagFile,
const ClassLinkedRefMap & d )
private

Definition at line 1046 of file namespacedef.cpp.

1047{
1048 for (const auto &cd : list)
1049 {
1050 if (cd->isLinkableInProject())
1051 {
1052 tagFile << " <class kind=\"" << cd->compoundTypeString()
1053 << "\">" << convertToXML(cd->name()) << "</class>\n";
1054 }
1055 }
1056}
DString convertToXML(const DString &s, bool keepEntities, const bool citeEntry)
Definition util.cpp:3241

References convertToXML().

Referenced by writeTagFile().

◆ writeConcepts()

void NamespaceDefImpl::writeConcepts ( OutputList & ol,
const DString & title )
private

Definition at line 900 of file namespacedef.cpp.

901{
903}
void writeDeclaration(OutputList &ol, const DString &header, bool localNames) const

References m_concepts, title(), and ConceptLinkedRefMap::writeDeclaration().

Referenced by writeDocumentation().

◆ writeConceptsToTagFile()

void NamespaceDefImpl::writeConceptsToTagFile ( TextStream & tagFile)
private

Definition at line 1058 of file namespacedef.cpp.

1059{
1060 for (const auto &cd : m_concepts)
1061 {
1062 if (cd->isLinkableInProject())
1063 {
1064 tagFile << " <concept>" << convertToXML(cd->name()) << "</concept>\n";
1065 }
1066 }
1067}

References convertToXML(), and m_concepts.

Referenced by writeTagFile().

◆ writeDetailedDescription()

void NamespaceDefImpl::writeDetailedDescription ( OutputList & ol,
const DString & title )
private

Definition at line 754 of file namespacedef.cpp.

755{
757 {
760 ol.writeRuler();
764 ol.writeAnchor(DString(),"details");
766 ol.startGroupHeader("details");
767 ol.parseText(title);
768 ol.endGroupHeader();
769
770 ol.startTextBlock();
771 if (!briefDescription().empty() && Config_getBool(REPEAT_BRIEF))
772 {
774 briefLine(),
775 this,
776 nullptr,
778 DocOptions());
779 }
780 if (!briefDescription().empty() && Config_getBool(REPEAT_BRIEF) &&
781 !documentation().empty())
782 {
786 ol.enableAll();
789 ol.writeString("\n\n");
791 }
792 if (!documentation().empty())
793 {
794 ol.generateDoc(docFile(),
795 docLine(),
796 this,
797 nullptr,
798 documentation()+"\n",
799 DocOptions()
800 .setIndexWords(true));
801 }
803 ol.endTextBlock();
804 }
805}
void writeRequirementRefs(OutputList &ol) const override
void writeRuler()
Definition outputlist.h:517
void endTextBlock(bool paraBreak=false)
Definition outputlist.h:668
void writeAnchor(const DString &fileName, const DString &name)
Definition outputlist.h:519
void startTextBlock(bool dense=false)
Definition outputlist.h:666
void generateDoc(const DString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const DString &docStr, const DocOptions &options)
void enableAll()

References DefinitionMixin< NamespaceDefMutable >::briefDescription(), DefinitionMixin< NamespaceDefMutable >::briefFile(), DefinitionMixin< NamespaceDefMutable >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< NamespaceDefMutable >::docFile(), DefinitionMixin< NamespaceDefMutable >::docLine(), DefinitionMixin< NamespaceDefMutable >::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::endTextBlock(), OutputList::generateDoc(), hasDetailedDescription(), DefinitionMixin< NamespaceDefMutable >::hasRequirementRefs(), Html, Latex, Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startGroupHeader(), OutputList::startTextBlock(), title(), OutputList::writeAnchor(), DefinitionMixin< NamespaceDefMutable >::writeRequirementRefs(), OutputList::writeRuler(), and OutputList::writeString().

Referenced by writeDocumentation().

◆ writeDocumentation()

void NamespaceDefImpl::writeDocumentation ( OutputList & ol)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1069 of file namespacedef.cpp.

1070{
1071 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
1072 //bool outputJava = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
1073 //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
1074
1075 DString pageTitle = title();
1076 startFile(ol,getOutputFileBase(),false,name(),pageTitle,HighlightedItem::NamespaceVisible,!generateTreeView);
1077
1078 if (!generateTreeView)
1079 {
1081 {
1083 }
1084 ol.endQuickIndices();
1085 }
1086
1087 startTitle(ol,getOutputFileBase(),this);
1088 ol.parseText(pageTitle);
1089 addGroupListToTitle(ol,this);
1092 ol.startContents();
1093
1094 //---------------------------------------- start flexible part -------------------------------
1095
1096 SrcLangExt lang = getLanguage();
1097 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Namespace))
1098 {
1099 const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
1100 switch (lde->kind())
1101 {
1102 case LayoutDocEntry::BriefDesc:
1104 break;
1105 case LayoutDocEntry::MemberDeclStart:
1107 break;
1108 case LayoutDocEntry::NamespaceClasses:
1109 {
1110 if (ls) writeClassDeclarations(ol,ls->title(lang),m_classes);
1111 }
1112 break;
1113 case LayoutDocEntry::NamespaceInterfaces:
1114 {
1115 if (ls) writeClassDeclarations(ol,ls->title(lang),m_interfaces);
1116 }
1117 break;
1118 case LayoutDocEntry::NamespaceStructs:
1119 {
1120 if (ls) writeClassDeclarations(ol,ls->title(lang),m_structs);
1121 }
1122 break;
1123 case LayoutDocEntry::NamespaceRecords:
1124 {
1125 if (ls) writeClassDeclarations(ol,ls->title(lang),m_records);
1126 }
1127 break;
1128 case LayoutDocEntry::NamespaceExceptions:
1129 {
1130 if (ls) writeClassDeclarations(ol,ls->title(lang),m_exceptions);
1131 }
1132 break;
1133 case LayoutDocEntry::NamespaceConcepts:
1134 {
1135 if (ls) writeConcepts(ol,ls->title(lang));
1136 }
1137 break;
1138 case LayoutDocEntry::NamespaceNestedNamespaces:
1139 {
1140 if (ls) writeNamespaceDeclarations(ol,ls->title(lang),false);
1141 }
1142 break;
1143 case LayoutDocEntry::NamespaceNestedConstantGroups:
1144 {
1145 if (ls) writeNamespaceDeclarations(ol,ls->title(lang),true);
1146 }
1147 break;
1148 case LayoutDocEntry::MemberGroups:
1150 break;
1151 case LayoutDocEntry::MemberDecl:
1152 {
1153 const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
1154 if (lmd) writeMemberDeclarations(ol,lmd->type,lmd->title(lang));
1155 }
1156 break;
1157 case LayoutDocEntry::MemberDeclEnd:
1159 break;
1160 case LayoutDocEntry::DetailedDesc:
1161 {
1162 if (ls) writeDetailedDescription(ol,ls->title(lang));
1163 }
1164 break;
1165 case LayoutDocEntry::MemberDefStart:
1167 break;
1168 case LayoutDocEntry::NamespaceInlineClasses:
1170 break;
1171 case LayoutDocEntry::MemberDef:
1172 {
1173 const LayoutDocEntryMemberDef *lmd = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get());
1174 if (lmd) writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
1175 }
1176 break;
1177 case LayoutDocEntry::MemberDefEnd:
1179 break;
1180 case LayoutDocEntry::AuthorSection:
1182 break;
1183 case LayoutDocEntry::Includes:
1185 break;
1186 case LayoutDocEntry::ClassInheritanceGraph:
1187 case LayoutDocEntry::ClassNestedClasses:
1188 case LayoutDocEntry::ClassCollaborationGraph:
1189 case LayoutDocEntry::ClassAllMembersLink:
1190 case LayoutDocEntry::ClassUsedFiles:
1191 case LayoutDocEntry::ClassInlineClasses:
1192 case LayoutDocEntry::ConceptDefinition:
1193 case LayoutDocEntry::FileClasses:
1194 case LayoutDocEntry::FileConcepts:
1195 case LayoutDocEntry::FileInterfaces:
1196 case LayoutDocEntry::FileStructs:
1197 case LayoutDocEntry::FileRecords:
1198 case LayoutDocEntry::FileExceptions:
1199 case LayoutDocEntry::FileNamespaces:
1200 case LayoutDocEntry::FileConstantGroups:
1201 case LayoutDocEntry::FileIncludeGraph:
1202 case LayoutDocEntry::FileIncludedByGraph:
1203 case LayoutDocEntry::FileSourceLink:
1204 case LayoutDocEntry::FileInlineClasses:
1205 case LayoutDocEntry::GroupClasses:
1206 case LayoutDocEntry::GroupConcepts:
1207 case LayoutDocEntry::GroupModules:
1208 case LayoutDocEntry::GroupInlineClasses:
1209 case LayoutDocEntry::GroupNamespaces:
1210 case LayoutDocEntry::GroupDirs:
1211 case LayoutDocEntry::GroupNestedGroups:
1212 case LayoutDocEntry::GroupFiles:
1213 case LayoutDocEntry::GroupGraph:
1214 case LayoutDocEntry::GroupPageDocs:
1215 case LayoutDocEntry::ModuleExports:
1216 case LayoutDocEntry::ModuleClasses:
1217 case LayoutDocEntry::ModuleConcepts:
1218 case LayoutDocEntry::ModuleUsedFiles:
1219 case LayoutDocEntry::DirSubDirs:
1220 case LayoutDocEntry::DirFiles:
1221 case LayoutDocEntry::DirGraph:
1222 err("Internal inconsistency: member '{}' should not be part of "
1223 "LayoutDocManager::Namespace entry list\n",lde->entryToString());
1224 break;
1225 }
1226 }
1227
1228 //---------------------------------------- end flexible part -------------------------------
1229
1230 ol.endContents();
1231
1232 endFileWithNavPath(ol,this);
1233
1234 if (Config_getBool(SEPARATE_MEMBER_PAGES))
1235 {
1236 MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
1237 if (allMemberList) allMemberList->sort();
1238 writeMemberPages(ol);
1239 }
1240}
void writeNavigationPath(OutputList &ol) const override
void sort()
Definition memberlist.h:77
void writeMemberDocumentation(OutputList &ol, MemberListType lt, const DString &title)
void writeMemberPages(OutputList &ol) override
void writeMemberGroups(OutputList &ol)
void startMemberDeclarations(OutputList &ol)
void writeAuthorSection(OutputList &ol)
void endMemberDocumentation(OutputList &ol)
void writeInlineClasses(OutputList &ol)
void writeBriefDescription(OutputList &ol)
void writeIncludeFiles(OutputList &ol) const
void startMemberDocumentation(OutputList &ol)
void writeNamespaceDeclarations(OutputList &ol, const DString &title, bool isConstantGroup=false)
void endMemberDeclarations(OutputList &ol)
void writeConcepts(OutputList &ol, const DString &title)
void writeClassDeclarations(OutputList &ol, const DString &title, const ClassLinkedRefMap &d)
void addNamespaceAttributes(OutputList &ol)
void writeMemberDeclarations(OutputList &ol, MemberListType lt, const DString &title)
void writeDetailedDescription(OutputList &ol, const DString &title)
void endContents()
Definition outputlist.h:616
void endQuickIndices()
Definition outputlist.h:600
void startContents()
Definition outputlist.h:614
void endTitle(OutputList &ol, const DString &fileName, const DString &name)
Definition index.cpp:404
void endFileWithNavPath(OutputList &ol, const DefinitionMutable *d, bool showPageNavigation)
Definition index.cpp:458
void startTitle(OutputList &ol, const DString &fileName, const DefinitionMutable *def)
Definition index.cpp:394
void startFile(OutputList &ol, const DString &name, bool isSource, const DString &manName, const DString &title, HighlightedItem hli, bool additionalIndices, const DString &altSidebarName, int hierarchyLevel, const DString &allMembersFile)
Definition index.cpp:411
@ NamespaceVisible
Definition index.h:94
MemberListType type
Definition layout.h:118
DString title(SrcLangExt lang) const
Definition layout.cpp:1827
DString title(SrcLangExt lang) const
Definition layout.cpp:1839
DString title(SrcLangExt lang) const
Definition layout.cpp:1820
void addGroupListToTitle(OutputList &ol, const Definition *d)
Definition util.cpp:3930

References addGroupListToTitle(), addNamespaceAttributes(), Config_getBool, displayName(), OutputList::endContents(), endFileWithNavPath(), endMemberDeclarations(), endMemberDocumentation(), OutputList::endQuickIndices(), endTitle(), err, DefinitionMixin< NamespaceDefMutable >::getLanguage(), getMemberList(), DefinitionMixin< NamespaceDefMutable >::getOuterScope(), getOutputFileBase(), Doxygen::globalScope, LayoutDocManager::instance(), m_classes, m_exceptions, m_interfaces, m_records, m_structs, DefinitionMixin< NamespaceDefMutable >::name(), NamespaceVisible, OutputList::parseText(), MemberVector::sort(), OutputList::startContents(), startFile(), startMemberDeclarations(), startMemberDocumentation(), startTitle(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDef::title(), LayoutDocEntrySection::title(), title(), LayoutDocEntryMemberDecl::type, LayoutDocEntryMemberDef::type, writeAuthorSection(), writeBriefDescription(), writeClassDeclarations(), writeConcepts(), writeDetailedDescription(), writeIncludeFiles(), writeInlineClasses(), writeMemberDeclarations(), writeMemberDocumentation(), writeMemberGroups(), writeMemberPages(), writeNamespaceDeclarations(), and DefinitionMixin< NamespaceDefMutable >::writeNavigationPath().

◆ writeIncludeFiles()

void NamespaceDefImpl::writeIncludeFiles ( OutputList & ol) const
private

Definition at line 465 of file namespacedef.cpp.

466{
467 if (m_incInfo.empty()) return;
468 ol.startParagraph();
469 for (const auto &kv : m_incInfo)
470 {
471 const IncludeInfo &incInfo = kv.second;
472 DString nm=incInfo.includeName.empty() ?
473 (incInfo.fileDef ?
474 incInfo.fileDef->docName() : DString()
475 ) :
476 incInfo.includeName;
477 if (!nm.empty())
478 {
479 ol.startTypewriter();
480 ol.docify(::includeStatement(SrcLangExt::Cpp,incInfo.kind));
481 ol.docify(::includeOpen(SrcLangExt::Cpp,incInfo.kind));
484 ol.docify(nm);
487 if (incInfo.fileDef)
488 {
489 ol.writeObjectLink(DString(),incInfo.fileDef->includeName(),DString(),nm);
490 }
491 else
492 {
493 ol.docify(nm);
494 }
496 ol.docify(::includeClose(SrcLangExt::Cpp,incInfo.kind));
497 ol.endTypewriter();
498 ol.lineBreak();
499 }
500 }
501 ol.endParagraph();
502}
virtual DString includeName() const =0
virtual const DString & docName() const =0
IncludeKind kind
Definition filedef.h:79
const FileDef * fileDef
Definition filedef.h:77
DString includeName
Definition filedef.h:78
void writeObjectLink(const DString &ref, const DString &file, const DString &anchor, const DString &name)
Definition outputlist.h:435
DString includeClose(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:82
DString includeOpen(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:69
DString includeStatement(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:52

References OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), FileDef::docName(), DString::empty(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTypewriter(), IncludeInfo::fileDef, Html, includeClose(), FileDef::includeName(), IncludeInfo::includeName, includeOpen(), includeStatement(), IncludeInfo::kind, OutputList::lineBreak(), m_incInfo, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startParagraph(), OutputList::startTypewriter(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

◆ writeInlineClasses()

void NamespaceDefImpl::writeInlineClasses ( OutputList & ol)
private

Definition at line 905 of file namespacedef.cpp.

906{
908}
void writeDocumentation(OutputList &ol, const Definition *container=nullptr) const
Definition classlist.cpp:72

References m_classes, and ClassLinkedRefMap::writeDocumentation().

Referenced by writeDocumentation().

◆ writeMemberDeclarations()

void NamespaceDefImpl::writeMemberDeclarations ( OutputList & ol,
MemberListType lt,
const DString & title )
private

Definition at line 1636 of file namespacedef.cpp.

1637{
1638 MemberList * ml = getMemberList(lt);
1639 if (ml) ml->writeDeclarations(ol,nullptr,this,nullptr,nullptr,nullptr,title,DString());
1640}
void writeDeclarations(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, const DString &title, const DString &subtitle, bool showEnumValues=false, bool showInline=false, const ClassDef *inheritedFrom=nullptr, MemberListType lt=MemberListType::PubMethods(), bool showSectionTitle=true) const
Writes the list of members to the output.

References getMemberList(), title(), and MemberList::writeDeclarations().

Referenced by writeDocumentation().

◆ writeMemberDocumentation()

void NamespaceDefImpl::writeMemberDocumentation ( OutputList & ol,
MemberListType lt,
const DString & title )
private

Definition at line 1642 of file namespacedef.cpp.

1643{
1644 MemberList * ml = getMemberList(lt);
1645 if (ml) ml->writeDocumentation(ol,displayName(),this,title,ml->listType().toLabel());
1646}
void writeDocumentation(OutputList &ol, const DString &scopeName, const Definition *container, const DString &title, const DString &anchor, bool showEnumValues=false, bool showInline=false) const
MemberListType listType() const
Definition memberlist.h:131
constexpr const char * toLabel() const noexcept
Definition types.h:402

References displayName(), getMemberList(), MemberList::listType(), title(), MemberListType::toLabel(), and MemberList::writeDocumentation().

Referenced by writeDocumentation().

◆ writeMemberGroups()

void NamespaceDefImpl::writeMemberGroups ( OutputList & ol)
private

Definition at line 916 of file namespacedef.cpp.

917{
918 /* write user defined member groups */
919 for (const auto &mg : m_memberGroups)
920 {
921 if (!mg->allMembersInSameSection() || !m_subGrouping)
922 {
923 mg->writeDeclarations(ol,nullptr,this,nullptr,nullptr,nullptr);
924 }
925 }
926}

References m_memberGroups, and m_subGrouping.

Referenced by writeDocumentation().

◆ writeMemberPages()

void NamespaceDefImpl::writeMemberPages ( OutputList & ol)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 1242 of file namespacedef.cpp.

1243{
1244 ol.pushGeneratorState();
1246
1247 for (const auto &ml : m_memberLists)
1248 {
1249 if (ml->listType().isDocumentation())
1250 {
1251 ml->writeDocumentationPage(ol,displayName(),this);
1252 }
1253 }
1254 ol.popGeneratorState();
1255}

References OutputList::disableAllBut(), displayName(), Html, m_memberLists, OutputList::popGeneratorState(), and OutputList::pushGeneratorState().

Referenced by writeDocumentation().

◆ writeNamespaceDeclarations()

void NamespaceDefImpl::writeNamespaceDeclarations ( OutputList & ol,
const DString & title,
bool isConstantGroup = false )
private

Definition at line 910 of file namespacedef.cpp.

912{
914}
void writeDeclaration(OutputList &ol, const DString &title, bool isConstantGroup=false, bool localName=false)

References isConstantGroup(), m_namespaces, title(), and NamespaceLinkedRefMap::writeDeclaration().

Referenced by writeDocumentation().

◆ writePageNavigation()

void NamespaceDefImpl::writePageNavigation ( OutputList & ol) const
overridevirtual

Reimplemented from DefinitionMixin< NamespaceDefMutable >.

Definition at line 1018 of file namespacedef.cpp.

1019{
1020 ol.writePageOutline();
1021}
void writePageOutline()
Definition outputlist.h:612

References OutputList::writePageOutline().

◆ writeQuickMemberLinks()

void NamespaceDefImpl::writeQuickMemberLinks ( OutputList & ol,
const MemberDef * currentMd ) const
overridevirtual

Reimplemented from DefinitionMixin< NamespaceDefMutable >.

Definition at line 1257 of file namespacedef.cpp.

1258{
1259 bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
1260
1261 ol.writeString(" <div class=\"navtab\">\n");
1262 ol.writeString(" <table>\n");
1263
1264 MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
1265 if (allMemberList)
1266 {
1267 for (const auto &md : *allMemberList)
1268 {
1269 if (md->getNamespaceDef()==this && md->isLinkable() && !md->isEnumValue())
1270 {
1271 if (md->isLinkableInProject())
1272 {
1273 DString fn = md->getOutputFileBase();
1275 if (md==currentMd) // selected item => highlight
1276 {
1277 ol.writeString(" <tr><td class=\"navtabHL\">");
1278 }
1279 else
1280 {
1281 ol.writeString(" <tr><td class=\"navtab\">");
1282 }
1283 ol.writeString("<span class=\"label\"><a ");
1284 ol.writeString("href=\"");
1285 if (createSubDirs) ol.writeString("../../");
1286 ol.writeString(fn+"#"+md->anchor());
1287 ol.writeString("\">");
1288 ol.writeString(convertToHtml(md->localName()));
1289 ol.writeString("</a></span>");
1290 ol.writeString("</td></tr>\n");
1291 }
1292 }
1293 }
1294 }
1295
1296 ol.writeString(" </table>\n");
1297 ol.writeString(" </div>\n");
1298}
void createSubDirs(const Dir &d)
Definition util.cpp:2978
DString convertToHtml(const DString &s, bool keepEntities)
Definition util.cpp:3300
void addHtmlExtensionIfMissing(DString &fName)
Definition util.cpp:3940

References addHtmlExtensionIfMissing(), Config_getBool, convertToHtml(), createSubDirs(), getMemberList(), and OutputList::writeString().

◆ writeSummaryLinks()

void NamespaceDefImpl::writeSummaryLinks ( OutputList & ol) const
overridevirtual

Reimplemented from DefinitionMixin< NamespaceDefMutable >.

Definition at line 940 of file namespacedef.cpp.

941{
944 bool first=true;
945 SrcLangExt lang = getLanguage();
946 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Namespace))
947 {
948 const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
949 if (lde->kind()==LayoutDocEntry::NamespaceClasses && m_classes.declVisible() && ls)
950 {
951 DString label = "nested-classes";
952 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
953 first=false;
954 }
955 else if (lde->kind()==LayoutDocEntry::NamespaceInterfaces && m_interfaces.declVisible() && ls)
956 {
957 DString label = "interfaces";
958 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
959 first=false;
960 }
961 else if (lde->kind()==LayoutDocEntry::NamespaceStructs && m_structs.declVisible() && ls)
962 {
963 DString label = "structs";
964 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
965 first=false;
966 }
967 else if (lde->kind()==LayoutDocEntry::NamespaceRecords && m_records.declVisible() && ls)
968 {
969 DString label = "records";
970 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
971 first=false;
972 }
973 else if (lde->kind()==LayoutDocEntry::NamespaceExceptions && m_exceptions.declVisible() && ls)
974 {
975 DString label = "exceptions";
976 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
977 first=false;
978 }
979 else if (lde->kind()==LayoutDocEntry::NamespaceNestedNamespaces && m_namespaces.declVisible(false) && ls)
980 {
981 DString label = "namespaces";
982 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
983 first=false;
984 }
985 else if (lde->kind()==LayoutDocEntry::NamespaceNestedConstantGroups && m_namespaces.declVisible(true) && ls)
986 {
987 DString label = "constantgroups";
988 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
989 first=false;
990 }
991 else if (lde->kind()==LayoutDocEntry::NamespaceConcepts && m_concepts.declVisible() && ls)
992 {
993 DString label = "concepts";
994 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
995 first=false;
996 }
997 else if (lde->kind()== LayoutDocEntry::MemberDecl)
998 {
999 const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
1000 if (lmd)
1001 {
1002 MemberList * ml = getMemberList(lmd->type);
1003 if (ml && ml->declVisible())
1004 {
1005 ol.writeSummaryLink(DString(),ml->listType().toLabel(),lmd->title(lang),first);
1006 first=false;
1007 }
1008 }
1009 }
1010 }
1011 if (!first)
1012 {
1013 ol.writeString(" </div>\n");
1014 }
1015 ol.popGeneratorState();
1016}
bool declVisible(const ClassDef::CompoundType *filter=nullptr) const
Definition classlist.cpp:27
bool declVisible() const
bool declVisible() const
bool declVisible(bool isContantGroup) const
void writeSummaryLink(const DString &file, const DString &anchor, const DString &title, bool first)
Definition outputlist.h:610

References ClassLinkedRefMap::declVisible(), ConceptLinkedRefMap::declVisible(), MemberList::declVisible(), NamespaceLinkedRefMap::declVisible(), OutputList::disableAllBut(), DefinitionMixin< NamespaceDefMutable >::getLanguage(), getMemberList(), Html, LayoutDocManager::instance(), MemberList::listType(), m_classes, m_concepts, m_exceptions, m_interfaces, m_namespaces, m_records, m_structs, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), LayoutDocEntryMemberDecl::title(), LayoutDocEntrySection::title(), MemberListType::toLabel(), LayoutDocEntryMemberDecl::type, OutputList::writeString(), and OutputList::writeSummaryLink().

◆ writeTagFile()

void NamespaceDefImpl::writeTagFile ( TextStream & tagFile)
overridevirtual

Implements NamespaceDefMutable.

Definition at line 668 of file namespacedef.cpp.

669{
670 DString fn = getOutputFileBase();
672 tagFile << " <compound kind=\"namespace\">\n";
673 tagFile << " <name>" << convertToXML(name()) << "</name>\n";
674 tagFile << " <filename>" << fn << "</filename>\n";
675 DString idStr = id();
676 if (!idStr.empty())
677 {
678 tagFile << " <clangid>" << convertToXML(idStr) << "</clangid>\n";
679 }
680 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Namespace))
681 {
682 switch (lde->kind())
683 {
684 case LayoutDocEntry::NamespaceNestedNamespaces:
685 {
686 for (const auto &nd : m_namespaces)
687 {
688 if (nd->isLinkableInProject())
689 {
690 tagFile << " <namespace>" << convertToXML(nd->name()) << "</namespace>\n";
691 }
692 }
693 }
694 break;
695 case LayoutDocEntry::NamespaceClasses:
696 {
698 }
699 break;
700 case LayoutDocEntry::NamespaceInterfaces:
701 {
703 }
704 break;
705 case LayoutDocEntry::NamespaceStructs:
706 {
708 }
709 break;
710 case LayoutDocEntry::NamespaceRecords:
711 {
713 }
714 break;
715 case LayoutDocEntry::NamespaceExceptions:
716 {
718 }
719 break;
720 case LayoutDocEntry::NamespaceConcepts:
721 {
722 writeConceptsToTagFile(tagFile);
723 }
724 break;
725 case LayoutDocEntry::MemberDecl:
726 {
727 const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
728 if (lmd)
729 {
730 MemberList * ml = getMemberList(lmd->type);
731 if (ml)
732 {
733 ml->writeTagFile(tagFile);
734 }
735 }
736 }
737 break;
738 case LayoutDocEntry::MemberGroups:
739 {
740 for (const auto &mg : m_memberGroups)
741 {
742 mg->writeTagFile(tagFile);
743 }
744 }
745 break;
746 default:
747 break;
748 }
749 }
751 tagFile << " </compound>\n";
752}
void writeDocAnchorsToTagFile(TextStream &fs) const override
void writeTagFile(TextStream &, bool useQualifiedName=false, bool showNamespaceMembers=true)
void writeConceptsToTagFile(TextStream &)
void writeClassesToTagFile(TextStream &, const ClassLinkedRefMap &d)

References addHtmlExtensionIfMissing(), convertToXML(), DString::empty(), getMemberList(), getOutputFileBase(), DefinitionMixin< NamespaceDefMutable >::id(), LayoutDocManager::instance(), m_classes, m_exceptions, m_interfaces, m_memberGroups, m_namespaces, m_records, m_structs, DefinitionMixin< NamespaceDefMutable >::name(), LayoutDocEntryMemberDecl::type, writeClassesToTagFile(), writeConceptsToTagFile(), DefinitionMixin< NamespaceDefMutable >::writeDocAnchorsToTagFile(), and MemberList::writeTagFile().

Member Data Documentation

◆ fileName

DString NamespaceDefImpl::fileName
private

Definition at line 157 of file namespacedef.cpp.

Referenced by getOutputFileBase(), and setFileNameLocal().

◆ files

FileList NamespaceDefImpl::files
private

Definition at line 158 of file namespacedef.cpp.

Referenced by insertUsedFile().

◆ m_allMembers

MemberLinkedRefMap NamespaceDefImpl::m_allMembers
private

Definition at line 165 of file namespacedef.cpp.

Referenced by getMemberByName(), and insertMember().

◆ m_classes

◆ m_concepts

ConceptLinkedRefMap NamespaceDefImpl::m_concepts
private

◆ m_exceptions

ClassLinkedRefMap NamespaceDefImpl::m_exceptions
private

◆ m_incInfo

std::map<std::string, IncludeInfo> NamespaceDefImpl::m_incInfo
private

Definition at line 163 of file namespacedef.cpp.

Referenced by setIncludeFile(), and writeIncludeFiles().

◆ m_inline

bool NamespaceDefImpl::m_inline = false
private

Definition at line 179 of file namespacedef.cpp.

Referenced by isInline(), and setInline().

◆ m_innerCompounds

LinkedRefMap<const Definition> NamespaceDefImpl::m_innerCompounds
private

Definition at line 162 of file namespacedef.cpp.

Referenced by addInnerCompound(), findInnerCompound(), and numDocMembers().

◆ m_interfaces

ClassLinkedRefMap NamespaceDefImpl::m_interfaces
private

◆ m_isPublished

bool NamespaceDefImpl::m_isPublished = false
private

Definition at line 177 of file namespacedef.cpp.

Referenced by addNamespaceAttributes(), and NamespaceDefImpl().

◆ m_memberGroups

◆ m_memberLists

◆ m_namespaces

NamespaceLinkedRefMap NamespaceDefImpl::m_namespaces
private

◆ m_records

ClassLinkedRefMap NamespaceDefImpl::m_records
private

◆ m_structs

ClassLinkedRefMap NamespaceDefImpl::m_structs
private

◆ m_subGrouping

bool NamespaceDefImpl::m_subGrouping = false
private

Definition at line 175 of file namespacedef.cpp.

Referenced by addMembersToMemberGroup(), subGrouping(), and writeMemberGroups().

◆ m_type

◆ m_usingDeclList

LinkedRefMap<const Definition> NamespaceDefImpl::m_usingDeclList
private

Definition at line 161 of file namespacedef.cpp.

Referenced by addUsingDeclaration(), findInnerCompound(), and getUsedDefinitions().

◆ m_usingDirList

LinkedRefMap<NamespaceDef> NamespaceDefImpl::m_usingDirList
private

◆ metaData

DString NamespaceDefImpl::metaData
private

Definition at line 178 of file namespacedef.cpp.

Referenced by setMetaData(), and writeBriefDescription().


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