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 ;; Version: 0.0.0
  22
  23 ;;; Commentary:
  24
  25 ;; Put this script into a "load-path"ed directory, and load it in your
  26 ;; init file.
  27 ;;
  28 ;;   (require 'spray)
  29 ;;
  30 ;; Then you may run spray with "M-x spray-mode". Binding some keys may
  31 ;; also be useful.
  32 ;;
  33 ;;   (global-set-key (kbd "<f6>") 'spray-mode)
  34 ;;
  35 ;; For more informations, see Readme.org.
  36
  37 ;;; Change Log:
  38 ;; 0.0.0 test release
  39
  40 ;;; Code:
  41
  42 (require 'face-remap)
  43
  44 ;; * customizable vars
  45
  46 (defvar spray-wpm 400 "words/min")
  47 (defvar spray-height 400 "height of characters")
  48
  49 (defvar spray-mode-map
  50   (let ((km (make-sparse-keymap)))
  51     (define-key km (kbd "SPC") 'spray-start/stop)
  52     (define-key km (kbd "h") 'spray-backward-word)
  53     (define-key km (kbd "l") 'spray-forward-word)
  54     (define-key km (kbd "<left>") 'spray-backward-word)
  55     (define-key km (kbd "<right>") 'spray-forward-word)
  56     km)
  57   "keymap for spray-mode buffers")
  58
  59 ;; * faces
  60
  61 (make-face 'spray-base-face)
  62 (set-face-attribute 'spray-base-face nil
  63                     :background (face-background 'default)
  64                     :foreground (face-foreground 'default))
  65
  66 (make-face 'spray-orp-face)
  67 (set-face-attribute 'spray-orp-face nil
  68                     :foreground "red"
  69                     :overline (face-foreground 'default)
  70                     :underline (face-foreground 'default))
  71
  72 ;; * internal vars
  73
  74 (defvar spray--base-overlay nil)
  75 (defvar spray--orp-overlay nil)
  76 (defvar spray--running nil)
  77 (defvar spray--delay 0)
  78 (defvar spray--saved-cursor-type nil)
  79 (defvar spray--saved-buffer-face nil)
  80 (defvar spray--saved-restriction nil)
  81
  82 ;; * the mode
  83
  84 ;;;###autoload
  85 (define-minor-mode spray-mode
  86   "spray mode"
  87   :init nil
  88   :keymap spray-mode-map
  89   (cond (spray-mode
  90          (setq spray--base-overlay (make-overlay (point-min) (point-max))
  91                spray--orp-overlay (make-overlay 0 0)
  92                spray--saved-cursor-type cursor-type
  93                spray--saved-restriction (and (buffer-narrowed-p)
  94                                              (cons (point-min) (point-max)))
  95                spray--saved-buffer-face (and (boundp 'buffer-face-mode)
  96                                              buffer-face-mode
  97                                              buffer-face-mode-face))
  98          (setq cursor-type nil)
  99          (let ((buffer-face-mode-face `(:height ,spray-height)))
 100            (buffer-face-mode 1))
 101          (overlay-put spray--base-overlay 'priority 100)
 102          (overlay-put spray--base-overlay 'face 'spray-base-face)
 103          (overlay-put spray--orp-overlay 'priority 101)
 104          (overlay-put spray--orp-overlay 'face 'spray-orp-face)
 105          (add-hook 'pre-command-hook 'spray--pre-command-handler)
 106          (spray-start/stop 1))
 107         (t
 108          (setq cursor-type spray--saved-cursor-type)
 109          (if spray--saved-restriction
 110              (narrow-to-region (car spray--saved-restriction)
 111                                (cdr spray--saved-restriction))
 112            (widen))
 113          (buffer-face-mode -1)
 114          (if spray--saved-buffer-face
 115              (let ((buffer-face-mode-face spray--saved-buffer-face))
 116                (buffer-face-mode 1)))
 117          (delete-overlay spray--base-overlay)
 118          (delete-overlay spray--orp-overlay)
 119          (remove-hook 'pre-command-hook 'spray--pre-command-handler)
 120          (spray-start/stop -1))))
 121
 122 (defun spray--pre-command-handler ()
 123   (unless (memq this-command
 124                 '(spray-forward-word spray-backward-word spray-start/stop))
 125     (spray-mode -1)))
 126
 127 (defun spray--word-at-point ()
 128   (skip-chars-backward "^\s\t\n")
 129   (let* ((beg (point))
 130          (len (skip-chars-forward "^\s\t\n"))
 131          (end (point))
 132          (orp (+ beg (cl-case len
 133                        ((1) 1)
 134                        ((2 3 4 5) 2)
 135                        ((6 7 8 9) 3)
 136                        ((10 11 12 13) 4)
 137                        (t 5)))))
 138     (setq spray--delay (+ (if (> len 9) 1 0)
 139                           (if (looking-at "\n[\s\t\n]") 3 0)
 140                           (cl-case (char-before)
 141                             ((?. ?! ?\? ?\;) 3)
 142                             ((?, ?:) 1)
 143                             (t 0))))
 144     (move-overlay spray--orp-overlay (1- orp) orp)
 145     (move-overlay spray--base-overlay beg end)
 146     (overlay-put spray--base-overlay
 147                  'before-string (make-string (- 5 (- orp beg)) ?\s))
 148     (narrow-to-region beg end)))
 149
 150 (defun spray--update ()
 151   (cond ((not (zerop spray--delay))
 152          (setq spray--delay (1- spray--delay))
 153          (when (= spray--delay 2)
 154            (narrow-to-region (point) (point))))
 155         (t
 156          (widen)
 157          (if (eobp)
 158              (spray-mode -1)
 159            (skip-chars-forward "\s\t\n")
 160            (spray--word-at-point)))))
 161
 162 ;; * interactive commands
 163
 164 (defun spray-start/stop (&optional switch)
 165   (interactive)
 166   (cond ((and (memql switch '(nil 1))
 167               (not spray--running))
 168          (setq spray--running
 169                (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update)))
 170         ((memql switch '(nil -1))
 171          (cancel-timer spray--running)
 172          (setq spray--running nil))
 173         (t
 174          nil)))
 175
 176 (defun spray-forward-word ()
 177   (interactive)
 178   (when spray--running (spray-start/stop -1))
 179   (widen)
 180   (skip-chars-forward "\s\t\n")
 181   (spray--word-at-point))
 182
 183 (defun spray-backward-word ()
 184   (interactive)
 185   (when spray--running (spray-start/stop -1))
 186   (widen)
 187   (skip-chars-backward "^\s\t\n")
 188   (skip-chars-backward "\s\t\n")
 189   (spray--word-at-point))
 190
 191 ;; * provide
 192
 193 (provide 'spray)
 194
 195 ;;; spray.el ends here