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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
//===-- GraphWriter.cpp - Implements GraphWriter support routines ---------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file implements misc. GraphWriter support routines.
//
//===----------------------------------------------------------------------===//
#include "llvm/Support/GraphWriter.h"
#include "llvm/Config/config.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/Program.h"
using namespace llvm;
static cl::opt<bool> ViewBackground("view-background", cl::Hidden,
cl::desc("Execute graph viewer in the background. Creates tmp file litter."));
std::string llvm::DOT::EscapeString(const std::string &Label) {
std::string Str(Label);
for (unsigned i = 0; i != Str.length(); ++i)
switch (Str[i]) {
case '\n':
Str.insert(Str.begin()+i, '\\'); // Escape character...
++i;
Str[i] = 'n';
break;
case '\t':
Str.insert(Str.begin()+i, ' '); // Convert to two spaces
++i;
Str[i] = ' ';
break;
case '\\':
if (i+1 != Str.length())
switch (Str[i+1]) {
case 'l': continue; // don't disturb \l
case '|': case '{': case '}':
Str.erase(Str.begin()+i); continue;
default: break;
}
case '{': case '}':
case '<': case '>':
case '|': case '"':
Str.insert(Str.begin()+i, '\\'); // Escape character...
++i; // don't infinite loop
break;
}
return Str;
}
/// \brief Get a color string for this node number. Simply round-robin selects
/// from a reasonable number of colors.
StringRef llvm::DOT::getColorString(unsigned ColorNumber) {
static const int NumColors = 20;
static const char* Colors[NumColors] = {
"aaaaaa", "aa0000", "00aa00", "aa5500", "0055ff", "aa00aa", "00aaaa",
"555555", "ff5555", "55ff55", "ffff55", "5555ff", "ff55ff", "55ffff",
"ffaaaa", "aaffaa", "ffffaa", "aaaaff", "ffaaff", "aaffff"};
return Colors[ColorNumber % NumColors];
}
std::string llvm::createGraphFilename(const Twine &Name, int &FD) {
FD = -1;
SmallString<128> Filename;
std::error_code EC = sys::fs::createTemporaryFile(Name, "dot", FD, Filename);
if (EC) {
errs() << "Error: " << EC.message() << "\n";
return "";
}
errs() << "Writing '" << Filename << "'... ";
return Filename.str();
}
// Execute the graph viewer. Return true if there were errors.
static bool ExecGraphViewer(StringRef ExecPath, std::vector<const char *> &args,
StringRef Filename, bool wait,
std::string &ErrMsg) {
assert(args.back() == nullptr);
if (wait) {
if (sys::ExecuteAndWait(ExecPath, args.data(), nullptr, nullptr, 0, 0,
&ErrMsg)) {
errs() << "Error: " << ErrMsg << "\n";
return true;
}
sys::fs::remove(Filename);
errs() << " done. \n";
} else {
sys::ExecuteNoWait(ExecPath, args.data(), nullptr, nullptr, 0, &ErrMsg);
errs() << "Remember to erase graph file: " << Filename.str() << "\n";
}
return false;
}
namespace {
struct GraphSession {
std::string LogBuffer;
bool TryFindProgram(StringRef Names, std::string &ProgramPath) {
raw_string_ostream Log(LogBuffer);
SmallVector<StringRef, 8> parts;
Names.split(parts, "|");
for (auto Name : parts) {
if (ErrorOr<std::string> P = sys::findProgramByName(Name)) {
ProgramPath = *P;
return true;
}
Log << " Tried '" << Name << "'\n";
}
return false;
}
};
} // namespace
static const char *getProgramName(GraphProgram::Name program) {
switch (program) {
case GraphProgram::DOT:
return "dot";
case GraphProgram::FDP:
return "fdp";
case GraphProgram::NEATO:
return "neato";
case GraphProgram::TWOPI:
return "twopi";
case GraphProgram::CIRCO:
return "circo";
}
llvm_unreachable("bad kind");
}
bool llvm::DisplayGraph(StringRef FilenameRef, bool wait,
GraphProgram::Name program) {
std::string Filename = FilenameRef;
wait &= !ViewBackground;
std::string ErrMsg;
std::string ViewerPath;
GraphSession S;
// Graphviz
if (S.TryFindProgram("Graphviz", ViewerPath)) {
std::vector<const char *> args;
args.push_back(ViewerPath.c_str());
args.push_back(Filename.c_str());
args.push_back(nullptr);
errs() << "Running 'Graphviz' program... ";
return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg);
}
// xdot
if (S.TryFindProgram("xdot|xdot.py", ViewerPath)) {
std::vector<const char *> args;
args.push_back(ViewerPath.c_str());
args.push_back(Filename.c_str());
args.push_back("-f");
args.push_back(getProgramName(program));
args.push_back(nullptr);
errs() << "Running 'xdot.py' program... ";
return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg);
}
enum PSViewerKind { PSV_None, PSV_OSXOpen, PSV_XDGOpen, PSV_Ghostview };
PSViewerKind PSViewer = PSV_None;
#ifdef __APPLE__
if (!PSViewer && S.TryFindProgram("open", ViewerPath))
PSViewer = PSV_OSXOpen;
#endif
if (!PSViewer && S.TryFindProgram("gv", ViewerPath))
PSViewer = PSV_Ghostview;
if (!PSViewer && S.TryFindProgram("xdg-open", ViewerPath))
PSViewer = PSV_XDGOpen;
// PostScript graph generator + PostScript viewer
std::string GeneratorPath;
if (PSViewer &&
(S.TryFindProgram(getProgramName(program), GeneratorPath) ||
S.TryFindProgram("dot|fdp|neato|twopi|circo", GeneratorPath))) {
std::string PSFilename = Filename + ".ps";
std::vector<const char *> args;
args.push_back(GeneratorPath.c_str());
args.push_back("-Tps");
args.push_back("-Nfontname=Courier");
args.push_back("-Gsize=7.5,10");
args.push_back(Filename.c_str());
args.push_back("-o");
args.push_back(PSFilename.c_str());
args.push_back(nullptr);
errs() << "Running '" << GeneratorPath << "' program... ";
if (ExecGraphViewer(GeneratorPath, args, Filename, wait, ErrMsg))
return true;
args.clear();
args.push_back(ViewerPath.c_str());
switch (PSViewer) {
case PSV_OSXOpen:
args.push_back("-W");
args.push_back(PSFilename.c_str());
break;
case PSV_XDGOpen:
wait = false;
args.push_back(PSFilename.c_str());
break;
case PSV_Ghostview:
args.push_back("--spartan");
args.push_back(PSFilename.c_str());
break;
case PSV_None:
llvm_unreachable("Invalid viewer");
}
args.push_back(nullptr);
ErrMsg.clear();
return ExecGraphViewer(ViewerPath, args, PSFilename, wait, ErrMsg);
}
// dotty
if (S.TryFindProgram("dotty", ViewerPath)) {
std::vector<const char *> args;
args.push_back(ViewerPath.c_str());
args.push_back(Filename.c_str());
args.push_back(nullptr);
// Dotty spawns another app and doesn't wait until it returns
#ifdef LLVM_ON_WIN32
wait = false;
#endif
errs() << "Running 'dotty' program... ";
return ExecGraphViewer(ViewerPath, args, Filename, wait, ErrMsg);
}
errs() << "Error: Couldn't find a usable graph viewer program:\n";
errs() << S.LogBuffer << "\n";
return true;
}
|
