Struct CodeBox 

pub struct CodeBox { /* private fields */ }

CodeBox is an object. It contains a *><> program complete with a stack, and is typically run in steps via CodeBox.Swim.

Implementations

impl CodeBox

pub fn new(script: &str, stack: Stack, compatibility_mode: bool) -> CodeBox

new returns a new CodeBox. “script” should be a complete *><> script, “stack” should be the initial stack, and compatibility_mode should be set if old fishinterpreter.com behaviour is needed.

pub fn shift(&mut self)

shift changes the fish’s x/y coordinates based on CodeBox.f_dir.

pub fn exe(&mut self, r: u8) -> (Option<String>, bool, f64)

exe executes the instruction the ><> is currently on top of. It returns the string it intends to output (None if none) and true when it executes “;”. It also returns the time it should sleep for.

pub fn swim(&mut self) -> (Option<String>, bool, f64)

swim causes the ><> to execute an instruction, then move. It returns a string of non-zero length when it has output and true when it encounters “;”.

pub fn push(&mut self, r: f64)

push appends r to the end of the current stack.

pub fn pop(&mut self) -> f64

pop removes the value on the end of the current stack and returns it.

pub fn stack_length(&mut self)

stack_length implements “l” on the current stack.

pub fn register(&mut self)

register implements “&” on the current stack.

pub fn reverse_stack(&mut self)

reverse_stack implements “r” on the current stack.

pub fn extend_stack(&mut self)

extend_stack implements “:” on the current stack.

pub fn stack_swap_two(&mut self)

stack_swap_two implements “$” on the current stack.

pub fn stack_swap_three(&mut self)

stack_swap_three implements “@” on the current stack.

pub fn stack_shift_right(&mut self)

stack_shift_right implements “}” on the current stack.

pub fn stack_shift_left(&mut self)

stack_shift_left implements “{” on the current stack.

pub fn close_stack(&mut self)

close_stack implements “]”.

pub fn new_stack(&mut self, n: usize)

new_stack implements “[”.

pub fn call(&mut self)

call implements “C”.

pub fn ret(&mut self)

ret implements “R”.

pub fn print(&self, clear: bool)

print outputs the codebox to stdout.

pub fn string_stack(&self) -> String

string_stack returns a copy of the current stack as a string.

pub fn size(&self) -> (usize, usize)

size returns the width and height of the codebox.

pub fn code_box(&self) -> Vec<Vec<u8>>

code_box outputs a copy of the current state of the codebox.

pub fn deep_sea(&self) -> bool

deep_sea returns if the ><> is in deepsea mode or not.

pub fn position(&self) -> (usize, usize)

position returns the x/y coordinates of the ><>.