diff options
| author | Kartik K. Agaram <vc@akkartik.com> | 2016-12-26 01:17:01 -0800 |
|---|---|---|
| committer | Kartik K. Agaram <vc@akkartik.com> | 2016-12-26 01:26:16 -0800 |
| commit | e5c11a5137d538b7713dd8708ca767c208824c06 (patch) | |
| tree | 82976fd80e5d8048840701c351827730b29f89f6 /html/003trace.cc.html | |
| parent | 63e1c465e46502bd7c391e31db73e7e5ae19adfd (diff) | |
| download | mu-e5c11a5137d538b7713dd8708ca767c208824c06.tar.gz | |
3709 - line numbers in html
Each line number also gets an anchor name, but I'm not hyperlinking them for now because I don't want to encourage bookmarking these links just yet. They aren't permalinks because every revision may change what's at any given line number.
Diffstat (limited to 'html/003trace.cc.html')
| -rw-r--r-- | html/003trace.cc.html | 852 |
1 files changed, 438 insertions, 414 deletions
diff --git a/html/003trace.cc.html b/html/003trace.cc.html index 7cb4e3e8..e16ad235 100644 --- a/html/003trace.cc.html +++ b/html/003trace.cc.html @@ -6,7 +6,7 @@ <meta name="Generator" content="Vim/7.4"> <meta name="plugin-version" content="vim7.4_v2"> <meta name="syntax" content="cpp"> -<meta name="settings" content="use_css,pre_wrap,no_foldcolumn,expand_tabs,prevent_copy="> +<meta name="settings" content="number_lines,use_css,pre_wrap,no_foldcolumn,expand_tabs,line_ids,prevent_copy="> <meta name="colorscheme" content="minimal"> <style type="text/css"> <!-- @@ -14,9 +14,10 @@ pre { white-space: pre-wrap; font-family: monospace; color: #eeeeee; background- body { font-size: 12pt; font-family: monospace; color: #eeeeee; background-color: #080808; } * { font-size: 12pt; font-size: 1em; } .Constant { color: #00a0a0; } +.cSpecial { color: #008000; } .Comment { color: #9090ff; } .Delimiter { color: #800080; } -.cSpecial { color: #008000; } +.LineNr { color: #444444; } .Identifier { color: #c0a020; } .Normal { color: #eeeeee; background-color: #080808; padding-bottom: 1px; } .PreProc { color: #800080; } @@ -26,422 +27,445 @@ body { font-size: 12pt; font-family: monospace; color: #eeeeee; background-color <script type='text/javascript'> <!-- +/* function to open any folds containing a jumped-to line before jumping to it */ +function JumpToLine() +{ + var lineNum; + lineNum = window.location.hash; + lineNum = lineNum.substr(1); /* strip off '#' */ + + if (lineNum.indexOf('L') == -1) { + lineNum = 'L'+lineNum; + } + lineElem = document.getElementById(lineNum); + /* Always jump to new location even if the line was hidden inside a fold, or + * we corrected the raw number to a line ID. + */ + if (lineElem) { + lineElem.scrollIntoView(true); + } + return true; +} +if ('onhashchange' in window) { + window.onhashchange = JumpToLine; +} + --> </script> </head> -<body> +<body onload='JumpToLine();'> <pre id='vimCodeElement'> -<span class="Comment">//: The goal of this skeleton is to make programs more easy to understand and</span> -<span class="Comment">//: more malleable, easy to rewrite in radical ways without accidentally</span> -<span class="Comment">//: breaking some corner case. Tests further both goals. They help</span> -<span class="Comment">//: understandability by letting one make small changes and get feedback. What</span> -<span class="Comment">//: if I wrote this line like so? What if I removed this function call, is it</span> -<span class="Comment">//: really necessary? Just try it, see if the tests pass. Want to explore</span> -<span class="Comment">//: rewriting this bit in this way? Tests put many refactorings on a firmer</span> -<span class="Comment">//: footing.</span> -<span class="Comment">//:</span> -<span class="Comment">//: But the usual way we write tests seems incomplete. Refactorings tend to</span> -<span class="Comment">//: work in the small, but don't help with changes to function boundaries. If</span> -<span class="Comment">//: you want to extract a new function you have to manually test-drive it to</span> -<span class="Comment">//: create tests for it. If you want to inline a function its tests are no</span> -<span class="Comment">//: longer valid. In both cases you end up having to reorganize code as well as</span> -<span class="Comment">//: tests, an error-prone activity.</span> -<span class="Comment">//:</span> -<span class="Comment">//: This file tries to fix this problem by supporting domain-driven testing</span> -<span class="Comment">//: We try to focus on the domain of inputs the program should work on. All</span> -<span class="Comment">//: tests invoke the program in a single way: by calling run() with different</span> -<span class="Comment">//: inputs. The program operates on the input and logs _facts_ it deduces to a</span> -<span class="Comment">//: trace:</span> -<span class="Comment">//: trace("label") << "fact 1: " << val;</span> -<span class="Comment">//:</span> -<span class="Comment">//: The tests check for facts:</span> -<span class="Comment">//: :(scenario foo)</span> -<span class="Comment">//: 34 # call run() with this input</span> -<span class="Comment">//: +label: fact 1: 34 # trace should have logged this at the end</span> -<span class="Comment">//: -label: fact 1: 35 # trace should never contain such a line</span> -<span class="Comment">//:</span> -<span class="Comment">//: Since we never call anything but the run() function directly, we never have</span> -<span class="Comment">//: to rewrite the tests when we reorganize the internals of the program. We</span> -<span class="Comment">//: just have to make sure our rewrite deduces the same facts about the domain,</span> -<span class="Comment">//: and that's something we're going to have to do anyway.</span> -<span class="Comment">//:</span> -<span class="Comment">//: To avoid the combinatorial explosion of integration tests, we organize the</span> -<span class="Comment">//: program into different layers, and each fact is logged to the trace with a</span> -<span class="Comment">//: specific label. Individual tests can focus on specific labels. In essence,</span> -<span class="Comment">//: validating the facts logged with a specific label is identical to calling</span> -<span class="Comment">//: some internal subsystem.</span> -<span class="Comment">//:</span> -<span class="Comment">//: Traces interact salubriously with layers. Thanks to our ordering</span> -<span class="Comment">//: directives, each layer can contain its own tests. They may rely on other</span> -<span class="Comment">//: layers, but when a test fails its usually due to breakage in the same</span> -<span class="Comment">//: layer. When multiple tests fail, it's usually useful to debug the very</span> -<span class="Comment">//: first test to fail. This is in contrast with the traditional approach,</span> -<span class="Comment">//: where changes can cause breakages in faraway subsystems, and picking the</span> -<span class="Comment">//: right test to debug can be an important skill to pick up.</span> -<span class="Comment">//:</span> -<span class="Comment">//: To build robust tests, trace facts about your domain rather than details of</span> -<span class="Comment">//: how you computed them.</span> -<span class="Comment">//:</span> -<span class="Comment">//: More details: <a href="http://akkartik.name/blog/tracing-tests">http://akkartik.name/blog/tracing-tests</a></span> -<span class="Comment">//:</span> -<span class="Comment">//: ---</span> -<span class="Comment">//:</span> -<span class="Comment">//: Between layers and domain-driven testing, programming starts to look like a</span> -<span class="Comment">//: fundamentally different activity. Instead of a) superficial, b) local rules</span> -<span class="Comment">//: on c) code [like <a href="http://blog.bbv.ch/2013/06/05/clean-code-cheat-sheet],">http://blog.bbv.ch/2013/06/05/clean-code-cheat-sheet],</a></span> -<span class="Comment">//: we allow programmers to engage with the a) deep, b) global structure of the</span> -<span class="Comment">//: c) domain. If you can systematically track discontinuities in the domain</span> -<span class="Comment">//: you don't care if the code used gotos as long as it passed the tests. If</span> -<span class="Comment">//: tests become more robust to run it becomes easier to try out radically</span> -<span class="Comment">//: different implementations for the same program. If code is super-easy to</span> -<span class="Comment">//: rewrite, it becomes less important what indentation style it uses, or that</span> -<span class="Comment">//: the objects are appropriately encapsulated, or that the functions are</span> -<span class="Comment">//: referentially transparent.</span> -<span class="Comment">//:</span> -<span class="Comment">//: Instead of plumbing, programming becomes building and gradually refining a</span> -<span class="Comment">//: map of the environment the program must operate under. Whether a program is</span> -<span class="Comment">//: 'correct' at a given point in time is a red herring; what matters is</span> -<span class="Comment">//: avoiding regression by monotonically nailing down the more 'eventful' parts</span> -<span class="Comment">//: of the terrain. It helps readers new and old and rewards curiosity to</span> -<span class="Comment">//: organize large programs in self-similar hiearchies of example scenarios</span> -<span class="Comment">//: colocated with the code that makes them work.</span> -<span class="Comment">//:</span> -<span class="Comment">//: "Programming properly should be regarded as an activity by which</span> -<span class="Comment">//: programmers form a mental model, rather than as production of a program."</span> -<span class="Comment">//: -- Peter Naur (<a href="http://alistair.cockburn.us/ASD+book+extract%3A+%22Naur,+Ehn,+Musashi%22)">http://alistair.cockburn.us/ASD+book+extract%3A+%22Naur,+Ehn,+Musashi%22)</a></span> - -<span class="Delimiter">:(before "End Types")</span> -<span class="Normal">struct</span> trace_line <span class="Delimiter">{</span> - <span class="Normal">int</span> depth<span class="Delimiter">;</span> <span class="Comment">// optional field just to help browse traces later</span> - string label<span class="Delimiter">;</span> - string contents<span class="Delimiter">;</span> - trace_line<span class="Delimiter">(</span>string l<span class="Delimiter">,</span> string c<span class="Delimiter">)</span> :depth<span class="Delimiter">(</span><span class="Constant">0</span><span class="Delimiter">),</span> label<span class="Delimiter">(</span>l<span class="Delimiter">),</span> contents<span class="Delimiter">(</span>c<span class="Delimiter">)</span> <span class="Delimiter">{}</span> - trace_line<span class="Delimiter">(</span><span class="Normal">int</span> d<span class="Delimiter">,</span> string l<span class="Delimiter">,</span> string c<span class="Delimiter">)</span> :depth<span class="Delimiter">(</span>d<span class="Delimiter">),</span> label<span class="Delimiter">(</span>l<span class="Delimiter">),</span> contents<span class="Delimiter">(</span>c<span class="Delimiter">)</span> <span class="Delimiter">{}</span> -<span class="Delimiter">};</span> - -<span class="Delimiter">:(before "End Globals")</span> -<span class="Normal">bool</span> Hide_errors = <span class="Constant">false</span><span class="Delimiter">;</span> -<span class="Normal">bool</span> Dump_trace = <span class="Constant">false</span><span class="Delimiter">;</span> -string Dump_label = <span class="Constant">""</span><span class="Delimiter">;</span> -<span class="Delimiter">:(before "End Setup")</span> -Hide_errors = <span class="Constant">false</span><span class="Delimiter">;</span> -Dump_trace = <span class="Constant">false</span><span class="Delimiter">;</span> -Dump_label = <span class="Constant">""</span><span class="Delimiter">;</span> - -<span class="Delimiter">:(before "End Types")</span> -<span class="Comment">// Pre-define some global constants that trace_stream needs to know about.</span> -<span class="Comment">// Since they're in the Types section, they'll be included in any cleaved</span> -<span class="Comment">// compilation units. So no extern linkage.</span> -<span class="Normal">const</span> <span class="Normal">int</span> Max_depth = <span class="Constant">9999</span><span class="Delimiter">;</span> -<span class="Normal">const</span> <span class="Normal">int</span> Error_depth = <span class="Constant">0</span><span class="Delimiter">;</span> <span class="Comment">// definitely always print errors</span> -<span class="Normal">const</span> <span class="Normal">int</span> App_depth = <span class="Constant">2</span><span class="Delimiter">;</span> <span class="Comment">// temporarily where all Mu code will trace to</span> - -<span class="Normal">struct</span> trace_stream <span class="Delimiter">{</span> - vector<trace_line> past_lines<span class="Delimiter">;</span> - <span class="Comment">// accumulator for current line</span> - ostringstream* curr_stream<span class="Delimiter">;</span> - string curr_label<span class="Delimiter">;</span> - <span class="Normal">int</span> curr_depth<span class="Delimiter">;</span> - <span class="Normal">int</span> callstack_depth<span class="Delimiter">;</span> - <span class="Normal">int</span> collect_depth<span class="Delimiter">;</span> - ofstream null_stream<span class="Delimiter">;</span> <span class="Comment">// never opens a file, so writes silently fail</span> - trace_stream<span class="Delimiter">()</span> :curr_stream<span class="Delimiter">(</span><span class="Constant">NULL</span><span class="Delimiter">),</span> curr_depth<span class="Delimiter">(</span>Max_depth<span class="Delimiter">),</span> callstack_depth<span class="Delimiter">(</span><span class="Constant">0</span><span class="Delimiter">),</span> collect_depth<span class="Delimiter">(</span>Max_depth<span class="Delimiter">)</span> <span class="Delimiter">{}</span> - ~trace_stream<span class="Delimiter">()</span> <span class="Delimiter">{</span> <span class="Normal">if</span> <span class="Delimiter">(</span>curr_stream<span class="Delimiter">)</span> <span class="Normal">delete</span> curr_stream<span class="Delimiter">;</span> <span class="Delimiter">}</span> - - ostream& stream<span class="Delimiter">(</span>string label<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Identifier">return</span> stream<span class="Delimiter">(</span>Max_depth<span class="Delimiter">,</span> label<span class="Delimiter">);</span> - <span class="Delimiter">}</span> - - ostream& stream<span class="Delimiter">(</span><span class="Normal">int</span> depth<span class="Delimiter">,</span> string label<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>depth > collect_depth<span class="Delimiter">)</span> <span class="Identifier">return</span> null_stream<span class="Delimiter">;</span> - curr_stream = <span class="Normal">new</span> ostringstream<span class="Delimiter">;</span> - curr_label = label<span class="Delimiter">;</span> - curr_depth = depth<span class="Delimiter">;</span> - <span class="Identifier">return</span> *curr_stream<span class="Delimiter">;</span> - <span class="Delimiter">}</span> - - <span class="Comment">// be sure to call this before messing with curr_stream or curr_label</span> - <span class="Normal">void</span> newline<span class="Delimiter">();</span> - <span class="Comment">// useful for debugging</span> - string readable_contents<span class="Delimiter">(</span>string label<span class="Delimiter">);</span> <span class="Comment">// empty label = show everything</span> -<span class="Delimiter">};</span> - -<span class="Delimiter">:(code)</span> -<span class="Normal">void</span> trace_stream::newline<span class="Delimiter">()</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>!curr_stream<span class="Delimiter">)</span> <span class="Identifier">return</span><span class="Delimiter">;</span> - string curr_contents = curr_stream<span class="Delimiter">-></span>str<span class="Delimiter">();</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>!curr_contents<span class="Delimiter">.</span>empty<span class="Delimiter">())</span> <span class="Delimiter">{</span> - past_lines<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>trace_line<span class="Delimiter">(</span>curr_depth<span class="Delimiter">,</span> trim<span class="Delimiter">(</span>curr_label<span class="Delimiter">),</span> curr_contents<span class="Delimiter">));</span> <span class="Comment">// preserve indent in contents</span> - <span class="Normal">if</span> <span class="Delimiter">((</span>!Hide_errors && curr_label == <span class="Constant">"error"</span><span class="Delimiter">)</span> - || Dump_trace - || <span class="Delimiter">(</span>!Dump_label<span class="Delimiter">.</span>empty<span class="Delimiter">()</span> && curr_label == Dump_label<span class="Delimiter">))</span> - cerr << curr_label << <span class="Constant">": "</span> << curr_contents << <span class="cSpecial">'\n'</span><span class="Delimiter">;</span> - <span class="Delimiter">}</span> - <span class="Normal">delete</span> curr_stream<span class="Delimiter">;</span> - curr_stream = <span class="Constant">NULL</span><span class="Delimiter">;</span> - curr_label<span class="Delimiter">.</span>clear<span class="Delimiter">();</span> - curr_depth = Max_depth<span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -string trace_stream::readable_contents<span class="Delimiter">(</span>string label<span class="Delimiter">)</span> <span class="Delimiter">{</span> - ostringstream output<span class="Delimiter">;</span> - label = trim<span class="Delimiter">(</span>label<span class="Delimiter">);</span> - <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>label<span class="Delimiter">.</span>empty<span class="Delimiter">()</span> || label == p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Delimiter">{</span> - output << std::setw<span class="Delimiter">(</span><span class="Constant">4</span><span class="Delimiter">)</span> << p<span class="Delimiter">-></span>depth << <span class="Constant">' '</span> << p<span class="Delimiter">-></span>label << <span class="Constant">": "</span> << p<span class="Delimiter">-></span>contents << <span class="cSpecial">'\n'</span><span class="Delimiter">;</span> - <span class="Delimiter">}</span> - <span class="Identifier">return</span> output<span class="Delimiter">.</span>str<span class="Delimiter">();</span> -<span class="Delimiter">}</span> - -<span class="Delimiter">:(before "End Globals")</span> -trace_stream* Trace_stream = <span class="Constant">NULL</span><span class="Delimiter">;</span> -<span class="Normal">int</span> Trace_errors = <span class="Constant">0</span><span class="Delimiter">;</span> <span class="Comment">// used only when Trace_stream is NULL</span> - -<span class="Delimiter">:(before "End Includes")</span> -<span class="PreProc">#define CLEAR_TRACE </span><span class="Normal">delete</span><span class="PreProc"> Trace_stream</span><span class="Delimiter">,</span><span class="PreProc"> Trace_stream = </span><span class="Normal">new</span><span class="PreProc"> trace_stream</span><span class="Delimiter">;</span> - -<span class="Comment">// Top-level helper. IMPORTANT: can't nest</span> -<span class="PreProc">#define trace(</span><span class="Delimiter">...</span><span class="PreProc">) !Trace_stream ? cerr </span><span class="Comment">/*</span><span class="Comment">print nothing</span><span class="Comment">*/</span><span class="PreProc"> : Trace_stream</span><span class="Delimiter">-></span><span class="PreProc">stream(__VA_ARGS__)</span> - -<span class="Comment">// Just for debugging; 'git log' should never show any calls to 'dbg'.</span> -<span class="PreProc">#define dbg trace(</span><span class="Constant">0</span><span class="Delimiter">,</span><span class="PreProc"> </span><span class="Constant">"a"</span><span class="PreProc">)</span> -<span class="PreProc">#define DUMP(label) </span><span class="Normal">if</span><span class="PreProc"> (Trace_stream) cerr << Trace_stream</span><span class="Delimiter">-></span><span class="PreProc">readable_contents(label)</span><span class="Delimiter">;</span> - -<span class="Comment">// Errors are a special layer.</span> -<span class="PreProc">#define raise (!Trace_stream ? (tb_shutdown()</span><span class="Delimiter">,</span><span class="PreProc">++Trace_errors</span><span class="Delimiter">,</span><span class="PreProc">cerr) </span><span class="Comment">/*</span><span class="Comment">do print</span><span class="Comment">*/</span><span class="PreProc"> : Trace_stream</span><span class="Delimiter">-></span><span class="PreProc">stream(Error_depth</span><span class="Delimiter">,</span><span class="PreProc"> </span><span class="Constant">"error"</span><span class="PreProc">))</span> -<span class="Comment">// If we aren't yet sure how to deal with some corner case, use assert_for_now</span> -<span class="Comment">// to indicate that it isn't an inviolable invariant.</span> -<span class="PreProc">#define assert_for_now assert</span> - -<span class="Comment">// Inside tests, fail any tests that displayed (unexpected) errors.</span> -<span class="Comment">// Expected errors in tests should always be hidden and silently checked for.</span> -<span class="Delimiter">:(before "End Test Teardown")</span> -<span class="Normal">if</span> <span class="Delimiter">(</span>Passed && !Hide_errors && trace_contains_errors<span class="Delimiter">())</span> <span class="Delimiter">{</span> - Passed = <span class="Constant">false</span><span class="Delimiter">;</span> -<span class="Delimiter">}</span> -<span class="Delimiter">:(code)</span> -<span class="Normal">bool</span> trace_contains_errors<span class="Delimiter">()</span> <span class="Delimiter">{</span> - <span class="Identifier">return</span> Trace_errors > <span class="Constant">0</span> || trace_count<span class="Delimiter">(</span><span class="Constant">"error"</span><span class="Delimiter">)</span> > <span class="Constant">0</span><span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -<span class="Delimiter">:(before "End Types")</span> -<span class="Normal">struct</span> end <span class="Delimiter">{};</span> -<span class="Delimiter">:(code)</span> -ostream& <span class="Normal">operator</span><<<span class="Delimiter">(</span>ostream& os<span class="Delimiter">,</span> unused end<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>Trace_stream<span class="Delimiter">)</span> Trace_stream<span class="Delimiter">-></span>newline<span class="Delimiter">();</span> - <span class="Identifier">return</span> os<span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -<span class="Delimiter">:(before "End Globals")</span> -<span class="Normal">bool</span> Save_trace = <span class="Constant">false</span><span class="Delimiter">;</span> - -<span class="Comment">// Trace_stream is a resource, lease_tracer uses RAII to manage it.</span> -<span class="Delimiter">:(before "End Types")</span> -<span class="Normal">struct</span> lease_tracer <span class="Delimiter">{</span> - lease_tracer<span class="Delimiter">();</span> - ~lease_tracer<span class="Delimiter">();</span> -<span class="Delimiter">};</span> -<span class="Delimiter">:(code)</span> -lease_tracer::lease_tracer<span class="Delimiter">()</span> <span class="Delimiter">{</span> Trace_stream = <span class="Normal">new</span> trace_stream<span class="Delimiter">;</span> <span class="Delimiter">}</span> -lease_tracer::~lease_tracer<span class="Delimiter">()</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>!Trace_stream<span class="Delimiter">)</span> <span class="Identifier">return</span><span class="Delimiter">;</span> <span class="Comment">// in case tests close Trace_stream</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>Save_trace<span class="Delimiter">)</span> <span class="Delimiter">{</span> - ofstream fout<span class="Delimiter">(</span><span class="Constant">"last_trace"</span><span class="Delimiter">);</span> - fout << Trace_stream<span class="Delimiter">-></span>readable_contents<span class="Delimiter">(</span><span class="Constant">""</span><span class="Delimiter">);</span> - fout<span class="Delimiter">.</span>close<span class="Delimiter">();</span> - <span class="Delimiter">}</span> - <span class="Normal">delete</span> Trace_stream<span class="Delimiter">,</span> Trace_stream = <span class="Constant">NULL</span><span class="Delimiter">;</span> -<span class="Delimiter">}</span> -<span class="Delimiter">:(before "End Includes")</span> -<span class="PreProc">#define START_TRACING_UNTIL_END_OF_SCOPE lease_tracer leased_tracer</span><span class="Delimiter">;</span> -<span class="Delimiter">:(before "End Test Setup")</span> -START_TRACING_UNTIL_END_OF_SCOPE - -<span class="Delimiter">:(before "End Includes")</span> -<span class="PreProc">#define CHECK_TRACE_CONTENTS(</span><span class="Delimiter">...</span><span class="PreProc">) check_trace_contents(__FUNCTION__</span><span class="Delimiter">,</span><span class="PreProc"> </span><span class="Constant">__FILE__</span><span class="Delimiter">,</span><span class="PreProc"> </span><span class="Constant">__LINE__</span><span class="Delimiter">,</span><span class="PreProc"> __VA_ARGS__)</span> - -<span class="PreProc">#define CHECK_TRACE_CONTAINS_ERRORS() CHECK(trace_contains_errors())</span> -<span class="PreProc">#define CHECK_TRACE_DOESNT_CONTAIN_ERRORS() \</span> -<span class="PreProc"> </span><span class="Normal">if</span><span class="PreProc"> (Passed && trace_contains_errors()) </span><span class="Delimiter">{</span><span class="PreProc"> \</span> -<span class="PreProc"> cerr << </span><span class="Constant">"</span><span class="cSpecial">\n</span><span class="Constant">F - "</span><span class="PreProc"> << __FUNCTION__ << </span><span class="Constant">"("</span><span class="PreProc"> << </span><span class="Constant">__FILE__</span><span class="PreProc"> << </span><span class="Constant">":"</span><span class="PreProc"> << </span><span class="Constant">__LINE__</span><span class="PreProc"> << </span><span class="Constant">"): unexpected errors</span><span class="cSpecial">\n</span><span class="Constant">"</span><span class="Delimiter">;</span><span class="PreProc"> \</span> -<span class="PreProc"> DUMP(</span><span class="Constant">"error"</span><span class="PreProc">)</span><span class="Delimiter">;</span><span class="PreProc"> \</span> -<span class="PreProc"> Passed = </span><span class="Constant">false</span><span class="Delimiter">;</span><span class="PreProc"> \</span> -<span class="PreProc"> </span><span class="Identifier">return</span><span class="Delimiter">;</span><span class="PreProc"> \</span> -<span class="PreProc"> </span><span class="Delimiter">}</span> - -<span class="PreProc">#define CHECK_TRACE_COUNT(label</span><span class="Delimiter">,</span><span class="PreProc"> count) \</span> -<span class="PreProc"> </span><span class="Normal">if</span><span class="PreProc"> (Passed && trace_count(label) != (count)) </span><span class="Delimiter">{</span><span class="PreProc"> \</span> -<span class="PreProc"> cerr << </span><span class="Constant">"</span><span class="cSpecial">\n</span><span class="Constant">F - "</span><span class="PreProc"> << __FUNCTION__ << </span><span class="Constant">"("</span><span class="PreProc"> << </span><span class="Constant">__FILE__</span><span class="PreProc"> << </span><span class="Constant">":"</span><span class="PreProc"> << </span><span class="Constant">__LINE__</span><span class="PreProc"> << </span><span class="Constant">"): trace_count of "</span><span class="PreProc"> << label << </span><span class="Constant">" should be "</span><span class="PreProc"> << count << </span><span class="cSpecial">'\n'</span><span class="Delimiter">;</span><span class="PreProc"> \</span> -<span class="PreProc"> cerr << </span><span class="Constant">" got "</span><span class="PreProc"> << trace_count(label) << </span><span class="cSpecial">'\n'</span><span class="Delimiter">;</span><span class="PreProc"> </span><span class="Comment">/*</span><span class="Comment"> multiple eval </span><span class="Comment">*/</span><span class="PreProc"> \</span> -<span class="PreProc"> DUMP(label)</span><span class="Delimiter">;</span><span class="PreProc"> \</span> -<span class="PreProc"> Passed = </span><span class="Constant">false</span><span class="Delimiter">;</span><span class="PreProc"> \</span> -<span class="PreProc"> </span><span class="Identifier">return</span><span class="Delimiter">;</span><span class="PreProc"> </span><span class="Comment">/*</span><span class="Comment"> Currently we stop at the very first failure. </span><span class="Comment">*/</span><span class="PreProc"> \</span> -<span class="PreProc"> </span><span class="Delimiter">}</span> - -<span class="PreProc">#define CHECK_TRACE_DOESNT_CONTAIN(</span><span class="Delimiter">...</span><span class="PreProc">) CHECK(trace_doesnt_contain(__VA_ARGS__))</span> - -<span class="Delimiter">:(code)</span> -<span class="Normal">bool</span> check_trace_contents<span class="Delimiter">(</span>string FUNCTION<span class="Delimiter">,</span> string <span class="Normal">FILE</span><span class="Delimiter">,</span> <span class="Normal">int</span> LINE<span class="Delimiter">,</span> string expected<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>!Passed<span class="Delimiter">)</span> <span class="Identifier">return</span> <span class="Constant">false</span><span class="Delimiter">;</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>!Trace_stream<span class="Delimiter">)</span> <span class="Identifier">return</span> <span class="Constant">false</span><span class="Delimiter">;</span> - vector<string> expected_lines = split<span class="Delimiter">(</span>expected<span class="Delimiter">,</span> <span class="Constant">"^D"</span><span class="Delimiter">);</span> - <span class="Normal">int</span> curr_expected_line = <span class="Constant">0</span><span class="Delimiter">;</span> - <span class="Normal">while</span> <span class="Delimiter">(</span>curr_expected_line < SIZE<span class="Delimiter">(</span>expected_lines<span class="Delimiter">)</span> && expected_lines<span class="Delimiter">.</span>at<span class="Delimiter">(</span>curr_expected_line<span class="Delimiter">).</span>empty<span class="Delimiter">())</span> - ++curr_expected_line<span class="Delimiter">;</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>curr_expected_line == SIZE<span class="Delimiter">(</span>expected_lines<span class="Delimiter">))</span> <span class="Identifier">return</span> <span class="Constant">true</span><span class="Delimiter">;</span> - string label<span class="Delimiter">,</span> contents<span class="Delimiter">;</span> - split_label_contents<span class="Delimiter">(</span>expected_lines<span class="Delimiter">.</span>at<span class="Delimiter">(</span>curr_expected_line<span class="Delimiter">),</span> &label<span class="Delimiter">,</span> &contents<span class="Delimiter">);</span> - <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>label != p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>contents != trim<span class="Delimiter">(</span>p<span class="Delimiter">-></span>contents<span class="Delimiter">))</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> - ++curr_expected_line<span class="Delimiter">;</span> - <span class="Normal">while</span> <span class="Delimiter">(</span>curr_expected_line < SIZE<span class="Delimiter">(</span>expected_lines<span class="Delimiter">)</span> && expected_lines<span class="Delimiter">.</span>at<span class="Delimiter">(</span>curr_expected_line<span class="Delimiter">).</span>empty<span class="Delimiter">())</span> - ++curr_expected_line<span class="Delimiter">;</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>curr_expected_line == SIZE<span class="Delimiter">(</span>expected_lines<span class="Delimiter">))</span> <span class="Identifier">return</span> <span class="Constant">true</span><span class="Delimiter">;</span> - split_label_contents<span class="Delimiter">(</span>expected_lines<span class="Delimiter">.</span>at<span class="Delimiter">(</span>curr_expected_line<span class="Delimiter">),</span> &label<span class="Delimiter">,</span> &contents<span class="Delimiter">);</span> - <span class="Delimiter">}</span> - - <span class="Normal">if</span> <span class="Delimiter">(</span>line_exists_anywhere<span class="Delimiter">(</span>label<span class="Delimiter">,</span> contents<span class="Delimiter">))</span> <span class="Delimiter">{</span> - cerr << <span class="Constant">"</span><span class="cSpecial">\n</span><span class="Constant">F - "</span> << FUNCTION << <span class="Constant">"("</span> << <span class="Normal">FILE</span> << <span class="Constant">":"</span> << LINE << <span class="Constant">"): line ["</span> << label << <span class="Constant">": "</span> << contents << <span class="Constant">"] out of order in trace:</span><span class="cSpecial">\n</span><span class="Constant">"</span><span class="Delimiter">;</span> - DUMP<span class="Delimiter">(</span><span class="Constant">""</span><span class="Delimiter">);</span> - <span class="Delimiter">}</span> - <span class="Normal">else</span> <span class="Delimiter">{</span> - cerr << <span class="Constant">"</span><span class="cSpecial">\n</span><span class="Constant">F - "</span> << FUNCTION << <span class="Constant">"("</span> << <span class="Normal">FILE</span> << <span class="Constant">":"</span> << LINE << <span class="Constant">"): missing ["</span> << contents << <span class="Constant">"] in trace:</span><span class="cSpecial">\n</span><span class="Constant">"</span><span class="Delimiter">;</span> - DUMP<span class="Delimiter">(</span>label<span class="Delimiter">);</span> - <span class="Delimiter">}</span> - Passed = <span class="Constant">false</span><span class="Delimiter">;</span> - <span class="Identifier">return</span> <span class="Constant">false</span><span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -<span class="Normal">void</span> split_label_contents<span class="Delimiter">(</span><span class="Normal">const</span> string& s<span class="Delimiter">,</span> string* label<span class="Delimiter">,</span> string* contents<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">static</span> <span class="Normal">const</span> string delim<span class="Delimiter">(</span><span class="Constant">": "</span><span class="Delimiter">);</span> - <span class="Normal">size_t</span> pos = s<span class="Delimiter">.</span>find<span class="Delimiter">(</span>delim<span class="Delimiter">);</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>pos == string::npos<span class="Delimiter">)</span> <span class="Delimiter">{</span> - *label = <span class="Constant">""</span><span class="Delimiter">;</span> - *contents = trim<span class="Delimiter">(</span>s<span class="Delimiter">);</span> - <span class="Delimiter">}</span> - <span class="Normal">else</span> <span class="Delimiter">{</span> - *label = trim<span class="Delimiter">(</span>s<span class="Delimiter">.</span>substr<span class="Delimiter">(</span><span class="Constant">0</span><span class="Delimiter">,</span> pos<span class="Delimiter">));</span> - *contents = trim<span class="Delimiter">(</span>s<span class="Delimiter">.</span>substr<span class="Delimiter">(</span>pos+SIZE<span class="Delimiter">(</span>delim<span class="Delimiter">)));</span> - <span class="Delimiter">}</span> -<span class="Delimiter">}</span> - -<span class="Normal">bool</span> line_exists_anywhere<span class="Delimiter">(</span><span class="Normal">const</span> string& label<span class="Delimiter">,</span> <span class="Normal">const</span> string& contents<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>label != p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>contents == trim<span class="Delimiter">(</span>p<span class="Delimiter">-></span>contents<span class="Delimiter">))</span> <span class="Identifier">return</span> <span class="Constant">true</span><span class="Delimiter">;</span> - <span class="Delimiter">}</span> - <span class="Identifier">return</span> <span class="Constant">false</span><span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -<span class="Normal">int</span> trace_count<span class="Delimiter">(</span>string label<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Identifier">return</span> trace_count<span class="Delimiter">(</span>label<span class="Delimiter">,</span> <span class="Constant">""</span><span class="Delimiter">);</span> -<span class="Delimiter">}</span> - -<span class="Normal">int</span> trace_count<span class="Delimiter">(</span>string label<span class="Delimiter">,</span> string line<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>!Trace_stream<span class="Delimiter">)</span> <span class="Identifier">return</span> <span class="Constant">0</span><span class="Delimiter">;</span> - <span class="Normal">long</span> result = <span class="Constant">0</span><span class="Delimiter">;</span> - <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>label == p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>line == <span class="Constant">""</span> || trim<span class="Delimiter">(</span>line<span class="Delimiter">)</span> == trim<span class="Delimiter">(</span>p<span class="Delimiter">-></span>contents<span class="Delimiter">))</span> - ++result<span class="Delimiter">;</span> - <span class="Delimiter">}</span> - <span class="Delimiter">}</span> - <span class="Identifier">return</span> result<span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -<span class="Normal">int</span> trace_count_prefix<span class="Delimiter">(</span>string label<span class="Delimiter">,</span> string prefix<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>!Trace_stream<span class="Delimiter">)</span> <span class="Identifier">return</span> <span class="Constant">0</span><span class="Delimiter">;</span> - <span class="Normal">long</span> result = <span class="Constant">0</span><span class="Delimiter">;</span> - <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>label == p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>starts_with<span class="Delimiter">(</span>trim<span class="Delimiter">(</span>p<span class="Delimiter">-></span>contents<span class="Delimiter">),</span> trim<span class="Delimiter">(</span>prefix<span class="Delimiter">)))</span> - ++result<span class="Delimiter">;</span> - <span class="Delimiter">}</span> - <span class="Delimiter">}</span> - <span class="Identifier">return</span> result<span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -<span class="Normal">bool</span> trace_doesnt_contain<span class="Delimiter">(</span>string label<span class="Delimiter">,</span> string line<span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Identifier">return</span> trace_count<span class="Delimiter">(</span>label<span class="Delimiter">,</span> line<span class="Delimiter">)</span> == <span class="Constant">0</span><span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -<span class="Normal">bool</span> trace_doesnt_contain<span class="Delimiter">(</span>string expected<span class="Delimiter">)</span> <span class="Delimiter">{</span> - vector<string> tmp = split_first<span class="Delimiter">(</span>expected<span class="Delimiter">,</span> <span class="Constant">": "</span><span class="Delimiter">);</span> - <span class="Identifier">return</span> trace_doesnt_contain<span class="Delimiter">(</span>tmp<span class="Delimiter">.</span>at<span class="Delimiter">(</span><span class="Constant">0</span><span class="Delimiter">),</span> tmp<span class="Delimiter">.</span>at<span class="Delimiter">(</span><span class="Constant">1</span><span class="Delimiter">));</span> -<span class="Delimiter">}</span> - -vector<string> split<span class="Delimiter">(</span>string s<span class="Delimiter">,</span> string delim<span class="Delimiter">)</span> <span class="Delimiter">{</span> - vector<string> result<span class="Delimiter">;</span> - <span class="Normal">size_t</span> begin=<span class="Constant">0</span><span class="Delimiter">,</span> end=s<span class="Delimiter">.</span>find<span class="Delimiter">(</span>delim<span class="Delimiter">);</span> - <span class="Normal">while</span> <span class="Delimiter">(</span><span class="Constant">true</span><span class="Delimiter">)</span> <span class="Delimiter">{</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>end == string::npos<span class="Delimiter">)</span> <span class="Delimiter">{</span> - result<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>string<span class="Delimiter">(</span>s<span class="Delimiter">,</span> begin<span class="Delimiter">,</span> string::npos<span class="Delimiter">));</span> - <span class="Identifier">break</span><span class="Delimiter">;</span> - <span class="Delimiter">}</span> - result<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>string<span class="Delimiter">(</span>s<span class="Delimiter">,</span> begin<span class="Delimiter">,</span> end-begin<span class="Delimiter">));</span> - begin = end+SIZE<span class="Delimiter">(</span>delim<span class="Delimiter">);</span> - end = s<span class="Delimiter">.</span>find<span class="Delimiter">(</span>delim<span class="Delimiter">,</span> begin<span class="Delimiter">);</span> - <span class="Delimiter">}</span> - <span class="Identifier">return</span> result<span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -vector<string> split_first<span class="Delimiter">(</span>string s<span class="Delimiter">,</span> string delim<span class="Delimiter">)</span> <span class="Delimiter">{</span> - vector<string> result<span class="Delimiter">;</span> - <span class="Normal">size_t</span> end=s<span class="Delimiter">.</span>find<span class="Delimiter">(</span>delim<span class="Delimiter">);</span> - result<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>string<span class="Delimiter">(</span>s<span class="Delimiter">,</span> <span class="Constant">0</span><span class="Delimiter">,</span> end<span class="Delimiter">));</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>end != string::npos<span class="Delimiter">)</span> - result<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>string<span class="Delimiter">(</span>s<span class="Delimiter">,</span> end+SIZE<span class="Delimiter">(</span>delim<span class="Delimiter">),</span> string::npos<span class="Delimiter">));</span> - <span class="Identifier">return</span> result<span class="Delimiter">;</span> -<span class="Delimiter">}</span> - -string trim<span class="Delimiter">(</span><span class="Normal">const</span> string& s<span class="Delimiter">)</span> <span class="Delimiter">{</span> - string::const_iterator first = s<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> - <span class="Normal">while</span> <span class="Delimiter">(</span>first != s<span class="Delimiter">.</span>end<span class="Delimiter">()</span> && isspace<span class="Delimiter">(</span>*first<span class="Delimiter">))</span> - ++first<span class="Delimiter">;</span> - <span class="Normal">if</span> <span class="Delimiter">(</span>first == s<span class="Delimiter">.</span>end<span class="Delimiter">())</span> <span class="Identifier">return</span> <span class="Constant">""</span><span class="Delimiter">;</span> - - string::const_iterator last = --s<span class="Delimiter">.</span>end<span class="Delimiter">();</span> - <span class="Normal">while</span> <span class="Delimiter">(</span>last != s<span class="Delimiter">.</span>begin<span class="Delimiter">()</span> && isspace<span class="Delimiter">(</span>*last<span class="Delimiter">))</span> - --last<span class="Delimiter">;</span> - ++last<span class="Delimiter">;</span> - <span class="Identifier">return</span> string<span class="Delimiter">(</span>first<span class="Delimiter">,</span> last<span class="Delimiter">);</span> -<span class="Delimiter">}</span> - -<span class="Delimiter">:(before "End Includes")</span> -<span class="PreProc">#include </span><span class="Constant"><vector></span> -<span class="Normal">using</span> std::vector<span class="Delimiter">;</span> -<span class="PreProc">#include </span><span class="Constant"><list></span> -<span class="Normal">using</span> std::list<span class="Delimiter">;</span> -<span class="PreProc">#include </span><span class="Constant"><map></span> -<span class="Normal">using</span> std::map<span class="Delimiter">;</span> -<span class="PreProc">#include </span><span class="Constant"><set></span> -<span class="Normal">using</span> std::set<span class="Delimiter">;</span> -<span class="PreProc">#include </span><span class="Constant"><algorithm></span> - -<span class="PreProc">#include </span><span class="Constant"><sstream></span> -<span class="Normal">using</span> std::istringstream<span class="Delimiter">;</span> -<span class="Normal">using</span> std::ostringstream<span class="Delimiter">;</span> - -<span class="PreProc">#include </span><span class="Constant"><fstream></span> -<span class="Normal">using</span> std::ifstream<span class="Delimiter">;</span> -<span class="Normal">using</span> std::ofstream<span class="Delimiter">;</span> - -<span class="PreProc">#include </span><span class="Constant">"termbox/termbox.h"</span> - -<span class="Delimiter">:(before "End Globals")</span> -<span class="Comment">//: In future layers we'll use the depth field as follows:</span> -<span class="Comment">//:</span> -<span class="Comment">//: Errors will be depth 0.</span> -<span class="Comment">//: Mu 'applications' will be able to use depths 1-100 as they like.</span> -<span class="Comment">//: Primitive statements will occupy 101-9989</span> -<span class="Normal">extern</span> <span class="Normal">const</span> <span class="Normal">int</span> Initial_callstack_depth = <span class="Constant">101</span><span class="Delimiter">;</span> -<span class="Normal">extern</span> <span class="Normal">const</span> <span class="Normal">int</span> Max_callstack_depth = <span class="Constant">9989</span><span class="Delimiter">;</span> -<span class="Comment">//: Finally, details of primitive Mu statements will occupy depth 9990-9999</span> -<span class="Comment">//: (more on that later as well)</span> -<span class="Comment">//:</span> -<span class="Comment">//: This framework should help us hide some details at each level, mixing</span> -<span class="Comment">//: static ideas like layers with the dynamic notion of call-stack depth.</span> +<a name="L1"></a><span id="L1" class="LineNr"> 1 </span><span class="Comment">//: The goal of this skeleton is to make programs more easy to understand and</span> +<a name="L2"></a><span id="L2" class="LineNr"> 2 </span><span class="Comment">//: more malleable, easy to rewrite in radical ways without accidentally</span> +<a name="L3"></a><span id="L3" class="LineNr"> 3 </span><span class="Comment">//: breaking some corner case. Tests further both goals. They help</span> +<a name="L4"></a><span id="L4" class="LineNr"> 4 </span><span class="Comment">//: understandability by letting one make small changes and get feedback. What</span> +<a name="L5"></a><span id="L5" class="LineNr"> 5 </span><span class="Comment">//: if I wrote this line like so? What if I removed this function call, is it</span> +<a name="L6"></a><span id="L6" class="LineNr"> 6 </span><span class="Comment">//: really necessary? Just try it, see if the tests pass. Want to explore</span> +<a name="L7"></a><span id="L7" class="LineNr"> 7 </span><span class="Comment">//: rewriting this bit in this way? Tests put many refactorings on a firmer</span> +<a name="L8"></a><span id="L8" class="LineNr"> 8 </span><span class="Comment">//: footing.</span> +<a name="L9"></a><span id="L9" class="LineNr"> 9 </span><span class="Comment">//:</span> +<a name="L10"></a><span id="L10" class="LineNr"> 10 </span><span class="Comment">//: But the usual way we write tests seems incomplete. Refactorings tend to</span> +<a name="L11"></a><span id="L11" class="LineNr"> 11 </span><span class="Comment">//: work in the small, but don't help with changes to function boundaries. If</span> +<a name="L12"></a><span id="L12" class="LineNr"> 12 </span><span class="Comment">//: you want to extract a new function you have to manually test-drive it to</span> +<a name="L13"></a><span id="L13" class="LineNr"> 13 </span><span class="Comment">//: create tests for it. If you want to inline a function its tests are no</span> +<a name="L14"></a><span id="L14" class="LineNr"> 14 </span><span class="Comment">//: longer valid. In both cases you end up having to reorganize code as well as</span> +<a name="L15"></a><span id="L15" class="LineNr"> 15 </span><span class="Comment">//: tests, an error-prone activity.</span> +<a name="L16"></a><span id="L16" class="LineNr"> 16 </span><span class="Comment">//:</span> +<a name="L17"></a><span id="L17" class="LineNr"> 17 </span><span class="Comment">//: This file tries to fix this problem by supporting domain-driven testing</span> +<a name="L18"></a><span id="L18" class="LineNr"> 18 </span><span class="Comment">//: We try to focus on the domain of inputs the program should work on. All</span> +<a name="L19"></a><span id="L19" class="LineNr"> 19 </span><span class="Comment">//: tests invoke the program in a single way: by calling run() with different</span> +<a name="L20"></a><span id="L20" class="LineNr"> 20 </span><span class="Comment">//: inputs. The program operates on the input and logs _facts_ it deduces to a</span> +<a name="L21"></a><span id="L21" class="LineNr"> 21 </span><span class="Comment">//: trace:</span> +<a name="L22"></a><span id="L22" class="LineNr"> 22 </span><span class="Comment">//: trace("label") << "fact 1: " << val;</span> +<a name="L23"></a><span id="L23" class="LineNr"> 23 </span><span class="Comment">//:</span> +<a name="L24"></a><span id="L24" class="LineNr"> 24 </span><span class="Comment">//: The tests check for facts:</span> +<a name="L25"></a><span id="L25" class="LineNr"> 25 </span><span class="Comment">//: :(scenario foo)</span> +<a name="L26"></a><span id="L26" class="LineNr"> 26 </span><span class="Comment">//: 34 # call run() with this input</span> +<a name="L27"></a><span id="L27" class="LineNr"> 27 </span><span class="Comment">//: +label: fact 1: 34 # trace should have logged this at the end</span> +<a name="L28"></a><span id="L28" class="LineNr"> 28 </span><span class="Comment">//: -label: fact 1: 35 # trace should never contain such a line</span> +<a name="L29"></a><span id="L29" class="LineNr"> 29 </span><span class="Comment">//:</span> +<a name="L30"></a><span id="L30" class="LineNr"> 30 </span><span class="Comment">//: Since we never call anything but the run() function directly, we never have</span> +<a name="L31"></a><span id="L31" class="LineNr"> 31 </span><span class="Comment">//: to rewrite the tests when we reorganize the internals of the program. We</span> +<a name="L32"></a><span id="L32" class="LineNr"> 32 </span><span class="Comment">//: just have to make sure our rewrite deduces the same facts about the domain,</span> +<a name="L33"></a><span id="L33" class="LineNr"> 33 </span><span class="Comment">//: and that's something we're going to have to do anyway.</span> +<a name="L34"></a><span id="L34" class="LineNr"> 34 </span><span class="Comment">//:</span> +<a name="L35"></a><span id="L35" class="LineNr"> 35 </span><span class="Comment">//: To avoid the combinatorial explosion of integration tests, we organize the</span> +<a name="L36"></a><span id="L36" class="LineNr"> 36 </span><span class="Comment">//: program into different layers, and each fact is logged to the trace with a</span> +<a name="L37"></a><span id="L37" class="LineNr"> 37 </span><span class="Comment">//: specific label. Individual tests can focus on specific labels. In essence,</span> +<a name="L38"></a><span id="L38" class="LineNr"> 38 </span><span class="Comment">//: validating the facts logged with a specific label is identical to calling</span> +<a name="L39"></a><span id="L39" class="LineNr"> 39 </span><span class="Comment">//: some internal subsystem.</span> +<a name="L40"></a><span id="L40" class="LineNr"> 40 </span><span class="Comment">//:</span> +<a name="L41"></a><span id="L41" class="LineNr"> 41 </span><span class="Comment">//: Traces interact salubriously with layers. Thanks to our ordering</span> +<a name="L42"></a><span id="L42" class="LineNr"> 42 </span><span class="Comment">//: directives, each layer can contain its own tests. They may rely on other</span> +<a name="L43"></a><span id="L43" class="LineNr"> 43 </span><span class="Comment">//: layers, but when a test fails its usually due to breakage in the same</span> +<a name="L44"></a><span id="L44" class="LineNr"> 44 </span><span class="Comment">//: layer. When multiple tests fail, it's usually useful to debug the very</span> +<a name="L45"></a><span id="L45" class="LineNr"> 45 </span><span class="Comment">//: first test to fail. This is in contrast with the traditional approach,</span> +<a name="L46"></a><span id="L46" class="LineNr"> 46 </span><span class="Comment">//: where changes can cause breakages in faraway subsystems, and picking the</span> +<a name="L47"></a><span id="L47" class="LineNr"> 47 </span><span class="Comment">//: right test to debug can be an important skill to pick up.</span> +<a name="L48"></a><span id="L48" class="LineNr"> 48 </span><span class="Comment">//:</span> +<a name="L49"></a><span id="L49" class="LineNr"> 49 </span><span class="Comment">//: To build robust tests, trace facts about your domain rather than details of</span> +<a name="L50"></a><span id="L50" class="LineNr"> 50 </span><span class="Comment">//: how you computed them.</span> +<a name="L51"></a><span id="L51" class="LineNr"> 51 </span><span class="Comment">//:</span> +<a name="L52"></a><span id="L52" class="LineNr"> 52 </span><span class="Comment">//: More details: <a href="http://akkartik.name/blog/tracing-tests">http://akkartik.name/blog/tracing-tests</a></span> +<a name="L53"></a><span id="L53" class="LineNr"> 53 </span><span class="Comment">//:</span> +<a name="L54"></a><span id="L54" class="LineNr"> 54 </span><span class="Comment">//: ---</span> +<a name="L55"></a><span id="L55" class="LineNr"> 55 </span><span class="Comment">//:</span> +<a name="L56"></a><span id="L56" class="LineNr"> 56 </span><span class="Comment">//: Between layers and domain-driven testing, programming starts to look like a</span> +<a name="L57"></a><span id="L57" class="LineNr"> 57 </span><span class="Comment">//: fundamentally different activity. Instead of a) superficial, b) local rules</span> +<a name="L58"></a><span id="L58" class="LineNr"> 58 </span><span class="Comment">//: on c) code [like <a href="http://blog.bbv.ch/2013/06/05/clean-code-cheat-sheet],">http://blog.bbv.ch/2013/06/05/clean-code-cheat-sheet],</a></span> +<a name="L59"></a><span id="L59" class="LineNr"> 59 </span><span class="Comment">//: we allow programmers to engage with the a) deep, b) global structure of the</span> +<a name="L60"></a><span id="L60" class="LineNr"> 60 </span><span class="Comment">//: c) domain. If you can systematically track discontinuities in the domain</span> +<a name="L61"></a><span id="L61" class="LineNr"> 61 </span><span class="Comment">//: you don't care if the code used gotos as long as it passed the tests. If</span> +<a name="L62"></a><span id="L62" class="LineNr"> 62 </span><span class="Comment">//: tests become more robust to run it becomes easier to try out radically</span> +<a name="L63"></a><span id="L63" class="LineNr"> 63 </span><span class="Comment">//: different implementations for the same program. If code is super-easy to</span> +<a name="L64"></a><span id="L64" class="LineNr"> 64 </span><span class="Comment">//: rewrite, it becomes less important what indentation style it uses, or that</span> +<a name="L65"></a><span id="L65" class="LineNr"> 65 </span><span class="Comment">//: the objects are appropriately encapsulated, or that the functions are</span> +<a name="L66"></a><span id="L66" class="LineNr"> 66 </span><span class="Comment">//: referentially transparent.</span> +<a name="L67"></a><span id="L67" class="LineNr"> 67 </span><span class="Comment">//:</span> +<a name="L68"></a><span id="L68" class="LineNr"> 68 </span><span class="Comment">//: Instead of plumbing, programming becomes building and gradually refining a</span> +<a name="L69"></a><span id="L69" class="LineNr"> 69 </span><span class="Comment">//: map of the environment the program must operate under. Whether a program is</span> +<a name="L70"></a><span id="L70" class="LineNr"> 70 </span><span class="Comment">//: 'correct' at a given point in time is a red herring; what matters is</span> +<a name="L71"></a><span id="L71" class="LineNr"> 71 </span><span class="Comment">//: avoiding regression by monotonically nailing down the more 'eventful' parts</span> +<a name="L72"></a><span id="L72" class="LineNr"> 72 </span><span class="Comment">//: of the terrain. It helps readers new and old and rewards curiosity to</span> +<a name="L73"></a><span id="L73" class="LineNr"> 73 </span><span class="Comment">//: organize large programs in self-similar hiearchies of example scenarios</span> +<a name="L74"></a><span id="L74" class="LineNr"> 74 </span><span class="Comment">//: colocated with the code that makes them work.</span> +<a name="L75"></a><span id="L75" class="LineNr"> 75 </span><span class="Comment">//:</span> +<a name="L76"></a><span id="L76" class="LineNr"> 76 </span><span class="Comment">//: "Programming properly should be regarded as an activity by which</span> +<a name="L77"></a><span id="L77" class="LineNr"> 77 </span><span class="Comment">//: programmers form a mental model, rather than as production of a program."</span> +<a name="L78"></a><span id="L78" class="LineNr"> 78 </span><span class="Comment">//: -- Peter Naur (<a href="http://alistair.cockburn.us/ASD+book+extract%3A+%22Naur,+Ehn,+Musashi%22)">http://alistair.cockburn.us/ASD+book+extract%3A+%22Naur,+Ehn,+Musashi%22)</a></span> +<a name="L79"></a><span id="L79" class="LineNr"> 79 </span> +<a name="L80"></a><span id="L80" class="LineNr"> 80 </span><span class="Delimiter">:(before "End Types")</span> +<a name="L81"></a><span id="L81" class="LineNr"> 81 </span><span class="Normal">struct</span> trace_line <span class="Delimiter">{</span> +<a name="L82"></a><span id="L82" class="LineNr"> 82 </span> <span class="Normal">int</span> depth<span class="Delimiter">;</span> <span class="Comment">// optional field just to help browse traces later</span> +<a name="L83"></a><span id="L83" class="LineNr"> 83 </span> string label<span class="Delimiter">;</span> +<a name="L84"></a><span id="L84" class="LineNr"> 84 </span> string contents<span class="Delimiter">;</span> +<a name="L85"></a><span id="L85" class="LineNr"> 85 </span> trace_line<span class="Delimiter">(</span>string l<span class="Delimiter">,</span> string c<span class="Delimiter">)</span> :depth<span class="Delimiter">(</span><span class="Constant">0</span><span class="Delimiter">),</span> label<span class="Delimiter">(</span>l<span class="Delimiter">),</span> contents<span class="Delimiter">(</span>c<span class="Delimiter">)</span> <span class="Delimiter">{}</span> +<a name="L86"></a><span id="L86" class="LineNr"> 86 </span> trace_line<span class="Delimiter">(</span><span class="Normal">int</span> d<span class="Delimiter">,</span> string l<span class="Delimiter">,</span> string c<span class="Delimiter">)</span> :depth<span class="Delimiter">(</span>d<span class="Delimiter">),</span> label<span class="Delimiter">(</span>l<span class="Delimiter">),</span> contents<span class="Delimiter">(</span>c<span class="Delimiter">)</span> <span class="Delimiter">{}</span> +<a name="L87"></a><span id="L87" class="LineNr"> 87 </span><span class="Delimiter">};</span> +<a name="L88"></a><span id="L88" class="LineNr"> 88 </span> +<a name="L89"></a><span id="L89" class="LineNr"> 89 </span><span class="Delimiter">:(before "End Globals")</span> +<a name="L90"></a><span id="L90" class="LineNr"> 90 </span><span class="Normal">bool</span> Hide_errors = <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L91"></a><span id="L91" class="LineNr"> 91 </span><span class="Normal">bool</span> Dump_trace = <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L92"></a><span id="L92" class="LineNr"> 92 </span>string Dump_label = <span class="Constant">""</span><span class="Delimiter">;</span> +<a name="L93"></a><span id="L93" class="LineNr"> 93 </span><span class="Delimiter">:(before "End Setup")</span> +<a name="L94"></a><span id="L94" class="LineNr"> 94 </span>Hide_errors = <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L95"></a><span id="L95" class="LineNr"> 95 </span>Dump_trace = <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L96"></a><span id="L96" class="LineNr"> 96 </span>Dump_label = <span class="Constant">""</span><span class="Delimiter">;</span> +<a name="L97"></a><span id="L97" class="LineNr"> 97 </span> +<a name="L98"></a><span id="L98" class="LineNr"> 98 </span><span class="Delimiter">:(before "End Types")</span> +<a name="L99"></a><span id="L99" class="LineNr"> 99 </span><span class="Comment">// Pre-define some global constants that trace_stream needs to know about.</span> +<a name="L100"></a><span id="L100" class="LineNr">100 </span><span class="Comment">// Since they're in the Types section, they'll be included in any cleaved</span> +<a name="L101"></a><span id="L101" class="LineNr">101 </span><span class="Comment">// compilation units. So no extern linkage.</span> +<a name="L102"></a><span id="L102" class="LineNr">102 </span><span class="Normal">const</span> <span class="Normal">int</span> Max_depth = <span class="Constant">9999</span><span class="Delimiter">;</span> +<a name="L103"></a><span id="L103" class="LineNr">103 </span><span class="Normal">const</span> <span class="Normal">int</span> Error_depth = <span class="Constant">0</span><span class="Delimiter">;</span> <span class="Comment">// definitely always print errors</span> +<a name="L104"></a><span id="L104" class="LineNr">104 </span><span class="Normal">const</span> <span class="Normal">int</span> App_depth = <span class="Constant">2</span><span class="Delimiter">;</span> <span class="Comment">// temporarily where all Mu code will trace to</span> +<a name="L105"></a><span id="L105" class="LineNr">105 </span> +<a name="L106"></a><span id="L106" class="LineNr">106 </span><span class="Normal">struct</span> trace_stream <span class="Delimiter">{</span> +<a name="L107"></a><span id="L107" class="LineNr">107 </span> vector<trace_line> past_lines<span class="Delimiter">;</span> +<a name="L108"></a><span id="L108" class="LineNr">108 </span> <span class="Comment">// accumulator for current line</span> +<a name="L109"></a><span id="L109" class="LineNr">109 </span> ostringstream* curr_stream<span class="Delimiter">;</span> +<a name="L110"></a><span id="L110" class="LineNr">110 </span> string curr_label<span class="Delimiter">;</span> +<a name="L111"></a><span id="L111" class="LineNr">111 </span> <span class="Normal">int</span> curr_depth<span class="Delimiter">;</span> +<a name="L112"></a><span id="L112" class="LineNr">112 </span> <span class="Normal">int</span> callstack_depth<span class="Delimiter">;</span> +<a name="L113"></a><span id="L113" class="LineNr">113 </span> <span class="Normal">int</span> collect_depth<span class="Delimiter">;</span> +<a name="L114"></a><span id="L114" class="LineNr">114 </span> ofstream null_stream<span class="Delimiter">;</span> <span class="Comment">// never opens a file, so writes silently fail</span> +<a name="L115"></a><span id="L115" class="LineNr">115 </span> trace_stream<span class="Delimiter">()</span> :curr_stream<span class="Delimiter">(</span><span class="Constant">NULL</span><span class="Delimiter">),</span> curr_depth<span class="Delimiter">(</span>Max_depth<span class="Delimiter">),</span> callstack_depth<span class="Delimiter">(</span><span class="Constant">0</span><span class="Delimiter">),</span> collect_depth<span class="Delimiter">(</span>Max_depth<span class="Delimiter">)</span> <span class="Delimiter">{}</span> +<a name="L116"></a><span id="L116" class="LineNr">116 </span> ~trace_stream<span class="Delimiter">()</span> <span class="Delimiter">{</span> <span class="Normal">if</span> <span class="Delimiter">(</span>curr_stream<span class="Delimiter">)</span> <span class="Normal">delete</span> curr_stream<span class="Delimiter">;</span> <span class="Delimiter">}</span> +<a name="L117"></a><span id="L117" class="LineNr">117 </span> +<a name="L118"></a><span id="L118" class="LineNr">118 </span> ostream& stream<span class="Delimiter">(</span>string label<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L119"></a><span id="L119" class="LineNr">119 </span> <span class="Identifier">return</span> stream<span class="Delimiter">(</span>Max_depth<span class="Delimiter">,</span> label<span class="Delimiter">);</span> +<a name="L120"></a><span id="L120" class="LineNr">120 </span> <span class="Delimiter">}</span> +<a name="L121"></a><span id="L121" class="LineNr">121 </span> +<a name="L122"></a><span id="L122" class="LineNr">122 </span> ostream& stream<span class="Delimiter">(</span><span class="Normal">int</span> depth<span class="Delimiter">,</span> string label<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L123"></a><span id="L123" class="LineNr">123 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>depth > collect_depth<span class="Delimiter">)</span> <span class="Identifier">return</span> null_stream<span class="Delimiter">;</span> +<a name="L124"></a><span id="L124" class="LineNr">124 </span> curr_stream = <span class="Normal">new</span> ostringstream<span class="Delimiter">;</span> +<a name="L125"></a><span id="L125" class="LineNr">125 </span> curr_label = label<span class="Delimiter">;</span> +<a name="L126"></a><span id="L126" class="LineNr">126 </span> curr_depth = depth<span class="Delimiter">;</span> +<a name="L127"></a><span id="L127" class="LineNr">127 </span> <span class="Identifier">return</span> *curr_stream<span class="Delimiter">;</span> +<a name="L128"></a><span id="L128" class="LineNr">128 </span> <span class="Delimiter">}</span> +<a name="L129"></a><span id="L129" class="LineNr">129 </span> +<a name="L130"></a><span id="L130" class="LineNr">130 </span> <span class="Comment">// be sure to call this before messing with curr_stream or curr_label</span> +<a name="L131"></a><span id="L131" class="LineNr">131 </span> <span class="Normal">void</span> newline<span class="Delimiter">();</span> +<a name="L132"></a><span id="L132" class="LineNr">132 </span> <span class="Comment">// useful for debugging</span> +<a name="L133"></a><span id="L133" class="LineNr">133 </span> string readable_contents<span class="Delimiter">(</span>string label<span class="Delimiter">);</span> <span class="Comment">// empty label = show everything</span> +<a name="L134"></a><span id="L134" class="LineNr">134 </span><span class="Delimiter">};</span> +<a name="L135"></a><span id="L135" class="LineNr">135 </span> +<a name="L136"></a><span id="L136" class="LineNr">136 </span><span class="Delimiter">:(code)</span> +<a name="L137"></a><span id="L137" class="LineNr">137 </span><span class="Normal">void</span> trace_stream::newline<span class="Delimiter">()</span> <span class="Delimiter">{</span> +<a name="L138"></a><span id="L138" class="LineNr">138 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>!curr_stream<span class="Delimiter">)</span> <span class="Identifier">return</span><span class="Delimiter">;</span> +<a name="L139"></a><span id="L139" class="LineNr">139 </span> string curr_contents = curr_stream<span class="Delimiter">-></span>str<span class="Delimiter">();</span> +<a name="L140"></a><span id="L140" class="LineNr">140 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>!curr_contents<span class="Delimiter">.</span>empty<span class="Delimiter">())</span> <span class="Delimiter">{</span> +<a name="L141"></a><span id="L141" class="LineNr">141 </span> past_lines<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>trace_line<span class="Delimiter">(</span>curr_depth<span class="Delimiter">,</span> trim<span class="Delimiter">(</span>curr_label<span class="Delimiter">),</span> curr_contents<span class="Delimiter">));</span> <span class="Comment">// preserve indent in contents</span> +<a name="L142"></a><span id="L142" class="LineNr">142 </span> <span class="Normal">if</span> <span class="Delimiter">((</span>!Hide_errors && curr_label == <span class="Constant">"error"</span><span class="Delimiter">)</span> +<a name="L143"></a><span id="L143" class="LineNr">143 </span> || Dump_trace +<a name="L144"></a><span id="L144" class="LineNr">144 </span> || <span class="Delimiter">(</span>!Dump_label<span class="Delimiter">.</span>empty<span class="Delimiter">()</span> && curr_label == Dump_label<span class="Delimiter">))</span> +<a name="L145"></a><span id="L145" class="LineNr">145 </span> cerr << curr_label << <span class="Constant">": "</span> << curr_contents << <span class="cSpecial">'\n'</span><span class="Delimiter">;</span> +<a name="L146"></a><span id="L146" class="LineNr">146 </span> <span class="Delimiter">}</span> +<a name="L147"></a><span id="L147" class="LineNr">147 </span> <span class="Normal">delete</span> curr_stream<span class="Delimiter">;</span> +<a name="L148"></a><span id="L148" class="LineNr">148 </span> curr_stream = <span class="Constant">NULL</span><span class="Delimiter">;</span> +<a name="L149"></a><span id="L149" class="LineNr">149 </span> curr_label<span class="Delimiter">.</span>clear<span class="Delimiter">();</span> +<a name="L150"></a><span id="L150" class="LineNr">150 </span> curr_depth = Max_depth<span class="Delimiter">;</span> +<a name="L151"></a><span id="L151" class="LineNr">151 </span><span class="Delimiter">}</span> +<a name="L152"></a><span id="L152" class="LineNr">152 </span> +<a name="L153"></a><span id="L153" class="LineNr">153 </span>string trace_stream::readable_contents<span class="Delimiter">(</span>string label<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L154"></a><span id="L154" class="LineNr">154 </span> ostringstream output<span class="Delimiter">;</span> +<a name="L155"></a><span id="L155" class="LineNr">155 </span> label = trim<span class="Delimiter">(</span>label<span class="Delimiter">);</span> +<a name="L156"></a><span id="L156" class="LineNr">156 </span> <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> +<a name="L157"></a><span id="L157" class="LineNr">157 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>label<span class="Delimiter">.</span>empty<span class="Delimiter">()</span> || label == p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L158"></a><span id="L158" class="LineNr">158 </span> output << std::setw<span class="Delimiter">(</span><span class="Constant">4</span><span class="Delimiter">)</span> << p<span class="Delimiter">-></span>depth << <span class="Constant">' '</span> << p<span class="Delimiter">-></span>label << <span class="Constant">": "</span> << p<span class="Delimiter">-></span>contents << <span class="cSpecial">'\n'</span><span class="Delimiter">;</span> +<a name="L159"></a><span id="L159" class="LineNr">159 </span> <span class="Delimiter">}</span> +<a name="L160"></a><span id="L160" class="LineNr">160 </span> <span class="Identifier">return</span> output<span class="Delimiter">.</span>str<span class="Delimiter">();</span> +<a name="L161"></a><span id="L161" class="LineNr">161 </span><span class="Delimiter">}</span> +<a name="L162"></a><span id="L162" class="LineNr">162 </span> +<a name="L163"></a><span id="L163" class="LineNr">163 </span><span class="Delimiter">:(before "End Globals")</span> +<a name="L164"></a><span id="L164" class="LineNr">164 </span>trace_stream* Trace_stream = <span class="Constant">NULL</span><span class="Delimiter">;</span> +<a name="L165"></a><span id="L165" class="LineNr">165 </span><span class="Normal">int</span> Trace_errors = <span class="Constant">0</span><span class="Delimiter">;</span> <span class="Comment">// used only when Trace_stream is NULL</span> +<a name="L166"></a><span id="L166" class="LineNr">166 </span> +<a name="L167"></a><span id="L167" class="LineNr">167 </span><span class="Delimiter">:(before "End Includes")</span> +<a name="L168"></a><span id="L168" class="LineNr">168 </span><span class="PreProc">#define CLEAR_TRACE </span><span class="Normal">delete</span><span class="PreProc"> Trace_stream</span><span class="Delimiter">,</span><span class="PreProc"> Trace_stream = </span><span class="Normal">new</span><span class="PreProc"> trace_stream</span><span class="Delimiter">;</span> +<a name="L169"></a><span id="L169" class="LineNr">169 </span> +<a name="L170"></a><span id="L170" class="LineNr">170 </span><span class="Comment">// Top-level helper. IMPORTANT: can't nest</span> +<a name="L171"></a><span id="L171" class="LineNr">171 </span><span class="PreProc">#define trace(</span><span class="Delimiter">...</span><span class="PreProc">) !Trace_stream ? cerr </span><span class="Comment">/*</span><span class="Comment">print nothing</span><span class="Comment">*/</span><span class="PreProc"> : Trace_stream</span><span class="Delimiter">-></span><span class="PreProc">stream(__VA_ARGS__)</span> +<a name="L172"></a><span id="L172" class="LineNr">172 </span> +<a name="L173"></a><span id="L173" class="LineNr">173 </span><span class="Comment">// Just for debugging; 'git log' should never show any calls to 'dbg'.</span> +<a name="L174"></a><span id="L174" class="LineNr">174 </span><span class="PreProc">#define dbg trace(</span><span class="Constant">0</span><span class="Delimiter">,</span><span class="PreProc"> </span><span class="Constant">"a"</span><span class="PreProc">)</span> +<a name="L175"></a><span id="L175" class="LineNr">175 </span><span class="PreProc">#define DUMP(label) </span><span class="Normal">if</span><span class="PreProc"> (Trace_stream) cerr << Trace_stream</span><span class="Delimiter">-></span><span class="PreProc">readable_contents(label)</span><span class="Delimiter">;</span> +<a name="L176"></a><span id="L176" class="LineNr">176 </span> +<a name="L177"></a><span id="L177" class="LineNr">177 </span><span class="Comment">// Errors are a special layer.</span> +<a name="L178"></a><span id="L178" class="LineNr">178 </span><span class="PreProc">#define raise (!Trace_stream ? (tb_shutdown()</span><span class="Delimiter">,</span><span class="PreProc">++Trace_errors</span><span class="Delimiter">,</span><span class="PreProc">cerr) </span><span class="Comment">/*</span><span class="Comment">do print</span><span class="Comment">*/</span><span class="PreProc"> : Trace_stream</span><span class="Delimiter">-></span><span class="PreProc">stream(Error_depth</span><span class="Delimiter">,</span><span class="PreProc"> </span><span class="Constant">"error"</span><span class="PreProc">))</span> +<a name="L179"></a><span id="L179" class="LineNr">179 </span><span class="Comment">// If we aren't yet sure how to deal with some corner case, use assert_for_now</span> +<a name="L180"></a><span id="L180" class="LineNr">180 </span><span class="Comment">// to indicate that it isn't an inviolable invariant.</span> +<a name="L181"></a><span id="L181" class="LineNr">181 </span><span class="PreProc">#define assert_for_now assert</span> +<a name="L182"></a><span id="L182" class="LineNr">182 </span> +<a name="L183"></a><span id="L183" class="LineNr">183 </span><span class="Comment">// Inside tests, fail any tests that displayed (unexpected) errors.</span> +<a name="L184"></a><span id="L184" class="LineNr">184 </span><span class="Comment">// Expected errors in tests should always be hidden and silently checked for.</span> +<a name="L185"></a><span id="L185" class="LineNr">185 </span><span class="Delimiter">:(before "End Test Teardown")</span> +<a name="L186"></a><span id="L186" class="LineNr">186 </span><span class="Normal">if</span> <span class="Delimiter">(</span>Passed && !Hide_errors && trace_contains_errors<span class="Delimiter">())</span> <span class="Delimiter">{</span> +<a name="L187"></a><span id="L187" class="LineNr">187 </span> Passed = <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L188"></a><span id="L188" class="LineNr">188 </span><span class="Delimiter">}</span> +<a name="L189"></a><span id="L189" class="LineNr">189 </span><span class="Delimiter">:(code)</span> +<a name="L190"></a><span id="L190" class="LineNr">190 </span><span class="Normal">bool</span> trace_contains_errors<span class="Delimiter">()</span> <span class="Delimiter">{</span> +<a name="L191"></a><span id="L191" class="LineNr">191 </span> <span class="Identifier">return</span> Trace_errors > <span class="Constant">0</span> || trace_count<span class="Delimiter">(</span><span class="Constant">"error"</span><span class="Delimiter">)</span> > <span class="Constant">0</span><span class="Delimiter">;</span> +<a name="L192"></a><span id="L192" class="LineNr">192 </span><span class="Delimiter">}</span> +<a name="L193"></a><span id="L193" class="LineNr">193 </span> +<a name="L194"></a><span id="L194" class="LineNr">194 </span><span class="Delimiter">:(before "End Types")</span> +<a name="L195"></a><span id="L195" class="LineNr">195 </span><span class="Normal">struct</span> end <span class="Delimiter">{};</span> +<a name="L196"></a><span id="L196" class="LineNr">196 </span><span class="Delimiter">:(code)</span> +<a name="L197"></a><span id="L197" class="LineNr">197 </span>ostream& <span class="Normal">operator</span><<<span class="Delimiter">(</span>ostream& os<span class="Delimiter">,</span> unused end<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L198"></a><span id="L198" class="LineNr">198 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>Trace_stream<span class="Delimiter">)</span> Trace_stream<span class="Delimiter">-></span>newline<span class="Delimiter">();</span> +<a name="L199"></a><span id="L199" class="LineNr">199 </span> <span class="Identifier">return</span> os<span class="Delimiter">;</span> +<a name="L200"></a><span id="L200" class="LineNr">200 </span><span class="Delimiter">}</span> +<a name="L201"></a><span id="L201" class="LineNr">201 </span> +<a name="L202"></a><span id="L202" class="LineNr">202 </span><span class="Delimiter">:(before "End Globals")</span> +<a name="L203"></a><span id="L203" class="LineNr">203 </span><span class="Normal">bool</span> Save_trace = <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L204"></a><span id="L204" class="LineNr">204 </span> +<a name="L205"></a><span id="L205" class="LineNr">205 </span><span class="Comment">// Trace_stream is a resource, lease_tracer uses RAII to manage it.</span> +<a name="L206"></a><span id="L206" class="LineNr">206 </span><span class="Delimiter">:(before "End Types")</span> +<a name="L207"></a><span id="L207" class="LineNr">207 </span><span class="Normal">struct</span> lease_tracer <span class="Delimiter">{</span> +<a name="L208"></a><span id="L208" class="LineNr">208 </span> lease_tracer<span class="Delimiter">();</span> +<a name="L209"></a><span id="L209" class="LineNr">209 </span> ~lease_tracer<span class="Delimiter">();</span> +<a name="L210"></a><span id="L210" class="LineNr">210 </span><span class="Delimiter">};</span> +<a name="L211"></a><span id="L211" class="LineNr">211 </span><span class="Delimiter">:(code)</span> +<a name="L212"></a><span id="L212" class="LineNr">212 </span>lease_tracer::lease_tracer<span class="Delimiter">()</span> <span class="Delimiter">{</span> Trace_stream = <span class="Normal">new</span> trace_stream<span class="Delimiter">;</span> <span class="Delimiter">}</span> +<a name="L213"></a><span id="L213" class="LineNr">213 </span>lease_tracer::~lease_tracer<span class="Delimiter">()</span> <span class="Delimiter">{</span> +<a name="L214"></a><span id="L214" class="LineNr">214 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>!Trace_stream<span class="Delimiter">)</span> <span class="Identifier">return</span><span class="Delimiter">;</span> <span class="Comment">// in case tests close Trace_stream</span> +<a name="L215"></a><span id="L215" class="LineNr">215 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>Save_trace<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L216"></a><span id="L216" class="LineNr">216 </span> ofstream fout<span class="Delimiter">(</span><span class="Constant">"last_trace"</span><span class="Delimiter">);</span> +<a name="L217"></a><span id="L217" class="LineNr">217 </span> fout << Trace_stream<span class="Delimiter">-></span>readable_contents<span class="Delimiter">(</span><span class="Constant">""</span><span class="Delimiter">);</span> +<a name="L218"></a><span id="L218" class="LineNr">218 </span> fout<span class="Delimiter">.</span>close<span class="Delimiter">();</span> +<a name="L219"></a><span id="L219" class="LineNr">219 </span> <span class="Delimiter">}</span> +<a name="L220"></a><span id="L220" class="LineNr">220 </span> <span class="Normal">delete</span> Trace_stream<span class="Delimiter">,</span> Trace_stream = <span class="Constant">NULL</span><span class="Delimiter">;</span> +<a name="L221"></a><span id="L221" class="LineNr">221 </span><span class="Delimiter">}</span> +<a name="L222"></a><span id="L222" class="LineNr">222 </span><span class="Delimiter">:(before "End Includes")</span> +<a name="L223"></a><span id="L223" class="LineNr">223 </span><span class="PreProc">#define START_TRACING_UNTIL_END_OF_SCOPE lease_tracer leased_tracer</span><span class="Delimiter">;</span> +<a name="L224"></a><span id="L224" class="LineNr">224 </span><span class="Delimiter">:(before "End Test Setup")</span> +<a name="L225"></a><span id="L225" class="LineNr">225 </span>START_TRACING_UNTIL_END_OF_SCOPE +<a name="L226"></a><span id="L226" class="LineNr">226 </span> +<a name="L227"></a><span id="L227" class="LineNr">227 </span><span class="Delimiter">:(before "End Includes")</span> +<a name="L228"></a><span id="L228" class="LineNr">228 </span><span class="PreProc">#define CHECK_TRACE_CONTENTS(</span><span class="Delimiter">...</span><span class="PreProc">) check_trace_contents(__FUNCTION__</span><span class="Delimiter">,</span><span class="PreProc"> </span><span class="Constant">__FILE__</span><span class="Delimiter">,</span><span class="PreProc"> </span><span class="Constant">__LINE__</span><span class="Delimiter">,</span><span class="PreProc"> __VA_ARGS__)</span> +<a name="L229"></a><span id="L229" class="LineNr">229 </span> +<a name="L230"></a><span id="L230" class="LineNr">230 </span><span class="PreProc">#define CHECK_TRACE_CONTAINS_ERRORS() CHECK(trace_contains_errors())</span> +<a name="L231"></a><span id="L231" class="LineNr">231 </span><span class="PreProc">#define CHECK_TRACE_DOESNT_CONTAIN_ERRORS() \</span> +<a name="L232"></a><span id="L232" class="LineNr">232 </span><span class="PreProc"> </span><span class="Normal">if</span><span class="PreProc"> (Passed && trace_contains_errors()) </span><span class="Delimiter">{</span><span class="PreProc"> \</span> +<a name="L233"></a><span id="L233" class="LineNr">233 </span><span class="PreProc"> cerr << </span><span class="Constant">"</span><span class="cSpecial">\n</span><span class="Constant">F - "</span><span class="PreProc"> << __FUNCTION__ << </span><span class="Constant">"("</span><span class="PreProc"> << </span><span class="Constant">__FILE__</span><span class="PreProc"> << </span><span class="Constant">":"</span><span class="PreProc"> << </span><span class="Constant">__LINE__</span><span class="PreProc"> << </span><span class="Constant">"): unexpected errors</span><span class="cSpecial">\n</span><span class="Constant">"</span><span class="Delimiter">;</span><span class="PreProc"> \</span> +<a name="L234"></a><span id="L234" class="LineNr">234 </span><span class="PreProc"> DUMP(</span><span class="Constant">"error"</span><span class="PreProc">)</span><span class="Delimiter">;</span><span class="PreProc"> \</span> +<a name="L235"></a><span id="L235" class="LineNr">235 </span><span class="PreProc"> Passed = </span><span class="Constant">false</span><span class="Delimiter">;</span><span class="PreProc"> \</span> +<a name="L236"></a><span id="L236" class="LineNr">236 </span><span class="PreProc"> </span><span class="Identifier">return</span><span class="Delimiter">;</span><span class="PreProc"> \</span> +<a name="L237"></a><span id="L237" class="LineNr">237 </span><span class="PreProc"> </span><span class="Delimiter">}</span> +<a name="L238"></a><span id="L238" class="LineNr">238 </span> +<a name="L239"></a><span id="L239" class="LineNr">239 </span><span class="PreProc">#define CHECK_TRACE_COUNT(label</span><span class="Delimiter">,</span><span class="PreProc"> count) \</span> +<a name="L240"></a><span id="L240" class="LineNr">240 </span><span class="PreProc"> </span><span class="Normal">if</span><span class="PreProc"> (Passed && trace_count(label) != (count)) </span><span class="Delimiter">{</span><span class="PreProc"> \</span> +<a name="L241"></a><span id="L241" class="LineNr">241 </span><span class="PreProc"> cerr << </span><span class="Constant">"</span><span class="cSpecial">\n</span><span class="Constant">F - "</span><span class="PreProc"> << __FUNCTION__ << </span><span class="Constant">"("</span><span class="PreProc"> << </span><span class="Constant">__FILE__</span><span class="PreProc"> << </span><span class="Constant">":"</span><span class="PreProc"> << </span><span class="Constant">__LINE__</span><span class="PreProc"> << </span><span class="Constant">"): trace_count of "</span><span class="PreProc"> << label << </span><span class="Constant">" should be "</span><span class="PreProc"> << count << </span><span class="cSpecial">'\n'</span><span class="Delimiter">;</span><span class="PreProc"> \</span> +<a name="L242"></a><span id="L242" class="LineNr">242 </span><span class="PreProc"> cerr << </span><span class="Constant">" got "</span><span class="PreProc"> << trace_count(label) << </span><span class="cSpecial">'\n'</span><span class="Delimiter">;</span><span class="PreProc"> </span><span class="Comment">/*</span><span class="Comment"> multiple eval </span><span class="Comment">*/</span><span class="PreProc"> \</span> +<a name="L243"></a><span id="L243" class="LineNr">243 </span><span class="PreProc"> DUMP(label)</span><span class="Delimiter">;</span><span class="PreProc"> \</span> +<a name="L244"></a><span id="L244" class="LineNr">244 </span><span class="PreProc"> Passed = </span><span class="Constant">false</span><span class="Delimiter">;</span><span class="PreProc"> \</span> +<a name="L245"></a><span id="L245" class="LineNr">245 </span><span class="PreProc"> </span><span class="Identifier">return</span><span class="Delimiter">;</span><span class="PreProc"> </span><span class="Comment">/*</span><span class="Comment"> Currently we stop at the very first failure. </span><span class="Comment">*/</span><span class="PreProc"> \</span> +<a name="L246"></a><span id="L246" class="LineNr">246 </span><span class="PreProc"> </span><span class="Delimiter">}</span> +<a name="L247"></a><span id="L247" class="LineNr">247 </span> +<a name="L248"></a><span id="L248" class="LineNr">248 </span><span class="PreProc">#define CHECK_TRACE_DOESNT_CONTAIN(</span><span class="Delimiter">...</span><span class="PreProc">) CHECK(trace_doesnt_contain(__VA_ARGS__))</span> +<a name="L249"></a><span id="L249" class="LineNr">249 </span> +<a name="L250"></a><span id="L250" class="LineNr">250 </span><span class="Delimiter">:(code)</span> +<a name="L251"></a><span id="L251" class="LineNr">251 </span><span class="Normal">bool</span> check_trace_contents<span class="Delimiter">(</span>string FUNCTION<span class="Delimiter">,</span> string <span class="Normal">FILE</span><span class="Delimiter">,</span> <span class="Normal">int</span> LINE<span class="Delimiter">,</span> string expected<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L252"></a><span id="L252" class="LineNr">252 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>!Passed<span class="Delimiter">)</span> <span class="Identifier">return</span> <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L253"></a><span id="L253" class="LineNr">253 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>!Trace_stream<span class="Delimiter">)</span> <span class="Identifier">return</span> <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L254"></a><span id="L254" class="LineNr">254 </span> vector<string> expected_lines = split<span class="Delimiter">(</span>expected<span class="Delimiter">,</span> <span class="Constant">"^D"</span><span class="Delimiter">);</span> +<a name="L255"></a><span id="L255" class="LineNr">255 </span> <span class="Normal">int</span> curr_expected_line = <span class="Constant">0</span><span class="Delimiter">;</span> +<a name="L256"></a><span id="L256" class="LineNr">256 </span> <span class="Normal">while</span> <span class="Delimiter">(</span>curr_expected_line < SIZE<span class="Delimiter">(</span>expected_lines<span class="Delimiter">)</span> && expected_lines<span class="Delimiter">.</span>at<span class="Delimiter">(</span>curr_expected_line<span class="Delimiter">).</span>empty<span class="Delimiter">())</span> +<a name="L257"></a><span id="L257" class="LineNr">257 </span> ++curr_expected_line<span class="Delimiter">;</span> +<a name="L258"></a><span id="L258" class="LineNr">258 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>curr_expected_line == SIZE<span class="Delimiter">(</span>expected_lines<span class="Delimiter">))</span> <span class="Identifier">return</span> <span class="Constant">true</span><span class="Delimiter">;</span> +<a name="L259"></a><span id="L259" class="LineNr">259 </span> string label<span class="Delimiter">,</span> contents<span class="Delimiter">;</span> +<a name="L260"></a><span id="L260" class="LineNr">260 </span> split_label_contents<span class="Delimiter">(</span>expected_lines<span class="Delimiter">.</span>at<span class="Delimiter">(</span>curr_expected_line<span class="Delimiter">),</span> &label<span class="Delimiter">,</span> &contents<span class="Delimiter">);</span> +<a name="L261"></a><span id="L261" class="LineNr">261 </span> <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L262"></a><span id="L262" class="LineNr">262 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>label != p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> +<a name="L263"></a><span id="L263" class="LineNr">263 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>contents != trim<span class="Delimiter">(</span>p<span class="Delimiter">-></span>contents<span class="Delimiter">))</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> +<a name="L264"></a><span id="L264" class="LineNr">264 </span> ++curr_expected_line<span class="Delimiter">;</span> +<a name="L265"></a><span id="L265" class="LineNr">265 </span> <span class="Normal">while</span> <span class="Delimiter">(</span>curr_expected_line < SIZE<span class="Delimiter">(</span>expected_lines<span class="Delimiter">)</span> && expected_lines<span class="Delimiter">.</span>at<span class="Delimiter">(</span>curr_expected_line<span class="Delimiter">).</span>empty<span class="Delimiter">())</span> +<a name="L266"></a><span id="L266" class="LineNr">266 </span> ++curr_expected_line<span class="Delimiter">;</span> +<a name="L267"></a><span id="L267" class="LineNr">267 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>curr_expected_line == SIZE<span class="Delimiter">(</span>expected_lines<span class="Delimiter">))</span> <span class="Identifier">return</span> <span class="Constant">true</span><span class="Delimiter">;</span> +<a name="L268"></a><span id="L268" class="LineNr">268 </span> split_label_contents<span class="Delimiter">(</span>expected_lines<span class="Delimiter">.</span>at<span class="Delimiter">(</span>curr_expected_line<span class="Delimiter">),</span> &label<span class="Delimiter">,</span> &contents<span class="Delimiter">);</span> +<a name="L269"></a><span id="L269" class="LineNr">269 </span> <span class="Delimiter">}</span> +<a name="L270"></a><span id="L270" class="LineNr">270 </span> +<a name="L271"></a><span id="L271" class="LineNr">271 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>line_exists_anywhere<span class="Delimiter">(</span>label<span class="Delimiter">,</span> contents<span class="Delimiter">))</span> <span class="Delimiter">{</span> +<a name="L272"></a><span id="L272" class="LineNr">272 </span> cerr << <span class="Constant">"</span><span class="cSpecial">\n</span><span class="Constant">F - "</span> << FUNCTION << <span class="Constant">"("</span> << <span class="Normal">FILE</span> << <span class="Constant">":"</span> << LINE << <span class="Constant">"): line ["</span> << label << <span class="Constant">": "</span> << contents << <span class="Constant">"] out of order in trace:</span><span class="cSpecial">\n</span><span class="Constant">"</span><span class="Delimiter">;</span> +<a name="L273"></a><span id="L273" class="LineNr">273 </span> DUMP<span class="Delimiter">(</span><span class="Constant">""</span><span class="Delimiter">);</span> +<a name="L274"></a><span id="L274" class="LineNr">274 </span> <span class="Delimiter">}</span> +<a name="L275"></a><span id="L275" class="LineNr">275 </span> <span class="Normal">else</span> <span class="Delimiter">{</span> +<a name="L276"></a><span id="L276" class="LineNr">276 </span> cerr << <span class="Constant">"</span><span class="cSpecial">\n</span><span class="Constant">F - "</span> << FUNCTION << <span class="Constant">"("</span> << <span class="Normal">FILE</span> << <span class="Constant">":"</span> << LINE << <span class="Constant">"): missing ["</span> << contents << <span class="Constant">"] in trace:</span><span class="cSpecial">\n</span><span class="Constant">"</span><span class="Delimiter">;</span> +<a name="L277"></a><span id="L277" class="LineNr">277 </span> DUMP<span class="Delimiter">(</span>label<span class="Delimiter">);</span> +<a name="L278"></a><span id="L278" class="LineNr">278 </span> <span class="Delimiter">}</span> +<a name="L279"></a><span id="L279" class="LineNr">279 </span> Passed = <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L280"></a><span id="L280" class="LineNr">280 </span> <span class="Identifier">return</span> <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L281"></a><span id="L281" class="LineNr">281 </span><span class="Delimiter">}</span> +<a name="L282"></a><span id="L282" class="LineNr">282 </span> +<a name="L283"></a><span id="L283" class="LineNr">283 </span><span class="Normal">void</span> split_label_contents<span class="Delimiter">(</span><span class="Normal">const</span> string& s<span class="Delimiter">,</span> string* label<span class="Delimiter">,</span> string* contents<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L284"></a><span id="L284" class="LineNr">284 </span> <span class="Normal">static</span> <span class="Normal">const</span> string delim<span class="Delimiter">(</span><span class="Constant">": "</span><span class="Delimiter">);</span> +<a name="L285"></a><span id="L285" class="LineNr">285 </span> <span class="Normal">size_t</span> pos = s<span class="Delimiter">.</span>find<span class="Delimiter">(</span>delim<span class="Delimiter">);</span> +<a name="L286"></a><span id="L286" class="LineNr">286 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>pos == string::npos<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L287"></a><span id="L287" class="LineNr">287 </span> *label = <span class="Constant">""</span><span class="Delimiter">;</span> +<a name="L288"></a><span id="L288" class="LineNr">288 </span> *contents = trim<span class="Delimiter">(</span>s<span class="Delimiter">);</span> +<a name="L289"></a><span id="L289" class="LineNr">289 </span> <span class="Delimiter">}</span> +<a name="L290"></a><span id="L290" class="LineNr">290 </span> <span class="Normal">else</span> <span class="Delimiter">{</span> +<a name="L291"></a><span id="L291" class="LineNr">291 </span> *label = trim<span class="Delimiter">(</span>s<span class="Delimiter">.</span>substr<span class="Delimiter">(</span><span class="Constant">0</span><span class="Delimiter">,</span> pos<span class="Delimiter">));</span> +<a name="L292"></a><span id="L292" class="LineNr">292 </span> *contents = trim<span class="Delimiter">(</span>s<span class="Delimiter">.</span>substr<span class="Delimiter">(</span>pos+SIZE<span class="Delimiter">(</span>delim<span class="Delimiter">)));</span> +<a name="L293"></a><span id="L293" class="LineNr">293 </span> <span class="Delimiter">}</span> +<a name="L294"></a><span id="L294" class="LineNr">294 </span><span class="Delimiter">}</span> +<a name="L295"></a><span id="L295" class="LineNr">295 </span> +<a name="L296"></a><span id="L296" class="LineNr">296 </span><span class="Normal">bool</span> line_exists_anywhere<span class="Delimiter">(</span><span class="Normal">const</span> string& label<span class="Delimiter">,</span> <span class="Normal">const</span> string& contents<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L297"></a><span id="L297" class="LineNr">297 </span> <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L298"></a><span id="L298" class="LineNr">298 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>label != p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> +<a name="L299"></a><span id="L299" class="LineNr">299 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>contents == trim<span class="Delimiter">(</span>p<span class="Delimiter">-></span>contents<span class="Delimiter">))</span> <span class="Identifier">return</span> <span class="Constant">true</span><span class="Delimiter">;</span> +<a name="L300"></a><span id="L300" class="LineNr">300 </span> <span class="Delimiter">}</span> +<a name="L301"></a><span id="L301" class="LineNr">301 </span> <span class="Identifier">return</span> <span class="Constant">false</span><span class="Delimiter">;</span> +<a name="L302"></a><span id="L302" class="LineNr">302 </span><span class="Delimiter">}</span> +<a name="L303"></a><span id="L303" class="LineNr">303 </span> +<a name="L304"></a><span id="L304" class="LineNr">304 </span><span class="Normal">int</span> trace_count<span class="Delimiter">(</span>string label<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L305"></a><span id="L305" class="LineNr">305 </span> <span class="Identifier">return</span> trace_count<span class="Delimiter">(</span>label<span class="Delimiter">,</span> <span class="Constant">""</span><span class="Delimiter">);</span> +<a name="L306"></a><span id="L306" class="LineNr">306 </span><span class="Delimiter">}</span> +<a name="L307"></a><span id="L307" class="LineNr">307 </span> +<a name="L308"></a><span id="L308" class="LineNr">308 </span><span class="Normal">int</span> trace_count<span class="Delimiter">(</span>string label<span class="Delimiter">,</span> string line<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L309"></a><span id="L309" class="LineNr">309 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>!Trace_stream<span class="Delimiter">)</span> <span class="Identifier">return</span> <span class="Constant">0</span><span class="Delimiter">;</span> +<a name="L310"></a><span id="L310" class="LineNr">310 </span> <span class="Normal">long</span> result = <span class="Constant">0</span><span class="Delimiter">;</span> +<a name="L311"></a><span id="L311" class="LineNr">311 </span> <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L312"></a><span id="L312" class="LineNr">312 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>label == p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L313"></a><span id="L313" class="LineNr">313 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>line == <span class="Constant">""</span> || trim<span class="Delimiter">(</span>line<span class="Delimiter">)</span> == trim<span class="Delimiter">(</span>p<span class="Delimiter">-></span>contents<span class="Delimiter">))</span> +<a name="L314"></a><span id="L314" class="LineNr">314 </span> ++result<span class="Delimiter">;</span> +<a name="L315"></a><span id="L315" class="LineNr">315 </span> <span class="Delimiter">}</span> +<a name="L316"></a><span id="L316" class="LineNr">316 </span> <span class="Delimiter">}</span> +<a name="L317"></a><span id="L317" class="LineNr">317 </span> <span class="Identifier">return</span> result<span class="Delimiter">;</span> +<a name="L318"></a><span id="L318" class="LineNr">318 </span><span class="Delimiter">}</span> +<a name="L319"></a><span id="L319" class="LineNr">319 </span> +<a name="L320"></a><span id="L320" class="LineNr">320 </span><span class="Normal">int</span> trace_count_prefix<span class="Delimiter">(</span>string label<span class="Delimiter">,</span> string prefix<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L321"></a><span id="L321" class="LineNr">321 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>!Trace_stream<span class="Delimiter">)</span> <span class="Identifier">return</span> <span class="Constant">0</span><span class="Delimiter">;</span> +<a name="L322"></a><span id="L322" class="LineNr">322 </span> <span class="Normal">long</span> result = <span class="Constant">0</span><span class="Delimiter">;</span> +<a name="L323"></a><span id="L323" class="LineNr">323 </span> <span class="Normal">for</span> <span class="Delimiter">(</span>vector<trace_line>::iterator p = Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> p != Trace_stream<span class="Delimiter">-></span>past_lines<span class="Delimiter">.</span>end<span class="Delimiter">();</span> ++p<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L324"></a><span id="L324" class="LineNr">324 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>label == p<span class="Delimiter">-></span>label<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L325"></a><span id="L325" class="LineNr">325 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>starts_with<span class="Delimiter">(</span>trim<span class="Delimiter">(</span>p<span class="Delimiter">-></span>contents<span class="Delimiter">),</span> trim<span class="Delimiter">(</span>prefix<span class="Delimiter">)))</span> +<a name="L326"></a><span id="L326" class="LineNr">326 </span> ++result<span class="Delimiter">;</span> +<a name="L327"></a><span id="L327" class="LineNr">327 </span> <span class="Delimiter">}</span> +<a name="L328"></a><span id="L328" class="LineNr">328 </span> <span class="Delimiter">}</span> +<a name="L329"></a><span id="L329" class="LineNr">329 </span> <span class="Identifier">return</span> result<span class="Delimiter">;</span> +<a name="L330"></a><span id="L330" class="LineNr">330 </span><span class="Delimiter">}</span> +<a name="L331"></a><span id="L331" class="LineNr">331 </span> +<a name="L332"></a><span id="L332" class="LineNr">332 </span><span class="Normal">bool</span> trace_doesnt_contain<span class="Delimiter">(</span>string label<span class="Delimiter">,</span> string line<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L333"></a><span id="L333" class="LineNr">333 </span> <span class="Identifier">return</span> trace_count<span class="Delimiter">(</span>label<span class="Delimiter">,</span> line<span class="Delimiter">)</span> == <span class="Constant">0</span><span class="Delimiter">;</span> +<a name="L334"></a><span id="L334" class="LineNr">334 </span><span class="Delimiter">}</span> +<a name="L335"></a><span id="L335" class="LineNr">335 </span> +<a name="L336"></a><span id="L336" class="LineNr">336 </span><span class="Normal">bool</span> trace_doesnt_contain<span class="Delimiter">(</span>string expected<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L337"></a><span id="L337" class="LineNr">337 </span> vector<string> tmp = split_first<span class="Delimiter">(</span>expected<span class="Delimiter">,</span> <span class="Constant">": "</span><span class="Delimiter">);</span> +<a name="L338"></a><span id="L338" class="LineNr">338 </span> <span class="Identifier">return</span> trace_doesnt_contain<span class="Delimiter">(</span>tmp<span class="Delimiter">.</span>at<span class="Delimiter">(</span><span class="Constant">0</span><span class="Delimiter">),</span> tmp<span class="Delimiter">.</span>at<span class="Delimiter">(</span><span class="Constant">1</span><span class="Delimiter">));</span> +<a name="L339"></a><span id="L339" class="LineNr">339 </span><span class="Delimiter">}</span> +<a name="L340"></a><span id="L340" class="LineNr">340 </span> +<a name="L341"></a><span id="L341" class="LineNr">341 </span>vector<string> split<span class="Delimiter">(</span>string s<span class="Delimiter">,</span> string delim<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L342"></a><span id="L342" class="LineNr">342 </span> vector<string> result<span class="Delimiter">;</span> +<a name="L343"></a><span id="L343" class="LineNr">343 </span> <span class="Normal">size_t</span> begin=<span class="Constant">0</span><span class="Delimiter">,</span> end=s<span class="Delimiter">.</span>find<span class="Delimiter">(</span>delim<span class="Delimiter">);</span> +<a name="L344"></a><span id="L344" class="LineNr">344 </span> <span class="Normal">while</span> <span class="Delimiter">(</span><span class="Constant">true</span><span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L345"></a><span id="L345" class="LineNr">345 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>end == string::npos<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L346"></a><span id="L346" class="LineNr">346 </span> result<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>string<span class="Delimiter">(</span>s<span class="Delimiter">,</span> begin<span class="Delimiter">,</span> string::npos<span class="Delimiter">));</span> +<a name="L347"></a><span id="L347" class="LineNr">347 </span> <span class="Identifier">break</span><span class="Delimiter">;</span> +<a name="L348"></a><span id="L348" class="LineNr">348 </span> <span class="Delimiter">}</span> +<a name="L349"></a><span id="L349" class="LineNr">349 </span> result<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>string<span class="Delimiter">(</span>s<span class="Delimiter">,</span> begin<span class="Delimiter">,</span> end-begin<span class="Delimiter">));</span> +<a name="L350"></a><span id="L350" class="LineNr">350 </span> begin = end+SIZE<span class="Delimiter">(</span>delim<span class="Delimiter">);</span> +<a name="L351"></a><span id="L351" class="LineNr">351 </span> end = s<span class="Delimiter">.</span>find<span class="Delimiter">(</span>delim<span class="Delimiter">,</span> begin<span class="Delimiter">);</span> +<a name="L352"></a><span id="L352" class="LineNr">352 </span> <span class="Delimiter">}</span> +<a name="L353"></a><span id="L353" class="LineNr">353 </span> <span class="Identifier">return</span> result<span class="Delimiter">;</span> +<a name="L354"></a><span id="L354" class="LineNr">354 </span><span class="Delimiter">}</span> +<a name="L355"></a><span id="L355" class="LineNr">355 </span> +<a name="L356"></a><span id="L356" class="LineNr">356 </span>vector<string> split_first<span class="Delimiter">(</span>string s<span class="Delimiter">,</span> string delim<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L357"></a><span id="L357" class="LineNr">357 </span> vector<string> result<span class="Delimiter">;</span> +<a name="L358"></a><span id="L358" class="LineNr">358 </span> <span class="Normal">size_t</span> end=s<span class="Delimiter">.</span>find<span class="Delimiter">(</span>delim<span class="Delimiter">);</span> +<a name="L359"></a><span id="L359" class="LineNr">359 </span> result<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>string<span class="Delimiter">(</span>s<span class="Delimiter">,</span> <span class="Constant">0</span><span class="Delimiter">,</span> end<span class="Delimiter">));</span> +<a name="L360"></a><span id="L360" class="LineNr">360 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>end != string::npos<span class="Delimiter">)</span> +<a name="L361"></a><span id="L361" class="LineNr">361 </span> result<span class="Delimiter">.</span>push_back<span class="Delimiter">(</span>string<span class="Delimiter">(</span>s<span class="Delimiter">,</span> end+SIZE<span class="Delimiter">(</span>delim<span class="Delimiter">),</span> string::npos<span class="Delimiter">));</span> +<a name="L362"></a><span id="L362" class="LineNr">362 </span> <span class="Identifier">return</span> result<span class="Delimiter">;</span> +<a name="L363"></a><span id="L363" class="LineNr">363 </span><span class="Delimiter">}</span> +<a name="L364"></a><span id="L364" class="LineNr">364 </span> +<a name="L365"></a><span id="L365" class="LineNr">365 </span>string trim<span class="Delimiter">(</span><span class="Normal">const</span> string& s<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<a name="L366"></a><span id="L366" class="LineNr">366 </span> string::const_iterator first = s<span class="Delimiter">.</span>begin<span class="Delimiter">();</span> +<a name="L367"></a><span id="L367" class="LineNr">367 </span> <span class="Normal">while</span> <span class="Delimiter">(</span>first != s<span class="Delimiter">.</span>end<span class="Delimiter">()</span> && isspace<span class="Delimiter">(</span>*first<span class="Delimiter">))</span> +<a name="L368"></a><span id="L368" class="LineNr">368 </span> ++first<span class="Delimiter">;</span> +<a name="L369"></a><span id="L369" class="LineNr">369 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>first == s<span class="Delimiter">.</span>end<span class="Delimiter">())</span> <span class="Identifier">return</span> <span class="Constant">""</span><span class="Delimiter">;</span> +<a name="L370"></a><span id="L370" class="LineNr">370 </span> +<a name="L371"></a><span id="L371" class="LineNr">371 </span> string::const_iterator last = --s<span class="Delimiter">.</span>end<span class="Delimiter">();</span> +<a name="L372"></a><span id="L372" class="LineNr">372 </span> <span class="Normal">while</span> <span class="Delimiter">(</span>last != s<span class="Delimiter">.</span>begin<span class="Delimiter">()</span> && isspace<span class="Delimiter">(</span>*last<span class="Delimiter">))</span> +<a name="L373"></a><span id="L373" class="LineNr">373 </span> --last<span class="Delimiter">;</span> +<a name="L374"></a><span id="L374" class="LineNr">374 </span> ++last<span class="Delimiter">;</span> +<a name="L375"></a><span id="L375" class="LineNr">375 </span> <span class="Identifier">return</span> string<span class="Delimiter">(</span>first<span class="Delimiter">,</span> last<span class="Delimiter">);</span> +<a name="L376"></a><span id="L376" class="LineNr">376 </span><span class="Delimiter">}</span> +<a name="L377"></a><span id="L377" class="LineNr">377 </span> +<a name="L378"></a><span id="L378" class="LineNr">378 </span><span class="Delimiter">:(before "End Includes")</span> +<a name="L379"></a><span id="L379" class="LineNr">379 </span><span class="PreProc">#include </span><span class="Constant"><vector></span> +<a name="L380"></a><span id="L380" class="LineNr">380 </span><span class="Normal">using</span> std::vector<span class="Delimiter">;</span> +<a name="L381"></a><span id="L381" class="LineNr">381 </span><span class="PreProc">#include </span><span class="Constant"><list></span> +<a name="L382"></a><span id="L382" class="LineNr">382 </span><span class="Normal">using</span> std::list<span class="Delimiter">;</span> +<a name="L383"></a><span id="L383" class="LineNr">383 </span><span class="PreProc">#include </span><span class="Constant"><map></span> +<a name="L384"></a><span id="L384" class="LineNr">384 </span><span class="Normal">using</span> std::map<span class="Delimiter">;</span> +<a name="L385"></a><span id="L385" class="LineNr">385 </span><span class="PreProc">#include </span><span class="Constant"><set></span> +<a name="L386"></a><span id="L386" class="LineNr">386 </span><span class="Normal">using</span> std::set<span class="Delimiter">;</span> +<a name="L387"></a><span id="L387" class="LineNr">387 </span><span class="PreProc">#include </span><span class="Constant"><algorithm></span> +<a name="L388"></a><span id="L388" class="LineNr">388 </span> +<a name="L389"></a><span id="L389" class="LineNr">389 </span><span class="PreProc">#include </span><span class="Constant"><sstream></span> +<a name="L390"></a><span id="L390" class="LineNr">390 </span><span class="Normal">using</span> std::istringstream<span class="Delimiter">;</span> +<a name="L391"></a><span id="L391" class="LineNr">391 </span><span class="Normal">using</span> std::ostringstream<span class="Delimiter">;</span> +<a name="L392"></a><span id="L392" class="LineNr">392 </span> +<a name="L393"></a><span id="L393" class="LineNr">393 </span><span class="PreProc">#include </span><span class="Constant"><fstream></span> +<a name="L394"></a><span id="L394" class="LineNr">394 </span><span class="Normal">using</span> std::ifstream<span class="Delimiter">;</span> +<a name="L395"></a><span id="L395" class="LineNr">395 </span><span class="Normal">using</span> std::ofstream<span class="Delimiter">;</span> +<a name="L396"></a><span id="L396" class="LineNr">396 </span> +<a name="L397"></a><span id="L397" class="LineNr">397 </span><span class="PreProc">#include </span><span class="Constant">"termbox/termbox.h"</span> +<a name="L398"></a><span id="L398" class="LineNr">398 </span> +<a name="L399"></a><span id="L399" class="LineNr">399 </span><span class="Delimiter">:(before "End Globals")</span> +<a name="L400"></a><span id="L400" class="LineNr">400 </span><span class="Comment">//: In future layers we'll use the depth field as follows:</span> +<a name="L401"></a><span id="L401" class="LineNr">401 </span><span class="Comment">//:</span> +<a name="L402"></a><span id="L402" class="LineNr">402 </span><span class="Comment">//: Errors will be depth 0.</span> +<a name="L403"></a><span id="L403" class="LineNr">403 </span><span class="Comment">//: Mu 'applications' will be able to use depths 1-100 as they like.</span> +<a name="L404"></a><span id="L404" class="LineNr">404 </span><span class="Comment">//: Primitive statements will occupy 101-9989</span> +<a name="L405"></a><span id="L405" class="LineNr">405 </span><span class="Normal">extern</span> <span class="Normal">const</span> <span class="Normal">int</span> Initial_callstack_depth = <span class="Constant">101</span><span class="Delimiter">;</span> +<a name="L406"></a><span id="L406" class="LineNr">406 </span><span class="Normal">extern</span> <span class="Normal">const</span> <span class="Normal">int</span> Max_callstack_depth = <span class="Constant">9989</span><span class="Delimiter">;</span> +<a name="L407"></a><span id="L407" class="LineNr">407 </span><span class="Comment">//: Finally, details of primitive Mu statements will occupy depth 9990-9999</span> +<a name="L408"></a><span id="L408" class="LineNr">408 </span><span class="Comment">//: (more on that later as well)</span> +<a name="L409"></a><span id="L409" class="LineNr">409 </span><span class="Comment">//:</span> +<a name="L410"></a><span id="L410" class="LineNr">410 </span><span class="Comment">//: This framework should help us hide some details at each level, mixing</span> +<a name="L411"></a><span id="L411" class="LineNr">411 </span><span class="Comment">//: static ideas like layers with the dynamic notion of call-stack depth.</span> </pre> </body> </html> |