Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/synthetic-borealis/hirnfick
A Brainfuck source-to-source compiler.
https://github.com/synthetic-borealis/hirnfick
brainfuck compiler deno javascript javascript-library nodejs transpiler
Last synced: 16 days ago
JSON representation
A Brainfuck source-to-source compiler.
- Host: GitHub
- URL: https://github.com/synthetic-borealis/hirnfick
- Owner: synthetic-borealis
- License: mit
- Created: 2022-01-11T12:15:07.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-10T22:51:04.000Z (over 1 year ago)
- Last Synced: 2024-12-08T10:36:58.560Z (about 1 month ago)
- Topics: brainfuck, compiler, deno, javascript, javascript-library, nodejs, transpiler
- Language: TypeScript
- Homepage: https://synthetic-borealis.github.io/hirnfick
- Size: 6.18 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Hirnfick
[](https://github.com/synthetic-borealis/hirnfick/blob/main/LICENSE)
[](https://badge.fury.io/js/hirnfick)
[](https://codecov.io/gh/synthetic-borealis/hirnfick)
[](https://www.npmjs.com/package/hirnfick)
A [Brainfuck](https://en.wikipedia.org/wiki/Brainfuck) source-to-source compiler that runs in
Node.js, Deno and web-browsers.
## Contents
1. [Installation](#installation)
2. [Usage](#usage)
1. [Compiler](#compiler)
2. [Library](#library)
3. [Supported Output Languages](#supported-output-languages)
4. [Examples](#examples)
## Installation
Run `npm i -g hirnfick` to install globally or `npm i hirnfick` to install for a single project.
## Usage
C++ style comments (i.e. ```// I'm a comment``` and ```/* I'm a comment too */```) are supported.
### Compiler
hirnfick -i [input file] -o [output file] options
Options:
- `--lang [language]` - Output language (default=js-node).
- Supported options: js-web, js-node, js-deno, python, c, cpp,
qbasic, pascal, rust.
- `--memory-size [fixed|dynamic]` - Type of cells array (default=fixed).
### Library
- Use ```compileTo[VARIANT]()``` where ```[VARIANT]``` is the output language/variant (
e.g. ```compileToJsWeb()```).
- ```compileToJsWeb()``` generates a function that returns an object with two members:
1. ```output``` - The output of the program.
2. ```cells``` - The array of cells that were used by the program.
- QBasic programs with dynamic arrays require PDS 7.1 or [FreeBASIC](https://www.freebasic.net/) to
compile.
- C++/JS style comments are supported.
- For more information see the [documentation](docs/API.md).
## Supported Output Languages
- JavaScript.
- Python.
- C.
- C++.
- QBasic (manually tested with [FreeBASIC](https://www.freebasic.net/) 1.09.0, QuickBASIC 4.5 and
PDS 7.1).
- Pascal (tested with Free Pascal 3.2.2 and Borland Pascal 7.0).
- Rust.
### Table 1: Supported Commands by Output Language
| Language | \> | \< | + | - | . | , | \[ | \] | Memory Size |
|:---------------------|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:--------------:|
| JavaScript (Web) | ✓ | ✓ | ✓ | ✓ | ✓ | ✗ | ✓ | ✓ | 30,000/Dynamic |
| JavaScript (Node.js) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 30,000/Dynamic |
| JavaScript (Deno) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 30,000/Dynamic |
| Python | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 30,000/Dynamic |
| C | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 30,000 |
| C++ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 30,000/Dynamic |
| QBasic | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 30,000/Dynamic |
| Pascal | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 30,000 |
| Rust | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 30,000/Dynamic |
## Examples
### CommonJS (Node)
```javascript
const hirnfick = require('hirnfick');
const helloWorldBF = '++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.'
+ '+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.';
try {
const helloWorldJS = hirnfick.compileToJsNode(helloWorldBF);
const helloWorld = new Function(`${helloWorldJS}`);
helloWorld();
} catch (err) {
console.error(`Error: ${err.message}`);
}
```
### Syntax Checking - CommonJS (Node)
```javascript
const hirnfick = require('hirnfick');
// This code prints 'Hello World!' to the screen
const validCode = '++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++++++..+++.>>.'
+ '<-.<.+++.------.--------.>>+.>++.';
// This code has a mismatching numbers of opening brackets and closing brackets
const invalidCode = '++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++++++..+++.>>'
+ '.<-.<.]]].------.--------.>>+.>++.';
console.log(hirnfick.hasMismatchingLoopBoundaries(validCode)); // false
console.log(hirnfick.hasMismatchingLoopBoundaries(invalidCode)); // true
```
### ESM (Node)
```javascript
import * as hirnfick from 'hirnfick';
const helloWorldBF = '++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.'
+ '+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.';
try {
const helloWorldJS = hirnfick.compileToJsNode(helloWorldBF);
const helloWorld = new Function(`${helloWorldJS}`);
helloWorld();
} catch (err) {
console.error(`Error: ${err.message}`);
}
```
### ESM (Deno)
```javascript
import hirnfick from "https://jspm.dev/hirnfick";
const helloWorldBF = '++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.'
+ '+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.';
try {
const helloJs = hirnfick.compileToJsWeb(helloWorldBF);
const runHello = new Function(`${helloJs} return main().output.trim();`);
console.log(runHello());
} catch (err) {
console.error(`Error: ${err.message}`);
}
```
### TypeScript (Deno)
```typescript
import * as hirnfick from "https://cdn.jsdelivr.net/gh/synthetic-borealis/hirnfick/deno/index.ts";
const helloWorldBF =
"++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---." +
"+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.";
try {
const helloJs = hirnfick.compileToJsWeb(helloWorldBF);
const runHello = new Function(`${helloJs} return main().output.trim();`);
console.log(runHello());
} catch (err) {
console.error(`Error: ${err.message}`)
}
```
### Web
```html
Document
Run
const runButton = document.getElementById('run-button');
const outputBox = document.getElementById('output-box');
const helloWorldBF = '++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.'
+ '+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.';
outputBox.value = '';
runButton.addEventListener('click', () => {
try {
const helloWorldProgram = hirnfick.compileToJsWeb(helloWorldCode);
const helloWorld = new Function(`${helloWorldProgram} return main().output;`);
outputBox.value += helloWorld();
} catch (err) {
outputBox.value = `Error: ${err.message}`;
}
});
```