summary refs log tree commit diff stats
path: root/make_doc.py
Commit message (Collapse)AuthorAgeFilesLines
* random updateshut2009-12-251-1/+1
|
* add documentation of some builtin moduleshut2009-12-111-0/+5
|
* make_doc.py to generate documentationhut2009-12-111-0/+23
-0700 .' href='/akkartik/mu/commit/html/106stream.subx.html?h=main&id=1fca8ee13c73790380fa2554c68ebf60c86e95d9'>1fca8ee1 ^
6e181e7f ^
1fca8ee1 ^
ec32c11d ^
1fca8ee1 ^
6e181e7f ^
dc5a0acf ^

6e181e7f ^

52e3ea8a ^
6e181e7f ^
52e3ea8a ^
60338448 ^
ce2c1efc ^
dc5a0acf ^
52e3ea8a ^
78357b88 ^
6e181e7f ^


1fca8ee1 ^
6e181e7f ^











ce2c1efc ^
6e181e7f ^















762107fd ^
6e181e7f ^



2104d1a7 ^

9a777801 ^
6e181e7f ^

9a777801 ^
6e181e7f ^
3350c34a ^


































































6e181e7f ^



1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
               

      
                      
                                  

                                                
                                   
                                                                                                                                
                                                 
       
    

                                                                                           

                                     
                                                              
                                
                                  
                                  
           
                             
                                                             
                                                                           


        
        











                                                                                 
                                                  















                                                                              
                                                                                                                             



                                                                                                                                              

                                                                                                                    
                                                                                                                           

                                                                                                                   
                                                                                                                                
                                                                                                                  


































































                                                                                                                                                                                                                                                                                                                                                                                                 



                                     
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Mu - 106stream.subx</title>
<meta name="Generator" content="Vim/8.2">
<meta name="plugin-version" content="vim8.1_v2">
<meta name="syntax" content="none">
<meta name="settings" content="number_lines,use_css,no_foldcolumn,expand_tabs,line_ids,prevent_copy=,use_input_for_pc=fallback">
<meta name="colorscheme" content="minimal-light">
<style>
<!--
pre { font-family: monospace; color: #000000; background-color: #ffffd7; }
body { font-size:12pt; font-family: monospace; color: #000000; background-color: #ffffd7; }
a { color:inherit; }
* { font-size:12pt; font-size: 1em; }
.subxH1Comment { color: #005faf; text-decoration: underline; }
.subxComment { color: #005faf; }
.subxS1Comment { color: #0000af; }
.subxS2Comment { color: #8a8a8a; }
.LineNr { }
.Constant { color: #008787; }
.subxFunction { color: #af5f00; text-decoration: underline; }
.Normal { color: #000000; background-color: #ffffd7; padding-bottom: 1px; }
-->
</style>

<script>
<!--

/* 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;
  }
  var 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/main/106stream.subx'>https://github.com/akkartik/mu/blob/main/106stream.subx</a>
<pre id='vimCodeElement'>
<span id="L1" class="LineNr"> 1 </span><span class="subxComment"># streams: data structure for operating on arrays in a stateful manner</span>
<span id="L2" class="LineNr"> 2 </span><span class="subxComment">#</span>
<span id="L3" class="LineNr"> 3 </span><span class="subxComment"># A stream looks like this:</span>
<span id="L4" class="LineNr"> 4 </span><span class="subxComment">#   write: int  # index at which writes go</span>
<span id="L5" class="LineNr"> 5 </span><span class="subxComment">#   read: int  # index that we've read until</span>
<span id="L6" class="LineNr"> 6 </span><span class="subxComment">#   data: (array byte)  # prefixed by size as usual</span>
<span id="L7" class="LineNr"> 7 </span><span class="subxComment">#</span>
<span id="L8" class="LineNr"> 8 </span><span class="subxComment"># some primitives for operating on streams:</span>
<span id="L9" class="LineNr"> 9 </span><span class="subxComment">#   - clear-stream (clears everything but the data size)</span>
<span id="L10" class="LineNr">10 </span><span class="subxComment">#   - rewind-stream (resets read pointer)</span>
<span id="L11" class="LineNr">11 </span><span class="subxComment">#</span>
<span id="L12" class="LineNr">12 </span><span class="subxComment"># We need to do this in machine code because streams need to be opaque types,</span>
<span id="L13" class="LineNr">13 </span><span class="subxComment"># and we don't yet support opaque types in Mu.</span>
<span id="L14" class="LineNr">14 </span>
<span id="L15" class="LineNr">15 </span>== code
<span id="L16" class="LineNr">16 </span><span class="subxComment">#   instruction                     effective address                                                   register    displacement    immediate</span>
<span id="L17" class="LineNr">17 </span><span class="subxS1Comment"># . op          subop               mod             rm32          base        index         scale       r32</span>
<span id="L18" class="LineNr">18 </span><span class="subxS1Comment"># . 1-3 bytes   3 bits              2 bits          3 bits        3 bits      3 bits        2 bits      2 bits      0/1/2/4 bytes   0/1/2/4 bytes</span>
<span id="L19" class="LineNr">19 </span>
<span id="L20" class="LineNr">20 </span><span class="subxFunction">clear-stream</span>:  <span class="subxComment"># f: (addr stream byte)</span>
<span id="L21" class="LineNr">21 </span>    <span class="subxS1Comment"># . prologue</span>
<span id="L22" class="LineNr">22 </span>    55/push-ebp
<span id="L23" class="LineNr">23 </span>    89/copy                         3/mod/direct    5/rm32/ebp   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          4/r32/esp  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy esp to ebp</span>
<span id="L24" class="LineNr">24 </span>    <span class="subxS1Comment"># . save registers</span>
<span id="L25" class="LineNr">25 </span>    50/push-eax
<span id="L26" class="LineNr">26 </span>    51/push-ecx
<span id="L27" class="LineNr">27 </span>    <span class="subxComment"># eax = f</span>
<span id="L28" class="LineNr">28 </span>    8b/copy                         1/mod/*+disp8   5/rm32/ebp   <span class="Normal"> . </span>         <span class="Normal"> . </span>                        0/r32/eax   8/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy *(ebp+8) to eax</span>
<span id="L29" class="LineNr">29 </span>    <span class="subxComment"># var count/ecx: int = f-&gt;size</span>
<span id="L30" class="LineNr">30 </span>    8b/copy                         1/mod/*+disp8   0/rm32/eax   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          1/r32/ecx   8/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy *(eax+8) to ecx</span>
<span id="L31" class="LineNr">31 </span>    <span class="subxComment"># var max/ecx: (addr byte) = &amp;f-&gt;data[f-&gt;size]</span>
<span id="L32" class="LineNr">32 </span>    8d/copy-address                 1/mod/*+disp8   4/rm32/sib    0/base/eax  1/index/ecx  <span class="Normal"> . </span>          1/r32/ecx   0xc/disp8      <span class="Normal"> . </span>                <span class="subxComment"># copy eax+ecx+12 to ecx</span>
<span id="L33" class="LineNr">33 </span>    <span class="subxComment"># f-&gt;write = 0</span>
<span id="L34" class="LineNr">34 </span>    c7          0/subop/copy        0/mod/direct    0/rm32/eax   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>         <span class="Normal"> . </span>              0/imm32           <span class="subxComment"># copy to *eax</span>
<span id="L35" class="LineNr">35 </span>    <span class="subxComment"># f-&gt;read = 0</span>
<span id="L36" class="LineNr">36 </span>    c7          0/subop/copy        1/mod/*+disp8   0/rm32/eax   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>          4/disp8         0/imm32           <span class="subxComment"># copy to *(eax+4)</span>
<span id="L37" class="LineNr">37 </span>    <span class="subxH1Comment"># - clear all stream data</span>
<span id="L38" class="LineNr">38 </span>    <span class="subxH1Comment"># - this isn't strictly necessary, and it can slow things down *a lot*, but better safe than sorry.</span>
<span id="L39" class="LineNr">39 </span>    <span class="subxComment"># var curr/eax: (addr byte) = f-&gt;data</span>
<span id="L40" class="LineNr">40 </span>    81          0/subop/add         3/mod/direct    0/rm32/eax   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>         <span class="Normal"> . </span>              0xc/imm32         <span class="subxComment"># add to eax</span>
<span id="L41" class="LineNr">41 </span><span class="Constant">$clear-stream:loop</span>:
<span id="L42" class="LineNr">42 </span>    <span class="subxComment"># if (curr &gt;= max) break</span>
<span id="L43" class="LineNr">43 </span>    39/compare                      3/mod/direct    0/rm32/eax   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          1/r32/ecx  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># compare eax with ecx</span>
<span id="L44" class="LineNr">44 </span>    73/jump-if-addr&gt;=  $clear-stream:end/disp8
<span id="L45" class="LineNr">45 </span>    <span class="subxComment"># *curr = 0</span>
<span id="L46" class="LineNr">46 </span>    c6          0/subop/copy-byte   0/mod/direct    0/rm32/eax   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>         <span class="Normal"> . </span>              0/imm8            <span class="subxComment"># copy byte to *eax</span>
<span id="L47" class="LineNr">47 </span>    <span class="subxComment"># ++curr</span>
<span id="L48" class="LineNr">48 </span>    40/increment-eax
<span id="L49" class="LineNr">49 </span>    eb/jump  $clear-stream:<span class="Constant">loop</span>/disp8
<span id="L50" class="LineNr">50 </span><span class="Constant">$clear-stream:end</span>:
<span id="L51" class="LineNr">51 </span>    <span class="subxS1Comment"># . restore registers</span>
<span id="L52" class="LineNr">52 </span>    59/pop-to-ecx
<span id="L53" class="LineNr">53 </span>    58/pop-to-eax
<span id="L54" class="LineNr">54 </span>    <span class="subxS1Comment"># . epilogue</span>
<span id="L55" class="LineNr">55 </span>    89/copy                         3/mod/direct    4/rm32/esp   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          5/r32/ebp  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy ebp to esp</span>
<span id="L56" class="LineNr">56 </span>    5d/pop-to-ebp
<span id="L57" class="LineNr">57 </span>    c3/return
<span id="L58" class="LineNr">58 </span>
<span id="L59" class="LineNr">59 </span><span class="subxFunction">rewind-stream</span>:  <span class="subxComment"># f: (addr stream byte)</span>
<span id="L60" class="LineNr">60 </span>    <span class="subxS1Comment"># . prologue</span>
<span id="L61" class="LineNr">61 </span>    55/push-ebp
<span id="L62" class="LineNr">62 </span>    89/copy                         3/mod/direct    5/rm32/ebp   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          4/r32/esp  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy esp to ebp</span>
<span id="L63" class="LineNr">63 </span>    <span class="subxS1Comment"># . save registers</span>
<span id="L64" class="LineNr">64 </span>    50/push-eax
<span id="L65" class="LineNr">65 </span>    <span class="subxComment"># eax = f</span>
<span id="L66" class="LineNr">66 </span>    8b/copy                         1/mod/*+disp8   5/rm32/ebp   <span class="Normal"> . </span>         <span class="Normal"> . </span>                        0/r32/eax   8/disp8        <span class="Normal"> . </span>                <span class="subxComment"># copy *(ebp+8) to eax</span>
<span id="L67" class="LineNr">67 </span>    <span class="subxComment"># f-&gt;read = 0</span>
<span id="L68" class="LineNr">68 </span>    c7          0/subop/copy        1/mod/*+disp8   0/rm32/eax   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>         <span class="Normal"> . </span>          4/disp8         0/imm32           <span class="subxComment"># copy to *(eax+4)</span>
<span id="L69" class="LineNr">69 </span><span class="Constant">$rewind-stream:end</span>:
<span id="L70" class="LineNr">70 </span>    <span class="subxS1Comment"># . restore registers</span>
<span id="L71" class="LineNr">71 </span>    58/pop-to-eax
<span id="L72" class="LineNr">72 </span>    <span class="subxS1Comment"># . epilogue</span>
<span id="L73" class="LineNr">73 </span>    89/copy                         3/mod/direct    4/rm32/esp   <span class="Normal"> . </span>         <span class="Normal"> . </span>           <span class="Normal"> . </span>          5/r32/ebp  <span class="Normal"> . </span>             <span class="Normal"> . </span>                <span class="subxComment"># copy ebp to esp</span>
<span id="L74" class="LineNr">74 </span>    5d/pop-to-ebp
<span id="L75" class="LineNr">75 </span>    c3/return
<span id="L76" class="LineNr">76 </span>
<span id="L77" class="LineNr">77 </span><span class="subxS2Comment"># . . vim&#0058;nowrap:textwidth=0</span>
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->