Fix missing accent character regression

[spray] / spray.el

diff --git a/spray.el b/spray.el
index 836cf07ff3137bbef25c568ab0244a492f325c2c..29a95a09d4136dc46471f9a90141b893edfd46bb 100644 (file)
--- a/spray.el
+++ b/spray.el
@@ -1,6 +1,6 @@
 ;;; spray.el --- a speed reading mode
 
 ;;; spray.el --- a speed reading mode
 

-;; Copyright (C) 2014 zk_phi
+;; Copyright (C) 2014 Ian Kelling <ian@iankelling.org>

 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by


@@ -16,30 +16,74 @@
 ;; along with this program; if not, write to the Free Software
 ;; Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 ;; along with this program; if not, write to the Free Software
 ;; Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 

-;; Author: zk_phi
-;; URL: http://hins11.yu-yake.com/
+;; Maintainer: Ian Kelling <ian@iankelling.org>

 ;; Author: Ian Kelling <ian@iankelling.org>
 ;; Author: Ian Kelling <ian@iankelling.org>

+;; Author: zk_phi
+;; Created: 18 Jun 2014

 ;; Version: 0.0.2
 ;; Version: 0.0.2

+;; URL: https://github.com/ian-kelling/spray
+;; Keywords: convenience

 
 ;;; Commentary:
 
 
 ;;; Commentary:
 

-;; Put this script into a "load-path"ed directory, and load it in your
-;; init file.
-;;
+;; For speed reading, or just more enjoyable reading. Narrows the buffer to show
+;; one word at a time. Adjust speed / pause as needed.
+;; 
+;; Download from Melpa or put this script into a "load-path"ed directory, and
+;; load it in your init file:
+

 ;;   (require 'spray)
 ;;   (require 'spray)

-;;
+

 ;; Then you may run spray with "M-x spray-mode". Binding some keys may
 ;; also be useful.
 ;; Then you may run spray with "M-x spray-mode". Binding some keys may
 ;; also be useful.

-;;
+

 ;;   (global-set-key (kbd "<f6>") 'spray-mode)
 ;;   (global-set-key (kbd "<f6>") 'spray-mode)

-;;
-;; For more informations, see Readme.org.

 
 

-;; Known bugs.
+;; In spray-mode buffers, following commands are available.
+
+;; - =spray-start/stop= (SPC) ::
+;; pause or resume spraying
+
+;; - =spray-backward-word= (h, <left>) ::
+;; pause and back to the last word
+
+;; - =spray-forward-word= (l, <right>) ::
+;; inverse of =spray-backward-word=
+
+;; - =spray-faster= (f) ::
+;; increases speed
+
+;; - =spray-slower= (s) ::
+;; decreases speed
+
+;; - =spray-quit= (q, <return>) ::
+;; quit =spray-mode=
+
+;; You may customize spray by modifying following items:
+
+;; - [Variable] spray-wpm
+;; - [Variable] spray-height
+;; - [Variable] spray-margin-top
+;; - [Variable] spray-margin-left
+;; - [Variable] spray-ramp
+;; - [Keymap] spray-mode-map
+;; - [Face] spray-base-face
+;; - [Face] spray-accent-face
+
+;; Readme.org from the package repository has some additional information:
+;; A gif screencast.
+;; Algorithm specification.
+;; Comparison with similar projects.
+
+;;; Known bugs:
+

 ;; repeated words are indistinguishable, for example
 ;; "going, going, gone" reads like going, gone, with a slight delay.
 ;; repeated words are indistinguishable, for example
 ;; "going, going, gone" reads like going, gone, with a slight delay.

+;;
+;; sentences (like this) should trigger a pause for ( and )

 
 ;;; Change Log:
 
 ;;; Change Log:

+

 ;; 0.0.0 test release
 ;; 0.0.1 add spray-set-margins
 ;; 0.0.2 margin options, speed control, better quit
 ;; 0.0.0 test release
 ;; 0.0.1 add spray-set-margins
 ;; 0.0.2 margin options, speed control, better quit


@@ -50,10 +94,56 @@
 
 ;; * customizable vars
 
 
 ;; * customizable vars
 

-(defvar spray-wpm 400 "words/min")
-(defvar spray-height 400 "height of characters")
-(defvar spray-margin-top 1 "character margin at top of buffer. Characters are as big as spray text characters.")
-(defvar spray-margin-left 1 "character margin at left of buffer. Characters are as big as spray text characters.")
+(defcustom spray-wpm 400
+  "Words per minute"
+  :group 'spray
+  :type 'integer)
+
+(defcustom spray-height 400
+  "Height of characters"
+  :group 'spray
+  :type 'integer)
+
+(defcustom spray-margin-top 1
+  "Character margin at top of buffer. Characters are as big as
+  spray text characters."
+  :group 'spray
+  :type 'integer)
+
+(defcustom spray-margin-left 1
+  "Character margin at left of buffer. Characters are as big as
+  spray text characters."
+  :group 'spray
+  :type 'integer)
+
+(defcustom spray-ramp 2
+  "Initial words before ramping up to full speed. Pauses for
+this multiple of wpm on the first word,
+decreasing by one for each subsequent word."
+  :group 'spray
+  :type 'integer)
+
+(defcustom spray-unsupported-minor-modes
+  '(buffer-face-mode smartparens-mode highlight-symbol-mode)
+  "Minor modes to toggle off when in spray mode."
+  :group 'spray
+  :type '(list symbol))
+
+
+;; * faces
+
+(defface spray-base-face
+  '((t (:inherit default)))
+  "Face for non-accent characters."
+  :group 'spray)
+
+(defface spray-accent-face
+  '((t (:foreground "red" :inherit spray-base-face)))
+  "Face for accent character."
+  :group 'spray)
+
+
+;; keymap

 
 (defvar spray-mode-map
   (let ((km (make-sparse-keymap)))
 
 (defvar spray-mode-map
   (let ((km (make-sparse-keymap)))


@@ -66,36 +156,27 @@
     (define-key km (kbd "s") 'spray-slower)
     (define-key km (kbd "q") 'spray-quit)
     (define-key km (kbd "<return>") 'spray-quit)
     (define-key km (kbd "s") 'spray-slower)
     (define-key km (kbd "q") 'spray-quit)
     (define-key km (kbd "<return>") 'spray-quit)

+    (define-key km [remap forward-char] 'spray-forward-word)
+    (define-key km [remap backward-char] 'spray-backward-word)
+    (define-key km [remap forward-word] 'spray-forward-word)
+    (define-key km [remap backward-word] 'spray-backward-word)
+    (define-key km [remap keyboard-quit] 'spray-quit)

     km)
   "keymap for spray-mode buffers")
 
     km)
   "keymap for spray-mode buffers")
 

-;; * faces
-
-(make-face 'spray-base-face)
-(set-face-attribute 'spray-base-face nil
-                    :background (face-background 'default)
-                    :foreground (face-foreground 'default)
-                    :slant 'normal)
-
-(make-face 'spray-accent-face)
-(set-face-attribute 'spray-accent-face nil
-                    :foreground "red"
-                    :overline (face-foreground 'default)
-                    :underline (face-foreground 'default)
-                    :slant 'normal)

 
 ;; * internal vars
 
 
 ;; * internal vars
 

-(defvar spray--margin-string ""
-  "Currently not used.")
+(defvar spray--margin-string "")

 (defvar spray--base-overlay nil)
 (defvar spray--accent-overlay nil)
 (defvar spray--running nil)
 (defvar spray--base-overlay nil)
 (defvar spray--accent-overlay nil)
 (defvar spray--running nil)

+(defvar spray--first-words 0)
+(defvar spray--initial-delay 0)

 (defvar spray--delay 0)
 (defvar spray--saved-cursor-type nil)
 (defvar spray--delay 0)
 (defvar spray--saved-cursor-type nil)

-(defvar spray--saved-buffer-face nil)

 (defvar spray--saved-restriction nil)
 (defvar spray--saved-restriction nil)

-(defvar spray--saved-smartparens-enabled nil)
+(defvar spray--saved-minor-modes nil)

 
 ;; * utility functions
 
 
 ;; * utility functions
 


@@ -117,18 +198,11 @@
                spray--accent-overlay (make-overlay 0 0)
                spray--saved-cursor-type cursor-type
                spray--saved-restriction (and (buffer-narrowed-p)
                spray--accent-overlay (make-overlay 0 0)
                spray--saved-cursor-type cursor-type
                spray--saved-restriction (and (buffer-narrowed-p)

-                                             (cons (point-min) (point-max)))
-               spray--saved-buffer-face (and (boundp 'buffer-face-mode)
-                                             buffer-face-mode
-                                             buffer-face-mode-face)
-               spray--saved-smartparens-enabled (and (boundp 'smartparens-mode)
-                                                     smartparens-mode)
-               spray--saved-highlight-symbol-enabled (and (boundp 'highlight-symbol-mode)
-                                                     highlight-symbol-mode))
-         ;; smartparens wrapping of all letter binds can cause problems.
-         ;; for example, it can cause auto-complete to activate
-         (and spray--saved-smartparens-enabled (smartparens-mode -1))
-         (and spray--saved-highlight-symbol-enabled (highlight-symbol-mode -1))
+                                             (cons (point-min) (point-max))))
+         (dolist (mode spray-unsupported-minor-modes)
+           (when (and (boundp mode) (eval mode))
+             (funcall mode -1)
+             (push mode spray--saved-minor-modes)))

          (setq cursor-type nil)
          (let ((buffer-face-mode-face `(:height ,spray-height)))
            (buffer-face-mode 1))
          (setq cursor-type nil)
          (let ((buffer-face-mode-face `(:height ,spray-height)))
            (buffer-face-mode 1))


@@ -138,20 +212,18 @@
          (overlay-put spray--accent-overlay 'face 'spray-accent-face)
          (spray-start))
         (t
          (overlay-put spray--accent-overlay 'face 'spray-accent-face)
          (spray-start))
         (t

-         (and spray--saved-smartparens-enabled (smartparens-mode 1))
-         (and spray--saved-highlight-symbol-enabled (highlight-symbol-mode 1))
-         (setq cursor-type spray--saved-cursor-type)
+         (spray-stop)
+         (delete-overlay spray--accent-overlay)
+         (delete-overlay spray--base-overlay)
+         (buffer-face-mode -1)

          (if spray--saved-restriction
              (narrow-to-region (car spray--saved-restriction)
                                (cdr spray--saved-restriction))
            (widen))
          (if spray--saved-restriction
              (narrow-to-region (car spray--saved-restriction)
                                (cdr spray--saved-restriction))
            (widen))

-         (buffer-face-mode -1)
-         (if spray--saved-buffer-face
-             (let ((buffer-face-mode-face spray--saved-buffer-face))
-               (buffer-face-mode 1)))
-         (delete-overlay spray--base-overlay)
-         (delete-overlay spray--accent-overlay)
-         (spray-stop))))
+         (setq cursor-type spray--saved-cursor-type)
+         (dolist (mode spray--saved-minor-modes)
+           (funcall mode 1))
+         (setq spray--saved-minor-modes nil))))

 
 (defun spray-quit ()
   "Exit spray mode."
 
 (defun spray-quit ()
   "Exit spray mode."


@@ -159,9 +231,9 @@
   (spray-mode -1))
 
 (defun spray--word-at-point ()
   (spray-mode -1))
 
 (defun spray--word-at-point ()

-  (skip-chars-backward "^\s\t\n")
+  (skip-chars-backward "^\s\t\n—")

   (let* ((beg (point))
   (let* ((beg (point))

-         (len (skip-chars-forward "^\s\t\n"))
+         (len (+ (skip-chars-forward "^\s\t\n—") (skip-chars-forward "—")))

          (end (point))
          (accent (+ beg (cl-case len
                        ((1) 1)
          (end (point))
          (accent (+ beg (cl-case len
                        ((1) 1)


@@ -177,7 +249,7 @@
                           (if (looking-at "\n[\s\t\n]") 3 0)
                           (cl-case (char-before)
                             ((?. ?! ?\? ?\;) 3)
                           (if (looking-at "\n[\s\t\n]") 3 0)
                           (cl-case (char-before)
                             ((?. ?! ?\? ?\;) 3)

-                            ((?, ?:) 1)
+                            ((?, ?: ?—) 1)

                             (t 0))))
     (move-overlay spray--accent-overlay (1- accent) accent)
     (move-overlay spray--base-overlay beg end)
                             (t 0))))
     (move-overlay spray--accent-overlay (1- accent) accent)
     (move-overlay spray--base-overlay beg end)


@@ -188,7 +260,9 @@
     (narrow-to-region beg end)))
 
 (defun spray--update ()
     (narrow-to-region beg end)))
 
 (defun spray--update ()

-  (cond ((not (zerop spray--delay))
+  (cond ((not (zerop spray--initial-delay))
+         (setq spray--initial-delay (1- spray--initial-delay)))
+        ((not (zerop spray--delay))

          (setq spray--delay (1- spray--delay))
          (when (= spray--delay 2)
            (narrow-to-region (point) (point))))
          (setq spray--delay (1- spray--delay))
          (when (= spray--delay 2)
            (narrow-to-region (point) (point))))


@@ -196,7 +270,10 @@
          (widen)
          (if (eobp)
              (spray-mode -1)
          (widen)
          (if (eobp)
              (spray-mode -1)

-           (skip-chars-forward "\s\t\n")
+           (when (not (zerop spray--first-words))
+             (setq spray--initial-delay spray--first-words)
+             (setq spray--first-words (1- spray--first-words)))
+           (skip-chars-forward "\s\t\n—")

            (spray--word-at-point)))))
 
 ;; * interactive commands
            (spray--word-at-point)))))
 
 ;; * interactive commands


@@ -218,30 +295,30 @@ Returns t if spray was unpaused."
 (defun spray-start ()
   "Start / resume spray."
   (interactive)
 (defun spray-start ()
   "Start / resume spray."
   (interactive)

+  (setq spray--first-words spray-ramp)

   (setq spray--running
         (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update)))
 
   (setq spray--running
         (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update)))
 

-

 (defun spray-forward-word ()
   (interactive)
   (spray-stop)
   (widen)
 (defun spray-forward-word ()
   (interactive)
   (spray-stop)
   (widen)

-  (skip-chars-forward "\s\t\n")
+  (skip-chars-forward "\s\t\n—")

   (spray--word-at-point))
 
 (defun spray-backward-word ()
   (interactive)
   (spray-stop)
   (widen)
   (spray--word-at-point))
 
 (defun spray-backward-word ()
   (interactive)
   (spray-stop)
   (widen)

-  (skip-chars-backward "^\s\t\n")
-  (skip-chars-backward "\s\t\n")
+  (skip-chars-backward "^\s\t\n—")
+  (skip-chars-backward "\s\t\n—")

   (spray--word-at-point))
 
 (defun spray-faster ()
   "Increases speed.
 
 Increases the wpm (words per minute) parameter. See the variable
   (spray--word-at-point))
 
 (defun spray-faster ()
   "Increases speed.
 
 Increases the wpm (words per minute) parameter. See the variable

-`spray-wmp'."
+`spray-wpm'."

   (interactive)
   (spray-inc-wpm 20))
 
   (interactive)
   (spray-inc-wpm 20))
 


@@ -249,7 +326,7 @@ Increases the wpm (words per minute) parameter. See the variable
   "Decreases speed.
 
 Decreases the wpm (words per minute) parameter. See the variable
   "Decreases speed.
 
 Decreases the wpm (words per minute) parameter. See the variable

-`spray-wmp'."
+`spray-wpm'."

   (interactive)
   (spray-inc-wpm -20))
 
   (interactive)
   (spray-inc-wpm -20))