termctl 0.1.2

small crate for controlling terminal output
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

#![allow(dead_code)]
#![allow(unused_macros)]
#![no_main]

use std::{
    fmt,
    io::{Write, Stdout},
    io,
    str,
};

pub mod erase;
pub mod cursor;
// this module (style.rs) contains a non macro defined fn.
pub mod style;
pub mod screen;

/// Object used for printing multiple escape sequences
pub struct MultiSeq(String);

impl MultiSeq {
    /// generates a storage struct for multi escape code sequences.
    pub fn new() -> Self {
        return Self(String::new()) 
    } 

    fn add(&mut self, seq: impl AsRef<str>) {
        self.0.push_str(seq.as_ref());     
    }

    /// prints the multi escape code sequence.
    pub fn print(&self, stdout: &mut Stdout) -> io::Result<()> {
        print!("{}", self.0);
        stdout.flush()?;
        return Ok(());
    } 
}

/// function used for printing singular escape sequences.
#[inline(always)]
fn template(
    stdout: &mut Stdout,
    msg: impl fmt::Display
) -> io::Result<()> {
    print!("{msg}");
    stdout.flush()?;    
    return Ok(()); 
}

/// generates almost all of the functions in the library.
#[macro_export]
macro_rules! gen_all {
    ($(
        $seq:literal, $args:expr, 
        [$(($arg_name:pat_param, $arg_type:ty)),*];
        $fn_name:ident,
        $doc:literal
    );*;) => {$(
        impl crate::MultiSeq {
            #[doc=concat!("Added to multi sequence struct:", $doc)]
            pub fn $fn_name(
                &mut self,
                $($arg_name: $arg_type),*
            ) {
                self.add(crate::MacroFmt::macro_fmt(
                    $args,
                    $seq,
                ))
            }
        }

        #[doc=$doc]
        pub fn $fn_name(
            mut stdout: &mut std::io::Stdout,
            $($arg_name: $arg_type),*
        ) -> std::io::Result<()> {
            Ok(crate::template( 
                &mut stdout,
                crate::MacroFmt::macro_fmt(
                    $args,
                    $seq,
                ),
            )?) 
        }
    )*};

    ($(($seq:literal, $name:ident, $doc:literal,));*;) => {$(
        impl crate::MultiSeq {
            #[doc=concat!("Added to multi sequence struct:", $doc)]
            pub fn $name(&mut self) {
                self.add($seq)
            }
        }

        #[doc=$doc]
        pub fn $name(mut stdout: &mut std::io::Stdout) -> std::io::Result<()> {
            Ok(crate::template( 
                &mut stdout,
                $seq,
            )?) 
        }
    )*};  
}

pub struct StrArray<'a, const N: usize>([&'a str; N]);

impl<'a, const N: usize> StrArray<'a, N> {
    #[inline(always)]
    pub fn new(str_array: [&'a str; N]) -> Self {
        return StrArray(str_array);
    }
}

impl<'a, const N: usize> AsRef<[&'a str]> for StrArray<'a, N> {
    fn as_ref(&self) -> &[&'a str] {
        return &self.0[0..];
    } 
}

pub trait MacroFmt {
    const PAT: &'static str = "{}";
    const ERR: &'static str = "Error: Differing number of formatting arguments and brace patterns";

    fn macro_fmt(
        &self,
        lit: &'static str,
    ) -> String;
}


impl<const N: usize> MacroFmt for StrArray<'_, N> {
    fn macro_fmt(
        &self,
        lit: &'static str,
    ) -> String {
        let mut ret = lit.to_string(); 

        debug_assert_eq!(
            ret.matches(Self::PAT)
                .collect::<Vec<&str>>()
                .len(),
            self.as_ref().len(),
            "{}", Self::ERR,
        );

        for fmt in self.as_ref() {
            ret = ret.replacen(Self::PAT, fmt, 1);
        }

        return ret;
    }
}

impl MacroFmt for &str {
    fn macro_fmt(
        &self,
        lit: &'static str,
    ) -> String {
        let ret = lit.to_string();

        debug_assert_eq!(
            ret.matches(Self::PAT)
                .collect::<Vec<&str>>()
                .len(),
            1, 
            "{}", Self::ERR,
        );

        return ret.replacen(Self::PAT, self, 1);
    }
}