cardinal_backend 0.1.1

Cardinal's back end.
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

//! Exposes an enum of instruction Opcodes.
//! 
//! Used for generating Function instructions.

use crate::Value;

/// An enumeration of instruction Opcodes
/// for Cardinal's IR.
/// 
/// Hex names are provided in documentation.
pub enum Opcode {
	/// Adds two numbers together, overwriting the
	/// provided output variable reference.
	/// 
	/// - `x`: Output variable reference
	/// - `y`: Integer value
	/// - `z`: Integer value
	/// 
	/// ```
	/// x = y + z
	/// ```
	IntegerAdd(Value, Value, Value),

	/// Negates a number, overwriting the provided
	/// output variable reference with the result.
	/// 
	/// - `x`: Output variable reference.
	/// - `y`: Signed integer value.
	/// 
	/// ```
	/// x = -y
	/// ```
	IntegerNegate(Value, Value),
}