The DotGraph
Class Reference
A dot graph. More...
Declaration
Included Headers
Derived Classes
class | DotCallGraph |
Representation of an call graph. More... | |
class | DotClassGraph |
Representation of a class inheritance or dependency graph. More... | |
class | DotDirDeps |
Representation of an directory dependency graph. More... | |
class | DotGfxHierarchyTable |
Represents a graphical class hierarchy. More... | |
class | DotGroupCollaboration |
Representation of a group collaboration graph. More... | |
class | DotInclDepGraph |
Representation of an include dependency graph. More... | |
class | DotLegendGraph |
Representation of a legend explaining the meaning of boxes, arrows, and colors. More... | |
Friends Index
class | DotNode |
Public Constructors Index
DotGraph () | |
Public Destructor Index
~DotGraph ()=default | |
Protected Member Functions Index
int | getNextNodeNumber () |
returns the node number. More... | |
int | getNextEdgeNumber () |
returns the edge number. More... | |
QCString | writeGraph (TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1) |
QCString | getBaseName () const =0 |
QCString | absMapName () const |
QCString | getMapLabel () const =0 |
QCString | getImgAltText () const |
void | computeTheGraph ()=0 |
QCString | absBaseName () const |
QCString | absDotName () const |
QCString | imgName () const |
QCString | absImgName () const |
QCString | relImgName () const |
Private Member Functions Index
bool | prepareDotFile () |
void | generateCode (TextStream &t) |
Protected Member Attributes Index
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 |
Private Member Attributes Index
int | m_curNodeNumber = 0 |
int | m_curEdgeNumber = 0 |
Protected Static Functions Index
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) |
Description
A dot graph.
Definition at line 34 of file dotgraph.h.
Friends
DotNode
|
Definition at line 36 of file dotgraph.h.
Reference DotNode.
Referenced by DotClassGraph::addClass, DotGfxHierarchyTable::addClassList, DotGroupCollaboration::addCollaborationMember, DotGroupCollaboration::addEdge, DotGfxHierarchyTable::addHierarchy, DotCallGraph::buildGraph, DotClassGraph::buildGraph, DotGroupCollaboration::buildGraph, DotInclDepGraph::buildGraph, computeGraph, DotLegendGraph::computeTheGraph, DotGfxHierarchyTable::createGraph, DotCallGraph::determineTruncatedNodes, DotClassGraph::determineTruncatedNodes, DotInclDepGraph::determineTruncatedNodes, DotCallGraph::determineVisibleNodes, DotClassGraph::determineVisibleNodes, DotInclDepGraph::determineVisibleNodes, DotInclDepGraph::diskName, DotCallGraph::DotCallGraph, DotClassGraph::DotClassGraph, DotGroupCollaboration::DotGroupCollaboration, DotInclDepGraph::DotInclDepGraph, DotNode, DotGroupCollaboration::Edge::Edge and DotGfxHierarchyTable::~DotGfxHierarchyTable.
Public Constructors
DotGraph()
| inline |
Definition at line 38 of file dotgraph.h.
References FALSE, m_doNotAddImageToIndex, m_noDivTag, m_urlOnly, m_zoomable and TRUE.
Referenced by ~DotGraph.
Public Destructor
~DotGraph()
| virtual default |
Definition at line 40 of file dotgraph.h.
Reference DotGraph.
Protected Member Functions
absBaseName()
| inline protected |
Definition at line 78 of file dotgraph.h.
References m_absPath and m_baseName.
Referenced by generateCode, prepareDotFile and DotLegendGraph::writeGraph.
absDotName()
| inline protected |
Definition at line 79 of file dotgraph.h.
References m_absPath and m_baseName.
Referenced by prepareDotFile.
absImgName()
| inline protected |
Definition at line 81 of file dotgraph.h.
References imgName and m_absPath.
Referenced by generateCode, prepareDotFile and DotLegendGraph::writeGraph.
absMapName()
| inline protected virtual |
Definition at line 72 of file dotgraph.h.
References m_absPath and m_baseName.
Referenced by generateCode and prepareDotFile.
computeTheGraph()
| protected |
Definition at line 76 of file dotgraph.h.
Referenced by writeGraph.
getBaseName()
| protected |
Definition at line 71 of file dotgraph.h.
Referenced by writeGraph.
getImgAltText()
| inline protected virtual |
Definition at line 74 of file dotgraph.h.
Referenced by generateCode.
getMapLabel()
| protected |
Definition at line 73 of file dotgraph.h.
Referenced by generateCode.
getNextEdgeNumber()
| inline protected |
returns the edge number.
Definition at line 47 of file dotgraph.h.
Reference m_curEdgeNumber.
getNextNodeNumber()
| inline protected |
returns the node number.
Definition at line 45 of file dotgraph.h.
Reference m_curNodeNumber.
imgName()
| protected |
Declaration at line 80 of file dotgraph.h, definition at line 107 of file dotgraph.cpp.
References BITMAP, Config_getBool, getDotImageExtension, m_baseName and m_graphFormat.
Referenced by absImgName, relImgName and writeGraph.
relImgName()
| inline protected |
Definition at line 82 of file dotgraph.h.
References imgName and m_relPath.
Referenced by generateCode.
writeGraph()
| protected |
Declaration at line 49 of file dotgraph.h, definition at line 115 of file dotgraph.cpp.
References 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 QCString::str.
Referenced by DotGfxHierarchyTable::createGraph, DotCallGraph::writeGraph, DotClassGraph::writeGraph, DotDirDeps::writeGraph, DotGroupCollaboration::writeGraph, DotInclDepGraph::writeGraph and DotLegendGraph::writeGraph.
Private Member Functions
generateCode()
|
Declaration at line 105 of file dotgraph.h, definition at line 212 of file dotgraph.cpp.
References absBaseName, absImgName, absMapName, BITMAP, correctId, DocBook, EPS, FALSE, 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, relImgName, DotFilePatcher::writeSVGFigureLink and DotFilePatcher::writeVecGfxFigure.
Referenced by writeGraph.
prepareDotFile()
|
Declaration at line 104 of file dotgraph.h, definition at line 151 of file dotgraph.cpp.
References absBaseName, absDotName, absImgName, absMapName, DotRunner::addJob, BITMAP, Config_getBool, Config_getEnumAsString, DotManager::createRunner, deliverablesPresent, EPS, err, FALSE, DotManager::instance, m_dir, m_generateImageMap, m_graphFormat, m_theGraph, MAP_CMD, Portable::openOutputStream, sameMd5Signature, term and TRUE.
Referenced by writeGraph.
Protected Member Attributes
m_absPath
| protected |
Definition at line 93 of file dotgraph.h.
Referenced by absBaseName, absDotName, absImgName, absMapName and writeGraph.
m_baseName
| protected |
Definition at line 94 of file dotgraph.h.
Referenced by absBaseName, absDotName, absMapName, generateCode, DotCallGraph::getMapLabel, DotDirDeps::getMapLabel, DotGroupCollaboration::getMapLabel, imgName and writeGraph.
m_dir
| protected |
Definition at line 87 of file dotgraph.h.
Referenced by prepareDotFile and writeGraph.
m_doNotAddImageToIndex
| protected |
Definition at line 97 of file dotgraph.h.
Referenced by DotGraph, DotCallGraph::writeGraph, writeGraph and DotGroupCollaboration::writeGraph.
m_fileName
| protected |
Definition at line 88 of file dotgraph.h.
Referenced by generateCode and writeGraph.
m_generateImageMap
| protected |
Definition at line 90 of file dotgraph.h.
Referenced by generateCode, prepareDotFile and writeGraph.
m_graphFormat
| protected |
Definition at line 85 of file dotgraph.h.
Referenced by DotCallGraph::computeTheGraph, DotClassGraph::computeTheGraph, DotGroupCollaboration::computeTheGraph, DotInclDepGraph::computeTheGraph, generateCode, imgName, prepareDotFile and writeGraph.
m_graphId
| protected |
Definition at line 91 of file dotgraph.h.
Referenced by generateCode and writeGraph.
m_noDivTag
| protected |
Definition at line 98 of file dotgraph.h.
Referenced by DotGfxHierarchyTable::createGraph, DotGraph and generateCode.
m_regenerate
| protected |
Definition at line 96 of file dotgraph.h.
Referenced by generateCode and writeGraph.
m_relPath
| protected |
Definition at line 89 of file dotgraph.h.
Referenced by generateCode, relImgName and writeGraph.
m_textFormat
| protected |
Definition at line 86 of file dotgraph.h.
Referenced by generateCode and writeGraph.
m_theGraph
| protected |
Definition at line 95 of file dotgraph.h.
Referenced by DotCallGraph::computeTheGraph, DotClassGraph::computeTheGraph, DotDirDeps::computeTheGraph, DotGfxHierarchyTable::computeTheGraph, DotGroupCollaboration::computeTheGraph, DotInclDepGraph::computeTheGraph, DotLegendGraph::computeTheGraph and prepareDotFile.
m_urlOnly
| protected |
Definition at line 100 of file dotgraph.h.
Referenced by DotGraph, generateCode and DotDirDeps::writeGraph.
m_zoomable
| protected |
Definition at line 99 of file dotgraph.h.
Referenced by DotGfxHierarchyTable::createGraph, DotGraph and generateCode.
Private Member Attributes
m_curEdgeNumber
|
Definition at line 108 of file dotgraph.h.
Referenced by getNextEdgeNumber.
m_curNodeNumber
|
Definition at line 107 of file dotgraph.h.
Referenced by getNextNodeNumber.
Protected Static Functions
computeGraph()
| protected static |
Declaration at line 61 of file dotgraph.h, definition at line 306 of file dotgraph.cpp.
References CallGraph, DotNode::clearWriteFlag, Dependency, DotNode, FALSE, QCString::isEmpty, DotNode::parents, TextStream::str, TRUE, DotNode::write, DotNode::writeArrow, writeGraphFooter and writeGraphHeader.
Referenced by DotCallGraph::computeTheGraph, DotClassGraph::computeTheGraph and DotInclDepGraph::computeTheGraph.
writeGraphFooter()
| protected static |
Declaration at line 60 of file dotgraph.h, definition at line 301 of file dotgraph.cpp.
Referenced by computeGraph, DotDirDeps::computeTheGraph, DotGfxHierarchyTable::computeTheGraph, DotGroupCollaboration::computeTheGraph and DotLegendGraph::computeTheGraph.
writeGraphHeader()
| protected static |
Declaration at line 59 of file dotgraph.h, definition at line 276 of file dotgraph.cpp.
References Config_getBool, Config_getString, convertToXML and QCString::isEmpty.
Referenced by computeGraph, DotDirDeps::computeTheGraph, DotGfxHierarchyTable::computeTheGraph, DotLegendGraph::computeTheGraph and DotGroupCollaboration::writeGraphHeader.
The documentation for this class was generated from the following files:
Generated via doxygen2docusaurus by Doxygen 1.14.0.