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
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 Member Functions inherited from DotGraph
	DotGraph ()
virtual	~DotGraph ()=default

Protected Member Functions
QCString	getBaseName () const override
QCString	getMapLabel () const override
void	computeTheGraph () override
Protected Member Functions inherited from DotGraph
int	getNextNodeNumber ()
	returns the node number.
int	getNextEdgeNumber ()
	returns the edge number.
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 Member Functions
QCString	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
QCString	m_inclDepFileName
QCString	m_inclByDepFileName
bool	m_inverse

Additional Inherited Members
Static Protected Member Functions inherited from 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 Attributes inherited from DotGraph
GraphOutputFormat	m_graphFormat = GraphOutputFormat::BITMAP
EmbeddedOutputFormat	m_textFormat = EmbeddedOutputFormat::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

Detailed Description

Representation of an include dependency graph.

Definition at line 30 of file dotincldepgraph.h.

Constructor & Destructor Documentation

DotInclDepGraph()

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

Definition at line 123 of file dotincldepgraph.cpp.

{
  m_inverse = inverse;
  ASSERT(fd!=nullptr);
  m_inclDepFileName   = fd->includeDependencyGraphFileName();
  m_inclByDepFileName = fd->includedByDependencyGraphFileName();
  QCString tmp_url=fd->getReference()+"$"+fd->getOutputFileBase();
  QCString 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, QCString::str(), and TRUE.

~DotInclDepGraph()

DotInclDepGraph::~DotInclDepGraph ( )

override

Definition at line 149 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 22 of file dotincldepgraph.cpp.

{
  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,EdgeInfo::Blue,EdgeInfo::Solid);
        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(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, FALSE, FileDef::generateSourceFile(), Definition::getOutputFileBase(), Definition::getReference(), Definition::getSourceFileBase(), FileDef::includedByFileList(), FileDef::includeFileList(), Definition::isHidden(), Definition::isLinkable(), m_inverse, m_usedNodes, DotNode::setDistance(), EdgeInfo::Solid, QCString::str(), and TRUE.

Referenced by buildGraph(), and DotInclDepGraph().

computeTheGraph()

void DotInclDepGraph::computeTheGraph ( )

overrideprotectedvirtual

Implements DotGraph.

Definition at line 166 of file dotincldepgraph.cpp.

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

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

determineTruncatedNodes()

void DotInclDepGraph::determineTruncatedNodes ( DotNodeDeque & queue )

private

Definition at line 98 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, FALSE, DotNode::isTruncated(), DotNode::isVisible(), DotNode::markAsTruncated(), TRUE, and DotNode::Unknown.

Referenced by DotInclDepGraph().

determineVisibleNodes()

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

private

Definition at line 79 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()

QCString DotInclDepGraph::diskName ( ) const

private

References DotGraph::DotNode.

getBaseName()

QCString DotInclDepGraph::getBaseName ( ) const

overrideprotectedvirtual

Implements DotGraph.

Definition at line 154 of file dotincldepgraph.cpp.

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

References m_inclByDepFileName, m_inclDepFileName, and m_inverse.

getMapLabel()

QCString DotInclDepGraph::getMapLabel ( ) const

overrideprotectedvirtual

Implements DotGraph.

Definition at line 172 of file dotincldepgraph.cpp.

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

References escapeCharsInString(), FALSE, m_inverse, and m_startNode.

isTooBig()

bool DotInclDepGraph::isTooBig

(

)

const

Definition at line 201 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 196 of file dotincldepgraph.cpp.

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

References m_startNode.

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

numNodes()

int DotInclDepGraph::numNodes

(

)

const

Definition at line 206 of file dotincldepgraph.cpp.

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

References m_startNode.

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

writeDocbook()

void DotInclDepGraph::writeDocbook

(

TextStream &

t

)

Definition at line 219 of file dotincldepgraph.cpp.

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

References FALSE, and 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 )

Definition at line 184 of file dotincldepgraph.cpp.

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

References DotGraph::writeGraph().

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

writeXML()

void DotInclDepGraph::writeXML

(

TextStream &

t

)

Definition at line 211 of file dotincldepgraph.cpp.

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

References FALSE, and m_usedNodes.

Referenced by generateXMLForFile().

Member Data Documentation

m_inclByDepFileName

QCString DotInclDepGraph::m_inclByDepFileName

private

Definition at line 60 of file dotincldepgraph.h.

Referenced by DotInclDepGraph(), and getBaseName().

m_inclDepFileName

QCString DotInclDepGraph::m_inclDepFileName

private

Definition at line 59 of file dotincldepgraph.h.

Referenced by DotInclDepGraph(), and getBaseName().

m_inverse

bool DotInclDepGraph::m_inverse

private

Definition at line 61 of file dotincldepgraph.h.

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

m_startNode

DotNode* DotInclDepGraph::m_startNode

private

Definition at line 57 of file dotincldepgraph.h.

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

m_usedNodes

DotNodeMap DotInclDepGraph::m_usedNodes

private

Definition at line 58 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