gshell 1.0.2

gshell is a shell for people who live in the terminal. It pairs familiar Unix behavior with a tighter core, fast interaction, and an interface built to stay out of the way.
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

mod alias;
mod cd;
mod clear;
mod echo;
mod exit;
mod export;
mod history;
mod jobs;
mod pwd;
mod source;
mod r#type;
mod unalias;

pub use alias::AliasBuiltin;
pub use cd::CdBuiltin;
pub use clear::ClearBuiltin;
pub use echo::EchoBuiltin;
pub use exit::ExitBuiltin;
pub use export::ExportBuiltin;
pub use history::HistoryBuiltin;
pub use jobs::{BgBuiltin, FgBuiltin, JobsBuiltin, KillBuiltin};
pub use pwd::PwdBuiltin;
pub use source::SourceBuiltin;
pub use r#type::TypeBuiltin;
pub use unalias::UnaliasBuiltin;

use std::{
    collections::HashMap,
    future::Future,
    pin::Pin,
    sync::{Arc, OnceLock},
};

use crate::shell::{SharedShellState, ShellAction, ShellResult};

pub type BuiltinFuture<'a> = Pin<Box<dyn Future<Output = ShellResult<ShellAction>> + Send + 'a>>;

pub trait Builtin: Send + Sync {
    fn name(&self) -> &'static str;
    fn execute<'a>(&'a self, state: SharedShellState, args: &'a [String]) -> BuiltinFuture<'a>;
}

#[derive(Default)]
pub struct BuiltinRegistry {
    builtins: HashMap<String, Arc<dyn Builtin>>,
}

impl BuiltinRegistry {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn defaults() -> &'static Self {
        static DEFAULTS: OnceLock<BuiltinRegistry> = OnceLock::new();
        DEFAULTS.get_or_init(Self::with_defaults)
    }

    pub fn with_defaults() -> Self {
        let mut registry = Self::new();
        registry.register(Arc::new(AliasBuiltin));
        registry.register(Arc::new(HistoryBuiltin));
        registry.register(Arc::new(JobsBuiltin));
        registry.register(Arc::new(FgBuiltin));
        registry.register(Arc::new(BgBuiltin));
        registry.register(Arc::new(KillBuiltin));
        registry.register(Arc::new(CdBuiltin));
        registry.register(Arc::new(PwdBuiltin));
        registry.register(Arc::new(EchoBuiltin));
        registry.register(Arc::new(ClearBuiltin));
        registry.register(Arc::new(SourceBuiltin));
        registry.register(Arc::new(TypeBuiltin));
        registry.register(Arc::new(UnaliasBuiltin));
        registry.register(Arc::new(ExportBuiltin));
        registry.register(Arc::new(ExitBuiltin));
        registry
    }

    pub fn register(&mut self, builtin: Arc<dyn Builtin>) -> Option<Arc<dyn Builtin>> {
        self.builtins.insert(builtin.name().to_string(), builtin)
    }

    pub fn get(&self, name: &str) -> Option<Arc<dyn Builtin>> {
        self.builtins.get(name).cloned()
    }

    pub fn contains(&self, name: &str) -> bool {
        self.builtins.contains_key(name)
    }

    pub fn names(&self) -> Vec<String> {
        let mut names = self.builtins.keys().cloned().collect::<Vec<_>>();
        names.sort();
        names
    }

    pub fn len(&self) -> usize {
        self.builtins.len()
    }

    pub fn is_empty(&self) -> bool {
        self.builtins.is_empty()
    }
}