rsconstruct 0.9.85

Rust based fast build system
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

//! Analyzer plugin registry.
//!
//! Every dependency analyzer (cpp, icpp, python, markdown, tera) submits an
//! [`AnalyzerPlugin`] entry via `inventory::submit!`. Analyzers are separate
//! from processors — they run after product discovery to add dependency edges
//! (e.g. C/C++ `#include` graphs, Python imports).

use anyhow::Result;

use crate::analyzers::DepAnalyzer;

/// An analyzer plugin. Each analyzer file submits one via `inventory::submit!`.
pub struct AnalyzerPlugin {
    pub name: &'static str,
    pub description: &'static str,
    pub is_native: bool,
    /// Create an analyzer from its TOML config section.
    /// Receives the instance name (iname) for cache-tagging, the raw
    /// `[analyzer.IN]` table value, and a verbose flag.
    pub create: fn(&str, &toml::Value, bool) -> Result<Box<dyn DepAnalyzer>>,
    /// Return the default config as a TOML string, or None if the analyzer has no config.
    pub defconfig_toml: fn() -> Option<String>,
    /// Config field names known to this analyzer. Used by `validate_analyzer_fields`
    /// to reject unknown fields before the analyzer is instantiated.
    pub known_fields: fn() -> &'static [&'static str],
}

unsafe impl Sync for AnalyzerPlugin {}

inventory::collect!(AnalyzerPlugin);

pub fn all_analyzer_plugins() -> impl Iterator<Item = &'static AnalyzerPlugin> {
    inventory::iter::<AnalyzerPlugin>.into_iter()
}

/// Return sorted analyzer names from the registry.
pub fn all_analyzer_names() -> Vec<&'static str> {
    let mut names: Vec<&str> = all_analyzer_plugins().map(|p| p.name).collect();
    names.sort_unstable();
    names
}

/// Find an analyzer plugin by name.
pub fn find_analyzer_plugin(name: &str) -> Option<&'static AnalyzerPlugin> {
    all_analyzer_plugins().find(|p| p.name == name)
}

/// Build a clap value parser that accepts any registered analyzer name.
pub fn analyzer_name_parser() -> clap::builder::PossibleValuesParser {
    clap::builder::PossibleValuesParser::new(all_analyzer_names())
}