mirage-analyzer 1.7.0

Path-Aware Code Intelligence Engine for Rust
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

//! Mirage - Path-Aware Code Intelligence Engine
//!
//! A control-flow and logic graph engine for multi-language codebases.
//!
//! For high-level convenience functions, see the [`forge`] module.
//!
//! # Getting Started
//!
//! ```rust,no_run
//! use mirage_analyzer::Backend;
//! use std::path::Path;
//!
//! // Auto-detect and open the database backend
//! let backend = Backend::detect_and_open(Path::new("codegraph.db"))?;
//!
//! // Query CFG blocks
//! let blocks = backend.get_cfg_blocks(123)?;
//! # Ok::<(), anyhow::Error>(())
//! ```
//!
//! # Backend Support
//!
//! Mirage supports SQLite storage with optional geometric analysis:
//! - **SQLite**: Default backend, backward compatible with Magellan v7+
//!
//! The backend is automatically detected from the database file format.
//!
//! # Public API
//!
//! - [`Backend`] - Enum wrapping storage backends with auto-detection
//! - [`StorageTrait`] - Backend-agnostic storage interface
//! - [`MirageDb`] - Legacy database connection (wraps Backend internally)
//! - [`forge`] - High-level API for external consumers

pub mod analysis;
pub mod cfg;
pub mod cli;
pub mod forge;
pub mod integrations;
pub mod output;
pub mod platform;
pub mod storage;

// Public API exports
pub use storage::{
    create_schema, Backend, CfgBlockData, DatabaseStatus, DocumentInfo, FactInfo, MirageDb,
    StorageTrait,
};

// Forge convenience function re-exports
pub use forge::{
    database_status, detect_cycles, find_dead_symbols, get_callees, get_function_cfg,
    get_function_paths, reachable_symbols, resolve_function, CycleReport, DeadSymbolInfo,
    FunctionCfgResult,
};