kimun-notes 0.14.0

A terminal-based notes application
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

//! The `Overlay` trait and its supporting types — the contract every editor
//! overlay (note browser, Saved Searches modal, or dialog) implements so the
//! `OverlayHost` can route input / app-messages / render to it uniformly.

use std::sync::Arc;

use kimun_core::NoteVault;
use ratatui::Frame;
use ratatui::layout::Rect;

use crate::components::event_state::EventState;
use crate::components::events::{AppEvent, AppTx, InputEvent};
use crate::settings::themes::Theme;

/// Identifies which overlay is active — used for toggle, focus label, and hints.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OverlayKind {
    NoteBrowser,
    SavedSearches,
    Dialog,
}

impl OverlayKind {
    /// Footer label for this overlay kind.
    pub fn label(&self) -> &'static str {
        match self {
            OverlayKind::NoteBrowser => "NOTE BROWSER",
            OverlayKind::SavedSearches => "SAVED SEARCHES",
            OverlayKind::Dialog => "DIALOG",
        }
    }
}

/// Outcome of routing an `AppEvent` to the active overlay. Overlays never
/// request their own dismissal here: dialogs close by emitting the
/// `AppEvent::CloseOverlay` event, which the editor handles separately.
#[derive(Debug)]
pub enum OverlayMsg {
    /// The overlay did not recognise the message.
    NotConsumed,
    /// The overlay handled the message and stays open.
    Consumed,
}

// `Send`: an `OverlayHost` lives in `EditorScreen`, whose `#[async_trait]`
// `AppScreen` methods desugar to `Send` futures — so the boxed overlay must be `Send`.
pub trait Overlay: Send {
    fn kind(&self) -> OverlayKind;
    fn handle_input(&mut self, event: &InputEvent, tx: &AppTx) -> EventState;
    fn handle_app_message(
        &mut self,
        _msg: &AppEvent,
        _vault: &Arc<NoteVault>,
        _tx: &AppTx,
    ) -> OverlayMsg {
        OverlayMsg::NotConsumed
    }
    fn render(&mut self, f: &mut Frame, area: Rect, theme: &Theme);
    fn hint_shortcuts(&self) -> Vec<(String, String)> {
        vec![]
    }
    /// The query string this overlay holds, if it is query-backed (the note
    /// browser). Used by the editor's save-current-query action to source the
    /// query from the active overlay. Defaults to `None` for non-query overlays.
    fn query(&self) -> Option<&str> {
        None
    }
    /// The saved-search name this overlay's query came from (its breadcrumb
    /// provenance), if any. Used to pre-fill the save-search dialog's name.
    /// Defaults to `None` for overlays without a breadcrumb.
    fn saved_search_provenance(&self) -> Option<&str> {
        None
    }
}