diff options
| author | Kartik K. Agaram <vc@akkartik.com> | 2016-12-26 11:44:14 -0800 |
|---|---|---|
| committer | Kartik K. Agaram <vc@akkartik.com> | 2016-12-26 11:44:14 -0800 |
| commit | 204dae921abff0c70e017215bb3c91fa6ca11aff (patch) | |
| tree | 548788d18c881e3f6beb56133c1ca9d733ffa1e8 /html/000organization.cc.html | |
| parent | e5c11a5137d538b7713dd8708ca767c208824c06 (diff) | |
| download | mu-204dae921abff0c70e017215bb3c91fa6ca11aff.tar.gz | |
3710
Turns out we don't need to explicitly add anchors for each line. Vim's TOhtml has magic for that out of the box.
Diffstat (limited to 'html/000organization.cc.html')
| -rw-r--r-- | html/000organization.cc.html | 280 |
1 files changed, 140 insertions, 140 deletions
diff --git a/html/000organization.cc.html b/html/000organization.cc.html index 36e490cf..091df0c2 100644 --- a/html/000organization.cc.html +++ b/html/000organization.cc.html @@ -54,146 +54,146 @@ if ('onhashchange' in window) { </head> <body onload='JumpToLine();'> <pre id='vimCodeElement'> -<a name="L1"></a><span id="L1" class="LineNr"> 1 </span><span class="Comment">//: You guessed right: the '000' prefix means you should start reading here.</span> -<a name="L2"></a><span id="L2" class="LineNr"> 2 </span><span class="Comment">//:</span> -<a name="L3"></a><span id="L3" class="LineNr"> 3 </span><span class="Comment">//: This project is set up to load all files with a numeric prefix. Just</span> -<a name="L4"></a><span id="L4" class="LineNr"> 4 </span><span class="Comment">//: create a new file and start hacking.</span> -<a name="L5"></a><span id="L5" class="LineNr"> 5 </span><span class="Comment">//:</span> -<a name="L6"></a><span id="L6" class="LineNr"> 6 </span><span class="Comment">//: The first few files (00*) are independent of what this program does, an</span> -<a name="L7"></a><span id="L7" class="LineNr"> 7 </span><span class="Comment">//: experimental skeleton that will hopefully make it both easier for others to</span> -<a name="L8"></a><span id="L8" class="LineNr"> 8 </span><span class="Comment">//: understand and more malleable, easier to rewrite and remould into radically</span> -<a name="L9"></a><span id="L9" class="LineNr"> 9 </span><span class="Comment">//: different shapes without breaking in subtle corner cases. The premise is</span> -<a name="L10"></a><span id="L10" class="LineNr"> 10 </span><span class="Comment">//: that understandability and rewrite-friendliness are related in a virtuous</span> -<a name="L11"></a><span id="L11" class="LineNr"> 11 </span><span class="Comment">//: cycle. Doing one well makes it easier to do the other.</span> -<a name="L12"></a><span id="L12" class="LineNr"> 12 </span><span class="Comment">//:</span> -<a name="L13"></a><span id="L13" class="LineNr"> 13 </span><span class="Comment">//: Lower down, this file contains a legal, bare-bones C++ program. It doesn't</span> -<a name="L14"></a><span id="L14" class="LineNr"> 14 </span><span class="Comment">//: do anything yet; subsequent files will contain :(...) directives to insert</span> -<a name="L15"></a><span id="L15" class="LineNr"> 15 </span><span class="Comment">//: lines into it. For example:</span> -<a name="L16"></a><span id="L16" class="LineNr"> 16 </span><span class="Comment">//: :(after "more events")</span> -<a name="L17"></a><span id="L17" class="LineNr"> 17 </span><span class="Comment">//: This directive means: insert the following lines after a line in the</span> -<a name="L18"></a><span id="L18" class="LineNr"> 18 </span><span class="Comment">//: program containing the words "more events".</span> -<a name="L19"></a><span id="L19" class="LineNr"> 19 </span><span class="Comment">//:</span> -<a name="L20"></a><span id="L20" class="LineNr"> 20 </span><span class="Comment">//: A simple tool is included to 'tangle' all the files together in sequence</span> -<a name="L21"></a><span id="L21" class="LineNr"> 21 </span><span class="Comment">//: according to their directives into a single source file containing all the</span> -<a name="L22"></a><span id="L22" class="LineNr"> 22 </span><span class="Comment">//: code for the project, and then feed the source file to the compiler.</span> -<a name="L23"></a><span id="L23" class="LineNr"> 23 </span><span class="Comment">//: (It'll drop these comments starting with a '//:' prefix that only make</span> -<a name="L24"></a><span id="L24" class="LineNr"> 24 </span><span class="Comment">//: sense before tangling.)</span> -<a name="L25"></a><span id="L25" class="LineNr"> 25 </span><span class="Comment">//:</span> -<a name="L26"></a><span id="L26" class="LineNr"> 26 </span><span class="Comment">//: Directives free up the programmer to order code for others to read rather</span> -<a name="L27"></a><span id="L27" class="LineNr"> 27 </span><span class="Comment">//: than as forced by the computer or compiler. Each individual feature can be</span> -<a name="L28"></a><span id="L28" class="LineNr"> 28 </span><span class="Comment">//: organized in a self-contained 'layer' that adds code to many different data</span> -<a name="L29"></a><span id="L29" class="LineNr"> 29 </span><span class="Comment">//: structures and functions all over the program. The right decomposition into</span> -<a name="L30"></a><span id="L30" class="LineNr"> 30 </span><span class="Comment">//: layers will let each layer make sense in isolation.</span> -<a name="L31"></a><span id="L31" class="LineNr"> 31 </span><span class="Comment">//:</span> -<a name="L32"></a><span id="L32" class="LineNr"> 32 </span><span class="Comment">//: "If I look at any small part of it, I can see what is going on -- I don't</span> -<a name="L33"></a><span id="L33" class="LineNr"> 33 </span><span class="Comment">//: need to refer to other parts to understand what something is doing.</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">//: If I look at any large part in overview, I can see what is going on -- I</span> -<a name="L36"></a><span id="L36" class="LineNr"> 36 </span><span class="Comment">//: don't need to know all the details to get it.</span> -<a name="L37"></a><span id="L37" class="LineNr"> 37 </span><span class="Comment">//:</span> -<a name="L38"></a><span id="L38" class="LineNr"> 38 </span><span class="Comment">//: Every level of detail is as locally coherent and as well thought-out as</span> -<a name="L39"></a><span id="L39" class="LineNr"> 39 </span><span class="Comment">//: any other level."</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">//: -- Richard Gabriel, "The Quality Without A Name"</span> -<a name="L42"></a><span id="L42" class="LineNr"> 42 </span><span class="Comment">//: (<a href="http://dreamsongs.com/Files/PatternsOfSoftware.pdf">http://dreamsongs.com/Files/PatternsOfSoftware.pdf</a>, page 42)</span> -<a name="L43"></a><span id="L43" class="LineNr"> 43 </span><span class="Comment">//:</span> -<a name="L44"></a><span id="L44" class="LineNr"> 44 </span><span class="Comment">//: Directives are powerful; they permit inserting or modifying any point in</span> -<a name="L45"></a><span id="L45" class="LineNr"> 45 </span><span class="Comment">//: the program. Using them tastefully requires mapping out specific lines as</span> -<a name="L46"></a><span id="L46" class="LineNr"> 46 </span><span class="Comment">//: waypoints for future layers to hook into. Often such waypoints will be in</span> -<a name="L47"></a><span id="L47" class="LineNr"> 47 </span><span class="Comment">//: comments, capitalized to hint that other layers rely on their presence.</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">//: A single waypoint might have many different code fragments hooking into</span> -<a name="L50"></a><span id="L50" class="LineNr"> 50 </span><span class="Comment">//: it from all over the codebase. Use 'before' directives to insert</span> -<a name="L51"></a><span id="L51" class="LineNr"> 51 </span><span class="Comment">//: code at a location in order, top to bottom, and 'after' directives to</span> -<a name="L52"></a><span id="L52" class="LineNr"> 52 </span><span class="Comment">//: insert code in reverse order. By convention waypoints intended for insertion</span> -<a name="L53"></a><span id="L53" class="LineNr"> 53 </span><span class="Comment">//: before begin with 'End'. Notice below how the layers line up above the "End</span> -<a name="L54"></a><span id="L54" class="LineNr"> 54 </span><span class="Comment">//: Foo" waypoint.</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">//: File 001 File 002 File 003</span> -<a name="L57"></a><span id="L57" class="LineNr"> 57 </span><span class="Comment">//: ============ =================== ===================</span> -<a name="L58"></a><span id="L58" class="LineNr"> 58 </span><span class="Comment">//: // Foo</span> -<a name="L59"></a><span id="L59" class="LineNr"> 59 </span><span class="Comment">//: ------------</span> -<a name="L60"></a><span id="L60" class="LineNr"> 60 </span><span class="Comment">//: <---- :(before "End Foo")</span> -<a name="L61"></a><span id="L61" class="LineNr"> 61 </span><span class="Comment">//: ....</span> -<a name="L62"></a><span id="L62" class="LineNr"> 62 </span><span class="Comment">//: ...</span> -<a name="L63"></a><span id="L63" class="LineNr"> 63 </span><span class="Comment">//: ------------</span> -<a name="L64"></a><span id="L64" class="LineNr"> 64 </span><span class="Comment">//: <---------------------------- :(before "End Foo")</span> -<a name="L65"></a><span id="L65" class="LineNr"> 65 </span><span class="Comment">//: ....</span> -<a name="L66"></a><span id="L66" class="LineNr"> 66 </span><span class="Comment">//: ...</span> -<a name="L67"></a><span id="L67" class="LineNr"> 67 </span><span class="Comment">//: // End Foo</span> -<a name="L68"></a><span id="L68" class="LineNr"> 68 </span><span class="Comment">//: ============</span> -<a name="L69"></a><span id="L69" class="LineNr"> 69 </span><span class="Comment">//:</span> -<a name="L70"></a><span id="L70" class="LineNr"> 70 </span><span class="Comment">//: Here's part of a layer in color: <a href="http://i.imgur.com/0eONnyX.png">http://i.imgur.com/0eONnyX.png</a>. Directives</span> -<a name="L71"></a><span id="L71" class="LineNr"> 71 </span><span class="Comment">//: are shaded dark.</span> -<a name="L72"></a><span id="L72" class="LineNr"> 72 </span><span class="Comment">//:</span> -<a name="L73"></a><span id="L73" class="LineNr"> 73 </span><span class="Comment">//: Layers do more than just shuffle code around. In a well-organized codebase</span> -<a name="L74"></a><span id="L74" class="LineNr"> 74 </span><span class="Comment">//: it should be possible to stop loading after any file/layer, build and run</span> -<a name="L75"></a><span id="L75" class="LineNr"> 75 </span><span class="Comment">//: the program, and pass all tests for loaded features. (Relevant is</span> -<a name="L76"></a><span id="L76" class="LineNr"> 76 </span><span class="Comment">//: <a href="http://youtube.com/watch?v=c8N72t7aScY">http://youtube.com/watch?v=c8N72t7aScY</a>, a scene from "2001: A Space</span> -<a name="L77"></a><span id="L77" class="LineNr"> 77 </span><span class="Comment">//: Odyssey".) Get into the habit of running the included script called</span> -<a name="L78"></a><span id="L78" class="LineNr"> 78 </span><span class="Comment">//: 'test_layers' before you commit any changes.</span> -<a name="L79"></a><span id="L79" class="LineNr"> 79 </span><span class="Comment">//:</span> -<a name="L80"></a><span id="L80" class="LineNr"> 80 </span><span class="Comment">//: This 'subsetting guarantee' ensures that this directory contains a</span> -<a name="L81"></a><span id="L81" class="LineNr"> 81 </span><span class="Comment">//: cleaned-up narrative of the evolution of this codebase. Organizing</span> -<a name="L82"></a><span id="L82" class="LineNr"> 82 </span><span class="Comment">//: autobiographically allows a newcomer to rapidly orient himself, reading the</span> -<a name="L83"></a><span id="L83" class="LineNr"> 83 </span><span class="Comment">//: first few files to understand a simple gestalt of a program's core purpose</span> -<a name="L84"></a><span id="L84" class="LineNr"> 84 </span><span class="Comment">//: and features, and later gradually working his way through other features as</span> -<a name="L85"></a><span id="L85" class="LineNr"> 85 </span><span class="Comment">//: the need arises.</span> -<a name="L86"></a><span id="L86" class="LineNr"> 86 </span><span class="Comment">//:</span> -<a name="L87"></a><span id="L87" class="LineNr"> 87 </span><span class="Comment">//: Programmers shouldn't need to understand everything about a program to hack</span> -<a name="L88"></a><span id="L88" class="LineNr"> 88 </span><span class="Comment">//: on it. But they shouldn't be prevented from a thorough understanding of</span> -<a name="L89"></a><span id="L89" class="LineNr"> 89 </span><span class="Comment">//: each aspect either. The goal of layers is to reward curiosity.</span> -<a name="L90"></a><span id="L90" class="LineNr"> 90 </span> -<a name="L91"></a><span id="L91" class="LineNr"> 91 </span><span class="Comment">// Includes</span> -<a name="L92"></a><span id="L92" class="LineNr"> 92 </span><span class="Comment">// End Includes</span> -<a name="L93"></a><span id="L93" class="LineNr"> 93 </span> -<a name="L94"></a><span id="L94" class="LineNr"> 94 </span><span class="Comment">// Types</span> -<a name="L95"></a><span id="L95" class="LineNr"> 95 </span><span class="Comment">// End Types</span> -<a name="L96"></a><span id="L96" class="LineNr"> 96 </span> -<a name="L97"></a><span id="L97" class="LineNr"> 97 </span><span class="Comment">// Prototypes are auto-generated in the 'build' script; define your functions</span> -<a name="L98"></a><span id="L98" class="LineNr"> 98 </span><span class="Comment">// in any order. Just be sure to declare each function header all on one line.</span> -<a name="L99"></a><span id="L99" class="LineNr"> 99 </span><span class="Comment">// Our auto-generation scripts are too minimal and simple-minded to handle</span> -<a name="L100"></a><span id="L100" class="LineNr">100 </span><span class="Comment">// anything else.</span> -<a name="L101"></a><span id="L101" class="LineNr">101 </span><span class="PreProc">#include </span><span class="Constant">"function_list"</span> <span class="Comment">// by convention, files ending with '_list' are auto-generated</span> -<a name="L102"></a><span id="L102" class="LineNr">102 </span> -<a name="L103"></a><span id="L103" class="LineNr">103 </span><span class="Comment">// Globals</span> -<a name="L104"></a><span id="L104" class="LineNr">104 </span><span class="Comment">//</span> -<a name="L105"></a><span id="L105" class="LineNr">105 </span><span class="Comment">// All statements in this section should always define a single variable on a</span> -<a name="L106"></a><span id="L106" class="LineNr">106 </span><span class="Comment">// single line. The 'build' script will simple-mindedly auto-generate extern</span> -<a name="L107"></a><span id="L107" class="LineNr">107 </span><span class="Comment">// declarations for them. Don't forget to define (not just declare) constants</span> -<a name="L108"></a><span id="L108" class="LineNr">108 </span><span class="Comment">// with extern linkage in this section, since C++ global constants have</span> -<a name="L109"></a><span id="L109" class="LineNr">109 </span><span class="Comment">// internal linkage by default.</span> -<a name="L110"></a><span id="L110" class="LineNr">110 </span><span class="Comment">//</span> -<a name="L111"></a><span id="L111" class="LineNr">111 </span><span class="Comment">// End Globals</span> -<a name="L112"></a><span id="L112" class="LineNr">112 </span> -<a name="L113"></a><span id="L113" class="LineNr">113 </span><span class="Normal">int</span> main<span class="Delimiter">(</span><span class="Normal">int</span> argc<span class="Delimiter">,</span> <span class="Normal">char</span>* argv[]<span class="Delimiter">)</span> <span class="Delimiter">{</span> -<a name="L114"></a><span id="L114" class="LineNr">114 </span> atexit<span class="Delimiter">(</span>teardown<span class="Delimiter">);</span> -<a name="L115"></a><span id="L115" class="LineNr">115 </span> -<a name="L116"></a><span id="L116" class="LineNr">116 </span> <span class="Comment">// End One-time Setup</span> -<a name="L117"></a><span id="L117" class="LineNr">117 </span> -<a name="L118"></a><span id="L118" class="LineNr">118 </span> <span class="Comment">// Commandline Parsing</span> -<a name="L119"></a><span id="L119" class="LineNr">119 </span> <span class="Comment">// End Commandline Parsing</span> -<a name="L120"></a><span id="L120" class="LineNr">120 </span> -<a name="L121"></a><span id="L121" class="LineNr">121 </span> <span class="Identifier">return</span> <span class="Constant">0</span><span class="Delimiter">;</span> <span class="Comment">// End Main</span> -<a name="L122"></a><span id="L122" class="LineNr">122 </span><span class="Delimiter">}</span> -<a name="L123"></a><span id="L123" class="LineNr">123 </span> -<a name="L124"></a><span id="L124" class="LineNr">124 </span><span class="Comment">// Unit Tests</span> -<a name="L125"></a><span id="L125" class="LineNr">125 </span><span class="Comment">// End Unit Tests</span> -<a name="L126"></a><span id="L126" class="LineNr">126 </span> -<a name="L127"></a><span id="L127" class="LineNr">127 </span><span class="Comment">//: our first directive; will move the include above the program</span> -<a name="L128"></a><span id="L128" class="LineNr">128 </span><span class="Delimiter">:(before "End Includes")</span> -<a name="L129"></a><span id="L129" class="LineNr">129 </span><span class="PreProc">#include </span><span class="Constant"><stdlib.h></span> -<a name="L130"></a><span id="L130" class="LineNr">130 </span> -<a name="L131"></a><span id="L131" class="LineNr">131 </span><span class="Comment">//: Without directives or with the :(code) directive, lines get added at the</span> -<a name="L132"></a><span id="L132" class="LineNr">132 </span><span class="Comment">//: end.</span> -<a name="L133"></a><span id="L133" class="LineNr">133 </span><span class="Delimiter">:(code)</span> -<a name="L134"></a><span id="L134" class="LineNr">134 </span><span class="Normal">void</span> setup<span class="Delimiter">()</span> <span class="Delimiter">{</span> -<a name="L135"></a><span id="L135" class="LineNr">135 </span> <span class="Comment">// End Setup</span> -<a name="L136"></a><span id="L136" class="LineNr">136 </span><span class="Delimiter">}</span> -<a name="L137"></a><span id="L137" class="LineNr">137 </span> -<a name="L138"></a><span id="L138" class="LineNr">138 </span><span class="Normal">void</span> teardown<span class="Delimiter">()</span> <span class="Delimiter">{</span> -<a name="L139"></a><span id="L139" class="LineNr">139 </span> <span class="Comment">// End Teardown</span> -<a name="L140"></a><span id="L140" class="LineNr">140 </span><span class="Delimiter">}</span> +<span id="L1" class="LineNr"> 1 </span><span class="Comment">//: You guessed right: the '000' prefix means you should start reading here.</span> +<span id="L2" class="LineNr"> 2 </span><span class="Comment">//:</span> +<span id="L3" class="LineNr"> 3 </span><span class="Comment">//: This project is set up to load all files with a numeric prefix. Just</span> +<span id="L4" class="LineNr"> 4 </span><span class="Comment">//: create a new file and start hacking.</span> +<span id="L5" class="LineNr"> 5 </span><span class="Comment">//:</span> +<span id="L6" class="LineNr"> 6 </span><span class="Comment">//: The first few files (00*) are independent of what this program does, an</span> +<span id="L7" class="LineNr"> 7 </span><span class="Comment">//: experimental skeleton that will hopefully make it both easier for others to</span> +<span id="L8" class="LineNr"> 8 </span><span class="Comment">//: understand and more malleable, easier to rewrite and remould into radically</span> +<span id="L9" class="LineNr"> 9 </span><span class="Comment">//: different shapes without breaking in subtle corner cases. The premise is</span> +<span id="L10" class="LineNr"> 10 </span><span class="Comment">//: that understandability and rewrite-friendliness are related in a virtuous</span> +<span id="L11" class="LineNr"> 11 </span><span class="Comment">//: cycle. Doing one well makes it easier to do the other.</span> +<span id="L12" class="LineNr"> 12 </span><span class="Comment">//:</span> +<span id="L13" class="LineNr"> 13 </span><span class="Comment">//: Lower down, this file contains a legal, bare-bones C++ program. It doesn't</span> +<span id="L14" class="LineNr"> 14 </span><span class="Comment">//: do anything yet; subsequent files will contain :(...) directives to insert</span> +<span id="L15" class="LineNr"> 15 </span><span class="Comment">//: lines into it. For example:</span> +<span id="L16" class="LineNr"> 16 </span><span class="Comment">//: :(after "more events")</span> +<span id="L17" class="LineNr"> 17 </span><span class="Comment">//: This directive means: insert the following lines after a line in the</span> +<span id="L18" class="LineNr"> 18 </span><span class="Comment">//: program containing the words "more events".</span> +<span id="L19" class="LineNr"> 19 </span><span class="Comment">//:</span> +<span id="L20" class="LineNr"> 20 </span><span class="Comment">//: A simple tool is included to 'tangle' all the files together in sequence</span> +<span id="L21" class="LineNr"> 21 </span><span class="Comment">//: according to their directives into a single source file containing all the</span> +<span id="L22" class="LineNr"> 22 </span><span class="Comment">//: code for the project, and then feed the source file to the compiler.</span> +<span id="L23" class="LineNr"> 23 </span><span class="Comment">//: (It'll drop these comments starting with a '//:' prefix that only make</span> +<span id="L24" class="LineNr"> 24 </span><span class="Comment">//: sense before tangling.)</span> +<span id="L25" class="LineNr"> 25 </span><span class="Comment">//:</span> +<span id="L26" class="LineNr"> 26 </span><span class="Comment">//: Directives free up the programmer to order code for others to read rather</span> +<span id="L27" class="LineNr"> 27 </span><span class="Comment">//: than as forced by the computer or compiler. Each individual feature can be</span> +<span id="L28" class="LineNr"> 28 </span><span class="Comment">//: organized in a self-contained 'layer' that adds code to many different data</span> +<span id="L29" class="LineNr"> 29 </span><span class="Comment">//: structures and functions all over the program. The right decomposition into</span> +<span id="L30" class="LineNr"> 30 </span><span class="Comment">//: layers will let each layer make sense in isolation.</span> +<span id="L31" class="LineNr"> 31 </span><span class="Comment">//:</span> +<span id="L32" class="LineNr"> 32 </span><span class="Comment">//: "If I look at any small part of it, I can see what is going on -- I don't</span> +<span id="L33" class="LineNr"> 33 </span><span class="Comment">//: need to refer to other parts to understand what something is doing.</span> +<span id="L34" class="LineNr"> 34 </span><span class="Comment">//:</span> +<span id="L35" class="LineNr"> 35 </span><span class="Comment">//: If I look at any large part in overview, I can see what is going on -- I</span> +<span id="L36" class="LineNr"> 36 </span><span class="Comment">//: don't need to know all the details to get it.</span> +<span id="L37" class="LineNr"> 37 </span><span class="Comment">//:</span> +<span id="L38" class="LineNr"> 38 </span><span class="Comment">//: Every level of detail is as locally coherent and as well thought-out as</span> +<span id="L39" class="LineNr"> 39 </span><span class="Comment">//: any other level."</span> +<span id="L40" class="LineNr"> 40 </span><span class="Comment">//:</span> +<span id="L41" class="LineNr"> 41 </span><span class="Comment">//: -- Richard Gabriel, "The Quality Without A Name"</span> +<span id="L42" class="LineNr"> 42 </span><span class="Comment">//: (<a href="http://dreamsongs.com/Files/PatternsOfSoftware.pdf">http://dreamsongs.com/Files/PatternsOfSoftware.pdf</a>, page 42)</span> +<span id="L43" class="LineNr"> 43 </span><span class="Comment">//:</span> +<span id="L44" class="LineNr"> 44 </span><span class="Comment">//: Directives are powerful; they permit inserting or modifying any point in</span> +<span id="L45" class="LineNr"> 45 </span><span class="Comment">//: the program. Using them tastefully requires mapping out specific lines as</span> +<span id="L46" class="LineNr"> 46 </span><span class="Comment">//: waypoints for future layers to hook into. Often such waypoints will be in</span> +<span id="L47" class="LineNr"> 47 </span><span class="Comment">//: comments, capitalized to hint that other layers rely on their presence.</span> +<span id="L48" class="LineNr"> 48 </span><span class="Comment">//:</span> +<span id="L49" class="LineNr"> 49 </span><span class="Comment">//: A single waypoint might have many different code fragments hooking into</span> +<span id="L50" class="LineNr"> 50 </span><span class="Comment">//: it from all over the codebase. Use 'before' directives to insert</span> +<span id="L51" class="LineNr"> 51 </span><span class="Comment">//: code at a location in order, top to bottom, and 'after' directives to</span> +<span id="L52" class="LineNr"> 52 </span><span class="Comment">//: insert code in reverse order. By convention waypoints intended for insertion</span> +<span id="L53" class="LineNr"> 53 </span><span class="Comment">//: before begin with 'End'. Notice below how the layers line up above the "End</span> +<span id="L54" class="LineNr"> 54 </span><span class="Comment">//: Foo" waypoint.</span> +<span id="L55" class="LineNr"> 55 </span><span class="Comment">//:</span> +<span id="L56" class="LineNr"> 56 </span><span class="Comment">//: File 001 File 002 File 003</span> +<span id="L57" class="LineNr"> 57 </span><span class="Comment">//: ============ =================== ===================</span> +<span id="L58" class="LineNr"> 58 </span><span class="Comment">//: // Foo</span> +<span id="L59" class="LineNr"> 59 </span><span class="Comment">//: ------------</span> +<span id="L60" class="LineNr"> 60 </span><span class="Comment">//: <---- :(before "End Foo")</span> +<span id="L61" class="LineNr"> 61 </span><span class="Comment">//: ....</span> +<span id="L62" class="LineNr"> 62 </span><span class="Comment">//: ...</span> +<span id="L63" class="LineNr"> 63 </span><span class="Comment">//: ------------</span> +<span id="L64" class="LineNr"> 64 </span><span class="Comment">//: <---------------------------- :(before "End Foo")</span> +<span id="L65" class="LineNr"> 65 </span><span class="Comment">//: ....</span> +<span id="L66" class="LineNr"> 66 </span><span class="Comment">//: ...</span> +<span id="L67" class="LineNr"> 67 </span><span class="Comment">//: // End Foo</span> +<span id="L68" class="LineNr"> 68 </span><span class="Comment">//: ============</span> +<span id="L69" class="LineNr"> 69 </span><span class="Comment">//:</span> +<span id="L70" class="LineNr"> 70 </span><span class="Comment">//: Here's part of a layer in color: <a href="http://i.imgur.com/0eONnyX.png">http://i.imgur.com/0eONnyX.png</a>. Directives</span> +<span id="L71" class="LineNr"> 71 </span><span class="Comment">//: are shaded dark.</span> +<span id="L72" class="LineNr"> 72 </span><span class="Comment">//:</span> +<span id="L73" class="LineNr"> 73 </span><span class="Comment">//: Layers do more than just shuffle code around. In a well-organized codebase</span> +<span id="L74" class="LineNr"> 74 </span><span class="Comment">//: it should be possible to stop loading after any file/layer, build and run</span> +<span id="L75" class="LineNr"> 75 </span><span class="Comment">//: the program, and pass all tests for loaded features. (Relevant is</span> +<span id="L76" class="LineNr"> 76 </span><span class="Comment">//: <a href="http://youtube.com/watch?v=c8N72t7aScY">http://youtube.com/watch?v=c8N72t7aScY</a>, a scene from "2001: A Space</span> +<span id="L77" class="LineNr"> 77 </span><span class="Comment">//: Odyssey".) Get into the habit of running the included script called</span> +<span id="L78" class="LineNr"> 78 </span><span class="Comment">//: 'test_layers' before you commit any changes.</span> +<span id="L79" class="LineNr"> 79 </span><span class="Comment">//:</span> +<span id="L80" class="LineNr"> 80 </span><span class="Comment">//: This 'subsetting guarantee' ensures that this directory contains a</span> +<span id="L81" class="LineNr"> 81 </span><span class="Comment">//: cleaned-up narrative of the evolution of this codebase. Organizing</span> +<span id="L82" class="LineNr"> 82 </span><span class="Comment">//: autobiographically allows a newcomer to rapidly orient himself, reading the</span> +<span id="L83" class="LineNr"> 83 </span><span class="Comment">//: first few files to understand a simple gestalt of a program's core purpose</span> +<span id="L84" class="LineNr"> 84 </span><span class="Comment">//: and features, and later gradually working his way through other features as</span> +<span id="L85" class="LineNr"> 85 </span><span class="Comment">//: the need arises.</span> +<span id="L86" class="LineNr"> 86 </span><span class="Comment">//:</span> +<span id="L87" class="LineNr"> 87 </span><span class="Comment">//: Programmers shouldn't need to understand everything about a program to hack</span> +<span id="L88" class="LineNr"> 88 </span><span class="Comment">//: on it. But they shouldn't be prevented from a thorough understanding of</span> +<span id="L89" class="LineNr"> 89 </span><span class="Comment">//: each aspect either. The goal of layers is to reward curiosity.</span> +<span id="L90" class="LineNr"> 90 </span> +<span id="L91" class="LineNr"> 91 </span><span class="Comment">// Includes</span> +<span id="L92" class="LineNr"> 92 </span><span class="Comment">// End Includes</span> +<span id="L93" class="LineNr"> 93 </span> +<span id="L94" class="LineNr"> 94 </span><span class="Comment">// Types</span> +<span id="L95" class="LineNr"> 95 </span><span class="Comment">// End Types</span> +<span id="L96" class="LineNr"> 96 </span> +<span id="L97" class="LineNr"> 97 </span><span class="Comment">// Prototypes are auto-generated in the 'build' script; define your functions</span> +<span id="L98" class="LineNr"> 98 </span><span class="Comment">// in any order. Just be sure to declare each function header all on one line.</span> +<span id="L99" class="LineNr"> 99 </span><span class="Comment">// Our auto-generation scripts are too minimal and simple-minded to handle</span> +<span id="L100" class="LineNr">100 </span><span class="Comment">// anything else.</span> +<span id="L101" class="LineNr">101 </span><span class="PreProc">#include </span><span class="Constant">"function_list"</span> <span class="Comment">// by convention, files ending with '_list' are auto-generated</span> +<span id="L102" class="LineNr">102 </span> +<span id="L103" class="LineNr">103 </span><span class="Comment">// Globals</span> +<span id="L104" class="LineNr">104 </span><span class="Comment">//</span> +<span id="L105" class="LineNr">105 </span><span class="Comment">// All statements in this section should always define a single variable on a</span> +<span id="L106" class="LineNr">106 </span><span class="Comment">// single line. The 'build' script will simple-mindedly auto-generate extern</span> +<span id="L107" class="LineNr">107 </span><span class="Comment">// declarations for them. Don't forget to define (not just declare) constants</span> +<span id="L108" class="LineNr">108 </span><span class="Comment">// with extern linkage in this section, since C++ global constants have</span> +<span id="L109" class="LineNr">109 </span><span class="Comment">// internal linkage by default.</span> +<span id="L110" class="LineNr">110 </span><span class="Comment">//</span> +<span id="L111" class="LineNr">111 </span><span class="Comment">// End Globals</span> +<span id="L112" class="LineNr">112 </span> +<span id="L113" class="LineNr">113 </span><span class="Normal">int</span> main<span class="Delimiter">(</span><span class="Normal">int</span> argc<span class="Delimiter">,</span> <span class="Normal">char</span>* argv[]<span class="Delimiter">)</span> <span class="Delimiter">{</span> +<span id="L114" class="LineNr">114 </span> atexit<span class="Delimiter">(</span>teardown<span class="Delimiter">);</span> +<span id="L115" class="LineNr">115 </span> +<span id="L116" class="LineNr">116 </span> <span class="Comment">// End One-time Setup</span> +<span id="L117" class="LineNr">117 </span> +<span id="L118" class="LineNr">118 </span> <span class="Comment">// Commandline Parsing</span> +<span id="L119" class="LineNr">119 </span> <span class="Comment">// End Commandline Parsing</span> +<span id="L120" class="LineNr">120 </span> +<span id="L121" class="LineNr">121 </span> <span class="Identifier">return</span> <span class="Constant">0</span><span class="Delimiter">;</span> <span class="Comment">// End Main</span> +<span id="L122" class="LineNr">122 </span><span class="Delimiter">}</span> +<span id="L123" class="LineNr">123 </span> +<span id="L124" class="LineNr">124 </span><span class="Comment">// Unit Tests</span> +<span id="L125" class="LineNr">125 </span><span class="Comment">// End Unit Tests</span> +<span id="L126" class="LineNr">126 </span> +<span id="L127" class="LineNr">127 </span><span class="Comment">//: our first directive; will move the include above the program</span> +<span id="L128" class="LineNr">128 </span><span class="Delimiter">:(before "End Includes")</span> +<span id="L129" class="LineNr">129 </span><span class="PreProc">#include </span><span class="Constant"><stdlib.h></span> +<span id="L130" class="LineNr">130 </span> +<span id="L131" class="LineNr">131 </span><span class="Comment">//: Without directives or with the :(code) directive, lines get added at the</span> +<span id="L132" class="LineNr">132 </span><span class="Comment">//: end.</span> +<span id="L133" class="LineNr">133 </span><span class="Delimiter">:(code)</span> +<span id="L134" class="LineNr">134 </span><span class="Normal">void</span> setup<span class="Delimiter">()</span> <span class="Delimiter">{</span> +<span id="L135" class="LineNr">135 </span> <span class="Comment">// End Setup</span> +<span id="L136" class="LineNr">136 </span><span class="Delimiter">}</span> +<span id="L137" class="LineNr">137 </span> +<span id="L138" class="LineNr">138 </span><span class="Normal">void</span> teardown<span class="Delimiter">()</span> <span class="Delimiter">{</span> +<span id="L139" class="LineNr">139 </span> <span class="Comment">// End Teardown</span> +<span id="L140" class="LineNr">140 </span><span class="Delimiter">}</span> </pre> </body> </html> |