yabfr 2.0.0

⚡blazingly fast brainf**k interpreter made in rust (yet another brainf**k _in_ rust)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! welcome to yabfr docs!
//!
//! ## what does this crate do?
//!
//! with this crate, you can execute a brainf**k program with a nice and simple rust API.
//!
//! ## features
//!
//! - [x] execute a brainf**k program from a string
//!
//! ## examples
//!
//! ```
//! use yabfr::run;
//!
//! let output = run("++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.");
//!
//! println!("{}", output)
//! ```
//!
//! # "issues"
//! - currently, there is no way to pass in "input" to the interpreter, will be fixed later *hopefully*
#[deny(missing_docs)]
use lexer::lex;
use parser::parse;
extern crate wasm_bindgen;

/// this module holds the [OpCode](instructions::OpCode) and [Instruction](instructions::Instruction) enums
pub(crate) mod instructions;
/// this module turns the source string into opcodes
pub(crate) mod lexer;
/// this module deals with parsing the [opcodes](instructions::OpCode) into [instructions](instructions::Instruction)
pub(crate) mod parser;
/// this module runs the program
pub(crate) mod runner;

use wasm_bindgen::prelude::*;

#[wasm_bindgen]
/// execute the brainfuck program
pub fn run(program: &str) -> String {
    let operation_codes = lex(program.to_string());

    let instructions = parse(operation_codes);

    let output = runner::run(&instructions);

    output
}

#[cfg(test)]
mod tests {
    use crate::run;

    #[test]
    fn gives_correct_output() {
        let hello_world = "++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.";
        let output = run(hello_world);

        assert_eq!(output, "Hello World!\n")
    }
}