1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/******************************************************************************
*
* Copyright (C) 1997-2019 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
* granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* Documents produced by Doxygen are derivative works derived from the
* input used in their production; they are not affected by this license.
*
*/
#ifndef DOTGRAPH_H
#define DOTGRAPH_H
#include <qcstring.h>
#include <qgstring.h>
#include <qdir.h>
class FTextStream;
class DotNode;
enum GraphOutputFormat { GOF_BITMAP, GOF_EPS };
enum EmbeddedOutputFormat { EOF_Html, EOF_LaTeX, EOF_Rtf, EOF_DocBook };
enum GraphType { Dependency, Inheritance, Collaboration, Hierarchy, CallGraph };
/** A dot graph */
class DotGraph
{
public:
DotGraph() : m_doNotAddImageToIndex(FALSE), m_noDivTag(FALSE),
m_zoomable(TRUE), m_urlOnly(FALSE) {}
virtual ~DotGraph() {}
protected:
/** returns node numbers. The Counter is reset by the constructor */
int getNextNodeNumber() { return ++m_curNodeNumber; }
QCString writeGraph(FTextStream &t,
GraphOutputFormat gf,
EmbeddedOutputFormat ef,
const char *path,
const char *fileName,
const char *relPath,
bool writeImageMap=TRUE,
int graphId=-1
);
static void writeGraphHeader(FTextStream& t, const QCString& title = QCString());
static void writeGraphFooter(FTextStream& t);
static void computeGraph(DotNode* root,
GraphType gt,
GraphOutputFormat format,
const QCString& rank, // either "LR", "RL", or ""
bool renderParents,
bool backArrows,
const QCString& title,
QGString& graphStr
);
virtual QCString getBaseName() const = 0;
virtual QCString absMapName() const { return m_absPath + m_baseName + ".map"; }
virtual QCString getMapLabel() const = 0;
virtual QCString getImgAltText() const { return ""; }
virtual void computeTheGraph() = 0;
QCString absBaseName() const { return m_absPath + m_baseName; }
QCString absDotName() const { return m_absPath + m_baseName + ".dot"; }
QCString imgName() const;
QCString absImgName() const { return m_absPath + imgName(); }
QCString relImgName() const { return m_relPath + imgName(); }
// the following variables are used while writing the graph to a .dot file
GraphOutputFormat m_graphFormat = GOF_BITMAP;
EmbeddedOutputFormat m_textFormat = EOF_Html;
QDir m_dir;
QCString m_fileName;
QCString m_relPath;
bool m_generateImageMap = false;
int m_graphId = 0;
QCString m_absPath;
QCString m_baseName;
QGString 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(FTextStream &t);
int m_curNodeNumber = 0;
};
#endif
|
