chore: rename midenc-runner to midenc-debug

Cargo.toml

@@ -10,9 +10,9 @@ members = [
     "hir-type",
     "midenc",
     "midenc-compile",
+    "midenc-debug",
     "midenc-driver",
     "midenc-session",
-    "midenc-runner",
     "sdk/base-sys",
     "tools/*",
     "frontend-wasm",
@@ -93,7 +93,7 @@ miden-parsing = "0.1"
 midenc-frontend-wasm = { version = "0.0.1", path = "frontend-wasm" }
 midenc-compile = { version = "0.0.1", path = "midenc-compile" }
 midenc-driver = { version = "0.0.1", path = "midenc-driver" }
-midenc-runner = { version = "0.0.1", path = "midenc-runner" }
+midenc-debug = { version = "0.0.1", path = "midenc-debug" }
 midenc-session = { version = "0.0.1", path = "midenc-session" }
 miden-integration-tests = { version = "0.0.0", path = "tests/integration" }
 wat = "1.0.69"

midenc-runner/Cargo.toml → midenc-debug/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
-name = "midenc-runner"
-description = "The Miden VM executor that implements midenc run"
+name = "midenc-debug"
+description = "An interactive debugger for Miden VM programs"
 version = "0.0.1"
 rust-version.workspace = true
 authors.workspace = true

midenc-driver/Cargo.toml

@@ -19,5 +19,5 @@ log.workspace = true
 midenc-hir.workspace = true
 midenc-session.workspace = true
 midenc-compile.workspace = true
-midenc-runner.workspace = true
+midenc-debug.workspace = true
 thiserror.workspace = true

midenc-driver/src/midenc.rs

@@ -3,8 +3,8 @@ use std::{ffi::OsString, path::PathBuf, rc::Rc, sync::Arc};
 use clap::{ColorChoice, Parser, Subcommand};
 use log::Log;
 use midenc_compile as compile;
+use midenc_debug as debugger;
 use midenc_hir::FunctionIdent;
-use midenc_runner as runner;
 use midenc_session::{
     diagnostics::{Emitter, Report},
     InputFile, Verbosity, Warnings,
@@ -93,10 +93,10 @@ enum Commands {
         #[arg(long, short = 'e', value_name = "NAME")]
         entrypoint: Option<FunctionIdent>,
     },
-    /// Run a program with the Miden VM
+    /// Run a program under the interactive Miden VM debugger
     ///
-    /// The program will be loaded into memory and executed with the Miden VM
-    Run {
+    /// This command starts a TUI-based interactive debugger with the given program loaded.
+    Debug {
         /// Specify the path to a Miden program file to execute.
         ///
         /// Miden Assembly programs are emitted by the compiler with a `.masl` extension.
@@ -110,7 +110,7 @@ enum Commands {
         /// access during execution. The inputs file is a JSON file which describes
         /// what the inputs are, or where to source them from.
         #[arg(long, value_name = "FILE")]
-        inputs: Option<runner::ProgramInputs>,
+        inputs: Option<debugger::ProgramInputs>,
         /// Arguments to place on the operand stack before calling the program entrypoint.
         ///
         /// Arguments will be pushed on the operand stack in the order of appearance,
@@ -121,9 +121,9 @@ enum Commands {
         ///
         /// NOTE: These arguments will override any stack values provided via --inputs
         #[arg(last(true), value_name = "ARGV")]
-        args: Vec<runner::Felt>,
+        args: Vec<debugger::Felt>,
         #[command(flatten)]
-        options: runner::Runner,
+        options: debugger::Runner,
     },
 }
 
@@ -175,7 +175,7 @@ impl Midenc {
                 let session = options.into_session(vec![input], emitter).with_arg_matches(matches);
                 compile::compile(Rc::new(session))
             }
-            Commands::Run {
+            Commands::Debug {
                 input,
                 inputs,
                 args,
@@ -186,7 +186,7 @@ impl Midenc {
                 }
                 let session = options.into_session(vec![input], emitter);
                 let args = args.into_iter().map(|felt| felt.0).collect();
-                runner::run(inputs, args, Rc::new(session), logger)
+                debugger::run(inputs, args, Rc::new(session), logger)
             }
             _ => unimplemented!(),
         }

tests/integration/Cargo.toml

@@ -31,7 +31,7 @@ midenc-codegen-masm.workspace = true
 midenc-session.workspace = true
 midenc-compile.workspace = true
 midenc-driver.workspace = true
-midenc-runner.workspace = true
+midenc-debug.workspace = true
 miden-integration-tests-rust-fib = { path = "../rust-apps/fib" }
 wasmprinter = "0.2.80"
 proptest.workspace = true

tests/integration/src/exec_emulator.rs

@@ -1,8 +1,8 @@
 use std::sync::Arc;
 
 use midenc_codegen_masm::{Emulator, Program};
+use midenc_debug::TestFelt;
 use midenc_hir::{Felt, Stack};
-use midenc_runner::TestFelt;
 
 /// Execute the module using the emulator with the given arguments
 /// Arguments are expected to be in the order they are passed to the entrypoint function

tests/integration/src/rust_masm_tests/abi_transform/stdlib.rs

@@ -3,8 +3,8 @@ use std::collections::VecDeque;
 
 use expect_test::expect_file;
 use miden_core::utils::group_slice_elements;
+use midenc_debug::{MidenExecutor, PopFromStack, PushToStack, TestFelt};
 use midenc_hir::Felt;
-use midenc_runner::{MidenExecutor, PopFromStack, PushToStack, TestFelt};
 use proptest::{
     arbitrary::any,
     prop_assert_eq,

tests/integration/src/rust_masm_tests/abi_transform/tx_kernel.rs

@@ -4,7 +4,7 @@ use expect_test::expect_file;
 use miden_assembly::LibraryPath;
 use miden_core::{Felt, FieldElement};
 use miden_processor::ExecutionError;
-use midenc_runner::MidenExecutor;
+use midenc_debug::MidenExecutor;
 
 use crate::{execute_emulator, CompilerTestBuilder};
 

tests/integration/src/rust_masm_tests/apps.rs

@@ -1,8 +1,8 @@
 use std::collections::VecDeque;
 
 use expect_test::expect_file;
+use midenc_debug::{MidenExecutor, PopFromStack, PushToStack};
 use midenc_hir::Felt;
-use midenc_runner::{MidenExecutor, PopFromStack, PushToStack};
 use proptest::{prelude::*, test_runner::TestRunner};
 
 use crate::CompilerTest;

tests/integration/src/rust_masm_tests/instructions.rs

@@ -1,5 +1,5 @@
 use expect_test::expect_file;
-use midenc_runner::PushToStack;
+use midenc_debug::PushToStack;
 use proptest::{
     prelude::*,
     test_runner::{TestError, TestRunner},

tests/integration/src/rust_masm_tests/intrinsics.rs

@@ -2,7 +2,7 @@ use core::panic;
 
 use expect_test::expect_file;
 use miden_core::Felt;
-use midenc_runner::{PushToStack, TestFelt};
+use midenc_debug::{PushToStack, TestFelt};
 use proptest::{
     arbitrary::any,
     test_runner::{TestError, TestRunner},

tests/integration/src/rust_masm_tests/mod.rs

@@ -4,7 +4,7 @@
 use std::{collections::VecDeque, sync::Arc};
 
 use miden_core::Felt;
-use midenc_runner::{MidenExecutor, PopFromStack};
+use midenc_debug::{MidenExecutor, PopFromStack};
 use midenc_session::Session;
 use proptest::{prop_assert_eq, test_runner::TestCaseError};