yosh 0.2.7

A POSIX-compliant shell implemented in Rust
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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
use std::collections::HashMap;

/// A shell variable with its value and attributes.
#[derive(Debug, Clone, PartialEq)]
pub struct Variable {
    pub value: String,
    pub exported: bool,
    pub readonly: bool,
}

impl Variable {
    pub fn new(value: impl Into<String>) -> Self {
        Variable {
            value: value.into(),
            exported: false,
            readonly: false,
        }
    }

    pub fn new_exported(value: impl Into<String>) -> Self {
        Variable {
            value: value.into(),
            exported: true,
            readonly: false,
        }
    }
}

/// A single scope in the scope chain.
#[derive(Debug, Clone)]
struct Scope {
    vars: HashMap<String, Variable>,
    positional_params: Vec<String>,
    /// POSIX `getopts` cursor within a stacked argv element (e.g. `-abc`).
    /// `0` means "advance to the next argv element on the next call."
    getopts_subindex: usize,
    /// `OPTIND` value snapshot saved on `push_scope`, restored on `pop_scope`.
    /// `None` outside any function call (global scope).
    saved_optind: Option<String>,
}

/// Storage for shell variables with scope chain support.
///
/// Scopes are stacked: `scopes[0]` is global, `scopes.last()` is current.
/// Variable lookups walk from top to bottom. Writes go to the scope that
/// already contains the variable, or to the global scope if the variable
/// is new (POSIX: function assignments affect the caller).
///
/// Positional parameters (`$1`, `$2`, ...) are per-scope — each function
/// invocation gets its own set.
#[derive(Debug, Clone)]
pub struct VarStore {
    scopes: Vec<Scope>,
    environ_cache: Option<Vec<(String, String)>>,
}

impl VarStore {
    /// Create an empty VarStore with a single global scope.
    pub fn new() -> Self {
        VarStore {
            scopes: vec![Scope {
                vars: HashMap::new(),
                positional_params: Vec::new(),
                getopts_subindex: 0,
                saved_optind: None,
            }],
            environ_cache: None,
        }
    }

    /// Initialize from the current process environment.
    pub fn from_environ() -> Self {
        let mut vars = HashMap::new();
        for (key, value) in std::env::vars() {
            vars.insert(key, Variable::new_exported(value));
        }
        VarStore {
            scopes: vec![Scope {
                vars,
                positional_params: Vec::new(),
                getopts_subindex: 0,
                saved_optind: None,
            }],
            environ_cache: None,
        }
    }

    // ── Scope management ────────────────────────────────────────────────

    /// Push a new scope with the given positional parameters.
    /// Used for function calls.
    ///
    /// Saves the caller's current `OPTIND` value into the new scope's
    /// `saved_optind` and resets the visible `OPTIND` to `"1"`. The
    /// stacked-options subcursor starts at `0`.
    pub fn push_scope(&mut self, positional_params: Vec<String>) {
        self.environ_cache = None;
        // Snapshot caller's OPTIND (may be unset → None).
        let saved_optind = self.get("OPTIND").map(|s| s.to_string());
        self.scopes.push(Scope {
            vars: HashMap::new(),
            positional_params,
            getopts_subindex: 0,
            saved_optind,
        });
        // Set OPTIND="1" in the new (top) scope so the function body
        // sees a fresh parse position. Direct write into top scope to
        // avoid POSIX "assign in caller" semantics of `set()`.
        self.scopes
            .last_mut()
            .unwrap()
            .vars
            .insert("OPTIND".to_string(), Variable::new("1"));
    }

    /// Pop the current scope, restoring the previous scope's positional
    /// parameters. Panics if only the global scope remains.
    ///
    /// Restores the caller's `OPTIND` from the popped scope's
    /// `saved_optind` snapshot (writing into whichever underlying scope
    /// already holds OPTIND, or creating it in the new top scope).
    pub fn pop_scope(&mut self) {
        self.environ_cache = None;
        assert!(self.scopes.len() > 1, "cannot pop the global scope");
        let popped = self.scopes.pop().unwrap();
        if let Some(prev_optind) = popped.saved_optind {
            // Write back into the now-current scope chain. Use `set`
            // so the value lands where OPTIND was originally defined
            // (typically scope[0]). Readonly OPTIND is not supported
            // and the assignment cannot fail in practice.
            let _ = self.set("OPTIND", prev_optind);
        }
    }

    // ── getopts subcursor (top scope) ───────────────────────────────────

    /// Get the current scope's `getopts` stacked-options subcursor.
    pub fn getopts_subindex(&self) -> usize {
        self.scopes.last().unwrap().getopts_subindex
    }

    /// Set the current scope's `getopts` stacked-options subcursor.
    pub fn set_getopts_subindex(&mut self, value: usize) {
        self.scopes.last_mut().unwrap().getopts_subindex = value;
    }

    /// Return the current scope depth. 1 = global scope only.
    pub fn scope_depth(&self) -> usize {
        self.scopes.len()
    }

    // ── Positional parameters ───────────────────────────────────────────

    /// Get the current scope's positional parameters.
    pub fn positional_params(&self) -> &[String] {
        &self.scopes.last().unwrap().positional_params
    }

    /// Set the current scope's positional parameters.
    pub fn set_positional_params(&mut self, params: Vec<String>) {
        self.scopes.last_mut().unwrap().positional_params = params;
    }

    // ── Variable access ─────────────────────────────────────────────────

    /// Get the string value of a variable, if set.
    /// Walks scopes from top to bottom.
    pub fn get(&self, name: &str) -> Option<&str> {
        // Fast path: single scope (most common — outside function calls)
        if self.scopes.len() == 1 {
            return self.scopes[0].vars.get(name).map(|v| v.value.as_str());
        }
        for scope in self.scopes.iter().rev() {
            if let Some(var) = scope.vars.get(name) {
                return Some(var.value.as_str());
            }
        }
        None
    }

    /// Get the full Variable struct, if set.
    /// Walks scopes from top to bottom.
    #[allow(dead_code)]
    pub fn get_var(&self, name: &str) -> Option<&Variable> {
        for scope in self.scopes.iter().rev() {
            if let Some(var) = scope.vars.get(name) {
                return Some(var);
            }
        }
        None
    }

    /// Set a variable's value. Returns an error if the variable is readonly.
    ///
    /// If the variable already exists in some scope, it is updated in-place
    /// in that scope (POSIX: function assignments affect the caller).
    /// If the variable is new, it is created in the global scope.
    pub fn set(&mut self, name: &str, value: impl Into<String>) -> Result<(), String> {
        self.environ_cache = None;
        let value = value.into();

        // Fast path: single scope (most common — outside function calls)
        if self.scopes.len() == 1 {
            if let Some(existing) = self.scopes[0].vars.get(name) {
                if existing.readonly {
                    return Err(format!("{}: readonly variable", name));
                }
                let exported = existing.exported;
                self.scopes[0].vars.insert(
                    name.to_string(),
                    Variable {
                        value,
                        exported,
                        readonly: false,
                    },
                );
            } else {
                self.scopes[0]
                    .vars
                    .insert(name.to_string(), Variable::new(value));
            }
            return Ok(());
        }

        // Search for existing variable in any scope (top to bottom).
        for scope in self.scopes.iter_mut().rev() {
            if let Some(existing) = scope.vars.get(name) {
                if existing.readonly {
                    return Err(format!("{}: readonly variable", name));
                }
                let exported = existing.exported;
                scope.vars.insert(
                    name.to_string(),
                    Variable {
                        value,
                        exported,
                        readonly: false,
                    },
                );
                return Ok(());
            }
        }

        // Not found — create in global scope.
        self.scopes[0]
            .vars
            .insert(name.to_string(), Variable::new(value));
        Ok(())
    }

    /// Set a variable's value with allexport support.
    pub fn set_with_options(
        &mut self,
        name: &str,
        value: impl Into<String>,
        allexport: bool,
    ) -> Result<(), String> {
        self.environ_cache = None;
        let value = value.into();

        for scope in self.scopes.iter_mut().rev() {
            if let Some(existing) = scope.vars.get(name) {
                if existing.readonly {
                    return Err(format!("{}: readonly variable", name));
                }
                let exported = existing.exported || allexport;
                scope.vars.insert(
                    name.to_string(),
                    Variable {
                        value,
                        exported,
                        readonly: false,
                    },
                );
                return Ok(());
            }
        }

        let mut var = Variable::new(value);
        if allexport {
            var.exported = true;
        }
        self.scopes[0].vars.insert(name.to_string(), var);
        Ok(())
    }

    /// Unset a variable. Returns an error if the variable is readonly.
    /// Removes from whichever scope contains it.
    pub fn unset(&mut self, name: &str) -> Result<(), String> {
        self.environ_cache = None;
        for scope in self.scopes.iter_mut().rev() {
            if let Some(existing) = scope.vars.get(name) {
                if existing.readonly {
                    return Err(format!("{}: readonly variable", name));
                }
                scope.vars.remove(name);
                return Ok(());
            }
        }
        Ok(())
    }

    /// Mark a variable as exported. Walks scopes to find it; if not found,
    /// creates in global scope with empty value.
    pub fn export(&mut self, name: &str) {
        self.environ_cache = None;
        for scope in self.scopes.iter_mut().rev() {
            if let Some(var) = scope.vars.get_mut(name) {
                var.exported = true;
                return;
            }
        }
        self.scopes[0]
            .vars
            .insert(name.to_string(), Variable::new_exported(""));
    }

    /// Mark a variable as readonly. Walks scopes to find it; if not found,
    /// creates in global scope with empty value.
    pub fn set_readonly(&mut self, name: &str) {
        self.environ_cache = None;
        for scope in self.scopes.iter_mut().rev() {
            if let Some(var) = scope.vars.get_mut(name) {
                var.readonly = true;
                return;
            }
        }
        let mut var = Variable::new("");
        var.readonly = true;
        self.scopes[0].vars.insert(name.to_string(), var);
    }

    /// Return only exported variables as (name, value) pairs.
    /// Later scopes shadow earlier ones. Result is cached until next mutation.
    pub fn environ(&mut self) -> &[(String, String)] {
        if self.environ_cache.is_none() {
            self.environ_cache = Some(self.build_environ());
        }
        self.environ_cache.as_ref().unwrap()
    }

    fn build_environ(&self) -> Vec<(String, String)> {
        let mut merged: HashMap<String, &Variable> = HashMap::new();
        for scope in &self.scopes {
            for (name, var) in &scope.vars {
                merged.insert(name.clone(), var);
            }
        }
        merged
            .into_iter()
            .filter(|(_, v)| v.exported)
            .map(|(k, v)| (k, v.value.clone()))
            .collect()
    }

    /// Iterate over all variables as (name, &Variable) pairs.
    /// Later scopes shadow earlier ones (lazy, no intermediate allocation).
    pub fn vars_iter(&self) -> impl Iterator<Item = (&str, &Variable)> {
        let mut seen = std::collections::HashSet::new();
        self.scopes
            .iter()
            .rev()
            .flat_map(|s| s.vars.iter())
            .filter_map(move |(k, v)| {
                if seen.insert(k.as_str()) {
                    Some((k.as_str(), v))
                } else {
                    None
                }
            })
    }
}

impl Default for VarStore {
    fn default() -> Self {
        Self::new()
    }
}

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

    #[test]
    fn test_get_set() {
        let mut store = VarStore::new();
        assert_eq!(store.get("FOO"), None);
        store.set("FOO", "bar").unwrap();
        assert_eq!(store.get("FOO"), Some("bar"));
    }

    #[test]
    fn test_unset() {
        let mut store = VarStore::new();
        store.set("FOO", "bar").unwrap();
        assert_eq!(store.get("FOO"), Some("bar"));
        store.unset("FOO").unwrap();
        assert_eq!(store.get("FOO"), None);
    }

    #[test]
    fn test_readonly_prevents_set() {
        let mut store = VarStore::new();
        store.set("FOO", "bar").unwrap();
        store.set_readonly("FOO");
        let result = store.set("FOO", "baz");
        assert!(result.is_err());
        assert_eq!(store.get("FOO"), Some("bar"));
    }

    #[test]
    fn test_readonly_prevents_unset() {
        let mut store = VarStore::new();
        store.set("FOO", "bar").unwrap();
        store.set_readonly("FOO");
        let result = store.unset("FOO");
        assert!(result.is_err());
        assert_eq!(store.get("FOO"), Some("bar"));
    }

    #[test]
    fn test_export() {
        let mut store = VarStore::new();
        store.set("FOO", "bar").unwrap();
        assert!(!store.get_var("FOO").unwrap().exported);
        store.export("FOO");
        assert!(store.get_var("FOO").unwrap().exported);
    }

    #[test]
    fn test_environ_excludes_unexported() {
        let mut store = VarStore::new();
        store.set("FOO", "bar").unwrap();
        store.set("BAZ", "qux").unwrap();
        store.export("FOO");
        let env = store.environ();
        assert_eq!(env.len(), 1);
        assert_eq!(env[0], ("FOO".to_string(), "bar".to_string()));
    }

    #[test]
    fn test_from_environ() {
        let store = VarStore::from_environ();
        if let Some(var) = store.get_var("PATH") {
            assert!(var.exported, "Variables from environ should be exported");
        }
    }

    #[test]
    fn test_push_pop_scope_positional_params() {
        let mut store = VarStore::new();
        store.set_positional_params(vec!["a".to_string(), "b".to_string()]);
        assert_eq!(store.positional_params(), &["a", "b"]);

        store.push_scope(vec!["x".to_string(), "y".to_string(), "z".to_string()]);
        assert_eq!(store.positional_params(), &["x", "y", "z"]);

        store.pop_scope();
        assert_eq!(store.positional_params(), &["a", "b"]);
    }

    #[test]
    fn test_scope_variable_lookup_walks_chain() {
        let mut store = VarStore::new();
        store.set("FOO", "global").unwrap();

        store.push_scope(vec![]);
        // Variable from global scope is visible
        assert_eq!(store.get("FOO"), Some("global"));

        // Setting FOO in function scope updates the global scope (POSIX)
        store.set("FOO", "updated").unwrap();
        store.pop_scope();
        assert_eq!(store.get("FOO"), Some("updated"));
    }

    #[test]
    fn test_scope_new_variable_goes_to_global() {
        let mut store = VarStore::new();
        store.push_scope(vec![]);
        store.set("NEW_VAR", "value").unwrap();
        store.pop_scope();
        // Variable created inside function scope persists in global
        assert_eq!(store.get("NEW_VAR"), Some("value"));
    }

    #[test]
    fn test_scope_readonly_across_scopes() {
        let mut store = VarStore::new();
        store.set("RO", "immutable").unwrap();
        store.set_readonly("RO");

        store.push_scope(vec![]);
        let result = store.set("RO", "changed");
        assert!(result.is_err());
        assert_eq!(store.get("RO"), Some("immutable"));
        store.pop_scope();
    }

    #[test]
    fn test_scope_export_across_scopes() {
        let mut store = VarStore::new();
        store.set("EX", "value").unwrap();

        store.push_scope(vec![]);
        store.export("EX");
        store.pop_scope();

        assert!(store.get_var("EX").unwrap().exported);
    }

    #[test]
    fn test_scope_unset_across_scopes() {
        let mut store = VarStore::new();
        store.set("DEL", "value").unwrap();

        store.push_scope(vec![]);
        store.unset("DEL").unwrap();
        store.pop_scope();

        assert_eq!(store.get("DEL"), None);
    }

    #[test]
    fn push_scope_snapshots_optind_and_resets_to_one() {
        let mut store = VarStore::new();
        store.set("OPTIND", "5").unwrap();

        store.push_scope(vec!["a".into(), "b".into()]);
        assert_eq!(store.get("OPTIND"), Some("1"));

        store.pop_scope();
        assert_eq!(store.get("OPTIND"), Some("5"));
    }

    #[test]
    fn push_scope_initial_subindex_is_zero() {
        let mut store = VarStore::new();
        store.push_scope(vec![]);
        assert_eq!(store.getopts_subindex(), 0);
    }

    #[test]
    fn set_getopts_subindex_round_trips() {
        let mut store = VarStore::new();
        store.set_getopts_subindex(3);
        assert_eq!(store.getopts_subindex(), 3);
    }

    #[test]
    fn push_scope_resets_subindex_and_pop_restores() {
        let mut store = VarStore::new();
        store.set_getopts_subindex(7);

        store.push_scope(vec![]);
        assert_eq!(store.getopts_subindex(), 0);
        store.set_getopts_subindex(2);

        store.pop_scope();
        assert_eq!(store.getopts_subindex(), 7);
    }
}