dialog 0.3.0

Display dialog boxes using various backends
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

// Copyright (C) 2019 Robin Krahl <robin.krahl@ireas.org>
// Copyright (C) 2019 Stephan Sokolow <http://www.ssokolow.com/ContactMe>
// SPDX-License-Identifier: MIT

use std::process;

use crate::{
    Choice, Error, FileSelection, FileSelectionMode, Input, Message, Password, Question, Result,
};

/// Subprocess exit codes
///
/// Note: `kdialog` doesn't have a fixed correspondence between button labels and status codes.
/// The following mappings occur:
///
/// - Yes/No = `0`/`1`
/// - Yes/No/Cancel = `0`/`1`/`2`
/// - OK/Cancel = `0`/`1`
const OK: i32 = 0;
const CANCEL: i32 = 1;

/// The `kdialog` backend.
///
/// This backend uses the external `kdialog` program to display KDE dialog boxes.
#[derive(Debug, Default)]
pub struct KDialog {
    icon: Option<String>,
    // TODO: --dontagain
}

impl KDialog {
    /// Creates a new `KDialog` instance without configuration.
    pub fn new() -> KDialog {
        Default::default()
    }

    /// Sets the icon in the dialog box's titlebar and taskbar button.
    ///
    /// The icon can be either a name from the user's configured icon theme, such as `error` or
    /// `info` or the path to an image to use.
    ///
    /// The default image depends on the dialog type.
    pub fn set_icon(&mut self, icon: impl Into<String>) {
        self.icon = Some(icon.into());
    }

    pub(crate) fn is_available() -> bool {
        super::is_available("kdialog")
    }

    fn execute(&self, args: Vec<&str>, title: &Option<String>) -> Result<process::Output> {
        let mut command = process::Command::new("kdialog");

        if let Some(ref icon) = self.icon {
            command.arg("--icon");
            command.arg(icon);
        }
        if let Some(ref title) = title {
            command.arg("--title");
            command.arg(title);
        }

        command.args(args);
        command.output().map_err(Error::IoError)
    }
}

impl AsRef<KDialog> for KDialog {
    fn as_ref(&self) -> &Self {
        self
    }
}

fn require_success(status: process::ExitStatus) -> Result<()> {
    if status.success() {
        Ok(())
    } else if let Some(code) = status.code() {
        match code {
            CANCEL => Ok(()),
            _ => Err(Error::from(("kdialog", status))),
        }
    } else {
        Err(Error::from(("kdialog", status)))
    }
}

fn get_choice(status: process::ExitStatus) -> Result<Choice> {
    if let Some(code) = status.code() {
        match code {
            OK => Ok(Choice::Yes),
            CANCEL => Ok(Choice::No),
            _ => Err(Error::from(("kdialog", status))),
        }
    } else {
        Err(Error::from(("kdialog", status)))
    }
}

fn get_stdout(output: process::Output) -> Result<Option<String>> {
    if output.status.success() {
        String::from_utf8(output.stdout)
            .map(|s| Some(s.trim_end_matches('\n').to_string()))
            .map_err(Error::from)
    } else if let Some(code) = output.status.code() {
        match code {
            OK => Ok(None),
            CANCEL => Ok(None),
            _ => Err(Error::from(("kdialog", output.status))),
        }
    } else {
        Err(Error::from(("kdialog", output.status)))
    }
}

impl super::Backend for KDialog {
    fn show_input(&self, input: &Input) -> Result<Option<String>> {
        let mut args = vec!["--inputbox", &input.text];
        if let Some(ref default) = input.default {
            args.push(default);
        }
        self.execute(args, &input.title).and_then(get_stdout)
    }

    fn show_message(&self, message: &Message) -> Result<()> {
        let args = vec!["--msgbox", &message.text];
        self.execute(args, &message.title)
            .and_then(|output| require_success(output.status))
            .map(|_| ())
    }

    fn show_password(&self, password: &Password) -> Result<Option<String>> {
        let args = vec!["--password", &password.text];
        self.execute(args, &password.title).and_then(get_stdout)
    }

    fn show_question(&self, question: &Question) -> Result<Choice> {
        let args = vec!["--yesno", &question.text];
        self.execute(args, &question.title)
            .and_then(|output| get_choice(output.status))
    }

    fn show_file_selection(&self, file_selection: &FileSelection) -> Result<Option<String>> {
        let dir = file_selection.path_to_string().ok_or("path not valid")?;
        let option = match file_selection.mode {
            FileSelectionMode::Open => "--getopenfilename",
            FileSelectionMode::Save => "--getsavefilename",
        };
        let args = vec![option, &dir];
        self.execute(args, &file_selection.title)
            .and_then(get_stdout)
    }
}