Doxygen
FileDef类 参考abstract

A model of a file symbol. 更多...

#include <filedef.h>

+ 类 FileDef 继承关系图:
+ FileDef 的协作图:

Public 成员函数

 ~FileDef ()
 
virtual DefType definitionType () const =0
 
virtual QCString name () const =0
 
virtual QCString displayName (bool=TRUE) const =0
 
virtual QCString fileName () const =0
 
virtual QCString getOutputFileBase () const =0
 
virtual QCString anchor () const =0
 
virtual QCString getSourceFileBase () 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 isLinkableInProject () const =0
 
virtual bool isLinkable () const =0
 
virtual bool isIncluded (const QCString &name) const =0
 
virtual PackageDef * packageDef () const =0
 
virtual DirDefgetDirDef () const =0
 
virtual LinkedRefMap< const NamespaceDefgetUsedNamespaces () const =0
 
virtual LinkedRefMap< const ClassDefgetUsedClasses () 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 writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const =0
 
virtual void writeSummaryLinks (OutputList &ol) const =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 (const ClassDef *cd)=0
 
virtual void insertConcept (const ConceptDef *cd)=0
 
virtual void insertNamespace (const NamespaceDef *nd)=0
 
virtual void computeAnchors ()=0
 
virtual void setPackageDef (PackageDef *pd)=0
 
virtual void setDirDef (DirDef *dd)=0
 
virtual void addUsingDirective (const NamespaceDef *nd)=0
 
virtual void addUsingDeclaration (const 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, bool local, bool imported)=0
 
virtual void addIncludedByDependency (const FileDef *fd, const QCString &incName, bool local, bool imported)=0
 
virtual void addMembersToMemberGroup ()=0
 
virtual void distributeMemberGroupDocumentation ()=0
 
virtual void findSectionsInDocumentation ()=0
 
virtual void addIncludedUsingDirectives (FileDefSet &visitedFiles)=0
 
virtual void addListReferences ()=0
 
- Public 成员函数 继承自 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 setLanguage (SrcLangExt lang)=0
 
virtual void setLocalName (const QCString &name)=0
 
virtual void makePartOfGroup (const GroupDef *gd)=0
 
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)=0
 
virtual void addSourceReferencedBy (const MemberDef *d)=0
 
virtual void addSourceReferences (const MemberDef *d)=0
 
virtual void mergeRefItems (Definition *d)=0
 
virtual void addInnerCompound (const 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 writeDocAnchorsToTagFile (TextStream &) const =0
 
virtual void writeToc (OutputList &ol, const LocalToc &lt) const =0
 
virtual ~DefinitionMutable ()=default
 
- Public 成员函数 继承自 Definition
virtual CodeSymbolType codeSymbolType () const =0
 
virtual bool isAlias () const =0
 
virtual bool isAnonymous () const =0
 
virtual QCString localName () const =0
 
virtual QCString qualifiedName () const =0
 
virtual QCString symbolName () 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 isVisibleInProject () const =0
 
virtual bool isVisible () const =0
 
virtual bool isHidden () const =0
 
virtual bool isArtificial () 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
 
virtual ~Definition ()=default
 

额外继承的成员函数

- Public 类型 继承自 Definition
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeConcept = 8
}
 

详细描述

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.

在文件 filedef.h73 行定义.

构造及析构函数说明

◆ ~FileDef()

FileDef::~FileDef ( )
inline

在文件 filedef.h76 行定义.

76 {}

成员函数说明

◆ absFilePath()

◆ addIncludedByDependency()

virtual void FileDef::addIncludedByDependency ( const FileDef fd,
const QCString incName,
bool  local,
bool  imported 
)
pure virtual

FileDefImpl 内被实现.

◆ addIncludeDependency()

virtual void FileDef::addIncludeDependency ( const FileDef fd,
const QCString incName,
bool  local,
bool  imported 
)
pure virtual

FileDefImpl 内被实现.

◆ addIncludedUsingDirectives()

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

FileDefImpl 内被实现.

◆ addListReferences()

virtual void FileDef::addListReferences ( )
pure virtual

FileDefImpl 内被实现.

被这些函数引用 addListReferences().

◆ addMembersToMemberGroup()

virtual void FileDef::addMembersToMemberGroup ( )
pure virtual

FileDefImpl 内被实现.

被这些函数引用 addMembersToMemberGroup().

◆ addSourceRef()

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

FileDefImpl 内被实现.

◆ addUsingDeclaration()

virtual void FileDef::addUsingDeclaration ( const ClassDef cd)
pure virtual

FileDefImpl 内被实现.

被这些函数引用 findUsingDeclarations().

◆ addUsingDirective()

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

FileDefImpl 内被实现.

被这些函数引用 findUsingDirectives().

◆ anchor()

virtual QCString FileDef::anchor ( ) const
pure virtual

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

实现了 Definition.

FileDefImpl 内被实现.

被这些函数引用 MemberDefImpl::_writeGroupInclude() , 以及 addToIndices().

◆ combineUsingRelations()

virtual void FileDef::combineUsingRelations ( )
pure virtual

FileDefImpl 内被实现.

被这些函数引用 combineUsingRelations().

◆ computeAnchors()

virtual void FileDef::computeAnchors ( )
pure virtual

FileDefImpl 内被实现.

被这些函数引用 computeMemberReferences().

◆ countMembers()

virtual void FileDef::countMembers ( )
pure virtual

FileDefImpl 内被实现.

被这些函数引用 countMembers().

◆ definitionType()

virtual DefType FileDef::definitionType ( ) const
pure virtual

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

实现了 Definition.

FileDefImpl 内被实现.

◆ displayName()

virtual QCString FileDef::displayName ( bool  includeScope = TRUE) const
pure virtual

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

实现了 Definition.

FileDefImpl 内被实现.

被这些函数引用 MemberDefImpl::writeDocumentation().

◆ distributeMemberGroupDocumentation()

virtual void FileDef::distributeMemberGroupDocumentation ( )
pure virtual

FileDefImpl 内被实现.

被这些函数引用 distributeMemberGroupDocumentation().

◆ docName()

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

Returns the name as it is used in the documentation

FileDefImpl 内被实现.

被这些函数引用 MemberDefImpl::_writeGroupInclude(), PerlModGenerator::addIncludeInfo(), DotInclDepGraph::DotInclDepGraph(), generateFileDocs(), generateFileSources() , 以及 writeIncludeInfo().

◆ fileName()

virtual QCString FileDef::fileName ( ) const
pure virtual

FileDefImpl 内被实现.

◆ fileVersion()

virtual QCString FileDef::fileVersion ( ) const
pure virtual

FileDefImpl 内被实现.

被这些函数引用 FileContext::Private::version().

◆ findSectionsInDocumentation()

virtual void FileDef::findSectionsInDocumentation ( )
pure virtual

FileDefImpl 内被实现.

被这些函数引用 findSectionsInDocumentation().

◆ generateSourceFile()

◆ getAllIncludeFilesRecursively()

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

FileDefImpl 内被实现.

被这些函数引用 generateFileSources().

◆ getClasses()

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

◆ getConcepts()

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

FileDefImpl 内被实现.

◆ getDirDef()

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

FileDefImpl 内被实现.

被这些函数引用 DefinitionImpl::navigationPathAsString() , 以及 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

FileDefImpl 内被实现.

被这些函数引用 generateXMLForFile().

◆ getNamespaces()

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

◆ getOutputFileBase()

◆ getPath()

virtual QCString FileDef::getPath ( ) const
pure virtual

Returns the absolute path of this file.

FileDefImpl 内被实现.

被这些函数引用 findFileDef(), generateDiskNames() , 以及 writeSingleFileIndex().

◆ getSourceDefinition()

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

FileDefImpl 内被实现.

◆ getSourceFileBase()

virtual QCString FileDef::getSourceFileBase ( ) const
pure virtual

Returns the name of the source listing of this definition.

实现了 Definition.

FileDefImpl 内被实现.

被这些函数引用 DefinitionImpl::_writeSourceRefList(), DotInclDepGraph::buildGraph(), FTVHelp::generateTree(), DefinitionImpl::getSourceFileBase(), node2URL() , 以及 writeSingleFileIndex().

◆ getSourceMember()

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

FileDefImpl 内被实现.

◆ getUsedClasses()

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

FileDefImpl 内被实现.

被这些函数引用 SymbolResolver::Private::getResolvedClassRec().

◆ getUsedNamespaces()

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

◆ getVersion()

virtual QCString FileDef::getVersion ( ) const
pure virtual

Returns version of this file.

FileDefImpl 内被实现.

被这些函数引用 FileContext::Private::versionInfo().

◆ hasDetailedDescription()

virtual bool FileDef::hasDetailedDescription ( ) const
pure virtual

FileDefImpl 内被实现.

被这些函数引用 FileContext::Private::hasDetails().

◆ includedByDependencyGraphFileName()

virtual QCString FileDef::includedByDependencyGraphFileName ( ) const
pure virtual

FileDefImpl 内被实现.

被这些函数引用 DotInclDepGraph::DotInclDepGraph().

◆ includedByFileList()

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

◆ includeDependencyGraphFileName()

virtual QCString FileDef::includeDependencyGraphFileName ( ) const
pure virtual

FileDefImpl 内被实现.

被这些函数引用 DotInclDepGraph::DotInclDepGraph().

◆ includeFileList()

◆ includeName()

virtual QCString FileDef::includeName ( ) const
pure virtual

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

FileDefImpl 内被实现.

被这些函数引用 FileDefImpl::writeIncludeFiles() , 以及 writeSingleFileIndex().

◆ insertClass()

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

FileDefImpl 内被实现.

被这些函数引用 addClassToContext() , 以及 createTagLessInstance().

◆ insertConcept()

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

FileDefImpl 内被实现.

被这些函数引用 addConceptToContext().

◆ insertMember()

virtual void FileDef::insertMember ( MemberDef md)
pure virtual

FileDefImpl 内被实现.

被这些函数引用 addVariableToFile(), findEnums() , 以及 NamespaceDefImpl::insertMember().

◆ insertNamespace()

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

FileDefImpl 内被实现.

被这些函数引用 buildNamespaceList() , 以及 findUsingDirectives().

◆ isDocumentationFile()

virtual bool FileDef::isDocumentationFile ( ) const
pure virtual

FileDefImpl 内被实现.

被这些函数引用 fileVisibleInIndex() , 以及 writeSingleFileIndex().

◆ isIncluded()

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

FileDefImpl 内被实现.

◆ isLinkable()

virtual bool FileDef::isLinkable ( ) const
pure virtual

Returns TRUE iff it is possible to link to this item. This can be a link to another project imported via a tag file.

实现了 Definition.

FileDefImpl 内被实现.

被这些函数引用 MemberDefImpl::_writeGroupInclude(), addMemberToSearchIndex(), DotInclDepGraph::buildGraph(), fileVisibleInIndex(), findMembersWithSpecificName(), generateFileRef(), getDefs(), resolveLink(), FileDefImpl::writeIncludeFiles(), writePartialFilePath() , 以及 FileDefImpl::writeTagFile().

◆ isLinkableInProject()

virtual bool FileDef::isLinkableInProject ( ) const
pure virtual

◆ isSource()

virtual bool FileDef::isSource ( ) const
pure virtual

Returns TRUE if this file is a source file.

FileDefImpl 内被实现.

被这些函数引用 generateFileSources(), parseFilesMultiThreading() , 以及 parseFilesSingleThreading().

◆ name()

◆ numDecMembers()

virtual int FileDef::numDecMembers ( ) const
pure virtual

FileDefImpl 内被实现.

◆ numDocMembers()

virtual int FileDef::numDocMembers ( ) const
pure virtual

FileDefImpl 内被实现.

◆ packageDef()

virtual PackageDef* FileDef::packageDef ( ) const
pure virtual

FileDefImpl 内被实现.

◆ parseSource()

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

FileDefImpl 内被实现.

被这些函数引用 generateFileSources().

◆ setDirDef()

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

FileDefImpl 内被实现.

◆ setDiskName()

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

FileDefImpl 内被实现.

被这些函数引用 generateDiskNames().

◆ setPackageDef()

virtual void FileDef::setPackageDef ( PackageDef *  pd)
pure virtual

FileDefImpl 内被实现.

◆ sortMemberLists()

virtual void FileDef::sortMemberLists ( )
pure virtual

FileDefImpl 内被实现.

被这些函数引用 sortMemberLists().

◆ subGrouping()

virtual bool FileDef::subGrouping ( ) const
pure virtual

FileDefImpl 内被实现.

被这些函数引用 FileContext::Private::createMemberGroups().

◆ title()

virtual QCString FileDef::title ( ) const
pure virtual

FileDefImpl 内被实现.

被这些函数引用 FileContext::Private::title().

◆ writeDocumentation()

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

FileDefImpl 内被实现.

被这些函数引用 generateFileDocs().

◆ writeMemberPages()

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

FileDefImpl 内被实现.

◆ writeQuickMemberLinks()

virtual void FileDef::writeQuickMemberLinks ( OutputList ol,
const MemberDef currentMd 
) const
pure virtual

实现了 DefinitionMutable.

DefinitionMixin< FileDef > , 以及 FileDefImpl 内被实现.

◆ writeSourceBody()

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

FileDefImpl 内被实现.

被这些函数引用 generateFileSources().

◆ writeSourceFooter()

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

FileDefImpl 内被实现.

被这些函数引用 generateFileSources().

◆ writeSourceHeader()

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

FileDefImpl 内被实现.

被这些函数引用 generateFileSources().

◆ writeSummaryLinks()

virtual void FileDef::writeSummaryLinks ( OutputList ol) const
pure virtual

实现了 DefinitionMutable.

DefinitionMixin< FileDef > , 以及 FileDefImpl 内被实现.

◆ writeTagFile()

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

FileDefImpl 内被实现.

被这些函数引用 writeTagFile().


该类的文档由以下文件生成: