brainpreter 0.1.0

A simple and easy to use brainfuck interpreter.
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
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

use super::instruction::Instruction;

// Struct for the program (a series of instructions)
pub struct Program {
    
    instr:Vec<Instruction>,
    ptr:usize,

}

impl Program {

    // Function to create and return a new program
    pub fn new() -> Program {

        Program {

            instr:Vec::<Instruction>::new(),
            ptr:0,

        }

    }

    // Function to increase the pointer
    pub fn inc_ptr(&mut self) -> bool {

        if self.ptr < self.instr.len() - 1 {
            self.ptr += 1;
            return true;
        }

        false

    }

    // Function to decrease the pointer
    #[allow(unused)]
    pub fn dec_ptr(&mut self) -> bool {

        if self.ptr > 0 {
            self.ptr -= 1;
            return true;
        }

        false

    }

    // Function to move the pointer
    pub fn set_ptr(&mut self, pos:usize) -> bool {

        if pos >= self.get_size() {
            return false;
        }

        self.ptr = pos;

        true

    }

    // Function to get the current instruction (if a program is already loaded and the instruction exists)
    pub fn get(&self) -> Option<Instruction> {

        if self.instr.len() > 0 { Option::Some(self.instr[self.ptr]) } else { Option::None }

    }

    // Function to increase the pointer and get the instruction
    #[allow(unused)]
    pub fn get_next(&mut self) -> Option<Instruction> {

        if self.inc_ptr() { self.get() } else { Option::None }

    }

    // Function to decrease the pointer and get the instruction
    #[allow(unused)]
    pub fn get_prev(&mut self) -> Option<Instruction> {

        if self.dec_ptr() { self.get() } else { Option::None }

    }

    // Function to get an instruction
    #[allow(unused)]
    pub fn get_at(&self, p:usize) -> Option<Instruction> {

        if p >= (0 as usize) && p < self.instr.len() { Option::Some(self.instr[p]) } else { Option::None }

    }

    // Function to add a new instruction at the end of the program
    pub fn push(&mut self, i:Instruction) -> &mut Program {

        self.instr.push(i);

        self

    }

    // Function to remove the last instruction from the program (if exists)
    #[allow(unused)]
    pub fn pop(&mut self) -> bool {
        
        return match self.instr.pop() {

            Some(_) => {
                
                if self.ptr >= self.instr.len() {
                    if self.ptr > 0 {
                        self.ptr -= 1;
                    }
                }

                true

            }

            None => false

        }

    }

    // Function to clear the program and set pointer to 0
    #[allow(unused)]
    pub fn clear(&mut self) -> &mut Program {

        self.instr.clear();
        self.ptr = 0;

        self

    }
    
    // Function to reset the pointer (set to 0)
    #[allow(unused)]
    pub fn reset_ptr(&mut self) -> &mut Program {

        self.ptr = 0;

        self

    }

    // Function to update a specific instruction
    pub fn update_instr(&mut self, pos:usize, new_instr:Instruction) -> bool {

        if self.instr.len() == 0 || pos >= self.instr.len() {
            return false;
        }

        self.instr[pos] = new_instr;

        return true;

    }

    // Function to get program's size
    pub fn get_size(&self) -> usize {

        self.instr.len()

    }

}