Improvement ideas - Githubissues

udem-dlteam / pnut

🥜 A Self-Compiling C Transpiler Targeting Human-Readable POSIX Shell

https://pnut.sh

BSD 2-Clause "Simplified" License

425 stars 14 forks source link

Improvement ideas #41

Open laurenthuberdeau opened 5 months ago

laurenthuberdeau commented 5 months ago

Some ideas on how to improve the project:

New features

[x] #91
[x] Support variadic functions.
[ ] Support & on local and global variables in Shell backend.
[ ] Generate executables compatible with ~macOS and~ Windows. Bonus points if they are αcτµαlly pδrταblε εxεcµταblε.
[ ] ARM/RISC-V backends.

Optimizations

[ ] Pre-allocate AST nodes before recursive call to use AST node memory as return location for fun calls.
[ ] Separate heap in 2 zones: one for the global state and one for the current declaration.
[ ] Manually manage stack of local variables in parser to save on local variable management.
[ ] Reuse assignment variable as temporary when possible. i.e. a = f(f(a)) => _f a $a; _f a $a; instead of _f __t1 $a; _f a $__t1.

Code quality / Tech debt

[ ] Unify the way the environment is tracked in the shell and exe backends.
[x] Add a CI/CD pipeline that tests Pnut on all supported platforms and makes releases for them.
[x] Improve errors produced by Pnut.
[ ] Rewrite pnut to use structs.

Other

[x] Improve README.md.
[x] Make a landing page for Pnut on pnut.sh.
[x] Add more examples.

xplshn commented 4 months ago

I think it'd be impressive to add the tools over at https://git.suckless.org/sbase/files.html as examples. That'd also be exciting for people interested in writing pure SH scripts (scripts that don't call external commands). :)