xqvm 0.1.0

X-Quadratic Virtual Machine — bytecode interpreter for the XQuad Toolchain
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

// Copyright (C) 2026 Postquant Labs Incorporated
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//
// SPDX-License-Identifier: AGPL-3.0-or-later

//! Integration tests for `TextTracer` output.

use xqvm::bytecode::{InstructionBuilder, Register};
use xqvm::{TextTracer, Vm};

#[test]
fn text_tracer_produces_header_and_rows() {
    let mut b = InstructionBuilder::new();
    let _ = b
        .emit_push(3)
        .emit_push(4)
        .emit_add()
        .emit_stow(Register(0))
        .emit_halt();
    let program = b.build().unwrap();

    let mut buf = Vec::new();
    let mut tracer = TextTracer::new(&mut buf);
    let mut vm = Vm::new();
    vm.run_trace(&mut tracer, &program).unwrap();

    let output = String::from_utf8(buf).unwrap();
    let lines: Vec<&str> = output.lines().collect();

    // First line is the column header.
    let header = lines.first().expect("should have header");
    assert!(header.contains("step"));
    assert!(header.contains("instruction"));

    // We should have header + 5 data rows.
    assert_eq!(lines.len(), 6, "header + 5 steps, got:\n{output}");

    // Step 4 (STOW r0) should show a written register.
    let stow_row = lines.get(4).expect("should have row 4");
    assert!(
        stow_row.contains("r0=7"),
        "STOW r0 row should show r0=7, got: {stow_row}",
    );
}

#[test]
fn text_tracer_large_stack_is_truncated() {
    let mut b = InstructionBuilder::new();
    for i in 0..12 {
        let _ = b.emit_push(i);
    }
    let _ = b.emit_halt();
    let program = b.build().unwrap();

    let mut buf = Vec::new();
    let mut tracer = TextTracer::new(&mut buf);
    let mut vm = Vm::new();
    vm.run_trace(&mut tracer, &program).unwrap();

    let output = String::from_utf8(buf).unwrap();
    let last_data = output.lines().last().unwrap();
    assert!(
        last_data.contains("..."),
        "12-element stack should be truncated, got: {last_data}"
    );
}