A dot graph. More...

#include <src/dotgraph.h>

Inheritance diagram for DotGraph:

Collaboration diagram for DotGraph:

Public Member Functions
	DotGraph ()
virtual	~DotGraph ()=default

Protected Member Functions
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	getBaseName () const =0
virtual DString	absMapName () const
virtual DString	getMapLabel () const =0
virtual DString	getImgAltText () const
virtual void	computeTheGraph ()=0
DString	absBaseName () const
DString	absDotName () const
DString	imgName () const
DString	absImgName () const
DString	relImgName () const

Static Protected Member Functions
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
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

Private Member Functions
bool	prepareDotFile ()
void	generateCode (TextStream &t)

Private Attributes
int	m_curNodeNumber = 0
int	m_curEdgeNumber = 0

Friends
class	DotNode

Detailed Description

A dot graph.

Definition at line 34 of file dotgraph.h.

Constructor & Destructor Documentation

◆ DotGraph()

DotGraph::DotGraph ( )

inline

Definition at line 38 of file dotgraph.h.

38 : m_doNotAddImageToIndex(false), m_noDivTag(false),

39 m_zoomable(true), m_urlOnly(false) {}

DotGraph::m_noDivTag

bool m_noDivTag

Definition dotgraph.h:98

DotGraph::m_urlOnly

bool m_urlOnly

Definition dotgraph.h:100

DotGraph::m_doNotAddImageToIndex

bool m_doNotAddImageToIndex

Definition dotgraph.h:97

DotGraph::m_zoomable

bool m_zoomable

Definition dotgraph.h:99

References m_doNotAddImageToIndex, m_noDivTag, m_urlOnly, and m_zoomable.

Referenced by ~DotGraph().

◆ ~DotGraph()

virtual DotGraph::~DotGraph ( )

virtualdefault

References DotGraph().

Member Function Documentation

◆ absBaseName()

DString DotGraph::absBaseName ( ) const

inlineprotected

Definition at line 78 of file dotgraph.h.

78{ return m_absPath + m_baseName; }

DotGraph::m_baseName

DString m_baseName

Definition dotgraph.h:94

DotGraph::m_absPath

DString m_absPath

Definition dotgraph.h:93

References m_absPath, and m_baseName.

Referenced by generateCode(), prepareDotFile(), and DotLegendGraph::writeGraph().

◆ absDotName()

DString DotGraph::absDotName ( ) const

inlineprotected

Definition at line 79 of file dotgraph.h.

79{ return m_absPath + m_baseName + ".dot"; }

References m_absPath, and m_baseName.

Referenced by prepareDotFile().

◆ absImgName()

DString DotGraph::absImgName ( ) const

inlineprotected

Definition at line 81 of file dotgraph.h.

81{ return m_absPath + imgName(); }

DotGraph::imgName

DString imgName() const

Definition dotgraph.cpp:107

References imgName(), and m_absPath.

Referenced by generateCode(), prepareDotFile(), and DotLegendGraph::writeGraph().

◆ absMapName()

virtual DString DotGraph::absMapName ( ) const

inlineprotectedvirtual

Definition at line 72 of file dotgraph.h.

72{ return m_absPath + m_baseName + ".map"; }

References m_absPath, and m_baseName.

Referenced by generateCode(), and prepareDotFile().

◆ computeGraph()

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

staticprotected

Definition at line 300 of file dotgraph.cpp.

{
  //printf("computeMd5Signature\n");
  TextStream md5stream;
  writeGraphHeader(md5stream,title);
  if (!rank.empty())
  {
    md5stream << "  rankdir=\"" << rank << "\";\n";
  }
  root->clearWriteFlag();
  root->write(md5stream, gt, format, gt!=GraphType::CallGraph && gt!=GraphType::Dependency, true, backArrows);
  if (renderParents)
  {
    for (const auto &pn : root->parents())
    {
      if (pn->isVisible())
      {
        const auto &children = pn->children();
        auto child_it = std::find(children.begin(),children.end(),root);
        size_t index = child_it - children.begin();
        root->writeArrow(md5stream,                              // stream
            gt,                                                  // graph type
            format,                                              // output format
            pn,                                                  // child node
            &pn->edgeInfo()[index],                              // edge info
            false,                                               // topDown?
            backArrows                                           // point back?
          );
      }
      pn->write(md5stream,      // stream
                gt,             // graph type
                format,         // output format
                true,           // topDown?
                false,          // toChildren?
                backArrows      // backward pointing arrows?
      );
    }
  }
  writeGraphFooter(md5stream);
 
  graphStr=md5stream.str();
}

References CallGraph, DotNode::clearWriteFlag(), Dependency, DotNode, DString::empty(), DotNode::parents(), TextStream::str(), DotNode::write(), DotNode::writeArrow(), writeGraphFooter(), and writeGraphHeader().

Referenced by DotCallGraph::computeTheGraph(), DotClassGraph::computeTheGraph(), and DotInclDepGraph::computeTheGraph().

◆ computeTheGraph()

virtual void DotGraph::computeTheGraph ( )

protectedpure virtual

Implemented in DotCallGraph, DotClassGraph, DotDirDeps, DotGfxHierarchyTable, DotGroupCollaboration, DotInclDepGraph, and DotLegendGraph.

Referenced by writeGraph().

◆ generateCode()

void DotGraph::generateCode ( TextStream & t )

private

Definition at line 205 of file dotgraph.cpp.

{
  DString imgExt = getDotImageExtension();
  if (m_graphFormat==GraphOutputFormat::BITMAP && m_textFormat==EmbeddedOutputFormat::DocBook)
  {
    t << "<para>\n";
    t << "    <informalfigure>\n";
    t << "        <mediaobject>\n";
    t << "            <imageobject>\n";
    t << "                <imagedata";
    t << " width=\"50%\" align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\"" << m_relPath << m_baseName << "." << imgExt << "\">";
    t << "</imagedata>\n";
    t << "            </imageobject>\n";
    t << "        </mediaobject>\n";
    t << "    </informalfigure>\n";
    t << "</para>\n";
  }
  else if (m_graphFormat==GraphOutputFormat::BITMAP && m_generateImageMap) // produce HTML to include the image
  {
    if (imgExt=="svg") // add link to SVG file without map file
    {
      if (!m_noDivTag) t << "<div class=\"center\">";
      if (m_regenerate || !DotFilePatcher::writeSVGFigureLink(t,m_relPath,m_baseName,absImgName())) // need to patch the links in the generated SVG file
      {
        if (m_regenerate)
        {
          DotManager::instance()->
               createFilePatcher(absImgName())->
               addSVGConversion(m_relPath,false,DString(),m_zoomable,m_graphId);
        }
        int mapId = DotManager::instance()->
               createFilePatcher(m_fileName)->
               addSVGObject(m_baseName,absImgName(),m_relPath);
        t << "<!-- " << "SVG " << mapId << " -->";
      }
      if (!m_noDivTag) t << "</div>\n";
    }
    else // add link to bitmap file with image map
    {
      if (!m_noDivTag) t << "<div class=\"center\">";
      t << "<img src=\"" << relImgName() << "\" border=\"0\" usemap=\"#"
        << DotFilePatcher::mapLabelToId(getMapLabel()) << "\" loading=\"lazy\" alt=\"" << getImgAltText() << "\"/>";
      if (!m_noDivTag) t << "</div>";
      t << "\n";
      if (m_regenerate || !insertMapFile(t, absMapName(), m_relPath, DotFilePatcher::mapLabelToId(getMapLabel())))
      {
        int mapId = DotManager::instance()->
          createFilePatcher(m_fileName)->
          addMap(absMapName(), m_relPath, m_urlOnly, DString(), getMapLabel());
        t << "<!-- MAP " << mapId << " -->\n";
      }
    }
  }
  else if (m_graphFormat==GraphOutputFormat::EPS) // produce tex to include the .eps image
  {
    if (m_regenerate || !DotFilePatcher::writeVecGfxFigure(t,m_baseName,absBaseName()))
    {
      int figId = DotManager::instance()->
                  createFilePatcher(m_fileName)->
                  addFigure(m_baseName,absBaseName(),false /*true*/);
      t << "\n% FIG " << figId << "\n";
    }
  }
}

References absBaseName(), absImgName(), absMapName(), BITMAP, DocBook, EPS, getDotImageExtension(), getImgAltText(), getMapLabel(), insertMapFile(), DotManager::instance(), m_baseName, m_fileName, m_generateImageMap, m_graphFormat, m_graphId, m_noDivTag, m_regenerate, m_relPath, m_textFormat, m_urlOnly, m_zoomable, DotFilePatcher::mapLabelToId(), relImgName(), DotFilePatcher::writeSVGFigureLink(), and DotFilePatcher::writeVecGfxFigure().

Referenced by writeGraph().

◆ getBaseName()

virtual DString DotGraph::getBaseName ( ) const

protectedpure virtual

Implemented in DotCallGraph, DotClassGraph, DotDirDeps, DotGfxHierarchyTable, DotGroupCollaboration, DotInclDepGraph, and DotLegendGraph.

Referenced by writeGraph().

◆ getImgAltText()

virtual DString DotGraph::getImgAltText ( ) const

inlineprotectedvirtual

Reimplemented in DotClassGraph, and DotDirDeps.

Definition at line 74 of file dotgraph.h.

74{ return ""; }

Referenced by generateCode().

◆ getMapLabel()

virtual DString DotGraph::getMapLabel ( ) const

protectedpure virtual

Implemented in DotCallGraph, DotClassGraph, DotDirDeps, DotGfxHierarchyTable, DotGroupCollaboration, DotInclDepGraph, and DotLegendGraph.

Referenced by generateCode().

◆ getNextEdgeNumber()

int DotGraph::getNextEdgeNumber ( )

inlineprotected

returns the edge number.

Definition at line 47 of file dotgraph.h.

47{ return ++m_curEdgeNumber; }

DotGraph::m_curEdgeNumber

int m_curEdgeNumber

Definition dotgraph.h:108

References m_curEdgeNumber.

Referenced by DotNode::writeArrow().

◆ getNextNodeNumber()

int DotGraph::getNextNodeNumber ( )

inlineprotected

returns the node number.

Definition at line 45 of file dotgraph.h.

45{ return ++m_curNodeNumber; }

DotGraph::m_curNodeNumber

int m_curNodeNumber

Definition dotgraph.h:107

References m_curNodeNumber.

◆ imgName()

DString DotGraph::imgName ( ) const

protected

Definition at line 107 of file dotgraph.cpp.

{
  return m_baseName + ((m_graphFormat == GraphOutputFormat::BITMAP) ?
                      ("." + getDotImageExtension()) : (Config_getBool(USE_PDFLATEX) ? ".pdf" : ".eps"));
}

References BITMAP, Config_getBool, getDotImageExtension(), m_baseName, and m_graphFormat.

Referenced by absImgName(), relImgName(), and writeGraph().

◆ prepareDotFile()

bool DotGraph::prepareDotFile ( )

private

Definition at line 151 of file dotgraph.cpp.

{
  if (!m_dir.exists())
  {
    term("Output dir {} does not exist!\n", m_dir.path());
  }
 
  // calculate md5
  DString sigStr = md5str(m_theGraph.view());
 
  // already queued files are processed again in case the output format has changed
 
  if (sameMd5Signature(absBaseName(), sigStr) &&
      deliverablesPresent(absImgName(),
                          m_graphFormat == GraphOutputFormat::BITMAP && m_generateImageMap ? absMapName() : DString()
                         )
     )
  {
    // all needed files are there
    return false;
  }
 
  // need to rebuild the image
 
  // write .dot file because image was new or has changed
  std::ofstream f = Portable::openOutputStream(absDotName());
  if (!f.is_open())
  {
    err("Could not open file {} for writing\n",absDotName());
    return true;
  }
  f << m_theGraph;
  f.close();
 
  if (m_graphFormat == GraphOutputFormat::BITMAP)
  {
    // run dot to create a bitmap image
    DotManager::instance()->addJob(DotJob(m_absPath, m_baseName + ".dot", Config_getEnumAsString(DOT_IMAGE_FORMAT), sigStr, absDotName(), m_theGraph.size(), m_generateImageMap));
  }
  else if (m_graphFormat == GraphOutputFormat::EPS)
  {
    // run dot to create a .eps image
    if (Config_getBool(USE_PDFLATEX))
    {
      DotManager::instance()->addJob(DotJob(m_absPath, m_baseName + ".dot", "pdf", sigStr, absDotName(), m_theGraph.size()));
    }
    else
    {
      DotManager::instance()->addJob(DotJob(m_absPath, m_baseName + ".dot", "eps", sigStr, absDotName(), m_theGraph.size()));
    }
  }
  return true;
}

References absBaseName(), absDotName(), absImgName(), absMapName(), DotManager::addJob(), BITMAP, Config_getBool, Config_getEnumAsString, deliverablesPresent(), EPS, err, Dir::exists(), DotManager::instance(), m_absPath, m_baseName, m_dir, m_generateImageMap, m_graphFormat, m_theGraph, md5str(), Portable::openOutputStream(), Dir::path(), sameMd5Signature(), DString::size(), term, and DString::view().

Referenced by writeGraph().

◆ relImgName()

DString DotGraph::relImgName ( ) const

inlineprotected

Definition at line 82 of file dotgraph.h.

82{ return m_relPath + imgName(); }

References imgName(), and m_relPath.

Referenced by generateCode().

◆ writeGraph()

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

protected

Definition at line 115 of file dotgraph.cpp.

{
  m_graphFormat = gf;
  m_textFormat = ef;
  m_dir = Dir(path.str());
  m_fileName = fileName;
  m_relPath = relPath;
  m_generateImageMap = generateImageMap;
  m_graphId = graphId;
 
  m_absPath  = m_dir.absPath() + "/";
  m_baseName = getBaseName();
 
  computeTheGraph();
 
  m_regenerate = prepareDotFile();
 
  if (!m_doNotAddImageToIndex)
  {
    std::lock_guard<std::mutex> lock(g_dotIndexListMutex);
    Doxygen::indexList->addImageFile(imgName());
  }
 
  generateCode(t);
 
  return m_baseName;
}

References Dir::absPath(), IndexList::addImageFile(), computeTheGraph(), g_dotIndexListMutex, generateCode(), getBaseName(), imgName(), Doxygen::indexList, m_absPath, m_baseName, m_dir, m_doNotAddImageToIndex, m_fileName, m_generateImageMap, m_graphFormat, m_graphId, m_regenerate, m_relPath, m_textFormat, prepareDotFile(), and DString::str().

Referenced by DotGfxHierarchyTable::createGraph(), DotCallGraph::writeGraph(), DotClassGraph::writeGraph(), DotDirDeps::writeGraph(), DotGroupCollaboration::writeGraph(), DotInclDepGraph::writeGraph(), and DotLegendGraph::writeGraph().

◆ writeGraphFooter()

void DotGraph::writeGraphFooter ( TextStream & t )

staticprotected

Definition at line 295 of file dotgraph.cpp.

{
  t << "}\n";
}

Referenced by computeGraph(), DotDirDeps::computeTheGraph(), DotGfxHierarchyTable::computeTheGraph(), DotGroupCollaboration::computeTheGraph(), and DotLegendGraph::computeTheGraph().

◆ writeGraphHeader()

void DotGraph::writeGraphHeader	(	TextStream &	t,
		const DString &	title = DString() )

staticprotected

Definition at line 270 of file dotgraph.cpp.

{
  t << "digraph ";
  if (title.empty())
  {
    t << "\"Dot Graph\"";
  }
  else
  {
    t << "\"" << convertToXML(title) << "\"";
  }
  t << "\n{\n";
  if (Config_getBool(INTERACTIVE_SVG)) // insert a comment to force regeneration when this
                       // option is toggled
  {
    t << " // INTERACTIVE_SVG=YES\n";
  }
  t << " // LATEX_PDF_SIZE\n"; // write placeholder for LaTeX PDF bounding box size replacement
  t << "  bgcolor=\"transparent\";\n";
  DString c = Config_getString(DOT_COMMON_ATTR);
  if (!c.empty()) c += ",";
  t << "  edge [" << c << Config_getString(DOT_EDGE_ATTR) << "];\n";
  t << "  node [" << c << Config_getString(DOT_NODE_ATTR) << "];\n";
}