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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
/*
* Copyright (c) 2016 Boucher, Antoni <bouanto@zoho.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
//! Trait and widget for input completion.
mod completers;
#[allow(missing_docs)]
pub mod completion_view;
use std::collections::HashMap;
use glib::ToValue;
use glib::types::Type;
use gtk::{
prelude::GtkListStoreExtManual,
traits::{
GtkListStoreExt,
TreeModelExt,
TreeSelectionExt,
},
ListStore,
TreeSelection,
};
use self::Column::Expand;
pub use self::completers::{CommandCompleter, NoCompleter, SettingCompleter};
pub use self::completion_view::CompletionView;
/// The identifier of the default completer.
pub const DEFAULT_COMPLETER_IDENT: &str = "__mg_default";
/// The identifier of the null completer.
pub const NO_COMPLETER_IDENT: &str = "__mg_no_completer";
#[doc(hidden)]
pub type Completers = HashMap<&'static str, Box<dyn Completer>>;
/// The type of a column.
#[derive(Clone, Copy, PartialEq)]
pub enum Column {
/// Specifies that the column does not expand, but won't be ellipsized.
AllVisible,
/// Specifies that the column will expand, but can be truncated (ellipsized).
Expand,
}
/// The trait completer is an interface to be satisfied by input completers.
pub trait Completer {
/// The number of columns of the completer.
fn columns(&self) -> Vec<Column> {
vec![Expand, Expand]
}
/// The number of column.
fn column_count(&self) -> usize {
self.columns().len()
}
/// From the selected text entry, return the text that should be written in the text input.
fn complete_result(&self, value: &str) -> String {
value.to_string()
}
/// From the user input, return the completion results.
/// The results are on two columns, hence the 2-tuple.
fn completions(&mut self, input: &str) -> Vec<CompletionResult>;
/// Return true if the completer is for an input containing a command.
/// Return false otherwise.
/// This will have the effect of removing the command when there's one it set to true.
fn have_command(&self) -> bool {
true
}
/// Set the column to use as the result of a selected text entry.
fn text_column(&self) -> i32 {
0
}
}
/// Completion to use with a text Entry.
pub struct Completion {
completer_ident: String,
completers: Completers,
}
impl Completion {
/// Create a new completion widget.
#[allow(unknown_lints, new_without_default_derive)]
pub fn new() -> Self {
Completion {
completer_ident: String::new(),
completers: HashMap::new(),
}
}
/// Add a new completer.
pub fn add_completer(&mut self, ident: &'static str, completer: Box<dyn Completer>) {
self.completers.insert(ident, completer);
}
/// Adjust the model by using the specified completer.
pub fn adjust_model(&mut self, completer_ident: &str) -> bool {
if completer_ident != self.completer_ident {
self.completer_ident = completer_ident.to_string();
if completer_ident == NO_COMPLETER_IDENT || !self.completers.contains_key(completer_ident) {
self.completer_ident = NO_COMPLETER_IDENT.to_string();
return true;
}
}
false
}
/// Complete the result for the selection using the current completer.
pub fn complete_result(&self, selection: &TreeSelection) -> Option<String> {
let mut completion = None;
if self.current_completer_ident() != NO_COMPLETER_IDENT {
if let Some((model, iter)) = selection.selected() {
if let Some(completer) = self.current_completer() {
let value: Option<String> = model.value(&iter, completer.text_column()).get().ok().flatten();
if let Some(value) = value {
completion = Some(completer.complete_result(&value));
}
}
}
}
completion
}
/// Get the current completer.
pub fn current_completer(&self) -> Option<&dyn Completer> {
self.completers.get(self.completer_ident.as_str())
.map(AsRef::as_ref)
}
/// Get the current completer.
#[allow(unknown_lints, borrowed_box)]
pub fn current_completer_mut(&mut self) -> Option<&mut Box<dyn Completer>> {
self.completers.get_mut(self.completer_ident.as_str())
}
/// Get the current completer ident.
pub fn current_completer_ident(&self) -> &str {
&self.completer_ident
}
/// Filter the rows from the input.
pub fn filter(&mut self, input: &str) -> Option<ListStore> {
self.current_completer_mut()
.map(|completer| {
// Multiply by 2 because each column has a foreground column.
let columns = vec![Type::STRING; completer.column_count() * 2];
let model = ListStore::new(&columns);
// Remove the command to only send the value to the completer.
let key =
if !completer.have_command() {
input
}
else if let Some(index) = input.find(' ') {
input[index + 1 ..].trim_start()
}
else {
input
};
for &CompletionResult { ref columns } in &completer.completions(key) {
let row = model.insert(-1);
let start_column = columns.len();
for (index, cell) in columns.iter().enumerate() {
model.set_value(&row, index as u32, &cell.value.to_value());
if let Some(ref foreground) = cell.foreground {
model.set_value(&row, (index + start_column) as u32, &foreground.to_value());
}
}
}
model
})
}
/// Set all the completers.
pub fn set_completers(&mut self, mut completers: Completers) {
completers.insert(NO_COMPLETER_IDENT, Box::new(NoCompleter::new()));
self.completers = completers;
}
}
/// A completion cell is the value with attributes of one data in a row.
#[derive(Clone)]
pub struct CompletionCell {
/// The foreground color of the cell or None if using the default color.
pub foreground: Option<String>,
/// The text value to show on the cell.
pub value: String,
}
impl CompletionCell {
/// Create a new cell.
pub fn new(value: &str) -> Self {
CompletionCell {
foreground: None,
value: value.to_string(),
}
}
/// Set the foreground color of the cell.
pub fn foreground(mut self, foreground: &str) -> Self {
self.foreground = Some(foreground.to_string());
self
}
}
/// Trait to specify that a type can be converted to a `CompletionCell`.
pub trait ToCell {
/// Convert a value to a `CompletionCell`.
fn to_cell(&self) -> CompletionCell;
}
impl ToCell for CompletionCell {
fn to_cell(&self) -> CompletionCell {
self.clone()
}
}
impl ToCell for str {
fn to_cell(&self) -> CompletionCell {
CompletionCell::new(self)
}
}
impl ToCell for String {
fn to_cell(&self) -> CompletionCell {
CompletionCell::new(self)
}
}
/// A result to show in the completion view.
pub struct CompletionResult {
/// The columns data.
pub columns: Vec<CompletionCell>,
}
impl CompletionResult {
/// Create a new completion result.
pub fn new(cols: &[&str]) -> Self {
let cols: Vec<_> = cols.iter().map(|col| CompletionCell::new(col)).collect();
CompletionResult {
columns: cols,
}
}
/// Create a new completion result with foregrounds.
pub fn from_cells(cols: &[&dyn ToCell]) -> Self {
CompletionResult {
columns: cols.iter().map(|value| value.to_cell()).collect(),
}
}
}