#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

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

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 Member Functions inherited from DefinitionIntf
	DefinitionIntf ()

virtual	~DefinitionIntf ()

Public Attributes
bool	visited

Protected Member Functions
void	acquireFileVersion ()

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

Private Member Functions
MemberList *	createMemberList (MemberListType lt)

void	addMemberToList (MemberListType lt, MemberDef *md)

void	writeMemberDeclarations (OutputList &ol, MemberListType lt, const QCString &title)

void	writeMemberDocumentation (OutputList &ol, MemberListType lt, const QCString &title)

void	writeIncludeFiles (OutputList &ol)

void	writeIncludeGraph (OutputList &ol)

void	writeIncludedByGraph (OutputList &ol)

void	writeMemberGroups (OutputList &ol)

void	writeAuthorSection (OutputList &ol)

void	writeSourceLink (OutputList &ol)

void	writeNamespaceDeclarations (OutputList &ol, const QCString &title, bool isConstantGroup)

void	writeClassDeclarations (OutputList &ol, const QCString &title)

void	writeInlineClasses (OutputList &ol)

void	startMemberDeclarations (OutputList &ol)

void	endMemberDeclarations (OutputList &ol)

void	startMemberDocumentation (OutputList &ol)

void	endMemberDocumentation (OutputList &ol)

void	writeDetailedDescription (OutputList &ol, const QCString &title)

void	writeBriefDescription (OutputList &ol)

Private Attributes
QDict< IncludeInfo > *	m_includeDict

QList< IncludeInfo > *	m_includeList

QDict< IncludeInfo > *	m_includedByDict

QList< IncludeInfo > *	m_includedByList

NamespaceSDict *	m_usingDirList

SDict< Definition > *	m_usingDeclList

QCString	m_path

QCString	m_filePath

QCString	m_inclDepFileName

QCString	m_inclByDepFileName

QCString	m_outputDiskName

QCString	m_fileName

QCString	m_docname

QIntDict< Definition > *	m_srcDefDict

QIntDict< MemberDef > *	m_srcMemberDict

bool	m_isSource

QCString	m_fileVersion

PackageDef *	m_package

DirDef *	m_dir

QList< MemberList >	m_memberLists

MemberGroupSDict *	m_memberGroupSDict

NamespaceSDict *	m_namespaceSDict

ClassSDict *	m_classSDict

bool	m_subGrouping

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.

Definition at line 64 of file filedef.h.

Constructor & Destructor Documentation

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

Definition at line 78 of file filedef.cpp.

References acquireFileVersion(), Config_getBool, getLanguageFromFileName(), guessSection(), m_classSDict, m_dir, m_docname, m_fileName, m_filePath, m_includedByDict, m_includedByList, m_includeDict, m_includeList, m_isSource, m_memberGroupSDict, m_namespaceSDict, m_package, m_path, m_srcDefDict, m_srcMemberDict, m_subGrouping, m_usingDeclList, m_usingDirList, name(), setDiskName(), Definition::setLanguage(), Definition::setReference(), Entry::SOURCE_SEC, and stripFromPath().

   : Definition((QCString)p+nm,1,1,nm)
{
  m_path=p;
  m_filePath=m_path+nm;
  m_fileName=nm;
  setDiskName(dn?dn:nm);
  setReference(lref);
  m_classSDict        = 0;
  m_includeList       = 0;
  m_includeDict       = 0; 
  m_includedByList    = 0;
  m_includedByDict    = 0; 
  m_namespaceSDict    = 0; 
  m_srcDefDict        = 0;
  m_srcMemberDict     = 0;
  m_usingDirList      = 0;
  m_usingDeclList     = 0;
  m_package           = 0;
  m_isSource          = guessSection(nm)==Entry::SOURCE_SEC; 
  m_docname           = nm;
  m_dir               = 0;
  if (Config_getBool(FULL_PATH_NAMES))
  {
    m_docname.prepend(stripFromPath(m_path.copy()));
  }
  setLanguage(getLanguageFromFileName(name()));
  m_memberGroupSDict = 0;
  acquireFileVersion();
  m_subGrouping=Config_getBool(SUBGROUPING);
}

FileDef::~FileDef ( )

destroy the file definition

Definition at line 112 of file filedef.cpp.

References m_classSDict, m_includedByDict, m_includedByList, m_includeDict, m_includeList, m_memberGroupSDict, m_namespaceSDict, m_srcDefDict, m_srcMemberDict, m_usingDeclList, and m_usingDirList.

{
  delete m_classSDict;
  delete m_includeDict;
  delete m_includeList;
  delete m_includedByDict;
  delete m_includedByList;
  delete m_namespaceSDict;
  delete m_srcDefDict;
  delete m_srcMemberDict;
  delete m_usingDirList;
  delete m_usingDeclList;
  delete m_memberGroupSDict;
}

Member Function Documentation

QCString FileDef::absFilePath ( ) const

inline

Returns the absolute path including the file name.

Definition at line 95 of file filedef.h.

References m_filePath.

Referenced by addIncludedByDependency(), addIncludeDependency(), addIncludeFile(), addVariableToFile(), buildFunctionList(), DotInclDepGraph::buildGraph(), VhdlDocGen::createFlowChart(), DotInclDepGraph::DotInclDepGraph(), findAndCopyImage(), findDefineDocumentation(), generateFileSources(), generateXMLForClass(), generateXMLForMember(), getResolvedClassRec(), mergeFileDef(), DocDotFile::parse(), DocMscFile::parse(), DocDiaFile::parse(), parseCode(), parseSource(), readTextFileByName(), showFileDefMatches(), MemberContext::Private::sourceCode(), DocbookDocVisitor::visitPost(), writeDocbookCodeBlock(), Definition::writeInlineCode(), writeSource(), and writeXMLCodeBlock().

{ return m_filePath; }

void FileDef::acquireFileVersion ( )

protected

Retrieves the file version from version control system.

Definition at line 1743 of file filedef.cpp.

References Config_getString, err(), Debug::ExtCmd, m_filePath, m_fileVersion, msg(), portable_pclose(), portable_popen(), and Debug::print().

Referenced by FileDef().

{
  QCString vercmd = Config_getString(FILE_VERSION_FILTER);
  if (!vercmd.isEmpty() && !m_filePath.isEmpty() &&
      m_filePath!="generated" && m_filePath!="graph_legend")
  {
    msg("Version of %s : ",m_filePath.data());
    QCString cmd = vercmd+" \""+m_filePath+"\"";
    Debug::print(Debug::ExtCmd,0,"Executing popen(`%s`)\n",qPrint(cmd));
    FILE *f=portable_popen(cmd,"r");
    if (!f)
    {
      err("could not execute %s\n",vercmd.data());
      return;
    }
    const int bufSize=1024;
    char buf[bufSize];
    int numRead = (int)fread(buf,1,bufSize-1,f);
    portable_pclose(f);
    if (numRead>0 && numRead<bufSize)
    {
      buf[numRead]='\0';
      m_fileVersion=QCString(buf,numRead).stripWhiteSpace();
      if (!m_fileVersion.isEmpty())
      {
        msg("%s\n",m_fileVersion.data());
        return;
      }
    }
    msg("no version available\n");
  }
}

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

Definition at line 1372 of file filedef.cpp.

References absFilePath(), IncludeInfo::fileDef, IncludeInfo::imported, IncludeInfo::includeName, IncludeInfo::indirect, IncludeInfo::local, m_includedByDict, and m_includedByList.

{
  //printf("FileDef::addIncludedByDependency(%p,%s,%d)\n",fd,incName,local);
  QCString iName = fd ? fd->absFilePath().data() : incName;
  if (!iName.isEmpty() && (m_includedByDict==0 || m_includedByDict->find(iName)==0))
  {
    if (m_includedByDict==0)
    {
      m_includedByDict = new QDict<IncludeInfo>(61);
      m_includedByList = new QList<IncludeInfo>;
      m_includedByList->setAutoDelete(TRUE);
    }
    IncludeInfo *ii = new IncludeInfo;
    ii->fileDef     = fd;
    ii->includeName = incName;
    ii->local       = local;
    ii->imported    = imported;
    ii->indirect    = FALSE;
    m_includedByList->append(ii);
    m_includedByDict->insert(iName,ii);
  }
}

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

Definition at line 1275 of file filedef.cpp.

References absFilePath(), IncludeInfo::fileDef, IncludeInfo::imported, IncludeInfo::includeName, IncludeInfo::indirect, IncludeInfo::local, m_includeDict, and m_includeList.

Referenced by TagFileParser::addIncludes().

{
  //printf("FileDef::addIncludeDependency(%p,%s,%d)\n",fd,incName,local);
  QCString iName = fd ? fd->absFilePath().data() : incName;
  if (!iName.isEmpty() && (!m_includeDict || m_includeDict->find(iName)==0))
  {
    if (m_includeDict==0)
    {
      m_includeDict   = new QDict<IncludeInfo>(61);
      m_includeList   = new QList<IncludeInfo>;
      m_includeList->setAutoDelete(TRUE);
    }
    IncludeInfo *ii = new IncludeInfo;
    ii->fileDef     = fd;
    ii->includeName = incName;
    ii->local       = local;
    ii->imported    = imported;
    ii->indirect    = indirect;
    m_includeList->append(ii);
    m_includeDict->insert(iName,ii);
  }
}

void FileDef::addIncludedUsingDirectives ( )

Definition at line 1299 of file filedef.cpp.

References addIncludedUsingDirectives(), IncludeInfo::fileDef, SDict< T >::find(), SDict< NamespaceDef >::Iterator, m_includeList, m_usingDeclList, m_usingDirList, SDict< T >::prepend(), Definition::qualifiedName(), and visited.

Referenced by addIncludedUsingDirectives(), and findIncludedUsingDirectives().

{
  if (visited) return;
  visited=TRUE;
  //printf("( FileDef::addIncludedUsingDirectives for file %s\n",name().data());
  if (m_includeList) // file contains #includes
  {
    {
      QListIterator<IncludeInfo> iii(*m_includeList);
      IncludeInfo *ii;
      for (iii.toFirst();(ii=iii.current());++iii) // foreach #include...
      {
        if (ii->fileDef && !ii->fileDef->visited) // ...that is a known file
        {
          // recurse into this file
          ii->fileDef->addIncludedUsingDirectives();
        }
      }
    }
    {
      QListIterator<IncludeInfo> iii(*m_includeList);
      IncludeInfo *ii;
      // iterate through list from last to first
      for (iii.toLast();(ii=iii.current());--iii)
      {
        if (ii->fileDef && ii->fileDef!=this)
        {
          // add using directives
          NamespaceSDict *unl = ii->fileDef->m_usingDirList;
          if (unl)
          {
            NamespaceSDict::Iterator nli(*unl);
            NamespaceDef *nd;
            for (nli.toLast();(nd=nli.current());--nli)
            {
              // append each using directive found in a #include file
              if (m_usingDirList==0) m_usingDirList = new NamespaceSDict;
              //printf("Prepending used namespace %s to the list of file %s\n",
              //    nd->name().data(),name().data());
              if (m_usingDirList->find(nd->qualifiedName())==0) // not yet added
              {
                m_usingDirList->prepend(nd->qualifiedName(),nd);
              }
            }
          }
          // add using declarations
          SDict<Definition> *udl = ii->fileDef->m_usingDeclList;
          if (udl)
          {
            SDict<Definition>::Iterator udi(*udl);
            Definition *d;
            for (udi.toLast();(d=udi.current());--udi)
            {
              //printf("Adding using declaration %s\n",d->name().data());
              if (m_usingDeclList==0)
              {
                m_usingDeclList = new SDict<Definition>(17);
              }
              if (m_usingDeclList->find(d->qualifiedName())==0)
              {
                m_usingDeclList->prepend(d->qualifiedName(),d);
              }
            }
          }
        }
      }
    }
  }
  //printf(") end FileDef::addIncludedUsingDirectives for file %s\n",name().data());
}

void FileDef::addListReferences ( )

Definition at line 1416 of file filedef.cpp.

References MemberList::addListReferences(), MemberGroup::addListReferences(), addRefItem(), getOutputFileBase(), SIntDict< MemberGroup >::Iterator, MemberList::listType(), m_memberGroupSDict, m_memberLists, MemberListType_documentationLists, name(), theTranslator, Translator::trFile(), and Definition::xrefListItems().

Referenced by addListReferences().

{
  {
    QList<ListItemInfo> *xrefItems = xrefListItems();
    addRefItem(xrefItems,
               getOutputFileBase(),
               theTranslator->trFile(TRUE,TRUE),
               getOutputFileBase(),name(),
               0,
               0
              );
  }
  if (m_memberGroupSDict)
  {
    MemberGroupSDict::Iterator mgli(*m_memberGroupSDict);
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      mg->addListReferences(this);
    }
  }
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberListType_documentationLists)
    {
      ml->addListReferences(this);
    }
  }
}

void FileDef::addMembersToMemberGroup ( )

Definition at line 1077 of file filedef.cpp.

References MemberGroup::addToDeclarationSection(), MemberGroup::allMembersInSameSection(), SIntDict< MemberGroup >::Iterator, MemberList::listType(), m_memberGroupSDict, m_memberLists, m_subGrouping, and MemberListType_declarationLists.

Referenced by addMembersToMemberGroup().

{
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberListType_declarationLists)
    {
      ::addMembersToMemberGroup(ml,&m_memberGroupSDict,this);
    }
  }
  // add members inside sections to their groups
  if (m_memberGroupSDict)
  {
    MemberGroupSDict::Iterator mgli(*m_memberGroupSDict);
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      if (mg->allMembersInSameSection() && m_subGrouping)
      {
        //printf("----> addToDeclarationSection(%s)\n",mg->header().data());
        mg->addToDeclarationSection();
      }
    }
  }
}

void FileDef::addMemberToList	(	MemberListType	lt,
		MemberDef *	md
	)

private

Definition at line 1818 of file filedef.cpp.

References MemberList::append(), Config_getBool, createMemberList(), MemberList::inSort(), MemberList::listType(), MemberListType_declarationLists, MemberListType_documentationLists, MemberList::needsSorting(), MemberList::setInFile(), MemberList::setNeedsSorting(), and MemberDef::setSectionList().

Referenced by insertMember().

{
  static bool sortBriefDocs = Config_getBool(SORT_BRIEF_DOCS);
  static bool sortMemberDocs = Config_getBool(SORT_MEMBER_DOCS);
  MemberList *ml = createMemberList(lt);
  ml->setNeedsSorting(
       ((ml->listType()&MemberListType_declarationLists) && sortBriefDocs) ||
       ((ml->listType()&MemberListType_documentationLists) && sortMemberDocs));
  ml->append(md);
#if 0
  if (ml->needsSorting())
    ml->inSort(md);
  else
    ml->append(md);
#endif
  if (lt&MemberListType_documentationLists)
  {
    ml->setInFile(TRUE);
  }
  if (ml->listType()&MemberListType_declarationLists) md->setSectionList(this,ml);
}

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

Definition at line 1207 of file filedef.cpp.

References m_srcDefDict, and m_srcMemberDict.

Referenced by addSourceReferences().

{
  //printf("FileDef::addSourceDef(%d,%p,%p)\n",line,d,md);
  if (d)
  {
    if (m_srcDefDict==0)    m_srcDefDict    = new QIntDict<Definition>(257);
    if (m_srcMemberDict==0) m_srcMemberDict = new QIntDict<MemberDef>(257);
    m_srcDefDict->insert(line,d);
    if (md) m_srcMemberDict->insert(line,md);
    //printf("Adding member %s with anchor %s at line %d to file %s\n",
    //    md?md->name().data():"<none>",md?md->anchor().data():"<none>",line,name().data());
  }
}

void FileDef::addUsingDeclaration ( Definition * def )

Definition at line 1263 of file filedef.cpp.

References SDict< T >::append(), SDict< T >::find(), m_usingDeclList, and Definition::qualifiedName().

Referenced by combineUsingRelations(), and findUsingDeclarations().

{
  if (m_usingDeclList==0)
  {
    m_usingDeclList = new SDict<Definition>(17);
  }
  if (m_usingDeclList->find(d->qualifiedName())==0)
  {
    m_usingDeclList->append(d->qualifiedName(),d);
  }
}

void FileDef::addUsingDirective ( NamespaceDef * nd )

Definition at line 1244 of file filedef.cpp.

References SDict< T >::append(), SDict< T >::find(), m_usingDirList, and Definition::qualifiedName().

Referenced by combineUsingRelations().

{
  if (m_usingDirList==0)
  {
    m_usingDirList = new NamespaceSDict;
  }
  if (m_usingDirList->find(nd->qualifiedName())==0)
  {
    m_usingDirList->append(nd->qualifiedName(),nd);
  }
  //printf("%p: FileDef::addUsingDirective: %s:%d\n",this,name().data(),usingDirList->count());
}

QCString FileDef::anchor ( ) const

inlinevirtual

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

Implements Definition.

Definition at line 83 of file filedef.h.

Referenced by MemberDef::_writeGroupInclude(), and writeDocumentation().

{ return QCString(); }

void FileDef::combineUsingRelations ( )

Definition at line 1694 of file filedef.cpp.

References addUsingDeclaration(), addUsingDirective(), NamespaceDef::combineUsingRelations(), NamespaceDef::getUsedClasses(), NamespaceDef::getUsedNamespaces(), SDict< NamespaceDef >::Iterator, m_usingDirList, and visited.

Referenced by combineUsingRelations().

{
  if (visited) return; // already done
  visited=TRUE;
  if (m_usingDirList)
  {
    NamespaceSDict::Iterator nli(*m_usingDirList);
    NamespaceDef *nd;
    for (nli.toFirst();(nd=nli.current());++nli)
    {
      nd->combineUsingRelations();
    }
    for (nli.toFirst();(nd=nli.current());++nli)
    {
      // add used namespaces of namespace nd to this namespace
      if (nd->getUsedNamespaces())
      {
        NamespaceSDict::Iterator unli(*nd->getUsedNamespaces());
        NamespaceDef *und;
        for (unli.toFirst();(und=unli.current());++unli)
        {
          //printf("Adding namespace %s to the using list of %s\n",und->qualifiedName().data(),qualifiedName().data());
          addUsingDirective(und);
        }
      }
      // add used classes of namespace nd to this namespace
      if (nd->getUsedClasses())
      {
        SDict<Definition>::Iterator cli(*nd->getUsedClasses());
        Definition *ucd;
        for (cli.toFirst();(ucd=cli.current());++cli)
        {
          //printf("Adding class %s to the using list of %s\n",cd->qualifiedName().data(),qualifiedName().data());
          addUsingDeclaration(ucd);
        }
      }
    }
  }
}

void FileDef::computeAnchors ( )

Compute the HTML anchor names for all members in the class

Definition at line 135 of file filedef.cpp.

References getMemberList(), MemberListType_allMembersList, and setAnchors().

Referenced by computeMemberReferences().

{
  MemberList *ml = getMemberList(MemberListType_allMembersList);
  if (ml) setAnchors(ml);
}

MemberList * FileDef::createMemberList ( MemberListType lt )

private

Definition at line 1800 of file filedef.cpp.

References MemberList::listType(), and m_memberLists.

Referenced by addMemberToList().

{
  m_memberLists.setAutoDelete(TRUE);
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()==lt)
    {
      return ml;
    }
  }
  // not found, create a new member list
  ml = new MemberList(lt);
  m_memberLists.append(ml);
  return ml;
}

DefType FileDef::definitionType ( ) const

inlinevirtual

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

Implements DefinitionIntf.

Definition at line 74 of file filedef.h.

References DefinitionIntf::TypeFile.

{ return TypeFile; }

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

inlinevirtual

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

Implements Definition.

Definition at line 78 of file filedef.h.

References name().

Referenced by writeDirHierarchy(), writeDirTreeNode(), and MemberDef::writeDocumentation().

{ return name(); }

void FileDef::distributeMemberGroupDocumentation ( )

Definition at line 141 of file filedef.cpp.

References MemberGroup::distributeMemberGroupDocumentation(), SIntDict< MemberGroup >::Iterator, and m_memberGroupSDict.

Referenced by distributeMemberGroupDocumentation().

{
  //printf("FileDef::distributeMemberGroupDocumentation()\n");
  if (m_memberGroupSDict)
  {
    MemberGroupSDict::Iterator mgli(*m_memberGroupSDict);
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      mg->distributeMemberGroupDocumentation();
    }
  }
}

const QCString& FileDef::docName ( ) const

inline

Returns the name as it is used in the documentation

Definition at line 98 of file filedef.h.

References m_docname.

Referenced by MemberDef::_writeGroupInclude(), DotInclDepGraph::DotInclDepGraph(), generateDocbookForClass(), generateFileDocs(), generateFileSources(), PerlModGenerator::generatePerlModForClass(), generateXMLForClass(), and ClassDef::writeIncludeFiles().

{ return m_docname; }

void FileDef::endMemberDeclarations ( OutputList & ol )

private

Definition at line 563 of file filedef.cpp.

References OutputList::endMemberSections().

Referenced by writeDocumentation().

{
  ol.endMemberSections();
}

void FileDef::endMemberDocumentation ( OutputList & ol )

private

Definition at line 577 of file filedef.cpp.

References Config_getBool, OutputList::enable(), OutputGenerator::Html, and Doxygen::suppressDocWarnings.

Referenced by writeDocumentation().

{
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    ol.enable(OutputGenerator::Html);
    Doxygen::suppressDocWarnings = FALSE;
  }
}

QCString FileDef::fileName ( ) const

inline

Definition at line 79 of file filedef.h.

References m_fileName.

Referenced by addInstance(), and FileName::compareValues().

{ return m_fileName; }

QCString FileDef::fileVersion ( ) const

Definition at line 1926 of file filedef.cpp.

References m_fileVersion.

Referenced by FileContext::Private::version().

{
  return m_fileVersion;
}

void FileDef::findSectionsInDocumentation ( )

Definition at line 155 of file filedef.cpp.

References Definition::docFile(), docFindSections(), Definition::documentation(), MemberGroup::findSectionsInDocumentation(), MemberList::findSectionsInDocumentation(), SIntDict< MemberGroup >::Iterator, MemberList::listType(), m_memberGroupSDict, m_memberLists, and MemberListType_declarationLists.

Referenced by findSectionsInDocumentation().

{
  docFindSections(documentation(),this,0,docFile());
  if (m_memberGroupSDict)
  {
    MemberGroupSDict::Iterator mgli(*m_memberGroupSDict);
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      mg->findSectionsInDocumentation();
    }
  }
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberListType_declarationLists)
    {
      ml->findSectionsInDocumentation();
    }
  }
}

void FileDef::finishParsing ( )

Definition at line 1072 of file filedef.cpp.

References ClangParser::finish(), and ClangParser::instance().

Referenced by generateFileSources().

{
  ClangParser::instance()->finish();
}

bool FileDef::generateSourceFile ( ) const

Definition at line 1402 of file filedef.cpp.

References Config_getBool, guessSection(), Entry::HEADER_SEC, Definition::isReference(), and name().

Referenced by FileListContext::Private::addFiles(), addIncludeFile(), addSourceReferences(), DotInclDepGraph::buildGraph(), RTFGenerator::endIndexSection(), LatexGenerator::endIndexSection(), fileVisibleInIndex(), generateFileSources(), FileContext::Private::hasSourceFile(), ClassDef::showUsedFiles(), FileContext::Private::sources(), DirDef::writeFileList(), writeIncludeFiles(), writeSingleFileIndex(), writeSource(), and writeSourceLink().

{ 
  static bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
  static bool verbatimHeaders = Config_getBool(VERBATIM_HEADERS);
  QCString extension = name().right(4);
  return !isReference() && 
         (sourceBrowser || 
           (verbatimHeaders && guessSection(name())==Entry::HEADER_SEC) 
         ) &&
         extension!=".doc" && extension!=".txt" && extension!=".dox" &&
         extension!=".md" && name().right(9)!=".markdown";  
}

void FileDef::getAllIncludeFilesRecursively ( QStrList & incFiles ) const

Definition at line 1915 of file filedef.cpp.

Referenced by generateFileSources(), and parseFile().

{
  QDict<void> includes(257);
  ::getAllIncludeFilesRecursively(&includes,this,incFiles);
}

ClassSDict* FileDef::getClassSDict ( ) const

inline

Definition at line 133 of file filedef.h.

References m_classSDict.

Referenced by FileContext::Private::classes(), generateDocbookForFile(), generateXMLForFile(), and FileContext::Private::inlineClasses().

{ return m_classSDict; }

DirDef* FileDef::getDirDef ( ) const

inline

Definition at line 120 of file filedef.h.

References m_dir.

Referenced by NestingContext::Private::addFiles(), DirDef::computeDependencies(), writeDirHierarchy(), writeDocumentation(), writePartialFilePath(), and writeSource().

{ return m_dir; }

MemberGroupSDict* FileDef::getMemberGroupSDict ( ) const

inline

Definition at line 131 of file filedef.h.

References m_memberGroupSDict.

Referenced by generateDocbookForFile(), generateXMLForFile(), and FileContext::Private::memberGroups().

{ return m_memberGroupSDict; }

MemberList * FileDef::getMemberList ( MemberListType lt ) const

Definition at line 1850 of file filedef.cpp.

References MemberList::listType(), and m_memberLists.

Referenced by computeAnchors(), generateDEFForFile(), PerlModGenerator::generatePerlModForFile(), FileContext::Private::getMemberList(), insertMember(), writeDocumentation(), writeMemberDeclarations(), writeMemberDocumentation(), writeQuickMemberLinks(), writeSummaryLinks(), and writeTagFile().

{
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (;(ml=mli.current());++mli)
  {
    if (ml->listType()==lt)
    {
      return ml;
    }
  }
  return 0;
}

const QList<MemberList>& FileDef::getMemberLists ( ) const

inline

Definition at line 128 of file filedef.h.

References m_memberLists.

Referenced by generateDocbookForFile(), and generateXMLForFile().

{ return m_memberLists; }

NamespaceSDict* FileDef::getNamespaceSDict ( ) const

inline

Definition at line 132 of file filedef.h.

References m_namespaceSDict.

Referenced by FileContext::Private::constantgroups(), generateDocbookForFile(), generateXMLForFile(), and FileContext::Private::namespaces().

{ return m_namespaceSDict; }

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.

Definition at line 1789 of file filedef.cpp.

References m_outputDiskName.

Referenced by MemberDef::_writeGroupInclude(), UsedDir::addFileDep(), TagFileParser::addIncludes(), addListReferences(), DirDef::addUsesDependency(), DotInclDepGraph::buildGraph(), DotInclDepGraph::DotInclDepGraph(), RTFGenerator::endIndexSection(), LatexGenerator::endIndexSection(), generateDEFForFile(), generateDEFForMember(), generateDocbookForClass(), generateDocbookForFile(), generateFileRef(), PerlModGenerator::generatePerlModForClass(), PerlModGenerator::generatePerlModForFile(), generateXMLForClass(), generateXMLForFile(), MemberDef::getOutputFileBase(), ClassDef::getOutputFileBase(), FileContext::Private::includedByGraph(), FileContext::Private::includeGraph(), node2URL(), ClassDef::showUsedFiles(), writeDirHierarchy(), writeDirTreeNode(), writeDocumentation(), DirDef::writeFileList(), GroupDef::writeFiles(), writeIncludeFiles(), writeInnerFiles(), writeMemberReference(), writePartialFilePath(), writeSingleFileIndex(), writeSource(), and writeTagFile().

{
  return m_outputDiskName;
}

QCString FileDef::getPath ( ) const

inline

Returns the absolute path of this file.

Definition at line 109 of file filedef.h.

References m_path.

Referenced by TagFileParser::addIncludes(), buildDirectories(), findFileDef(), FileName::generateDiskNames(), showFileDefMatches(), ClassDef::showUsedFiles(), writeFileIndex(), writeSingleFileIndex(), and writeTagFile().

{ return m_path; }

Definition * FileDef::getSourceDefinition ( int lineNr ) const

Definition at line 1221 of file filedef.cpp.

References m_srcDefDict.

{
  Definition *result=0;
  if (m_srcDefDict)
  {
    result = m_srcDefDict->find(lineNr);
  }
  //printf("%s::getSourceDefinition(%d)=%s\n",name().data(),lineNr,result?result->name().data():"none");
  return result;
}

QCString FileDef::getSourceFileBase ( ) const

virtual

Returns the name of the source listing of this definition.

Reimplemented from Definition.

Definition at line 1777 of file filedef.cpp.

References m_filePath, m_outputDiskName, Htags::path2URL(), and Htags::useHtags.

Referenced by Definition::_writeSourceRefList(), DotInclDepGraph::buildGraph(), RTFGenerator::endIndexSection(), LatexGenerator::endIndexSection(), FTVHelp::generateTree(), Definition::getSourceFileBase(), includeName(), node2URL(), ClassDef::showUsedFiles(), writeDetailedDescription(), writeDirHierarchy(), writeDirTreeNode(), and writeSource().

{
  if (Htags::useHtags)
  {
    return Htags::path2URL(m_filePath);
  }
  else
  {
    return m_outputDiskName+"_source";
  }
}

MemberDef * FileDef::getSourceMember ( int lineNr ) const

Definition at line 1232 of file filedef.cpp.

References m_srcMemberDict.

{
  MemberDef *result=0;
  if (m_srcMemberDict)
  {
    result = m_srcMemberDict->find(lineNr);
  }
  //printf("%s::getSourceMember(%d)=%s\n",name().data(),lineNr,result?result->name().data():"none");
  return result;
}

SDict<Definition>* FileDef::getUsedClasses ( ) const

inline

Definition at line 122 of file filedef.h.

References m_usingDeclList.

Referenced by getResolvedClassRec(), and isAccessibleFrom().

{ return m_usingDeclList; }

NamespaceSDict * FileDef::getUsedNamespaces ( ) const

Definition at line 1257 of file filedef.cpp.

References m_usingDirList.

Referenced by findGlobalMember(), findMember(), findScopeFromQualifiedName(), getResolvedClassRec(), getResolvedSymbol(), isAccessibleFrom(), and isAccessibleFromWithExpScope().

{ 
  //printf("%p: FileDef::getUsedNamespace: %s:%d\n",this,name().data(),usingDirList?usingDirList->count():0);
  return m_usingDirList; 
}

QCString FileDef::getVersion ( ) const

inline

Returns version of this file.

Definition at line 112 of file filedef.h.

References m_fileVersion.

Referenced by format_warn(), ClassDef::showUsedFiles(), and FileContext::Private::versionInfo().

{ return m_fileVersion; }

bool FileDef::hasDetailedDescription ( ) const

Definition at line 179 of file filedef.cpp.

References Definition::briefDescription(), Config_getBool, Definition::documentation(), Definition::getBodyDef(), and Definition::getStartBodyLine().

Referenced by FileContext::Private::hasDetails(), and writeDetailedDescription().

{
  static bool repeatBrief = Config_getBool(REPEAT_BRIEF);
  static bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
  return ((!briefDescription().isEmpty() && repeatBrief) || 
          !documentation().stripWhiteSpace().isEmpty() || // avail empty section
          (sourceBrowser && getStartBodyLine()!=-1 && getBodyDef())
         );
}

QCString FileDef::includedByDependencyGraphFileName ( ) const

Definition at line 1936 of file filedef.cpp.

References m_inclByDepFileName.

Referenced by DotInclDepGraph::DotInclDepGraph().

{
  return m_inclByDepFileName;
}

QList<IncludeInfo>* FileDef::includedByFileList ( ) const

inline

Definition at line 124 of file filedef.h.

References m_includedByList.

Referenced by DotInclDepGraph::buildGraph(), PerlModGenerator::generatePerlModForFile(), and generateXMLForFile().

{ return m_includedByList; }

QCString FileDef::includeDependencyGraphFileName ( ) const

Definition at line 1931 of file filedef.cpp.

References m_inclDepFileName.

Referenced by DotInclDepGraph::DotInclDepGraph().

{
  return m_inclDepFileName;
}

QList<IncludeInfo>* FileDef::includeFileList ( ) const

inline

Definition at line 123 of file filedef.h.

References m_includeList.

Referenced by DotInclDepGraph::buildGraph(), DirDef::computeDependencies(), generateDocbookForFile(), PerlModGenerator::generatePerlModForFile(), generateXMLForFile(), getAllIncludeFilesRecursively(), and FileContext::Private::includeList().

{ return m_includeList; }

QCString FileDef::includeName ( ) const

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

Definition at line 1795 of file filedef.cpp.

References getSourceFileBase().

Referenced by DirDef::writeFileList(), writeIncludeFiles(), ClassDef::writeIncludeFiles(), writeSingleFileIndex(), and writeSourceLink().

{ 
  return getSourceFileBase();
}

void FileDef::insertClass ( ClassDef * cd )

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

Definition at line 1160 of file filedef.cpp.

References SDict< T >::append(), Config_getBool, SDict< T >::inSort(), Definition::isHidden(), m_classSDict, and Definition::name().

Referenced by addClassToContext(), and createTagLessInstance().

{
  if (cd->isHidden()) return;
  if (m_classSDict==0)
  {
    m_classSDict = new ClassSDict(17);
  }
  if (Config_getBool(SORT_BRIEF_DOCS))
  {
    m_classSDict->inSort(cd->name(),cd);
  }
  else
  {
    m_classSDict->append(cd->name(),cd);
  }
}

void FileDef::insertMember ( MemberDef * md )

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

Definition at line 1106 of file filedef.cpp.

Referenced by addVariableToFile(), buildFunctionList(), and findEnums().

{
  if (md->isHidden()) return;
  //printf("%s:FileDef::insertMember(%s (=%p) list has %d elements)\n",
  //    name().data(),md->name().data(),md,allMemberList.count());
  MemberList *allMemberList = getMemberList(MemberListType_allMembersList);
  if (allMemberList && allMemberList->findRef(md)!=-1)  // TODO optimize the findRef!
  { 
    return;
  }
  if (allMemberList==0)
  {
    allMemberList = new MemberList(MemberListType_allMembersList);
    m_memberLists.append(allMemberList);
  }
  allMemberList->append(md); 
  //::addFileMemberNameToIndex(md);
  switch (md->memberType())
  {
    case MemberType_Variable:     
    case MemberType_Property:     
      addMemberToList(MemberListType_decVarMembers,md);
      addMemberToList(MemberListType_docVarMembers,md);
      break;
    case MemberType_Function: 
      addMemberToList(MemberListType_decFuncMembers,md);
      addMemberToList(MemberListType_docFuncMembers,md);
      break;
    case MemberType_Typedef:      
      addMemberToList(MemberListType_decTypedefMembers,md);
      addMemberToList(MemberListType_docTypedefMembers,md);
      break;
    case MemberType_Enumeration:  
      addMemberToList(MemberListType_decEnumMembers,md);
      addMemberToList(MemberListType_docEnumMembers,md);
      break;
    case MemberType_EnumValue:    // enum values are shown inside their enums
      break;
    case MemberType_Define:       
      addMemberToList(MemberListType_decDefineMembers,md);
      addMemberToList(MemberListType_docDefineMembers,md);
      break;
    default:
       err("FileDef::insertMembers(): "
           "member `%s' with class scope `%s' inserted in file scope `%s'!\n",
           md->name().data(),
           md->getClassDef() ? md->getClassDef()->name().data() : "<global>",
           name().data());
  }
  //addMemberToGroup(md,groupId);
}

void FileDef::insertNamespace ( NamespaceDef * nd )

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

Definition at line 1178 of file filedef.cpp.

References SDict< T >::append(), Config_getBool, SDict< T >::find(), SDict< T >::inSort(), Definition::isHidden(), m_namespaceSDict, and Definition::name().

Referenced by buildNamespaceList().

{
  if (nd->isHidden()) return;
  if (!nd->name().isEmpty() && 
      (m_namespaceSDict==0 || m_namespaceSDict->find(nd->name())==0))
  {
    if (m_namespaceSDict==0)
    {
      m_namespaceSDict = new NamespaceSDict;
    }
    if (Config_getBool(SORT_BRIEF_DOCS))
    {
      m_namespaceSDict->inSort(nd->name(),nd);
    }
    else
    {
      m_namespaceSDict->append(nd->name(),nd);
    }
  }
}

bool FileDef::isDocumentationFile ( ) const

Definition at line 1734 of file filedef.cpp.

References name().

Referenced by FileListContext::Private::addFiles(), buildDirectories(), fileVisibleInIndex(), writeSingleFileIndex(), and writeSource().

{
  return name().right(4)==".doc" ||
         name().right(4)==".txt" ||
         name().right(4)==".dox" ||
         name().right(3)==".md"  ||
         name().right(9)==".markdown";
}

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

Definition at line 1396 of file filedef.cpp.

References m_includeDict.

{
  if (name.isEmpty()) return FALSE;
  return m_includeDict!=0 && m_includeDict->find(name)!=0;
}

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.

Definition at line 116 of file filedef.h.

References isLinkableInProject(), and Definition::isReference().

Referenced by MemberDef::_writeGroupInclude(), addMemberToSearchIndex(), DotInclDepGraph::buildGraph(), DirDef::computeDependencies(), createJavascriptSearchIndex(), fileVisibleInIndex(), findMembersWithSpecificName(), generateFileRef(), getDefs(), resolveLink(), ClassDef::showUsedFiles(), DirDef::writeFileList(), writeIncludeFiles(), writePartialFilePath(), writeSource(), and writeTagFile().

{ return isLinkableInProject() || isReference(); }

bool FileDef::isLinkableInProject ( ) const

virtual

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

Implements Definition.

Definition at line 1888 of file filedef.cpp.

References Config_getBool, Definition::hasDocumentation(), Definition::isLinkableViaGroup(), and Definition::isReference().

Referenced by MemberDef::_computeLinkableInProject(), addFileMemberNameToIndex(), FileListContext::Private::addFiles(), RTFGenerator::endIndexSection(), LatexGenerator::endIndexSection(), fileVisibleInIndex(), generateFileDocs(), GlobalsIndexContext::Private::getMembersFiltered(), ClassDef::isEmbeddedInOuterScope(), isLinkable(), RTFGenerator::startIndexSection(), LatexGenerator::startIndexSection(), writeSingleFileIndex(), GroupDef::writeTagFile(), and writeTagFile().

{
  static bool showFiles = Config_getBool(SHOW_FILES);
  return hasDocumentation() && !isReference() && (showFiles || isLinkableViaGroup());
}

bool FileDef::isSource ( ) const

inline

Returns TRUE if this file is a source file.

Definition at line 101 of file filedef.h.

References m_isSource.

Referenced by generateFileSources(), and parseFiles().

{ return m_isSource; }

QCString FileDef::name ( ) const

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

Definition at line 1199 of file filedef.cpp.

References Config_getBool, m_fileName, and Definition::name().

Referenced by addIncludeFile(), DocSets::addIndexItem(), addListReferences(), DefinitionContext< T >::Cachable< NamespaceContext::Private >::Cachable(), MemberName::compareValues(), MemberNameInfo::compareValues(), FilePairDict::compareValues(), FileList::compareValues(), createJavascriptSearchIndex(), displayName(), FileDef(), findAndCopyImage(), VhdlDocGen::findConstraintFile(), findUsingDeclarations(), generateDEFForFile(), generateDocbook(), generateDocbookForFile(), PerlModGenerator::generatePerlModForFile(), PerlModGenerator::generatePerlModForGroup(), generateSourceFile(), generateXML(), generateXMLForFile(), getDefs(), insertMember(), isDocumentationFile(), isVarWithConstructor(), ClassDef::showUsedFiles(), title(), writeDetailedDescription(), writeDirHierarchy(), writeDirTreeNode(), writeDocumentation(), writeFileLinkForMember(), DirDef::writeFileList(), GroupDef::writeFiles(), writeIncludedByGraph(), writeIncludeGraph(), writeInnerFiles(), writeMemberDocumentation(), writeMemberPages(), writePartialFilePath(), writeSingleFileIndex(), writeSource(), Definition::writeSourceDef(), GroupDef::writeTagFile(), DirDef::writeTagFile(), writeTagFile(), and TooltipManager::writeTooltips().

{ 
  if (Config_getBool(FULL_PATH_NAMES)) 
    return m_fileName; 
  else 
    return Definition::name(); 
} 

PackageDef* FileDef::packageDef ( ) const

inline

Definition at line 119 of file filedef.h.

References m_package.

{ return m_package; }

void FileDef::parseSource	(	bool	sameTu,
		QStrList &	filesInSameTu
	)

Definition at line 1033 of file filedef.cpp.

References absFilePath(), Config_getBool, fileToString(), Definition::getDefFileExtension(), Definition::getLanguage(), ParserManager::getParser(), ClangParser::instance(), ParserInterface::parseCode(), Doxygen::parserManager, ParserInterface::resetCodeParserState(), SrcLangExt_Cpp, SrcLangExt_ObjC, ClangParser::start(), ClangParser::switchToFile(), and ClangParser::writeSources().

Referenced by generateFileSources().

{
  static bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
  DevNullCodeDocInterface devNullIntf;
  (void)sameTu;
  (void)filesInSameTu;
#if USE_LIBCLANG
  static bool clangAssistedParsing = Config_getBool(CLANG_ASSISTED_PARSING);
  if (clangAssistedParsing && 
      (getLanguage()==SrcLangExt_Cpp || getLanguage()==SrcLangExt_ObjC))
  {
    if (!sameTu)
    {
      ClangParser::instance()->start(absFilePath(),filesInSameTu);
    }
    else
    {
      ClangParser::instance()->switchToFile(absFilePath());
    }
    ClangParser::instance()->writeSources(devNullIntf,this);
  }
  else
#endif
  {
    ParserInterface *pIntf = Doxygen::parserManager->getParser(getDefFileExtension());
    pIntf->resetCodeParserState();
    pIntf->parseCode(
            devNullIntf,0,
            fileToString(absFilePath(),filterSourceFiles,TRUE),
            getLanguage(),
            FALSE,0,this
           );
  }
}

void FileDef::setDirDef ( DirDef * dd )

inline

Definition at line 163 of file filedef.h.

References m_dir.

Referenced by DirDef::addFile().

{ m_dir=dd; }

void FileDef::setDiskName ( const QCString & name )

Definition at line 127 of file filedef.cpp.

References convertNameToFile(), m_inclByDepFileName, m_inclDepFileName, and m_outputDiskName.

Referenced by FileDef(), and FileName::generateDiskNames().

{
  m_outputDiskName = convertNameToFile(name);
  m_inclDepFileName = convertNameToFile(name+"_incl");
  m_inclByDepFileName = convertNameToFile(name+"_dep_incl");
}

void FileDef::setPackageDef ( PackageDef * pd )

inline

Definition at line 162 of file filedef.h.

References m_package.

{ m_package=pd; }

void FileDef::sortMemberLists ( )

Definition at line 1840 of file filedef.cpp.

References m_memberLists, MemberList::needsSorting(), MemberList::setNeedsSorting(), and MemberList::sort().

Referenced by sortMemberLists().

{
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (;(ml=mli.current());++mli)
  {
    if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(FALSE); }
  }
}

void FileDef::startMemberDeclarations ( OutputList & ol )

private

Definition at line 558 of file filedef.cpp.

References OutputList::startMemberSections().

Referenced by writeDocumentation().

{
  ol.startMemberSections();
}

void FileDef::startMemberDocumentation ( OutputList & ol )

private

Definition at line 568 of file filedef.cpp.

References Config_getBool, OutputList::disable(), OutputGenerator::Html, and Doxygen::suppressDocWarnings.

Referenced by writeDocumentation().

{
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    ol.disable(OutputGenerator::Html);
    Doxygen::suppressDocWarnings = TRUE;
  }
}

void FileDef::startParsing ( )

Definition at line 1068 of file filedef.cpp.

Referenced by generateFileSources().

{

}

bool FileDef::subGrouping ( ) const

inline

Definition at line 139 of file filedef.h.

References m_subGrouping.

Referenced by FileContext::Private::memberGroups().

{ return m_subGrouping; }

QCString FileDef::title ( ) const

Definition at line 1921 of file filedef.cpp.

References name(), theTranslator, and Translator::trFileReference().

Referenced by FileContext::Private::title(), writeDocumentation(), and writeSource().

{
  return theTranslator->trFileReference(name());
}

void FileDef::writeAuthorSection ( OutputList & ol )

private

Definition at line 605 of file filedef.cpp.

References Config_getString, OutputList::disableAllBut(), OutputList::endGroupHeader(), OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startGroupHeader(), theTranslator, Translator::trAuthor(), and Translator::trGeneratedAutomatically().

Referenced by writeDocumentation().

{
  // write Author section (Man only)
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Man);
  ol.startGroupHeader();
  ol.parseText(theTranslator->trAuthor(TRUE,TRUE));
  ol.endGroupHeader();
  ol.parseText(theTranslator->trGeneratedAutomatically(Config_getString(PROJECT_NAME)));
  ol.popGeneratorState();
}

void FileDef::writeBriefDescription ( OutputList & ol )

private

Definition at line 366 of file filedef.cpp.

References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), Definition::documentation(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), OutputGenerator::Html, DocRoot::isEmpty(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, Translator::trMore(), validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString(), and OutputList::writeSynopsis().

Referenced by writeDocumentation().

{
  if (!briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
  {
    DocRoot *rootNode = validatingParseDoc(briefFile(),briefLine(),this,0,
                       briefDescription(),TRUE,FALSE,0,TRUE,FALSE);
    if (rootNode && !rootNode->isEmpty())
    {
      ol.startParagraph();
      ol.writeDoc(rootNode,this,0);
      ol.pushGeneratorState();
      ol.disable(OutputGenerator::RTF);
      ol.writeString(" \n");
      ol.enable(OutputGenerator::RTF);
      if (Config_getBool(REPEAT_BRIEF) ||
          !documentation().isEmpty()
         )
      {
        ol.disableAllBut(OutputGenerator::Html);
        ol.startTextLink(0,"details");
        ol.parseText(theTranslator->trMore());
        ol.endTextLink();
      }
      ol.popGeneratorState();
      ol.endParagraph();
    }
    delete rootNode;
  }
  ol.writeSynopsis();
}

void FileDef::writeClassDeclarations	(	OutputList &	ol,
		const QCString &	title
	)

private

Definition at line 539 of file filedef.cpp.

References m_classSDict, and ClassSDict::writeDeclaration().

Referenced by writeDocumentation().

{
  // write list of classes
  if (m_classSDict) m_classSDict->writeDeclaration(ol,0,title,FALSE);
}

void FileDef::writeDetailedDescription	(	OutputList &	ol,
		const QCString &	title
	)

private

Definition at line 295 of file filedef.cpp.

References Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), Definition::docFile(), Definition::docLine(), Definition::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), OutputList::endParagraph(), OutputList::endTextBlock(), OutputList::generateDoc(), getSourceFileBase(), hasDetailedDescription(), OutputGenerator::Html, OutputList::isEnabled(), OutputGenerator::Latex, OutputGenerator::Man, name(), OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startGroupHeader(), OutputList::startParagraph(), OutputList::startTextBlock(), theTranslator, Translator::trDefinedInSourceFile(), OutputList::writeAnchor(), OutputList::writeObjectLink(), OutputList::writeRuler(), and OutputList::writeString().

Referenced by writeDocumentation().

{
  if (hasDetailedDescription())
  {
    ol.pushGeneratorState();
      ol.disable(OutputGenerator::Html);
      ol.writeRuler();
    ol.popGeneratorState();
    ol.pushGeneratorState();
      ol.disableAllBut(OutputGenerator::Html);
      ol.writeAnchor(0,"details"); 
    ol.popGeneratorState();
    ol.startGroupHeader();
    ol.parseText(title);
    ol.endGroupHeader();
    ol.startTextBlock();
    if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
    {
      ol.generateDoc(briefFile(),briefLine(),this,0,briefDescription(),FALSE,FALSE);
    }
    if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF) && 
        !documentation().isEmpty())
    {
      ol.pushGeneratorState();
        ol.disable(OutputGenerator::Man);
        ol.disable(OutputGenerator::RTF);
        // ol.newParagraph(); // FIXME:PARA
        ol.enableAll();
        ol.disableAllBut(OutputGenerator::Man);
        ol.enable(OutputGenerator::Latex);
        ol.writeString("\n\n");
      ol.popGeneratorState();
    }
    if (!documentation().isEmpty())
    {
      ol.generateDoc(docFile(),docLine(),this,0,documentation()+"\n",TRUE,FALSE);
    }
    //printf("Writing source ref for file %s\n",name().data());
    if (Config_getBool(SOURCE_BROWSER)) 
    {
      //if Latex enabled and LATEX_SOURCE_CODE isn't -> skip, bug_738548
      ol.pushGeneratorState();
      if (ol.isEnabled(OutputGenerator::Latex) && !Config_getBool(LATEX_SOURCE_CODE))
      { 
        ol.disable(OutputGenerator::Latex);
      }
      if (ol.isEnabled(OutputGenerator::RTF) && !Config_getBool(RTF_SOURCE_CODE))
      { 
        ol.disable(OutputGenerator::RTF);
      }
      ol.startParagraph();
      QCString refText = theTranslator->trDefinedInSourceFile();
      int fileMarkerPos = refText.find("@0");
      if (fileMarkerPos!=-1) // should always pass this.
      {
        ol.parseText(refText.left(fileMarkerPos)); //text left from marker 1
        ol.writeObjectLink(0,getSourceFileBase(),
            0,name());
        ol.parseText(refText.right(
              refText.length()-fileMarkerPos-2)); // text right from marker 2
      }
      ol.endParagraph();
      //Restore settings, bug_738548
      ol.popGeneratorState();
    }
    ol.endTextBlock();
  }
}

void FileDef::writeDocumentation ( OutputList & ol )

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

Definition at line 660 of file filedef.cpp.

Referenced by generateFileDocs().

{
  static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  //funcList->countDecMembers();
  
  //QCString fn = name();
  //if (Config_getBool(FULL_PATH_NAMES))
  //{
  //  fn.prepend(stripFromPath(getPath().copy()));
  //}
  //printf("WriteDocumentation diskname=%s\n",diskname.data());
  
  QCString versionTitle;
  if (!m_fileVersion.isEmpty())
  {
    versionTitle=("("+m_fileVersion+")");
  }
  QCString title = m_docname+versionTitle;
  QCString pageTitle=theTranslator->trFileReference(m_docname);
  if (getDirDef())
  {
    startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_FileVisible,!generateTreeView);
    if (!generateTreeView)
    {
      getDirDef()->writeNavigationPath(ol);
      ol.endQuickIndices();
    }
    QCString pageTitleShort=theTranslator->trFileReference(name());
    startTitle(ol,getOutputFileBase(),this);
    ol.pushGeneratorState();
      ol.disableAllBut(OutputGenerator::Html);
      ol.parseText(pageTitleShort); // Html only
      ol.enableAll();
      ol.disable(OutputGenerator::Html);
      ol.parseText(pageTitle); // other output formats
    ol.popGeneratorState();
    addGroupListToTitle(ol,this);
    endTitle(ol,getOutputFileBase(),title);
  }
  else
  {
    startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_FileVisible,!generateTreeView);
    if (!generateTreeView)
    {
      ol.endQuickIndices();
    }
    startTitle(ol,getOutputFileBase(),this);
    ol.parseText(pageTitle);
    addGroupListToTitle(ol,this);
    endTitle(ol,getOutputFileBase(),title);
  }
  ol.startContents();
  if (!m_fileVersion.isEmpty())
  {
    ol.disableAllBut(OutputGenerator::Html);
    ol.startProjectNumber();
    ol.docify(versionTitle);
    ol.endProjectNumber();
    ol.enableAll();
  }
  
  if (Doxygen::searchIndex)
  {
    Doxygen::searchIndex->setCurrentDoc(this,anchor(),FALSE);
    Doxygen::searchIndex->addWord(localName(),TRUE);
  }
  
  //---------------------------------------- start flexible part -------------------------------
  
  SrcLangExt lang = getLanguage();
  QListIterator<LayoutDocEntry> eli(
      LayoutDocManager::instance().docEntries(LayoutDocManager::File));
  LayoutDocEntry *lde;
  for (eli.toFirst();(lde=eli.current());++eli)
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::BriefDesc: 
        writeBriefDescription(ol);
        break; 
      case LayoutDocEntry::MemberDeclStart: 
        startMemberDeclarations(ol);
        break; 
      case LayoutDocEntry::FileIncludes:
        writeIncludeFiles(ol);
        break;
      case LayoutDocEntry::FileIncludeGraph:
        writeIncludeGraph(ol);
        break;
      case LayoutDocEntry::FileIncludedByGraph:
        writeIncludedByGraph(ol);
        break;
      case LayoutDocEntry::FileSourceLink:
        writeSourceLink(ol);
        break;
      case LayoutDocEntry::FileClasses: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeClassDeclarations(ol,ls->title(lang));
        }
        break; 
      case LayoutDocEntry::FileNamespaces: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeNamespaceDeclarations(ol,ls->title(lang),false);
        }
        break; 
      case LayoutDocEntry::FileConstantGroups:
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeNamespaceDeclarations(ol,ls->title(lang),true);
        }
        break;
      case LayoutDocEntry::MemberGroups: 
        writeMemberGroups(ol);
        break; 
      case LayoutDocEntry::MemberDecl: 
        {
          LayoutDocEntryMemberDecl *lmd = (LayoutDocEntryMemberDecl*)lde;
          writeMemberDeclarations(ol,lmd->type,lmd->title(lang));
        }
        break; 
      case LayoutDocEntry::MemberDeclEnd: 
        endMemberDeclarations(ol);
        break;
      case LayoutDocEntry::DetailedDesc: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeDetailedDescription(ol,ls->title(lang));
        }
        break;
      case LayoutDocEntry::MemberDefStart: 
        startMemberDocumentation(ol);
        break; 
      case LayoutDocEntry::FileInlineClasses:
        writeInlineClasses(ol);
        break;
      case LayoutDocEntry::MemberDef: 
        {
          LayoutDocEntryMemberDef *lmd = (LayoutDocEntryMemberDef*)lde;
          writeMemberDocumentation(ol,lmd->type,lmd->title(lang));
        }
        break;
      case LayoutDocEntry::MemberDefEnd: 
        endMemberDocumentation(ol);
        break;
      case LayoutDocEntry::AuthorSection: 
        writeAuthorSection(ol);
        break;
      case LayoutDocEntry::ClassIncludes:
      case LayoutDocEntry::ClassInheritanceGraph:
      case LayoutDocEntry::ClassNestedClasses:
      case LayoutDocEntry::ClassCollaborationGraph:
      case LayoutDocEntry::ClassAllMembersLink:
      case LayoutDocEntry::ClassUsedFiles:
      case LayoutDocEntry::ClassInlineClasses:
      case LayoutDocEntry::NamespaceNestedNamespaces:
      case LayoutDocEntry::NamespaceNestedConstantGroups:
      case LayoutDocEntry::NamespaceClasses:
      case LayoutDocEntry::NamespaceInlineClasses:
      case LayoutDocEntry::GroupClasses: 
      case LayoutDocEntry::GroupInlineClasses: 
      case LayoutDocEntry::GroupNamespaces:
      case LayoutDocEntry::GroupDirs: 
      case LayoutDocEntry::GroupNestedGroups: 
      case LayoutDocEntry::GroupFiles:
      case LayoutDocEntry::GroupGraph: 
      case LayoutDocEntry::GroupPageDocs:
      case LayoutDocEntry::DirSubDirs:
      case LayoutDocEntry::DirFiles:
      case LayoutDocEntry::DirGraph:
        err("Internal inconsistency: member %d should not be part of "
            "LayoutDocManager::File entry list\n",lde->kind());
        break;
    }
  }
  //---------------------------------------- end flexible part -------------------------------
  ol.endContents();
  endFileWithNavPath(this,ol);
  if (Config_getBool(SEPARATE_MEMBER_PAGES))
  {
    MemberList *ml = getMemberList(MemberListType_allMembersList);
    if (ml) ml->sort();
    writeMemberPages(ol);
  }
}

void FileDef::writeIncludedByGraph ( OutputList & ol )

private

Definition at line 492 of file filedef.cpp.

References Config_getBool, OutputList::disable(), OutputList::enableAll(), OutputList::endInclDepGraph(), OutputList::endTextBlock(), DotInclDepGraph::isTooBig(), DotInclDepGraph::isTrivial(), OutputGenerator::Man, name(), OutputList::parseText(), OutputList::startInclDepGraph(), OutputList::startTextBlock(), theTranslator, Translator::trInclByDepGraph(), and warn_uncond().

Referenced by writeDocumentation().

{
  if (Config_getBool(HAVE_DOT) /*&& Config_getBool(INCLUDED_BY_GRAPH)*/)
  {
    //printf("Graph for file %s\n",name().data());
    DotInclDepGraph incDepGraph(this,TRUE);
    if (incDepGraph.isTooBig())
    {
       warn_uncond("Included by graph for '%s' not generated, too many nodes. Consider increasing DOT_GRAPH_MAX_NODES.\n",name().data());
    }
    else if (!incDepGraph.isTrivial())
    {
      ol.startTextBlock(); 
      ol.disable(OutputGenerator::Man);
      ol.startInclDepGraph();
      ol.parseText(theTranslator->trInclByDepGraph());
      ol.endInclDepGraph(incDepGraph);
      ol.enableAll();
      ol.endTextBlock(TRUE);
    }
    //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
  }
}

void FileDef::writeIncludeFiles ( OutputList & ol )

private

Definition at line 399 of file filedef.cpp.

References OutputList::disable(), OutputList::disableAllBut(), OutputList::docify(), OutputList::enableAll(), OutputList::endTextBlock(), OutputList::endTypewriter(), IncludeInfo::fileDef, generateSourceFile(), Definition::getLanguage(), getOutputFileBase(), Definition::getReference(), OutputGenerator::Html, IncludeInfo::imported, IncludeInfo::includeName, includeName(), IncludeInfo::indirect, isLinkable(), OutputList::lineBreak(), IncludeInfo::local, m_includeList, SrcLangExt_IDL, SrcLangExt_Java, OutputList::startTextBlock(), OutputList::startTypewriter(), and OutputList::writeObjectLink().

Referenced by writeDocumentation().

{
  if (m_includeList && m_includeList->count()>0)
  {
    ol.startTextBlock(TRUE);
    QListIterator<IncludeInfo> ili(*m_includeList);
    IncludeInfo *ii;
    for (;(ii=ili.current());++ili)
    {
      if (!ii->indirect)
      {
        FileDef *fd=ii->fileDef;
        bool isIDLorJava = FALSE;
        if (fd)
        {
          SrcLangExt lang   = fd->getLanguage();
          isIDLorJava = lang==SrcLangExt_IDL || lang==SrcLangExt_Java;
        }
        ol.startTypewriter();
        if (isIDLorJava) // IDL/Java include
        {
          ol.docify("import ");
        }
        else if (ii->imported) // Objective-C include
        {
          ol.docify("#import ");
        }
        else // C/C++ include
        {
          ol.docify("#include ");
        }
        if (ii->local || isIDLorJava)
          ol.docify("\"");
        else
          ol.docify("<");
        ol.disable(OutputGenerator::Html);
        ol.docify(ii->includeName);
        ol.enableAll();
        ol.disableAllBut(OutputGenerator::Html);
        
        // Here we use the include file name as it appears in the file.
        // we could also we the name as it is used within doxygen,
        // then we should have used fd->docName() instead of ii->includeName
        if (fd && fd->isLinkable())
        {
          ol.writeObjectLink(fd->getReference(),
              fd->generateSourceFile() ? fd->includeName() : fd->getOutputFileBase(),
              0,ii->includeName);
        }
        else
        {
          ol.docify(ii->includeName);
        }
        
        ol.enableAll();
        if (ii->local || isIDLorJava)
          ol.docify("\"");
        else
          ol.docify(">");
        if (isIDLorJava) 
          ol.docify(";");
        ol.endTypewriter();
        ol.lineBreak();
      }
    }
    ol.endTextBlock();
  }
}

void FileDef::writeIncludeGraph ( OutputList & ol )

private

Definition at line 468 of file filedef.cpp.

References Config_getBool, OutputList::disable(), OutputList::enableAll(), OutputList::endInclDepGraph(), OutputList::endTextBlock(), DotInclDepGraph::isTooBig(), DotInclDepGraph::isTrivial(), OutputGenerator::Man, name(), OutputList::parseText(), OutputList::startInclDepGraph(), OutputList::startTextBlock(), theTranslator, Translator::trInclDepGraph(), and warn_uncond().

Referenced by writeDocumentation().

{
  if (Config_getBool(HAVE_DOT) /*&& Config_getBool(INCLUDE_GRAPH)*/)
  {
    //printf("Graph for file %s\n",name().data());
    DotInclDepGraph incDepGraph(this,FALSE);
    if (incDepGraph.isTooBig())
    {
       warn_uncond("Include graph for '%s' not generated, too many nodes. Consider increasing DOT_GRAPH_MAX_NODES.\n",name().data());
    }
    else if (!incDepGraph.isTrivial())
    {
      ol.startTextBlock(); 
      ol.disable(OutputGenerator::Man);
      ol.startInclDepGraph();
      ol.parseText(theTranslator->trInclDepGraph(name()));
      ol.endInclDepGraph(incDepGraph);
      ol.enableAll();
      ol.endTextBlock(TRUE);
    }
    //incDepGraph.writeGraph(Config_getString(HTML_OUTPUT),fd->getOutputFileBase());
  }
}

void FileDef::writeInlineClasses ( OutputList & ol )

private

Definition at line 545 of file filedef.cpp.

References OutputList::disable(), OutputList::enable(), OutputGenerator::Html, OutputList::isEnabled(), m_classSDict, and ClassSDict::writeDocumentation().

Referenced by writeDocumentation().

{
  // temporarily undo the disbling could be done by startMemberDocumentation()
  // as a result of setting SEPARATE_MEMBER_PAGES to YES; see bug730512
  bool isEnabled = ol.isEnabled(OutputGenerator::Html);
  ol.enable(OutputGenerator::Html);
  if (m_classSDict) m_classSDict->writeDocumentation(ol,this);
  // restore the initial state if needed
  if (!isEnabled) ol.disable(OutputGenerator::Html);
}

void FileDef::writeMemberDeclarations	(	OutputList &	ol,
		MemberListType	lt,
		const QCString &	title
	)

private

Definition at line 1864 of file filedef.cpp.

References Config_getBool, getMemberList(), MemberList::writeDeclarations(), and VhdlDocGen::writeVhdlDeclarations().

Referenced by writeDocumentation().

{
  static bool optVhdl = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
  MemberList * ml = getMemberList(lt);
  if (ml) 
  {
    if (optVhdl) // use specific declarations function
    {
      VhdlDocGen::writeVhdlDeclarations(ml,ol,0,0,this,0);
    }
    else
    {
      ml->writeDeclarations(ol,0,0,this,0,title,0);
    }
  }
}

void FileDef::writeMemberDocumentation	(	OutputList &	ol,
		MemberListType	lt,
		const QCString &	title
	)

private

Definition at line 1882 of file filedef.cpp.

References getMemberList(), name(), and MemberList::writeDocumentation().

Referenced by writeDocumentation().

{
  MemberList * ml = getMemberList(lt);
  if (ml) ml->writeDocumentation(ol,name(),this,title);
}

void FileDef::writeMemberGroups ( OutputList & ol )

private

Definition at line 586 of file filedef.cpp.

References MemberGroup::allMembersInSameSection(), MemberGroup::header(), SIntDict< MemberGroup >::Iterator, m_memberGroupSDict, m_subGrouping, SIntDict< T >::sort(), and MemberGroup::writeDeclarations().

Referenced by writeDocumentation().

{
  /* write user defined member groups */
  if (m_memberGroupSDict)
  {
    m_memberGroupSDict->sort();
    MemberGroupSDict::Iterator mgli(*m_memberGroupSDict);
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      if ((!mg->allMembersInSameSection() || !m_subGrouping) 
          && mg->header()!="[NOHEADER]")
      {
        mg->writeDeclarations(ol,0,0,this,0);
      }
    }
  }
}

void FileDef::writeMemberPages ( OutputList & ol )

Definition at line 856 of file filedef.cpp.

References OutputList::disableAllBut(), OutputGenerator::Html, MemberList::listType(), m_memberLists, MemberListType_documentationLists, name(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), and MemberList::writeDocumentationPage().

Referenced by writeDocumentation().

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  
  QListIterator<MemberList> mli(m_memberLists);
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberListType_documentationLists)
    {
      ml->writeDocumentationPage(ol,name(),this);
    }
  }
  ol.popGeneratorState();
}

void FileDef::writeNamespaceDeclarations	(	OutputList &	ol,
		const QCString &	title,
		bool	isConstantGroup
	)

private

Definition at line 532 of file filedef.cpp.

References m_namespaceSDict, and NamespaceSDict::writeDeclaration().

Referenced by writeDocumentation().

{
  // write list of namespaces
  if (m_namespaceSDict) m_namespaceSDict->writeDeclaration(ol,title,isConstantGroup);
}

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

virtual

Reimplemented from Definition.

Definition at line 874 of file filedef.cpp.

References MemberDef::anchor(), Config_getBool, convertToHtml(), createSubDirs(), MemberDef::getFileDef(), getMemberList(), MemberDef::getNamespaceDef(), MemberDef::getOutputFileBase(), Doxygen::htmlFileExtension, MemberDef::isEnumValue(), MemberDef::isLinkable(), MemberDef::isLinkableInProject(), Definition::localName(), MemberListType_allMembersList, and OutputList::writeString().

{
  static bool createSubDirs=Config_getBool(CREATE_SUBDIRS);
  ol.writeString("      <div class=\"navtab\">\n");
  ol.writeString("        <table>\n");
  MemberList *allMemberList = getMemberList(MemberListType_allMembersList);
  if (allMemberList)
  {
    MemberListIterator mli(*allMemberList);
    MemberDef *md;
    for (mli.toFirst();(md=mli.current());++mli)
    {
      if (md->getFileDef()==this && md->getNamespaceDef()==0 && md->isLinkable() && !md->isEnumValue())
      {
        ol.writeString("          <tr><td class=\"navtab\">");
        if (md->isLinkableInProject())
        {
          if (md==currentMd) // selected item => highlight
          {
            ol.writeString("<a class=\"qindexHL\" ");
          }
          else
          {
            ol.writeString("<a class=\"qindex\" ");
          }
          ol.writeString("href=\"");
          if (createSubDirs) ol.writeString("../../");
          ol.writeString(md->getOutputFileBase()+Doxygen::htmlFileExtension+"#"+md->anchor());
          ol.writeString("\">");
          ol.writeString(convertToHtml(md->localName()));
          ol.writeString("</a>");
        }
        ol.writeString("</td></tr>\n");
      }
    }
  }
  ol.writeString("        </table>\n");
  ol.writeString("      </div>\n");
}

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

Write a source listing of this file to the output

Definition at line 918 of file filedef.cpp.

References absFilePath(), Config_getBool, OutputList::disable(), OutputList::enable(), OutputList::enableAll(), OutputList::endCodeFragment(), OutputList::endContents(), endFileWithNavPath(), OutputList::endQuickIndices(), OutputList::endTextLink(), endTitle(), fileToString(), generateSourceFile(), Definition::getDefFileExtension(), getDirDef(), getFileFilter(), Definition::getLanguage(), getOutputFileBase(), ParserManager::getParser(), getSourceFileBase(), HLI_FileVisible, ClangParser::instance(), isDocumentationFile(), isLinkable(), OutputGenerator::Latex, m_docname, m_fileVersion, OutputGenerator::Man, name(), ParserInterface::parseCode(), Doxygen::parserManager, Doxygen::parseSourcesNeeded, OutputList::parseText(), ParserInterface::resetCodeParserState(), OutputGenerator::RTF, SrcLangExt_Cpp, SrcLangExt_ObjC, ClangParser::start(), OutputList::startCodeFragment(), OutputList::startContents(), startFile(), OutputList::startTextLink(), startTitle(), ClangParser::switchToFile(), theTranslator, title(), Translator::trGotoDocumentation(), Translator::trSourceFile(), Definition::writeNavigationPath(), and ClangParser::writeSources().

Referenced by generateFileSources().

{
  static bool generateTreeView  = Config_getBool(GENERATE_TREEVIEW);
  static bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
  static bool latexSourceCode   = Config_getBool(LATEX_SOURCE_CODE);
  static bool rtfSourceCode     = Config_getBool(RTF_SOURCE_CODE);
  DevNullCodeDocInterface devNullIntf;
  QCString title = m_docname;
  if (!m_fileVersion.isEmpty())
  {
    title+=(" ("+m_fileVersion+")");
  }
  QCString pageTitle = theTranslator->trSourceFile(title);
  ol.disable(OutputGenerator::Man);
  if (!latexSourceCode) ol.disable(OutputGenerator::Latex);
  if (!rtfSourceCode) ol.disable(OutputGenerator::RTF);
  bool isDocFile = isDocumentationFile();
  bool genSourceFile = !isDocFile && generateSourceFile();
  if (getDirDef())
  {
    startFile(ol,getSourceFileBase(),0,pageTitle,HLI_FileVisible,
        !generateTreeView,
        !isDocFile && genSourceFile ? QCString() : getOutputFileBase());
    if (!generateTreeView)
    {
      getDirDef()->writeNavigationPath(ol);
      ol.endQuickIndices();
    }
    startTitle(ol,getSourceFileBase());
    ol.parseText(name());
    endTitle(ol,getSourceFileBase(),title);
  }
  else
  {
    startFile(ol,getSourceFileBase(),0,pageTitle,HLI_FileVisible,FALSE,
        !isDocFile && genSourceFile ? QCString() : getOutputFileBase());
    startTitle(ol,getSourceFileBase());
    ol.parseText(title);
    endTitle(ol,getSourceFileBase(),0);
  }
  ol.startContents();
  if (isLinkable())
  {
    if (latexSourceCode) ol.disable(OutputGenerator::Latex);
    if (rtfSourceCode) ol.disable(OutputGenerator::RTF);
    ol.startTextLink(getOutputFileBase(),0);
    ol.parseText(theTranslator->trGotoDocumentation());
    ol.endTextLink();
    if (latexSourceCode) ol.enable(OutputGenerator::Latex);
    if (rtfSourceCode) ol.enable(OutputGenerator::RTF);
  }
  (void)sameTu;
  (void)filesInSameTu;
#if USE_LIBCLANG
  static bool clangAssistedParsing = Config_getBool(CLANG_ASSISTED_PARSING);
  if (clangAssistedParsing && 
      (getLanguage()==SrcLangExt_Cpp || getLanguage()==SrcLangExt_ObjC))
  {
    ol.startCodeFragment();
    if (!sameTu)
    {
      ClangParser::instance()->start(absFilePath(),filesInSameTu);
    }
    else
    {
      ClangParser::instance()->switchToFile(absFilePath());
    }
    ClangParser::instance()->writeSources(ol,this);
    ol.endCodeFragment();
  }
  else
#endif
  {
    ParserInterface *pIntf = Doxygen::parserManager->getParser(getDefFileExtension());
    pIntf->resetCodeParserState();
    ol.startCodeFragment();
    bool needs2PassParsing = 
        Doxygen::parseSourcesNeeded &&                // we need to parse (filtered) sources for cross-references
        !filterSourceFiles &&                         // but user wants to show sources as-is
        !getFileFilter(absFilePath(),TRUE).isEmpty(); // and there is a filter used while parsing
    if (needs2PassParsing)
    {
      // parse code for cross-references only (see bug707641)
      pIntf->parseCode(devNullIntf,0,
                       fileToString(absFilePath(),TRUE,TRUE),
                       getLanguage(),
                       FALSE,0,this
                      );
    }
    pIntf->parseCode(ol,0,
        fileToString(absFilePath(),filterSourceFiles,TRUE),
        getLanguage(),      // lang
        FALSE,              // isExampleBlock
        0,                  // exampleName
        this,               // fileDef
        -1,                 // startLine
        -1,                 // endLine
        FALSE,              // inlineFragment
        0,                  // memberDef
        TRUE,               // showLineNumbers
        0,                  // searchCtx
        !needs2PassParsing  // collectXRefs
        );
    ol.endCodeFragment();
  }
  ol.endContents();
  endFileWithNavPath(this,ol);
  ol.enableAll();
}

void FileDef::writeSourceLink ( OutputList & ol )

private

Definition at line 517 of file filedef.cpp.

References OutputList::disableAllBut(), OutputList::enableAll(), OutputList::endParagraph(), OutputList::endTextLink(), generateSourceFile(), OutputGenerator::Html, includeName(), OutputList::parseText(), OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, and Translator::trGotoSourceCode().

Referenced by writeDocumentation().

{
  //printf("%s: generateSourceFile()=%d\n",name().data(),generateSourceFile());
  if (generateSourceFile())
  {
    ol.disableAllBut(OutputGenerator::Html);
    ol.startParagraph();
    ol.startTextLink(includeName(),0);
    ol.parseText(theTranslator->trGotoSourceCode());
    ol.endTextLink();
    ol.endParagraph();
    ol.enableAll();
  }
}

void FileDef::writeSummaryLinks ( OutputList & ol )

virtual

Reimplemented from Definition.

Definition at line 617 of file filedef.cpp.

References ClassSDict::declVisible(), MemberList::declVisible(), NamespaceSDict::declVisible(), OutputList::disableAllBut(), LayoutDocManager::File, LayoutDocEntry::FileClasses, LayoutDocEntry::FileNamespaces, Definition::getLanguage(), getMemberList(), OutputGenerator::Html, LayoutDocManager::instance(), LayoutDocEntry::kind(), MemberList::listType(), MemberList::listTypeAsString(), m_classSDict, m_namespaceSDict, LayoutDocEntry::MemberDecl, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), LayoutDocEntrySection::title(), LayoutDocEntryMemberDecl::title(), LayoutDocEntryMemberDecl::type, OutputList::writeString(), and OutputList::writeSummaryLink().

{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  QListIterator<LayoutDocEntry> eli(
      LayoutDocManager::instance().docEntries(LayoutDocManager::File));
  LayoutDocEntry *lde;
  bool first=TRUE;
  SrcLangExt lang=getLanguage();
  for (eli.toFirst();(lde=eli.current());++eli)
  {
    if ((lde->kind()==LayoutDocEntry::FileClasses && 
         m_classSDict && m_classSDict->declVisible()) || 
        (lde->kind()==LayoutDocEntry::FileNamespaces && 
         m_namespaceSDict && m_namespaceSDict->declVisible())
       )
    {
      LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
      QCString label = lde->kind()==LayoutDocEntry::FileClasses ? "nested-classes" : "namespaces";
      ol.writeSummaryLink(0,label,ls->title(lang),first);
      first=FALSE;
    }
    else if (lde->kind()==LayoutDocEntry::MemberDecl)
    {
      LayoutDocEntryMemberDecl *lmd = (LayoutDocEntryMemberDecl*)lde;
      MemberList * ml = getMemberList(lmd->type);
      if (ml && ml->declVisible())
      {
        ol.writeSummaryLink(0,MemberList::listTypeAsString(ml->listType()),lmd->title(lang),first);
        first=FALSE;
      }
    }
  }
  if (!first)
  {
    ol.writeString("  </div>\n");
  }
  ol.popGeneratorState();
}

void FileDef::writeTagFile ( FTextStream & t )

Definition at line 189 of file filedef.cpp.

References ClassDef::compoundTypeString(), convertToXML(), endl(), LayoutDocManager::File, LayoutDocEntry::FileClasses, IncludeInfo::fileDef, LayoutDocEntry::FileNamespaces, Definition::getLanguage(), getMemberList(), getOutputFileBase(), getPath(), IncludeInfo::imported, IncludeInfo::includeName, IncludeInfo::indirect, LayoutDocManager::instance(), isLinkable(), NamespaceDef::isLinkableInProject(), ClassDef::isLinkableInProject(), Definition::isReference(), SIntDict< MemberGroup >::Iterator, LayoutDocEntry::kind(), IncludeInfo::local, m_classSDict, m_includeList, m_memberGroupSDict, m_namespaceSDict, LayoutDocEntry::MemberDecl, LayoutDocEntry::MemberGroups, name(), Definition::name(), SrcLangExt_IDL, SrcLangExt_Java, LayoutDocEntryMemberDecl::type, Definition::writeDocAnchorsToTagFile(), MemberGroup::writeTagFile(), and MemberList::writeTagFile().

Referenced by writeTagFile().

{
  tagFile << "  <compound kind=\"file\">" << endl;
  tagFile << "    <name>" << convertToXML(name()) << "</name>" << endl;
  tagFile << "    <path>" << convertToXML(getPath()) << "</path>" << endl;
  tagFile << "    <filename>" << convertToXML(getOutputFileBase()) << "</filename>" << endl;
  if (m_includeList && m_includeList->count()>0)
  {
    QListIterator<IncludeInfo> ili(*m_includeList);
    IncludeInfo *ii;
    for (;(ii=ili.current());++ili)
    {
      if (!ii->indirect)
      {
        FileDef *fd=ii->fileDef;
        if (fd && fd->isLinkable() && !fd->isReference()) 
        {
          bool isIDLorJava = FALSE;
          SrcLangExt lang = fd->getLanguage();
          isIDLorJava = lang==SrcLangExt_IDL || lang==SrcLangExt_Java;
          const char *locStr = (ii->local    || isIDLorJava) ? "yes" : "no";
          const char *impStr = (ii->imported || isIDLorJava) ? "yes" : "no";
          tagFile << "    <includes id=\"" 
                  << convertToXML(fd->getOutputFileBase()) << "\" "
                  << "name=\"" << convertToXML(fd->name()) << "\" "
                  << "local=\"" << locStr << "\" "
                  << "imported=\"" << impStr << "\">"
                  << convertToXML(ii->includeName)
                  << "</includes>" 
                  << endl;
        }
      }
    }
  }
  QListIterator<LayoutDocEntry> eli(
      LayoutDocManager::instance().docEntries(LayoutDocManager::File));
  LayoutDocEntry *lde;
  for (eli.toFirst();(lde=eli.current());++eli)
  {
    switch (lde->kind())
    {
      case LayoutDocEntry::FileClasses:
        {
          if (m_classSDict)
          {
            SDict<ClassDef>::Iterator ci(*m_classSDict);
            ClassDef *cd;
            for (ci.toFirst();(cd=ci.current());++ci)
            {
              if (cd->isLinkableInProject())
              {
                tagFile << "    <class kind=\"" << cd->compoundTypeString() <<
                  "\">" << convertToXML(cd->name()) << "</class>" << endl;
              }
            }
          }
        }
        break;
      case LayoutDocEntry::FileNamespaces:
        {
          if (m_namespaceSDict)
          {
            SDict<NamespaceDef>::Iterator ni(*m_namespaceSDict);
            NamespaceDef *nd;
            for (ni.toFirst();(nd=ni.current());++ni)
            {
              if (nd->isLinkableInProject())
              {
                tagFile << "    <namespace>" << convertToXML(nd->name()) << "</namespace>" << endl;
              }
            }
          }
        }
        break;
      case LayoutDocEntry::MemberDecl:
        {
          LayoutDocEntryMemberDecl *lmd = (LayoutDocEntryMemberDecl*)lde;
          MemberList * ml = getMemberList(lmd->type);
          if (ml)
          {
            ml->writeTagFile(tagFile);
          }
        }
        break;
      case LayoutDocEntry::MemberGroups:
        {
          if (m_memberGroupSDict)
          {
            MemberGroupSDict::Iterator mgli(*m_memberGroupSDict);
            MemberGroup *mg;
            for (;(mg=mgli.current());++mgli)
            {
              mg->writeTagFile(tagFile);
            }
          }
        }
        break;
      default:
        break;
    }
  }
  writeDocAnchorsToTagFile(tagFile);
  tagFile << "  </compound>" << endl;
}