2017-03-02 12:41:24 +00:00
|
|
|
|
//: The goal of layers is to make programs more easy to understand and more
|
|
|
|
|
//: malleable, easy to rewrite in radical ways without accidentally breaking
|
|
|
|
|
//: some corner case. Tests further both goals. They help understandability by
|
|
|
|
|
//: letting one make small changes and get feedback. What if I wrote this line
|
|
|
|
|
//: like so? What if I removed this function call, is it really necessary?
|
|
|
|
|
//: Just try it, see if the tests pass. Want to explore rewriting this bit in
|
|
|
|
|
//: this way? Tests put many refactorings on a firmer footing.
|
2015-03-17 03:26:59 +00:00
|
|
|
|
//:
|
|
|
|
|
//: But the usual way we write tests seems incomplete. Refactorings tend to
|
|
|
|
|
//: work in the small, but don't help with changes to function boundaries. If
|
|
|
|
|
//: you want to extract a new function you have to manually test-drive it to
|
|
|
|
|
//: create tests for it. If you want to inline a function its tests are no
|
|
|
|
|
//: longer valid. In both cases you end up having to reorganize code as well as
|
|
|
|
|
//: tests, an error-prone activity.
|
|
|
|
|
//:
|
2017-03-02 13:48:01 +00:00
|
|
|
|
//: In response, this layer introduces the notion of *domain-driven* testing.
|
|
|
|
|
//: We focus on the domain of inputs the whole program needs to handle rather
|
|
|
|
|
//: than the correctness of individual functions. All tests invoke the program
|
|
|
|
|
//: in a single way: by calling run() with some input. As the program operates
|
|
|
|
|
//: on the input, it traces out a list of _facts_ deduced about the domain:
|
2015-03-17 03:26:59 +00:00
|
|
|
|
//: trace("label") << "fact 1: " << val;
|
|
|
|
|
//:
|
2017-03-02 13:48:01 +00:00
|
|
|
|
//: Tests can now check these facts:
|
2015-05-03 18:53:15 +00:00
|
|
|
|
//: :(scenario foo)
|
2015-03-17 03:26:59 +00:00
|
|
|
|
//: 34 # call run() with this input
|
2017-03-02 13:48:01 +00:00
|
|
|
|
//: +label: fact 1: 34 # 'run' should have deduced this fact
|
|
|
|
|
//: -label: fact 1: 35 # the trace should not contain such a fact
|
2015-03-17 03:26:59 +00:00
|
|
|
|
//:
|
|
|
|
|
//: Since we never call anything but the run() function directly, we never have
|
|
|
|
|
//: to rewrite the tests when we reorganize the internals of the program. We
|
|
|
|
|
//: just have to make sure our rewrite deduces the same facts about the domain,
|
|
|
|
|
//: and that's something we're going to have to do anyway.
|
|
|
|
|
//:
|
2017-03-02 13:48:01 +00:00
|
|
|
|
//: To avoid the combinatorial explosion of integration tests, each layer
|
|
|
|
|
//: mainly logs facts to the trace with a common *label*. All tests in a layer
|
|
|
|
|
//: tend to check facts with this label. Validating the facts logged with a
|
|
|
|
|
//: specific label is like calling functions of that layer directly.
|
2015-03-17 03:26:59 +00:00
|
|
|
|
//:
|
|
|
|
|
//: To build robust tests, trace facts about your domain rather than details of
|
|
|
|
|
//: how you computed them.
|
|
|
|
|
//:
|
|
|
|
|
//: More details: http://akkartik.name/blog/tracing-tests
|
|
|
|
|
//:
|
|
|
|
|
//: ---
|
|
|
|
|
//:
|
|
|
|
|
//: Between layers and domain-driven testing, programming starts to look like a
|
|
|
|
|
//: fundamentally different activity. Instead of a) superficial, b) local rules
|
2017-03-02 12:41:24 +00:00
|
|
|
|
//: on c) code [like say http://blog.bbv.ch/2013/06/05/clean-code-cheat-sheet],
|
2015-03-17 03:26:59 +00:00
|
|
|
|
//: we allow programmers to engage with the a) deep, b) global structure of the
|
2017-03-02 12:41:24 +00:00
|
|
|
|
//: c) domain. If you can systematically track discontinuities in the domain,
|
2015-03-17 03:26:59 +00:00
|
|
|
|
//: you don't care if the code used gotos as long as it passed the tests. If
|
|
|
|
|
//: tests become more robust to run it becomes easier to try out radically
|
|
|
|
|
//: different implementations for the same program. If code is super-easy to
|
|
|
|
|
//: rewrite, it becomes less important what indentation style it uses, or that
|
|
|
|
|
//: the objects are appropriately encapsulated, or that the functions are
|
|
|
|
|
//: referentially transparent.
|
|
|
|
|
//:
|
|
|
|
|
//: Instead of plumbing, programming becomes building and gradually refining a
|
|
|
|
|
//: map of the environment the program must operate under. Whether a program is
|
|
|
|
|
//: 'correct' at a given point in time is a red herring; what matters is
|
|
|
|
|
//: avoiding regression by monotonically nailing down the more 'eventful' parts
|
2017-03-02 12:41:24 +00:00
|
|
|
|
//: of the terrain. It helps readers new and old, and rewards curiosity, to
|
|
|
|
|
//: organize large programs in self-similar hierarchies of example scenarios
|
2015-03-17 03:26:59 +00:00
|
|
|
|
//: colocated with the code that makes them work.
|
|
|
|
|
//:
|
|
|
|
|
//: "Programming properly should be regarded as an activity by which
|
|
|
|
|
//: programmers form a mental model, rather than as production of a program."
|
|
|
|
|
//: -- Peter Naur (http://alistair.cockburn.us/ASD+book+extract%3A+%22Naur,+Ehn,+Musashi%22)
|
2015-02-18 00:57:37 +00:00
|
|
|
|
|
2015-05-22 01:10:17 +00:00
|
|
|
|
:(before "End Types")
|
|
|
|
|
struct trace_line {
|
2015-05-22 01:57:25 +00:00
|
|
|
|
int depth; // optional field just to help browse traces later
|
2015-05-22 01:10:17 +00:00
|
|
|
|
string label;
|
|
|
|
|
string contents;
|
2015-05-22 01:57:25 +00:00
|
|
|
|
trace_line(string l, string c) :depth(0), label(l), contents(c) {}
|
|
|
|
|
trace_line(int d, string l, string c) :depth(d), label(l), contents(c) {}
|
2015-05-22 01:10:17 +00:00
|
|
|
|
};
|
|
|
|
|
|
2015-10-07 06:38:28 +00:00
|
|
|
|
:(before "End Globals")
|
2018-07-26 17:23:59 +00:00
|
|
|
|
bool Hide_errors = false; // if set, don't print even error trace lines to screen
|
|
|
|
|
bool Dump_trace = false; // if set, print trace lines to screen
|
|
|
|
|
string Dump_label = ""; // if set, print trace lines matching a single label to screen
|
2017-07-09 21:34:17 +00:00
|
|
|
|
:(before "End Reset")
|
2015-10-07 05:35:21 +00:00
|
|
|
|
Hide_errors = false;
|
2016-10-18 17:04:39 +00:00
|
|
|
|
Dump_trace = false;
|
2016-11-06 05:17:55 +00:00
|
|
|
|
Dump_label = "";
|
2015-10-07 05:35:21 +00:00
|
|
|
|
|
2018-07-26 17:09:29 +00:00
|
|
|
|
//: Support for tracing an entire run.
|
|
|
|
|
//: Traces can have a lot of overhead, so only turn them on when asked.
|
|
|
|
|
:(before "End Commandline Options(*arg)")
|
|
|
|
|
else if (is_equal(*arg, "--trace")) {
|
|
|
|
|
Save_trace = true;
|
|
|
|
|
}
|
|
|
|
|
:(before "End Commandline Parsing")
|
|
|
|
|
if (Save_trace) {
|
|
|
|
|
cerr << "initializing trace\n";
|
|
|
|
|
Trace_stream = new trace_stream;
|
|
|
|
|
}
|
|
|
|
|
:(code)
|
|
|
|
|
void cleanup_main() {
|
|
|
|
|
if (!Trace_stream) return;
|
|
|
|
|
if (Save_trace)
|
|
|
|
|
Trace_stream->save();
|
|
|
|
|
delete Trace_stream;
|
|
|
|
|
Trace_stream = NULL;
|
|
|
|
|
}
|
|
|
|
|
:(before "End One-time Setup")
|
|
|
|
|
atexit(cleanup_main);
|
|
|
|
|
|
2016-08-28 21:55:43 +00:00
|
|
|
|
:(before "End Types")
|
2016-08-29 01:12:03 +00:00
|
|
|
|
// Pre-define some global constants that trace_stream needs to know about.
|
|
|
|
|
// Since they're in the Types section, they'll be included in any cleaved
|
|
|
|
|
// compilation units. So no extern linkage.
|
2016-08-28 21:55:43 +00:00
|
|
|
|
const int Max_depth = 9999;
|
|
|
|
|
const int Error_depth = 0; // definitely always print errors
|
2016-10-22 23:56:07 +00:00
|
|
|
|
const int App_depth = 2; // temporarily where all Mu code will trace to
|
2016-08-28 21:55:43 +00:00
|
|
|
|
|
2015-02-18 00:57:37 +00:00
|
|
|
|
struct trace_stream {
|
2015-05-22 01:10:17 +00:00
|
|
|
|
vector<trace_line> past_lines;
|
2015-02-18 00:57:37 +00:00
|
|
|
|
// accumulator for current line
|
|
|
|
|
ostringstream* curr_stream;
|
2015-10-06 05:53:41 +00:00
|
|
|
|
string curr_label;
|
2015-05-22 01:57:25 +00:00
|
|
|
|
int curr_depth;
|
2015-10-19 22:07:54 +00:00
|
|
|
|
int callstack_depth;
|
2015-10-07 06:38:28 +00:00
|
|
|
|
int collect_depth;
|
2015-07-14 22:51:15 +00:00
|
|
|
|
ofstream null_stream; // never opens a file, so writes silently fail
|
2015-10-19 22:07:54 +00:00
|
|
|
|
trace_stream() :curr_stream(NULL), curr_depth(Max_depth), callstack_depth(0), collect_depth(Max_depth) {}
|
2015-02-18 00:57:37 +00:00
|
|
|
|
~trace_stream() { if (curr_stream) delete curr_stream; }
|
|
|
|
|
|
2015-10-06 05:53:41 +00:00
|
|
|
|
ostream& stream(string label) {
|
2015-10-07 06:38:28 +00:00
|
|
|
|
return stream(Max_depth, label);
|
2015-05-22 01:57:25 +00:00
|
|
|
|
}
|
|
|
|
|
|
2015-10-06 05:53:41 +00:00
|
|
|
|
ostream& stream(int depth, string label) {
|
2015-10-07 06:38:28 +00:00
|
|
|
|
if (depth > collect_depth) return null_stream;
|
2015-02-18 00:57:37 +00:00
|
|
|
|
curr_stream = new ostringstream;
|
2015-10-06 05:53:41 +00:00
|
|
|
|
curr_label = label;
|
2015-05-22 01:57:25 +00:00
|
|
|
|
curr_depth = depth;
|
2015-02-18 00:57:37 +00:00
|
|
|
|
return *curr_stream;
|
|
|
|
|
}
|
|
|
|
|
|
2018-07-26 05:25:12 +00:00
|
|
|
|
void save() {
|
2018-07-26 17:23:59 +00:00
|
|
|
|
cerr << "saving trace to 'last_run'\n";
|
2017-12-05 09:15:10 +00:00
|
|
|
|
ofstream fout("last_run");
|
|
|
|
|
fout << readable_contents("");
|
|
|
|
|
fout.close();
|
|
|
|
|
}
|
|
|
|
|
|
2015-10-06 05:53:41 +00:00
|
|
|
|
// be sure to call this before messing with curr_stream or curr_label
|
2016-08-28 21:55:43 +00:00
|
|
|
|
void newline();
|
2016-02-25 15:31:20 +00:00
|
|
|
|
// useful for debugging
|
2016-08-28 21:55:43 +00:00
|
|
|
|
string readable_contents(string label); // empty label = show everything
|
2015-02-18 00:57:37 +00:00
|
|
|
|
};
|
|
|
|
|
|
2016-08-28 21:55:43 +00:00
|
|
|
|
:(code)
|
|
|
|
|
void trace_stream::newline() {
|
|
|
|
|
if (!curr_stream) return;
|
|
|
|
|
string curr_contents = curr_stream->str();
|
3370
Fix CI.
Figuring out this memory leak was an epic story. I was able to quickly
track down that it was caused by commit 3365, in particular the
overloading of to-text to support characters. But beyond that I was
stumped. Why were layer 3's trace_stream::curr_stream objects being
leaked in layer 81 by a change in layer 59?!
Triaging through the layers, I found the following:
layer 81 - leaks 2 blocks (in clear-line-erases-printed-characters)
layer 83 - leaks 4 additional blocks (in clear-line-erases-printed-characters-2)
I also figured out that the leaks were happening because of the call to
'trace' on a character inside print:character (that's the 'print'
function called with a character argument)
trace 90, [print-character], c
So I tried to create a simple scenario:
scenario trace-on-character-leaks [
1:character <- copy 111/o
trace 90, [print-character], 1:character
]
But that triggered no leaks. Which made sense because there were plenty
of calls to that 'trace' instruction in print:character. The leak only
happened when print:character was called from clear-line. Oh, it happens
only when tracing 0/nul characters. Tracing a Mu string with a nul
character creates an empty C++ string, which is weird. But why should it
leak memory?!
Anyway, I tried a new scenario at layer 62 (when 'trace' starts
auto-converting characters to text)
scenario stashing-nul-character-leaks [
1:character <- copy 0/nul
trace 90, [dbg], 1:character
]
But still, no leak! I played around with running layers until 70, 80.
But then it didn't leak even at layer 82 where I'd seen it leak before.
What had I done?
Turns out it was only leaking if I used names for variables and not
numeric addresses. Eventually I was able to get layer 59 to leak:
scenario stashing-nul-character-leaks [
c:character <- copy 0/nul
x:text <- to-text c
trace 90, [dbg], x
]
At that point I finally went to look at layer 3 (I'd been thinking about
it before, but hadn't bothered to *actually go look*!) And the leak was
obvious.
In the end, all the information I needed was right there in the leak
report. The reason this was hard to find was that I wasn't ready to
believe there could be a bug in layer 3 after all these months. I had to
go through the five stages of grief before I was ready for that
realization.
Final mystery: why was the memory leak not triggered by numeric
variables? Because the transform to auto-convert ingredients to text
only operated on named variables. Manually performing the transform did
leak:
scenario stashing-text-containing-nul-character-leaks [
1:text <- new character:type, 1/capacity
put-index *1:text, 0, 0/nul
trace 90, [dbg], 1:text
]
2016-09-16 21:37:52 +00:00
|
|
|
|
if (!curr_contents.empty()) {
|
|
|
|
|
past_lines.push_back(trace_line(curr_depth, trim(curr_label), curr_contents)); // preserve indent in contents
|
2016-11-06 05:17:55 +00:00
|
|
|
|
if ((!Hide_errors && curr_label == "error")
|
|
|
|
|
|| Dump_trace
|
|
|
|
|
|| (!Dump_label.empty() && curr_label == Dump_label))
|
3370
Fix CI.
Figuring out this memory leak was an epic story. I was able to quickly
track down that it was caused by commit 3365, in particular the
overloading of to-text to support characters. But beyond that I was
stumped. Why were layer 3's trace_stream::curr_stream objects being
leaked in layer 81 by a change in layer 59?!
Triaging through the layers, I found the following:
layer 81 - leaks 2 blocks (in clear-line-erases-printed-characters)
layer 83 - leaks 4 additional blocks (in clear-line-erases-printed-characters-2)
I also figured out that the leaks were happening because of the call to
'trace' on a character inside print:character (that's the 'print'
function called with a character argument)
trace 90, [print-character], c
So I tried to create a simple scenario:
scenario trace-on-character-leaks [
1:character <- copy 111/o
trace 90, [print-character], 1:character
]
But that triggered no leaks. Which made sense because there were plenty
of calls to that 'trace' instruction in print:character. The leak only
happened when print:character was called from clear-line. Oh, it happens
only when tracing 0/nul characters. Tracing a Mu string with a nul
character creates an empty C++ string, which is weird. But why should it
leak memory?!
Anyway, I tried a new scenario at layer 62 (when 'trace' starts
auto-converting characters to text)
scenario stashing-nul-character-leaks [
1:character <- copy 0/nul
trace 90, [dbg], 1:character
]
But still, no leak! I played around with running layers until 70, 80.
But then it didn't leak even at layer 82 where I'd seen it leak before.
What had I done?
Turns out it was only leaking if I used names for variables and not
numeric addresses. Eventually I was able to get layer 59 to leak:
scenario stashing-nul-character-leaks [
c:character <- copy 0/nul
x:text <- to-text c
trace 90, [dbg], x
]
At that point I finally went to look at layer 3 (I'd been thinking about
it before, but hadn't bothered to *actually go look*!) And the leak was
obvious.
In the end, all the information I needed was right there in the leak
report. The reason this was hard to find was that I wasn't ready to
believe there could be a bug in layer 3 after all these months. I had to
go through the five stages of grief before I was ready for that
realization.
Final mystery: why was the memory leak not triggered by numeric
variables? Because the transform to auto-convert ingredients to text
only operated on named variables. Manually performing the transform did
leak:
scenario stashing-text-containing-nul-character-leaks [
1:text <- new character:type, 1/capacity
put-index *1:text, 0, 0/nul
trace 90, [dbg], 1:text
]
2016-09-16 21:37:52 +00:00
|
|
|
|
cerr << curr_label << ": " << curr_contents << '\n';
|
|
|
|
|
}
|
2016-08-28 21:55:43 +00:00
|
|
|
|
delete curr_stream;
|
|
|
|
|
curr_stream = NULL;
|
|
|
|
|
curr_label.clear();
|
|
|
|
|
curr_depth = Max_depth;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
string trace_stream::readable_contents(string label) {
|
|
|
|
|
ostringstream output;
|
|
|
|
|
label = trim(label);
|
2016-10-20 05:10:35 +00:00
|
|
|
|
for (vector<trace_line>::iterator p = past_lines.begin(); p != past_lines.end(); ++p)
|
2016-08-28 21:55:43 +00:00
|
|
|
|
if (label.empty() || label == p->label) {
|
|
|
|
|
output << std::setw(4) << p->depth << ' ' << p->label << ": " << p->contents << '\n';
|
|
|
|
|
}
|
|
|
|
|
return output.str();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
:(before "End Globals")
|
2015-02-18 00:57:37 +00:00
|
|
|
|
trace_stream* Trace_stream = NULL;
|
2016-08-22 15:57:42 +00:00
|
|
|
|
int Trace_errors = 0; // used only when Trace_stream is NULL
|
2015-02-18 00:57:37 +00:00
|
|
|
|
|
2016-08-28 22:21:12 +00:00
|
|
|
|
:(before "End Includes")
|
|
|
|
|
#define CLEAR_TRACE delete Trace_stream, Trace_stream = new trace_stream;
|
|
|
|
|
|
2016-02-25 15:31:20 +00:00
|
|
|
|
// Top-level helper. IMPORTANT: can't nest
|
2015-05-22 01:57:25 +00:00
|
|
|
|
#define trace(...) !Trace_stream ? cerr /*print nothing*/ : Trace_stream->stream(__VA_ARGS__)
|
2016-02-25 15:31:20 +00:00
|
|
|
|
|
2016-08-28 22:21:12 +00:00
|
|
|
|
// Just for debugging; 'git log' should never show any calls to 'dbg'.
|
|
|
|
|
#define dbg trace(0, "a")
|
|
|
|
|
#define DUMP(label) if (Trace_stream) cerr << Trace_stream->readable_contents(label);
|
|
|
|
|
|
2016-02-25 19:29:42 +00:00
|
|
|
|
// Errors are a special layer.
|
2017-06-16 23:56:29 +00:00
|
|
|
|
#define raise (!Trace_stream ? (scroll_to_bottom_and_close_console(),++Trace_errors,cerr) /*do print*/ : Trace_stream->stream(Error_depth, "error"))
|
2016-11-11 05:39:02 +00:00
|
|
|
|
// If we aren't yet sure how to deal with some corner case, use assert_for_now
|
|
|
|
|
// to indicate that it isn't an inviolable invariant.
|
|
|
|
|
#define assert_for_now assert
|
2016-08-28 22:21:12 +00:00
|
|
|
|
|
2017-06-16 23:56:29 +00:00
|
|
|
|
//: Automatically close the console in some situations.
|
|
|
|
|
:(before "End One-time Setup")
|
|
|
|
|
atexit(scroll_to_bottom_and_close_console);
|
|
|
|
|
:(code)
|
|
|
|
|
void scroll_to_bottom_and_close_console() {
|
|
|
|
|
if (!tb_is_active()) return;
|
|
|
|
|
// leave the screen in a relatively clean state
|
|
|
|
|
tb_set_cursor(tb_width()-1, tb_height()-1);
|
|
|
|
|
cout << "\r\n";
|
|
|
|
|
tb_shutdown();
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-25 15:31:20 +00:00
|
|
|
|
// Inside tests, fail any tests that displayed (unexpected) errors.
|
|
|
|
|
// Expected errors in tests should always be hidden and silently checked for.
|
|
|
|
|
:(before "End Test Teardown")
|
2016-11-16 05:55:56 +00:00
|
|
|
|
if (Passed && !Hide_errors && trace_contains_errors()) {
|
2016-02-25 15:31:20 +00:00
|
|
|
|
Passed = false;
|
|
|
|
|
}
|
2016-11-16 05:55:56 +00:00
|
|
|
|
:(code)
|
|
|
|
|
bool trace_contains_errors() {
|
|
|
|
|
return Trace_errors > 0 || trace_count("error") > 0;
|
|
|
|
|
}
|
2015-02-18 00:57:37 +00:00
|
|
|
|
|
|
|
|
|
:(before "End Types")
|
2015-07-25 07:02:20 +00:00
|
|
|
|
struct end {};
|
2016-08-28 21:55:43 +00:00
|
|
|
|
:(code)
|
2018-07-26 03:47:41 +00:00
|
|
|
|
ostream& operator<<(ostream& os, end /*unused*/) {
|
2015-02-18 00:57:37 +00:00
|
|
|
|
if (Trace_stream) Trace_stream->newline();
|
2015-07-25 07:02:20 +00:00
|
|
|
|
return os;
|
2015-02-18 00:57:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
2016-08-28 21:55:43 +00:00
|
|
|
|
:(before "End Globals")
|
2018-07-26 17:23:59 +00:00
|
|
|
|
bool Save_trace = false; // if set, write out trace to disk
|
2015-05-28 20:25:23 +00:00
|
|
|
|
|
|
|
|
|
// Trace_stream is a resource, lease_tracer uses RAII to manage it.
|
2016-08-28 22:21:12 +00:00
|
|
|
|
:(before "End Types")
|
2015-02-18 00:57:37 +00:00
|
|
|
|
struct lease_tracer {
|
2016-08-28 22:21:12 +00:00
|
|
|
|
lease_tracer();
|
|
|
|
|
~lease_tracer();
|
2015-02-18 00:57:37 +00:00
|
|
|
|
};
|
2016-08-28 22:21:12 +00:00
|
|
|
|
:(code)
|
|
|
|
|
lease_tracer::lease_tracer() { Trace_stream = new trace_stream; }
|
|
|
|
|
lease_tracer::~lease_tracer() {
|
2018-07-26 05:25:12 +00:00
|
|
|
|
if (Save_trace) Trace_stream->save();
|
2016-08-28 22:21:12 +00:00
|
|
|
|
delete Trace_stream, Trace_stream = NULL;
|
|
|
|
|
}
|
|
|
|
|
:(before "End Includes")
|
2015-02-18 00:57:37 +00:00
|
|
|
|
#define START_TRACING_UNTIL_END_OF_SCOPE lease_tracer leased_tracer;
|
|
|
|
|
:(before "End Test Setup")
|
2015-11-08 03:54:38 +00:00
|
|
|
|
START_TRACING_UNTIL_END_OF_SCOPE
|
2015-02-18 00:57:37 +00:00
|
|
|
|
|
2015-09-12 21:58:33 +00:00
|
|
|
|
:(before "End Includes")
|
2015-05-21 18:37:50 +00:00
|
|
|
|
#define CHECK_TRACE_CONTENTS(...) check_trace_contents(__FUNCTION__, __FILE__, __LINE__, __VA_ARGS__)
|
|
|
|
|
|
2016-11-16 05:55:56 +00:00
|
|
|
|
#define CHECK_TRACE_CONTAINS_ERRORS() CHECK(trace_contains_errors())
|
|
|
|
|
#define CHECK_TRACE_DOESNT_CONTAIN_ERRORS() \
|
|
|
|
|
if (Passed && trace_contains_errors()) { \
|
2016-08-29 06:27:04 +00:00
|
|
|
|
cerr << "\nF - " << __FUNCTION__ << "(" << __FILE__ << ":" << __LINE__ << "): unexpected errors\n"; \
|
|
|
|
|
DUMP("error"); \
|
|
|
|
|
Passed = false; \
|
|
|
|
|
return; \
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#define CHECK_TRACE_COUNT(label, count) \
|
2016-09-02 07:42:43 +00:00
|
|
|
|
if (Passed && trace_count(label) != (count)) { \
|
2016-08-29 06:27:04 +00:00
|
|
|
|
cerr << "\nF - " << __FUNCTION__ << "(" << __FILE__ << ":" << __LINE__ << "): trace_count of " << label << " should be " << count << '\n'; \
|
|
|
|
|
cerr << " got " << trace_count(label) << '\n'; /* multiple eval */ \
|
|
|
|
|
DUMP(label); \
|
|
|
|
|
Passed = false; \
|
|
|
|
|
return; /* Currently we stop at the very first failure. */ \
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#define CHECK_TRACE_DOESNT_CONTAIN(...) CHECK(trace_doesnt_contain(__VA_ARGS__))
|
|
|
|
|
|
2016-08-28 21:55:43 +00:00
|
|
|
|
:(code)
|
2015-09-29 16:12:31 +00:00
|
|
|
|
bool check_trace_contents(string FUNCTION, string FILE, int LINE, string expected) {
|
2016-09-02 07:42:43 +00:00
|
|
|
|
if (!Passed) return false;
|
2015-09-16 02:48:53 +00:00
|
|
|
|
if (!Trace_stream) return false;
|
2015-02-18 00:57:37 +00:00
|
|
|
|
vector<string> expected_lines = split(expected, "");
|
2016-03-14 03:26:47 +00:00
|
|
|
|
int curr_expected_line = 0;
|
2015-05-17 09:22:41 +00:00
|
|
|
|
while (curr_expected_line < SIZE(expected_lines) && expected_lines.at(curr_expected_line).empty())
|
2015-02-18 00:57:37 +00:00
|
|
|
|
++curr_expected_line;
|
2015-05-17 09:22:41 +00:00
|
|
|
|
if (curr_expected_line == SIZE(expected_lines)) return true;
|
2015-10-06 05:53:41 +00:00
|
|
|
|
string label, contents;
|
|
|
|
|
split_label_contents(expected_lines.at(curr_expected_line), &label, &contents);
|
2016-10-20 05:10:35 +00:00
|
|
|
|
for (vector<trace_line>::iterator p = Trace_stream->past_lines.begin(); p != Trace_stream->past_lines.end(); ++p) {
|
2016-06-11 17:46:37 +00:00
|
|
|
|
if (label != p->label) continue;
|
|
|
|
|
if (contents != trim(p->contents)) continue;
|
2015-02-18 00:57:37 +00:00
|
|
|
|
++curr_expected_line;
|
2015-05-17 09:22:41 +00:00
|
|
|
|
while (curr_expected_line < SIZE(expected_lines) && expected_lines.at(curr_expected_line).empty())
|
2015-02-18 00:57:37 +00:00
|
|
|
|
++curr_expected_line;
|
2015-05-17 09:22:41 +00:00
|
|
|
|
if (curr_expected_line == SIZE(expected_lines)) return true;
|
2015-10-06 05:53:41 +00:00
|
|
|
|
split_label_contents(expected_lines.at(curr_expected_line), &label, &contents);
|
2015-02-18 00:57:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
2016-06-11 17:46:37 +00:00
|
|
|
|
if (line_exists_anywhere(label, contents)) {
|
|
|
|
|
cerr << "\nF - " << FUNCTION << "(" << FILE << ":" << LINE << "): line [" << label << ": " << contents << "] out of order in trace:\n";
|
|
|
|
|
DUMP("");
|
|
|
|
|
}
|
|
|
|
|
else {
|
|
|
|
|
cerr << "\nF - " << FUNCTION << "(" << FILE << ":" << LINE << "): missing [" << contents << "] in trace:\n";
|
|
|
|
|
DUMP(label);
|
|
|
|
|
}
|
2015-02-18 00:57:37 +00:00
|
|
|
|
Passed = false;
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2015-10-06 05:53:41 +00:00
|
|
|
|
void split_label_contents(const string& s, string* label, string* contents) {
|
2015-05-21 18:29:19 +00:00
|
|
|
|
static const string delim(": ");
|
2015-05-17 09:22:41 +00:00
|
|
|
|
size_t pos = s.find(delim);
|
|
|
|
|
if (pos == string::npos) {
|
2015-10-06 05:53:41 +00:00
|
|
|
|
*label = "";
|
2015-05-21 19:36:59 +00:00
|
|
|
|
*contents = trim(s);
|
2015-02-18 00:57:37 +00:00
|
|
|
|
}
|
|
|
|
|
else {
|
2015-10-06 05:53:41 +00:00
|
|
|
|
*label = trim(s.substr(0, pos));
|
2015-05-21 19:36:59 +00:00
|
|
|
|
*contents = trim(s.substr(pos+SIZE(delim)));
|
2015-02-18 00:57:37 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-06-11 17:46:37 +00:00
|
|
|
|
bool line_exists_anywhere(const string& label, const string& contents) {
|
2016-10-20 05:10:35 +00:00
|
|
|
|
for (vector<trace_line>::iterator p = Trace_stream->past_lines.begin(); p != Trace_stream->past_lines.end(); ++p) {
|
2016-06-11 17:46:37 +00:00
|
|
|
|
if (label != p->label) continue;
|
|
|
|
|
if (contents == trim(p->contents)) return true;
|
|
|
|
|
}
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2015-10-06 05:53:41 +00:00
|
|
|
|
int trace_count(string label) {
|
|
|
|
|
return trace_count(label, "");
|
2015-02-18 00:57:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
2015-10-06 05:53:41 +00:00
|
|
|
|
int trace_count(string label, string line) {
|
2016-02-25 15:31:20 +00:00
|
|
|
|
if (!Trace_stream) return 0;
|
2015-02-18 00:57:37 +00:00
|
|
|
|
long result = 0;
|
2016-10-20 05:10:35 +00:00
|
|
|
|
for (vector<trace_line>::iterator p = Trace_stream->past_lines.begin(); p != Trace_stream->past_lines.end(); ++p) {
|
2015-10-06 05:53:41 +00:00
|
|
|
|
if (label == p->label) {
|
2015-12-24 23:36:12 +00:00
|
|
|
|
if (line == "" || trim(line) == trim(p->contents))
|
2015-02-18 00:57:37 +00:00
|
|
|
|
++result;
|
2015-06-28 01:06:28 +00:00
|
|
|
|
}
|
2015-02-18 00:57:37 +00:00
|
|
|
|
}
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
|
2016-08-17 19:14:09 +00:00
|
|
|
|
int trace_count_prefix(string label, string prefix) {
|
|
|
|
|
if (!Trace_stream) return 0;
|
|
|
|
|
long result = 0;
|
2016-10-20 05:10:35 +00:00
|
|
|
|
for (vector<trace_line>::iterator p = Trace_stream->past_lines.begin(); p != Trace_stream->past_lines.end(); ++p) {
|
2016-08-17 19:14:09 +00:00
|
|
|
|
if (label == p->label) {
|
|
|
|
|
if (starts_with(trim(p->contents), trim(prefix)))
|
|
|
|
|
++result;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
|
2015-10-06 05:53:41 +00:00
|
|
|
|
bool trace_doesnt_contain(string label, string line) {
|
|
|
|
|
return trace_count(label, line) == 0;
|
2015-02-18 00:57:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
bool trace_doesnt_contain(string expected) {
|
2015-09-12 21:39:20 +00:00
|
|
|
|
vector<string> tmp = split_first(expected, ": ");
|
2015-05-07 22:49:40 +00:00
|
|
|
|
return trace_doesnt_contain(tmp.at(0), tmp.at(1));
|
2015-02-18 00:57:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
vector<string> split(string s, string delim) {
|
|
|
|
|
vector<string> result;
|
2015-05-17 09:22:41 +00:00
|
|
|
|
size_t begin=0, end=s.find(delim);
|
2015-02-18 00:57:37 +00:00
|
|
|
|
while (true) {
|
2015-05-17 09:22:41 +00:00
|
|
|
|
if (end == string::npos) {
|
|
|
|
|
result.push_back(string(s, begin, string::npos));
|
2015-02-18 00:57:37 +00:00
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
result.push_back(string(s, begin, end-begin));
|
2015-09-12 21:39:20 +00:00
|
|
|
|
begin = end+SIZE(delim);
|
2015-02-18 00:57:37 +00:00
|
|
|
|
end = s.find(delim, begin);
|
|
|
|
|
}
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-12 21:39:20 +00:00
|
|
|
|
vector<string> split_first(string s, string delim) {
|
|
|
|
|
vector<string> result;
|
|
|
|
|
size_t end=s.find(delim);
|
|
|
|
|
result.push_back(string(s, 0, end));
|
|
|
|
|
if (end != string::npos)
|
|
|
|
|
result.push_back(string(s, end+SIZE(delim), string::npos));
|
|
|
|
|
return result;
|
|
|
|
|
}
|
|
|
|
|
|
2015-05-21 19:36:59 +00:00
|
|
|
|
string trim(const string& s) {
|
|
|
|
|
string::const_iterator first = s.begin();
|
|
|
|
|
while (first != s.end() && isspace(*first))
|
|
|
|
|
++first;
|
|
|
|
|
if (first == s.end()) return "";
|
|
|
|
|
|
|
|
|
|
string::const_iterator last = --s.end();
|
|
|
|
|
while (last != s.begin() && isspace(*last))
|
|
|
|
|
--last;
|
|
|
|
|
++last;
|
|
|
|
|
return string(first, last);
|
|
|
|
|
}
|
|
|
|
|
|
2015-02-18 00:57:37 +00:00
|
|
|
|
:(before "End Includes")
|
2016-06-02 17:40:06 +00:00
|
|
|
|
#include <vector>
|
2015-02-18 00:57:37 +00:00
|
|
|
|
using std::vector;
|
2016-06-02 17:40:06 +00:00
|
|
|
|
#include <list>
|
2015-02-18 00:57:37 +00:00
|
|
|
|
using std::list;
|
2016-06-02 17:40:06 +00:00
|
|
|
|
#include <set>
|
2015-04-25 00:09:17 +00:00
|
|
|
|
using std::set;
|
2015-02-18 00:57:37 +00:00
|
|
|
|
|
2016-06-02 17:40:06 +00:00
|
|
|
|
#include <sstream>
|
2015-02-18 00:57:37 +00:00
|
|
|
|
using std::istringstream;
|
|
|
|
|
using std::ostringstream;
|
|
|
|
|
|
2016-06-02 17:40:06 +00:00
|
|
|
|
#include <fstream>
|
2015-02-18 00:57:37 +00:00
|
|
|
|
using std::ifstream;
|
|
|
|
|
using std::ofstream;
|
|
|
|
|
|
2016-06-02 17:40:06 +00:00
|
|
|
|
#include "termbox/termbox.h"
|
2015-06-21 07:24:12 +00:00
|
|
|
|
|
2016-08-29 01:12:03 +00:00
|
|
|
|
:(before "End Globals")
|
2015-05-22 01:57:25 +00:00
|
|
|
|
//: In future layers we'll use the depth field as follows:
|
|
|
|
|
//:
|
2015-10-19 22:07:54 +00:00
|
|
|
|
//: Errors will be depth 0.
|
2016-02-25 19:29:42 +00:00
|
|
|
|
//: Mu 'applications' will be able to use depths 1-100 as they like.
|
2015-10-29 19:09:23 +00:00
|
|
|
|
//: Primitive statements will occupy 101-9989
|
2016-08-29 01:12:03 +00:00
|
|
|
|
extern const int Initial_callstack_depth = 101;
|
|
|
|
|
extern const int Max_callstack_depth = 9989;
|
2016-10-22 23:56:07 +00:00
|
|
|
|
//: Finally, details of primitive Mu statements will occupy depth 9990-9999
|
|
|
|
|
//: (more on that later as well)
|
2015-05-22 01:57:25 +00:00
|
|
|
|
//:
|
|
|
|
|
//: This framework should help us hide some details at each level, mixing
|
|
|
|
|
//: static ideas like layers with the dynamic notion of call-stack depth.
|