Doxygen
|
A model of a file symbol. More...
#include <src/filedef.h>
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< const Definition > & | getUsedDefinitions () 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 | 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 <) 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 } |
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.
|
pure virtual |
Returns the absolute path including the file name.
Implemented in FileDefImpl.
References absFilePath().
Referenced by 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().
|
pure virtual |
Implemented in FileDefImpl.
References addIncludedByDependency().
Referenced by addIncludedByDependency(), and ModuleManager::resolveImports().
|
pure virtual |
Implemented in FileDefImpl.
References addIncludeDependency().
Referenced by addIncludeDependency(), and ModuleManager::resolveImports().
|
pure virtual |
Implemented in FileDefImpl.
References addIncludedUsingDirectives().
Referenced by addIncludedUsingDirectives().
|
pure virtual |
|
pure virtual |
Implemented in FileDefImpl.
References addMembersToMemberGroup().
Referenced by addMembersToMemberGroup().
|
pure virtual |
|
pure virtual |
Implemented in FileDefImpl.
References addUsingDeclaration().
Referenced by addUsingDeclaration(), findUsingDeclarations(), and findUsingDeclImports().
|
pure virtual |
Implemented in FileDefImpl.
References addUsingDirective().
Referenced by addUsingDirective(), and findUsingDirectives().
|
pure virtual |
Implemented in FileDefImpl.
References combineUsingRelations().
Referenced by combineUsingRelations().
|
pure virtual |
|
pure virtual |
|
pure virtual |
Implemented in FileDefImpl.
References distributeMemberGroupDocumentation().
Referenced by distributeMemberGroupDocumentation().
|
pure virtual |
Returns the name as it is used in the documentation
Implemented in FileDefImpl.
References docName().
Referenced by MemberDefImpl::_writeGroupInclude(), PerlModGenerator::addIncludeInfo(), docName(), DotInclDepGraph::DotInclDepGraph(), generateFileSources(), generateSqlite3ForClass(), and writeIncludeInfo().
|
pure virtual |
Returns the unique file name (this may include part of the path).
Implemented in FileDefImpl.
References fileName().
Referenced by fileName(), CCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), XMLCodeParser::parseCode(), and ModuleManager::resolveImports().
|
pure virtual |
|
pure virtual |
Implemented in FileDefImpl.
References findSectionsInDocumentation().
Referenced by findSectionsInDocumentation().
|
pure virtual |
Implemented in FileDefImpl.
References generateSourceFile().
Referenced by addIncludeFile(), addSourceReferences(), DotInclDepGraph::buildGraph(), fileVisibleInIndex(), generateFileSources(), generateSourceFile(), FileDefImpl::writeIncludeFiles(), and writeSingleFileIndex().
|
pure virtual |
Implemented in FileDefImpl.
References getAllIncludeFilesRecursively().
Referenced by generateFileSources(), and getAllIncludeFilesRecursively().
|
pure virtual |
Implemented in FileDefImpl.
References getClasses().
Referenced by generateSqlite3ForFile(), generateXMLForFile(), and getClasses().
|
pure virtual |
Implemented in FileDefImpl.
References getConcepts().
Referenced by generateSqlite3ForFile(), generateXMLForFile(), and getConcepts().
|
pure virtual |
Implemented in FileDefImpl.
References getDirDef().
Referenced by getDirDef(), and writePartialFilePath().
|
pure virtual |
Implemented in FileDefImpl.
References getMemberGroups().
Referenced by PerlModGenerator::generatePerlModForFile(), generateSqlite3ForFile(), generateXMLForFile(), and getMemberGroups().
|
pure virtual |
Implemented in FileDefImpl.
References getMemberList().
Referenced by generateDEFForFile(), PerlModGenerator::generatePerlModForFile(), and getMemberList().
|
pure virtual |
Implemented in FileDefImpl.
References getMemberLists().
Referenced by generateSqlite3ForFile(), generateXMLForFile(), and getMemberLists().
|
pure virtual |
Implemented in FileDefImpl.
References getModuleDef().
Referenced by findModuleDef(), and getModuleDef().
|
pure virtual |
Implemented in FileDefImpl.
References getNamespaces().
Referenced by generateSqlite3ForFile(), generateXMLForFile(), and getNamespaces().
|
pure virtual |
Returns the absolute path of this file.
Implemented in FileDefImpl.
References getPath().
Referenced by findFileDef(), getPath(), ModuleDefImpl::writeFiles(), and writeSingleFileIndex().
|
pure virtual |
|
pure virtual |
|
pure virtual |
Implemented in FileDefImpl.
References getUsedDefinitions().
Referenced by getUsedDefinitions(), and SymbolResolver::Private::isAccessibleFrom().
|
pure virtual |
Implemented in FileDefImpl.
References getUsedNamespaces().
Referenced by findGlobalMember(), findMember(), findScopeFromQualifiedName(), findUsingDirectives(), generateClassOrGlobalLink(), getUsedNamespaces(), and SymbolResolver::Private::isAccessibleFrom().
|
pure virtual |
Returns version of this file.
Implemented in FileDefImpl.
References getVersion().
Referenced by getVersion().
|
pure virtual |
Implemented in FileDefImpl.
References hasDetailedDescription().
Referenced by hasDetailedDescription().
|
pure virtual |
|
pure virtual |
|
pure virtual |
Implemented in FileDefImpl.
References includedByDependencyGraphFileName().
Referenced by DotInclDepGraph::DotInclDepGraph(), and includedByDependencyGraphFileName().
|
pure virtual |
Implemented in FileDefImpl.
References includedByFileList().
Referenced by DotInclDepGraph::buildGraph(), PerlModGenerator::generatePerlModForFile(), generateSqlite3ForFile(), generateXMLForFile(), and includedByFileList().
|
pure virtual |
Implemented in FileDefImpl.
References includeDependencyGraphFileName().
Referenced by DotInclDepGraph::DotInclDepGraph(), and includeDependencyGraphFileName().
|
pure virtual |
Implemented in FileDefImpl.
References includeFileList().
Referenced by DotInclDepGraph::buildGraph(), PerlModGenerator::generatePerlModForFile(), generateSqlite3ForFile(), generateXMLForFile(), getAllIncludeFilesRecursively(), and includeFileList().
|
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().
|
pure virtual |
Implemented in FileDefImpl.
References insertClass().
Referenced by addClassToContext(), createTagLessInstance(), findUsingDeclImports(), and insertClass().
|
pure virtual |
Implemented in FileDefImpl.
References insertConcept().
Referenced by addConceptToContext(), and insertConcept().
|
pure virtual |
Implemented in FileDefImpl.
References insertMember().
Referenced by addGlobalFunction(), addVariableToFile(), buildFunctionList(), findEnums(), findUsingDeclImports(), insertMember(), NamespaceDefImpl::insertMember(), and insertMemberAlias().
|
pure virtual |
Implemented in FileDefImpl.
References insertNamespace().
Referenced by buildNamespaceList(), findUsingDirectives(), and insertNamespace().
|
pure virtual |
Implemented in FileDefImpl.
References isDocumentationFile().
Referenced by fileVisibleInIndex(), isDocumentationFile(), and writeSingleFileIndex().
|
pure virtual |
Implemented in FileDefImpl.
References isIncluded(), and Definition::name().
Referenced by isIncluded().
|
pure virtual |
Returns TRUE if this file is a source file.
Implemented in FileDefImpl.
References isSource().
Referenced by generateFileSources(), isSource(), parseFilesMultiThreading(), and parseFilesSingleThreading().
|
pure virtual |
|
pure virtual |
|
pure virtual |
Implemented in FileDefImpl.
References createFileDef(), overrideIncludedByGraph(), and toFileDef().
Referenced by buildFileList(), and overrideIncludedByGraph().
|
pure virtual |
Implemented in FileDefImpl.
References overrideIncludeGraph().
Referenced by buildFileList(), and overrideIncludeGraph().
|
pure virtual |
Implemented in FileDefImpl.
References parseSource().
Referenced by generateFileSources(), and parseSource().
|
pure virtual |
Implemented in FileDefImpl.
References removeMember().
Referenced by findMember(), and removeMember().
|
pure virtual |
Implemented in FileDefImpl.
References setDirDef().
Referenced by DirDefImpl::addFile(), and setDirDef().
|
pure virtual |
Implemented in FileDefImpl.
References Definition::name(), and setDiskName().
Referenced by generateDiskNames(), and setDiskName().
|
pure virtual |
Implemented in FileDefImpl.
References setModuleDef().
Referenced by ModuleManager::resolvePartitions(), and setModuleDef().
|
pure virtual |
|
pure virtual |
|
pure virtual |
Implemented in FileDefImpl.
References title().
Referenced by generateSqlite3ForFile(), and title().
|
pure virtual |
|
pure virtual |
|
pure virtual |
Implemented in FileDefImpl.
References writeSourceBody().
Referenced by generateFileSources(), and writeSourceBody().
|
pure virtual |
Implemented in FileDefImpl.
References writeSourceFooter().
Referenced by generateFileSources(), and writeSourceFooter().
|
pure virtual |
Implemented in FileDefImpl.
References writeSourceHeader().
Referenced by generateFileSources(), and writeSourceHeader().
|
pure virtual |