-
Notifications
You must be signed in to change notification settings - Fork 9
/
exwm-input.el
1258 lines (1148 loc) · 53.3 KB
/
exwm-input.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
;;; exwm-input.el --- Input Module for EXWM -*- lexical-binding: t -*-
;; Copyright (C) 2015-2024 Free Software Foundation, Inc.
;; Author: Chris Feng <chris.w.feng@gmail.com>
;; 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 <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This module deals with key/mouse matters, including:
;; + Input focus,
;; + Key/Button event handling,
;; + Key events filtering and simulation.
;; Todo:
;; + Pointer simulation mode (e.g. 'C-c 1'/'C-c 2' for single/double click,
;; move with arrow keys).
;; + Simulation keys to mimic Emacs key bindings for text edit (redo, select,
;; cancel, clear, etc). Some of them are not present on common keyboard
;; (keycode = 0). May need to use XKB extension.
;;; Code:
(require 'xcb-keysyms)
(require 'exwm-core)
(defgroup exwm-input nil
"Input."
:group 'exwm)
(defcustom exwm-input-prefix-keys
'(?\C-x ?\C-u ?\C-h ?\M-x ?\M-` ?\M-& ?\M-:)
"List of prefix keys EXWM should forward to Emacs when in `line-mode'.
There is no need to add prefix keys for global/simulation keys or those
defined in `exwm-mode-map' here."
:type '(repeat key-sequence)
:get (lambda (symbol)
(mapcar #'vector (default-value symbol)))
:set (lambda (symbol value)
(set symbol (mapcar (lambda (i)
(if (sequencep i)
(aref i 0)
i))
value))))
(defcustom exwm-input-move-event 's-down-mouse-1
"Emacs event to start moving a window."
:type 'key-sequence
:get (lambda (symbol)
(let ((value (default-value symbol)))
(if (mouse-event-p value)
value
(vector value))))
:set (lambda (symbol value)
(set symbol (if (sequencep value)
(aref value 0)
value))))
(defcustom exwm-input-resize-event 's-down-mouse-3
"Emacs event to start resizing a window."
:type 'key-sequence
:get (lambda (symbol)
(let ((value (default-value symbol)))
(if (mouse-event-p value)
value
(vector value))))
:set (lambda (symbol value)
(set symbol (if (sequencep value)
(aref value 0)
value))))
(defcustom exwm-input-line-mode-passthrough nil
"Non-nil makes `line-mode' forward all events to Emacs."
:type 'boolean)
;; Input focus update requests should be accumulated for a short time
;; interval so that only the last one need to be processed. This not
;; improves the overall performance, but avoids the problem of input
;; focus loop, which is a result of the interaction with Emacs frames.
;;
;; FIXME: The time interval is hard to decide and perhaps machine-dependent.
;; A value too small can cause redundant updates of input focus,
;; and even worse, dead loops. OTOH a large value would bring
;; laggy experience.
(defconst exwm-input--update-focus-interval 0.01
"Time interval (in seconds) for accumulating input focus update requests.")
(defconst exwm-input--passthrough-functions '(read-char
read-char-exclusive
read-key-sequence-vector
read-key-sequence
read-event)
"Low-level read functions that must be exempted from EXWM input handling.")
(defvar exwm-input--during-command nil
"Indicate whether between `pre-command-hook' and `post-command-hook'.")
(defvar exwm-input--global-keys nil "Global key bindings.")
(defvar exwm-input--global-prefix-keys nil
"List of prefix keys of global key bindings.")
(defvar exwm-input--line-mode-cache nil "Cache for incomplete key sequence.")
(defvar exwm-input--local-simulation-keys nil
"Whether simulation keys are local.")
(defvar exwm-input--simulation-keys nil "Simulation keys in `line-mode'.")
(defvar exwm-input--skip-buffer-list-update nil
"Skip the upcoming `buffer-list-update'.")
(defvar exwm-input--temp-line-mode nil
"Non-nil indicates it's in temporary line-mode for `char-mode'.")
(defvar exwm-input--timestamp-atom nil)
(defvar exwm-input--timestamp-callback nil)
(defvar exwm-input--timestamp-window nil)
(defvar exwm-input--update-focus-timer nil
"Timer for deferring the update of input focus.")
(defvar exwm-input--update-focus-lock nil
"Lock for solving input focus update contention.")
(defvar exwm-input--update-focus-window nil "The (Emacs) window to be focused.
This value should always be overwritten.")
(defvar exwm-input--echo-area-timer nil "Timer for detecting echo area dirty.")
(defvar exwm-input--event-hook nil
"Hook to run when EXWM receives an event.")
(defvar exwm-input-input-mode-change-hook nil
"Hook to run when an input mode changes on an `exwm-mode' buffer.
Current buffer will be the `exwm-mode' buffer when this hook runs.")
(defvar exwm-workspace--current)
(declare-function exwm-floating--do-moveresize "exwm-floating.el"
(data _synthetic))
(declare-function exwm-floating--start-moveresize "exwm-floating.el"
(id &optional type))
(declare-function exwm-floating--stop-moveresize "exwm-floating.el"
(&rest _args))
(declare-function exwm-layout--iconic-state-p "exwm-layout.el" (&optional id))
(declare-function exwm-layout--show "exwm-layout.el" (id &optional window))
(declare-function exwm-reset "exwm.el" ())
(declare-function exwm-workspace--minibuffer-own-frame-p "exwm-workspace.el")
(declare-function exwm-workspace--workspace-p "exwm-workspace.el" (workspace))
(declare-function exwm-workspace-switch "exwm-workspace.el"
(frame-or-index &optional force))
(defun exwm-input--set-focus (id)
"Set input focus to window ID in a proper way."
(let ((from (slot-value (xcb:+request-unchecked+reply exwm--connection
(make-instance 'xcb:GetInputFocus))
'focus))
tree)
(if (or (exwm--id->buffer from)
(eq from id))
(exwm--log "#x%x => #x%x" (or from 0) (or id 0))
;; Attempt to find the top-level X window for a 'focus proxy'.
(unless (= from xcb:Window:None)
(setq tree (xcb:+request-unchecked+reply exwm--connection
(make-instance 'xcb:QueryTree
:window from)))
(when tree
(setq from (slot-value tree 'parent))))
(exwm--log "#x%x (corrected) => #x%x" (or from 0) (or id 0)))
(when (and (exwm--id->buffer id)
;; Avoid redundant input focus transfer.
(not (eq from id)))
(with-current-buffer (exwm--id->buffer id)
(exwm-input--update-timestamp
(lambda (timestamp id send-input-focus wm-take-focus)
(when send-input-focus
(xcb:+request exwm--connection
(make-instance 'xcb:SetInputFocus
:revert-to xcb:InputFocus:Parent
:focus id
:time timestamp)))
(when wm-take-focus
(let ((event (make-instance 'xcb:icccm:WM_TAKE_FOCUS
:window id
:time timestamp)))
(setq event (xcb:marshal event exwm--connection))
(xcb:+request exwm--connection
(make-instance 'xcb:icccm:SendEvent
:destination id
:event event))))
(exwm-input--set-active-window id)
(xcb:flush exwm--connection))
id
(or exwm--hints-input
(not (memq xcb:Atom:WM_TAKE_FOCUS exwm--protocols)))
(memq xcb:Atom:WM_TAKE_FOCUS exwm--protocols))))))
(defun exwm-input--update-timestamp (callback &rest args)
"Fetch the latest timestamp from the server and feed it to CALLBACK.
ARGS are additional arguments to CALLBACK."
(setq exwm-input--timestamp-callback (cons callback args))
(exwm--log)
(xcb:+request exwm--connection
(make-instance 'xcb:ChangeProperty
:mode xcb:PropMode:Replace
:window exwm-input--timestamp-window
:property exwm-input--timestamp-atom
:type xcb:Atom:CARDINAL
:format 32
:data-len 0
:data nil))
(xcb:flush exwm--connection))
(defun exwm-input--on-PropertyNotify (data _synthetic)
"Handle PropertyNotify events with DATA."
(exwm--log)
(when exwm-input--timestamp-callback
(let ((obj (make-instance 'xcb:PropertyNotify)))
(xcb:unmarshal obj data)
(when (= exwm-input--timestamp-window
(slot-value obj 'window))
(apply (car exwm-input--timestamp-callback)
(slot-value obj 'time)
(cdr exwm-input--timestamp-callback))
(setq exwm-input--timestamp-callback nil)))))
(defvar exwm-input--last-enter-notify-position nil)
(defun exwm-input--on-EnterNotify (data _synthetic)
"Handle EnterNotify events with DATA."
(let ((evt (make-instance 'xcb:EnterNotify))
buffer window frame frame-xid edges fake-evt)
(xcb:unmarshal evt data)
(with-slots (time root event root-x root-y event-x event-y state) evt
(setq buffer (exwm--id->buffer event)
window (get-buffer-window buffer t))
(exwm--log "buffer=%s; window=%s" buffer window)
(when (and buffer window (not (eq window (selected-window)))
(not (equal exwm-input--last-enter-notify-position
(vector root-x root-y))))
(setq frame (window-frame window)
frame-xid (frame-parameter frame 'exwm-id))
(unless (eq frame exwm-workspace--current)
(if (exwm-workspace--workspace-p frame)
;; The X window is on another workspace.
(exwm-workspace-switch frame)
(with-current-buffer buffer
(when (and (derived-mode-p 'exwm-mode)
(not (eq exwm--frame exwm-workspace--current)))
;; The floating X window is on another workspace.
(exwm-workspace-switch exwm--frame)))))
;; Send a fake MotionNotify event to Emacs.
(setq edges (window-inside-pixel-edges window)
fake-evt (make-instance 'xcb:MotionNotify
:detail 0
:time time
:root root
:event frame-xid
:child xcb:Window:None
:root-x root-x
:root-y root-y
:event-x (+ event-x (elt edges 0))
:event-y (+ event-y (elt edges 1))
:state state
:same-screen 1))
(xcb:+request exwm--connection
(make-instance 'xcb:SendEvent
:propagate 0
:destination frame-xid
:event-mask xcb:EventMask:NoEvent
:event (xcb:marshal fake-evt exwm--connection)))
(xcb:flush exwm--connection))
(setq exwm-input--last-enter-notify-position (vector root-x root-y)))))
(defun exwm-input--on-keysyms-update ()
"Update global prefix keys."
(exwm--log)
(let ((exwm-input--global-prefix-keys nil))
(exwm-input--update-global-prefix-keys)))
(defun exwm-input--on-buffer-list-update ()
"Run in `buffer-list-update-hook' to track input focus."
(when (and ; this hook is called incesantly; place cheap tests on top
(not exwm-input--skip-buffer-list-update)
(exwm--terminal-p) ; skip other terminals, e.g. TTY client frames
(not (frame-parameter nil 'no-accept-focus)))
(exwm--log "current-buffer=%S selected-window=%S"
(current-buffer) (selected-window))
(redirect-frame-focus (selected-frame) nil)
(setq exwm-input--update-focus-window (selected-window))
(exwm-input--update-focus-defer)))
(defun exwm-input--update-focus-defer ()
"Schedule a deferred update to input focus.
Instead of immediately focusing the current window, it defers the focus change
until the selected window stops changing (debouncing input focus updates)."
(when exwm-input--update-focus-timer
(cancel-timer exwm-input--update-focus-timer))
(setq exwm-input--update-focus-timer
;; Attempt to accumulate successive events close enough.
(run-with-timer exwm-input--update-focus-interval
nil
#'exwm-input--update-focus-commit)))
(defun exwm-input--update-focus-commit ()
"Attempt to update the window focus.
If we're currently updating the window focus, re-schedule a focus update
attempt later."
(if exwm-input--update-focus-lock
(exwm-input--update-focus-defer)
(let ((exwm-input--update-focus-lock t))
(exwm-input--update-focus exwm-input--update-focus-window))))
(defun exwm-input--update-focus (window)
"Update input focus to WINDOW."
(when (window-live-p window)
(exwm--log "focus-window=%s focus-buffer=%s" window (window-buffer window))
(with-current-buffer (window-buffer window)
(if (derived-mode-p 'exwm-mode)
(if (not (eq exwm--frame exwm-workspace--current))
(progn
(set-frame-parameter exwm--frame 'exwm-selected-window window)
(exwm--defer 0 #'exwm-workspace-switch exwm--frame))
(exwm--log "Set focus on #x%x" exwm--id)
(when exwm--floating-frame
;; Adjust stacking orders of the floating X window.
(xcb:+request exwm--connection
(make-instance 'xcb:ConfigureWindow
:window exwm--id
:value-mask xcb:ConfigWindow:StackMode
:stack-mode xcb:StackMode:TopIf))
(xcb:+request exwm--connection
(make-instance 'xcb:ConfigureWindow
:window (frame-parameter exwm--floating-frame
'exwm-container)
:value-mask (logior
xcb:ConfigWindow:Sibling
xcb:ConfigWindow:StackMode)
:sibling exwm--id
:stack-mode xcb:StackMode:Below))
;; This floating X window might be hide by `exwm-floating-hide'.
(when (exwm-layout--iconic-state-p)
(exwm-layout--show exwm--id window))
(xcb:flush exwm--connection))
(exwm-input--set-focus exwm--id))
(when (eq (selected-window) window)
(exwm--log "Focus on %s" window)
(if (and (exwm-workspace--workspace-p (selected-frame))
(not (eq (selected-frame) exwm-workspace--current)))
;; The focus is on another workspace (e.g. it got clicked)
;; so switch to it.
(progn
(exwm--log "Switching to %s's workspace %s (%s)"
window
(window-frame window)
(selected-frame))
(set-frame-parameter (selected-frame) 'exwm-selected-window
window)
(exwm--defer 0 #'exwm-workspace-switch (selected-frame)))
;; The focus is still on the current workspace.
(if (not (and (exwm-workspace--minibuffer-own-frame-p)
(minibufferp)))
(x-focus-frame (window-frame window))
;; X input focus should be set on the previously selected
;; frame.
(x-focus-frame (window-frame (minibuffer-window))))
(exwm-input--set-active-window)
(xcb:flush exwm--connection)))))))
(defun exwm-input--set-active-window (&optional id)
"Set _NET_ACTIVE_WINDOW.
When non-nil, ID is passed as the window data."
(exwm--log)
(xcb:+request exwm--connection
(make-instance 'xcb:ewmh:set-_NET_ACTIVE_WINDOW
:window exwm--root
:data (or id xcb:Window:None))))
(defun exwm-input--on-ButtonPress (data _synthetic)
"Handle ButtonPress event with DATA."
(let ((obj (make-instance 'xcb:ButtonPress))
(mode xcb:Allow:SyncPointer)
button-event window buffer frame fake-last-command)
(xcb:unmarshal obj data)
(exwm--log "major-mode=%s buffer=%s"
major-mode (buffer-name (current-buffer)))
(with-slots (detail event state) obj
(setq button-event (xcb:keysyms:keysym->event exwm--connection
detail state)
buffer (exwm--id->buffer event)
window (get-buffer-window buffer t))
(cond ((and (eq button-event exwm-input-move-event)
buffer
;; Either an undecorated or a floating X window.
(with-current-buffer buffer
(or (not (derived-mode-p 'exwm-mode))
exwm--floating-frame)))
;; Move
(exwm-floating--start-moveresize
event xcb:ewmh:_NET_WM_MOVERESIZE_MOVE))
((and (eq button-event exwm-input-resize-event)
buffer
(with-current-buffer buffer
(or (not (derived-mode-p 'exwm-mode))
exwm--floating-frame)))
;; Resize
(exwm-floating--start-moveresize event))
(buffer
;; Click to focus
(setq fake-last-command t)
(unless (eq window (selected-window))
(setq frame (window-frame window))
(unless (eq frame exwm-workspace--current)
(if (exwm-workspace--workspace-p frame)
;; The X window is on another workspace
(exwm-workspace-switch frame)
(with-current-buffer buffer
(when (and (derived-mode-p 'exwm-mode)
(not (eq exwm--frame
exwm-workspace--current)))
;; The floating X window is on another workspace
(exwm-workspace-switch exwm--frame)))))
;; It has been reported that the `window' may have be deleted
(if (window-live-p window)
(select-window window)
(setq window (get-buffer-window buffer t))
(when window (select-window window))))
;; Also process keybindings.
(with-current-buffer buffer
(when (derived-mode-p 'exwm-mode)
(cl-case exwm--input-mode
(line-mode
(setq mode (exwm-input--on-ButtonPress-line-mode
buffer button-event)))
(char-mode
(setq mode (exwm-input--on-ButtonPress-char-mode)))))))
(t
;; Replay this event by default.
(setq fake-last-command t)
(setq mode xcb:Allow:ReplayPointer)))
(when fake-last-command
(if buffer
(with-current-buffer buffer
(exwm-input--fake-last-command))
(exwm-input--fake-last-command))))
(xcb:+request exwm--connection
(make-instance 'xcb:AllowEvents :mode mode :time xcb:Time:CurrentTime))
(xcb:flush exwm--connection))
(run-hooks 'exwm-input--event-hook))
(defun exwm-input--on-KeyPress (data _synthetic)
"Handle KeyPress event with DATA."
(with-current-buffer (window-buffer (selected-window))
(let ((obj (make-instance 'xcb:KeyPress)))
(xcb:unmarshal obj data)
(exwm--log "major-mode=%s buffer=%s"
major-mode (buffer-name (current-buffer)))
(if (derived-mode-p 'exwm-mode)
(cl-case exwm--input-mode
(line-mode
(exwm-input--on-KeyPress-line-mode obj data))
(char-mode
(exwm-input--on-KeyPress-char-mode obj data)))
(exwm-input--on-KeyPress-char-mode obj)))
(run-hooks 'exwm-input--event-hook)))
(defun exwm-input--on-CreateNotify (data _synthetic)
"Handle CreateNotify events with DATA."
(exwm--log)
(let ((evt (make-instance 'xcb:CreateNotify)))
(xcb:unmarshal evt data)
(with-slots (window) evt
(exwm-input--grab-global-prefix-keys window))))
(defun exwm-input--update-global-prefix-keys ()
"Update `exwm-input--global-prefix-keys'."
(exwm--log)
(when exwm--connection
(let ((original exwm-input--global-prefix-keys))
(setq exwm-input--global-prefix-keys nil)
(dolist (i exwm-input--global-keys)
(cl-pushnew (elt i 0) exwm-input--global-prefix-keys))
(unless (equal original exwm-input--global-prefix-keys)
(apply #'exwm-input--grab-global-prefix-keys
(slot-value (xcb:+request-unchecked+reply exwm--connection
(make-instance 'xcb:QueryTree
:window exwm--root))
'children))))))
(defun exwm-input--grab-global-prefix-keys (&rest xwins)
"Grab global prefix keys in XWINS."
(exwm--log)
(let ((req (make-instance 'xcb:GrabKey
:owner-events 0
:grab-window nil
:modifiers nil
:key nil
:pointer-mode xcb:GrabMode:Async
:keyboard-mode xcb:GrabMode:Async))
keysyms keycode alt-modifier)
(dolist (k exwm-input--global-prefix-keys)
(setq keysyms (xcb:keysyms:event->keysyms exwm--connection k))
(if (not keysyms)
(warn "Key unavailable: %s" (key-description (vector k)))
(setq keycode (xcb:keysyms:keysym->keycode exwm--connection
(caar keysyms)))
(exwm--log "Grabbing key=%s (keysyms=%s keycode=%s)"
(single-key-description k) keysyms keycode)
(dolist (keysym keysyms)
(setf (slot-value req 'modifiers) (cdr keysym)
(slot-value req 'key) keycode)
;; Also grab this key with num-lock mask set.
(when (and (/= 0 xcb:keysyms:num-lock-mask)
(= 0 (logand (cdr keysym) xcb:keysyms:num-lock-mask)))
(setf alt-modifier (logior (cdr keysym)
xcb:keysyms:num-lock-mask)))
(dolist (xwin xwins)
(setf (slot-value req 'grab-window) xwin)
(xcb:+request exwm--connection req)
(when alt-modifier
(setf (slot-value req 'modifiers) alt-modifier)
(xcb:+request exwm--connection req))))))
(xcb:flush exwm--connection)))
(defun exwm-input--set-key (key command)
"Set KEY to COMMAND."
(exwm--log "key: %s, command: %s" key command)
(global-set-key key command)
(cl-pushnew key exwm-input--global-keys))
(defcustom exwm-input-global-keys nil
"Global keys.
It is an alist of the form (key . command), meaning giving KEY (a key
sequence) a global binding as COMMAND.
Notes:
* Setting the value directly (rather than customizing it) after EXWM
finishes initialization has no effect."
:type '(alist :key-type key-sequence :value-type function)
:set (lambda (symbol value)
(when (boundp symbol)
(dolist (i (symbol-value symbol))
(global-unset-key (car i))))
(set symbol value)
(setq exwm-input--global-keys nil)
(dolist (i value)
(exwm-input--set-key (car i) (cdr i)))
(when exwm--connection
(exwm-input--update-global-prefix-keys))))
;;;###autoload
(defun exwm-input-set-key (key command)
"Set a global KEY binding to COMMAND.
The new binding only takes effect in real time when this command is
called interactively, and is lost when this session ends unless it's
specifically saved in the Customize interface for `exwm-input-global-keys'.
In configuration you should customize or set `exwm-input-global-keys'
instead."
(interactive "KSet key globally: \nCSet key %s to command: ")
(exwm--log)
(setq exwm-input-global-keys (append exwm-input-global-keys
(list (cons key command))))
(exwm-input--set-key key command)
(when (called-interactively-p 'any)
(exwm-input--update-global-prefix-keys)))
(defsubst exwm-input--unread-event (event)
"Append EVENT to `unread-command-events'."
(declare (indent defun))
(setq unread-command-events
(append unread-command-events `((t . ,event)))))
(defun exwm-input--mimic-read-event (event)
"Process EVENT as if it were returned by `read-event'."
(exwm--log)
(unless (eq 0 extra-keyboard-modifiers)
(setq event (event-convert-list (append (event-modifiers
extra-keyboard-modifiers)
event))))
(when (characterp event)
(let ((event* (when keyboard-translate-table
(aref keyboard-translate-table event))))
(when event*
(setq event event*))))
event)
(cl-defun exwm-input--translate (key)
"Translate KEY."
(let (translation)
(dolist (map (list input-decode-map
local-function-key-map
key-translation-map))
(setq translation (lookup-key map key))
(if (functionp translation)
(cl-return-from exwm-input--translate (funcall translation nil))
(when (vectorp translation)
(cl-return-from exwm-input--translate translation)))))
key)
(defun exwm-input--cache-event (event &optional temp-line-mode)
"Cache EVENT.
When non-nil, TEMP-LINE-MODE temporarily puts the window in line mode."
(exwm--log "%s" event)
(setq exwm-input--line-mode-cache
(vconcat exwm-input--line-mode-cache (vector event)))
;; Attempt to translate this key sequence.
(setq exwm-input--line-mode-cache
(exwm-input--translate exwm-input--line-mode-cache))
;; When the key sequence is complete (not a keymap).
;; Note that `exwm-input--line-mode-cache' might get translated to nil, for
;; example 'mouse--down-1-maybe-follows-link' does this.
(if (and exwm-input--line-mode-cache
(keymapp (key-binding exwm-input--line-mode-cache)))
;; Grab keyboard temporarily to intercept the complete key sequence.
(when temp-line-mode
(setq exwm-input--temp-line-mode t)
(exwm-input--grab-keyboard))
(setq exwm-input--line-mode-cache nil)
(when exwm-input--temp-line-mode
(setq exwm-input--temp-line-mode nil)
(exwm-input--release-keyboard))))
(defun exwm-input--event-passthrough-p (event)
"Whether EVENT should be passed to Emacs.
Current buffer must be an `exwm-mode' buffer."
(or exwm-input-line-mode-passthrough
exwm-input--during-command
;; Forward the event when there is an incomplete key
;; sequence or when the minibuffer is active.
exwm-input--line-mode-cache
(eq (active-minibuffer-window) (selected-window))
;;
(memq event exwm-input--global-prefix-keys)
(memq event exwm-input-prefix-keys)
(when overriding-terminal-local-map
(lookup-key overriding-terminal-local-map
(vector event)))
(lookup-key (current-local-map) (vector event))
(gethash event exwm-input--simulation-keys)))
(defun exwm-input--noop (&rest _args)
"A placeholder command."
(interactive))
(defun exwm-input--fake-last-command ()
"Fool some packages into thinking there is a change in the buffer."
(setq last-command #'exwm-input--noop)
;; The Emacs manual says:
;; > Quitting is suppressed while running pre-command-hook and
;; > post-command-hook. If an error happens while executing one of these
;; > hooks, it does not terminate execution of the hook; instead the error is
;; > silenced and the function in which the error occurred is removed from the
;; > hook.
;; We supress errors but neither continue execution nor we remove from the
;; hook.
(condition-case err
(run-hooks 'pre-command-hook)
((error)
(exwm--log "Error occurred while running pre-command-hook: %s"
(error-message-string err))
(xcb-debug:backtrace)))
(condition-case err
(run-hooks 'post-command-hook)
((error)
(exwm--log "Error occurred while running post-command-hook: %s"
(error-message-string err))
(xcb-debug:backtrace))))
(defun exwm-input--on-KeyPress-line-mode (keypress raw-data)
"Feed parsed X KEYPRESS event with RAW-DATA to Emacs command loop."
(with-slots (detail state) keypress
(let ((keysym (xcb:keysyms:keycode->keysym exwm--connection detail state))
event raw-event mode)
(exwm--log "%s" keysym)
(when (and (/= 0 (car keysym))
(setq raw-event (xcb:keysyms:keysym->event
exwm--connection (car keysym)
(logand state (lognot (cdr keysym)))))
(setq event (exwm-input--mimic-read-event raw-event))
(exwm-input--event-passthrough-p event))
(setq mode xcb:Allow:AsyncKeyboard)
(exwm-input--cache-event event)
(exwm-input--unread-event raw-event))
(unless mode
(if (= 0 (logand #x6000 state)) ;Check the 13~14 bits.
;; Not an XKB state; just replay it.
(setq mode xcb:Allow:ReplayKeyboard)
;; An XKB state; sent it with SendEvent.
;; FIXME: Can this also be replayed?
;; FIXME: KeyRelease events are lost.
(setq mode xcb:Allow:AsyncKeyboard)
(xcb:+request exwm--connection
(make-instance 'xcb:SendEvent
:propagate 0
:destination (slot-value keypress 'event)
:event-mask xcb:EventMask:NoEvent
:event raw-data)))
(when event
(if (not defining-kbd-macro)
(exwm-input--fake-last-command)
;; Make Emacs aware of this event when defining keyboard macros.
(set-transient-map `(keymap (t . ,#'exwm-input--noop)))
(exwm-input--unread-event event))))
(xcb:+request exwm--connection
(make-instance 'xcb:AllowEvents
:mode mode
:time xcb:Time:CurrentTime))
(xcb:flush exwm--connection))))
(defun exwm-input--on-KeyPress-char-mode (keypress &optional _raw-data)
"Handle `char-mode' KEYPRESS event."
(with-slots (detail state) keypress
(let ((keysym (xcb:keysyms:keycode->keysym exwm--connection detail state))
event raw-event)
(exwm--log "%s" keysym)
(when (and (/= 0 (car keysym))
(setq raw-event (xcb:keysyms:keysym->event
exwm--connection (car keysym)
(logand state (lognot (cdr keysym)))))
(setq event (exwm-input--mimic-read-event raw-event)))
(if (not (derived-mode-p 'exwm-mode))
(exwm-input--unread-event raw-event)
(exwm-input--cache-event event t)
(exwm-input--unread-event raw-event)))))
(xcb:+request exwm--connection
(make-instance 'xcb:AllowEvents
:mode xcb:Allow:AsyncKeyboard
:time xcb:Time:CurrentTime))
(xcb:flush exwm--connection))
(defun exwm-input--on-ButtonPress-line-mode (buffer button-event)
"Handle button events in line mode.
BUFFER is the `exwm-mode' buffer the event was generated
on. BUTTON-EVENT is the X event converted into an Emacs event.
The return value is used as event_mode to release the original
button event."
(with-current-buffer buffer
(let ((read-event (exwm-input--mimic-read-event button-event)))
(exwm--log "%s" read-event)
(if (and read-event
(exwm-input--event-passthrough-p read-event))
;; The event should be forwarded to emacs
(progn
(exwm-input--cache-event read-event)
(exwm-input--unread-event button-event)
xcb:Allow:SyncPointer)
;; The event should be replayed
xcb:Allow:ReplayPointer))))
(defun exwm-input--on-ButtonPress-char-mode ()
"Handle button events in `char-mode'.
The return value is used as event_mode to release the original
button event."
(exwm--log)
xcb:Allow:ReplayPointer)
(defun exwm-input--update-mode-line (id)
"Update the propertized `mode-line-process' for window ID."
(exwm--log "#x%x" id)
(let (help-echo cmd mode)
(with-current-buffer (exwm--id->buffer id)
(cl-case exwm--input-mode
(line-mode
(setq mode "line"
help-echo "mouse-1: Switch to char-mode"
cmd (lambda ()
(interactive)
(exwm-input-release-keyboard id))))
(char-mode
(setq mode "char"
help-echo "mouse-1: Switch to line-mode"
cmd (lambda ()
(interactive)
(exwm-input-grab-keyboard id)))))
(setq mode-line-process
`(": "
(:propertize ,mode
help-echo ,help-echo
mouse-face mode-line-highlight
local-map
(keymap
(mode-line
keymap
(down-mouse-1 . ,cmd))))))
(force-mode-line-update))))
(defun exwm-input--grab-keyboard (&optional id)
"Grab all key events on window ID."
(unless id (setq id (exwm--buffer->id (window-buffer))))
(when id
(exwm--log "id=#x%x" id)
(when (xcb:+request-checked+request-check exwm--connection
(make-instance 'xcb:GrabKey
:owner-events 0
:grab-window id
:modifiers xcb:ModMask:Any
:key xcb:Grab:Any
:pointer-mode xcb:GrabMode:Async
:keyboard-mode xcb:GrabMode:Sync))
(exwm--log "Failed to grab keyboard for #x%x" id))
(let ((buffer (exwm--id->buffer id)))
(when buffer
(with-current-buffer buffer
(setq exwm--input-mode 'line-mode)
(run-hooks 'exwm-input-input-mode-change-hook))))))
(defun exwm-input--release-keyboard (&optional id)
"Ungrab all key events on window ID."
(unless id (setq id (exwm--buffer->id (window-buffer))))
(when id
(exwm--log "id=#x%x" id)
(when (xcb:+request-checked+request-check exwm--connection
(make-instance 'xcb:UngrabKey
:key xcb:Grab:Any
:grab-window id
:modifiers xcb:ModMask:Any))
(exwm--log "Failed to release keyboard for #x%x" id))
(exwm-input--grab-global-prefix-keys id)
(let ((buffer (exwm--id->buffer id)))
(when buffer
(with-current-buffer buffer
(setq exwm--input-mode 'char-mode)
(run-hooks 'exwm-input-input-mode-change-hook))))))
;;;###autoload
(defun exwm-input-grab-keyboard (&optional id)
"Switch to `line-mode`.
When ID is non-nil, grab key events on its corresponding window."
(interactive (list (when (derived-mode-p 'exwm-mode)
(exwm--buffer->id (window-buffer)))))
(when id
(exwm--log "id=#x%x" id)
(setq exwm--selected-input-mode 'line-mode)
(exwm-input--grab-keyboard id)
(exwm-input--update-mode-line id)))
;;;###autoload
(defun exwm-input-release-keyboard (&optional id)
"Switch to `char-mode`.
When ID is non-nil, release keyboard events on its corresponding window."
(interactive (list (when (derived-mode-p 'exwm-mode)
(exwm--buffer->id (window-buffer)))))
(when id
(exwm--log "id=#x%x" id)
(setq exwm--selected-input-mode 'char-mode)
(exwm-input--release-keyboard id)
(exwm-input--update-mode-line id)))
;;;###autoload
(defun exwm-input-toggle-keyboard (&optional id)
"Toggle between `line-mode' and `char-mode'.
When ID is non-nil, toggle in its correpsonding window."
(interactive (list (when (derived-mode-p 'exwm-mode)
(exwm--buffer->id (window-buffer)))))
(when id
(exwm--log "id=#x%x" id)
(with-current-buffer (exwm--id->buffer id)
(cl-case exwm--input-mode
(line-mode
(exwm-input-release-keyboard id))
(char-mode
(exwm-reset))))))
(defun exwm-input--fake-key (event)
"Fake a key event equivalent to Emacs event EVENT."
(let* ((keysyms (xcb:keysyms:event->keysyms exwm--connection event))
keycode id)
(when (= 0 (caar keysyms))
(user-error "[EXWM] Invalid key: %s" (single-key-description event)))
(setq keycode (xcb:keysyms:keysym->keycode exwm--connection
(caar keysyms)))
(when (/= 0 keycode)
(setq id (exwm--buffer->id (window-buffer (selected-window))))
(exwm--log "id=#x%x event=%s keycode" id event keycode)
(dolist (class '(xcb:KeyPress xcb:KeyRelease))
(xcb:+request exwm--connection
(make-instance 'xcb:SendEvent
:propagate 0 :destination id
:event-mask xcb:EventMask:NoEvent
:event (xcb:marshal
(make-instance class
:detail keycode
:time xcb:Time:CurrentTime
:root exwm--root :event id
:child 0
:root-x 0 :root-y 0
:event-x 0 :event-y 0
:state (cdar keysyms)
:same-screen 1)
exwm--connection)))))
(xcb:flush exwm--connection)))
;;;###autoload
(cl-defun exwm-input-send-next-key (n &optional end-key)
"Send next N keys to client window.
N is currently capped at 12.
EXWM will prompt for the key to send.
If END-KEY is non-nil, stop sending keys if it's pressed."
(interactive "p")
(exwm--log)
(unless (derived-mode-p 'exwm-mode) (cl-return-from exwm-input-send-next-key))
(setq n (min n 12))
(let (key keys)
(dotimes (i n)
;; Skip events not from keyboard
(let ((exwm-input-line-mode-passthrough t))
(catch 'break
(while t
(setq key (read-key (format "Send key: %s (%d/%d) %s"
(key-description keys)
(1+ i) n
(if end-key
(concat "To exit, press: "
(key-description
(list end-key)))
""))))
(unless (listp key) (throw 'break nil)))))
(setq keys (vconcat keys (vector key)))
(when (eq key end-key) (cl-return-from exwm-input-send-next-key))
(exwm-input--fake-key key))))
(defun exwm-input--set-simulation-keys (keys &optional cache)
"Set simulation KEYS.
If CACHE is non-nil reuse `exwm-input--simulation-keys' cache."
(exwm--log "%s" keys)
(unless cache
;; Unbind simulation keys.
(let ((hash (buffer-local-value 'exwm-input--simulation-keys
(current-buffer))))
(when (hash-table-p hash)
(maphash (lambda (key _value)
(when (sequencep key)
(if exwm-input--local-simulation-keys
(local-unset-key key)
(define-key exwm-mode-map key nil))))
hash)))
;; Abandon the old hash table.
(setq exwm-input--simulation-keys (make-hash-table :test #'equal)))
(dolist (i keys)
(let ((original (vconcat (car i)))
(simulated (cdr i)))
(setq simulated (if (sequencep simulated)
(append simulated nil)
(list simulated)))
;; The key stored is a key sequence (vector).
;; The value stored is a list of key events.
(puthash original simulated exwm-input--simulation-keys)
;; Also mark the prefix key as used.
(puthash (aref original 0) t exwm-input--simulation-keys)))
;; Update keymaps.
(maphash (lambda (key _value)
(when (sequencep key)
(if exwm-input--local-simulation-keys
(local-set-key key #'exwm-input-send-simulation-key)
(define-key exwm-mode-map key
#'exwm-input-send-simulation-key))))
exwm-input--simulation-keys))
(defcustom exwm-input-simulation-keys nil
"Simulation keys.
It is an alist of the form (original-key . simulated-key), where both
original-key and simulated-key are key sequences. Original-key is what you
type to an X window in `line-mode' which then gets translated to simulated-key
by EXWM and forwarded to the X window.
Notes:
* Setting the value directly (rather than customizing it) after EXWM
finishes initialization has no effect.
* Original-keys consist of multiple key events are only supported in Emacs
26.2 and later.
* A minority of applications do not accept simulated keys by default. It's
required to customize them to accept events sent by SendEvent.
* The predefined examples in the Customize interface are not guaranteed to
work for all applications. This can be tweaked on a per application basis
with `exwm-input-set-local-simulation-keys'."
:type '(alist :key-type (key-sequence :tag "Original")
:value-type (choice (key-sequence :tag "User-defined")