Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrjameshamilton/bf
An optimizing brainf*ck compiler with multiple target backends: JVM, smali, dex, C, LLVM IR, ARM, WASM, JavaScript and Lox.
https://github.com/mrjameshamilton/bf
arm assembly brainfuck bytecode compiler java javascript jvm jvm-bytecode jvm-language kotlin language llvm llvm-ir lox smali wasm
Last synced: about 2 months ago
JSON representation
An optimizing brainf*ck compiler with multiple target backends: JVM, smali, dex, C, LLVM IR, ARM, WASM, JavaScript and Lox.
- Host: GitHub
- URL: https://github.com/mrjameshamilton/bf
- Owner: mrjameshamilton
- License: mit
- Created: 2022-05-07T11:23:07.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T19:34:29.000Z (about 1 year ago)
- Last Synced: 2023-09-28T07:04:32.847Z (about 1 year ago)
- Topics: arm, assembly, brainfuck, bytecode, compiler, java, javascript, jvm, jvm-bytecode, jvm-language, kotlin, language, llvm, llvm-ir, lox, smali, wasm
- Language: Kotlin
- Homepage:
- Size: 103 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# An optimizing Brainf*ck compiler
An optimizing [brainf*ck](http://brainfuck.org/brainfuck.html) compiler with multiple target backends:
JVM using [ProGuardCORE](https://github.com/guardsquare/proguard-core) for code generation,
[smali](https://github.com/JesusFreke/smali), dex using [BAT](https://github.com/netomi/bat),
C, LLVM IR, ARM assembly, WASM and JavaScript.
Some optimizations are applied before code generation:
* Zero-ing loops (`[+]` / `[-]`) are represented as a single instruction
* Consecutive zero-ing instructions are merged
* Consecutive move and add instructions are merged into single instructions with an amount parameter
* Zero moves/adds are removed
* Top-level loops before memory updates are removed
## Building
```shell
./gradlew build
```
The build task will execute all tests and create an output jar `lib/bf.jar`.
## Executing
A wrapper script `bin/bf` is provided for convenience in the `bin/` directory:
```shell
$ bin/bf --help
Usage: bf options_list
Arguments:
script -> brainf*ck script { String }
Options:
--output, -o -> output { String }
--target, -t [JVM] -> target { Value should be one of [jvm, c, llvm, smali] }
--debug, -d [false]
--help, -h -> Usage info
```
By default, `bf` will compile a provided brainf*ck script for the JVM and execute it. The compiler
can instead generate a jar file with the `-o` option.
### JVM (default)
```shell
$ bin/bf examples/helloworld.bf -t jvm -o helloworld.jar
$ java -jar helloworld.jar
```
### Smali (Dalvik assembler)
```shell
$ bin/bf examples/helloworld.bf -t smali -o helloworld.smali
$ smali a helloworld.smali -o classes.dex
$ adb push classes.dex /sdcard/Download/classes.dex
$ adb shell dalvikvm -cp /sdcard/Download/classes.dex Main
```
### Dex
```shell
$ bin/bf examples/helloworld.bf -t dex -o helloworld.dex
$ adb push helloworld.dex /sdcard/Download/helloworld.dex
$ adb shell dalvikvm -cp /sdcard/Download/helloworld.dex Main
```
### C
```shell
$ bin/bf examples/helloworld.bf -t c -o helloworld.c
$ gcc helloworld.c -o helloworld && ./helloworld
```
### LLVM IR
```shell
$ bin/bf examples/helloworld.bf -t llvm -o helloworld.ll
$ lli helloworld.ll
```
### ARM assembly
```shell
$ bin/bf examples/helloworld.bf -t arm -o helloworld.s
$ arm-none-eabi-as helloworld.s -o helloworld.o
$ arm-none-eabi-ld helloworld.o -o helloworld
$ qemu-arm ./helloworld
```
### WASM
```shell
$ bin/bf examples/helloworld.bf -t wasm -o helloworld.wat
$ wasmtime helloworld.wat
```
### JavaScript
```shell
$ bin/bf examples/helloworld.bf -t js -o helloworld.js
$ nodejs helloworld.js
```
Inputs for the Javascript version are passed as command-line arguments.
### Lox
[Lox](https://github.com/munificent/craftinginterpreters) doesn't provide any built-in way
to convert ASCII character codes to characters, and the built-in `print` function always prints newlines,
but we can use `awk` to convert ASCII codes to characters while merging all the lines together.
```shell
$ bin/bf examples/helloworld.bf -t lox -o helloworld.lox
$ jlox helloworld.lox | awk '{printf("%c", $1)}' ORS=' '
```
Lox also doesn't provide any ability to receive inputs so the inputs to a program
can be compiled directly into it by using the `bf` `--input` option.
# Useful brainf*ck resources
* [Brainf*ck language reference](http://brainfuck.org/brainfuck.html)
* [Sample programs by Daniel B Cristofani](http://brainfuck.org/)
* [Optimizing brainf*ck programs](http://calmerthanyouare.org/2015/01/07/optimizing-brainfuck.html)
* [Brainf*ck Wikipedia article](https://en.wikipedia.org/wiki/Brainfuck)