diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 46 |
1 files changed, 42 insertions, 4 deletions
@@ -13,14 +13,52 @@ for amd64 linux systems. ## Glossary -the following is a list of words available in this forth. (neither of these have been implemented yet i'm just putting them here in the meantime lol) +the following is a list of words available in this forth. + +### `#tib ( -- a )` +variable containing the amount of characters in the input buffer. + +### `>in ( -- a )` +variable containing the index of the first unparsed character +in the input buffer. + +### `brk@ ( -- a )` +yields current program break. + +### `bye ( -- )` +exits the forth system. ### `dp ( -- a )` -`dp` is a variable that contains the lowest free byte of memory in user memory. +a variable that contains the lowest free byte of memory in user memory. + +### `dp0 ( -- )` +a variable that contains the first byte of user memory. + +### `dp$ ( -- )` +a variable that contains the last available byte of user memory. + +### `executable ( u a -- )` +marks the u bytes starting at address a as executable. +this is used primarily to mark the program break, +which is used as the user memory space. + +### `grow ( u -- )` +grows the user memory space by u bytes. ### `here ( -- a )` -`here` yields the address of the first available byte -in user memory. +yields the address of the first available byte in user memory. + +### `latest ( -- a )` +a variable containing the execution token of +the most recently created word. + +### `state ( -- a )` +a variable containing a boolean value. +if 0 (false), the system is in interpreting mode, +if -1 (true), the system is in compiling mode. + +### `tib ( -- a )` +a variable containing the address of the current input buffer. ## dictionary format |