Representation of an include dependency graph 更多...

#include <dotincldepgraph.h>

类 DotInclDepGraph 继承关系图:

DotInclDepGraph 的协作图:

Public 成员函数
	DotInclDepGraph (const FileDef *fd, bool inverse)

	~DotInclDepGraph ()

QCString	writeGraph (TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)

bool	isTrivial () const

bool	isTooBig () const

int	numNodes () const

void	writeXML (TextStream &t)

void	writeDocbook (TextStream &t)

Public 成员函数继承自 DotGraph
	DotGraph ()

virtual	~DotGraph ()

Protected 成员函数
virtual QCString	getBaseName () const

virtual QCString	getMapLabel () const

virtual void	computeTheGraph ()

Protected 成员函数继承自 DotGraph
int	getNextNodeNumber ()
	returns node numbers. 更多...

QCString	writeGraph (TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)

virtual QCString	absMapName () const

virtual QCString	getImgAltText () const

QCString	absBaseName () const

QCString	absDotName () const

QCString	imgName () const

QCString	absImgName () const

QCString	relImgName () const

Private 成员函数
QCString	diskName () const

void	buildGraph (DotNode n, const FileDef fd, int distance)

void	determineVisibleNodes (DotNodeDeque &queue, int &maxNodes)

void	determineTruncatedNodes (DotNodeDeque &queue)

Private 属性
DotNode *	m_startNode

DotNodeMap	m_usedNodes

QCString	m_inclDepFileName

QCString	m_inclByDepFileName

bool	m_inverse

额外继承的成员函数
静态 Protected 成员函数继承自 DotGraph
static void	writeGraphHeader (TextStream &t, const QCString &title=QCString())

static void	writeGraphFooter (TextStream &t)

static void	computeGraph (DotNode *root, GraphType gt, GraphOutputFormat format, const QCString &rank, bool renderParents, bool backArrows, const QCString &title, QCString &graphStr)

Protected 属性继承自 DotGraph
GraphOutputFormat	m_graphFormat = GOF_BITMAP

EmbeddedOutputFormat	m_textFormat = EOF_Html

Dir	m_dir

QCString	m_fileName

QCString	m_relPath

bool	m_generateImageMap = false

int	m_graphId = 0

QCString	m_absPath

QCString	m_baseName

QCString	m_theGraph

bool	m_regenerate = false

bool	m_doNotAddImageToIndex = false

bool	m_noDivTag = false

bool	m_zoomable = true

bool	m_urlOnly = false

详细描述

Representation of an include dependency graph

在文件 dotincldepgraph.h 第 30 行定义.

构造及析构函数说明

◆ DotInclDepGraph()

DotInclDepGraph::DotInclDepGraph	(	const FileDef *	fd,
		bool	inverse
	)

在文件 dotincldepgraph.cpp 第 123 行定义.

 {
   m_inverse = inverse;
   ASSERT(fd!=0);
   m_inclDepFileName   = fd->includeDependencyGraphFileName();
   m_inclByDepFileName = fd->includedByDependencyGraphFileName();
   QCString tmp_url=fd->getReference()+"$"+fd->getOutputFileBase();
   QCString tooltip = fd->briefDescriptionAsTooltip();
   m_startNode = new DotNode(getNextNodeNumber(),
                             fd->docName(),
                             tooltip,
                             tmp_url,
                             TRUE);    // root node
   m_startNode->setDistance(0);
   m_usedNodes.insert(std::make_pair(fd->absFilePath().str(),m_startNode));
   buildGraph(m_startNode,fd,1);
  
   int maxNodes = Config_getInt(DOT_GRAPH_MAX_NODES);
   DotNodeDeque openNodeQueue;
   openNodeQueue.push_back(m_startNode);
   determineVisibleNodes(openNodeQueue,maxNodes);
   openNodeQueue.clear();
   openNodeQueue.push_back(m_startNode);
   determineTruncatedNodes(openNodeQueue);
 }

引用了 FileDef::absFilePath(), ASSERT, Definition::briefDescriptionAsTooltip(), buildGraph(), Config_getInt, determineTruncatedNodes(), determineVisibleNodes(), FileDef::docName(), DotGraph::getNextNodeNumber(), FileDef::getOutputFileBase(), Definition::getReference(), FileDef::includedByDependencyGraphFileName(), FileDef::includeDependencyGraphFileName(), m_inclByDepFileName, m_inclDepFileName, m_inverse, m_startNode, m_usedNodes, DotNode::setDistance(), QCString::str() , 以及 TRUE.

◆ ~DotInclDepGraph()

DotInclDepGraph::~DotInclDepGraph ( )

在文件 dotincldepgraph.cpp 第 149 行定义.

 {
   DotNode::deleteNodes(m_startNode);
 }

引用了 DotNode::deleteNodes() , 以及 m_startNode.

成员函数说明

◆ buildGraph()

void DotInclDepGraph::buildGraph	(	DotNode *	n,
		const FileDef *	fd,
		int	distance
	)

private

在文件 dotincldepgraph.cpp 第 22 行定义.

 {
   const IncludeInfoList &includeFiles = m_inverse ? fd->includedByFileList() : fd->includeFileList();
   for (const auto &ii : includeFiles)
   {
     const FileDef *bfd = ii.fileDef;
     QCString in = ii.includeName;
     //printf(">>>> in='%s' bfd=%p\n",qPrint(ii->includeName),bfd);
     bool doc=TRUE,src=FALSE;
     if (bfd)
     {
       in  = bfd->absFilePath();
       doc = bfd->isLinkable() && !bfd->isHidden();
       src = bfd->generateSourceFile();
     }
     if (doc || src || !Config_getBool(HIDE_UNDOC_RELATIONS))
     {
       QCString url="";
       if (bfd) url=bfd->getOutputFileBase();
       if (!doc && src)
       {
         url=bfd->getSourceFileBase();
       }
       auto it = m_usedNodes.find(in.str());
       if (it!=m_usedNodes.end()) // file is already a node in the graph
       {
         DotNode *bn = it->second;
         n->addChild(bn,0,0);
         bn->addParent(n);
         bn->setDistance(distance);
       }
       else
       {
         QCString tmp_url;
         QCString tooltip;
         if (bfd)
         {
           tmp_url=doc || src ? bfd->getReference()+"$"+url : QCString();
           tooltip = bfd->briefDescriptionAsTooltip();
         }
         DotNode *bn = new DotNode(getNextNodeNumber(),// n
                          ii.includeName,   // label
                          tooltip,           // tip
                          tmp_url,           // url
                          FALSE,             // rootNode
                          0);                // cd
         n->addChild(bn,0,0);
         bn->addParent(n);
         m_usedNodes.insert(std::make_pair(in.str(),bn));
         bn->setDistance(distance);
  
         if (bfd) buildGraph(bn,bfd,distance+1);
       }
     }
   }
 }

引用了 FileDef::absFilePath(), DotNode::addChild(), DotNode::addParent(), Definition::briefDescriptionAsTooltip(), Config_getBool, FALSE, FileDef::generateSourceFile(), DotGraph::getNextNodeNumber(), FileDef::getOutputFileBase(), Definition::getReference(), FileDef::getSourceFileBase(), FileDef::includedByFileList(), FileDef::includeFileList(), Definition::isHidden(), FileDef::isLinkable(), m_inverse, m_usedNodes, DotNode::setDistance(), QCString::str() , 以及 TRUE.

被这些函数引用 DotInclDepGraph().

◆ computeTheGraph()

void DotInclDepGraph::computeTheGraph ( )

protectedvirtual

实现了 DotGraph.

在文件 dotincldepgraph.cpp 第 166 行定义.

 {
   computeGraph(m_startNode, Dependency, m_graphFormat, "", FALSE,
                m_inverse, m_startNode->label(), m_theGraph);
 }

引用了 DotGraph::computeGraph(), Dependency, FALSE, DotNode::label(), DotGraph::m_graphFormat, m_inverse, m_startNode , 以及 DotGraph::m_theGraph.

◆ determineTruncatedNodes()

void DotInclDepGraph::determineTruncatedNodes ( DotNodeDeque & queue )

private

在文件 dotincldepgraph.cpp 第 98 行定义.

 {
   while (!queue.empty())
   {
     DotNode *n = queue.front();
     queue.pop_front();
     if (n->isVisible() && n->isTruncated()==DotNode::Unknown)
     {
       bool truncated = FALSE;
       for (const auto &dn : n->children())
       {
         if (!dn->isVisible())
         {
           truncated = TRUE;
         }
         else
         {
           queue.push_back(dn);
         }
       }
       n->markAsTruncated(truncated);
     }
   }
 }

引用了 DotNode::children(), FALSE, DotNode::isTruncated(), DotNode::isVisible(), DotNode::markAsTruncated(), TRUE , 以及 DotNode::Unknown.

被这些函数引用 DotInclDepGraph().

◆ determineVisibleNodes()

void DotInclDepGraph::determineVisibleNodes	(	DotNodeDeque &	queue,
		int &	maxNodes
	)

private

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

 {
   while (!queue.empty() && maxNodes>0)
   {
     DotNode *n = queue.front();
     queue.pop_front();
     if (!n->isVisible() && n->distance()<=Config_getInt(MAX_DOT_GRAPH_DEPTH)) // not yet processed
     {
       n->markAsVisible();
       maxNodes--;
       // add direct children
       for (const auto &dn : n->children())
       {
         queue.push_back(dn);
       }
     }
   }
 }

引用了 DotNode::children(), Config_getInt, DotNode::distance(), DotNode::isVisible() , 以及 DotNode::markAsVisible().

被这些函数引用 DotInclDepGraph().

◆ diskName()

QCString DotInclDepGraph::diskName ( ) const

private

◆ getBaseName()

QCString DotInclDepGraph::getBaseName ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotincldepgraph.cpp 第 154 行定义.

 {
   if (m_inverse)
   {
     return m_inclByDepFileName;
   }
   else
   {
     return m_inclDepFileName;
   }
 }

引用了 m_inclByDepFileName, m_inclDepFileName , 以及 m_inverse.

◆ getMapLabel()

QCString DotInclDepGraph::getMapLabel ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotincldepgraph.cpp 第 172 行定义.

 {
   if (m_inverse)
   {
     return escapeCharsInString(m_startNode->label(),FALSE) + "dep";
   }
   else
   {
     return escapeCharsInString(m_startNode->label(),FALSE);
   }
 }

引用了 escapeCharsInString(), FALSE, DotNode::label(), m_inverse , 以及 m_startNode.

◆ isTooBig()

bool DotInclDepGraph::isTooBig ( ) const

在文件 dotincldepgraph.cpp 第 201 行定义.

 {
   return numNodes()>=Config_getInt(DOT_GRAPH_MAX_NODES);
 }

引用了 Config_getInt , 以及 numNodes().

被这些函数引用 FileDefImpl::writeIncludedByGraph() , 以及 FileDefImpl::writeIncludeGraph().

◆ isTrivial()

bool DotInclDepGraph::isTrivial ( ) const

在文件 dotincldepgraph.cpp 第 196 行定义.

 {
   return m_startNode->children().empty();
 }

引用了 DotNode::children() , 以及 m_startNode.

被这些函数引用 generateXMLForFile(), FileDefImpl::writeIncludedByGraph() , 以及 FileDefImpl::writeIncludeGraph().

◆ numNodes()

int DotInclDepGraph::numNodes ( ) const

在文件 dotincldepgraph.cpp 第 206 行定义.

 {
   return (int)m_startNode->children().size();
 }

引用了 DotNode::children() , 以及 m_startNode.

被这些函数引用 isTooBig(), FileDefImpl::writeIncludedByGraph() , 以及 FileDefImpl::writeIncludeGraph().

◆ writeDocbook()

void DotInclDepGraph::writeDocbook ( TextStream & t )

在文件 dotincldepgraph.cpp 第 219 行定义.

 {
   for (const auto &kv : m_usedNodes)
   {
     kv.second->writeDocbook(t,FALSE);
   }
 }

引用了 FALSE , 以及 m_usedNodes.

◆ writeGraph()

QCString DotInclDepGraph::writeGraph	(	TextStream &	t,
		GraphOutputFormat	gf,
		EmbeddedOutputFormat	ef,
		const QCString &	path,
		const QCString &	fileName,
		const QCString &	relPath,
		bool	writeImageMap = `TRUE`,
		int	graphId = `-1`
	)

在文件 dotincldepgraph.cpp 第 184 行定义.

 {
   return DotGraph::writeGraph(out, graphFormat, textFormat, path, fileName, relPath, generateImageMap, graphId);
 }

引用了 DotGraph::writeGraph().

被这些函数引用 RTFGenerator::endInclDepGraph(), DocbookGenerator::endInclDepGraph(), LatexGenerator::endInclDepGraph() , 以及 HtmlGenerator::endInclDepGraph().

◆ writeXML()

void DotInclDepGraph::writeXML ( TextStream & t )

在文件 dotincldepgraph.cpp 第 211 行定义.

 {
   for (const auto &kv : m_usedNodes)
   {
     kv.second->writeXML(t,FALSE);
   }
 }

引用了 FALSE , 以及 m_usedNodes.

被这些函数引用 generateXMLForFile().

类成员变量说明

◆ m_inclByDepFileName

QCString DotInclDepGraph::m_inclByDepFileName

private

在文件 dotincldepgraph.h 第 58 行定义.

被这些函数引用 DotInclDepGraph() , 以及 getBaseName().

◆ m_inclDepFileName

QCString DotInclDepGraph::m_inclDepFileName

private

在文件 dotincldepgraph.h 第 57 行定义.

被这些函数引用 DotInclDepGraph() , 以及 getBaseName().

◆ m_inverse

bool DotInclDepGraph::m_inverse

private

在文件 dotincldepgraph.h 第 59 行定义.

被这些函数引用 buildGraph(), computeTheGraph(), DotInclDepGraph(), getBaseName() , 以及 getMapLabel().

◆ m_startNode

DotNode* DotInclDepGraph::m_startNode

private

在文件 dotincldepgraph.h 第 55 行定义.

被这些函数引用 computeTheGraph(), DotInclDepGraph(), getMapLabel(), isTrivial(), numNodes() , 以及 ~DotInclDepGraph().

◆ m_usedNodes

DotNodeMap DotInclDepGraph::m_usedNodes

private

在文件 dotincldepgraph.h 第 56 行定义.

被这些函数引用 buildGraph(), DotInclDepGraph(), writeDocbook() , 以及 writeXML().

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

src/dotincldepgraph.h
src/dotincldepgraph.cpp

Public 成员函数

Protected 成员函数

Private 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DotInclDepGraph()

◆ ~DotInclDepGraph()

成员函数说明

◆ buildGraph()

◆ computeTheGraph()

◆ determineTruncatedNodes()

◆ determineVisibleNodes()

◆ diskName()

◆ getBaseName()

◆ getMapLabel()

◆ isTooBig()

◆ isTrivial()

◆ numNodes()

◆ writeDocbook()

◆ writeGraph()

◆ writeXML()

类成员变量说明

◆ m_inclByDepFileName

◆ m_inclDepFileName

◆ m_inverse

◆ m_startNode

◆ m_usedNodes