/
lib_mouse.c
2099 lines (1863 loc) · 54.6 KB
/
lib_mouse.c
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
/****************************************************************************
* Copyright 2018-2023,2024 Thomas E. Dickey *
* Copyright 1998-2016,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* "Software"), to deal in the Software without restriction, including *
* without limitation the rights to use, copy, modify, merge, publish, *
* distribute, distribute with modifications, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included *
* in all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
* *
* Except as contained in this notice, the name(s) of the above copyright *
* holders shall not be used in advertising or otherwise to promote the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************/
/****************************************************************************
* Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
* and: Eric S. Raymond <esr@snark.thyrsus.com> *
* and: Thomas E. Dickey 1996-on *
* and: Juergen Pfeifer 2008 *
****************************************************************************/
/*
* This module is intended to encapsulate ncurses's interface to pointing
* devices.
*
* The primary method used is xterm's internal mouse-tracking facility.
* Additional methods depend on the platform:
* Alessandro Rubini's GPM server (Linux)
* sysmouse (FreeBSD)
* special-purpose mouse interface for OS/2 EMX.
*
* Notes for implementors of new mouse-interface methods:
*
* The code is logically split into a lower level that accepts event reports
* in a device-dependent format and an upper level that parses mouse gestures
* and filters events. The mediating data structure is a circular queue of
* MEVENT structures.
*
* Functionally, the lower level's job is to pick up primitive events and
* put them on the circular queue. This can happen in one of two ways:
* either (a) _nc_mouse_event() detects a series of incoming mouse reports
* and queues them, or (b) code in lib_getch.c detects the kmous prefix in
* the keyboard input stream and calls _nc_mouse_inline to queue up a series
* of adjacent mouse reports.
*
* In either case, _nc_mouse_parse() should be called after the series is
* accepted to parse the digested mouse reports (low-level MEVENTs) into
* a gesture (a high-level or composite MEVENT).
*
* Don't be too shy about adding new event types or modifiers, if you can find
* room for them in the 32-bit mask. The API is written so that users get
* feedback on which theoretical event types they won't see when they call
* mousemask. There's one bit per button (the RESERVED_EVENT bit) not being
* used yet, and a couple of bits open at the high end.
*/
#ifdef __EMX__
# include <io.h>
# define INCL_DOS
# define INCL_VIO
# define INCL_KBD
# define INCL_MOU
# define INCL_DOSPROCESS
# include <os2.h> /* Need to include before the others */
#endif
#include <curses.priv.h>
#ifndef CUR
#define CUR SP_TERMTYPE
#endif
MODULE_ID("$Id: lib_mouse.c,v 1.200 2024/02/17 21:13:01 tom Exp $")
#include <tic.h>
#if USE_GPM_SUPPORT
#include <linux/keyboard.h> /* defines KG_* macros */
#ifdef HAVE_LIBDL
/* use dynamic loader to avoid linkage dependency */
#include <dlfcn.h>
#ifdef RTLD_NOW
#define my_RTLD RTLD_NOW
#else
#ifdef RTLD_LAZY
#define my_RTLD RTLD_LAZY
#else
make an error
#endif
#endif /* RTLD_NOW */
#endif /* HAVE_LIBDL */
#endif /* USE_GPM_SUPPORT */
#if USE_SYSMOUSE
#undef buttons /* symbol conflict in consio.h */
#undef mouse_info /* symbol conflict in consio.h */
#include <osreldate.h>
#if defined(__DragonFly_version) || (defined(__FreeBSD__) && (__FreeBSD_version >= 400017))
#include <sys/consio.h>
#include <sys/fbio.h>
#else
#include <machine/console.h>
#endif
#endif /* use_SYSMOUSE */
#if USE_KLIBC_MOUSE
#include <sys/socket.h>
#define pipe(handles) socketpair(AF_LOCAL, SOCK_STREAM, 0, handles)
#define DosWrite(hfile, pbuffer, cbwrite, pcbactual) \
write(hfile, pbuffer, cbwrite)
#define DosExit(action, result ) /* do nothing */
#define DosCreateThread(ptid, pfn, param, flag, cbStack) \
(*(ptid) = _beginthread(pfn, NULL, cbStack, \
(void *)param), (*(ptid) == -1))
#endif
#define MY_TRACE TRACE_ICALLS|TRACE_IEVENT
#define MASK_RELEASE(x) (mmask_t) NCURSES_MOUSE_MASK(x, 001)
#define MASK_PRESS(x) (mmask_t) NCURSES_MOUSE_MASK(x, 002)
#define MASK_CLICK(x) (mmask_t) NCURSES_MOUSE_MASK(x, 004)
#define MASK_DOUBLE_CLICK(x) (mmask_t) NCURSES_MOUSE_MASK(x, 010)
#define MASK_TRIPLE_CLICK(x) (mmask_t) NCURSES_MOUSE_MASK(x, 020)
#define MASK_RESERVED_EVENT(x) (mmask_t) NCURSES_MOUSE_MASK(x, 040)
#if NCURSES_MOUSE_VERSION == 1
#define BUTTON_CLICKED (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED | BUTTON4_CLICKED)
#define BUTTON_PRESSED (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED | BUTTON4_PRESSED)
#define BUTTON_RELEASED (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED | BUTTON4_RELEASED)
#define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED)
#define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED)
#define MAX_BUTTONS 4
#else
#define BUTTON_CLICKED (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED | BUTTON4_CLICKED | BUTTON5_CLICKED)
#define BUTTON_PRESSED (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED | BUTTON4_PRESSED | BUTTON5_PRESSED)
#define BUTTON_RELEASED (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED | BUTTON4_RELEASED | BUTTON5_RELEASED)
#define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED | BUTTON5_DOUBLE_CLICKED)
#define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED | BUTTON5_TRIPLE_CLICKED)
#if NCURSES_MOUSE_VERSION == 2
#define MAX_BUTTONS 5
#else
#define MAX_BUTTONS 11
#endif
#endif
#define INVALID_EVENT -1
#define NORMAL_EVENT 0
#define ValidEvent(ep) ((ep)->id != INVALID_EVENT)
#define Invalidate(ep) (ep)->id = INVALID_EVENT
#if USE_GPM_SUPPORT
#ifndef LIBGPM_SONAME
#define LIBGPM_SONAME "libgpm.so"
#endif
#define GET_DLSYM(name) (my_##name = (TYPE_##name) dlsym(sp->_dlopen_gpm, #name))
#endif /* USE_GPM_SUPPORT */
static bool _nc_mouse_parse(SCREEN *, int);
static void _nc_mouse_resume(SCREEN *);
static void _nc_mouse_wrap(SCREEN *);
/* maintain a circular list of mouse events */
#define FirstEV(sp) ((sp)->_mouse_events)
#define LastEV(sp) ((sp)->_mouse_events + EV_MAX - 1)
#undef NEXT
#define NEXT(ep) ((ep >= LastEV(SP_PARM)) \
? FirstEV(SP_PARM) \
: ep + 1)
#undef PREV
#define PREV(ep) ((ep <= FirstEV(SP_PARM)) \
? LastEV(SP_PARM) \
: ep - 1)
#define IndexEV(sp, ep) (ep - FirstEV(sp))
#define RunParams(sp, eventp, runp) \
(long) IndexEV(sp, runp), \
(long) (IndexEV(sp, eventp) + (EV_MAX - 1)) % EV_MAX
#ifdef TRACE
static void
_trace_slot(SCREEN *sp, const char *tag)
{
MEVENT *ep;
_tracef("%s", tag);
for (ep = FirstEV(sp); ep <= LastEV(sp); ep++)
_tracef("mouse event queue slot %ld = %s",
(long) IndexEV(sp, ep),
_nc_tracemouse(sp, ep));
}
#endif
#if USE_EMX_MOUSE
# define TOP_ROW 0
# define LEFT_COL 0
# define M_FD(sp) sp->_mouse_fd
static void
write_event(SCREEN *sp, int down, int button, int x, int y)
{
char buf[6];
unsigned long ignore;
_nc_STRCPY(buf, "\033[M", sizeof(buf)); /* should be the same as key_mouse */
buf[3] = ' ' + (button - 1) + (down ? 0 : 0x40);
buf[4] = ' ' + x - LEFT_COL + 1;
buf[5] = ' ' + y - TOP_ROW + 1;
DosWrite(sp->_emxmouse_wfd, buf, 6, &ignore);
}
static void
#if USE_KLIBC_MOUSE
mouse_server(void *param)
#else
mouse_server(unsigned long param)
#endif
{
SCREEN *sp = (SCREEN *) param;
unsigned short fWait = MOU_WAIT;
/* NOPTRRECT mourt = { 0,0,24,79 }; */
MOUEVENTINFO mouev;
HMOU hmou;
unsigned short mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN | MOUSE_BN3_DOWN;
int nbuttons = 3;
int oldstate = 0;
char err[80];
unsigned long rc;
/* open the handle for the mouse */
if (MouOpen(NULL, &hmou) == 0) {
rc = MouSetEventMask(&mask, hmou);
if (rc) { /* retry with 2 buttons */
mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN;
rc = MouSetEventMask(&mask, hmou);
nbuttons = 2;
}
if (rc == 0 && MouDrawPtr(hmou) == 0) {
for (;;) {
/* sit and wait on the event queue */
rc = MouReadEventQue(&mouev, &fWait, hmou);
if (rc) {
_nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
"Error reading mouse queue, rc=%lu.\r\n", rc);
break;
}
if (!sp->_emxmouse_activated)
goto finish;
/*
* OS/2 numbers a 3-button mouse inconsistently from other
* platforms:
* 1 = left
* 2 = right
* 3 = middle.
*/
if ((mouev.fs ^ oldstate) & MOUSE_BN1_DOWN)
write_event(sp, mouev.fs & MOUSE_BN1_DOWN,
sp->_emxmouse_buttons[1], mouev.col, mouev.row);
if ((mouev.fs ^ oldstate) & MOUSE_BN2_DOWN)
write_event(sp, mouev.fs & MOUSE_BN2_DOWN,
sp->_emxmouse_buttons[3], mouev.col, mouev.row);
if ((mouev.fs ^ oldstate) & MOUSE_BN3_DOWN)
write_event(sp, mouev.fs & MOUSE_BN3_DOWN,
sp->_emxmouse_buttons[2], mouev.col, mouev.row);
finish:
oldstate = mouev.fs;
}
} else {
_nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
"Error setting event mask, buttons=%d, rc=%lu.\r\n",
nbuttons, rc);
}
DosWrite(2, err, strlen(err), &rc);
MouClose(hmou);
}
DosExit(EXIT_THREAD, 0L);
}
#endif /* USE_EMX_MOUSE */
#if USE_SYSMOUSE
static void
sysmouse_server(SCREEN *sp)
{
struct mouse_info the_mouse;
MEVENT *work;
the_mouse.operation = MOUSE_GETINFO;
if (sp != 0
&& sp->_mouse_fd >= 0
&& sp->_sysmouse_tail < FIFO_SIZE
&& ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
if (sp->_sysmouse_head > sp->_sysmouse_tail) {
sp->_sysmouse_tail = 0;
sp->_sysmouse_head = 0;
}
work = &(sp->_sysmouse_fifo[sp->_sysmouse_tail]);
memset(work, 0, sizeof(*work));
work->id = NORMAL_EVENT; /* there's only one mouse... */
sp->_sysmouse_old_buttons = sp->_sysmouse_new_buttons;
sp->_sysmouse_new_buttons = the_mouse.u.data.buttons & 0x7;
if (sp->_sysmouse_new_buttons) {
if (sp->_sysmouse_new_buttons & 1)
work->bstate |= BUTTON1_PRESSED;
if (sp->_sysmouse_new_buttons & 2)
work->bstate |= BUTTON2_PRESSED;
if (sp->_sysmouse_new_buttons & 4)
work->bstate |= BUTTON3_PRESSED;
} else {
if (sp->_sysmouse_old_buttons & 1)
work->bstate |= BUTTON1_RELEASED;
if (sp->_sysmouse_old_buttons & 2)
work->bstate |= BUTTON2_RELEASED;
if (sp->_sysmouse_old_buttons & 4)
work->bstate |= BUTTON3_RELEASED;
}
/* for cosmetic bug in syscons.c on FreeBSD 3.[34] */
the_mouse.operation = MOUSE_HIDE;
ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
the_mouse.operation = MOUSE_SHOW;
ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
/*
* We're only interested if the button is pressed or released.
* FIXME: implement continuous event-tracking.
*/
if (sp->_sysmouse_new_buttons != sp->_sysmouse_old_buttons) {
sp->_sysmouse_tail += 1;
}
work->x = the_mouse.u.data.x / sp->_sysmouse_char_width;
work->y = the_mouse.u.data.y / sp->_sysmouse_char_height;
}
}
static void
handle_sysmouse(int sig GCC_UNUSED)
{
sysmouse_server(CURRENT_SCREEN);
}
#endif /* USE_SYSMOUSE */
#if !defined(USE_TERM_DRIVER) || defined(EXP_WIN32_DRIVER)
#define xterm_kmous "\033[M"
static void
init_xterm_mouse(SCREEN *sp)
{
sp->_mouse_type = M_XTERM;
sp->_mouse_format = MF_X10;
sp->_mouse_xtermcap = tigetstr("XM");
if (VALID_STRING(sp->_mouse_xtermcap)) {
char *code = strstr(sp->_mouse_xtermcap, "[?");
if (code != 0) {
code += 2;
while ((*code >= '0') && (*code <= '9')) {
char *next = code;
while ((*next >= '0') && (*next <= '9')) {
++next;
}
if (!strncmp(code, "1006", (size_t) (next - code))) {
sp->_mouse_format = MF_SGR1006;
}
#ifdef EXP_XTERM_1005
if (!strncmp(code, "1005", (size_t) (next - code))) {
sp->_mouse_format = MF_XTERM_1005;
}
#endif
if (*next == ';') {
while (*next == ';') {
++next;
}
code = next;
} else {
break;
}
}
}
} else {
int code = tigetnum("XM");
switch (code) {
#ifdef EXP_XTERM_1005
case 1005:
/* see "xterm+sm+1005" */
sp->_mouse_xtermcap = "\033[?1005;1000%?%p1%{1}%=%th%el%;";
sp->_mouse_format = MF_XTERM_1005;
break;
#endif
case 1006:
/* see "xterm+sm+1006" */
sp->_mouse_xtermcap = "\033[?1006;1000%?%p1%{1}%=%th%el%;";
sp->_mouse_format = MF_SGR1006;
break;
default:
sp->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
break;
}
}
}
#endif
static void
enable_xterm_mouse(SCREEN *sp, int enable)
{
TPUTS_TRACE(enable
? "xterm mouse initialization"
: "xterm mouse deinitialization");
#if USE_EMX_MOUSE
sp->_emxmouse_activated = enable;
#else
NCURSES_PUTP2("xterm-mouse", TIPARM_1(sp->_mouse_xtermcap, enable));
#endif
sp->_mouse_active = enable;
}
#if defined(USE_TERM_DRIVER)
static void
enable_win32_mouse(SCREEN *sp, int enable)
{
#if defined(EXP_WIN32_DRIVER)
enable_xterm_mouse(sp, enable);
#else
sp->_mouse_active = enable;
#endif
}
#endif
#if USE_GPM_SUPPORT
static bool
allow_gpm_mouse(SCREEN *sp GCC_UNUSED)
{
bool result = FALSE;
#if USE_WEAK_SYMBOLS
/* Danger Robinson: do not use dlopen for libgpm if already loaded */
if ((Gpm_Wgetch) != 0) {
if (!sp->_mouse_gpm_loaded) {
T(("GPM library was already dlopen'd, not by us"));
}
} else
#endif
/* GPM does printf's without checking if stdout is a terminal */
if (NC_ISATTY(fileno(stdout))) {
const char *list = getenv("NCURSES_GPM_TERMS");
const char *env = getenv("TERM");
if (list != 0) {
if (env != 0) {
result = _nc_name_match(list, env, "|:");
}
} else {
/* GPM checks the beginning of the $TERM variable to decide if it
* should pass xterm events through. There is no real advantage in
* allowing GPM to do this. Recent versions relax that check, and
* pretend that GPM can work with any terminal having the kmous
* capability. Perhaps that works for someone. If so, they can
* set the environment variable (above).
*/
if (env != 0 && strstr(env, "linux") != 0) {
result = TRUE;
}
}
}
return result;
}
#ifdef HAVE_LIBDL
static void
unload_gpm_library(SCREEN *sp)
{
if (sp->_dlopen_gpm != 0) {
T(("unload GPM library"));
sp->_mouse_gpm_loaded = FALSE;
sp->_mouse_fd = -1;
}
}
static void
load_gpm_library(SCREEN *sp)
{
sp->_mouse_gpm_found = FALSE;
/*
* If we already had a successful dlopen, reuse it.
*/
if (sp->_dlopen_gpm != 0) {
sp->_mouse_gpm_found = TRUE;
sp->_mouse_gpm_loaded = TRUE;
} else if ((sp->_dlopen_gpm = dlopen(LIBGPM_SONAME, my_RTLD)) != 0) {
#if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpedantic"
#endif
if (GET_DLSYM(gpm_fd) == 0 ||
GET_DLSYM(Gpm_Open) == 0 ||
GET_DLSYM(Gpm_Close) == 0 ||
GET_DLSYM(Gpm_GetEvent) == 0) {
#if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
#pragma GCC diagnostic pop
#endif
T(("GPM initialization failed: %s", dlerror()));
unload_gpm_library(sp);
dlclose(sp->_dlopen_gpm);
sp->_dlopen_gpm = 0;
} else {
sp->_mouse_gpm_found = TRUE;
sp->_mouse_gpm_loaded = TRUE;
}
}
}
#endif /* HAVE_LIBDL */
static bool
enable_gpm_mouse(SCREEN *sp, bool enable)
{
bool result;
T((T_CALLED("enable_gpm_mouse(%d)"), enable));
if (enable && !sp->_mouse_active) {
#ifdef HAVE_LIBDL
if (sp->_mouse_gpm_found && !sp->_mouse_gpm_loaded) {
load_gpm_library(sp);
}
#endif
if (sp->_mouse_gpm_loaded) {
int code;
/* GPM: initialize connection to gpm server */
sp->_mouse_gpm_connect.eventMask = GPM_DOWN | GPM_UP;
sp->_mouse_gpm_connect.defaultMask =
(unsigned short) (~(sp->_mouse_gpm_connect.eventMask | GPM_HARD));
sp->_mouse_gpm_connect.minMod = 0;
sp->_mouse_gpm_connect.maxMod =
(unsigned short) (~((1 << KG_SHIFT) |
(1 << KG_SHIFTL) |
(1 << KG_SHIFTR)));
/*
* Note: GPM hardcodes \E[?1001s and \E[?1000h during its open.
* The former is recognized by wscons (SunOS), and the latter by
* xterm. Those will not show up in ncurses' traces.
*/
code = my_Gpm_Open(&sp->_mouse_gpm_connect, 0);
result = (code >= 0);
/*
* GPM can return a -2 if it is trying to do something with xterm.
* Ignore that, since it conflicts with our use of stdin.
*/
if (code == -2) {
my_Gpm_Close();
}
} else {
result = FALSE;
}
sp->_mouse_active = result;
T(("GPM open %s", result ? "succeeded" : "failed"));
} else {
if (!enable && sp->_mouse_active) {
/* GPM: close connection to gpm server */
my_Gpm_Close();
sp->_mouse_active = FALSE;
T(("GPM closed"));
}
result = enable;
}
#ifdef HAVE_LIBDL
if (!result) {
unload_gpm_library(sp);
}
#endif
returnBool(result);
}
#endif /* USE_GPM_SUPPORT */
static void
initialize_mousetype(SCREEN *sp)
{
T((T_CALLED("initialize_mousetype()")));
/* Try gpm first, because gpm may be configured to run in xterm */
#if USE_GPM_SUPPORT
if (allow_gpm_mouse(sp)) {
if (!sp->_mouse_gpm_loaded) {
#ifdef HAVE_LIBDL
load_gpm_library(sp);
#else /* !HAVE_LIBDL */
sp->_mouse_gpm_found = TRUE;
sp->_mouse_gpm_loaded = TRUE;
#endif
}
/*
* The gpm_fd file-descriptor may be negative (xterm). So we have to
* maintain our notion of whether the mouse connection is active
* without testing the file-descriptor.
*/
if (sp->_mouse_gpm_found && enable_gpm_mouse(sp, TRUE)) {
sp->_mouse_type = M_GPM;
sp->_mouse_fd = *(my_gpm_fd);
T(("GPM mouse_fd %d", sp->_mouse_fd));
returnVoid;
}
}
#endif /* USE_GPM_SUPPORT */
/* OS/2 VIO */
#if USE_EMX_MOUSE
if (!sp->_emxmouse_thread
&& strstr(SP_TERMTYPE term_names, "xterm") == 0
&& NonEmpty(key_mouse)) {
int handles[2];
if (pipe(handles) < 0) {
perror("mouse pipe error");
returnVoid;
} else {
int rc;
if (!sp->_emxmouse_buttons[0]) {
const char *s = getenv("MOUSE_BUTTONS_123");
sp->_emxmouse_buttons[0] = 1;
if (s && strlen(s) >= 3) {
sp->_emxmouse_buttons[1] = s[0] - '0';
sp->_emxmouse_buttons[2] = s[1] - '0';
sp->_emxmouse_buttons[3] = s[2] - '0';
} else {
sp->_emxmouse_buttons[1] = 1;
sp->_emxmouse_buttons[2] = 3;
sp->_emxmouse_buttons[3] = 2;
}
}
sp->_emxmouse_wfd = handles[1];
M_FD(sp) = handles[0];
/* Needed? */
setmode(handles[0], O_BINARY);
setmode(handles[1], O_BINARY);
/* Do not use CRT functions, we may single-threaded. */
rc = DosCreateThread((unsigned long *) &sp->_emxmouse_thread,
mouse_server, (long) sp, 0, 8192);
if (rc) {
printf("mouse thread error %d=%#x", rc, rc);
} else {
sp->_mouse_type = M_XTERM;
}
returnVoid;
}
}
#endif /* USE_EMX_MOUSE */
#if USE_SYSMOUSE
{
static char dev_tty[] = "/dev/tty";
struct mouse_info the_mouse;
char *the_device = 0;
if (NC_ISATTY(sp->_ifd))
the_device = ttyname(sp->_ifd);
if (the_device == 0)
the_device = dev_tty;
sp->_mouse_fd = open(the_device, O_RDWR);
if (sp->_mouse_fd >= 0) {
/*
* sysmouse does not have a usable user interface for obtaining
* mouse events. The logical way to proceed (reading data on a
* stream) only works if one opens the device as root. Even in
* that mode, careful examination shows we lose events
* occasionally. The interface provided for user programs is to
* establish a signal handler. really.
*
* Take over SIGUSR2 for this purpose since SIGUSR1 is more
* likely to be used by an application. getch() will have to
* handle the misleading EINTR's.
*/
signal(SIGUSR2, SIG_IGN);
the_mouse.operation = MOUSE_MODE;
the_mouse.u.mode.mode = 0;
the_mouse.u.mode.signal = SIGUSR2;
if (ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
signal(SIGUSR2, handle_sysmouse);
the_mouse.operation = MOUSE_SHOW;
ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
#if defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) /* FreeBSD > 2.x */
{
#ifndef FBIO_GETMODE /* FreeBSD 3.x */
#define FBIO_GETMODE CONS_GET
#define FBIO_MODEINFO CONS_MODEINFO
#endif /* FBIO_GETMODE */
video_info_t the_video;
if (ioctl(sp->_mouse_fd,
FBIO_GETMODE,
&the_video.vi_mode) != -1
&& ioctl(sp->_mouse_fd,
FBIO_MODEINFO,
&the_video) != -1) {
sp->_sysmouse_char_width = the_video.vi_cwidth;
sp->_sysmouse_char_height = the_video.vi_cheight;
}
}
#endif /* defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) */
if (sp->_sysmouse_char_width <= 0)
sp->_sysmouse_char_width = 8;
if (sp->_sysmouse_char_height <= 0)
sp->_sysmouse_char_height = 16;
sp->_mouse_type = M_SYSMOUSE;
returnVoid;
}
}
}
#endif /* USE_SYSMOUSE */
#ifdef USE_TERM_DRIVER
CallDriver(sp, td_initmouse);
#endif
#if !defined(USE_TERM_DRIVER) || defined(EXP_WIN32_DRIVER)
/* we know how to recognize mouse events under "xterm" */
if (NonEmpty(key_mouse)) {
init_xterm_mouse(sp);
} else if (strstr(SP_TERMTYPE term_names, "xterm") != 0) {
if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
init_xterm_mouse(sp);
}
#endif
returnVoid;
}
static bool
_nc_mouse_init(SCREEN *sp)
/* initialize the mouse */
{
bool result = FALSE;
T((T_CALLED("_nc_mouse_init(%p)"), (void *) sp));
if (sp != 0) {
if (!sp->_mouse_initialized) {
int i;
sp->_mouse_initialized = TRUE;
TR(MY_TRACE, ("set _mouse_initialized"));
sp->_mouse_eventp = FirstEV(sp);
for (i = 0; i < EV_MAX; i++)
Invalidate(sp->_mouse_events + i);
initialize_mousetype(sp);
T(("set _mouse_type to %d", sp->_mouse_type));
}
result = sp->_mouse_initialized;
}
returnCode(result);
}
/*
* Query to see if there is a pending mouse event. This is called from
* fifo_push() in lib_getch.c
*/
static bool
_nc_mouse_event(SCREEN *sp)
{
MEVENT *eventp = sp->_mouse_eventp;
bool result = FALSE;
(void) eventp;
switch (sp->_mouse_type) {
case M_XTERM:
/* xterm: never have to query, mouse events are in the keyboard stream */
#if USE_EMX_MOUSE
{
char kbuf[3];
int i, res = read(M_FD(sp), &kbuf, 3); /* Eat the prefix */
if (res != 3)
printf("Got %d chars instead of 3 for prefix.\n", res);
for (i = 0; i < res; i++) {
if (kbuf[i] != key_mouse[i])
printf("Got char %d instead of %d for prefix.\n",
(int) kbuf[i], (int) key_mouse[i]);
}
result = TRUE;
}
#endif /* USE_EMX_MOUSE */
break;
#if USE_GPM_SUPPORT
case M_GPM:
if (sp->_mouse_fd >= 0) {
/* query server for event, return TRUE if we find one */
Gpm_Event ev;
switch (my_Gpm_GetEvent(&ev)) {
case 0:
/* Connection closed, drop the mouse. */
sp->_mouse_fd = -1;
break;
case 1:
/* there's only one mouse... */
eventp->id = NORMAL_EVENT;
eventp->bstate = 0;
switch (ev.type & 0x0f) {
case (GPM_DOWN):
if (ev.buttons & GPM_B_LEFT)
eventp->bstate |= BUTTON1_PRESSED;
if (ev.buttons & GPM_B_MIDDLE)
eventp->bstate |= BUTTON2_PRESSED;
if (ev.buttons & GPM_B_RIGHT)
eventp->bstate |= BUTTON3_PRESSED;
break;
case (GPM_UP):
if (ev.buttons & GPM_B_LEFT)
eventp->bstate |= BUTTON1_RELEASED;
if (ev.buttons & GPM_B_MIDDLE)
eventp->bstate |= BUTTON2_RELEASED;
if (ev.buttons & GPM_B_RIGHT)
eventp->bstate |= BUTTON3_RELEASED;
break;
default:
eventp->bstate |= REPORT_MOUSE_POSITION;
break;
}
eventp->x = ev.x - 1;
eventp->y = ev.y - 1;
eventp->z = 0;
/* bump the next-free pointer into the circular list */
sp->_mouse_eventp = NEXT(eventp);
result = TRUE;
break;
}
}
break;
#endif
#if USE_SYSMOUSE
case M_SYSMOUSE:
if (sp->_sysmouse_head < sp->_sysmouse_tail) {
*eventp = sp->_sysmouse_fifo[sp->_sysmouse_head];
/*
* Point the fifo-head to the next possible location. If there
* are none, reset the indices. This may be interrupted by the
* signal handler, doing essentially the same reset.
*/
sp->_sysmouse_head += 1;
if (sp->_sysmouse_head == sp->_sysmouse_tail) {
sp->_sysmouse_tail = 0;
sp->_sysmouse_head = 0;
}
/* bump the next-free pointer into the circular list */
sp->_mouse_eventp = eventp = NEXT(eventp);
result = TRUE;
}
break;
#endif /* USE_SYSMOUSE */
#ifdef USE_TERM_DRIVER
case M_TERM_DRIVER:
while (sp->_drv_mouse_head < sp->_drv_mouse_tail) {
*eventp = sp->_drv_mouse_fifo[sp->_drv_mouse_head];
/*
* Point the fifo-head to the next possible location. If there
* are none, reset the indices.
*/
sp->_drv_mouse_head += 1;
if (sp->_drv_mouse_head == sp->_drv_mouse_tail) {
sp->_drv_mouse_tail = 0;
sp->_drv_mouse_head = 0;
}
/* bump the next-free pointer into the circular list */
sp->_mouse_eventp = eventp = NEXT(eventp);
result = TRUE;
}
break;
#endif
case M_NONE:
break;
}
return result; /* true if we found an event */
}
#if USE_EMX_MOUSE
#define PRESS_POSITION(n) \
do { \
eventp->bstate = MASK_PRESS(n); \
sp->_mouse_bstate |= MASK_PRESS(n); \
if (button & 0x40) { \
eventp->bstate = MASK_RELEASE(n); \
sp->_mouse_bstate &= ~MASK_PRESS(n); \
} \
} while (0)
#else
#define PRESS_POSITION(n) \
do { \
eventp->bstate = (mmask_t) ((sp->_mouse_bstate & MASK_PRESS(n)) \
? REPORT_MOUSE_POSITION \
: MASK_PRESS(n)); \
sp->_mouse_bstate |= MASK_PRESS(n); \
} while (0)
#endif
static bool
handle_wheel(SCREEN *sp, MEVENT * eventp, int button, int wheel)
{
bool result = TRUE;
switch (button & 3) {
case 0:
if (wheel) {
eventp->bstate = MASK_PRESS(4);
/* Do not record in sp->_mouse_bstate; there will be no
* corresponding release event.
*/
} else {
PRESS_POSITION(1);
}
break;
case 1:
if (wheel) {
#if NCURSES_MOUSE_VERSION >= 2
eventp->bstate = MASK_PRESS(5);
/* See comment above for button 4 */
#else
/* Ignore this event as it is not a true press of the button */
eventp->bstate = REPORT_MOUSE_POSITION;
#endif
} else {
PRESS_POSITION(2);
}
break;
case 2:
PRESS_POSITION(3);
break;
default:
/*
* case 3 is sent when the mouse buttons are released.
*
* If the terminal uses xterm mode 1003, a continuous series of
* button-release events is sent as the mouse moves around the screen,
* or as the wheel mouse is rotated.
*
* Return false in this case, so that when running in X10 mode, we will
* recalculate bstate.
*/
eventp->bstate = REPORT_MOUSE_POSITION;