blazefuck

Crates.ioblazefuck
lib.rsblazefuck
version1.0.0
created_at2022-05-14 17:52:53.103447+00
updated_at2022-05-14 17:52:53.103447+00
descriptionA blazingly-fast (interactive) Brainfuck interpreter.
homepage
repositoryhttps://github.com/poopsicles/blazefuck
max_upload_size
id586729
size44,637
fumnanya (poopsicles)

documentation

README

blazefuck

A blazingly-fast (interactive) Brainfuck interpreter, written in Rust.

Description

A tiny, efficient Brainfuck interpreter, with a REPL for easy, on-the-fly evaluation

Brainfuck is a simple esoteric language with a minimal subset of commands, you can read more here.

Getting Started

Dependencies

  • Install the rustup toolchain for your system.

Installing

  • Add Cargo's binary directory to your path environment variables
    The rustup installer should do this for you, but if not, it should be located at ~/.cargo/bin (Linux) or %USERPROFILE\.cargo\bin (Windows).
  • Simply run cargo install blazefuck at a terminal and it'll be installed from crates.io.

Executing program

  • Type blazefuck at a prompt
$ blazefuck
blazefuck 1.0.0 on windows, run with "-h" or "--help" for more information.
Use "cells" to show the cell stack and "exit" to exit the interpreter.
>>> _

You can then use the normal Brainfuck commands, as follows:
> Increment the data pointer (to point to the next cell to the right).
< Decrement the data pointer (to point to the next cell to the left).
+ Increment (increase by one) the byte at the data pointer.
- Decrement (decrease by one) the byte at the data pointer.
. Output the byte at the data pointer.
, Accept one byte of input, storing its value in the byte at the data pointer.
[ If the byte at the data pointer is zero, then instead of moving the instruction pointer forward to the next command, jump it forward to the command after the matching ] command.
] If the byte at the data pointer is nonzero, then instead of moving the instruction pointer forward to the next command, jump it back to the command after the matching [ command.

Also cells and exit will show the current cell stack and exit the REPL, respectively.

  • Alternatively a source file can be specified with blazefuck [FILE], some examples can be found here.
$ blazefuck hello.bf
Hello World!

$ _
  • Some flags can be specified as follows:
-d, --debug     Shows the cell stack after every command
-s, --strict    Activates strict mode
  • Strict mode has some key differences, as opposed to normal mode, some programs will not run well with it enabled.
    It:
    • Disallows access of any cells not between #1 and #30000, normal mode wraps around to the beginning or end.
    • Disallows cell data being incremented or decremented past 0-255, normal mode also wraps around.

Building from source

  • Clone this repository
$ git clone https://github.com/poopsicles/blazefuck
  • Switch to the newly created directory
$ cd ./blazefuck
  • Compile using cargo
$ cargo build
  • Cargo will grab the required dependencies and create the binary at ./target/debug/blazefuck

Version History

  • 1.0
    • Initial release

License

This project is licensed under the MIT License, more details here.

Commit count: 4

cargo fmt