X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=spray.el;h=95951ca2d05ab9c4b8dca6e624e0c4143c1643ab;hb=396e2e3c4ded4b9d13b038af9a6285c6b68867ff;hp=76e4e36159ea55a6aa8538455adb8a16136f87ed;hpb=75f317ce2611178f4532e535638294c3f48cc552;p=spray diff --git a/spray.el b/spray.el index 76e4e36..95951ca 100644 --- a/spray.el +++ b/spray.el @@ -1,4 +1,4 @@ -;;; cedit.el --- a speed reading mode +;;; spray.el --- a speed reading mode ;; Copyright (C) 2014 zk_phi @@ -19,7 +19,7 @@ ;; Author: zk_phi ;; URL: http://hins11.yu-yake.com/ ;; Author: Ian Kelling -;; Version: 0.0.1 +;; Version: 0.0.2 ;;; Commentary: @@ -35,9 +35,16 @@ ;; ;; For more informations, see Readme.org. +;; Known bugs. +;; repeated words are indistinguishable, for example +;; "going, going, gone" reads like going, gone, with a slight delay. +;; +;; sentences (like this) should trigger a pause for ( and ) + ;;; Change Log: ;; 0.0.0 test release ;; 0.0.1 add spray-set-margins +;; 0.0.2 margin options, speed control, better quit ;;; Code: @@ -45,10 +52,23 @@ ;; * customizable vars -(defvar spray-wpm 400 "words/min") -(defvar spray-height 400 "height of characters") -(defvar spray-margin-top 1 "character margin at top of buffer. Characters are as big as spray text characters.") -(defvar spray-margin-left 0 "character margin at left of buffer. Characters are as big as spray text characters.") +(defvar spray-wpm 400 + "words/min") + +(defvar spray-height 400 + "height of characters") + +(defvar spray-margin-top 1 + "character margin at top of buffer. Characters are as big as + spray text characters.") + +(defvar spray-margin-left 1 + "character margin at left of buffer. Characters are as big as + spray text characters.") + +(defvar spray-ramp 2 + "Ramp up to full speed. Pause for this multiple of wpm on the first word, +decreasing by one for each subsequent word.") (defvar spray-mode-map (let ((km (make-sparse-keymap))) @@ -58,37 +78,43 @@ (define-key km (kbd "") 'spray-backward-word) (define-key km (kbd "") 'spray-forward-word) (define-key km (kbd "f") 'spray-faster) + (define-key km (kbd "s") 'spray-slower) (define-key km (kbd "q") 'spray-quit) (define-key km (kbd "") 'spray-quit) + (define-key km [remap forward-char] 'spray-forward-word) + (define-key km [remap backward-char] 'spray-backward-word) + (define-key km [remap forward-word] 'spray-forward-word) + (define-key km [remap backward-word] 'spray-backward-word) + (define-key km [remap keyboard-quit] 'spray-quit) km) "keymap for spray-mode buffers") +(defvar spray-unsupported-minor-modes + '(buffer-face-mode smartparens-mode highlight-symbol-mode)) + ;; * faces (make-face 'spray-base-face) (set-face-attribute 'spray-base-face nil - :background (face-background 'default) - :foreground (face-foreground 'default) - :slant 'normal) + :inherit 'default) -(make-face 'spray-orp-face) -(set-face-attribute 'spray-orp-face nil - :foreground "red" - :overline (face-foreground 'default) - :underline (face-foreground 'default) - :slant 'normal) +(make-face 'spray-accent-face) +(set-face-attribute 'spray-accent-face nil + :inherit 'spray-base-face + :foreground "red") ;; * internal vars -(defvar spray--margin-string "" - "Currently not used.") +(defvar spray--margin-string "") (defvar spray--base-overlay nil) -(defvar spray--orp-overlay nil) +(defvar spray--accent-overlay nil) (defvar spray--running nil) +(defvar spray--first-words 0) +(defvar spray--initial-delay 0) (defvar spray--delay 0) (defvar spray--saved-cursor-type nil) -(defvar spray--saved-buffer-face nil) (defvar spray--saved-restriction nil) +(defvar spray--saved-minor-modes nil) ;; * utility functions @@ -107,34 +133,35 @@ :keymap spray-mode-map (cond (spray-mode (setq spray--base-overlay (make-overlay (point-min) (point-max)) - spray--orp-overlay (make-overlay 0 0) + spray--accent-overlay (make-overlay 0 0) spray--saved-cursor-type cursor-type spray--saved-restriction (and (buffer-narrowed-p) - (cons (point-min) (point-max))) - spray--saved-buffer-face (and (boundp 'buffer-face-mode) - buffer-face-mode - buffer-face-mode-face)) + (cons (point-min) (point-max)))) + (dolist (mode spray-unsupported-minor-modes) + (when (and (boundp mode) (eval mode)) + (funcall mode -1) + (push mode spray--saved-minor-modes))) (setq cursor-type nil) (let ((buffer-face-mode-face `(:height ,spray-height))) (buffer-face-mode 1)) (overlay-put spray--base-overlay 'priority 100) (overlay-put spray--base-overlay 'face 'spray-base-face) - (overlay-put spray--orp-overlay 'priority 101) - (overlay-put spray--orp-overlay 'face 'spray-orp-face) + (overlay-put spray--accent-overlay 'priority 101) + (overlay-put spray--accent-overlay 'face 'spray-accent-face) (spray-start)) (t - (setq cursor-type spray--saved-cursor-type) + (spray-stop) + (delete-overlay spray--accent-overlay) + (delete-overlay spray--base-overlay) + (buffer-face-mode -1) (if spray--saved-restriction (narrow-to-region (car spray--saved-restriction) (cdr spray--saved-restriction)) (widen)) - (buffer-face-mode -1) - (if spray--saved-buffer-face - (let ((buffer-face-mode-face spray--saved-buffer-face)) - (buffer-face-mode 1))) - (delete-overlay spray--base-overlay) - (delete-overlay spray--orp-overlay) - (spray-stop)))) + (setq cursor-type spray--saved-cursor-type) + (dolist (mode spray--saved-minor-modes) + (funcall mode 1)) + (setq spray--saved-minor-modes nil)))) (defun spray-quit () "Exit spray mode." @@ -142,32 +169,38 @@ (spray-mode -1)) (defun spray--word-at-point () - (skip-chars-backward "^\s\t\n") + (skip-chars-backward "^\s\t\n—") (let* ((beg (point)) - (len (skip-chars-forward "^\s\t\n")) + (len (+ (skip-chars-forward "^\s\t\n—") (skip-chars-forward "—"))) (end (point)) - (orp (+ beg (cl-case len + (accent (+ beg (cl-case len ((1) 1) ((2 3 4 5) 2) ((6 7 8 9) 3) ((10 11 12 13) 4) (t 5))))) + ;; this fairly obfuscated, using magic numbers to store state + ;; it would be nice to sometime patch this so it is more readable. + ;; for greater than 9 length, we display for twice as long + ;; for some punctuation, we display a blank (setq spray--delay (+ (if (> len 9) 1 0) (if (looking-at "\n[\s\t\n]") 3 0) (cl-case (char-before) ((?. ?! ?\? ?\;) 3) - ((?, ?:) 1) + ((?, ?: ?—) 1) (t 0)))) - (move-overlay spray--orp-overlay (1- orp) orp) + (move-overlay spray--accent-overlay (1- accent) accent) (move-overlay spray--base-overlay beg end) (spray-set-margins) (overlay-put spray--base-overlay 'before-string (concat spray--margin-string - (make-string (- 5 (- orp beg)) ?\s))) + (make-string (- 5 (- accent beg)) ?\s))) (narrow-to-region beg end))) (defun spray--update () - (cond ((not (zerop spray--delay)) + (cond ((not (zerop spray--initial-delay)) + (setq spray--initial-delay (1- spray--initial-delay))) + ((not (zerop spray--delay)) (setq spray--delay (1- spray--delay)) (when (= spray--delay 2) (narrow-to-region (point) (point)))) @@ -175,7 +208,10 @@ (widen) (if (eobp) (spray-mode -1) - (skip-chars-forward "\s\t\n") + (when (not (zerop spray--first-words)) + (setq spray--initial-delay spray--first-words) + (setq spray--first-words (1- spray--first-words))) + (skip-chars-forward "\s\t\n—") (spray--word-at-point))))) ;; * interactive commands @@ -197,30 +233,30 @@ Returns t if spray was unpaused." (defun spray-start () "Start / resume spray." (interactive) + (setq spray--first-words spray-ramp) (setq spray--running (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update))) - (defun spray-forward-word () (interactive) (spray-stop) (widen) - (skip-chars-forward "\s\t\n") + (skip-chars-forward "\s\t\n—") (spray--word-at-point)) (defun spray-backward-word () (interactive) (spray-stop) (widen) - (skip-chars-backward "^\s\t\n") - (skip-chars-backward "\s\t\n") + (skip-chars-backward "^\s\t\n—") + (skip-chars-backward "\s\t\n—") (spray--word-at-point)) (defun spray-faster () "Increases speed. Increases the wpm (words per minute) parameter. See the variable -`spray-wmp'." +`spray-wpm'." (interactive) (spray-inc-wpm 20)) @@ -228,7 +264,7 @@ Increases the wpm (words per minute) parameter. See the variable "Decreases speed. Decreases the wpm (words per minute) parameter. See the variable -`spray-wmp'." +`spray-wpm'." (interactive) (spray-inc-wpm -20))