5128 lines
250 KiB
HTML
5128 lines
250 KiB
HTML
<h2>$</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -c<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return ASCII:NUL (0).</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>'</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return an empty string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>(</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Provide a visual indication of a code group.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>)</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Provide a visual indication of a code group.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>*</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Multiply `n1` by `n2` and return the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #2 #6 *
|
|
#-1 #100 *</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>*/mod</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xyz-rv<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Multiply `x` by `y` and then divide by `z` and return the integer part of the quotient and remainder.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>+</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Add `n1` to `n2` and return the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 #2 + </xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>,</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store the specified value into the memory at `here` and increment `Heap` by 1.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> $a , $b , $c , #0 ,</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>-</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Subtract `n2` from `n1` and return the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #2 #1 - </xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>---reveal---</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Switch to the exposed (public) portion of a lexical namespace.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>-eq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare two values for inequality. Returns `TRUE` if they are not equal or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 #2 -eq?
|
|
$a $b -eq?</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>-if</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> fq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute the quotation if the flag is `FALSE`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>-if;</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> fq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute the quotation if the flag is `FALSE`. If false, also exit the word.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>/</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-v<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Divide `n` by `m` and return the integer part of the quotient.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>//</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>"Ignore any tokens remaining on the current line. Works with files and the interactive ""listener""."</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>/mod</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-rv<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Divide `n` by `m` and return the integer part of the quotient and remainder.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>0;</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-n || n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>If `n` is zero, drop `n` and exit the current word. If non-zero, leave `n` alone and allow execution to continue.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>;</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>End the current definition.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>?dup</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-nn || n-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Duplicate top value on stack if not zero. If zero, do nothing.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 ?dup
|
|
#0 ?dup</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>ASCII:ACK</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:BEL</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:BS</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:CAN</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:CR</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:DC1</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:DC2</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:DC3</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:DC4</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:DEL</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:DLE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:EM</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:ENQ</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:EOT</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:ESC</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:ETB</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:ETX</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:FF</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:FS</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:GS</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:HT</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:LF</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:NAK</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:NUL</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:RS</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:SI</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:SO</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:SOH</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:SPACE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:STX</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:SUB</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:SYN</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:US</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ASCII:VT</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Refers to specific ASCII code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>ASCII</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>BUILD</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Return a build identifier. Use along with version to identify an image.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>Base</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. Holds the current numeric base. Base must be in the range of 2-16.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>Compiler</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. Holds the compiler state. If TRUE, the compiler is active. If FALSE, it is not.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>DEVICE:BLOCKS</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for block support.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:CLOCK</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for clock words.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:ERROR</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for error handlers.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:FFI</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for foreign function interface.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:FILES</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for filesystem access.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:FLOATS</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for floating point.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:IMAGE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for image writer.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:IOCTL</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for Unix IOCTL interface.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:KEYBOARD</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for Keyboard input.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:MALLOC</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for memory allocator.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:MULTICORE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for multicore support.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:OUTPUT</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for Output device.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:RESERVED11</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Reserved device ID.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:RESERVED12</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Reserved device ID.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:RESERVED13</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Reserved device ID.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:RESERVED6</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Reserved device ID.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:RNG</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for random number generator.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:SCRIPTING</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for scripting support.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:SOCKET</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for sockets.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>DEVICE:UNIX</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for unix syscall.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rreDEVICE:</td></tr></table><hr/>
|
|
<h2>DEVICE:UNSIGNED</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return device ID for unsigned maths.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>DEVICE</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>Dictionary</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. Holds a pointer to the most recent dictionary header.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>END</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Used to denote the end of a linked list. The last cons will have the cdr point to this address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>EOM</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Returns the last addressable memory address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>FALSE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Returns `0`, the value used to indicate a FALSE result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>FREE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Returns the number of cells available to your application. This is the amount of memory, less the already consumed portion and buffers mapped for Retro's internal use.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>HOME</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Hold the path to the users home directory. Defined as a floating buffer above `here`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>Heap</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. Holds the address of the next available cell.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>I</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Access the loop index for the current loop. (For loops made using `indexed-times`)</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>Ignoring</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. When TRUE, ignore input to end of line.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>J</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Access the parent loop index for the current loop. (For loops made using `indexed-times`)</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>K</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Access the grandparent loop index for the current loop. (For loops made using `indexed-times`)</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>RewriteUnderscores</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. When set to `TRUE`, Retro will replace underscores in strings with spaces. When `FALSE`, Retro does not.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>STRINGS</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the address of the start of the temporary string pool. This can be altered by changing the values of `TempStrings` and `TempStringMax`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ScopeList</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. This holds some information used by `{{` and `}}`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>TIB</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Returns a pointer to the text input buffer.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>TRUE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Returns `-1`, the value used to indicate a TRUE result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>TempStringMax</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. Holds the maximum length of a temporary string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>TempStrings</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. Holds the number of temporary strings.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>Version</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. This stores the version number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>[</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Begin a quotation.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>]</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>End a quotation.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:-eq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aa-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare all values in the array. Return `FALSE` if all values are equal or `TRUE` otherwise. This assumes the array contains only numeric values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:append</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aa-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new array consisting of the values in a1 followed by the values in a2.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:begins-with?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aa-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if a1 begins with a2 or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:chop</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new array containing all but the last value in the source array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:contains/string?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sa-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if the string value is in the array or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:contains?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if the value is in the array or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:copy</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aa-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Copy an array (a1) to a destination (a2).</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:counted-results</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Run a quote and construct a new array from the returned values. The quote should return the values and the number of values to put into the array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:dup</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-b<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Make a copy of an array. Return the address of the copy.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:ends-with?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aa-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if a1 ends with a2 or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:eq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aa-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare all values in the array. Return `TRUE` if all values are equal or `FALSE` otherwise. This assumes the array contains only numeric values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:fetch</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> an-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the value stored at the specified index in the specified array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> { #0 #1 #3 } #2 a:fetch</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>a:filter</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aq-b<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>For each item in the initial array, run the specified quote. If the quote returns `TRUE`, copy the item into a new array. If `FALSE`, discard it. Returns a pointer to the new array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:first</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the first value in the array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:for-each</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute the quote once for each item in the array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:from-string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a new array with the characters in the source string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:hash</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Calculate a hash value for a given array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:index</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> an-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the location of the first instance of the specified value in the array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:index/string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> as-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the location of the first instance of the specified string in the array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:indices</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> av-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new array with the indices the specified value was found at in the original array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:indices/string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> as-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new array with the indices of the specified string in the original array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:last</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the last value in the array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:left</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> an-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new array containing the first `n` values from the source array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:length</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the length of a array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:make</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute quote. Return a new array containing the values the quote leaves on the stack. This is identical to doing `a:counted-results</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:map</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aq-b<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute quote once for each item in the array. Constructs a new array from the value returned by the quote.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:middle</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> afl-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Extract a new array from the middle of the specified array. This will take the values starting at `f` and extend to the `l` last value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:prepend</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aa-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new array consisting of the values in a2 followed by the values in a1.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:reduce</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> pnq-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Takes an array, a starting value, and a quote. This will apply the quote to each item in the array; the quote should consume two values and return one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:reverse</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-b<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Reverse the order of items in a array. This will return a new array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:right</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> an-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new array containing the specified number of values from the right side of the array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:store</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> van-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a value into the array at the specified index.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #3 { #0 #1 #2 } #1 a:store</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>a:temp</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Make a copy of the array in a rotating set of temporary buffers.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:th</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> an-b<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the actual address of the `n`th item in the array.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>a:to-string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a new string from the provided array of character values. This string will be stored in the temporal string buffers.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> { $h $e $l $l $o } a:to-string s:put nl</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>abort</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Abort execution.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>again</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Close an unconditional loop. Branches back to the prior `repeat`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>allot</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Allocate the specified number of cells from the `Heap`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'Buffer d:create #100 allot</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>and</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-o<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Perform a bitwise AND operation between the two provided values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>b:fetch</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the 8-bit value stored at the specified address. Addressing for this is in 8-bit units.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'>{n/a)</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>b:fetch-next</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-an<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the value stored at the specified address. Returns the next address and the value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>b</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>b:store</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store an 8-bit value into the specified address. Addressing for this is in 8-bit units.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>b:store-next</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a value into the specified address and return the next address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>b</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>b:to-byte-address</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Translate a physical address to a byte address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>banner</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display a welcome message on startup.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>bi</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xqq-?<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute q1 against x, then execute q2 against a copy of x.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #100 [ #10 * ] [ #10 - ] bi</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>bi*</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xyqq-?<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute q1 against x and q2 against y.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #10 #20 [ #2 * ] [ #10 / ] bi*</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>bi@</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xyq-?<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute q against x, then execute q against y.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #10 #20 [ #3 * ] bi@</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>binary</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set `Base` to binary.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>block:read</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Read 1024 cells from block n in the block storage into memory at address a.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>block</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>block:set-file</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set the file name of the block storage device.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>block</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>block:write</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Save the 1024 cells at address a to block n in the block storage.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>block</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>buffer:add</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Append a value to the current buffer.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>buffer</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>buffer:empty</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Reset the current buffer to an empty state.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>buffer</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>buffer:end</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a pointer to the current end of the active buffer.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>buffer</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>buffer:get</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Remove the last value from the current buffer.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>buffer</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>buffer:preserve</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Save and restore the current buffer before and after executing the specified quote.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>buffer</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>buffer:set</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Assign a new buffer as the current one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>buffer</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>buffer:size</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the number of cells in the buffer.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>buffer</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>buffer:start</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the start address of the current buffer.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>buffer</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>bye</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Exit Retro.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:-consonant?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is a not consonant or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:-digit?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is a not numeric digit or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:-lowercase?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is not lowercase or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:-uppercase?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is not uppercase or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:-visible?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is not printable or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:-vowel?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is not a vowel or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:-whitespace?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is not whitespace, or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:consonant?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is a consonant or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:digit?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is a numeric digit or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:get</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -c<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Vectored. Read a single keypress.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>c:letter?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is an ASCII letter or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:lowercase?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is lowercase or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:put</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Vectored. Display a single character.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:to-lower</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-c<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert character to lowercase equivalent.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:to-number</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert an ASCII digit character into the corresponding decimal value</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:to-string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert character into a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:to-upper</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-c<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert character to uppercase equivalent.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:toggle-case</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-c<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert an ASCII character to the opposite case.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:uppercase?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is uppercase or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:visible?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is printable or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:vowel?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is a vowel or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>c:whitespace?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> c-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if character is whitespace, or FALSE otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>c</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>call</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Call a function.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>car</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a pointer to the car of cons a.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>car!</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store n into the car of cons a.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>car@</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the contents of the car of cons a.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>case</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nmq- || nmq-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>If `n` is equal to `m`, drop both and execute the specified quote before exiting the calling word. If not equal, leave `n` on the stack and let execution continue.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>cdr</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a pointer to the cdr of cons a.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>cdr!</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store n into the cdr of cons a.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>cdr@</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the contents of the cdr of cons a.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>choose</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> fqq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute q1 if the flag is true (-1) or q2 if the flag is false (0). Only these flags are valid when using `choose`; passing other values as flags will result in memory corruption.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>class:data</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n- || n-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Class handler for data structures.</p>
|
|
<p>Interpret Time:
|
|
Keep the address or value on the stack.</p>
|
|
|
|
<p>Compile Time:
|
|
Compile the value or address as a literal into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>class</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>class:macro</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Class handler for compiler macros (immediate words)</p>
|
|
<p>Interpret Time:
|
|
Execute the function at the provided address.</p>
|
|
|
|
<p>Compile Time:
|
|
Execute the function at the provided address.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>class</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>class:primitive</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Class handler for primitive words (words which map to Nga instructions)</p>
|
|
<p>Interpret Time:
|
|
Execute the function.</p>
|
|
|
|
<p>Compile Time:
|
|
Compile the machine code in the definiton into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>class</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>class:word</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Class handler for normal words.</p>
|
|
<p>Interpret Time:
|
|
Execute the function at the provided address.</p>
|
|
|
|
<p>Compile Time:
|
|
Compile a call to the specified address into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>class</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>clear</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Clear the display.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>clock:day</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current day.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:hour</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current hour. This will be in the range of 0-23, inclusive.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:minute</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current minute. This will be in the range of 0-59, inclusive.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:month</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current month. This will be in the range of 1-12, inclusive.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:operation</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trigger a clock operation. This is not intended to be used directly.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>clock:second</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current second. This will be in the range of 0-59, inclusive.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:timestamp</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a host specific timestamp. In the standard system, this is a 32-bit Unix timestamp, but this is not required.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>clock:utc:day</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current day in UTC.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:utc:hour</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current hour in UTC.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:utc:minute</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current minute in UTC.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:utc:month</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current month in UTC.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:utc:second</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current second in UTC.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:utc:year</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current year in UTC.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>clock:year</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current year.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>clock</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS, rre</td></tr></table><hr/>
|
|
<h2>comma</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store the specified value into the memory at `here` and increment `Heap` by 1. Identical to `,`, this is provided for compatibility with the RetroForth on ilo and napia.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> $a , $b , $c , #0 ,</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>compile:call</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compile a call to the specified address into the current definition.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>compile</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>compile:jump</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compile a jump to the specified address into the current definition.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>compile</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>compile:lit</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compile the code to push a number to the stack into the current definition.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>compile</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>compile:ret</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compile a return instruction into the current definition.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>compile</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>compiling?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if compiler is on or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>cons</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xy-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a new cons cell with a car of x and a cdr of y.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>const</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ns-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a constant returning the specified value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>copy</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sdl-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Copy `l` cells from memory at `s` to the memory at `d`. These should not overlap.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>core:init</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Clear the internal state of core `n`. This should be done prior to use of `core:start`, which activates processing on the core.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>core</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>core:pause</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Suspend processing on core `n`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>core</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>core:pause-current</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Suspend processing on the current core.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>core</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>core:read/reg</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-v<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Read a value from register `n` on the current core.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>core</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>core:resume</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Resume processing on core `n` after a `core:pause` or `core:pause-current`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>core</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>core:start</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> an-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set the IP of core `n` to address `a` and begin processing on core `n`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>core</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>core:write/reg</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> vn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Write a value to register number `n` on the current core.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>core</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>curry</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nq-q<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Bind a value to a function and return a new quote that calls the bound action.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Inline a numeric value to the current assembly segment.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:Hash-Function</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. Holds a pointer tho the function for calculating dictionary hashes.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:add-header</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> saa-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Vectored. Create a header. Provide a string (s) for the name, a pointer to the class handler (a1) and a pointer to the word definition (a2) Generally this won't be used directly.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:class</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> d-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a dictionary header, return the class field.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:create</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Hook. Create a new dictionary header named the specified string. The new header will point to `here` and have a class of `class:data`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:for-each</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute the specified quote once for each header in the dictionary. Before running the quote, this also pushes a pointer to the header onto the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:hash</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> d-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a dictionary header, return the hash field.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:last</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -d<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the most recent dictionary header.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:last.class</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a pointer to the class field of the most recent dictionary header.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:last.name</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a pointer to the name field of the most recent dictionary header.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:last.xt</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a pointer to the xt field of the most recent dictionary header.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:link</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> d-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a dictionary header, return the link field.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:lookup</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-d<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Lookup the specified name in the dictionary and return a pointer to its dictionary header. This returns zero if the word is not found. This also sets an internal variable ('which' in retro.muri) to the header address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:lookup-xt</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-d<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Lookup the specified address in the dictionary and return a pointer to its dictionary header. This returns zero if the word is not found.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:name</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> d-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a dictionary header, return the name field.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:rehash</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Update the hashes for all visible words in the dictionary.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:set-source</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set the `d:source` field of the header for the named word (s2) to string (s1). The string will not be duplicated.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>d:source</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> d-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a dictionary header, return the source field.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:use-hashes</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Change dictionary search to use hashed name comparions.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:use-strings</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Change dictionary search to use full name comparions.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>d:words</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display a list of all named items in the `Dictionary`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>d:words-beginning-with</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display a list of all named items in the `Dictionary` that begin with the provided substring.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>d:words-with</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display a list of all named items in the `Dictionary` that contain the provided substring.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>d:xt</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> d-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a dictionary header, return the xt field.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>d</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>data</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Change the class of the most recently defined word to `class:data`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>decimal</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set `Base` to decimal.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>depth</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the number of items on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>dip</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nq-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Temporarily remove n from the stack, execute the quotation, and then restore n to the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>does</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Attach an action to the most recently created word. This is used in a manner similar to CREATE/DOES> in traditional Forth.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>double:const</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nns-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a constant returning the specified double cell value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>double</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>double:dip</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> mnq-mn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Temporarily remove m and n from the stack, execute the quotation, and then restore m and n to the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>double:fetch</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the double cell values stored in the double cell variable at a.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>double</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>double:sip</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> mnq(?n-?)-mn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Run quote. After execution completes, put a copy of m and n back on top of the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>double:store</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nna-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store the double cell values on the stack in the double cell variable at a.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>double</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>double:swap</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nnmm-mmnn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Swap double cell value on stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>double</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>double:var</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nns-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a variable for holding the specified double cell value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>double</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>drop</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Discard the top value on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>drop-pair</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Remove top two items on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>dump-stack</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display the items on the data stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>dup</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Duplicate the top item on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>dup-pair</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-nmnm<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Duplicate the top two items on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>e:-INF</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -e<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Negative infinity. For encoded floating-point values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:-inf?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Is encoded value negative infinity?</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:INF</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -e<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Infinity. For encoded floating-point values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:MAX</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -e<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Maximum value. For encoded floating-point values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:MIN</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -e<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Minimum value. For encoded floating-point values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:NAN</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -e<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Not a Number. For encoded floating-point values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:clip</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-E<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constrain the encoded value to the allowable range.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:inf?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Is encoded value infinity?</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:max?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Is encoded value at the maximum?</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:min?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Is encoded value at the minimum?</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:n?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if the encoded value is a valid number, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:nan?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Is encoded value a Nan?</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:put</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display an encoded number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:to-f</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -n</p>
|
|
</div>
|
|
<p>Decode an encoded floating-point value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>e:zero?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> e-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if the value is zero, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>e</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>eq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare two values for equality. Returns `TRUE` if they are equal or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 #2 eq?
|
|
$a $b eq?</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>err:dso</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Error handler for data stack overflow</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>err</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>err:dsu</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Error handler for data stack underflow.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>err</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>err:notfound</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Vectored. Error handler. Called when a word is not found by `interpret`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>err</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>err:set-defaults</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set the default error handlers for various conditions.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>err</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>err:set-handler</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> an-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set error handler for error code N. </p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>err</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>f:*</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-F</p>
|
|
</div>
|
|
<p>Multiply two floating-point numbers, returning the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .3.1415 .22 f:*</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:+</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-F</p>
|
|
</div>
|
|
<p>Add two floating-point numbers, returning the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .3.1 .22 f:+</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:-</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-F</p>
|
|
</div>
|
|
<p>Subtract F2 from F1 returning the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .22.3 .0.12 f:-</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:-INF</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -n</p>
|
|
</div>
|
|
<p>Return a value corresponding to negative infinity</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:-eq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-</p>
|
|
</div>
|
|
<p>Compare two floating-point values for inequality. Returns `TRUE` if they are not equal or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:-inf?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Return `TRUE` if floating-point value is -INF or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:/</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-F</p>
|
|
</div>
|
|
<p>Divide floating-point value F1 by F2.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:E</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -F</p>
|
|
</div>
|
|
<p>Return the floating-point value for Euler's number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:E1</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -f</p>
|
|
</div>
|
|
<p>Hook. Return a constant used as the scaling factor for the e: words.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:INF</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -n</p>
|
|
</div>
|
|
<p>Return a value corresponding to positive infinity</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:NAN</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -n</p>
|
|
</div>
|
|
<p>Return a value corresponding to NaN</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:PI</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -F</p>
|
|
</div>
|
|
<p>Return the floating-point value for PI.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:abs</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the absolute value for a floating-point value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:acos</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the arc cosine of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:adepth</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the number of items on the alternate floating-point stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:asin</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the arc sine of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:atan</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the arc tangent of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:between?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> nlu-</p>
|
|
</div>
|
|
<p>Return TRUE if number is between the lower (l) and upper (u) bounds. If not, return FALSE. This is inclusive of the limits.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .3 .1 .100 f:between?
|
|
.100 .200 .300 f:between?</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:case</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> nm-n</p>
|
|
</div>
|
|
<p>If `n` is equal to `m`, drop both and execute the specified quote before exiting the calling word. If not equal, leave `n` on the stack and let execution continue.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:ceiling</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the smallest integral value greater than or equal to the specified value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:cos</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the cosine of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:dec</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> n-m</p>
|
|
</div>
|
|
<p>Decrement n by one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .100 f:dec</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:depth</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the number of items on the floating-point stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:drop</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Discard the top item on the floating-point stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:drop-pair</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-</p>
|
|
</div>
|
|
<p>Remove top two items on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:dump-astack</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display the items on the alternate floating-point stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:dump-stack</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display the items on the floating-point stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:dup</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-FF</p>
|
|
</div>
|
|
<p>Duplicate the top item on the floating-point stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:dup-pair</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> nm-nmnm</p>
|
|
</div>
|
|
<p>Duplicate the top two items on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:eq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-</p>
|
|
</div>
|
|
<p>Compare two floating-point values for equality. Returns `TRUE` if they are equal or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:fetch</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -n</p>
|
|
</div>
|
|
<p>Fetch a stored floating-point value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:floor</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Perform a mathematical floor operation on the floating-point value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:gt?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-</p>
|
|
</div>
|
|
<p>Compare two floating-point values for greater than.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:inc</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> n-m</p>
|
|
</div>
|
|
<p>Increment n by one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .100 f:inc</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:inf?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Return `TRUE` if floating-point value is INF or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:limit</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> nlu-m</p>
|
|
</div>
|
|
<p>Return n if it is within the lower (l) and upper (u) bounds. If outside the bounds, return the closes boundary value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .-10 .5 .8 f:limit
|
|
.10 .1 .15 f:limit</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:log</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-F</p>
|
|
</div>
|
|
<p>Return log(F1) for base F2 for floating-point values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:lt?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-</p>
|
|
</div>
|
|
<p>Compare two floating-point values for less than.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:max</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> mn-o</p>
|
|
</div>
|
|
<p>Return the greater of two values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .1 .7 f:max
|
|
.-8 .-10 f:max</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:min</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> mn-o</p>
|
|
</div>
|
|
<p>Return the lesser of two values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .1 .7 f:min
|
|
.-8 .-10 f:min</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:nan?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Return `TRUE` if floating-point value is NaN or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:negate</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Invert the sign of the floating-point value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .3.1415 f:negate</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:negative?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Return `TRUE` if floating-point value is negative or `FALSE` if not.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:nip</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> NM-M</p>
|
|
</div>
|
|
<p>Remove the second item from the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:over</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FG-FGF</p>
|
|
</div>
|
|
<p>Put a copy of the second floating-point value over the top one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:pop</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -F</p>
|
|
</div>
|
|
<p>Pop a floating-point value from the alternate stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:positive?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Return `TRUE` if floating-point value is positive or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:power</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FF-F</p>
|
|
</div>
|
|
<p>Return F1^F2 for floating-point values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:push</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Push a floating-point value to an alternative stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:put</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Display a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:rot</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> abc-bca</p>
|
|
</div>
|
|
<p>Rotate the top three values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:round</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> f-f</p>
|
|
</div>
|
|
<p>Round a floating-point value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:sign</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Return 1 if the floating-point value is positive or -1 if it is negative.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> .3.1415 f:sign</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>f:signed-sqrt</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the square root of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:signed-square</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> f-f</p>
|
|
</div>
|
|
<p>Return the square of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:sin</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the sine of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:sqrt</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the square root of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:square</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> f-f</p>
|
|
</div>
|
|
<p>Return the square of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:store</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> n-</p>
|
|
</div>
|
|
<p>Store a floating-point value to the specified memory location.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:swap</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FG-GF</p>
|
|
</div>
|
|
<p>Exchange the top and second items on the floating-point stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:tan</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-F</p>
|
|
</div>
|
|
<p>Return the tangent of a floating-point number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:to-e</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -e<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> n-</p>
|
|
</div>
|
|
<p>Encode the floating-point value to an integer.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:to-number</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Convert a floating-point value into a number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:to-string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> F-</p>
|
|
</div>
|
|
<p>Convert a floating-point value into a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>f:tuck</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> FG-GFG</p>
|
|
</div>
|
|
<p>Tuck a copy of the top floating-point value under the second one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>f</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>fetch</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the value stored at the specified address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> &Version fetch</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>fetch-next</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-an<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the value stored at the specified address. Returns the next address and the value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ffi:invoke</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Invoke an FFI function. Set the stack as needed, and pass the FFI handle to this.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:wrd</td></tr><tr><td><b>Namespace:</b> </td><td>ffi</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>ffi:map-sym</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Map in a symbol from a shared library or object file. Returns an FFI handle.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ffi</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>ffi:open</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Open a shared library or object file.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ffi</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>ffi:operation</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-?<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trigger an i/o operation using the FFI device.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ffi</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:A</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant for opening a file in APPEND mode.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:R</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant for opening a file in READ mode.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:R+</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant for opening a file in READ & WRITE mode.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:W</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant for opening a file in WRITE mode.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:close</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> h-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a file handle, close the file.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:delete</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Delete the named file.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:exists?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a file name, return `TRUE` if it exists or `FALSE` if it does not.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:flush</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> h-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a file handle, flush any pending writes to disk.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:for-each-line</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a file name, open it and run the quote once for each line in the file.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:open</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sm-h<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Open a named file (s) with the given mode (m). Returns a handle identifying the file.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> '/etc/motd file:R file:open</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>file:open-for-append</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Open a file for reading & writing. Returns the size (NOS) and a file ID (TOS)</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:open-for-reading</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Open a file for reading. Returns the size (NOS) and a file ID (TOS)</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:open-for-writing</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Open a file for writing. Returns the file ID</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:operation</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trigger a file I/O operation. This is not intended to be used directly.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:read</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> h-c<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a file handle, read and return the next byte in it.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:read-line</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> f-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a file handle, read a line and return a pointer to it.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:read/bytes</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> pnf-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a pointer, a count, and a file handle, read and store the requested number of bytes into memory, starting at the specified address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:read/c</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> h-c<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a file handle, read and return the next character in it. If compiled with UTF32 support this will read and convert UTF8.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:seek</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nh-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Move the current offset into a file to the specified one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:size</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> h-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a file handle, return the size of the file (in bytes).</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:slurp</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> as-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given an address and a file name, read the file contents into memory starting at the address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:spew</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a string (s1) and a file name (s2), write the string into the file, replacing any existing content.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:tell</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> h-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a file handle, return the current offset in the file.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:write</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ch-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Write a byte to the file represented by the handle.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:write/bytes</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> pnf-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Write n bytes to the file represented by the handle. Bytes are taken from memory, starting at the provided address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>file:write/c</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ch-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Write a character to the file represented by the handle. If built with UTF32 support, this will translate the character back to a UTF8 sequence before writing.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>file</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>fill</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> vpn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fill memory starting at "p" with value "v". Fills "n" cells.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:append/value</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> pv-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Append a cons cell to a list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:create</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> v-p<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a new list wit the given value as the car of the first node.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:del</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> pn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Remove the specified cons from a list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:drop</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> p-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Remove the last cons from a list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:for-each</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> pq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Run a quotation against each value in a list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:inject</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> pnv-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Insert a new cons (v) into the list (p), at the specified index (n).</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:length</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> p-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the length of a list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:put</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> p-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display the (as numbers) values in a list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:to-end</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> p-p<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a pointer to a list, return a pointer to the last cons cell.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>fll:to-index</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> pn-p<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a node number, return a pointer to the cons cell in the list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>rre</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>float:operation</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trigger a floating-point operation. This is not intended to be used directly.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>float</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>forever</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Run quotation in an endless loop.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>gc</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Save value of `Heap`, run the function provided, then restore `Heap`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>gopher:get</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> asns-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Takes an address, a server, a port, and a selector. Fetch the resource and store it at address. Return the number of bytes received.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>gopher</td></tr><tr><td><b>Interface Layer:</b> </td><td>ios</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> here 'forthworks.com #70 '/ gopher:get
|
|
here s:put</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>gt?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare n1 and n2. Return `TRUE` if n1 is greater than n2, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>gteq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare n1 and n2. Return `TRUE` if n1 is greater than or equal to n2, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>h:fetch</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the 16-bit value stored at the specified address. Addressing for this is in 8-bit units.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'>{n/a)</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>h:fetch-next</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-an<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the value stored at the specified address. Returns the next address and the value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>h</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>h:store</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store an 16-bit value into the specified address. Addressing for this is in 8-bit units.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>h:store-next</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a value into the specified address and return the next address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>h</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>here</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the next free address in memory.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>hex</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set `Base` to hexadecimal.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>hook</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Add a hook point into the current word. This should only be used as the first word in a definition.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>global</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> :foo hook ;</xmp>
|
|
</p>
|
|
<p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> :bar hook (default_action: n:square n:put nl ;</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>i</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Assemble the instructions specified by the string into the current assembly scope.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>if</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> fq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute the quote if the flag is `TRUE`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>if;</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> fq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute the quotation if the flag is `TRUE`. If true, also exit the word.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>image:save</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Save the current system to a new image file.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>image</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>immediate</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Change the class of the most recently defined word to `class:macro`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>include</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Run the code in the specified file. </p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>indexed-times</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Run a quote the specified number of times, tracking the loop index in `I`. This is less efficient than `times`, so if the index is not needed, this should be avoided.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>interpret</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Vectored. Interpret a single input token.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> '#100 interpret
|
|
'words interpret</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>io:core</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trigger an I/O operation involving multicore support. Unix system call.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>io</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>io:enumerate</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the number of I/O devices.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>io</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>io:invoke</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Invoke an interaction with an I/O device.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>io</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>io:query</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-mN<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Ask an I/O device to identify itself. Returns a version (m) and device ID (N).</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>io</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>io:scan-for</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-m<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Scan the I/O devices for a device with a specified ID. Returns the device number, or -1 if not found.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>io</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>io:unix-syscall</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trigger a Unix system call. This is not intended to be used directly.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>io</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>library:.CONFIG</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Data. Return a template for a library file name in `~/.config/retroforth/library`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>library:.config</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Find the users home directory and construct a filename for a library in the `~/.config/retroforth/library` directory.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>library:CWD</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Data. Return a template for a library file name in `./library`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>library:contains?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Check to see if a library exists.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>library:cwd</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Construct a filename for a library in the `~/library` directory.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>library:filename</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given a library name, construct the actual filename to load.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>library:load</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Load a library. This will load the string, with ".retro".</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>listen</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>"Run interactive ""listener"" (a REPL)."</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>lt?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare n1 and n2. Return `TRUE` if n1 is less than n2, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>lteq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare n1 and n2. Return `TRUE` if n1 is less than or equal to n2, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>mem:alloc</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Use malloc to allocate memory. Returns a double cell pointer to this memory.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>mem:cell+</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nnn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return address of next cell. Uses a double cell pointer on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>mem:fetch</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch value from malloc'd memory region. Address is a double cell value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>mem:fetch-double</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch a double cell value from a malloc memory region.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>mem:free</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fre a malloc'd region of memory. Pass a double cell pointer to the memory to free.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>mem:resize</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> mmn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Resize a malloc'd memory area.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>mem:store</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xnn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a value into a malloc'd memory region. Uses a double cell pointer for the address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>mem:store-double</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xxnn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a double value into a malloc'd memory region. Uses a double cell pointer for the address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>mem</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>mod</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-o<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Divide `n` by `m` and return the remainder.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:-zero?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if number is not zero, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:MAX</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the maximum value that will fit in a cell.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:MIN</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the minimum value that will fit in a cell.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:abs</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the absolute value of a number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #10 n:abs
|
|
#-10 n:abs
|
|
</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:add</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Add `n1` to `n2` and return the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 #2 + </xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:between?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nlu-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if number is between the lower (l) and upper (u) bounds. If not, return FALSE. This is inclusive of the limits.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #3 #1 #100 n:between?
|
|
$q $a $b n:between?</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:dec</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-m<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Decrement n by one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #100 n:dec</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:div</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-v<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Divide `n` by `m` and return the integer part of the quotient.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:divmod</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-rv<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Divide `n` by `m` and return the integer part of the quotient and remainder.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:even?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if number is even, or `FALSE` if not.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #12 n:even?
|
|
#11 n:even?</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:inc</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-m<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Increment n by one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #100 n:inc</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:limit</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nlu-m<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return n if it is within the lower (l) and upper (u) bounds. If outside the bounds, return the closes boundary value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #-10 #5 #8 n:limit
|
|
#10 #1 #15 n:limit</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:max</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> mn-o<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the greater of two values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 #7 n:max
|
|
#-8 #-10 n:max</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:min</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> mn-o<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the lesser of two values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 #7 n:min
|
|
#-8 #-10 n:min</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:mod</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-o<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Divide `n` by `m` and return the remainder.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:mul</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Multiply `n1` by `n2` and return the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #2 #6 *
|
|
#-1 #100 *</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:negate</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Invert the sign of a number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #10 n:negate
|
|
#-10 n:negate</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:negative?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if number is negative, or `FALSE` if not.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:odd?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if number is odd, or `FALSE` if not.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:positive?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if number is positive, or `FALSE` if not.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:pow</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> bp-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return base (b) to power (p).</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:put</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display a number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:random</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a random number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> n:random n:put</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:sqrt</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-m<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the square root of a number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:square</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-m<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the square of a number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:strictly-positive?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return TRUE if number is greater than zero or FALSE if it is zero or less.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:sub</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Subtract `n2` from `n1` and return the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #2 #1 - </xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>n:to-float</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -F</p>
|
|
</div>
|
|
<p>Convert a number into a floating-point value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>n:to-string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert a number into a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>n:zero?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if number is zero, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>n</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>nip</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-m<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Remove the second item from the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>nl</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display a newline.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>not</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-m<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Perform a logical NOT operation.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>octal</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set `Base` to octal.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>a</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>or</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> mn-o<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Perform a bitwise OR between the provided values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>over</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-nmn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Put a copy of n over m.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>pack</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nnnn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Pack four 8-bit values into a 32-bit value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>parse-until</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Read input from stdin (via `c:get`) until the returned character is matched by the quote. Returns a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>all</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> :read-until-period (-s)
|
|
[ $. eq? ] parse-until ;</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>pb:get</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Copy a string from the pasteboard to the specified address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>pb</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS</td></tr></table><hr/>
|
|
<h2>pb:length</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the length of the string on the pasteboard.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>pb</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'>pb</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>pb:set</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Copy a string to the pasteboard.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>pb</td></tr><tr><td><b>Interface Layer:</b> </td><td>iOS</td></tr></table><hr/>
|
|
<h2>pop</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> n-<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Move a value from the return stack to the data stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>primitive</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Change the class of the most recently defined word to `class:primitive`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>push</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -n<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Move a value from the data stack to the return stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>r</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Lookup a reference by name and inline its pointer to the current assembly segment.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>reclass</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Change the class handler of the most recently defined word to the specified one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>reorder</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...ss-?<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Restructure the order of items on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>repeat</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Begin an unconditional loop.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>reset</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Remove all items from the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>rot</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> abc-bca<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Rotate the top three values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s,</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compile the code needed to push a string pointer to the stack and inline the string data into the current definition.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:ASCII-LETTERS</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Returns a string of the ASCII letters (upper and lower case)</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:ASCII-LOWERCASE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Returns a string of the ASCII letters in lowercase</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:ASCII-UPPERCASE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Returns a string of the ASCII letters in uppercase</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:DIGITS</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Return a string of characters recognized as numeric digits.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:PUNCTUATION</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Return a string of characters recognized as punctuation.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:WHITESPACE</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Constant. Returns a string of characters recognized as whitespace.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:data</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:append</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new string consisting of s1 followed by s2.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:begins-with?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if s1 begins with s2 or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:case</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sSq- || sSq-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>If the `s` matches `S`, discard `s` and run the quote before exiting the caller. If they do not match, discard the quote and leave `s` on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:chop</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Remove the last character from a string. Returns a new string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:const</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a constant named s2, returning a pointer to s1. This will use `s:keep` to preserve the original string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:contains/char?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sc-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if the character is present in the string or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:contains/string?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if the second string is present in the first string or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:copy</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sa-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Copy a string (s) to a destination (a). This will include the terminator character when copying.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:dedup</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a deduplicated version of the string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>s:dedup.data</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Variable. Holds a pointer to the deduplication list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>s:dedup.defined?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Check to see if a string is in the deduplication list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>s:dedup.find</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a pointer to a deduplicated copy of a string. If the string is not in the deduplication list, this will cause errors.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>s:dedup.register</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Add a string to the deduplication list.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>s:empty</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return an empty string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:ends-with?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return `TRUE` if s1 ends with s2 or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:eq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare two strings for equality. Return `TRUE` if identical or `FALSE` if not.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'hello 'again s:eq?
|
|
'test 'test s:eq?</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>s:evaluate</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-?<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -?</p>
|
|
</div>
|
|
<p>Evaluate string as if it was typed into the interpreter.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:fetch</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the character value stored at the specified index in the string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'abcdef #2 s:fetch</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>s:filter</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sq-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute the quote once for each value in the string. If the quote returns `TRUE`, append the value into a new string. If `FALSE` the value will be discarded.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:for-each</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute the quote once for each value in the string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:format</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Construct a new string using the template passed and items from the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:get</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Read input from standard in (via `c:get`) until a CR or LF is encountered. Returns a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>all</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>s:get-word</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Read input from standard in (via `c:get`) until a whitespace is encountered. Returns a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>all</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>s:hash</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Calculate a hash value for a string. This uses the djb2 algorithm.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:index/char</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sc-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the location of the first instance of the specified character in the string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:index/string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the location of the first instance of the specified substring (s2) in the string (s1). Returns -1 if not found.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:keep</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a string into the heap and return a pointer to the start of it.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:left</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sn-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new string containing the first `n` characters from the source string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:length</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the number of characters in a string, excluding the NULL terminator.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:map</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sq-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute the specified quote once for each character in the string. Builds a new string from the return value of the quote. The quote should return only one value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:prepend</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new string consisting of s2 followed by s1.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:put</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:replace</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sss-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Replace the first instance of s2 in s1 with s3.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:replace-all</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sss-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Replace all instances of s2 in s1 with s3.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:reverse</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Reverse the order of ASCII characters in a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:right</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sn-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a new string containing the specified number of characters from the right side of the string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:skip</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Internal helper function used to skip over a string in a definition.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:split/char</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sc-ss<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Split a string on the first occurrence of the specified character.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:split/string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-ss<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Split a string on the first occurrence of the specified string. After the split, the top stack item will be the part of the string before the specified substring, and the second item will be the rest of the original string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'Hello_Brave_World! 'Brave s:split-on-string s:put nl s:put nl</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>s:store</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> csn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a character value into the string at the specified index.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> $z 'abcdef #1 s:store</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>s:substr</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sfl-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Extract a substring from the specified string. This will take the characters starting at `f` and extend `l` characters in length.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:temp</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Move a string into the temporary string buffers.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:to-float</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -F</p>
|
|
</div>
|
|
<p>Convert a string representation into a floating-point value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>s:to-lower</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert uppercase ASCII characters in a string to lowercase.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:to-number</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert a string to a number.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:to-upper</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert lowercase ASCII characters in a string to uppercase.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:tokenize</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sc-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Takes a string and a character to use as a separator. It splits the string into substrings and returns an array containing pointers to each of them.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:tokenize-on-string</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Takes a string (s1) and a substring (s2) use as a separator. It splits the string into substrings and returns as array containing pointers to each of them.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>s:trim</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trim leading and trailing whitespace from a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> '__hello__ s:trim</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>s:trim-left</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trim leading whitespace from a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> '__hello__ s:trim-left</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>s:trim-right</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trim trailing whitespace from a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> '__hello__ s:trim-right</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>s:unique?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Alias for `s:dedup.defined?`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>s</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>script:abort-include</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Discard remaining tokens on the current line being evaluated. This only works when including a file, not at the interpreter.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>sys</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>script:arguments</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the number of arguments passed to the program.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>sys</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>script:current-file</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the filename of the file being processed by the current `include`, or `/dev/stdin` if the input source is the terminal.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>sys</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>script:current-line</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current line number of the file being processed by the current `include`, or `0` if the input source is the terminal. Line numbering starts at 1.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>script</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>script:current-line-text</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the text of the current line being processed by the current `include`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>script</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>script:get-argument</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Given an argument number, return the argument as a string.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>script</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>script:ignore-to-eof</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Discard remaining lines in the file currently being evaluated. This only works when including a file, not at the interpreter.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>script</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>script:ignore-to-eol</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Discard remaining tokens in the current line. This only works when including a file, not at the interpreter.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>script</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>script:name</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the filename of the program being run.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>script</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>set-hook</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aa-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Patch the hook point in a2 to point to a1.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> :foo hook ;
|
|
:bar #1 ;
|
|
&bar &foo set-hook</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>shift</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> mn-o<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Peform a bitwise shift of m by n bits. If n is positive, shift right. If negative, the shift will be to the left.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:!</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ns-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a value into a variable.</p>
|
|
<p>Interpret Time:
|
|
Store a value into the named variable.</p>
|
|
|
|
<p>Compile Time:
|
|
Compile the code to store a value into a named variable.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:#</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Process token as a number.</p>
|
|
<p>Interpret Time:
|
|
Convert the string into a number and leave on the stack.</p>
|
|
|
|
<p>Compile Time:
|
|
Convert the string into a number and compile into the current definition as a literal.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:$</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-c<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Process token as an ASCII character.</p>
|
|
<p>Interpret Time:
|
|
Fetch first character from string. Leave on stack.</p>
|
|
|
|
<p>Compile Time:
|
|
Fetch first character from the string. Compile into the current definition as literal.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:&</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return a pointer to a named item. If name is not found, returns 0.</p>
|
|
<p>Interpret Time:
|
|
Lookup name in dictionary, return contents of the xt field on the stack.</p>
|
|
|
|
<p>Compile Time:
|
|
Lookup name in dictionary, compile code to push the contents of the xt field into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:'</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Process token as a string.</p>
|
|
<p>Interpret Time:
|
|
Move string into temporary buffer. If `RewriteUnderscores` is `TRUE`, replace all instances of _ with space.</p>
|
|
|
|
<p>Compile Time:
|
|
Move string into temporary buffer. If `RewriteUnderscores` is `TRUE`, replace all instances of _ with space. Then compile the string into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:(</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Process token as a comment.</p>
|
|
<p>Interpret Time:
|
|
Discard the string.</p>
|
|
|
|
<p>Compile Time:
|
|
Discard the string.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:.</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -F</p>
|
|
</div>
|
|
<p>Interpret time: convert string to a floating-point value. Compile time: convert string to a floating-point value and compile code to push this value to the float stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>sigil::</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Hook. Process token as a new definition.</p>
|
|
<p>Interpret Time:
|
|
Create a header pointing to `here` with the provided string as the name. Sets class to `class:word`.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:@</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch from a stored variable.</p>
|
|
<p>Interpret Time:
|
|
Fetch a value from a named variable.</p>
|
|
|
|
<p>Compile Time:
|
|
Compile the code to fetch a value from a named variable into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:\</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Process token as an instruction bundle.</p>
|
|
<p>Interpret Time:
|
|
Discard the string.</p>
|
|
|
|
<p>Compile Time:
|
|
Assemble the opcodes in the string and use `,` to inline it into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:^</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Process token as a function reference.</p>
|
|
<p>Interpret Time:
|
|
Discard the string.</p>
|
|
|
|
<p>Compile Time:
|
|
Comma the XT of the word into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:`</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Process token as a bytecode.</p>
|
|
<p>Interpret Time:
|
|
Discard the string.</p>
|
|
|
|
<p>Compile Time:
|
|
Convert the string to a number and use `,` to inline it into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sigil:|</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>POSTPONE equivalent.</p>
|
|
<p>Interpret Time:
|
|
Discard the string.</p>
|
|
|
|
<p>Compile Time:
|
|
Convert the string to a number and use `,` to inline it into the current definition.</p>
|
|
|
|
<table><tr><td><b>Class:</b> </td><td>class:macro</td></tr><tr><td><b>Namespace:</b> </td><td>sigil</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>sip</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nq(?n-?)-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Run quote. After execution completes, put a copy of n back on top of the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>socket:accept</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Begin accepting connections. Returns a new socket and an error code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:bind</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sn-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Bind a socket to a port. The port should be a string. Returns 0 if successful or -1 otherwise and an error code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:close</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Close a socket.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:configure</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Configure internal settings for a host (s1) and port (s2). Use before `socket:bind`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:connect</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Connect to a server. Provide a socket, this will return a status flag and an error code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:create</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Obtain a new socket.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:gethostbyname</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> as-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Get the host IP in dotted notation. The host is specified by the string and the address is the start of the buffer for the dotted IP.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:listen</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Prepare a socket for accepting incoming connections. Takes a backlog count (n1) and a socket (n2). Returns a flag (0 success, -1 failed) and an error code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:operation</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Trigger a socket operation. This is not intended to be used directly.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:recv</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ann-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Receive data from a socket. This will read into memory starting at address *a*, up to *n1* bytes. *n2* is the socket. Returns the number of bytes read and an error code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>socket:send</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sn-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Send a string to a socket. This will return the number of characters sent and an error code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>socket</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>sp</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display a space (`ASCII:SPACE`)</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> :spaces (n-) [ sp ] times ;
|
|
#12 spaces</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>store</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a value into the specified address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'Base var
|
|
#10 &Base store</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>store-next</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a value into the specified address and return the next address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>swap</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-mn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Exchange the position of the top two items on the stack</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>tab</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display a tab (`ASCII:HT`)</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>tail-recurse</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Convert a call before the semicolon to a jump.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>times</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Run the specified quote the specified number of times.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #12 [ $- c:put ] times</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>tri</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xqqq-?<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Apply q1 against x, then q2 against a copy of x, and finally q3 against another copy of x.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>tri*</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xyzqqq-?<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Apply q1 against x, q2 against y, and q3 against z.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>tri@</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xyzq-?<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Apply q against x, then against y, and finally against z.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>tuck</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-mnm<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Put a copy of the top item on the stack under the second one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>ui:add-view</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Add view named `s` to the displayed views.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:create-view</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a new view. `s1` is the name and `s2` is the type.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:get-action</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the address of the Retro handler for a view's associated action.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:get-position</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the row and column of the named view.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:get-size</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-nn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the height and width of the named view.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:get-text</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Get the value of the text property of the named view.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:get-title</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Get the value of the title property for the named view.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:operation</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ...n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Carry out a UI operation. Used internally by the other `ui:` words.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:present</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Display all views.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:remove-view</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Remove view named `s` from the displayed views.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:set-action</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> as-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set the action handler for a view to the specified Retro word address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:set-position</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nns-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Move view `s` to row `n1` and column `n2`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:set-size</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nns-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set view `s` to height `n1` and width `n2`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:set-text</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set the text property of view `s2` to `s1`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>ui:set-title</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set the title property of view `s2` to `s1`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>ui</td></tr><tr><td><b>Interface Layer:</b> </td><td>retro/python</td></tr></table><hr/>
|
|
<h2>unhook</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Reset the hook point in a1 to the default definition.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> :foo hook #1 ;
|
|
:bar #2 ;
|
|
&bar &foo set-hook
|
|
&foo unhook</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unix:chdir</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Change the current working directory to the specified one.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> '/etc unix:chdir</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unix:count-files-in-cwd</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the number of files (and subdirectories) in the current working directory</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:exec0</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute a process by running the application specified by s.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:exec1</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute a process by running the application specified by s1. Pass s2 as an argument.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:exec2</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute a process by running the application specified by s1. Pass s2 and s3 as arguments.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:exec3</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ssss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute a process by running the application specified by s1. Pass s2, s3, and s4 as arguments.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:execute</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Runs another application and return after execution is completed. This does not invoke the shell like `unix:system` and does not support globbing.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'ls_-lh_/etc unix:system</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unix:exit</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Exit the current process, returning the specified return code.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:for-each-file</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Run a quote once for each file or subdirectory in the current directory. The quote will receive the file name as a string and should consume this and return nothing on the stack.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:fork</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fork the current process. Returns a PID.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:get-cwd</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -s<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the current working directory</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:getenv</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sa-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Get an environment variable. Provide the name and an address to store it in.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'SHELL s:empty [ unix:getenv ] sip s:put nl</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unix:getpid</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Return the PID of the current process.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:kill</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Terminates a process. Takes a process and a signal to send.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:pclose</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Close a pipe.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:pipe</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Takes a string with a Unix command line and run it in a pipe, returning a new string with the first line of the output from the pipe.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'ls_-l unix:pipe s:put nl</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unix:popen</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> sn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Open a pipe. Takes a command to run, and a file mode (`file:R` or `file:W`; `file:R+` may work on some systems). Returns a file ID usable with words in the `file:` namespace.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:putenv</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Takes a string in the form `name=value` and sets an environment variable named `name` to `value`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'EDITOR=vi unix:putenv</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unix:sleep</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Sleep for the specified number of seconds.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:slurp-pipe</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> as-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Open a pipe. Read all output from the pipe (until ASCII:NULL) and store in the specified buffer. Return the number of bytes read.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unix:system</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Runs another application using the system shell and returns after execution is completed.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'ls_-lh_/etc unix:system</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unix:wait</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Waits for a child process to complete. This maps to the wait() system call.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unix</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unpack</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> n-nnnn<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Unpack a 32-bit value into four 8-bit values.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>unsigned:*</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Multiply `n1` by `n2` and return the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unsigned</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #2 #6 unsigned:*
|
|
#-1 #100 unsigned:*</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unsigned:*/mod</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> xyz-rv<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Multiply `x` by `y` and then divide by `z` and return the integer part of the quotient and remainder.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>rre</td></tr></table><hr/>
|
|
<h2>unsigned:+</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Add `n1` to `n2` and return the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unsigned</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 #2 unsigned:+ </xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unsigned:-</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Subtract `n2` from `n1` and return the result.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unsigned</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #2 #1 unsigned:- </xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unsigned:-eq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare two values for inequality. Returns `TRUE` if they are not equal or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unsigned</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 #2 unsigned:-eq?
|
|
$a $b unsigned:-eq?</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unsigned:/mod</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nm-rv<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Divide `n` by `m` and return the integer part of the quotient and remainder.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unsigned</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>unsigned:eq?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare two values for equality. Returns `TRUE` if they are equal or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unsigned</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #1 #2 unsigned:eq?
|
|
$a $b unsigned:eq?</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>unsigned:gt?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare n1 and n2. Return `TRUE` if n1 is greater than n2, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unsigned</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>unsigned:lt?</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> nn-f<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Compare n1 and n2. Return `TRUE` if n1 is less than n2, or `FALSE` otherwise.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unsigned</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>unsigned:shift</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> mn-o<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Peform a bitwise shift of m by n bits. If n is positive, shift right. If negative, the shift will be to the left.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>unsigned</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>until</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q(-f)-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute quote repeatedly while the quote returns a value of `FALSE`. The quote should return a flag of either `TRUE` or `FALSE`, though `until` will treat any non-zero value as `TRUE`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #10 [ dup n:put nl n:dec dup n:zero? ] until</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>v:dec</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Decrement the value stored at the specified address by 1.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>v</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>v:dec-by</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Decrement the value stored at the specified address by the specified value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>v</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>v:inc</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Increment the value stored at the specified address by 1.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>v</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>v:inc-by</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Increment the value stored at the specified address by the specified value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>v</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>v:limit</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> alu-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the value stored at the address, then run `n:limit` against it, using the specified lower and upper bounds. Then store the resulting value back to the original address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>v</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>v:off</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set a variable to 0.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>v</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>v:on</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Set a variable to -1.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>v</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>v:preserve</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Make a copy of the value at the address, then run the quote. Once the quote completes, restore the address to the specified value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>v</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>v:update</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> aq-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch a value from the specified address, then run the quotation with this value on the stack. Afterwards, store the returned value at the original address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>v</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>var</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> s-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a variable. The variable is initialized to 0.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'Base var</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>var-n</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ns-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a variable with the specified initial value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #10 'Base var-n
|
|
</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>var-s</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> ss-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Create a variable with the specified initial value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> 'Test 'Word var-s
|
|
</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>w:fetch</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-n<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the 32-bit value stored at the specified address. Addressing for this is in 8-bit units. The address must be aligned on a four byte boundary.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'>{n/a)</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>w:fetch-next</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> a-an<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Fetch the value stored at the specified address. Returns the next address and the value.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>w</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>w:store</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store an 32-bit value into the specified address. Addressing for this is in 8-bit units. The address must be aligned on a four byte boundary.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>w:store-next</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> na-a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Store a value into the specified address and return the next address.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>w</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>while</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> q(-f)-<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Execute quote repeatedly while the quote returns a `TRUE` value. The quote should return a flag of either `TRUE` or `FALSE`, though `while` will treat any non-zero value as `TRUE`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><p><b>Example:</b> <br>
|
|
<br>
|
|
<xmp style='background:#f2f2f2'> #10 [ dup n:put nl n:dec dup n:-zero? ] while</xmp>
|
|
</p>
|
|
<hr/>
|
|
<h2>xor</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> mn-o<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Perform a bitwise XOR operation.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:primitive</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>{</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Begin an array. This is intended to make creating arrays a bit cleaner than using a quotation and `a:counted-results`.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>{{</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Begin a lexically scoped area.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>}</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>Complete an array begun by `{`. Returns a pointer to the data.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|
|
<h2>}}</h2>
|
|
<div style='margin-left: 1em;'><p><b>Data:</b> -<br>
|
|
<b>Addr:</b> -<br>
|
|
<b>Float:</b> -</p>
|
|
</div>
|
|
<p>End a lexically scoped area. This will hide any headers between `{{` and `---reveal---`, leaving only headers between `---reveal---` and the `}}` visible.</p>
|
|
<table><tr><td><b>Class:</b> </td><td>class:word</td></tr><tr><td><b>Namespace:</b> </td><td>global</td></tr><tr><td><b>Interface Layer:</b> </td><td>all</td></tr></table><hr/>
|