-;;; cedit.el --- a speed reading mode
+;;; spray.el --- a speed reading mode
;; Copyright (C) 2014 zk_phi
;; Author: zk_phi
;; URL: http://hins11.yu-yake.com/
-;; Version: 0.0.1
+;; Author: Ian Kelling <ian@iankelling.org>
+;; Version: 0.0.2
;;; Commentary:
;;; Change Log:
;; 0.0.0 test release
;; 0.0.1 add spray-set-margins
+;; 0.0.2 margin options, speed control, better quit
;;; Code:
(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 0 "character margin at left of buffer. Characters are as big as spray text characters.")
(defvar spray-mode-map
(let ((km (make-sparse-keymap)))
(define-key km (kbd "<left>") 'spray-backward-word)
(define-key km (kbd "<right>") 'spray-forward-word)
(define-key km (kbd "f") 'spray-faster)
- (define-key km (kbd "s") 'spray-slower)
+ (define-key km (kbd "q") 'spray-quit)
+ (define-key km (kbd "<return>") 'spray-quit)
km)
"keymap for spray-mode buffers")
(make-face 'spray-base-face)
(set-face-attribute 'spray-base-face nil
:background (face-background 'default)
- :foreground (face-foreground 'default))
+ :foreground (face-foreground 'default)
+ :slant 'normal)
-(make-face 'spray-orp-face)
-(set-face-attribute 'spray-orp-face nil
+(make-face 'spray-accent-face)
+(set-face-attribute 'spray-accent-face nil
:foreground "red"
:overline (face-foreground 'default)
- :underline (face-foreground 'default))
+ :underline (face-foreground 'default)
+ :slant 'normal)
;; * internal vars
-(defvar spray--margin-string "")
+(defvar spray--margin-string ""
+ "Currently not used.")
(defvar spray--base-overlay nil)
(defvar spray--orp-overlay nil)
(defvar spray--running nil)
;; * utility functions
-(defun spray-set-margins (left above)
- "add margins before/above the spray text. each arguments can be
-an integer or a float value."
+(defun spray-set-margins ()
+ "Setup spray--margin-string"
(setq spray--margin-string
- (propertize " " 'display `((space-width ,left) (height ,(1+ above))))))
+ (concat (make-string spray-margin-top 10) ;; 10 = ascii newline
+ (make-string spray-margin-left 32)))) ;; 32 = ascii space
;; * the mode
(overlay-put spray--base-overlay 'priority 100)
(overlay-put spray--base-overlay 'face 'spray-base-face)
(overlay-put spray--orp-overlay 'priority 101)
- (overlay-put spray--orp-overlay 'face 'spray-orp-face)
- (add-hook 'pre-command-hook 'spray--pre-command-handler)
- (spray-start/stop 1))
+ (overlay-put spray--orp-overlay 'face 'spray-accent-face)
+ (spray-start))
(t
(setq cursor-type spray--saved-cursor-type)
(if spray--saved-restriction
(buffer-face-mode 1)))
(delete-overlay spray--base-overlay)
(delete-overlay spray--orp-overlay)
- (remove-hook 'pre-command-hook 'spray--pre-command-handler)
- (spray-start/stop -1))))
+ (spray-stop))))
-(defun spray--pre-command-handler ()
- (unless (string-match "^spray-" (symbol-name this-command))
- (spray-mode -1)))
+(defun spray-quit ()
+ "Exit spray mode."
+ (interactive)
+ (spray-mode -1))
(defun spray--word-at-point ()
(skip-chars-backward "^\s\t\n")
(t 0))))
(move-overlay spray--orp-overlay (1- orp) orp)
(move-overlay spray--base-overlay beg end)
+ (spray-set-margins)
(overlay-put spray--base-overlay 'before-string
(concat spray--margin-string
(make-string (- 5 (- orp beg)) ?\s)))
;; * interactive commands
-(defun spray-start/stop (&optional switch)
+(defun spray-start/stop ()
+ "Toggle pause/unpause spray."
(interactive)
- (cond ((and (memql switch '(nil 1))
- (not spray--running))
- (setq spray--running
- (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update)))
- ((memql switch '(nil -1))
- (cancel-timer spray--running)
- (setq spray--running nil))
- (t
- nil)))
+ (or (spray-stop) (spray-start)))
+
+(defun spray-stop ()
+ "Pause spray.
+Returns t if spray was unpaused."
+ (interactive)
+ (prog1 spray--running
+ (when spray--running
+ (cancel-timer spray--running)
+ (setq spray--running nil))))
+
+(defun spray-start ()
+ "Start / resume spray."
+ (interactive)
+ (setq spray--running
+ (run-with-timer 0 (/ 60.0 spray-wpm) 'spray--update)))
+
(defun spray-forward-word ()
(interactive)
- (when spray--running (spray-start/stop -1))
+ (spray-stop)
(widen)
(skip-chars-forward "\s\t\n")
(spray--word-at-point))
(defun spray-backward-word ()
(interactive)
- (when spray--running (spray-start/stop -1))
+ (spray-stop)
(widen)
(skip-chars-backward "^\s\t\n")
(skip-chars-backward "\s\t\n")
(defun spray-inc-wpm (delta)
(let ((was-running spray--running))
- (spray-start/stop -1)
+ (spray-stop)
(when (< 10 (+ spray-wpm delta))
(setq spray-wpm (+ spray-wpm delta)))
- (spray-backward-word)
+ (and was-running (spray-backward-word))
(message "spray wpm: %d" spray-wpm)
(when was-running
- (spray-start/stop 1))))
+ (spray-start))))
;; * provide