iota-editor 0.1.0

A simple text editor
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

pub use super::keyboard::Key;
pub use super::uibuf::{CharStyle, CharColor};

pub use self::rb::RustboxFrontend;

/// A general means of representing events from different frontends.
///
/// A frontend should translate its own events into an EditorEvent to be used
/// elsewhere in the program.
pub enum EditorEvent {
    KeyEvent(Option<Key>),
    Resize(usize, usize),
    UnSupported
}

/// A Frontend is a means of representing the Editor to the user.
///
/// For example, there could be frontends for:
/// - a terminal
/// - a GUI
/// - a web browser
///
/// Frontends are chose at startup and can't be changed while the Editor is
/// running.
pub trait Frontend {
    /// Poll the frontend for an event, translating it to an EditorEvent
    fn poll_event(&self) -> EditorEvent;
    /// Present the newly drawn data (cursor / content) to the user
    fn present(&self);
    /// Get the frontends window height or equivalent
    fn get_window_height(&self) -> usize;
    /// Get the frontends window width or equivalent
    fn get_window_width(&self) -> usize;
    /// Draw the cursor to the frontend
    fn draw_cursor(&mut self, offset: isize, linenum: isize);
    /// Draw the given char & styles to the frontend
    fn draw_char(&mut self, offset: usize, linenum: usize, ch: char, fg: CharColor, bg: CharColor, style: CharStyle);
}

mod rb;