raton 0.1.0-alpha.9

ratón is a tiny, modular, embeddable scripting language
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

//! Bytecode type definitions.

use crate::{BinaryOperator, UnaryOperator, Value};
use std::{collections::BTreeMap, hash::Hash};

/// A single bytecode instruction, which may contain arguments.
#[derive(Debug, Clone, PartialEq, Hash)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "bitcode", derive(bitcode::Encode, bitcode::Decode))]
#[non_exhaustive]
pub enum Instruction {
    /// Allocate this many variables on the stack.
    AllocVariables(u16),
    /// Push the constant onto the stack.
    LoadConstant(Value),
    /// Push the indexed variable's value onto the stack.
    LoadVariable(u16),
    /// Store a value popped from the stack into the indexed variable.
    StoreVariable(u16),
    /// Push the result of the unary operation on a value popped from the stack.
    UnaryOperator(UnaryOperator),
    /// Push the result of the binary operation on two values popped from the stack.
    BinaryOperator(BinaryOperator),
    /// Jump to the indexed instruction.
    Jump(u32),
    /// Jump to the indexed instruction if a value peeked from the stack is the bool 'false'.
    #[cfg(feature = "bool_type")]
    JumpIfFalse(u32),
    /// Call the named function with the given number of arguments.
    CallByName(ReceiverLocation, String, u16),
    /// Call the function at the given address with the given number of arguments.
    CallByAddress(u32, u16),
    /// Return from the current function.
    Return,
    /// Discard an item popped from the stack.
    Pop,
}

/// Where the receiver is located in the virtual machine's memory.
#[derive(Debug, Clone, PartialEq, Hash)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "bitcode", derive(bitcode::Encode, bitcode::Decode))]
#[non_exhaustive]
pub enum ReceiverLocation {
    /// Variable.
    Variable(u16),
    /// Before the other arguments on the stack.
    Temporary,
    /// A function call, not a method call.
    None,
}

/// A bytecode instruction stream for a whole program, with known entry
/// points for public functions.
#[derive(Clone, Debug, Hash)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "bitcode", derive(bitcode::Encode, bitcode::Decode))]
#[allow(unused)]
#[non_exhaustive]
pub struct ProgramBytecode {
    /// Information on public functions, callable from outside the program.
    pub public_functions: BTreeMap<String, PublicFunction>,
    /// The bytecode instruction stream of the program.
    pub instructions: Vec<Instruction>,
}

/// Information on a public function, allowing it to be called.
#[derive(Clone, Debug, Hash)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "bitcode", derive(bitcode::Encode, bitcode::Decode))]
#[allow(unused)]
#[non_exhaustive]
pub struct PublicFunction {
    /// The address of the first instruction of the function.
    pub address: u32,
    /// The number of arguments of the function.
    pub arguments: u16,
}