about summary refs log blame commit diff stats
path: root/html/real-files.mu.html
blob: 10d67c908ed8e04e7c414ac129fe782fc0abe97d (plain) (tree)
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Mu - 000organization.cc</title>
<meta name="Generator" content="Vim/8.0">
<meta name="plugin-version" content="vim7.4_v2">
<meta name="syntax" content="cpp">
<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">
<!--
pre { white-space: pre-wrap; font-family: monospace; color: #aaaaaa; background-color: #080808; }
body { font-size:12pt; font-family: monospace; color: #aaaaaa; background-color: #080808; }
.subxS2Comment a { color:inherit; }
.subxS1Comment a { color:inherit; }
.subxComment a { color:inheri
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Mu - real-files.mu</title>
<meta name="Generator" content="Vim/8.0">
<meta name="plugin-version" content="vim7.4_v2">
<meta name="syntax" content="none">
<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">
<!--
pre { white-space: pre-wrap; font-family: monospace; color: #aaaaaa; background-color: #080808; }
body { font-size:12pt; font-family: monospace; color: #aaaaaa; background-color: #080808; }
.subxS2Comment a { color:inherit; }
.subxS1Comment a { color:inherit; }
.subxComment a { color:inherit; }
.subxH2Comment a { color:inherit; }
.subxH1Comment a { color:inherit; }
* { font-size:12pt; font-size: 1em; }
.muRecipe { color: #ff8700; }
.LineNr { color:#444444; }
.Constant { color:#00a0a0; }
.Special { color:#c00000; }
.Comment { color: #8080ff; }
-->
</style>

<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 onload='JumpToLine();'>
<a href='https://github.com/akkartik/mu/blob/master/real-files.mu'>https://github.com/akkartik/mu/blob/master/real-files.mu</a>
<pre id='vimCodeElement'>
<span id="L1" class="LineNr"> 1 </span><span class="Comment"># example program: read a character from one file and write it to another</span>
<span id="L2" class="LineNr"> 2 </span><span class="Comment"># BEWARE: this will modify your file system</span>
<span id="L3" class="LineNr"> 3 </span><span class="Comment"># before running it, put a character into /tmp/mu-x</span>
<span id="L4" class="LineNr"> 4 </span><span class="Comment"># after running it, check /tmp/mu-y</span>
<span id="L5" class="LineNr"> 5 </span>
<span id="L6" class="LineNr"> 6 </span><span class="muRecipe">def</span> <a href='real-files.mu.html#L6'>main</a> [
<span id="L7" class="LineNr"> 7 </span>  <span class="Constant">local-scope</span>
<span id="L8" class="LineNr"> 8 </span>  f:num/file <span class="Special">&lt;-</span> $open-file-for-reading <span class="Constant">[/tmp/mu-x]</span>
<span id="L9" class="LineNr"> 9 </span>  $print <span class="Constant">[file to read from: ]</span>, f, <span class="Constant">10/newline</span>
<span id="L10" class="LineNr">10 </span>  c:char, eof?:bool <span class="Special">&lt;-</span> $read-from-file f
<span id="L11" class="LineNr">11 </span>  $print <span class="Constant">[copying ]</span>, c, <span class="Constant">10/newline</span>
<span id="L12" class="LineNr">12 </span>  f <span class="Special">&lt;-</span> $close-file f
<span id="L13" class="LineNr">13 </span>  $print <span class="Constant">[file after closing: ]</span>, f, <span class="Constant">10/newline</span>
<span id="L14" class="LineNr">14 </span>  f <span class="Special">&lt;-</span> $open-file-for-writing <span class="Constant">[/tmp/mu-y]</span>
<span id="L15" class="LineNr">15 </span>  $print <span class="Constant">[file to <a href='075channel.mu.html#L60'>write</a> to: ]</span>, f, <span class="Constant">10/newline</span>
<span id="L16" class="LineNr">16 </span>  $write-to-file f, c
<span id="L17" class="LineNr">17 </span>  f <span class="Special">&lt;-</span> $close-file f
<span id="L18" class="LineNr">18 </span>]
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->
;//: 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.&quot;</span> <span id="L40" class="LineNr"> 40 </span><span class="Comment">//:</span> <span id="L41" class="LineNr"> 41 </span><span class="Comment">//: -- Richard Gabriel, &quot;The Quality Without A Name&quot;</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 &quot;End</span> <span id="L54" class="LineNr"> 54 </span><span class="Comment">//: Foo&quot; 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">//: &lt;---- :(before &quot;End Foo&quot;)</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">//: &lt;---------------------------- :(before &quot;End Foo&quot;)</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 &quot;2001: A Space</span> <span id="L77" class="LineNr"> 77 </span><span class="Comment">//: Odyssey&quot;.) 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 newcomers to rapidly orient themselves, reading</span> <span id="L83" class="LineNr"> 83 </span><span class="Comment">//: the first few files to understand a simple gestalt of a program's core</span> <span id="L84" class="LineNr"> 84 </span><span class="Comment">//: purpose and features, and later gradually working their way through other</span> <span id="L85" class="LineNr"> 85 </span><span class="Comment">//: features as 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</span> <span id="L88" class="LineNr"> 88 </span><span class="Comment">//: hack on it. But they shouldn't be prevented from a thorough understanding</span> <span id="L89" class="LineNr"> 89 </span><span class="Comment">//: of 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">// Function prototypes are auto-generated in the 'build*' scripts; define your</span> <span id="L98" class="LineNr"> 98 </span><span class="Comment">// functions in any order. Just be sure to declare each function header all on</span> <span id="L99" class="LineNr"> 99 </span><span class="Comment">// one line, ending with the '{'. Our auto-generation scripts are too minimal</span> <span id="L100" class="LineNr">100 </span><span class="Comment">// and simple-minded to handle anything else.</span> <span id="L101" class="LineNr">101 </span><span class="Comment">#include &quot;function_list&quot; // 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*' scripts will simple-mindedly auto-generate extern</span> <span id="L107" class="LineNr">107 </span><span class="Comment">// declarations for them. Remember to define (not just declare) constants with</span> <span id="L108" class="LineNr">108 </span><span class="Comment">// extern linkage in this section, since C++ global constants have internal</span> <span id="L109" class="LineNr">109 </span><span class="Comment">// 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> <a href='000organization.cc.html#L113'>main</a><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><a href='000organization.cc.html#L134'>reset</a><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; insert the following header at the start of the program</span> <span id="L128" class="LineNr">128 </span><span class="Delimiter">:(before &quot;End Includes&quot;)</span> <span id="L129" class="LineNr">129 </span><span class="Comment">#include &lt;stdlib.h&gt;</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> <a href='000organization.cc.html#L134'>reset</a><span class="Delimiter">()</span> <span class="Delimiter">{</span> <span id="L135" class="LineNr">135 </span> <span class="Comment">// End Reset</span> <span id="L136" class="LineNr">136 </span><span class="Delimiter">}</span> </pre> </body> </html> <!-- vim: set foldmethod=manual : -->