-
Notifications
You must be signed in to change notification settings - Fork 10
/
hui-window.el
1308 lines (1203 loc) · 56.1 KB
/
hui-window.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
;;; hui-window.el --- Smart Mouse Key window and modeline depress/release actions. -*- lexical-binding: t; -*-
;;
;; Author: Bob Weiner
;;
;; Orig-Date: 21-Sep-92
;; Last-Mod: 21-Jan-24 at 10:32:38 by Bob Weiner
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
;; Copyright (C) 1992-2024 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
;;; Commentary:
;;
;; Must be loaded AFTER hmouse-alist has been defined in "hui-mouse.el".
;;
;; Handles drags in same window or across windows and modeline presses.
;;
;; The Action and Assist Key specifics per context are summarized in
;; "man/hkey-help.txt".
;;; Code:
;;; ************************************************************************
;;; Other required Elisp libraries
;;; ************************************************************************
(eval-when-compile (defvar assist-flag nil)) ;; Silences free variable compiler warnings
(require 'hycontrol)
;; If installed, use pulse library for momentary highlighting of buffer/file item lines.
(require 'pulse nil t)
(require 'seq)
(require 'hui-select)
;;; ************************************************************************
;;; Public declarations
;;; ************************************************************************
(defvar action-key-depress-args) ; "hmouse-drv.el"
(defvar assist-key-depress-args) ; "hmouse-drv.el"
(defvar action-key-depress-prev-point) ; "hmouse-drv.el"
(defvar assist-key-depress-prev-point) ; "hmouse-drv.el"
(defvar action-key-release-prev-point) ; "hmouse-drv.el"
(defvar assist-key-release-prev-point) ; "hmouse-drv.el"
(defvar assist-key-depress-window) ; "hmouse-drv.el"
(defvar action-key-depress-window) ; "hmouse-drv.el"
(defvar assist-key-release-window) ; "hmouse-drv.el"
(defvar action-key-release-window) ; "hmouse-drv.el"
(defvar assist-key-release-args) ; "hmouse-drv.el"
(defvar action-key-release-args) ; "hmouse-drv.el"
(defvar hkey-value) ; "hui-mouse.el"
(defvar hkey-region) ; "hmouse-drv.el"
(defvar hpath:display-where-alist) ; "hpath.el"
(defvar hpath:display-where) ; "hpath.el"
(defvar action-key-modeline-buffer-id-function) ; "hui-mouse.el"
(declare-function hbut:act "hbut")
(declare-function hbut:action "hbut")
(declare-function hbut:at-p "hbut")
(declare-function hkey-summarize "hmouse-drv")
(declare-function hmouse-save-region "hmouse-drv")
(declare-function hmouse-use-region-p "hmouse-drv")
(declare-function hmouse-window-coordinates "hmouse-drv")
(declare-function smart-helm-alive-p "hui-mouse")
(declare-function smart-helm-line-has-action "hui-mouse")
(declare-function smart-helm-to-minibuffer "hui-mouse")
;;; ************************************************************************
;;; Public variables
;;; ************************************************************************
(defcustom action-key-minibuffer-function #'hyperbole
"*Function run by the Action Key after a click in an inactive minibuffer.
Its default value is `hyperbole', which displays the Hyperbole minibuffer menu."
:type 'function
:group 'hyperbole-keys)
(defcustom assist-key-minibuffer-function #'hui-menu-screen-commands
"*Function run by the Assist Key after a click in an inactive minibuffer.
Its default value is `hui-menu-screen-commands', which displays a popup menu
of screen control commands."
:type 'function
:group 'hyperbole-keys)
;; Set this to `hmouse-context-ibuffer-menu' if you use the ibuffer package.
(defcustom action-key-modeline-function #'hmouse-context-menu
"Function to call when Action Mouse Key is clicked in the center of a modeline."
:type 'function
:group 'hyperbole-keys)
(defcustom assist-key-modeline-function #'hui-menu-screen-commands
"Function to call when Assist Mouse Key is clicked in the center of a modeline."
:type 'function
:group 'hyperbole-keys)
(defun hmouse-map-modes-to-form (mode-forms)
"Map over MODE-FORMS, a sequence of (major-mode(s) form-to-eval) lists.
Return items with a single `major-mode' in the car, (major-mode form-to-eval)."
(apply 'nconc
(mapcar (lambda (modes-form)
(if (sequencep (car modes-form))
(mapcar (lambda (mode) (cons mode (cdr modes-form)))
(car modes-form))
(list modes-form)))
mode-forms)))
(defvar hmouse-drag-item-mode-forms
(hmouse-map-modes-to-form
'((Buffer-menu-mode (Buffer-menu-buffer t))
(ibuffer-mode (ibuffer-current-buffer t))
(helm-major-mode (helm-get-selection (current-buffer)))
;; Note how multiple major modes may be grouped with a single form for item getting.
((dired-mode vc-dired-mode wdired-mode) (or (when (dired-get-filename nil t)
(hmouse-dired-display-here-mode 1)
(dired-get-filename nil t))
;; Drag from first line current directory
;; means move this dired buffer to the
;; release window.
(prog1 (current-buffer)
(hmouse-pulse-buffer)
(bury-buffer))))
(treemacs-mode (if (fboundp 'treemacs-node-buffer-and-position)
(treemacs-node-buffer-and-position)
(error "(hmouse-item-to-window): %s the treemacs package for item dragging support"
(if (fboundp 'treemacs) "Update" "Install"))))))
"List of (major-mode lisp-form) lists.
The car of an item must be a `major-mode' symbol. The cadr of an item
is a Lisp form to evaluate to get the item name at point (typically a
buffer, file or directory name whose contents will be displayed in the
drag release window.")
(defcustom hmouse-pulse-flag t
"Non-nil means pulse visually if supported.
When display supports visual pulsing, then pulse lines and
buffers when an Action Key drag is used to place a buffer, file
or button referent in a window."
:type 'boolean
:group 'hyperbole-keys)
(defvar hmouse-pulse-iterations 40
"Number of iterations in an hmouse-pulse operation when `pulse-flag' is active.
Temporarily override `pulse-iterations' with this for hmouse operations.")
(defvar hmouse-edge-sensitivity 10
"*Number of chars from window edges in which a click is considered at an edge.")
(defvar hmouse-side-sensitivity 5
"*Characters from window side within which a click is considered on the side.
Either direction from window side is considered.")
(defvar hmouse-x-drag-sensitivity 5
"*Number of characters between mouse depress/release for a horizontal drag.
The number of characters mouse must move horizontally between a
depress and release to register as a horizontal drag.")
(defvar hmouse-y-drag-sensitivity 3
"*Number of lines between mouse depress/release to register a vertical drag.
The number of lines mouse must move vertically between a depress
and release to register a vertical drag")
(defvar hmouse-x-diagonal-sensitivity 4
"*Number of characters between mouse depress/release to register a diagonal drag.
The number of characters mouse must move horizontally between a
depress and release to register a diagonal drag")
(defvar hmouse-y-diagonal-sensitivity 3
"*Number of lines between mouse depress/release to register a diagonal drag.
The number of lines mouse must move vertically between a depress
and release to register a diagonal drag.")
;; Ensure any helm item at Action Mouse Key depress point is selected
;; before a drag that ends in another window.
(add-hook 'action-key-depress-hook
(lambda () (if (eq major-mode 'helm-major-mode)
;; Select any line with an action.
(smart-helm-line-has-action))))
;;;
;;; Add window handling to hmouse-alist dispatch table.
(defvar hmouse-alist)
(defun hmouse-alist-add-window-handlers ()
"Add Smart Mouse Key drag actions to `hmouse-alist'."
(unless (assoc '(hmouse-inactive-minibuffer-p) hmouse-alist)
(setq hmouse-alist
(append
'(
((hmouse-drag-thing)
. ((hmouse-yank-region) . (hmouse-kill-and-yank-region)))
((hmouse-drag-window-side)
. ((hmouse-resize-window-side) . (hmouse-resize-window-side)))
;;
;; Although Hyperbole can distinguish whether inter-window
;; drags are between frames or not, having different behavior
;; for those 2 cases could be confusing, so treat all
;; modeline drags between windows the same and comment out
;; this next clause.
;; Modeline drag between frames
;; ((and (hmouse-modeline-depress) (hmouse-drag-between-frames)) .
;; ((hmouse-clone-window-to-frame) . (hmouse-move-window-to-frame)))
;;
;; Drag from an item to display (not a Modeline) with release on a Modeline
((and (setq hkey-value (and (not (hmouse-modeline-depress))
(hmouse-modeline-release)
(not (hmouse-modeline-click))))
(hmouse-at-item-p action-key-depress-window))
. ((hmouse-item-to-window t) . (hmouse-swap-buffers)))
;; Drag from within a window (not a Modeline and not an item) with release on a Modeline
(hkey-value
. ((hmouse-buffer-to-window t) . (hmouse-swap-buffers)))
;; Non-vertical Modeline drag between windows
((and (hmouse-modeline-depress) (hmouse-drag-between-windows)
(not (hmouse-drag-vertically-within-emacs)))
. ((hmouse-buffer-to-window) . (hmouse-swap-buffers)))
;; Modeline drag that ends outside of Emacs
((and (hmouse-modeline-depress) (hmouse-drag-outside-all-windows))
. ((hycontrol-clone-window-to-new-frame)
. (hycontrol-window-to-new-frame)))
;; Other Modeline click or drag
((hmouse-modeline-depress)
. ((action-key-modeline) . (assist-key-modeline)))
;; Drag between windows and on an item (buffer-name, file-name or Hyperbole button)
((and (hmouse-drag-between-windows)
(hmouse-at-item-p (if assist-flag assist-key-depress-window
action-key-depress-window)))
. ((hmouse-drag-item-to-display) . (hmouse-drag-item-to-display)))
;; Drag between windows not on an item
((hmouse-drag-between-windows)
;; Note that functions on next line use any region as button name
. ((hui:ibut-link-directly) . (hui:ebut-link-directly)))
((hmouse-drag-region-active)
. ((hmouse-drag-not-allowed) . (hmouse-drag-not-allowed)))
((setq hkey-value (hmouse-drag-horizontally))
. ((hmouse-horizontal-action-drag) . (hmouse-horizontal-assist-drag)))
((hmouse-drag-vertically)
. ((hmouse-vertical-action-drag) . (hmouse-vertical-assist-drag)))
((setq hkey-value (hmouse-drag-diagonally))
. ((call-interactively #'hywconfig-ring-save)
. (call-interactively #'hywconfig-yank-pop)))
;; Window drag that ends outside of Emacs
((hmouse-drag-outside-all-windows)
. ((or (hmouse-drag-item-to-display)
(hycontrol-clone-window-to-new-frame))
. (hycontrol-window-to-new-frame)))
;; If click in the minibuffer when it is not active (blank),
;; Action Key displays the Hyperbole minibuffer menu and
;; the Assist Key popups the jump menu.
((hmouse-inactive-minibuffer-p)
. ((funcall action-key-minibuffer-function)
. (funcall assist-key-minibuffer-function)))
((and (boundp 'ivy-mode) ivy-mode
(minibuffer-window-active-p (selected-window)))
. ((ivy-mouse-done action-key-release-args)
. (ivy-mouse-dispatching-done assist-key-release-args)))
;; Handle widgets in Custom-mode
((eq major-mode 'Custom-mode)
. ((smart-custom) . (smart-custom-assist)))
;;
;; Now since this is not a drag and if there was an active
;; region prior to when the Action or Assist Key was
;; pressed, then store point at one end of the region into
;; `hkey-value' and the string value of the region
;; into `hkey-region' which is either yanked, or
;; killed and yanked at the current point.
((hmouse-prior-active-region)
. ((hmouse-yank-region) . (hmouse-kill-and-yank-region))))
hmouse-alist))))
(with-eval-after-load 'hui-mouse (hmouse-alist-add-window-handlers))
;;; ************************************************************************
;;; Public functions
;;; ************************************************************************
(defun hmouse-at-item-p (start-window)
"Return t if point is on an item draggable by Hyperbole, otherwise nil.
Draggable items include Hyperbole buttons, Dired items, buffer/ibuffer
menu items."
(let* ((buf (when (window-live-p start-window)
(window-buffer start-window)))
(mode (when buf
(buffer-local-value 'major-mode buf))))
(and buf (save-window-excursion
(select-window start-window)
;; Point must be on an item, not after one
(and (not (looking-at "\\s-*$"))
(or (memq mode (mapcar #'car hmouse-drag-item-mode-forms))
(hbut:at-p))))
t)))
(defun hmouse-context-menu ()
"If running under a window system, display or hide the buffer menu.
If not running under a window system and Smart Menus are loaded, display the
appropriate Smart Menu for the context at point. (Smart Menus are a
part of InfoDock and not a part of Hyperbole)."
(interactive)
(if (and (fboundp 'smart-menu)
(null window-system))
(smart-menu)
(let ((wind (get-buffer-window "*Buffer List*"))
owind)
(if wind
(unwind-protect
(progn (setq owind (selected-window))
(select-window wind)
(bury-buffer nil))
(select-window owind))
(buffer-menu)))))
(defun hmouse-context-ibuffer-menu ()
"If running under a window system, display or hide the IBuffer menu.
If not running under a window system and Smart Menus are loaded, display the
appropriate Smart Menu for the context at point. (Smart Menus are a
part of InfoDock and not a part of Hyperbole)."
(interactive)
(if (and (fboundp 'smart-menu)
(null window-system))
(smart-menu)
(let ((wind (get-buffer-window "*Ibuffer*"))
owind)
(if wind
(unwind-protect
(progn (setq owind (selected-window))
(select-window wind)
(bury-buffer nil))
(select-window owind))
(ibuffer)))))
(defun hmouse-prior-active-region ()
"Return t if there is an active region in buffer of last Smart Mouse Key release."
(when (and (setq hkey-value (if assist-flag assist-key-depress-prev-point action-key-depress-prev-point))
(buffer-live-p (marker-buffer hkey-value)))
(save-excursion
(with-current-buffer (marker-buffer hkey-value)
;; Store and goto any prior value of point from the region
;; prior to the Smart Key depress, so we can return to it later.
(and (goto-char hkey-value)
(hmouse-save-region)
t)))))
(defun hmouse-dired-readin-hook ()
"Remove local `hpath:display-where' setting whenever re-read a Dired directory.
See `hmouse-dired-item-dragged' for use."
(hmouse-dired-display-here-mode 0))
(define-minor-mode hmouse-dired-display-here-mode
"Display item here on key press after Dired item drag.
Once a Dired buffer item has been dragged, make next Action Key
press on an item display it in the same Dired window.
By default an Action Key press on a Dired item displays it in another
window. But once a Dired item is dragged to another window, the next
Action Key press should display it in the Dired window so that the
behavior matches that of Buffer Menu and allows for setting what is
displayed in all windows on screen, including the Dired window.
If the directory is re-read into the Dired buffer with {g}, then Action
Key behavior reverts to as though no items have been dragged."
:lighter " DisplayHere"
(if hmouse-dired-display-here-mode
(progn (set (make-local-variable 'hpath:display-where) 'this-window)
(add-hook 'dired-after-readin-hook 'hmouse-dired-readin-hook nil t))
(kill-local-variable 'hpath:display-where)
(remove-hook 'dired-after-readin-hook 'hmouse-dired-readin-hook t)))
(defun hmouse-drag-region-active ()
"Return non-nil if drag region is active.
If an active region existed in the depress buffer prior to the
depress and a drag motion has occurred, return non-nil ."
(save-excursion
(and (hmouse-goto-region-prev-point)
(hmouse-use-region-p)
(or (hmouse-drag-vertically) (hmouse-drag-horizontally) (hmouse-drag-diagonally))
(setq hkey-value (point)))))
(defun hmouse-drag-thing ()
"Return t if drag began at a thing and ended some other place in the same buffer.
If no region is active and a Smart Key drag began at the
start/end of a delimited construct and ended at some other point
in the same buffer, return t else nil.
Delimited constructs include lists, comments, strings,
arrays/vectors, sets, and markup pair tags, such as <div>
</div>. Point must be on the start or end delimiter or in the
case of markup pair tags, on the first character of either tag.
For strings and comments, point must be on the first line."
;; Move point back to Smart Key depress location for testing whether at a thing.
(let ((depress-args (if assist-flag assist-key-depress-args action-key-depress-args))
(release-args (if assist-flag assist-key-release-args action-key-release-args))
(marked-thing)
(ignore-drag))
(save-excursion
(hmouse-goto-depress-point)
(if (and (not (hmouse-use-region-p)) (hui-select-at-delimited-thing-p)
(or (markerp depress-args) (markerp release-args)
(and (not (or (hmouse-drag-window-side) (hmouse-modeline-depress)))
(or (hmouse-drag-between-windows) (hmouse-drag-vertically)
(hmouse-drag-horizontally) (hmouse-drag-diagonally))))
(let ((start-buf (window-buffer (smart-window-of-coords depress-args)))
(end-buf (window-buffer (smart-window-of-coords release-args)))
(start-point (smart-point-of-coords depress-args))
(end-point (smart-point-of-coords release-args)))
;; If it is a click, return nil; if drag end point
;; is within the thing to operate upon, don't set a
;; region, so no operation will be performed but
;; return t (ignore drag).
(not (and (eq start-buf end-buf)
start-point
end-point
(/= start-point end-point)
(setq marked-thing (hui-select-delimited-thing))
(setq ignore-drag (and (> end-point (min (point) (mark)))
(< end-point (max (point) (mark)))))))))
(progn (when (not (hmouse-use-region-p)) (hui-select-delimited-thing))
;; Erase any saved location of a region prior to Smart Key depress since now we have a
;; new region location. This prevents hmouse-kill-and-yank-region from jumping to the
;; old location.
(if assist-flag
(setq assist-key-depress-prev-point nil)
(setq action-key-depress-prev-point nil))
;; Store any new value of point as a result of marking the region, so we can return to it
;; later.
(setq hkey-value (point))
(hmouse-save-region)
t)
(if marked-thing (deactivate-mark))
(when ignore-drag (error "(Hyperbole): Smart Key drag of a delimited thing must end outside of the thing"))
nil))))
(defun hmouse-kill-region ()
"Kill the marked region near where the Smart Key was depressed.
Signals an error if the depress buffer is read-only."
;; Region may be in another buffer, so move there if so.
(hmouse-goto-region-prev-point)
(if buffer-read-only
;; In this case, we want an error that will terminate execution so that
;; hkey-region is not reset to nil. This allows the user to fix the
;; problem and then to try killing again.
(error "(hmouse-kill-region): Use {%s} to enable killing from this buffer"
(hmouse-read-only-toggle-key))
(kill-region (or hkey-value (point)) (mark))))
(defun hmouse-kill-and-yank-region ()
"Kill the marked region and yank it at the point of release.
Kill the marked region near where the Smart Key was depressed and
yank it at the point of release.
Signals an error if either depress or release buffer is read-only."
(when hkey-region
;; Move point back to Smart Key depress buffer.
(hmouse-goto-depress-point)
(if buffer-read-only
;; In this case, we want an error that will terminate execution so that
;; hkey-region is not reset to nil. This allows the user to fix the
;; problem and then to try killing again.
(error "(hmouse-kill-and-yank-region): Use {%s} to enable killing from this buffer"
(hmouse-read-only-toggle-key))
;; Depress and release may be in the same buffer, in which case,
;; save the release point that may change as a result of
;; the kill; also, before the kill, restore the point to where it
;; was when the region was set.
(hmouse-goto-release-point)
(let ((release-point (point-marker))
(release-window (if assist-flag assist-key-release-window action-key-release-window)))
(if buffer-read-only
;; In this case, we want an error that will terminate execution so that
;; hkey-region is not reset to nil. This allows the user to fix the
;; problem and then to try yanking again.
(error "(hmouse-kill-and-yank-region): Use {%s} to enable yanking into this buffer"
(hmouse-read-only-toggle-key))
;; Region may be in another buffer, so move there if so.
(hmouse-goto-region-prev-point)
;; Now kill and yank the region into the Smart Key release buffer.
(kill-region (or hkey-value (point)) (mark))
;; Permanently return to release point
(select-frame-set-input-focus (window-frame release-window))
(select-window release-window)
(goto-char release-point)
;; Protect from indentation errors
(ignore-errors (hmouse-insert-region)))))))
(defun hmouse-yank-region ()
"Yank the region of text saved in `hkey-region' into the current buffer.
Signals an error if the buffer is read-only."
;; If a region was just selected for yanking, deactivate it as we
;; have already copied the region into `hkey-region'.
(when hkey-region
(hmouse-goto-region-prev-point)
(if (region-active-p) (deactivate-mark))
(hmouse-goto-release-point)
(if buffer-read-only
;; In this case, we want an error that will terminate execution so that
;; hkey-region is not reset to nil. This allows the user to fix the
;; problem and then to try yanking again.
(error "(hmouse-yank-region): Buffer is read-only; use {%s} to enable yanking"
(hmouse-read-only-toggle-key))
;; Permanently return to release point
(let ((release-window (if assist-flag assist-key-release-window action-key-release-window)))
(select-frame-set-input-focus (window-frame release-window))
(select-window release-window))
;; Protect from indentation errors
(ignore-errors (hmouse-insert-region)))))
(defun hmouse-drag-between-frames ()
"Return non-nil if last Action Key depress and release were in different frames.
If free variable `assist-flag' is non-nil, uses Assist Key."
(if assist-flag
(and (window-live-p assist-key-depress-window)
(window-live-p assist-key-release-window)
(not (eq (window-frame assist-key-depress-window)
(window-frame assist-key-release-window))))
(and (window-live-p action-key-depress-window)
(window-live-p action-key-release-window)
(not (eq (window-frame action-key-depress-window)
(window-frame action-key-release-window))))))
(defun hmouse-drag-between-windows ()
"Return non-nil if last Action Key depress and release were in different windows.
If free variable `assist-flag' is non-nil, uses Assist Key."
(if assist-flag
(and (window-live-p assist-key-depress-window)
(window-live-p assist-key-release-window)
(not (eq assist-key-depress-window assist-key-release-window)))
(and (window-live-p action-key-depress-window)
(window-live-p action-key-release-window)
(not (eq action-key-depress-window action-key-release-window)))))
(defun hmouse-press-release-same-window ()
"Return non-nil if last Action Key depress and release were in the same window.
If free variable `assist-flag' is non-nil, use Assist Key."
(if assist-flag
(and (window-live-p assist-key-depress-window)
(window-live-p assist-key-release-window)
(eq assist-key-depress-window assist-key-release-window))
(and (window-live-p action-key-depress-window)
(window-live-p action-key-release-window)
(eq action-key-depress-window action-key-release-window))))
(defun hmouse-drag-outside-all-windows ()
"Return non-nil if last Action Key release was outside of an Emacs window.
If free variable `assist-flag' is non-nil, uses Assist Key."
(if assist-flag
(and (window-live-p assist-key-depress-window) (not assist-key-release-window))
(and (window-live-p action-key-depress-window) (not action-key-release-window))))
(defun hmouse-drag-item-to-display (&optional new-window-flag)
"Drag an item and release where it is to be displayed.
Draggable items include Hyperbole buttons, Dired items, buffer/ibuffer
menu items.
Depress on the item and release where the item is to be displayed.
If depress is on an item and release is outside of Emacs, the
item is displayed in a new frame with a single window. If the
release is inside Emacs and the optional NEW-WINDOW-FLAG is non-nil,
the release window is sensibly split before the buffer is
displayed. Otherwise, the buffer is simply displayed in the
release window.
Return t unless source buffer is not one of these modes or point is
not on an item, then nil.
See `hmouse-drag-item-mode-forms' for how to allow for draggable
items in other modes."
(when (hmouse-at-item-p action-key-depress-window)
(hmouse-item-to-window new-window-flag)
t))
(defun hmouse-drag-same-window ()
"Return non-nil if last Action Key use was a drag in the same window.
If free variable `assist-flag' is non-nil, uses Assist Key."
(or (hmouse-drag-horizontally) (hmouse-drag-vertically) (hmouse-drag-diagonally)))
(defun hmouse-drag-diagonally ()
"Return non-nil iff last Action Key use was a diagonal drag in a single window.
If free variable `assist-flag' is non-nil, use Assist Key.
Value returned is nil if not a diagonal drag, or one of the
following symbols depending on the direction of the drag:
southeast, southwest, northwest, northeast."
(when (hmouse-press-release-same-window)
(let ((last-depress-x) (last-release-x)
(last-depress-y) (last-release-y))
(if assist-flag
(setq last-depress-x (hmouse-x-coord assist-key-depress-args)
last-release-x (hmouse-x-coord assist-key-release-args)
last-depress-y (hmouse-y-coord assist-key-depress-args)
last-release-y (hmouse-y-coord assist-key-release-args))
(setq last-depress-x (hmouse-x-coord action-key-depress-args)
last-release-x (hmouse-x-coord action-key-release-args)
last-depress-y (hmouse-y-coord action-key-depress-args)
last-release-y (hmouse-y-coord action-key-release-args)))
(and last-depress-x last-release-x last-depress-y last-release-y
(>= (- (max last-depress-x last-release-x)
(min last-depress-x last-release-x))
hmouse-x-diagonal-sensitivity)
(>= (- (max last-depress-y last-release-y)
(min last-depress-y last-release-y))
hmouse-y-diagonal-sensitivity)
(cond
((< last-depress-x last-release-x)
(if (< last-depress-y last-release-y)
'southeast 'northeast))
(t (if (< last-depress-y last-release-y)
'southwest 'northwest)))))))
(defun hmouse-drag-horizontally ()
"Return non-nil iff last Action Key use was a horizontal drag in a single window.
If free variable `assist-flag' is non-nil, use Assist Key.
Value returned is nil if not a horizontal drag, \\='left if drag
moved left or \\='right otherwise."
(when (hmouse-press-release-same-window)
(let ((last-depress-x) (last-release-x)
(last-depress-y) (last-release-y))
(if assist-flag
(setq last-depress-x (hmouse-x-coord assist-key-depress-args)
last-release-x (hmouse-x-coord assist-key-release-args)
last-depress-y (hmouse-y-coord assist-key-depress-args)
last-release-y (hmouse-y-coord assist-key-release-args))
(setq last-depress-x (hmouse-x-coord action-key-depress-args)
last-release-x (hmouse-x-coord action-key-release-args)
last-depress-y (hmouse-y-coord action-key-depress-args)
last-release-y (hmouse-y-coord action-key-release-args)))
(and last-depress-x last-release-x last-depress-y last-release-y
(>= (- (max last-depress-x last-release-x)
(min last-depress-x last-release-x))
hmouse-x-drag-sensitivity)
;; Don't want to register vertical drags here, so ensure any
;; vertical movement was less than the vertical drag sensitivity.
(< (- (max last-depress-y last-release-y)
(min last-depress-y last-release-y))
hmouse-y-drag-sensitivity)
(if (< last-depress-x last-release-x) 'right 'left)))))
(defun hmouse-drag-vertically-within-emacs ()
"Return non-nil iff last Action Key use was a vertical drag in the same frame.
If free variable `assist-flag' is non-nil, use Assist Key.
Value returned is nil if not a vertical line drag, \\='up if drag moved up or
\\='down otherwise."
(unless (or (hmouse-drag-between-frames) (hmouse-drag-outside-all-windows))
(let ((last-depress-x) (last-release-x)
(last-depress-y) (last-release-y))
(if assist-flag
(setq last-depress-x (hmouse-x-coord assist-key-depress-args)
last-release-x (hmouse-x-coord assist-key-release-args)
last-depress-y (hmouse-y-coord assist-key-depress-args)
last-release-y (hmouse-y-coord assist-key-release-args))
(setq last-depress-x (hmouse-x-coord action-key-depress-args)
last-release-x (hmouse-x-coord action-key-release-args)
last-depress-y (hmouse-y-coord action-key-depress-args)
last-release-y (hmouse-y-coord action-key-release-args)))
(and last-depress-x last-release-x last-depress-y last-release-y
(>= (- (max last-depress-y last-release-y)
(min last-depress-y last-release-y))
hmouse-y-drag-sensitivity)
;; Don't want to register horizontal drags here, so ensure any
;; horizontal movement was less than or equal to the horizontal drag
;; sensitivity.
(<= (- (max last-depress-x last-release-x)
(min last-depress-x last-release-x))
hmouse-x-drag-sensitivity)
(if (< last-depress-y last-release-y) 'down 'up)))))
(defun hmouse-drag-vertically ()
"Return non-nil iff last Action Key use was a vertical drag in a single window.
If free variable `assist-flag' is non-nil, uses Assist Key.
Value returned is nil if not a vertical line drag, \\='up if drag moved up or
\\='down otherwise."
(when (hmouse-press-release-same-window)
(hmouse-drag-vertically-within-emacs)))
(defun hmouse-drag-window-side ()
"Return non-nil if Action Key was dragged, in one window, from a side divider.
If free variable `assist-flag' is non-nil, uses Assist Key."
(cond ((hyperb:window-system)
(let* ((depress-args (if assist-flag assist-key-depress-args
action-key-depress-args))
(release-args (if assist-flag assist-key-release-args
action-key-release-args))
(wd (smart-window-of-coords depress-args))
(wr (smart-window-of-coords release-args))
(right-side-ln (and (window-live-p wd) (1- (nth 2 (window-edges wd)))))
(last-press-x (and (window-live-p wd) depress-args (hmouse-x-coord depress-args)))
(last-release-x (and (window-live-p wr) release-args (hmouse-x-coord release-args))))
(and last-press-x last-release-x right-side-ln
(/= last-press-x last-release-x)
(not (<= (abs (- right-side-ln (frame-width))) 5))
(<= (abs (- last-press-x right-side-ln))
hmouse-side-sensitivity))))))
(defun hmouse-read-only-toggle-key ()
"Return the first toggle read-only mode key binding, or nil if none."
(key-description (where-is-internal #'read-only-mode nil t)))
(defun hmouse-vertical-action-drag ()
"Handle an Action Key vertical drag within a window.
Adds a window to the right of this one.
Beep and print message if the window cannot be split further."
(interactive)
(condition-case ()
(split-window-horizontally nil)
(error (beep)
(message "(hmouse-vertical-action-drag): Can't split the window further."))))
(defun hmouse-vertical-assist-drag ()
"Handle an Assist Key vertical drag within a window: deletes the current window.
Beep and print message if the window cannot be split further."
(condition-case ()
(delete-window)
(error (beep)
(message "(hmouse-vertical-assist-drag): A single window cannot be deleted."))))
(defun hmouse-horizontal-action-drag ()
"Handle an Action Key horizontal drag within a window.
Adds a window below this one.
Beep and print message if the window cannot be split further."
(interactive)
(condition-case ()
(if (fboundp 'split-window-quietly)
(split-window-quietly nil)
(split-window-vertically nil))
(error (beep)
(message "(hmouse-horizontal-action-drag): Can't split the window further."))))
(defun hmouse-horizontal-assist-drag ()
"Handle an Assist Key horizontal drag within a window: delete the current window.
Beep and print message if the window cannot be split further."
(condition-case ()
(delete-window)
(error (beep)
(message "(hmouse-horizontal-assist-drag): A single window cannot be deleted."))))
(defun smart-coords-in-window-p (coords window)
"Test if COORDS are in WINDOW. Return WINDOW if they are, nil otherwise."
(cond ((null coords) nil)
((eventp coords)
(let ((w-or-f (posn-window (event-start coords))))
(when (framep w-or-f)
(setq w-or-f (frame-selected-window w-or-f)))
(when (and (eq w-or-f window) (window-valid-p window))
window)))
((fboundp 'window-edges)
(let* ((edges (window-edges window))
(w-xmin (nth 0 edges))
(w-ymin (nth 1 edges))
(w-xmax (nth 2 edges))
(w-ymax (nth 3 edges))
(x (hmouse-x-coord coords))
(y (hmouse-y-coord coords)))
(and (<= w-xmin x) (<= x w-xmax)
(<= w-ymin y) (<= y w-ymax)
(window-valid-p window)
window)))))
(defun smart-point-of-coords (coords)
"Return point within window in which COORDS fall or nil if none.
Ignores minibuffer window."
(cond ((markerp coords)
(marker-position coords))
((eventp coords)
(posn-point (event-start coords)))))
(defun smart-window-of-coords (coords)
"Return window in which COORDS fall or nil if none.
Ignores minibuffer window."
(cond ((null coords) nil)
((markerp coords)
(get-buffer-window (marker-buffer coords)))
((eventp coords)
(let ((w-or-f (posn-window (event-start coords))))
(when (framep w-or-f) (setq w-or-f (frame-selected-window w-or-f)))
w-or-f))
(t (let ((window-list (hypb:window-list 'no-minibuf))
(window)
(w))
(while (and (not window) window-list)
(setq w (car window-list)
window-list (cdr window-list)
window (smart-coords-in-window-p coords w)))
window))))
;;; ************************************************************************
;;; Private functions
;;; ************************************************************************
(defun hmouse-split-window ()
"Split selected window parallel to its shortest dimension."
(if (>= (window-width) (window-height))
;; side-by-side windows
(split-window-horizontally)
;; windows atop the other
(split-window-vertically)))
(defun hmouse-buffer-to-window (&optional new-window)
"Replace buffer in the release window with buffer from the depress window.
Invoked via drag, using the Action Key release window and the
Action Key depress window. With optional boolean NEW-WINDOW
non-nil, sensibly split the release window before replacing the
buffer."
(when new-window
(with-selected-window action-key-release-window
(hmouse-split-window)))
(set-window-buffer action-key-release-window (window-buffer action-key-depress-window)))
(defun hmouse-drag-not-allowed ()
"Display an error when a region is active and in-window drags are not allowed."
;; Return point to where it was prior to depress so the region does not permanently change.
(goto-char hkey-value)
(error "(hmouse-drag-region-active): Region is active; use a Smart Key press/click within a window, not a drag"))
(defun hmouse-set-buffer-and-point (buffer point)
"Set BUFFER and POINT."
(when buffer
(set-buffer buffer)
(when point (goto-char point))))
(defun hmouse-goto-region-prev-point ()
"Temporarily set point to where it was prior to the last Smart Key depress.
Return t if such a point is saved, else nil."
(let* ((prev-point (if assist-flag assist-key-depress-prev-point action-key-depress-prev-point))
(buf (and prev-point (marker-buffer prev-point)))
(loc (and prev-point (marker-position prev-point))))
(when (and buf loc)
(hmouse-set-buffer-and-point buf loc)
t)))
(defun hmouse-goto-depress-point ()
"Temporarily set point to where the last Smart Key was depressed."
(let ((buf (window-buffer (if assist-flag assist-key-depress-window action-key-depress-window)))
(loc (smart-point-of-coords (if assist-flag assist-key-depress-args action-key-depress-args))))
(hmouse-set-buffer-and-point buf loc)))
(defun hmouse-goto-release-point ()
"Temporarily set point to where the last Smart Key was released."
(let ((buf (window-buffer (if assist-flag assist-key-release-window action-key-release-window)))
(loc (smart-point-of-coords (if assist-flag assist-key-release-args action-key-release-args))))
(hmouse-set-buffer-and-point buf loc)))
(defun hmouse-inactive-minibuffer-p ()
"Non-nil means last event was a press or release in an inactive minibuffer."
(let ((window (posn-window (event-start last-command-event))))
(when (framep window) (setq window (frame-selected-window window)))
(and (window-live-p window)
(window-minibuffer-p window)
(not (minibuffer-window-active-p window)))))
(defun hmouse-insert-region ()
"Save a mark, then insert at point the text from `hkey-region' and indent it."
(indent-for-tab-command)
(push-mark nil t)
(when (smart-eobp) (insert "\n"))
(insert hkey-region)
(indent-region (point) (mark))
(message "") ;; Clear any indenting message.
;; From par-align.el library; need to think about all the
;; possibilities before enabling filling of this region.
;; (when (fboundp 'fill-region-and-align) (fill-region-and-align (mark) (point)))
)
(defun hmouse-pulse-buffer ()
"When `hmouse-pulse-flag' is non-nil, display can pulse, pulse the buffer."
(when (and hmouse-pulse-flag (featurep 'pulse) pulse-flag (pulse-available-p))
(let ((pulse-iterations hmouse-pulse-iterations))
(recenter)
(pulse-momentary-highlight-region (window-start) (window-end) 'next-error))))
(defun hmouse-pulse-line ()
"When `hmouse-pulse-flag' is non-nil, display can pulse, pulse the line."
(when (and hmouse-pulse-flag (featurep 'pulse) pulse-flag (pulse-available-p))
(let ((pulse-iterations hmouse-pulse-iterations))
(recenter)
(pulse-momentary-highlight-one-line (point) 'next-error))))
(defun hmouse-pulse-region (start end)
"When `hmouse-pulse-flag' is non-nil, pulse the region between START and END."
(when (and hmouse-pulse-flag (featurep 'pulse) pulse-flag (pulse-available-p))
(let ((pulse-iterations hmouse-pulse-iterations))
(pulse-momentary-highlight-region start end 'next-error))))
(defun hmouse-item-to-window (&optional new-window-flag)
"Display item/action of Action Key depress at the release location.
Return non-nil if item is displayed or action is executed; nil
otherwise.
Item is a buffer, file menu item or a Hyperbole button (execute its
action).
Release location may be an Emacs window or outside of Emacs, in
which case a new frame with a single window is created to display
the item. If the release is inside Emacs and the optional
NEW-WINDOW-FLAG is non-nil, the release window is sensibly split
before the buffer is displayed. Otherwise, the buffer is simply
displayed in the release window.
If depress is on the top fixed header line or to the right of any
item, this moves the menu buffer itself to the release location."
(let* ((w1 action-key-depress-window)
;; Release may be outside of an Emacs window in which case,
;; create a new frame and window.
(w2 (or action-key-release-window (frame-selected-window (hycontrol-make-frame))))
(w1-ref)
(pos)
(at-button-flag))
(when (and (window-live-p w1) (window-live-p w2))
(unwind-protect
(progn (select-window w1)
(if (eq (posn-area (event-start action-key-depress-args)) 'header-line)
;; Drag from fixed header-line means move this menu buffer
;; to release window.
(progn (setq w1-ref (current-buffer))
(hmouse-pulse-buffer)
(sit-for 0.05)
(bury-buffer))
;; Otherwise, move the current menu item to the release window.
(setq w1-ref (or (eval (cadr (assq major-mode hmouse-drag-item-mode-forms)))
(when (setq at-button-flag (hbut:at-p))
(hbut:action 'hbut:current))))
(when w1-ref (hmouse-pulse-line) (sit-for 0.05))))
(hypb:select-window-frame w2)
(when (and new-window-flag action-key-release-window)
(hmouse-split-window))))
(unwind-protect
(progn
(when (and w1-ref (not (stringp w1-ref)) (sequencep w1-ref)
(buffer-live-p (seq-elt w1-ref 0))
(integerp (seq-elt w1-ref 1)))
;; w1-ref is a list or vector of `buffer' and `position' elements.
(setq pos (seq-elt w1-ref 1)
w1-ref (seq-elt w1-ref 0)))
(cond ((not w1-ref)
(if (not (window-live-p w1))
(error "(hmouse-item-to-window): Action Mouse Key item drag must start in a live window")
(error "(hmouse-item-to-window): No item to display at start of Action Mouse Key drag")))
(at-button-flag
(let ((hpath:display-where 'this-window))
(hbut:act)))
((buffer-live-p w1-ref) ;; Must be a buffer, not a buffer name
(set-window-buffer w2 w1-ref)
(set-buffer w1-ref))
((and (stringp w1-ref) (file-readable-p w1-ref))
(set-window-buffer w2 (set-buffer (find-file-noselect w1-ref))))
(t (error "(hmouse-item-to-window): Cannot find or read `%s'" w1-ref)))
(if pos
(progn (goto-char pos)
(hmouse-pulse-line))
(hmouse-pulse-buffer)))
;; If helm is active, end in the minibuffer window.
(if (smart-helm-alive-p)
(smart-helm-to-minibuffer)))))
(defun action-key-modeline ()
"Handle Action Key depresses on a window mode line.
If the Action Key is:
(1) clicked on the first blank character of a window's modeline,
the window's buffer is buried (placed at bottom of buffer list);
(2) clicked on right edge of a window's modeline,
the Info buffer is displayed, or if already displayed and the
modeline clicked belongs to a window displaying Info, the Info
buffer is hidden;
(3) clicked on the buffer id of a window's modeline, Dired is run
on the current directory, replacing the window's buffer;
successive clicks walk up the directory tree
(4) clicked anywhere in the middle of a window's modeline,
the function given by `action-key-modeline-function' is called;
(5) dragged vertically from non-bottommost modeline to within a window,
the modeline is moved to point of key release, thereby resizing
its window and potentially its vertical neighbors.
(6) dragged from a bottommost modeline in a frame with a non-nil
`drag-with-mode-line' parameter (use `frame-set-parameter'),
moves the frame as the drag occurs."
;; Modeline window resizing is now handled in action-key-depress
;; via a call to mouse-drag-mode-line, providing live visual
;; feedback.
(let ((w (smart-window-of-coords action-key-depress-args)))
(if w (select-window w))
(when (hmouse-modeline-click)
(cond ((hmouse-emacs-at-modeline-buffer-id-p)
(funcall action-key-modeline-buffer-id-function))
((hmouse-release-left-edge) (bury-buffer))
((hmouse-release-right-edge)
(if (eq major-mode 'Info-mode)
(quit-window)
(info)))
(t (funcall action-key-modeline-function))))))
(defun assist-key-modeline ()
"Handle Assist Key depresses on a window mode line.
If the Assist Key is:
(1) clicked on the first blank character of a window's modeline,
bottom buffer in buffer list is unburied and placed in window;
(2) clicked on right edge of a window's modeline,
the summary of Smart Key behavior is displayed, or if already
displayed and the modeline clicked belongs to a window displaying
the summary, the summary buffer is hidden;
(3) clicked on the buffer id of a window's modeline,
the next buffer in sequence is displayed in the window
(4) clicked anywhere in the middle of a window's modeline,
the function given by `assist-key-modeline-function' is called;
(5) dragged vertically from non-bottommost modeline to within a window,
the modeline is moved to point of key release, thereby resizing
its window and potentially its vertical neighbors.