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

add block: words and rest of mem: words to glossary

Browse source 
FossilOrigin-Name: 1ae4c608cf65d3c29faabaff2ed627d26579b796f56867a7a254c4df60ad205b
This commit is contained in:
crc 2022-08-22 10:03:44 +00:00
parent ef2e2e05df
commit 6474a66c42
5 changed files with 92 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/Glossary-Concise.txt
View file

@ -361,6 +361,15 @@ Execute q against x, then execute q against y.
binary D: - A: - F: -
Set `Base` to binary.
block:read D: an- A: - F: -
Read 1024 cells from block n in the block storage into memory at address a.
block:set-file D: s- A: - F: -
Set the file name of the block storage device.
block:write D: an- A: - F: -
Save the 1024 cells at address a to block n in the block storage.
buffer:add D: n- A: - F: -
Append a value to the current buffer.
@ -1093,6 +1102,9 @@ Fetch a double cell value from a malloc memory region.
mem:free D: nn- A: - F: -
Fre a malloc'd region of memory. Pass a double cell pointer to the memory to free.
mem:resize D: mmn- A: - F: -
Resize a malloc'd memory area.
mem:store D: xnn- A: - F: -
Store a value into a malloc'd memory region. Uses a double cell pointer for the address.

4
doc/Glossary-Names-and-Stack.txt
View file

@ -119,6 +119,9 @@ bi D: xqq-? A: - F: -
bi* D: xyqq-? A: - F: -
bi@ D: xyq-? A: - F: -
binary D: - A: - F: -
block:read D: an- A: - F: -
block:set-file D: s- A: - F: -
block:write D: an- A: - F: -
buffer:add D: n- A: - F: -
buffer:empty D: - A: - F: -
buffer:end D: -a A: - F: -
@ -363,6 +366,7 @@ mem:cell+ D: nnn-n A: - F: -
mem:fetch D: nn-n A: - F: -
mem:fetch-double D: nn-n A: - F: -
mem:free D: nn- A: - F: -
mem:resize D: mmn- A: - F: -
mem:store D: xnn- A: - F: -
mod D: nm-o A: - F: -
n:-zero? D: n-f A: - F: -

28
doc/Glossary.html
View file

@ -904,6 +904,27 @@
</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> an-<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> an-<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>
@ -2719,6 +2740,13 @@
</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>

44
doc/Glossary.txt
View file

@ -1402,6 +1402,39 @@ Set `Base` to binary.
Class: class:word | Namespace: a | Interface Layer: all
------------------------------------------------------------------------
block:read
Data: an-
Addr: -
Float: -
Read 1024 cells from block n in the block storage into memory at address a.
Class: class:word | Namespace: block | Interface Layer: rre
------------------------------------------------------------------------
block:set-file
Data: s-
Addr: -
Float: -
Set the file name of the block storage device.
Class: class:word | Namespace: block | Interface Layer: rre
------------------------------------------------------------------------
block:write
Data: an-
Addr: -
Float: -
Save the 1024 cells at address a to block n in the block storage.
Class: class:word | Namespace: block | Interface Layer: rre
------------------------------------------------------------------------
buffer:add
Data: n-
@ -4212,6 +4245,17 @@ Fre a malloc'd region of memory. Pass a double cell pointer to the memory to fre
Class: class:word | Namespace: mem | Interface Layer: rre
------------------------------------------------------------------------
mem:resize
Data: mmn-
Addr: -
Float: -
Resize a malloc'd memory area.
Class: class:word | Namespace: mem | Interface Layer: rre
------------------------------------------------------------------------
mem:store
Data: xnn-

4
doc/words.tsv
View file

@ -119,6 +119,9 @@ bi xqq-? - - Execute q1 against x, then execute q2 against a copy of x. class:
bi* xyqq-? - - Execute q1 against x and q2 against y. class:word #10 #20 [ #2 * ] [ #10 / ] bi* {n/a} global all
bi@ xyq-? - - Execute q against x, then execute q against y. class:word #10 #20 [ #3 * ] bi@ {n/a} global all
binary - - - Set `Base` to binary. class:word {n/a} {n/a} a all
block:read an- - - Read 1024 cells from block n in the block storage into memory at address a. class:word {n/a} {n/a} block rre
block:set-file s- - - Set the file name of the block storage device. class:word {n/a} {n/a} block rre
block:write an- - - Save the 1024 cells at address a to block n in the block storage. class:word {n/a} {n/a} block rre
buffer:add n- - - Append a value to the current buffer. class:word {n/a} {n/a} buffer all
buffer:empty - - - Reset the current buffer to an empty state. class:word {n/a} {n/a} buffer all
buffer:end -a - - Return a pointer to the current end of the active buffer. class:word {n/a} {n/a} buffer all
@ -363,6 +366,7 @@ mem:cell+ nnn-n - - Return address of next cell. Uses a double cell pointer on t
mem:fetch nn-n - - Fetch value from malloc'd memory region. Address is a double cell value. class:word {n/a} {n/a} mem rre
mem:fetch-double nn-n - - Fetch a double cell value from a malloc memory region. class:word {n/a} {n/a} mem rre
mem:free nn- - - Fre a malloc'd region of memory. Pass a double cell pointer to the memory to free. class:word {n/a} {n/a} mem rre
mem:resize mmn- - - Resize a malloc'd memory area. class:word {n/a} {n/a} mem rre
mem:store xnn- - - Store a value into a malloc'd memory region. Uses a double cell pointer for the address. class:word {n/a} {n/a} mem rre
mod nm-o - - Divide `n` by `m` and return the remainder. class:word {n/a} {n/a} global all
n:-zero? n-f - - Return `TRUE` if number is not zero, or `FALSE` otherwise. class:word {n/a} {n/a} n all

1 $ -c - - Return ASCII:NUL (0). class:macro {n/a} {n/a} global all
119 bi* xyqq-? - - Execute q1 against x and q2 against y. class:word #10 #20 [ #2 * ] [ #10 / ] bi* {n/a} global all
120 bi@ xyq-? - - Execute q against x, then execute q against y. class:word #10 #20 [ #3 * ] bi@ {n/a} global all
121 binary - - - Set `Base` to binary. class:word {n/a} {n/a} a all
122 block:read an- - - Read 1024 cells from block n in the block storage into memory at address a. class:word {n/a} {n/a} block rre
123 block:set-file s- - - Set the file name of the block storage device. class:word {n/a} {n/a} block rre
124 block:write an- - - Save the 1024 cells at address a to block n in the block storage. class:word {n/a} {n/a} block rre
125 buffer:add n- - - Append a value to the current buffer. class:word {n/a} {n/a} buffer all
126 buffer:empty - - - Reset the current buffer to an empty state. class:word {n/a} {n/a} buffer all
127 buffer:end -a - - Return a pointer to the current end of the active buffer. class:word {n/a} {n/a} buffer all
366 mem:fetch nn-n - - Fetch value from malloc'd memory region. Address is a double cell value. class:word {n/a} {n/a} mem rre
367 mem:fetch-double nn-n - - Fetch a double cell value from a malloc memory region. class:word {n/a} {n/a} mem rre
368 mem:free nn- - - Fre a malloc'd region of memory. Pass a double cell pointer to the memory to free. class:word {n/a} {n/a} mem rre
369 mem:resize mmn- - - Resize a malloc'd memory area. class:word {n/a} {n/a} mem rre
370 mem:store xnn- - - Store a value into a malloc'd memory region. Uses a double cell pointer for the address. class:word {n/a} {n/a} mem rre
371 mod nm-o - - Divide `n` by `m` and return the remainder. class:word {n/a} {n/a} global all
372 n:-zero? n-f - - Return `TRUE` if number is not zero, or `FALSE` otherwise. class:word {n/a} {n/a} n all