strokes.el 64.4 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
;;; strokes.el --- control Emacs through mouse strokes
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1997, 2000, 2001, 2002, 2003, 2004,
4
;;   2005, 2006 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5

6
;; Author: David Bakhash <cadet@alum.mit.edu>
Richard M. Stallman's avatar
Richard M. Stallman committed
7
;; Maintainer: FSF
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
;; Keywords: lisp, mouse, extensions

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
26 27 28 29 30 31 32 33 34 35

;;; Commentary:

;; This is the strokes package.  It is intended to allow the user to
;; control Emacs by means of mouse strokes.  Once strokes is loaded, you
;; can always get help be invoking `strokes-help':

;; > M-x strokes-help

;; and you can learn how to use the package.  A mouse stroke, for now,
Dave Love's avatar
Dave Love committed
36 37 38 39 40 41 42 43
;; can be defined as holding the shift key and the middle button, for
;; instance, and then moving the mouse in whatever pattern you wish,
;; which you have set Emacs to understand as mapping to a given
;; command.  For example, you may wish the have a mouse stroke that
;; looks like a capital `C' which means `copy-region-as-kill'.  Treat
;; strokes just like you do key bindings.  For example, Emacs sets key
;; bindings globally with the `global-set-key' command.  Likewise, you
;; can do
Richard M. Stallman's avatar
Richard M. Stallman committed
44

Dave Love's avatar
Dave Love committed
45
;; > M-x strokes-global-set-stroke
Richard M. Stallman's avatar
Richard M. Stallman committed
46 47 48

;; to interactively program in a stroke.  It would be wise to set the
;; first one to this very command, so that from then on, you invoke
Dave Love's avatar
Dave Love committed
49 50 51
;; `strokes-global-set-stroke' with a stroke.  Likewise, there may
;; eventually be a `strokes-local-set-stroke' command, also analogous
;; to `local-set-key'.
Richard M. Stallman's avatar
Richard M. Stallman committed
52 53 54 55 56 57 58 59 60 61 62 63

;; You can always unset the last stroke definition with the command

;; > M-x strokes-unset-last-stroke

;; and the last stroke that was added to `strokes-global-map' will be
;; removed.

;; Other analogies between strokes and key bindings are as follows:

;;    1) To describe a stroke binding, you can type

Dave Love's avatar
Dave Love committed
64
;;       > M-x strokes-describe-stroke
Richard M. Stallman's avatar
Richard M. Stallman committed
65 66 67 68 69

;;       analogous to `describe-key'.  It's also wise to have a stroke,
;;       like an `h', for help, or a `?', mapped to `describe-stroke'.

;;    2) stroke bindings are set internally through the Lisp function
Dave Love's avatar
Dave Love committed
70 71
;;       `strokes-define-stroke', similar to the `define-key' function.
;;       some examples for a 3x3 stroke grid would be
Richard M. Stallman's avatar
Richard M. Stallman committed
72

Dave Love's avatar
Dave Love committed
73
;;       (strokes-define-stroke c-mode-stroke-map
Richard M. Stallman's avatar
Richard M. Stallman committed
74 75
;;                      '((0 . 0) (1 . 1) (2 . 2))
;;                      'kill-region)
Dave Love's avatar
Dave Love committed
76
;;       (strokes-define-stroke strokes-global-map
Richard M. Stallman's avatar
Richard M. Stallman committed
77 78 79 80 81
;;                      '((0 . 0) (0 . 1) (0 . 2) (1 . 2) (2 . 2))
;;                      'list-buffers)

;;       however, if you would probably just have the user enter in the
;;       stroke interactively and then set the stroke to whatever he/she
82
;;       entered.  The Lisp function to interactively read a stroke is
Richard M. Stallman's avatar
Richard M. Stallman committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
;;       `strokes-read-stroke'.  This is especially helpful when you're
;;       on a fast computer that can handle a 9x9 stroke grid.

;;       NOTE: only global stroke bindings are currently implemented,
;;       however mode- and buffer-local stroke bindings may eventually
;;       be implemented in a future version.

;; The important variables to be aware of for this package are listed
;; below.  They can all be altered through the customizing package via

;; > M-x customize

;; and customizing the group named `strokes'.  You can also read
;; documentation on the variables there.

;; `strokes-minimum-match-score' (determines the threshold of error that
99
;; makes a stroke acceptable or unacceptable.  If your strokes aren't
Richard M. Stallman's avatar
Richard M. Stallman committed
100 101 102 103 104
;; matching, then you should raise this variable.

;; `strokes-grid-resolution' (determines the grid dimensions that you use
;; when defining/reading strokes.  The finer the grid your computer can
;; handle, the more you can do, but even a 3x3 grid is pretty cool.)
105
;; The default value (9) should be fine for most decent computers.
Richard M. Stallman's avatar
Richard M. Stallman committed
106 107 108 109 110 111 112
;; NOTE: This variable should not be set to a number less than 3.

;; `strokes-display-strokes-buffer' will allow you to hide the strokes
;; buffer when doing simple strokes.  This is a speedup for slow
;; computers as well as people who don't want to see their strokes.

;; If you find that your mouse is accelerating too fast, you can
Dave Love's avatar
Dave Love committed
113
;; execute an X command to slow it down.  A good possibility is
Richard M. Stallman's avatar
Richard M. Stallman committed
114 115 116 117 118 119 120 121

;; % xset m 5/4 8

;; which seems, heuristically, to work okay, without much disruption.

;; Whenever you load in the strokes package, you will be able to save
;; what you've done upon exiting Emacs.  You can also do

Dave Love's avatar
Dave Love committed
122
;; > M-x strokes-prompt-user-save-strokes
Richard M. Stallman's avatar
Richard M. Stallman committed
123 124 125 126 127 128 129

;; and it will save your strokes in ~/.strokes, or you may wish to change
;; this by setting the variable `strokes-file'.

;; Note that internally, all of the routines that are part of this
;; package are able to deal with complex strokes, as they are a superset
;; of simple strokes.  However, the default of this package will map
Dave Love's avatar
Dave Love committed
130 131 132
;; S-mouse-2 to the command `strokes-do-stroke', and M-mouse-2 to
;; `strokes-do-complex-stroke'.  Complex strokes are terminated
;; with mouse button 3.
Richard M. Stallman's avatar
Richard M. Stallman committed
133

Dave Love's avatar
Dave Love committed
134
;; You can also toggle between strokes mode by simple typing
Richard M. Stallman's avatar
Richard M. Stallman committed
135 136 137

;; > M-x strokes-mode

Dave Love's avatar
Dave Love committed
138 139 140 141 142 143
;; I hope that, with the help of others, this package will be useful
;; in entering in pictographic-like language text using the mouse
;; (i.e. Korean).  Japanese and Chinese are a bit trickier, but I'm
;; sure that with help it can be done.  The next version will allow
;; the user to enter strokes which "remove the pencil from the paper"
;; so to speak, so one character can have multiple strokes.
Richard M. Stallman's avatar
Richard M. Stallman committed
144

145 146
;; NOTE (Oct 7, 2006): The URLs below seem to be invalid!!!

Richard M. Stallman's avatar
Richard M. Stallman committed
147 148 149 150 151 152 153 154 155 156
;; You can read more about strokes at:

;; http://www.mit.edu/people/cadet/strokes-help.html

;; If you're interested in using strokes for writing English into Emacs
;; using strokes, then you'll want to read about it on the web page above
;; or just download from http://www.mit.edu/people/cadet/strokes-abc.el,
;; which is nothing but a file with some helper commands for inserting
;; alphanumerics and punctuation.

157 158 159 160 161 162 163 164
;; Great thanks to Rob Ristroph for his generosity in letting me use
;; his PC to develop this, Jason Johnson for his help in algorithms,
;; Euna Kim for her help in Korean, and massive thanks to the helpful
;; guys on the help instance on athena (zeno, jered, amu, gsstark,
;; ghudson, etc) Special thanks to Steve Baur, Kyle Jones, and Hrvoje
;; Niksic for all their help.  And special thanks to Dave Gillespie
;; for all the elisp help--he is responsible for helping me use the cl
;; macros at (near) max speed.
Richard M. Stallman's avatar
Richard M. Stallman committed
165 166

;; Tasks: (what I'm getting ready for future version)...
Dave Love's avatar
Dave Love committed
167
;; 2) use 'strokes-read-complex-stroke for Korean, etc.
Richard M. Stallman's avatar
Richard M. Stallman committed
168 169 170 171 172 173
;; 4) buffer-local 'strokes-local-map, and mode-stroke-maps would be nice
;; 6) add some hooks, like `strokes-read-stroke-hook'
;; 7) See what people think of the factory settings.  Should I change
;;    them?  They're all pretty arbitrary in a way.  I guess they
;;    should be minimal, but computers are getting lots faster, and
;;    if I choose the defaults too conservatively, then strokes will
174
;;    surely disappoint some people on decent machines (until they
Richard M. Stallman's avatar
Richard M. Stallman committed
175 176 177 178
;;    figure out M-x customize).  I need feedback.
;; Other: I always have the most beta version of strokes, so if you
;;        want it just let me know.

Dave Love's avatar
Dave Love committed
179 180
;; Fixme: Use pbm instead of xpm for pixmaps to work generally.

Richard M. Stallman's avatar
Richard M. Stallman committed
181 182 183 184 185
;;; Code:

;;; Requirements and provisions...

(autoload 'mail-position-on-field "sendmail")
186
(eval-when-compile (require 'cl))
Richard M. Stallman's avatar
Richard M. Stallman committed
187 188 189

;;; Constants...

190
(defconst strokes-lift :strokes-lift
Richard M. Stallman's avatar
Richard M. Stallman committed
191
  "Symbol representing a stroke lift event for complex strokes.
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
Complex strokes are those which contain two or more simple strokes.")

(defconst strokes-xpm-header "/* XPM */
static char * stroke_xpm[] = {
/* width height ncolors cpp [x_hot y_hot] */
\"33 33 9 1 26 23\",
/* colors */
\" 	c none s none\",
\"*	c #000000 s foreground\",
\"R	c #FFFF00000000\",
\"O	c #FFFF80000000\",
\"Y	c #FFFFFFFF0000\",
\"G	c #0000FFFF0000\",
\"B	c #00000000FFFF\",
\"P	c #FFFF0000FFFF\",
\".	c #45458B8B0000\",
/* pixels */\n"
Dave Love's avatar
Dave Love committed
209
  "The header to all xpm buffers created by strokes.")
Richard M. Stallman's avatar
Richard M. Stallman committed
210 211 212 213

;;; user variables...

(defgroup strokes nil
214
  "Control Emacs through mouse strokes."
Dave Love's avatar
Dave Love committed
215
  :link '(emacs-commentary-link "strokes")
Richard M. Stallman's avatar
Richard M. Stallman committed
216 217 218
  :group 'mouse)

(defcustom strokes-modeline-string " Strokes"
Dave Love's avatar
Dave Love committed
219
  "*Modeline identification when Strokes mode is on \(default is \" Strokes\"\)."
Richard M. Stallman's avatar
Richard M. Stallman committed
220 221 222 223 224
  :type 'string
  :group 'strokes)

(defcustom strokes-character ?@
  "*Character used when drawing strokes in the strokes buffer.
225
\(The default is `@', which works well.\)"
Richard M. Stallman's avatar
Richard M. Stallman committed
226 227 228 229 230
  :type 'character
  :group 'strokes)

(defcustom strokes-minimum-match-score 1000
  "*Minimum score for a stroke to be considered a possible match.
231
Setting this variable to 0 would require a perfectly precise match.
Richard M. Stallman's avatar
Richard M. Stallman committed
232 233 234 235 236 237
The default value is 1000, but it's mostly dependent on how precisely
you manage to replicate your user-defined strokes.  It also depends on
the value of `strokes-grid-resolution', since a higher grid resolution
will correspond to more sample points, and thus more distance
measurements.  Usually, this is not a problem since you first set
`strokes-grid-resolution' based on what your computer seems to be able
Dave Love's avatar
Dave Love committed
238
to handle (though the defaults are usually more than sufficient), and
Richard M. Stallman's avatar
Richard M. Stallman committed
239 240 241 242 243 244 245 246 247
then you can set `strokes-minimum-match-score' to something that works
for you.  The only purpose of this variable is to insure that if you
do a bogus stroke that really doesn't match any of the predefined
ones, then strokes should NOT pick the one that came closest."
  :type 'integer
  :group 'strokes)

(defcustom strokes-grid-resolution 9
  "*Integer defining dimensions of the stroke grid.
248
The grid is a square grid, where `strokes-grid-resolution' defaults to
Richard M. Stallman's avatar
Richard M. Stallman committed
249
`9', making a 9x9 grid whose coordinates go from (0 . 0) on the top
250
left to ((strokes-grid-resolution - 1) . (strokes-grid-resolution - 1))
Richard M. Stallman's avatar
Richard M. Stallman committed
251 252 253 254 255 256 257 258 259 260 261 262
on the bottom right.  The greater the resolution, the more intricate
your strokes can be.
NOTE: This variable should be odd and MUST NOT be less than 3 and need
      not be greater than 33, which is the resolution of the pixmaps.
WARNING: Changing the value of this variable will gravely affect the
         strokes you have already programmed in.  You should try to
         figure out what it should be based on your needs and on how
         quick the particular platform(s) you're operating on, and
         only then start programming in your custom strokes."
  :type 'integer
  :group 'strokes)

263
(defcustom strokes-file (convert-standard-filename "~/.strokes")
264
  "*File containing saved strokes for Strokes mode (default is ~/.strokes)."
Richard M. Stallman's avatar
Richard M. Stallman committed
265 266 267
  :type 'file
  :group 'strokes)

Dave Love's avatar
Dave Love committed
268 269
(defvar strokes-buffer-name " *strokes*"
  "The name of the buffer that the strokes take place in.")
Richard M. Stallman's avatar
Richard M. Stallman committed
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288

(defcustom strokes-use-strokes-buffer t
  "*If non-nil, the strokes buffer is used and strokes are displayed.
If nil, strokes will be read the same, however the user will not be
able to see the strokes.  This be helpful for people who don't like
the delay in switching to the strokes buffer."
  :type 'boolean
  :group 'strokes)

;;; internal variables...

(defvar strokes-window-configuration nil
  "The special window configuration used when entering strokes.
This is set properly in the function `strokes-update-window-configuration'.")

(defvar strokes-last-stroke nil
  "Last stroke entered by the user.
Its value gets set every time the function
`strokes-fill-stroke' gets called,
289
since that is the best time to set the variable.")
Richard M. Stallman's avatar
Richard M. Stallman committed
290 291 292 293 294 295

(defvar strokes-global-map '()
  "Association list of strokes and their definitions.
Each entry is (STROKE . COMMAND) where STROKE is itself a list of
coordinates (X . Y) where X and Y are lists of positions on the
normalized stroke grid, with the top left at (0 . 0).  COMMAND is the
296
corresponding interactive function.")
Richard M. Stallman's avatar
Richard M. Stallman committed
297 298

(defvar strokes-load-hook nil
299
  "Functions to be called when Strokes is loaded.")
Richard M. Stallman's avatar
Richard M. Stallman committed
300

301 302 303 304 305 306 307 308 309 310 311 312
;;; ### NOT IMPLEMENTED YET ###
;;(defvar edit-strokes-menu
;;  '("Edit-Strokes"
;;    ["Add stroke..." strokes-global-set-stroke t]
;;    ["Delete stroke..." strokes-edit-delete-stroke t]
;;    ["Change stroke"	strokes-smaller	t]
;;    ["Change definition"	strokes-larger	t]
;;    ["[Re]List Strokes chronologically"	strokes-list-strokes	t]
;;    ["[Re]List Strokes alphabetically"	strokes-list-strokes	t]
;;    ["Quit"		strokes-edit-quit		t]
;;    ))

Richard M. Stallman's avatar
Richard M. Stallman committed
313 314
;;; Macros...

Dave Love's avatar
Dave Love committed
315 316 317 318 319
;; unused
;; (defmacro strokes-while-inhibiting-garbage-collector (&rest forms)
;;   "Execute FORMS without interference from the garbage collector."
;;   `(let ((gc-cons-threshold 134217727))
;;      ,@forms))
320

Richard M. Stallman's avatar
Richard M. Stallman committed
321 322
(defsubst strokes-click-p (stroke)
  "Non-nil if STROKE is really click."
Richard M. Stallman's avatar
Richard M. Stallman committed
323
  (< (length stroke) 2))
Richard M. Stallman's avatar
Richard M. Stallman committed
324 325 326 327

;;; old, but worked pretty good (just in case)...
;;(defmacro strokes-define-stroke (stroke-map stroke def)
;;  "Add STROKE to STROKE-MAP alist with given command DEF"
Richard M. Stallman's avatar
Richard M. Stallman committed
328
;;  (list 'if (list '< (list 'length stroke) 2)
Richard M. Stallman's avatar
Richard M. Stallman committed
329 330 331 332 333 334
;;	(list 'error
;;	      "That's a click, not a stroke.  See `strokes-click-command'")
;;	(list 'setq stroke-map (list 'cons (list 'cons stroke def)
;;				     (list 'remassoc stroke stroke-map)))))

(defsubst strokes-remassoc (key list)
335 336 337 338
  (let (elt)
    (while (setq elt (assoc key list))
      (setq list (delete elt list))))
  list)
Richard M. Stallman's avatar
Richard M. Stallman committed
339 340 341 342

(defmacro strokes-define-stroke (stroke-map stroke def)
  "Add STROKE to STROKE-MAP alist with given command DEF."
  `(if (strokes-click-p ,stroke)
Dave Love's avatar
Dave Love committed
343
       (error "That's a click, not a stroke")
Richard M. Stallman's avatar
Richard M. Stallman committed
344 345 346 347
     (setq ,stroke-map (cons (cons ,stroke ,def)
			     (strokes-remassoc ,stroke ,stroke-map)))))

(defsubst strokes-square (x)
Dave Love's avatar
Dave Love committed
348
  "Return the square of the number X."
Richard M. Stallman's avatar
Richard M. Stallman committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
  (* x x))

(defsubst strokes-distance-squared (p1 p2)
  "Gets the distance (squared) between to points P1 and P2.
P1 and P2 are cons cells in the form (X . Y)."
  (let ((x1 (car p1))
	(y1 (cdr p1))
	(x2 (car p2))
	(y2 (cdr p2)))
    (+ (strokes-square (- x2 x1))
       (strokes-square (- y2 y1)))))

;;; Functions...

(defsubst strokes-mouse-event-p (event)
364 365 366 367 368 369 370 371 372 373 374 375 376 377
  (and (consp event) (symbolp (car event))
       (or (eq (car event) 'mouse-movement)
	   (memq 'click (get (car event) 'event-symbol-elements))
	   (memq 'down (get (car event) 'event-symbol-elements))
	   (memq 'drag (get (car event) 'event-symbol-elements)))))

(defsubst strokes-button-press-event-p (event)
  (and (consp event) (symbolp (car event))
       (memq 'down (get (car event) 'event-symbol-elements))))

(defsubst strokes-button-release-event-p (event)
  (and (consp event) (symbolp (car event))
       (or (memq 'click (get (car event) 'event-symbol-elements))
	   (memq 'drag (get (car event) 'event-symbol-elements)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395

(defun strokes-event-closest-point-1 (window &optional line)
  "Return position of start of line LINE in WINDOW.
If LINE is nil, return the last position visible in WINDOW."
  (let* ((total (- (window-height window)
		   (if (window-minibuffer-p window)
		       0 1)))
	 (distance (or line total)))
    (save-excursion
      (goto-char (window-start window))
      (if (= (vertical-motion distance) distance)
	  (if (not line)
	      (forward-char -1)))
      (point))))

(defun strokes-event-closest-point (event &optional start-window)
  "Return the nearest position to where EVENT ended its motion.
This is computed for the window where EVENT's motion started,
Dave Love's avatar
Dave Love committed
396
or for window START-WINDOW if that is specified."
Richard M. Stallman's avatar
Richard M. Stallman committed
397 398
  (or start-window (setq start-window (posn-window (event-start event))))
  (if (eq start-window (posn-window (event-end event)))
399
      (if (eq (posn-point (event-end event)) 'vertical-line)
Richard M. Stallman's avatar
Richard M. Stallman committed
400 401
	  (strokes-event-closest-point-1 start-window
					 (cdr (posn-col-row (event-end event))))
402
	(if (eq (posn-point (event-end event)) 'mode-line)
Richard M. Stallman's avatar
Richard M. Stallman committed
403
	    (strokes-event-closest-point-1 start-window)
404
	  (posn-point (event-end event))))
Richard M. Stallman's avatar
Richard M. Stallman committed
405 406 407 408 409 410 411 412
    ;; EVENT ended in some other window.
    (let* ((end-w (posn-window (event-end event)))
	   (end-w-top)
	   (w-top (nth 1 (window-edges start-window))))
      (setq end-w-top
	    (if (windowp end-w)
		(nth 1 (window-edges end-w))
	      (/ (cdr (posn-x-y (event-end event)))
Richard M. Stallman's avatar
Richard M. Stallman committed
413
		 (frame-char-height end-w))))
Richard M. Stallman's avatar
Richard M. Stallman committed
414 415 416 417 418
      (if (>= end-w-top w-top)
	  (strokes-event-closest-point-1 start-window)
	(window-start start-window)))))

(defun strokes-lift-p (object)
419
  "Return non-nil if OBJECT is a stroke-lift."
Richard M. Stallman's avatar
Richard M. Stallman committed
420 421 422 423 424 425
  (eq object strokes-lift))

(defun strokes-unset-last-stroke ()
  "Undo the last stroke definition."
  (interactive)
  (let ((command (cdar strokes-global-map)))
Richard M. Stallman's avatar
Richard M. Stallman committed
426
    (if (y-or-n-p
Dave Love's avatar
Dave Love committed
427
	 (format "Really delete last stroke definition, defined to `%s'? "
Richard M. Stallman's avatar
Richard M. Stallman committed
428 429 430 431 432 433 434 435 436 437 438 439
		 command))
	(progn
	  (setq strokes-global-map (cdr strokes-global-map))
	  (message "That stroke has been deleted"))
      (message "Nothing done"))))

;;;###autoload
(defun strokes-global-set-stroke (stroke command)
  "Interactively give STROKE the global binding as COMMAND.
Operated just like `global-set-key', except for strokes.
COMMAND is a symbol naming an interactively-callable function.  STROKE
is a list of sampled positions on the stroke grid as described in the
440 441 442
documentation for the `strokes-define-stroke' function.

See also `strokes-global-set-stroke-string'."
Richard M. Stallman's avatar
Richard M. Stallman committed
443 444 445 446
  (interactive
   (list
    (and (or strokes-mode (strokes-mode t))
	 (strokes-read-complex-stroke
Dave Love's avatar
Dave Love committed
447 448
	  "Draw with mouse button 1 (or 2).  End with button 3..."))
    (read-command "Command to map stroke to: ")))
Richard M. Stallman's avatar
Richard M. Stallman committed
449 450
  (strokes-define-stroke strokes-global-map stroke command))

451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
(defun strokes-global-set-stroke-string (stroke string)
  "Interactively give STROKE the global binding as STRING.
Operated just like `global-set-key', except for strokes.  STRING
is a string to be inserted by the stroke.  STROKE is a list of
sampled positions on the stroke grid as described in the
documentation for the `strokes-define-stroke' function.

Compare `strokes-global-set-stroke'."
  (interactive
   (list
    (and (or strokes-mode (strokes-mode t))
	 (strokes-read-complex-stroke
	  "Draw with mouse button 1 (or 2).  End with button 3..."))
    (read-string "String to map stroke to: ")))
  (strokes-define-stroke strokes-global-map stroke string))

Richard M. Stallman's avatar
Richard M. Stallman committed
467 468 469 470 471 472 473 474 475 476
;;(defun global-unset-stroke (stroke); FINISH THIS DEFUN!
;;  "delete all strokes matching STROKE from `strokes-global-map',
;; letting the user input
;; the stroke with the mouse"
;;  (interactive
;;   (list
;;    (strokes-read-stroke "Enter the stroke you want to delete...")))
;;  (strokes-define-stroke 'strokes-global-map stroke command))

(defun strokes-get-grid-position (stroke-extent position &optional grid-resolution)
Dave Love's avatar
Dave Love committed
477
  "Map POSITION to a new grid position.
478
Do so based on its STROKE-EXTENT and GRID-RESOLUTION.
Richard M. Stallman's avatar
Richard M. Stallman committed
479 480
STROKE-EXTENT as a list \(\(XMIN . YMIN\) \(XMAX . YMAX\)\).
If POSITION is a `strokes-lift', then it is itself returned.
481
Optional GRID-RESOLUTION may be used in place of `strokes-grid-resolution'.
Dave Love's avatar
Dave Love committed
482
The grid is a square whose dimension is [0,GRID-RESOLUTION)."
Richard M. Stallman's avatar
Richard M. Stallman committed
483 484 485 486 487 488 489 490
  (cond ((consp position)		; actual pixel location
	 (let ((grid-resolution (or grid-resolution strokes-grid-resolution))
	       (x (car position))
	       (y (cdr position))
	       (xmin (caar stroke-extent))
	       (ymin (cdar stroke-extent))
	       ;; the `1+' is there to insure that the
	       ;; formula evaluates correctly at the boundaries
491 492
	       (xmax (1+ (car (cadr stroke-extent))))
	       (ymax (1+ (cdr (cadr stroke-extent)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
493 494 495 496 497 498 499 500 501 502
	   (cons (floor (* grid-resolution
			   (/ (float (- x xmin))
			      (- xmax xmin))))
		 (floor (* grid-resolution
			   (/ (float (- y ymin))
			      (- ymax ymin)))))))
	((strokes-lift-p position)	; stroke lift
	 strokes-lift)))

(defun strokes-get-stroke-extent (pixel-positions)
Dave Love's avatar
Dave Love committed
503
  "From a list of absolute PIXEL-POSITIONS, return absolute spatial extent.
Richard M. Stallman's avatar
Richard M. Stallman committed
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
The return value is a list ((XMIN . YMIN) (XMAX . YMAX))."
  (if pixel-positions
      (let ((xmin (caar pixel-positions))
	    (xmax (caar pixel-positions))
	    (ymin (cdar pixel-positions))
	    (ymax (cdar pixel-positions))
	    (rest (cdr pixel-positions)))
	(while rest
	  (if (consp (car rest))
	      (let ((x (caar rest))
		    (y (cdar rest)))
		(if (< x xmin)
		    (setq xmin x))
		(if (> x xmax)
		    (setq xmax x))
		(if (< y ymin)
		    (setq ymin y))
		(if (> y ymax)
		    (setq ymax y))))
	  (setq rest (cdr rest)))
	(let ((delta-x (- xmax xmin))
	      (delta-y (- ymax ymin)))
	  (if (> delta-x delta-y)
	      (setq ymin (- ymin
			    (/ (- delta-x delta-y)
			       2))
		    ymax (+ ymax
			    (/ (- delta-x delta-y)
			       2)))
	    (setq xmin (- xmin
			  (/ (- delta-y delta-x)
			     2))
		  xmax (+ xmax
			  (/ (- delta-y delta-x)
			     2))))
	  (list (cons xmin ymin)
		(cons xmax ymax))))
    nil))

(defun strokes-eliminate-consecutive-redundancies (entries)
Dave Love's avatar
Dave Love committed
544
  "Return a list with no consecutive redundant entries."
Richard M. Stallman's avatar
Richard M. Stallman committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
  ;; defun a grande vitesse grace a Dave G.
  (loop for element on entries
        if (not (equal (car element) (cadr element)))
        collect (car element)))
;;  (loop for element on entries
;;        nconc (if (not (equal (car el) (cadr el)))
;;                  (list (car el)))))
;; yet another (orig) way of doing it...
;;  (if entries
;;      (let* ((current (car entries))
;;	     (rest (cdr entries))
;;	     (non-redundant-list (list current))
;;	     (next nil))
;;	(while rest
;;	  (setq next (car rest))
;;	  (if (equal current next)
;;	      (setq rest (cdr rest))
;;	    (setq non-redundant-list (cons next non-redundant-list)
;;		  current next
;;		  rest (cdr rest))))
;;	(nreverse non-redundant-list))
;;    nil))

(defun strokes-renormalize-to-grid (positions &optional grid-resolution)
  "Map POSITIONS to a new grid whose dimensions are based on GRID-RESOLUTION.
POSITIONS is a list of positions and stroke-lifts.
571
Optional GRID-RESOLUTION may be used in place of `strokes-grid-resolution'.
Dave Love's avatar
Dave Love committed
572
The grid is a square whose dimension is [0,GRID-RESOLUTION)."
Richard M. Stallman's avatar
Richard M. Stallman committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
  (or grid-resolution (setq grid-resolution strokes-grid-resolution))
  (let ((stroke-extent (strokes-get-stroke-extent positions)))
    (mapcar (function
	     (lambda (pos)
	       (strokes-get-grid-position stroke-extent pos grid-resolution)))
	    positions)))

(defun strokes-fill-stroke (unfilled-stroke &optional force)
  "Fill in missing grid locations in the list of UNFILLED-STROKE.
If FORCE is non-nil, then fill the stroke even if it's `stroke-click'.
NOTE: This is where the global variable `strokes-last-stroke' is set."
  (setq strokes-last-stroke		; this is global
	(if (and (strokes-click-p unfilled-stroke)
		 (not force))
	    unfilled-stroke
	  (loop for grid-locs on unfilled-stroke
		nconc (let* ((current (car grid-locs))
			     (current-is-a-point-p (consp current))
			     (next (cadr grid-locs))
			     (next-is-a-point-p (consp next))
			     (both-are-points-p (and current-is-a-point-p
						     next-is-a-point-p))
			     (x1 (and current-is-a-point-p
				      (car current)))
			     (y1 (and current-is-a-point-p
				      (cdr current)))
			     (x2 (and next-is-a-point-p
				      (car next)))
			     (y2 (and next-is-a-point-p
				      (cdr next)))
			     (delta-x (and both-are-points-p
					   (- x2 x1)))
			     (delta-y (and both-are-points-p
					   (- y2 y1)))
			     (slope (and both-are-points-p
					 (if (zerop delta-x)
					     nil ; undefined vertical slope
					   (/ (float delta-y)
					      delta-x)))))
			(cond ((not both-are-points-p)
			       (list current))
Dave Love's avatar
Dave Love committed
614
			      ((null slope) ; undefined vertical slope
Richard M. Stallman's avatar
Richard M. Stallman committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
			       (if (>= delta-y 0)
				   (loop for y from y1 below y2
					 collect (cons x1 y))
				 (loop for y from y1 above y2
				       collect (cons x1 y))))
			      ((zerop slope) ; (= y1 y2)
			       (if (>= delta-x 0)
				   (loop for x from x1 below x2
					 collect (cons x y1))
				 (loop for x from x1 above x2
				       collect (cons x y1))))
			      ((>= (abs delta-x) (abs delta-y))
			       (if (> delta-x 0)
				   (loop for x from x1 below x2
					 collect (cons x
						       (+ y1
							  (round (* slope
								    (- x x1))))))
				 (loop for x from x1 above x2
				       collect (cons x
						     (+ y1
							(round (* slope
								  (- x x1))))))))
			      (t	; (< (abs delta-x) (abs delta-y))
			       (if (> delta-y 0)
				   (loop for y from y1 below y2
					 collect (cons (+ x1
							  (round (/ (- y y1)
								    slope)))
						       y))
				 (loop for y from y1 above y2
				       collect (cons (+ x1
							(round (/ (- y y1)
								  slope)))
						     y))))))))))

(defun strokes-rate-stroke (stroke1 stroke2)
Dave Love's avatar
Dave Love committed
652
  "Rates STROKE1 with STROKE2 and return a score based on a distance metric.
Richard M. Stallman's avatar
Richard M. Stallman committed
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
Note: the rating is an error rating, and therefore, a return of 0
represents a perfect match.  Also note that the order of stroke
arguments is order-independent for the algorithm used here."
  (if (and stroke1 stroke2)
      (let ((rest1 (cdr stroke1))
	    (rest2 (cdr stroke2))
	    (err (strokes-distance-squared (car stroke1)
					   (car stroke2))))
	(while (and rest1 rest2)
	  (while (and (consp (car rest1))
		      (consp (car rest2)))
	    (setq err (+ err
			 (strokes-distance-squared (car rest1)
						   (car rest2)))
		  stroke1 rest1
		  stroke2 rest2
		  rest1 (cdr stroke1)
		  rest2 (cdr stroke2)))
	  (cond ((and (strokes-lift-p (car rest1))
		      (strokes-lift-p (car rest2)))
		 (setq rest1 (cdr rest1)
		       rest2 (cdr rest2)))
		((strokes-lift-p (car rest2))
		 (while (consp (car rest1))
		   (setq err (+ err
				(strokes-distance-squared (car rest1)
							  (car stroke2)))
			 rest1 (cdr rest1))))
		((strokes-lift-p (car rest1))
		 (while (consp (car rest2))
		   (setq err (+ err
				(strokes-distance-squared (car stroke1)
							  (car rest2)))
			 rest2 (cdr rest2))))))
	(if (null rest2)
	    (while (consp (car rest1))
	      (setq err (+ err
			   (strokes-distance-squared (car rest1)
						     (car stroke2)))
		    rest1 (cdr rest1))))
	(if (null rest1)
	    (while (consp (car rest2))
	      (setq err (+ err
			   (strokes-distance-squared (car stroke1)
						     (car rest2)))
		    rest2 (cdr rest2))))
	(if (or (strokes-lift-p (car rest1))
		(strokes-lift-p (car rest2)))
	    (setq err nil)
	  err))
    nil))

(defun strokes-match-stroke (stroke stroke-map)
Dave Love's avatar
Dave Love committed
706
  "Find the best matching command of STROKE in STROKE-MAP.
Richard M. Stallman's avatar
Richard M. Stallman committed
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
Returns the corresponding match as (COMMAND . SCORE)."
  (if (and stroke stroke-map)
      (let ((score (strokes-rate-stroke stroke (caar stroke-map)))
	    (command (cdar stroke-map))
	    (map (cdr stroke-map)))
	(while map
	  (let ((newscore (strokes-rate-stroke stroke (caar map))))
	    (if (or (and newscore score (< newscore score))
		    (and newscore (null score)))
		(setq score newscore
		      command (cdar map)))
	    (setq map (cdr map))))
	(if score
	    (cons command score)
	  nil))
    nil))

;;;###autoload
(defun strokes-read-stroke (&optional prompt event)
  "Read a simple stroke (interactively) and return the stroke.
Optional PROMPT in minibuffer displays before and during stroke reading.
This function will display the stroke interactively as it is being
entered in the strokes buffer if the variable
`strokes-use-strokes-buffer' is non-nil.
731
Optional EVENT is acceptable as the starting event of the stroke."
Richard M. Stallman's avatar
Richard M. Stallman committed
732
  (save-excursion
Richard M. Stallman's avatar
Richard M. Stallman committed
733 734 735 736 737 738 739 740 741
    (let ((pix-locs nil)
	  (grid-locs nil)
	  (safe-to-draw-p nil))
      (if strokes-use-strokes-buffer
	  ;; switch to the strokes buffer and
	  ;; display the stroke as it's being read
	  (save-window-excursion
	    (set-window-configuration strokes-window-configuration)
	    (when prompt
Deepak Goel's avatar
Deepak Goel committed
742
	      (message "%s" prompt)
Richard M. Stallman's avatar
Richard M. Stallman committed
743
	      (setq event (read-event))
744
	      (or (strokes-button-press-event-p event)
Richard M. Stallman's avatar
Richard M. Stallman committed
745 746 747 748 749
		  (error "You must draw with the mouse")))
	    (unwind-protect
		(track-mouse
		  (or event (setq event (read-event)
				  safe-to-draw-p t))
750
		  (while (not (strokes-button-release-event-p event))
Richard M. Stallman's avatar
Richard M. Stallman committed
751 752
		    (if (strokes-mouse-event-p event)
			(let ((point (strokes-event-closest-point event)))
Richard M. Stallman's avatar
Richard M. Stallman committed
753 754 755 756
			  (if (and point safe-to-draw-p)
			      ;; we can draw that point
			      (progn
				(goto-char point)
Dave Love's avatar
Dave Love committed
757
				(subst-char-in-region point (1+ point)
758
						      ?\s strokes-character))
Richard M. Stallman's avatar
Richard M. Stallman committed
759 760
			    ;; otherwise, we can start drawing the next time...
			    (setq safe-to-draw-p t))
761
			  (push (cdr (mouse-pixel-position))
Richard M. Stallman's avatar
Richard M. Stallman committed
762
				pix-locs)))
Richard M. Stallman's avatar
Richard M. Stallman committed
763
		    (setq event (read-event)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
764
	    ;; protected
Richard M. Stallman's avatar
Richard M. Stallman committed
765
	    ;; clean up strokes buffer and then bury it.
Richard M. Stallman's avatar
Richard M. Stallman committed
766
	    (when (equal (buffer-name) strokes-buffer-name)
Dave Love's avatar
Dave Love committed
767
	      (subst-char-in-region (point-min) (point-max)
768
				    strokes-character ?\s)
Richard M. Stallman's avatar
Richard M. Stallman committed
769
	      (goto-char (point-min))
Richard M. Stallman's avatar
Richard M. Stallman committed
770 771 772
	      (bury-buffer))))
      ;; Otherwise, don't use strokes buffer and read stroke silently
      (when prompt
Deepak Goel's avatar
Deepak Goel committed
773
	(message "%s" prompt)
Richard M. Stallman's avatar
Richard M. Stallman committed
774
	(setq event (read-event))
775
	(or (strokes-button-press-event-p event)
Richard M. Stallman's avatar
Richard M. Stallman committed
776 777 778
	    (error "You must draw with the mouse")))
      (track-mouse
	(or event (setq event (read-event)))
779
	(while (not (strokes-button-release-event-p event))
Richard M. Stallman's avatar
Richard M. Stallman committed
780
	  (if (strokes-mouse-event-p event)
781
	      (push (cdr (mouse-pixel-position))
Richard M. Stallman's avatar
Richard M. Stallman committed
782 783 784
		    pix-locs))
	  (setq event (read-event))))
      (setq grid-locs (strokes-renormalize-to-grid (nreverse pix-locs)))
Dave Love's avatar
Dave Love committed
785 786
      (strokes-fill-stroke
       (strokes-eliminate-consecutive-redundancies grid-locs)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
787 788 789 790 791 792

;;;###autoload
(defun strokes-read-complex-stroke (&optional prompt event)
  "Read a complex stroke (interactively) and return the stroke.
Optional PROMPT in minibuffer displays before and during stroke reading.
Note that a complex stroke allows the user to pen-up and pen-down.  This
Dave Love's avatar
Dave Love committed
793 794
is implemented by allowing the user to paint with button 1 or button 2 and
then complete the stroke with button 3.
795
Optional EVENT is acceptable as the starting event of the stroke."
Richard M. Stallman's avatar
Richard M. Stallman committed
796 797 798 799 800 801
  (save-excursion
    (save-window-excursion
      (set-window-configuration strokes-window-configuration)
      (let ((pix-locs nil)
	    (grid-locs nil))
	(if prompt
802
	    (while (not (strokes-button-press-event-p event))
Deepak Goel's avatar
Deepak Goel committed
803
	      (message "%s" prompt)
Richard M. Stallman's avatar
Richard M. Stallman committed
804 805 806 807
	      (setq event (read-event))))
	(unwind-protect
	    (track-mouse
	      (or event (setq event (read-event)))
808 809 810 811 812
	      (while (not (and (strokes-button-press-event-p event)
			       (eq 'mouse-3
				   (car (get (car event)
					     'event-symbol-elements)))))
		(while (not (strokes-button-release-event-p event))
Richard M. Stallman's avatar
Richard M. Stallman committed
813 814 815 816
		  (if (strokes-mouse-event-p event)
		      (let ((point (strokes-event-closest-point event)))
			(when point
			  (goto-char point)
Dave Love's avatar
Dave Love committed
817
			  (subst-char-in-region point (1+ point)
818
						?\s strokes-character))
819
			(push (cdr (mouse-pixel-position))
Richard M. Stallman's avatar
Richard M. Stallman committed
820 821 822
			      pix-locs)))
		  (setq event (read-event)))
		(push strokes-lift pix-locs)
823
		(while (not (strokes-button-press-event-p event))
Richard M. Stallman's avatar
Richard M. Stallman committed
824 825 826 827
		  (setq event (read-event))))
	      ;; ### KLUDGE! ### sit and wait
	      ;; for some useless event to
	      ;; happen to fix the minibuffer bug.
828
	      (while (not (strokes-button-release-event-p (read-event))))
Richard M. Stallman's avatar
Richard M. Stallman committed
829 830 831 832 833 834
	      (setq pix-locs (nreverse (cdr pix-locs))
		    grid-locs (strokes-renormalize-to-grid pix-locs))
	      (strokes-fill-stroke
	       (strokes-eliminate-consecutive-redundancies grid-locs)))
	  ;; protected
	  (when (equal (buffer-name) strokes-buffer-name)
Dave Love's avatar
Dave Love committed
835
	    (subst-char-in-region (point-min) (point-max)
836
				  strokes-character ?\s)
Richard M. Stallman's avatar
Richard M. Stallman committed
837 838
	    (goto-char (point-min))
	    (bury-buffer)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
839 840 841 842 843 844 845 846 847

(defun strokes-execute-stroke (stroke)
  "Given STROKE, execute the command which corresponds to it.
The command will be executed provided one exists for that stroke,
based on the variable `strokes-minimum-match-score'.
If no stroke matches, nothing is done and return value is nil."
  (let* ((match (strokes-match-stroke stroke strokes-global-map))
	 (command (car match))
	 (score (cdr match)))
Dave Love's avatar
Dave Love committed
848
    (cond ((and match (<= score strokes-minimum-match-score))
Richard M. Stallman's avatar
Richard M. Stallman committed
849 850 851 852
	   (message "%s" command)
	   (command-execute command))
	  ((null strokes-global-map)
	   (if (file-exists-p strokes-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
853
	       (and (y-or-n-p
Richard M. Stallman's avatar
Richard M. Stallman committed
854 855 856
		     (format "No strokes loaded.  Load `%s'? "
			     strokes-file))
		    (strokes-load-user-strokes))
Dave Love's avatar
Dave Love committed
857
	     (error "No strokes defined; use `strokes-global-set-stroke'")))
Richard M. Stallman's avatar
Richard M. Stallman committed
858 859 860 861 862 863 864
	  (t
	   (error
	    "No stroke matches; see variable `strokes-minimum-match-score'")
	   nil))))

;;;###autoload
(defun strokes-do-stroke (event)
865
  "Read a simple stroke from the user and then execute its command.
Richard M. Stallman's avatar
Richard M. Stallman committed
866 867 868 869 870 871 872
This must be bound to a mouse event."
  (interactive "e")
  (or strokes-mode (strokes-mode t))
  (strokes-execute-stroke (strokes-read-stroke nil event)))

;;;###autoload
(defun strokes-do-complex-stroke (event)
873
  "Read a complex stroke from the user and then execute its command.
Richard M. Stallman's avatar
Richard M. Stallman committed
874 875 876 877 878 879 880 881 882 883 884
This must be bound to a mouse event."
  (interactive "e")
  (or strokes-mode (strokes-mode t))
  (strokes-execute-stroke (strokes-read-complex-stroke nil event)))

;;;###autoload
(defun strokes-describe-stroke (stroke)
  "Displays the command which STROKE maps to, reading STROKE interactively."
  (interactive
   (list
    (strokes-read-complex-stroke
Dave Love's avatar
Dave Love committed
885
     "Enter stroke to describe; end with button 3...")))
Richard M. Stallman's avatar
Richard M. Stallman committed
886
  (let* ((match (strokes-match-stroke stroke strokes-global-map))
Dave Love's avatar
Dave Love committed
887
	 (command (car match))
Richard M. Stallman's avatar
Richard M. Stallman committed
888
	 (score (cdr match)))
Dave Love's avatar
Dave Love committed
889 890
    (if (and match
	     (<= score strokes-minimum-match-score))
Richard M. Stallman's avatar
Richard M. Stallman committed
891 892 893 894 895
	(message "That stroke maps to `%s'" command)
      (message "That stroke is undefined"))
    (sleep-for 1)))			; helpful for recursive edits

;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
896
(defun strokes-help ()
897
  "Get instruction on using the Strokes package."
Richard M. Stallman's avatar
Richard M. Stallman committed
898
  (interactive)
Dave Love's avatar
Dave Love committed
899 900
  (with-output-to-temp-buffer "*Help with Strokes*"
    (princ
901 902
     (substitute-command-keys
      "This is help for the strokes package.
Richard M. Stallman's avatar
Richard M. Stallman committed
903

Richard M. Stallman's avatar
Richard M. Stallman committed
904
------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
905

Richard M. Stallman's avatar
Richard M. Stallman committed
906
** Strokes...
Richard M. Stallman's avatar
Richard M. Stallman committed
907

Richard M. Stallman's avatar
Richard M. Stallman committed
908 909 910 911 912
The strokes package allows you to define strokes, made with
the mouse or other pointer device, that Emacs can interpret as
corresponding to commands, and then executes the commands.  It does
character recognition, so you don't have to worry about getting it
right every time.
Richard M. Stallman's avatar
Richard M. Stallman committed
913

914
Strokes also allows you to compose documents graphically.  You can
915
fully edit documents in Chinese, Japanese, etc. based on Emacs
Dave Love's avatar
Dave Love committed
916
strokes.  Once you've done so, you can ASCII compress-and-encode them
917 918 919 920 921
and then safely save them for later use, send letters to friends
\(using Emacs, of course).  Strokes will later decode these documents,
extracting the strokes for editing use once again, so the editing
cycle can continue.

Richard M. Stallman's avatar
Richard M. Stallman committed
922 923 924
Strokes are easy to program and fun to use.  To start strokes going,
you'll want to put the following line in your .emacs file as mentioned
in the commentary to strokes.el.
Richard M. Stallman's avatar
Richard M. Stallman committed
925

Richard M. Stallman's avatar
Richard M. Stallman committed
926 927
This will load strokes when and only when you start Emacs on a window
system, with a mouse or other pointer device defined.
Richard M. Stallman's avatar
Richard M. Stallman committed
928

Richard M. Stallman's avatar
Richard M. Stallman committed
929
To toggle strokes-mode, you just do
Richard M. Stallman's avatar
Richard M. Stallman committed
930

Richard M. Stallman's avatar
Richard M. Stallman committed
931
> M-x strokes-mode
Richard M. Stallman's avatar
Richard M. Stallman committed
932

933
** Strokes for controlling the behavior of Emacs...
Richard M. Stallman's avatar
Richard M. Stallman committed
934

Richard M. Stallman's avatar
Richard M. Stallman committed
935
When you're ready to start defining strokes, just use the command
Richard M. Stallman's avatar
Richard M. Stallman committed
936

Dave Love's avatar
Dave Love committed
937
> M-x strokes-global-set-stroke
Richard M. Stallman's avatar
Richard M. Stallman committed
938

Richard M. Stallman's avatar
Richard M. Stallman committed
939
You will see a ` *strokes*' buffer which is waiting for you to enter in
Dave Love's avatar
Dave Love committed
940 941
your stroke.  When you enter in the stroke, you draw with button 1 or
button 2, and then end with button 3.  Next, you enter in the command
Richard M. Stallman's avatar
Richard M. Stallman committed
942 943 944
which will be executed when that stroke is invoked.  Simple as that.
For now, try to define a stroke to copy a region.  This is a popular
edit command, so type
Richard M. Stallman's avatar
Richard M. Stallman committed
945

Dave Love's avatar
Dave Love committed
946
> M-x strokes-global-set-stroke
Richard M. Stallman's avatar
Richard M. Stallman committed
947

948
Then, in the ` *strokes*' buffer, draw the letter `C' (for `copy')
Richard M. Stallman's avatar
Richard M. Stallman committed
949
and then, when it asks you to enter the command to map that to, type
Richard M. Stallman's avatar
Richard M. Stallman committed
950

Richard M. Stallman's avatar
Richard M. Stallman committed
951
> copy-region-as-kill
Richard M. Stallman's avatar
Richard M. Stallman committed
952

Richard M. Stallman's avatar
Richard M. Stallman committed
953
That's about as hard as it gets.
Dave Love's avatar
Dave Love committed
954
Remember: paint with button 1 or button 2 and then end with button 3.
Richard M. Stallman's avatar
Richard M. Stallman committed
955

Richard M. Stallman's avatar
Richard M. Stallman committed
956
If ever you want to know what a certain strokes maps to, then do
Richard M. Stallman's avatar
Richard M. Stallman committed
957

Dave Love's avatar
Dave Love committed
958
> M-x strokes-describe-stroke
Richard M. Stallman's avatar
Richard M. Stallman committed
959

Richard M. Stallman's avatar
Richard M. Stallman committed
960
and you can enter in any arbitrary stroke.  Remember: The strokes
961
package lets you program in simple and complex (multi-lift) strokes.
Richard M. Stallman's avatar
Richard M. Stallman committed
962 963
The only difference is how you *invoke* the two.  You will most likely
use simple strokes, as complex strokes were developed for
Dave Love's avatar
Dave Love committed
964 965
Chinese/Japanese/Korean.  So the shifted middle mouse button (S-mouse-2) will
invoke the command `strokes-do-stroke'.
Richard M. Stallman's avatar
Richard M. Stallman committed
966

Richard M. Stallman's avatar
Richard M. Stallman committed
967 968
If ever you define a stroke which you don't like, then you can unset
it with the command
Richard M. Stallman's avatar
Richard M. Stallman committed
969

Richard M. Stallman's avatar
Richard M. Stallman committed
970
> M-x strokes-unset-last-stroke
Richard M. Stallman's avatar
Richard M. Stallman committed
971

972 973 974 975 976 977 978 979 980 981 982 983 984 985
You can always get an idea of what your current strokes look like with
the command

> M-x strokes-list-strokes

Your strokes will be displayed in alphabetical order (based on command
names) and the beginning of each simple stroke will be marked by a
color dot.  Since you may have several simple strokes in a complex
stroke, the dot colors are arranged in the rainbow color sequence,
`ROYGBIV'.  If you want a listing of your strokes from most recent
down, then use a prefix argument:

> C-u M-x strokes-list-strokes

Richard M. Stallman's avatar
Richard M. Stallman committed
986 987 988 989 990
Your strokes are stored as you enter them.  They get saved in a file
called ~/.strokes, along with other strokes configuration variables.
You can change this location by setting the variable `strokes-file'.
You will be prompted to save them when you exit Emacs, or you can save
them with
Richard M. Stallman's avatar
Richard M. Stallman committed
991

992
> M-x strokes-prompt-user-save-strokes
Richard M. Stallman's avatar
Richard M. Stallman committed
993

Richard M. Stallman's avatar
Richard M. Stallman committed
994 995
Your strokes get loaded automatically when you enable `strokes-mode'.
You can also load in your user-defined strokes with
Richard M. Stallman's avatar
Richard M. Stallman committed
996

Dave Love's avatar
Dave Love committed
997
> M-x strokes-load-user-strokes
Richard M. Stallman's avatar
Richard M. Stallman committed
998

999 1000 1001
** Strokes for pictographic editing...

If you'd like to create graphical files with strokes, you'll have to
Dave Love's avatar
Dave Love committed
1002 1003 1004 1005 1006 1007 1008
be running a version of Emacs with XPM support.  You use the binding
to `strokes-compose-complex-stroke' to start drawing your strokes.
These are just complex strokes, and thus continue drawing with mouse-1
or mouse-2 and end with mouse-3.  Then the stroke image gets inserted
into the buffer.  You treat it somewhat like any other character,
which you can copy, paste, delete, move, etc.  When all is done, you
may want to send the file, or save it.  This is done with
1009 1010 1011 1012 1013 1014 1015

> M-x strokes-encode-buffer

Likewise, to decode the strokes from a strokes-encoded buffer you do

> M-x strokes-decode-buffer

Richard M. Stallman's avatar
Richard M. Stallman committed
1016
** A few more important things...
Richard M. Stallman's avatar
Richard M. Stallman committed
1017

1018 1019 1020
o The command `strokes-do-complex-stroke' is invoked with M-mouse-2,
  so that you can execute complex strokes (i.e. with more than one lift)
  if preferred.
Richard M. Stallman's avatar
Richard M. Stallman committed
1021

Richard M. Stallman's avatar
Richard M. Stallman committed
1022 1023 1024
o Strokes are a bit computer-dependent in that they depend somewhat on
  the speed of the computer you're working on.  This means that you
  may have to tweak some variables.  You can read about them in the
Dave Love's avatar
Dave Love committed
1025
  commentary of `strokes.el'.  Better to just use \\[apropos] and read their
Richard M. Stallman's avatar
Richard M. Stallman committed
1026 1027 1028 1029
  docstrings.  All variables/functions start with `strokes'.  The one
  variable which many people wanted to see was
  `strokes-use-strokes-buffer' which allows the user to use strokes
  silently--without displaying the strokes.  All variables can be set
1030
  by customizing the group `strokes' via \\[customize-group]."))
Dave Love's avatar
Dave Love committed
1031
    (set-buffer standard-output)
1032 1033
    (help-mode)
    (print-help-return-message)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1034

Dave Love's avatar
Dave Love committed
1035
(defalias 'strokes-report-bug 'report-emacs-bug)
Richard M. Stallman's avatar
Richard M. Stallman committed
1036 1037

(defsubst strokes-fill-current-buffer-with-whitespace ()
1038
  "Erase the contents of the current buffer and fill it with whitespace."
Richard M. Stallman's avatar
Richard M. Stallman committed
1039 1040
  (erase-buffer)
  (loop repeat (frame-height) do
1041
	(insert-char ?\s (1- (frame-width)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1042 1043 1044
	(newline))
  (goto-char (point-min)))

1045 1046
(defun strokes-window-configuration-changed-p ()
  "Non-nil if the `strokes-window-configuration' frame properties changed.
Dave Love's avatar
Dave Love committed
1047
This is based on the last time `strokes-window-configuration' was updated."
1048 1049 1050
  (compare-window-configurations (current-window-configuration)
				 strokes-window-configuration))

Richard M. Stallman's avatar
Richard M. Stallman committed
1051
(defun strokes-update-window-configuration ()
1052
  "Ensure that `strokes-window-configuration' is up-to-date."
Richard M. Stallman's avatar
Richard M. Stallman committed
1053 1054 1055 1056 1057 1058 1059 1060
  (interactive)
  (let ((current-window (selected-window)))
    (cond ((or (window-minibuffer-p current-window)
	       (window-dedicated-p current-window))
	   ;; don't try to update strokes window configuration
	   ;; if window is dedicated or a minibuffer
	   nil)
	  ((or (interactive-p)
1061
	       (not (buffer-live-p (get-buffer strokes-buffer-name)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
	       (null strokes-window-configuration))
	   ;; create `strokes-window-configuration' from scratch...
	   (save-excursion
	     (save-window-excursion
	       (get-buffer-create strokes-buffer-name)
	       (set-window-buffer current-window strokes-buffer-name)
	       (delete-other-windows)
	       (fundamental-mode)
	       (auto-save-mode 0)
	       (if (featurep 'font-lock)
		   (font-lock-mode 0))
	       (abbrev-mode 0)
	       (buffer-disable-undo (current-buffer))
	       (setq truncate-lines nil)
	       (strokes-fill-current-buffer-with-whitespace)
	       (setq strokes-window-configuration (current-window-configuration))
	       (bury-buffer))))
1079 1080 1081
	  ((strokes-window-configuration-changed-p) ; simple update
	   ;; update the strokes-window-configuration for this
	   ;; specific frame...
Richard M. Stallman's avatar
Richard M. Stallman committed
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
	   (save-excursion
	     (save-window-excursion
	       (set-window-buffer current-window strokes-buffer-name)
	       (delete-other-windows)
	       (strokes-fill-current-buffer-with-whitespace)
	       (setq strokes-window-configuration (current-window-configuration))
	       (bury-buffer)))))))

;;;###autoload
(defun strokes-load-user-strokes ()
  "Load user-defined strokes from file named by `strokes-file'."
  (interactive)
  (cond ((and (file-exists-p strokes-file)
	      (file-readable-p strokes-file))
	 (load-file strokes-file))
	((interactive-p)
	 (error "Trouble loading user-defined strokes; nothing done"))
	(t
	 (message "No user-defined strokes, sorry"))))

(defun strokes-prompt-user-save-strokes ()
  "Save user-defined strokes to file named by `strokes-file'."
  (interactive)
  (save-excursion
    (let ((current strokes-global-map))
      (unwind-protect
	  (progn
	    (setq strokes-global-map nil)
	    (strokes-load-user-strokes)
	    (if (and (not (equal current strokes-global-map))
		     (or (interactive-p)
1113
			 (yes-or-no-p "Save your strokes? ")))
Richard M. Stallman's avatar
Richard M. Stallman committed
1114 1115 1116 1117 1118 1119 1120 1121
		(progn
		  (require 'pp)		; pretty-print variables
		  (message "Saving strokes in %s..." strokes-file)
		  (get-buffer-create "*saved-strokes*")
		  (set-buffer "*saved-strokes*")
		  (erase-buffer)
		  (emacs-lisp-mode)
		  (goto-char (point-min))
1122
		  (insert
Dave Love's avatar
Dave Love committed
1123
		   ";;   -*- emacs-lisp -*-\n")
1124
		  (insert (format ";;; saved strokes for %s, as of %s\n\n"
1125 1126
				  (user-full-name)
				  (format-time-string "%B %e, %Y" nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1127
		  (message "Saving strokes in %s..." strokes-file)
Dave Love's avatar
Dave Love committed
1128
		  (insert (format "(setq strokes-global-map\n'%s)"
1129
				  (pp current)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
		  (message "Saving strokes in %s..." strokes-file)
		  (indent-region (point-min) (point-max) nil)
		  (write-region (point-min)
				(point-max)
				strokes-file))
	      (message "(no changes need to be saved)")))
	;; protected
	(if (get-buffer "*saved-strokes*")
	    (kill-buffer (get-buffer "*saved-strokes*")))
	(setq strokes-global-map current)))))

(defun strokes-toggle-strokes-buffer (&optional arg)
  "Toggle the use of the strokes buffer.
Dave Love's avatar
Dave Love committed
1143
In other words, toggle the variable `strokes-use-strokes-buffer'.
Richard M. Stallman's avatar
Richard M. Stallman committed
1144 1145 1146 1147 1148 1149 1150
With ARG, use strokes buffer if and only if ARG is positive or true.
Returns value of `strokes-use-strokes-buffer'."
  (interactive "P")
  (setq strokes-use-strokes-buffer
	(if arg (> (prefix-numeric-value arg) 0)
	  (not strokes-use-strokes-buffer))))

1151
(defun strokes-xpm-for-stroke (&optional stroke bufname b/w-only)
Dave Love's avatar
Dave Love committed
1152
  "Create an XPM pixmap for the given STROKE in buffer ` *strokes-xpm*'.
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169