Public Member Functions | List of all members
FileDefImpl Class Reference
Inheritance diagram for FileDefImpl:
Inheritance graph
Collaboration diagram for FileDefImpl:
Collaboration graph

Public Member Functions

 FileDefImpl (const QCString &p, const QCString &n, const QCString &ref=QCString(), const QCString &dn=QCString())
virtual ~FileDefImpl ()
virtual DefType definitionType () const
virtual CodeSymbolType codeSymbolType () const
virtual QCString name () const
virtual QCString displayName (bool=TRUE) const
virtual QCString fileName () const
virtual QCString getOutputFileBase () const
virtual QCString anchor () const
virtual QCString getSourceFileBase () const
virtual QCString includeName () const
virtual QCString includeDependencyGraphFileName () const
virtual QCString includedByDependencyGraphFileName () const
virtual QCString absFilePath () const
virtual const QCStringdocName () const
virtual bool isSource () const
virtual bool isDocumentationFile () const
virtual const DefinitiongetSourceDefinition (int lineNr) const
virtual const MemberDefgetSourceMember (int lineNr) const
virtual QCString getPath () const
virtual QCString getVersion () const
virtual bool isLinkableInProject () const
virtual bool isLinkable () const
virtual bool isIncluded (const QCString &name) const
virtual PackageDef * packageDef () const
virtual DirDefgetDirDef () const
virtual LinkedRefMap< const NamespaceDefgetUsedNamespaces () const
virtual LinkedRefMap< const ClassDefgetUsedClasses () const
virtual const IncludeInfoListincludeFileList () const
virtual const IncludeInfoListincludedByFileList () const
virtual void getAllIncludeFilesRecursively (StringVector &incFiles) const
virtual MemberListgetMemberList (MemberListType lt) const
virtual const MemberListsgetMemberLists () const
virtual const MemberGroupListgetMemberGroups () const
virtual const NamespaceLinkedRefMapgetNamespaces () const
virtual const ConceptLinkedRefMapgetConcepts () const
virtual const ClassLinkedRefMapgetClasses () const
virtual QCString title () const
virtual bool hasDetailedDescription () const
virtual QCString fileVersion () const
virtual bool subGrouping () const
virtual void countMembers ()
virtual int numDocMembers () const
virtual int numDecMembers () const
virtual void addSourceRef (int line, const Definition *d, const MemberDef *md)
virtual void writeDocumentation (OutputList &ol)
virtual void writeMemberPages (OutputList &ol)
virtual void writeQuickMemberLinks (OutputList &ol, const MemberDef *currentMd) const
virtual void writeSummaryLinks (OutputList &ol) const
virtual void writeTagFile (TextStream &t)
virtual void writeSourceHeader (OutputList &ol)
virtual void writeSourceBody (OutputList &ol, ClangTUParser *clangParser)
virtual void writeSourceFooter (OutputList &ol)
virtual void parseSource (ClangTUParser *clangParser)
virtual void setDiskName (const QCString &name)
virtual void insertMember (MemberDef *md)
virtual void insertClass (const ClassDef *cd)
virtual void insertConcept (const ConceptDef *cd)
virtual void insertNamespace (const NamespaceDef *nd)
virtual void computeAnchors ()
virtual void setPackageDef (PackageDef *pd)
virtual void setDirDef (DirDef *dd)
virtual void addUsingDirective (const NamespaceDef *nd)
virtual void addUsingDeclaration (const ClassDef *cd)
virtual void combineUsingRelations ()
virtual bool generateSourceFile () const
virtual void sortMemberLists ()
virtual void addIncludeDependency (const FileDef *fd, const QCString &incName, bool local, bool imported)
virtual void addIncludedByDependency (const FileDef *fd, const QCString &incName, bool local, bool imported)
virtual void addMembersToMemberGroup ()
virtual void distributeMemberGroupDocumentation ()
virtual void findSectionsInDocumentation ()
virtual void addIncludedUsingDirectives (FileDefSet &visitedFiles)
virtual void addListReferences ()
- Public Member Functions inherited from DefinitionMixin< FileDef >
 DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char *b=0, const char *d=0, bool isSymbol=TRUE)
virtual bool isAlias () const
virtual bool isAnonymous () const
virtual QCString localName () const
virtual QCString qualifiedName () const
virtual QCString symbolName () const
virtual QCString getSourceAnchor () const
virtual QCString documentation () const
virtual int docLine () const
virtual QCString docFile () const
virtual QCString briefDescription (bool abbreviate=FALSE) const
virtual QCString briefDescriptionAsTooltip () const
virtual int briefLine () const
virtual QCString inbodyDocumentation () const
virtual QCString inbodyFile () const
virtual int inbodyLine () const
virtual QCString briefFile () const
virtual QCString getDefFileName () const
virtual QCString getDefFileExtension () const
virtual int getDefLine () const
virtual int getDefColumn () const
virtual bool hasDocumentation () const
virtual bool hasUserDocumentation () const
virtual bool isVisibleInProject () const
virtual bool isVisible () const
virtual bool isHidden () const
virtual bool isArtificial () const
virtual QCString getReference () const
virtual bool isReference () const
virtual QCString externalReference (const QCString &relPath) const
virtual int getStartDefLine () const
virtual int getStartBodyLine () const
virtual int getEndBodyLine () const
virtual const FileDefgetBodyDef () const
virtual SrcLangExt getLanguage () const
virtual const GroupListpartOfGroups () const
virtual bool isLinkableViaGroup () const
virtual const RefItemVector & xrefListItems () const
virtual const DefinitionfindInnerCompound (const QCString &name) const
virtual DefinitiongetOuterScope () const
virtual const MemberVectorgetReferencesMembers () const
virtual const MemberVectorgetReferencedByMembers () const
virtual bool hasSections () const
virtual bool hasSources () const
virtual bool hasBriefDescription () const
virtual QCString id () const
virtual const SectionRefsgetSectionRefs () const
virtual void setName (const QCString &name)
virtual void setId (const QCString &name)
virtual void setDefFile (const QCString &df, int defLine, int defColumn)
virtual void setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)
virtual void setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine)
virtual void setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine)
virtual void setReference (const QCString &r)
virtual void addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)
virtual void setBodySegment (int defLine, int bls, int ble)
virtual void setBodyDef (const FileDef *fd)
virtual void addSourceReferencedBy (const MemberDef *md)
virtual void addSourceReferences (const MemberDef *md)
virtual void setRefItems (const RefItemVector &sli)
virtual void mergeRefItems (Definition *def)
virtual void mergeReferences (const Definition *other)
virtual void mergeReferencedBy (const Definition *other)
virtual void addInnerCompound (const Definition *def)
virtual void setOuterScope (Definition *def)
virtual void setHidden (bool b)
virtual void setArtificial (bool b)
virtual void setLanguage (SrcLangExt lang)
virtual void writeSourceDef (OutputList &ol, const QCString &scopeName) const
virtual void writeInlineCode (OutputList &ol, const QCString &scopeName) const
virtual bool hasSourceRefs () const
virtual bool hasSourceReffedBy () const
virtual void writeSourceRefs (OutputList &ol, const QCString &scopeName) const
virtual void writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const
virtual void makePartOfGroup (const GroupDef *gd)
virtual void writeNavigationPath (OutputList &ol) const
virtual QCString navigationPathAsString () const
virtual QCString pathFragment () const
virtual void writeDocAnchorsToTagFile (TextStream &fs) const
virtual void setLocalName (const QCString &name)
virtual void addSectionsToIndex ()
virtual void writeToc (OutputList &ol, const LocalToc &lt) const
virtual void setCookie (Definition::Cookie *cookie) const
virtual Definition::Cookiecookie () const
virtual void computeTooltip ()
virtual void _setSymbolName (const QCString &name)
virtual QCString _symbolName () const

Additional Inherited Members

- Public Types inherited from Definition
enum  DefType {
  TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3,
  TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7,
  TypeConcept = 8
- Protected Member Functions inherited from DefinitionMixin< FileDef >
 DefinitionMixin (const DefinitionMixin &def)=default

Constructor & Destructor Documentation

◆ FileDefImpl()

FileDefImpl::FileDefImpl ( const QCString p,
const QCString nm,
const QCString lref = QCString(),
const QCString dn = QCString() 

create a new file definition, where p is the file path, nm the file name, and lref is an HTML anchor name if the file was read from a tag file or 0 otherwise

◆ ~FileDefImpl()

FileDefImpl::~FileDefImpl ( )

destroy the file definition

Member Function Documentation

◆ absFilePath()

virtual QCString FileDefImpl::absFilePath ( ) const

Returns the absolute path including the file name.

Implements FileDef.

◆ anchor()

virtual QCString FileDefImpl::anchor ( ) const

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

Implements FileDef.

◆ codeSymbolType()

virtual CodeSymbolType FileDefImpl::codeSymbolType ( ) const

Used for syntax highlighting symbol class

Implements Definition.

◆ computeAnchors()

void FileDefImpl::computeAnchors ( )

Compute the HTML anchor names for all members in the class

Implements FileDef.

◆ definitionType()

virtual DefType FileDefImpl::definitionType ( ) const

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

Implements FileDef.

◆ displayName()

virtual QCString FileDefImpl::displayName ( bool  includeScope = TRUE) const

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

Implements FileDef.

◆ docName()

virtual const QCString& FileDefImpl::docName ( ) const

Returns the name as it is used in the documentation

Implements FileDef.

◆ getOutputFileBase()

QCString FileDefImpl::getOutputFileBase ( ) const

Returns the base file name (without extension) of this definition. as it is referenced to/written to disk.

Implements FileDef.

◆ getPath()

virtual QCString FileDefImpl::getPath ( ) const

Returns the absolute path of this file.

Implements FileDef.

◆ getSourceFileBase()

QCString FileDefImpl::getSourceFileBase ( ) const

Returns the name of the source listing of this definition.

Reimplemented from DefinitionMixin< FileDef >.

◆ getVersion()

virtual QCString FileDefImpl::getVersion ( ) const

Returns version of this file.

Implements FileDef.

◆ includeName()

QCString FileDefImpl::includeName ( ) const

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

Implements FileDef.

◆ insertClass()

void FileDefImpl::insertClass ( const ClassDef cd)

Adds compound definition cd to the list of all compounds of this file

Implements FileDef.

◆ insertMember()

void FileDefImpl::insertMember ( MemberDef md)

Adds member definition md to the list of all members of this file

Implements FileDef.

◆ insertNamespace()

void FileDefImpl::insertNamespace ( const NamespaceDef nd)

Adds namespace definition nd to the list of all compounds of this file

Implements FileDef.

◆ isLinkable()

virtual bool FileDefImpl::isLinkable ( ) const

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

Implements FileDef.

◆ isLinkableInProject()

bool FileDefImpl::isLinkableInProject ( ) const

Returns TRUE iff it is possible to link to this item within this project.

Implements FileDef.

◆ isSource()

virtual bool FileDefImpl::isSource ( ) const

Returns TRUE if this file is a source file.

Implements FileDef.

◆ name()

QCString FileDefImpl::name ( ) const

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

Reimplemented from DefinitionMixin< FileDef >.

◆ writeDocumentation()

void FileDefImpl::writeDocumentation ( OutputList ol)

Write the documentation page for this file to the file of output generators ol.

Implements FileDef.

◆ writeSourceHeader()

void FileDefImpl::writeSourceHeader ( OutputList ol)

Write a source listing of this file to the output

Implements FileDef.

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