cargo_e/
ext.rs

1//! High-level API for embedding cargo-e: unified target collection (builtins + plugins)
2//!
3//! Provides `ExtContext` which holds the parsed CLI and process manager,
4//! and a `collect_targets` method to enumerate both built-in and plugin targets.
5// Core types always available
6use crate::{
7    e_collect::collect_all_targets, e_processmanager::ProcessManager, e_target::CargoTarget, Cli,
8};
9// Plugin API loading and target collection (only when plugins are enabled)
10#[cfg(feature = "uses_plugins")]
11use crate::plugins::plugin_api::load_plugins;
12use anyhow::{anyhow, Result};
13#[cfg(feature = "uses_plugins")]
14use once_cell::sync::OnceCell;
15use std::{collections::HashSet, path::PathBuf, sync::Arc};
16
17/// Embedding context for cargo-e: CLI, process manager, and discovery directory.
18pub struct ExtContext {
19    /// Parsed CLI options (same flags as the `cargo-e` binary)
20    pub cli: Cli,
21    /// Shared process manager for plugin in-process execution
22    pub manager: Arc<ProcessManager>,
23    /// Working directory used for scanning plugins
24    pub cwd: PathBuf,
25    /// Lazily-loaded plugin instances
26    #[cfg(feature = "uses_plugins")]
27    plugins: OnceCell<Vec<Box<dyn crate::plugins::plugin_api::Plugin>>>,
28}
29
30impl ExtContext {
31    /// Create a new embedding context with a CLI and ProcessManager.
32    /// Does not perform any target collection yet.
33    /// Create a new ExtContext; plugin loading is deferred until first use.
34    pub fn new(cli: Cli, manager: Arc<ProcessManager>) -> Result<Self> {
35        let cwd = std::env::current_dir()?;
36        Ok(ExtContext {
37            cli,
38            manager,
39            cwd,
40            #[cfg(feature = "uses_plugins")]
41            plugins: OnceCell::new(),
42        })
43    }
44
45    /// Collect all targets: built-in examples/binaries/tests/benches and plugin targets.
46    /// Deduplicates by (name, kind, extended).
47    pub fn collect_targets(&self) -> Result<Vec<CargoTarget>> {
48        // 1. Built-in targets
49        let threads = std::thread::available_parallelism()
50            .map(|n| n.get())
51            .unwrap_or(4);
52        let mut all = collect_all_targets(
53            self.cli.manifest_path.clone(),
54            self.cli.workspace,
55            threads,
56            self.cli.json_all_targets,
57        )
58        .map_err(|e| anyhow!("collect_all_targets failed: {}", e))?;
59        // 2. Plugin targets (load plugins only once)
60        #[cfg(feature = "uses_plugins")]
61        {
62            use crate::e_target::TargetKind;
63            use crate::e_target::TargetOrigin;
64            let plugins = self
65                .plugins
66                .get_or_try_init(|| load_plugins(&self.cli, self.manager.clone()))?;
67            for plugin in plugins.iter() {
68                if plugin.matches(&self.cwd) {
69                    let plugin_path = plugin
70                        .source()
71                        .map(PathBuf::from)
72                        .unwrap_or_else(|| self.cwd.clone());
73                    for pt in plugin.collect_targets(&self.cwd)? {
74                        let ct = if let Some(ct) = pt.cargo_target {
75                            ct
76                        } else {
77                            let reported = pt
78                                .metadata
79                                .as_ref()
80                                .map(PathBuf::from)
81                                .unwrap_or_else(|| self.cwd.clone());
82                            CargoTarget {
83                                name: pt.name.clone(),
84                                display_name: pt.name.clone(),
85                                manifest_path: self.cwd.clone(),
86                                kind: TargetKind::Plugin,
87                                extended: false,
88                                toml_specified: false,
89                                origin: Some(TargetOrigin::Plugin {
90                                    plugin_path: plugin_path.clone(),
91                                    reported,
92                                }),
93                            }
94                        };
95                        all.push(ct);
96                    }
97                }
98            }
99        }
100        // 3. Deduplicate
101        let mut seen = HashSet::new();
102        all.retain(|t| seen.insert((t.name.clone(), t.kind, t.extended)));
103        Ok(all)
104    }
105    /// Run a target (example, binary, or plugin-provided) using the shared ProcessManager.
106    /// Returns Ok(Some(status)) for built-in runs, or Ok(None) if no action was taken.
107    pub fn run_target(&self, target: &CargoTarget) -> Result<Option<std::process::ExitStatus>> {
108        // Plugin targets
109        #[cfg(feature = "uses_plugins")]
110        {
111            #[allow(unused_imports)]
112            use crate::e_target::{TargetKind, TargetOrigin};
113            if target.kind == TargetKind::Plugin {
114                // Find matching plugin (cached)
115                let plugins = self
116                    .plugins
117                    .get_or_try_init(|| load_plugins(&self.cli, self.manager.clone()))?;
118                for plugin in plugins.iter() {
119                    if let Some(crate::e_target::TargetOrigin::Plugin { plugin_path, .. }) =
120                        &target.origin
121                    {
122                        if plugin.source().map(PathBuf::from) == Some(plugin_path.clone()) {
123                            // Convert to plugin_api::Target
124                            let _plugin_target =
125                                crate::plugins::plugin_api::Target::from(target.clone());
126                            // Run in-process via plugin
127                            plugin.run_with_manager(self.manager.clone(), &self.cli, target)?;
128                            return Ok(None);
129                        }
130                    }
131                }
132                return Ok(None);
133            }
134        }
135        // Built-in via e_runner
136        crate::e_runner::run_example(self.manager.clone(), &self.cli, target)
137    }
138}
cargo_e/ext.rs

cargo_e/
ext.rs
