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

Public Member Functions

 FileDefImpl (const DString &p, const DString &n, const DString &ref=DString(), const DString &dn=DString())
 ~FileDefImpl () override
DefType definitionType () const override
CodeSymbolType codeSymbolType () const override
const DString & name () const override
DString displayName (bool=true) const override
DString fileName () const override
DString getOutputFileBase () const override
DString anchor () const override
DString getSourceFileBase () const override
DString includeName () const override
DString includeDependencyGraphFileName () const override
DString includedByDependencyGraphFileName () const override
DString absFilePath () const override
const DString & docName () const override
bool isSource () const override
bool isDocumentationFile () const override
const Definition * getSourceDefinition (int lineNr) const override
const MemberDef * getSourceMember (int lineNr) const override
DString getPath () const override
DString getVersion () const override
bool isLinkableInProject () const override
bool isLinkable () const override
bool isIncluded (const DString &name) const override
DirDef * getDirDef () const override
ModuleDef * getModuleDef () const override
const LinkedRefMap< NamespaceDef > & getUsedNamespaces () const override
const LinkedRefMap< const Definition > & getUsedDefinitions () const override
const IncludeInfoList & includeFileList () const override
const IncludeInfoList & includedByFileList () const override
void getAllIncludeFilesRecursively (StringVector &incFiles) const override
MemberList * getMemberList (MemberListType lt) const override
const MemberLists & getMemberLists () const override
const MemberGroupList & getMemberGroups () const override
const NamespaceLinkedRefMap & getNamespaces () const override
const ConceptLinkedRefMap & getConcepts () const override
const ClassLinkedRefMap & getClasses () const override
DString title () const override
bool hasDetailedDescription () const override
DString fileVersion () const override
bool subGrouping () const override
void countMembers () override
int numDocMembers () const override
int numDecMembers () const override
void addSourceRef (int line, const Definition *d, const MemberDef *md) override
void writeDocumentation (OutputList &ol) override
void writeMemberPages (OutputList &ol) override
void writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const override
void writeSummaryLinks (OutputList &ol) const override
void writePageNavigation (OutputList &ol) const override
void writeTagFile (TextStream &t) override
void writeSourceHeader (OutputList &ol) override
void writeSourceBody (OutputList &ol, ClangTUParser *clangParser) override
void writeSourceFooter (OutputList &ol) override
void parseSource (ClangTUParser *clangParser) override
void setDiskName (const DString &name) override
void insertMember (MemberDef *md) override
void removeMember (MemberDef *md) override
void insertClass (ClassDef *cd) override
void insertConcept (ConceptDef *cd) override
void insertNamespace (NamespaceDef *nd) override
void computeAnchors () override
void setDirDef (DirDef *dd) override
void setModuleDef (ModuleDef *mod) override
void addUsingDirective (NamespaceDef *nd) override
void addUsingDeclaration (const Definition *d) override
void combineUsingRelations () override
bool generateSourceFile () const override
void sortMemberLists () override
void addIncludeDependency (const FileDef *fd, const DString &incName, IncludeKind kind) override
void addIncludedByDependency (const FileDef *fd, const DString &incName, IncludeKind kind) override
void addMembersToMemberGroup () override
void distributeMemberGroupDocumentation () override
void findSectionsInDocumentation () override
void setIncludeFile (FileDef *fd, const DString &includeName, bool local, bool force) override
void addIncludedUsingDirectives (FileDefSet &visitedFiles) override
void addListReferences () override
void addRequirementReferences () override
bool hasIncludeGraph () const override
bool hasIncludedByGraph () const override
void overrideIncludeGraph (bool e) override
void overrideIncludedByGraph (bool e) override
bool visibleInIndex (bool &genSourceFile) const override
 Returns true if this file is visible in the index.
Public Member Functions inherited from DefinitionMixin< FileDef >
 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
bool isAnonymous () const override
const DString & localName () const override
DString qualifiedName () const override
DString symbolName () 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
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
void setName (const DString &name) 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 addInnerCompound (Definition *def) 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 Member Functions

void setDiskNameLocal (const DString &name)
void acquireFileVersion ()
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 writeIncludeFiles (OutputList &ol)
void writeIncludeGraph (OutputList &ol)
void writeIncludedByGraph (OutputList &ol)
void writeMemberGroups (OutputList &ol)
void writeAuthorSection (OutputList &ol)
void writeSourceLink (OutputList &ol)
void writeNamespaceDeclarations (OutputList &ol, const DString &title, bool isConstantGroup)
void writeClassDeclarations (OutputList &ol, const DString &title, const ClassLinkedRefMap &list)
void writeConcepts (OutputList &ol, const DString &title)
void writeInlineClasses (OutputList &ol)
void startMemberDeclarations (OutputList &ol)
void endMemberDeclarations (OutputList &ol)
void startMemberDocumentation (OutputList &ol)
void endMemberDocumentation (OutputList &ol)
void writeDetailedDescription (OutputList &ol, const DString &title)
void writeBriefDescription (OutputList &ol)
void writeClassesToTagFile (TextStream &t, const ClassLinkedRefMap &list)
void removeMemberFromList (MemberListType lt, MemberDef *md)

Private Attributes

IncludeInfoMap m_includeMap
IncludeInfoList m_includeList
IncludeInfoMap m_includedByMap
IncludeInfoList m_includedByList
LinkedRefMap< NamespaceDef > m_usingDirList
LinkedRefMap< const Definition > m_usingDeclList
std::unique_ptr< IncludeInfo > m_incInfo
DString m_path
DString m_filePath
DString m_inclDepFileName
DString m_inclByDepFileName
DString m_outputDiskName
DString m_fileName
DString m_docname
DefinitionLineMap m_srcDefMap
MemberDefLineMap m_srcMemberMap
bool m_isSource
DString m_fileVersion
DirDef * m_dir = nullptr
ModuleDef * m_moduleDef = nullptr
MemberLists m_memberLists
MemberGroupList m_memberGroups
NamespaceLinkedRefMap m_namespaces
ClassLinkedRefMap m_classes
ClassLinkedRefMap m_interfaces
ClassLinkedRefMap m_structs
ClassLinkedRefMap m_records
ClassLinkedRefMap m_exceptions
ConceptLinkedRefMap m_concepts
bool m_subGrouping
bool m_hasIncludeGraph = Config_getBool(INCLUDE_GRAPH)
bool m_hasIncludedByGraph = Config_getBool(INCLUDED_BY_GRAPH)

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 118 of file filedef.cpp.

Constructor & Destructor Documentation

◆ FileDefImpl()

FileDefImpl::FileDefImpl ( const DString & p,
const DString & nm,
const DString & lref = DString(),
const DString & dn = DString() )

create a new file definition, where p is the file path, nm the file name, and lref is an HTML anchor name if the file was read from a tag file or nullptr otherwise

Definition at line 282 of file filedef.cpp.

284 : DefinitionMixin(p+nm,1,1,nm,nullptr,nullptr,!p.empty())
285{
287 m_filePath=p+nm;
288 m_fileName=nm;
289
290 setReference(lref);
291 setDiskNameLocal(!dn.empty() ? dn : nm);
292 m_isSource = EntryType::guessSection(nm).isSource();
293 m_docname = nm;
294 m_dir = nullptr;
295 if (Config_getBool(FULL_PATH_NAMES))
296 {
298 }
300 Config_getBool(FULL_PATH_NAMES) ? m_fileName : DefinitionMixin::name()));
302 m_subGrouping=Config_getBool(SUBGROUPING);
303}
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:148
DString & prepend(const char *s)
Definition dstring.h:515
const DString & name() const override
void setLanguage(SrcLangExt lang) override
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)
static EntryType guessSection(const DString &name)
Definition types.cpp:22
DirDef * m_dir
Definition filedef.cpp:254
void setDiskNameLocal(const DString &name)
Definition filedef.cpp:310
void acquireFileVersion()
Definition filedef.cpp:1777
bool m_isSource
Definition filedef.cpp:252
DString m_path
Definition filedef.cpp:243
bool m_subGrouping
Definition filedef.cpp:265
DString m_fileName
Definition filedef.cpp:248
DString m_docname
Definition filedef.cpp:249
DString m_filePath
Definition filedef.cpp:244
#define Config_getBool(name)
Definition config.h:33
DString removeLongPathMarker(const DString &path)
Definition portable.cpp:656
SrcLangExt getLanguageFromFileName(const DString &fileName, SrcLangExt defLang)
Definition util.cpp:4177
DString stripFromPath(const DString &path)
Definition util.cpp:219

References acquireFileVersion(), Config_getBool, DefinitionMixin< FileDef >::DefinitionMixin(), DString::empty(), getLanguageFromFileName(), EntryType::guessSection(), m_dir, m_docname, m_fileName, m_filePath, m_isSource, m_path, m_subGrouping, DefinitionMixin< Base >::name(), DString::prepend(), Portable::removeLongPathMarker(), setDiskNameLocal(), DefinitionMixin< FileDef >::setLanguage(), DefinitionMixin< FileDef >::setReference(), and stripFromPath().

◆ ~FileDefImpl()

FileDefImpl::~FileDefImpl ( )
override

destroy the file definition

Definition at line 306 of file filedef.cpp.

307{
308}

Member Function Documentation

◆ absFilePath()

DString FileDefImpl::absFilePath ( ) const
inlineoverridevirtual

Returns the absolute path including the file name.

Implements FileDef.

Definition at line 137 of file filedef.cpp.

137{ return m_filePath; }

References m_filePath.

Referenced by parseSource(), and writeSourceBody().

◆ acquireFileVersion()

void FileDefImpl::acquireFileVersion ( )
private

Definition at line 1777 of file filedef.cpp.

1778{
1779 DString vercmd = Config_getString(FILE_VERSION_FILTER);
1780 if (!vercmd.empty() && !m_filePath.empty() && !isReference() &&
1781 m_filePath!="generated" && m_filePath!="graph_legend.dox")
1782 {
1783 msg("Version of {} : ",m_filePath);
1784 DString cmd = vercmd+" \""+m_filePath+"\"";
1785 Debug::print(Debug::ExtCmd,0,"Executing popen(`{}`)\n",cmd);
1786 FILE *f=Portable::popen(cmd,"r");
1787 if (!f)
1788 {
1789 err("could not execute {}\n",vercmd);
1790 return;
1791 }
1792 const int bufSize=1024;
1793 char buf[bufSize];
1794 int numRead = static_cast<int>(fread(buf,1,bufSize-1,f));
1796 if (numRead>0 && numRead<bufSize)
1797 {
1798 buf[numRead]='\0';
1799 m_fileVersion=DString(buf,numRead).stripWhiteSpace();
1800 if (!m_fileVersion.empty())
1801 {
1802 msg("{}\n",m_fileVersion);
1803 return;
1804 }
1805 }
1806 msg("no version available\n");
1807 }
1808}
DString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition dstring.h:337
@ ExtCmd
Definition debug.h:37
static void print(DebugMask mask, int prio, fmt::format_string< Args... > fmt, Args &&... args)
Definition debug.h:78
virtual bool isReference() const =0
DString m_fileVersion
Definition filedef.cpp:253
#define Config_getString(name)
Definition config.h:32
#define msg(fmt,...)
Definition message.h:94
#define err(fmt,...)
Definition message.h:127
FILE * popen(const DString &name, const DString &type)
Definition portable.cpp:495
int pclose(FILE *stream)
Definition portable.cpp:504

References Config_getString, DString::empty(), err, Debug::ExtCmd, DefinitionMixin< FileDef >::isReference(), m_filePath, m_fileVersion, msg, Portable::pclose(), Portable::popen(), Debug::print(), and DString::stripWhiteSpace().

Referenced by FileDefImpl().

◆ addIncludedByDependency()

void FileDefImpl::addIncludedByDependency ( const FileDef * fd,
const DString & incName,
IncludeKind kind )
overridevirtual

Implements FileDef.

Definition at line 1669 of file filedef.cpp.

1670{
1671 //printf("FileDefImpl::addIncludedByDependency(%p,%s,%d)\n",fd,incName,local);
1672 DString iName = fd ? fd->absFilePath() : incName;
1673 if (!iName.empty() && m_includedByMap.find(iName.str())==m_includedByMap.end())
1674 {
1675 m_includedByList.emplace_back(fd,incName,kind);
1676 m_includedByMap.emplace(iName.str(),&m_includedByList.back());
1677 }
1678}
const std::string & str() const
Definition dstring.h:645
virtual DString absFilePath() const =0
IncludeInfoList m_includedByList
Definition filedef.cpp:239
IncludeInfoMap m_includedByMap
Definition filedef.cpp:238

References FileDef::absFilePath(), DString::empty(), m_includedByList, m_includedByMap, and DString::str().

◆ addIncludeDependency()

void FileDefImpl::addIncludeDependency ( const FileDef * fd,
const DString & incName,
IncludeKind kind )
overridevirtual

Implements FileDef.

Definition at line 1610 of file filedef.cpp.

1611{
1612 //printf("FileDefImpl::addIncludeDependency(%p,%s,%d)\n",(void*)fd,qPrint(incName),kind);
1613 DString iName = fd ? fd->absFilePath() : incName;
1614 if (!iName.empty() && m_includeMap.find(iName.str())==m_includeMap.end())
1615 {
1616 m_includeList.emplace_back(fd,incName,kind);
1617 m_includeMap.emplace(iName.str(),&m_includeList.back());
1618 }
1619}
IncludeInfoMap m_includeMap
Definition filedef.cpp:236
IncludeInfoList m_includeList
Definition filedef.cpp:237

References FileDef::absFilePath(), DString::empty(), m_includeList, m_includeMap, and DString::str().

◆ addIncludedUsingDirectives()

void FileDefImpl::addIncludedUsingDirectives ( FileDefSet & visitedFiles)
overridevirtual

Implements FileDef.

Definition at line 1621 of file filedef.cpp.

1622{
1623 if (visitedFiles.find(this)!=visitedFiles.end()) return; // file already processed
1624 visitedFiles.insert(this);
1625 //printf("( FileDefImpl::addIncludedUsingDirectives for file %s\n",qPrint(name()));
1626
1627 if (!m_includeList.empty()) // file contains #includes
1628 {
1629 {
1630 for (const auto &ii : m_includeList) // foreach #include...
1631 {
1632 if (ii.fileDef) // ...that is a known file
1633 {
1634 // recurse into this file
1635 const_cast<FileDef*>(ii.fileDef)->addIncludedUsingDirectives(visitedFiles);
1636 }
1637 }
1638 }
1639 {
1640 // iterate through list from last to first
1641 for (auto ii_it = m_includeList.rbegin(); ii_it!=m_includeList.rend(); ++ii_it)
1642 {
1643 auto &ii = *ii_it;
1644 if (ii.fileDef && ii.fileDef!=this)
1645 {
1646 // add using directives
1647 auto unl = ii.fileDef->getUsedNamespaces();
1648 for (auto it = unl.rbegin(); it!=unl.rend(); ++it)
1649 {
1650 auto *nd = *it;
1651 //printf(" adding using directive for %s\n",qPrint(nd->qualifiedName()));
1652 m_usingDirList.prepend(nd->qualifiedName(),nd);
1653 }
1654 // add using declarations
1655 auto udl = ii.fileDef->getUsedDefinitions();
1656 for (auto it = udl.rbegin(); it!=udl.rend(); ++it)
1657 {
1658 auto *d = *it;
1659 m_usingDeclList.prepend(d->qualifiedName(),d);
1660 }
1661 }
1662 }
1663 }
1664 }
1665 //printf(") end FileDefImpl::addIncludedUsingDirectives for file %s\n",qPrint(name()));
1666}
void addIncludedUsingDirectives(FileDefSet &visitedFiles) override
Definition filedef.cpp:1621
LinkedRefMap< const Definition > m_usingDeclList
Definition filedef.cpp:241
LinkedRefMap< NamespaceDef > m_usingDirList
Definition filedef.cpp:240
bool prepend(const char *k, T *obj)
Definition linkedmap.h:317

References addIncludedUsingDirectives(), DString::insert(), m_includeList, m_usingDeclList, m_usingDirList, and LinkedRefMap< T, Hash, KeyEqual, Map >::prepend().

Referenced by addIncludedUsingDirectives().

◆ addListReferences()

void FileDefImpl::addListReferences ( )
overridevirtual

Implements FileDef.

Definition at line 1698 of file filedef.cpp.

1699{
1702 theTranslator->trFile(true,true),
1704 DString(),
1705 nullptr
1706 );
1707 for (const auto &mg : m_memberGroups)
1708 {
1709 mg->addListReferences(this);
1710 }
1711 for (auto &ml : m_memberLists)
1712 {
1713 if (ml->listType().isDocumentation())
1714 {
1715 ml->addListReferences(this);
1716 }
1717 }
1718}
const RefItemVector & xrefListItems() const override
const DString & name() const override
Definition filedef.cpp:1537
MemberGroupList m_memberGroups
Definition filedef.cpp:257
DString getOutputFileBase() const override
Definition filedef.cpp:1823
MemberLists m_memberLists
Definition filedef.cpp:256
virtual DString trFile(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(), getOutputFileBase(), m_memberGroups, m_memberLists, name(), theTranslator, Translator::trFile(), and DefinitionMixin< FileDef >::xrefListItems().

◆ addMembersToMemberGroup()

void FileDefImpl::addMembersToMemberGroup ( )
overridevirtual

Implements FileDef.

Definition at line 1344 of file filedef.cpp.

1345{
1346 for (auto &ml : m_memberLists)
1347 {
1348 if (ml->listType().isDeclaration())
1349 {
1351 }
1352 }
1353
1354 // add members inside sections to their groups
1355 for (const auto &mg : m_memberGroups)
1356 {
1357 if (mg->allMembersInSameSection() && m_subGrouping)
1358 {
1359 //printf("----> addToDeclarationSection(%s)\n",qPrint(mg->header()));
1360 mg->addToDeclarationSection();
1361 }
1362 }
1363}
void addMembersToMemberGroup() override
Definition filedef.cpp:1344

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

Referenced by addMembersToMemberGroup().

◆ addMemberToList()

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

Definition at line 1834 of file filedef.cpp.

1835{
1836 bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
1837 bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
1838 const auto &ml = m_memberLists.get(lt,MemberListContainer::File);
1839 ml->setNeedsSorting(
1840 (ml->listType().isDeclaration() && sortBriefDocs) ||
1841 (ml->listType().isDocumentation() && sortMemberDocs));
1842 ml->push_back(md);
1843 if (ml->listType().isDeclaration())
1844 {
1845 MemberDefMutable *mdm = toMemberDefMutable(md);
1846 if (mdm)
1847 {
1848 mdm->setSectionList(this,ml.get());
1849 }
1850 }
1851}
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, File, MemberLists::get(), m_memberLists, MemberDefMutable::setSectionList(), and toMemberDefMutable().

Referenced by insertMember().

◆ addRequirementReferences()

void FileDefImpl::addRequirementReferences ( )
overridevirtual

Implements FileDef.

Definition at line 1720 of file filedef.cpp.

1721{
1723 for (const auto &mg : m_memberGroups)
1724 {
1725 mg->addRequirementReferences(this);
1726 }
1727 for (auto &ml : m_memberLists)
1728 {
1729 if (ml->listType().isDocumentation())
1730 {
1731 ml->addRequirementReferences(this);
1732 }
1733 }
1734}
static RequirementManager & instance()
void addRequirementRefsForSymbol(const Definition *symbol)

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

◆ addSourceRef()

void FileDefImpl::addSourceRef ( int line,
const Definition * d,
const MemberDef * md )
overridevirtual

Implements FileDef.

Definition at line 1545 of file filedef.cpp.

1546{
1547 //printf("FileDefImpl::addSourceRef(%d,%s,%s)\n",line,qPrint(d?d->name():"nullptr"),qPrint(md?md->name():"nullptr"));
1548 if (d)
1549 {
1550 m_srcDefMap.emplace(line,d);
1551 if (md) m_srcMemberMap.emplace(line,md);
1552 //printf("Adding member %s with anchor %s at line %d to file %s\n",
1553 // md?qPrint(md->name()):"<none>",md?qPrint(md->anchor()):"<none>",line,qPrint(name()));
1554 }
1555}
MemberDefLineMap m_srcMemberMap
Definition filedef.cpp:251
DefinitionLineMap m_srcDefMap
Definition filedef.cpp:250

References m_srcDefMap, and m_srcMemberMap.

◆ addUsingDeclaration()

void FileDefImpl::addUsingDeclaration ( const Definition * d)
overridevirtual

Implements FileDef.

Definition at line 1584 of file filedef.cpp.

1585{
1587}
virtual DString qualifiedName() const =0
bool add(const char *k, T *obj)
Definition linkedmap.h:284

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

Referenced by combineUsingRelations().

◆ addUsingDirective()

void FileDefImpl::addUsingDirective ( NamespaceDef * nd)
overridevirtual

Implements FileDef.

Definition at line 1572 of file filedef.cpp.

1573{
1575 //printf("%p: FileDefImpl::addUsingDirective: %s:%d\n",this,qPrint(name()),usingDirList->count());
1576}

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

Referenced by combineUsingRelations().

◆ anchor()

DString FileDefImpl::anchor ( ) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 132 of file filedef.cpp.

132{ return DString(); }

◆ codeSymbolType()

CodeSymbolType FileDefImpl::codeSymbolType ( ) const
inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 126 of file filedef.cpp.

126{ return CodeSymbolType::Default; }

References Default.

◆ combineUsingRelations()

void FileDefImpl::combineUsingRelations ( )
overridevirtual

Implements FileDef.

Definition at line 1738 of file filedef.cpp.

1739{
1740 LinkedRefMap<NamespaceDef> usingDirList = m_usingDirList;
1741 NamespaceDefSet visitedNamespaces;
1742 for (auto &nd : usingDirList)
1743 {
1744 NamespaceDefMutable *ndm = toNamespaceDefMutable(nd);
1745 if (ndm)
1746 {
1747 ndm->combineUsingRelations(visitedNamespaces);
1748 }
1749 }
1750
1751 for (auto &nd : usingDirList)
1752 {
1753 // add used namespaces of namespace nd to this namespace
1754 for (const auto &und : nd->getUsedNamespaces())
1755 {
1756 addUsingDirective(und);
1757 }
1758 // add used classes of namespace nd to this namespace
1759 for (const auto &ud : nd->getUsedDefinitions())
1760 {
1762 }
1763 }
1764}
void addUsingDirective(NamespaceDef *nd) override
Definition filedef.cpp:1572
void addUsingDeclaration(const Definition *d) override
Definition filedef.cpp:1584
virtual void combineUsingRelations(NamespaceDefSet &visitedNamespace)=0
NamespaceDefMutable * toNamespaceDefMutable(Definition *d)
std::unordered_set< const NamespaceDef * > NamespaceDefSet

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

◆ computeAnchors()

void FileDefImpl::computeAnchors ( )
overridevirtual

Compute the HTML anchor names for all members in the class

Implements FileDef.

Definition at line 332 of file filedef.cpp.

333{
334 MemberList *ml = getMemberList(MemberListType::AllMembersList());
335 if (ml) ml->setAnchors();
336}
MemberList * getMemberList(MemberListType lt) const override
Definition filedef.cpp:1900
void setAnchors()

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

◆ countMembers()

void FileDefImpl::countMembers ( )
overridevirtual

Implements FileDef.

Definition at line 1991 of file filedef.cpp.

1992{
1993 for (auto &ml : m_memberLists)
1994 {
1995 ml->countDecMembers();
1996 ml->countDocMembers();
1997 }
1998 for (const auto &mg : m_memberGroups)
1999 {
2000 mg->countDecMembers();
2001 mg->countDocMembers();
2002 }
2003}

References m_memberGroups, and m_memberLists.

◆ definitionType()

DefType FileDefImpl::definitionType ( ) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 125 of file filedef.cpp.

125{ return TypeFile; }

References definitionType(), and Definition::TypeFile.

Referenced by definitionType().

◆ displayName()

DString FileDefImpl::displayName ( bool includeScope = true) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 129 of file filedef.cpp.

129{ return localName(); }
const DString & localName() const override

References DefinitionMixin< FileDef >::localName().

Referenced by writeDocumentation().

◆ distributeMemberGroupDocumentation()

void FileDefImpl::distributeMemberGroupDocumentation ( )
overridevirtual

Implements FileDef.

Definition at line 338 of file filedef.cpp.

339{
340 //printf("FileDefImpl::distributeMemberGroupDocumentation()\n");
341 for (const auto &mg : m_memberGroups)
342 {
343 mg->distributeMemberGroupDocumentation();
344 }
345}

References m_memberGroups.

◆ docName()

const DString & FileDefImpl::docName ( ) const
inlineoverridevirtual

Returns the name as it is used in the documentation

Implements FileDef.

Definition at line 138 of file filedef.cpp.

138{ return m_docname; }

References m_docname.

◆ endMemberDeclarations()

void FileDefImpl::endMemberDeclarations ( OutputList & ol)
private

Definition at line 791 of file filedef.cpp.

792{
794}
void endMemberSections()
Definition outputlist.h:459

References OutputList::endMemberSections().

Referenced by writeDocumentation().

◆ endMemberDocumentation()

void FileDefImpl::endMemberDocumentation ( OutputList & ol)
private

Definition at line 805 of file filedef.cpp.

806{
807 if (Config_getBool(SEPARATE_MEMBER_PAGES))
808 {
811 }
812}
static bool suppressDocWarnings
Definition doxygen.h:123
void enable(OutputType o)

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

Referenced by writeDocumentation().

◆ fileName()

DString FileDefImpl::fileName ( ) const
inlineoverridevirtual

Returns the unique file name (this may include part of the path).

Implements FileDef.

Definition at line 130 of file filedef.cpp.

130{ return m_fileName; }

References m_fileName.

◆ fileVersion()

DString FileDefImpl::fileVersion ( ) const
overridevirtual

Implements FileDef.

Definition at line 1976 of file filedef.cpp.

1977{
1978 return m_fileVersion;
1979}

References m_fileVersion.

◆ findSectionsInDocumentation()

void FileDefImpl::findSectionsInDocumentation ( )
overridevirtual

Implements FileDef.

Definition at line 347 of file filedef.cpp.

348{
352 for (const auto &mg : m_memberGroups)
353 {
354 mg->findSectionsInDocumentation(this);
355 }
356
357 for (auto &ml : m_memberLists)
358 {
359 if (ml->listType().isDeclaration())
360 {
361 ml->findSectionsInDocumentation(this);
362 }
363 }
364}
DString docFile() const override
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< FileDef >::briefDescription(), DefinitionMixin< FileDef >::docFile(), docFindSections(), DefinitionMixin< FileDef >::documentation(), DefinitionMixin< FileDef >::inbodyDocumentation(), m_memberGroups, and m_memberLists.

◆ generateSourceFile()

bool FileDefImpl::generateSourceFile ( ) const
overridevirtual

Implements FileDef.

Definition at line 1686 of file filedef.cpp.

1687{
1688 bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
1689 bool verbatimHeaders = Config_getBool(VERBATIM_HEADERS);
1690 return !isReference() &&
1691 (sourceBrowser ||
1692 (verbatimHeaders && (EntryType::guessSection(name()).isHeader() || !m_includedByMap.empty()))
1693 ) &&
1695}
bool isReference() const override
bool isDocumentationFile() const override
Definition filedef.cpp:1766

References Config_getBool, EntryType::guessSection(), isDocumentationFile(), DefinitionMixin< FileDef >::isReference(), m_includedByMap, and name().

Referenced by visibleInIndex(), writeSourceHeader(), and writeSourceLink().

◆ getAllIncludeFilesRecursively()

void FileDefImpl::getAllIncludeFilesRecursively ( StringVector & incFiles) const
overridevirtual

Implements FileDef.

Definition at line 1958 of file filedef.cpp.

1959{
1960 StringUnorderedSet includes;
1961 ::getAllIncludeFilesRecursively(includes,this,incFiles);
1962}
void getAllIncludeFilesRecursively(StringVector &incFiles) const override
Definition filedef.cpp:1958
std::unordered_set< std::string > StringUnorderedSet
Definition containers.h:29

References getAllIncludeFilesRecursively().

Referenced by getAllIncludeFilesRecursively().

◆ getClasses()

const ClassLinkedRefMap & FileDefImpl::getClasses ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 160 of file filedef.cpp.

160{ return m_classes; }
ClassLinkedRefMap m_classes
Definition filedef.cpp:259

References m_classes.

◆ getConcepts()

const ConceptLinkedRefMap & FileDefImpl::getConcepts ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 159 of file filedef.cpp.

159{ return m_concepts; }
ConceptLinkedRefMap m_concepts
Definition filedef.cpp:264

References m_concepts.

◆ getDirDef()

DirDef * FileDefImpl::getDirDef ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 148 of file filedef.cpp.

148{ return m_dir; }

References m_dir.

Referenced by writeDocumentation(), and writeSourceHeader().

◆ getMemberGroups()

const MemberGroupList & FileDefImpl::getMemberGroups ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 157 of file filedef.cpp.

157{ return m_memberGroups; }

References m_memberGroups.

◆ getMemberList()

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

Implements FileDef.

Definition at line 1900 of file filedef.cpp.

1901{
1902 for (auto &ml : m_memberLists)
1903 {
1904 if (ml->listType()==lt)
1905 {
1906 return ml.get();
1907 }
1908 }
1909 return nullptr;
1910}

References m_memberLists.

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

◆ getMemberLists()

const MemberLists & FileDefImpl::getMemberLists ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 156 of file filedef.cpp.

156{ return m_memberLists; }

References m_memberLists.

◆ getModuleDef()

ModuleDef * FileDefImpl::getModuleDef ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 149 of file filedef.cpp.

149{ return m_moduleDef; }
ModuleDef * m_moduleDef
Definition filedef.cpp:255

References m_moduleDef.

◆ getNamespaces()

const NamespaceLinkedRefMap & FileDefImpl::getNamespaces ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 158 of file filedef.cpp.

158{ return m_namespaces; }
NamespaceLinkedRefMap m_namespaces
Definition filedef.cpp:258

References m_namespaces.

◆ getOutputFileBase()

DString FileDefImpl::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 1823 of file filedef.cpp.

1824{
1825 return m_outputDiskName;
1826}
DString m_outputDiskName
Definition filedef.cpp:247

References m_outputDiskName.

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

◆ getPath()

DString FileDefImpl::getPath ( ) const
inlineoverridevirtual

Returns the absolute path of this file.

Implements FileDef.

Definition at line 143 of file filedef.cpp.

143{ return m_path; }

References m_path.

Referenced by writeTagFile().

◆ getSourceDefinition()

const Definition * FileDefImpl::getSourceDefinition ( int lineNr) const
overridevirtual

Implements FileDef.

Definition at line 1557 of file filedef.cpp.

1558{
1559 auto it = m_srcDefMap.find(lineNr);
1560 //printf("%s::getSourceDefinition(%d)=%s\n",qPrint(name()),lineNr,it!=m_srcDefMap.end()?qPrint(it->second->name()):"none");
1561 return it!=m_srcDefMap.end() ? it->second : nullptr;
1562}

References m_srcDefMap.

◆ getSourceFileBase()

DString FileDefImpl::getSourceFileBase ( ) const
overridevirtual

Returns the name of the source listing of this definition.

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 1811 of file filedef.cpp.

1812{
1813 if (Htags::useHtags)
1814 {
1816 }
1817 else
1818 {
1819 return m_outputDiskName+"_source";
1820 }
1821}
static DString path2URL(const DString &path)
Definition htags.cpp:159
static bool useHtags
Definition htags.h:23

References m_filePath, m_outputDiskName, Htags::path2URL(), and Htags::useHtags.

Referenced by includeName(), writeDetailedDescription(), and writeSourceHeader().

◆ getSourceMember()

const MemberDef * FileDefImpl::getSourceMember ( int lineNr) const
overridevirtual

Implements FileDef.

Definition at line 1564 of file filedef.cpp.

1565{
1566 auto it = m_srcMemberMap.find(lineNr);
1567 //printf("%s::getSourceMember(%d)=%s\n",qPrint(name()),lineNr,it!=m_srcMemberMap.end()?qPrint(it->second->name()):"none");
1568 return it!=m_srcMemberMap.end() ? it->second : nullptr;
1569}

References m_srcMemberMap.

◆ getUsedDefinitions()

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

Implements FileDef.

Definition at line 151 of file filedef.cpp.

151{ return m_usingDeclList; }

References m_usingDeclList.

◆ getUsedNamespaces()

const LinkedRefMap< NamespaceDef > & FileDefImpl::getUsedNamespaces ( ) const
overridevirtual

Implements FileDef.

Definition at line 1578 of file filedef.cpp.

1579{
1580 //printf("%p: FileDefImpl::getUsedNamespace: %s:%d\n",this,qPrint(name()),usingDirList?usingDirList->count():0);
1581 return m_usingDirList;
1582}

References m_usingDirList.

◆ getVersion()

DString FileDefImpl::getVersion ( ) const
inlineoverridevirtual

Returns version of this file.

Implements FileDef.

Definition at line 144 of file filedef.cpp.

144{ return m_fileVersion; }

References m_fileVersion.

◆ hasDetailedDescription()

bool FileDefImpl::hasDetailedDescription ( ) const
overridevirtual

Implements FileDef.

Definition at line 366 of file filedef.cpp.

367{
368 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
369 bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
370 return ((!briefDescription().empty() && repeatBrief) ||
371 !documentation().stripWhiteSpace().empty() || // avail empty section
372 (sourceBrowser && getStartBodyLine()!=-1 && getBodyDef()) ||
374 );
375}
bool hasRequirementRefs() const override
const FileDef * getBodyDef() const override
int getStartBodyLine() const override
std::string_view stripWhiteSpace(std::string_view s)
Given a string view s, returns a new, narrower view on that string, skipping over any leading or trai...
Definition stringutil.h:75

References DefinitionMixin< FileDef >::briefDescription(), Config_getBool, DefinitionMixin< FileDef >::documentation(), DefinitionMixin< FileDef >::getBodyDef(), DefinitionMixin< FileDef >::getStartBodyLine(), DefinitionMixin< FileDef >::hasRequirementRefs(), and stripWhiteSpace().

Referenced by writeDetailedDescription().

◆ hasIncludedByGraph()

bool FileDefImpl::hasIncludedByGraph ( ) const
overridevirtual

Implements FileDef.

Definition at line 2032 of file filedef.cpp.

2033{
2034 return m_hasIncludedByGraph;
2035}
bool m_hasIncludedByGraph
Definition filedef.cpp:267

References m_hasIncludedByGraph.

◆ hasIncludeGraph()

bool FileDefImpl::hasIncludeGraph ( ) const
overridevirtual

Implements FileDef.

Definition at line 2027 of file filedef.cpp.

2028{
2029 return m_hasIncludeGraph;
2030}
bool m_hasIncludeGraph
Definition filedef.cpp:266

References m_hasIncludeGraph.

◆ includedByDependencyGraphFileName()

DString FileDefImpl::includedByDependencyGraphFileName ( ) const
overridevirtual

Implements FileDef.

Definition at line 1986 of file filedef.cpp.

1987{
1988 return m_inclByDepFileName;
1989}
DString m_inclByDepFileName
Definition filedef.cpp:246

References m_inclByDepFileName.

◆ includedByFileList()

const IncludeInfoList & FileDefImpl::includedByFileList ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 153 of file filedef.cpp.

153{ return m_includedByList; }

References m_includedByList.

◆ includeDependencyGraphFileName()

DString FileDefImpl::includeDependencyGraphFileName ( ) const
overridevirtual

Implements FileDef.

Definition at line 1981 of file filedef.cpp.

1982{
1983 return m_inclDepFileName;
1984}
DString m_inclDepFileName
Definition filedef.cpp:245

References m_inclDepFileName.

◆ includeFileList()

const IncludeInfoList & FileDefImpl::includeFileList ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 152 of file filedef.cpp.

152{ return m_includeList; }

References m_includeList.

◆ includeName()

DString FileDefImpl::includeName ( ) const
overridevirtual

Returns the name of the verbatim copy of this file (if any).

Implements FileDef.

Definition at line 1829 of file filedef.cpp.

1830{
1831 return getSourceFileBase();
1832}
DString getSourceFileBase() const override
Definition filedef.cpp:1811

References getSourceFileBase().

Referenced by setIncludeFile(), and writeSourceLink().

◆ insertClass()

void FileDefImpl::insertClass ( ClassDef * cd)
overridevirtual

Adds compound definition cd to the list of all compounds of this file

Implements FileDef.

Definition at line 1495 of file filedef.cpp.

1496{
1497 if (cd->isHidden()) return;
1498
1499 ClassLinkedRefMap *list = &m_classes;
1500
1501 if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
1502 {
1504 {
1505 list = &m_interfaces;
1506 }
1507 else if (cd->compoundType()==ClassDef::Struct)
1508 {
1509 list = &m_structs;
1510 }
1511 else if (cd->compoundType()==ClassDef::Record)
1512 {
1513 list = &m_records;
1514 }
1515 else if (cd->compoundType()==ClassDef::Exception)
1516 {
1517 list = &m_exceptions;
1518 }
1519 }
1520
1521 list->add(cd->name(),cd);
1522}
@ 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/...
virtual const DString & name() const =0
virtual bool isHidden() const =0
ClassLinkedRefMap m_interfaces
Definition filedef.cpp:260
ClassLinkedRefMap m_structs
Definition filedef.cpp:261
ClassLinkedRefMap m_exceptions
Definition filedef.cpp:263
ClassLinkedRefMap m_records
Definition filedef.cpp:262

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

◆ insertConcept()

void FileDefImpl::insertConcept ( ConceptDef * cd)
overridevirtual

Implements FileDef.

Definition at line 1524 of file filedef.cpp.

1525{
1526 if (cd->isHidden()) return;
1527 m_concepts.add(cd->name(),cd);
1528}

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

◆ insertMember()

void FileDefImpl::insertMember ( MemberDef * md)
overridevirtual

Adds member definition md to the list of all members of this file

Implements FileDef.

Definition at line 1366 of file filedef.cpp.

1367{
1368 if (md->isHidden()) return;
1369 MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
1370 //printf("%s:FileDefImpl::insertMember(%s (=%p) list has %zu elements)\n",
1371 // qPrint(name()),qPrint(md->name()),(void*)md,allMemberList ? allMemberList->size() : 0);
1372 if (allMemberList && allMemberList->contains(md))
1373 {
1374 //printf("already added\n");
1375 return;
1376 }
1377
1378 if (allMemberList==nullptr)
1379 {
1380 m_memberLists.emplace_back(std::make_unique<MemberList>(MemberListType::AllMembersList(),MemberListContainer::File));
1381 allMemberList = m_memberLists.back().get();
1382 }
1383 allMemberList->push_back(md);
1384 switch (md->memberType())
1385 {
1386 case MemberType::Property:
1387 if (md->getLanguage() == SrcLangExt::Python)
1388 {
1389 addMemberToList(MemberListType::PropertyMembers(),md);
1390 addMemberToList(MemberListType::Properties(),md);
1391 break;
1392 }
1393 // fallthrough, explicitly no break here
1394 case MemberType::Variable:
1395 if (md->anonymousMemberForDeclaration()==nullptr) // not a split member that has a separate declaration member
1396 {
1397 addMemberToList(MemberListType::DecVarMembers(),md);
1398 }
1399 if (!md->isAnonymous() && md->anonymousMemberForDetails()==nullptr) // not a split member that has a separate details member
1400 {
1401 addMemberToList(MemberListType::DocVarMembers(),md);
1402 }
1403 break;
1404 case MemberType::Function:
1405 addMemberToList(MemberListType::DecFuncMembers(),md);
1406 addMemberToList(MemberListType::DocFuncMembers(),md);
1407 break;
1408 case MemberType::Typedef:
1409 addMemberToList(MemberListType::DecTypedefMembers(),md);
1410 addMemberToList(MemberListType::DocTypedefMembers(),md);
1411 break;
1412 case MemberType::Sequence:
1413 addMemberToList(MemberListType::DecSequenceMembers(),md);
1414 addMemberToList(MemberListType::DocSequenceMembers(),md);
1415 break;
1416 case MemberType::Dictionary:
1417 addMemberToList(MemberListType::DecDictionaryMembers(),md);
1418 addMemberToList(MemberListType::DocDictionaryMembers(),md);
1419 break;
1420 case MemberType::Enumeration:
1421 addMemberToList(MemberListType::DecEnumMembers(),md);
1422 addMemberToList(MemberListType::DocEnumMembers(),md);
1423 break;
1424 case MemberType::EnumValue: // enum values are shown inside their enums
1425 break;
1426 case MemberType::Define:
1427 addMemberToList(MemberListType::DecDefineMembers(),md);
1428 addMemberToList(MemberListType::DocDefineMembers(),md);
1429 break;
1430 default:
1431 err("FileDefImpl::insertMembers(): "
1432 "member '{}' with class scope '{}' inserted in file scope '{}'!\n",
1433 md->name(),
1434 md->getClassDef() ? md->getClassDef()->name() : "<global>",
1435 name());
1436 }
1437 //addMemberToGroup(md,groupId);
1438}
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual bool isAnonymous() const =0
void addMemberToList(MemberListType lt, MemberDef *md)
Definition filedef.cpp:1834
virtual const ClassDef * getClassDef() const =0
virtual const MemberDef * anonymousMemberForDeclaration() const =0
virtual const MemberDef * anonymousMemberForDetails() const =0
virtual MemberType memberType() const =0
bool contains(const MemberDef *md) const
Definition memberlist.h:90
void push_back(const T &value)
Definition memberlist.h:49

References addMemberToList(), MemberDef::anonymousMemberForDeclaration(), MemberDef::anonymousMemberForDetails(), MemberVector::contains(), err, File, MemberLists::get(), MemberDef::getClassDef(), Definition::getLanguage(), getMemberList(), Definition::isAnonymous(), Definition::isHidden(), m_memberLists, MemberDef::memberType(), Definition::name(), name(), and MemberVector::push_back().

◆ insertNamespace()

void FileDefImpl::insertNamespace ( NamespaceDef * nd)
overridevirtual

Adds namespace definition nd to the list of all compounds of this file

Implements FileDef.

Definition at line 1531 of file filedef.cpp.

1532{
1533 if (nd->isHidden()) return;
1534 m_namespaces.add(nd->name(),nd);
1535}

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

◆ isDocumentationFile()

bool FileDefImpl::isDocumentationFile ( ) const
overridevirtual

Implements FileDef.

Definition at line 1766 of file filedef.cpp.

1767{
1768 static const std::unordered_set<std::string> docExtensions =
1769 { "doc", "txt", "dox", "md", "markdown" };
1770
1771 size_t lastDot = name().rfind('.');
1772 return (lastDot!=DString::npos &&
1773 docExtensions.find(name().mid(lastDot+1).str())!=docExtensions.end()) ||
1774 getLanguageFromFileName(getFileNameExtension(name())) == SrcLangExt::Markdown;
1775}
size_t rfind(char c, size_t pos=npos) const
Definition dstring.h:244
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
DString getFileNameExtension(const DString &fn)
Definition util.cpp:4219

References getFileNameExtension(), getLanguageFromFileName(), name(), DString::npos, and DString::rfind().

Referenced by generateSourceFile(), visibleInIndex(), and writeSourceHeader().

◆ isIncluded()

bool FileDefImpl::isIncluded ( const DString & name) const
overridevirtual

Implements FileDef.

Definition at line 1680 of file filedef.cpp.

1681{
1682 if (name.empty()) return false;
1683 return m_includeMap.find(name.str())!=m_includeMap.end();
1684}

References m_includeMap, and name().

◆ isLinkable()

bool FileDefImpl::isLinkable ( ) const
inlineoverridevirtual

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 146 of file filedef.cpp.

146{ return isLinkableInProject() || isReference(); }
bool isLinkableInProject() const override
Definition filedef.cpp:1936

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

Referenced by visibleInIndex(), and writeSourceHeader().

◆ isLinkableInProject()

bool FileDefImpl::isLinkableInProject ( ) const
overridevirtual

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

Implements Definition.

Definition at line 1936 of file filedef.cpp.

1937{
1938 bool showFiles = Config_getBool(SHOW_FILES);
1939 return hasDocumentation() && !isReference() && (showFiles || isLinkableViaGroup());
1940}
bool isLinkableViaGroup() const override
bool hasDocumentation() const override

References Config_getBool, DefinitionMixin< FileDef >::hasDocumentation(), DefinitionMixin< FileDef >::isLinkableViaGroup(), and DefinitionMixin< FileDef >::isReference().

Referenced by isLinkable(), and visibleInIndex().

◆ isSource()

bool FileDefImpl::isSource ( ) const
inlineoverridevirtual

Returns true if this file is a source file.

Implements FileDef.

Definition at line 139 of file filedef.cpp.

139{ return m_isSource; }

References m_isSource.

◆ name()

const DString & FileDefImpl::name ( ) const
overridevirtual

◆ numDecMembers()

int FileDefImpl::numDecMembers ( ) const
overridevirtual

Implements FileDef.

Definition at line 2011 of file filedef.cpp.

2012{
2013 MemberList *ml = getMemberList(MemberListType::AllMembersList());
2014 return ml ? ml->numDecMembers() : 0;
2015}
int numDecMembers(const ClassDef *inheritedFrom) const
Definition memberlist.h:134

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

◆ numDocMembers()

int FileDefImpl::numDocMembers ( ) const
overridevirtual

Implements FileDef.

Definition at line 2005 of file filedef.cpp.

2006{
2007 MemberList *ml = getMemberList(MemberListType::AllMembersList());
2008 return ml ? ml->numDocMembers() : 0;
2009}
int numDocMembers() const
Definition memberlist.h:139

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

◆ overrideIncludedByGraph()

void FileDefImpl::overrideIncludedByGraph ( bool e)
overridevirtual

Implements FileDef.

Definition at line 2022 of file filedef.cpp.

2023{
2025}

References m_hasIncludedByGraph.

◆ overrideIncludeGraph()

void FileDefImpl::overrideIncludeGraph ( bool e)
overridevirtual

Implements FileDef.

Definition at line 2017 of file filedef.cpp.

2018{
2020}

References m_hasIncludeGraph.

◆ parseSource()

void FileDefImpl::parseSource ( ClangTUParser * clangParser)
overridevirtual

Implements FileDef.

Definition at line 1315 of file filedef.cpp.

1316{
1317 bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
1318 OutputCodeList devNullList;
1319 devNullList.add<DevNullCodeGenerator>();
1320#if USE_LIBCLANG
1321 if (Doxygen::clangAssistedParsing && clangParser &&
1322 (getLanguage()==SrcLangExt::Cpp || getLanguage()==SrcLangExt::ObjC))
1323 {
1324 clangParser->switchToFile(this);
1325 clangParser->writeSources(devNullList,this);
1326 }
1327 else
1328#endif
1329 {
1331 intf->resetCodeParserState();
1332 size_t indent = 0;
1333 intf->parseCode(
1334 devNullList,DString(),
1335 detab(fileToString(absFilePath(),filterSourceFiles,true),indent),
1336 getLanguage(),
1337 Config_getBool(STRIP_CODE_COMMENTS),
1338 CodeParserOptions()
1339 .setFileDef(this)
1340 );
1341 }
1342}
void switchToFile(const FileDef *fd)
Switches to another file within the translation unit started with start().
void writeSources(OutputCodeList &ol, const FileDef *fd)
writes the syntax highlighted source code for a file
DString getDefFileExtension() const override
SrcLangExt getLanguage() const override
static bool clangAssistedParsing
Definition doxygen.h:129
static ParserManager * parserManager
Definition doxygen.h:122
DString absFilePath() const override
Definition filedef.cpp:137
void add(OutputCodeIntfPtr &&p)
Definition outputlist.h:192
std::unique_ptr< CodeParserInterface > getCodeParser(const DString &extension)
Gets the interface to the parser associated with a given extension.
Definition parserintf.h:253
DString detab(const DString &s, size_t &refIndent)
Definition util.cpp:5207
DString fileToString(const DString &name, bool filter, bool isSourceCode)
Definition util.cpp:1058

References absFilePath(), OutputCodeList::add(), Doxygen::clangAssistedParsing, Config_getBool, detab(), fileToString(), ParserManager::getCodeParser(), DefinitionMixin< FileDef >::getDefFileExtension(), DefinitionMixin< FileDef >::getLanguage(), and Doxygen::parserManager.

◆ removeMember()

void FileDefImpl::removeMember ( MemberDef * md)
overridevirtual

Implements FileDef.

Definition at line 1446 of file filedef.cpp.

1447{
1448 removeMemberFromList(MemberListType::AllMembersList(),md);
1449 switch(md->memberType())
1450 {
1451 case MemberType::Property:
1452 if (md->getLanguage() == SrcLangExt::Python)
1453 {
1454 removeMemberFromList(MemberListType::PropertyMembers(),md);
1455 removeMemberFromList(MemberListType::Properties(),md);
1456 break;
1457 }
1458 // fallthrough, explicitly no break here
1459 case MemberType::Variable:
1460 removeMemberFromList(MemberListType::DecVarMembers(),md);
1461 removeMemberFromList(MemberListType::DocVarMembers(),md);
1462 break;
1463 case MemberType::Function:
1464 removeMemberFromList(MemberListType::DecFuncMembers(),md);
1465 removeMemberFromList(MemberListType::DocFuncMembers(),md);
1466 break;
1467 case MemberType::Typedef:
1468 removeMemberFromList(MemberListType::DecTypedefMembers(),md);
1469 removeMemberFromList(MemberListType::DocTypedefMembers(),md);
1470 break;
1471 case MemberType::Sequence:
1472 removeMemberFromList(MemberListType::DecSequenceMembers(),md);
1473 removeMemberFromList(MemberListType::DocSequenceMembers(),md);
1474 break;
1475 case MemberType::Dictionary:
1476 removeMemberFromList(MemberListType::DecDictionaryMembers(),md);
1477 removeMemberFromList(MemberListType::DocDictionaryMembers(),md);
1478 break;
1479 case MemberType::Enumeration:
1480 removeMemberFromList(MemberListType::DecEnumMembers(),md);
1481 removeMemberFromList(MemberListType::DocEnumMembers(),md);
1482 break;
1483 case MemberType::EnumValue: // enum values are shown inside their enums
1484 break;
1485 case MemberType::Define:
1486 removeMemberFromList(MemberListType::DecDefineMembers(),md);
1487 removeMemberFromList(MemberListType::DocDefineMembers(),md);
1488 break;
1489 default:
1490 err("FileDefImpl::removeMember(): unexpected member remove in file!\n");
1491 }
1492}
void removeMemberFromList(MemberListType lt, MemberDef *md)
Definition filedef.cpp:1440

References err, Definition::getLanguage(), MemberDef::memberType(), and removeMemberFromList().

◆ removeMemberFromList()

void FileDefImpl::removeMemberFromList ( MemberListType lt,
MemberDef * md )
private

Definition at line 1440 of file filedef.cpp.

1441{
1442 MemberList *ml = getMemberList(lt);
1443 if (ml) ml->remove(md);
1444}
void remove(const MemberDef *md)
Definition memberlist.h:85

References getMemberList(), and MemberVector::remove().

Referenced by removeMember().

◆ setDirDef()

void FileDefImpl::setDirDef ( DirDef * dd)
inlineoverridevirtual

Implements FileDef.

Definition at line 186 of file filedef.cpp.

186{ m_dir=dd; }

References m_dir.

◆ setDiskName()

void FileDefImpl::setDiskName ( const DString & name)
overridevirtual

Implements FileDef.

Definition at line 326 of file filedef.cpp.

327{
329}

References name(), and setDiskNameLocal().

◆ setDiskNameLocal()

void FileDefImpl::setDiskNameLocal ( const DString & name)
private

Definition at line 310 of file filedef.cpp.

311{
312 if (isReference())
313 {
315 m_inclDepFileName = name+"_incl";
316 m_inclByDepFileName = name+"_dep_incl";
317 }
318 else
319 {
323 }
324}
DString convertNameToFile(const DString &name, bool allowDots, bool allowUnderscore)
Definition util.cpp:2872

References convertNameToFile(), DefinitionMixin< FileDef >::isReference(), m_inclByDepFileName, m_inclDepFileName, m_outputDiskName, and name().

Referenced by FileDefImpl(), and setDiskName().

◆ setIncludeFile()

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

Implements FileDef.

Definition at line 1589 of file filedef.cpp.

1591{
1592 //printf("FileDefImpl::setIncludeFile(%p,%s,%d,%d)\n",fd,includeName,local,force);
1593 if (!m_incInfo) m_incInfo = std::make_unique<IncludeInfo>();
1594 if ((!includeName.empty() && m_incInfo->includeName.empty()) ||
1595 (fd!=nullptr && m_incInfo->fileDef==nullptr)
1596 )
1597 {
1598 //printf("Setting file info\n");
1599 m_incInfo->fileDef = fd;
1600 m_incInfo->includeName = includeName;
1602 }
1603 if (force && !includeName.empty())
1604 {
1605 m_incInfo->includeName = includeName;
1607 }
1608}
std::unique_ptr< IncludeInfo > m_incInfo
Definition filedef.cpp:242
DString includeName() const override
Definition filedef.cpp:1829
@ IncludeLocal
Definition filedef.h:47
@ IncludeSystem
Definition filedef.h:46

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

◆ setModuleDef()

void FileDefImpl::setModuleDef ( ModuleDef * mod)
inlineoverridevirtual

Implements FileDef.

Definition at line 187 of file filedef.cpp.

187{ m_moduleDef=mod; }

References m_moduleDef.

◆ sortMemberLists()

void FileDefImpl::sortMemberLists ( )
overridevirtual

Implements FileDef.

Definition at line 1853 of file filedef.cpp.

1854{
1855 for (auto &ml : m_memberLists)
1856 {
1857 if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(false); }
1858 }
1859
1860 for (const auto &mg : m_memberGroups)
1861 {
1862 MemberList &mlg = const_cast<MemberList&>(mg->members());
1863 if (mlg.needsSorting()) { mlg.sort(); mlg.setNeedsSorting(false); }
1864 }
1865
1866 std::stable_sort(m_includedByList.begin(),m_includedByList.end(),
1867 [](const auto &fi1,const auto &fi2) { return fi1.includeName < fi2.includeName; });
1868
1869 if (Config_getBool(SORT_BRIEF_DOCS))
1870 {
1871 auto classComp = [](const ClassLinkedRefMap::Ptr &c1,const ClassLinkedRefMap::Ptr &c2)
1872 {
1873 return Config_getBool(SORT_BY_SCOPE_NAME) ?
1874 dstricmp_sort(c1->displayName(), c2->displayName())<0 :
1875 dstricmp_sort(c1->className(), c2->className())<0;
1876 };
1877
1878 std::stable_sort(m_classes.begin(), m_classes.end(), classComp);
1879 std::stable_sort(m_interfaces.begin(),m_interfaces.end(),classComp);
1880 std::stable_sort(m_structs.begin(), m_structs.end(), classComp);
1881 std::stable_sort(m_records.begin(), m_records.end(), classComp);
1882 std::stable_sort(m_exceptions.begin(),m_exceptions.end(),classComp);
1883
1884 auto conceptComp = [](const ConceptLinkedRefMap::Ptr &c1,const ConceptLinkedRefMap::Ptr &c2)
1885 {
1886 return dstricmp_sort(c1->name(),c2->name())<0;
1887 };
1888
1889 std::stable_sort(m_concepts.begin(), m_concepts.end(), conceptComp);
1890
1891 auto namespaceComp = [](const NamespaceLinkedRefMap::Ptr &n1,const NamespaceLinkedRefMap::Ptr &n2)
1892 {
1893 return dstricmp_sort(n1->name(),n2->name())<0;
1894 };
1895
1896 std::stable_sort(m_namespaces.begin(),m_namespaces.end(),namespaceComp);
1897 }
1898}
virtual DString className() const =0
Returns the name of the class including outer classes, but not including namespaces.
virtual DString displayName(bool includeScope=true) const =0
iterator end()
Definition linkedmap.h:367
iterator begin()
Definition linkedmap.h:366
bool needsSorting() const
Definition memberlist.h:141
void setNeedsSorting(bool b)
void sort()
Definition memberlist.h:77
int dstricmp_sort(const char *str1, const char *str2)
Definition dstring.h:67

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

◆ startMemberDeclarations()

void FileDefImpl::startMemberDeclarations ( OutputList & ol)
private

Definition at line 786 of file filedef.cpp.

787{
789}
void startMemberSections()
Definition outputlist.h:457

References OutputList::startMemberSections().

Referenced by writeDocumentation().

◆ startMemberDocumentation()

void FileDefImpl::startMemberDocumentation ( OutputList & ol)
private

Definition at line 796 of file filedef.cpp.

797{
798 if (Config_getBool(SEPARATE_MEMBER_PAGES))
799 {
802 }
803}
void disable(OutputType o)

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

Referenced by writeDocumentation().

◆ subGrouping()

bool FileDefImpl::subGrouping ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 164 of file filedef.cpp.

164{ return m_subGrouping; }

References m_subGrouping.

◆ title()

DString FileDefImpl::title ( ) const
overridevirtual

Implements FileDef.

Definition at line 1964 of file filedef.cpp.

1965{
1966 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
1967 {
1968 return name();
1969 }
1970 else
1971 {
1973 }
1974}
virtual DString trFileReference(const DString &fileName)=0

References Config_getBool, name(), theTranslator, and Translator::trFileReference().

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

◆ visibleInIndex()

bool FileDefImpl::visibleInIndex ( bool & genSourceFile) const
overridevirtual

Returns true if this file is visible in the index.

The parameter genSourceFile is set to true if this file is only linkable as a source file.

Implements FileDef.

Definition at line 2037 of file filedef.cpp.

2038{
2039 bool allExternals = Config_getBool(ALLEXTERNALS);
2040 bool isDocFile = isDocumentationFile();
2041 genSourceFile = !isDocFile && generateSourceFile();
2042 return ((allExternals && isLinkable()) || isLinkableInProject()) && !isDocFile;
2043}
bool generateSourceFile() const override
Definition filedef.cpp:1686
bool isLinkable() const override
Definition filedef.cpp:146

References Config_getBool, generateSourceFile(), isDocumentationFile(), isLinkable(), and isLinkableInProject().

◆ writeAuthorSection()

void FileDefImpl::writeAuthorSection ( OutputList & ol)
private

Definition at line 826 of file filedef.cpp.

827{
828 // write Author section (Man only)
831 ol.startGroupHeader();
832 ol.parseText(theTranslator->trAuthor(true,true));
833 ol.endGroupHeader();
836}
void parseText(const DString &textStr)
void pushGeneratorState()
void disableAllBut(OutputType o)
void popGeneratorState()
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

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 FileDefImpl::writeBriefDescription ( OutputList & ol)
private

Definition at line 551 of file filedef.cpp.

552{
554 {
555 auto parser { createDocParser() };
556 auto ast { validatingParseDoc(*parser.get(),
557 briefFile(),
558 briefLine(),
559 this,
560 nullptr,
562 DocOptions()
563 .setIndexWords(true)
564 .setSingleLine(true))
565 };
566 if (!ast->empty())
567 {
568 ol.startParagraph();
571 ol.writeString(" - ");
573 ol.writeDoc(ast.get(),this,nullptr);
576 ol.writeString(" \n");
578
579 if (Config_getBool(REPEAT_BRIEF) ||
580 !documentation().stripWhiteSpace().empty()
581 )
582 {
584 ol.startTextLink(DString(),"details");
586 ol.endTextLink();
587 }
589 ol.endParagraph();
590 }
591 }
592 ol.writeSynopsis();
593}
virtual DString briefFile() const =0
bool hasBriefDescription() const override
int briefLine() 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 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 startTextLink(const DString &file, const DString &anchor)
Definition outputlist.h:438
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)

References DefinitionMixin< FileDef >::briefDescription(), DefinitionMixin< FileDef >::briefFile(), DefinitionMixin< FileDef >::briefLine(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< FileDef >::documentation(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), DefinitionMixin< FileDef >::hasBriefDescription(), Html, Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startParagraph(), OutputList::startTextLink(), stripWhiteSpace(), theTranslator, Translator::trMore(), validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString(), and OutputList::writeSynopsis().

Referenced by writeDocumentation().

◆ writeClassDeclarations()

void FileDefImpl::writeClassDeclarations ( OutputList & ol,
const DString & title,
const ClassLinkedRefMap & list )
private

Definition at line 761 of file filedef.cpp.

762{
763 // write list of classes
764 list.writeDeclaration(ol,nullptr,title,false);
765}
void writeDeclaration(OutputList &ol, const ClassDef::CompoundType *filter, const DString &header, bool localNames) const
Definition classlist.cpp:51
DString title() const override
Definition filedef.cpp:1964

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

Referenced by writeDocumentation().

◆ writeClassesToTagFile()

void FileDefImpl::writeClassesToTagFile ( TextStream & t,
const ClassLinkedRefMap & list )
private

Definition at line 595 of file filedef.cpp.

596{
597 for (const auto &cd : list)
598 {
599 if (cd->isLinkableInProject())
600 {
601 tagFile << " <class kind=\"" << cd->compoundTypeString() <<
602 "\">" << convertToXML(cd->name()) << "</class>\n";
603 }
604 }
605}
DString convertToXML(const DString &s, bool keepEntities, const bool citeEntry)
Definition util.cpp:3241

References convertToXML().

Referenced by writeTagFile().

◆ writeConcepts()

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

Definition at line 767 of file filedef.cpp.

768{
769 // write list of classes
771}
void writeDeclaration(OutputList &ol, const DString &header, bool localNames) const

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

Referenced by writeDocumentation().

◆ writeDetailedDescription()

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

Definition at line 480 of file filedef.cpp.

481{
483 {
486 ol.writeRuler();
490 ol.writeAnchor(DString(),"details");
492 ol.startGroupHeader("details");
493 ol.parseText(title);
494 ol.endGroupHeader();
495
496 ol.startTextBlock();
497 if (!briefDescription().empty() && Config_getBool(REPEAT_BRIEF))
498 {
500 briefLine(),
501 this,
502 nullptr,
504 DocOptions());
505 }
506 if (!briefDescription().empty() && Config_getBool(REPEAT_BRIEF) &&
507 !documentation().empty())
508 {
512 ol.enableAll();
515 ol.writeString("\n\n");
517 }
518 if (!documentation().empty())
519 {
520 ol.generateDoc(docFile(),
521 docLine(),
522 this,
523 nullptr,
524 documentation()+"\n",
525 DocOptions()
526 .setIndexWords(true));
527 }
528 //printf("Writing source ref for file %s\n",qPrint(name()));
529 if (Config_getBool(SOURCE_BROWSER))
530 {
531 ol.startParagraph("definition");
532 DString refText = theTranslator->trDefinedInSourceFile();
533 if (size_t fileMarkerPos = refText.find("@0"); fileMarkerPos!=DString::npos) // should always pass this.
534 {
535 ol.parseText(refText.left(fileMarkerPos)); //text left from marker 1
536 ol.writeObjectLink(DString(),getSourceFileBase(),DString(),name());
537 ol.parseText(refText.right(
538 refText.length()-fileMarkerPos-2)); // text right from marker 2
539 }
540 else
541 {
542 err("translation error: invalid marker in trDefinedInSourceFile()\n");
543 }
544 ol.endParagraph();
545 }
547 ol.endTextBlock();
548 }
549}
DString right(size_t len) const
Definition dstring.h:311
size_t find(char c, size_t pos=0) const
Definition dstring.h:239
DString left(size_t len) const
Definition dstring.h:306
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition dstring.h:151
DString briefFile() const override
void writeRequirementRefs(OutputList &ol) const override
int docLine() const override
bool hasDetailedDescription() const override
Definition filedef.cpp:366
void writeObjectLink(const DString &ref, const DString &file, const DString &anchor, const DString &name)
Definition outputlist.h:435
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()
virtual DString trDefinedInSourceFile()=0

References DefinitionMixin< FileDef >::briefDescription(), DefinitionMixin< FileDef >::briefFile(), DefinitionMixin< FileDef >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< FileDef >::docFile(), DefinitionMixin< FileDef >::docLine(), DefinitionMixin< FileDef >::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::endParagraph(), OutputList::endTextBlock(), err, DString::find(), OutputList::generateDoc(), getSourceFileBase(), hasDetailedDescription(), DefinitionMixin< FileDef >::hasRequirementRefs(), Html, Latex, DString::left(), DString::length(), Man, name(), DString::npos, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), DString::right(), RTF, OutputList::startGroupHeader(), OutputList::startParagraph(), OutputList::startTextBlock(), theTranslator, title(), Translator::trDefinedInSourceFile(), OutputList::writeAnchor(), OutputList::writeObjectLink(), DefinitionMixin< FileDef >::writeRequirementRefs(), OutputList::writeRuler(), and OutputList::writeString().

Referenced by writeDocumentation().

◆ writeDocumentation()

void FileDefImpl::writeDocumentation ( OutputList & ol)
overridevirtual

Write the documentation page for this file to the file of output generators ol.

Implements FileDef.

Definition at line 918 of file filedef.cpp.

919{
920 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
921 //funcList->countDecMembers();
922
923 //DString fn = name();
924 //if (Config_getBool(FULL_PATH_NAMES))
925 //{
926 // fn.prepend(stripFromPath(getPath()));
927 //}
928
929 //printf("WriteDocumentation diskname=%s\n",qPrint(diskname));
930
931 DString versionTitle;
932 if (!m_fileVersion.empty())
933 {
934 versionTitle=" ("+m_fileVersion+")";
935 }
936 DString title = m_docname+versionTitle;
937 DString pageTitle;
938 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
939 {
940 pageTitle=m_docname;
941 }
942 else
943 {
945 }
946
947 if (getDirDef())
948 {
949 startFile(ol,getOutputFileBase(),false,name(),pageTitle,HighlightedItem::FileVisible,!generateTreeView);
950 if (!generateTreeView)
951 {
953 ol.endQuickIndices();
954 }
955 startTitle(ol,getOutputFileBase(),this);
958 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
959 {
960 ol.parseText(displayName()); // Html only
961 }
962 else
963 {
965 }
966 ol.enableAll();
968 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
969 {
970 ol.parseText(Config_getBool(FULL_PATH_NAMES) ? // other output formats
971 pageTitle :
972 name());
973 }
974 else
975 {
976 ol.parseText(Config_getBool(FULL_PATH_NAMES) ? // other output formats
977 pageTitle :
979 }
981 addGroupListToTitle(ol,this);
983 }
984 else
985 {
986 startFile(ol,getOutputFileBase(),false,name(),pageTitle,HighlightedItem::FileVisible,!generateTreeView);
987 if (!generateTreeView)
988 {
989 ol.endQuickIndices();
990 }
991 startTitle(ol,getOutputFileBase(),this);
992 ol.parseText(pageTitle);
993 addGroupListToTitle(ol,this);
995 }
996
997 ol.startContents();
998
999 if (!m_fileVersion.empty())
1000 {
1002 ol.startProjectNumber();
1003 ol.docify(versionTitle);
1004 ol.endProjectNumber();
1005 ol.enableAll();
1006 }
1007
1008 //---------------------------------------- start flexible part -------------------------------
1009
1010 SrcLangExt lang = getLanguage();
1011 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
1012 {
1013 const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
1014 switch (lde->kind())
1015 {
1016 case LayoutDocEntry::BriefDesc:
1018 break;
1019 case LayoutDocEntry::MemberDeclStart:
1021 break;
1022 case LayoutDocEntry::Includes:
1024 break;
1025 case LayoutDocEntry::FileIncludeGraph:
1027 break;
1028 case LayoutDocEntry::FileIncludedByGraph:
1030 break;
1031 case LayoutDocEntry::FileSourceLink:
1032 writeSourceLink(ol);
1033 break;
1034 case LayoutDocEntry::FileClasses:
1035 if (ls) writeClassDeclarations(ol,ls->title(lang),m_classes);
1036 break;
1037 case LayoutDocEntry::FileInterfaces:
1038 if (ls) writeClassDeclarations(ol,ls->title(lang),m_interfaces);
1039 break;
1040 case LayoutDocEntry::FileStructs:
1041 if (ls) writeClassDeclarations(ol,ls->title(lang),m_structs);
1042 break;
1043 case LayoutDocEntry::FileRecords:
1044 if (ls) writeClassDeclarations(ol,ls->title(lang),m_records);
1045 break;
1046 case LayoutDocEntry::FileExceptions:
1047 if (ls) writeClassDeclarations(ol,ls->title(lang),m_exceptions);
1048 break;
1049 case LayoutDocEntry::FileConcepts:
1050 if (ls) writeConcepts(ol,ls->title(lang));
1051 break;
1052 case LayoutDocEntry::FileNamespaces:
1053 if (ls) writeNamespaceDeclarations(ol,ls->title(lang),false);
1054 break;
1055 case LayoutDocEntry::FileConstantGroups:
1056 if (ls) writeNamespaceDeclarations(ol,ls->title(lang),true);
1057 break;
1058 case LayoutDocEntry::MemberGroups:
1060 break;
1061 case LayoutDocEntry::MemberDecl:
1062 {
1063 const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
1064 if (lmd) writeMemberDeclarations(ol,lmd->type,lmd->title(lang));
1065 }
1066 break;
1067 case LayoutDocEntry::MemberDeclEnd:
1069 break;
1070 case LayoutDocEntry::DetailedDesc:
1071 if (ls) writeDetailedDescription(ol,ls->title(lang));
1072 break;
1073 case LayoutDocEntry::MemberDefStart:
1075 break;
1076 case LayoutDocEntry::FileInlineClasses:
1078 break;
1079 case LayoutDocEntry::MemberDef:
1080 {
1081 const LayoutDocEntryMemberDef *lmd = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get());
1082 if (lmd) writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
1083 }
1084 break;
1085 case LayoutDocEntry::MemberDefEnd:
1087 break;
1088 case LayoutDocEntry::AuthorSection:
1090 break;
1091 case LayoutDocEntry::ClassInheritanceGraph:
1092 case LayoutDocEntry::ClassNestedClasses:
1093 case LayoutDocEntry::ClassCollaborationGraph:
1094 case LayoutDocEntry::ClassAllMembersLink:
1095 case LayoutDocEntry::ClassUsedFiles:
1096 case LayoutDocEntry::ClassInlineClasses:
1097 case LayoutDocEntry::NamespaceNestedNamespaces:
1098 case LayoutDocEntry::NamespaceNestedConstantGroups:
1099 case LayoutDocEntry::NamespaceClasses:
1100 case LayoutDocEntry::NamespaceConcepts:
1101 case LayoutDocEntry::NamespaceInterfaces:
1102 case LayoutDocEntry::NamespaceStructs:
1103 case LayoutDocEntry::NamespaceRecords:
1104 case LayoutDocEntry::NamespaceExceptions:
1105 case LayoutDocEntry::NamespaceInlineClasses:
1106 case LayoutDocEntry::ConceptDefinition:
1107 case LayoutDocEntry::GroupClasses:
1108 case LayoutDocEntry::GroupConcepts:
1109 case LayoutDocEntry::GroupModules:
1110 case LayoutDocEntry::GroupInlineClasses:
1111 case LayoutDocEntry::GroupNamespaces:
1112 case LayoutDocEntry::GroupDirs:
1113 case LayoutDocEntry::GroupNestedGroups:
1114 case LayoutDocEntry::GroupFiles:
1115 case LayoutDocEntry::GroupGraph:
1116 case LayoutDocEntry::GroupPageDocs:
1117 case LayoutDocEntry::ModuleExports:
1118 case LayoutDocEntry::ModuleClasses:
1119 case LayoutDocEntry::ModuleConcepts:
1120 case LayoutDocEntry::ModuleUsedFiles:
1121 case LayoutDocEntry::DirSubDirs:
1122 case LayoutDocEntry::DirFiles:
1123 case LayoutDocEntry::DirGraph:
1124 err("Internal inconsistency: member '{}' should not be part of "
1125 "LayoutDocManager::File entry list\n",lde->entryToString());
1126 break;
1127 }
1128 }
1129
1130 //---------------------------------------- end flexible part -------------------------------
1131
1132 ol.endContents();
1133
1134 endFileWithNavPath(ol,this);
1135
1136 if (Config_getBool(SEPARATE_MEMBER_PAGES))
1137 {
1138 MemberList *ml = getMemberList(MemberListType::AllMembersList());
1139 if (ml) ml->sort();
1140 writeMemberPages(ol);
1141 }
1142}
virtual void writeNavigationPath(OutputList &ol) const =0
void writeBriefDescription(OutputList &ol)
Definition filedef.cpp:551
void writeSourceLink(OutputList &ol)
Definition filedef.cpp:739
void writeMemberDocumentation(OutputList &ol, MemberListType lt, const DString &title)
Definition filedef.cpp:1930
DString displayName(bool=true) const override
Definition filedef.cpp:129
void endMemberDeclarations(OutputList &ol)
Definition filedef.cpp:791
void writeConcepts(OutputList &ol, const DString &title)
Definition filedef.cpp:767
void writeInlineClasses(OutputList &ol)
Definition filedef.cpp:773
void writeIncludeFiles(OutputList &ol)
Definition filedef.cpp:607
void writeNamespaceDeclarations(OutputList &ol, const DString &title, bool isConstantGroup)
Definition filedef.cpp:754
void writeMemberPages(OutputList &ol) override
Definition filedef.cpp:1144
void writeIncludedByGraph(OutputList &ol)
Definition filedef.cpp:713
void writeClassDeclarations(OutputList &ol, const DString &title, const ClassLinkedRefMap &list)
Definition filedef.cpp:761
void writeAuthorSection(OutputList &ol)
Definition filedef.cpp:826
void writeDetailedDescription(OutputList &ol, const DString &title)
Definition filedef.cpp:480
DirDef * getDirDef() const override
Definition filedef.cpp:148
void writeIncludeGraph(OutputList &ol)
Definition filedef.cpp:688
void startMemberDocumentation(OutputList &ol)
Definition filedef.cpp:796
void startMemberDeclarations(OutputList &ol)
Definition filedef.cpp:786
void endMemberDocumentation(OutputList &ol)
Definition filedef.cpp:805
void writeMemberDeclarations(OutputList &ol, MemberListType lt, const DString &title)
Definition filedef.cpp:1912
void writeMemberGroups(OutputList &ol)
Definition filedef.cpp:814
static LayoutDocManager & instance()
Returns a reference to this singleton.
Definition layout.cpp:1476
void endContents()
Definition outputlist.h:616
void docify(const DString &s)
Definition outputlist.h:433
void startProjectNumber()
Definition outputlist.h:387
void endQuickIndices()
Definition outputlist.h:600
void startContents()
Definition outputlist.h:614
void endProjectNumber()
Definition outputlist.h:389
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
MemberListType type
Definition layout.h:118
DString title(SrcLangExt lang) const
Definition layout.cpp:1827
MemberListType type
Definition layout.h:137
DString title(SrcLangExt lang) const
Definition layout.cpp:1839
DString title(SrcLangExt lang) const
Definition layout.cpp:1820
SrcLangExt
Definition types.h:207
void addGroupListToTitle(OutputList &ol, const Definition *d)
Definition util.cpp:3930

References addGroupListToTitle(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), displayName(), OutputList::docify(), DString::empty(), OutputList::enableAll(), OutputList::endContents(), endFileWithNavPath(), endMemberDeclarations(), endMemberDocumentation(), OutputList::endProjectNumber(), OutputList::endQuickIndices(), endTitle(), err, FileVisible, getDirDef(), DefinitionMixin< FileDef >::getLanguage(), getMemberList(), getOutputFileBase(), Html, LayoutDocManager::instance(), m_classes, m_docname, m_exceptions, m_fileVersion, m_interfaces, m_records, m_structs, name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), MemberVector::sort(), OutputList::startContents(), startFile(), startMemberDeclarations(), startMemberDocumentation(), OutputList::startProjectNumber(), startTitle(), theTranslator, title(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDef::title(), LayoutDocEntrySection::title(), Translator::trFileReference(), LayoutDocEntryMemberDecl::type, LayoutDocEntryMemberDef::type, writeAuthorSection(), writeBriefDescription(), writeClassDeclarations(), writeConcepts(), writeDetailedDescription(), writeIncludedByGraph(), writeIncludeFiles(), writeIncludeGraph(), writeInlineClasses(), writeMemberDeclarations(), writeMemberDocumentation(), writeMemberGroups(), writeMemberPages(), writeNamespaceDeclarations(), DefinitionMutable::writeNavigationPath(), and writeSourceLink().

◆ writeIncludedByGraph()

void FileDefImpl::writeIncludedByGraph ( OutputList & ol)
private

Definition at line 713 of file filedef.cpp.

714{
715 if (Config_getBool(HAVE_DOT) && m_hasIncludedByGraph /*&& Config_getBool(INCLUDED_BY_GRAPH)*/)
716 {
717 //printf("Graph for file %s\n",qPrint(name()));
718 DotInclDepGraph incDepGraph(this,true);
719 if (incDepGraph.isTooBig())
720 {
721 warn_uncond("Included by graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
722 qPrint(name()), incDepGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
723 }
724 else if (!incDepGraph.isTrivial())
725 {
726 ol.startTextBlock();
730 ol.endInclDepGraph(incDepGraph);
731 ol.enableAll();
732 ol.endTextBlock(true);
733 }
734 //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
735 }
736}
void startInclDepGraph()
Definition outputlist.h:648
void endInclDepGraph(DotInclDepGraph &g)
Definition outputlist.h:650
virtual DString trInclByDepGraph()=0
#define Config_getInt(name)
Definition config.h:34
const char * qPrint(const char *s)
Definition dstring.h:783
#define warn_uncond(fmt,...)
Definition message.h:122

References Config_getBool, Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endInclDepGraph(), OutputList::endTextBlock(), DotInclDepGraph::isTooBig(), DotInclDepGraph::isTrivial(), m_hasIncludedByGraph, Man, name(), DotInclDepGraph::numNodes(), OutputList::parseText(), qPrint(), OutputList::startInclDepGraph(), OutputList::startTextBlock(), theTranslator, Translator::trInclByDepGraph(), and warn_uncond.

Referenced by writeDocumentation().

◆ writeIncludeFiles()

void FileDefImpl::writeIncludeFiles ( OutputList & ol)
private

Definition at line 607 of file filedef.cpp.

608{
609 if (m_incInfo)
610 {
611 DString nm=m_incInfo->includeName.empty() ?
612 (m_incInfo->fileDef ?
613 m_incInfo->fileDef->docName() : DString()
614 ) :
615 m_incInfo->includeName;
616 if (!nm.empty())
617 {
618 ol.startParagraph();
619 ol.startTypewriter();
620 ol.docify(::includeStatement(SrcLangExt::Cpp,m_incInfo->kind));
621 ol.docify(::includeOpen(SrcLangExt::Cpp,m_incInfo->kind));
624 ol.docify(nm);
627 if (m_incInfo->fileDef)
628 {
629 ol.writeObjectLink(DString(),m_incInfo->fileDef->includeName(),DString(),nm);
630 }
631 else
632 {
633 ol.docify(nm);
634 }
636 ol.docify(::includeClose(SrcLangExt::Cpp,m_incInfo->kind));
637 ol.endTypewriter();
638 ol.endParagraph();
639 }
640 }
641 else if (!m_includeList.empty())
642 {
643 ol.startTextBlock(true);
644 for (const auto &ii : m_includeList)
645 {
646 const FileDef *fd=ii.fileDef;
647 ol.startTypewriter();
648 SrcLangExt lang = fd ? fd->getLanguage() : SrcLangExt::Cpp;
649 ol.docify(::includeStatement(lang,ii.kind));
650 ol.docify(::includeOpen(lang,ii.kind));
652 ol.docify(ii.includeName);
653 ol.enableAll();
655
656 // Here we use the include file name as it appears in the file.
657 // we could also we the name as it is used within doxygen,
658 // then we should have used fd->docName() instead of ii->includeName
659 if (fd && fd->isLinkable())
660 {
663 DString(),ii.includeName);
664 }
665 else
666 {
667 ModuleDef *mod = ModuleManager::instance().getPrimaryInterface(ii.includeName);
668 if (ii.kind==IncludeKind::ImportModule && mod && mod->isLinkable())
669 {
671 DString(),ii.includeName);
672 }
673 else
674 {
675 ol.docify(ii.includeName);
676 }
677 }
678
679 ol.enableAll();
680 ol.docify(::includeClose(lang,ii.kind));
681 ol.endTypewriter();
682 ol.lineBreak();
683 }
684 ol.endTextBlock();
685 }
686}
virtual bool isLinkable() const =0
virtual DString getReference() const =0
virtual DString getOutputFileBase() const =0
virtual DString includeName() const =0
virtual bool generateSourceFile() const =0
static ModuleManager & instance()
ModuleDef * getPrimaryInterface(const DString &moduleName) const
void lineBreak(const DString &style=DString())
Definition outputlist.h:555
void startTypewriter()
Definition outputlist.h:445
void endTypewriter()
Definition outputlist.h:447
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
@ ImportModule
Definition filedef.h:52

References OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), DString::empty(), OutputList::enable(), OutputList::enableAll(), OutputList::endParagraph(), OutputList::endTextBlock(), OutputList::endTypewriter(), FileDef::generateSourceFile(), Definition::getLanguage(), Definition::getOutputFileBase(), ModuleManager::getPrimaryInterface(), Definition::getReference(), Html, ImportModule, includeClose(), FileDef::includeName(), includeOpen(), includeStatement(), ModuleManager::instance(), Definition::isLinkable(), OutputList::lineBreak(), m_incInfo, m_includeList, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startParagraph(), OutputList::startTextBlock(), OutputList::startTypewriter(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

◆ writeIncludeGraph()

void FileDefImpl::writeIncludeGraph ( OutputList & ol)
private

Definition at line 688 of file filedef.cpp.

689{
690 if (Config_getBool(HAVE_DOT) && m_hasIncludeGraph /*&& Config_getBool(INCLUDE_GRAPH)*/)
691 {
692 //printf("Graph for file %s\n",qPrint(name()));
693 DotInclDepGraph incDepGraph(this,false);
694 if (incDepGraph.isTooBig())
695 {
696 warn_uncond("Include graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
697 qPrint(name()), incDepGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
698 }
699 else if (!incDepGraph.isTrivial())
700 {
701 ol.startTextBlock();
705 ol.endInclDepGraph(incDepGraph);
706 ol.enableAll();
707 ol.endTextBlock(true);
708 }
709 //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
710 }
711}
virtual DString trInclDepGraph(const DString &fName)=0

References Config_getBool, Config_getInt, OutputList::disable(), OutputList::enableAll(), OutputList::endInclDepGraph(), OutputList::endTextBlock(), DotInclDepGraph::isTooBig(), DotInclDepGraph::isTrivial(), m_hasIncludeGraph, Man, name(), DotInclDepGraph::numNodes(), OutputList::parseText(), qPrint(), OutputList::startInclDepGraph(), OutputList::startTextBlock(), theTranslator, Translator::trInclDepGraph(), and warn_uncond.

Referenced by writeDocumentation().

◆ writeInlineClasses()

void FileDefImpl::writeInlineClasses ( OutputList & ol)
private

Definition at line 773 of file filedef.cpp.

774{
775 // temporarily undo the disabling could be done by startMemberDocumentation()
776 // as a result of setting SEPARATE_MEMBER_PAGES to YES; see bug730512
777 bool isEnabled = ol.isEnabled(OutputType::Html);
779
781
782 // restore the initial state if needed
783 if (!isEnabled) ol.disable(OutputType::Html);
784}
void writeDocumentation(OutputList &ol, const Definition *container=nullptr) const
Definition classlist.cpp:72
bool isEnabled(OutputType o)

References OutputList::disable(), OutputList::enable(), Html, OutputList::isEnabled(), m_classes, and ClassLinkedRefMap::writeDocumentation().

Referenced by writeDocumentation().

◆ writeMemberDeclarations()

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

Definition at line 1912 of file filedef.cpp.

1913{
1914 bool optVhdl = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
1915 MemberList * ml = getMemberList(lt);
1916 if (ml)
1917 {
1918 if (optVhdl) // use specific declarations function
1919 {
1920
1921 VhdlDocGen::writeVhdlDeclarations(ml,ol,nullptr,nullptr,this,nullptr,nullptr);
1922 }
1923 else
1924 {
1925 ml->writeDeclarations(ol,nullptr,nullptr,this,nullptr,nullptr,title,DString());
1926 }
1927 }
1928}
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.
static void writeVhdlDeclarations(const MemberList *, OutputList &, const GroupDef *, const ClassDef *, const FileDef *, const NamespaceDef *, const ModuleDef *)

References Config_getBool, getMemberList(), title(), MemberList::writeDeclarations(), and VhdlDocGen::writeVhdlDeclarations().

Referenced by writeDocumentation().

◆ writeMemberDocumentation()

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

Definition at line 1930 of file filedef.cpp.

1931{
1932 MemberList * ml = getMemberList(lt);
1933 if (ml) ml->writeDocumentation(ol,name(),this,title,ml->listType().toLabel());
1934}
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 getMemberList(), MemberList::listType(), name(), title(), MemberListType::toLabel(), and MemberList::writeDocumentation().

Referenced by writeDocumentation().

◆ writeMemberGroups()

void FileDefImpl::writeMemberGroups ( OutputList & ol)
private

Definition at line 814 of file filedef.cpp.

815{
816 /* write user defined member groups */
817 for (const auto &mg : m_memberGroups)
818 {
819 if (!mg->allMembersInSameSection() || !m_subGrouping)
820 {
821 mg->writeDeclarations(ol,nullptr,nullptr,this,nullptr,nullptr);
822 }
823 }
824}

References m_memberGroups, and m_subGrouping.

Referenced by writeDocumentation().

◆ writeMemberPages()

void FileDefImpl::writeMemberPages ( OutputList & ol)
overridevirtual

Implements FileDef.

Definition at line 1144 of file filedef.cpp.

1145{
1146 ol.pushGeneratorState();
1148
1149 for (const auto &ml : m_memberLists)
1150 {
1151 if (ml->listType().isDocumentation())
1152 {
1153 ml->writeDocumentationPage(ol,name(),this);
1154 }
1155 }
1156
1157 ol.popGeneratorState();
1158}

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

Referenced by writeDocumentation().

◆ writeNamespaceDeclarations()

void FileDefImpl::writeNamespaceDeclarations ( OutputList & ol,
const DString & title,
bool isConstantGroup )
private

Definition at line 754 of file filedef.cpp.

756{
757 // write list of namespaces
758 m_namespaces.writeDeclaration(ol,title,isConstantGroup);
759}
void writeDeclaration(OutputList &ol, const DString &title, bool isConstantGroup=false, bool localName=false)

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

Referenced by writeDocumentation().

◆ writePageNavigation()

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

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 910 of file filedef.cpp.

911{
912 ol.writePageOutline();
913}
void writePageOutline()
Definition outputlist.h:612

References OutputList::writePageOutline().

◆ writeQuickMemberLinks()

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

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 1160 of file filedef.cpp.

1161{
1162 bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
1163
1164 ol.writeString(" <div class=\"navtab\">\n");
1165 ol.writeString(" <table>\n");
1166
1167 MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
1168 if (allMemberList)
1169 {
1170 for (const auto &md : *allMemberList)
1171 {
1172 if (md->getFileDef()==this && md->getNamespaceDef()==nullptr && md->isLinkable() && !md->isEnumValue())
1173 {
1174 if (md->isLinkableInProject())
1175 {
1176 DString fn=md->getOutputFileBase();
1178 if (md==currentMd) // selected item => highlight
1179 {
1180 ol.writeString(" <tr><td class=\"navtabHL\">");
1181 }
1182 else
1183 {
1184 ol.writeString(" <tr><td class=\"navtab\">");
1185 }
1186 ol.writeString("<span class=\"label\"><a ");
1187 ol.writeString("href=\"");
1188 if (createSubDirs) ol.writeString("../../");
1189 ol.writeString(fn+"#"+md->anchor());
1190 ol.writeString("\">");
1191 ol.writeString(convertToHtml(md->localName()));
1192 ol.writeString("</a></span>");
1193 ol.writeString("</td></tr>\n");
1194 }
1195 }
1196 }
1197 }
1198
1199 ol.writeString(" </table>\n");
1200 ol.writeString(" </div>\n");
1201}
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().

◆ writeSourceBody()

void FileDefImpl::writeSourceBody ( OutputList & ol,
ClangTUParser * clangParser )
overridevirtual

Implements FileDef.

Definition at line 1257 of file filedef.cpp.

1258{
1259 bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
1260 OutputCodeList devNullList;
1261 devNullList.add<DevNullCodeGenerator>();
1262#if USE_LIBCLANG
1263 if (Doxygen::clangAssistedParsing && clangParser &&
1264 (getLanguage()==SrcLangExt::Cpp || getLanguage()==SrcLangExt::ObjC))
1265 {
1266 auto &codeOL = ol.codeGenerators();
1267 codeOL.startCodeFragment("DoxyCode");
1268 clangParser->switchToFile(this);
1269 clangParser->writeSources(codeOL,this);
1270 codeOL.endCodeFragment("DoxyCode");
1271 }
1272 else
1273#endif
1274 {
1276 intf->resetCodeParserState();
1277 auto &codeOL = ol.codeGenerators();
1278 codeOL.startCodeFragment("DoxyCode");
1279 bool needs2PassParsing =
1280 Doxygen::parseSourcesNeeded && // we need to parse (filtered) sources for cross-references
1281 !filterSourceFiles && // but user wants to show sources as-is
1282 !getFileFilter(absFilePath(),true).empty(); // and there is a filter used while parsing
1283
1284 if (needs2PassParsing)
1285 {
1286 // parse code for cross-references only (see bug707641)
1287 intf->parseCode(devNullList,DString(),
1288 fileToString(absFilePath(),true,true),
1289 getLanguage(),
1290 Config_getBool(STRIP_CODE_COMMENTS),
1291 CodeParserOptions()
1292 .setFileDef(this)
1293 );
1294 }
1295 size_t indent = 0;
1296 intf->parseCode(codeOL,DString(),
1297 detab(fileToString(absFilePath(),filterSourceFiles,true),indent),
1298 getLanguage(), // lang
1299 Config_getBool(STRIP_CODE_COMMENTS),
1300 CodeParserOptions()
1301 .setFileDef(this)
1302 .setCollectXRefs(!needs2PassParsing)
1303 );
1304 codeOL.endCodeFragment("DoxyCode");
1305 }
1306}
static bool parseSourcesNeeded
Definition doxygen.h:116
void startCodeFragment(const DString &style)
Definition outputlist.h:276
const OutputCodeList & codeGenerators() const
Definition outputlist.h:354
DString getFileFilter(const DString &name, bool isSourceCode)
Definition util.cpp:1025

References absFilePath(), OutputCodeList::add(), Doxygen::clangAssistedParsing, OutputList::codeGenerators(), Config_getBool, detab(), DString::empty(), fileToString(), ParserManager::getCodeParser(), DefinitionMixin< FileDef >::getDefFileExtension(), getFileFilter(), DefinitionMixin< FileDef >::getLanguage(), Doxygen::parserManager, Doxygen::parseSourcesNeeded, and OutputCodeList::startCodeFragment().

◆ writeSourceFooter()

void FileDefImpl::writeSourceFooter ( OutputList & ol)
overridevirtual

Implements FileDef.

Definition at line 1308 of file filedef.cpp.

1309{
1310 ol.endContents();
1311 endFileWithNavPath(ol,this,false);
1312 ol.enableAll();
1313}

References OutputList::enableAll(), OutputList::endContents(), and endFileWithNavPath().

◆ writeSourceHeader()

void FileDefImpl::writeSourceHeader ( OutputList & ol)
overridevirtual

Write a source listing of this file to the output

Implements FileDef.

Definition at line 1204 of file filedef.cpp.

1205{
1206 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
1207 DString title = m_docname;
1208 if (!m_fileVersion.empty())
1209 {
1210 title+=" ("+m_fileVersion+")";
1211 }
1212 DString pageTitle = theTranslator->trSourceFile(title);
1214
1215 bool isDocFile = isDocumentationFile();
1216 bool genSourceFile = !isDocFile && generateSourceFile();
1217 if (getDirDef())
1218 {
1219 startFile(ol,getSourceFileBase(),true,DString(),pageTitle,HighlightedItem::FileVisible,
1220 !generateTreeView,
1221 !isDocFile && genSourceFile ? DString() : getOutputFileBase(),
1222 0);
1223 if (!generateTreeView)
1224 {
1226 ol.endQuickIndices();
1227 }
1229 ol.parseText(name());
1231 }
1232 else
1233 {
1234 startFile(ol,getSourceFileBase(),true,DString(),pageTitle,HighlightedItem::FileVisible,false,
1235 !isDocFile && genSourceFile ? DString() : getOutputFileBase(),
1236 0);
1238 ol.parseText(title);
1239 endTitle(ol,getSourceFileBase(),DString());
1240 }
1241
1242 ol.startContents();
1243
1244 if (isLinkable())
1245 {
1246 ol.startTextLink(getOutputFileBase(),DString());
1248 ol.endTextLink();
1249
1250 ol.pushGeneratorState();
1252 ol.writeString("\\par\n");
1253 ol.popGeneratorState();
1254 }
1255}
virtual DString trGotoDocumentation()=0
virtual DString trSourceFile(const DString &filename)=0

References Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DString::empty(), OutputList::endQuickIndices(), OutputList::endTextLink(), endTitle(), FileVisible, generateSourceFile(), getDirDef(), getOutputFileBase(), getSourceFileBase(), isDocumentationFile(), isLinkable(), m_docname, m_fileVersion, Man, name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), RTF, OutputList::startContents(), startFile(), OutputList::startTextLink(), startTitle(), theTranslator, title(), Translator::trGotoDocumentation(), Translator::trSourceFile(), DefinitionMutable::writeNavigationPath(), and OutputList::writeString().

◆ writeSourceLink()

void FileDefImpl::writeSourceLink ( OutputList & ol)
private

Definition at line 739 of file filedef.cpp.

740{
741 //printf("%s: generateSourceFile()=%d\n",qPrint(name()),generateSourceFile());
742 if (generateSourceFile())
743 {
745 ol.startParagraph();
746 ol.startTextLink(includeName(),DString());
748 ol.endTextLink();
749 ol.endParagraph();
750 ol.enableAll();
751 }
752}
virtual DString trGotoSourceCode()=0

References OutputList::disableAllBut(), OutputList::enableAll(), OutputList::endParagraph(), OutputList::endTextLink(), generateSourceFile(), Html, includeName(), OutputList::parseText(), OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, and Translator::trGotoSourceCode().

Referenced by writeDocumentation().

◆ writeSummaryLinks()

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

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 838 of file filedef.cpp.

839{
842 bool first=true;
843 SrcLangExt lang=getLanguage();
844 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
845 {
846 const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
847 if (lde->kind()==LayoutDocEntry::FileClasses && m_classes.declVisible() && ls)
848 {
849 DString label = "nested-classes";
850 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
851 first=false;
852 }
853 else if (lde->kind()==LayoutDocEntry::FileInterfaces && m_interfaces.declVisible() && ls)
854 {
855 DString label = "interfaces";
856 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
857 first=false;
858 }
859 else if (lde->kind()==LayoutDocEntry::FileStructs && m_structs.declVisible() && ls)
860 {
861 DString label = "structs";
862 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
863 first=false;
864 }
865 else if (lde->kind()==LayoutDocEntry::FileRecords && m_records.declVisible() && ls)
866 {
867 DString label = "records";
868 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
869 first=false;
870 }
871 else if (lde->kind()==LayoutDocEntry::FileExceptions && m_exceptions.declVisible() && ls)
872 {
873 DString label = "exceptions";
874 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
875 first=false;
876 }
877 else if (lde->kind()==LayoutDocEntry::FileNamespaces && m_namespaces.declVisible(false) && ls)
878 {
879 DString label = "namespaces";
880 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
881 first=false;
882 }
883 else if (lde->kind()==LayoutDocEntry::FileConcepts && m_concepts.declVisible() && ls)
884 {
885 DString label = "concepts";
886 ol.writeSummaryLink(DString(),label,ls->title(lang),first);
887 first=false;
888 }
889 else if (lde->kind()==LayoutDocEntry::MemberDecl)
890 {
891 const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
892 if (lmd)
893 {
894 MemberList * ml = getMemberList(lmd->type);
895 if (ml && ml->declVisible())
896 {
897 ol.writeSummaryLink(DString(),ml->listType().toLabel(),lmd->title(lang),first);
898 first=false;
899 }
900 }
901 }
902 }
903 if (!first)
904 {
905 ol.writeString(" </div>\n");
906 }
908}
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< FileDef >::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 FileDefImpl::writeTagFile ( TextStream & t)
overridevirtual

Implements FileDef.

Definition at line 377 of file filedef.cpp.

378{
379 DString fn=getOutputFileBase();
381 tagFile << " <compound kind=\"file\">\n";
382 tagFile << " <name>" << convertToXML(name()) << "</name>\n";
383 tagFile << " <path>" << convertToXML(stripFromPath(getPath())) << "</path>\n";
384 tagFile << " <filename>" << fn << "</filename>\n";
385 for (const auto &ii : m_includeList)
386 {
387 const FileDef *fd=ii.fileDef;
388 if (fd && fd->isLinkable() && !fd->isReference())
389 {
390 DString attr = includeTagFileAttributes(fd->getLanguage(),ii.kind);
391 tagFile << " <includes id=\""
392 << convertToXML(fd->getOutputFileBase()) << "\" "
393 << "name=\"" << convertToXML(fd->name()) << "\" "
394 << attr << ">"
395 << convertToXML(ii.includeName)
396 << "</includes>\n";
397 }
398 }
399 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
400 {
401 switch (lde->kind())
402 {
403 case LayoutDocEntry::FileClasses:
404 {
406 }
407 break;
408 case LayoutDocEntry::FileInterfaces:
409 {
411 }
412 break;
413 case LayoutDocEntry::FileStructs:
414 {
416 }
417 break;
418 case LayoutDocEntry::FileRecords:
419 {
421 }
422 break;
423 case LayoutDocEntry::FileExceptions:
424 {
426 }
427 break;
428 case LayoutDocEntry::FileConcepts:
429 {
430 for (const auto *nd : m_concepts)
431 {
432 if (nd->isLinkableInProject())
433 {
434 tagFile << " <concept>" << convertToXML(nd->name()) << "</concept>\n";
435 }
436 }
437 }
438 break;
439 case LayoutDocEntry::FileNamespaces:
440 {
441 for (const auto *nd : m_namespaces)
442 {
443 if (nd->isLinkableInProject())
444 {
445 tagFile << " <namespace>" << convertToXML(nd->name()) << "</namespace>\n";
446 }
447 }
448 }
449 break;
450 case LayoutDocEntry::MemberDecl:
451 {
452 const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
453 if (lmd)
454 {
455 MemberList * ml = getMemberList(lmd->type);
456 if (ml)
457 {
458 ml->writeTagFile(tagFile,false,false);
459 }
460 }
461 }
462 break;
463 case LayoutDocEntry::MemberGroups:
464 {
465 for (const auto &mg : m_memberGroups)
466 {
467 mg->writeTagFile(tagFile);
468 }
469 }
470 break;
471 default:
472 break;
473 }
474 }
475
477 tagFile << " </compound>\n";
478}
void writeDocAnchorsToTagFile(TextStream &fs) const override
DString getPath() const override
Definition filedef.cpp:143
void writeClassesToTagFile(TextStream &t, const ClassLinkedRefMap &list)
Definition filedef.cpp:595
void writeTagFile(TextStream &, bool useQualifiedName=false, bool showNamespaceMembers=true)
DString includeTagFileAttributes(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:100

References addHtmlExtensionIfMissing(), convertToXML(), Definition::getLanguage(), getMemberList(), Definition::getOutputFileBase(), getOutputFileBase(), getPath(), includeTagFileAttributes(), LayoutDocManager::instance(), Definition::isLinkable(), Definition::isReference(), m_classes, m_concepts, m_exceptions, m_includeList, m_interfaces, m_memberGroups, m_namespaces, m_records, m_structs, Definition::name(), name(), stripFromPath(), LayoutDocEntryMemberDecl::type, writeClassesToTagFile(), DefinitionMixin< FileDef >::writeDocAnchorsToTagFile(), and MemberList::writeTagFile().

Member Data Documentation

◆ m_classes

◆ m_concepts

ConceptLinkedRefMap FileDefImpl::m_concepts
private

◆ m_dir

DirDef* FileDefImpl::m_dir = nullptr
private

Definition at line 254 of file filedef.cpp.

Referenced by FileDefImpl(), getDirDef(), and setDirDef().

◆ m_docname

DString FileDefImpl::m_docname
private

Definition at line 249 of file filedef.cpp.

Referenced by docName(), FileDefImpl(), writeDocumentation(), and writeSourceHeader().

◆ m_exceptions

ClassLinkedRefMap FileDefImpl::m_exceptions
private

◆ m_fileName

DString FileDefImpl::m_fileName
private

Definition at line 248 of file filedef.cpp.

Referenced by FileDefImpl(), fileName(), and name().

◆ m_filePath

DString FileDefImpl::m_filePath
private

Definition at line 244 of file filedef.cpp.

Referenced by absFilePath(), acquireFileVersion(), FileDefImpl(), and getSourceFileBase().

◆ m_fileVersion

DString FileDefImpl::m_fileVersion
private

◆ m_hasIncludedByGraph

bool FileDefImpl::m_hasIncludedByGraph = Config_getBool(INCLUDED_BY_GRAPH)
private

Definition at line 267 of file filedef.cpp.

Referenced by hasIncludedByGraph(), overrideIncludedByGraph(), and writeIncludedByGraph().

◆ m_hasIncludeGraph

bool FileDefImpl::m_hasIncludeGraph = Config_getBool(INCLUDE_GRAPH)
private

Definition at line 266 of file filedef.cpp.

Referenced by hasIncludeGraph(), overrideIncludeGraph(), and writeIncludeGraph().

◆ m_incInfo

std::unique_ptr<IncludeInfo> FileDefImpl::m_incInfo
private

Definition at line 242 of file filedef.cpp.

Referenced by setIncludeFile(), and writeIncludeFiles().

◆ m_inclByDepFileName

DString FileDefImpl::m_inclByDepFileName
private

Definition at line 246 of file filedef.cpp.

Referenced by includedByDependencyGraphFileName(), and setDiskNameLocal().

◆ m_inclDepFileName

DString FileDefImpl::m_inclDepFileName
private

Definition at line 245 of file filedef.cpp.

Referenced by includeDependencyGraphFileName(), and setDiskNameLocal().

◆ m_includedByList

IncludeInfoList FileDefImpl::m_includedByList
private

Definition at line 239 of file filedef.cpp.

Referenced by addIncludedByDependency(), includedByFileList(), and sortMemberLists().

◆ m_includedByMap

IncludeInfoMap FileDefImpl::m_includedByMap
private

Definition at line 238 of file filedef.cpp.

Referenced by addIncludedByDependency(), and generateSourceFile().

◆ m_includeList

IncludeInfoList FileDefImpl::m_includeList
private

◆ m_includeMap

IncludeInfoMap FileDefImpl::m_includeMap
private

Definition at line 236 of file filedef.cpp.

Referenced by addIncludeDependency(), and isIncluded().

◆ m_interfaces

ClassLinkedRefMap FileDefImpl::m_interfaces
private

◆ m_isSource

bool FileDefImpl::m_isSource
private

Definition at line 252 of file filedef.cpp.

Referenced by FileDefImpl(), and isSource().

◆ m_memberGroups

◆ m_memberLists

◆ m_moduleDef

ModuleDef* FileDefImpl::m_moduleDef = nullptr
private

Definition at line 255 of file filedef.cpp.

Referenced by getModuleDef(), and setModuleDef().

◆ m_namespaces

◆ m_outputDiskName

DString FileDefImpl::m_outputDiskName
private

Definition at line 247 of file filedef.cpp.

Referenced by getOutputFileBase(), getSourceFileBase(), and setDiskNameLocal().

◆ m_path

DString FileDefImpl::m_path
private

Definition at line 243 of file filedef.cpp.

Referenced by FileDefImpl(), and getPath().

◆ m_records

ClassLinkedRefMap FileDefImpl::m_records
private

◆ m_srcDefMap

DefinitionLineMap FileDefImpl::m_srcDefMap
private

Definition at line 250 of file filedef.cpp.

Referenced by addSourceRef(), and getSourceDefinition().

◆ m_srcMemberMap

MemberDefLineMap FileDefImpl::m_srcMemberMap
private

Definition at line 251 of file filedef.cpp.

Referenced by addSourceRef(), and getSourceMember().

◆ m_structs

ClassLinkedRefMap FileDefImpl::m_structs
private

◆ m_subGrouping

bool FileDefImpl::m_subGrouping
private

Definition at line 265 of file filedef.cpp.

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

◆ m_usingDeclList

LinkedRefMap<const Definition> FileDefImpl::m_usingDeclList
private

◆ m_usingDirList

LinkedRefMap<NamespaceDef> FileDefImpl::m_usingDirList
private

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