Representation of an call graph 更多...

#include <dotcallgraph.h>

类 DotCallGraph 继承关系图:

DotCallGraph 的协作图:

Public 成员函数
	DotCallGraph (const MemberDef *md, bool inverse)

	~DotCallGraph ()

bool	isTrivial () const

bool	isTooBig () const

int	numNodes () const

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

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

virtual	~DotGraph ()

静态 Public 成员函数
static bool	isTrivial (const MemberDef *md, bool inverse)

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 成员函数
void	buildGraph (DotNode n, const MemberDef md, int distance)

void	determineVisibleNodes (DotNodeDeque &queue, int &maxNodes)

void	determineTruncatedNodes (DotNodeDeque &queue)

Private 属性
DotNode *	m_startNode

DotNodeMap	m_usedNodes

bool	m_inverse

QCString	m_diskName

const Definition *	m_scope

额外继承的成员函数
静态 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 call graph

在文件 dotcallgraph.h 第 26 行定义.

构造及析构函数说明

◆ DotCallGraph()

DotCallGraph::DotCallGraph	(	const MemberDef *	md,
		bool	inverse
	)

在文件 dotcallgraph.cpp 第 120 行定义.

 {
   m_inverse = inverse;
   m_diskName = md->getOutputFileBase()+"_"+md->anchor();
   m_scope    = md->getOuterScope();
   QCString uniqueId = getUniqueId(md);
   QCString name;
   if (Config_getBool(HIDE_SCOPE_NAMES))
   {
     name = md->name();
   }
   else
   {
     name = md->qualifiedName();
   }
   QCString tooltip = md->briefDescriptionAsTooltip();
   m_startNode = new DotNode(getNextNodeNumber(),
     linkToText(md->getLanguage(),name,FALSE),
     tooltip,
     uniqueId,
     TRUE     // root node
   );
   m_startNode->setDistance(0);
   m_usedNodes.insert(std::make_pair(uniqueId.str(),m_startNode));
   buildGraph(m_startNode,md,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);
 }

引用了 MemberDef::anchor(), Definition::briefDescriptionAsTooltip(), buildGraph(), Config_getBool, Config_getInt, determineTruncatedNodes(), determineVisibleNodes(), FALSE, Definition::getLanguage(), DotGraph::getNextNodeNumber(), Definition::getOuterScope(), MemberDef::getOutputFileBase(), getUniqueId(), linkToText(), m_diskName, m_inverse, m_scope, m_startNode, m_usedNodes, Definition::name(), MemberDef::qualifiedName(), DotNode::setDistance(), QCString::str() , 以及 TRUE.

◆ ~DotCallGraph()

DotCallGraph::~DotCallGraph ( )

在文件 dotcallgraph.cpp 第 155 行定义.

 {
   DotNode::deleteNodes(m_startNode);
 }

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

成员函数说明

◆ buildGraph()

void DotCallGraph::buildGraph	(	DotNode *	n,
		const MemberDef *	md,
		int	distance
	)

private

在文件 dotcallgraph.cpp 第 33 行定义.

 {
   auto refs = m_inverse ? md->getReferencedByMembers() : md->getReferencesMembers();
   for (const auto &rmd : refs)
   {
     if (rmd->showInCallGraph())
     {
       QCString uniqueId = getUniqueId(rmd);
       auto it = m_usedNodes.find(uniqueId.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 name;
         if (Config_getBool(HIDE_SCOPE_NAMES))
         {
           name  = rmd->getOuterScope()==m_scope ?
             rmd->name() : rmd->qualifiedName();
         }
         else
         {
           name = rmd->qualifiedName();
         }
         QCString tooltip = rmd->briefDescriptionAsTooltip();
         DotNode *bn = new DotNode(
             getNextNodeNumber(),
             linkToText(rmd->getLanguage(),name,FALSE),
             tooltip,
             uniqueId,
             0 //distance
             );
         n->addChild(bn,0,0);
         bn->addParent(n);
         bn->setDistance(distance);
         m_usedNodes.insert(std::make_pair(uniqueId.str(),bn));
  
         buildGraph(bn,rmd,distance+1);
       }
     }
   }
 }

引用了 DotNode::addChild(), DotNode::addParent(), Config_getBool, FALSE, DotGraph::getNextNodeNumber(), Definition::getReferencedByMembers(), Definition::getReferencesMembers(), getUniqueId(), linkToText(), m_inverse, m_scope, m_usedNodes, Definition::name(), DotNode::setDistance() , 以及 QCString::str().

被这些函数引用 DotCallGraph().

◆ computeTheGraph()

void DotCallGraph::computeTheGraph ( )

protectedvirtual

实现了 DotGraph.

在文件 dotcallgraph.cpp 第 165 行定义.

 {
   computeGraph(
     m_startNode,
     CallGraph,
     m_graphFormat,
     m_inverse ? "RL" : "LR",
     FALSE,
     m_inverse,
     m_startNode->label(),
     m_theGraph);
 }

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

◆ determineTruncatedNodes()

void DotCallGraph::determineTruncatedNodes ( DotNodeDeque & queue )

private

在文件 dotcallgraph.cpp 第 99 行定义.

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

被这些函数引用 DotCallGraph().

◆ determineVisibleNodes()

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

private

在文件 dotcallgraph.cpp 第 80 行定义.

 {
   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().

被这些函数引用 DotCallGraph().

◆ getBaseName()

QCString DotCallGraph::getBaseName ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotcallgraph.cpp 第 160 行定义.

 {
   return m_diskName + (m_inverse ? "_icgraph" : "_cgraph");
 }

引用了 m_diskName , 以及 m_inverse.

◆ getMapLabel()

QCString DotCallGraph::getMapLabel ( ) const

protectedvirtual

实现了 DotGraph.

在文件 dotcallgraph.cpp 第 178 行定义.

 {
   return m_baseName;
 }

引用了 DotGraph::m_baseName.

◆ isTooBig()

bool DotCallGraph::isTooBig ( ) const

在文件 dotcallgraph.cpp 第 200 行定义.

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

引用了 Config_getInt , 以及 numNodes().

被这些函数引用 MemberDefImpl::_writeCallerGraph() , 以及 MemberDefImpl::_writeCallGraph().

◆ isTrivial() [1/2]

bool DotCallGraph::isTrivial ( ) const

在文件 dotcallgraph.cpp 第 195 行定义.

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

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

被这些函数引用 MemberDefImpl::_hasVisibleCallerGraph(), MemberDefImpl::_hasVisibleCallGraph(), MemberDefImpl::_writeCallerGraph() , 以及 MemberDefImpl::_writeCallGraph().

◆ isTrivial() [2/2]

bool DotCallGraph::isTrivial	(	const MemberDef *	md,
		bool	inverse
	)

static

在文件 dotcallgraph.cpp 第 210 行定义.

 {
   auto refs = inverse ? md->getReferencedByMembers() : md->getReferencesMembers();
   for (const auto &rmd : refs)
   {
     if (rmd->showInCallGraph())
     {
       return FALSE;
     }
   }
   return TRUE;
 }

引用了 FALSE, Definition::getReferencedByMembers(), Definition::getReferencesMembers() , 以及 TRUE.

◆ numNodes()

int DotCallGraph::numNodes ( ) const

在文件 dotcallgraph.cpp 第 205 行定义.

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

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

被这些函数引用 MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph() , 以及 isTooBig().

◆ writeGraph()

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

在文件 dotcallgraph.cpp 第 183 行定义.

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

引用了 DotGraph::writeGraph().

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

类成员变量说明

◆ m_diskName

QCString DotCallGraph::m_diskName

private

在文件 dotcallgraph.h 第 65 行定义.

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

◆ m_inverse

bool DotCallGraph::m_inverse

private

在文件 dotcallgraph.h 第 64 行定义.

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

◆ m_scope

const Definition* DotCallGraph::m_scope

private

在文件 dotcallgraph.h 第 66 行定义.

被这些函数引用 buildGraph() , 以及 DotCallGraph().

◆ m_startNode

DotNode* DotCallGraph::m_startNode

private

在文件 dotcallgraph.h 第 62 行定义.

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

◆ m_usedNodes

DotNodeMap DotCallGraph::m_usedNodes

private

在文件 dotcallgraph.h 第 63 行定义.

被这些函数引用 buildGraph() , 以及 DotCallGraph().

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

src/dotcallgraph.h
src/dotcallgraph.cpp

Public 成员函数

静态 Public 成员函数

Protected 成员函数

Private 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DotCallGraph()

◆ ~DotCallGraph()

成员函数说明

◆ buildGraph()

◆ computeTheGraph()

◆ determineTruncatedNodes()

◆ determineVisibleNodes()

◆ getBaseName()

◆ getMapLabel()

◆ isTooBig()

◆ isTrivial() [1/2]

◆ isTrivial() [2/2]

◆ numNodes()

◆ writeGraph()

类成员变量说明

◆ m_diskName

◆ m_inverse

◆ m_scope

◆ m_startNode

◆ m_usedNodes