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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
use std::collections::{BTreeMap, BTreeSet};
use std::str::Chars;
use std::sync::Arc;
/// Word separation type used by CompletionTree
#[derive(Debug, Clone, PartialEq)]
pub enum WordSeparator {
Whitespace,
Separator(&'static str),
}
/// A completion tree that holds and handles completions
#[derive(Debug, Clone)]
pub struct CompletionTree {
root: CompletionNode,
inclusions: Arc<BTreeSet<char>>,
min_word_len: usize,
separator: WordSeparator,
}
impl Default for CompletionTree {
fn default() -> Self {
let inclusions = Arc::new(BTreeSet::new());
Self {
root: CompletionNode::new(inclusions.clone()),
inclusions,
min_word_len: 5,
separator: WordSeparator::Whitespace,
}
}
}
impl CompletionTree {
/// Create a new CompletionTree with provided non alphabet characters whitelisted.
/// The default CompletionTree will only parse alphabet characters (a-z, A-Z). Use this to
/// introduce additional accepted special characters.
///
/// # Arguments
///
/// * `incl` An array slice with allowed characters
///
/// # Example
/// ```
/// extern crate rs_complete;
/// use rs_complete::CompletionTree;
///
/// let mut completions = CompletionTree::default();
/// completions.insert("test-hyphen test_underscore");
/// assert_eq!(
/// completions.complete("te"),
/// Some(vec!["test".to_string()]));
///
/// let mut completions = CompletionTree::with_inclusions(&['-', '_']);
/// completions.insert("test-hyphen test_underscore");
/// assert_eq!(
/// completions.complete("te"),
/// Some(vec!["test-hyphen".to_string(), "test_underscore".to_string()]));
/// ```
pub fn with_inclusions(incl: &[char]) -> Self {
let mut set = BTreeSet::new();
incl.iter().for_each(|c| {
set.insert(*c);
});
let inclusions = Arc::new(set);
Self {
root: CompletionNode::new(inclusions.clone()),
inclusions,
..Self::default()
}
}
/// Inserts one or more words into the completion tree for later use.
/// Input is automatically split using the defined [WordSeparator] (see [CompletionTree::separator]).
///
/// # Arguments
///
/// * `line` A str slice containing one or more words
///
/// # Example
/// ```
/// extern crate rs_complete;
/// use rs_complete::CompletionTree;
///
/// let mut completions = CompletionTree::default();
/// completions.set_min_word_len(1);
///
/// // Insert multiple words
/// completions.insert("a line with many words");
/// assert_eq!(completions.word_count(), 5);
/// completions.clear();
/// assert_eq!(completions.word_count(), 0);
///
/// // The above line is equal to the following:
/// completions.insert("a");
/// completions.insert("line");
/// completions.insert("with");
/// completions.insert("many");
/// completions.insert("words");
/// assert_eq!(completions.word_count(), 5);
/// ```
pub fn insert(&mut self, line: &str) {
match self.separator {
WordSeparator::Whitespace => line.split_whitespace().for_each(|w| self.insert_word(w)),
WordSeparator::Separator(sep) => line.split(sep).for_each(|w| self.insert_word(w)),
};
}
fn insert_word(&mut self, word: &str) {
if word.len() >= self.min_word_len {
self.root.insert(word.chars());
}
}
/// Changes the word separator used by CompletionTree::insert()
/// If left unchanged the default is [WordSeparator::Whitespace]
///
/// # Arguments
///
/// * `separator` A WordSeparator
///
/// # Example
///
/// ```
/// extern crate rs_complete;
/// use rs_complete::{CompletionTree, WordSeparator};
///
/// let mut completions = CompletionTree::default();
/// completions.separator(WordSeparator::Separator("|"));
/// completions.set_min_word_len(1);
///
/// // Insert multiple words
/// completions.insert("a|line|with|many|words");
/// assert_eq!(completions.word_count(), 5);
/// completions.clear();
/// assert_eq!(completions.word_count(), 0);
///
/// // The above line is equal to the following:
/// completions.insert("a");
/// completions.insert("line");
/// completions.insert("with");
/// completions.insert("many");
/// completions.insert("words");
/// assert_eq!(completions.word_count(), 5);
/// ```
pub fn separator(&mut self, separator: WordSeparator) {
self.separator = separator;
}
/// Returns an optional vector of completions based on the provided input
///
/// # Arguments
///
/// * `line` The line to complete
/// In case of multiple words, only the last will be completed
///
/// # Example
/// ```
/// extern crate rs_complete;
/// use rs_complete::CompletionTree;
///
/// let mut completions = CompletionTree::default();
/// completions.insert("batman robin batmobile batcave robber");
/// assert_eq!(
/// completions.complete("bat"),
/// Some(vec!["batcave", "batman", "batmobile"].iter().map(|s| s.to_string()).collect()));
///
/// assert_eq!(
/// completions.complete("to the bat"),
/// Some(vec!["to the batcave", "to the batman", "to the batmobile"].iter().map(|s| s.to_string()).collect()));
/// ```
pub fn complete(&self, line: &str) -> Option<Vec<String>> {
if !line.is_empty() {
let last_word = line.split_whitespace().last().unwrap();
if let Some(mut extensions) = self.root.complete(last_word.chars()) {
extensions.sort();
return Some(
extensions
.iter()
.map(|ext| format!("{}{}", line, ext))
.collect::<Vec<String>>(),
);
} else {
return None;
}
}
None
}
/// Clears all the data from the tree
/// # Example
/// ```
/// extern crate rs_complete;
/// use rs_complete::CompletionTree;
///
/// let mut completions = CompletionTree::default();
/// completions.insert("batman robin batmobile batcave robber");
/// assert_eq!(completions.word_count(), 5);
/// assert_eq!(completions.size(), 24);
/// completions.clear();
/// assert_eq!(completions.size(), 1);
/// assert_eq!(completions.word_count(), 0);
/// ```
pub fn clear(&mut self) {
self.root.clear();
}
/// Returns a count of how many words that exist in the tree
/// # Example
/// ```
/// extern crate rs_complete;
/// use rs_complete::CompletionTree;
///
/// let mut completions = CompletionTree::default();
/// completions.insert("batman robin batmobile batcave robber");
/// assert_eq!(completions.word_count(), 5);
/// ```
pub fn word_count(&self) -> u32 {
self.root.word_count()
}
/// Returns the size of the tree, the amount of nodes, not words
/// # Example
/// ```
/// extern crate rs_complete;
/// use rs_complete::CompletionTree;
///
/// let mut completions = CompletionTree::default();
/// completions.insert("batman robin batmobile batcave robber");
/// assert_eq!(completions.size(), 24);
/// ```
pub fn size(&self) -> u32 {
self.root.subnode_count()
}
/// Returns the minimum word length to complete. This allows you
/// to pass full sentences to `insert()` and not worry about
/// pruning out small words like "a" or "to", because they will be
/// ignored.
/// # Example
/// ```
/// extern crate rs_complete;
/// use rs_complete::CompletionTree;
///
/// let mut completions = CompletionTree::default();
/// completions.set_min_word_len(4);
/// completions.insert("one two three four five");
/// assert_eq!(completions.word_count(), 3);
///
/// let mut completions = CompletionTree::default();
/// completions.set_min_word_len(1);
/// completions.insert("one two three four five");
/// assert_eq!(completions.word_count(), 5);
/// ```
pub fn min_word_len(&self) -> usize {
self.min_word_len
}
/// Sets the minimum word length to complete on. Smaller words are
/// ignored. This only affects future calls to `insert()` -
/// changing this won't start completing on smaller words that
/// were added in the past, nor will it exclude larger words
/// already inserted into the completion tree.
pub fn set_min_word_len(&mut self, len: usize) {
self.min_word_len = len;
}
}
#[derive(Debug, Clone)]
struct CompletionNode {
subnodes: BTreeMap<char, CompletionNode>,
leaf: bool,
inclusions: Arc<BTreeSet<char>>,
}
impl CompletionNode {
fn new(incl: Arc<BTreeSet<char>>) -> Self {
Self {
subnodes: BTreeMap::new(),
leaf: false,
inclusions: incl,
}
}
fn clear(&mut self) {
self.subnodes.clear();
}
fn word_count(&self) -> u32 {
let mut count = self.subnodes.values().map(|n| n.word_count()).sum();
if self.leaf {
count += 1;
}
count
}
fn subnode_count(&self) -> u32 {
self.subnodes
.values()
.map(|n| n.subnode_count())
.sum::<u32>()
+ 1
}
fn insert(&mut self, mut iter: Chars) {
if let Some(c) = iter.next() {
if self.inclusions.contains(&c) || c.is_alphanumeric() {
let inclusions = self.inclusions.clone();
let subnode = self
.subnodes
.entry(c)
.or_insert_with(|| CompletionNode::new(inclusions));
subnode.insert(iter);
} else {
self.leaf = true;
}
} else {
self.leaf = true;
}
}
fn complete(&self, mut iter: Chars) -> Option<Vec<String>> {
if let Some(c) = iter.next() {
if let Some(subnode) = self.subnodes.get(&c) {
subnode.complete(iter)
} else {
None
}
} else {
Some(self.collect("".to_string()))
}
}
fn collect(&self, partial: String) -> Vec<String> {
let mut completions = vec![];
if self.leaf {
completions.push(partial.clone());
}
if !self.subnodes.is_empty() {
for (c, node) in &self.subnodes {
let mut partial = partial.clone();
partial.push(*c);
completions.append(&mut node.collect(partial));
}
}
completions
}
}