nu_command/platform/
clear.rs

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
use crossterm::{
    cursor::MoveTo,
    terminal::{Clear as ClearCommand, ClearType},
    QueueableCommand,
};
use nu_engine::command_prelude::*;
use nu_protocol::shell_error::io::IoError;

use std::io::Write;

#[derive(Clone)]
pub struct Clear;

impl Command for Clear {
    fn name(&self) -> &str {
        "clear"
    }

    fn description(&self) -> &str {
        "Clear the terminal."
    }

    fn extra_description(&self) -> &str {
        "By default clears the current screen and the off-screen scrollback buffer."
    }

    fn signature(&self) -> Signature {
        Signature::build("clear")
            .category(Category::Platform)
            .input_output_types(vec![(Type::Nothing, Type::Nothing)])
            .switch(
                "keep-scrollback",
                "Do not clear the scrollback history",
                Some('k'),
            )
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        _input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let from_io_error = IoError::factory(call.head, None);
        match call.has_flag(engine_state, stack, "keep-scrollback")? {
            true => {
                std::io::stdout()
                    .queue(MoveTo(0, 0))
                    .map_err(&from_io_error)?
                    .queue(ClearCommand(ClearType::All))
                    .map_err(&from_io_error)?
                    .flush()
                    .map_err(&from_io_error)?;
            }
            _ => {
                std::io::stdout()
                    .queue(MoveTo(0, 0))
                    .map_err(&from_io_error)?
                    .queue(ClearCommand(ClearType::All))
                    .map_err(&from_io_error)?
                    .queue(ClearCommand(ClearType::Purge))
                    .map_err(&from_io_error)?
                    .flush()
                    .map_err(&from_io_error)?;
            }
        };

        Ok(PipelineData::Empty)
    }

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Clear the terminal",
                example: "clear",
                result: None,
            },
            Example {
                description: "Clear the terminal but not its scrollback history",
                example: "clear --keep-scrollback",
                result: None,
            },
        ]
    }
}