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
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215


//! Holds the component structs of the interpreter

use crate::{
    instruction::Instruction,
    error::BrainfuckError,
};
use std::string::ToString;
use std::fmt;
use std::fmt::Debug;



pub const MEMORY_SIZE: usize = 30_000;



/// The component that handles the instructions
#[derive(Debug)]
pub struct Tape {
    stream: Vec<Instruction>,
    ptr: usize,
} impl Tape {
    pub fn new(mut stream: Vec<Instruction>) -> Self {
        if !stream.ends_with(&[Instruction::EOF]) {
            stream.push(Instruction::EOF);
        }
        Tape {
            stream,
            ptr: 0usize,
        }
    }

    /// Creates a `Tape` from a string of instructions
    pub fn from_string<S: ToString>(s: S) -> Self {

        // TODO: This needs cleaned, is ugly <3
        let mut stream: Vec<Instruction> = s.to_string()
            .chars()
            .map(|c| Instruction::from_char(c))
            .collect();

        if !stream.ends_with(&[Instruction::EOF]) {
            stream.push(Instruction::EOF);
        }

        Self::new(stream)
    }

    /// Gets the current instruction and advances the instruction pointer
    pub fn get_instruction(&mut self) -> Instruction {
        self.ptr += 1;
        self.stream[self.ptr - 1]
    }

    /// Utility function used to jump back to the corresponding SetJump instruction (`[`)
    /// Returns Err if it does not find a matching instruction
    pub fn jump_back(&mut self) -> Result<(), BrainfuckError> {
        // Current state: self.ptr is one above the Jump instruction

        self.ptr -= 1;

        let mut depth = 0;

        while self.ptr != 0 {
            match self.stream.get(self.ptr) {
                Some(Instruction::SetJump) => { depth -= 1; },
                Some(Instruction::Jump) => { depth += 1; },
                _ => (),
            };

            if depth == 0 {
                return Ok(())
            } else {
                self.ptr -= 1;
            }
        }

        Err(BrainfuckError::new("Mismatched jump operations (missing a `[`)"))
    }

    /// Utility function used to jump forward to the corresponding Jump instruction (`]`)
    /// Returns Err if it does not find a matching instruction
    pub fn jump_forward(&mut self) -> Result<(), BrainfuckError> {

        // We are currently on the instruction right after the SetJump, so initialise depth with 1
        let mut depth = 1;

        while self.ptr != self.stream.len() {
            match self.stream.get(self.ptr) {
                Some(Instruction::SetJump) => { depth += 1; },
                Some(Instruction::Jump) => { depth -= 1; },
                _ => ()
            };

            if depth == 0 {
                return Ok(());
            } else {
                self.ptr += 1;
            }
        }

        Err(BrainfuckError::new("Mismatched jump operations (missing a `]`)"))
    }
} impl Default for Tape {
    fn default() -> Self {
        Self::new(Vec::new())
    }
}

/// Component of the interpreter that handles virtual memory management
pub struct Memory {
    bytes: [u8; MEMORY_SIZE],
    ptr: usize,
} impl Memory {

    pub fn new() -> Self {
        let bytes = [0u8; MEMORY_SIZE];
        Memory {
            bytes,
            ptr: 0usize
        }
    }

    /// Called when the `.` instruction is encountered.
    /// Attempts to pull the value at the data pointer from memory
    /// _Should_ never panic, will panic if the data pointer is greater than 30,000, however, the
    /// data pointer should never go higher than that (the program will return Err in `memory.inc_ptr()`
    /// if the data pointer will be higher than 30,000)
    pub fn pull(&self) -> u8 {
        self.bytes[self.ptr]
    }

    /// Called when the `,` instruction is encountered
    /// Attempts to push the value into the memory location at the data pointer
    /// See `memory.pull()` for safety
    pub fn push(&mut self, value: u8) {
        self.bytes[self.ptr] = value;
    }

    /// Called when the `>` instruction is encountered
    /// Attempts to increment the data pointer
    /// Returns `Err` if the data pointer would pass the end of memory if incremented
    pub fn inc_ptr(&mut self) -> Result<(), BrainfuckError> {
        if self.ptr == MEMORY_SIZE - 1 {
            Err(BrainfuckError::new("Attempt to increment data pointer past the end of memory"))
        } else {
            self.ptr += 1;
            Ok(())
        }
    }

    /// Called when the `<` instruction is encountered
    /// Attempts to decrement the data pointer
    pub fn dec_ptr(&mut self) {
        if self.ptr != 0 {
            self.ptr -= 1;
        }
    }

    /// Called when the `+` instruction is encountered
    /// Wrapping adds the value at the data pointer
    pub fn inc_val(&mut self) {
        self.bytes[self.ptr] = self.bytes[self.ptr].wrapping_add(1);
    }

    /// Called when the `-` instruction is encountered
    /// Wrapping subtracts the value at the data pointer
    pub fn dec_val(&mut self) {
        self.bytes[self.ptr] = self.bytes[self.ptr].wrapping_sub(1);
    }
} impl Debug for Memory {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Memory {{\n\tbytes: {:?},\n\tptr: {}\n}}", self.bytes.iter().map(|v| *v).collect::<Vec<u8>>(), self.ptr)
    }
}

/// """Wrapper""" for the Memory component of the interpreter that handles the actual
/// IO and such of the interpreter
#[derive(Debug)]
pub struct IO {
    input: Vec<u8>,
    output: Vec<u8>,
} impl IO {

    /// Constructor for the IO component
    pub fn new(input: Vec<u8>) -> Self {
        IO {
            input,
            output: Vec::new(),
        }
    }

    /// Write a single byte from the front of `io.input` into `memory`
    pub fn write_to(&mut self, memory: &mut Memory) {
        if self.input.len() != 0 {
            memory.push(self.input.remove(0));
        }
    }

    /// Write a single byte from `memory` onto the back of `io.output`
    pub fn pull_from(&mut self, memory: &mut Memory) {
        self.output.push(memory.pull());
    }

    pub fn output(&self) -> Vec<u8> {
        self.output.clone()
    }

} impl Default for IO {
    fn default() -> Self {
        Self::new(Vec::new())
    }
}