Skip to content

Add correct- below wrong-character + various #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lordnik22 merged 1 commit into from
Jan 28, 2026
Merged

Add correct- below wrong-character + various #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,21 +156,17 @@ A little diagram because [uniline](https://github.com/tbanel/uniline) is fun:
│ ▽ │ ▽ resume │ ▽
╭─────╮ ╭─────╮ ╭┴──┴─────┴───┴────╮ ╭─┴─────────┴─╮ ╭────╮
│start├──▷┤setup├──────▷┤speed-type session├───▷┤complete/menu├────▷┤quit│
╰─────╯ ╰─┬───╯ ╰─┬──────────────┬─╯ │╰──────┬──────╯ ╰────╯
△ │ △ save │
│ ▽ │ │
│ ╭─┴──────────────┴─╮ │
│ │add words on error│ │
│ ╰──────────────────╯ │
│ ▽
│ ╭─────────────┴──────╮
╰────────────────────────────┤replay/next/continue│
╰────────────────────╯


╰─────╯ ╰─┬───╯ ╰─┬──────────────┬─╯ │╰───┬───┬───┬─╯ ╰────╯
△ │ △ save │ │ △
│ ▽ │ │ ▽ │
│ ╭─┴──────────────┴─╮ │ ├───┴──────────╮
│ │add words on error│ │ │toggle preview│
│ ╰──────────────────╯ │ ╰──────────────╯
│ │
│ ╭────────────────────╮ │
╰──────────┤replay/next/continue├─-◁────╯
╰────────────────────╯
```


### Start
The flow is started by calling one of the autoloaded commands:
- `speed-type-text`
Expand Down Expand Up @@ -229,8 +225,8 @@ To color the characters a overlay is used:

#### Text Properties:
- speed-type-orig-pos: Used for "continue" and add new words
- car: start
- cdr: end
- car: start of word
- cdr: end of word
- speed-type-char-status: Used to ignore characters and determine complete
- ignore
- correct
Expand Down Expand Up @@ -288,6 +284,14 @@ After setup is complete it kills the completed `speed-type-buffer` and
`speed-type-preview-buffer`. It may reuse the existing content-buffer
for the new speed-type session.

### Toggle Preview
Toggles the display of the preview buffer. It opens a little window
below the speed-type buffer.

If the preview buffer is already displayed, will delete the window.
The buffer stays open in the background until the speed-type buffer is
quit.

### Median Stats
Calculates and displays the median stats of various buffer-local vars
from current and previous speed-type sessions.
Expand Down
121 changes: 94 additions & 27 deletions speed-type.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ beginning."
:type 'boolean)

(defcustom speed-type-downcase nil
"Toggle downcasing of mistyped words."
"If t will downcase content."
:type 'boolean)

(defcustom speed-type-point-motion-on-error 'point-move
Expand Down Expand Up @@ -363,7 +363,8 @@ Median Non-consecutive errors: %d")
"d" #'speed-type--display-statistic
"r" #'speed-type-replay
"n" #'speed-type-play-next
"c" #'speed-type-play-continue)
"c" #'speed-type-play-continue
"t" #'speed-type-toggle-preview)

(defvar-keymap speed-type-mode-map
:doc "Keymap for `speed-type-mode'."
Expand Down Expand Up @@ -790,6 +791,9 @@ leave buffer in read-only mode."
(when (not (eq 'never speed-type-save-statistic-option))
(insert (format " [%s]isplay statistic\n"
(propertize "d" 'face 'highlight))))
(when (not (null speed-type-provide-preview-option))
(insert (format " [%s]oggle preview\n"
(propertize "t" 'face 'highlight))))
(when speed-type--go-next-fn
(insert (format " [%s]ext random sample\n"
(propertize "n" 'face 'highlight))))
Expand Down Expand Up @@ -1058,6 +1062,20 @@ If the length is uneven will return symbol `uneven'."
0)
'uneven))

(defun speed-type--check-same-str (a b)
"Return non-nil if A and B are identical or both whitespace.

Whitespace is determined using `char-syntax'."
(when (not (= (length a) (length b))) (user-error "A(%d) and B(%d) must be the same" a b))
(let ((still-correct t)
(i 0)
(length-a (length a)))
(while (and (< i length-a) still-correct)
(setq still-correct (speed-type--check-same i a b))
(setq i (1+ i)))
still-correct))


(defun speed-type--check-same (pos a b)
"Return non-nil if A[POS] and B[POS] are identical or both whitespace.

Expand All @@ -1081,6 +1099,24 @@ Whitespace is determined using `char-syntax'."
(eq q 'error))
(cl-decf speed-type--entries))))))

(defun speed-type-toggle-preview ()
"Toggle preview of speed-type session in `current-buffer'.

If preview is currently display in some window will delete that window.
Else if there is no such window, `split-window' and display the preview
in new window."
(interactive)
(unless (derived-mode-p 'speed-type-mode) (user-error "Not in a speed-type buffer: cannot open preview"))
(unless (and (boundp 'speed-type--preview-buffer) speed-type--preview-buffer) (user-error "Preview buffer not defined please configure `speed-type-provide-preview-option'"))
(let ((bw (get-buffer-window speed-type--preview-buffer)))
(if bw (delete-window bw)
(let ((sw (selected-window))
(pw (split-window nil 5 'above))
(buf (current-buffer)))
(set-window-buffer sw speed-type--preview-buffer)
(set-window-buffer pw buf)
(select-window pw)))))

(defun speed-type--display-statistic ()
"Display median values from current and past entries."
(interactive)
Expand Down Expand Up @@ -1180,6 +1216,52 @@ ENTRIES ERRORS NON-CONSECUTIVE-ERRORS CORRECTIONS SECONDS."
(speed-type--elapsed-time speed-type--time-register)))
(speed-type-display-menu))))

(defun speed-type-preview-buffer-insert (orig new new-last-pos face)
"Insert NEW at the end of preview-buffer and set given FACE as overlay.

ORIG is inserted below, when it doesn't match NEW.

POS is used to access the focused char.

NEW-LAST-POS is `point' in `current-buffer', it's used to determine if
movement-commands were used since last insert.

When `current-buffer' has no variable `speed-type--preview-buffer' with non-nil
value return nil."
(when (and (boundp 'speed-type--preview-buffer) speed-type--preview-buffer)
(with-current-buffer speed-type--preview-buffer
(unwind-protect
(save-excursion
(goto-char (point-min))
(end-of-line)
(when-let* ((win (get-buffer-window (current-buffer))))
(set-window-point win (point)))
(read-only-mode -1)
(when (and (not (= speed-type--last-position 0))
(> (abs (- new-last-pos speed-type--last-position)) 2))
(let ((point-movement-str (concat "[ " (symbol-name last-command) "(" (number-to-string speed-type--last-position) ") → (" (number-to-string (1- new-last-pos)) ") ]")))
(insert point-movement-str)
(let ((overlay (make-overlay (- (point) (length point-movement-str)) (point))))
(overlay-put overlay 'priority 1)
(overlay-put overlay 'face 'speed-type-info-face))))
(insert (string-replace "\t" "⇥" (string-replace " " "·" (string-replace "\n" "⏎" new))))
(let ((overlay (make-overlay (- (point) (length new)) (point))))
(overlay-put overlay 'priority 1)
(overlay-put overlay 'face face))
(setq-local speed-type--insert-position (point))
(when (not (speed-type--check-same-str orig new))
(let ((inhibit-message t))
(end-of-line)
(let ((cc (1- (current-column))))
(or (search-forward "\n" nil t 1) (insert "\n"))
(move-to-column cc t))
(insert (string-replace "\t" "⇥" (string-replace " " "·" (string-replace "\n" "⏎" orig))))
(let ((overlay (make-overlay (- (point) (length orig)) (point))))
(overlay-put overlay 'priority 1)
(overlay-put overlay 'face 'speed-type-correct-face))))
(setq-local speed-type--last-position new-last-pos))
(read-only-mode)))))

(defun speed-type--diff (orig new start end)
"Synchronise local buffer state with buffer-content by comparing ORIG and NEW.
ORIG is the original text. NEW is the new text.
Expand Down Expand Up @@ -1211,9 +1293,11 @@ END is a point where the check stops to scan for diff."
(speed-type-add-extra-words (+ (or speed-type-add-extra-words-on-error 0)
(or (and non-consecutive-error-p speed-type-add-extra-words-on-non-consecutive-errors) 0)))))
(cl-incf speed-type--entries)
(let ((overlay (make-overlay pos (1+ pos))))
(overlay-put overlay 'priority 1)
(overlay-put overlay 'face (if is-same 'speed-type-correct-face (if non-consecutive-error-p 'speed-type-error-face 'speed-type-consecutive-error-face))))))
(let ((f (if is-same 'speed-type-correct-face (if non-consecutive-error-p 'speed-type-error-face 'speed-type-consecutive-error-face))))
(let ((overlay (make-overlay pos (1+ pos))))
(overlay-put overlay 'priority 1)
(overlay-put overlay 'face f))
(speed-type-preview-buffer-insert (char-to-string (aref orig i)) (char-to-string (aref new i)) pos f))))
(if (or (eq speed-type-point-motion-on-error 'point-move)
(string= new "")
(not any-error))
Expand All @@ -1237,27 +1321,10 @@ are color coded and stats are gathered about the typing performance."
(if (< start (point-max))
(let* ((end (if (> end (point-max)) (point-max) end))
(orig (buffer-substring start end)))
(when speed-type--preview-buffer
(let ((new-last-pos start))
(with-current-buffer speed-type--preview-buffer
(unwind-protect
(save-excursion
(goto-char (point-max))
(when-let* ((win (get-buffer-window (current-buffer))))
(set-window-point win (point)))
(read-only-mode -1)
(when (and (not (= speed-type--last-position 0))
(> (abs (- new-last-pos speed-type--last-position)) 2))
(let ((point-movement-str (concat "[ " (symbol-name last-command) "(" (number-to-string speed-type--last-position) ") → (" (number-to-string (1- new-last-pos)) ") ]")))
(insert point-movement-str)
(let ((overlay (make-overlay (- (point) (length point-movement-str)) (point))))
(overlay-put overlay 'priority 1)
(overlay-put overlay 'face 'speed-type-info-face))))
(insert (cond ((eq this-command (key-binding (kbd "<deletechar>"))) "⌦")
((eq this-command (key-binding (kbd "DEL"))) "⌫")
(t (string-replace "\t" "⇥" (string-replace " " "·" (string-replace "\n" "⏎" new-text))))))
(setq-local speed-type--last-position new-last-pos))
(read-only-mode)))))
(when-let ((special-char (cond ((eq this-command (key-binding (kbd "<deletechar>"))) "->")
((eq this-command (key-binding (kbd "DEL"))) "<-")
(t nil))))
(speed-type-preview-buffer-insert special-char special-char start 'speed-type-info-face))
(when-let* ((overlay (and (equal new-text "")
(car (overlays-at end)))))
(move-overlay overlay (1- (overlay-end overlay)) (overlay-end overlay)) (current-buffer))
Expand Down Expand Up @@ -1380,7 +1447,7 @@ CALLBACK is called when the setup process has been completed."
(with-current-buffer speed-type--preview-buffer
(setq-local speed-type--buffer buf
speed-type--last-position 0
truncate-lines nil)
truncate-lines t)
(speed-type-mode)
(add-hook 'kill-buffer-hook #'speed-type--kill-preview-buffer-hook nil t)
(read-only-mode))
Expand Down
Loading
Loading