A model of a file symbol. More...

#include <filedef.h>

Inheritance diagram for FileDef:

Public Member Functions
	FileDef (const char p, const char n, const char ref=0, const char dn=0)

	~FileDef ()

DefType	definitionType () const

QCString	name () const

QCString	displayName (bool=TRUE) const

QCString	fileName () const

QCString	getOutputFileBase () const

QCString	anchor () const

QCString	getSourceFileBase () const

QCString	includeName () const

QCString	includeDependencyGraphFileName () const

QCString	includedByDependencyGraphFileName () const

QCString	absFilePath () const

const QCString &	docName () const

bool	isSource () const

bool	isDocumentationFile () const

Definition *	getSourceDefinition (int lineNr) const

MemberDef *	getSourceMember (int lineNr) const

QCString	getPath () const

QCString	getVersion () const

bool	isLinkableInProject () const

bool	isLinkable () const

bool	isIncluded (const QCString &name) const

PackageDef *	packageDef () const

DirDef *	getDirDef () const

NamespaceSDict *	getUsedNamespaces () const

SDict< Definition > *	getUsedClasses () const

QList< IncludeInfo > *	includeFileList () const

QList< IncludeInfo > *	includedByFileList () const

void	getAllIncludeFilesRecursively (QStrList &incFiles) const

MemberList *	getMemberList (MemberListType lt) const

const QList< MemberList > &	getMemberLists () const

MemberGroupSDict *	getMemberGroupSDict () const

NamespaceSDict *	getNamespaceSDict () const

ClassSDict *	getClassSDict () const

QCString	title () const

bool	hasDetailedDescription () const

QCString	fileVersion () const

bool	subGrouping () const

void	addSourceRef (int line, Definition d, MemberDef md)

void	writeDocumentation (OutputList &ol)

void	writeMemberPages (OutputList &ol)

void	writeQuickMemberLinks (OutputList &ol, MemberDef *currentMd) const

void	writeSummaryLinks (OutputList &ol)

void	writeTagFile (FTextStream &t)

void	startParsing ()

void	writeSource (OutputList &ol, bool sameTu, QStrList &filesInSameTu)

void	parseSource (bool sameTu, QStrList &filesInSameTu)

void	finishParsing ()

void	setDiskName (const QCString &name)

void	insertMember (MemberDef *md)

void	insertClass (ClassDef *cd)

void	insertNamespace (NamespaceDef *nd)

void	computeAnchors ()

void	setPackageDef (PackageDef *pd)

void	setDirDef (DirDef *dd)

void	addUsingDirective (NamespaceDef *nd)

void	addUsingDeclaration (Definition *def)

void	combineUsingRelations ()

bool	generateSourceFile () const

void	sortMemberLists ()

void	addIncludeDependency (FileDef fd, const char incName, bool local, bool imported, bool indirect)

void	addIncludedByDependency (FileDef fd, const char incName, bool local, bool imported)

void	addMembersToMemberGroup ()

void	distributeMemberGroupDocumentation ()

void	findSectionsInDocumentation ()

void	addIncludedUsingDirectives ()

void	addListReferences ()

Public Member Functions inherited from Definition
	Definition (const char defFileName, int defLine, int defColumn, const char name, const char b=0, const char d=0, bool isSymbol=TRUE)

virtual	~Definition ()

const QCString &	name () const

QCString	localName () const

virtual QCString	qualifiedName () const

QCString	symbolName () const

virtual QCString	getSourceAnchor () const

virtual QCString	documentation () const

int	docLine () const

QCString	docFile () const

virtual QCString	briefDescription (bool abbreviate=FALSE) const

QCString	briefDescriptionAsTooltip () const

int	briefLine () const

QCString	inbodyDocumentation () const

QCString	inbodyFile () const

int	inbodyLine () const

QCString	briefFile () const

QCString	getDefFileName () const

QCString	getDefFileExtension () const

int	getDefLine () const

int	getDefColumn () const

virtual bool	hasDocumentation () const

virtual bool	hasUserDocumentation () const

virtual bool	isVisibleInProject () const

virtual bool	isVisible () const

bool	isHidden () const

bool	isArtificial () const

virtual QCString	getReference () const

virtual bool	isReference () const

QCString	externalReference (const QCString &relPath) const

int	getStartBodyLine () const

int	getEndBodyLine () const

FileDef *	getBodyDef () const

SrcLangExt	getLanguage () const
	Returns the programming language this definition was written in. More...

GroupList *	partOfGroups () const

bool	isLinkableViaGroup () const

QList< ListItemInfo > *	xrefListItems () const

virtual Definition *	findInnerCompound (const char *name)

virtual Definition *	getOuterScope () const

MemberSDict *	getReferencesMembers () const

MemberSDict *	getReferencedByMembers () const

bool	hasSections () const

bool	hasSources () const

bool	hasBriefDescription () const
	returns TRUE if this class has a brief description

QCString	id () const

virtual void	setName (const char *name)

void	setId (const char *name)

virtual void	setDocumentation (const char d, const char docFile, int docLine, bool stripWhiteSpace=TRUE)

virtual void	setBriefDescription (const char b, const char briefFile, int briefLine)

virtual void	setInbodyDocumentation (const char d, const char docFile, int docLine)

void	setReference (const char *r)

void	addSectionsToDefinition (QList< SectionInfo > *anchorList)

void	setBodySegment (int bls, int ble)

void	setBodyDef (FileDef *fd)

void	addSourceReferencedBy (MemberDef *d)

void	addSourceReferences (MemberDef *d)

void	setRefItems (const QList< ListItemInfo > *sli)

void	mergeRefItems (Definition *d)

virtual void	addInnerCompound (Definition *d)

virtual void	setOuterScope (Definition *d)

virtual void	setHidden (bool b)

void	setArtificial (bool b)

void	setLanguage (SrcLangExt lang)

void	writeSourceDef (OutputList &ol, const char *scopeName)

void	writeInlineCode (OutputList &ol, const char *scopeName)

void	writeSourceRefs (OutputList &ol, const char *scopeName)

void	writeSourceReffedBy (OutputList &ol, const char *scopeName)

void	makePartOfGroup (GroupDef *gd)

void	writeNavigationPath (OutputList &ol) const

QCString	navigationPathAsString () const

QCString	pathFragment () const

void	writeDocAnchorsToTagFile (FTextStream &)

void	setLocalName (const QCString name)

void	addSectionsToIndex ()

void	writeToc (OutputList &ol)

void	setCookie (Cookie *cookie)

Cookie *	cookie () const

Public Attributes
bool	visited

Protected Member Functions
void	acquireFileVersion ()
	Retrieves the file version from version control system.

Protected Member Functions inherited from Definition
	Definition (const Definition &d)

Additional Inherited Members
Public Types inherited from DefinitionIntf
enum	DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3, TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7, TypeSymbolList = 8 }

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.

Constructor & Destructor Documentation

§ FileDef()

FileDef::FileDef	(	const char *	p,
		const char *	nm,
		const char *	lref = `0`,
		const char *	dn = `0`
	)

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

§ ~FileDef()

FileDef::~FileDef ( )

destroy the file definition

Member Function Documentation

§ absFilePath()

QCString FileDef::absFilePath ( ) const

inline

Returns the absolute path including the file name.

§ anchor()

QCString FileDef::anchor ( ) const

inlinevirtual

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

Implements Definition.

§ computeAnchors()

void FileDef::computeAnchors ( )

Compute the HTML anchor names for all members in the class

§ definitionType()

DefType FileDef::definitionType ( ) const

inlinevirtual

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

Implements DefinitionIntf.

§ displayName()

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

inlinevirtual

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

Implements Definition.

§ docName()

const QCString& FileDef::docName ( ) const

inline

Returns the name as it is used in the documentation

§ getOutputFileBase()

QCString FileDef::getOutputFileBase ( ) const

virtual

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

Implements Definition.

§ getPath()

QCString FileDef::getPath ( ) const

inline

Returns the absolute path of this file.

§ getSourceFileBase()

QCString FileDef::getSourceFileBase ( ) const

virtual

Returns the name of the source listing of this definition.

Reimplemented from Definition.

§ getVersion()

QCString FileDef::getVersion ( ) const

inline

Returns version of this file.

§ includeName()

QCString FileDef::includeName ( ) const

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

§ insertClass()

void FileDef::insertClass ( ClassDef * cd )

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

§ insertMember()

void FileDef::insertMember ( MemberDef * md )

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

§ insertNamespace()

void FileDef::insertNamespace ( NamespaceDef * nd )

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

§ isLinkable()

bool FileDef::isLinkable ( ) const

inlinevirtual

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 Definition.

§ isLinkableInProject()

bool FileDef::isLinkableInProject ( ) const

virtual

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

Implements Definition.

§ isSource()

bool FileDef::isSource ( ) const

inline

Returns TRUE if this file is a source file.

§ name()

QCString FileDef::name ( ) const

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

§ writeDocumentation()

void FileDef::writeDocumentation ( OutputList & ol )

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

§ writeSource()

void FileDef::writeSource	(	OutputList &	ol,
		bool	sameTu,
		QStrList &	filesInSameTu
	)

Write a source listing of this file to the output

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

src/filedef.h
src/filedef.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ FileDef()

§ ~FileDef()

Member Function Documentation

§ absFilePath()

§ anchor()

§ computeAnchors()

§ definitionType()

§ displayName()

§ docName()

§ getOutputFileBase()

§ getPath()

§ getSourceFileBase()

§ getVersion()

§ includeName()

§ insertClass()

§ insertMember()

§ insertNamespace()

§ isLinkable()

§ isLinkableInProject()

§ isSource()

§ name()

§ writeDocumentation()

§ writeSource()