Doxygen
Loading...
Searching...
No Matches
FileDef Class Referenceabstract

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 QCStringdocName () const =0
 
virtual bool isSource () const =0
 
virtual bool isDocumentationFile () const =0
 
virtual const DefinitiongetSourceDefinition (int lineNr) const =0
 
virtual const MemberDefgetSourceMember (int lineNr) const =0
 
virtual QCString getPath () const =0
 
virtual QCString getVersion () const =0
 
virtual bool isIncluded (const QCString &name) const =0
 
virtual DirDefgetDirDef () const =0
 
virtual ModuleDefgetModuleDef () const =0
 
virtual const LinkedRefMap< NamespaceDef > & getUsedNamespaces () const =0
 
virtual const LinkedRefMap< const Definition > & getUsedDefinitions () const =0
 
virtual const IncludeInfoListincludeFileList () const =0
 
virtual const IncludeInfoListincludedByFileList () const =0
 
virtual void getAllIncludeFilesRecursively (StringVector &incFiles) const =0
 
virtual MemberListgetMemberList (MemberListType lt) const =0
 
virtual const MemberListsgetMemberLists () const =0
 
virtual const MemberGroupListgetMemberGroups () const =0
 
virtual const NamespaceLinkedRefMapgetNamespaces () const =0
 
virtual const ConceptLinkedRefMapgetConcepts () const =0
 
virtual const ClassLinkedRefMapgetClasses () 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 removeMember (MemberDef *md)=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 (const Definition *d)=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, const QCString &sourceRefName)=0
 
virtual void addSourceReferences (MemberDef *d, const QCString &sourceRefName)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addInnerCompound (Definition *d)=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 =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 QCStringname () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString displayName (bool includeScope=TRUE) const =0
 
virtual const QCStringlocalName () 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 FileDefgetBodyDef () const =0
 
virtual SrcLangExt getLanguage () const =0
 Returns the programming language this definition was written in.
 
virtual const GroupListpartOfGroups () const =0
 
virtual bool isLinkableViaGroup () const =0
 
virtual const RefItemVectorxrefListItems () const =0
 
virtual const DefinitionfindInnerCompound (const QCString &name) const =0
 
virtual DefinitiongetOuterScope () const =0
 
virtual const MemberVectorgetReferencesMembers () const =0
 
virtual const MemberVectorgetReferencedByMembers () 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 SectionRefsgetSectionRefs () 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()

◆ addIncludedByDependency()

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

◆ addIncludeDependency()

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

◆ addIncludedUsingDirectives()

virtual void FileDef::addIncludedUsingDirectives ( FileDefSet & visitedFiles)
pure virtual

Implemented in FileDefImpl.

References addIncludedUsingDirectives().

Referenced by addIncludedUsingDirectives().

◆ addListReferences()

virtual void FileDef::addListReferences ( )
pure virtual

Implemented in FileDefImpl.

References addListReferences().

Referenced by addListReferences().

◆ addMembersToMemberGroup()

virtual void FileDef::addMembersToMemberGroup ( )
pure virtual

Implemented in FileDefImpl.

References addMembersToMemberGroup().

Referenced by addMembersToMemberGroup().

◆ addSourceRef()

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

Implemented in FileDefImpl.

References addSourceRef().

Referenced by addSourceRef().

◆ addUsingDeclaration()

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

◆ addUsingDirective()

virtual void FileDef::addUsingDirective ( NamespaceDef * nd)
pure virtual

Implemented in FileDefImpl.

References addUsingDirective().

Referenced by addUsingDirective(), and findUsingDirectives().

◆ combineUsingRelations()

virtual void FileDef::combineUsingRelations ( )
pure virtual

Implemented in FileDefImpl.

References combineUsingRelations().

Referenced by combineUsingRelations().

◆ computeAnchors()

virtual void FileDef::computeAnchors ( )
pure virtual

Implemented in FileDefImpl.

References computeAnchors().

Referenced by computeAnchors().

◆ countMembers()

virtual void FileDef::countMembers ( )
pure virtual

Implemented in FileDefImpl.

References countMembers().

Referenced by countMembers().

◆ distributeMemberGroupDocumentation()

virtual void FileDef::distributeMemberGroupDocumentation ( )
pure virtual

◆ docName()

virtual const QCString & FileDef::docName ( ) const
pure virtual

◆ fileName()

virtual QCString FileDef::fileName ( ) const
pure virtual

◆ fileVersion()

virtual QCString FileDef::fileVersion ( ) const
pure virtual

Implemented in FileDefImpl.

References fileVersion().

Referenced by fileVersion().

◆ findSectionsInDocumentation()

virtual void FileDef::findSectionsInDocumentation ( )
pure virtual

Implemented in FileDefImpl.

References findSectionsInDocumentation().

Referenced by findSectionsInDocumentation().

◆ generateSourceFile()

◆ getAllIncludeFilesRecursively()

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

◆ getClasses()

virtual const ClassLinkedRefMap & FileDef::getClasses ( ) const
pure virtual

Implemented in FileDefImpl.

References getClasses().

Referenced by generateSqlite3ForFile(), generateXMLForFile(), and getClasses().

◆ getConcepts()

virtual const ConceptLinkedRefMap & FileDef::getConcepts ( ) const
pure virtual

Implemented in FileDefImpl.

References getConcepts().

Referenced by generateSqlite3ForFile(), generateXMLForFile(), and getConcepts().

◆ getDirDef()

virtual DirDef * FileDef::getDirDef ( ) const
pure virtual

Implemented in FileDefImpl.

References getDirDef().

Referenced by getDirDef(), and writePartialFilePath().

◆ getMemberGroups()

virtual const MemberGroupList & FileDef::getMemberGroups ( ) const
pure virtual

◆ getMemberList()

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

◆ getMemberLists()

virtual const MemberLists & FileDef::getMemberLists ( ) const
pure virtual

◆ getModuleDef()

virtual ModuleDef * FileDef::getModuleDef ( ) const
pure virtual

Implemented in FileDefImpl.

References getModuleDef().

Referenced by findModuleDef(), and getModuleDef().

◆ getNamespaces()

virtual const NamespaceLinkedRefMap & FileDef::getNamespaces ( ) const
pure virtual

◆ getPath()

virtual QCString FileDef::getPath ( ) const
pure virtual

Returns the absolute path of this file.

Implemented in FileDefImpl.

References getPath().

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

◆ getSourceDefinition()

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

Implemented in FileDefImpl.

References getSourceDefinition().

Referenced by getSourceDefinition().

◆ getSourceMember()

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

Implemented in FileDefImpl.

References getSourceMember().

Referenced by getSourceMember().

◆ getUsedDefinitions()

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

◆ getUsedNamespaces()

◆ getVersion()

virtual QCString FileDef::getVersion ( ) const
pure virtual

Returns version of this file.

Implemented in FileDefImpl.

References getVersion().

Referenced by getVersion().

◆ hasDetailedDescription()

virtual bool FileDef::hasDetailedDescription ( ) const
pure virtual

Implemented in FileDefImpl.

References hasDetailedDescription().

Referenced by hasDetailedDescription().

◆ hasIncludedByGraph()

virtual bool FileDef::hasIncludedByGraph ( ) const
pure virtual

Implemented in FileDefImpl.

References hasIncludedByGraph().

Referenced by hasIncludedByGraph().

◆ hasIncludeGraph()

virtual bool FileDef::hasIncludeGraph ( ) const
pure virtual

Implemented in FileDefImpl.

References hasIncludeGraph().

Referenced by hasIncludeGraph().

◆ includedByDependencyGraphFileName()

virtual QCString FileDef::includedByDependencyGraphFileName ( ) const
pure virtual

◆ includedByFileList()

virtual const IncludeInfoList & FileDef::includedByFileList ( ) const
pure virtual

◆ includeDependencyGraphFileName()

virtual QCString FileDef::includeDependencyGraphFileName ( ) const
pure virtual

◆ includeFileList()

◆ includeName()

virtual QCString FileDef::includeName ( ) const
pure virtual

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

Implemented in FileDefImpl.

References includeName().

Referenced by includeName(), FileDefImpl::writeIncludeFiles(), and writeSingleFileIndex().

◆ insertClass()

virtual void FileDef::insertClass ( ClassDef * cd)
pure virtual

◆ insertConcept()

virtual void FileDef::insertConcept ( ConceptDef * cd)
pure virtual

Implemented in FileDefImpl.

References insertConcept().

Referenced by addConceptToContext(), and insertConcept().

◆ insertMember()

◆ insertNamespace()

virtual void FileDef::insertNamespace ( NamespaceDef * nd)
pure virtual

◆ isDocumentationFile()

virtual bool FileDef::isDocumentationFile ( ) const
pure virtual

◆ isIncluded()

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

Implemented in FileDefImpl.

References isIncluded(), and Definition::name().

Referenced by isIncluded().

◆ isSource()

virtual bool FileDef::isSource ( ) const
pure virtual

Returns TRUE if this file is a source file.

Implemented in FileDefImpl.

References isSource().

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

◆ numDecMembers()

virtual int FileDef::numDecMembers ( ) const
pure virtual

Implemented in FileDefImpl.

References numDecMembers().

Referenced by numDecMembers().

◆ numDocMembers()

virtual int FileDef::numDocMembers ( ) const
pure virtual

Implemented in FileDefImpl.

References numDocMembers().

Referenced by numDocMembers().

◆ overrideIncludedByGraph()

virtual void FileDef::overrideIncludedByGraph ( bool e)
pure virtual

◆ overrideIncludeGraph()

virtual void FileDef::overrideIncludeGraph ( bool e)
pure virtual

Implemented in FileDefImpl.

References overrideIncludeGraph().

Referenced by buildFileList(), and overrideIncludeGraph().

◆ parseSource()

virtual void FileDef::parseSource ( ClangTUParser * clangParser)
pure virtual

Implemented in FileDefImpl.

References parseSource().

Referenced by generateFileSources(), and parseSource().

◆ removeMember()

virtual void FileDef::removeMember ( MemberDef * md)
pure virtual

Implemented in FileDefImpl.

References removeMember().

Referenced by findMember(), and removeMember().

◆ setDirDef()

virtual void FileDef::setDirDef ( DirDef * dd)
pure virtual

Implemented in FileDefImpl.

References setDirDef().

Referenced by DirDefImpl::addFile(), and setDirDef().

◆ setDiskName()

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

Implemented in FileDefImpl.

References Definition::name(), and setDiskName().

Referenced by generateDiskNames(), and setDiskName().

◆ setModuleDef()

virtual void FileDef::setModuleDef ( ModuleDef * mod)
pure virtual

Implemented in FileDefImpl.

References setModuleDef().

Referenced by ModuleManager::resolvePartitions(), and setModuleDef().

◆ sortMemberLists()

virtual void FileDef::sortMemberLists ( )
pure virtual

Implemented in FileDefImpl.

References sortMemberLists().

Referenced by sortMemberLists().

◆ subGrouping()

virtual bool FileDef::subGrouping ( ) const
pure virtual

Implemented in FileDefImpl.

References subGrouping().

Referenced by subGrouping().

◆ title()

virtual QCString FileDef::title ( ) const
pure virtual

Implemented in FileDefImpl.

References title().

Referenced by generateSqlite3ForFile(), and title().

◆ writeDocumentation()

virtual void FileDef::writeDocumentation ( OutputList & ol)
pure virtual

Implemented in FileDefImpl.

References writeDocumentation().

Referenced by writeDocumentation().

◆ writeMemberPages()

virtual void FileDef::writeMemberPages ( OutputList & ol)
pure virtual

Implemented in FileDefImpl.

References writeMemberPages().

Referenced by writeMemberPages().

◆ writeSourceBody()

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

Implemented in FileDefImpl.

References writeSourceBody().

Referenced by generateFileSources(), and writeSourceBody().

◆ writeSourceFooter()

virtual void FileDef::writeSourceFooter ( OutputList & ol)
pure virtual

Implemented in FileDefImpl.

References writeSourceFooter().

Referenced by generateFileSources(), and writeSourceFooter().

◆ writeSourceHeader()

virtual void FileDef::writeSourceHeader ( OutputList & ol)
pure virtual

Implemented in FileDefImpl.

References writeSourceHeader().

Referenced by generateFileSources(), and writeSourceHeader().

◆ writeTagFile()

virtual void FileDef::writeTagFile ( TextStream & t)
pure virtual

Implemented in FileDefImpl.

References writeTagFile().

Referenced by writeTagFile().


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