Skip to content

Commit b28fecb

Browse files
quentinquentin
committed
fixes for the debug report
Fix bad characters in diffs. Fix syntax highlighting of souffle diffs. Add syntax highlighting of souffle RAM diffs.
1 parent 518270b commit b28fecb

File tree

3 files changed

+148
-55
lines changed

3 files changed

+148
-55
lines changed

‎src/include/souffle/utility/FileUtil.h

+8-6
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
#pragma once
1818

1919
#include <algorithm>
20+
#include <array>
2021
#include <climits>
2122
#include <cstdio>
2223
#include <cstdlib>
@@ -322,19 +323,20 @@ inline std::string tempFile() {
322323
}
323324

324325
inline std::stringstream execStdOut(char const* cmd) {
325-
FILE* in = popen(cmd, "r");
326326
std::stringstream data;
327+
std::shared_ptr<FILE> command_pipe(popen(cmd, "r"), pclose);
327328

328-
if (in == nullptr) {
329+
if (command_pipe.get() == nullptr) {
329330
return data;
330331
}
331332

332-
while (!feof(in)) {
333-
int c = fgetc(in);
334-
data << static_cast<char>(c);
333+
std::array<char, 256> buffer;
334+
while (!feof(command_pipe.get())) {
335+
if (fgets(buffer.data(), 256, command_pipe.get()) != nullptr) {
336+
data << buffer.data();
337+
}
335338
}
336339

337-
pclose(in);
338340
return data;
339341
}
340342

‎src/ram/StringConstant.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class StringConstant : public Expression {
4444

4545
protected:
4646
void print(std::ostream& os) const override {
47-
os << "string(\"" << stringify(constant) << "\")";
47+
os << "STRING(\"" << stringify(constant) << "\")";
4848
}
4949

5050
bool equal(const Node& node) const override {

‎src/reports/DebugReport.cpp

+139-48
Original file line numberDiff line numberDiff line change
@@ -114,22 +114,24 @@ void DebugReport::flush() {
114114
std::ofstream(dst) << *this;
115115
}
116116

117+
static std::string CDATA(const std::string_view code) {
118+
return "<![CDATA[" + replaceAll(code, "]]>", "]]]]><![CDATA[>") + "]]>";
119+
}
120+
117121
void DebugReport::addSection(std::string id, std::string title, const std::string_view code) {
118-
addSection(DebugReportSection(
119-
std::move(id), std::move(title), tfm::format("<pre>%s</pre>", replaceAll(code, "<", "&lt"))));
122+
addSection(
123+
DebugReportSection(std::move(id), std::move(title), tfm::format("<pre>%s</pre>", CDATA(code))));
120124
}
121125

122126
void DebugReport::addCodeSection(std::string id, std::string title, std::string_view language,
123127
std::string_view prev, std::string_view curr) {
124-
auto diff =
125-
replaceAll(replaceAll(prev.empty() ? curr : generateDiff(prev, curr), "\\", "\\\\"), "`", "\\`");
128+
const std::string diff = (prev.empty() ? std::string(curr) : generateDiff(prev, curr));
126129
auto divId = nextUniqueId++;
127130
auto html = R"(
128-
<div id="code-id-%d"></div>
129-
<script type="text/javascript"> renderDiff('%s', 'code-id-%d', `%s`) </script>
131+
<div id="code-id-%d" class="diff-%s">%s></div>
130132
)";
131133
addSection(DebugReportSection(
132-
std::move(id), std::move(title), tfm::format(html, divId, language, divId, diff)));
134+
std::move(id), std::move(title), tfm::format(html, divId, language, CDATA(diff))));
133135
}
134136

135137
void DebugReport::endSection(std::string currentSectionName, std::string currentSectionTitle) {
@@ -141,13 +143,15 @@ void DebugReport::endSection(std::string currentSectionName, std::string current
141143
}
142144

143145
void DebugReport::print(std::ostream& out) const {
144-
out << R"(
145-
<!DOCTYPE html>
146-
<html lang='en-AU'>
146+
out << R"--html--(
147+
<?xml version="1.0" encoding="utf-8"?>
148+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
149+
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
150+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-AU">
147151
<head>
148-
<meta charset=\"UTF-8\">
149-
<title>Souffle Debug Report ()";
150-
out << Global::config().get("") << R"()</title>
152+
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />
153+
<title>Souffle Debug Report ()--html--";
154+
out << Global::config().get("") << R"--html--()</title>
151155
<style>
152156
ul { list-style-type: none; }
153157
ul > li.leaf { display: inline-block; padding: 0em 1em; }
@@ -162,15 +166,16 @@ void DebugReport::print(std::ostream& out) const {
162166
.headerdiv a { float:right; }
163167
</style>
164168
165-
<link rel="stylesheet" type="text/css" href=
166-
"https://cdn.jsdelivr.net/npm/[email protected]/styles/default.min.css" />
167-
<script type="text/javascript" src=
168-
"https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@10.0.0/build/highlight.min.js"></script>
169+
<link rel="stylesheet" href=
170+
"https://cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/default.min.css">
171+
<script src=
172+
"https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.5.1/build/highlight.min.js"></script>
169173
174+
<!-- must use 3.4.10 until https://github.com/rtfpessoa/diff2html/issues/437 is resolved -->
170175
<link rel="stylesheet" type="text/css" href=
171-
"https://cdn.jsdelivr.net/npm/diff2html/bundles/css/diff2html.min.css" />
176+
"https://cdn.jsdelivr.net/npm/diff2html@3.4.10/bundles/css/diff2html.min.css" />
172177
<script type="text/javascript" src=
173-
"https://cdn.jsdelivr.net/npm/diff2html/bundles/js/diff2html-ui-base.min.js"></script>
178+
"https://cdn.jsdelivr.net/npm/diff2html@3.4.10/bundles/js/diff2html-ui-base.min.js"></script>
174179
175180
<script>
176181
function toggleVisibility(id) {
@@ -192,26 +197,26 @@ void DebugReport::print(std::ostream& out) const {
192197
let KEYWORDS = {
193198
$pattern: '\\.?\\w+',
194199
literal: 'true false',
195-
keyword: '.pragma .functor .component .decl .input .output ' +
200+
keyword: '.pragma .functor .component .decl .input .output .type ' +
196201
'ord strlen strsub range matches land lor lxor lnot bwand bwor bwxor bwnot bshl bshr bshru',
197202
}
198203
199204
let STRING = hljs.QUOTE_STRING_MODE
200205
let NUMBERS = {
201206
className: 'number', relevance: 0, variants: [
202-
{ begin: /0b[01]+/ },
203-
{ begin: /\d+\.\d+/ }, // float
204-
{ begin: /\d+\.\d+.\d+.\d+/ }, // IPv4 literal
205-
{ begin: /\d+u?/ },
206-
{ begin: /0x[a-fA-F0-9]+u?/ }
207+
{ begin: /\b0b[01]+/ },
208+
{ begin: /\b\d+\.\d+/ }, // float
209+
{ begin: /\b\d+\.\d+.\d+.\d+/ }, // IPv4 literal
210+
{ begin: /\b\d+u?/ },
211+
{ begin: /\b0x[a-fA-F0-9]+u?/ }
207212
]
208213
}
209214
210215
let PREPROCESSOR = {
211216
className: 'meta',
212217
begin: /#\s*[a-z]+\b/,
213218
end: /$/,
214-
keywords: {
219+
keyword: {
215220
'meta-keyword': 'if else elif endif define undef warning error line pragma ifdef ifndef include'
216221
},
217222
contains: [
@@ -229,7 +234,7 @@ void DebugReport::print(std::ostream& out) const {
229234
}
230235
let PARENTED = { begin: /\(/, end: /\)/, relevance: 0 }
231236
let LIST = { begin: /\[/, end: /\]/ }
232-
let PRED_OP = { begin: /:-/ } // relevance booster
237+
let PRED_OP = { begin: /:\-/ } // relevance booster
233238
234239
let INNER = [
235240
ATOM,
@@ -249,37 +254,123 @@ void DebugReport::print(std::ostream& out) const {
249254
keywords: KEYWORDS,
250255
contains: INNER.concat([{ begin: /\.$/ }]) // relevance booster
251256
};
252-
})
253-
// TODO: Add a highlighter for `ram`
254-
hljs.configure({ languages: ['souffle'] })
257+
});
258+
259+
hljs.registerLanguage('ram', function (hljs) {
260+
const COMMENT_MODES = [
261+
hljs.C_LINE_COMMENT_MODE,
262+
hljs.C_BLOCK_COMMENT_MODE,
263+
];
264+
265+
const KEYWORDS = {
266+
keyword: [
267+
'ALL',
268+
'AND',
269+
'BEGIN',
270+
'CALL',
271+
'CLEAR',
272+
'DEBUG',
273+
'DECLARATION',
274+
'END',
275+
'EXIT',
276+
'FLOAT',
277+
'FOR',
278+
'IF',
279+
'IN',
280+
'INDEX',
281+
'INSERT',
282+
'INTO',
283+
'IO',
284+
'ISEMPTY',
285+
'LOOP',
286+
'MAIN',
287+
'NOT',
288+
'NUMBER',
289+
'ON',
290+
'PROGRAM',
291+
'QUERY',
292+
'SEARCH',
293+
'STRING',
294+
'SUBROUTINE',
295+
'SWAP',
296+
'UNSIGNED',
297+
'count',
298+
'max',
299+
'mean',
300+
'min',
301+
'sum',
302+
],
303+
};
304+
305+
const STRING = hljs.QUOTE_STRING_MODE;
306+
307+
const INDEX = {
308+
className: 'variable',
309+
begin: /\bt\d+(\.\d+)?/
310+
}
311+
312+
const INNER = [
313+
INDEX,
314+
hljs.QUOTE_STRING_MODE,
315+
hljs.C_NUMBER_MODE,
316+
].concat(COMMENT_MODES)
317+
318+
return {
319+
name: 'ram',
320+
keywords: KEYWORDS,
321+
contains: INNER
322+
};
323+
});
324+
325+
hljs.configure({ languages: ['souffle', 'ram'] })
255326
}
256327
257328
if (typeof Diff2HtmlUI !== 'undefined' && typeof hljs !== 'undefined') {
258-
function renderDiff(lang, id, diff) {
259329
// file extension determines the language used for highlighting
260-
let file = `Datalog.${lang}`
261-
let prefix = `diff ${file} ${file}
262-
--- ${file}
263-
+++ ${file}
330+
let souffle_file = `Datalog.souffle`
331+
let souffle_prefix = `diff ${souffle_file} ${souffle_file}
332+
--- ${souffle_file}
333+
+++ ${souffle_file}
264334
@@ -1 +1 @@
265335
`
266-
new Diff2HtmlUI(document.getElementById(id), prefix + diff, {
267-
drawFileList: false,
268-
highlight: true,
269-
matching: 'none',
270-
outputFormat: 'side-by-side',
271-
synchronisedScroll: true,
272-
}, hljs).draw()
273-
}
274-
} else { // fallback to plain text
275-
function renderDiff(lang, id, diff) {
276-
document.getElementById(id).innerText = diff
277-
}
336+
let ram_file = `Datalog.ram`
337+
let ram_prefix = `diff ${ram_file} ${ram_file}
338+
--- ${ram_file}
339+
+++ ${ram_file}
340+
@@ -1 +1 @@
341+
`
342+
343+
document.addEventListener('DOMContentLoaded', function() {
344+
var els = document.getElementsByClassName("diff-souffle");
345+
Array.prototype.forEach.call(els, function(el) {
346+
diff2htmlUi = new Diff2HtmlUI(el, souffle_prefix + el.textContent, {
347+
drawFileList: false,
348+
highlight: true,
349+
matching: 'none',
350+
outputFormat: 'side-by-side',
351+
synchronisedScroll: true,
352+
highlightLanguage: 'souffle'
353+
}, hljs);
354+
diff2htmlUi.draw();
355+
});
356+
var els = document.getElementsByClassName("diff-ram");
357+
Array.prototype.forEach.call(els, function(el) {
358+
diff2htmlUi = new Diff2HtmlUI(el, ram_prefix + el.textContent, {
359+
drawFileList: false,
360+
highlight: true,
361+
matching: 'none',
362+
outputFormat: 'side-by-side',
363+
synchronisedScroll: true,
364+
highlightLanguage: 'ram'
365+
}, hljs);
366+
diff2htmlUi.draw();
367+
});
368+
});
278369
}
279370
</script>
280371
</head>
281372
<body>
282-
<div class='headerdiv'><h1>Souffle Debug Report ()";
373+
<div class='headerdiv'><h1>Souffle Debug Report ()--html--";
283374
out << Global::config().get("") << ")</h1></div>\n";
284375
for (const DebugReportSection& section : sections) {
285376
section.printIndex(out);

0 commit comments

Comments
 (0)