txtpp 0.2.4

A simple-to-use general purpose preprocessor for text files.
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use std::fmt::{Display, Formatter};

mod directive_add_line;
mod directive_from;
use directive_from::TXTPP_HASH;

/// Directive struct
///
/// This object stores information detected from line that contains a directive
#[derive(Debug, PartialEq)]
pub struct Directive {
    /// The whitespaces string before the first non-whitespace character in the line
    pub whitespaces: String,
    /// The content from the first non-whitespace to the directive prefix `TXTPP#`
    pub prefix: String,
    /// The directive type
    pub directive_type: DirectiveType,
    /// The arguments of the directive
    pub args: Vec<String>,
}

impl Directive {
    /// Create a new directive
    pub fn new(
        whitespaces: &str,
        prefix: &str,
        directive_type: DirectiveType,
        args: Vec<String>,
    ) -> Self {
        Self {
            whitespaces: whitespaces.to_string(),
            prefix: prefix.to_string(),
            directive_type,
            args,
        }
    }
}

impl Display for Directive {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let arg_str = if self.args.len() == 1 {
            self.args[0].clone()
        } else {
            format!("{} ...", self.args[0])
        };
        write!(
            f,
            "{whitespaces}{prefix}{TXTPP_HASH}{directive_type} {arg_str}",
            whitespaces = self.whitespaces,
            prefix = self.prefix,
            directive_type = self.directive_type,
        )
    }
}

/// Directive type
#[derive(Debug, PartialEq)]
pub enum DirectiveType {
    /// Empty directive
    Empty,
    /// Include directive, argument is path to a file
    Include,
    /// After directive, argument is path to a file
    After,
    /// Run directive, argument is a command
    Run,
    /// Tag directive, argument is a string
    Tag,
    /// Temp directive, argument is file content
    Temp,
    /// Write directive, argument is file content
    Write,
}

impl TryFrom<&str> for DirectiveType {
    type Error = ();

    fn try_from(value: &str) -> std::result::Result<Self, Self::Error> {
        match value {
            "" => Ok(DirectiveType::Empty),
            "include" => Ok(DirectiveType::Include),
            "run" => Ok(DirectiveType::Run),
            "tag" => Ok(DirectiveType::Tag),
            "temp" => Ok(DirectiveType::Temp),
            "write" => Ok(DirectiveType::Write),
            "after" => Ok(DirectiveType::After),
            _ => Err(()),
        }
    }
}

impl DirectiveType {
    /// Does directive support multi-line arguments
    pub fn supports_multi_line(&self) -> bool {
        !matches!(
            self,
            DirectiveType::After | DirectiveType::Include | DirectiveType::Tag
        )
    }
}

impl Display for DirectiveType {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            DirectiveType::Empty => write!(f, ""),
            DirectiveType::Include => write!(f, "include"),
            DirectiveType::After => write!(f, "after"),
            DirectiveType::Run => write!(f, "run"),
            DirectiveType::Tag => write!(f, "tag"),
            DirectiveType::Temp => write!(f, "temp"),
            DirectiveType::Write => write!(f, "write"),
        }
    }
}