Rename painting module to handwriting

Cargo.lock

@@ -1344,7 +1344,7 @@ dependencies = [
 
 [[package]]
 name = "inkr"
-version = "0.1.0"
+version = "1.0.0"
 dependencies = [
  "base64 0.22.1",
  "eframe",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "inkr"
-version = "0.1.0"
+version = "1.0.0"
 authors = []
 edition = "2024"
 

PKGBUILD

@@ -0,0 +1,27 @@
+pkgname=inkr
+pkgver=1.0.0
+pkgrel=1
+pkgdesc="A note-taking and handwriting tool"
+arch=('x86_64' 'aarch64')
+url="https://git.nubo.sh/hulthe/inkr"
+#license=('GPL')
+groups=('base-devel')
+depends=('glibc')
+makedepends=('cargo')
+#optdepends=('ed: for "patch -e" functionality')
+#source=(" ftp://ftp.gnu.org/gnu/$pkgname/$pkgname-$pkgver.tar.xz"{,.sig})
+#sha256sums=('SKIP')
+prepare() {
+	export RUSTUP_TOOLCHAIN=stable
+	cargo fetch --locked --target "$(rustc -vV | sed -n 's/host: //p')"
+}
+build() {
+	export RUSTUP_TOOLCHAIN=stable
+	cargo build --frozen --release
+}
+package() {
+	cd ..
+	install -Dm0755 -t "$pkgdir/usr/bin/" "${CARGO_TARGET_DIR:-target}/release/$pkgname"
+	install -Dm0755 -t "$pkgdir/usr/share/applications/" "assets/$pkgname.desktop"
+	install -Dm0755 "assets/icon.svg" "$pkgdir/usr/share/pixmaps/$pkgname.svg"
+}

assets/inkr.desktop

@@ -0,0 +1,9 @@
+[Desktop Entry]
+Name=inkr
+Exec=inkr
+Terminal=false
+Type=Application
+Icon=inkr
+StartupWMClass=inkr
+MimeType=x-scheme-handler/inkr;
+Categories=Office;

src/app.rs

@@ -2,11 +2,14 @@ use std::{
     fs,
     path::PathBuf,
     sync::{Arc, mpsc},
+    thread::JoinHandle,
+    time::{Duration, Instant},
 };
 
 use crate::{file_editor::FileEditor, preferences::Preferences, util::GuiSender};
 use egui::{
-    Align, Button, Color32, FontData, FontDefinitions, PointerButton, RichText, ScrollArea, Stroke,
+    Align, Button, Color32, Context, FontData, FontDefinitions, Key, Modifiers, PointerButton,
+    RichText, ScrollArea, Stroke,
 };
 
 #[derive(serde::Deserialize, serde::Serialize)]
@@ -18,6 +21,8 @@ pub struct App {
     actions_tx: mpsc::Sender<Action>,
     #[serde(skip)]
     actions_rx: mpsc::Receiver<Action>,
+    #[serde(skip)]
+    jobs: Jobs,
 
     tabs: Vec<(TabId, Tab)>,
     open_tab_index: Option<usize>,
@@ -25,6 +30,33 @@ pub struct App {
     next_tab_id: TabId,
 }
 
+pub struct Jobs {
+    handles: Vec<JoinHandle<()>>,
+    actions_tx: mpsc::Sender<Action>,
+}
+
+impl Jobs {
+    fn start(&mut self, ctx: &Context, job: impl FnOnce() -> Option<Action> + Send + 'static) {
+        let ctx = ctx.clone();
+        let actions_tx = self.actions_tx.clone();
+        self.handles.push(std::thread::spawn(move || {
+            // start rendering the spinner thingy
+            ctx.request_repaint();
+
+            let start = Instant::now();
+
+            if let Some(action) = job() {
+                let _ = actions_tx.send(action);
+                ctx.request_repaint();
+            };
+
+            // Make sure that task takes at least 250ms to run, so that the spinner won't blink
+            let sleep_for = Duration::from_millis(250).saturating_sub(start.elapsed());
+            std::thread::sleep(sleep_for);
+        }));
+    }
+}
+
 #[derive(serde::Deserialize, serde::Serialize)]
 enum Tab {
     File(FileEditor),
@@ -36,6 +68,12 @@ impl Tab {
             Tab::File(file_editor) => file_editor.title(),
         }
     }
+
+    pub fn is_dirty(&self) -> bool {
+        match self {
+            Tab::File(file_editor) => file_editor.is_dirty,
+        }
+    }
 }
 
 pub type TabId = usize;
@@ -55,8 +93,12 @@ impl Default for App {
         let (actions_tx, actions_rx) = mpsc::channel();
         Self {
             preferences: Preferences::default(),
-            actions_tx,
+            actions_tx: actions_tx.clone(/* this is silly, i know */),
             actions_rx,
+            jobs: Jobs {
+                handles: Default::default(),
+                actions_tx,
+            },
             tabs: vec![(1, Tab::File(FileEditor::new("note.md")))],
             open_tab_index: None,
             next_tab_id: 2,
@@ -146,7 +188,7 @@ impl App {
         Default::default()
     }
 
-    fn actions_tx(&self, ctx: &egui::Context) -> GuiSender<Action> {
+    fn actions_tx(&self, ctx: &Context) -> GuiSender<Action> {
         GuiSender::new(self.actions_tx.clone(), ctx)
     }
 
@@ -175,9 +217,11 @@ impl eframe::App for App {
         eframe::set_value(storage, eframe::APP_KEY, self);
     }
 
-    fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
+    fn update(&mut self, ctx: &Context, _frame: &mut eframe::Frame) {
         self.preferences.apply(ctx);
 
+        self.jobs.handles.retain(|job| !job.is_finished());
+
         while let Ok(action) = self.actions_rx.try_recv() {
             self.handle_action(action);
         }
@@ -186,11 +230,11 @@ impl eframe::App for App {
             self.open_tab_index = Some(self.tabs.len().saturating_sub(1));
         }
 
-        //ctx.input_mut(|input| {
-        //    if input.consume_key(Modifiers::CTRL, Key::H) {
-        //        self.buffer.push(BufferItem::Painting(Default::default()));
-        //    }
-        //});
+        ctx.input_mut(|input| {
+            if input.consume_key(Modifiers::CTRL, Key::S) {
+                self.save_active_tab(ctx);
+            }
+        });
 
         egui::TopBottomPanel::top("top_panel").show(ctx, |ui| {
             egui::containers::menu::Bar::new().ui(ui, |ui| {
@@ -205,22 +249,15 @@ impl eframe::App for App {
 
                     #[cfg(not(target_arch = "wasm32"))]
                     if ui.button("Open File").clicked() {
-                        let actions_tx = self.actions_tx(ui.ctx());
-                        std::thread::spawn(move || {
-                            let file = rfd::FileDialog::new().pick_file();
+                        self.jobs.start(ui.ctx(), move || {
+                            let file_path = rfd::FileDialog::new().pick_file()?;
 
-                            let Some(file_path) = file else { return };
-
-                            let text = match fs::read_to_string(&file_path) {
-                                Ok(text) => text,
-                                Err(e) => {
-                                    log::error!("Failed to read {file_path:?}: {e}");
-                                    return;
-                                }
-                            };
+                            let text = fs::read_to_string(&file_path)
+                                .inspect_err(|e| log::error!("Failed to read {file_path:?}: {e}"))
+                                .ok()?;
 
                             let editor = FileEditor::from_file(file_path, &text);
-                            let _ = actions_tx.send(Action::OpenFile(editor));
+                            Some(Action::OpenFile(editor))
                         });
                     }
 
@@ -237,6 +274,19 @@ impl eframe::App for App {
                         }
                     }
 
+                    let can_save_file = self
+                        .open_tab_index
+                        .and_then(|i| self.tabs.get(i))
+                        .and_then(|(id, tab)| match tab {
+                            Tab::File(file_editor) => Some((*id, file_editor)),
+                        })
+                        .and_then(|(_, file_editor)| file_editor.path().zip(Some(file_editor)))
+                        .is_some();
+
+                    if ui.add_enabled(can_save_file, Button::new("Save")).clicked() {
+                        self.save_active_tab(ui.ctx());
+                    }
+
                     let open_file =
                         self.open_tab_index
                             .and_then(|i| self.tabs.get(i))
@@ -244,45 +294,22 @@ impl eframe::App for App {
                                 Tab::File(file_editor) => Some((*id, file_editor)),
                             });
 
-                    let open_file_with_path = open_file
-                        .clone()
-                        .and_then(|(_, file_editor)| file_editor.path().zip(Some(file_editor)));
-
-                    if ui
-                        .add_enabled(open_file_with_path.is_some(), Button::new("Save"))
-                        .clicked()
-                    {
-                        if let Some((file_path, file_editor)) = open_file_with_path {
-                            let text = file_editor.to_string();
-                            let file_path = file_path.to_owned();
-                            std::thread::spawn(move || {
-                                if let Err(e) = fs::write(file_path, text.as_bytes()) {
-                                    log::error!("{e}");
-                                };
-                            });
-                        }
-                    }
-
                     #[cfg(not(target_arch = "wasm32"))]
                     if ui
                         .add_enabled(open_file.is_some(), Button::new("Save As"))
                         .clicked()
                     {
-                        let actions_tx = self.actions_tx(ui.ctx());
                         let (tab_id, editor) =
                             open_file.expect("We checked that open_file is_some");
                         let text = editor.to_string();
-                        std::thread::spawn(move || {
-                            let Some(file_path) = rfd::FileDialog::new().save_file() else {
-                                return;
-                            };
+                        self.jobs.start(ui.ctx(), move || {
+                            let file_path = rfd::FileDialog::new().save_file()?;
 
-                            if let Err(e) = fs::write(&file_path, text.as_bytes()) {
-                                log::error!("{e}");
-                                return;
-                            };
+                            fs::write(&file_path, text.as_bytes())
+                                .inspect_err(|e| log::error!("{e}"))
+                                .ok()?;
 
-                            let _ = actions_tx.send(Action::MoveFile(tab_id, file_path));
+                            Some(Action::MoveFile(tab_id, file_path))
                         });
                     }
 
@@ -297,7 +324,9 @@ impl eframe::App for App {
                     }
                 });
 
-                ui.add_space(16.0);
+                if !self.jobs.handles.is_empty() {
+                    ui.spinner();
+                }
 
                 ui.add_space(16.0);
 
@@ -306,8 +335,7 @@ impl eframe::App for App {
                         let selected = self.open_tab_index == Some(i);
                         let mut button = Button::new(tab.title()).selected(selected);
 
-                        let dirty = i == 0; // TODO: mark as dirty when contents hasn't been saved
-                        if dirty {
+                        if tab.is_dirty() {
                             button = button.right_text(RichText::new("*").strong())
                         }
 
@@ -355,4 +383,31 @@ impl App {
         self.next_tab_id += 1;
         self.tabs.insert(i, (id, tab));
     }
+
+    fn save_active_tab(&mut self, ctx: &Context) {
+        let open_file = self
+            .open_tab_index
+            .and_then(|i| self.tabs.get_mut(i))
+            .and_then(|(id, tab)| match tab {
+                Tab::File(file_editor) => Some((*id, file_editor)),
+            })
+            .and_then(|(_, file_editor)| {
+                file_editor
+                    .path()
+                    .map(ToOwned::to_owned)
+                    .zip(Some(file_editor))
+            });
+
+        if let Some((file_path, file_editor)) = open_file {
+            file_editor.is_dirty = false;
+            let text = file_editor.to_string();
+            let file_path = file_path.to_owned();
+            self.jobs.start(ctx, move || {
+                if let Err(e) = fs::write(file_path, text.as_bytes()) {
+                    log::error!("{e}");
+                };
+                None
+            });
+        }
+    }
 }

src/file_editor.rs

@@ -12,7 +12,7 @@ use egui::{
 
 use crate::{
     custom_code_block::{MdItem, iter_lines_and_code_blocks},
-    painting::{self, Handwriting, HandwritingStyle},
+    handwriting::{self, Handwriting, HandwritingStyle},
     preferences::Preferences,
     text_editor::MdTextEdit,
 };
@@ -22,6 +22,9 @@ pub struct FileEditor {
     title: String,
     pub path: Option<PathBuf>,
     pub buffer: Vec<BufferItem>,
+
+    /// Whether the file has been edited since it was laste saved to disk.
+    pub is_dirty: bool,
 }
 
 #[derive(serde::Deserialize, serde::Serialize)]
@@ -37,6 +40,7 @@ impl FileEditor {
             title: title.into(),
             path: None,
             buffer,
+            is_dirty: false,
         }
     }
 
@@ -69,9 +73,11 @@ impl FileEditor {
             ui.horizontal(|ui| {
                 ui.label("new");
                 if ui.button("text").clicked() {
+                    self.is_dirty = true;
                     self.buffer.push(BufferItem::Text(Default::default()));
                 }
                 if ui.button("writing").clicked() {
+                    self.is_dirty = true;
                     self.buffer
                         .push(BufferItem::Handwriting(Default::default()));
                 }
@@ -138,14 +144,18 @@ impl FileEditor {
 
                 let item_response = ui.allocate_ui(item_size, |ui| match item {
                     BufferItem::Text(text_edit) => {
-                        text_edit.ui(ui);
+                        if text_edit.ui(ui).changed {
+                            self.is_dirty = true;
                         }
-                    BufferItem::Handwriting(painting) => {
+                    }
+                    BufferItem::Handwriting(handwriting) => {
                         let style = HandwritingStyle {
                             animate: preferences.animations,
                             ..HandwritingStyle::from_theme(ui.ctx().theme())
                         };
-                        painting.ui(&style, ui);
+                        if handwriting.ui(&style, ui).changed {
+                            self.is_dirty = true;
+                        }
                     }
                 });
 
@@ -211,10 +221,12 @@ impl FileEditor {
                     Ordering::Greater => {
                         let item = self.buffer.remove(from);
                         self.buffer.insert(to, item);
+                        self.is_dirty = true;
                     }
                     Ordering::Less => {
                         let item = self.buffer.remove(from);
                         self.buffer.insert(to - 1, item);
+                        self.is_dirty = true;
                     }
                     Ordering::Equal => {}
                 }
@@ -275,7 +287,7 @@ impl From<&str> for FileEditor {
             match item {
                 MdItem::Line(line) => push_text(buffer, line),
                 MdItem::CodeBlock { key, content, span } => match key {
-                    painting::CODE_BLOCK_KEY => match Handwriting::from_str(span) {
+                    handwriting::CODE_BLOCK_KEY => match Handwriting::from_str(span) {
                         Ok(handwriting) => {
                             if let Some(BufferItem::Text(text_edit)) = buffer.last_mut() {
                                 if text_edit.text.ends_with('\n') {

src/handwriting.rs

@@ -94,6 +94,10 @@ pub struct Handwriting {
     last_mesh_ctx: Option<MeshContext>,
 }
 
+pub struct HandwritingResponse {
+    pub changed: bool,
+}
+
 /// Context of a mesh render.
 #[derive(Clone, Copy, PartialEq)]
 struct MeshContext {
@@ -164,6 +168,7 @@ impl Handwriting {
         &mut self,
         style: Option<&mut HandwritingStyle>,
         ui: &mut egui::Ui,
+        response: &mut HandwritingResponse,
     ) -> egui::Response {
         ui.horizontal(|ui| {
             if let Some(style) = style {
@@ -175,12 +180,14 @@ impl Handwriting {
             if ui.button("Clear Painting").clicked() {
                 self.strokes.clear();
                 self.refresh_texture = true;
+                response.changed = true;
             }
 
             ui.add_enabled_ui(!self.strokes.is_empty(), |ui| {
                 if ui.button("Undo").clicked() {
                     self.strokes.pop();
                     self.refresh_texture = true;
+                    response.changed = true;
                 }
             });
 
@@ -190,12 +197,18 @@ impl Handwriting {
         .response
     }
 
-    fn commit_current_line(&mut self) {
+    fn commit_current_line(&mut self, response: &mut HandwritingResponse) {
         debug_assert!(!self.current_stroke.is_empty());
         self.strokes.push(mem::take(&mut self.current_stroke));
+        response.changed = true;
     }
 
-    pub fn ui_content(&mut self, style: &HandwritingStyle, ui: &mut Ui) -> egui::Response {
+    pub fn ui_content(
+        &mut self,
+        style: &HandwritingStyle,
+        ui: &mut Ui,
+        hw_response: &mut HandwritingResponse,
+    ) -> egui::Response {
         if style.animate {
             self.height = ui.ctx().animate_value_with_time(
                 self.id.with("height animation"),
@@ -206,8 +219,8 @@ impl Handwriting {
             self.height = self.desired_height;
         }
 
-        let size = Vec2::new(ui.available_width(), self.height);
-        let (response, painter) = ui.allocate_painter(size, Sense::drag());
+        let desired_size = Vec2::new(ui.available_width(), self.height);
+        let (response, painter) = ui.allocate_painter(desired_size, Sense::drag());
 
         let mut response = response
             //.on_hover_cursor(CursorIcon::Crosshair)
@@ -216,20 +229,24 @@ impl Handwriting {
 
         let size = response.rect.size();
 
-        let to_screen = emath::RectTransform::from_to(
-            //Rect::from_min_size(Pos2::ZERO, response.rect.square_proportions()),
-            Rect::from_min_size(Pos2::ZERO, size),
-            response.rect,
-        );
+        // Calculate matrices that convert between screen-space and image-space.
+        // - image-space: 0,0 is the top-left of the texture.
+        // - screen-space: 0,0 is the top-left of the window.
+        // Both spaces use the same logical points, not pixels.
+        let to_screen =
+            emath::RectTransform::from_to(Rect::from_min_size(Pos2::ZERO, size), response.rect);
         let from_screen = to_screen.inverse();
 
-        let is_drawing = response.interact_pointer_pos().is_some();
+        // Was the user in the process of drawing a stroke last frame?
         let was_drawing = !self.current_stroke.is_empty();
 
+        // Is the user in the process of drawing a stroke now?
+        let is_drawing = response.interact_pointer_pos().is_some();
+
         if !is_drawing {
-            // commit current line
             if was_drawing {
-                self.commit_current_line();
+                // commit current line
+                self.commit_current_line(hw_response);
                 response.mark_changed();
             }
 
@@ -241,6 +258,8 @@ impl Handwriting {
                 .map(|p| p.y + HANDWRITING_BOTTOM_PADDING)
                 .fold(HANDWRITING_MIN_HEIGHT, |max, y| max.max(y));
 
+            // Change the height of the handwriting item.
+            // We don't do this mid-stroke, only when the user e.g. lifts the pen.
             if self.desired_height != lines_max_y {
                 self.desired_height = lines_max_y;
                 response.mark_changed();
@@ -275,6 +294,7 @@ impl Handwriting {
                 .collect::<Vec<_>>()
             });
 
+            // Process input events and turn them into strokes
             for event in events {
                 let last_canvas_pos = self.current_stroke.last();
 
@@ -324,7 +344,7 @@ impl Handwriting {
                         (PointerButton::Primary, false) => {
                             if last_canvas_pos.is_some() {
                                 self.push_to_stroke(from_screen * pos);
-                                self.commit_current_line();
+                                self.commit_current_line(hw_response);
                                 response.mark_changed();
                             }
 
@@ -341,7 +361,7 @@ impl Handwriting {
                     // in the same frame. Should handle this.
                     Event::PointerGone | Event::WindowFocused(false) => {
                         if !self.current_stroke.is_empty() {
-                            self.commit_current_line();
+                            self.commit_current_line(hw_response);
                             break;
                         }
                     }
@@ -361,6 +381,7 @@ impl Handwriting {
             }
         }
 
+        // Draw the horizontal ruled lines
         (1..)
             .map(|n| n as f32 * HANDWRITING_LINE_SPACING)
             .take_while(|&y| y < size.y)
@@ -373,9 +394,12 @@ impl Handwriting {
                 painter.add(shape);
             });
 
+        // Get the dimensions of the image
         let mesh_rect = response
             .rect
             .with_max_y(response.rect.min.y + self.desired_height);
+
+        // These are the values that, if changed, would require the mesh to be re-rendered.
         let new_context = MeshContext {
             ui_theme: ui.ctx().theme(),
             pixels_per_point: ui.pixels_per_point(),
@@ -383,24 +407,25 @@ impl Handwriting {
             stroke: style.stroke,
         };
 
+        // Figure out if we need to re-rasterize the mesh.
         if Some(&new_context) != self.last_mesh_ctx.as_ref() {
             self.refresh_texture = true;
         }
 
         if self.refresh_texture {
-            // rasterize the entire texture from scratch
+            // ...if we do, rasterize the entire texture from scratch
             self.refresh_texture(style, new_context, ui);
             self.unblitted_lines.clear();
         } else if !self.unblitted_lines.is_empty() {
-            // only rasterize the new lines onto the existing texture
+            // ...if we don't, we can get away with  only rasterizing the *new* lines onto the
+            // existing texture.
             for [from, to] in std::mem::take(&mut self.unblitted_lines) {
                 self.draw_line_to_texture(from, to, &new_context, ui);
             }
             self.unblitted_lines.clear();
         }
 
-        //painter.add(self.mesh.clone());
-
+        // Draw the texture
         if let Some(texture) = &self.texture {
             let texture = SizedTexture::new(texture.id(), texture.size_vec2());
             let shape = RectShape {
@@ -475,9 +500,11 @@ impl Handwriting {
         }
     }
 
-    pub fn ui(&mut self, style: &HandwritingStyle, ui: &mut Ui) {
+    pub fn ui(&mut self, style: &HandwritingStyle, ui: &mut Ui) -> HandwritingResponse {
+        let mut response = HandwritingResponse { changed: false };
+
         ui.vertical_centered_justified(|ui| {
-            self.ui_control(None, ui);
+            self.ui_control(None, ui, &mut response);
 
             //ui.label("Paint with your mouse/touch!");
             Frame::canvas(ui.style())
@@ -485,9 +512,11 @@ impl Handwriting {
                 .stroke(Stroke::new(5.0, Color32::from_black_alpha(40)))
                 .fill(style.bg_color)
                 .show(ui, |ui| {
-                    self.ui_content(style, ui);
+                    self.ui_content(style, ui, &mut response);
                 });
         });
+
+        response
     }
 
     fn push_to_stroke(&mut self, new_canvas_pos: Pos2) {

src/lib.rs

@@ -5,7 +5,7 @@ pub mod constants;
 pub mod custom_code_block;
 pub mod easy_mark;
 pub mod file_editor;
-pub mod painting;
+pub mod handwriting;
 pub mod preferences;
 pub mod rasterizer;
 pub mod text_editor;

src/text_editor.rs

@@ -24,6 +24,10 @@ pub struct MdTextEdit {
     cursor: Option<CCursorRange>,
 }
 
+pub struct MdTextEditOutput {
+    pub changed: bool,
+}
+
 impl MdTextEdit {
     pub fn new() -> Self {
         MdTextEdit::default()
@@ -36,7 +40,7 @@ impl MdTextEdit {
         }
     }
 
-    pub fn ui(&mut self, ui: &mut Ui) {
+    pub fn ui(&mut self, ui: &mut Ui) -> MdTextEditOutput {
         let Self {
             text,
             highlighter,
@@ -72,6 +76,10 @@ impl MdTextEdit {
             *cursor = text_edit.cursor_range;
             //ui.ctx().request_repaint();
         }
+
+        MdTextEditOutput {
+            changed: text_edit.response.changed(),
+        }
     }
 }