about summary refs log blame commit diff stats
path: root/html/061channel.mu.html
blob: 350dab6eec7f9b6249af1589ff7596c6154ad08f (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12



                                                                                          
                                 






                                                                                         

                                                                                                 
                        
                               
                                   
                             

                             
                            
                              
                              




















                                                                                                          
                                                  
       


                                                                                                                                                                                   

                         
                                                                                                       

   
 
                   


                                                                                                             

                                                             



                                                                                                           
 
 

                                                                                       
                                           
                                                     
                                                                                                          
                                                      
                                                                                                                             
                                                                               
                                                      
                                                                                                                             
                                                                               
                                                                         
                                                                                                  
                                                                                                                                                         

                                                                                                                                       
                                             
 
 
                                                                                  
                                            
                                           

                                                                                                       

                                                        

                                                                      
                                                                                                                                     
                                   

                                          

                                                                                                                                



                                                                                                

                                                                     



                                                                                  
                                  
                                                                                              
 
 
                                                                                    
                                           
                                           
                                                                                                       

                                                         

                                                                         
                                                                                                                                     
                                   

                                            

                                                                                                                                
                                                                                  
                                                       
                                                                                     

                                                                     



                                                                                  
                                  
                                                                                                      
 
 
                                                    
                                           
                                                                                                       
                                  


                                                                         
                                  
                                                                                              

 
                                                                 
       
                                                                                                                                           

                                                                                                                                                                                   

                         

                                                                                                                                                 

   
 
                                                                        
       

                                                                                                                                                                              

                                                                                                                                                                                   

                         

                                                                                                                                                 

   
 
                                                                       
       


                                                                                                                                                                              

                                                                                                                                                                                   

                         

                                                                                                                                                 

   
 
                                                       
       
                                                           
                                                                                                                                           
                                                         

                                                                                                                                                                              
                                                           

                                                                                                                                                                                   
                                                                                   
                                                                                                                                                                              
                                                                                                                                                                                   
                                                                                  
                                                                                                                                              
                                                                                                                                                                                   

                         



                                                                                                                                                                             

   



                                                                                                      
                                                     
                                           
                                                                                                       
                                                                          

                                                                                                           

                                                                    
 


                                                                                                                                                                                                                                   
                                                    
                                           
                                                                                                       
                                                          
                                                                                                          
                                                                                 

                                                                   



                                                                                

                                                              
                                                                                                           

                                                                   
 
 
                                                                                        
                                                       
                                           
                                                                                                       
                                                                                                                  

                                                            
 
 
                                                                     
       


                                                                                                                                             

                         

                                                                                                                                             

   
 
                                                                  
       



                                                                                                                                                                              

                         

                                                                                                                                             

   
 
                                                             
       



                                                                                                                                                                              

                         

                                                                                                                                             

   
 
                                                                
       




                                                                                                                                                                              

                         

                                                                                                                                             



                                                                              
                                                                                             
                                                   
                                           

                                                                                                      

                                               
                                                                                                       

                                                                                          
                                                   
                                                                


                                                                        

                                                                                                      
                                                              
                                        
                                                                                                                                        


                                                                                                                        
                                        
                                                                
                                                                                               

                                                         


                                                                                                             
                                                                                                     

                                                                                                  
                                         
                                    
                                                       
                                                                                    

                                                                                                                                 
                                    




                                                                                 
                                         
                                    
                                       
                                  
                                                                                             

 
                                                                            
       



                                                                                                                                                            
                                                                                                      
                                                                                                    
                                                                                                                                                                                                                                                                                   


                                                                                                                                                            
                                                                                                                       
                                            




                                                                                                                                                                                
                                                                                                             
                                            




                                                                                                                                                                                
                                                                                                             
                                                





                                                                                                                                                                                      
                                                                                                                     
                                                                                                                            




                        



                                     
<!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 - 061channel.mu</title>
<meta name="Generator" content="Vim/7.4">
<meta name="plugin-version" content="vim7.4_v1">
<meta name="syntax" content="none">
<meta name="settings" content="use_css,pre_wrap,no_foldcolumn,expand_tabs,prevent_copy=">
<meta name="colorscheme" content="minimal">
<style type="text/css">
<!--
pre { white-space: pre-wrap; font-family: monospace; color: #eeeeee; background-color: #080808; }
body { font-family: monospace; color: #eeeeee; background-color: #080808; }
* { font-size: 1.05em; }
.muScenario { color: #00af00; }
.SalientComment { color: #00ffff; }
.muRecipe { color: #ff8700; }
.Comment { color: #9090ff; }
.Constant { color: #00a0a0; }
.Special { color: #ff6060; }
.Delimiter { color: #a04060; }
.muControl { color: #c0a020; }
-->
</style>

<script type='text/javascript'>
<!--

-->
</script>
</head>
<body>
<pre id='vimCodeElement'>
<span class="Comment"># Mu synchronizes using channels rather than locks, like Erlang and Go.</span>
<span class="Comment">#</span>
<span class="Comment"># The two ends of a channel will usually belong to different routines, but</span>
<span class="Comment"># each end should only be used by a single one. Don't try to read from or</span>
<span class="Comment"># write to it from multiple routines at once.</span>
<span class="Comment">#</span>
<span class="Comment"># The key property of channels is that writing to a full channel or reading</span>
<span class="Comment"># from an empty one will put the current routine in 'waiting' state until the</span>
<span class="Comment"># operation can be completed.</span>

<span class="muScenario">scenario</span> channel [
  run [
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>new-channel <span class="Constant">3/capacity</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">34</span>
    <span class="Constant">2</span>:number, <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>read <span class="Constant">1</span>:address:channel
  ]
  memory-should-contain [
    <span class="Constant">2</span><span class="Special"> &lt;- </span><span class="Constant">34</span>
  ]
]

container channel [
  <span class="Comment"># To avoid locking, writer and reader will never write to the same location.</span>
  <span class="Comment"># So channels will include fields in pairs, one for the writer and one for the</span>
  <span class="Comment"># reader.</span>
  first-full:number  <span class="Comment"># for write</span>
  first-free:number  <span class="Comment"># for read</span>
  <span class="Comment"># A circular buffer contains values from index first-full up to (but not</span>
  <span class="Comment"># including) index first-empty. The reader always modifies it at first-full,</span>
  <span class="Comment"># while the writer always modifies it at first-empty.</span>
  data:address:array:location
]

<span class="Comment"># result:address:channel &lt;- new-channel capacity:number</span>
<span class="muRecipe">recipe</span> new-channel [
  <span class="Constant">local-scope</span>
  <span class="Comment"># result = new channel</span>
  result:address:channel<span class="Special"> &lt;- </span>new <span class="Constant">channel:type</span>
  <span class="Comment"># result.first-full = 0</span>
  full:address:number<span class="Special"> &lt;- </span>get-address *result, <span class="Constant">first-full:offset</span>
  *full<span class="Special"> &lt;- </span>copy <span class="Constant">0</span>
  <span class="Comment"># result.first-free = 0</span>
  free:address:number<span class="Special"> &lt;- </span>get-address *result, <span class="Constant">first-free:offset</span>
  *free<span class="Special"> &lt;- </span>copy <span class="Constant">0</span>
  <span class="Comment"># result.data = new location[ingredient+1]</span>
  capacity:number<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  capacity<span class="Special"> &lt;- </span>add capacity, <span class="Constant">1</span>  <span class="Comment"># unused slot for 'full?' below</span>
  dest:address:address:array:location<span class="Special"> &lt;- </span>get-address *result, <span class="Constant">data:offset</span>
  *dest<span class="Special"> &lt;- </span>new <span class="Constant">location:type</span>, capacity
  <span class="muControl">reply</span> result
]

<span class="Comment"># chan &lt;- write chan:address:channel, val:location</span>
<span class="muRecipe">recipe</span> write [
  <span class="Constant">local-scope</span>
  chan:address:channel<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  val:location<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  <span class="Delimiter">{</span>
    <span class="Comment"># block if chan is full</span>
    full:boolean<span class="Special"> &lt;- </span>channel-full? chan
    <span class="muControl">break-unless</span> full
    full-address:address:number<span class="Special"> &lt;- </span>get-address *chan, <span class="Constant">first-full:offset</span>
    wait-for-location *full-address
  <span class="Delimiter">}</span>
  <span class="Comment"># store val</span>
  circular-buffer:address:array:location<span class="Special"> &lt;- </span>get *chan, <span class="Constant">data:offset</span>
  free:address:number<span class="Special"> &lt;- </span>get-address *chan, <span class="Constant">first-free:offset</span>
  dest:address:location<span class="Special"> &lt;- </span>index-address *circular-buffer, *free
  *dest<span class="Special"> &lt;- </span>copy val
  <span class="Comment"># mark its slot as filled</span>
  *free<span class="Special"> &lt;- </span>add *free, <span class="Constant">1</span>
  <span class="Delimiter">{</span>
    <span class="Comment"># wrap free around to 0 if necessary</span>
    len:number<span class="Special"> &lt;- </span>length *circular-buffer
    at-end?:boolean<span class="Special"> &lt;- </span>greater-or-equal *free, len
    <span class="muControl">break-unless</span> at-end?
    *free<span class="Special"> &lt;- </span>copy <span class="Constant">0</span>
  <span class="Delimiter">}</span>
  <span class="muControl">reply</span> chan/same-as-ingredient:<span class="Constant">0</span>
]

<span class="Comment"># result:location, chan &lt;- read chan:address:channel</span>
<span class="muRecipe">recipe</span> read [
  <span class="Constant">local-scope</span>
  chan:address:channel<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  <span class="Delimiter">{</span>
    <span class="Comment"># block if chan is empty</span>
    empty?:boolean<span class="Special"> &lt;- </span>channel-empty? chan
    <span class="muControl">break-unless</span> empty?
    free-address:address:number<span class="Special"> &lt;- </span>get-address *chan, <span class="Constant">first-free:offset</span>
    wait-for-location *free-address
  <span class="Delimiter">}</span>
  <span class="Comment"># read result</span>
  full:address:number<span class="Special"> &lt;- </span>get-address *chan, <span class="Constant">first-full:offset</span>
  circular-buffer:address:array:location<span class="Special"> &lt;- </span>get *chan, <span class="Constant">data:offset</span>
  result:location<span class="Special"> &lt;- </span>index *circular-buffer, *full
  <span class="Comment"># mark its slot as empty</span>
  *full<span class="Special"> &lt;- </span>add *full, <span class="Constant">1</span>
  <span class="Delimiter">{</span>
    <span class="Comment"># wrap full around to 0 if necessary</span>
    len:number<span class="Special"> &lt;- </span>length *circular-buffer
    at-end?:boolean<span class="Special"> &lt;- </span>greater-or-equal *full, len
    <span class="muControl">break-unless</span> at-end?
    *full<span class="Special"> &lt;- </span>copy <span class="Constant">0</span>
  <span class="Delimiter">}</span>
  <span class="muControl">reply</span> result, chan/same-as-ingredient:<span class="Constant">0</span>
]

<span class="muRecipe">recipe</span> clear-channel [
  <span class="Constant">local-scope</span>
  chan:address:channel<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  <span class="Delimiter">{</span>
    empty?:boolean<span class="Special"> &lt;- </span>channel-empty? chan
    <span class="muControl">break-if</span> empty?
    _, chan<span class="Special"> &lt;- </span>read chan
  <span class="Delimiter">}</span>
  <span class="muControl">reply</span> chan/same-as-ingredient:<span class="Constant">0</span>
]

<span class="muScenario">scenario</span> channel-initialization [
  run [
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>new-channel <span class="Constant">3/capacity</span>
    <span class="Constant">2</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-full:offset</span>
    <span class="Constant">3</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-free:offset</span>
  ]
  memory-should-contain [
    <span class="Constant">2</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># first-full</span>
    <span class="Constant">3</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># first-free</span>
  ]
]

<span class="muScenario">scenario</span> channel-write-increments-free [
  run [
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>new-channel <span class="Constant">3/capacity</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">34</span>
    <span class="Constant">2</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-full:offset</span>
    <span class="Constant">3</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-free:offset</span>
  ]
  memory-should-contain [
    <span class="Constant">2</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># first-full</span>
    <span class="Constant">3</span><span class="Special"> &lt;- </span><span class="Constant">1</span>  <span class="Comment"># first-free</span>
  ]
]

<span class="muScenario">scenario</span> channel-read-increments-full [
  run [
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>new-channel <span class="Constant">3/capacity</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">34</span>
    _, <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>read <span class="Constant">1</span>:address:channel
    <span class="Constant">2</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-full:offset</span>
    <span class="Constant">3</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-free:offset</span>
  ]
  memory-should-contain [
    <span class="Constant">2</span><span class="Special"> &lt;- </span><span class="Constant">1</span>  <span class="Comment"># first-full</span>
    <span class="Constant">3</span><span class="Special"> &lt;- </span><span class="Constant">1</span>  <span class="Comment"># first-free</span>
  ]
]

<span class="muScenario">scenario</span> channel-wrap [
  run [
    <span class="Comment"># channel with just 1 slot</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>new-channel <span class="Constant">1/capacity</span>
    <span class="Comment"># write and read a value</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">34</span>
    _, <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>read <span class="Constant">1</span>:address:channel
    <span class="Comment"># first-free will now be 1</span>
    <span class="Constant">2</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-free:offset</span>
    <span class="Constant">3</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-free:offset</span>
    <span class="Comment"># write second value, verify that first-free wraps</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">34</span>
    <span class="Constant">4</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-free:offset</span>
    <span class="Comment"># read second value, verify that first-full wraps</span>
    _, <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>read <span class="Constant">1</span>:address:channel
    <span class="Constant">5</span>:number<span class="Special"> &lt;- </span>get *<span class="Constant">1</span>:address:channel, <span class="Constant">first-full:offset</span>
  ]
  memory-should-contain [
    <span class="Constant">2</span><span class="Special"> &lt;- </span><span class="Constant">1</span>  <span class="Comment"># first-free after first write</span>
    <span class="Constant">3</span><span class="Special"> &lt;- </span><span class="Constant">1</span>  <span class="Comment"># first-full after first read</span>
    <span class="Constant">4</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># first-free after second write, wrapped</span>
    <span class="Constant">5</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># first-full after second read, wrapped</span>
  ]
]

<span class="SalientComment">## helpers</span>

<span class="Comment"># An empty channel has first-empty and first-full both at the same value.</span>
<span class="muRecipe">recipe</span> channel-empty? [
  <span class="Constant">local-scope</span>
  chan:address:channel<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  <span class="Comment"># return chan.first-full == chan.first-free</span>
  full:number<span class="Special"> &lt;- </span>get *chan, <span class="Constant">first-full:offset</span>
  free:number<span class="Special"> &lt;- </span>get *chan, <span class="Constant">first-free:offset</span>
  result:boolean<span class="Special"> &lt;- </span>equal full, free
  <span class="muControl">reply</span> result
]

<span class="Comment"># A full channel has first-empty just before first-full, wasting one slot.</span>
<span class="Comment"># (Other alternatives: <a href="https://en.wikipedia.org/wiki/Circular_buffer#Full_.2F_Empty_Buffer_Distinction)">https://en.wikipedia.org/wiki/Circular_buffer#Full_.2F_Empty_Buffer_Distinction)</a></span>
<span class="muRecipe">recipe</span> channel-full? [
  <span class="Constant">local-scope</span>
  chan:address:channel<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  <span class="Comment"># tmp = chan.first-free + 1</span>
  tmp:number<span class="Special"> &lt;- </span>get *chan, <span class="Constant">first-free:offset</span>
  tmp<span class="Special"> &lt;- </span>add tmp, <span class="Constant">1</span>
  <span class="Delimiter">{</span>
    <span class="Comment"># if tmp == chan.capacity, tmp = 0</span>
    len:number<span class="Special"> &lt;- </span>channel-capacity chan
    at-end?:boolean<span class="Special"> &lt;- </span>greater-or-equal tmp, len
    <span class="muControl">break-unless</span> at-end?
    tmp<span class="Special"> &lt;- </span>copy <span class="Constant">0</span>
  <span class="Delimiter">}</span>
  <span class="Comment"># return chan.first-full == tmp</span>
  full:number<span class="Special"> &lt;- </span>get *chan, <span class="Constant">first-full:offset</span>
  result:boolean<span class="Special"> &lt;- </span>equal full, tmp
  <span class="muControl">reply</span> result
]

<span class="Comment"># result:number &lt;- channel-capacity chan:address:channel</span>
<span class="muRecipe">recipe</span> channel-capacity [
  <span class="Constant">local-scope</span>
  chan:address:channel<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  q:address:array:location<span class="Special"> &lt;- </span>get *chan, <span class="Constant">data:offset</span>
  result:number<span class="Special"> &lt;- </span>length *q
  <span class="muControl">reply</span> result
]

<span class="muScenario">scenario</span> channel-new-empty-not-full [
  run [
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>new-channel <span class="Constant">3/capacity</span>
    <span class="Constant">2</span>:boolean<span class="Special"> &lt;- </span>channel-empty? <span class="Constant">1</span>:address:channel
    <span class="Constant">3</span>:boolean<span class="Special"> &lt;- </span>channel-full? <span class="Constant">1</span>:address:channel
  ]
  memory-should-contain [
    <span class="Constant">2</span><span class="Special"> &lt;- </span><span class="Constant">1</span>  <span class="Comment"># empty?</span>
    <span class="Constant">3</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># full?</span>
  ]
]

<span class="muScenario">scenario</span> channel-write-not-empty [
  run [
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>new-channel <span class="Constant">3/capacity</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">34</span>
    <span class="Constant">2</span>:boolean<span class="Special"> &lt;- </span>channel-empty? <span class="Constant">1</span>:address:channel
    <span class="Constant">3</span>:boolean<span class="Special"> &lt;- </span>channel-full? <span class="Constant">1</span>:address:channel
  ]
  memory-should-contain [
    <span class="Constant">2</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># empty?</span>
    <span class="Constant">3</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># full?</span>
  ]
]

<span class="muScenario">scenario</span> channel-write-full [
  run [
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>new-channel <span class="Constant">1/capacity</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">34</span>
    <span class="Constant">2</span>:boolean<span class="Special"> &lt;- </span>channel-empty? <span class="Constant">1</span>:address:channel
    <span class="Constant">3</span>:boolean<span class="Special"> &lt;- </span>channel-full? <span class="Constant">1</span>:address:channel
  ]
  memory-should-contain [
    <span class="Constant">2</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># empty?</span>
    <span class="Constant">3</span><span class="Special"> &lt;- </span><span class="Constant">1</span>  <span class="Comment"># full?</span>
  ]
]

<span class="muScenario">scenario</span> channel-read-not-full [
  run [
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>new-channel <span class="Constant">1/capacity</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">34</span>
    _, <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>read <span class="Constant">1</span>:address:channel
    <span class="Constant">2</span>:boolean<span class="Special"> &lt;- </span>channel-empty? <span class="Constant">1</span>:address:channel
    <span class="Constant">3</span>:boolean<span class="Special"> &lt;- </span>channel-full? <span class="Constant">1</span>:address:channel
  ]
  memory-should-contain [
    <span class="Constant">2</span><span class="Special"> &lt;- </span><span class="Constant">1</span>  <span class="Comment"># empty?</span>
    <span class="Constant">3</span><span class="Special"> &lt;- </span><span class="Constant">0</span>  <span class="Comment"># full?</span>
  ]
]

<span class="Comment"># helper for channels of characters in particular</span>
<span class="Comment"># out &lt;- buffer-lines in:address:channel, out:address:channel</span>
<span class="muRecipe">recipe</span> buffer-lines [
  <span class="Constant">local-scope</span>
  in:address:channel<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  out:address:channel<span class="Special"> &lt;- </span><span class="Constant">next-ingredient</span>
  <span class="Comment"># repeat forever</span>
  <span class="Delimiter">{</span>
    line:address:buffer<span class="Special"> &lt;- </span>new-buffer, <span class="Constant">30</span>
    <span class="Comment"># read characters from 'in' until newline, copy into line</span>
    <span class="Delimiter">{</span>
<span class="Constant">      +next-character</span>
      c:character, in<span class="Special"> &lt;- </span>read in
      <span class="Comment"># drop a character on backspace</span>
      <span class="Delimiter">{</span>
        <span class="Comment"># special-case: if it's a backspace</span>
        backspace?:boolean<span class="Special"> &lt;- </span>equal c, <span class="Constant">8</span>
        <span class="muControl">break-unless</span> backspace?
        <span class="Comment"># drop previous character</span>
        <span class="Delimiter">{</span>
          buffer-length:address:number<span class="Special"> &lt;- </span>get-address *line, <span class="Constant">length:offset</span>
          buffer-empty?:boolean<span class="Special"> &lt;- </span>equal *buffer-length, <span class="Constant">0</span>
          <span class="muControl">break-if</span> buffer-empty?
          *buffer-length<span class="Special"> &lt;- </span>subtract *buffer-length, <span class="Constant">1</span>
        <span class="Delimiter">}</span>
        <span class="Comment"># and don't append this one</span>
        <span class="muControl">loop</span> <span class="Constant">+next-character:label</span>
      <span class="Delimiter">}</span>
      <span class="Comment"># append anything else</span>
      line<span class="Special"> &lt;- </span>buffer-append line, c
      line-done?:boolean<span class="Special"> &lt;- </span>equal c, <span class="Constant">10/newline</span>
      <span class="muControl">break-if</span> line-done?
      <span class="Comment"># stop buffering on eof (currently only generated by fake console)</span>
      eof?:boolean<span class="Special"> &lt;- </span>equal c, <span class="Constant">0/eof</span>
      <span class="muControl">break-if</span> eof?
      <span class="muControl">loop</span>
    <span class="Delimiter">}</span>
    <span class="Comment"># copy line into 'out'</span>
    i:number<span class="Special"> &lt;- </span>copy <span class="Constant">0</span>
    line-contents:address:array:character<span class="Special"> &lt;- </span>get *line, <span class="Constant">data:offset</span>
    max:number<span class="Special"> &lt;- </span>get *line, <span class="Constant">length:offset</span>
    <span class="Delimiter">{</span>
      done?:boolean<span class="Special"> &lt;- </span>greater-or-equal i, max
      <span class="muControl">break-if</span> done?
      c:character<span class="Special"> &lt;- </span>index *line-contents, i
      out<span class="Special"> &lt;- </span>write out, c
      i<span class="Special"> &lt;- </span>add i, <span class="Constant">1</span>
      <span class="muControl">loop</span>
    <span class="Delimiter">}</span>
    <span class="muControl">loop</span>
  <span class="Delimiter">}</span>
  <span class="muControl">reply</span> out/same-as-ingredient:<span class="Constant">1</span>
]

<span class="muScenario">scenario</span> buffer-lines-blocks-until-newline [
  run [
    <span class="Constant">1</span>:address:channel/stdin<span class="Special"> &lt;- </span>new-channel <span class="Constant">10/capacity</span>
    <span class="Constant">2</span>:address:channel/buffered-stdin<span class="Special"> &lt;- </span>new-channel <span class="Constant">10/capacity</span>
    <span class="Constant">3</span>:boolean<span class="Special"> &lt;- </span>channel-empty? <span class="Constant">2</span>:address:channel/buffered-stdin
    assert <span class="Constant">3</span>:boolean, [
F buffer-lines-blocks-until-newline: channel should be empty <span class="muRecipe">after</span> init]
    <span class="Comment"># buffer stdin into buffered-stdin, try to read from buffered-stdin</span>
    <span class="Constant">4</span>:number/buffer-routine<span class="Special"> &lt;- </span>start-running <span class="Constant">buffer-lines:recipe</span>, <span class="Constant">1</span>:address:channel/stdin, <span class="Constant">2</span>:address:channel/buffered-stdin
    wait-for-routine <span class="Constant">4</span>:number/buffer-routine
    <span class="Constant">5</span>:boolean<span class="Special"> &lt;- </span>channel-empty? <span class="Constant">2</span>:address:channel/buffered-stdin
    assert <span class="Constant">5</span>:boolean, [
F buffer-lines-blocks-until-newline: channel should be empty <span class="muRecipe">after</span> buffer-lines bring-up]
    <span class="Comment"># write 'a'</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">97/a</span>
    restart <span class="Constant">4</span>:number/buffer-routine
    wait-for-routine <span class="Constant">4</span>:number/buffer-routine
    <span class="Constant">6</span>:boolean<span class="Special"> &lt;- </span>channel-empty? <span class="Constant">2</span>:address:channel/buffered-stdin
    assert <span class="Constant">6</span>:boolean, [
F buffer-lines-blocks-until-newline: channel should be empty <span class="muRecipe">after</span> writing 'a']
    <span class="Comment"># write 'b'</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">98/b</span>
    restart <span class="Constant">4</span>:number/buffer-routine
    wait-for-routine <span class="Constant">4</span>:number/buffer-routine
    <span class="Constant">7</span>:boolean<span class="Special"> &lt;- </span>channel-empty? <span class="Constant">2</span>:address:channel/buffered-stdin
    assert <span class="Constant">7</span>:boolean, [
F buffer-lines-blocks-until-newline: channel should be empty <span class="muRecipe">after</span> writing 'b']
    <span class="Comment"># write newline</span>
    <span class="Constant">1</span>:address:channel<span class="Special"> &lt;- </span>write <span class="Constant">1</span>:address:channel, <span class="Constant">10/newline</span>
    restart <span class="Constant">4</span>:number/buffer-routine
    wait-for-routine <span class="Constant">4</span>:number/buffer-routine
    <span class="Constant">8</span>:boolean<span class="Special"> &lt;- </span>channel-empty? <span class="Constant">2</span>:address:channel/buffered-stdin
    <span class="Constant">9</span>:boolean/completed?<span class="Special"> &lt;- </span>not <span class="Constant">8</span>:boolean
    assert <span class="Constant">9</span>:boolean/completed?, [
F buffer-lines-blocks-until-newline: channel should contain data <span class="muRecipe">after</span> writing newline]
    trace <span class="Constant">1</span>, <span class="Constant">[test]</span>, <span class="Constant">[reached end]</span>
  ]
  trace-should-contain [
    test: reached end
  ]
]
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->