basalt-tui 0.11.1

Basalt TUI application for Obsidian notes.
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
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
use std::{
    fmt,
    fs::File,
    io::{self, Write},
    path::{Path, PathBuf},
};

use ratatui::layout::Size;

use crate::note_editor::{
    ast::{self},
    cursor::{self, Cursor},
    parser,
    text_buffer::TextBuffer,
    viewport::Viewport,
    virtual_document::VirtualDocument,
};

#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub enum EditMode {
    #[default]
    /// Shows the markdown exactly as written
    Source,
    // TODO:
    // /// Hides most of the markdown syntax
    // LivePreview
}

#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub enum View {
    #[default]
    Read,
    Edit(EditMode),
}

impl fmt::Display for View {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            View::Read => write!(f, "READ"),
            View::Edit(..) => write!(f, "EDIT"),
        }
    }
}

#[derive(Clone, Debug, Default)]
pub struct NoteEditorState<'a> {
    // FIXME: Use Rope instead of String for O(log n) instead of O(n).
    pub content: String,
    pub view: View,
    pub cursor: Cursor,
    pub ast_nodes: Vec<ast::Node>,
    pub virtual_document: VirtualDocument<'a>,
    filepath: PathBuf,
    filename: String,
    active: bool,
    modified: bool,
    viewport: Viewport,
    text_buffer: Option<TextBuffer>,
}

impl<'a> NoteEditorState<'a> {
    pub fn new(content: &str, filename: &str, filepath: &Path) -> Self {
        let ast_nodes = parser::from_str(content);
        let content = content.to_string();
        Self {
            text_buffer: None,
            content: content.clone(),
            view: View::Read,
            cursor: Cursor::default(),
            viewport: Viewport::default(),
            virtual_document: VirtualDocument::default(),
            filename: filename.to_string(),
            filepath: filepath.to_path_buf(),
            ast_nodes,
            active: false,
            modified: false,
        }
    }

    pub fn viewport(&self) -> &Viewport {
        &self.viewport
    }

    pub fn is_editing(&self) -> bool {
        matches!(self.view, View::Edit(..))
    }

    pub fn text_buffer(&self) -> Option<&TextBuffer> {
        self.text_buffer.as_ref()
    }

    // FIXME: if document is empty cannot write as there is no markdown block to write on.
    pub fn enter_insert(&mut self, block_idx: usize) {
        if let Some((_, block)) = self.virtual_document.get_block(block_idx) {
            let source_range = block.source_range();
            if let Some(content) = self.content.get(source_range.clone()) {
                self.text_buffer = Some(TextBuffer::new(content, source_range.clone()));
            }
        } else {
            self.text_buffer = Some(TextBuffer::new("", 0..0));
        }
    }

    pub fn exit_insert(&mut self) {
        if matches!(self.view, View::Read) {
            return;
        }

        if let Some(buffer) = self.text_buffer() {
            let new_content = buffer.write(&self.content);
            if self.content != new_content {
                self.content = new_content;
                self.ast_nodes = parser::from_str(&self.content);
                self.update_layout();
                self.modified = true;
            }
        }

        self.text_buffer = None;
    }

    pub fn insert_char(&mut self, c: char) {
        if let Some(buffer) = &mut self.text_buffer {
            let insertion_offset = self.cursor.source_offset();
            buffer.insert_char(c, insertion_offset);

            // Shift source ranges of all nodes after the insertion point
            self.shift_source_ranges(insertion_offset, 1);

            self.update_layout();
            self.cursor_right(1);
        }
    }

    pub fn delete_char(&mut self) {
        if let Some(buffer) = &mut self.text_buffer {
            if buffer.source_range.start == self.cursor.source_offset() {
                // TODO: Get previous block source range start
                // Get current block source range end
                // Get content with source range
                // Create new text buffer that has merged the previous and current blocks
            } else {
                let deletion_offset = self.cursor.source_offset();
                buffer.delete_char(deletion_offset);

                // We shift by -1 (saturating subtraction) to move ranges backwards
                self.shift_source_ranges(deletion_offset, -1);

                self.update_layout();
                self.cursor_left(1);
            }
        }
    }

    pub fn active(&self) -> bool {
        self.active
    }

    pub fn current_block(&self) -> usize {
        *self
            .virtual_document
            .line_to_block()
            .get(self.cursor.virtual_row())
            .unwrap_or(&0)
    }

    pub fn set_view(&mut self, view: View) {
        let block_idx = self.current_block();

        self.view = view;

        use cursor::Message::*;

        match self.view {
            View::Read => {
                self.exit_insert();
                self.update_layout();
                self.cursor.update(
                    SwitchMode(cursor::CursorMode::Read),
                    self.virtual_document.lines(),
                    &None,
                );
            }
            View::Edit(..) => {
                self.enter_insert(block_idx);
                self.update_layout();
                self.cursor.update(
                    SwitchMode(cursor::CursorMode::Edit),
                    self.virtual_document.lines(),
                    &self.text_buffer,
                );
            }
        }
    }

    pub fn resize_viewport(&mut self, size: Size) {
        if self.viewport.size_changed(size) {
            use cursor::Message::*;

            let current_block_idx =
                matches!(self.view, View::Edit(..)).then_some(self.current_block());

            self.virtual_document.layout(
                &self.filename,
                &self.content,
                &self.view,
                current_block_idx,
                &self.ast_nodes,
                size.width.into(),
                self.text_buffer.clone(),
            );

            self.viewport.resize(size);

            self.cursor.update(
                Jump(self.cursor.source_offset()),
                self.virtual_document.lines(),
                &self.text_buffer,
            );

            self.ensure_cursor_visible();
        }
    }

    /// Ensures the cursor is visible within the viewport by scrolling if necessary.
    /// This method should be called after any operation that might cause the cursor
    /// to move outside the visible area (e.g., resize, cursor movement).
    fn ensure_cursor_visible(&mut self) {
        let cursor_row = self.cursor.virtual_row() as i32;
        let viewport_top = self.viewport.top() as i32;
        let viewport_bottom = self.viewport.bottom() as i32;
        let meta_len = self.virtual_document.meta().len() as i32;

        let effective_bottom = viewport_bottom.saturating_sub(meta_len);

        if cursor_row < viewport_top {
            let scroll_offset = cursor_row - viewport_top;
            self.viewport.scroll_by((scroll_offset, 0));
        } else if cursor_row >= effective_bottom {
            let scroll_offset = cursor_row - effective_bottom + 1;
            self.viewport.scroll_by((scroll_offset, 0));
        }
    }

    pub fn set_active(&mut self, active: bool) {
        self.active = active;
    }

    pub fn modified(&self) -> bool {
        self.text_buffer()
            .map(|buffer| buffer.modified)
            .unwrap_or(self.modified)
    }

    pub fn cursor_word_forward(&mut self) {
        use cursor::Message::*;

        self.cursor.update(
            MoveWordForward,
            self.virtual_document.lines(),
            &self.text_buffer,
        );
    }

    pub fn cursor_word_backward(&mut self) {
        use cursor::Message::*;

        self.cursor.update(
            MoveWordBackward,
            self.virtual_document.lines(),
            &self.text_buffer,
        );
    }

    pub fn cursor_left(&mut self, amount: usize) {
        use cursor::Message::*;

        self.cursor.update(
            MoveLeft(amount),
            self.virtual_document.lines(),
            &self.text_buffer,
        );
    }

    pub fn cursor_right(&mut self, amount: usize) {
        use cursor::Message::*;

        self.cursor.update(
            MoveRight(amount),
            self.virtual_document.lines(),
            &self.text_buffer,
        );
    }

    pub fn cursor_jump(&mut self, idx: usize) {
        use cursor::Message::*;

        if let Some(block) = self.virtual_document.blocks().get(idx) {
            self.cursor.update(
                Jump(block.source_range.start),
                self.virtual_document.lines(),
                &self.text_buffer,
            );
        }

        self.ensure_cursor_visible();
    }

    pub fn update_layout(&mut self) {
        use cursor::Message::*;

        let current_block_idx = if matches!(self.view, View::Edit(..)) {
            Some(self.current_block())
        } else {
            None
        };

        self.virtual_document.layout(
            &self.filename,
            &self.content,
            &self.view,
            current_block_idx,
            &self.ast_nodes,
            self.viewport.area().width.into(),
            self.text_buffer.clone(),
        );

        self.cursor.update(
            Jump(self.cursor.source_offset()),
            self.virtual_document.lines(),
            &self.text_buffer,
        );
    }

    pub fn cursor_up(&mut self, amount: usize) {
        use cursor::Message::*;

        let prev_block_idx = self.current_block();

        self.cursor.update(
            MoveUp(amount),
            self.virtual_document.lines(),
            &self.text_buffer,
        );

        if matches!(self.view, View::Edit(..)) {
            let current_block_idx = self.current_block();

            if current_block_idx != prev_block_idx {
                self.enter_insert(current_block_idx);

                self.virtual_document.layout(
                    &self.filename,
                    &self.content,
                    &self.view,
                    Some(current_block_idx),
                    &self.ast_nodes,
                    self.viewport.area().width.into(),
                    self.text_buffer.clone(),
                );

                // Recalculate cursor position after layout change
                // The virtual line indices have shifted, so we need to find the new position
                // based on the source offset
                self.cursor.update(
                    Jump(self.cursor.source_offset()),
                    self.virtual_document.lines(),
                    &self.text_buffer,
                );
            }
        }

        self.ensure_cursor_visible();
    }

    pub fn cursor_down(&mut self, amount: usize) {
        use cursor::Message::*;

        let prev_block_idx = self.current_block();

        self.cursor.update(
            MoveDown(amount),
            self.virtual_document.lines(),
            &self.text_buffer,
        );

        if matches!(self.view, View::Edit(..)) {
            let current_block_idx = self.current_block();

            if current_block_idx != prev_block_idx {
                self.enter_insert(current_block_idx);

                self.virtual_document.layout(
                    &self.filename,
                    &self.content,
                    &self.view,
                    Some(current_block_idx),
                    &self.ast_nodes,
                    self.viewport.area().width.into(),
                    self.text_buffer.clone(),
                );

                // Recalculate cursor position after layout change
                // The virtual line indices have shifted, so we need to find the new position
                // based on the source offset
                self.cursor.update(
                    Jump(self.cursor.source_offset()),
                    self.virtual_document.lines(),
                    &self.text_buffer,
                );
            }
        }

        self.ensure_cursor_visible();
    }

    pub fn save_to_file(&mut self) -> io::Result<()> {
        if self.modified() {
            let mut file = File::create(&self.filepath)?;
            file.write_all(self.content.as_bytes())?;
            self.modified = false;
        }
        Ok(())
    }

    /// The shift amount can be positive (insertion) or negative (deletion).
    fn shift_source_ranges(&mut self, offset: usize, shift: isize) {
        self.shift_nodes(offset, shift);
    }

    /// Shifts source ranges of top-level AST nodes.
    ///
    /// This function is a helper function intended to shift the source ranges when editing the
    /// document. After exiting the edit mode, the source ranges are calculated by the parser, so
    /// we don't have to be precise here.
    fn shift_nodes(&mut self, offset: usize, shift: isize) {
        let shift_value = |v: usize| v.checked_add_signed(shift).unwrap_or(0);

        // We only take the current node and the rest after it
        let nodes = self
            .ast_nodes
            .iter_mut()
            .filter(|node| node.source_range().end > offset);

        nodes.for_each(|node| {
            let range = node.source_range();
            let shifted_range = if range.start > offset {
                shift_value(range.start)..shift_value(range.end)
            } else {
                range.start..shift_value(range.end)
            };
            node.set_source_range(shifted_range);
        });
    }
}