litnik 0.2.1

An embedded Lit and FileCheck runner for compiler test suites.
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
use crate::shell::ast::Command;
use crate::shell::environment::ShellEnv;
use std::fs;
use std::io;

/// Result of a standalone builtin command.
#[derive(Debug, Clone)]
pub struct ExecResult {
    /// Text written to standard output.
    pub stdout: String,
    /// Text written to standard error.
    pub stderr: String,
    /// Process-style status, where zero denotes success.
    pub exit_code: i32,
}

/// Returns whether `name` is routed to the in-process builtin layer.
///
/// A recognized name can still fail on the current platform. `ulimit` is
/// recognized so it can be rejected instead of silently invoking a host
/// utility without applying the requested limit.
pub fn is_inproc_builtin(name: &str) -> bool {
    matches!(
        name,
        "cd" | "pushd"
            | "popd"
            | "export"
            | "echo"
            | "@echo"
            | "mkdir"
            | "rm"
            | "umask"
            | "ulimit"
            | ":"
    )
}

/// Executes a builtin against mutable shell state.
///
/// Stateful operations such as `cd` and `export` update `env` on success.
/// Standard input is accepted for the executor interface; these builtins do
/// not consume it.
///
/// # Errors
///
/// Returns an error for malformed arguments, invalid directory transitions,
/// and operations unsupported on the current platform.
pub fn run_inproc_builtin(
    cmd: &Command,
    env: &mut ShellEnv,
    _stdin: Option<&str>,
) -> Result<ExecResult, String> {
    if cmd.args.is_empty() {
        return Ok(ExecResult {
            stdout: String::new(),
            stderr: String::new(),
            exit_code: 0,
        });
    }

    match cmd.args[0].as_str() {
        "cd" => builtin_cd(cmd, env),
        "pushd" => builtin_pushd(cmd, env),
        "popd" => builtin_popd(cmd, env),
        "export" => builtin_export(cmd, env),
        "echo" | "@echo" => builtin_echo(cmd, env, None),
        "mkdir" => builtin_mkdir(cmd, env),
        "rm" => builtin_rm(cmd, env),
        "umask" => builtin_umask(cmd, env),
        "ulimit" => builtin_ulimit(cmd, env),
        ":" => Ok(ExecResult {
            stdout: String::new(),
            stderr: String::new(),
            exit_code: 0,
        }),
        _ => Err(format!("unsupported builtin '{}'", cmd.args[0].as_str())),
    }
}

fn builtin_cd(cmd: &Command, env: &mut ShellEnv) -> Result<ExecResult, String> {
    if cmd.args.len() != 2 {
        return Err("'cd' supports exactly one argument".into());
    }
    env.change_dir(cmd.args[1].as_str())?;
    Ok(ExecResult {
        stdout: String::new(),
        stderr: String::new(),
        exit_code: 0,
    })
}

fn builtin_pushd(cmd: &Command, env: &mut ShellEnv) -> Result<ExecResult, String> {
    if cmd.args.len() != 2 {
        return Err("'pushd' supports exactly one argument".into());
    }
    env.pushd(cmd.args[1].as_str())?;
    Ok(ExecResult {
        stdout: String::new(),
        stderr: String::new(),
        exit_code: 0,
    })
}

fn builtin_popd(cmd: &Command, env: &mut ShellEnv) -> Result<ExecResult, String> {
    if cmd.args.len() != 1 {
        return Err("'popd' does not support arguments".into());
    }
    env.popd()
        .ok_or_else(|| "popd: directory stack empty".to_string())?;
    Ok(ExecResult {
        stdout: String::new(),
        stderr: String::new(),
        exit_code: 0,
    })
}

fn builtin_export(cmd: &Command, env: &mut ShellEnv) -> Result<ExecResult, String> {
    if cmd.args.len() == 1 {
        let mut entries = env
            .env
            .iter()
            .map(|(key, value)| format!("{key}={value}"))
            .collect::<Vec<_>>();
        entries.sort_unstable();
        let output = entries.join("\n") + "\n";
        return Ok(ExecResult {
            stdout: output,
            stderr: String::new(),
            exit_code: 0,
        });
    }

    let mut i = 1usize;
    let mut unset_next = false;
    let mut clear_env = false;
    while i < cmd.args.len() {
        let arg = cmd.args[i].as_str();
        if unset_next {
            env.env.remove(arg);
            unset_next = false;
            i += 1;
            continue;
        }
        if arg == "-u" {
            unset_next = true;
            i += 1;
            continue;
        }
        if arg == "-i" {
            clear_env = true;
            i += 1;
            continue;
        }

        if clear_env {
            env.env.clear();
            clear_env = false;
        }

        let Some((key, value)) = arg.split_once('=') else {
            return Err(format!("'export' malformed assignment '{arg}'"));
        };
        env.env.insert(key.to_string(), value.to_string());
        i += 1;
    }

    if unset_next {
        return Err("'export -u' requires a variable name".to_string());
    }
    if clear_env {
        env.env.clear();
    }

    Ok(ExecResult {
        stdout: String::new(),
        stderr: String::new(),
        exit_code: 0,
    })
}

fn builtin_echo(
    cmd: &Command,
    _env: &mut ShellEnv,
    _stdin: Option<&str>,
) -> Result<ExecResult, String> {
    let mut args = cmd.args.iter().skip(1).peekable();
    let mut interpret_escape = false;
    let mut add_newline = true;
    let mut payload = Vec::new();

    while let Some(arg) = args.peek() {
        match arg.as_str() {
            "-e" => {
                interpret_escape = true;
                args.next();
            }
            "-n" => {
                add_newline = false;
                args.next();
            }
            _ => break,
        }
    }

    for arg in args {
        payload.push(decode_echo(arg.as_str(), interpret_escape));
    }

    let mut out = String::new();
    if !payload.is_empty() {
        out.push_str(&payload.join(" "));
    }
    if add_newline {
        out.push('\n');
    }

    Ok(ExecResult {
        stdout: out,
        stderr: String::new(),
        exit_code: 0,
    })
}

fn decode_echo(input: &str, interpret_escape: bool) -> String {
    if !interpret_escape {
        return input.to_string();
    }
    let mut out = String::new();
    let mut chars = input.chars().peekable();
    while let Some(ch) = chars.next() {
        if ch != '\\' {
            out.push(ch);
            continue;
        }
        match chars.next() {
            Some('n') => out.push('\n'),
            Some('t') => out.push('\t'),
            Some('r') => out.push('\r'),
            Some('0') => out.push('\0'),
            Some(other) => out.push(other),
            None => out.push('\\'),
        }
    }
    out
}

fn builtin_mkdir(cmd: &Command, env: &mut ShellEnv) -> Result<ExecResult, String> {
    if cmd.args.len() < 2 {
        return Err("mkdir: missing operand".into());
    }
    let mut recursive = false;
    let mut paths = Vec::new();
    let mut i = 1usize;
    while i < cmd.args.len() {
        let arg = cmd.args[i].as_str();
        if arg == "-p" {
            recursive = true;
            i += 1;
            continue;
        }
        if arg == "--" {
            i += 1;
            paths.extend(cmd.args[i..].iter().map(|arg| arg.as_owned_text()));
            break;
        }
        if arg.starts_with('-') && arg != "-" {
            if arg[1..].chars().all(|flag| flag == 'p') {
                recursive = true;
                i += 1;
                continue;
            }
            return Err(format!("mkdir: unsupported option '{arg}'"));
        }
        paths.push(arg.to_string());
        i += 1;
    }
    if paths.is_empty() {
        return Err("mkdir: missing operand".into());
    }

    let mut stderr = String::new();
    let mut exit_code = 0;
    for path in paths {
        let path = env.resolve_path(&path);
        let result = if recursive {
            fs::create_dir_all(&path)
        } else {
            fs::create_dir(&path)
        };
        if let Err(err) = result {
            exit_code = 1;
            stderr.push_str(&format!("mkdir: {err}\n"));
        }
    }

    Ok(ExecResult {
        stdout: String::new(),
        stderr,
        exit_code,
    })
}

fn builtin_rm(cmd: &Command, env: &mut ShellEnv) -> Result<ExecResult, String> {
    if cmd.args.len() < 2 {
        return Err("rm: missing operand".into());
    }
    let mut force = false;
    let mut recursive = false;
    let mut paths = Vec::new();

    let mut i = 1usize;
    while i < cmd.args.len() {
        let arg = cmd.args[i].as_str();
        if arg == "-f" {
            force = true;
            i += 1;
            continue;
        }
        if arg == "-r" || arg == "-R" || arg == "--recursive" {
            recursive = true;
            i += 1;
            continue;
        }
        if arg == "--" {
            i += 1;
            paths.extend(cmd.args[i..].iter().map(|arg| arg.as_owned_text()));
            break;
        }
        if arg.starts_with('-') && arg != "-" {
            let mut recognized = true;
            for flag in arg[1..].chars() {
                match flag {
                    'f' => force = true,
                    'r' | 'R' => recursive = true,
                    _ => recognized = false,
                }
            }
            if recognized {
                i += 1;
                continue;
            }
            return Err(format!("rm: unsupported option '{arg}'"));
        }
        paths.push(arg.to_string());
        i += 1;
    }

    if paths.is_empty() {
        return Err("rm: missing operand".into());
    }

    let mut stderr = String::new();
    let mut exit_code = 0;
    for path in paths {
        let target = env.resolve_path(&path);
        let metadata = fs::symlink_metadata(&target);
        let result = if metadata
            .as_ref()
            .is_ok_and(|metadata| metadata.file_type().is_symlink())
        {
            fs::remove_file(&target)
        } else if target.is_dir() {
            if recursive {
                fs::remove_dir_all(&target)
            } else {
                Err(io::Error::other("is a directory"))
            }
        } else if force && !target.exists() {
            Ok(())
        } else {
            fs::remove_file(&target)
        };
        if let Err(err) = result {
            exit_code = 1;
            if !force || err.kind() != io::ErrorKind::NotFound {
                stderr.push_str(&format!("rm: {path}: {err}\n"));
            }
        }
    }

    Ok(ExecResult {
        stdout: String::new(),
        stderr,
        exit_code,
    })
}

fn builtin_umask(cmd: &Command, env: &mut ShellEnv) -> Result<ExecResult, String> {
    #[cfg(not(unix))]
    {
        let _ = (cmd, env);
        Err("'umask' is not supported on this platform".into())
    }

    #[cfg(unix)]
    {
        if cmd.args.len() != 2 {
            return Err("umask supports exactly one argument".into());
        }
        let value = u32::from_str_radix(cmd.args[1].as_str(), 8)
            .map_err(|_| "invalid octal umask".to_string())?;
        if value > 0o777 {
            return Err("umask must be between 000 and 777".to_string());
        }
        env.umask = Some(value);
        Ok(ExecResult {
            stdout: String::new(),
            stderr: String::new(),
            exit_code: 0,
        })
    }
}

fn builtin_ulimit(cmd: &Command, _env: &mut ShellEnv) -> Result<ExecResult, String> {
    Err(format!(
        "'ulimit' is unsupported; refusing to run '{}' without applying a resource limit",
        cmd.args
            .iter()
            .map(|arg| arg.as_str())
            .collect::<Vec<_>>()
            .join(" ")
    ))
}

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

    #[test]
    fn decode_escaped_newline() {
        let cmd = crate::shell::ast::Command {
            args: vec!["echo".into(), "a\\nb".into()],
            redirects: Vec::new(),
        };
        let mut env = crate::shell::environment::ShellEnv::new(
            std::env::current_dir().unwrap(),
            std::collections::HashMap::new(),
            false,
        );
        let res = builtin_echo(&cmd, &mut env, None).unwrap();
        assert_eq!(res.stdout, "a\\nb\n");
    }
}