anchor-cli 1.1.1

Anchor CLI
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

//! `anchor debugger` — a foundry-style SBF instruction stepper built on the
//! same per-test register traces that `--profile` consumes for flamegraphs.
//!
//! ## Flow
//!
//! 1. The caller invokes the existing `anchor test --profile` pipeline,
//!    which leaves traces under `target/anchor-v2-profile/<test>/`.
//! 2. [`run`] walks that directory, materializes a [`DebugSession`], and
//!    launches the TUI.
//!
//! Keeping the trace-producing half identical to `--profile` means the
//! debugger and flamegraph don't drift: any improvement to the trace
//! pipeline is picked up by both.

use {
    anyhow::Result,
    std::{
        collections::BTreeMap,
        path::{Path, PathBuf},
    },
};

pub mod arena;
pub mod cargo_deps;
pub mod gdb;
pub mod highlight;
pub mod loose;
pub mod model;
pub mod path_label;
pub mod rustc_wrapper;
pub mod source;
pub mod tui;

/// Default trace directory name (relative to the workspace root). Mirrors
/// `crate::profile::DEFAULT_PROFILE_DIR` so the loose-mode flow agrees
/// with the Anchor.toml-driven flow on where to read/write traces.
pub fn loose_profile_dir_name() -> &'static str {
    crate::profile::DEFAULT_PROFILE_DIR
}

/// Build a [`model::DebugSession`] from the profile trace directory and
/// launch the TUI. Blocks until the user quits.
pub fn run(
    profile_dir: &Path,
    programs: &BTreeMap<String, PathBuf>,
    manifest_dir: Option<&Path>,
    crate_dir: Option<&Path>,
    test_filter: Option<&str>,
) -> Result<()> {
    // Probe the terminal background BEFORE anything that might call into
    // `highlight::ctx()` (arena pre-highlights disasm). The detection
    // round-trips an OSC 11 query on a regular TTY; once the TUI raw-mode
    // takeover starts, the reply might not get back to us cleanly.
    highlight::detect_theme_mode_once();
    let session =
        arena::build_session(profile_dir, programs, manifest_dir, crate_dir, test_filter)?;
    tui::run(session)
}