native-dialog 0.9.6

A library to display dialogs. Supports GNU/Linux, BSD Unix, macOS and Windows.
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

use std::collections::HashMap;

use super::backend::{Backend, BackendKind};
use crate::dialog::{DialogImpl, MessageAlert, MessageConfirm};
use crate::{MessageLevel, Result};

impl MessageAlert {
    fn create(&self) -> Result<Backend> {
        let params = BackendParams {
            title: &self.title,
            text: &self.text,
            level: self.level,
            ask: false,
            owner: unsafe { self.owner.as_x11() },
        };

        init_backend(params)
    }
}

impl DialogImpl for MessageAlert {
    fn show(self) -> Result<Self::Output> {
        let backend = self.create()?;
        backend.exec()?;
        Ok(())
    }

    #[cfg(feature = "async")]
    async fn spawn(self) -> Result<Self::Output> {
        let backend = self.create()?;
        backend.spawn().await?;
        Ok(())
    }
}

impl MessageConfirm {
    fn create(&self) -> Result<Backend> {
        let params = BackendParams {
            title: &self.title,
            text: &self.text,
            level: self.level,
            ask: true,
            owner: unsafe { self.owner.as_x11() },
        };

        init_backend(params)
    }
}

impl DialogImpl for MessageConfirm {
    fn show(self) -> Result<Self::Output> {
        let backend = self.create()?;
        let output = backend.exec()?;
        Ok(output.is_some())
    }

    #[cfg(feature = "async")]
    async fn spawn(self) -> Result<Self::Output> {
        let backend = self.create()?;
        let output = backend.spawn().await?;
        Ok(output.is_some())
    }
}

/// Modified version of `str::replace`.
fn replace_many(text: &str, replacements: HashMap<char, &str>) -> String {
    let pattern = replacements.keys().copied().collect::<Vec<_>>();

    let mut result = String::with_capacity(text.len());
    let mut last_end = 0;
    for (start, part) in text.match_indices(pattern.as_slice()) {
        let ch = unsafe { part.chars().next().unwrap_unchecked() };
        result.push_str(unsafe { text.get_unchecked(last_end..start) });
        result.push_str(unsafe { replacements.get(&ch).unwrap_unchecked() });
        last_end = start + part.len();
    }
    result.push_str(unsafe { text.get_unchecked(last_end..text.len()) });
    result
}

/// GMarkup flavoured XML has defined only 5 entities and doesn't support user-defined entities.
/// See https://gitlab.gnome.org/GNOME/glib/-/blob/353942c6/glib/gmarkup.c#L2189
fn escape_pango_entities(text: &str) -> String {
    let replacements = HashMap::from([
        ('&', "&amp;"),
        ('<', "&lt;"),
        ('>', "&gt;"),
        ('"', "&quot;"),
        ('\'', "&apos;"),
    ]);

    replace_many(text, replacements)
}

/// See https://github.com/qt/qtbase/blob/2e2f1e2/src/gui/text/qtextdocument.cpp#L166
fn escape_qt_text_document(text: &str) -> String {
    let replacements = HashMap::from([
        ('\n', "<br>"),
        ('\t', " "),
        ('<', "&lt;"),
        ('>', "&gt;"),
        ('&', "&amp;"),
    ]);

    let escaped = replace_many(text, replacements);

    format!("<html><body>{}</body></html>", escaped)
}

struct BackendParams<'a> {
    title: &'a str,
    text: &'a str,
    level: MessageLevel,
    ask: bool,
    owner: Option<u64>,
}

fn init_backend(params: BackendParams) -> Result<Backend> {
    let mut backend = Backend::new()?;
    match backend.kind {
        BackendKind::KDialog => init_kdialog(&mut backend, params),
        BackendKind::Zenity => init_zenity(&mut backend, params),
        BackendKind::Yad => init_yad(&mut backend, params),
    };

    Ok(backend)
}

fn init_kdialog(backend: &mut Backend, params: BackendParams) {
    if let Some(owner) = params.owner {
        backend.command.arg(format!("--attach=0x{:x}", owner));
    }

    if params.ask {
        backend.command.arg("--yesno");
    } else {
        backend.command.arg("--msgbox");
    }

    let text = escape_qt_text_document(params.text);
    backend.command.arg(text);

    backend.command.arg("--title");
    backend.command.arg(params.title);

    match params.level {
        MessageLevel::Info => backend.command.arg("--icon=dialog-information"),
        MessageLevel::Warning => backend.command.arg("--icon=dialog-warning"),
        MessageLevel::Error => backend.command.arg("--icon=dialog-error"),
    };
}

fn init_zenity(backend: &mut Backend, params: BackendParams) {
    let version = backend.version();

    if let Some(owner) = params.owner {
        // `--attach` was removed after zenity 3.44.3
        // https://github.com/GNOME/zenity/commit/cbf1311
        if matches!(&version, Some(v) if *v <= (3, 44, 2)) {
            backend.command.arg(format!("--attach=0x{:x}", owner));
        }
    }

    backend.command.arg("--width=400");

    if params.ask {
        backend.command.arg("--question");

        // `--icon-name` was renamed to `--icon` at zenity 3.90.0
        match &version {
            Some(v) if *v < (3, 90, 0) => backend.command.arg("--icon-name"),
            _ => backend.command.arg("--icon"),
        };
        match params.level {
            MessageLevel::Info => backend.command.arg("dialog-information"),
            MessageLevel::Warning => backend.command.arg("dialog-warning"),
            MessageLevel::Error => backend.command.arg("dialog-error"),
        };
    } else {
        match params.level {
            MessageLevel::Info => backend.command.arg("--info"),
            MessageLevel::Warning => backend.command.arg("--warning"),
            MessageLevel::Error => backend.command.arg("--error"),
        };
    }

    backend.command.arg("--title");
    backend.command.arg(params.title);

    let text = escape_pango_entities(params.text);
    backend.command.arg("--text");
    backend.command.arg(text);
}

fn init_yad(backend: &mut Backend, params: BackendParams) {
    if params.ask {
        backend.command.arg("--button");
        backend.command.arg("Yes:0");
        backend.command.arg("--button");
        backend.command.arg("No:1");
    } else {
        backend.command.arg("--button");
        backend.command.arg("Ok:0");
    }

    backend.command.arg("--image");
    match params.level {
        MessageLevel::Info => backend.command.arg("dialog-information"),
        MessageLevel::Warning => backend.command.arg("dialog-warning"),
        MessageLevel::Error => backend.command.arg("dialog-error"),
    };

    backend.command.arg("--title");
    backend.command.arg(params.title);

    let text = escape_pango_entities(params.text);
    backend.command.arg("--text");
    backend.command.arg(text);
}