2022-04-04 12:28:39 +02:00
|
|
|
# peon
|
|
|
|
|
|
2022-05-20 15:55:28 +02:00
|
|
|
Peon is a simple, functional, async-first programming language with a focus on correctness and speed
|
|
|
|
|
|
|
|
|
|
## Project structure
|
|
|
|
|
|
2022-05-20 16:01:34 +02:00
|
|
|
- `src/` -> Contains the entirety of peon's toolchain
|
2022-05-20 16:14:08 +02:00
|
|
|
- `src/memory/` -> Contains peon's memory allocator and GC (TODO)
|
|
|
|
|
- `src/frontend/` -> Contains the tokenizer, parser and compiler
|
|
|
|
|
- `src/frontend/meta/` -> Contains shared error definitions, AST node and token
|
2022-05-20 16:01:34 +02:00
|
|
|
declarations as well as the bytecode used by the compiler
|
2022-05-20 16:14:08 +02:00
|
|
|
- `src/backend/` -> Contains the peon VM and type system
|
|
|
|
|
- `src/util/` -> Contains utilities such as the bytecode debugger and serializer as well
|
2022-05-20 16:01:34 +02:00
|
|
|
as procedures to handle multi-byte sequences
|
2022-05-20 16:03:19 +02:00
|
|
|
- `src/config.nim` -> Contains compile-time configuration variables
|
|
|
|
|
- `src/main.nim` -> Ties up the whole toolchain together by tokenizing,
|
|
|
|
|
parsing, compiling, debugging, (de-)serializing and executing peon code
|
2022-05-20 16:14:08 +02:00
|
|
|
- `docs/` -> Contains documentation for various components of peon (bytecode, syntax, etc.)
|
|
|
|
|
- `tests/` -> Contains tests (both in peon and Nim) for the toolchain
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Credits
|
|
|
|
|
|
|
|
|
|
- Araq, for creating the amazing language that is [Nim](https://nim-lang.org)
|
|
|
|
|
- The Nim community and contributors, for making Nim what it is today
|
|
|
|
|
- Bob Nystrom, for his amazing [book](https://craftinginterpreters.com) that inspired me
|
|
|
|
|
and taught me how to actually make a programming language
|
|
|
|
|
- [Njsmith](https://vorpus.org/), for his awesome articles on structured concurrency
|
2022-05-20 16:01:34 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Disclaimer about the project's state
|
|
|
|
|
|
2022-05-20 16:14:08 +02:00
|
|
|
The project is still in its very early days: lots of stuff is not implemented, a work in progress or
|
|
|
|
|
otherwise outright broken. Feel free to report bugs! Also, yes: peon is yet another programming language
|
|
|
|
|
inspired by Bob's book, but it is also **very** different from Lox, which is an object-oriented, dynamically typed
|
|
|
|
|
and very high level programming language. Peon is a statically-typed, functional language which aims to
|
|
|
|
|
allow low-level interfacing with C and Nim code while being a breeze to use. Also, peon will feature
|
|
|
|
|
[structured concurrency](https://vorpus.org/blog/notes-on-structured-concurrency-or-go-statement-considered-harmful/)
|
|
|
|
|
with coroutines (think Futures/Fibers but without callback hell). Since, unlike Lox, peon isn't a toy language, there's
|
|
|
|
|
obviously plans to implement creature comforts like an import system, exception handling package manager, etc.
|
