tex-fmt 0.5.7

LaTeX formatter written in 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Utilities for ignoring verbatim environments

use crate::format::{Pattern, State};
use crate::logging::{record_line_log, Log};
use log::Level::Warn;
use std::path::Path;

/// Information on the verbatim state of a line
#[derive(Clone, Debug)]
pub struct Verbatim {
    /// The verbatim depth of a line
    pub actual: i8,
    /// Whether the line is in a verbatim environment
    pub visual: bool,
}

impl Verbatim {
    /// Construct a new verbatim state
    #[must_use]
    pub const fn new() -> Self {
        Self {
            actual: 0,
            visual: false,
        }
    }
}

impl Default for Verbatim {
    fn default() -> Self {
        Self::new()
    }
}

/// Determine whether a line is in a verbatim environment
#[allow(clippy::too_many_arguments)]
pub fn get_verbatim(
    line: &str,
    state: &State,
    logs: &mut Vec<Log>,
    file: &Path,
    warn: bool,
    pattern: &Pattern,
    verbatims_begin: &[String],
    verbatims_end: &[String],
) -> Verbatim {
    let diff = get_verbatim_diff(line, pattern, verbatims_begin, verbatims_end);
    let actual = state.verbatim.actual + diff;
    let visual = actual > 0 || state.verbatim.actual > 0;

    if warn && (actual < 0) {
        record_line_log(
            logs,
            Warn,
            file,
            state.linum_new,
            state.linum_old,
            line,
            "Verbatim count is negative.",
        );
    }

    Verbatim { actual, visual }
}

/// Calculate total verbatim depth change
fn get_verbatim_diff(
    line: &str,
    pattern: &Pattern,
    verbatims_begin: &[String],
    verbatims_end: &[String],
) -> i8 {
    if pattern.contains_env_begin
        && verbatims_begin.iter().any(|r| line.contains(r))
    {
        1
    } else if pattern.contains_env_end
        && verbatims_end.iter().any(|r| line.contains(r))
    {
        -1
    } else {
        0
    }
}