DotCallGraph Class Reference

Representation of an call graph. More...

#include <src/dotcallgraph.h>

Inheritance diagram for DotCallGraph:

Collaboration diagram for DotCallGraph:

Public Member Functions
	DotCallGraph (const MemberDef *md, bool inverse)
	~DotCallGraph () override
bool	isTrivial () const
bool	isTooBig () const
int	numNodes () const
DString	writeGraph (TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const DString &path, const DString &fileName, const DString &relPath, bool writeImageMap=true, int graphId=-1)
Public Member Functions inherited from DotGraph
	DotGraph ()
virtual	~DotGraph ()=default

Static Public Member Functions
static bool	isTrivial (const MemberDef *md, bool inverse)

Protected Member Functions
DString	getBaseName () const override
DString	getMapLabel () const override
void	computeTheGraph () override
Protected Member Functions inherited from DotGraph
int	getNextNodeNumber ()
	returns the node number.
int	getNextEdgeNumber ()
	returns the edge number.
DString	writeGraph (TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const DString &path, const DString &fileName, const DString &relPath, bool writeImageMap=true, int graphId=-1)
virtual DString	absMapName () const
virtual DString	getImgAltText () const
DString	absBaseName () const
DString	absDotName () const
DString	imgName () const
DString	absImgName () const
DString	relImgName () const

Private Member Functions
void	buildGraph (DotNode *n, const MemberDef *md, int distance)
void	determineVisibleNodes (DotNodeDeque &queue, int &maxNodes)
void	determineTruncatedNodes (DotNodeDeque &queue)

Private Attributes
DotNode *	m_startNode
DotNodeMap	m_usedNodes
bool	m_inverse
DString	m_diskName
const Definition *	m_scope

Additional Inherited Members
Static Protected Member Functions inherited from DotGraph
static void	writeGraphHeader (TextStream &t, const DString &title=DString())
static void	writeGraphFooter (TextStream &t)
static void	computeGraph (DotNode *root, GraphType gt, GraphOutputFormat format, const DString &rank, bool renderParents, bool backArrows, const DString &title, DString &graphStr)
Protected Attributes inherited from DotGraph
GraphOutputFormat	m_graphFormat = GraphOutputFormat::BITMAP
EmbeddedOutputFormat	m_textFormat = EmbeddedOutputFormat::Html
Dir	m_dir
DString	m_fileName
DString	m_relPath
bool	m_generateImageMap = false
int	m_graphId = 0
DString	m_absPath
DString	m_baseName
DString	m_theGraph
bool	m_regenerate = false
bool	m_doNotAddImageToIndex = false
bool	m_noDivTag = false
bool	m_zoomable = true
bool	m_urlOnly = false

Detailed Description

Representation of an call graph.

Definition at line 28 of file dotcallgraph.h.

Constructor & Destructor Documentation

DotCallGraph()

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

Definition at line 122 of file dotcallgraph.cpp.

{
  m_inverse = inverse;
  m_diskName = md->getOutputFileBase()+"_"+md->anchor();
  m_scope    = md->getOuterScope();
  DString uniqueId = getUniqueId(md);
  DString name;
  if (Config_getBool(HIDE_SCOPE_NAMES))
  {
    name = md->name();
  }
  else
  {
    name = md->qualifiedName();
  }
  DString tooltip = md->briefDescriptionAsTooltip();
  m_startNode = new DotNode(this,
    linkToText(md->getLanguage(),name,false),
    tooltip,
    uniqueId,
    true     // root node
  );
  m_startNode->setDistance(0);
  m_usedNodes.emplace(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);
}

References Definition::anchor(), Definition::briefDescriptionAsTooltip(), buildGraph(), Config_getBool, Config_getInt, determineTruncatedNodes(), determineVisibleNodes(), DotGraph::DotNode, Definition::getLanguage(), Definition::getOuterScope(), Definition::getOutputFileBase(), getUniqueId(), linkToText(), m_diskName, m_inverse, m_scope, m_startNode, m_usedNodes, Definition::name(), Definition::qualifiedName(), DotNode::setDistance(), and DString::str().

~DotCallGraph()

DotCallGraph::~DotCallGraph ( )

override

Definition at line 157 of file dotcallgraph.cpp.

{
  DotNode::deleteNodes(m_startNode);
}

References DotNode::deleteNodes(), and m_startNode.

Member Function Documentation

buildGraph()

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

private

Definition at line 35 of file dotcallgraph.cpp.

{
  auto refs = m_inverse ? md->getReferencedByMembers() : md->getReferencesMembers();
  for (const auto &rmd : refs)
  {
    if (rmd->isCallable())
    {
      DString 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,EdgeInfo::Blue,EdgeInfo::Solid);
        bn->addParent(n);
        bn->setDistance(distance);
      }
      else
      {
        DString name;
        if (Config_getBool(HIDE_SCOPE_NAMES))
        {
          name  = rmd->getOuterScope()==m_scope ?
            rmd->name() : rmd->qualifiedName();
        }
        else
        {
          name = rmd->qualifiedName();
        }
        DString tooltip = rmd->briefDescriptionAsTooltip();
        DotNode *bn = new DotNode(
            this,
            linkToText(rmd->getLanguage(),name,false),
            tooltip,
            uniqueId,
            0 //distance
            );
        n->addChild(bn,EdgeInfo::Blue,EdgeInfo::Solid);
        bn->addParent(n);
        bn->setDistance(distance);
        m_usedNodes.emplace(uniqueId.str(),bn);
 
        buildGraph(bn,rmd,distance+1);
      }
    }
  }
}

References DotNode::addChild(), DotNode::addParent(), EdgeInfo::Blue, buildGraph(), Config_getBool, DotGraph::DotNode, Definition::getReferencedByMembers(), Definition::getReferencesMembers(), getUniqueId(), linkToText(), m_inverse, m_scope, m_usedNodes, Definition::name(), DotNode::setDistance(), EdgeInfo::Solid, and DString::str().

Referenced by buildGraph(), and DotCallGraph().

computeTheGraph()

void DotCallGraph::computeTheGraph ( )

overrideprotectedvirtual

Implements DotGraph.

Definition at line 167 of file dotcallgraph.cpp.

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

References CallGraph, DotGraph::computeGraph(), DotNode::label(), DotGraph::m_graphFormat, m_inverse, m_startNode, and DotGraph::m_theGraph.

determineTruncatedNodes()

void DotCallGraph::determineTruncatedNodes ( DotNodeDeque & queue )

private

Definition at line 101 of file dotcallgraph.cpp.

{
  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);
    }
  }
}

References DotNode::children(), DotGraph::DotNode, DotNode::isTruncated(), DotNode::isVisible(), DotNode::markAsTruncated(), and DotNode::Unknown.

Referenced by DotCallGraph().

determineVisibleNodes()

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

private

Definition at line 82 of file dotcallgraph.cpp.

{
  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);
      }
    }
  }
}

References DotNode::children(), Config_getInt, DotNode::distance(), DotGraph::DotNode, DotNode::isVisible(), and DotNode::markAsVisible().

Referenced by DotCallGraph().

getBaseName()

DString DotCallGraph::getBaseName ( ) const

overrideprotectedvirtual

Implements DotGraph.

Definition at line 162 of file dotcallgraph.cpp.

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

References m_diskName, and m_inverse.

getMapLabel()

DString DotCallGraph::getMapLabel ( ) const

overrideprotectedvirtual

Implements DotGraph.

Definition at line 180 of file dotcallgraph.cpp.

{
  return m_baseName;
}

References DotGraph::m_baseName.

isTooBig()

bool DotCallGraph::isTooBig

(

)

const

Definition at line 204 of file dotcallgraph.cpp.

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

References Config_getInt, and numNodes().

Referenced by MemberDefImpl::_writeCallerGraph(), and MemberDefImpl::_writeCallGraph().

isTrivial() [1/2]

bool DotCallGraph::isTrivial

(

)

const

Definition at line 199 of file dotcallgraph.cpp.

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

References DotNode::children(), and m_startNode.

Referenced by MemberDefImpl::_hasVisibleCallerGraph(), MemberDefImpl::_hasVisibleCallGraph(), MemberDefImpl::_writeCallerGraph(), and MemberDefImpl::_writeCallGraph().

isTrivial() [2/2]

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

static

Definition at line 214 of file dotcallgraph.cpp.

{
  auto refs = inverse ? md->getReferencedByMembers() : md->getReferencesMembers();
  for (const auto &rmd : refs)
  {
    if (rmd->isCallable())
    {
      return false;
    }
  }
  return true;
}

References Definition::getReferencedByMembers(), and Definition::getReferencesMembers().

numNodes()

int DotCallGraph::numNodes

(

)

const

Definition at line 209 of file dotcallgraph.cpp.

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

References DotNode::children(), and m_startNode.

Referenced by MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph(), and isTooBig().

writeGraph()

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

Definition at line 185 of file dotcallgraph.cpp.

{
  m_doNotAddImageToIndex = textFormat!=EmbeddedOutputFormat::Html;
 
  return DotGraph::writeGraph(out, graphFormat, textFormat, path, fileName, relPath, generateImageMap, graphId);
}

References Html, DotGraph::m_doNotAddImageToIndex, and DotGraph::writeGraph().

Referenced by DocbookGenerator::endCallGraph(), HtmlGenerator::endCallGraph(), LatexGenerator::endCallGraph(), and RTFGenerator::endCallGraph().

Member Data Documentation

m_diskName

DString DotCallGraph::m_diskName

private

Definition at line 56 of file dotcallgraph.h.

Referenced by DotCallGraph(), and getBaseName().

m_inverse

bool DotCallGraph::m_inverse

private

Definition at line 55 of file dotcallgraph.h.

Referenced by buildGraph(), computeTheGraph(), DotCallGraph(), and getBaseName().

m_scope

const Definition* DotCallGraph::m_scope

private

Definition at line 57 of file dotcallgraph.h.

Referenced by buildGraph(), and DotCallGraph().

m_startNode

DotNode* DotCallGraph::m_startNode

private

Definition at line 53 of file dotcallgraph.h.

Referenced by computeTheGraph(), DotCallGraph(), isTrivial(), numNodes(), and ~DotCallGraph().

m_usedNodes

DotNodeMap DotCallGraph::m_usedNodes

private

Definition at line 54 of file dotcallgraph.h.

Referenced by buildGraph(), and DotCallGraph().

---

The documentation for this class was generated from the following files:

• src/dotcallgraph.h
• src/dotcallgraph.cpp