类 DirDefImpl 继承关系图:

DirDefImpl 的协作图:

Public 成员函数
	DirDefImpl (const QCString &path)

virtual	~DirDefImpl ()

virtual DefType	definitionType () const

virtual CodeSymbolType	codeSymbolType () const

virtual QCString	getOutputFileBase () const

virtual QCString	anchor () const

virtual bool	isLinkableInProject () const

virtual bool	isLinkable () const

virtual QCString	displayName (bool=TRUE) const

virtual const QCString	shortName () const

virtual void	addSubDir (DirDef *subdir)

virtual const FileList &	getFiles () const

virtual void	addFile (const FileDef *fd)

virtual const DirList &	subDirs () const

virtual bool	hasSubdirs () const

virtual int	level () const

virtual DirDef *	parent () const

virtual int	dirCount () const

virtual const UsedDirLinkedMap &	usedDirs () const

virtual bool	isParentOf (const DirDef *dir) const

virtual bool	depGraphIsTrivial () const

virtual QCString	shortTitle () const

virtual bool	hasDetailedDescription () const

virtual void	writeDocumentation (OutputList &ol)

virtual void	writeTagFile (TextStream &t)

virtual void	setDiskName (const QCString &name)

virtual void	sort ()

virtual void	setParent (DirDef *parent)

virtual void	setDirCount (int count)

virtual void	setLevel ()

virtual void	addUsesDependency (const DirDef usedDir, const FileDef srcFd, const FileDef *dstFd, bool srcDirect, bool dstDirect)
	Add as "uses" dependency between this dir and dir, that was caused by a dependency on file fd. 更多...

virtual void	computeDependencies ()
	Computes the dependencies between directories 更多...

Public 成员函数继承自 DefinitionMixin< DirDef >
	DefinitionMixin (const QCString &defFileName, int defLine, int defColumn, const QCString &name, const char b=0, const char d=0, bool isSymbol=TRUE)

virtual	~DefinitionMixin ()

virtual bool	isAlias () const

virtual QCString	name () const

virtual bool	isAnonymous () const

virtual QCString	localName () const

virtual QCString	qualifiedName () const

virtual QCString	symbolName () const

virtual QCString	getSourceFileBase () const

virtual QCString	getSourceAnchor () const

virtual QCString	documentation () const

virtual int	docLine () const

virtual QCString	docFile () const

virtual QCString	briefDescription (bool abbreviate=FALSE) const

virtual QCString	briefDescriptionAsTooltip () const

virtual int	briefLine () const

virtual QCString	inbodyDocumentation () const

virtual QCString	inbodyFile () const

virtual int	inbodyLine () const

virtual QCString	briefFile () const

virtual QCString	getDefFileName () const

virtual QCString	getDefFileExtension () const

virtual int	getDefLine () const

virtual int	getDefColumn () const

virtual bool	hasDocumentation () const

virtual bool	hasUserDocumentation () const

virtual bool	isVisibleInProject () const

virtual bool	isVisible () const

virtual bool	isHidden () const

virtual bool	isArtificial () const

virtual QCString	getReference () const

virtual bool	isReference () const

virtual QCString	externalReference (const QCString &relPath) const

virtual int	getStartDefLine () const

virtual int	getStartBodyLine () const

virtual int	getEndBodyLine () const

virtual const FileDef *	getBodyDef () const

virtual SrcLangExt	getLanguage () const

virtual const GroupList &	partOfGroups () const

virtual bool	isLinkableViaGroup () const

virtual const RefItemVector &	xrefListItems () const

virtual const Definition *	findInnerCompound (const QCString &name) const

virtual Definition *	getOuterScope () const

virtual const MemberVector &	getReferencesMembers () const

virtual const MemberVector &	getReferencedByMembers () const

virtual bool	hasSections () const

virtual bool	hasSources () const

virtual bool	hasBriefDescription () const

virtual QCString	id () const

virtual const SectionRefs &	getSectionRefs () const

virtual void	setName (const QCString &name)

virtual void	setId (const QCString &name)

virtual void	setDefFile (const QCString &df, int defLine, int defColumn)

virtual void	setDocumentation (const QCString &doc, const QCString &docFile, int docLine, bool stripWhiteSpace=TRUE)

virtual void	setBriefDescription (const QCString &brief, const QCString &briefFile, int briefLine)

virtual void	setInbodyDocumentation (const QCString &doc, const QCString &docFile, int docLine)

virtual void	setReference (const QCString &r)

virtual void	addSectionsToDefinition (const std::vector< const SectionInfo * > &anchorList)

virtual void	setBodySegment (int defLine, int bls, int ble)

virtual void	setBodyDef (const FileDef *fd)

virtual void	addSourceReferencedBy (const MemberDef *md)

virtual void	addSourceReferences (const MemberDef *md)

virtual void	setRefItems (const RefItemVector &sli)

virtual void	mergeRefItems (Definition *def)

virtual void	mergeReferences (const Definition *other)

virtual void	mergeReferencedBy (const Definition *other)

virtual void	addInnerCompound (const Definition *def)

virtual void	setOuterScope (Definition *def)

virtual void	setHidden (bool b)

virtual void	setArtificial (bool b)

virtual void	setLanguage (SrcLangExt lang)

virtual void	writeSourceDef (OutputList &ol, const QCString &scopeName) const

virtual void	writeInlineCode (OutputList &ol, const QCString &scopeName) const

virtual bool	hasSourceRefs () const

virtual bool	hasSourceReffedBy () const

virtual void	writeSourceRefs (OutputList &ol, const QCString &scopeName) const

virtual void	writeSourceReffedBy (OutputList &ol, const QCString &scopeName) const

virtual void	makePartOfGroup (const GroupDef *gd)

virtual void	writeNavigationPath (OutputList &ol) const

virtual QCString	navigationPathAsString () const

virtual void	writeQuickMemberLinks (OutputList &ol, const MemberDef *md) const

virtual void	writeSummaryLinks (OutputList &ol) const

virtual QCString	pathFragment () const

virtual void	writeDocAnchorsToTagFile (TextStream &fs) const

virtual void	setLocalName (const QCString &name)

virtual void	addSectionsToIndex ()

virtual void	writeToc (OutputList &ol, const LocalToc &lt) const

virtual void	computeTooltip ()

virtual void	_setSymbolName (const QCString &name)

virtual QCString	_symbolName () const

Public 成员函数继承自 DirDef
virtual	~DirDef ()

Public 成员函数继承自 DefinitionMutable
virtual bool	hasSourceRefs () const =0

virtual bool	hasSourceReffedBy () const =0

virtual	~DefinitionMutable ()=default

Public 成员函数继承自 Definition
virtual bool	isAlias () const =0

virtual QCString	name () const =0

virtual bool	isAnonymous () const =0

virtual QCString	localName () const =0

virtual QCString	qualifiedName () const =0

virtual QCString	symbolName () const =0

virtual QCString	getSourceFileBase () const =0

virtual QCString	getSourceAnchor () const =0

virtual QCString	documentation () const =0

virtual int	docLine () const =0

virtual QCString	docFile () const =0

virtual QCString	briefDescriptionAsTooltip () const =0

virtual int	briefLine () const =0

virtual QCString	inbodyDocumentation () const =0

virtual QCString	inbodyFile () const =0

virtual int	inbodyLine () const =0

virtual QCString	briefFile () const =0

virtual QCString	getDefFileName () const =0

virtual QCString	getDefFileExtension () const =0

virtual int	getDefLine () const =0

virtual int	getDefColumn () const =0

virtual bool	hasDocumentation () const =0

virtual bool	hasUserDocumentation () const =0

virtual bool	isVisibleInProject () const =0

virtual bool	isVisible () const =0

virtual bool	isHidden () const =0

virtual bool	isArtificial () const =0

virtual QCString	getReference () const =0

virtual bool	isReference () const =0

virtual int	getStartDefLine () const =0

virtual int	getStartBodyLine () const =0

virtual int	getEndBodyLine () const =0

virtual const FileDef *	getBodyDef () const =0

virtual SrcLangExt	getLanguage () const =0
	Returns the programming language this definition was written in. 更多...

virtual const GroupList &	partOfGroups () const =0

virtual bool	isLinkableViaGroup () const =0

virtual const RefItemVector &	xrefListItems () const =0

virtual Definition *	getOuterScope () const =0

virtual const MemberVector &	getReferencesMembers () const =0

virtual const MemberVector &	getReferencedByMembers () const =0

virtual bool	hasSections () const =0

virtual bool	hasSources () const =0

virtual bool	hasBriefDescription () const =0
	returns TRUE if this class has a brief description 更多...

virtual QCString	id () const =0

virtual const SectionRefs &	getSectionRefs () const =0
	returns the section dictionary, only of importance for pagedef 更多...

virtual QCString	navigationPathAsString () const =0

virtual QCString	pathFragment () const =0

virtual QCString	_symbolName () const =0

virtual	~Definition ()=default

静态 Public 成员函数
static DirDef *	mergeDirectoryInTree (const QCString &path)

Private 成员函数
void	writeDetailedDescription (OutputList &ol, const QCString &title)

void	writeBriefDescription (OutputList &ol)

void	writeDirectoryGraph (OutputList &ol)

void	writeSubDirList (OutputList &ol)

void	writeFileList (OutputList &ol)

void	startMemberDeclarations (OutputList &ol)

void	endMemberDeclarations (OutputList &ol)

静态 Private 成员函数
static DirDef *	createNewDir (const QCString &path)

static bool	matchPath (const QCString &path, const StringVector &l)

Private 属性
DirList	m_subdirs

QCString	m_dispName

QCString	m_shortName

QCString	m_diskName

FileList	m_fileList

int	m_dirCount = -1

int	m_level

DirDef *	m_parent

UsedDirLinkedMap	m_usedDirs

额外继承的成员函数
Public 类型继承自 Definition
enum	DefType { TypeClass = 0, TypeFile = 1, TypeNamespace = 2, TypeMember = 3, TypeGroup = 4, TypePackage = 5, TypePage = 6, TypeDir = 7, TypeConcept = 8 }

Protected 成员函数继承自 DefinitionMixin< DirDef >
	DefinitionMixin (const DefinitionMixin &def)=default

详细描述

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

构造及析构函数说明

◆ DirDefImpl()

DirDefImpl::DirDefImpl ( const QCString & path )

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

                                            : DefinitionMixin(path,1,1,path)
 {
   bool fullPathNames = Config_getBool(FULL_PATH_NAMES);
   // get display name (stripping the paths mentioned in STRIP_FROM_PATH)
   // get short name (last part of path)
   m_shortName = path;
   m_diskName = path;
   if (m_shortName.at(m_shortName.length()-1)=='/')
   { // strip trailing /
     m_shortName = m_shortName.left(m_shortName.length()-1);
   }
   int pi=m_shortName.findRev('/');
   if (pi!=-1)
   { // remove everything till the last /
     m_shortName = m_shortName.mid(pi+1);
   }
   setLocalName(m_shortName);
   m_dispName = fullPathNames ? stripFromPath(path) : m_shortName;
   if (m_dispName.length()>0 && m_dispName.at(m_dispName.length()-1)=='/')
   { // strip trailing /
     m_dispName = m_dispName.left(m_dispName.length()-1);
   }
  
   m_level=-1;
   m_parent=0;
 }

◆ ~DirDefImpl()

DirDefImpl::~DirDefImpl ( )

virtual

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

139 {

140 }

成员函数说明

◆ addFile()

void DirDefImpl::addFile ( const FileDef * fd )

virtual

实现了 DirDef.

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

 {
   m_fileList.push_back(fd);
   const_cast<FileDef*>(fd)->setDirDef(this);
 }

引用了 m_fileList.

◆ addSubDir()

void DirDefImpl::addSubDir ( DirDef * subdir )

virtual

实现了 DirDef.

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

 {
   m_subdirs.push_back(subdir);
   subdir->setOuterScope(this);
   subdir->setParent(this);
 }

引用了 m_subdirs, DefinitionMutable::setOuterScope() , 以及 DirDef::setParent().

◆ addUsesDependency()

void DirDefImpl::addUsesDependency	(	const DirDef *	dir,
		const FileDef *	srcFd,
		const FileDef *	dstFd,
		bool	srcDirect,
		bool	dstDirect
	)

virtual

Add as "uses" dependency between this dir and dir, that was caused by a dependency on file fd.

srcDirect and dstDirect indicate if it is a direct dependencies (true) or if the dependencies was indirect (e.g. a parent dir that has a child dir that has the dependencies)

实现了 DirDef.

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

 {
   if (this==dir) return; // do not add self-dependencies
   //static int count=0;
   //printf("  %d add dependency %s->%s due to %s->%s\n",
   //    count++,qPrint(shortName()),
   //    qPrint(dir->shortName()),
   //    qPrint(srcFd->name()),
   //    qPrint(dstFd->name()));
  
   // levels match => add direct dependency
   bool added=FALSE;
   UsedDir *usedDir = m_usedDirs.find(dir->getOutputFileBase());
   if (usedDir) // dir dependency already present
   {
      const FilePair *usedPair = usedDir->findFilePair(FilePair::key(srcFd,dstFd));
      if (usedPair==0) // new file dependency
      {
        //printf("  => new file\n");
        usedDir->addFileDep(srcFd,dstFd, srcDirect, dstDirect);
        added=TRUE;
      }
      else
      {
        // dir & file dependency already added
      }
   }
   else // new directory dependency
   {
     //printf("  => new file\n");
     auto newUsedDir = std::make_unique<UsedDir>(dir);
     newUsedDir->addFileDep(srcFd,dstFd, srcDirect, dstDirect);
     usedDir = m_usedDirs.add(dir->getOutputFileBase(),std::move(newUsedDir));
     added=TRUE;
   }
   if (added)
   {
     if (dir->parent())
     {
       // add relation to parent of used dir
       addUsesDependency(dir->parent(),
                         srcFd,
                         dstFd,
                         srcDirect,
                         false); // indirect dependency on dest dir
     }
     if (parent())
     {
       // add relation for the parent of this dir as well
       parent()->addUsesDependency(dir,
                                  srcFd,
                                  dstFd,
                                  false, // indirect dependency from source dir
                                  dstDirect);
     }
   }
 }

引用了 LinkedMap< T, Hash, KeyEqual, Map >::add(), UsedDir::addFileDep(), DirDef::addUsesDependency(), FALSE, LinkedMap< T, Hash, KeyEqual, Map >::find(), UsedDir::findFilePair(), DirDef::getOutputFileBase(), FilePair::key(), m_usedDirs, parent(), DirDef::parent() , 以及 TRUE.

被这些函数引用 computeDependencies().

◆ anchor()

virtual QCString DirDefImpl::anchor ( ) const

inlinevirtual

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

实现了 DirDef.

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

59 { return m_usedDirs; }

引用了 m_usedDirs.

◆ codeSymbolType()

virtual CodeSymbolType DirDefImpl::codeSymbolType ( ) const

inlinevirtual

Used for syntax highlighting symbol class

实现了 Definition.

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

57 { return m_parent; }

引用了 m_parent.

◆ computeDependencies()

void DirDefImpl::computeDependencies ( )

virtual

Computes the dependencies between directories

实现了 DirDef.

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

 {
   for (const auto &fd : m_fileList)
   {
     //printf("  File %s\n",qPrint(fd->name()));
     //printf("** dir=%s file=%s\n",qPrint(shortName()),qPrint(fd->name()));
     for (const auto &ii : fd->includeFileList())
     {
       //printf("  > %s\n",qPrint(ii->includeName));
       //printf("    #include %s\n",qPrint(ii->includeName));
       if (ii.fileDef && ii.fileDef->isLinkable()) // linkable file
       {
         DirDef *usedDir = ii.fileDef->getDirDef();
         if (usedDir)
         {
           // add dependency: thisDir->usedDir
           //static int count=0;
           //printf("      %d: add dependency %s->%s\n",count++,qPrint(name()),qPrint(usedDir->name()));
           addUsesDependency(usedDir,fd,ii.fileDef,true,true);
         }
       }
     }
   }
  
   std::sort(m_usedDirs.begin(),m_usedDirs.end(),
             [](const auto &u1,const auto &u2)
             { return qstricmp(u1->dir()->getOutputFileBase(),u2->dir()->getOutputFileBase())<0; });
  
   for (const auto& usedDirectory : m_usedDirs)
   {
     usedDirectory->sort();
   }
 }

引用了 addUsesDependency(), LinkedMap< T, Hash, KeyEqual, Map >::begin(), LinkedMap< T, Hash, KeyEqual, Map >::end(), m_fileList , 以及 m_usedDirs.

◆ createNewDir()

DirDef * DirDefImpl::createNewDir ( const QCString & path )

staticprivate

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

 {
   ASSERT(path!=0);
   DirDef *dir = Doxygen::dirLinkedMap->find(path);
   if (dir==0) // new dir
   {
     dir = Doxygen::dirLinkedMap->add(path,
             std::unique_ptr<DirDef>(
               createDirDef(path)));
     //printf("Adding new dir %s\n",path);
     //printf("createNewDir %s short=%s\n",path,qPrint(dir->shortName()));
   }
   return dir;
 }

引用了 LinkedMap< T, Hash, KeyEqual, Map >::add(), ASSERT, createDirDef(), Doxygen::dirLinkedMap , 以及 LinkedMap< T, Hash, KeyEqual, Map >::find().

被这些函数引用 mergeDirectoryInTree().

◆ definitionType()

virtual DefType DirDefImpl::definitionType ( ) const

inlinevirtual

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

实现了 DirDef.

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

56 { return m_level; }

引用了 m_level.

◆ depGraphIsTrivial()

bool DirDefImpl::depGraphIsTrivial ( ) const

virtual

实现了 DirDef.

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

 {
   return m_usedDirs.empty();
 }

引用了 LinkedMap< T, Hash, KeyEqual, Map >::empty() , 以及 m_usedDirs.

◆ dirCount()

virtual int DirDefImpl::dirCount ( ) const

inlinevirtual

实现了 DirDef.

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

75 :

76 static DirDef *mergeDirectoryInTree(const QCString &path);

◆ displayName()

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

inlinevirtual

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

实现了 DirDef.

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

66 { m_diskName = name; }

被这些函数引用 writeDirectoryGraph() , 以及 writeTagFile().

◆ endMemberDeclarations()

void DirDefImpl::endMemberDeclarations ( OutputList & ol )

private

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

 {
   ol.endMemberSections();
 }

引用了 OutputList::endMemberSections().

被这些函数引用 writeDocumentation().

◆ getFiles()

virtual const FileList& DirDefImpl::getFiles ( ) const

inlinevirtual

实现了 DirDef.

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

66 { m_diskName = name; }

◆ getOutputFileBase()

QCString DirDefImpl::getOutputFileBase ( ) const

virtual

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

实现了 DirDef.

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

 {
   //printf("DirDefImpl::getOutputFileBase() %s->dir_%s\n",
   //    qPrint(m_diskName),qPrint(encodeDirName(m_diskName)));
   return "dir_"+encodeDirName(m_diskName);
 }

引用了 encodeDirName() , 以及 m_diskName.

被这些函数引用 writeDocumentation() , 以及 writeTagFile().

◆ hasDetailedDescription()

bool DirDefImpl::hasDetailedDescription ( ) const

virtual

实现了 DirDef.

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

 {
   static bool repeatBrief = Config_getBool(REPEAT_BRIEF);
   return (!briefDescription().isEmpty() && repeatBrief) || !documentation().isEmpty();
 }

引用了 DefinitionMixin< DirDef >::briefDescription(), Config_getBool, DefinitionMixin< DirDef >::documentation() , 以及 QCString::isEmpty().

◆ hasSubdirs()

virtual bool DirDefImpl::hasSubdirs ( ) const

inlinevirtual

实现了 DirDef.

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

75 :

76 static DirDef *mergeDirectoryInTree(const QCString &path);

◆ isLinkable()

bool DirDefImpl::isLinkable ( ) const

virtual

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

实现了 DirDef.

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

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

引用了 isLinkableInProject() , 以及 DefinitionMixin< DirDef >::isReference().

◆ isLinkableInProject()

bool DirDefImpl::isLinkableInProject ( ) const

virtual

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

实现了 DirDef.

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

 {
   return !isReference();
 }

引用了 DefinitionMixin< DirDef >::isReference().

被这些函数引用 isLinkable().

◆ isParentOf()

bool DirDefImpl::isParentOf ( const DirDef * dir ) const

virtual

实现了 DirDef.

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

 {
   if (dir->parent()==this) // this is a parent of dir
     return TRUE;
   else if (dir->parent()) // repeat for the parent of dir
     return isParentOf(dir->parent());
   else
     return FALSE;
 }

引用了 FALSE, DirDef::parent() , 以及 TRUE.

◆ level()

virtual int DirDefImpl::level ( ) const

inlinevirtual

实现了 DirDef.

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

75 :

76 static DirDef *mergeDirectoryInTree(const QCString &path);

◆ matchPath()

bool DirDefImpl::matchPath	(	const QCString &	path,
		const StringVector &	l
	)

staticprivate

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

 {
   for (const auto &s : l)
   {
     std::string prefix = s.substr(0,path.length());
     if (qstricmp(prefix.c_str(),path)==0) // case insensitive compare
     {
       return TRUE;
     }
   }
   return FALSE;
 }

引用了 FALSE, QCString::length(), qstricmp() , 以及 TRUE.

被这些函数引用 mergeDirectoryInTree().

◆ mergeDirectoryInTree()

DirDef * DirDefImpl::mergeDirectoryInTree ( const QCString & path )

static

strip part of path if it matches one of the paths in the Config_getList(STRIP_FROM_PATH) list

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

 {
   //printf("DirDefImpl::mergeDirectoryInTree(%s)\n",qPrint(path));
   int p=0,i=0;
   DirDef *dir=0;
   while ((i=path.find('/',p))!=-1)
   {
     QCString part=path.left(i+1);
     if (!matchPath(part,Config_getList(STRIP_FROM_PATH)) && (part!="/" && part!="//"))
     {
       dir=createNewDir(part);
     }
     p=i+1;
   }
   return dir;
 }

引用了 Config_getList, createNewDir(), QCString::find(), QCString::left() , 以及 matchPath().

被这些函数引用 buildDirectories().

◆ parent()

virtual DirDef* DirDefImpl::parent ( ) const

inlinevirtual

实现了 DirDef.

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

75 :

76 static DirDef *mergeDirectoryInTree(const QCString &path);

被这些函数引用 addUsesDependency() , 以及 setLevel().

◆ setDirCount()

void DirDefImpl::setDirCount ( int count )

virtual

实现了 DirDef.

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

 {
   m_dirCount=count;
 }

引用了 m_dirCount.

◆ setDiskName()

virtual void DirDefImpl::setDiskName ( const QCString & name )

inlinevirtual

实现了 DirDef.

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

103 {

◆ setLevel()

void DirDefImpl::setLevel ( )

virtual

实现了 DirDef.

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

 {
   if (m_level==-1) // level not set before
   {
     DirDef *p = parent();
     if (p)
     {
       p->setLevel();
       m_level = p->level()+1;
     }
     else
     {
       m_level = 0;
     }
   }
 }

引用了 DirDef::level(), m_level, parent() , 以及 DirDef::setLevel().

◆ setParent()

void DirDefImpl::setParent ( DirDef * parent )

virtual

实现了 DirDef.

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

 {
    m_parent=p;
 }

引用了 m_parent.

◆ shortName()

virtual const QCString DirDefImpl::shortName ( ) const

inlinevirtual

实现了 DirDef.

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

66 { m_diskName = name; }

被这些函数引用 writeDirectoryGraph().

◆ shortTitle()

QCString DirDefImpl::shortTitle ( ) const

virtual

实现了 DirDef.

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

 {
   return theTranslator->trDirReference(m_shortName);
 }

引用了 m_shortName, theTranslator , 以及 Translator::trDirReference().

被这些函数引用 writeDocumentation().

◆ sort()

void DirDefImpl::sort ( )

virtual

实现了 DirDef.

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

 {
   std::sort(m_subdirs.begin(), m_subdirs.end(), compareDirDefs);
   std::sort(m_fileList.begin(), m_fileList.end(), compareFileDefs);
 }

引用了 compareDirDefs(), compareFileDefs(), m_fileList , 以及 m_subdirs.

◆ startMemberDeclarations()

void DirDefImpl::startMemberDeclarations ( OutputList & ol )

private

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

 {
   ol.startMemberSections();
 }

引用了 OutputList::startMemberSections().

被这些函数引用 writeDocumentation().

◆ subDirs()

virtual const DirList& DirDefImpl::subDirs ( ) const

inlinevirtual

实现了 DirDef.

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

75 :

76 static DirDef *mergeDirectoryInTree(const QCString &path);

◆ usedDirs()

virtual const UsedDirLinkedMap& DirDefImpl::usedDirs ( ) const

inlinevirtual

实现了 DirDef.

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

75 :

76 static DirDef *mergeDirectoryInTree(const QCString &path);

◆ writeBriefDescription()

void DirDefImpl::writeBriefDescription ( OutputList & ol )

private

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

 {
   if (hasBriefDescription())
   {
     std::unique_ptr<IDocParser> parser { createDocParser() };
     std::unique_ptr<DocRoot> rootNode  { validatingParseDoc(
          *parser.get(), briefFile(),briefLine(),this,0,briefDescription(),TRUE,FALSE,
          QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT)) };
     if (rootNode && !rootNode->isEmpty())
     {
       ol.startParagraph();
       ol.pushGeneratorState();
       ol.disableAllBut(OutputGenerator::Man);
       ol.writeString(" - ");
       ol.popGeneratorState();
       ol.writeDoc(rootNode.get(),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(QCString(),"details");
         ol.parseText(theTranslator->trMore());
         ol.endTextLink();
       }
       ol.popGeneratorState();
  
       ol.endParagraph();
     }
   }
   ol.writeSynopsis();
 }

引用了 DefinitionMixin< DirDef >::briefDescription(), DefinitionMixin< DirDef >::briefFile(), DefinitionMixin< DirDef >::briefLine(), Config_getBool, createDocParser(), OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< DirDef >::documentation(), OutputList::enable(), OutputList::endParagraph(), OutputList::endTextLink(), FALSE, DefinitionMixin< DirDef >::hasBriefDescription(), OutputGenerator::Html, OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startParagraph(), OutputList::startTextLink(), theTranslator, Translator::trMore(), TRUE, validatingParseDoc(), OutputList::writeDoc(), OutputList::writeString() , 以及 OutputList::writeSynopsis().

被这些函数引用 writeDocumentation().

◆ writeDetailedDescription()

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

private

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

 {
   if ((!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF)) ||
       !documentation().isEmpty())
   {
     ol.pushGeneratorState();
       ol.disable(OutputGenerator::Html);
       ol.writeRuler();
     ol.popGeneratorState();
     ol.pushGeneratorState();
       ol.disableAllBut(OutputGenerator::Html);
       ol.writeAnchor(QCString(),"details");
     ol.popGeneratorState();
     ol.startGroupHeader();
     ol.parseText(title);
     ol.endGroupHeader();
  
     // repeat brief description
     if (!briefDescription().isEmpty() && Config_getBool(REPEAT_BRIEF))
     {
       ol.generateDoc(briefFile(),briefLine(),this,0,briefDescription(),FALSE,FALSE,
                      QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     }
     // separator between brief and details
     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();
     }
  
     // write documentation
     if (!documentation().isEmpty())
     {
       ol.generateDoc(docFile(),docLine(),this,0,documentation()+"\n",TRUE,FALSE,
                      QCString(),FALSE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     }
   }
 }

引用了 DefinitionMixin< DirDef >::briefDescription(), DefinitionMixin< DirDef >::briefFile(), DefinitionMixin< DirDef >::briefLine(), Config_getBool, OutputList::disable(), OutputList::disableAllBut(), DefinitionMixin< DirDef >::docFile(), DefinitionMixin< DirDef >::docLine(), DefinitionMixin< DirDef >::documentation(), OutputList::enable(), OutputList::enableAll(), OutputList::endGroupHeader(), FALSE, OutputList::generateDoc(), OutputGenerator::Html, OutputGenerator::Latex, OutputGenerator::Man, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputGenerator::RTF, OutputList::startGroupHeader(), TRUE, OutputList::writeAnchor(), OutputList::writeRuler() , 以及 OutputList::writeString().

被这些函数引用 writeDocumentation().

◆ writeDirectoryGraph()

void DirDefImpl::writeDirectoryGraph ( OutputList & ol )

private

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

 {
   // write graph dependency graph
   if (Config_getBool(DIRECTORY_GRAPH) && Config_getBool(HAVE_DOT))
   {
     DotDirDeps dirDep(this);
     if (!dirDep.isTrivial())
     {
       msg("Generating dependency graph for directory %s\n",qPrint(displayName()));
       ol.disable(OutputGenerator::Man);
       //ol.startParagraph();
       ol.startDirDepGraph();
       ol.parseText(theTranslator->trDirDepGraph(shortName()));
       ol.endDirDepGraph(dirDep);
       //ol.endParagraph();
       ol.enableAll();
     }
   }
 }

引用了 Config_getBool, OutputList::disable(), displayName(), OutputList::enableAll(), OutputList::endDirDepGraph(), DotDirDeps::isTrivial(), OutputGenerator::Man, msg(), OutputList::parseText(), qPrint(), shortName(), OutputList::startDirDepGraph(), theTranslator , 以及 Translator::trDirDepGraph().

被这些函数引用 writeDocumentation().

◆ writeDocumentation()

void DirDefImpl::writeDocumentation ( OutputList & ol )

virtual

实现了 DirDef.

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

 {
   static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
   ol.pushGeneratorState();
  
   QCString title=theTranslator->trDirReference(m_dispName);
   startFile(ol,getOutputFileBase(),name(),title,HLI_Files,!generateTreeView);
  
   if (!generateTreeView)
   {
     // write navigation path
     writeNavigationPath(ol);
     ol.endQuickIndices();
   }
  
   startTitle(ol,getOutputFileBase());
   ol.pushGeneratorState();
     ol.disableAllBut(OutputGenerator::Html);
     ol.parseText(shortTitle());
     ol.enableAll();
     ol.disable(OutputGenerator::Html);
     ol.parseText(title);
   ol.popGeneratorState();
   endTitle(ol,getOutputFileBase(),title);
   ol.startContents();
  
   //---------------------------------------- start flexible part -------------------------------
  
   SrcLangExt lang = getLanguage();
   for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Directory))
   {
     switch (lde->kind())
     {
       case LayoutDocEntry::BriefDesc:
         writeBriefDescription(ol);
         break;
       case LayoutDocEntry::DirGraph:
         writeDirectoryGraph(ol);
         break;
       case LayoutDocEntry::MemberDeclStart:
         startMemberDeclarations(ol);
         break;
       case LayoutDocEntry::DirSubDirs:
         writeSubDirList(ol);
         break;
       case LayoutDocEntry::DirFiles:
         writeFileList(ol);
         break;
       case LayoutDocEntry::MemberDeclEnd:
         endMemberDeclarations(ol);
         break;
       case LayoutDocEntry::DetailedDesc:
         {
           const LayoutDocEntrySection *ls = (const LayoutDocEntrySection*)lde.get();
           writeDetailedDescription(ol,ls->title(lang));
         }
         break;
       case LayoutDocEntry::ClassIncludes:
       case LayoutDocEntry::ClassInlineClasses:
       case LayoutDocEntry::ClassInheritanceGraph:
       case LayoutDocEntry::ClassNestedClasses:
       case LayoutDocEntry::ClassCollaborationGraph:
       case LayoutDocEntry::ClassAllMembersLink:
       case LayoutDocEntry::ClassUsedFiles:
       case LayoutDocEntry::NamespaceNestedNamespaces:
       case LayoutDocEntry::NamespaceNestedConstantGroups:
       case LayoutDocEntry::NamespaceClasses:
       case LayoutDocEntry::NamespaceConcepts:
       case LayoutDocEntry::NamespaceInterfaces:
       case LayoutDocEntry::NamespaceStructs:
       case LayoutDocEntry::NamespaceExceptions:
       case LayoutDocEntry::NamespaceInlineClasses:
       case LayoutDocEntry::ConceptDefinition:
       case LayoutDocEntry::FileClasses:
       case LayoutDocEntry::FileConcepts:
       case LayoutDocEntry::FileInterfaces:
       case LayoutDocEntry::FileStructs:
       case LayoutDocEntry::FileExceptions:
       case LayoutDocEntry::FileNamespaces:
       case LayoutDocEntry::FileConstantGroups:
       case LayoutDocEntry::FileIncludes:
       case LayoutDocEntry::FileIncludeGraph:
       case LayoutDocEntry::FileIncludedByGraph:
       case LayoutDocEntry::FileSourceLink:
       case LayoutDocEntry::FileInlineClasses:
       case LayoutDocEntry::GroupClasses:
       case LayoutDocEntry::GroupConcepts:
       case LayoutDocEntry::GroupInlineClasses:
       case LayoutDocEntry::GroupNamespaces:
       case LayoutDocEntry::GroupDirs:
       case LayoutDocEntry::GroupNestedGroups:
       case LayoutDocEntry::GroupFiles:
       case LayoutDocEntry::GroupGraph:
       case LayoutDocEntry::GroupPageDocs:
       case LayoutDocEntry::AuthorSection:
       case LayoutDocEntry::MemberGroups:
       case LayoutDocEntry::MemberDecl:
       case LayoutDocEntry::MemberDef:
       case LayoutDocEntry::MemberDefStart:
       case LayoutDocEntry::MemberDefEnd:
         err("Internal inconsistency: member %d should not be part of "
             "LayoutDocManager::Directory entry list\n",lde->kind());
         break;
     }
   }
  
   //---------------------------------------- end flexible part -------------------------------
  
   ol.endContents();
  
   endFileWithNavPath(this,ol);
  
   ol.popGeneratorState();
 }

◆ writeFileList()

void DirDefImpl::writeFileList ( OutputList & ol )

private

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

 {
   int numFiles = 0;
   for (const auto &fd : m_fileList)
   {
     if (fd->hasDocumentation())
     {
       numFiles++;
     }
   }
  
   // write file list
   if (numFiles>0)
   {
     ol.startMemberHeader("files");
     ol.parseText(theTranslator->trFile(TRUE,FALSE));
     ol.endMemberHeader();
     ol.startMemberList();
     for (const auto &fd : m_fileList)
     {
       if (fd->hasDocumentation())
       {
         ol.startMemberDeclaration();
         ol.startMemberItem(fd->anchor(),0);
         ol.docify(theTranslator->trFile(FALSE,TRUE)+" ");
         ol.insertMemberAlign();
         if (fd->isLinkable())
         {
           ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),QCString(),fd->name());
         }
         else
         {
           ol.startBold();
           ol.docify(fd->name());
           ol.endBold();
         }
         if (fd->generateSourceFile())
         {
           ol.pushGeneratorState();
           ol.disableAllBut(OutputGenerator::Html);
           ol.docify(" ");
           ol.startTextLink(fd->includeName(),QCString());
           ol.docify("[");
           ol.parseText(theTranslator->trCode());
           ol.docify("]");
           ol.endTextLink();
           ol.popGeneratorState();
         }
         ol.endMemberItem();
         if (!fd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
         {
           ol.startMemberDescription(fd->getOutputFileBase());
           ol.generateDoc(briefFile(),briefLine(),fd,0,fd->briefDescription(),
               FALSE, // indexWords
               FALSE, // isExample
               QCString(), // exampleName
               TRUE,  // single line
               TRUE,  // link from index
               Config_getBool(MARKDOWN_SUPPORT)
               );
           ol.endMemberDescription();
         }
         ol.endMemberDeclaration(fd->anchor(),QCString());
       }
     }
     ol.endMemberList();
   }
 }

引用了 DefinitionMixin< DirDef >::briefFile(), DefinitionMixin< DirDef >::briefLine(), Config_getBool, OutputList::disableAllBut(), OutputList::docify(), OutputList::endBold(), OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), OutputList::endTextLink(), FALSE, OutputList::generateDoc(), OutputGenerator::Html, OutputList::insertMemberAlign(), m_fileList, OutputList::parseText(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::startBold(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), OutputList::startTextLink(), theTranslator, Translator::trCode(), Translator::trFile(), TRUE , 以及 OutputList::writeObjectLink().

被这些函数引用 writeDocumentation().

◆ writeSubDirList()

void DirDefImpl::writeSubDirList ( OutputList & ol )

private

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

 {
   int numSubdirs = 0;
   for(const auto dd : m_subdirs)
   {
     if (dd->hasDocumentation() || !dd->getFiles().empty())
     {
       numSubdirs++;
     }
   }
  
   // write subdir list
   if (numSubdirs>0)
   {
     ol.startMemberHeader("subdirs");
     ol.parseText(theTranslator->trDir(TRUE,FALSE));
     ol.endMemberHeader();
     ol.startMemberList();
     for(const auto dd : m_subdirs)
     {
       if (dd->hasDocumentation() || dd->getFiles().empty())
       {
         ol.startMemberDeclaration();
         ol.startMemberItem(dd->anchor(),0);
         ol.parseText(theTranslator->trDir(FALSE,TRUE)+" ");
         ol.insertMemberAlign();
         ol.writeObjectLink(dd->getReference(),dd->getOutputFileBase(),QCString(),dd->shortName());
         ol.endMemberItem();
         if (!dd->briefDescription().isEmpty() && Config_getBool(BRIEF_MEMBER_DESC))
         {
           ol.startMemberDescription(dd->getOutputFileBase());
           ol.generateDoc(briefFile(),briefLine(),dd,0,dd->briefDescription(),
               FALSE, // indexWords
               FALSE, // isExample
               QCString(), // exampleName
               TRUE,  // single line
               TRUE,  // link from index
               Config_getBool(MARKDOWN_SUPPORT)
               );
           ol.endMemberDescription();
         }
         ol.endMemberDeclaration(dd->anchor(),QCString());
       }
     }
  
     ol.endMemberList();
   }
 }

引用了 DefinitionMixin< DirDef >::briefFile(), DefinitionMixin< DirDef >::briefLine(), Config_getBool, OutputList::endMemberDeclaration(), OutputList::endMemberDescription(), OutputList::endMemberHeader(), OutputList::endMemberItem(), OutputList::endMemberList(), FALSE, OutputList::generateDoc(), OutputList::insertMemberAlign(), m_subdirs, OutputList::parseText(), OutputList::startMemberDeclaration(), OutputList::startMemberDescription(), OutputList::startMemberHeader(), OutputList::startMemberItem(), OutputList::startMemberList(), theTranslator, Translator::trDir(), TRUE , 以及 OutputList::writeObjectLink().

被这些函数引用 writeDocumentation().

◆ writeTagFile()

void DirDefImpl::writeTagFile ( TextStream & t )

virtual

实现了 DirDef.

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

 {
   tagFile << "  <compound kind=\"dir\">\n";
   tagFile << "    <name>" << convertToXML(displayName()) << "</name>\n";
   tagFile << "    <path>" << convertToXML(name()) << "</path>\n";
   tagFile << "    <filename>" << addHtmlExtensionIfMissing(getOutputFileBase()) << "</filename>\n";
   for (const auto &lde : LayoutDocManager::instance().docEntries(LayoutDocManager::Directory))
   {
     switch (lde->kind())
     {
       case LayoutDocEntry::DirSubDirs:
         {
           if (m_subdirs.size()>0)
           {
             for(const auto dd : m_subdirs)
             {
               tagFile << "    <dir>" << convertToXML(dd->displayName()) << "</dir>\n";
             }
           }
         }
         break;
       case LayoutDocEntry::DirFiles:
         {
           for (const auto &fd : m_fileList)
           {
               tagFile << "    <file>" << convertToXML(fd->name()) << "</file>\n";
           }
         }
         break;
       default:
         break;
     }
   }
   writeDocAnchorsToTagFile(tagFile);
   tagFile << "  </compound>\n";
 }

引用了 addHtmlExtensionIfMissing(), convertToXML(), LayoutDocManager::Directory, LayoutDocEntry::DirFiles, LayoutDocEntry::DirSubDirs, displayName(), getOutputFileBase(), LayoutDocManager::instance(), m_fileList, m_subdirs, DefinitionMixin< DirDef >::name() , 以及 DefinitionMixin< DirDef >::writeDocAnchorsToTagFile().

类成员变量说明

◆ m_dirCount

int DirDefImpl::m_dirCount = -1

private

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

被这些函数引用 setDirCount().

◆ m_diskName

QCString DirDefImpl::m_diskName

private

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

被这些函数引用 getOutputFileBase().

◆ m_dispName

QCString DirDefImpl::m_dispName

private

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

被这些函数引用 writeDocumentation().

◆ m_fileList

FileList DirDefImpl::m_fileList

private

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

被这些函数引用 addFile(), computeDependencies(), sort(), writeFileList() , 以及 writeTagFile().

◆ m_level

int DirDefImpl::m_level

private

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

被这些函数引用 definitionType() , 以及 setLevel().

◆ m_parent

DirDef* DirDefImpl::m_parent

private

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

被这些函数引用 codeSymbolType() , 以及 setParent().

◆ m_shortName

QCString DirDefImpl::m_shortName

private

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

被这些函数引用 shortTitle().

◆ m_subdirs

DirList DirDefImpl::m_subdirs

private

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

被这些函数引用 addSubDir(), sort(), writeSubDirList() , 以及 writeTagFile().

◆ m_usedDirs

UsedDirLinkedMap DirDefImpl::m_usedDirs

private

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

被这些函数引用 addUsesDependency(), anchor(), computeDependencies() , 以及 depGraphIsTrivial().

该类的文档由以下文件生成:

src/dirdef.cpp

Public 成员函数

静态 Public 成员函数

Private 成员函数

静态 Private 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DirDefImpl()

◆ ~DirDefImpl()

成员函数说明

◆ addFile()

◆ addSubDir()

◆ addUsesDependency()

◆ anchor()

◆ codeSymbolType()

◆ computeDependencies()

◆ createNewDir()

◆ definitionType()

◆ depGraphIsTrivial()

◆ dirCount()

◆ displayName()

◆ endMemberDeclarations()

◆ getFiles()

◆ getOutputFileBase()

◆ hasDetailedDescription()

◆ hasSubdirs()

◆ isLinkable()

◆ isLinkableInProject()

◆ isParentOf()

◆ level()

◆ matchPath()

◆ mergeDirectoryInTree()

◆ parent()

◆ setDirCount()

◆ setDiskName()

◆ setLevel()

◆ setParent()

◆ shortName()

◆ shortTitle()

◆ sort()

◆ startMemberDeclarations()

◆ subDirs()

◆ usedDirs()

◆ writeBriefDescription()

◆ writeDetailedDescription()

◆ writeDirectoryGraph()

◆ writeDocumentation()

◆ writeFileList()

◆ writeSubDirList()

◆ writeTagFile()

类成员变量说明

◆ m_dirCount

◆ m_diskName

◆ m_dispName

◆ m_fileList

◆ m_level

◆ m_parent

◆ m_shortName

◆ m_subdirs

◆ m_usedDirs