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

   1 ;;; cedit.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.1
  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 ;;; Change Log:
  39 ;; 0.0.0 test release
  40 ;; 0.0.1 add spray-set-margins
  41
  42 ;;; Code:
  43
  44 (require 'face-remap)
  45
  46 ;; * customizable vars
  47
  48 (defvar spray-wpm 400 "words/min")
  49 (defvar spray-height 400 "height of characters")
  50
  51 (defvar spray-mode-map
  52   (let ((km (make-sparse-keymap)))
  53     (define-key km (kbd "SPC") 'spray-start/stop)
  54     (define-key km (kbd "h") 'spray-backward-word)
  55     (define-key km (kbd "l") 'spray-forward-word)
  56     (define-key km (kbd "<left>") 'spray-backward-word)
  57     (define-key km (kbd "<right>") 'spray-forward-word)
  58     (define-key km (kbd "f") 'spray-faster)
  59     (define-key km (kbd "q") 'spray-quit)
  60     (define-key km (kbd "<return>") 'spray-quit)
  61     km)
  62   "keymap for spray-mode buffers")
  63
  64 ;; * faces
  65
  66 (make-face 'spray-base-face)
  67 (set-face-attribute 'spray-base-face nil
  68                     :background (face-background 'default)
  69                     :foreground (face-foreground 'default)
  70                     :slant 'normal)
  71
  72 (make-face 'spray-orp-face)
  73 (set-face-attribute 'spray-orp-face nil
  74                     :foreground "red"
  75                     :overline (face-foreground 'default)
  76                     :underline (face-foreground 'default)
  77                     :slant 'normal)
  78
  79 ;; * internal vars
  80
  81 (defvar spray--margin-string ""
  82   "Currently not used.")
  83 (defvar spray--base-overlay nil)
  84 (defvar spray--orp-overlay nil)
  85 (defvar spray--running nil)
  86 (defvar spray--delay 0)
  87 (defvar spray--saved-cursor-type nil)
  88 (defvar spray--saved-buffer-face nil)
  89 (defvar spray--saved-restriction nil)
  90
  91 ;; * utility functions
  92
  93 (defun spray-set-margins (left above)
  94   "Currently broken & not used:
  95 add margins before/above the spray text. each arguments can be
  96 an integer or a float value."
  97   (setq spray--margin-string
  98         (propertize " " 'display `((space-width ,left) (height ,(+ 1 above))))))
  99
 100 ;; * the mode
 101
 102 ;;;###autoload
 103 (define-minor-mode spray-mode
 104   "spray mode"
 105   :init nil
 106   :keymap spray-mode-map
 107   (cond (spray-mode
 108          (setq spray--base-overlay (make-overlay (point-min) (point-max))
 109                spray--orp-overlay (make-overlay 0 0)
 110                spray--saved-cursor-type cursor-type
 111                spray--saved-restriction (and (buffer-narrowed-p)
 112                                              (cons (point-min) (point-max)))
 113                spray--saved-buffer-face (and (boundp 'buffer-face-mode)
 114                                              buffer-face-mode
 115                                              buffer-face-mode-face))
 116          (setq cursor-type nil)
 117          (let ((buffer-face-mode-face `(:height ,spray-height)))
 118            (buffer-face-mode 1))
 119          (overlay-put spray--base-overlay 'priority 100)
 120          (overlay-put spray--base-overlay 'face 'spray-base-face)
 121          (overlay-put spray--orp-overlay 'priority 101)
 122          (overlay-put spray--orp-overlay 'face 'spray-orp-face)
 123          (add-hook 'pre-command-hook 'spray--pre-command-handler)
 124          (spray-start))
 125         (t
 126          (setq cursor-type spray--saved-cursor-type)
 127          (if spray--saved-restriction
 128              (narrow-to-region (car spray--saved-restriction)
 129                                (cdr spray--saved-restriction))
 130            (widen))
 131          (buffer-face-mode -1)
 132          (if spray--saved-buffer-face
 133              (let ((buffer-face-mode-face spray--saved-buffer-face))
 134                (buffer-face-mode 1)))
 135          (delete-overlay spray--base-overlay)
 136          (delete-overlay spray--orp-overlay)
 137          (remove-hook 'pre-command-hook 'spray--pre-command-handler)
 138          (spray-stop))))
 139
 140 (defun spray-quit ()
 141   "Exit spray mode."
 142   (interactive)
 143   (spray-mode -1))
 144
 145 (defun spray--pre-command-handler ()
 146   (unless (string-match "^spray-" (symbol-name this-command))
 147     (spray-mode -1)))
 148
 149 (defun spray--word-at-point ()
 150   (skip-chars-backward "^\s\t\n")
 151   (let* ((beg (point))
 152          (len (skip-chars-forward "^\s\t\n"))
 153          (end (point))
 154          (orp (+ beg (cl-case len
 155                        ((1) 1)
 156                        ((2 3 4 5) 2)
 157                        ((6 7 8 9) 3)
 158                        ((10 11 12 13) 4)
 159                        (t 5)))))
 160     (setq spray--delay (+ (if (> len 9) 1 0)
 161                           (if (looking-at "\n[\s\t\n]") 3 0)
 162                           (cl-case (char-before)
 163                             ((?. ?! ?\? ?\;) 3)
 164                             ((?, ?:) 1)
 165                             (t 0))))
 166     (move-overlay spray--orp-overlay (1- orp) orp)
 167     (move-overlay spray--base-overlay beg end)
 168     (overlay-put spray--base-overlay 'before-string
 169                  (concat spray--margin-string
 170                          (make-string (- 5 (- orp beg)) ?\s)))
 171     (narrow-to-region beg end)))
 172
 173 (defun spray--update ()
 174   (cond ((not (zerop spray--delay))
 175          (setq spray--delay (1- spray--delay))
 176          (when (= spray--delay 2)
 177            (narrow-to-region (point) (point))))
 178         (t
 179          (widen)
 180          (if (eobp)
 181              (spray-mode -1)
 182            (skip-chars-forward "\s\t\n")
 183            (spray--word-at-point)))))
 184
 185 ;; * interactive commands
 186
 187 (defun spray-start/stop ()
 188   "Toggle pause/unpause spray."
 189   (interactive)
 190   (or (spray-stop) (spray-start)))
 191
 192 (defun spray-stop ()
 193   "Pause spray.
 194 Returns t if spray was unpaused."
 195   (interactive)
 196   (prog1 spray--running
 197     (when spray--running
 198       (cancel-timer spray--running)
 199       (setq spray--running nil))))
 200
 201 (defun spray-start ()
 202   "Start / resume spray."
 203   (interactive)
 204   (setq spray--running
 205         (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update)))
 206
 207
 208 (defun spray-forward-word ()
 209   (interactive)
 210   (spray-stop)
 211   (widen)
 212   (skip-chars-forward "\s\t\n")
 213   (spray--word-at-point))
 214
 215 (defun spray-backward-word ()
 216   (interactive)
 217   (spray-stop)
 218   (widen)
 219   (skip-chars-backward "^\s\t\n")
 220   (skip-chars-backward "\s\t\n")
 221   (spray--word-at-point))
 222
 223 (defun spray-faster ()
 224   "Increases speed.
 225
 226 Increases the wpm (words per minute) parameter. See the variable
 227 `spray-wmp'."
 228   (interactive)
 229   (spray-inc-wpm 20))
 230
 231 (defun spray-slower ()
 232   "Decreases speed.
 233
 234 Decreases the wpm (words per minute) parameter. See the variable
 235 `spray-wmp'."
 236   (interactive)
 237   (spray-inc-wpm -20))
 238
 239 (defun spray-inc-wpm (delta)
 240   (let ((was-running spray--running))
 241     (spray-stop)
 242     (when (< 10 (+ spray-wpm delta))
 243       (setq spray-wpm (+ spray-wpm delta)))
 244     (and was-running (spray-backward-word))
 245     (message "spray wpm: %d" spray-wpm)
 246     (when was-running
 247       (spray-start))))
 248
 249 ;; * provide
 250
 251 (provide 'spray)
 252
 253 ;;; spray.el ends here