dirdef.h 文件参考

#include <vector>
#include <map>
#include "qcstring.h"
#include "linkedmap.h"
#include "definition.h"

dirdef.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

类
class	FilePair
	Class representing a pair of FileDef objects 更多...
class	FilePairLinkedMap
	A linked map of file pairs 更多...
class	UsedDir
	Usage information of a directory. 更多...
class	DirDef
	A model of a directory symbol. 更多...
class	DirDef::UsedDirLinkedMap
class	DirRelation
	A usage relation between two directories. 更多...
class	DirLinkedMap
	A linked map of directories 更多...
class	DirList
	A list of directories. 更多...
class	DirRelationLinkedMap

函数
bool	compareDirDefs (const DirDef *item1, const DirDef *item2)
DirDef *	toDirDef (Definition *d)
const DirDef *	toDirDef (const Definition *d)
void	buildDirectories ()
void	generateDirDocs (OutputList &ol)
void	computeDirDependencies ()

函数说明

buildDirectories()

void buildDirectories

(

)

在文件 dirdef.cpp 第 1005 行定义.

{
  // for each input file
  for (const auto &fn : *Doxygen::inputNameLinkedMap)
  {
    for (const auto &fd : *fn)
    {
      if (fd->getReference().isEmpty())
      {
        DirDef *dir;
        if ((dir=Doxygen::dirLinkedMap->find(fd->getPath()))==0) // new directory
        {
          dir = DirDefImpl::mergeDirectoryInTree(fd->getPath());
        }
        if (dir && !fd->isDocumentationFile()) dir->addFile(fd.get());
      }
      else
      {
        // do something for file imported via tag files.
      }
    }
  }
 
  // compute relations between directories => introduce container dirs.
  for (const auto &dir : *Doxygen::dirLinkedMap)
  {
    QCString name = dir->name();
    int i=name.findRev('/',(int)name.length()-2);
    if (i>0)
    {
      DirDef *parent = Doxygen::dirLinkedMap->find(name.left(i+1));
      //if (parent==0) parent=root;
      if (parent)
      {
        parent->addSubDir(dir.get());
        //printf("DirDefImpl::addSubdir(): Adding subdir\n%s to\n%s\n",
        //  qPrint(dir->displayName()), qPrint(parent->displayName()));
      }
    }
  }
 
  // sort the directory contents
  for (const auto &dir : *Doxygen::dirLinkedMap)
  {
    dir->sort();
  }
 
  // short the directories themselves
  std::sort(Doxygen::dirLinkedMap->begin(),
            Doxygen::dirLinkedMap->end(),
            [](const auto &d1,const auto &d2)
            {
              QCString s1 = d1->shortName(), s2 = d2->shortName();
              int i = qstricmp(s1,s2);
              if (i==0) // if sort name are equal, sort on full path
              {
                QCString n1 = d1->name(), n2 = d2->name();
                int n = qstricmp(n1,n2);
                return n < 0;
              }
              return i < 0;
            });
 
  // set the directory count identifier
  int dirCount=0;
  for (const auto &dir : *Doxygen::dirLinkedMap)
  {
    dir->setDirCount(dirCount++);
  }
 
  computeCommonDirPrefix();
}

引用了 DirDef::addFile(), DirDef::addSubDir(), begin(), computeCommonDirPrefix(), Doxygen::dirLinkedMap, end(), LinkedMap< T, Hash, KeyEqual, Map >::find(), QCString::findRev(), Doxygen::inputNameLinkedMap, QCString::left(), QCString::length(), DirDefImpl::mergeDirectoryInTree() , 以及 qstricmp().

被这些函数引用 parseInput().

compareDirDefs()

bool compareDirDefs	(	const DirDef *	item1,
		const DirDef *	item2
	)

在文件 dirdef.cpp 第 1115 行定义.

{
  return qstricmp(item1->shortName(),item2->shortName()) < 0;
}

引用了 qstricmp() , 以及 DirDef::shortName().

被这些函数引用 DirDefImpl::sort() , 以及 GroupDefImpl::sortMemberLists().

computeDirDependencies()

void computeDirDependencies

(

)

在文件 dirdef.cpp 第 1078 行定义.

{
  // compute nesting level for each directory
  for (const auto &dir : *Doxygen::dirLinkedMap)
  {
    dir->setLevel();
  }
 
  // compute uses dependencies between directories
  for (const auto &dir : *Doxygen::dirLinkedMap)
  {
    //printf("computeDependencies for %s: #dirs=%d\n",qPrint(dir->name()),Doxygen::directories.count());
    dir->computeDependencies();
  }
}

引用了 Doxygen::dirLinkedMap.

被这些函数引用 parseInput().

generateDirDocs()

void generateDirDocs

(

OutputList &

ol

)

在文件 dirdef.cpp 第 1094 行定义.

{
  for (const auto &dir : *Doxygen::dirLinkedMap)
  {
    ol.pushGeneratorState();
    if (!dir->hasDocumentation())
    {
      ol.disableAllBut(OutputGenerator::Html);
    }
    dir->writeDocumentation(ol);
    ol.popGeneratorState();
  }
  if (Config_getBool(DIRECTORY_GRAPH))
  {
    for (const auto &dr : Doxygen::dirRelations)
    {
      dr->writeDocumentation(ol);
    }
  }
}

引用了 Config_getBool, Doxygen::dirLinkedMap, Doxygen::dirRelations, OutputList::disableAllBut(), OutputGenerator::Html, OutputList::popGeneratorState() , 以及 OutputList::pushGeneratorState().

被这些函数引用 generateOutput().

toDirDef() [1/2]

const DirDef* toDirDef

(

const Definition *

d

)

在文件 dirdef.cpp 第 1135 行定义.

{
  if (d==0) return 0;
  if (d && typeid(*d)==typeid(DirDefImpl))
  {
    return static_cast<const DirDef*>(d);
  }
  else
  {
    return 0;
  }
}

toDirDef() [2/2]

DirDef* toDirDef

(

Definition *

d

)

在文件 dirdef.cpp 第 1122 行定义.

{
  if (d==0) return 0;
  if (d && typeid(*d)==typeid(DirDefImpl))
  {
    return static_cast<DirDef*>(d);
  }
  else
  {
    return 0;
  }
}

被这些函数引用 NestingNodeContext::Private::addDirFiles() , 以及 NestingNodeContext::Private::createDir().