https://github.com/kleinesfilmroellchen/boxfunge

https://github.com/kleinesfilmroellchen/boxfunge

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kleinesfilmroellchen/boxfunge
• Owner: kleinesfilmroellchen
• License: mit
• Created: 2024-02-20T13:42:59.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-02-23T15:15:31.000Z (9 months ago)
• Last Synced: 2024-05-01T16:17:06.210Z (6 months ago)
• Language: Rust
• Size: 31.3 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Boxfunge

> Befunge interpreter in Rust

Boxfunge (oxidized Befunge) is an experimental interpreter and JIT compiler for the esoteric [Befunge](https://catseye.tc/view/Befunge-93/doc/Befunge-93.markdown) programming language. Befunge is one of the most well-known esoteric programming languages and intended to be hard to compile. This implementation has a basic, but very fast interpreter as its core. Currently, a very complicated program, such as the self-interpreter included in this repo, can run at roughly 5ns per Befunge command (200 million steps per second) in release mode. There is also a just-in-time compiler.

Boxfunge supports standard Befunge-93, the original variant. However, it is planned to remove the 80x25 grid restriction via a command-line flag, which would allow the language to be Turing-complete. Support for Befunge-98 (a generalized extension with many advanced features like concurrency) may be added at some point.

To try out the interpreter, this repo contains a collection of programs that are also used for testing the interpreter's functionality. They are mostly taken from the Esolangs wiki.

## Installation and Usage

```sh

$ cargo build

$ cargo run -- arguments...

$ cargo test

```

### Command-line interface

```

Usage: boxfunge  [-p] [-j] [-s ] [-i ]

Befunge-93 interpreter.

Positional Arguments:

  input             input file to read

Options:

  -p, --show-performance

                    collect and show performance metrics

  -j, --use-jit     use the experimental just-in-time compiler

  -s, --language-standard

                    language standard to use, for future compatibility. default:

                    98

  -i, --stdin       file to use as stdin for the program; particularly useful

                    with self-interpreters

  --help            display usage information

```