uxn/README.md

78 lines
1.6 KiB
Markdown
Raw Normal View History

2021-01-29 19:17:59 +00:00
# Uxn
2021-02-08 22:49:45 +00:00
A [stack-based VM](https://wiki.xxiivv.com/site/uxn.html), written in ANSI C.
2021-01-29 19:35:59 +00:00
2021-01-30 01:49:10 +00:00
## Assembly Syntax
2021-01-29 19:35:59 +00:00
2021-02-04 20:22:08 +00:00
### Write
2021-02-08 22:49:45 +00:00
- `;variable`, automatically assign an address to a label.
- `:const FFCF`, manually assign an address to a label.
- `@label`, assign the current address to a label.
2021-02-04 20:22:08 +00:00
### Read
2021-02-08 22:49:45 +00:00
- `,literal`, push label value to stack, prefixed with `LIT LEN`.
- `.pointer`, push label value to stack.
2021-02-04 20:22:08 +00:00
### Special
2021-02-08 22:49:45 +00:00
- `( comment )`, toggle parsing on/off.
- `|0010`, move to position in the program.
- `"hello`, push literal bytes for word "hello".
- `#04`, a zero-page address, equivalent to `,0004`.
2021-01-31 05:31:49 +00:00
2021-02-06 18:39:13 +00:00
### Operator modes
- `,1234 ,0001 ADD^`, 16-bits operators have the short flag `^`.
2021-02-08 04:49:00 +00:00
- `,12 ,11 GTH JMP?`, conditional operators have the cond flag `?`.
2021-02-06 18:39:13 +00:00
2021-01-29 19:35:59 +00:00
```
2021-02-05 22:01:34 +00:00
( hello world )
2021-02-04 20:22:08 +00:00
2021-02-05 22:01:34 +00:00
;iterator
2021-01-30 01:49:10 +00:00
2021-02-05 22:01:34 +00:00
|0100 @RESET
2021-01-30 22:25:48 +00:00
2021-02-10 19:06:36 +00:00
@word1 "hello_world ( len: 0x0b )
2021-02-05 22:01:34 +00:00
@loop
2021-02-10 19:06:36 +00:00
,00 IOW ( write to device#0 )
2021-02-08 04:49:00 +00:00
,incr JSR ( increment itr )
,word1 ,strlen JSR ( get strlen )
NEQ ,loop ROT JSR? ( loop != strlen )
2021-02-05 22:01:34 +00:00
2021-02-08 04:49:00 +00:00
BRK
@strlen
,0001 ADD^ LDR
RTS
2021-02-05 22:01:34 +00:00
2021-02-06 04:18:30 +00:00
@incr
,iterator LDR
,01 ADD
,iterator STR
,iterator LDR
RTS
2021-02-08 04:49:00 +00:00
2021-02-05 22:01:34 +00:00
|c000 @FRAME BRK
|d000 @ERROR BRK
|FFFA .RESET .FRAME .ERROR
2021-01-29 19:35:59 +00:00
```
2021-02-08 22:49:45 +00:00
## TODOs
2021-02-01 19:58:47 +00:00
2021-02-10 19:06:36 +00:00
- Implement signed flag to operators.
- On-screen debugger.
- Auto-advance ldr?
- Getting rid of IOR/IOW would be nice..
2021-02-11 18:15:26 +00:00
- Sending from the wst to the rst, balance mode/flag?
2021-02-05 18:51:45 +00:00
2021-01-30 22:25:48 +00:00
## Refs
https://code.9front.org/hg/plan9front/file/a7f9946e238f/sys/src/games/nes/cpu.c
http://www.w3group.de/stable_glossar.html
http://www.emulator101.com/6502-addressing-modes.html
http://forth.works/8f0c04f616b6c34496eb2141785b4454
2021-02-06 04:18:30 +00:00
https://justinmeiners.github.io/lc3-vm/