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
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License in the LICENSE-APACHE file or at:
// https://www.apache.org/licenses/LICENSE-2.0
//! Filter-list adapter
use super::Filter;
use crate::{ListData, SharedData};
use kas::event::{ConfigCx, EventCx};
use kas::{autoimpl, impl_scope, Events, Widget};
use kas_widgets::edit::{EditBox, EditField, EditGuard};
use std::fmt::Debug;
#[derive(Debug, Default)]
pub struct SetFilter<T: Debug>(pub T);
/// An [`EditGuard`] which sends a [`SetFilter`] message on every change
///
/// This may be used for search-as-you-type. Unfortunately the usual "messages
/// return up the tree" mechanism will not pass these messages to [`FilterList`]
/// when this is a sibling widget, hence the parent will likely need to call
/// [`FilterList::set_filter`] with [`SetFilter`]'s value.
pub struct KeystrokeGuard;
impl EditGuard for KeystrokeGuard {
type Data = ();
fn edit(edit: &mut EditField<Self>, cx: &mut EventCx, _: &Self::Data) {
cx.push(SetFilter(edit.to_string()));
}
}
/// An [`EditGuard`] which sends a [`SetFilter`] message on activate and focus loss
///
/// This may be used for search-as-you-type. Unfortunately the usual "messages
/// return up the tree" mechanism will not pass these messages to [`FilterList`]
/// when this is a sibling widget, hence the parent will likely need to call
/// [`FilterList::set_filter`] with [`SetFilter`]'s value.
pub struct AflGuard;
impl EditGuard for AflGuard {
type Data = ();
#[inline]
fn focus_lost(edit: &mut EditField<Self>, cx: &mut EventCx, _: &Self::Data) {
cx.push(SetFilter(edit.to_string()));
}
}
impl_scope! {
/// An [`EditBox`] above a [`FilterList`]
///
/// This is essentially just two widgets with "glue" to handle a
/// [`SetFilter`] message from the [`EditBox`].
#[autoimpl(Deref, DerefMut using self.list)]
#[autoimpl(Scrollable using self.list where W: trait)]
#[widget {
Data = A;
layout = column! [
self.edit,
self.list,
];
}]
pub struct FilterBoxList<A, F, W, G = KeystrokeGuard>
where
A: ListData + 'static,
F: Filter<A::Item, Value = String>,
W: Widget<Data = UnsafeFilteredList<A>>,
G: EditGuard<Data = ()>,
{
core: widget_core!(),
#[widget(&())] edit: EditBox<G>,
#[widget] list: FilterList<A, F, W>,
}
impl Self {
/// Construct
///
/// Parameters `list` and `filter` are passed to [`FilterList::new`].
///
/// Parameter `guard` may be [`KeystrokeGuard`], [`AflGuard`] or a
/// custom implementation.
pub fn new(list: W, filter: F, guard: G) -> Self {
Self {
core: Default::default(),
edit: EditBox::new(guard),
list: FilterList::new(list, filter),
}
}
}
impl Events for Self {
fn handle_messages(&mut self, cx: &mut EventCx, data: &A) {
if let Some(SetFilter(value)) = cx.try_pop() {
self.list.set_filter(&mut cx.config_cx(), data, value);
}
}
}
}
impl_scope! {
/// A widget adding a filter over some [`ListData`]
///
/// Why is this a widget? Widgets can access and pass on data, which is
/// what we need to filter a list.
///
/// Warning: this implementation is at least `O(n)` where `n = data.len()`.
/// Large collections may need to be filtered through another means.
/// This design may be re-evaluated for performance in the future.
///
/// To set the filter call [`Self::set_filter`] or pass a message of type
/// `SetFilter<F::Value>`.
#[autoimpl(Deref, DerefMut using self.list)]
#[autoimpl(Scrollable using self.list where W: trait)]
#[widget {
layout = self.list;
}]
pub struct FilterList<A, F, W>
where
A: ListData + 'static,
F: Filter<A::Item, Value = String>,
W: Widget<Data = UnsafeFilteredList<A>>,
{
core: widget_core!(),
#[widget(unsafe { &UnsafeFilteredList::new(data, &self.view) })]
pub list: W,
filter: F,
view: Vec<A::Key>,
}
impl Self {
/// Construct around `list` widget with the given `filter`
pub fn new(list: W, filter: F) -> Self {
FilterList {
core: Default::default(),
list,
filter,
view: vec![],
}
}
/// Set filter value
pub fn set_filter(&mut self, cx: &mut ConfigCx, data: &A, filter: F::Value) {
if self.filter.set_filter(filter) {
cx.update(self.as_node(data));
}
}
}
impl Events for Self {
type Data = A;
fn update(&mut self, _: &mut kas::event::ConfigCx, data: &A) {
self.view.clear();
self.view.reserve(data.len());
for key in data.iter_from(0, usize::MAX) {
if let Some(item) = data.borrow(&key) {
if self.filter.matches(std::borrow::Borrow::borrow(&item)) {
self.view.push(key);
}
}
}
}
fn handle_messages(&mut self, cx: &mut EventCx, data: &A) {
if let Some(SetFilter(value)) = cx.try_pop() {
self.set_filter(&mut cx.config_cx(), data, value);
}
}
}
}
impl_scope! {
/// Filtered view over a list
///
/// WARNING: this struct is `unsafe` because it contains lifetime-bound
/// references cast to `'static`. Instances or copies of this struct must
/// not outlive functions they are passed into.
/// (This is a poor design since it does not properly capsulate unsafety,
/// used for compatibility with other components. It does at least
/// encapsulate unsafety since this struct is only accessible behind a
/// non-`mut` reference, cannot be copied, and none of its methods return
/// references which don't have their own lifetime bound. Eventually the
/// plan is to make `Widget::Data` a GAT (once Rust supports object-safe
/// GAT traits), after which this struct may have a lifetime bound.)
///
/// This is an abstraction over a [`ListData`]. Items and associated keys
/// are not adjusted in any way.
///
/// The filter applies to [`SharedData::contains_key`] and [`ListData`]
/// methods, but not to [`SharedData::borrow`] (the latter can thus access
/// items excluded by the filter).
#[derive(Debug)]
pub struct UnsafeFilteredList<A: ListData + 'static> {
data: &'static A,
view: &'static [A::Key],
}
impl Self {
unsafe fn new<'a>(data: &'a A, view: &'a [A::Key]) -> Self {
UnsafeFilteredList {
data: std::mem::transmute(data),
view: std::mem::transmute(view),
}
}
}
impl SharedData for Self {
type Key = A::Key;
type Item = A::Item;
type ItemRef<'b> = A::ItemRef<'b> where A: 'b;
fn contains_key(&self, key: &Self::Key) -> bool {
// TODO(opt): note that this is O(n*n). For large lists it would be
// faster to re-evaluate the filter. Alternatively we could use a
// HashSet or BTreeSet to test membership.
self.view.iter().any(|item| *item == *key)
}
#[inline]
fn borrow(&self, key: &Self::Key) -> Option<Self::ItemRef<'_>> {
self.data.borrow(key)
}
}
impl ListData for Self {
type KeyIter<'b> = KeyIter<'b, A::Key>
where Self: 'b;
fn is_empty(&self) -> bool {
self.view.is_empty()
}
fn len(&self) -> usize {
self.view.len()
}
fn iter_from(&self, start: usize, limit: usize) -> Self::KeyIter<'_> {
let end = self.len().min(start + limit);
KeyIter { list: &self.view[start..end], index: 0 }
}
}
}
/// Key iterator used by [`UnsafeFilteredList`]
pub struct KeyIter<'b, Item: Clone> {
list: &'b [Item],
index: usize,
}
impl<'b, Item: Clone> Iterator for KeyIter<'b, Item> {
type Item = Item;
fn next(&mut self) -> Option<Item> {
let key = self.list.get(self.index).cloned();
if key.is_some() {
self.index += 1;
}
key
}
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.list.len() - self.index;
(len, Some(len))
}
}
impl<'b, Item: Clone> ExactSizeIterator for KeyIter<'b, Item> {}
impl<'b, Item: Clone> std::iter::FusedIterator for KeyIter<'b, Item> {}