1 /****************************************************************************
2 * Copyright 2018-2020,2021 Thomas E. Dickey *
3 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
4 * *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
12 * *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
15 * *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
27 * authorization. *
28 ****************************************************************************/
29
30 /****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 * and: Juergen Pfeifer 2008 *
35 ****************************************************************************/
36
37 /*
38 * This module is intended to encapsulate ncurses's interface to pointing
39 * devices.
40 *
41 * The primary method used is xterm's internal mouse-tracking facility.
42 * Additional methods depend on the platform:
43 * Alessandro Rubini's GPM server (Linux)
44 * sysmouse (FreeBSD)
45 * special-purpose mouse interface for OS/2 EMX.
46 *
47 * Notes for implementors of new mouse-interface methods:
48 *
49 * The code is logically split into a lower level that accepts event reports
50 * in a device-dependent format and an upper level that parses mouse gestures
51 * and filters events. The mediating data structure is a circular queue of
52 * MEVENT structures.
53 *
54 * Functionally, the lower level's job is to pick up primitive events and
55 * put them on the circular queue. This can happen in one of two ways:
56 * either (a) _nc_mouse_event() detects a series of incoming mouse reports
57 * and queues them, or (b) code in lib_getch.c detects the kmous prefix in
58 * the keyboard input stream and calls _nc_mouse_inline to queue up a series
59 * of adjacent mouse reports.
60 *
61 * In either case, _nc_mouse_parse() should be called after the series is
62 * accepted to parse the digested mouse reports (low-level MEVENTs) into
63 * a gesture (a high-level or composite MEVENT).
64 *
65 * Don't be too shy about adding new event types or modifiers, if you can find
66 * room for them in the 32-bit mask. The API is written so that users get
67 * feedback on which theoretical event types they won't see when they call
68 * mousemask. There's one bit per button (the RESERVED_EVENT bit) not being
69 * used yet, and a couple of bits open at the high end.
70 */
71
72 #ifdef __EMX__
73 # include <io.h>
74 # define INCL_DOS
75 # define INCL_VIO
76 # define INCL_KBD
77 # define INCL_MOU
78 # define INCL_DOSPROCESS
79 # include <os2.h> /* Need to include before the others */
80 #endif
81
82 #include <curses.priv.h>
83
84 #ifndef CUR
85 #define CUR SP_TERMTYPE
86 #endif
87
88 MODULE_ID("$Id: lib_mouse.c,v 1.193 2021/03/20 12:56:32 tom Exp $")
89
90 #include <tic.h>
91
92 #if USE_GPM_SUPPORT
93 #include <linux/keyboard.h> /* defines KG_* macros */
94
95 #ifdef HAVE_LIBDL
96 /* use dynamic loader to avoid linkage dependency */
97 #include <dlfcn.h>
98
99 #ifdef RTLD_NOW
100 #define my_RTLD RTLD_NOW
101 #else
102 #ifdef RTLD_LAZY
103 #define my_RTLD RTLD_LAZY
104 #else
105 make an error
106 #endif
107 #endif /* RTLD_NOW */
108 #endif /* HAVE_LIBDL */
109
110 #endif /* USE_GPM_SUPPORT */
111
112 #if USE_SYSMOUSE
113 #undef buttons /* symbol conflict in consio.h */
114 #undef mouse_info /* symbol conflict in consio.h */
115 #include <osreldate.h>
116 #if defined(__DragonFly_version) || (defined(__FreeBSD__) && (__FreeBSD_version >= 400017))
117 #include <sys/consio.h>
118 #include <sys/fbio.h>
119 #else
120 #include <machine/console.h>
121 #endif
122 #endif /* use_SYSMOUSE */
123
124 #if USE_KLIBC_MOUSE
125 #include <sys/socket.h>
126 #define pipe(handles) socketpair(AF_LOCAL, SOCK_STREAM, 0, handles)
127 #define DosWrite(hfile, pbuffer, cbwrite, pcbactual) \
128 write(hfile, pbuffer, cbwrite)
129 #define DosExit(action, result ) /* do nothing */
130 #define DosCreateThread(ptid, pfn, param, flag, cbStack) \
131 (*(ptid) = _beginthread(pfn, NULL, cbStack, \
132 (void *)param), (*(ptid) == -1))
133 #endif
134
135 #define MY_TRACE TRACE_ICALLS|TRACE_IEVENT
136
137 #define MASK_RELEASE(x) (mmask_t) NCURSES_MOUSE_MASK(x, 001)
138 #define MASK_PRESS(x) (mmask_t) NCURSES_MOUSE_MASK(x, 002)
139 #define MASK_CLICK(x) (mmask_t) NCURSES_MOUSE_MASK(x, 004)
140 #define MASK_DOUBLE_CLICK(x) (mmask_t) NCURSES_MOUSE_MASK(x, 010)
141 #define MASK_TRIPLE_CLICK(x) (mmask_t) NCURSES_MOUSE_MASK(x, 020)
142 #define MASK_RESERVED_EVENT(x) (mmask_t) NCURSES_MOUSE_MASK(x, 040)
143
144 #if NCURSES_MOUSE_VERSION == 1
145
146 #define BUTTON_CLICKED (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED | BUTTON4_CLICKED)
147 #define BUTTON_PRESSED (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED | BUTTON4_PRESSED)
148 #define BUTTON_RELEASED (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED | BUTTON4_RELEASED)
149 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED)
150 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED)
151
152 #define MAX_BUTTONS 4
153
154 #else
155
156 #define BUTTON_CLICKED (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED | BUTTON4_CLICKED | BUTTON5_CLICKED)
157 #define BUTTON_PRESSED (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED | BUTTON4_PRESSED | BUTTON5_PRESSED)
158 #define BUTTON_RELEASED (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED | BUTTON4_RELEASED | BUTTON5_RELEASED)
159 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED | BUTTON5_DOUBLE_CLICKED)
160 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED | BUTTON5_TRIPLE_CLICKED)
161
162 #if NCURSES_MOUSE_VERSION == 2
163 #define MAX_BUTTONS 5
164 #else
165 #define MAX_BUTTONS 11
166 #endif
167
168 #endif
169
170 #define INVALID_EVENT -1
171 #define NORMAL_EVENT 0
172
173 #define ValidEvent(ep) ((ep)->id != INVALID_EVENT)
174 #define Invalidate(ep) (ep)->id = INVALID_EVENT
175
176 #if USE_GPM_SUPPORT
177
178 #ifndef LIBGPM_SONAME
179 #define LIBGPM_SONAME "libgpm.so"
180 #endif
181
182 #define GET_DLSYM(name) (my_##name = (TYPE_##name) dlsym(sp->_dlopen_gpm, #name))
183
184 #endif /* USE_GPM_SUPPORT */
185
186 static bool _nc_mouse_parse(SCREEN *, int);
187 static void _nc_mouse_resume(SCREEN *);
188 static void _nc_mouse_wrap(SCREEN *);
189
190 /* maintain a circular list of mouse events */
191
192 #define FirstEV(sp) ((sp)->_mouse_events)
193 #define LastEV(sp) ((sp)->_mouse_events + EV_MAX - 1)
194
195 #undef NEXT
196 #define NEXT(ep) ((ep >= LastEV(SP_PARM)) \
197 ? FirstEV(SP_PARM) \
198 : ep + 1)
199
200 #undef PREV
201 #define PREV(ep) ((ep <= FirstEV(SP_PARM)) \
202 ? LastEV(SP_PARM) \
203 : ep - 1)
204
205 #define IndexEV(sp, ep) (ep - FirstEV(sp))
206
207 #define RunParams(sp, eventp, runp) \
208 (long) IndexEV(sp, runp), \
209 (long) (IndexEV(sp, eventp) + (EV_MAX - 1)) % EV_MAX
210
211 #ifdef TRACE
212 static void
_trace_slot(SCREEN * sp,const char * tag)213 _trace_slot(SCREEN *sp, const char *tag)
214 {
215 MEVENT *ep;
216
217 _tracef("%s", tag);
218
219 for (ep = FirstEV(sp); ep <= LastEV(sp); ep++)
220 _tracef("mouse event queue slot %ld = %s",
221 (long) IndexEV(sp, ep),
222 _nc_tracemouse(sp, ep));
223 }
224 #endif
225
226 #if USE_EMX_MOUSE
227
228 # define TOP_ROW 0
229 # define LEFT_COL 0
230
231 # define M_FD(sp) sp->_mouse_fd
232
233 static void
write_event(SCREEN * sp,int down,int button,int x,int y)234 write_event(SCREEN *sp, int down, int button, int x, int y)
235 {
236 char buf[6];
237 unsigned long ignore;
238
239 _nc_STRCPY(buf, "\033[M", sizeof(buf)); /* should be the same as key_mouse */
240 buf[3] = ' ' + (button - 1) + (down ? 0 : 0x40);
241 buf[4] = ' ' + x - LEFT_COL + 1;
242 buf[5] = ' ' + y - TOP_ROW + 1;
243 DosWrite(sp->_emxmouse_wfd, buf, 6, &ignore);
244 }
245
246 static void
247 #if USE_KLIBC_MOUSE
mouse_server(void * param)248 mouse_server(void *param)
249 #else
250 mouse_server(unsigned long param)
251 #endif
252 {
253 SCREEN *sp = (SCREEN *) param;
254 unsigned short fWait = MOU_WAIT;
255 /* NOPTRRECT mourt = { 0,0,24,79 }; */
256 MOUEVENTINFO mouev;
257 HMOU hmou;
258 unsigned short mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN | MOUSE_BN3_DOWN;
259 int nbuttons = 3;
260 int oldstate = 0;
261 char err[80];
262 unsigned long rc;
263
264 /* open the handle for the mouse */
265 if (MouOpen(NULL, &hmou) == 0) {
266 rc = MouSetEventMask(&mask, hmou);
267 if (rc) { /* retry with 2 buttons */
268 mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN;
269 rc = MouSetEventMask(&mask, hmou);
270 nbuttons = 2;
271 }
272 if (rc == 0 && MouDrawPtr(hmou) == 0) {
273 for (;;) {
274 /* sit and wait on the event queue */
275 rc = MouReadEventQue(&mouev, &fWait, hmou);
276 if (rc) {
277 _nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
278 "Error reading mouse queue, rc=%lu.\r\n", rc);
279 break;
280 }
281 if (!sp->_emxmouse_activated)
282 goto finish;
283
284 /*
285 * OS/2 numbers a 3-button mouse inconsistently from other
286 * platforms:
287 * 1 = left
288 * 2 = right
289 * 3 = middle.
290 */
291 if ((mouev.fs ^ oldstate) & MOUSE_BN1_DOWN)
292 write_event(sp, mouev.fs & MOUSE_BN1_DOWN,
293 sp->_emxmouse_buttons[1], mouev.col, mouev.row);
294 if ((mouev.fs ^ oldstate) & MOUSE_BN2_DOWN)
295 write_event(sp, mouev.fs & MOUSE_BN2_DOWN,
296 sp->_emxmouse_buttons[3], mouev.col, mouev.row);
297 if ((mouev.fs ^ oldstate) & MOUSE_BN3_DOWN)
298 write_event(sp, mouev.fs & MOUSE_BN3_DOWN,
299 sp->_emxmouse_buttons[2], mouev.col, mouev.row);
300
301 finish:
302 oldstate = mouev.fs;
303 }
304 } else {
305 _nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
306 "Error setting event mask, buttons=%d, rc=%lu.\r\n",
307 nbuttons, rc);
308 }
309
310 DosWrite(2, err, strlen(err), &rc);
311 MouClose(hmou);
312 }
313 DosExit(EXIT_THREAD, 0L);
314 }
315
316 #endif /* USE_EMX_MOUSE */
317
318 #if USE_SYSMOUSE
319 static void
sysmouse_server(SCREEN * sp)320 sysmouse_server(SCREEN *sp)
321 {
322 struct mouse_info the_mouse;
323 MEVENT *work;
324
325 the_mouse.operation = MOUSE_GETINFO;
326 if (sp != 0
327 && sp->_mouse_fd >= 0
328 && sp->_sysmouse_tail < FIFO_SIZE
329 && ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
330
331 if (sp->_sysmouse_head > sp->_sysmouse_tail) {
332 sp->_sysmouse_tail = 0;
333 sp->_sysmouse_head = 0;
334 }
335 work = &(sp->_sysmouse_fifo[sp->_sysmouse_tail]);
336 memset(work, 0, sizeof(*work));
337 work->id = NORMAL_EVENT; /* there's only one mouse... */
338
339 sp->_sysmouse_old_buttons = sp->_sysmouse_new_buttons;
340 sp->_sysmouse_new_buttons = the_mouse.u.data.buttons & 0x7;
341
342 if (sp->_sysmouse_new_buttons) {
343 if (sp->_sysmouse_new_buttons & 1)
344 work->bstate |= BUTTON1_PRESSED;
345 if (sp->_sysmouse_new_buttons & 2)
346 work->bstate |= BUTTON2_PRESSED;
347 if (sp->_sysmouse_new_buttons & 4)
348 work->bstate |= BUTTON3_PRESSED;
349 } else {
350 if (sp->_sysmouse_old_buttons & 1)
351 work->bstate |= BUTTON1_RELEASED;
352 if (sp->_sysmouse_old_buttons & 2)
353 work->bstate |= BUTTON2_RELEASED;
354 if (sp->_sysmouse_old_buttons & 4)
355 work->bstate |= BUTTON3_RELEASED;
356 }
357
358 /* for cosmetic bug in syscons.c on FreeBSD 3.[34] */
359 the_mouse.operation = MOUSE_HIDE;
360 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
361 the_mouse.operation = MOUSE_SHOW;
362 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
363
364 /*
365 * We're only interested if the button is pressed or released.
366 * FIXME: implement continuous event-tracking.
367 */
368 if (sp->_sysmouse_new_buttons != sp->_sysmouse_old_buttons) {
369 sp->_sysmouse_tail += 1;
370 }
371 work->x = the_mouse.u.data.x / sp->_sysmouse_char_width;
372 work->y = the_mouse.u.data.y / sp->_sysmouse_char_height;
373 }
374 }
375
376 static void
handle_sysmouse(int sig GCC_UNUSED)377 handle_sysmouse(int sig GCC_UNUSED)
378 {
379 sysmouse_server(CURRENT_SCREEN);
380 }
381 #endif /* USE_SYSMOUSE */
382
383 #ifndef USE_TERM_DRIVER
384 #define xterm_kmous "\033[M"
385
386 static void
init_xterm_mouse(SCREEN * sp)387 init_xterm_mouse(SCREEN *sp)
388 {
389 sp->_mouse_type = M_XTERM;
390 sp->_mouse_format = MF_X10;
391 sp->_mouse_xtermcap = tigetstr("XM");
392 if (VALID_STRING(sp->_mouse_xtermcap)) {
393 char *code = strstr(sp->_mouse_xtermcap, "[?");
394 if (code != 0) {
395 code += 2;
396 while ((*code >= '0') && (*code <= '9')) {
397 char *next = code;
398 while ((*next >= '0') && (*next <= '9')) {
399 ++next;
400 }
401 if (!strncmp(code, "1006", (size_t) (next - code))) {
402 sp->_mouse_format = MF_SGR1006;
403 }
404 #ifdef EXP_XTERM_1005
405 if (!strncmp(code, "1005", (size_t) (next - code))) {
406 sp->_mouse_format = MF_XTERM_1005;
407 }
408 #endif
409 if (*next == ';') {
410 while (*next == ';') {
411 ++next;
412 }
413 code = next;
414 } else {
415 break;
416 }
417 }
418 }
419 } else {
420 int code = tigetnum("XM");
421 switch (code) {
422 #ifdef EXP_XTERM_1005
423 case 1005:
424 /* see "xterm+sm+1005" */
425 sp->_mouse_xtermcap = "\033[?1005;1000%?%p1%{1}%=%th%el%;";
426 sp->_mouse_format = MF_XTERM_1005;
427 break;
428 #endif
429 case 1006:
430 /* see "xterm+sm+1006" */
431 sp->_mouse_xtermcap = "\033[?1006;1000%?%p1%{1}%=%th%el%;";
432 sp->_mouse_format = MF_SGR1006;
433 break;
434 default:
435 sp->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
436 break;
437 }
438 }
439 }
440 #endif
441
442 static void
enable_xterm_mouse(SCREEN * sp,int enable)443 enable_xterm_mouse(SCREEN *sp, int enable)
444 {
445 #if USE_EMX_MOUSE
446 sp->_emxmouse_activated = enable;
447 #else
448 NCURSES_PUTP2("xterm-mouse", TIPARM_1(sp->_mouse_xtermcap, enable));
449 #endif
450 sp->_mouse_active = enable;
451 }
452
453 #if USE_GPM_SUPPORT
454 static bool
allow_gpm_mouse(SCREEN * sp GCC_UNUSED)455 allow_gpm_mouse(SCREEN *sp GCC_UNUSED)
456 {
457 bool result = FALSE;
458
459 #if USE_WEAK_SYMBOLS
460 /* Danger Robinson: do not use dlopen for libgpm if already loaded */
461 if ((Gpm_Wgetch) != 0) {
462 if (!sp->_mouse_gpm_loaded) {
463 T(("GPM library was already dlopen'd, not by us"));
464 }
465 } else
466 #endif
467 /* GPM does printf's without checking if stdout is a terminal */
468 if (NC_ISATTY(fileno(stdout))) {
469 const char *list = getenv("NCURSES_GPM_TERMS");
470 const char *env = getenv("TERM");
471 if (list != 0) {
472 if (env != 0) {
473 result = _nc_name_match(list, env, "|:");
474 }
475 } else {
476 /* GPM checks the beginning of the $TERM variable to decide if it
477 * should pass xterm events through. There is no real advantage in
478 * allowing GPM to do this. Recent versions relax that check, and
479 * pretend that GPM can work with any terminal having the kmous
480 * capability. Perhaps that works for someone. If so, they can
481 * set the environment variable (above).
482 */
483 if (env != 0 && strstr(env, "linux") != 0) {
484 result = TRUE;
485 }
486 }
487 }
488 return result;
489 }
490
491 #ifdef HAVE_LIBDL
492 static void
unload_gpm_library(SCREEN * sp)493 unload_gpm_library(SCREEN *sp)
494 {
495 if (sp->_dlopen_gpm != 0) {
496 T(("unload GPM library"));
497 sp->_mouse_gpm_loaded = FALSE;
498 sp->_mouse_fd = -1;
499 }
500 }
501
502 static void
load_gpm_library(SCREEN * sp)503 load_gpm_library(SCREEN *sp)
504 {
505 sp->_mouse_gpm_found = FALSE;
506
507 /*
508 * If we already had a successful dlopen, reuse it.
509 */
510 if (sp->_dlopen_gpm != 0) {
511 sp->_mouse_gpm_found = TRUE;
512 sp->_mouse_gpm_loaded = TRUE;
513 } else if ((sp->_dlopen_gpm = dlopen(LIBGPM_SONAME, my_RTLD)) != 0) {
514 #if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
515 #pragma GCC diagnostic push
516 #pragma GCC diagnostic ignored "-Wpedantic"
517 #endif
518 if (GET_DLSYM(gpm_fd) == 0 ||
519 GET_DLSYM(Gpm_Open) == 0 ||
520 GET_DLSYM(Gpm_Close) == 0 ||
521 GET_DLSYM(Gpm_GetEvent) == 0) {
522 #if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
523 #pragma GCC diagnostic pop
524 #endif
525 T(("GPM initialization failed: %s", dlerror()));
526 unload_gpm_library(sp);
527 dlclose(sp->_dlopen_gpm);
528 sp->_dlopen_gpm = 0;
529 } else {
530 sp->_mouse_gpm_found = TRUE;
531 sp->_mouse_gpm_loaded = TRUE;
532 }
533 }
534 }
535 #endif /* HAVE_LIBDL */
536
537 static bool
enable_gpm_mouse(SCREEN * sp,bool enable)538 enable_gpm_mouse(SCREEN *sp, bool enable)
539 {
540 bool result;
541
542 T((T_CALLED("enable_gpm_mouse(%d)"), enable));
543
544 if (enable && !sp->_mouse_active) {
545 #ifdef HAVE_LIBDL
546 if (sp->_mouse_gpm_found && !sp->_mouse_gpm_loaded) {
547 load_gpm_library(sp);
548 }
549 #endif
550 if (sp->_mouse_gpm_loaded) {
551 int code;
552
553 /* GPM: initialize connection to gpm server */
554 sp->_mouse_gpm_connect.eventMask = GPM_DOWN | GPM_UP;
555 sp->_mouse_gpm_connect.defaultMask =
556 (unsigned short) (~(sp->_mouse_gpm_connect.eventMask | GPM_HARD));
557 sp->_mouse_gpm_connect.minMod = 0;
558 sp->_mouse_gpm_connect.maxMod =
559 (unsigned short) (~((1 << KG_SHIFT) |
560 (1 << KG_SHIFTL) |
561 (1 << KG_SHIFTR)));
562 /*
563 * Note: GPM hardcodes \E[?1001s and \E[?1000h during its open.
564 * The former is recognized by wscons (SunOS), and the latter by
565 * xterm. Those will not show up in ncurses' traces.
566 */
567 code = my_Gpm_Open(&sp->_mouse_gpm_connect, 0);
568 result = (code >= 0);
569
570 /*
571 * GPM can return a -2 if it is trying to do something with xterm.
572 * Ignore that, since it conflicts with our use of stdin.
573 */
574 if (code == -2) {
575 my_Gpm_Close();
576 }
577 } else {
578 result = FALSE;
579 }
580 sp->_mouse_active = result;
581 T(("GPM open %s", result ? "succeeded" : "failed"));
582 } else {
583 if (!enable && sp->_mouse_active) {
584 /* GPM: close connection to gpm server */
585 my_Gpm_Close();
586 sp->_mouse_active = FALSE;
587 T(("GPM closed"));
588 }
589 result = enable;
590 }
591 #ifdef HAVE_LIBDL
592 if (!result) {
593 unload_gpm_library(sp);
594 }
595 #endif
596 returnBool(result);
597 }
598 #endif /* USE_GPM_SUPPORT */
599
600 static void
initialize_mousetype(SCREEN * sp)601 initialize_mousetype(SCREEN *sp)
602 {
603 T((T_CALLED("initialize_mousetype()")));
604
605 /* Try gpm first, because gpm may be configured to run in xterm */
606 #if USE_GPM_SUPPORT
607 if (allow_gpm_mouse(sp)) {
608 if (!sp->_mouse_gpm_loaded) {
609 #ifdef HAVE_LIBDL
610 load_gpm_library(sp);
611 #else /* !HAVE_LIBDL */
612 sp->_mouse_gpm_found = TRUE;
613 sp->_mouse_gpm_loaded = TRUE;
614 #endif
615 }
616
617 /*
618 * The gpm_fd file-descriptor may be negative (xterm). So we have to
619 * maintain our notion of whether the mouse connection is active
620 * without testing the file-descriptor.
621 */
622 if (sp->_mouse_gpm_found && enable_gpm_mouse(sp, TRUE)) {
623 sp->_mouse_type = M_GPM;
624 sp->_mouse_fd = *(my_gpm_fd);
625 T(("GPM mouse_fd %d", sp->_mouse_fd));
626 returnVoid;
627 }
628 }
629 #endif /* USE_GPM_SUPPORT */
630
631 /* OS/2 VIO */
632 #if USE_EMX_MOUSE
633 if (!sp->_emxmouse_thread
634 && strstr(SP_TERMTYPE term_names, "xterm") == 0
635 && NonEmpty(key_mouse)) {
636 int handles[2];
637
638 if (pipe(handles) < 0) {
639 perror("mouse pipe error");
640 returnVoid;
641 } else {
642 int rc;
643
644 if (!sp->_emxmouse_buttons[0]) {
645 const char *s = getenv("MOUSE_BUTTONS_123");
646
647 sp->_emxmouse_buttons[0] = 1;
648 if (s && strlen(s) >= 3) {
649 sp->_emxmouse_buttons[1] = s[0] - '0';
650 sp->_emxmouse_buttons[2] = s[1] - '0';
651 sp->_emxmouse_buttons[3] = s[2] - '0';
652 } else {
653 sp->_emxmouse_buttons[1] = 1;
654 sp->_emxmouse_buttons[2] = 3;
655 sp->_emxmouse_buttons[3] = 2;
656 }
657 }
658 sp->_emxmouse_wfd = handles[1];
659 M_FD(sp) = handles[0];
660 /* Needed? */
661 setmode(handles[0], O_BINARY);
662 setmode(handles[1], O_BINARY);
663 /* Do not use CRT functions, we may single-threaded. */
664 rc = DosCreateThread((unsigned long *) &sp->_emxmouse_thread,
665 mouse_server, (long) sp, 0, 8192);
666 if (rc) {
667 printf("mouse thread error %d=%#x", rc, rc);
668 } else {
669 sp->_mouse_type = M_XTERM;
670 }
671 returnVoid;
672 }
673 }
674 #endif /* USE_EMX_MOUSE */
675
676 #if USE_SYSMOUSE
677 {
678 static char dev_tty[] = "/dev/tty";
679 struct mouse_info the_mouse;
680 char *the_device = 0;
681
682 if (NC_ISATTY(sp->_ifd))
683 the_device = ttyname(sp->_ifd);
684 if (the_device == 0)
685 the_device = dev_tty;
686
687 sp->_mouse_fd = open(the_device, O_RDWR);
688
689 if (sp->_mouse_fd >= 0) {
690 /*
691 * sysmouse does not have a usable user interface for obtaining
692 * mouse events. The logical way to proceed (reading data on a
693 * stream) only works if one opens the device as root. Even in
694 * that mode, careful examination shows we lose events
695 * occasionally. The interface provided for user programs is to
696 * establish a signal handler. really.
697 *
698 * Take over SIGUSR2 for this purpose since SIGUSR1 is more
699 * likely to be used by an application. getch() will have to
700 * handle the misleading EINTR's.
701 */
702 signal(SIGUSR2, SIG_IGN);
703 the_mouse.operation = MOUSE_MODE;
704 the_mouse.u.mode.mode = 0;
705 the_mouse.u.mode.signal = SIGUSR2;
706 if (ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
707 signal(SIGUSR2, handle_sysmouse);
708 the_mouse.operation = MOUSE_SHOW;
709 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
710
711 #if defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) /* FreeBSD > 2.x */
712 {
713 #ifndef FBIO_GETMODE /* FreeBSD 3.x */
714 #define FBIO_GETMODE CONS_GET
715 #define FBIO_MODEINFO CONS_MODEINFO
716 #endif /* FBIO_GETMODE */
717 video_info_t the_video;
718
719 if (ioctl(sp->_mouse_fd,
720 FBIO_GETMODE,
721 &the_video.vi_mode) != -1
722 && ioctl(sp->_mouse_fd,
723 FBIO_MODEINFO,
724 &the_video) != -1) {
725 sp->_sysmouse_char_width = the_video.vi_cwidth;
726 sp->_sysmouse_char_height = the_video.vi_cheight;
727 }
728 }
729 #endif /* defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) */
730
731 if (sp->_sysmouse_char_width <= 0)
732 sp->_sysmouse_char_width = 8;
733 if (sp->_sysmouse_char_height <= 0)
734 sp->_sysmouse_char_height = 16;
735 sp->_mouse_type = M_SYSMOUSE;
736 returnVoid;
737 }
738 }
739 }
740 #endif /* USE_SYSMOUSE */
741
742 #ifdef USE_TERM_DRIVER
743 CallDriver(sp, td_initmouse);
744 #else
745 /* we know how to recognize mouse events under "xterm" */
746 if (NonEmpty(key_mouse)) {
747 init_xterm_mouse(sp);
748 } else if (strstr(SP_TERMTYPE term_names, "xterm") != 0) {
749 if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
750 init_xterm_mouse(sp);
751 }
752 #endif
753
754 returnVoid;
755 }
756
757 static bool
_nc_mouse_init(SCREEN * sp)758 _nc_mouse_init(SCREEN *sp)
759 /* initialize the mouse */
760 {
761 bool result = FALSE;
762
763 if (sp != 0) {
764 if (!sp->_mouse_initialized) {
765 int i;
766
767 sp->_mouse_initialized = TRUE;
768
769 TR(MY_TRACE, ("_nc_mouse_init() called"));
770
771 sp->_mouse_eventp = FirstEV(sp);
772 for (i = 0; i < EV_MAX; i++)
773 Invalidate(sp->_mouse_events + i);
774
775 initialize_mousetype(sp);
776
777 T(("_nc_mouse_init() set mousetype to %d", sp->_mouse_type));
778 }
779 result = sp->_mouse_initialized;
780 }
781 return result;
782 }
783
784 /*
785 * Query to see if there is a pending mouse event. This is called from
786 * fifo_push() in lib_getch.c
787 */
788 static bool
_nc_mouse_event(SCREEN * sp)789 _nc_mouse_event(SCREEN *sp)
790 {
791 MEVENT *eventp = sp->_mouse_eventp;
792 bool result = FALSE;
793
794 (void) eventp;
795
796 switch (sp->_mouse_type) {
797 case M_XTERM:
798 /* xterm: never have to query, mouse events are in the keyboard stream */
799 #if USE_EMX_MOUSE
800 {
801 char kbuf[3];
802
803 int i, res = read(M_FD(sp), &kbuf, 3); /* Eat the prefix */
804 if (res != 3)
805 printf("Got %d chars instead of 3 for prefix.\n", res);
806 for (i = 0; i < res; i++) {
807 if (kbuf[i] != key_mouse[i])
808 printf("Got char %d instead of %d for prefix.\n",
809 (int) kbuf[i], (int) key_mouse[i]);
810 }
811 result = TRUE;
812 }
813 #endif /* USE_EMX_MOUSE */
814 break;
815
816 #if USE_GPM_SUPPORT
817 case M_GPM:
818 if (sp->_mouse_fd >= 0) {
819 /* query server for event, return TRUE if we find one */
820 Gpm_Event ev;
821
822 switch (my_Gpm_GetEvent(&ev)) {
823 case 0:
824 /* Connection closed, drop the mouse. */
825 sp->_mouse_fd = -1;
826 break;
827 case 1:
828 /* there's only one mouse... */
829 eventp->id = NORMAL_EVENT;
830
831 eventp->bstate = 0;
832 switch (ev.type & 0x0f) {
833 case (GPM_DOWN):
834 if (ev.buttons & GPM_B_LEFT)
835 eventp->bstate |= BUTTON1_PRESSED;
836 if (ev.buttons & GPM_B_MIDDLE)
837 eventp->bstate |= BUTTON2_PRESSED;
838 if (ev.buttons & GPM_B_RIGHT)
839 eventp->bstate |= BUTTON3_PRESSED;
840 break;
841 case (GPM_UP):
842 if (ev.buttons & GPM_B_LEFT)
843 eventp->bstate |= BUTTON1_RELEASED;
844 if (ev.buttons & GPM_B_MIDDLE)
845 eventp->bstate |= BUTTON2_RELEASED;
846 if (ev.buttons & GPM_B_RIGHT)
847 eventp->bstate |= BUTTON3_RELEASED;
848 break;
849 default:
850 eventp->bstate |= REPORT_MOUSE_POSITION;
851 break;
852 }
853
854 eventp->x = ev.x - 1;
855 eventp->y = ev.y - 1;
856 eventp->z = 0;
857
858 /* bump the next-free pointer into the circular list */
859 sp->_mouse_eventp = NEXT(eventp);
860 result = TRUE;
861 break;
862 }
863 }
864 break;
865 #endif
866
867 #if USE_SYSMOUSE
868 case M_SYSMOUSE:
869 if (sp->_sysmouse_head < sp->_sysmouse_tail) {
870 *eventp = sp->_sysmouse_fifo[sp->_sysmouse_head];
871
872 /*
873 * Point the fifo-head to the next possible location. If there
874 * are none, reset the indices. This may be interrupted by the
875 * signal handler, doing essentially the same reset.
876 */
877 sp->_sysmouse_head += 1;
878 if (sp->_sysmouse_head == sp->_sysmouse_tail) {
879 sp->_sysmouse_tail = 0;
880 sp->_sysmouse_head = 0;
881 }
882
883 /* bump the next-free pointer into the circular list */
884 sp->_mouse_eventp = eventp = NEXT(eventp);
885 result = TRUE;
886 }
887 break;
888 #endif /* USE_SYSMOUSE */
889
890 #ifdef USE_TERM_DRIVER
891 case M_TERM_DRIVER:
892 while (sp->_drv_mouse_head < sp->_drv_mouse_tail) {
893 *eventp = sp->_drv_mouse_fifo[sp->_drv_mouse_head];
894
895 /*
896 * Point the fifo-head to the next possible location. If there
897 * are none, reset the indices.
898 */
899 sp->_drv_mouse_head += 1;
900 if (sp->_drv_mouse_head == sp->_drv_mouse_tail) {
901 sp->_drv_mouse_tail = 0;
902 sp->_drv_mouse_head = 0;
903 }
904
905 /* bump the next-free pointer into the circular list */
906 sp->_mouse_eventp = eventp = NEXT(eventp);
907 result = TRUE;
908 }
909 break;
910 #endif
911
912 case M_NONE:
913 break;
914 }
915
916 return result; /* true if we found an event */
917 }
918
919 #if USE_EMX_MOUSE
920 #define PRESS_POSITION(n) \
921 do { \
922 eventp->bstate = MASK_PRESS(n); \
923 sp->_mouse_bstate |= MASK_PRESS(n); \
924 if (button & 0x40) { \
925 eventp->bstate = MASK_RELEASE(n); \
926 sp->_mouse_bstate &= ~MASK_PRESS(n); \
927 } \
928 } while (0)
929 #else
930 #define PRESS_POSITION(n) \
931 do { \
932 eventp->bstate = (mmask_t) ((sp->_mouse_bstate & MASK_PRESS(n)) \
933 ? REPORT_MOUSE_POSITION \
934 : MASK_PRESS(n)); \
935 sp->_mouse_bstate |= MASK_PRESS(n); \
936 } while (0)
937 #endif
938
939 static bool
handle_wheel(SCREEN * sp,MEVENT * eventp,int button,int wheel)940 handle_wheel(SCREEN *sp, MEVENT * eventp, int button, int wheel)
941 {
942 bool result = TRUE;
943
944 switch (button & 3) {
945 case 0:
946 if (wheel) {
947 eventp->bstate = MASK_PRESS(4);
948 /* Do not record in sp->_mouse_bstate; there will be no
949 * corresponding release event.
950 */
951 } else {
952 PRESS_POSITION(1);
953 }
954 break;
955 case 1:
956 if (wheel) {
957 #if NCURSES_MOUSE_VERSION >= 2
958 eventp->bstate = MASK_PRESS(5);
959 /* See comment above for button 4 */
960 #else
961 /* Ignore this event as it is not a true press of the button */
962 eventp->bstate = REPORT_MOUSE_POSITION;
963 #endif
964 } else {
965 PRESS_POSITION(2);
966 }
967 break;
968 case 2:
969 PRESS_POSITION(3);
970 break;
971 default:
972 result = FALSE;
973 break;
974 }
975 return result;
976 }
977
978 static bool
decode_X10_bstate(SCREEN * sp,MEVENT * eventp,unsigned intro)979 decode_X10_bstate(SCREEN *sp, MEVENT * eventp, unsigned intro)
980 {
981 bool result;
982 int button = 0;
983 int wheel = (intro & 96) == 96;
984
985 eventp->bstate = 0;
986
987 if (intro >= 96) {
988 if (intro >= 160) {
989 button = (int) (intro - 152); /* buttons 8-11 */
990 } else {
991 button = (int) (intro - 92); /* buttons 4-7 */
992 }
993 } else {
994 button = (intro & 3);
995 }
996
997 if (button > MAX_BUTTONS) {
998 eventp->bstate = REPORT_MOUSE_POSITION;
999 } else if (!handle_wheel(sp, eventp, (int) intro, wheel)) {
1000
1001 /*
1002 * Release events aren't reported for individual buttons, just for
1003 * the button set as a whole. However, because there are normally
1004 * no mouse events under xterm that intervene between press and
1005 * release, we can infer the button actually released by looking at
1006 * the previous event.
1007 */
1008 if (sp->_mouse_bstate & BUTTON_PRESSED) {
1009 int b;
1010
1011 eventp->bstate = BUTTON_RELEASED;
1012 for (b = 1; b <= MAX_BUTTONS; ++b) {
1013 if (!(sp->_mouse_bstate & MASK_PRESS(b)))
1014 eventp->bstate &= ~MASK_RELEASE(b);
1015 }
1016 sp->_mouse_bstate = 0;
1017 } else {
1018 /*
1019 * xterm will return a stream of release-events to let the
1020 * application know where the mouse is going, if private mode
1021 * 1002 or 1003 is enabled.
1022 */
1023 eventp->bstate = REPORT_MOUSE_POSITION;
1024 }
1025 }
1026
1027 if (intro & 4) {
1028 eventp->bstate |= BUTTON_SHIFT;
1029 }
1030 if (intro & 8) {
1031 eventp->bstate |= BUTTON_ALT;
1032 }
1033 if (intro & 16) {
1034 eventp->bstate |= BUTTON_CTRL;
1035 }
1036 result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
1037 return result;
1038 }
1039
1040 /* This code requires that your xterm entry contain the kmous capability and
1041 * that it be set to the \E[M documented in the Xterm Control Sequences
1042 * reference. This is how we arrange for mouse events to be reported via a
1043 * KEY_MOUSE return value from wgetch(). After this value is received,
1044 * _nc_mouse_inline() gets called and is immediately responsible for parsing
1045 * the mouse status information following the prefix.
1046 *
1047 * The following quotes from the ctlseqs.ms document in the XTerm distribution,
1048 * describing the mouse tracking feature:
1049 *
1050 * Parameters for all mouse tracking escape sequences generated by xterm encode
1051 * numeric parameters in a single character as value+040. For example, ! is
1052 * 1.
1053 *
1054 * On button press or release, xterm sends ESC [ M CbCxCy. The low two bits of
1055 * Cb encode button information: 0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed,
1056 * 3=release. The upper bits encode what modifiers were down when the button
1057 * was pressed and are added together. 4=Shift, 8=Meta, 16=Control. Cx and Cy
1058 * are the x and y coordinates of the mouse event. The upper left corner is
1059 * (1,1).
1060 *
1061 * (End quote) By the time we get here, we've eaten the key prefix. FYI, the
1062 * loop below is necessary because mouse click info isn't guaranteed to present
1063 * as a single clist item.
1064 *
1065 * Wheel mice may return buttons 4 and 5 when the wheel is turned. We encode
1066 * those as button presses.
1067 */
1068 static bool
decode_xterm_X10(SCREEN * sp,MEVENT * eventp)1069 decode_xterm_X10(SCREEN *sp, MEVENT * eventp)
1070 {
1071 #define MAX_KBUF 3
1072 unsigned char kbuf[MAX_KBUF + 1];
1073 size_t grabbed;
1074 int res;
1075 bool result;
1076
1077 # if USE_PTHREADS_EINTR
1078 # if USE_WEAK_SYMBOLS
1079 if ((pthread_self) && (pthread_kill) && (pthread_equal))
1080 # endif
1081 _nc_globals.read_thread = pthread_self();
1082 # endif
1083 for (grabbed = 0; grabbed < MAX_KBUF; grabbed += (size_t) res) {
1084
1085 /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
1086 res = (int) read(
1087 #if USE_EMX_MOUSE
1088 (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
1089 #else
1090 sp->_ifd,
1091 #endif
1092 kbuf + grabbed, (size_t) (MAX_KBUF - (int) grabbed));
1093 if (res == -1)
1094 break;
1095 }
1096 #if USE_PTHREADS_EINTR
1097 _nc_globals.read_thread = 0;
1098 #endif
1099 kbuf[MAX_KBUF] = '\0';
1100
1101 TR(TRACE_IEVENT,
1102 ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
1103
1104 /* there's only one mouse... */
1105 eventp->id = NORMAL_EVENT;
1106
1107 result = decode_X10_bstate(sp, eventp, kbuf[0]);
1108
1109 eventp->x = (kbuf[1] - ' ') - 1;
1110 eventp->y = (kbuf[2] - ' ') - 1;
1111
1112 return result;
1113 }
1114
1115 #ifdef EXP_XTERM_1005
1116 /*
1117 * This is identical to X10/X11 responses except that there are two UTF-8
1118 * characters storing the ordinates instead of two bytes.
1119 */
1120 static bool
decode_xterm_1005(SCREEN * sp,MEVENT * eventp)1121 decode_xterm_1005(SCREEN *sp, MEVENT * eventp)
1122 {
1123 char kbuf[80];
1124 size_t grabbed;
1125 size_t limit = (sizeof(kbuf) - 1);
1126 unsigned coords[2];
1127 bool result;
1128
1129 coords[0] = 0;
1130 coords[1] = 0;
1131
1132 # if USE_PTHREADS_EINTR
1133 # if USE_WEAK_SYMBOLS
1134 if ((pthread_self) && (pthread_kill) && (pthread_equal))
1135 # endif
1136 _nc_globals.read_thread = pthread_self();
1137 # endif
1138 for (grabbed = 0; grabbed < limit;) {
1139 int res;
1140
1141 res = (int) read(
1142 #if USE_EMX_MOUSE
1143 (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
1144 #else
1145 sp->_ifd,
1146 #endif
1147 (kbuf + grabbed), (size_t) 1);
1148 if (res == -1)
1149 break;
1150 grabbed += (size_t) res;
1151 if (grabbed > 1) {
1152 size_t check = 1;
1153 int n;
1154
1155 for (n = 0; n < 2; ++n) {
1156 int rc;
1157
1158 if (check >= grabbed)
1159 break;
1160 rc = _nc_conv_to_utf32(&coords[n], kbuf + check, (unsigned)
1161 (grabbed - check));
1162 if (!rc)
1163 break;
1164 check += (size_t) rc;
1165 }
1166 if (n >= 2)
1167 break;
1168 }
1169 }
1170 #if USE_PTHREADS_EINTR
1171 _nc_globals.read_thread = 0;
1172 #endif
1173
1174 TR(TRACE_IEVENT,
1175 ("_nc_mouse_inline sees the following xterm data: %s",
1176 _nc_visbufn(kbuf, (int) grabbed)));
1177
1178 /* there's only one mouse... */
1179 eventp->id = NORMAL_EVENT;
1180
1181 result = decode_X10_bstate(sp, eventp, UChar(kbuf[0]));
1182
1183 eventp->x = (int) (coords[0] - ' ') - 1;
1184 eventp->y = (int) (coords[1] - ' ') - 1;
1185
1186 return result;
1187 }
1188 #endif /* EXP_XTERM_1005 */
1189
1190 /*
1191 * ECMA-48 section 5.4
1192 */
1193 #define isInter(c) ((c) >= 0x20 && (c) <= 0x2f)
1194 #define isParam(c) ((c) >= 0x30 && (c) <= 0x3f)
1195 #define isFinal(c) ((c) >= 0x40 && (c) <= 0x7e)
1196
1197 #define MAX_PARAMS 9
1198
1199 typedef struct {
1200 int nerror; /* nonzero if there are unexpected chars */
1201 int nparam; /* number of numeric parameters */
1202 int params[MAX_PARAMS];
1203 int final; /* the final-character */
1204 } SGR_DATA;
1205
1206 static bool
read_SGR(SCREEN * sp,SGR_DATA * result)1207 read_SGR(SCREEN *sp, SGR_DATA * result)
1208 {
1209 char kbuf[80]; /* bigger than any possible mouse response */
1210 int grabbed = 0;
1211 int ch = 0;
1212 int now = -1;
1213 int marker = 1;
1214
1215 memset(result, 0, sizeof(*result));
1216 # if USE_PTHREADS_EINTR
1217 # if USE_WEAK_SYMBOLS
1218 if ((pthread_self) && (pthread_kill) && (pthread_equal))
1219 # endif
1220 _nc_globals.read_thread = pthread_self();
1221 # endif
1222
1223 do {
1224 int res;
1225
1226 res = (int) read(
1227 #if USE_EMX_MOUSE
1228 (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
1229 #else
1230 sp->_ifd,
1231 #endif
1232 (kbuf + grabbed), (size_t) 1);
1233 if (res == -1)
1234 break;
1235 if ((grabbed + MAX_KBUF) >= (int) sizeof(kbuf)) {
1236 result->nerror++;
1237 break;
1238 }
1239 ch = UChar(kbuf[grabbed]);
1240 kbuf[grabbed + 1] = 0;
1241 switch (ch) {
1242 case '0':
1243 case '1':
1244 case '2':
1245 case '3':
1246 case '4':
1247 case '5':
1248 case '6':
1249 case '7':
1250 case '8':
1251 case '9':
1252 if (marker) {
1253 ++now;
1254 result->nparam = (now + 1);
1255 }
1256 marker = 0;
1257 result->params[now] = (result->params[now] * 10) + (ch - '0');
1258 break;
1259 case ';':
1260 if (marker) {
1261 ++now;
1262 result->nparam = (now + 1);
1263 }
1264 marker = 1;
1265 break;
1266 default:
1267 if (ch < 32 || ch > 126) {
1268 /*
1269 * Technically other characters could be interspersed in the
1270 * response. Ignore those for now.
1271 */
1272 result->nerror++;
1273 continue;
1274 } else if (isFinal(ch)) {
1275 if (marker) {
1276 result->nparam++;
1277 }
1278 result->final = ch;
1279 } else {
1280 result->nerror++;
1281 }
1282 break;
1283 }
1284 ++grabbed;
1285 } while (!isFinal(ch));
1286 #if USE_PTHREADS_EINTR
1287 _nc_globals.read_thread = 0;
1288 #endif
1289
1290 kbuf[++grabbed] = 0;
1291 TR(TRACE_IEVENT,
1292 ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
1293 return (grabbed > 0) && (result->nerror == 0);
1294 }
1295
1296 static bool
decode_xterm_SGR1006(SCREEN * sp,MEVENT * eventp)1297 decode_xterm_SGR1006(SCREEN *sp, MEVENT * eventp)
1298 {
1299 SGR_DATA data;
1300 bool result = FALSE;
1301 if (read_SGR(sp, &data)) {
1302 int b = data.params[0];
1303 int b3 = 1 + (b & 3);
1304 int wheel = ((b & 64) == 64);
1305
1306 if (b >= 132) {
1307 b3 = MAX_BUTTONS + 1;
1308 } else if (b >= 128) {
1309 b3 = (b - 120); /* buttons 8-11 */
1310 } else if (b >= 64) {
1311 b3 = (b - 60); /* buttons 6-7 */
1312 }
1313
1314 eventp->id = NORMAL_EVENT;
1315 if (data.final == 'M') {
1316 (void) handle_wheel(sp, eventp, b, wheel);
1317 } else if (b3 > MAX_BUTTONS) {
1318 eventp->bstate = REPORT_MOUSE_POSITION;
1319 } else {
1320 mmask_t pressed = (mmask_t) NCURSES_MOUSE_MASK(b3, NCURSES_BUTTON_PRESSED);
1321 mmask_t release = (mmask_t) NCURSES_MOUSE_MASK(b3, NCURSES_BUTTON_RELEASED);
1322 if (sp->_mouse_bstate & pressed) {
1323 eventp->bstate = release;
1324 sp->_mouse_bstate &= ~pressed;
1325 } else {
1326 eventp->bstate = REPORT_MOUSE_POSITION;
1327 }
1328 }
1329 if (b & 4) {
1330 eventp->bstate |= BUTTON_SHIFT;
1331 }
1332 if (b & 8) {
1333 eventp->bstate |= BUTTON_ALT;
1334 }
1335 if (b & 16) {
1336 eventp->bstate |= BUTTON_CTRL;
1337 }
1338 result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
1339 eventp->x = (data.params[1] ? (data.params[1] - 1) : 0);
1340 eventp->y = (data.params[2] ? (data.params[2] - 1) : 0);
1341 }
1342 return result;
1343 }
1344
1345 static bool
_nc_mouse_inline(SCREEN * sp)1346 _nc_mouse_inline(SCREEN *sp)
1347 /* mouse report received in the keyboard stream -- parse its info */
1348 {
1349 bool result = FALSE;
1350 MEVENT *eventp = sp->_mouse_eventp;
1351
1352 TR(MY_TRACE, ("_nc_mouse_inline() called"));
1353
1354 if (sp->_mouse_type == M_XTERM) {
1355 switch (sp->_mouse_format) {
1356 case MF_X10:
1357 result = decode_xterm_X10(sp, eventp);
1358 break;
1359 case MF_SGR1006:
1360 result = decode_xterm_SGR1006(sp, eventp);
1361 break;
1362 #ifdef EXP_XTERM_1005
1363 case MF_XTERM_1005:
1364 result = decode_xterm_1005(sp, eventp);
1365 break;
1366 #endif
1367 }
1368
1369 TR(MY_TRACE,
1370 ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
1371 _nc_tracemouse(sp, eventp),
1372 (long) IndexEV(sp, eventp)));
1373
1374 /* bump the next-free pointer into the circular list */
1375 sp->_mouse_eventp = NEXT(eventp);
1376
1377 if (!result) {
1378 /* If this event is from a wheel-mouse, treat it like position
1379 * reports and avoid waiting for the release-events which will
1380 * never come.
1381 */
1382 if (eventp->bstate & BUTTON_PRESSED) {
1383 int b;
1384
1385 for (b = 4; b <= MAX_BUTTONS; ++b) {
1386 if ((eventp->bstate & MASK_PRESS(b))) {
1387 result = TRUE;
1388 break;
1389 }
1390 }
1391 }
1392 }
1393 }
1394
1395 return (result);
1396 }
1397
1398 static void
mouse_activate(SCREEN * sp,int on)1399 mouse_activate(SCREEN *sp, int on)
1400 {
1401 if (!on && !sp->_mouse_initialized)
1402 return;
1403
1404 if (!_nc_mouse_init(sp))
1405 return;
1406
1407 if (on) {
1408 sp->_mouse_bstate = 0;
1409 switch (sp->_mouse_type) {
1410 case M_XTERM:
1411 #if NCURSES_EXT_FUNCS
1412 NCURSES_SP_NAME(keyok) (NCURSES_SP_ARGx KEY_MOUSE, on);
1413 #endif
1414 TPUTS_TRACE("xterm mouse initialization");
1415 enable_xterm_mouse(sp, 1);
1416 break;
1417 #if USE_GPM_SUPPORT
1418 case M_GPM:
1419 if (enable_gpm_mouse(sp, TRUE)) {
1420 sp->_mouse_fd = *(my_gpm_fd);
1421 T(("GPM mouse_fd %d", sp->_mouse_fd));
1422 }
1423 break;
1424 #endif
1425 #if USE_SYSMOUSE
1426 case M_SYSMOUSE:
1427 signal(SIGUSR2, handle_sysmouse);
1428 sp->_mouse_active = TRUE;
1429 break;
1430 #endif
1431 #ifdef USE_TERM_DRIVER
1432 case M_TERM_DRIVER:
1433 sp->_mouse_active = TRUE;
1434 break;
1435 #endif
1436 case M_NONE:
1437 return;
1438 }
1439 /* Make runtime binding to cut down on object size of applications that
1440 * do not use the mouse (e.g., 'clear').
1441 */
1442 sp->_mouse_event = _nc_mouse_event;
1443 sp->_mouse_inline = _nc_mouse_inline;
1444 sp->_mouse_parse = _nc_mouse_parse;
1445 sp->_mouse_resume = _nc_mouse_resume;
1446 sp->_mouse_wrap = _nc_mouse_wrap;
1447 } else {
1448
1449 switch (sp->_mouse_type) {
1450 case M_XTERM:
1451 TPUTS_TRACE("xterm mouse deinitialization");
1452 enable_xterm_mouse(sp, 0);
1453 break;
1454 #if USE_GPM_SUPPORT
1455 case M_GPM:
1456 enable_gpm_mouse(sp, FALSE);
1457 break;
1458 #endif
1459 #if USE_SYSMOUSE
1460 case M_SYSMOUSE:
1461 signal(SIGUSR2, SIG_IGN);
1462 sp->_mouse_active = FALSE;
1463 break;
1464 #endif
1465 #ifdef USE_TERM_DRIVER
1466 case M_TERM_DRIVER:
1467 sp->_mouse_active = FALSE;
1468 break;
1469 #endif
1470 case M_NONE:
1471 return;
1472 }
1473 }
1474 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1475 }
1476
1477 /**************************************************************************
1478 *
1479 * Device-independent code
1480 *
1481 **************************************************************************/
1482
1483 static bool
_nc_mouse_parse(SCREEN * sp,int runcount)1484 _nc_mouse_parse(SCREEN *sp, int runcount)
1485 /* parse a run of atomic mouse events into a gesture */
1486 {
1487 MEVENT *eventp = sp->_mouse_eventp;
1488 MEVENT *next, *ep;
1489 MEVENT *first_valid = NULL;
1490 MEVENT *first_invalid = NULL;
1491 int n;
1492 int b;
1493 bool merge;
1494 bool endLoop;
1495
1496 TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));
1497
1498 /*
1499 * When we enter this routine, the event list next-free pointer
1500 * points just past a run of mouse events that we know were separated
1501 * in time by less than the critical click interval. The job of this
1502 * routine is to collapse this run into a single higher-level event
1503 * or gesture.
1504 *
1505 * We accomplish this in two passes. The first pass merges press/release
1506 * pairs into click events. The second merges runs of click events into
1507 * double or triple-click events.
1508 *
1509 * It's possible that the run may not resolve to a single event (for
1510 * example, if the user quadruple-clicks). If so, leading events
1511 * in the run are ignored if user does not call getmouse in a loop (getting
1512 * them from newest to older).
1513 *
1514 * Note that this routine is independent of the format of the specific
1515 * format of the pointing-device's reports. We can use it to parse
1516 * gestures on anything that reports press/release events on a per-
1517 * button basis, as long as the device-dependent mouse code puts stuff
1518 * on the queue in MEVENT format.
1519 */
1520
1521 /*
1522 * Reset all events that were not set, in case the user sometimes calls
1523 * getmouse only once and other times until there are no more events in
1524 * queue.
1525 *
1526 * This also allows reaching the beginning of the run.
1527 */
1528 ep = eventp;
1529 for (n = runcount; n < EV_MAX; n++) {
1530 Invalidate(ep);
1531 ep = NEXT(ep);
1532 }
1533
1534 #ifdef TRACE
1535 if (USE_TRACEF(TRACE_IEVENT)) {
1536 _trace_slot(sp, "before mouse press/release merge:");
1537 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1538 RunParams(sp, eventp, ep),
1539 runcount);
1540 _nc_unlock_global(tracef);
1541 }
1542 #endif /* TRACE */
1543
1544 /* first pass; merge press/release pairs */
1545 endLoop = FALSE;
1546 while (!endLoop) {
1547 next = NEXT(ep);
1548 if (next == eventp) {
1549 /* Will end the loop, but compact before */
1550 endLoop = TRUE;
1551 } else {
1552
1553 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
1554 == !(next->bstate & MASK_RELEASE(x)))
1555
1556 if (ValidEvent(ep) && ValidEvent(next)
1557 && ep->x == next->x && ep->y == next->y
1558 && (ep->bstate & BUTTON_PRESSED)
1559 && (!(next->bstate & BUTTON_PRESSED))) {
1560 bool changed = TRUE;
1561
1562 for (b = 1; b <= MAX_BUTTONS; ++b) {
1563 if (!MASK_CHANGED(b)) {
1564 changed = FALSE;
1565 break;
1566 }
1567 }
1568
1569 if (changed) {
1570 merge = FALSE;
1571 for (b = 1; b <= MAX_BUTTONS; ++b) {
1572 if ((sp->_mouse_mask & MASK_CLICK(b))
1573 && (ep->bstate & MASK_PRESS(b))) {
1574 next->bstate &= ~MASK_RELEASE(b);
1575 next->bstate |= MASK_CLICK(b);
1576 merge = TRUE;
1577 }
1578 }
1579 if (merge) {
1580 Invalidate(ep);
1581 }
1582 }
1583 }
1584 }
1585
1586 /* Compact valid events */
1587 if (!ValidEvent(ep)) {
1588 if ((first_valid != NULL) && (first_invalid == NULL)) {
1589 first_invalid = ep;
1590 }
1591 } else {
1592 if (first_valid == NULL) {
1593 first_valid = ep;
1594 } else if (first_invalid != NULL) {
1595 *first_invalid = *ep;
1596 Invalidate(ep);
1597 first_invalid = NEXT(first_invalid);
1598 }
1599 }
1600
1601 ep = next;
1602 }
1603
1604 if (first_invalid != NULL) {
1605 eventp = first_invalid;
1606 }
1607 #ifdef TRACE
1608 if (USE_TRACEF(TRACE_IEVENT)) {
1609 _trace_slot(sp, "before mouse click merge:");
1610 if (first_valid == NULL) {
1611 _tracef("_nc_mouse_parse: no valid event");
1612 } else {
1613 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1614 RunParams(sp, eventp, first_valid),
1615 runcount);
1616 _nc_unlock_global(tracef);
1617 }
1618 }
1619 #endif /* TRACE */
1620
1621 /*
1622 * Second pass; merge click runs. We merge click events forward in the
1623 * queue. For example, double click can be changed to triple click.
1624 *
1625 * NOTE: There is a problem with this design! If the application
1626 * allows enough click events to pile up in the circular queue so
1627 * they wrap around, it will cheerfully merge the newest forward
1628 * into the oldest, creating a bogus doubleclick and confusing
1629 * the queue-traversal logic rather badly. Generally this won't
1630 * happen, because calling getmouse() marks old events invalid and
1631 * ineligible for merges. The true solution to this problem would
1632 * be to timestamp each MEVENT and perform the obvious sanity check,
1633 * but the timer element would have to have sub-second resolution,
1634 * which would get us into portability trouble.
1635 */
1636 first_invalid = NULL;
1637 endLoop = (first_valid == NULL);
1638 ep = first_valid;
1639 while (!endLoop) {
1640 next = NEXT(ep);
1641
1642 if (next == eventp) {
1643 /* Will end the loop, but check event type and compact before */
1644 endLoop = TRUE;
1645 } else if (!ValidEvent(next)) {
1646 continue;
1647 } else {
1648 /* merge click events forward */
1649 if ((ep->bstate & BUTTON_CLICKED)
1650 && (next->bstate & BUTTON_CLICKED)) {
1651 merge = FALSE;
1652 for (b = 1; b <= MAX_BUTTONS; ++b) {
1653 if ((sp->_mouse_mask & MASK_DOUBLE_CLICK(b))
1654 && (ep->bstate & MASK_CLICK(b))
1655 && (next->bstate & MASK_CLICK(b))) {
1656 next->bstate &= ~MASK_CLICK(b);
1657 next->bstate |= MASK_DOUBLE_CLICK(b);
1658 merge = TRUE;
1659 }
1660 }
1661 if (merge) {
1662 Invalidate(ep);
1663 }
1664 }
1665
1666 /* merge double-click events forward */
1667 if ((ep->bstate & BUTTON_DOUBLE_CLICKED)
1668 && (next->bstate & BUTTON_CLICKED)) {
1669 merge = FALSE;
1670 for (b = 1; b <= MAX_BUTTONS; ++b) {
1671 if ((sp->_mouse_mask & MASK_TRIPLE_CLICK(b))
1672 && (ep->bstate & MASK_DOUBLE_CLICK(b))
1673 && (next->bstate & MASK_CLICK(b))) {
1674 next->bstate &= ~MASK_CLICK(b);
1675 next->bstate |= MASK_TRIPLE_CLICK(b);
1676 merge = TRUE;
1677 }
1678 }
1679 if (merge) {
1680 Invalidate(ep);
1681 }
1682 }
1683 }
1684
1685 /* Discard event if it does not match event mask */
1686 if (!(ep->bstate & sp->_mouse_mask2)) {
1687 Invalidate(ep);
1688 }
1689
1690 /* Compact valid events */
1691 if (!ValidEvent(ep)) {
1692 if (ep == first_valid) {
1693 first_valid = next;
1694 } else if (first_invalid == NULL) {
1695 first_invalid = ep;
1696 }
1697 } else if (first_invalid != NULL) {
1698 *first_invalid = *ep;
1699 Invalidate(ep);
1700 first_invalid = NEXT(first_invalid);
1701 }
1702
1703 ep = next;
1704 }
1705
1706 if (first_invalid == NULL) {
1707 first_invalid = eventp;
1708 }
1709 sp->_mouse_eventp = first_invalid;
1710
1711 #ifdef TRACE
1712 if (first_valid != NULL) {
1713 if (USE_TRACEF(TRACE_IEVENT)) {
1714 _trace_slot(sp, "after mouse event queue compaction:");
1715 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1716 RunParams(sp, first_invalid, first_valid),
1717 runcount);
1718 _nc_unlock_global(tracef);
1719 }
1720 for (ep = first_valid; ep != first_invalid; ep = NEXT(ep)) {
1721 if (ValidEvent(ep))
1722 TR(MY_TRACE,
1723 ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
1724 _nc_tracemouse(sp, ep),
1725 (long) IndexEV(sp, ep)));
1726 }
1727 }
1728 #endif /* TRACE */
1729
1730 /* after all this, do we have a valid event? */
1731 return ValidEvent(PREV(first_invalid));
1732 }
1733
1734 static void
_nc_mouse_wrap(SCREEN * sp)1735 _nc_mouse_wrap(SCREEN *sp)
1736 /* release mouse -- called by endwin() before shellout/exit */
1737 {
1738 TR(MY_TRACE, ("_nc_mouse_wrap() called"));
1739
1740 switch (sp->_mouse_type) {
1741 case M_XTERM:
1742 if (sp->_mouse_mask)
1743 mouse_activate(sp, FALSE);
1744 break;
1745 #if USE_GPM_SUPPORT
1746 /* GPM: pass all mouse events to next client */
1747 case M_GPM:
1748 if (sp->_mouse_mask)
1749 mouse_activate(sp, FALSE);
1750 break;
1751 #endif
1752 #if USE_SYSMOUSE
1753 case M_SYSMOUSE:
1754 mouse_activate(sp, FALSE);
1755 break;
1756 #endif
1757 #ifdef USE_TERM_DRIVER
1758 case M_TERM_DRIVER:
1759 mouse_activate(sp, FALSE);
1760 break;
1761 #endif
1762 case M_NONE:
1763 break;
1764 }
1765 }
1766
1767 static void
_nc_mouse_resume(SCREEN * sp)1768 _nc_mouse_resume(SCREEN *sp)
1769 /* re-connect to mouse -- called by doupdate() after shellout */
1770 {
1771 TR(MY_TRACE, ("_nc_mouse_resume() called"));
1772
1773 switch (sp->_mouse_type) {
1774 case M_XTERM:
1775 /* xterm: re-enable reporting */
1776 if (sp->_mouse_mask)
1777 mouse_activate(sp, TRUE);
1778 break;
1779
1780 #if USE_GPM_SUPPORT
1781 case M_GPM:
1782 /* GPM: reclaim our event set */
1783 if (sp->_mouse_mask)
1784 mouse_activate(sp, TRUE);
1785 break;
1786 #endif
1787
1788 #if USE_SYSMOUSE
1789 case M_SYSMOUSE:
1790 mouse_activate(sp, TRUE);
1791 break;
1792 #endif
1793
1794 #ifdef USE_TERM_DRIVER
1795 case M_TERM_DRIVER:
1796 mouse_activate(sp, TRUE);
1797 break;
1798 #endif
1799
1800 case M_NONE:
1801 break;
1802 }
1803 }
1804
1805 /**************************************************************************
1806 *
1807 * Mouse interface entry points for the API
1808 *
1809 **************************************************************************/
1810
1811 NCURSES_EXPORT(int)
NCURSES_SP_NAME(getmouse)1812 NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1813 {
1814 int result = ERR;
1815 MEVENT *eventp;
1816
1817 T((T_CALLED("getmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1818
1819 if ((aevent != 0) &&
1820 (SP_PARM != 0) &&
1821 (SP_PARM->_mouse_type != M_NONE) &&
1822 (eventp = SP_PARM->_mouse_eventp) != 0) {
1823 /* compute the current-event pointer */
1824 MEVENT *prev = PREV(eventp);
1825
1826 /*
1827 * Discard events not matching mask (there could be still some if
1828 * _nc_mouse_parse was not called, e.g., when _nc_mouse_inline returns
1829 * false).
1830 */
1831 while (ValidEvent(prev) && (!(prev->bstate & SP_PARM->_mouse_mask2))) {
1832 Invalidate(prev);
1833 prev = PREV(prev);
1834 }
1835 if (ValidEvent(prev)) {
1836 /* copy the event we find there */
1837 *aevent = *prev;
1838
1839 TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
1840 _nc_tracemouse(SP_PARM, prev),
1841 (long) IndexEV(SP_PARM, prev)));
1842
1843 Invalidate(prev); /* so the queue slot becomes free */
1844 SP_PARM->_mouse_eventp = prev;
1845 result = OK;
1846 } else {
1847 /* Reset the provided event */
1848 aevent->bstate = 0;
1849 Invalidate(aevent);
1850 aevent->x = 0;
1851 aevent->y = 0;
1852 aevent->z = 0;
1853 }
1854 }
1855 returnCode(result);
1856 }
1857
1858 #if NCURSES_SP_FUNCS
1859 /* grab a copy of the current mouse event */
1860 NCURSES_EXPORT(int)
getmouse(MEVENT * aevent)1861 getmouse(MEVENT * aevent)
1862 {
1863 return NCURSES_SP_NAME(getmouse) (CURRENT_SCREEN, aevent);
1864 }
1865 #endif
1866
1867 NCURSES_EXPORT(int)
NCURSES_SP_NAME(ungetmouse)1868 NCURSES_SP_NAME(ungetmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1869 {
1870 int result = ERR;
1871 MEVENT *eventp;
1872
1873 T((T_CALLED("ungetmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1874
1875 if (aevent != 0 &&
1876 SP_PARM != 0 &&
1877 (eventp = SP_PARM->_mouse_eventp) != 0) {
1878
1879 /* stick the given event in the next-free slot */
1880 *eventp = *aevent;
1881
1882 /* bump the next-free pointer into the circular list */
1883 SP_PARM->_mouse_eventp = NEXT(eventp);
1884
1885 /* push back the notification event on the keyboard queue */
1886 result = NCURSES_SP_NAME(ungetch) (NCURSES_SP_ARGx KEY_MOUSE);
1887 }
1888 returnCode(result);
1889 }
1890
1891 #if NCURSES_SP_FUNCS
1892 /* enqueue a synthesized mouse event to be seen by the next wgetch() */
1893 NCURSES_EXPORT(int)
ungetmouse(MEVENT * aevent)1894 ungetmouse(MEVENT * aevent)
1895 {
1896 return NCURSES_SP_NAME(ungetmouse) (CURRENT_SCREEN, aevent);
1897 }
1898 #endif
1899
1900 NCURSES_EXPORT(mmask_t)
NCURSES_SP_NAME(mousemask)1901 NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
1902 /* set the mouse event mask */
1903 {
1904 mmask_t result = 0;
1905
1906 T((T_CALLED("mousemask(%p,%#lx,%p)"),
1907 (void *) SP_PARM,
1908 (unsigned long) newmask,
1909 (void *) oldmask));
1910
1911 if (SP_PARM != 0) {
1912 if (oldmask)
1913 *oldmask = SP_PARM->_mouse_mask;
1914
1915 if (newmask || SP_PARM->_mouse_initialized) {
1916 _nc_mouse_init(SP_PARM);
1917
1918 if (SP_PARM->_mouse_type != M_NONE) {
1919 int b;
1920
1921 result = newmask &
1922 (REPORT_MOUSE_POSITION
1923 | BUTTON_ALT
1924 | BUTTON_CTRL
1925 | BUTTON_SHIFT
1926 | BUTTON_PRESSED
1927 | BUTTON_RELEASED
1928 | BUTTON_CLICKED
1929 | BUTTON_DOUBLE_CLICKED
1930 | BUTTON_TRIPLE_CLICKED);
1931
1932 mouse_activate(SP_PARM, (bool) (result != 0));
1933
1934 SP_PARM->_mouse_mask = result;
1935 SP_PARM->_mouse_mask2 = result;
1936
1937 /*
1938 * Make a mask corresponding to the states we will need to
1939 * retain (temporarily) while building up the state that the
1940 * user asked for.
1941 */
1942 for (b = 1; b <= MAX_BUTTONS; ++b) {
1943 if (SP_PARM->_mouse_mask2 & MASK_TRIPLE_CLICK(b))
1944 SP_PARM->_mouse_mask2 |= MASK_DOUBLE_CLICK(b);
1945 if (SP_PARM->_mouse_mask2 & MASK_DOUBLE_CLICK(b))
1946 SP_PARM->_mouse_mask2 |= MASK_CLICK(b);
1947 if (SP_PARM->_mouse_mask2 & MASK_CLICK(b))
1948 SP_PARM->_mouse_mask2 |= (MASK_PRESS(b) |
1949 MASK_RELEASE(b));
1950 }
1951 }
1952 }
1953 }
1954 returnMMask(result);
1955 }
1956
1957 #if NCURSES_SP_FUNCS
1958 NCURSES_EXPORT(mmask_t)
mousemask(mmask_t newmask,mmask_t * oldmask)1959 mousemask(mmask_t newmask, mmask_t * oldmask)
1960 {
1961 return NCURSES_SP_NAME(mousemask) (CURRENT_SCREEN, newmask, oldmask);
1962 }
1963 #endif
1964
1965 NCURSES_EXPORT(bool)
wenclose(const WINDOW * win,int y,int x)1966 wenclose(const WINDOW *win, int y, int x)
1967 /* check to see if given window encloses given screen location */
1968 {
1969 bool result = FALSE;
1970
1971 T((T_CALLED("wenclose(%p,%d,%d)"), (const void *) win, y, x));
1972
1973 if (win != 0) {
1974 y -= win->_yoffset;
1975 result = ((win->_begy <= y &&
1976 win->_begx <= x &&
1977 (win->_begx + win->_maxx) >= x &&
1978 (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
1979 }
1980 returnBool(result);
1981 }
1982
1983 NCURSES_EXPORT(int)
NCURSES_SP_NAME(mouseinterval)1984 NCURSES_SP_NAME(mouseinterval) (NCURSES_SP_DCLx int maxclick)
1985 /* set the maximum mouse interval within which to recognize a click */
1986 {
1987 int oldval;
1988
1989 T((T_CALLED("mouseinterval(%p,%d)"), (void *) SP_PARM, maxclick));
1990
1991 if (SP_PARM != 0) {
1992 oldval = SP_PARM->_maxclick;
1993 if (maxclick >= 0)
1994 SP_PARM->_maxclick = maxclick;
1995 } else {
1996 oldval = DEFAULT_MAXCLICK;
1997 }
1998
1999 returnCode(oldval);
2000 }
2001
2002 #if NCURSES_SP_FUNCS
2003 NCURSES_EXPORT(int)
mouseinterval(int maxclick)2004 mouseinterval(int maxclick)
2005 {
2006 return NCURSES_SP_NAME(mouseinterval) (CURRENT_SCREEN, maxclick);
2007 }
2008 #endif
2009
2010 /* This may be used by other routines to ask for the existence of mouse
2011 support */
2012 NCURSES_EXPORT(bool)
_nc_has_mouse(SCREEN * sp)2013 _nc_has_mouse(SCREEN *sp)
2014 {
2015 return (((0 == sp) || (sp->_mouse_type == M_NONE)) ? FALSE : TRUE);
2016 }
2017
2018 NCURSES_EXPORT(bool)
NCURSES_SP_NAME(has_mouse)2019 NCURSES_SP_NAME(has_mouse) (NCURSES_SP_DCL0)
2020 {
2021 return _nc_has_mouse(SP_PARM);
2022 }
2023
2024 #if NCURSES_SP_FUNCS
2025 NCURSES_EXPORT(bool)
has_mouse(void)2026 has_mouse(void)
2027 {
2028 return _nc_has_mouse(CURRENT_SCREEN);
2029 }
2030 #endif
2031
2032 NCURSES_EXPORT(bool)
wmouse_trafo(const WINDOW * win,int * pY,int * pX,bool to_screen)2033 wmouse_trafo(const WINDOW *win, int *pY, int *pX, bool to_screen)
2034 {
2035 bool result = FALSE;
2036
2037 T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"),
2038 (const void *) win,
2039 (void *) pY,
2040 (void *) pX,
2041 to_screen));
2042
2043 if (win && pY && pX) {
2044 int y = *pY;
2045 int x = *pX;
2046
2047 if (to_screen) {
2048 y += win->_begy + win->_yoffset;
2049 x += win->_begx;
2050 if (wenclose(win, y, x))
2051 result = TRUE;
2052 } else {
2053 if (wenclose(win, y, x)) {
2054 y -= (win->_begy + win->_yoffset);
2055 x -= win->_begx;
2056 result = TRUE;
2057 }
2058 }
2059 if (result) {
2060 *pX = x;
2061 *pY = y;
2062 }
2063 }
2064 returnBool(result);
2065 }
2066