README.md

a lua interpreter in rust

based on Build a Lua Interpreter in Rust by Wubing Zheng

How I think the stack is supposed to work with bytecode

Operations can manipulate in three ways:

1. push a value on top of the stack, incrementing stack size
2. pop a value off the stack
3. set the value of an item on the stack at a specific index

bytecode instructions as rust enums

Bytecode instruction as specified in luajit:

A single bytecode instruction is 32 bit wide and has an 8 bit opcode field and
several operand fields of 8 or 16 bit. Instructions come in one of two formats:

+---+---+---+---+
| B | C | A | OP|
|   D   | A | OP|
+---+---+---+---+

How local variables work

When assigning local variables they are stored on the stack and their name is appended to a locals list. When a name is referenced, first go through locals in reverse. If the name can be found, its index points to the stack index where the value is stored. The VM can then use the MOVE(dst, src) bytecode to copy that value to the top of the stack.

How a function is executed in print("hello world")

1. the print function is loaded onto the stack with the GetGlobal(dst,src). It finds the name of the global at src in the constants and loads it onto the stack at dst.
2. the next opcode is LoadConst(dst,src) which loads "hello world" from the constants list to dst on the stack
3. the opcode Call(func_index, ...) which executes the function that is stored on the stack at func_index. The function takes a single argument and expects it at func_index+1 on the stack.

Other stack operations

Aside from loading functions and their arguments onto the stack to be executed, local variables are also stored on the stack. This is what makes them execute faster than accessing global variables. Therefore the next free index on the stack is equivalent to locals.len().