今回、Rust やシステムプログラミングの練習を兼ねて、シェルを Rust で実装しました。この記事では、その際の解説やポイントなどを書いていきたいと思います。
今回実装するシェルはcoconush🥥と名付けました。錆(Rust)は基本的に茶色い見た目をしています。そんな Rust で、カーネルを守る貝殻(シェル)を実装するので、同じく「茶色の見た目で、何かを覆うもの」としてココナッツから名前を取りました Nushell 被り 。GitHub のリポジトリと Zenn のスクラップを載せておきます。
oshanQQ/coconush: 🥥 A toy shell implemented in Rust
coconush の内部実装は、
の無限ループです。Rust では、システムコールを叩く手段として標準クレートとnixというクレートが使えます。今回は簡潔に書くことができるstd::Command()を使っていきます。こちらが、coconush のmain()部分です。
mod prompt; use std::env; use std::io::{stdin, stdout, Write}; use std::path::Path; use std::process::Command; fn main() { loop { // display status if let Err(e) = prompt::display_prompt() { eprintln!("prompt error: {}", e); } if let Err(e) = stdout().flush() { eprintln!("buf error: {}", e); } // input line let mut line = String::new(); if let Err(e) = stdin().read_line(&mut line) { eprintln!("read line error: {}", e); } // parse input let mut parts = line.trim().split_whitespace(); let command = parts.next().unwrap_or("\n"); let args = parts; // exec command match command { "cd" => { let new_dir = args.peekable().peek().map_or("/", |x| *x); let root = Path::new(new_dir); if let Err(e) = env::set_current_dir(&root) { eprintln!("cd error: {}", e); } }, "exit" => return, command => match Command::new(command).args(args).spawn() { Ok(mut child) => { if let Err(e) = child.wait() { eprintln!("wait error: {}", e); } } Err(e) => { eprintln!("exec error: {}", e); } }, } } }
まずは、プロンプトを表示させる部分です。
// display status if let Err(e) = prompt::display_prompt() { eprintln!("prompt error: {}", e); } if let Err(e) = stdout().flush() { eprintln!("buf error: {}", e); }
display_prompt()関数は、prompt.rsモジュールで定義しています。
// prompt.rs use colored::*; use std::env; use std::io::Result; use whoami::{hostname, username}; pub fn display_prompt() -> Result<()> { let current_path = env::current_dir()?; print!( "{}{}{}:{}{}", username().green().truecolor(222, 165, 132).bold(), "@".truecolor(222, 165, 132).bold(), hostname().truecolor(222, 165, 132).bold(), current_path.display(), ">".truecolor(222, 165, 132).bold() ); Ok(()) } #[cfg(test)] mod tests { use super::*; #[test] fn get_current_directory() { assert!(display_prompt().is_ok()); } }
やってることは、
username, hostname, カレントディレクトリのパスを取得して表示Resultを返させているOk()を返すかどうかのテストです。Resultを返させることで関数の呼び出し元でエラーハンドリングできる他、テストも可能です。
main()内(関数の呼び出し元)では「Ok()のときにはそのまま実行(値を返したりはしない)して、Err()のときにはエラーメッセージを返す」という処理を書いています。さらにif let文を使うことで、matchよりも簡潔に書くことができます。以前matchで書いていたときは、記述量が多くなって冗長でした。ここら辺は上手く省略できたかなと思っています。
またプロンプトを表示させた状態で入力を受けつけたいので、ラインバッファをflush()で解放してあげています。
次に、入力を受け取る部分です。
// input line let mut line = String::new(); if let Err(e) = stdin().read_line(&mut line) { eprintln!("read line error: {}", e); } // parse input let mut parts = line.trim().split_whitespace(); let command = parts.next().unwrap_or("\n"); let args = parts;
前半部分では普通に入力を受け取っています。後半の部分では、コマンド部分とオプション部分をそれぞれcommand変数とargs変数に入れています。これらを、次のコマンド実行部分に渡していきます。
// exec command match command { "cd" => { let new_dir = args.peekable().peek().map_or("/", |x| *x); let root = Path::new(new_dir); if let Err(e) = env::set_current_dir(&root) { eprintln!("cd error: {}", e); } }, "exit" => return, command => match Command::new(command).args(args).spawn() { Ok(mut child) => { if let Err(e) = child.wait() { eprintln!("wait error: {}", e); } } Err(e) => { eprintln!("exec error: {}", e); } }, }
cdコマンドは、forkしたプロセスをexecで変えるという流れで実行できないため、ビルトインコマンドとして定義しています。具体的には、cdのみの場合はホームディレクトリ(/)に移動し、それ以外は指定されたディレクトリに移動するというものです。つまり、普通のcdコマンドです。Rust のコード上では、cdという単語の次の単語への参照をpeekable().peek()で取得し、map_or()内のクロージャで参照外しを行っています。
exitコマンドは、シェルプログラムそのものを終了するコマンドになっています。
それ以外のコマンドは、基本的にstd::Command()に渡して実行できます。ただ、子プロセスをフォークした時に子プロセスが死ぬまで親プロセス側は待機しておく必要があります。そのため、Ok()だった場合にwait()関数を実行しています。
coconush では、以上の処理をloop()でループさせています。こうすることで、シェルの動作を再現する事ができます。
比較的少ないコード量でシステムプログラミングの入門ができるという点から、シェル自作は初学者にかなりおススメできると思っています。Rust に関しても、unwrap()で甘えずにエラーハンドリングができているのではないでしょうか。
coconush にはパイプなどは実装されていません。気が向いたら実装して記事にするかもなので、そのときはよろしくお願いします。