DotGraph类 参考

A dot graph 更多...

#include <dotgraph.h>

类 DotGraph 继承关系图:

DotGraph 的协作图:

Public 成员函数
	DotGraph ()
virtual	~DotGraph ()

Protected 成员函数
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	getBaseName () const =0
virtual QCString	absMapName () const
virtual QCString	getMapLabel () const =0
virtual QCString	getImgAltText () const
virtual void	computeTheGraph ()=0
QCString	absBaseName () const
QCString	absDotName () const
QCString	imgName () const
QCString	absImgName () const
QCString	relImgName () const

静态 Protected 成员函数
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 属性
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

Private 成员函数
	DotGraph (const DotGraph &)
DotGraph &	operator= (const DotGraph &)
bool	prepareDotFile ()
void	generateCode (TextStream &t)

Private 属性
int	m_curNodeNumber = 0

详细描述

A dot graph

在文件 dotgraph.h 第 32 行定义.

构造及析构函数说明

DotGraph() [1/2]

DotGraph::DotGraph ( )

inline

在文件 dotgraph.h 第 35 行定义.

               : m_doNotAddImageToIndex(FALSE), m_noDivTag(FALSE),
                 m_zoomable(TRUE), m_urlOnly(FALSE) {}

~DotGraph()

virtual DotGraph::~DotGraph ( )

inlinevirtual

在文件 dotgraph.h 第 37 行定义.

{}

DotGraph() [2/2]

DotGraph::DotGraph ( const DotGraph &  )

private

成员函数说明

absBaseName()

QCString DotGraph::absBaseName ( ) const

inlineprotected

在文件 dotgraph.h 第 72 行定义.

{ return m_absPath + m_baseName; }

引用了 m_absPath , 以及 m_baseName.

被这些函数引用 generateCode(), prepareDotFile() , 以及 DotLegendGraph::writeGraph().

absDotName()

QCString DotGraph::absDotName ( ) const

inlineprotected

在文件 dotgraph.h 第 73 行定义.

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

引用了 m_absPath , 以及 m_baseName.

被这些函数引用 prepareDotFile().

absImgName()

QCString DotGraph::absImgName ( ) const

inlineprotected

在文件 dotgraph.h 第 75 行定义.

{ return m_absPath + imgName(); }

引用了 imgName() , 以及 m_absPath.

被这些函数引用 generateCode(), prepareDotFile() , 以及 DotLegendGraph::writeGraph().

absMapName()

virtual QCString DotGraph::absMapName ( ) const

inlineprotectedvirtual

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

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

引用了 m_absPath , 以及 m_baseName.

被这些函数引用 generateCode() , 以及 prepareDotFile().

computeGraph()

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

staticprotected

在文件 dotgraph.cpp 第 305 行定义.

{
  //printf("computeMd5Signature\n");
  TextStream md5stream;
  writeGraphHeader(md5stream,title);
  if (!rank.isEmpty())
  {
    md5stream << "  rankdir=\"" << rank << "\";\n";
  }
  root->clearWriteFlag();
  root->write(md5stream, gt, format, gt!=CallGraph && gt!=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();
}

引用了 CallGraph, DotNode::clearWriteFlag(), Dependency, FALSE, QCString::isEmpty(), DotNode::parents(), TextStream::str(), TRUE, DotNode::write(), DotNode::writeArrow(), writeGraphFooter() , 以及 writeGraphHeader().

被这些函数引用 DotClassGraph::computeTheGraph(), DotInclDepGraph::computeTheGraph() , 以及 DotCallGraph::computeTheGraph().

computeTheGraph()

virtual void DotGraph::computeTheGraph ( )

protectedpure virtual

在 DotDirDeps, DotCallGraph, DotClassGraph, DotInclDepGraph, DotGfxHierarchyTable, DotLegendGraph , 以及 DotGroupCollaboration 内被实现.

被这些函数引用 writeGraph().

generateCode()

void DotGraph::generateCode ( TextStream &  t )

private

在文件 dotgraph.cpp 第 204 行定义.

{
  QCString imgExt = getDotImageExtension();
  if (m_graphFormat==GOF_BITMAP && m_textFormat==EOF_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==GOF_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,QCString(),m_zoomable,m_graphId);
        }
        int mapId = DotManager::instance()->
               createFilePatcher(m_fileName)->
               addSVGObject(m_baseName,absImgName(),m_relPath);
        t << "<!-- SVG " << mapId << " -->\n";
      }
      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=\"#" << correctId(getMapLabel()) << "\" alt=\"" << getImgAltText() << "\"/>";
      if (!m_noDivTag) t << "</div>";
      t << "\n";
      if (m_regenerate || !insertMapFile(t, absMapName(), m_relPath, correctId(getMapLabel())))
      {
        int mapId = DotManager::instance()->
          createFilePatcher(m_fileName)->
          addMap(absMapName(), m_relPath, m_urlOnly, QCString(), getMapLabel());
        t << "<!-- MAP " << mapId << " -->\n";
      }
    }
  }
  else if (m_graphFormat==GOF_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";
    }
  }
}

引用了 absBaseName(), absImgName(), absMapName(), correctId(), EOF_DocBook, FALSE, getDotImageExtension(), getImgAltText(), getMapLabel(), GOF_BITMAP, GOF_EPS, 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, relImgName(), DotFilePatcher::writeSVGFigureLink() , 以及 DotFilePatcher::writeVecGfxFigure().

被这些函数引用 writeGraph().

getBaseName()

virtual QCString DotGraph::getBaseName ( ) const

protectedpure virtual

在 DotDirDeps, DotCallGraph, DotClassGraph, DotInclDepGraph, DotGfxHierarchyTable, DotLegendGraph , 以及 DotGroupCollaboration 内被实现.

被这些函数引用 writeGraph().

getImgAltText()

virtual QCString DotGraph::getImgAltText ( ) const

inlineprotectedvirtual

被 DotDirDeps , 以及 DotClassGraph 重载.

在文件 dotgraph.h 第 68 行定义.

{ return ""; }

被这些函数引用 generateCode().

getMapLabel()

virtual QCString DotGraph::getMapLabel ( ) const

protectedpure virtual

在 DotDirDeps, DotCallGraph, DotClassGraph, DotInclDepGraph, DotLegendGraph, DotGfxHierarchyTable , 以及 DotGroupCollaboration 内被实现.

被这些函数引用 generateCode().

getNextNodeNumber()

int DotGraph::getNextNodeNumber ( )

inlineprotected

returns node numbers.

The Counter is reset by the constructor

在文件 dotgraph.h 第 41 行定义.

{ return ++m_curNodeNumber; }

引用了 m_curNodeNumber.

被这些函数引用 DotClassGraph::addClass(), DotGfxHierarchyTable::addClassList(), DotGroupCollaboration::addCollaborationMember(), DotGfxHierarchyTable::addHierarchy(), DotInclDepGraph::buildGraph(), DotCallGraph::buildGraph(), DotGroupCollaboration::buildGraph(), DotCallGraph::DotCallGraph(), DotClassGraph::DotClassGraph(), DotGroupCollaboration::DotGroupCollaboration() , 以及 DotInclDepGraph::DotInclDepGraph().

imgName()

QCString DotGraph::imgName ( ) const

protected

在文件 dotgraph.cpp 第 105 行定义.

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

引用了 Config_getBool, getDotImageExtension(), GOF_BITMAP, m_baseName , 以及 m_graphFormat.

被这些函数引用 absImgName(), relImgName() , 以及 writeGraph().

operator=()

DotGraph& DotGraph::operator= ( const DotGraph &  )

private

prepareDotFile()

bool DotGraph::prepareDotFile ( )

private

在文件 dotgraph.cpp 第 143 行定义.

{
  if (!m_dir.exists())
  {
    term("Output dir %s does not exist!\n", m_dir.path().c_str());
  }
 
  char sigStr[33];
  uchar md5_sig[16];
  // calculate md5
  MD5Buffer((const unsigned char*)m_theGraph.data(), m_theGraph.length(), md5_sig);
  // convert result to a string
  MD5SigToString(md5_sig, sigStr);
 
  // already queued files are processed again in case the output format has changed
 
  if (sameMd5Signature(absBaseName(), sigStr) &&
      deliverablesPresent(absImgName(),
                          m_graphFormat == GOF_BITMAP && m_generateImageMap ? absMapName() : QCString()
                         )
     )
  {
    // 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(absDotName().str(),std::ofstream::out | std::ofstream::binary);
  if (!f.is_open())
  {
    err("Could not open file %s for writing\n",qPrint(absDotName()));
    return TRUE;
  }
  f << m_theGraph;
  f.close();
 
  if (m_graphFormat == GOF_BITMAP)
  {
    // run dot to create a bitmap image
    DotRunner * dotRun = DotManager::instance()->createRunner(absDotName(), sigStr);
    dotRun->addJob(Config_getEnumAsString(DOT_IMAGE_FORMAT), absImgName(), absDotName(), 1);
    if (m_generateImageMap) dotRun->addJob(MAP_CMD, absMapName(), absDotName(), 1);
  }
  else if (m_graphFormat == GOF_EPS)
  {
    // run dot to create a .eps image
    DotRunner *dotRun = DotManager::instance()->createRunner(absDotName(), sigStr);
    if (Config_getBool(USE_PDFLATEX))
    {
      dotRun->addJob("pdf",absImgName(),absDotName(),1);
    }
    else
    {
      dotRun->addJob("ps",absImgName(),absDotName(),1);
    }
  }
  return TRUE;
}

引用了 absBaseName(), absDotName(), absImgName(), absMapName(), DotRunner::addJob(), Config_getBool, Config_getEnumAsString, DotManager::createRunner(), QCString::data(), deliverablesPresent(), err(), Dir::exists(), FALSE, GOF_BITMAP, GOF_EPS, DotManager::instance(), QCString::length(), m_dir, m_generateImageMap, m_graphFormat, m_theGraph, MAP_CMD, Dir::path(), qPrint(), sameMd5Signature(), term() , 以及 TRUE.

被这些函数引用 writeGraph().

relImgName()

QCString DotGraph::relImgName ( ) const

inlineprotected

在文件 dotgraph.h 第 76 行定义.

{ return m_relPath + imgName(); }

引用了 imgName() , 以及 m_relPath.

被这些函数引用 generateCode().

writeGraph()

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

protected

在文件 dotgraph.cpp 第 111 行定义.

{
  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) Doxygen::indexList->addImageFile(imgName());
 
  generateCode(t);
 
  return m_baseName;
}

引用了 Dir::absPath(), IndexList::addImageFile(), computeTheGraph(), 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() , 以及 QCString::str().

被这些函数引用 DotGfxHierarchyTable::createGraph(), DotGroupCollaboration::writeGraph(), DotInclDepGraph::writeGraph(), DotClassGraph::writeGraph(), DotLegendGraph::writeGraph(), DotDirDeps::writeGraph() , 以及 DotCallGraph::writeGraph().

writeGraphFooter()

void DotGraph::writeGraphFooter ( TextStream &  t )

staticprotected

在文件 dotgraph.cpp 第 300 行定义.

{
  t << "}\n";
}

被这些函数引用 computeGraph(), DotGroupCollaboration::computeTheGraph(), DotLegendGraph::computeTheGraph(), DotGfxHierarchyTable::computeTheGraph() , 以及 DotDirDeps::computeTheGraph().

writeGraphHeader()

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

staticprotected

在文件 dotgraph.cpp 第 268 行定义.

{
  int fontSize      = Config_getInt(DOT_FONTSIZE);
  QCString fontName = Config_getString(DOT_FONTNAME);
  t << "digraph ";
  if (title.isEmpty())
  {
    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
  if (Config_getBool(DOT_TRANSPARENT))
  {
    t << "  bgcolor=\"transparent\";\n";
  }
  t << "  edge [fontname=\"" << fontName << "\","
         "fontsize=\"" << fontSize << "\","
         "labelfontname=\"" << fontName << "\","
         "labelfontsize=\"" << fontSize << "\"];\n";
  t << "  node [fontname=\"" << fontName << "\","
         "fontsize=\"" << fontSize << "\",shape=record];\n";
}

引用了 Config_getBool, Config_getInt, Config_getString, convertToXML() , 以及 QCString::isEmpty().

被这些函数引用 computeGraph(), DotLegendGraph::computeTheGraph(), DotGfxHierarchyTable::computeTheGraph() , 以及 DotDirDeps::computeTheGraph().

类成员变量说明

m_absPath

QCString DotGraph::m_absPath

protected

在文件 dotgraph.h 第 87 行定义.

被这些函数引用 absBaseName(), absDotName(), absImgName(), absMapName() , 以及 writeGraph().

m_baseName

QCString DotGraph::m_baseName

protected

在文件 dotgraph.h 第 88 行定义.

被这些函数引用 absBaseName(), absDotName(), absMapName(), generateCode(), DotGroupCollaboration::getMapLabel(), DotCallGraph::getMapLabel(), DotDirDeps::getMapLabel(), imgName() , 以及 writeGraph().

m_curNodeNumber

int DotGraph::m_curNodeNumber = 0

private

在文件 dotgraph.h 第 103 行定义.

被这些函数引用 getNextNodeNumber().

m_dir

Dir DotGraph::m_dir

protected

在文件 dotgraph.h 第 81 行定义.

被这些函数引用 prepareDotFile() , 以及 writeGraph().

m_doNotAddImageToIndex

bool DotGraph::m_doNotAddImageToIndex = false

protected

在文件 dotgraph.h 第 91 行定义.

被这些函数引用 DotGroupCollaboration::writeGraph() , 以及 writeGraph().

m_fileName

QCString DotGraph::m_fileName

protected

在文件 dotgraph.h 第 82 行定义.

被这些函数引用 generateCode() , 以及 writeGraph().

m_generateImageMap

bool DotGraph::m_generateImageMap = false

protected

在文件 dotgraph.h 第 84 行定义.

被这些函数引用 generateCode(), prepareDotFile() , 以及 writeGraph().

m_graphFormat

GraphOutputFormat DotGraph::m_graphFormat = GOF_BITMAP

protected

在文件 dotgraph.h 第 79 行定义.

被这些函数引用 DotGroupCollaboration::computeTheGraph(), DotInclDepGraph::computeTheGraph(), DotClassGraph::computeTheGraph(), DotCallGraph::computeTheGraph(), generateCode(), imgName(), prepareDotFile() , 以及 writeGraph().

m_graphId

int DotGraph::m_graphId = 0

protected

在文件 dotgraph.h 第 85 行定义.

被这些函数引用 generateCode() , 以及 writeGraph().

m_noDivTag

bool DotGraph::m_noDivTag = false

protected

在文件 dotgraph.h 第 92 行定义.

被这些函数引用 DotGfxHierarchyTable::createGraph() , 以及 generateCode().

m_regenerate

bool DotGraph::m_regenerate = false

protected

在文件 dotgraph.h 第 90 行定义.

被这些函数引用 generateCode() , 以及 writeGraph().

m_relPath

QCString DotGraph::m_relPath

protected

在文件 dotgraph.h 第 83 行定义.

被这些函数引用 generateCode(), relImgName() , 以及 writeGraph().

m_textFormat

EmbeddedOutputFormat DotGraph::m_textFormat = EOF_Html

protected

在文件 dotgraph.h 第 80 行定义.

被这些函数引用 generateCode() , 以及 writeGraph().

m_theGraph

QCString DotGraph::m_theGraph

protected

在文件 dotgraph.h 第 89 行定义.

被这些函数引用 DotGroupCollaboration::computeTheGraph(), DotLegendGraph::computeTheGraph(), DotGfxHierarchyTable::computeTheGraph(), DotClassGraph::computeTheGraph(), DotInclDepGraph::computeTheGraph(), DotCallGraph::computeTheGraph(), DotDirDeps::computeTheGraph() , 以及 prepareDotFile().

m_urlOnly

bool DotGraph::m_urlOnly = false

protected

在文件 dotgraph.h 第 94 行定义.

被这些函数引用 generateCode() , 以及 DotDirDeps::writeGraph().

m_zoomable

bool DotGraph::m_zoomable = true

protected

在文件 dotgraph.h 第 93 行定义.

被这些函数引用 DotGfxHierarchyTable::createGraph() , 以及 generateCode().

---

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

• src/dotgraph.h
• src/dotgraph.cpp