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

Public Member Functions

 FileDefImpl (const QCString &p, const QCString &n, const QCString &ref=QCString(), const QCString &dn=QCString())
 ~FileDefImpl () override
DefType definitionType () const override
CodeSymbolType codeSymbolType () const override
const QCStringname () const override
QCString displayName (bool=TRUE) const override
QCString fileName () const override
QCString getOutputFileBase () const override
QCString anchor () const override
QCString getSourceFileBase () const override
QCString includeName () const override
QCString includeDependencyGraphFileName () const override
QCString includedByDependencyGraphFileName () const override
QCString absFilePath () const override
const QCStringdocName () const override
bool isSource () const override
bool isDocumentationFile () const override
const DefinitiongetSourceDefinition (int lineNr) const override
const MemberDefgetSourceMember (int lineNr) const override
QCString getPath () const override
QCString getVersion () const override
bool isLinkableInProject () const override
bool isLinkable () const override
bool isIncluded (const QCString &name) const override
DirDefgetDirDef () const override
ModuleDefgetModuleDef () const override
const LinkedRefMap< NamespaceDef > & getUsedNamespaces () const override
const LinkedRefMap< const Definition > & getUsedDefinitions () const override
const IncludeInfoListincludeFileList () const override
const IncludeInfoListincludedByFileList () const override
void getAllIncludeFilesRecursively (StringVector &incFiles) const override
MemberListgetMemberList (MemberListType lt) const override
const MemberListsgetMemberLists () const override
const MemberGroupListgetMemberGroups () const override
const NamespaceLinkedRefMapgetNamespaces () const override
const ConceptLinkedRefMapgetConcepts () const override
const ClassLinkedRefMapgetClasses () const override
QCString title () const override
bool hasDetailedDescription () const override
QCString 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 QCString &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 QCString &incName, IncludeKind kind) override
void addIncludedByDependency (const FileDef *fd, const QCString &incName, IncludeKind kind) override
void addMembersToMemberGroup () override
void distributeMemberGroupDocumentation () override
void findSectionsInDocumentation () override
void addIncludedUsingDirectives (FileDefSet &visitedFiles) override
void addListReferences () override
bool hasIncludeGraph () const override
bool hasIncludedByGraph () const override
void overrideIncludeGraph (bool e) override
void overrideIncludedByGraph (bool e) override
Public Member Functions inherited from DefinitionMixin< FileDef >
 DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
DefinitionMixinoperator= (const DefinitionMixin &other)
 ~DefinitionMixin () override=default
bool isAlias () const override
bool isAnonymous () const override
const QCStringlocalName () const override
QCString qualifiedName () const override
QCString symbolName () const override
QCString getSourceAnchor () const override
QCString documentation () const override
int docLine () const override
QCString docFile () const override
QCString briefDescription (bool abbreviate=FALSE) const override
QCString briefDescriptionAsTooltip () const override
int briefLine () const override
QCString inbodyDocumentation () const override
QCString inbodyFile () const override
int inbodyLine () const override
QCString briefFile () const override
QCString getDefFileName () const override
QCString getDefFileExtension () const override
int getDefLine () const override
int getDefColumn () const override
bool hasDocumentation () const override
bool hasUserDocumentation () const override
bool isVisibleInProject () const override
bool isVisible () const override
bool isHidden () const override
bool isArtificial () const override
bool isExported () const override
QCString getReference () const override
bool isReference () const override
QCString externalReference (const QCString &relPath) const override
int getStartDefLine () const override
int getStartBodyLine () const override
int getEndBodyLine () const override
const FileDefgetBodyDef () const override
SrcLangExt getLanguage () const override
const GroupListpartOfGroups () const override
bool isLinkableViaGroup () const override
const RefItemVectorxrefListItems () const override
const DefinitionfindInnerCompound (const QCString &name) const override
DefinitiongetOuterScope () const override
const MemberVectorgetReferencesMembers () const override
const MemberVectorgetReferencedByMembers () const override
bool hasSections () const override
bool hasSources () const override
bool hasBriefDescription () const override
QCString id () const override
const SectionRefsgetSectionRefs () const override
void setName (const QCString &name) override
void setId (const QCString &name) override
void setDefFile (const QCString &df, int defLine, int defColumn) override
void setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE) override
void setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine) override
void setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine) override
void setReference (const QCString &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 QCString &sourceRefName) override
void addSourceReferences (MemberDef *md, const QCString &sourceRefName) override
void setRefItems (const RefItemVector &sli) 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 QCString &scopeName) const override
bool hasSourceRefs () const override
bool hasSourceReffedBy () const override
void writeSourceRefs (OutputList &ol, const QCString &scopeName) const override
void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const override
void makePartOfGroup (GroupDef *gd) override
void writeNavigationPath (OutputList &ol) const override
QCString navigationPathAsString () const override
QCString pathFragment () const override
void writeDocAnchorsToTagFile (TextStream &fs) const override
void setLocalName (const QCString &name) override
void writeToc (OutputList &ol, const LocalToc &lt) const override
void computeTooltip () override
void _setSymbolName (const QCString &name) override
QCString _symbolName () const override

Private Member Functions

void setDiskNameLocal (const QCString &name)
void acquireFileVersion ()
void addMemberToList (MemberListType lt, MemberDef *md)
void writeMemberDeclarations (OutputList &ol, MemberListType lt, const QCString &title)
void writeMemberDocumentation (OutputList &ol, MemberListType lt, const QCString &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 QCString &title, bool isConstantGroup)
void writeClassDeclarations (OutputList &ol, const QCString &title, const ClassLinkedRefMap &list)
void writeConcepts (OutputList &ol, const QCString &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 QCString &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< NamespaceDefm_usingDirList
LinkedRefMap< const Definitionm_usingDeclList
QCString m_path
QCString m_filePath
QCString m_inclDepFileName
QCString m_inclByDepFileName
QCString m_outputDiskName
QCString m_fileName
QCString m_docname
DefinitionLineMap m_srcDefMap
MemberDefLineMap m_srcMemberMap
bool m_isSource
QCString m_fileVersion
DirDefm_dir = nullptr
ModuleDefm_moduleDef = nullptr
MemberLists m_memberLists
MemberGroupList m_memberGroups
NamespaceLinkedRefMap m_namespaces
ClassLinkedRefMap m_classes
ClassLinkedRefMap m_interfaces
ClassLinkedRefMap m_structs
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 122 of file filedef.cpp.

Constructor & Destructor Documentation

◆ FileDefImpl()

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

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

282 : DefinitionMixin(p+nm,1,1,nm,nullptr,nullptr,!p.isEmpty())
283{
285 m_filePath=p+nm;
286 m_fileName=nm;
287
288 setReference(lref);
289 setDiskNameLocal(!dn.isEmpty() ? dn : nm);
290 m_isSource = guessSection(nm).isSource();
291 m_docname = nm;
292 m_dir = nullptr;
293 if (Config_getBool(FULL_PATH_NAMES))
294 {
296 }
298 Config_getBool(FULL_PATH_NAMES) ? m_fileName : DefinitionMixin::name()));
300 m_subGrouping=Config_getBool(SUBGROUPING);
301}
const QCString & name() const override
void setLanguage(SrcLangExt lang) override
void setReference(const QCString &r) override
DefinitionMixin(const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=nullptr, const char *d=nullptr, bool isSymbol=TRUE)
DirDef * m_dir
Definition filedef.cpp:253
QCString m_path
Definition filedef.cpp:242
void setDiskNameLocal(const QCString &name)
Definition filedef.cpp:308
void acquireFileVersion()
Definition filedef.cpp:1686
QCString m_fileName
Definition filedef.cpp:247
bool m_isSource
Definition filedef.cpp:251
bool m_subGrouping
Definition filedef.cpp:263
QCString m_docname
Definition filedef.cpp:248
QCString m_filePath
Definition filedef.cpp:243
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163
#define Config_getBool(name)
Definition config.h:33
SrcLangExt getLanguageFromFileName(const QCString &fileName, SrcLangExt defLang)
Definition util.cpp:5107
static QCString stripFromPath(const QCString &p, const StringVector &l)
Definition util.cpp:307
EntryType guessSection(const QCString &name)
Definition util.cpp:347
QCString removeLongPathMarker(QCString path)
Definition util.cpp:296

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

◆ ~FileDefImpl()

FileDefImpl::~FileDefImpl ( )
override

destroy the file definition

Definition at line 304 of file filedef.cpp.

305{
306}

Member Function Documentation

◆ absFilePath()

QCString FileDefImpl::absFilePath ( ) const
inlineoverridevirtual

Returns the absolute path including the file name.

Implements FileDef.

Definition at line 141 of file filedef.cpp.

141{ return m_filePath; }

References m_filePath.

Referenced by parseSource(), and writeSourceBody().

◆ acquireFileVersion()

void FileDefImpl::acquireFileVersion ( )
private

Definition at line 1686 of file filedef.cpp.

1687{
1688 QCString vercmd = Config_getString(FILE_VERSION_FILTER);
1689 if (!vercmd.isEmpty() && !m_filePath.isEmpty() && !isReference() &&
1690 m_filePath!="generated" && m_filePath!="graph_legend.dox")
1691 {
1692 msg("Version of {} : ",m_filePath);
1693 QCString cmd = vercmd+" \""+m_filePath+"\"";
1694 Debug::print(Debug::ExtCmd,0,"Executing popen(`{}`)\n",cmd);
1695 FILE *f=Portable::popen(cmd,"r");
1696 if (!f)
1697 {
1698 err("could not execute {}\n",vercmd);
1699 return;
1700 }
1701 const int bufSize=1024;
1702 char buf[bufSize];
1703 int numRead = static_cast<int>(fread(buf,1,bufSize-1,f));
1705 if (numRead>0 && numRead<bufSize)
1706 {
1707 buf[numRead]='\0';
1708 m_fileVersion=QCString(buf,numRead).stripWhiteSpace();
1709 if (!m_fileVersion.isEmpty())
1710 {
1711 msg("{}\n",m_fileVersion);
1712 return;
1713 }
1714 }
1715 msg("no version available\n");
1716 }
1717}
@ ExtCmd
Definition debug.h:36
static void print(DebugMask mask, int prio, fmt::format_string< Args... > fmt, Args &&... args)
Definition debug.h:76
virtual bool isReference() const =0
QCString m_fileVersion
Definition filedef.cpp:252
#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 QCString &name, const QCString &type)
Definition portable.cpp:480
int pclose(FILE *stream)
Definition portable.cpp:489

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

Referenced by FileDefImpl().

◆ addIncludedByDependency()

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

Implements FileDef.

Definition at line 1592 of file filedef.cpp.

1593{
1594 //printf("FileDefImpl::addIncludedByDependency(%p,%s,%d)\n",fd,incName,local);
1595 QCString iName = fd ? fd->absFilePath() : incName;
1596 if (!iName.isEmpty() && m_includedByMap.find(iName.str())==m_includedByMap.end())
1597 {
1598 m_includedByList.emplace_back(fd,incName,kind);
1599 m_includedByMap.emplace(iName.str(),&m_includedByList.back());
1600 }
1601}
virtual QCString absFilePath() const =0
IncludeInfoList m_includedByList
Definition filedef.cpp:239
IncludeInfoMap m_includedByMap
Definition filedef.cpp:238
const std::string & str() const
Definition qcstring.h:552

References FileDef::absFilePath(), QCString::isEmpty(), m_includedByList, m_includedByMap, and QCString::str().

◆ addIncludeDependency()

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

Implements FileDef.

Definition at line 1533 of file filedef.cpp.

1534{
1535 //printf("FileDefImpl::addIncludeDependency(%p,%s,%d)\n",(void*)fd,qPrint(incName),kind);
1536 QCString iName = fd ? fd->absFilePath() : incName;
1537 if (!iName.isEmpty() && m_includeMap.find(iName.str())==m_includeMap.end())
1538 {
1539 m_includeList.emplace_back(fd,incName,kind);
1540 m_includeMap.emplace(iName.str(),&m_includeList.back());
1541 }
1542}
IncludeInfoMap m_includeMap
Definition filedef.cpp:236
IncludeInfoList m_includeList
Definition filedef.cpp:237

References FileDef::absFilePath(), QCString::isEmpty(), m_includeList, m_includeMap, and QCString::str().

◆ addIncludedUsingDirectives()

void FileDefImpl::addIncludedUsingDirectives ( FileDefSet & visitedFiles)
overridevirtual

Implements FileDef.

Definition at line 1544 of file filedef.cpp.

1545{
1546 if (visitedFiles.find(this)!=visitedFiles.end()) return; // file already processed
1547 visitedFiles.insert(this);
1548 //printf("( FileDefImpl::addIncludedUsingDirectives for file %s\n",qPrint(name()));
1549
1550 if (!m_includeList.empty()) // file contains #includes
1551 {
1552 {
1553 for (const auto &ii : m_includeList) // foreach #include...
1554 {
1555 if (ii.fileDef) // ...that is a known file
1556 {
1557 // recurse into this file
1558 const_cast<FileDef*>(ii.fileDef)->addIncludedUsingDirectives(visitedFiles);
1559 }
1560 }
1561 }
1562 {
1563 // iterate through list from last to first
1564 for (auto ii_it = m_includeList.rbegin(); ii_it!=m_includeList.rend(); ++ii_it)
1565 {
1566 auto &ii = *ii_it;
1567 if (ii.fileDef && ii.fileDef!=this)
1568 {
1569 // add using directives
1570 auto unl = ii.fileDef->getUsedNamespaces();
1571 for (auto it = unl.rbegin(); it!=unl.rend(); ++it)
1572 {
1573 auto *nd = *it;
1574 //printf(" adding using directive for %s\n",qPrint(nd->qualifiedName()));
1575 m_usingDirList.prepend(nd->qualifiedName(),nd);
1576 }
1577 // add using declarations
1578 auto udl = ii.fileDef->getUsedDefinitions();
1579 for (auto it = udl.rbegin(); it!=udl.rend(); ++it)
1580 {
1581 auto *d = *it;
1582 m_usingDeclList.prepend(d->qualifiedName(),d);
1583 }
1584 }
1585 }
1586 }
1587 }
1588 //printf(") end FileDefImpl::addIncludedUsingDirectives for file %s\n",qPrint(name()));
1589}
void addIncludedUsingDirectives(FileDefSet &visitedFiles) override
Definition filedef.cpp:1544
LinkedRefMap< const Definition > m_usingDeclList
Definition filedef.cpp:241
LinkedRefMap< NamespaceDef > m_usingDirList
Definition filedef.cpp:240

References addIncludedUsingDirectives(), QCString::insert(), m_includeList, m_usingDeclList, and m_usingDirList.

Referenced by addIncludedUsingDirectives().

◆ addListReferences()

void FileDefImpl::addListReferences ( )
overridevirtual

Implements FileDef.

Definition at line 1621 of file filedef.cpp.

1622{
1623 {
1624 const RefItemVector &xrefItems = xrefListItems();
1625 addRefItem(xrefItems,
1629 QCString(),
1630 nullptr
1631 );
1632 }
1633 for (const auto &mg : m_memberGroups)
1634 {
1635 mg->addListReferences(this);
1636 }
1637 for (auto &ml : m_memberLists)
1638 {
1639 if (ml->listType().isDocumentation())
1640 {
1641 ml->addListReferences(this);
1642 }
1643 }
1644}
const RefItemVector & xrefListItems() const override
QCString getOutputFileBase() const override
Definition filedef.cpp:1732
MemberGroupList m_memberGroups
Definition filedef.cpp:256
const QCString & name() const override
Definition filedef.cpp:1481
MemberLists m_memberLists
Definition filedef.cpp:255
virtual QCString trFile(bool first_capital, bool singular)=0
Translator * theTranslator
Definition language.cpp:71
#define TRUE
Definition qcstring.h:37
std::vector< RefItem * > RefItemVector
Definition reflist.h:133
void addRefItem(const RefItemVector &sli, const QCString &key, const QCString &prefix, const QCString &name, const QCString &title, const QCString &args, const Definition *scope)
Definition util.cpp:4726

References addRefItem(), getOutputFileBase(), m_memberGroups, m_memberLists, name(), theTranslator, TRUE, and DefinitionMixin< FileDef >::xrefListItems().

◆ addMembersToMemberGroup()

void FileDefImpl::addMembersToMemberGroup ( )
overridevirtual

Implements FileDef.

Definition at line 1298 of file filedef.cpp.

1299{
1300 for (auto &ml : m_memberLists)
1301 {
1302 if (ml->listType().isDeclaration())
1303 {
1305 }
1306 }
1307
1308 // add members inside sections to their groups
1309 for (const auto &mg : m_memberGroups)
1310 {
1311 if (mg->allMembersInSameSection() && m_subGrouping)
1312 {
1313 //printf("----> addToDeclarationSection(%s)\n",qPrint(mg->header()));
1314 mg->addToDeclarationSection();
1315 }
1316 }
1317}
void addMembersToMemberGroup() override
Definition filedef.cpp:1298

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

Referenced by addMembersToMemberGroup().

◆ addMemberToList()

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

Definition at line 1743 of file filedef.cpp.

1744{
1745 bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
1746 bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
1747 const auto &ml = m_memberLists.get(lt,MemberListContainer::File);
1748 ml->setNeedsSorting(
1749 (ml->listType().isDeclaration() && sortBriefDocs) ||
1750 (ml->listType().isDocumentation() && sortMemberDocs));
1751 ml->push_back(md);
1752 if (ml->listType().isDeclaration())
1753 {
1754 MemberDefMutable *mdm = toMemberDefMutable(md);
1755 if (mdm)
1756 {
1757 mdm->setSectionList(this,ml.get());
1758 }
1759 }
1760}
virtual void setSectionList(const Definition *container, const MemberList *sl)=0
MemberDefMutable * toMemberDefMutable(Definition *d)

References Config_getBool, File, m_memberLists, MemberDefMutable::setSectionList(), and toMemberDefMutable().

Referenced by insertMember().

◆ addSourceRef()

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

Implements FileDef.

Definition at line 1489 of file filedef.cpp.

1490{
1491 //printf("FileDefImpl::addSourceRef(%d,%s,%s)\n",line,qPrint(d?d->name():"nullptr"),qPrint(md?md->name():"nullptr"));
1492 if (d)
1493 {
1494 m_srcDefMap.emplace(line,d);
1495 if (md) m_srcMemberMap.emplace(line,md);
1496 //printf("Adding member %s with anchor %s at line %d to file %s\n",
1497 // md?qPrint(md->name()):"<none>",md?qPrint(md->anchor()):"<none>",line,qPrint(name()));
1498 }
1499}
MemberDefLineMap m_srcMemberMap
Definition filedef.cpp:250
DefinitionLineMap m_srcDefMap
Definition filedef.cpp:249

References m_srcDefMap, and m_srcMemberMap.

◆ addUsingDeclaration()

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

Implements FileDef.

Definition at line 1528 of file filedef.cpp.

1529{
1530 m_usingDeclList.add(d->qualifiedName(),d);
1531}
virtual QCString qualifiedName() const =0

References m_usingDeclList, and Definition::qualifiedName().

Referenced by combineUsingRelations().

◆ addUsingDirective()

void FileDefImpl::addUsingDirective ( NamespaceDef * nd)
overridevirtual

Implements FileDef.

Definition at line 1516 of file filedef.cpp.

1517{
1518 m_usingDirList.add(nd->qualifiedName(),nd);
1519 //printf("%p: FileDefImpl::addUsingDirective: %s:%d\n",this,qPrint(name()),usingDirList->count());
1520}

References m_usingDirList, and Definition::qualifiedName().

Referenced by combineUsingRelations().

◆ anchor()

QCString FileDefImpl::anchor ( ) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 136 of file filedef.cpp.

136{ return QCString(); }

◆ codeSymbolType()

CodeSymbolType FileDefImpl::codeSymbolType ( ) const
inlineoverridevirtual

Used for syntax highlighting symbol class

Implements Definition.

Definition at line 130 of file filedef.cpp.

130{ return CodeSymbolType::Default; }

References Default.

◆ combineUsingRelations()

void FileDefImpl::combineUsingRelations ( )
overridevirtual

Implements FileDef.

Definition at line 1648 of file filedef.cpp.

1649{
1650 LinkedRefMap<NamespaceDef> usingDirList = m_usingDirList;
1651 NamespaceDefSet visitedNamespaces;
1652 for (auto &nd : usingDirList)
1653 {
1654 NamespaceDefMutable *ndm = toNamespaceDefMutable(nd);
1655 if (ndm)
1656 {
1657 ndm->combineUsingRelations(visitedNamespaces);
1658 }
1659 }
1660
1661 for (auto &nd : usingDirList)
1662 {
1663 // add used namespaces of namespace nd to this namespace
1664 for (const auto &und : nd->getUsedNamespaces())
1665 {
1666 addUsingDirective(und);
1667 }
1668 // add used classes of namespace nd to this namespace
1669 for (const auto &ud : nd->getUsedDefinitions())
1670 {
1672 }
1673 }
1674}
void addUsingDirective(NamespaceDef *nd) override
Definition filedef.cpp:1516
void addUsingDeclaration(const Definition *d) override
Definition filedef.cpp:1528
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 330 of file filedef.cpp.

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

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

◆ countMembers()

void FileDefImpl::countMembers ( )
overridevirtual

Implements FileDef.

Definition at line 1899 of file filedef.cpp.

1900{
1901 for (auto &ml : m_memberLists)
1902 {
1903 ml->countDecMembers();
1904 ml->countDocMembers();
1905 }
1906 for (const auto &mg : m_memberGroups)
1907 {
1908 mg->countDecMembers();
1909 mg->countDocMembers();
1910 }
1911}

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

129{ return TypeFile; }

References definitionType(), and Definition::TypeFile.

Referenced by definitionType().

◆ displayName()

QCString FileDefImpl::displayName ( bool includeScope = TRUE) const
inlineoverridevirtual

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

Implements Definition.

Definition at line 133 of file filedef.cpp.

133{ return localName(); }
const QCString & localName() const override

References DefinitionMixin< FileDef >::localName(), and TRUE.

Referenced by writeDocumentation().

◆ distributeMemberGroupDocumentation()

void FileDefImpl::distributeMemberGroupDocumentation ( )
overridevirtual

Implements FileDef.

Definition at line 336 of file filedef.cpp.

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

References m_memberGroups.

◆ docName()

const QCString & FileDefImpl::docName ( ) const
inlineoverridevirtual

Returns the name as it is used in the documentation

Implements FileDef.

Definition at line 142 of file filedef.cpp.

142{ return m_docname; }

References m_docname.

◆ endMemberDeclarations()

void FileDefImpl::endMemberDeclarations ( OutputList & ol)
private

Definition at line 751 of file filedef.cpp.

752{
754}
void endMemberSections()
Definition outputlist.h:463

References OutputList::endMemberSections().

Referenced by writeDocumentation().

◆ endMemberDocumentation()

void FileDefImpl::endMemberDocumentation ( OutputList & ol)
private

Definition at line 765 of file filedef.cpp.

766{
767 if (Config_getBool(SEPARATE_MEMBER_PAGES))
768 {
771 }
772}
static bool suppressDocWarnings
Definition doxygen.h:132
void enable(OutputType o)
#define FALSE
Definition qcstring.h:34

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

Referenced by writeDocumentation().

◆ fileName()

QCString FileDefImpl::fileName ( ) const
inlineoverridevirtual

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

Implements FileDef.

Definition at line 134 of file filedef.cpp.

134{ return m_fileName; }

References m_fileName.

◆ fileVersion()

QCString FileDefImpl::fileVersion ( ) const
overridevirtual

Implements FileDef.

Definition at line 1884 of file filedef.cpp.

1885{
1886 return m_fileVersion;
1887}

References m_fileVersion.

◆ findSectionsInDocumentation()

void FileDefImpl::findSectionsInDocumentation ( )
overridevirtual

Implements FileDef.

Definition at line 345 of file filedef.cpp.

346{
350 for (const auto &mg : m_memberGroups)
351 {
352 mg->findSectionsInDocumentation(this);
353 }
354
355 for (auto &ml : m_memberLists)
356 {
357 if (ml->listType().isDeclaration())
358 {
359 ml->findSectionsInDocumentation(this);
360 }
361 }
362}
QCString docFile() const override
QCString briefDescription(bool abbreviate=FALSE) const override
QCString inbodyDocumentation() const override
QCString documentation() const override
void docFindSections(const QCString &input, const Definition *d, const QCString &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 1609 of file filedef.cpp.

1610{
1611 bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
1612 bool verbatimHeaders = Config_getBool(VERBATIM_HEADERS);
1613 return !isReference() &&
1614 (sourceBrowser ||
1615 (verbatimHeaders && (guessSection(name()).isHeader() || !m_includedByMap.empty()))
1616 ) &&
1618}
bool isReference() const override
bool isDocumentationFile() const override
Definition filedef.cpp:1676

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

Referenced by writeSourceHeader(), and writeSourceLink().

◆ getAllIncludeFilesRecursively()

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

Implements FileDef.

Definition at line 1866 of file filedef.cpp.

1867{
1868 StringUnorderedSet includes;
1869 ::getAllIncludeFilesRecursively(includes,this,incFiles);
1870}
void getAllIncludeFilesRecursively(StringVector &incFiles) const override
Definition filedef.cpp:1866
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 164 of file filedef.cpp.

164{ return m_classes; }
ClassLinkedRefMap m_classes
Definition filedef.cpp:258

References m_classes.

◆ getConcepts()

const ConceptLinkedRefMap & FileDefImpl::getConcepts ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 163 of file filedef.cpp.

163{ return m_concepts; }
ConceptLinkedRefMap m_concepts
Definition filedef.cpp:262

References m_concepts.

◆ getDirDef()

DirDef * FileDefImpl::getDirDef ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 152 of file filedef.cpp.

152{ return m_dir; }

References m_dir.

Referenced by writeDocumentation(), and writeSourceHeader().

◆ getMemberGroups()

const MemberGroupList & FileDefImpl::getMemberGroups ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 161 of file filedef.cpp.

161{ return m_memberGroups; }

References m_memberGroups.

◆ getMemberList()

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

Implements FileDef.

Definition at line 1808 of file filedef.cpp.

1809{
1810 for (auto &ml : m_memberLists)
1811 {
1812 if (ml->listType()==lt)
1813 {
1814 return ml.get();
1815 }
1816 }
1817 return nullptr;
1818}

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

160{ return m_memberLists; }

References m_memberLists.

◆ getModuleDef()

ModuleDef * FileDefImpl::getModuleDef ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 153 of file filedef.cpp.

153{ return m_moduleDef; }
ModuleDef * m_moduleDef
Definition filedef.cpp:254

References m_moduleDef.

◆ getNamespaces()

const NamespaceLinkedRefMap & FileDefImpl::getNamespaces ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 162 of file filedef.cpp.

162{ return m_namespaces; }
NamespaceLinkedRefMap m_namespaces
Definition filedef.cpp:257

References m_namespaces.

◆ getOutputFileBase()

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

1733{
1734 return m_outputDiskName;
1735}
QCString m_outputDiskName
Definition filedef.cpp:246

References m_outputDiskName.

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

◆ getPath()

QCString FileDefImpl::getPath ( ) const
inlineoverridevirtual

Returns the absolute path of this file.

Implements FileDef.

Definition at line 147 of file filedef.cpp.

147{ return m_path; }

References m_path.

Referenced by writeTagFile().

◆ getSourceDefinition()

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

Implements FileDef.

Definition at line 1501 of file filedef.cpp.

1502{
1503 auto it = m_srcDefMap.find(lineNr);
1504 //printf("%s::getSourceDefinition(%d)=%s\n",qPrint(name()),lineNr,it!=m_srcDefMap.end()?qPrint(it->second->name()):"none");
1505 return it!=m_srcDefMap.end() ? it->second : nullptr;
1506}

References m_srcDefMap.

◆ getSourceFileBase()

QCString FileDefImpl::getSourceFileBase ( ) const
overridevirtual

Returns the name of the source listing of this definition.

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 1720 of file filedef.cpp.

1721{
1722 if (Htags::useHtags)
1723 {
1725 }
1726 else
1727 {
1728 return m_outputDiskName+"_source";
1729 }
1730}
static QCString path2URL(const QCString &path)
Definition htags.cpp:157
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 1508 of file filedef.cpp.

1509{
1510 auto it = m_srcMemberMap.find(lineNr);
1511 //printf("%s::getSourceMember(%d)=%s\n",qPrint(name()),lineNr,it!=m_srcMemberMap.end()?qPrint(it->second->name()):"none");
1512 return it!=m_srcMemberMap.end() ? it->second : nullptr;
1513}

References m_srcMemberMap.

◆ getUsedDefinitions()

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

Implements FileDef.

Definition at line 155 of file filedef.cpp.

155{ return m_usingDeclList; }

References m_usingDeclList.

◆ getUsedNamespaces()

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

Implements FileDef.

Definition at line 1522 of file filedef.cpp.

1523{
1524 //printf("%p: FileDefImpl::getUsedNamespace: %s:%d\n",this,qPrint(name()),usingDirList?usingDirList->count():0);
1525 return m_usingDirList;
1526}

References m_usingDirList.

◆ getVersion()

QCString FileDefImpl::getVersion ( ) const
inlineoverridevirtual

Returns version of this file.

Implements FileDef.

Definition at line 148 of file filedef.cpp.

148{ return m_fileVersion; }

References m_fileVersion.

◆ hasDetailedDescription()

bool FileDefImpl::hasDetailedDescription ( ) const
overridevirtual

Implements FileDef.

Definition at line 364 of file filedef.cpp.

365{
366 bool repeatBrief = Config_getBool(REPEAT_BRIEF);
367 bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
368 return ((!briefDescription().isEmpty() && repeatBrief) ||
369 !documentation().stripWhiteSpace().isEmpty() || // avail empty section
370 (sourceBrowser && getStartBodyLine()!=-1 && getBodyDef())
371 );
372}
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:72

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

Referenced by writeDetailedDescription().

◆ hasIncludedByGraph()

bool FileDefImpl::hasIncludedByGraph ( ) const
overridevirtual

Implements FileDef.

Definition at line 1940 of file filedef.cpp.

1941{
1942 return m_hasIncludedByGraph;
1943}
bool m_hasIncludedByGraph
Definition filedef.cpp:265

References m_hasIncludedByGraph.

◆ hasIncludeGraph()

bool FileDefImpl::hasIncludeGraph ( ) const
overridevirtual

Implements FileDef.

Definition at line 1935 of file filedef.cpp.

1936{
1937 return m_hasIncludeGraph;
1938}
bool m_hasIncludeGraph
Definition filedef.cpp:264

References m_hasIncludeGraph.

◆ includedByDependencyGraphFileName()

QCString FileDefImpl::includedByDependencyGraphFileName ( ) const
overridevirtual

Implements FileDef.

Definition at line 1894 of file filedef.cpp.

1895{
1896 return m_inclByDepFileName;
1897}
QCString m_inclByDepFileName
Definition filedef.cpp:245

References m_inclByDepFileName.

◆ includedByFileList()

const IncludeInfoList & FileDefImpl::includedByFileList ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 157 of file filedef.cpp.

157{ return m_includedByList; }

References m_includedByList.

◆ includeDependencyGraphFileName()

QCString FileDefImpl::includeDependencyGraphFileName ( ) const
overridevirtual

Implements FileDef.

Definition at line 1889 of file filedef.cpp.

1890{
1891 return m_inclDepFileName;
1892}
QCString m_inclDepFileName
Definition filedef.cpp:244

References m_inclDepFileName.

◆ includeFileList()

const IncludeInfoList & FileDefImpl::includeFileList ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 156 of file filedef.cpp.

156{ return m_includeList; }

References m_includeList.

◆ includeName()

QCString FileDefImpl::includeName ( ) const
overridevirtual

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

Implements FileDef.

Definition at line 1738 of file filedef.cpp.

1739{
1740 return getSourceFileBase();
1741}
QCString getSourceFileBase() const override
Definition filedef.cpp:1720

References getSourceFileBase().

Referenced by 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 1443 of file filedef.cpp.

1444{
1445 if (cd->isHidden()) return;
1446
1447 ClassLinkedRefMap *list = &m_classes;
1448
1449 if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
1450 {
1452 {
1453 list = &m_interfaces;
1454 }
1455 else if (cd->compoundType()==ClassDef::Struct)
1456 {
1457 list = &m_structs;
1458 }
1459 else if (cd->compoundType()==ClassDef::Exception)
1460 {
1461 list = &m_exceptions;
1462 }
1463 }
1464
1465 list->add(cd->name(),cd);
1466}
@ Interface
Definition classdef.h:112
@ Exception
Definition classdef.h:115
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e.
virtual bool isHidden() const =0
virtual const QCString & name() const =0
ClassLinkedRefMap m_interfaces
Definition filedef.cpp:259
ClassLinkedRefMap m_structs
Definition filedef.cpp:260
ClassLinkedRefMap m_exceptions
Definition filedef.cpp:261
bool add(const char *k, T *obj)
Definition linkedmap.h:284

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

◆ insertConcept()

void FileDefImpl::insertConcept ( ConceptDef * cd)
overridevirtual

Implements FileDef.

Definition at line 1468 of file filedef.cpp.

1469{
1470 if (cd->isHidden()) return;
1471 m_concepts.add(cd->name(),cd);
1472}

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

1321{
1322 if (md->isHidden()) return;
1323 MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
1324 //printf("%s:FileDefImpl::insertMember(%s (=%p) list has %zu elements)\n",
1325 // qPrint(name()),qPrint(md->name()),(void*)md,allMemberList ? allMemberList->size() : 0);
1326 if (allMemberList && allMemberList->contains(md))
1327 {
1328 //printf("already added\n");
1329 return;
1330 }
1331
1332 if (allMemberList==nullptr)
1333 {
1334 m_memberLists.emplace_back(std::make_unique<MemberList>(MemberListType::AllMembersList(),MemberListContainer::File));
1335 allMemberList = m_memberLists.back().get();
1336 }
1337 allMemberList->push_back(md);
1338 switch (md->memberType())
1339 {
1341 if (md->getLanguage() == SrcLangExt::Python)
1342 {
1343 addMemberToList(MemberListType::PropertyMembers(),md);
1344 addMemberToList(MemberListType::Properties(),md);
1345 break;
1346 }
1347 // fallthrough, explicitly no break here
1349 addMemberToList(MemberListType::DecVarMembers(),md);
1350 addMemberToList(MemberListType::DocVarMembers(),md);
1351 break;
1353 addMemberToList(MemberListType::DecFuncMembers(),md);
1354 addMemberToList(MemberListType::DocFuncMembers(),md);
1355 break;
1357 addMemberToList(MemberListType::DecTypedefMembers(),md);
1358 addMemberToList(MemberListType::DocTypedefMembers(),md);
1359 break;
1361 addMemberToList(MemberListType::DecSequenceMembers(),md);
1362 addMemberToList(MemberListType::DocSequenceMembers(),md);
1363 break;
1365 addMemberToList(MemberListType::DecDictionaryMembers(),md);
1366 addMemberToList(MemberListType::DocDictionaryMembers(),md);
1367 break;
1369 addMemberToList(MemberListType::DecEnumMembers(),md);
1370 addMemberToList(MemberListType::DocEnumMembers(),md);
1371 break;
1372 case MemberType::EnumValue: // enum values are shown inside their enums
1373 break;
1374 case MemberType::Define:
1375 addMemberToList(MemberListType::DecDefineMembers(),md);
1376 addMemberToList(MemberListType::DocDefineMembers(),md);
1377 break;
1378 default:
1379 err("FileDefImpl::insertMembers(): "
1380 "member '{}' with class scope '{}' inserted in file scope '{}'!\n",
1381 md->name(),
1382 md->getClassDef() ? md->getClassDef()->name() : "<global>",
1383 name());
1384 }
1385 //addMemberToGroup(md,groupId);
1386}
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
void addMemberToList(MemberListType lt, MemberDef *md)
Definition filedef.cpp:1743
virtual const ClassDef * getClassDef() const =0
virtual MemberType memberType() const =0
bool contains(const MemberDef *md) const
Definition memberlist.h:89
void push_back(const T &value)
Definition memberlist.h:48
@ Enumeration
Definition types.h:557
@ EnumValue
Definition types.h:558
@ Dictionary
Definition types.h:568
@ Sequence
Definition types.h:567
@ Variable
Definition types.h:555
@ Property
Definition types.h:563
@ Typedef
Definition types.h:556
@ Function
Definition types.h:554

References addMemberToList(), MemberVector::contains(), Define, Dictionary, Enumeration, EnumValue, err, File, Function, MemberDef::getClassDef(), Definition::getLanguage(), getMemberList(), Definition::isHidden(), m_memberLists, MemberDef::memberType(), Definition::name(), name(), Property, MemberVector::push_back(), Sequence, Typedef, and Variable.

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

1476{
1477 if (nd->isHidden()) return;
1478 m_namespaces.add(nd->name(),nd);
1479}

References Definition::isHidden(), m_namespaces, and Definition::name().

◆ isDocumentationFile()

bool FileDefImpl::isDocumentationFile ( ) const
overridevirtual

Implements FileDef.

Definition at line 1676 of file filedef.cpp.

1677{
1678 static const std::unordered_set<std::string> docExtensions =
1679 { "doc", "txt", "dox", "md", "markdown" };
1680
1681 int lastDot = name().findRev('.');
1682 return (lastDot!=-1 && docExtensions.find(name().mid(lastDot+1).str())!=docExtensions.end()) ||
1683 getLanguageFromFileName(getFileNameExtension(name())) == SrcLangExt::Markdown;
1684}
int findRev(char c, int index=-1, bool cs=TRUE) const
Definition qcstring.cpp:96
QCString getFileNameExtension(const QCString &fn)
Definition util.cpp:5149

References QCString::findRev(), getFileNameExtension(), getLanguageFromFileName(), and name().

Referenced by generateSourceFile(), and writeSourceHeader().

◆ isIncluded()

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

Implements FileDef.

Definition at line 1603 of file filedef.cpp.

1604{
1605 if (name.isEmpty()) return FALSE;
1606 return m_includeMap.find(name.str())!=m_includeMap.end();
1607}

References FALSE, 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 150 of file filedef.cpp.

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

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

Referenced by 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 1844 of file filedef.cpp.

1845{
1846 bool showFiles = Config_getBool(SHOW_FILES);
1847 return hasDocumentation() && !isReference() && (showFiles || isLinkableViaGroup());
1848}
bool isLinkableViaGroup() const override
bool hasDocumentation() const override

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

Referenced by isLinkable().

◆ isSource()

bool FileDefImpl::isSource ( ) const
inlineoverridevirtual

Returns TRUE if this file is a source file.

Implements FileDef.

Definition at line 143 of file filedef.cpp.

143{ return m_isSource; }

References m_isSource.

◆ name()

◆ numDecMembers()

int FileDefImpl::numDecMembers ( ) const
overridevirtual

Implements FileDef.

Definition at line 1919 of file filedef.cpp.

1920{
1921 MemberList *ml = getMemberList(MemberListType::AllMembersList());
1922 return ml ? ml->numDecMembers() : 0;
1923}
int numDecMembers(const ClassDef *inheritedFrom) const
Definition memberlist.h:133

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

◆ numDocMembers()

int FileDefImpl::numDocMembers ( ) const
overridevirtual

Implements FileDef.

Definition at line 1913 of file filedef.cpp.

1914{
1915 MemberList *ml = getMemberList(MemberListType::AllMembersList());
1916 return ml ? ml->numDocMembers() : 0;
1917}
int numDocMembers() const
Definition memberlist.h:138

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

◆ overrideIncludedByGraph()

void FileDefImpl::overrideIncludedByGraph ( bool e)
overridevirtual

Implements FileDef.

Definition at line 1930 of file filedef.cpp.

1931{
1933}

References m_hasIncludedByGraph.

◆ overrideIncludeGraph()

void FileDefImpl::overrideIncludeGraph ( bool e)
overridevirtual

Implements FileDef.

Definition at line 1925 of file filedef.cpp.

1926{
1928}

References m_hasIncludeGraph.

◆ parseSource()

void FileDefImpl::parseSource ( ClangTUParser * clangParser)
overridevirtual

Implements FileDef.

Definition at line 1271 of file filedef.cpp.

1272{
1273 bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
1274 OutputCodeList devNullList;
1275 devNullList.add<DevNullCodeGenerator>();
1276#if USE_LIBCLANG
1277 if (Doxygen::clangAssistedParsing && clangParser &&
1278 (getLanguage()==SrcLangExt::Cpp || getLanguage()==SrcLangExt::ObjC))
1279 {
1280 clangParser->switchToFile(this);
1281 clangParser->writeSources(devNullList,this);
1282 }
1283 else
1284#endif
1285 {
1287 intf->resetCodeParserState();
1288 intf->parseCode(
1289 devNullList,QCString(),
1290 fileToString(absFilePath(),filterSourceFiles,TRUE),
1291 getLanguage(),
1292 Config_getBool(STRIP_CODE_COMMENTS),
1293 FALSE,QCString(),this
1294 );
1295 }
1296}
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
QCString getDefFileExtension() const override
SrcLangExt getLanguage() const override
static bool clangAssistedParsing
Definition doxygen.h:138
static ParserManager * parserManager
Definition doxygen.h:131
QCString absFilePath() const override
Definition filedef.cpp:141
void add(OutputCodeIntfPtr &&p)
Definition outputlist.h:195
std::unique_ptr< CodeParserInterface > getCodeParser(const QCString &extension)
Gets the interface to the parser associated with a given extension.
Definition parserintf.h:218
QCString fileToString(const QCString &name, bool filter, bool isSourceCode)
Definition util.cpp:1439

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

◆ removeMember()

void FileDefImpl::removeMember ( MemberDef * md)
overridevirtual

Implements FileDef.

Definition at line 1394 of file filedef.cpp.

1395{
1396 removeMemberFromList(MemberListType::AllMembersList(),md);
1397 switch(md->memberType())
1398 {
1400 if (md->getLanguage() == SrcLangExt::Python)
1401 {
1402 removeMemberFromList(MemberListType::PropertyMembers(),md);
1403 removeMemberFromList(MemberListType::Properties(),md);
1404 break;
1405 }
1406 // fallthrough, explicitly no break here
1408 removeMemberFromList(MemberListType::DecVarMembers(),md);
1409 removeMemberFromList(MemberListType::DocVarMembers(),md);
1410 break;
1412 removeMemberFromList(MemberListType::DecFuncMembers(),md);
1413 removeMemberFromList(MemberListType::DocFuncMembers(),md);
1414 break;
1416 removeMemberFromList(MemberListType::DecTypedefMembers(),md);
1417 removeMemberFromList(MemberListType::DocTypedefMembers(),md);
1418 break;
1420 removeMemberFromList(MemberListType::DecSequenceMembers(),md);
1421 removeMemberFromList(MemberListType::DocSequenceMembers(),md);
1422 break;
1424 removeMemberFromList(MemberListType::DecDictionaryMembers(),md);
1425 removeMemberFromList(MemberListType::DocDictionaryMembers(),md);
1426 break;
1428 removeMemberFromList(MemberListType::DecEnumMembers(),md);
1429 removeMemberFromList(MemberListType::DocEnumMembers(),md);
1430 break;
1431 case MemberType::EnumValue: // enum values are shown inside their enums
1432 break;
1433 case MemberType::Define:
1434 removeMemberFromList(MemberListType::DecDefineMembers(),md);
1435 removeMemberFromList(MemberListType::DocDefineMembers(),md);
1436 break;
1437 default:
1438 err("FileDefImpl::removeMember(): unexpected member remove in file!\n");
1439 }
1440}
void removeMemberFromList(MemberListType lt, MemberDef *md)
Definition filedef.cpp:1388

References Define, Dictionary, Enumeration, EnumValue, err, Function, Definition::getLanguage(), MemberDef::memberType(), Property, removeMemberFromList(), Sequence, Typedef, and Variable.

◆ removeMemberFromList()

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

Definition at line 1388 of file filedef.cpp.

1389{
1390 MemberList *ml = getMemberList(lt);
1391 if (ml) ml->remove(md);
1392}
void remove(const MemberDef *md)
Definition memberlist.h:84

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

Referenced by removeMember().

◆ setDirDef()

void FileDefImpl::setDirDef ( DirDef * dd)
inlineoverridevirtual

Implements FileDef.

Definition at line 190 of file filedef.cpp.

190{ m_dir=dd; }

References m_dir.

◆ setDiskName()

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

Implements FileDef.

Definition at line 324 of file filedef.cpp.

325{
327}

References name(), and setDiskNameLocal().

◆ setDiskNameLocal()

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

Definition at line 308 of file filedef.cpp.

309{
310 if (isReference())
311 {
313 m_inclDepFileName = name+"_incl";
314 m_inclByDepFileName = name+"_dep_incl";
315 }
316 else
317 {
321 }
322}
QCString convertNameToFile(const QCString &name, bool allowDots, bool allowUnderscore)
Definition util.cpp:3425

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

Referenced by FileDefImpl(), and setDiskName().

◆ setModuleDef()

void FileDefImpl::setModuleDef ( ModuleDef * mod)
inlineoverridevirtual

Implements FileDef.

Definition at line 191 of file filedef.cpp.

191{ m_moduleDef=mod; }

References m_moduleDef.

◆ sortMemberLists()

void FileDefImpl::sortMemberLists ( )
overridevirtual

Implements FileDef.

Definition at line 1762 of file filedef.cpp.

1763{
1764 for (auto &ml : m_memberLists)
1765 {
1766 if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(FALSE); }
1767 }
1768
1769 for (const auto &mg : m_memberGroups)
1770 {
1771 MemberList &mlg = const_cast<MemberList&>(mg->members());
1772 if (mlg.needsSorting()) { mlg.sort(); mlg.setNeedsSorting(FALSE); }
1773 }
1774
1775 std::stable_sort(m_includedByList.begin(),m_includedByList.end(),
1776 [](const auto &fi1,const auto &fi2) { return fi1.includeName < fi2.includeName; });
1777
1778 if (Config_getBool(SORT_BRIEF_DOCS))
1779 {
1780 auto classComp = [](const ClassLinkedRefMap::Ptr &c1,const ClassLinkedRefMap::Ptr &c2)
1781 {
1782 return Config_getBool(SORT_BY_SCOPE_NAME) ?
1783 qstricmp_sort(c1->name(), c2->name())<0 :
1784 qstricmp_sort(c1->className(), c2->className())<0;
1785 };
1786
1787 std::stable_sort(m_classes.begin(), m_classes.end(), classComp);
1788 std::stable_sort(m_interfaces.begin(),m_interfaces.end(),classComp);
1789 std::stable_sort(m_structs.begin(), m_structs.end(), classComp);
1790 std::stable_sort(m_exceptions.begin(),m_exceptions.end(),classComp);
1791
1792 auto conceptComp = [](const ConceptLinkedRefMap::Ptr &c1,const ConceptLinkedRefMap::Ptr &c2)
1793 {
1794 return qstricmp_sort(c1->name(),c2->name())<0;
1795 };
1796
1797 std::stable_sort(m_concepts.begin(), m_concepts.end(), conceptComp);
1798
1799 auto namespaceComp = [](const NamespaceLinkedRefMap::Ptr &n1,const NamespaceLinkedRefMap::Ptr &n2)
1800 {
1801 return qstricmp_sort(n1->name(),n2->name())<0;
1802 };
1803
1804 std::stable_sort(m_namespaces.begin(),m_namespaces.end(),namespaceComp);
1805 }
1806}
virtual QCString className() const =0
Returns the name of the class including outer classes, but not including namespaces.
bool needsSorting() const
Definition memberlist.h:140
void setNeedsSorting(bool b)
void sort()
Definition memberlist.h:76
int qstricmp_sort(const char *str1, const char *str2)
Definition qcstring.h:86

References ClassDef::className(), Config_getBool, FALSE, m_classes, m_concepts, m_exceptions, m_includedByList, m_interfaces, m_memberGroups, m_memberLists, m_namespaces, m_structs, Definition::name(), MemberList::needsSorting(), qstricmp_sort(), MemberList::setNeedsSorting(), and MemberVector::sort().

◆ startMemberDeclarations()

void FileDefImpl::startMemberDeclarations ( OutputList & ol)
private

Definition at line 746 of file filedef.cpp.

747{
749}
void startMemberSections()
Definition outputlist.h:461

References OutputList::startMemberSections().

Referenced by writeDocumentation().

◆ startMemberDocumentation()

void FileDefImpl::startMemberDocumentation ( OutputList & ol)
private

Definition at line 756 of file filedef.cpp.

757{
758 if (Config_getBool(SEPARATE_MEMBER_PAGES))
759 {
762 }
763}
void disable(OutputType o)

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

Referenced by writeDocumentation().

◆ subGrouping()

bool FileDefImpl::subGrouping ( ) const
inlineoverridevirtual

Implements FileDef.

Definition at line 168 of file filedef.cpp.

168{ return m_subGrouping; }

References m_subGrouping.

◆ title()

QCString FileDefImpl::title ( ) const
overridevirtual

Implements FileDef.

Definition at line 1872 of file filedef.cpp.

1873{
1874 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
1875 {
1876 return name();
1877 }
1878 else
1879 {
1881 }
1882}
virtual QCString trFileReference(const QCString &fileName)=0

References Config_getBool, name(), and theTranslator.

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

◆ writeAuthorSection()

void FileDefImpl::writeAuthorSection ( OutputList & ol)
private

Definition at line 786 of file filedef.cpp.

787{
788 // write Author section (Man only)
791 ol.startGroupHeader();
793 ol.endGroupHeader();
796}
void startGroupHeader(const QCString &id=QCString(), int extraLevels=0)
Definition outputlist.h:453
void pushGeneratorState()
void disableAllBut(OutputType o)
void popGeneratorState()
void endGroupHeader(int extraLevels=0)
Definition outputlist.h:455
void parseText(const QCString &textStr)
virtual QCString trGeneratedAutomatically(const QCString &s)=0
virtual QCString trAuthor(bool first_capital, bool singular)=0

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

Referenced by writeDocumentation().

◆ writeBriefDescription()

void FileDefImpl::writeBriefDescription ( OutputList & ol)
private

Definition at line 543 of file filedef.cpp.

544{
546 {
547 auto parser { createDocParser() };
548 auto ast { validatingParseDoc(*parser.get(),
549 briefFile(),
550 briefLine(),
551 this,
552 nullptr,
554 DocOptions()
555 .setIndexWords(true)
556 .setSingleLine(true))
557 };
558 if (!ast->isEmpty())
559 {
560 ol.startParagraph();
563 ol.writeString(" - ");
565 ol.writeDoc(ast.get(),this,nullptr);
568 ol.writeString(" \n");
570
571 if (Config_getBool(REPEAT_BRIEF) ||
572 !documentation().stripWhiteSpace().isEmpty()
573 )
574 {
576 ol.startTextLink(QCString(),"details");
578 ol.endTextLink();
579 }
581 ol.endParagraph();
582 }
583 }
584 ol.writeSynopsis();
585}
virtual QCString 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:383
void writeString(const QCString &text)
Definition outputlist.h:411
void startParagraph(const QCString &classDef=QCString())
Definition outputlist.h:407
void endParagraph()
Definition outputlist.h:409
void endTextLink()
Definition outputlist.h:444
void writeSynopsis()
Definition outputlist.h:592
void startTextLink(const QCString &file, const QCString &anchor)
Definition outputlist.h:442
virtual QCString trMore()=0
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &input, const DocOptions &options)
IDocParserPtr createDocParser()
factory function to create a parser
Definition docparser.cpp:55

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, validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString(), and OutputList::writeSynopsis().

Referenced by writeDocumentation().

◆ writeClassDeclarations()

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

Definition at line 721 of file filedef.cpp.

722{
723 // write list of classes
724 list.writeDeclaration(ol,nullptr,title,FALSE);
725}
void writeDeclaration(OutputList &ol, const ClassDef::CompoundType *filter, const QCString &header, bool localNames) const
Definition classlist.cpp:53
QCString title() const override
Definition filedef.cpp:1872

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

Referenced by writeDocumentation().

◆ writeClassesToTagFile()

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

Definition at line 587 of file filedef.cpp.

588{
589 for (const auto &cd : list)
590 {
591 if (cd->isLinkableInProject())
592 {
593 tagFile << " <class kind=\"" << cd->compoundTypeString() <<
594 "\">" << convertToXML(cd->name()) << "</class>\n";
595 }
596 }
597}
QCString convertToXML(const QCString &s, bool keepEntities)
Definition util.cpp:3833

References convertToXML().

Referenced by writeTagFile().

◆ writeConcepts()

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

Definition at line 727 of file filedef.cpp.

728{
729 // write list of classes
730 m_concepts.writeDeclaration(ol,title,FALSE);
731}

References FALSE, m_concepts, and title().

Referenced by writeDocumentation().

◆ writeDetailedDescription()

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

Definition at line 472 of file filedef.cpp.

473{
475 {
478 ol.writeRuler();
482 ol.writeAnchor(QCString(),"details");
484 ol.startGroupHeader("details");
485 ol.parseText(title);
486 ol.endGroupHeader();
487
488 ol.startTextBlock();
489 if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
490 {
492 briefLine(),
493 this,
494 nullptr,
496 DocOptions());
497 }
498 if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF) &&
499 !documentation().isEmpty())
500 {
504 ol.enableAll();
507 ol.writeString("\n\n");
509 }
510 if (!documentation().isEmpty())
511 {
512 ol.generateDoc(docFile(),
513 docLine(),
514 this,
515 nullptr,
516 documentation()+"\n",
517 DocOptions()
518 .setIndexWords(true));
519 }
520 //printf("Writing source ref for file %s\n",qPrint(name()));
521 if (Config_getBool(SOURCE_BROWSER))
522 {
523 ol.startParagraph("definition");
524 QCString refText = theTranslator->trDefinedInSourceFile();
525 int fileMarkerPos = refText.find("@0");
526 if (fileMarkerPos!=-1) // should always pass this.
527 {
528 ol.parseText(refText.left(fileMarkerPos)); //text left from marker 1
529 ol.writeObjectLink(QCString(),getSourceFileBase(),QCString(),name());
530 ol.parseText(refText.right(
531 refText.length()-fileMarkerPos-2)); // text right from marker 2
532 }
533 else
534 {
535 err("translation error: invalid marker in trDefinedInSourceFile()\n");
536 }
537 ol.endParagraph();
538 }
539 ol.endTextBlock();
540 }
541}
QCString briefFile() const override
int docLine() const override
bool hasDetailedDescription() const override
Definition filedef.cpp:364
void endTextBlock(bool paraBreak=FALSE)
Definition outputlist.h:672
void writeRuler()
Definition outputlist.h:521
void writeObjectLink(const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
Definition outputlist.h:439
void generateDoc(const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &docStr, const DocOptions &options)
void startTextBlock(bool dense=FALSE)
Definition outputlist.h:670
void writeAnchor(const QCString &fileName, const QCString &name)
Definition outputlist.h:523
void enableAll()
int find(char c, int index=0, bool cs=TRUE) const
Definition qcstring.cpp:43
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:166
QCString right(size_t len) const
Definition qcstring.h:234
QCString left(size_t len) const
Definition qcstring.h:229
virtual QCString 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, QCString::find(), OutputList::generateDoc(), getSourceFileBase(), hasDetailedDescription(), Html, Latex, QCString::left(), QCString::length(), Man, name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), QCString::right(), RTF, OutputList::startGroupHeader(), OutputList::startParagraph(), OutputList::startTextBlock(), theTranslator, title(), OutputList::writeAnchor(), OutputList::writeObjectLink(), 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 872 of file filedef.cpp.

873{
874 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
875 //funcList->countDecMembers();
876
877 //QCString fn = name();
878 //if (Config_getBool(FULL_PATH_NAMES))
879 //{
880 // fn.prepend(stripFromPath(getPath()));
881 //}
882
883 //printf("WriteDocumentation diskname=%s\n",qPrint(diskname));
884
885 QCString versionTitle;
886 if (!m_fileVersion.isEmpty())
887 {
888 versionTitle=("("+m_fileVersion+")");
889 }
890 QCString title = m_docname+versionTitle;
891 QCString pageTitle;
892 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
893 {
894 pageTitle=m_docname;
895 }
896 else
897 {
899 }
900
901 if (getDirDef())
902 {
903 startFile(ol,getOutputFileBase(),false,name(),pageTitle,HighlightedItem::FileVisible,!generateTreeView);
904 if (!generateTreeView)
905 {
907 ol.endQuickIndices();
908 }
909 startTitle(ol,getOutputFileBase(),this);
912 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
913 {
914 ol.parseText(displayName()); // Html only
915 }
916 else
917 {
919 }
920 ol.enableAll();
922 if (Config_getBool(HIDE_COMPOUND_REFERENCE))
923 {
924 ol.parseText(Config_getBool(FULL_PATH_NAMES) ? // other output formats
925 pageTitle :
926 name());
927 }
928 else
929 {
930 ol.parseText(Config_getBool(FULL_PATH_NAMES) ? // other output formats
931 pageTitle :
933 }
935 addGroupListToTitle(ol,this);
937 }
938 else
939 {
940 startFile(ol,getOutputFileBase(),false,name(),pageTitle,HighlightedItem::FileVisible,!generateTreeView);
941 if (!generateTreeView)
942 {
943 ol.endQuickIndices();
944 }
945 startTitle(ol,getOutputFileBase(),this);
946 ol.parseText(pageTitle);
947 addGroupListToTitle(ol,this);
949 }
950
951 ol.startContents();
952
953 if (!m_fileVersion.isEmpty())
954 {
957 ol.docify(versionTitle);
958 ol.endProjectNumber();
959 ol.enableAll();
960 }
961
962 //---------------------------------------- start flexible part -------------------------------
963
964 SrcLangExt lang = getLanguage();
965 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
966 {
967 const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
968 switch (lde->kind())
969 {
970 case LayoutDocEntry::BriefDesc:
972 break;
973 case LayoutDocEntry::MemberDeclStart:
975 break;
976 case LayoutDocEntry::FileIncludes:
978 break;
979 case LayoutDocEntry::FileIncludeGraph:
981 break;
982 case LayoutDocEntry::FileIncludedByGraph:
984 break;
985 case LayoutDocEntry::FileSourceLink:
986 writeSourceLink(ol);
987 break;
988 case LayoutDocEntry::FileClasses:
989 if (ls) writeClassDeclarations(ol,ls->title(lang),m_classes);
990 break;
991 case LayoutDocEntry::FileInterfaces:
992 if (ls) writeClassDeclarations(ol,ls->title(lang),m_interfaces);
993 break;
994 case LayoutDocEntry::FileStructs:
995 if (ls) writeClassDeclarations(ol,ls->title(lang),m_structs);
996 break;
997 case LayoutDocEntry::FileExceptions:
998 if (ls) writeClassDeclarations(ol,ls->title(lang),m_exceptions);
999 break;
1000 case LayoutDocEntry::FileConcepts:
1001 if (ls) writeConcepts(ol,ls->title(lang));
1002 break;
1003 case LayoutDocEntry::FileNamespaces:
1004 if (ls) writeNamespaceDeclarations(ol,ls->title(lang),false);
1005 break;
1006 case LayoutDocEntry::FileConstantGroups:
1007 if (ls) writeNamespaceDeclarations(ol,ls->title(lang),true);
1008 break;
1009 case LayoutDocEntry::MemberGroups:
1011 break;
1012 case LayoutDocEntry::MemberDecl:
1013 {
1014 const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
1015 if (lmd) writeMemberDeclarations(ol,lmd->type,lmd->title(lang));
1016 }
1017 break;
1018 case LayoutDocEntry::MemberDeclEnd:
1020 break;
1021 case LayoutDocEntry::DetailedDesc:
1022 if (ls) writeDetailedDescription(ol,ls->title(lang));
1023 break;
1024 case LayoutDocEntry::MemberDefStart:
1026 break;
1027 case LayoutDocEntry::FileInlineClasses:
1029 break;
1030 case LayoutDocEntry::MemberDef:
1031 {
1032 const LayoutDocEntryMemberDef *lmd = dynamic_cast<const LayoutDocEntryMemberDef*>(lde.get());
1033 if (lmd) writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
1034 }
1035 break;
1036 case LayoutDocEntry::MemberDefEnd:
1038 break;
1039 case LayoutDocEntry::AuthorSection:
1041 break;
1042 case LayoutDocEntry::ClassIncludes:
1043 case LayoutDocEntry::ClassInheritanceGraph:
1044 case LayoutDocEntry::ClassNestedClasses:
1045 case LayoutDocEntry::ClassCollaborationGraph:
1046 case LayoutDocEntry::ClassAllMembersLink:
1047 case LayoutDocEntry::ClassUsedFiles:
1048 case LayoutDocEntry::ClassInlineClasses:
1049 case LayoutDocEntry::NamespaceNestedNamespaces:
1050 case LayoutDocEntry::NamespaceNestedConstantGroups:
1051 case LayoutDocEntry::NamespaceClasses:
1052 case LayoutDocEntry::NamespaceConcepts:
1053 case LayoutDocEntry::NamespaceInterfaces:
1054 case LayoutDocEntry::NamespaceStructs:
1055 case LayoutDocEntry::NamespaceExceptions:
1056 case LayoutDocEntry::NamespaceInlineClasses:
1057 case LayoutDocEntry::ConceptDefinition:
1058 case LayoutDocEntry::GroupClasses:
1059 case LayoutDocEntry::GroupConcepts:
1060 case LayoutDocEntry::GroupModules:
1061 case LayoutDocEntry::GroupInlineClasses:
1062 case LayoutDocEntry::GroupNamespaces:
1063 case LayoutDocEntry::GroupDirs:
1064 case LayoutDocEntry::GroupNestedGroups:
1065 case LayoutDocEntry::GroupFiles:
1066 case LayoutDocEntry::GroupGraph:
1067 case LayoutDocEntry::GroupPageDocs:
1068 case LayoutDocEntry::ModuleExports:
1069 case LayoutDocEntry::ModuleClasses:
1070 case LayoutDocEntry::ModuleConcepts:
1071 case LayoutDocEntry::ModuleUsedFiles:
1072 case LayoutDocEntry::DirSubDirs:
1073 case LayoutDocEntry::DirFiles:
1074 case LayoutDocEntry::DirGraph:
1075 err("Internal inconsistency: member '{}' should not be part of "
1076 "LayoutDocManager::File entry list\n",lde->entryToString());
1077 break;
1078 }
1079 }
1080
1081 //---------------------------------------- end flexible part -------------------------------
1082
1083 ol.endContents();
1084
1085 endFileWithNavPath(ol,this);
1086
1087 if (Config_getBool(SEPARATE_MEMBER_PAGES))
1088 {
1089 MemberList *ml = getMemberList(MemberListType::AllMembersList());
1090 if (ml) ml->sort();
1091 writeMemberPages(ol);
1092 }
1093}
virtual void writeNavigationPath(OutputList &ol) const =0
void writeBriefDescription(OutputList &ol)
Definition filedef.cpp:543
void writeSourceLink(OutputList &ol)
Definition filedef.cpp:699
void writeNamespaceDeclarations(OutputList &ol, const QCString &title, bool isConstantGroup)
Definition filedef.cpp:714
void writeClassDeclarations(OutputList &ol, const QCString &title, const ClassLinkedRefMap &list)
Definition filedef.cpp:721
void endMemberDeclarations(OutputList &ol)
Definition filedef.cpp:751
void writeMemberDeclarations(OutputList &ol, MemberListType lt, const QCString &title)
Definition filedef.cpp:1820
void writeInlineClasses(OutputList &ol)
Definition filedef.cpp:733
void writeIncludeFiles(OutputList &ol)
Definition filedef.cpp:599
void writeDetailedDescription(OutputList &ol, const QCString &title)
Definition filedef.cpp:472
void writeMemberPages(OutputList &ol) override
Definition filedef.cpp:1095
void writeConcepts(OutputList &ol, const QCString &title)
Definition filedef.cpp:727
void writeIncludedByGraph(OutputList &ol)
Definition filedef.cpp:673
void writeAuthorSection(OutputList &ol)
Definition filedef.cpp:786
DirDef * getDirDef() const override
Definition filedef.cpp:152
QCString displayName(bool=TRUE) const override
Definition filedef.cpp:133
void writeMemberDocumentation(OutputList &ol, MemberListType lt, const QCString &title)
Definition filedef.cpp:1838
void writeIncludeGraph(OutputList &ol)
Definition filedef.cpp:648
void startMemberDocumentation(OutputList &ol)
Definition filedef.cpp:756
void startMemberDeclarations(OutputList &ol)
Definition filedef.cpp:746
void endMemberDocumentation(OutputList &ol)
Definition filedef.cpp:765
void writeMemberGroups(OutputList &ol)
Definition filedef.cpp:774
static LayoutDocManager & instance()
Returns a reference to this singleton.
Definition layout.cpp:1435
void endContents()
Definition outputlist.h:620
void docify(const QCString &s)
Definition outputlist.h:437
void startProjectNumber()
Definition outputlist.h:391
void endQuickIndices()
Definition outputlist.h:604
void startContents()
Definition outputlist.h:618
void endProjectNumber()
Definition outputlist.h:393
void startTitle(OutputList &ol, const QCString &fileName, const DefinitionMutable *def)
Definition index.cpp:384
void endTitle(OutputList &ol, const QCString &fileName, const QCString &name)
Definition index.cpp:394
void startFile(OutputList &ol, const QCString &name, bool isSource, const QCString &manName, const QCString &title, HighlightedItem hli, bool additionalIndices, const QCString &altSidebarName, int hierarchyLevel, const QCString &allMembersFile)
Definition index.cpp:401
void endFileWithNavPath(OutputList &ol, const DefinitionMutable *d, bool showPageNavigation)
Definition index.cpp:448
QCString title(SrcLangExt lang) const
Definition layout.cpp:1786
MemberListType type
Definition layout.h:118
MemberListType type
Definition layout.h:137
QCString title(SrcLangExt lang) const
Definition layout.cpp:1798
QCString title(SrcLangExt lang) const
Definition layout.cpp:1779
SrcLangExt
Definition types.h:207
void addGroupListToTitle(OutputList &ol, const Definition *d)
Definition util.cpp:4813

References addGroupListToTitle(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), displayName(), OutputList::docify(), 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_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(), 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 673 of file filedef.cpp.

674{
675 if (Config_getBool(HAVE_DOT) && m_hasIncludedByGraph /*&& Config_getBool(INCLUDED_BY_GRAPH)*/)
676 {
677 //printf("Graph for file %s\n",qPrint(name()));
678 DotInclDepGraph incDepGraph(this,TRUE);
679 if (incDepGraph.isTooBig())
680 {
681 warn_uncond("Included by graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
682 qPrint(name()), incDepGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
683 }
684 else if (!incDepGraph.isTrivial())
685 {
686 ol.startTextBlock();
690 ol.endInclDepGraph(incDepGraph);
691 ol.enableAll();
692 ol.endTextBlock(TRUE);
693 }
694 //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
695 }
696}
void startInclDepGraph()
Definition outputlist.h:652
void endInclDepGraph(DotInclDepGraph &g)
Definition outputlist.h:654
virtual QCString trInclByDepGraph()=0
#define Config_getInt(name)
Definition config.h:34
#define warn_uncond(fmt,...)
Definition message.h:122
const char * qPrint(const char *s)
Definition qcstring.h:687

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, TRUE, and warn_uncond.

Referenced by writeDocumentation().

◆ writeIncludeFiles()

void FileDefImpl::writeIncludeFiles ( OutputList & ol)
private

Definition at line 599 of file filedef.cpp.

600{
601 if (!m_includeList.empty())
602 {
604 for (const auto &ii : m_includeList)
605 {
606 const FileDef *fd=ii.fileDef;
607 ol.startTypewriter();
608 SrcLangExt lang = fd ? fd->getLanguage() : SrcLangExt::Cpp;
609 ol.docify(::includeStatement(lang,ii.kind));
610 ol.docify(::includeOpen(lang,ii.kind));
612 ol.docify(ii.includeName);
613 ol.enableAll();
615
616 // Here we use the include file name as it appears in the file.
617 // we could also we the name as it is used within doxygen,
618 // then we should have used fd->docName() instead of ii->includeName
619 if (fd && fd->isLinkable())
620 {
623 QCString(),ii.includeName);
624 }
625 else
626 {
627 ModuleDef *mod = ModuleManager::instance().getPrimaryInterface(ii.includeName);
628 if (ii.kind==IncludeKind::ImportModule && mod && mod->isLinkable())
629 {
631 QCString(),ii.includeName);
632 }
633 else
634 {
635 ol.docify(ii.includeName);
636 }
637 }
638
639 ol.enableAll();
640 ol.docify(::includeClose(lang,ii.kind));
641 ol.endTypewriter();
642 ol.lineBreak();
643 }
644 ol.endTextBlock();
645 }
646}
virtual bool isLinkable() const =0
virtual QCString getReference() const =0
virtual QCString getOutputFileBase() const =0
virtual QCString includeName() const =0
virtual bool generateSourceFile() const =0
static ModuleManager & instance()
ModuleDef * getPrimaryInterface(const QCString &moduleName) const
void startTypewriter()
Definition outputlist.h:449
void endTypewriter()
Definition outputlist.h:451
void lineBreak(const QCString &style=QCString())
Definition outputlist.h:559
QCString includeClose(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:86
QCString includeStatement(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:56
QCString includeOpen(SrcLangExt lang, IncludeKind kind)
Definition filedef.cpp:73
@ ImportModule
Definition filedef.h:55

References OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::enableAll(), 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_includeList, OutputList::startTextBlock(), OutputList::startTypewriter(), TRUE, and OutputList::writeObjectLink().

Referenced by writeDocumentation().

◆ writeIncludeGraph()

void FileDefImpl::writeIncludeGraph ( OutputList & ol)
private

Definition at line 648 of file filedef.cpp.

649{
650 if (Config_getBool(HAVE_DOT) && m_hasIncludeGraph /*&& Config_getBool(INCLUDE_GRAPH)*/)
651 {
652 //printf("Graph for file %s\n",qPrint(name()));
653 DotInclDepGraph incDepGraph(this,FALSE);
654 if (incDepGraph.isTooBig())
655 {
656 warn_uncond("Include graph for '{}' not generated, too many nodes ({}), threshold is {}. Consider increasing DOT_GRAPH_MAX_NODES.\n",
657 qPrint(name()), incDepGraph.numNodes(), Config_getInt(DOT_GRAPH_MAX_NODES));
658 }
659 else if (!incDepGraph.isTrivial())
660 {
661 ol.startTextBlock();
665 ol.endInclDepGraph(incDepGraph);
666 ol.enableAll();
667 ol.endTextBlock(TRUE);
668 }
669 //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
670 }
671}
virtual QCString trInclDepGraph(const QCString &fName)=0

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

Referenced by writeDocumentation().

◆ writeInlineClasses()

void FileDefImpl::writeInlineClasses ( OutputList & ol)
private

Definition at line 733 of file filedef.cpp.

734{
735 // temporarily undo the disabling could be done by startMemberDocumentation()
736 // as a result of setting SEPARATE_MEMBER_PAGES to YES; see bug730512
737 bool isEnabled = ol.isEnabled(OutputType::Html);
739
740 m_classes.writeDocumentation(ol,this);
741
742 // restore the initial state if needed
743 if (!isEnabled) ol.disable(OutputType::Html);
744}
bool isEnabled(OutputType o)

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

Referenced by writeDocumentation().

◆ writeMemberDeclarations()

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

Definition at line 1820 of file filedef.cpp.

1821{
1822 bool optVhdl = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
1823 MemberList * ml = getMemberList(lt);
1824 if (ml)
1825 {
1826 if (optVhdl) // use specific declarations function
1827 {
1828
1829 VhdlDocGen::writeVhdlDeclarations(ml,ol,nullptr,nullptr,this,nullptr,nullptr);
1830 }
1831 else
1832 {
1833 ml->writeDeclarations(ol,nullptr,nullptr,this,nullptr,nullptr,title,QCString());
1834 }
1835 }
1836}
void writeDeclarations(OutputList &ol, const ClassDef *cd, const NamespaceDef *nd, const FileDef *fd, const GroupDef *gd, const ModuleDef *mod, const QCString &title, const QCString &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 QCString & title )
private

Definition at line 1838 of file filedef.cpp.

1839{
1840 MemberList * ml = getMemberList(lt);
1841 if (ml) ml->writeDocumentation(ol,name(),this,title,ml->listType().toLabel());
1842}
MemberListType listType() const
Definition memberlist.h:130
void writeDocumentation(OutputList &ol, const QCString &scopeName, const Definition *container, const QCString &title, const QCString &anchor, bool showEnumValues=FALSE, bool showInline=FALSE) const
constexpr const char * toLabel() const
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 774 of file filedef.cpp.

775{
776 /* write user defined member groups */
777 for (const auto &mg : m_memberGroups)
778 {
779 if (!mg->allMembersInSameSection() || !m_subGrouping)
780 {
781 mg->writeDeclarations(ol,nullptr,nullptr,this,nullptr,nullptr);
782 }
783 }
784}

References m_memberGroups, and m_subGrouping.

Referenced by writeDocumentation().

◆ writeMemberPages()

void FileDefImpl::writeMemberPages ( OutputList & ol)
overridevirtual

Implements FileDef.

Definition at line 1095 of file filedef.cpp.

1096{
1097 ol.pushGeneratorState();
1099
1100 for (const auto &ml : m_memberLists)
1101 {
1102 if (ml->listType().isDocumentation())
1103 {
1104 ml->writeDocumentationPage(ol,name(),this);
1105 }
1106 }
1107
1108 ol.popGeneratorState();
1109}

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

Referenced by writeDocumentation().

◆ writeNamespaceDeclarations()

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

Definition at line 714 of file filedef.cpp.

716{
717 // write list of namespaces
718 m_namespaces.writeDeclaration(ol,title,isConstantGroup);
719}

References m_namespaces, and title().

Referenced by writeDocumentation().

◆ writePageNavigation()

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

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 864 of file filedef.cpp.

865{
866 ol.writePageOutline();
867}
void writePageOutline()
Definition outputlist.h:616

References OutputList::writePageOutline().

◆ writeQuickMemberLinks()

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

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 1111 of file filedef.cpp.

1112{
1113 bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
1114
1115 ol.writeString(" <div class=\"navtab\">\n");
1116 ol.writeString(" <table>\n");
1117
1118 MemberList *allMemberList = getMemberList(MemberListType::AllMembersList());
1119 if (allMemberList)
1120 {
1121 for (const auto &md : *allMemberList)
1122 {
1123 if (md->getFileDef()==this && md->getNamespaceDef()==nullptr && md->isLinkable() && !md->isEnumValue())
1124 {
1125 if (md->isLinkableInProject())
1126 {
1127 QCString fn=md->getOutputFileBase();
1129 if (md==currentMd) // selected item => highlight
1130 {
1131 ol.writeString(" <tr><td class=\"navtabHL\">");
1132 }
1133 else
1134 {
1135 ol.writeString(" <tr><td class=\"navtab\">");
1136 }
1137 ol.writeString("<span class=\"label\"><a ");
1138 ol.writeString("href=\"");
1139 if (createSubDirs) ol.writeString("../../");
1140 ol.writeString(fn+"#"+md->anchor());
1141 ol.writeString("\">");
1142 ol.writeString(convertToHtml(md->localName()));
1143 ol.writeString("</a></span>");
1144 ol.writeString("</td></tr>\n");
1145 }
1146 }
1147 }
1148 }
1149
1150 ol.writeString(" </table>\n");
1151 ol.writeString(" </div>\n");
1152}
QCString convertToHtml(const QCString &s, bool keepEntities)
Definition util.cpp:3884
void createSubDirs(const Dir &d)
Definition util.cpp:3561
void addHtmlExtensionIfMissing(QCString &fName)
Definition util.cpp:4823

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

◆ writeSourceBody()

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

Implements FileDef.

Definition at line 1208 of file filedef.cpp.

1209{
1210 bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
1211 OutputCodeList devNullList;
1212 devNullList.add<DevNullCodeGenerator>();
1213#if USE_LIBCLANG
1214 if (Doxygen::clangAssistedParsing && clangParser &&
1215 (getLanguage()==SrcLangExt::Cpp || getLanguage()==SrcLangExt::ObjC))
1216 {
1217 auto &codeOL = ol.codeGenerators();
1218 codeOL.startCodeFragment("DoxyCode");
1219 clangParser->switchToFile(this);
1220 clangParser->writeSources(codeOL,this);
1221 codeOL.endCodeFragment("DoxyCode");
1222 }
1223 else
1224#endif
1225 {
1227 intf->resetCodeParserState();
1228 auto &codeOL = ol.codeGenerators();
1229 codeOL.startCodeFragment("DoxyCode");
1230 bool needs2PassParsing =
1231 Doxygen::parseSourcesNeeded && // we need to parse (filtered) sources for cross-references
1232 !filterSourceFiles && // but user wants to show sources as-is
1233 !getFileFilter(absFilePath(),TRUE).isEmpty(); // and there is a filter used while parsing
1234
1235 if (needs2PassParsing)
1236 {
1237 // parse code for cross-references only (see bug707641)
1238 intf->parseCode(devNullList,QCString(),
1240 getLanguage(),
1241 Config_getBool(STRIP_CODE_COMMENTS),
1242 FALSE,QCString(),this
1243 );
1244 }
1245 intf->parseCode(codeOL,QCString(),
1246 fileToString(absFilePath(),filterSourceFiles,TRUE),
1247 getLanguage(), // lang
1248 Config_getBool(STRIP_CODE_COMMENTS),
1249 FALSE, // isExampleBlock
1250 QCString(), // exampleName
1251 this, // fileDef
1252 -1, // startLine
1253 -1, // endLine
1254 FALSE, // inlineFragment
1255 nullptr, // memberDef
1256 TRUE, // showLineNumbers
1257 nullptr, // searchCtx
1258 !needs2PassParsing // collectXRefs
1259 );
1260 codeOL.endCodeFragment("DoxyCode");
1261 }
1262}
static bool parseSourcesNeeded
Definition doxygen.h:123
void startCodeFragment(const QCString &style)
Definition outputlist.h:279
const OutputCodeList & codeGenerators() const
Definition outputlist.h:358
QCString getFileFilter(const QCString &name, bool isSourceCode)
Definition util.cpp:1367

References absFilePath(), OutputCodeList::add(), Doxygen::clangAssistedParsing, OutputList::codeGenerators(), Config_getBool, FALSE, fileToString(), DefinitionMixin< FileDef >::getDefFileExtension(), getFileFilter(), DefinitionMixin< FileDef >::getLanguage(), QCString::isEmpty(), Doxygen::parserManager, Doxygen::parseSourcesNeeded, OutputCodeList::startCodeFragment(), and TRUE.

◆ writeSourceFooter()

void FileDefImpl::writeSourceFooter ( OutputList & ol)
overridevirtual

Implements FileDef.

Definition at line 1264 of file filedef.cpp.

1265{
1266 ol.endContents();
1267 endFileWithNavPath(ol,this,false);
1268 ol.enableAll();
1269}

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

1156{
1157 bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
1158 QCString title = m_docname;
1159 if (!m_fileVersion.isEmpty())
1160 {
1161 title+=(" ("+m_fileVersion+")");
1162 }
1163 QCString pageTitle = theTranslator->trSourceFile(title);
1165
1166 bool isDocFile = isDocumentationFile();
1167 bool genSourceFile = !isDocFile && generateSourceFile();
1168 if (getDirDef())
1169 {
1170 startFile(ol,getSourceFileBase(),true,QCString(),pageTitle,HighlightedItem::FileVisible,
1171 !generateTreeView,
1172 !isDocFile && genSourceFile ? QCString() : getOutputFileBase(),
1173 0);
1174 if (!generateTreeView)
1175 {
1177 ol.endQuickIndices();
1178 }
1180 ol.parseText(name());
1182 }
1183 else
1184 {
1185 startFile(ol,getSourceFileBase(),true,QCString(),pageTitle,HighlightedItem::FileVisible,false,
1186 !isDocFile && genSourceFile ? QCString() : getOutputFileBase(),
1187 0);
1189 ol.parseText(title);
1190 endTitle(ol,getSourceFileBase(),QCString());
1191 }
1192
1193 ol.startContents();
1194
1195 if (isLinkable())
1196 {
1197 ol.startTextLink(getOutputFileBase(),QCString());
1199 ol.endTextLink();
1200
1201 ol.pushGeneratorState();
1203 ol.writeString("\\par\n");
1204 ol.popGeneratorState();
1205 }
1206}
bool generateSourceFile() const override
Definition filedef.cpp:1609
bool isLinkable() const override
Definition filedef.cpp:150
virtual QCString trSourceFile(const QCString &filename)=0
virtual QCString trGotoDocumentation()=0

References Config_getBool, OutputList::disable(), OutputList::disableAllBut(), 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(), DefinitionMutable::writeNavigationPath(), and OutputList::writeString().

◆ writeSourceLink()

void FileDefImpl::writeSourceLink ( OutputList & ol)
private

Definition at line 699 of file filedef.cpp.

700{
701 //printf("%s: generateSourceFile()=%d\n",qPrint(name()),generateSourceFile());
702 if (generateSourceFile())
703 {
705 ol.startParagraph();
706 ol.startTextLink(includeName(),QCString());
708 ol.endTextLink();
709 ol.endParagraph();
710 ol.enableAll();
711 }
712}
QCString includeName() const override
Definition filedef.cpp:1738
virtual QCString trGotoSourceCode()=0

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

Referenced by writeDocumentation().

◆ writeSummaryLinks()

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

Reimplemented from DefinitionMixin< FileDef >.

Definition at line 798 of file filedef.cpp.

799{
802 bool first=TRUE;
803 SrcLangExt lang=getLanguage();
804 for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::File))
805 {
806 const LayoutDocEntrySection *ls = dynamic_cast<const LayoutDocEntrySection*>(lde.get());
807 if (lde->kind()==LayoutDocEntry::FileClasses && m_classes.declVisible() && ls)
808 {
809 QCString label = "nested-classes";
810 ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
811 first=FALSE;
812 }
813 else if (lde->kind()==LayoutDocEntry::FileInterfaces && m_interfaces.declVisible() && ls)
814 {
815 QCString label = "interfaces";
816 ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
817 first=FALSE;
818 }
819 else if (lde->kind()==LayoutDocEntry::FileStructs && m_structs.declVisible() && ls)
820 {
821 QCString label = "structs";
822 ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
823 first=FALSE;
824 }
825 else if (lde->kind()==LayoutDocEntry::FileExceptions && m_exceptions.declVisible() && ls)
826 {
827 QCString label = "exceptions";
828 ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
829 first=FALSE;
830 }
831 else if (lde->kind()==LayoutDocEntry::FileNamespaces && m_namespaces.declVisible(false) && ls)
832 {
833 QCString label = "namespaces";
834 ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
835 first=FALSE;
836 }
837 else if (lde->kind()==LayoutDocEntry::FileConcepts && m_concepts.declVisible() && ls)
838 {
839 QCString label = "concepts";
840 ol.writeSummaryLink(QCString(),label,ls->title(lang),first);
841 first=FALSE;
842 }
843 else if (lde->kind()==LayoutDocEntry::MemberDecl)
844 {
845 const LayoutDocEntryMemberDecl *lmd = dynamic_cast<const LayoutDocEntryMemberDecl*>(lde.get());
846 if (lmd)
847 {
848 MemberList * ml = getMemberList(lmd->type);
849 if (ml && ml->declVisible())
850 {
851 ol.writeSummaryLink(QCString(),ml->listType().toLabel(),lmd->title(lang),first);
852 first=FALSE;
853 }
854 }
855 }
856 }
857 if (!first)
858 {
859 ol.writeString(" </div>\n");
860 }
862}
bool declVisible() const
void writeSummaryLink(const QCString &file, const QCString &anchor, const QCString &title, bool first)
Definition outputlist.h:614

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

◆ writeTagFile()

void FileDefImpl::writeTagFile ( TextStream & t)
overridevirtual

Implements FileDef.

Definition at line 374 of file filedef.cpp.

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

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

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

◆ m_docname

QCString FileDefImpl::m_docname
private

Definition at line 248 of file filedef.cpp.

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

◆ m_exceptions

ClassLinkedRefMap FileDefImpl::m_exceptions
private

◆ m_fileName

QCString FileDefImpl::m_fileName
private

Definition at line 247 of file filedef.cpp.

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

◆ m_filePath

QCString FileDefImpl::m_filePath
private

Definition at line 243 of file filedef.cpp.

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

◆ m_fileVersion

QCString FileDefImpl::m_fileVersion
private

◆ m_hasIncludedByGraph

bool FileDefImpl::m_hasIncludedByGraph = Config_getBool(INCLUDED_BY_GRAPH)
private

Definition at line 265 of file filedef.cpp.

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

◆ m_hasIncludeGraph

bool FileDefImpl::m_hasIncludeGraph = Config_getBool(INCLUDE_GRAPH)
private

Definition at line 264 of file filedef.cpp.

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

◆ m_inclByDepFileName

QCString FileDefImpl::m_inclByDepFileName
private

Definition at line 245 of file filedef.cpp.

Referenced by includedByDependencyGraphFileName(), and setDiskNameLocal().

◆ m_inclDepFileName

QCString FileDefImpl::m_inclDepFileName
private

Definition at line 244 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 251 of file filedef.cpp.

Referenced by FileDefImpl(), and isSource().

◆ m_memberGroups

◆ m_memberLists

◆ m_moduleDef

ModuleDef* FileDefImpl::m_moduleDef = nullptr
private

Definition at line 254 of file filedef.cpp.

Referenced by getModuleDef(), and setModuleDef().

◆ m_namespaces

◆ m_outputDiskName

QCString FileDefImpl::m_outputDiskName
private

Definition at line 246 of file filedef.cpp.

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

◆ m_path

QCString FileDefImpl::m_path
private

Definition at line 242 of file filedef.cpp.

Referenced by FileDefImpl(), and getPath().

◆ m_srcDefMap

DefinitionLineMap FileDefImpl::m_srcDefMap
private

Definition at line 249 of file filedef.cpp.

Referenced by addSourceRef(), and getSourceDefinition().

◆ m_srcMemberMap

MemberDefLineMap FileDefImpl::m_srcMemberMap
private

Definition at line 250 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 263 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: