texform-transform 0.1.0

Profile-based AST transform engine for TeXForm (internal; use the texform crate)
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

//! Eliminated-form contract checked after the full transform pipeline.

use crate::ast::Ast;
use crate::parse::ParseContext;
use crate::rewrite::rule::RuleTargetKey;
use crate::rewrite::scheduler::{node_name_for_target, target_present};

/// A single eliminated-form contract violation found in an AST.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ContractViolation {
    /// The eliminated form that is still present.
    pub target: RuleTargetKey,
    /// Best-effort node name for human-facing diagnostics.
    pub node_name: Option<String>,
}

impl std::fmt::Display for ContractViolation {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "contract violation for {} `{}` (node {:?})",
            self.target.kind_label(),
            self.target.name,
            self.node_name
        )
    }
}

/// Collects all eliminated-form contract violations currently present in `ast`.
pub fn collect_eliminated_violations(
    ast: &Ast,
    parse_ctx: &ParseContext,
    eliminated_forms: &[RuleTargetKey],
) -> Vec<ContractViolation> {
    let mut violations = Vec::new();

    for node_id in ast.find_all(ast.root(), |_| true) {
        for target in eliminated_forms {
            if target_present(ast, node_id, *target, parse_ctx) {
                let node_name = node_name_for_target(ast, node_id);
                violations.push(ContractViolation {
                    target: *target,
                    node_name,
                });
            }
        }
    }

    violations
}