planckforth/README.md

46 lines
2.5 KiB
Markdown
Raw Normal View History

2020-12-29 15:05:33 +01:00
# PlanckForth: Bootstrapping Forth from Handwritten Executable
2020-12-28 14:11:20 +01:00
```
2020-12-30 11:41:21 +01:00
$ git clone https://github.com/nineties/planckforth.git
$ cd planckforth
2020-12-28 14:11:20 +01:00
$ make
2020-12-30 11:41:21 +01:00
$ cat helloworld.fs | ./planck
2020-12-29 06:51:27 +01:00
```
2020-12-28 18:16:46 +01:00
# Builtin Words
2021-01-02 01:29:30 +01:00
| code | name | stack effect | semantics |
|:----:|:---------|:----------------|:-----------------------------|
| Q | quit | ( -- ) | Exit the process |
| C | cell | ( -- n ) | The size of Cells |
| h | &here | ( -- c-addr ) | The address of 'here' cell |
| l | &latest | ( -- c-addr ) | The address of 'latest' cell |
| k | key | ( -- c ) | Read character |
| t | type | ( c -- ) | Print character |
| j | jump | ( -- ) | Unconditional branch |
| J | 0jump | ( n -- ) | Jump if a == 0 |
| f | find | ( c -- xt ) | Get execution token of c |
| x | execute | ( xt -- ... ) | Run the execution token |
| @ | fetch | ( a-addr -- w ) | Load value from addr |
| ! | store | ( w a-addr -- ) | Store value to addr |
| ? | cfetch | ( c-addr -- c ) | Load byte from addr |
| $ | cstore | ( c c-addr -- ) | Store byte to addr |
| d | dfetch | ( -- a-addr ) | Get data stack pointer |
| D | dstore | ( a-addr -- ) | Set data stack pointer |
| r | rfetch | ( -- a-addr ) | Get return stack pointer |
| R | rstore | ( a-addr -- ) | Set return stack pointer |
| i | docol | ( -- a-addr ) | Get the interpreter function |
| e | exit | ( -- ) | Exit current function |
| L | lit | ( -- a ) | Load immediate |
| S | string | ( -- c-addr u ) | Load string literal |
| + | add | ( a b -- c ) | c = (a + b) |
| - | sub | ( a b -- c ) | c = (a - b) |
| * | mul | ( a b -- c ) | c = (a * b) |
| / | div | ( a b -- c ) | c = (a / b) |
| % | mod | ( a b -- c ) | c = (a % b) |
| & | and | ( a b -- c ) | c = (a & b) |
| \| | or | ( a b -- c ) | c = (a \| b) |
| ^ | xor | ( a b -- c ) | c = (a ^ b) |
| < | less | ( a b -- c ) | c = (a < b) |
| = | equal | ( a b -- c ) | c = (a == b) |