yash-builtin 0.16.0

Implementation of the built-in utilities of yash
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

// This file is part of yash, an extended POSIX shell.
// Copyright (C) 2023 WATANABE Yuki
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

//! Part of the cd built-in that prints the new working directory

use super::target::Origin;
use crate::common::report::prepare_report_message_and_divert;
use yash_env::Env;
use yash_env::io::Fd;
use yash_env::path::Path;
use yash_env::source::pretty::{Report, ReportType};
use yash_env::system::{Errno, Fcntl, Isatty, Write};

impl Origin {
    /// Whether the built-in should print the target directory path.
    pub fn should_print_path(&self) -> bool {
        use Origin::*;
        match self {
            Oldpwd | Cdpath => true,
            Home | Literal => false,
        }
    }
}

/// Prints the new working directory path if needed.
pub async fn print_path<S>(env: &mut Env<S>, path: &Path, origin: &Origin)
where
    S: Fcntl + Isatty + Write,
{
    if !origin.should_print_path() {
        return;
    }

    let line = format!("{}\n", path.display());
    match env.system.write_all(Fd::STDOUT, line.as_bytes()).await {
        Ok(_) => (),
        Err(errno) => handle_print_error(env, errno).await,
    }
}

/// Prints a warning message for a failed print.
///
/// The message is only a warning because it does not affect the exit status.
async fn handle_print_error<S>(env: &mut Env<S>, errno: Errno)
where
    S: Fcntl + Isatty + Write,
{
    let mut report = Report::new();
    report.r#type = ReportType::Warning;
    report.title = format!("cannot print new $PWD: {errno}").into();
    let (message, _divert) = prepare_report_message_and_divert(env, report);
    env.system.print_error(&message).await;
}