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.
40 ;; 0.0.1 add spray-set-margins
41 ;; 0.0.2 margin options, speed control, better quit
47 ;; * customizable vars
49 (defvar spray-wpm 400 "words/min")
50 (defvar spray-height 400 "height of characters")
51 (defvar spray-margin-top 1 "character margin at top of buffer. Characters are as big as spray text characters.")
52 (defvar spray-margin-left 0 "character margin at left of buffer. Characters are as big as spray text characters.")
54 (defvar spray-mode-map
55 (let ((km (make-sparse-keymap)))
56 (define-key km (kbd "SPC") 'spray-start/stop)
57 (define-key km (kbd "h") 'spray-backward-word)
58 (define-key km (kbd "l") 'spray-forward-word)
59 (define-key km (kbd "<left>") 'spray-backward-word)
60 (define-key km (kbd "<right>") 'spray-forward-word)
61 (define-key km (kbd "f") 'spray-faster)
62 (define-key km (kbd "s") 'spray-slower)
63 (define-key km (kbd "q") 'spray-quit)
64 (define-key km (kbd "<return>") 'spray-quit)
66 "keymap for spray-mode buffers")
70 (make-face 'spray-base-face)
71 (set-face-attribute 'spray-base-face nil
72 :background (face-background 'default)
73 :foreground (face-foreground 'default)
76 (make-face 'spray-accent-face)
77 (set-face-attribute 'spray-accent-face nil
79 :overline (face-foreground 'default)
80 :underline (face-foreground 'default)
85 (defvar spray--margin-string ""
86 "Currently not used.")
87 (defvar spray--base-overlay nil)
88 (defvar spray--accent-overlay nil)
89 (defvar spray--running nil)
90 (defvar spray--delay 0)
91 (defvar spray--saved-cursor-type nil)
92 (defvar spray--saved-buffer-face nil)
93 (defvar spray--saved-restriction nil)
94 (defvar spray--saved-smartparens-enabled nil)
96 ;; * utility functions
98 (defun spray-set-margins ()
99 "Setup spray--margin-string"
100 (setq spray--margin-string
101 (concat (make-string spray-margin-top 10) ;; 10 = ascii newline
102 (make-string spray-margin-left 32)))) ;; 32 = ascii space
107 (define-minor-mode spray-mode
110 :keymap spray-mode-map
112 (setq spray--base-overlay (make-overlay (point-min) (point-max))
113 spray--accent-overlay (make-overlay 0 0)
114 spray--saved-cursor-type cursor-type
115 spray--saved-restriction (and (buffer-narrowed-p)
116 (cons (point-min) (point-max)))
117 spray--saved-buffer-face (and (boundp 'buffer-face-mode)
119 buffer-face-mode-face)
120 spray--saved-smartparens-enabled (and (boundp 'smartparens-mode)
122 ;; smartparens wrapping of all letter binds can cause problems.
123 ;; for example, it can cause auto-complete to activate
124 (and spray--saved-smartparens-enabled (smartparens-mode -1))
125 (setq cursor-type nil)
126 (let ((buffer-face-mode-face `(:height ,spray-height)))
127 (buffer-face-mode 1))
128 (overlay-put spray--base-overlay 'priority 100)
129 (overlay-put spray--base-overlay 'face 'spray-base-face)
130 (overlay-put spray--accent-overlay 'priority 101)
131 (overlay-put spray--accent-overlay 'face 'spray-accent-face)
134 (and spray--saved-smartparens-enabled (smartparens-mode 1))
135 (setq cursor-type spray--saved-cursor-type)
136 (if spray--saved-restriction
137 (narrow-to-region (car spray--saved-restriction)
138 (cdr spray--saved-restriction))
140 (buffer-face-mode -1)
141 (if spray--saved-buffer-face
142 (let ((buffer-face-mode-face spray--saved-buffer-face))
143 (buffer-face-mode 1)))
144 (delete-overlay spray--base-overlay)
145 (delete-overlay spray--accent-overlay)
153 (defun spray--word-at-point ()
154 (skip-chars-backward "^\s\t\n")
156 (len (skip-chars-forward "^\s\t\n"))
158 (accent (+ beg (cl-case len
164 (setq spray--delay (+ (if (> len 9) 1 0)
165 (if (looking-at "\n[\s\t\n]") 3 0)
166 (cl-case (char-before)
170 (move-overlay spray--accent-overlay (1- accent) accent)
171 (move-overlay spray--base-overlay beg end)
173 (overlay-put spray--base-overlay 'before-string
174 (concat spray--margin-string
175 (make-string (- 5 (- accent beg)) ?\s)))
176 (narrow-to-region beg end)))
178 (defun spray--update ()
179 (cond ((not (zerop spray--delay))
180 (setq spray--delay (1- spray--delay))
181 (when (= spray--delay 2)
182 (narrow-to-region (point) (point))))
187 (skip-chars-forward "\s\t\n")
188 (spray--word-at-point)))))
190 ;; * interactive commands
192 (defun spray-start/stop ()
193 "Toggle pause/unpause spray."
195 (or (spray-stop) (spray-start)))
199 Returns t if spray was unpaused."
201 (prog1 spray--running
203 (cancel-timer spray--running)
204 (setq spray--running nil))))
206 (defun spray-start ()
207 "Start / resume spray."
210 (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update)))
213 (defun spray-forward-word ()
217 (skip-chars-forward "\s\t\n")
218 (spray--word-at-point))
220 (defun spray-backward-word ()
224 (skip-chars-backward "^\s\t\n")
225 (skip-chars-backward "\s\t\n")
226 (spray--word-at-point))
228 (defun spray-faster ()
231 Increases the wpm (words per minute) parameter. See the variable
236 (defun spray-slower ()
239 Decreases the wpm (words per minute) parameter. See the variable
244 (defun spray-inc-wpm (delta)
245 (let ((was-running spray--running))
247 (when (< 10 (+ spray-wpm delta))
248 (setq spray-wpm (+ spray-wpm delta)))
249 (and was-running (spray-backward-word))
250 (message "spray wpm: %d" spray-wpm)
258 ;;; spray.el ends here