devela 0.27.0

A development layer of coherence.
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

// devela::sys::mem::view::slice::join
//
//! Defines the [`const_join!`] macro.
//

#[doc = crate::_tags!(code)]
/// Joins multiple byte slices or string slices in compile-time.
#[doc = crate::_doc_location!("sys/mem/view")]
///
/// It leverages the [`ArrayFrom`][crate::ArrayFrom] struct.
///
/// Note that these operations are slow and should not be used for fast paths,
/// but mostly for compile-time needs.
///
/// # Example
/// ```
/// # use devela::{const_assert, const_join};
/// /* string slices */
///
/// const SBASE: &str = "path/to";
/// const SPART1: &str = "/foo";
/// const SPART2: &str = "/bar";
/// const SPATH: &str = const_join!(str: SBASE, SPART1, SPART2);
/// const_assert![eq_str SPATH, "path/to/foo/bar"];
///
/// const SREPEATED: &str = const_join!(str_repeated: SPART1, 3);
/// const_assert![eq_str SREPEATED, "/foo/foo/foo"];
///
/// const SPARTS: &str = const_join!(str_separated: "/"; "path", "to", "file");
/// const_assert!(eq_str SPARTS, "path/to/file");
///
/// /* byte slices */
///
/// const BBASE: &[u8] = b"path/to";
/// const BPART1: &[u8] = b"/foo";
/// const BPART2: &[u8] = b"/bar";
/// const BPATH: &[u8] = const_join!(bytes: BBASE, BPART1, BPART2);
/// const_assert![eq_buf BPATH, b"path/to/foo/bar"];
///
/// const BREPEATED: &[u8] = const_join!(bytes_repeated: BPART1, 3);
/// const_assert![eq_buf BREPEATED, b"/foo/foo/foo"];
///
/// const BPARTS: &[u8] = const_join!(bytes_separated: b"/"; b"path", b"to", b"file");
/// const_assert!(eq_buf BPARTS, b"path/to/file");
/// ```
///
/// # Features
/// Makes use of the `unsafe_str` feature if available.
#[macro_export]
#[cfg_attr(cargo_primary_package, doc(hidden))]
macro_rules! _const_join {
    /* bytes */

    // trivial cases
    (bytes:) => { &[] };
    (bytes: $bytes:expr $(,)?) => { $crate::const_join!(bytes_as_slice: $bytes) };
    // main implementation
    (bytes: $($bytes: expr),+ $(,)?) => {{
        const SLICES: &[&[u8]] = &[$( $crate::const_join!(bytes_as_slice: $bytes) ),+];
        const LEN: usize = $crate::ArrayFrom(SLICES).len();
        &$crate::ArrayFrom(SLICES).to_array::<LEN>()
    }};

    // Repeat a byte slice a constant number of times:
    (bytes_repeated: $bytes:expr, $num:expr $(,)?) => {{
        const SLICE: &[u8] = $crate::const_join!(bytes_as_slice: $bytes);
        const NUM: usize = $num;
        const LEN: usize = SLICE.len() * NUM;
        const fn repeated() -> [u8; LEN] {
            let (mut out, mut i) = ([0u8; LEN], 0);
            while i < NUM {
                $crate::Slice::<u8>::copy_array_at(&mut out, SLICE, i * SLICE.len()); i += 1;
            }
            out
        }
        &repeated()
    }};
    (bytes_separated: $sep:expr; $first:expr, $($rest:expr),+ $(,)?) => {{
        const fn join() -> [u8; LEN] {
            let (mut out, mut pos, mut i) = ([0u8; LEN], 0, 0);
            // First part (no preceding separator)
            while i < $first.len() { out[pos] = $first[i]; pos += 1; i += 1; }
            // Subsequent parts with separators
            $(
                let mut j = 0; // Separator
                while j < $sep.len() { out[pos] = $sep[j]; pos += 1; j += 1; }
                let mut k = 0; // Part
                while k < $rest.len() { out[pos] = $rest[k]; pos += 1; k += 1; }
            )+
            out
        }
        const SEP: &[u8] = $sep;
        const LEN: usize = $first.len() $(+ SEP.len() + $rest.len())+;
        &join()
    }};
    // input normalization
    (bytes_as_slice: $bytes: expr) => {{
        const LEN: usize = $crate::ArrayFrom($bytes).len();
        &$crate::ArrayFrom($bytes).to_array::<LEN>()
    }};

    /* strings */

    // trivial cases
    (str: ) => { "" };
    (str: $A:expr $(,)?) => { $A };
    // variadic case: Reduce to two-argument case
    (str: $A:expr, $B:expr, $($rest:expr),+ $(,)?) => {
        $crate::const_join!(str: $A, $crate::const_join!(str: $B $(, $rest)+))
    };
    // two args (base case)
    (str: $A:expr, $B:expr $(,)?) => {{
        const fn combined() -> [u8; LEN] {
            let mut out = [0u8; LEN];
            $crate::Slice::<u8>::copy_array_at(&mut out, A.as_bytes(), 0);
            $crate::Slice::<u8>::copy_array_at(&mut out, B.as_bytes(), A.len());
            out
        }
        const A: &str = $A;
        const B: &str = $B;
        const LEN: usize = A.len() + B.len();
        const RESULT: &[u8] = &combined();
        $crate::Str::__utf8_bytes_to_str(RESULT)
    }};
    // Repeat a string slice a constant number of times:
    (str_repeated: $A:expr, $count:expr $(,)?) => {{
        const fn repeated() -> [u8; LEN] {
            let mut out = [0u8; LEN];
            let mut i = 0;
            while i < COUNT {
                $crate::Slice::<u8>::copy_array_at(&mut out, A.as_bytes(), i * A.len());
                i += 1;
            }
            out
        }
        const A: &str = $A;
        const COUNT: usize = $count;
        const LEN: usize = A.len() * COUNT;
        const REPEATED: &[u8] = &repeated();
        $crate::Str::__utf8_bytes_to_str(REPEATED)
    }};
    // Join strings with separator
    (str_separated: $sep:expr; $first:expr, $($rest:expr),+ $(,)?) => {{
        const fn join() -> [u8; LEN] {
            let (mut out, mut pos, mut i) = ([0u8; LEN], 0, 0);
            // First part
            let first = $first.as_bytes();
            while i < first.len() { out[pos] = first[i]; pos += 1; i += 1; }
            // Subsequent parts
            $(
                let mut j = 0; // Separator
                let sep = $sep.as_bytes();
                while j < sep.len() { out[pos] = sep[j]; pos += 1; j += 1; }
                let mut k = 0; // Part
                let rest = $rest.as_bytes();
                while k < rest.len() { out[pos] = rest[k]; pos += 1; k += 1; }
            )+
            out
        }
        const SEP: &str = $sep;
        const LEN: usize = $first.len() $(+ SEP.len() + $rest.len())+;
        const RESULT: &[u8] = &join();
        $crate::Str::__utf8_bytes_to_str(RESULT)
    }};
}
#[doc(inline)]
pub use _const_join as const_join;

#[cfg(test)]
mod tests {
    #![allow(unused)]

    use crate::{const_assert, const_join};

    #[test]
    const fn join_bytes() {
        const BASE: &[u8] = b"path/to";
        const PART1: &[u8] = b"/foo";
        const PART2: &[u8] = b"/bar";
        const PATH: &[u8] = const_join!(bytes: BASE, PART1, PART2);
        const_assert![eq_buf PATH, b"path/to/foo/bar"];

        const REPEATED: &[u8] = const_join!(bytes_repeated: PART1, 3);
        const_assert![eq_buf REPEATED, b"/foo/foo/foo"];

        const PARTS: &[u8] = const_join!(bytes_separated: b"/"; b"path", b"to", b"file");
        const_assert!(eq_buf PARTS, b"path/to/file");
    }
    #[test]
    const fn join_bytes_mixed() {
        // Array literals
        const ARR_ARR: &[u8] = const_join!(bytes: [1, 2], [3, 4]);
        const_assert!(eq_buf ARR_ARR, &[1,2,3,4]);

        const ARR_SLI: &[u8] = const_join!(bytes: [1, 2], &[3, 4]);
        const_assert!(eq_buf ARR_SLI, &[1,2,3,4]);

        const ARR_LIT: &[u8] = const_join!(bytes: [1, 2, 3], 4);
        const_assert!(eq_buf ARR_LIT, &[1,2,3,4]);

        const STR_ARR_LIT_SLI: &[u8] = const_join!(bytes: "01", [1, 2], 3, &[4]);
        const_assert!(eq_buf STR_ARR_LIT_SLI, &[48,49,1,2,3,4]);
    }
    #[test]
    #[cfg(feature = "term")]
    const fn join_bytes_ansi() {
        use crate::Ansi;
        const ANSI0: &[u8] = const_join!(bytes: Ansi::BOLD);
        const_assert!(eq_buf & [27, 91, 49, 109], ANSI0);

        const ANSI1: &[u8] = const_join!(bytes: Ansi::BOLD, Ansi::ITALIC);
        const_assert![eq_buf & [27, 91, 49, 109, 27, 91, 51, 109], ANSI1];
    }

    #[test]
    const fn join_str() {
        const BASE: &str = "path/to";
        const PART1: &str = "/foo";
        const PART2: &str = "/bar";
        const PATH: &str = const_join!(str: BASE, PART1, PART2);
        const_assert![eq_str PATH, "path/to/foo/bar"];

        const REPEATED: &str = const_join!(str_repeated: PART1, 3);
        const_assert![eq_str REPEATED, "/foo/foo/foo"];

        const PARTS: &str = const_join!(str_separated: "/"; "path", "to", "file");
        const_assert!(eq_str PARTS, "path/to/file");
    }
}