Skip to main content

The FileDef Class Reference

A model of a file symbol. More...

Declaration​

class FileDef { ... }

Included Headers​

#include <src/filedef.h>

Base classes​

classDefinitionMutable
classDefinition

The common base class of all entity definitions found in the sources. More...

Derived Classes​

classDefinitionMixin<Base>

Public Member Functions Index​

QCStringfileName () const =0
QCStringincludeName () const =0
QCStringincludeDependencyGraphFileName () const =0
QCStringincludedByDependencyGraphFileName () const =0
QCStringabsFilePath () const =0
const QCString &docName () const =0
boolisSource () const =0
boolisDocumentationFile () const =0
const Definition *getSourceDefinition (int lineNr) const =0
const MemberDef *getSourceMember (int lineNr) const =0
QCStringgetPath () const =0
QCStringgetVersion () const =0
boolisIncluded (const QCString &name) const =0
DirDef *getDirDef () const =0
ModuleDef *getModuleDef () const =0
const LinkedRefMap< NamespaceDef > &getUsedNamespaces () const =0
const LinkedRefMap< const Definition > &getUsedDefinitions () const =0
const IncludeInfoList &includeFileList () const =0
const IncludeInfoList &includedByFileList () const =0
voidgetAllIncludeFilesRecursively (StringVector &incFiles) const =0
MemberList *getMemberList (MemberListType lt) const =0
const MemberLists &getMemberLists () const =0
const MemberGroupList &getMemberGroups () const =0
const NamespaceLinkedRefMap &getNamespaces () const =0
const ConceptLinkedRefMap &getConcepts () const =0
const ClassLinkedRefMap &getClasses () const =0
QCStringtitle () const =0
boolhasDetailedDescription () const =0
QCStringfileVersion () const =0
boolsubGrouping () const =0
voidcountMembers ()=0
intnumDocMembers () const =0
intnumDecMembers () const =0
voidaddSourceRef (int line, const Definition *d, const MemberDef *md)=0
voidwriteDocumentation (OutputList &ol)=0
voidwriteMemberPages (OutputList &ol)=0
voidwriteTagFile (TextStream &t)=0
voidwriteSourceHeader (OutputList &ol)=0
voidwriteSourceBody (OutputList &ol, ClangTUParser *clangParser)=0
voidwriteSourceFooter (OutputList &ol)=0
voidparseSource (ClangTUParser *clangParser)=0
voidsetDiskName (const QCString &name)=0
voidinsertMember (MemberDef *md)=0
voidinsertClass (ClassDef *cd)=0
voidinsertConcept (ConceptDef *cd)=0
voidinsertNamespace (NamespaceDef *nd)=0
voidremoveMember (MemberDef *md)=0
voidcomputeAnchors ()=0
voidsetDirDef (DirDef *dd)=0
voidsetModuleDef (ModuleDef *mod)=0
voidaddUsingDirective (NamespaceDef *nd)=0
voidaddUsingDeclaration (const Definition *d)=0
voidcombineUsingRelations ()=0
boolgenerateSourceFile () const =0
voidsortMemberLists ()=0
voidaddIncludeDependency (const FileDef *fd, const QCString &incName, IncludeKind kind)=0
voidaddIncludedByDependency (const FileDef *fd, const QCString &incName, IncludeKind kind)=0
voidaddMembersToMemberGroup ()=0
voiddistributeMemberGroupDocumentation ()=0
voidfindSectionsInDocumentation ()=0
voidaddIncludedUsingDirectives (FileDefSet &visitedFiles)=0
voidaddListReferences ()=0
boolhasIncludeGraph () const =0
boolhasIncludedByGraph () const =0
voidoverrideIncludeGraph (bool e)=0
voidoverrideIncludedByGraph (bool e)=0

Description​

A model of a file symbol.

An object of this class contains all file information that is gathered. This includes the members and compounds defined in the file.

The member writeDocumentation() can be used to generate the page of documentation to HTML and LaTeX.

Definition at line 98 of file filedef.h.

Public Member Functions​

absFilePath()​

virtual QCString FileDef::absFilePath ()

Returns the absolute path including the file name.

Definition at line 115 of file filedef.h.

Reference absFilePath.

Referenced by MemberDefImpl::_writeGroupInclude, absFilePath, FileDefImpl::addIncludedByDependency, FileDefImpl::addIncludeDependency, addIncludeFile, addVariableToFile, buildFunctionList, DotInclDepGraph::buildGraph, VhdlDocGen::createFlowChart, DotInclDepGraph::DotInclDepGraph, DocParser::findAndCopyImage, findFile, findFilePath, generateFileSources, generateSqlite3ForClass, generateSqlite3ForFile, generateSqlite3ForMember, generateXMLForClass, generateXMLForMember, haveEqualFileNames, DocbookDocVisitor::operator(), XmlDocVisitor::operator(), DocDiaFile::parse, DocDotFile::parse, DocMscFile::parse, DocPlantUmlFile::parse, CCodeParser::parseCode, readTextFileByName, ModuleManager::resolveImports and writeXMLCodeBlock.

addIncludedByDependency()​

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

Definition at line 195 of file filedef.h.

Reference addIncludedByDependency.

Referenced by addIncludedByDependency and ModuleManager::resolveImports.

addIncludeDependency()​

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

Definition at line 194 of file filedef.h.

Reference addIncludeDependency.

Referenced by addIncludeDependency and ModuleManager::resolveImports.

addIncludedUsingDirectives()​

virtual void FileDef::addIncludedUsingDirectives (FileDefSet & visitedFiles)

Definition at line 200 of file filedef.h.

Reference addIncludedUsingDirectives.

Referenced by addIncludedUsingDirectives.

addListReferences()​

virtual void FileDef::addListReferences ()

Definition at line 202 of file filedef.h.

Reference addListReferences.

Referenced by addListReferences.

addMembersToMemberGroup()​

virtual void FileDef::addMembersToMemberGroup ()

Definition at line 197 of file filedef.h.

Reference addMembersToMemberGroup.

Referenced by addMembersToMemberGroup.

addSourceRef()​

virtual void FileDef::addSourceRef (int line, const Definition * d, const MemberDef * md)

Definition at line 165 of file filedef.h.

Reference addSourceRef.

Referenced by addSourceRef.

addUsingDeclaration()​

virtual void FileDef::addUsingDeclaration (const Definition * d)

Definition at line 188 of file filedef.h.

Reference addUsingDeclaration.

Referenced by addUsingDeclaration, findUsingDeclarations and findUsingDeclImports.

addUsingDirective()​

virtual void FileDef::addUsingDirective (NamespaceDef * nd)

Definition at line 187 of file filedef.h.

Reference addUsingDirective.

Referenced by addUsingDirective and findUsingDirectives.

combineUsingRelations()​

virtual void FileDef::combineUsingRelations ()

Definition at line 189 of file filedef.h.

Reference combineUsingRelations.

Referenced by combineUsingRelations.

computeAnchors()​

virtual void FileDef::computeAnchors ()

Definition at line 182 of file filedef.h.

Reference computeAnchors.

Referenced by computeAnchors.

countMembers()​

virtual void FileDef::countMembers ()

Definition at line 159 of file filedef.h.

Reference countMembers.

Referenced by countMembers.

distributeMemberGroupDocumentation()​

virtual void FileDef::distributeMemberGroupDocumentation ()

Definition at line 198 of file filedef.h.

Reference distributeMemberGroupDocumentation.

Referenced by distributeMemberGroupDocumentation.

docName()​

virtual const QCString & FileDef::docName ()

Returns the name as it is used in the documentation

Definition at line 118 of file filedef.h.

Reference docName.

Referenced by PerlModGenerator::addIncludeInfo, docName, DotInclDepGraph::DotInclDepGraph, generateFileSources, generateSqlite3ForClass and writeIncludeInfo.

fileName()​

virtual QCString FileDef::fileName ()

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

Definition at line 105 of file filedef.h.

Reference fileName.

Referenced by fileName, CCodeParser::parseCode, FortranCodeParser::parseCode, LexCodeParser::parseCode, PythonCodeParser::parseCode, SQLCodeParser::parseCode, VHDLCodeParser::parseCode, XMLCodeParser::parseCode and ModuleManager::resolveImports.

fileVersion()​

virtual QCString FileDef::fileVersion ()

Definition at line 155 of file filedef.h.

Reference fileVersion.

Referenced by fileVersion.

findSectionsInDocumentation()​

virtual void FileDef::findSectionsInDocumentation ()

Definition at line 199 of file filedef.h.

Reference findSectionsInDocumentation.

Referenced by findSectionsInDocumentation.

generateSourceFile()​

virtual bool FileDef::generateSourceFile ()

Definition at line 191 of file filedef.h.

Reference generateSourceFile.

Referenced by addIncludeFile, addSourceReferences, DotInclDepGraph::buildGraph, fileVisibleInIndex, generateFileSources, generateSourceFile, FileDefImpl::writeIncludeFiles and writeSingleFileIndex.

getAllIncludeFilesRecursively()​

virtual void FileDef::getAllIncludeFilesRecursively (StringVector & incFiles)

Definition at line 142 of file filedef.h.

Reference getAllIncludeFilesRecursively.

Referenced by generateFileSources and getAllIncludeFilesRecursively.

getClasses()​

virtual const ClassLinkedRefMap & FileDef::getClasses ()

Definition at line 151 of file filedef.h.

Reference getClasses.

Referenced by generateSqlite3ForFile, generateXMLForFile and getClasses.

getConcepts()​

virtual const ConceptLinkedRefMap & FileDef::getConcepts ()

Definition at line 150 of file filedef.h.

Reference getConcepts.

Referenced by generateSqlite3ForFile, generateXMLForFile and getConcepts.

getDirDef()​

virtual DirDef * FileDef::getDirDef ()

Definition at line 136 of file filedef.h.

Reference getDirDef.

Referenced by getDirDef and writePartialFilePath.

getMemberGroups()​

virtual const MemberGroupList & FileDef::getMemberGroups ()

Definition at line 148 of file filedef.h.

Reference getMemberGroups.

Referenced by PerlModGenerator::generatePerlModForFile, generateSqlite3ForFile, generateXMLForFile and getMemberGroups.

getMemberList()​

virtual MemberList * FileDef::getMemberList (MemberListType lt)

Definition at line 144 of file filedef.h.

Reference getMemberList.

Referenced by generateDEFForFile, PerlModGenerator::generatePerlModForFile and getMemberList.

getMemberLists()​

virtual const MemberLists & FileDef::getMemberLists ()

Definition at line 145 of file filedef.h.

Reference getMemberLists.

Referenced by generateSqlite3ForFile, generateXMLForFile and getMemberLists.

getModuleDef()​

virtual ModuleDef * FileDef::getModuleDef ()

Definition at line 137 of file filedef.h.

Reference getModuleDef.

Referenced by findModuleDef and getModuleDef.

getNamespaces()​

virtual const NamespaceLinkedRefMap & FileDef::getNamespaces ()

Definition at line 149 of file filedef.h.

Reference getNamespaces.

Referenced by generateSqlite3ForFile, generateXMLForFile and getNamespaces.

getPath()​

virtual QCString FileDef::getPath ()

Returns the absolute path of this file.

Definition at line 129 of file filedef.h.

Reference getPath.

Referenced by findFileDef, getPath, ModuleDefImpl::writeFiles and writeSingleFileIndex.

getSourceDefinition()​

virtual const Definition * FileDef::getSourceDefinition (int lineNr)

Definition at line 125 of file filedef.h.

Reference getSourceDefinition.

Referenced by getSourceDefinition.

getSourceMember()​

virtual const MemberDef * FileDef::getSourceMember (int lineNr)

Definition at line 126 of file filedef.h.

Reference getSourceMember.

Referenced by getSourceMember.

getUsedDefinitions()​

virtual const LinkedRefMap< const Definition > & FileDef::getUsedDefinitions ()

Definition at line 139 of file filedef.h.

Reference getUsedDefinitions.

Referenced by getUsedDefinitions and SymbolResolver::Private::isAccessibleFrom.

getUsedNamespaces()​

virtual const LinkedRefMap< NamespaceDef > & FileDef::getUsedNamespaces ()

Definition at line 138 of file filedef.h.

Reference getUsedNamespaces.

Referenced by findGlobalMember, findMember, findScopeFromQualifiedName, findUsingDirectives, generateClassOrGlobalLink, getUsedNamespaces and SymbolResolver::Private::isAccessibleFrom.

getVersion()​

virtual QCString FileDef::getVersion ()

Returns version of this file.

Definition at line 132 of file filedef.h.

Reference getVersion.

Referenced by getVersion.

hasDetailedDescription()​

virtual bool FileDef::hasDetailedDescription ()

Definition at line 154 of file filedef.h.

Reference hasDetailedDescription.

Referenced by hasDetailedDescription.

hasIncludedByGraph()​

virtual bool FileDef::hasIncludedByGraph ()

Definition at line 206 of file filedef.h.

Reference hasIncludedByGraph.

Referenced by hasIncludedByGraph.

hasIncludeGraph()​

virtual bool FileDef::hasIncludeGraph ()

Definition at line 205 of file filedef.h.

Reference hasIncludeGraph.

Referenced by hasIncludeGraph.

includedByDependencyGraphFileName()​

virtual QCString FileDef::includedByDependencyGraphFileName ()

Definition at line 112 of file filedef.h.

Reference includedByDependencyGraphFileName.

Referenced by DotInclDepGraph::DotInclDepGraph and includedByDependencyGraphFileName.

includedByFileList()​

virtual const IncludeInfoList & FileDef::includedByFileList ()

Definition at line 141 of file filedef.h.

Reference includedByFileList.

Referenced by DotInclDepGraph::buildGraph, PerlModGenerator::generatePerlModForFile, generateSqlite3ForFile, generateXMLForFile and includedByFileList.

includeDependencyGraphFileName()​

virtual QCString FileDef::includeDependencyGraphFileName ()

Definition at line 110 of file filedef.h.

Reference includeDependencyGraphFileName.

Referenced by DotInclDepGraph::DotInclDepGraph and includeDependencyGraphFileName.

includeFileList()​

virtual const IncludeInfoList & FileDef::includeFileList ()

Definition at line 140 of file filedef.h.

Reference includeFileList.

Referenced by DotInclDepGraph::buildGraph, PerlModGenerator::generatePerlModForFile, generateSqlite3ForFile, generateXMLForFile, getAllIncludeFilesRecursively and includeFileList.

includeName()​

virtual QCString FileDef::includeName ()

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

Definition at line 108 of file filedef.h.

Reference includeName.

Referenced by includeName, FileDefImpl::writeIncludeFiles and writeSingleFileIndex.

insertClass()​

virtual void FileDef::insertClass (ClassDef * cd)

Definition at line 178 of file filedef.h.

Reference insertClass.

Referenced by addClassToContext, createTagLessInstance, findUsingDeclImports and insertClass.

insertConcept()​

virtual void FileDef::insertConcept (ConceptDef * cd)

Definition at line 179 of file filedef.h.

Reference insertConcept.

Referenced by addConceptToContext and insertConcept.

insertMember()​

virtual void FileDef::insertMember (MemberDef * md)

Definition at line 177 of file filedef.h.

Reference insertMember.

Referenced by addGlobalFunction, addVariableToFile, buildFunctionList, findEnums, findUsingDeclImports, insertMember, NamespaceDefImpl::insertMember and insertMemberAlias.

insertNamespace()​

virtual void FileDef::insertNamespace (NamespaceDef * nd)

Definition at line 180 of file filedef.h.

Reference insertNamespace.

Referenced by buildNamespaceList, findUsingDirectives and insertNamespace.

isDocumentationFile()​

virtual bool FileDef::isDocumentationFile ()

Definition at line 123 of file filedef.h.

Reference isDocumentationFile.

Referenced by fileVisibleInIndex, isDocumentationFile and writeSingleFileIndex.

isIncluded()​

virtual bool FileDef::isIncluded (const QCString & name)

Definition at line 134 of file filedef.h.

References isIncluded and Definition::name.

Referenced by isIncluded.

isSource()​

virtual bool FileDef::isSource ()

Returns TRUE if this file is a source file.

Definition at line 121 of file filedef.h.

Reference isSource.

Referenced by generateFileSources, isSource, parseFilesMultiThreading and parseFilesSingleThreading.

numDecMembers()​

virtual int FileDef::numDecMembers ()

Definition at line 161 of file filedef.h.

Reference numDecMembers.

Referenced by numDecMembers.

numDocMembers()​

virtual int FileDef::numDocMembers ()

Definition at line 160 of file filedef.h.

Reference numDocMembers.

Referenced by numDocMembers.

overrideIncludedByGraph()​

virtual void FileDef::overrideIncludedByGraph (bool e)

Definition at line 209 of file filedef.h.

References createFileDef, overrideIncludedByGraph and toFileDef.

Referenced by buildFileList and overrideIncludedByGraph.

overrideIncludeGraph()​

virtual void FileDef::overrideIncludeGraph (bool e)

Definition at line 208 of file filedef.h.

Reference overrideIncludeGraph.

Referenced by buildFileList and overrideIncludeGraph.

parseSource()​

virtual void FileDef::parseSource (ClangTUParser * clangParser)

Definition at line 174 of file filedef.h.

Reference parseSource.

Referenced by generateFileSources and parseSource.

removeMember()​

virtual void FileDef::removeMember (MemberDef * md)

Definition at line 181 of file filedef.h.

Reference removeMember.

Referenced by findMember and removeMember.

setDirDef()​

virtual void FileDef::setDirDef (DirDef * dd)

Definition at line 184 of file filedef.h.

Reference setDirDef.

Referenced by DirDefImpl::addFile and setDirDef.

setDiskName()​

virtual void FileDef::setDiskName (const QCString & name)

Definition at line 175 of file filedef.h.

References Definition::name and setDiskName.

Referenced by generateDiskNames and setDiskName.

setModuleDef()​

virtual void FileDef::setModuleDef (ModuleDef * mod)

Definition at line 185 of file filedef.h.

Reference setModuleDef.

Referenced by ModuleManager::resolvePartitions and setModuleDef.

sortMemberLists()​

virtual void FileDef::sortMemberLists ()

Definition at line 192 of file filedef.h.

Reference sortMemberLists.

Referenced by sortMemberLists.

subGrouping()​

virtual bool FileDef::subGrouping ()

Definition at line 157 of file filedef.h.

Reference subGrouping.

Referenced by subGrouping.

title()​

virtual QCString FileDef::title ()

Definition at line 153 of file filedef.h.

Reference title.

Referenced by generateSqlite3ForFile and title.

writeDocumentation()​

virtual void FileDef::writeDocumentation (OutputList & ol)

Definition at line 167 of file filedef.h.

Reference writeDocumentation.

Referenced by writeDocumentation.

writeMemberPages()​

virtual void FileDef::writeMemberPages (OutputList & ol)

Definition at line 168 of file filedef.h.

Reference writeMemberPages.

Referenced by writeMemberPages.

writeSourceBody()​

virtual void FileDef::writeSourceBody (OutputList & ol, ClangTUParser * clangParser)

Definition at line 172 of file filedef.h.

Reference writeSourceBody.

Referenced by generateFileSources and writeSourceBody.

writeSourceFooter()​

virtual void FileDef::writeSourceFooter (OutputList & ol)

Definition at line 173 of file filedef.h.

Reference writeSourceFooter.

Referenced by generateFileSources and writeSourceFooter.

writeSourceHeader()​

virtual void FileDef::writeSourceHeader (OutputList & ol)

Definition at line 171 of file filedef.h.

Reference writeSourceHeader.

Referenced by generateFileSources and writeSourceHeader.

writeTagFile()​

virtual void FileDef::writeTagFile (TextStream & t)

Definition at line 169 of file filedef.h.

Reference writeTagFile.

Referenced by writeTagFile.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.