depfile 0.1.1

Simply parse .d 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
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
use crate::Depfile;
use logos::{Logos, Span};
use std::borrow::Cow;

impl<'a> TryFrom<&'a str> for Depfile<'a> {
    type Error = usize;

    fn try_from(value: &'a str) -> Result<Self, Self::Error> {
        #[derive(PartialEq)]
        enum State {
            ExpectTarget,
            ContinueTargetOrColon,
            ExpectDeps,
        }
        let mut state = State::ExpectTarget;
        let mut lex = Token::lexer(value);

        let mut rules = Vec::new();
        let mut target = Vec::<Cow<'_, str>>::new();
        // buf is target name if state is expect target,
        // or dep name if expect dep
        let mut buf = Buf::None;
        let mut deps = Vec::new();

        loop {
            match lex.next() {
                None => {
                    match state {
                        State::ExpectTarget => {}
                        State::ContinueTargetOrColon => {
                            // expecting `:`
                            return Err(lex.span().start);
                        }
                        State::ExpectDeps => {
                            if !buf.is_empty() {
                                deps.push(buf.take_into_cow(value));
                            }

                            add_rule(&mut rules, &mut target, &mut deps);
                        }
                    }
                    break;
                }
                Some(Ok(Token::Lit)) => {
                    match state {
                        State::ExpectTarget => {
                            buf.update(lex.span(), value);
                            state = State::ContinueTargetOrColon;
                        }
                        State::ContinueTargetOrColon => {
                            buf.update(lex.span(), value);
                        }
                        State::ExpectDeps => {
                            buf.update(lex.span(), value);
                        }
                    }
                    continue;
                }
                Some(Ok(Token::Colon)) => {
                    match state {
                        State::ExpectTarget => {
                            // expecting lit
                            return Err(lex.span().start);
                        }
                        State::ContinueTargetOrColon => {
                            if !buf.is_empty() {
                                target.push(buf.take_into_cow(value));
                            }
                            debug_assert!(
                                !target.is_empty(),
                                "target should be non empty to enter ContinueTargetOrColon state"
                            );
                            state = State::ExpectDeps;
                        }
                        State::ExpectDeps => {
                            // assume it's unescaped colon
                            buf.update(lex.span(), value);
                        }
                    }
                    continue;
                }
                Some(Ok(Token::Space | Token::EscapeNewline)) => {
                    match state {
                        State::ExpectTarget => {}
                        State::ContinueTargetOrColon => {
                            // target separator
                            if !buf.is_empty() {
                                target.push(buf.take_into_cow(value));
                            }
                        }
                        State::ExpectDeps => {
                            // dep separator
                            if !buf.is_empty() {
                                deps.push(buf.take_into_cow(value));
                            }
                        }
                    }
                    continue;
                }
                Some(Ok(Token::Cr)) => {
                    // standalone \r is not allowed
                    return Err(lex.span().start);
                }
                Some(Ok(Token::Newline)) => {
                    // treat as whitespace unless in the middle of some text
                    match state {
                        State::ExpectTarget => {}
                        State::ContinueTargetOrColon => {
                            // gracefull
                        }
                        State::ExpectDeps => {
                            // end of dep
                            if !buf.is_empty() {
                                deps.push(buf.take_into_cow(value));
                            }
                            add_rule(&mut rules, &mut target, &mut deps);
                            state = State::ExpectTarget
                        }
                    }
                    continue;
                }
                Some(Ok(Token::EscapeColon)) => {
                    buf.push(':', value);
                    continue;
                }
                Some(Ok(Token::EscapeBackslash)) => {
                    buf.push('\\', value);
                    continue;
                }
                Some(Ok(Token::EscapeSpace)) => {
                    buf.push(' ', value);
                    continue;
                }
                Some(Err(())) => {
                    return Err(lex.span().start);
                }
            }
        }

        Ok(Self { rules })
    }
}

enum Buf {
    None,
    Span(Span),
    String(String),
}
impl Buf {
    fn is_empty(&self) -> bool {
        match self {
            Buf::None => true,
            Buf::Span(range) => range.start == range.end,
            Buf::String(s) => s.is_empty(),
        }
    }
    fn take_into_cow<'a>(&mut self, source: &'a str) -> Cow<'a, str> {
        let mut buf = Buf::None;
        std::mem::swap(self, &mut buf);
        buf.into_cow(source)
    }
    fn into_cow(self, source: &str) -> Cow<'_, str> {
        match self {
            Self::None => Cow::Borrowed(""),
            Self::Span(span) => {
                // safety: span must only be valid indices
                let source = unsafe { source.get_unchecked(span) };
                Cow::Borrowed(source)
            }
            Self::String(string) => Cow::Owned(string),
        }
    }

    fn update(&mut self, new_span: Span, source: &str) {
        match self {
            Self::None => *self = Self::Span(new_span.clone()),
            Self::Span(span) => span.end = new_span.end,
            Self::String(string) => {
                // safety: span must only be valid indices
                let source = unsafe { source.get_unchecked(new_span) };
                string.push_str(source);
            }
        }
    }

    fn push(&mut self, c: char, source: &str) {
        match self {
            Self::None => {
                let mut s = String::new();
                s.push(c);
                *self = Self::String(s);
            }
            Self::Span(span) => {
                let span = span.clone();
                // safety: span must only be valid indices
                let source = unsafe { source.get_unchecked(span) };
                *self = Self::String(format!("{source}{c}"));
            }
            Self::String(string) => {
                string.push(c);
            }
        }
    }
}

fn add_rule<'a>(
    rules: &mut Vec<(Cow<'a, str>, Vec<Cow<'a, str>>)>,
    targets: &mut Vec<Cow<'a, str>>,
    deps: &mut Vec<Cow<'a, str>>,
) {
    while !targets.is_empty() {
        if targets.len() == 1 {
            let t = targets.pop().unwrap();
            rules.push((t, std::mem::take(deps)));
            return;
        }
        let t = targets.pop().unwrap();
        rules.push((t, deps.clone()));
    }
}

#[derive(Logos, Debug, PartialEq)]
enum Token {
    /// `\ ` or `\` followed by a newline
    #[regex(r"\\\r?\n")]
    EscapeNewline,
    /// `\ ` or `\` followed by a newline
    #[regex(r"\\[ \t]")]
    EscapeSpace,
    /// `\\`
    #[token(r"\\")]
    EscapeBackslash,
    /// `\:`
    #[token(r"\:")]
    EscapeColon,
    /// A newline
    #[regex(r"\r?\n")]
    Newline,
    /// A `\r`
    #[token("\r")]
    Cr,
    /// A space
    #[regex(r"[\t ]")]
    Space,
    /// A colon
    #[token(r":")]
    Colon,
    // Any literal that's not one of the above
    #[regex(r"[^\\\r\n \t:]+")]
    Lit,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_token() {
        let mut lex = Token::lexer("");
        assert_eq!(lex.next(), None);
        let mut lex = Token::lexer("target: dep1 dep2 dep3");
        assert_eq!(lex.next(), Some(Ok(Token::Lit)));
        assert_eq!(lex.span(), 0..6);
        assert_eq!(lex.slice(), "target");
        assert_eq!(lex.next(), Some(Ok(Token::Colon)));
        assert_eq!(lex.span(), 6..7);
        assert_eq!(lex.next(), Some(Ok(Token::Space)));
        assert_eq!(lex.span(), 7..8);
        assert_eq!(lex.next(), Some(Ok(Token::Lit)));
        assert_eq!(lex.span(), 8..12);
        assert_eq!(lex.slice(), "dep1");
        assert_eq!(lex.next(), Some(Ok(Token::Space)));
        assert_eq!(lex.span(), 12..13);
        assert_eq!(lex.next(), Some(Ok(Token::Lit)));
        assert_eq!(lex.span(), 13..17);
        assert_eq!(lex.slice(), "dep2");
        assert_eq!(lex.next(), Some(Ok(Token::Space)));
        assert_eq!(lex.span(), 17..18);
        assert_eq!(lex.next(), Some(Ok(Token::Lit)));
        assert_eq!(lex.span(), 18..22);
        assert_eq!(lex.slice(), "dep3");
        assert_eq!(lex.next(), None);
        let mut lex = Token::lexer("tar\\ get: \\:dep1 \\\n dep2\\\r\n dep3");
        assert_eq!(lex.next(), Some(Ok(Token::Lit)));
        assert_eq!(lex.span(), 0..3);
        assert_eq!(lex.slice(), "tar");
        assert_eq!(lex.next(), Some(Ok(Token::EscapeSpace)));
        assert_eq!(lex.span(), 3..5);
        assert_eq!(lex.next(), Some(Ok(Token::Lit)));
        assert_eq!(lex.span(), 5..8);
        assert_eq!(lex.slice(), "get");
        assert_eq!(lex.next(), Some(Ok(Token::Colon)));
        assert_eq!(lex.span(), 8..9);
        assert_eq!(lex.next(), Some(Ok(Token::Space)));
        assert_eq!(lex.span(), 9..10);
        assert_eq!(lex.next(), Some(Ok(Token::EscapeColon)));
        assert_eq!(lex.span(), 10..12);
        assert_eq!(lex.next(), Some(Ok(Token::Lit)));
        assert_eq!(lex.span(), 12..16);
        assert_eq!(lex.slice(), "dep1");
        assert_eq!(lex.next(), Some(Ok(Token::Space)));
        assert_eq!(lex.span(), 16..17);
        assert_eq!(lex.next(), Some(Ok(Token::EscapeNewline)));
        assert_eq!(lex.span(), 17..19);
        assert_eq!(lex.next(), Some(Ok(Token::Space)));
        assert_eq!(lex.span(), 19..20);
        assert_eq!(lex.next(), Some(Ok(Token::Lit)));
        assert_eq!(lex.span(), 20..24);
        assert_eq!(lex.slice(), "dep2");
        assert_eq!(lex.next(), Some(Ok(Token::EscapeNewline)));
        assert_eq!(lex.span(), 24..27);
        assert_eq!(lex.next(), Some(Ok(Token::Space)));
        assert_eq!(lex.span(), 27..28);
        assert_eq!(lex.next(), Some(Ok(Token::Lit)));
        assert_eq!(lex.span(), 28..32);
        assert_eq!(lex.slice(), "dep3");
        assert_eq!(lex.next(), None);
    }

    #[test]
    fn test_parse_empty() {
        let df = crate::parse("").unwrap();
        assert!(df.is_empty());
        let df = crate::parse("  ").unwrap();
        assert!(df.is_empty());
        let df = crate::parse("\n").unwrap();
        assert!(df.is_empty());
        let df = crate::parse("\n\n \n").unwrap();
        assert!(df.is_empty());
    }

    macro_rules! deps {
        () => {
            Some(vec![].as_ref())
        };
        ($($x:literal),* $(,)?) => {
            Some(vec![$( $x.into() ),*].as_ref())
        };
    }

    #[test]
    fn test_parse_single_target() {
        let df = crate::parse("target:").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("target"), deps![]);
        let df = crate::parse("tar\\ get:").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("tar get"), deps![]);
        let df = crate::parse("tar\\:get:").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("tar:get"), deps![]);
        assert_eq!(df.find("foo"), None);
        let df = crate::parse("target:dep").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("target"), deps!["dep"]);
        let df = crate::parse("tar\\ get:dep").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("tar get"), deps!["dep"]);
        let df = crate::parse("tar\\:get:dep").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("tar:get"), deps!["dep"]);
        let df = crate::parse("target: dep").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("target"), deps!["dep"]);
        let df = crate::parse("tar\\ get: dep dep2.c").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("tar get"), deps!["dep", "dep2.c"]);
        let df = crate::parse("tar\\:get: dep dep\\\\ 2.c").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("tar:get"), deps!["dep", "dep\\", "2.c"]);
        let df = crate::parse("t\\ ar\\:get: dep \\\n  dep2 \\\n 2.c").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("t ar:get"), deps!["dep", "dep2", "2.c"]);
        // windows
        let df = crate::parse(r"my\ project\ with\:files.o: C\:\\path\ with\ spaces\\file\:name.c")
            .unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(
            df.find("my project with:files.o"),
            deps![r"C:\path with spaces\file:name.c"]
        );
    }

    #[test]
    fn test_parse_path_styles() {
        let df = crate::parse(r"build/output/main.o: src/core/main.c include/header.h").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(
            df.find("build/output/main.o"),
            deps![r"src/core/main.c", r"include/header.h"]
        );
        let df =
            crate::parse(r"build\\output\\main.o: src\\core\\main.c include\\header.h").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(
            df.find(r"build\output\main.o"),
            deps![r"src\core\main.c", r"include\header.h"]
        );
        // note: unescaped colon
        let df = crate::parse(r"target.o: C:/Users/Me/documents/file.c D:\\Project/Module\\sub.c")
            .unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(
            df.find(r"target.o"),
            deps![r"C:/Users/Me/documents/file.c", r"D:\Project/Module\sub.c"]
        );
    }

    #[test]
    fn test_parse_non_ascii() {
        let df = crate::parse(r"prôjet/débût/файл.o: src/main.c").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("prôjet/débût/файл.o"), deps![r"src/main.c"]);
        let df = crate::parse(
            r"répertoire\ de\ travail/fichier\ final.o: dossier\ source/你好module spécial.c",
        )
        .unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(
            df.find("répertoire de travail/fichier final.o"),
            deps![r"dossier source/你好module", "spécial.c"]
        );
    }

    #[test]
    fn test_multiple_targets() {
        let df = crate::parse(r"tar\ get1.o target2.o: dep1.c dep2.c").unwrap();
        assert_eq!(df.len(), 2);
        assert_eq!(df.find("tar get1.o"), deps![r"dep1.c", "dep2.c"]);
        assert_eq!(df.find("target2.o"), deps![r"dep1.c", "dep2.c"]);
        let df = crate::parse(
            r"targetA.o : depA1.c depA2.c
targetB.o\
: depB1.c
targetC.o: depC1.c depC2.c depC3.c",
        )
        .unwrap();
        assert_eq!(df.len(), 3);
        assert_eq!(df.find("targetA.o"), deps![r"depA1.c", "depA2.c"]);
        assert_eq!(df.find("targetB.o"), deps![r"depB1.c"]);
        assert_eq!(
            df.find("targetC.o"),
            deps![r"depC1.c", "depC2.c", "depC3.c"]
        );
        let df = crate::parse(
            r"a: b
c: d \
   e
f g: d c",
        )
        .unwrap();
        assert_eq!(df.len(), 4);
        assert_eq!(df.find("a"), deps!["b"]);
        assert_eq!(df.find("c"), deps!["d", "e"]);
        assert_eq!(df.find("f"), deps!["d", "c"]);
        assert_eq!(df.find("g"), deps!["d", "c"]);
    }

    #[test]
    fn test_invalid() {
        // missing :
        let df = crate::parse("target.0 depc");
        assert_eq!(df, Err(13));
        // unescaped :, graceful
        let df = crate::parse("target: :invalid").unwrap();
        assert_eq!(df.len(), 1);
        assert_eq!(df.find("target"), deps![":invalid"]);
        // trailing \
        let df = crate::parse("a:b\\");
        assert_eq!(df, Err(3));
        // no target name
        let df = crate::parse(":b");
        assert_eq!(df, Err(0));
    }
}