mirrored from git://git.sv.gnu.org/emacs.git
/
strokes.el
1737 lines (1557 loc) · 66.2 KB
/
strokes.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
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
544
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
571
572
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
614
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
652
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
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; strokes.el --- control Emacs through mouse strokes -*- lexical-binding: t; -*-
;; Copyright (C) 1997, 2000-2024 Free Software Foundation, Inc.
;; Author: David Bakhash <cadet@alum.mit.edu>
;; Maintainer: emacs-devel@gnu.org
;; 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 3 of the License, 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. If not, see <https://www.gnu.org/licenses/>.
;;; 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,
;; 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
;; > M-x strokes-global-set-stroke
;; 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
;; `strokes-global-set-stroke' with a stroke. Likewise, there may
;; eventually be a `strokes-local-set-stroke' command, also analogous
;; to `local-set-key'.
;; 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
;; > M-x strokes-describe-stroke
;; 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
;; `strokes-define-stroke', similar to the `define-key' function.
;; some examples for a 3x3 stroke grid would be
;; (strokes-define-stroke c-mode-stroke-map
;; '((0 . 0) (1 . 1) (2 . 2))
;; 'kill-region)
;; (strokes-define-stroke strokes-global-map
;; '((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
;; entered. The Lisp function to interactively read a stroke is
;; `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
;; makes a stroke acceptable or unacceptable. If your strokes aren't
;; 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.)
;; The default value (9) should be fine for most decent computers.
;; NOTE: This variable should not be set to a number less than 3.
;; `strokes-use-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
;; execute an X command to slow it down. A good possibility is
;; % 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
;; > M-x strokes-prompt-user-save-strokes
;; and it will save your strokes in your `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
;; 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.
;; You can also toggle between strokes mode by simple typing
;; > M-x strokes-mode
;; 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.
;; You can read more about strokes at:
;; https://web.archive.org/web/20041209171947/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:
;; https://web.archive.org/web/20041204163338/http://www.mit.edu/people/cadet/strokes-abc.el
;; which is nothing but a file with some helper commands for inserting
;; alphanumerics and punctuation.
;; 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
;; Nikšić 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.
;; Tasks: (what I'm getting ready for future version)...
;; 2) use 'strokes-read-complex-stroke for Korean, etc.
;; 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
;; surely disappoint some people on decent machines (until they
;; 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.
;; Fixme: Use pbm instead of xpm for pixmaps to work generally.
;;; Code:
;;; Requirements and provisions...
(autoload 'mail-position-on-field "sendmail")
(eval-when-compile (require 'cl-lib))
;;; Constants...
(defconst strokes-lift :strokes-lift
"Symbol representing a stroke lift event for complex strokes.
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"
"The header to all XPM buffers created by strokes.")
;;; user variables...
(defgroup strokes nil
"Control Emacs through mouse strokes."
:link '(emacs-commentary-link "strokes")
:group 'mouse)
(defcustom strokes-lighter " Strokes"
"Mode line identifier for Strokes mode."
:type 'string)
(defcustom strokes-character ?@
"Character used when drawing strokes in the strokes buffer.
\(The default is `@', which works well.)"
:type 'character)
(defcustom strokes-minimum-match-score 1000
"Minimum score for a stroke to be considered a possible match.
Setting this variable to 0 would require a perfectly precise match.
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
to handle (though the defaults are usually more than sufficient), and
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)
(defcustom strokes-grid-resolution 9
"Integer defining dimensions of the stroke grid.
The grid is a square grid, where `strokes-grid-resolution' defaults to
`9', making a 9x9 grid whose coordinates go from (0 . 0) on the top
left to ((strokes-grid-resolution - 1) . (strokes-grid-resolution - 1))
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 'natnum)
(defcustom strokes-file (locate-user-emacs-file "strokes" ".strokes")
"File containing saved strokes for Strokes mode."
:version "24.4" ; added locate-user-emacs-file
:type 'file)
(defvar strokes-buffer-name " *strokes*"
"The name of the buffer that the strokes take place in.")
(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)
(defvar strokes-no-match-function 'strokes-no-match-default
"Function run by `strokes-execute-stroke' when no stroke matches.
The function is called with two arguments, the stroke and the
closest match returned by `strokes-match-stroke'. It can be used
to show detailed information about the unmatched stroke or
perform some fallback action. The default function
`strokes-no-match-default' simply signals an error.")
;;; 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, since that is the best time to set the variable.")
(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 corresponding interactive function.")
(defvar strokes-load-hook nil
"Functions to be called when Strokes is loaded.")
(make-obsolete-variable 'strokes-load-hook
"use `with-eval-after-load' instead." "28.1")
;;; ### 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]
;; ))
;;; Macros...
(defsubst strokes-click-p (stroke)
"Non-nil if STROKE is really click."
(< (length stroke) 2))
;;; 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"
;; (list 'if (list '< (list 'length stroke) 2)
;; (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)
(let (elt)
(while (setq elt (assoc key list))
(setq list (delete elt list))))
list)
(defmacro strokes-define-stroke (stroke-map stroke def)
"Add STROKE to STROKE-MAP alist with given command DEF."
`(if (strokes-click-p ,stroke)
(error "That's a click, not a stroke")
(setq ,stroke-map (cons (cons ,stroke ,def)
(strokes-remassoc ,stroke ,stroke-map)))))
(defsubst strokes-square (x)
"Return the square of the number X."
(* x x))
(defsubst strokes-distance-squared (p1 p2)
"Compute 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)
(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)))))
(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,
or for window START-WINDOW if that is specified."
(or start-window (setq start-window (posn-window (event-start event))))
(if (eq start-window (posn-window (event-end event)))
(if (eq (posn-point (event-end event)) 'vertical-line)
(strokes-event-closest-point-1 start-window
(cdr (posn-col-row (event-end event))))
(if (eq (posn-point (event-end event)) 'mode-line)
(strokes-event-closest-point-1 start-window)
(posn-point (event-end event))))
;; 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)))
(frame-char-height end-w))))
(if (>= end-w-top w-top)
(strokes-event-closest-point-1 start-window)
(window-start start-window)))))
(defun strokes-lift-p (object)
"Return non-nil if OBJECT is a stroke-lift."
(eq object strokes-lift))
(defun strokes-unset-last-stroke ()
"Undo the last stroke definition."
(interactive)
(let ((command (cdar strokes-global-map)))
(if (y-or-n-p
(format-message
"Really delete last stroke definition, defined to `%s'? "
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.
Works 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
documentation for the `strokes-define-stroke' function.
See also `strokes-global-set-stroke-string'."
(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-command "Command to map stroke to: ")))
(strokes-define-stroke strokes-global-map stroke command))
(defun strokes-global-set-stroke-string (stroke string)
"Interactively give STROKE the global binding as STRING.
Works 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))
;;(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)
"Map POSITION to a new grid position.
Do so based on its STROKE-EXTENT and GRID-RESOLUTION.
STROKE-EXTENT is a list ((XMIN . YMIN) (XMAX . YMAX)).
If POSITION is a `strokes-lift', then it is itself returned.
Optional GRID-RESOLUTION may be used in place of `strokes-grid-resolution'.
The grid is a square whose dimension is [0,GRID-RESOLUTION)."
(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
(xmax (1+ (car (cadr stroke-extent))))
(ymax (1+ (cdr (cadr stroke-extent)))))
(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)
"From a list of absolute PIXEL-POSITIONS, return absolute spatial extent.
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)
"Return a list with no consecutive redundant entries."
;; defun a grande vitesse grace a Dave G.
(cl-loop for element on entries
if (not (equal (car element) (cadr element)))
collect (car element)))
;; (cl-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.
Optional GRID-RESOLUTION may be used in place of `strokes-grid-resolution'.
The grid is a square whose dimension is [0,GRID-RESOLUTION)."
(or grid-resolution (setq grid-resolution strokes-grid-resolution))
(let ((stroke-extent (strokes-get-stroke-extent positions)))
(mapcar (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 `strokes-click-p'.
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
(cl-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))
((null slope) ; undefined vertical slope
(if (>= delta-y 0)
(cl-loop for y from y1 below y2
collect (cons x1 y))
(cl-loop for y from y1 above y2
collect (cons x1 y))))
((zerop slope) ; (= y1 y2)
(if (>= delta-x 0)
(cl-loop for x from x1 below x2
collect (cons x y1))
(cl-loop for x from x1 above x2
collect (cons x y1))))
((>= (abs delta-x) (abs delta-y))
(if (> delta-x 0)
(cl-loop for x from x1 below x2
collect (cons x
(+ y1
(round (* slope
(- x x1))))))
(cl-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)
;; FIXME: Reduce redundancy between branches.
(cl-loop for y from y1 below y2
collect (cons (+ x1
(round (/ (- y y1)
slope)))
y))
(cl-loop for y from y1 above y2
collect (cons (+ x1
(round (/ (- y y1)
slope)))
y))))))))))
(defun strokes-rate-stroke (stroke1 stroke2)
"Rate STROKE1 with STROKE2 and return a score based on a distance metric.
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)
"Find the best matching command of STROKE in STROKE-MAP.
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))
(defsubst strokes-fill-current-buffer-with-whitespace ()
"Erase the contents of the current buffer and fill it with whitespace."
(erase-buffer)
(cl-loop repeat (frame-height) do
(insert-char ?\s (1- (frame-width)))
(newline))
(goto-char (point-min)))
;;;###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.
Optional EVENT is acceptable as the starting event of the stroke."
(save-excursion
(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)
;; The frame has been resized, so we need to refill the
;; strokes buffer so that the strokes canvas is the whole
;; visible buffer.
(unless (> 1 (abs (- (line-end-position) (window-width))))
(strokes-fill-current-buffer-with-whitespace))
(when prompt
(message "%s" prompt)
(setq event (read--potential-mouse-event))
(or (strokes-button-press-event-p event)
(error "You must draw with the mouse")))
(unwind-protect
(track-mouse
(or event (setq event (read--potential-mouse-event)
safe-to-draw-p t))
(while (not (strokes-button-release-event-p event))
(if (strokes-mouse-event-p event)
(let ((point (strokes-event-closest-point event)))
(if (and point safe-to-draw-p)
;; we can draw that point
(progn
(goto-char point)
(subst-char-in-region point (1+ point)
?\s strokes-character))
;; otherwise, we can start drawing the next time...
(setq safe-to-draw-p t))
(push (cdr (mouse-pixel-position))
pix-locs)))
(setq event (read--potential-mouse-event))))
;; protected
;; clean up strokes buffer and then bury it.
(when (equal (buffer-name) strokes-buffer-name)
(subst-char-in-region (point-min) (point-max)
strokes-character ?\s)
(goto-char (point-min))
(bury-buffer))))
;; Otherwise, don't use strokes buffer and read stroke silently
(when prompt
(message "%s" prompt)
(setq event (read--potential-mouse-event))
(or (strokes-button-press-event-p event)
(error "You must draw with the mouse")))
(track-mouse
(or event (setq event (read--potential-mouse-event)))
(while (not (strokes-button-release-event-p event))
(if (strokes-mouse-event-p event)
(push (cdr (mouse-pixel-position))
pix-locs))
(setq event (read--potential-mouse-event)))))
(setq grid-locs (strokes-renormalize-to-grid (nreverse pix-locs)))
(strokes-fill-stroke
(strokes-eliminate-consecutive-redundancies grid-locs)))))
;;;###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
is implemented by allowing the user to paint with button 1 or button 2 and
then complete the stroke with button 3.
Optional EVENT is acceptable as the starting event of the stroke."
(save-excursion
(save-window-excursion
(set-window-configuration strokes-window-configuration)
(let ((pix-locs nil)
(grid-locs nil))
(if prompt
(while (not (strokes-button-press-event-p event))
(message "%s" prompt)
(setq event (read--potential-mouse-event))))
(unwind-protect
(track-mouse
(or event (setq event (read--potential-mouse-event)))
(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))
(if (strokes-mouse-event-p event)
(let ((point (strokes-event-closest-point event)))
(when point
(goto-char point)
(subst-char-in-region point (1+ point)
?\s strokes-character))
(push (cdr (mouse-pixel-position))
pix-locs)))
(setq event (read--potential-mouse-event)))
(push strokes-lift pix-locs)
(while (not (strokes-button-press-event-p event))
(setq event (read--potential-mouse-event))))
;; ### KLUDGE! ### sit and wait
;; for some useless event to
;; happen to fix the minibuffer bug.
(while (not (strokes-button-release-event-p
(read--potential-mouse-event))))
(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)
(subst-char-in-region (point-min) (point-max)
strokes-character ?\s)
(goto-char (point-min))
(bury-buffer)))))))
(defun strokes-no-match-default (&rest _)
"Signal an error when no stroke matches."
(error
"No stroke matches; see variable `strokes-minimum-match-score'"))
(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, `strokes-no-match-function' is called."
(let* ((match (strokes-match-stroke stroke strokes-global-map))
(command (car match))
(score (cdr match)))
(cond ((and match (<= score strokes-minimum-match-score))
(message "%s" command)
(command-execute command))
((null strokes-global-map)
(if (file-exists-p strokes-file)
(and (y-or-n-p
(format-message "No strokes loaded. Load `%s'? "
strokes-file))
(strokes-load-user-strokes))
(error "No strokes defined; use `strokes-global-set-stroke'")))
(t (funcall strokes-no-match-function stroke match)))))
;;;###autoload
(defun strokes-do-stroke (event)
"Read a simple stroke from the user and then execute its command.
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)
"Read a complex stroke from the user and then execute its command.
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
"Enter stroke to describe; end with button 3...")))
(let* ((match (strokes-match-stroke stroke strokes-global-map))
(command (car match))
(score (cdr match)))
(if (and match
(<= score strokes-minimum-match-score))
(message "That stroke maps to `%s'" command)
(message "That stroke is undefined"))
(sleep-for 1))) ; helpful for recursive edits
;;;###autoload
(defun strokes-help ()
"Get instruction on using the Strokes package."
(interactive)
(with-output-to-temp-buffer "*Help with Strokes*"
(princ
(substitute-command-keys
"This is help for the strokes package.
------------------------------------------------------------
** Strokes...
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.
Strokes also allows you to compose documents graphically. You can
fully edit documents in Chinese, Japanese, etc. based on Emacs
strokes. Once you've done so, you can ASCII compress-and-encode them
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.
To toggle strokes-mode, invoke the command
> \\[strokes-mode]
** Strokes for controlling the behavior of Emacs...
When you're ready to start defining strokes, just use the command
> \\[strokes-global-set-stroke]
You will see a ` *strokes*' buffer which is waiting for you to enter in
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
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
> \\[strokes-global-set-stroke]
Then, in the ` *strokes*' buffer, draw the letter `C' (for `copy')
and then, when it asks you to enter the command to map that to, type
> copy-region-as-kill
That's about as hard as it gets.
Remember: paint with button 1 or button 2 and then end with button 3.
If ever you want to know what a certain strokes maps to, then do
> \\[strokes-describe-stroke]
and you can enter in any arbitrary stroke. Remember: The strokes
package lets you program in simple and complex (multi-lift) strokes.
The only difference is how you *invoke* the two. You will most likely
use simple strokes, as complex strokes were developed for
Chinese/Japanese/Korean. So the shifted middle mouse button (S-mouse-2)
will invoke the command `strokes-do-stroke'.
If ever you define a stroke which you don't like, then you can unset
it with the command
> \\[strokes-unset-last-stroke]
You can always get an idea of what your current strokes look like with
the command
> \\[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:
> \\[universal-argument] \\[strokes-list-strokes]
Your strokes are stored as you enter them. They get saved into the
file specified by the `strokes-file' variable, along with other strokes
configuration variables. You will be prompted to save them when you
exit Emacs, or you can save them with
> \\[strokes-prompt-user-save-strokes]
Your strokes get loaded automatically when you enable `strokes-mode'.
You can also load in your user-defined strokes with
> \\[strokes-load-user-strokes]