1 ;;; spray.el --- a speed reading mode
3 ;; Copyright (C) 2014 zk_phi
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.
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.
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
20 ;; URL: http://hins11.yu-yake.com/
21 ;; Author: Ian Kelling <ian@iankelling.org>
26 ;; Put this script into a "load-path"ed directory, and load it in your
31 ;; Then you may run spray with "M-x spray-mode". Binding some keys may
34 ;; (global-set-key (kbd "<f6>") 'spray-mode)
36 ;; For more informations, see Readme.org.
39 ;; repeated words are indistinguishable, for example
40 ;; "going, going, gone" reads like going, gone, with a slight delay.
44 ;; 0.0.1 add spray-set-margins
45 ;; 0.0.2 margin options, speed control, better quit
51 ;; * customizable vars
53 (defvar spray-wpm 400 "words/min")
54 (defvar spray-height 400 "height of characters")
55 (defvar spray-margin-top 1 "character margin at top of buffer. Characters are as big as spray text characters.")
56 (defvar spray-margin-left 1 "character margin at left of buffer. Characters are as big as spray text characters.")
58 (defvar spray-mode-map
59 (let ((km (make-sparse-keymap)))
60 (define-key km (kbd "SPC") 'spray-start/stop)
61 (define-key km (kbd "h") 'spray-backward-word)
62 (define-key km (kbd "l") 'spray-forward-word)
63 (define-key km (kbd "<left>") 'spray-backward-word)
64 (define-key km (kbd "<right>") 'spray-forward-word)
65 (define-key km (kbd "f") 'spray-faster)
66 (define-key km (kbd "s") 'spray-slower)
67 (define-key km (kbd "q") 'spray-quit)
68 (define-key km (kbd "<return>") 'spray-quit)
70 "keymap for spray-mode buffers")
74 (make-face 'spray-base-face)
75 (set-face-attribute 'spray-base-face nil
76 :background (face-background 'default)
77 :foreground (face-foreground 'default)
80 (make-face 'spray-accent-face)
81 (set-face-attribute 'spray-accent-face nil
83 :overline (face-foreground 'default)
84 :underline (face-foreground 'default)
89 (defvar spray--margin-string ""
90 "Currently not used.")
91 (defvar spray--base-overlay nil)
92 (defvar spray--accent-overlay nil)
93 (defvar spray--running nil)
94 (defvar spray--delay 0)
95 (defvar spray--saved-cursor-type nil)
96 (defvar spray--saved-buffer-face nil)
97 (defvar spray--saved-restriction nil)
98 (defvar spray--saved-smartparens-enabled nil)
100 ;; * utility functions
102 (defun spray-set-margins ()
103 "Setup spray--margin-string"
104 (setq spray--margin-string
105 (concat (make-string spray-margin-top 10) ;; 10 = ascii newline
106 (make-string spray-margin-left 32)))) ;; 32 = ascii space
111 (define-minor-mode spray-mode
114 :keymap spray-mode-map
116 (setq spray--base-overlay (make-overlay (point-min) (point-max))
117 spray--accent-overlay (make-overlay 0 0)
118 spray--saved-cursor-type cursor-type
119 spray--saved-restriction (and (buffer-narrowed-p)
120 (cons (point-min) (point-max)))
121 spray--saved-buffer-face (and (boundp 'buffer-face-mode)
123 buffer-face-mode-face)
124 spray--saved-smartparens-enabled (and (boundp 'smartparens-mode)
126 spray--saved-highlight-symbol-enabled (and (boundp 'highlight-symbol-mode)
127 highlight-symbol-mode))
128 ;; smartparens wrapping of all letter binds can cause problems.
129 ;; for example, it can cause auto-complete to activate
130 (and spray--saved-smartparens-enabled (smartparens-mode -1))
131 (and spray--saved-highlight-symbol-enabled (highlight-symbol-mode -1))
132 (setq cursor-type nil)
133 (let ((buffer-face-mode-face `(:height ,spray-height)))
134 (buffer-face-mode 1))
135 (overlay-put spray--base-overlay 'priority 100)
136 (overlay-put spray--base-overlay 'face 'spray-base-face)
137 (overlay-put spray--accent-overlay 'priority 101)
138 (overlay-put spray--accent-overlay 'face 'spray-accent-face)
141 (and spray--saved-smartparens-enabled (smartparens-mode 1))
142 (and spray--saved-highlight-symbol-enabled (highlight-symbol-mode 1))
143 (setq cursor-type spray--saved-cursor-type)
144 (if spray--saved-restriction
145 (narrow-to-region (car spray--saved-restriction)
146 (cdr spray--saved-restriction))
148 (buffer-face-mode -1)
149 (if spray--saved-buffer-face
150 (let ((buffer-face-mode-face spray--saved-buffer-face))
151 (buffer-face-mode 1)))
152 (delete-overlay spray--base-overlay)
153 (delete-overlay spray--accent-overlay)
161 (defun spray--word-at-point ()
162 (skip-chars-backward "^\s\t\n")
164 (len (skip-chars-forward "^\s\t\n"))
166 (accent (+ beg (cl-case len
172 ;; this fairly obfuscated, using magic numbers to store state
173 ;; it would be nice to sometime patch this so it is more readable.
174 ;; for greater than 9 length, we display for twice as long
175 ;; for some punctuation, we display a blank
176 (setq spray--delay (+ (if (> len 9) 1 0)
177 (if (looking-at "\n[\s\t\n]") 3 0)
178 (cl-case (char-before)
182 (move-overlay spray--accent-overlay (1- accent) accent)
183 (move-overlay spray--base-overlay beg end)
185 (overlay-put spray--base-overlay 'before-string
186 (concat spray--margin-string
187 (make-string (- 5 (- accent beg)) ?\s)))
188 (narrow-to-region beg end)))
190 (defun spray--update ()
191 (cond ((not (zerop spray--delay))
192 (setq spray--delay (1- spray--delay))
193 (when (= spray--delay 2)
194 (narrow-to-region (point) (point))))
199 (skip-chars-forward "\s\t\n")
200 (spray--word-at-point)))))
202 ;; * interactive commands
204 (defun spray-start/stop ()
205 "Toggle pause/unpause spray."
207 (or (spray-stop) (spray-start)))
211 Returns t if spray was unpaused."
213 (prog1 spray--running
215 (cancel-timer spray--running)
216 (setq spray--running nil))))
218 (defun spray-start ()
219 "Start / resume spray."
222 (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update)))
225 (defun spray-forward-word ()
229 (skip-chars-forward "\s\t\n")
230 (spray--word-at-point))
232 (defun spray-backward-word ()
236 (skip-chars-backward "^\s\t\n")
237 (skip-chars-backward "\s\t\n")
238 (spray--word-at-point))
240 (defun spray-faster ()
243 Increases the wpm (words per minute) parameter. See the variable
248 (defun spray-slower ()
251 Decreases the wpm (words per minute) parameter. See the variable
256 (defun spray-inc-wpm (delta)
257 (let ((was-running spray--running))
259 (when (< 10 (+ spray-wpm delta))
260 (setq spray-wpm (+ spray-wpm delta)))
261 (and was-running (spray-backward-word))
262 (message "spray wpm: %d" spray-wpm)
270 ;;; spray.el ends here