DotInclDepGraph Class Reference

Representation of an include dependency graph. More...

#include <src/dotincldepgraph.h>

Inheritance diagram for DotInclDepGraph:

Collaboration diagram for DotInclDepGraph:

Public Member Functions
	DotInclDepGraph (const FileDef *fd, bool inverse)
	~DotInclDepGraph () override
DString	writeGraph (TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const DString &path, const DString &fileName, const DString &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 Member Functions inherited from DotGraph
	DotGraph ()
virtual	~DotGraph ()=default

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
DString	diskName () const
void	buildGraph (DotNode *n, const FileDef *fd, int distance)
void	determineVisibleNodes (DotNodeDeque &queue, int &maxNodes)
void	determineTruncatedNodes (DotNodeDeque &queue)

Private Attributes
DotNode *	m_startNode
DotNodeMap	m_usedNodes
DString	m_inclDepFileName
DString	m_inclByDepFileName
bool	m_inverse

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 include dependency graph.

Definition at line 29 of file dotincldepgraph.h.

Constructor & Destructor Documentation

DotInclDepGraph()

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

Definition at line 127 of file dotincldepgraph.cpp.

{
  m_inverse = inverse;
  ASSERT(fd!=nullptr);
  m_inclDepFileName   = fd->includeDependencyGraphFileName();
  m_inclByDepFileName = fd->includedByDependencyGraphFileName();
  DString tmp_url=fd->getReference()+"$"+fd->getOutputFileBase();
  DString tooltip = fd->briefDescriptionAsTooltip();
  m_startNode = new DotNode(this,
                            fd->docName(),
                            tooltip,
                            tmp_url,
                            true);    // root node
  m_startNode->setDistance(0);
  m_usedNodes.emplace(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);
}

References FileDef::absFilePath(), ASSERT, Definition::briefDescriptionAsTooltip(), buildGraph(), Config_getInt, determineTruncatedNodes(), determineVisibleNodes(), FileDef::docName(), DotGraph::DotNode, Definition::getOutputFileBase(), Definition::getReference(), FileDef::includedByDependencyGraphFileName(), FileDef::includeDependencyGraphFileName(), m_inclByDepFileName, m_inclDepFileName, m_inverse, m_startNode, m_usedNodes, DotNode::setDistance(), and DString::str().

~DotInclDepGraph()

DotInclDepGraph::~DotInclDepGraph ( )

override

Definition at line 153 of file dotincldepgraph.cpp.

{
  DotNode::deleteNodes(m_startNode);
}

References DotNode::deleteNodes(), and m_startNode.

Member Function Documentation

buildGraph()

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

private

Definition at line 26 of file dotincldepgraph.cpp.

{
  const IncludeInfoList &includeFiles = m_inverse ? fd->includedByFileList() : fd->includeFileList();
  for (const auto &ii : includeFiles)
  {
    const FileDef *bfd = ii.fileDef;
    DString 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))
    {
      DString 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,EdgeInfo::Blue,EdgeInfo::Solid);
        bn->addParent(n);
        bn->setDistance(distance);
      }
      else
      {
        DString tmp_url;
        DString tooltip;
        if (bfd)
        {
          tmp_url=doc || src ? bfd->getReference()+"$"+url : DString();
          tooltip = bfd->briefDescriptionAsTooltip();
        }
        DotNode *bn = new DotNode(this,
                         ii.includeName,   // label
                         tooltip,           // tip
                         tmp_url,           // url
                         false,             // rootNode
                         nullptr);                // cd
        n->addChild(bn,EdgeInfo::Blue,EdgeInfo::Solid);
        bn->addParent(n);
        m_usedNodes.emplace(in.str(),bn);
        bn->setDistance(distance);
 
        if (bfd) buildGraph(bn,bfd,distance+1);
      }
    }
  }
}

References FileDef::absFilePath(), DotNode::addChild(), DotNode::addParent(), EdgeInfo::Blue, Definition::briefDescriptionAsTooltip(), buildGraph(), Config_getBool, DotGraph::DotNode, FileDef::generateSourceFile(), Definition::getOutputFileBase(), Definition::getReference(), Definition::getSourceFileBase(), FileDef::includedByFileList(), FileDef::includeFileList(), Definition::isHidden(), Definition::isLinkable(), m_inverse, m_usedNodes, DotNode::setDistance(), EdgeInfo::Solid, and DString::str().

Referenced by buildGraph(), and DotInclDepGraph().

computeTheGraph()

void DotInclDepGraph::computeTheGraph ( )

overrideprotectedvirtual

Implements DotGraph.

Definition at line 170 of file dotincldepgraph.cpp.

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

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

determineTruncatedNodes()

void DotInclDepGraph::determineTruncatedNodes ( DotNodeDeque & queue )

private

Definition at line 102 of file dotincldepgraph.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 DotInclDepGraph().

determineVisibleNodes()

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

private

Definition at line 83 of file dotincldepgraph.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 DotInclDepGraph().

diskName()

DString DotInclDepGraph::diskName ( ) const

private

References DotGraph::DotNode.

getBaseName()

DString DotInclDepGraph::getBaseName ( ) const

overrideprotectedvirtual

Implements DotGraph.

Definition at line 158 of file dotincldepgraph.cpp.

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

References m_inclByDepFileName, m_inclDepFileName, and m_inverse.

getMapLabel()

DString DotInclDepGraph::getMapLabel ( ) const

overrideprotectedvirtual

Implements DotGraph.

Definition at line 176 of file dotincldepgraph.cpp.

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

References escapeCharsInString(), DotNode::label(), m_inverse, and m_startNode.

isTooBig()

bool DotInclDepGraph::isTooBig

(

)

const

Definition at line 207 of file dotincldepgraph.cpp.

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

References Config_getInt, and numNodes().

Referenced by FileDefImpl::writeIncludedByGraph(), and FileDefImpl::writeIncludeGraph().

isTrivial()

bool DotInclDepGraph::isTrivial

(

)

const

Definition at line 202 of file dotincldepgraph.cpp.

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

References DotNode::children(), and m_startNode.

Referenced by generateXMLForFile(), FileDefImpl::writeIncludedByGraph(), and FileDefImpl::writeIncludeGraph().

numNodes()

int DotInclDepGraph::numNodes

(

)

const

Definition at line 212 of file dotincldepgraph.cpp.

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

References DotNode::children(), and m_startNode.

Referenced by isTooBig(), FileDefImpl::writeIncludedByGraph(), and FileDefImpl::writeIncludeGraph().

writeDocbook()

void DotInclDepGraph::writeDocbook

(

TextStream &

t

)

Definition at line 225 of file dotincldepgraph.cpp.

{
  for (const auto &[name,node] : m_usedNodes)
  {
    node->writeDocbook(t,false);
  }
}

References m_usedNodes.

writeGraph()

DString DotInclDepGraph::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 188 of file dotincldepgraph.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::endInclDepGraph(), HtmlGenerator::endInclDepGraph(), LatexGenerator::endInclDepGraph(), and RTFGenerator::endInclDepGraph().

writeXML()

void DotInclDepGraph::writeXML

(

TextStream &

t

)

Definition at line 217 of file dotincldepgraph.cpp.

{
  for (const auto &[name,node] : m_usedNodes)
  {
    node->writeXML(t,false);
  }
}

References m_usedNodes.

Referenced by generateXMLForFile().

Member Data Documentation

m_inclByDepFileName

DString DotInclDepGraph::m_inclByDepFileName

private

Definition at line 59 of file dotincldepgraph.h.

Referenced by DotInclDepGraph(), and getBaseName().

m_inclDepFileName

DString DotInclDepGraph::m_inclDepFileName

private

Definition at line 58 of file dotincldepgraph.h.

Referenced by DotInclDepGraph(), and getBaseName().

m_inverse

bool DotInclDepGraph::m_inverse

private

Definition at line 60 of file dotincldepgraph.h.

Referenced by buildGraph(), computeTheGraph(), DotInclDepGraph(), getBaseName(), and getMapLabel().

m_startNode

DotNode* DotInclDepGraph::m_startNode

private

Definition at line 56 of file dotincldepgraph.h.

Referenced by computeTheGraph(), DotInclDepGraph(), getMapLabel(), isTrivial(), numNodes(), and ~DotInclDepGraph().

m_usedNodes

DotNodeMap DotInclDepGraph::m_usedNodes

private

Definition at line 57 of file dotincldepgraph.h.

Referenced by buildGraph(), DotInclDepGraph(), writeDocbook(), and writeXML().

---

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

• src/dotincldepgraph.h
• src/dotincldepgraph.cpp