1 //===-- GraphWriter.cpp - Implements GraphWriter support routines ---------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements misc. GraphWriter support routines.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Support/GraphWriter.h"
15 #include "llvm/Config/config.h"
16 #include "llvm/Support/CommandLine.h"
17 #include "llvm/Support/FileSystem.h"
18 #include "llvm/Support/Path.h"
19 #include "llvm/Support/Program.h"
22 static cl::opt<bool> ViewBackground("view-background", cl::Hidden,
23 cl::desc("Execute graph viewer in the background. Creates tmp file litter."));
25 std::string llvm::DOT::EscapeString(const std::string &Label) {
26 std::string Str(Label);
27 for (unsigned i = 0; i != Str.length(); ++i)
30 Str.insert(Str.begin()+i, '\\'); // Escape character...
35 Str.insert(Str.begin()+i, ' '); // Convert to two spaces
40 if (i+1 != Str.length())
42 case 'l': continue; // don't disturb \l
43 case '|': case '{': case '}':
44 Str.erase(Str.begin()+i); continue;
50 Str.insert(Str.begin()+i, '\\'); // Escape character...
51 ++i; // don't infinite loop
57 /// \brief Get a color string for this node number. Simply round-robin selects
58 /// from a reasonable number of colors.
59 StringRef llvm::DOT::getColorString(unsigned ColorNumber) {
60 static const int NumColors = 20;
61 static const char* Colors[NumColors] = {
62 "aaaaaa", "aa0000", "00aa00", "aa5500", "0055ff", "aa00aa", "00aaaa",
63 "555555", "ff5555", "55ff55", "ffff55", "5555ff", "ff55ff", "55ffff",
64 "ffaaaa", "aaffaa", "ffffaa", "aaaaff", "ffaaff", "aaffff"};
65 return Colors[ColorNumber % NumColors];
68 std::string llvm::createGraphFilename(const Twine &Name) {
70 sys::Path Filename = sys::Path::GetTemporaryDirectory(&ErrMsg);
71 if (Filename.isEmpty()) {
72 errs() << "Error: " << ErrMsg << "\n";
75 Filename.appendComponent((Name + ".dot").str());
76 if (Filename.makeUnique(true,&ErrMsg)) {
77 errs() << "Error: " << ErrMsg << "\n";
80 return Filename.str();
83 // Execute the graph viewer. Return true if successful.
84 static bool LLVM_ATTRIBUTE_UNUSED
85 ExecGraphViewer(StringRef ExecPath, std::vector<const char*> &args,
86 StringRef Filename, bool wait, std::string &ErrMsg) {
88 if (sys::ExecuteAndWait(sys::Path(ExecPath), &args[0],0,0,0,0,&ErrMsg)) {
89 errs() << "Error: " << ErrMsg << "\n";
93 sys::fs::remove(Filename, Existed);
94 errs() << " done. \n";
97 sys::ExecuteNoWait(sys::Path(ExecPath), &args[0],0,0,0,&ErrMsg);
98 errs() << "Remember to erase graph file: " << Filename.str() << "\n";
103 void llvm::DisplayGraph(StringRef FilenameRef, bool wait,
104 GraphProgram::Name program) {
105 std::string Filename = FilenameRef;
106 wait &= !ViewBackground;
109 std::string Graphviz(LLVM_PATH_GRAPHVIZ);
111 std::vector<const char*> args;
112 args.push_back(Graphviz.c_str());
113 args.push_back(Filename.c_str());
116 errs() << "Running 'Graphviz' program... ";
117 if (!ExecGraphViewer(Graphviz, args, Filename, wait, ErrMsg))
121 std::vector<const char*> args;
122 args.push_back(LLVM_PATH_XDOT_PY);
123 args.push_back(Filename.c_str());
126 case GraphProgram::DOT: args.push_back("-f"); args.push_back("dot"); break;
127 case GraphProgram::FDP: args.push_back("-f"); args.push_back("fdp"); break;
128 case GraphProgram::NEATO: args.push_back("-f"); args.push_back("neato");break;
129 case GraphProgram::TWOPI: args.push_back("-f"); args.push_back("twopi");break;
130 case GraphProgram::CIRCO: args.push_back("-f"); args.push_back("circo");break;
135 errs() << "Running 'xdot.py' program... ";
136 if (!ExecGraphViewer(LLVM_PATH_XDOT_PY, args, Filename, wait, ErrMsg))
139 #elif (HAVE_GV && (HAVE_DOT || HAVE_FDP || HAVE_NEATO || \
140 HAVE_TWOPI || HAVE_CIRCO))
141 sys::Path PSFilename = sys::Path(Filename);
142 PSFilename.appendSuffix("ps");
146 // Set default grapher
148 prog = LLVM_PATH_CIRCO;
151 prog = LLVM_PATH_TWOPI;
154 prog = LLVM_PATH_NEATO;
157 prog = LLVM_PATH_FDP;
160 prog = LLVM_PATH_DOT;
163 // Find which program the user wants
165 if (program == GraphProgram::DOT)
166 prog = LLVM_PATH_DOT;
169 if (program == GraphProgram::FDP)
170 prog = LLVM_PATH_FDP;
173 if (program == GraphProgram::NEATO)
174 prog = LLVM_PATH_NEATO;
177 if (program == GraphProgram::TWOPI)
178 prog = LLVM_PATH_TWOPI;
181 if (program == GraphProgram::CIRCO)
182 prog = LLVM_PATH_CIRCO;
185 std::vector<const char*> args;
186 args.push_back(prog.c_str());
187 args.push_back("-Tps");
188 args.push_back("-Nfontname=Courier");
189 args.push_back("-Gsize=7.5,10");
190 args.push_back(Filename.c_str());
191 args.push_back("-o");
192 args.push_back(PSFilename.c_str());
195 errs() << "Running '" << prog << "' program... ";
197 if (!ExecGraphViewer(prog, args, Filename, wait, ErrMsg))
200 std::string gv(LLVM_PATH_GV);
202 args.push_back(gv.c_str());
203 args.push_back(PSFilename.c_str());
204 args.push_back("--spartan");
208 if (!ExecGraphViewer(gv, args, PSFilename.str(), wait, ErrMsg))
212 std::string dotty(LLVM_PATH_DOTTY);
214 std::vector<const char*> args;
215 args.push_back(dotty.c_str());
216 args.push_back(Filename.c_str());
219 // Dotty spawns another app and doesn't wait until it returns
220 #if defined (__MINGW32__) || defined (_WINDOWS)
223 errs() << "Running 'dotty' program... ";
224 if (!ExecGraphViewer(dotty, args, Filename, wait, ErrMsg))