tengwar 1.1.0

Transliterate text into J.R.R. Tolkien's Tengwar.
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

//! Utility module for more easily writing more meaningful test code.
#![cfg(test)]


macro_rules! params {
    () => { "" };
    ($k:ident=$v:expr) => {
        concat!(stringify!($k), "=", stringify!($v))
    };
    ($k:ident=$v:expr $(, $kn:ident=$vn:expr)+ $(,)?) => {
        concat!(params!($k=$v), $(", ", params!($kn=$vn)),+)
    };
    ($($t:tt)*) => { stringify!($($t)*) };
}


/// Convert an input into the Tengwar. If the input is a string literal, this
///     will transcribe it, returning a tuple with the input and output. If the
///     input is an already-transcribed tuple, this will resolve to a reference.
macro_rules! tengwar {
    ($mode:ty $([])?, $input:literal) => {
        ($input, <$mode as $crate::TengwarMode>::transcribe::<String>($input))
    };
    ($mode:ty [$($k:ident=$v:expr),+ $(,)?], $input:literal) => {{
        let mut iter = <$mode as $crate::TengwarMode>::default_transcriber($input);
        $(iter.settings.$k = $v;)+
        ($input, iter.collect::<String>())
    }};
    ($mode:ty $([$($t:tt)*])?, $input:expr) => { &$input };
}


/// Test the output of the transcription process by specifying a mode, and some
///     values that should either match or differ.
macro_rules! test_tengwar {
    //  Save the conversion for later reuse.
    ($mode:ty $([$($t:tt)*])?, $lhs:tt $op:tt $rhs:tt as $bind:tt) => {
        let $bind = test_tengwar!($mode $([$($t)*])?, $lhs $op $rhs);
    };
    ($lhs:tt $op:tt $rhs:tt as $bind:tt) => {
        let $bind = test_tengwar!($lhs $op $rhs);
    };

    //  Allow chaining multiple test operations.
    ($mode:ty $([$($t:tt)*])?, $lhs:tt $op:tt $rhs:tt $($more:tt)+) => {{
        let lhs = tengwar!($mode $([$($t)*])?, $lhs);
        test_tengwar!($mode $([$($t)*])?, lhs $op $rhs);
        test_tengwar!($mode $([$($t)*])?, lhs $($more)+);
        lhs
    }};

    //  Specify that the input must transcribe to an exact sequence of `char`s.
    ($mode:ty $([$($t:tt)*])?, $lhs:tt => $rhs:tt) => {{
        let conversion = tengwar!($mode $([$($t)*])?, $lhs);
        let (input, output) = &conversion;
        let expected: String = $rhs.into_iter().collect();

        println!(
            // "[{file}:{line:0>3}] {mode}: {input:?} -> {output}{params}",
            "[{file}:{line:0>3}] {input:?} -> {output}{params}",
            file = file!(),
            line = line!(),
            // mode = stringify!($mode),
            params = concat!($("  [", params!($($t)*), "]")?),
        );

        assert_eq!(expected.as_str(), output.as_str(),
            "Transcription of {input:?} does not match expectation.\
            \n  Expected: {expected}\
            \n  Received: {output}",
        );

        conversion
    }};

    //  Specify that the input must transcribe to the same as another.
    ($mode:ty $([$($t:tt)*])?, $lhs:tt == $rhs:tt) => {{
        let lhs = tengwar!($mode $([$($t)*])?, $lhs);
        let rhs = tengwar!($mode $([$($t)*])?, $rhs);
        let (lhs_in, lhs_out) = &lhs;
        let (rhs_in, rhs_out) = &rhs;

        assert_eq!(lhs_out.as_str(), rhs_out.as_str(),
            "Transcription of {lhs_in:?} does not match that of {rhs_in:?}.\
            \n  {lhs_in:>w$}  (left): {lhs_out}\
            \n  {rhs_in:>w$} (right): {rhs_out}",
            w = lhs_in.chars().count().max(rhs_in.chars().count()),
        );

        lhs
    }};
    ($mode:ty $([$($t:tt)*])?, $lhs:tt != $rhs:tt) => {{
        let lhs = tengwar!($mode $([$($t)*])?, $lhs);
        let rhs = tengwar!($mode $([$($t)*])?, $rhs);
        let (lhs_in, lhs_out) = &lhs;
        let (rhs_in, rhs_out) = &rhs;

        assert_ne!(lhs_out.as_str(), rhs_out.as_str(),
            "Transcription of {lhs_in:?} wrongly matches that of {rhs_in:?}.\
            \n  {lhs_in:>w$}  (left): {lhs_out}\
            \n  {rhs_in:>w$} (right): {rhs_out}",
            w = lhs_in.chars().count().max(rhs_in.chars().count()),
        );

        lhs
    }};

    //  Specify that saved transcriptions must match.
    ($lhs:ident == $rhs:ident) => {{
        let (lhs_in, lhs_out) = &$lhs;
        let (rhs_in, rhs_out) = &$rhs;

        assert_eq!(lhs_out, rhs_out,
            "Output of `{lhs}` does not match that of `{rhs}`.\
            \n  {lhs_in:>w$}  (left): {lhs_out}\
            \n  {rhs_in:>w$} (right): {rhs_out}",
            lhs = stringify!($lhs),
            rhs = stringify!($rhs),
            w = lhs_in.chars().count().max(rhs_in.chars().count()),
        );
    }};
    ($lhs:ident != $rhs:ident) => {{
        let (lhs_in, lhs_out) = &$lhs;
        let (rhs_in, rhs_out) = &$rhs;

        assert_ne!(lhs_out, rhs_out,
            "Output of `{lhs}` wrongly matches that of `{rhs}`.\
            \n  {lhs_in:>w$}  (left): {lhs_out}\
            \n  {rhs_in:>w$} (right): {rhs_out}",
            lhs = stringify!($lhs),
            rhs = stringify!($rhs),
            w = lhs_in.chars().count().max(rhs_in.chars().count()),
        );
    }};
}