FileDef Class Reference

A model of a file symbol. More...

#include <src/filedef.h>

Inheritance diagram for FileDef:

Collaboration diagram for FileDef:

Public Member Functions
virtual QCString	fileName () const =0
virtual QCString	includeName () const =0
virtual QCString	includeDependencyGraphFileName () const =0
virtual QCString	includedByDependencyGraphFileName () const =0
virtual QCString	absFilePath () const =0
virtual const QCString &	docName () const =0
virtual bool	isSource () const =0
virtual bool	isDocumentationFile () const =0
virtual const Definition *	getSourceDefinition (int lineNr) const =0
virtual const MemberDef *	getSourceMember (int lineNr) const =0
virtual QCString	getPath () const =0
virtual QCString	getVersion () const =0
virtual bool	isIncluded (const QCString &name) const =0
virtual DirDef *	getDirDef () const =0
virtual ModuleDef *	getModuleDef () const =0
virtual const LinkedRefMap< NamespaceDef > &	getUsedNamespaces () const =0
virtual const LinkedRefMap< ClassDef > &	getUsedClasses () const =0
virtual const IncludeInfoList &	includeFileList () const =0
virtual const IncludeInfoList &	includedByFileList () const =0
virtual void	getAllIncludeFilesRecursively (StringVector &incFiles) const =0
virtual MemberList *	getMemberList (MemberListType lt) const =0
virtual const MemberLists &	getMemberLists () const =0
virtual const MemberGroupList &	getMemberGroups () const =0
virtual const NamespaceLinkedRefMap &	getNamespaces () const =0
virtual const ConceptLinkedRefMap &	getConcepts () const =0
virtual const ClassLinkedRefMap &	getClasses () const =0
virtual QCString	title () const =0
virtual bool	hasDetailedDescription () const =0
virtual QCString	fileVersion () const =0
virtual bool	subGrouping () const =0
virtual void	countMembers ()=0
virtual int	numDocMembers () const =0
virtual int	numDecMembers () const =0
virtual void	addSourceRef (int line, const Definition *d, const MemberDef *md)=0
virtual void	writeDocumentation (OutputList &ol)=0
virtual void	writeMemberPages (OutputList &ol)=0
virtual void	writeTagFile (TextStream &t)=0
virtual void	writeSourceHeader (OutputList &ol)=0
virtual void	writeSourceBody (OutputList &ol, ClangTUParser *clangParser)=0
virtual void	writeSourceFooter (OutputList &ol)=0
virtual void	parseSource (ClangTUParser *clangParser)=0
virtual void	setDiskName (const QCString &name)=0
virtual void	insertMember (MemberDef *md)=0
virtual void	insertClass (ClassDef *cd)=0
virtual void	insertConcept (ConceptDef *cd)=0
virtual void	insertNamespace (NamespaceDef *nd)=0
virtual void	computeAnchors ()=0
virtual void	setDirDef (DirDef *dd)=0
virtual void	setModuleDef (ModuleDef *mod)=0
virtual void	addUsingDirective (NamespaceDef *nd)=0
virtual void	addUsingDeclaration (ClassDef *cd)=0
virtual void	combineUsingRelations ()=0
virtual bool	generateSourceFile () const =0
virtual void	sortMemberLists ()=0
virtual void	addIncludeDependency (const FileDef *fd, const QCString &incName, IncludeKind kind)=0
virtual void	addIncludedByDependency (const FileDef *fd, const QCString &incName, IncludeKind kind)=0
virtual void	addMembersToMemberGroup ()=0
virtual void	distributeMemberGroupDocumentation ()=0
virtual void	findSectionsInDocumentation ()=0
virtual void	addIncludedUsingDirectives (FileDefSet &visitedFiles)=0
virtual void	addListReferences ()=0
virtual bool	hasIncludeGraph () const =0
virtual bool	hasIncludedByGraph () const =0
virtual void	overrideIncludeGraph (bool e)=0
virtual void	overrideIncludedByGraph (bool e)=0
Public Member Functions inherited from DefinitionMutable
virtual void	setName (const QCString &name)=0
virtual void	setId (const QCString &name)=0
virtual void	setDefFile (const QCString &df, int defLine, int defColumn)=0
virtual void	setDocumentation (const QCString &d, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)=0
virtual void	setBriefDescription (const QCString &b, const QCString &briefFile, int briefLine)=0
virtual void	setInbodyDocumentation (const QCString &d, const QCString &docFile, int docLine)=0
virtual void	setReference (const QCString &r)=0
virtual void	setBodySegment (int defLine, int bls, int ble)=0
virtual void	setBodyDef (const FileDef *fd)=0
virtual void	setRefItems (const RefItemVector &sli)=0
virtual void	setOuterScope (Definition *d)=0
virtual void	setHidden (bool b)=0
virtual void	setArtificial (bool b)=0
virtual void	setExported (bool b)=0
virtual void	setLanguage (SrcLangExt lang)=0
virtual void	setLocalName (const QCString &name)=0
virtual void	makePartOfGroup (GroupDef *gd)=0
virtual void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0
virtual void	addSourceReferencedBy (MemberDef *d)=0
virtual void	addSourceReferences (MemberDef *d)=0
virtual void	mergeRefItems (Definition *d)=0
virtual void	addInnerCompound (Definition *d)=0
virtual void	addSectionsToIndex ()=0
virtual void	mergeReferences (const Definition *other)=0
virtual void	mergeReferencedBy (const Definition *other)=0
virtual void	computeTooltip ()=0
virtual void	writeSourceDef (OutputList &ol, const QCString &scopeName) const =0
virtual void	writeInlineCode (OutputList &ol, const QCString &scopeName) const =0
virtual bool	hasSourceRefs () const =0
virtual bool	hasSourceReffedBy () const =0
virtual void	writeSourceRefs (OutputList &ol, const QCString &scopeName) const =0
virtual void	writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const =0
virtual void	writeNavigationPath (OutputList &ol) const =0
virtual void	writeQuickMemberLinks (OutputList &, const MemberDef *) const =0
virtual void	writeSummaryLinks (OutputList &) const =0
virtual void	writeDocAnchorsToTagFile (TextStream &) const =0
virtual void	writeToc (OutputList &ol, const LocalToc &lt) const =0
Public Member Functions inherited from Definition
virtual DefType	definitionType () const =0
virtual CodeSymbolType	codeSymbolType () const =0
virtual bool	isAlias () const =0
virtual const QCString &	name () const =0
virtual bool	isAnonymous () const =0
virtual QCString	displayName (bool includeScope=TRUE) const =0
virtual const QCString &	localName () const =0
virtual QCString	qualifiedName () const =0
virtual QCString	symbolName () const =0
virtual QCString	getOutputFileBase () const =0
virtual QCString	anchor () const =0
virtual QCString	getSourceFileBase () const =0
virtual QCString	getSourceAnchor () const =0
virtual QCString	documentation () const =0
virtual int	docLine () const =0
virtual QCString	docFile () const =0
virtual QCString	briefDescription (bool abbreviate=FALSE) const =0
virtual QCString	briefDescriptionAsTooltip () const =0
virtual int	briefLine () const =0
virtual QCString	inbodyDocumentation () const =0
virtual QCString	inbodyFile () const =0
virtual int	inbodyLine () const =0
virtual QCString	briefFile () const =0
virtual QCString	getDefFileName () const =0
virtual QCString	getDefFileExtension () const =0
virtual int	getDefLine () const =0
virtual int	getDefColumn () const =0
virtual bool	hasDocumentation () const =0
virtual bool	hasUserDocumentation () const =0
virtual bool	isLinkableInProject () const =0
virtual bool	isLinkable () const =0
virtual bool	isVisibleInProject () const =0
virtual bool	isVisible () const =0
virtual bool	isHidden () const =0
virtual bool	isArtificial () const =0
virtual bool	isExported () const =0
virtual QCString	getReference () const =0
virtual bool	isReference () const =0
virtual QCString	externalReference (const QCString &relPath) const =0
virtual int	getStartDefLine () const =0
virtual int	getStartBodyLine () const =0
virtual int	getEndBodyLine () const =0
virtual const FileDef *	getBodyDef () const =0
virtual SrcLangExt	getLanguage () const =0
	Returns the programming language this definition was written in.
virtual const GroupList &	partOfGroups () const =0
virtual bool	isLinkableViaGroup () const =0
virtual const RefItemVector &	xrefListItems () const =0
virtual const Definition *	findInnerCompound (const QCString &name) const =0
virtual Definition *	getOuterScope () const =0
virtual const MemberVector &	getReferencesMembers () const =0
virtual const MemberVector &	getReferencedByMembers () const =0
virtual bool	hasSections () const =0
virtual bool	hasSources () const =0
virtual bool	hasBriefDescription () const =0
	returns TRUE if this class has a brief description
virtual QCString	id () const =0
virtual const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef
virtual QCString	navigationPathAsString () const =0
virtual QCString	pathFragment () const =0
virtual void	_setSymbolName (const QCString &name)=0
virtual QCString	_symbolName () const =0

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

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.

Member Function Documentation

absFilePath()

virtual QCString FileDef::absFilePath ( ) const

pure virtual

Returns the absolute path including the file name.

Implemented in FileDefImpl.

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

addIncludedByDependency()

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

pure virtual

Implemented in FileDefImpl.

addIncludeDependency()

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

pure virtual

Implemented in FileDefImpl.

Referenced by ModuleManager::resolveImports().

addIncludedUsingDirectives()

virtual void FileDef::addIncludedUsingDirectives ( FileDefSet & visitedFiles )

pure virtual

Implemented in FileDefImpl.

addListReferences()

virtual void FileDef::addListReferences ( )

pure virtual

Implemented in FileDefImpl.

Referenced by addListReferences().

addMembersToMemberGroup()

virtual void FileDef::addMembersToMemberGroup ( )

pure virtual

Implemented in FileDefImpl.

Referenced by addMembersToMemberGroup().

addSourceRef()

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

pure virtual

Implemented in FileDefImpl.

addUsingDeclaration()

virtual void FileDef::addUsingDeclaration ( ClassDef * cd )

pure virtual

Implemented in FileDefImpl.

Referenced by findUsingDeclarations().

addUsingDirective()

virtual void FileDef::addUsingDirective ( NamespaceDef * nd )

pure virtual

Implemented in FileDefImpl.

Referenced by findUsingDirectives().

combineUsingRelations()

virtual void FileDef::combineUsingRelations ( )

pure virtual

Implemented in FileDefImpl.

Referenced by combineUsingRelations().

computeAnchors()

virtual void FileDef::computeAnchors ( )

pure virtual

Implemented in FileDefImpl.

Referenced by computeMemberReferences().

countMembers()

virtual void FileDef::countMembers ( )

pure virtual

Implemented in FileDefImpl.

Referenced by countMembers().

distributeMemberGroupDocumentation()

virtual void FileDef::distributeMemberGroupDocumentation ( )

pure virtual

Implemented in FileDefImpl.

Referenced by distributeMemberGroupDocumentation().

docName()

virtual const QCString & FileDef::docName ( ) const

pure virtual

Returns the name as it is used in the documentation

Implemented in FileDefImpl.

Referenced by MemberDefImpl::_writeGroupInclude(), PerlModGenerator::addIncludeInfo(), DotInclDepGraph::DotInclDepGraph(), generateFileDocs(), generateFileSources(), generateSqlite3ForClass(), and writeIncludeInfo().

fileName()

virtual QCString FileDef::fileName ( ) const

pure virtual

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

Implemented in FileDefImpl.

Referenced by CCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), and XMLCodeParser::parseCode().

fileVersion()

virtual QCString FileDef::fileVersion ( ) const

pure virtual

Implemented in FileDefImpl.

findSectionsInDocumentation()

virtual void FileDef::findSectionsInDocumentation ( )

pure virtual

Implemented in FileDefImpl.

Referenced by findSectionsInDocumentation().

generateSourceFile()

virtual bool FileDef::generateSourceFile ( ) const

pure virtual

Implemented in FileDefImpl.

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

getAllIncludeFilesRecursively()

virtual void FileDef::getAllIncludeFilesRecursively ( StringVector & incFiles ) const

pure virtual

Implemented in FileDefImpl.

Referenced by generateFileSources().

getClasses()

virtual const ClassLinkedRefMap & FileDef::getClasses ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by generateSqlite3ForFile(), and generateXMLForFile().

getConcepts()

virtual const ConceptLinkedRefMap & FileDef::getConcepts ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by generateSqlite3ForFile(), and generateXMLForFile().

getDirDef()

virtual DirDef * FileDef::getDirDef ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by DefinitionImpl::navigationPathAsString(), and writePartialFilePath().

getMemberGroups()

virtual const MemberGroupList & FileDef::getMemberGroups ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by PerlModGenerator::generatePerlModForFile(), generateSqlite3ForFile(), and generateXMLForFile().

getMemberList()

virtual MemberList * FileDef::getMemberList ( MemberListType lt ) const

pure virtual

Implemented in FileDefImpl.

Referenced by generateDEFForFile(), and PerlModGenerator::generatePerlModForFile().

getMemberLists()

virtual const MemberLists & FileDef::getMemberLists ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by generateSqlite3ForFile(), and generateXMLForFile().

getModuleDef()

virtual ModuleDef * FileDef::getModuleDef ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by findModuleDef().

getNamespaces()

virtual const NamespaceLinkedRefMap & FileDef::getNamespaces ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by generateSqlite3ForFile(), and generateXMLForFile().

getPath()

virtual QCString FileDef::getPath ( ) const

pure virtual

Returns the absolute path of this file.

Implemented in FileDefImpl.

Referenced by findFileDef(), generateDiskNames(), ModuleDefImpl::writeFiles(), and writeSingleFileIndex().

getSourceDefinition()

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

pure virtual

Implemented in FileDefImpl.

getSourceMember()

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

pure virtual

Implemented in FileDefImpl.

getUsedClasses()

virtual const LinkedRefMap< ClassDef > & FileDef::getUsedClasses ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by SymbolResolver::Private::getResolvedTypeRec(), and SymbolResolver::Private::isAccessibleFrom().

getUsedNamespaces()

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

pure virtual

Implemented in FileDefImpl.

Referenced by FileDefImpl::addIncludedUsingDirectives(), findGlobalMember(), findMember(), findScopeFromQualifiedName(), findUsingDirectives(), generateClassOrGlobalLink(), SymbolResolver::Private::getResolvedTypeRec(), and SymbolResolver::Private::isAccessibleFrom().

getVersion()

virtual QCString FileDef::getVersion ( ) const

pure virtual

Returns version of this file.

Implemented in FileDefImpl.

hasDetailedDescription()

virtual bool FileDef::hasDetailedDescription ( ) const

pure virtual

Implemented in FileDefImpl.

hasIncludedByGraph()

virtual bool FileDef::hasIncludedByGraph ( ) const

pure virtual

Implemented in FileDefImpl.

hasIncludeGraph()

virtual bool FileDef::hasIncludeGraph ( ) const

pure virtual

Implemented in FileDefImpl.

includedByDependencyGraphFileName()

virtual QCString FileDef::includedByDependencyGraphFileName ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by DotInclDepGraph::DotInclDepGraph().

includedByFileList()

virtual const IncludeInfoList & FileDef::includedByFileList ( ) const

pure virtual

Implemented in FileDefImpl.

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

includeDependencyGraphFileName()

virtual QCString FileDef::includeDependencyGraphFileName ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by DotInclDepGraph::DotInclDepGraph().

includeFileList()

virtual const IncludeInfoList & FileDef::includeFileList ( ) const

pure virtual

Implemented in FileDefImpl.

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

includeName()

virtual QCString FileDef::includeName ( ) const

pure virtual

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

Implemented in FileDefImpl.

Referenced by ClassDefImpl::setIncludeFile(), ConceptDefImpl::setIncludeFile(), FileDefImpl::writeIncludeFiles(), and writeSingleFileIndex().

insertClass()

virtual void FileDef::insertClass ( ClassDef * cd )

pure virtual

Implemented in FileDefImpl.

Referenced by addClassToContext(), and createTagLessInstance().

insertConcept()

virtual void FileDef::insertConcept ( ConceptDef * cd )

pure virtual

Implemented in FileDefImpl.

Referenced by addConceptToContext().

insertMember()

virtual void FileDef::insertMember ( MemberDef * md )

pure virtual

Implemented in FileDefImpl.

Referenced by addVariableToFile(), findEnums(), and NamespaceDefImpl::insertMember().

insertNamespace()

virtual void FileDef::insertNamespace ( NamespaceDef * nd )

pure virtual

Implemented in FileDefImpl.

Referenced by buildNamespaceList(), and findUsingDirectives().

isDocumentationFile()

virtual bool FileDef::isDocumentationFile ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by fileVisibleInIndex(), and writeSingleFileIndex().

isIncluded()

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

pure virtual

Implemented in FileDefImpl.

isSource()

virtual bool FileDef::isSource ( ) const

pure virtual

Returns TRUE if this file is a source file.

Implemented in FileDefImpl.

Referenced by generateFileSources(), parseFilesMultiThreading(), and parseFilesSingleThreading().

numDecMembers()

virtual int FileDef::numDecMembers ( ) const

pure virtual

Implemented in FileDefImpl.

numDocMembers()

virtual int FileDef::numDocMembers ( ) const

pure virtual

Implemented in FileDefImpl.

overrideIncludedByGraph()

virtual void FileDef::overrideIncludedByGraph ( bool e )

pure virtual

Implemented in FileDefImpl.

Referenced by buildFileList().

overrideIncludeGraph()

virtual void FileDef::overrideIncludeGraph ( bool e )

pure virtual

Implemented in FileDefImpl.

Referenced by buildFileList().

parseSource()

virtual void FileDef::parseSource ( ClangTUParser * clangParser )

pure virtual

Implemented in FileDefImpl.

Referenced by generateFileSources().

setDirDef()

virtual void FileDef::setDirDef ( DirDef * dd )

pure virtual

Implemented in FileDefImpl.

setDiskName()

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

pure virtual

Implemented in FileDefImpl.

Referenced by generateDiskNames().

setModuleDef()

virtual void FileDef::setModuleDef ( ModuleDef * mod )

pure virtual

Implemented in FileDefImpl.

Referenced by ModuleManager::resolvePartitions().

sortMemberLists()

virtual void FileDef::sortMemberLists ( )

pure virtual

Implemented in FileDefImpl.

Referenced by sortMemberLists().

subGrouping()

virtual bool FileDef::subGrouping ( ) const

pure virtual

Implemented in FileDefImpl.

title()

virtual QCString FileDef::title ( ) const

pure virtual

Implemented in FileDefImpl.

Referenced by generateSqlite3ForFile().

writeDocumentation()

virtual void FileDef::writeDocumentation ( OutputList & ol )

pure virtual

Implemented in FileDefImpl.

Referenced by generateFileDocs().

writeMemberPages()

virtual void FileDef::writeMemberPages ( OutputList & ol )

pure virtual

Implemented in FileDefImpl.

writeSourceBody()

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

pure virtual

Implemented in FileDefImpl.

Referenced by generateFileSources().

writeSourceFooter()

virtual void FileDef::writeSourceFooter ( OutputList & ol )

pure virtual

Implemented in FileDefImpl.

Referenced by generateFileSources().

writeSourceHeader()

virtual void FileDef::writeSourceHeader ( OutputList & ol )

pure virtual

Implemented in FileDefImpl.

Referenced by generateFileSources().

writeTagFile()

virtual void FileDef::writeTagFile ( TextStream & t )

pure virtual

Implemented in FileDefImpl.

Referenced by writeTagFile().

---

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

• src/filedef.h