iankelling.org Git - spray/blob - spray.el

   1 ;;; spray.el --- a speed reading mode
   2
   3 ;; Copyright (C) 2014 zk_phi
   4
   5 ;; This program is free software; you can redistribute it and/or modify
   6 ;; it under the terms of the GNU General Public License as published by
   7 ;; the Free Software Foundation; either version 2 of the License, or
   8 ;; (at your option) any later version.
   9 ;;
  10 ;; This program is distributed in the hope that it will be useful,
  11 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 ;; GNU General Public License for more details.
  14 ;;
  15 ;; You should have received a copy of the GNU General Public License
  16 ;; along with this program; if not, write to the Free Software
  17 ;; Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18
  19 ;; Author: zk_phi
  20 ;; URL: http://hins11.yu-yake.com/
  21 ;; Author: Ian Kelling <ian@iankelling.org>
  22 ;; Version: 0.0.2
  23
  24 ;;; Commentary:
  25
  26 ;; Put this script into a "load-path"ed directory, and load it in your
  27 ;; init file.
  28 ;;
  29 ;;   (require 'spray)
  30 ;;
  31 ;; Then you may run spray with "M-x spray-mode". Binding some keys may
  32 ;; also be useful.
  33 ;;
  34 ;;   (global-set-key (kbd "<f6>") 'spray-mode)
  35 ;;
  36 ;; For more informations, see Readme.org.
  37
  38 ;; Known bugs.
  39 ;; repeated words are indistinguishable, for example
  40 ;; "going, going, gone" reads like going, gone, with a slight delay.
  41 ;;
  42 ;; sentences (like this) should trigger a pause for ( and )
  43
  44 ;;; Change Log:
  45 ;; 0.0.0 test release
  46 ;; 0.0.1 add spray-set-margins
  47 ;; 0.0.2 margin options, speed control, better quit
  48
  49 ;;; Code:
  50
  51 (require 'face-remap)
  52
  53 ;; * customizable vars
  54
  55 (defvar spray-wpm 400 "words/min")
  56 (defvar spray-height 400 "height of characters")
  57 (defvar spray-margin-top 1 "character margin at top of buffer. Characters are as big as spray text characters.")
  58 (defvar spray-margin-left 1 "character margin at left of buffer. Characters are as big as spray text characters.")
  59 (defvar spray-ramp 2
  60   "Ramp up to full speed. Pause for this multiple of wpm on the first word,
  61 decreasing by one for each subsequent word.")
  62
  63 (defvar spray-mode-map
  64   (let ((km (make-sparse-keymap)))
  65     (define-key km (kbd "SPC") 'spray-start/stop)
  66     (define-key km (kbd "h") 'spray-backward-word)
  67     (define-key km (kbd "l") 'spray-forward-word)
  68     (define-key km (kbd "<left>") 'spray-backward-word)
  69     (define-key km (kbd "<right>") 'spray-forward-word)
  70     (define-key km (kbd "f") 'spray-faster)
  71     (define-key km (kbd "s") 'spray-slower)
  72     (define-key km (kbd "q") 'spray-quit)
  73     (define-key km (kbd "<return>") 'spray-quit)
  74     km)
  75   "keymap for spray-mode buffers")
  76
  77 ;; * faces
  78
  79 (make-face 'spray-base-face)
  80 (set-face-attribute 'spray-base-face nil
  81                     :background (face-background 'default)
  82                     :foreground (face-foreground 'default)
  83                     :slant 'normal)
  84
  85 (make-face 'spray-accent-face)
  86 (set-face-attribute 'spray-accent-face nil
  87                     :foreground "red"
  88                     :overline (face-foreground 'default)
  89                     :underline (face-foreground 'default)
  90                     :slant 'normal)
  91
  92 ;; * internal vars
  93
  94 (defvar spray--margin-string ""
  95   "Currently not used.")
  96 (defvar spray--base-overlay nil)
  97 (defvar spray--accent-overlay nil)
  98 (defvar spray--running nil)
  99 (defvar spray--first-words 0)
 100 (defvar spray--initial-delay 0)
 101 (defvar spray--delay 0)
 102 (defvar spray--saved-cursor-type nil)
 103 (defvar spray--saved-buffer-face nil)
 104 (defvar spray--saved-restriction nil)
 105 (defvar spray--saved-smartparens-enabled nil)
 106
 107 ;; * utility functions
 108
 109 (defun spray-set-margins ()
 110   "Setup spray--margin-string"
 111   (setq spray--margin-string
 112         (concat (make-string spray-margin-top 10) ;; 10 = ascii newline
 113                 (make-string spray-margin-left 32)))) ;; 32 = ascii space
 114
 115 ;; * the mode
 116
 117 ;;;###autoload
 118 (define-minor-mode spray-mode
 119   "spray mode"
 120   :init nil
 121   :keymap spray-mode-map
 122   (cond (spray-mode
 123          (setq spray--base-overlay (make-overlay (point-min) (point-max))
 124                spray--accent-overlay (make-overlay 0 0)
 125                spray--saved-cursor-type cursor-type
 126                spray--saved-restriction (and (buffer-narrowed-p)
 127                                              (cons (point-min) (point-max)))
 128                spray--saved-buffer-face (and (boundp 'buffer-face-mode)
 129                                              buffer-face-mode
 130                                              buffer-face-mode-face)
 131                spray--saved-smartparens-enabled (and (boundp 'smartparens-mode)
 132                                                      smartparens-mode)
 133                spray--saved-highlight-symbol-enabled (and (boundp 'highlight-symbol-mode)
 134                                                      highlight-symbol-mode))
 135          ;; smartparens wrapping of all letter binds can cause problems.
 136          ;; for example, it can cause auto-complete to activate
 137          (and spray--saved-smartparens-enabled (smartparens-mode -1))
 138          (and spray--saved-highlight-symbol-enabled (highlight-symbol-mode -1))
 139          (setq cursor-type nil)
 140          (let ((buffer-face-mode-face `(:height ,spray-height)))
 141            (buffer-face-mode 1))
 142          (overlay-put spray--base-overlay 'priority 100)
 143          (overlay-put spray--base-overlay 'face 'spray-base-face)
 144          (overlay-put spray--accent-overlay 'priority 101)
 145          (overlay-put spray--accent-overlay 'face 'spray-accent-face)
 146          (spray-start))
 147         (t
 148          (and spray--saved-smartparens-enabled (smartparens-mode 1))
 149          (and spray--saved-highlight-symbol-enabled (highlight-symbol-mode 1))
 150          (setq cursor-type spray--saved-cursor-type)
 151          (if spray--saved-restriction
 152              (narrow-to-region (car spray--saved-restriction)
 153                                (cdr spray--saved-restriction))
 154            (widen))
 155          (buffer-face-mode -1)
 156          (if spray--saved-buffer-face
 157              (let ((buffer-face-mode-face spray--saved-buffer-face))
 158                (buffer-face-mode 1)))
 159          (delete-overlay spray--base-overlay)
 160          (delete-overlay spray--accent-overlay)
 161          (spray-stop))))
 162
 163 (defun spray-quit ()
 164   "Exit spray mode."
 165   (interactive)
 166   (spray-mode -1))
 167
 168 (defun spray--word-at-point ()
 169   (skip-chars-backward "^\s\t\n—")
 170   (let* ((beg (point))
 171          (len (+ (skip-chars-forward "^\s\t\n—") (skip-chars-forward "—")))
 172          (end (point))
 173          (accent (+ beg (cl-case len
 174                        ((1) 1)
 175                        ((2 3 4 5) 2)
 176                        ((6 7 8 9) 3)
 177                        ((10 11 12 13) 4)
 178                        (t 5)))))
 179     ;; this fairly obfuscated, using magic numbers to store state
 180     ;; it would be nice to sometime patch this so it is more readable.
 181     ;; for greater than 9 length, we display for twice as long
 182     ;; for some punctuation, we display a blank
 183     (setq spray--delay (+ (if (> len 9) 1 0)
 184                           (if (looking-at "\n[\s\t\n]") 3 0)
 185                           (cl-case (char-before)
 186                             ((?. ?! ?\? ?\;) 3)
 187                             ((?, ?: ?—) 1)
 188                             (t 0))))
 189     (move-overlay spray--accent-overlay (1- accent) accent)
 190     (move-overlay spray--base-overlay beg end)
 191     (spray-set-margins)
 192     (overlay-put spray--base-overlay 'before-string
 193                  (concat spray--margin-string
 194                          (make-string (- 5 (- accent beg)) ?\s)))
 195     (narrow-to-region beg end)))
 196
 197
 198 (defun spray--update ()
 199   (cond ((not (zerop spray--initial-delay))
 200          (setq spray--initial-delay (1- spray--initial-delay)))
 201         ((not (zerop spray--delay))
 202          (setq spray--delay (1- spray--delay))
 203          (when (= spray--delay 2)
 204            (narrow-to-region (point) (point))))
 205         (t
 206          (widen)
 207          (if (eobp)
 208              (spray-mode -1)
 209            (when (not (zerop spray--first-words))
 210              (setq spray--initial-delay spray--first-words)
 211              (setq spray--first-words (1- spray--first-words)))
 212            (skip-chars-forward "\s\t\n—")
 213            (spray--word-at-point)))))
 214
 215 ;; * interactive commands
 216
 217 (defun spray-start/stop ()
 218   "Toggle pause/unpause spray."
 219   (interactive)
 220   (or (spray-stop) (spray-start)))
 221
 222 (defun spray-stop ()
 223   "Pause spray.
 224 Returns t if spray was unpaused."
 225   (interactive)
 226   (prog1 spray--running
 227     (when spray--running
 228       (cancel-timer spray--running)
 229       (setq spray--running nil))))
 230
 231 (defun spray-start ()
 232   "Start / resume spray."
 233   (interactive)
 234   (setq spray--first-words spray-ramp)
 235   (setq spray--running
 236         (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update)))
 237
 238
 239 (defun spray-forward-word ()
 240   (interactive)
 241   (spray-stop)
 242   (widen)
 243   (skip-chars-forward "\s\t\n—")
 244   (spray--word-at-point))
 245
 246 (defun spray-backward-word ()
 247   (interactive)
 248   (spray-stop)
 249   (widen)
 250   (skip-chars-backward "^\s\t\n—")
 251   (skip-chars-backward "\s\t\n—")
 252   (spray--word-at-point))
 253
 254 (defun spray-faster ()
 255   "Increases speed.
 256
 257 Increases the wpm (words per minute) parameter. See the variable
 258 `spray-wmp'."
 259   (interactive)
 260   (spray-inc-wpm 20))
 261
 262 (defun spray-slower ()
 263   "Decreases speed.
 264
 265 Decreases the wpm (words per minute) parameter. See the variable
 266 `spray-wmp'."
 267   (interactive)
 268   (spray-inc-wpm -20))
 269
 270 (defun spray-inc-wpm (delta)
 271   (let ((was-running spray--running))
 272     (spray-stop)
 273     (when (< 10 (+ spray-wpm delta))
 274       (setq spray-wpm (+ spray-wpm delta)))
 275     (and was-running (spray-backward-word))
 276     (message "spray wpm: %d" spray-wpm)
 277     (when was-running
 278       (spray-start))))
 279
 280 ;; * provide
 281
 282 (provide 'spray)
 283
 284 ;;; spray.el ends here