aboutsummaryrefslogtreecommitdiff
path: root/gloss.el
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-04-30 07:27:44 -0500
committerCraig Jennings <c@cjennings.net>2026-04-30 07:27:44 -0500
commit9e90517a98785c450cd13cd940bd1787a4771529 (patch)
tree5c20f077bd3dcc28661711c3fdcad5ab90a5a3fa /gloss.el
parent5c7bb207081278e41122e62d8f6c282a18574665 (diff)
downloadgloss-9e90517a98785c450cd13cd940bd1787a4771529.tar.gz
gloss-9e90517a98785c450cd13cd940bd1787a4771529.zip
refactor: rework gloss-add UX to single side-window buffer
The previous shape opened a regular (non-side) buffer for body input and showed the saved entry in the side window after C-c C-c. That left an extra window split during the typing phase and a side popup the user didn't ask for. New shape, modeled on `org-capture': - `gloss-add' renders the term and underline as a read-only header in *gloss-add: TERM*, leaves the body region beneath it editable, and pops the buffer in the side-window slot. Point lands at the body start so the user can type immediately. - `gloss-add-finish' reads the body via the `gloss-add--body-start' marker, saves with source `manual', kills the buffer, closes the side window, and echoes `gloss-add: saved TERM' for confirmation. - `gloss-add-abort' kills the buffer and closes the side window. - The shared `gloss--add-cleanup' helper handles kill + window-close for both finish and abort. Read-only header uses text properties (`read-only', `front-sticky', `rear-nonsticky') rather than narrowing, so the user can't escape the restriction with `C-x n w'. `gloss--add-finish-internal' no longer calls show-entry — the save is its only responsibility. The display decision (show or not) is the caller's, which lets `gloss-add-finish' choose "save and close" while `gloss-lookup' still chooses "save and show." The previous saved-window-config approach is dropped — the side-slot takeover means there's nothing to restore. Layout returns to its pre-add state on either C-c C-c or C-c C-k. Adds `tests/test-gloss--add-flow-smoke.el' covering the four interactive moments (open, finish, abort, empty-term guard) plus the read-only-header invariant. Updates the `gloss--add-finish-internal' tests to drop the show-entry assertion. 129 tests pass in 0.27s.
Diffstat (limited to 'gloss.el')
-rw-r--r--gloss.el73
1 files changed, 52 insertions, 21 deletions
diff --git a/gloss.el b/gloss.el
index 62ecba4..46ce78e 100644
--- a/gloss.el
+++ b/gloss.el
@@ -140,8 +140,13 @@ Returns a symbol naming the action taken: :show, :auto-save, :pick,
(defvar-local gloss-add--term nil
"Term being added in this `gloss-add-mode' buffer.")
+(defvar-local gloss-add--body-start nil
+ "Marker pointing at the first editable position in `gloss-add-mode'.
+Everything before this marker (the rendered header — term + underline
++ blank line) is text-property read-only.")
+
(defun gloss--add-finish-internal (term body)
- "Save TERM with BODY as a manual entry, then show it.
+ "Validate and save TERM with BODY as a manual entry.
Returns the saved entry plist, or nil if `gloss-core-save' returned nil
(e.g. user cancelled at the collision prompt). Trims surrounding
whitespace from BODY before saving."
@@ -150,43 +155,69 @@ whitespace from BODY before saving."
(let ((trimmed (string-trim (or body ""))))
(when (string-empty-p trimmed)
(user-error "gloss-add: body cannot be empty"))
- (let ((saved (gloss-core-save term trimmed 'manual)))
- (when saved
- (gloss-display-show-entry term trimmed))
- saved)))
+ (gloss-core-save term trimmed 'manual)))
+
+(defun gloss--add-cleanup (buf win)
+ "Kill BUF and close WIN if it's still live.
+Used by both `gloss-add-finish' and `gloss-add-abort' so the layout
+returns to its pre-add state."
+ (let ((kill-buffer-query-functions nil))
+ (kill-buffer buf))
+ (when (window-live-p win)
+ (delete-window win)))
(defun gloss-add-finish ()
- "Save the current `gloss-add-mode' buffer's body for the recorded term."
+ "Save the current `gloss-add-mode' buffer's body for the recorded term.
+Body is everything after the read-only header. After saving, kills the
+add buffer and closes the side window — the user is returned to the
+pre-add window layout, with a confirmation message in the echo area."
(interactive)
(unless gloss-add--term
(user-error "gloss-add: no term recorded for this buffer"))
- (let ((term gloss-add--term)
- (body (buffer-string))
- (buf (current-buffer)))
- (gloss--add-finish-internal term body)
- (let ((kill-buffer-query-functions nil))
- (kill-buffer buf))))
+ (let* ((term gloss-add--term)
+ (body (buffer-substring-no-properties
+ (or gloss-add--body-start (point-min))
+ (point-max)))
+ (buf (current-buffer))
+ (win (get-buffer-window (current-buffer)))
+ (saved (gloss--add-finish-internal term body)))
+ (gloss--add-cleanup buf win)
+ (when saved
+ (message "gloss-add: saved %s" term))))
(defun gloss-add-abort ()
- "Abandon the current `gloss-add-mode' buffer without saving."
+ "Abandon the current `gloss-add-mode' buffer without saving.
+Kills the add buffer and closes the side window."
(interactive)
- (let ((kill-buffer-query-functions nil))
- (kill-buffer (current-buffer))))
+ (gloss--add-cleanup (current-buffer)
+ (get-buffer-window (current-buffer))))
;;;###autoload
(defun gloss-add (term)
"Add TERM to the glossary manually.
-Opens a side buffer for the body; \\[gloss-add-finish] saves,
-\\[gloss-add-abort] cancels."
+Opens a side-window buffer with TERM rendered as a read-only header
+and an editable body region beneath it. \\[gloss-add-finish] saves
+and shows the saved entry; \\[gloss-add-abort] cancels and closes
+the side window."
(interactive (list (read-string "Add term: ")))
(when (string-empty-p (string-trim (or term "")))
(user-error "gloss-add: term cannot be empty"))
(let ((buf (get-buffer-create (format "*gloss-add: %s*" term))))
(with-current-buffer buf
- (erase-buffer)
- (gloss-add-mode)
- (setq gloss-add--term term))
- (pop-to-buffer buf)))
+ (let ((inhibit-read-only t))
+ (erase-buffer)
+ (insert (gloss-display--render-entry term ""))
+ (let ((body-start (point-max-marker)))
+ (set-marker-insertion-type body-start nil)
+ (add-text-properties (point-min) body-start
+ '(read-only "Header is not editable"
+ front-sticky t
+ rear-nonsticky t))
+ (gloss-add-mode)
+ (setq gloss-add--term term)
+ (setq gloss-add--body-start body-start)))
+ (goto-char (point-max)))
+ (pop-to-buffer buf gloss-display--side-window-alist)))
(defun gloss--after-save-refresh-cache ()
"Buffer-local `after-save-hook' that clears the gloss cache."