crc/retroforth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

more glossary updates

Browse source 
FossilOrigin-Name: 4cfe1f3b58b493f0ed5769ce817ce69bdce73f90657470ab934d312d78abe6f8
This commit is contained in:
crc 2019-10-14 20:59:08 +00:00
parent 5cf232571e
commit 25dcf051d6
5 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
RELEASE-NOTES
View file

@ -82,6 +82,7 @@ Documentation
- fix some namespace listings in the glossary
- correct an example in the book
- formatting improvements in html for glossary server
- minor expansions to the descriptions in the glossary
Kernel

6
doc/Glossary-Concise.txt
View file

@ -188,7 +188,7 @@ RewriteUnderscores D: -a A: - F: -
Variable. When set to `TRUE`, RETRO will replace underscores in strings with spaces. When `FALSE`, RETRO does not.
STRINGS D: -a A: - F: -
Return the address of the start of the temporary string pool.
Return the address of the start of the temporary string pool. This can be altered by changing the values of `TempStrings` and `TempStringMax`.
ScopeList D: -a A: - F: -
Variable. This holds some information used by `{{` and `}}`.
@ -422,7 +422,7 @@ case D: nmq- || nmq-n A: - F: -
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.
choose D: fqq- A: - F: -
Execute q1 if the flag is true (-1) or q2 if the flag is false (0). Only these flags are valid when using `choose`.
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.
class:data D: n- || n-n A: - F: -
Class handler for data structures.
@ -1352,7 +1352,7 @@ times D: nq- A: - F: -
Run the specified quote the specified number of times.
times<with-index> D: nq- A: - F: -
Run a quote the specified number of times, tracking the loop index in `I`.
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.
tri D: xqqq-? A: - F: -
Apply q1 against x, then q2 against a copy of x, and finally q3 against another copy of x.

6
doc/Glossary.html
View file

@ -471,7 +471,7 @@
<b>Addr:</b> -<br>
<b>Float:</b> -</p>
</div>
<p>Return the address of the start of the temporary string pool.</p>
<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/>
<h1>ScopeList</h1>
<div style='margin-left: 1em;'><p><b>Data:</b> -a<br>
@ -1041,7 +1041,7 @@
<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`.</p>
<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/>
<h1>class:data</h1>
<div style='margin-left: 1em;'><p><b>Data:</b> n- || n-n<br>
@ -3471,7 +3471,7 @@
<b>Addr:</b> -<br>
<b>Float:</b> -</p>
</div>
<p>Run a quote the specified number of times, tracking the loop index in `I`.</p>
<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/>
<h1>tri</h1>
<div style='margin-left: 1em;'><p><b>Data:</b> xqqq-?<br>

6
doc/Glossary.txt
View file

@ -730,7 +730,7 @@ STRINGS
Addr: -
Float: -
Return the address of the start of the temporary string pool.
Return the address of the start of the temporary string pool. This can be altered by changing the values of `TempStrings` and `TempStringMax`.
Class: class:word | Namespace: global | Interface Layer: all
------------------------------------------------------------------------
@ -1618,7 +1618,7 @@ choose
Addr: -
Float: -
Execute q1 if the flag is true (-1) or q2 if the flag is false (0). Only these flags are valid when using `choose`.
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.
Class: class:word | Namespace: global | Interface Layer: all
------------------------------------------------------------------------
@ -5326,7 +5326,7 @@ times<with-index>
Addr: -
Float: -
Run a quote the specified number of times, tracking the loop index in `I`.
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.
Class: class:word | Namespace: global | Interface Layer: all
------------------------------------------------------------------------

6
words.tsv
View file

@ -61,7 +61,7 @@ J -n - - Access the parent loop index for the current loop. (For loops made usin
K -n - - Access the grandparent loop index for the current loop. (For loops made using `times<with-index>`) class:word {n/a} {n/a} global all
NoEcho -a - - Variable. If TRUE, allow display of the "ok" prompt and startup banner. class:word {n/a} {n/a} global rre
RewriteUnderscores -a - - Variable. When set to `TRUE`, RETRO will replace underscores in strings with spaces. When `FALSE`, RETRO does not. class:data {n/a} {n/a} global all
STRINGS -a - - Return the address of the start of the temporary string pool. class:word {n/a} {n/a} global all
STRINGS -a - - Return the address of the start of the temporary string pool. This can be altered by changing the values of `TempStrings` and `TempStringMax`. class:word {n/a} {n/a} global all
ScopeList -a - - Variable. This holds some information used by `{{` and `}}`. class:data {n/a} {n/a} global all
TIB -a - - Constant. Returns a pointer to the text input buffer. class:data {n/a} {n/a} global rre
TRUE -n - - Returns `-1`, the value used to indicate a TRUE result. class:word {n/a} {n/a} global all
@ -139,7 +139,7 @@ c:vowel? c-f - - Return TRUE if character is a vowel or FALSE otherwise. class
c:whitespace? c-f - - Return TRUE if character is whitespace, or FALSE otherwise. class:word {n/a} {n/a} c all
call a- - - Call a function. class:primitive {n/a} {n/a} global all
case nmq- || nmq-n - - 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. class:word {n/a} {n/a} global all
choose fqq- - - Execute q1 if the flag is true (-1) or q2 if the flag is false (0). Only these flags are valid when using `choose`. class:word {n/a} {n/a} global all
choose fqq- - - 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. class:word {n/a} {n/a} global all
class:data n- || n-n - - Class handler for data structures. Keep the address or value on the stack. Compile the value or address as a literal into the current definition. class:word {n/a} {n/a} class all
class:macro a- - - Class handler for compiler macros (immediate words) Execute the function at the provided address. Execute the function at the provided address. class:word {n/a} {n/a} class all
class:primitive a- - - Class handler for primitive words (words which map to Nga instructions) Execute the function. Compile the machine code in the definiton into the current definition. class:word {n/a} {n/a} class all
@ -449,7 +449,7 @@ sys:argv n-s - - Given an argument number, return the argument as a string. cl
sys:name -s - - Return the filename of the program being run. class:word {n/a} {n/a} sys rre
tab - - - Display a tab (`ASCII:HT`) class:word {n/a} {n/a} global all
times nq- - - Run the specified quote the specified number of times. class:word #12 [ $- c:put ] times {n/a} global all
times<with-index> nq- - - Run a quote the specified number of times, tracking the loop index in `I`. class:word {n/a} {n/a} global all
times<with-index> nq- - - 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. class:word {n/a} {n/a} global all
tri xqqq-? - - Apply q1 against x, then q2 against a copy of x, and finally q3 against another copy of x. class:word {n/a} {n/a} global all
tri* xyzqqq-? - - Apply q1 against x, q2 against y, and q3 against z. class:word {n/a} {n/a} global all
tri@ xyzq-? - - Apply q against x, then against y, and finally against z. class:word {n/a} {n/a} global all

Can't render this file because it contains an unexpected character in line 62 and column 55.