1 /****************************************************************************
2 * Copyright (c) 1998-2018,2019 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 * and: Thomas E. Dickey 1996-on *
33 * and: Juergen Pfeifer 2008 *
34 ****************************************************************************/
37 * This module is intended to encapsulate ncurses's interface to pointing
40 * The primary method used is xterm's internal mouse-tracking facility.
41 * Additional methods depend on the platform:
42 * Alessandro Rubini's GPM server (Linux)
44 * special-purpose mouse interface for OS/2 EMX.
46 * Notes for implementors of new mouse-interface methods:
48 * The code is logically split into a lower level that accepts event reports
49 * in a device-dependent format and an upper level that parses mouse gestures
50 * and filters events. The mediating data structure is a circular queue of
53 * Functionally, the lower level's job is to pick up primitive events and
54 * put them on the circular queue. This can happen in one of two ways:
55 * either (a) _nc_mouse_event() detects a series of incoming mouse reports
56 * and queues them, or (b) code in lib_getch.c detects the kmous prefix in
57 * the keyboard input stream and calls _nc_mouse_inline to queue up a series
58 * of adjacent mouse reports.
60 * In either case, _nc_mouse_parse() should be called after the series is
61 * accepted to parse the digested mouse reports (low-level MEVENTs) into
62 * a gesture (a high-level or composite MEVENT).
64 * Don't be too shy about adding new event types or modifiers, if you can find
65 * room for them in the 32-bit mask. The API is written so that users get
66 * feedback on which theoretical event types they won't see when they call
67 * mousemask. There's one bit per button (the RESERVED_EVENT bit) not being
68 * used yet, and a couple of bits open at the high end.
77 # define INCL_DOSPROCESS
78 # include <os2.h> /* Need to include before the others */
81 #include <curses.priv.h>
84 #define CUR SP_TERMTYPE
87 MODULE_ID("$Id: lib_mouse.c,v 1.183 2019/08/10 17:11:50 tom Exp $")
92 #include <linux/keyboard.h> /* defines KG_* macros */
95 /* use dynamic loader to avoid linkage dependency */
99 #define my_RTLD RTLD_NOW
102 #define my_RTLD RTLD_LAZY
106 #endif /* RTLD_NOW */
107 #endif /* HAVE_LIBDL */
109 #endif /* USE_GPM_SUPPORT */
112 #undef buttons /* symbol conflict in consio.h */
113 #undef mouse_info /* symbol conflict in consio.h */
114 #include <osreldate.h>
115 #if defined(__DragonFly_version) || (defined(__FreeBSD__) && (__FreeBSD_version >= 400017))
116 #include <sys/consio.h>
117 #include <sys/fbio.h>
119 #include <machine/console.h>
121 #endif /* use_SYSMOUSE */
124 #include <sys/socket.h>
125 #define pipe(handles) socketpair(AF_LOCAL, SOCK_STREAM, 0, handles)
126 #define DosWrite(hfile, pbuffer, cbwrite, pcbactual) \
127 write(hfile, pbuffer, cbwrite)
128 #define DosExit(action, result ) /* do nothing */
129 #define DosCreateThread(ptid, pfn, param, flag, cbStack) \
130 (*(ptid) = _beginthread(pfn, NULL, cbStack, \
131 (void *)param), (*(ptid) == -1))
134 #define MY_TRACE TRACE_ICALLS|TRACE_IEVENT
136 #define MASK_RELEASE(x) (mmask_t) NCURSES_MOUSE_MASK(x, 001)
137 #define MASK_PRESS(x) (mmask_t) NCURSES_MOUSE_MASK(x, 002)
138 #define MASK_CLICK(x) (mmask_t) NCURSES_MOUSE_MASK(x, 004)
139 #define MASK_DOUBLE_CLICK(x) (mmask_t) NCURSES_MOUSE_MASK(x, 010)
140 #define MASK_TRIPLE_CLICK(x) (mmask_t) NCURSES_MOUSE_MASK(x, 020)
141 #define MASK_RESERVED_EVENT(x) (mmask_t) NCURSES_MOUSE_MASK(x, 040)
143 #if NCURSES_MOUSE_VERSION == 1
144 #define BUTTON_CLICKED (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED | BUTTON4_CLICKED)
145 #define BUTTON_PRESSED (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED | BUTTON4_PRESSED)
146 #define BUTTON_RELEASED (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED | BUTTON4_RELEASED)
147 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED)
148 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED)
149 #define MAX_BUTTONS 4
151 #define BUTTON_CLICKED (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED | BUTTON4_CLICKED | BUTTON5_CLICKED)
152 #define BUTTON_PRESSED (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED | BUTTON4_PRESSED | BUTTON5_PRESSED)
153 #define BUTTON_RELEASED (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED | BUTTON4_RELEASED | BUTTON5_RELEASED)
154 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED | BUTTON5_DOUBLE_CLICKED)
155 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED | BUTTON5_TRIPLE_CLICKED)
156 #define MAX_BUTTONS 5
159 #define INVALID_EVENT -1
160 #define NORMAL_EVENT 0
162 #define ValidEvent(ep) ((ep)->id != INVALID_EVENT)
163 #define Invalidate(ep) (ep)->id = INVALID_EVENT
167 #ifndef LIBGPM_SONAME
168 #define LIBGPM_SONAME "libgpm.so"
171 #define GET_DLSYM(name) (my_##name = (TYPE_##name) dlsym(sp->_dlopen_gpm, #name))
173 #endif /* USE_GPM_SUPPORT */
175 static bool _nc_mouse_parse(SCREEN *, int);
176 static void _nc_mouse_resume(SCREEN *);
177 static void _nc_mouse_wrap(SCREEN *);
179 /* maintain a circular list of mouse events */
181 #define FirstEV(sp) ((sp)->_mouse_events)
182 #define LastEV(sp) ((sp)->_mouse_events + EV_MAX - 1)
185 #define NEXT(ep) ((ep >= LastEV(SP_PARM)) \
190 #define PREV(ep) ((ep <= FirstEV(SP_PARM)) \
194 #define IndexEV(sp, ep) (ep - FirstEV(sp))
196 #define RunParams(sp, eventp, runp) \
197 (long) IndexEV(sp, runp), \
198 (long) (IndexEV(sp, eventp) + (EV_MAX - 1)) % EV_MAX
202 _trace_slot(SCREEN *sp, const char *tag)
208 for (ep = FirstEV(sp); ep <= LastEV(sp); ep++)
209 _tracef("mouse event queue slot %ld = %s",
210 (long) IndexEV(sp, ep),
211 _nc_tracemouse(sp, ep));
220 # define M_FD(sp) sp->_mouse_fd
223 write_event(SCREEN *sp, int down, int button, int x, int y)
226 unsigned long ignore;
228 _nc_STRCPY(buf, "\033[M", sizeof(buf)); /* should be the same as key_mouse */
229 buf[3] = ' ' + (button - 1) + (down ? 0 : 0x40);
230 buf[4] = ' ' + x - LEFT_COL + 1;
231 buf[5] = ' ' + y - TOP_ROW + 1;
232 DosWrite(sp->_emxmouse_wfd, buf, 6, &ignore);
237 mouse_server(void *param)
239 mouse_server(unsigned long param)
242 SCREEN *sp = (SCREEN *) param;
243 unsigned short fWait = MOU_WAIT;
244 /* NOPTRRECT mourt = { 0,0,24,79 }; */
247 unsigned short mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN | MOUSE_BN3_DOWN;
253 /* open the handle for the mouse */
254 if (MouOpen(NULL, &hmou) == 0) {
255 rc = MouSetEventMask(&mask, hmou);
256 if (rc) { /* retry with 2 buttons */
257 mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN;
258 rc = MouSetEventMask(&mask, hmou);
261 if (rc == 0 && MouDrawPtr(hmou) == 0) {
263 /* sit and wait on the event queue */
264 rc = MouReadEventQue(&mouev, &fWait, hmou);
266 _nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
267 "Error reading mouse queue, rc=%lu.\r\n", rc);
270 if (!sp->_emxmouse_activated)
274 * OS/2 numbers a 3-button mouse inconsistently from other
280 if ((mouev.fs ^ oldstate) & MOUSE_BN1_DOWN)
281 write_event(sp, mouev.fs & MOUSE_BN1_DOWN,
282 sp->_emxmouse_buttons[1], mouev.col, mouev.row);
283 if ((mouev.fs ^ oldstate) & MOUSE_BN2_DOWN)
284 write_event(sp, mouev.fs & MOUSE_BN2_DOWN,
285 sp->_emxmouse_buttons[3], mouev.col, mouev.row);
286 if ((mouev.fs ^ oldstate) & MOUSE_BN3_DOWN)
287 write_event(sp, mouev.fs & MOUSE_BN3_DOWN,
288 sp->_emxmouse_buttons[2], mouev.col, mouev.row);
294 _nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
295 "Error setting event mask, buttons=%d, rc=%lu.\r\n",
299 DosWrite(2, err, strlen(err), &rc);
302 DosExit(EXIT_THREAD, 0L);
305 #endif /* USE_EMX_MOUSE */
309 sysmouse_server(SCREEN *sp)
311 struct mouse_info the_mouse;
314 the_mouse.operation = MOUSE_GETINFO;
316 && sp->_mouse_fd >= 0
317 && sp->_sysmouse_tail < FIFO_SIZE
318 && ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
320 if (sp->_sysmouse_head > sp->_sysmouse_tail) {
321 sp->_sysmouse_tail = 0;
322 sp->_sysmouse_head = 0;
324 work = &(sp->_sysmouse_fifo[sp->_sysmouse_tail]);
325 memset(work, 0, sizeof(*work));
326 work->id = NORMAL_EVENT; /* there's only one mouse... */
328 sp->_sysmouse_old_buttons = sp->_sysmouse_new_buttons;
329 sp->_sysmouse_new_buttons = the_mouse.u.data.buttons & 0x7;
331 if (sp->_sysmouse_new_buttons) {
332 if (sp->_sysmouse_new_buttons & 1)
333 work->bstate |= BUTTON1_PRESSED;
334 if (sp->_sysmouse_new_buttons & 2)
335 work->bstate |= BUTTON2_PRESSED;
336 if (sp->_sysmouse_new_buttons & 4)
337 work->bstate |= BUTTON3_PRESSED;
339 if (sp->_sysmouse_old_buttons & 1)
340 work->bstate |= BUTTON1_RELEASED;
341 if (sp->_sysmouse_old_buttons & 2)
342 work->bstate |= BUTTON2_RELEASED;
343 if (sp->_sysmouse_old_buttons & 4)
344 work->bstate |= BUTTON3_RELEASED;
347 /* for cosmetic bug in syscons.c on FreeBSD 3.[34] */
348 the_mouse.operation = MOUSE_HIDE;
349 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
350 the_mouse.operation = MOUSE_SHOW;
351 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
354 * We're only interested if the button is pressed or released.
355 * FIXME: implement continuous event-tracking.
357 if (sp->_sysmouse_new_buttons != sp->_sysmouse_old_buttons) {
358 sp->_sysmouse_tail += 1;
360 work->x = the_mouse.u.data.x / sp->_sysmouse_char_width;
361 work->y = the_mouse.u.data.y / sp->_sysmouse_char_height;
366 handle_sysmouse(int sig GCC_UNUSED)
368 sysmouse_server(CURRENT_SCREEN);
370 #endif /* USE_SYSMOUSE */
372 #ifndef USE_TERM_DRIVER
373 #define xterm_kmous "\033[M"
376 init_xterm_mouse(SCREEN *sp)
378 sp->_mouse_type = M_XTERM;
379 sp->_mouse_format = MF_X10;
380 sp->_mouse_xtermcap = tigetstr("XM");
381 if (VALID_STRING(sp->_mouse_xtermcap)) {
382 char *code = strstr(sp->_mouse_xtermcap, "[?");
385 while ((*code >= '0') && (*code <= '9')) {
387 while ((*next >= '0') && (*next <= '9')) {
390 if (!strncmp(code, "1006", (size_t) (next - code))) {
391 sp->_mouse_format = MF_SGR1006;
393 #ifdef EXP_XTERM_1005
394 if (!strncmp(code, "1005", (size_t) (next - code))) {
395 sp->_mouse_format = MF_XTERM_1005;
399 while (*next == ';') {
409 int code = tigetnum("XM");
417 sp->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
423 enable_xterm_mouse(SCREEN *sp, int enable)
426 sp->_emxmouse_activated = enable;
428 NCURSES_PUTP2("xterm-mouse", TPARM_1(sp->_mouse_xtermcap, enable));
430 sp->_mouse_active = enable;
435 allow_gpm_mouse(SCREEN *sp GCC_UNUSED)
440 /* Danger Robinson: do not use dlopen for libgpm if already loaded */
441 if ((Gpm_Wgetch) != 0) {
442 if (!sp->_mouse_gpm_loaded) {
443 T(("GPM library was already dlopen'd, not by us"));
447 /* GPM does printf's without checking if stdout is a terminal */
448 if (NC_ISATTY(fileno(stdout))) {
449 const char *list = getenv("NCURSES_GPM_TERMS");
450 const char *env = getenv("TERM");
453 result = _nc_name_match(list, env, "|:");
456 /* GPM checks the beginning of the $TERM variable to decide if it
457 * should pass xterm events through. There is no real advantage in
458 * allowing GPM to do this. Recent versions relax that check, and
459 * pretend that GPM can work with any terminal having the kmous
460 * capability. Perhaps that works for someone. If so, they can
461 * set the environment variable (above).
463 if (env != 0 && strstr(env, "linux") != 0) {
473 unload_gpm_library(SCREEN *sp)
475 if (sp->_dlopen_gpm != 0) {
476 T(("unload GPM library"));
477 sp->_mouse_gpm_loaded = FALSE;
479 dlclose(sp->_dlopen_gpm);
485 load_gpm_library(SCREEN *sp)
487 sp->_mouse_gpm_found = FALSE;
488 if ((sp->_dlopen_gpm = dlopen(LIBGPM_SONAME, my_RTLD)) != 0) {
489 #if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
490 #pragma GCC diagnostic push
491 #pragma GCC diagnostic ignored "-Wpedantic"
493 if (GET_DLSYM(gpm_fd) == 0 ||
494 GET_DLSYM(Gpm_Open) == 0 ||
495 GET_DLSYM(Gpm_Close) == 0 ||
496 GET_DLSYM(Gpm_GetEvent) == 0) {
497 #if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
498 #pragma GCC diagnostic pop
500 T(("GPM initialization failed: %s", dlerror()));
501 unload_gpm_library(sp);
503 sp->_mouse_gpm_found = TRUE;
504 sp->_mouse_gpm_loaded = TRUE;
511 enable_gpm_mouse(SCREEN *sp, bool enable)
515 T((T_CALLED("enable_gpm_mouse(%d)"), enable));
517 if (enable && !sp->_mouse_active) {
519 if (sp->_mouse_gpm_found && !sp->_mouse_gpm_loaded) {
520 load_gpm_library(sp);
523 if (sp->_mouse_gpm_loaded) {
526 /* GPM: initialize connection to gpm server */
527 sp->_mouse_gpm_connect.eventMask = GPM_DOWN | GPM_UP;
528 sp->_mouse_gpm_connect.defaultMask =
529 (unsigned short) (~(sp->_mouse_gpm_connect.eventMask | GPM_HARD));
530 sp->_mouse_gpm_connect.minMod = 0;
531 sp->_mouse_gpm_connect.maxMod =
532 (unsigned short) (~((1 << KG_SHIFT) |
536 * Note: GPM hardcodes \E[?1001s and \E[?1000h during its open.
537 * The former is recognized by wscons (SunOS), and the latter by
538 * xterm. Those will not show up in ncurses' traces.
540 code = my_Gpm_Open(&sp->_mouse_gpm_connect, 0);
541 result = (code >= 0);
544 * GPM can return a -2 if it is trying to do something with xterm.
545 * Ignore that, since it conflicts with our use of stdin.
553 sp->_mouse_active = result;
554 T(("GPM open %s", result ? "succeeded" : "failed"));
556 if (!enable && sp->_mouse_active) {
557 /* GPM: close connection to gpm server */
559 sp->_mouse_active = FALSE;
566 unload_gpm_library(sp);
571 #endif /* USE_GPM_SUPPORT */
574 initialize_mousetype(SCREEN *sp)
576 T((T_CALLED("initialize_mousetype()")));
578 /* Try gpm first, because gpm may be configured to run in xterm */
580 if (allow_gpm_mouse(sp)) {
581 if (!sp->_mouse_gpm_loaded) {
583 load_gpm_library(sp);
584 #else /* !HAVE_LIBDL */
585 sp->_mouse_gpm_found = TRUE;
586 sp->_mouse_gpm_loaded = TRUE;
591 * The gpm_fd file-descriptor may be negative (xterm). So we have to
592 * maintain our notion of whether the mouse connection is active
593 * without testing the file-descriptor.
595 if (sp->_mouse_gpm_found && enable_gpm_mouse(sp, TRUE)) {
596 sp->_mouse_type = M_GPM;
597 sp->_mouse_fd = *(my_gpm_fd);
598 T(("GPM mouse_fd %d", sp->_mouse_fd));
602 #endif /* USE_GPM_SUPPORT */
606 if (!sp->_emxmouse_thread
607 && strstr(SP_TERMTYPE term_names, "xterm") == 0
608 && NonEmpty(key_mouse)) {
611 if (pipe(handles) < 0) {
612 perror("mouse pipe error");
617 if (!sp->_emxmouse_buttons[0]) {
618 const char *s = getenv("MOUSE_BUTTONS_123");
620 sp->_emxmouse_buttons[0] = 1;
621 if (s && strlen(s) >= 3) {
622 sp->_emxmouse_buttons[1] = s[0] - '0';
623 sp->_emxmouse_buttons[2] = s[1] - '0';
624 sp->_emxmouse_buttons[3] = s[2] - '0';
626 sp->_emxmouse_buttons[1] = 1;
627 sp->_emxmouse_buttons[2] = 3;
628 sp->_emxmouse_buttons[3] = 2;
631 sp->_emxmouse_wfd = handles[1];
632 M_FD(sp) = handles[0];
634 setmode(handles[0], O_BINARY);
635 setmode(handles[1], O_BINARY);
636 /* Do not use CRT functions, we may single-threaded. */
637 rc = DosCreateThread((unsigned long *) &sp->_emxmouse_thread,
638 mouse_server, (long) sp, 0, 8192);
640 printf("mouse thread error %d=%#x", rc, rc);
642 sp->_mouse_type = M_XTERM;
647 #endif /* USE_EMX_MOUSE */
651 static char dev_tty[] = "/dev/tty";
652 struct mouse_info the_mouse;
653 char *the_device = 0;
655 if (NC_ISATTY(sp->_ifd))
656 the_device = ttyname(sp->_ifd);
658 the_device = dev_tty;
660 sp->_mouse_fd = open(the_device, O_RDWR);
662 if (sp->_mouse_fd >= 0) {
664 * sysmouse does not have a usable user interface for obtaining
665 * mouse events. The logical way to proceed (reading data on a
666 * stream) only works if one opens the device as root. Even in
667 * that mode, careful examination shows we lose events
668 * occasionally. The interface provided for user programs is to
669 * establish a signal handler. really.
671 * Take over SIGUSR2 for this purpose since SIGUSR1 is more
672 * likely to be used by an application. getch() will have to
673 * handle the misleading EINTR's.
675 signal(SIGUSR2, SIG_IGN);
676 the_mouse.operation = MOUSE_MODE;
677 the_mouse.u.mode.mode = 0;
678 the_mouse.u.mode.signal = SIGUSR2;
679 if (ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
680 signal(SIGUSR2, handle_sysmouse);
681 the_mouse.operation = MOUSE_SHOW;
682 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
684 #if defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) /* FreeBSD > 2.x */
686 #ifndef FBIO_GETMODE /* FreeBSD 3.x */
687 #define FBIO_GETMODE CONS_GET
688 #define FBIO_MODEINFO CONS_MODEINFO
689 #endif /* FBIO_GETMODE */
690 video_info_t the_video;
692 if (ioctl(sp->_mouse_fd,
694 &the_video.vi_mode) != -1
695 && ioctl(sp->_mouse_fd,
698 sp->_sysmouse_char_width = the_video.vi_cwidth;
699 sp->_sysmouse_char_height = the_video.vi_cheight;
702 #endif /* defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) */
704 if (sp->_sysmouse_char_width <= 0)
705 sp->_sysmouse_char_width = 8;
706 if (sp->_sysmouse_char_height <= 0)
707 sp->_sysmouse_char_height = 16;
708 sp->_mouse_type = M_SYSMOUSE;
713 #endif /* USE_SYSMOUSE */
715 #ifdef USE_TERM_DRIVER
716 CallDriver(sp, td_initmouse);
718 /* we know how to recognize mouse events under "xterm" */
719 if (NonEmpty(key_mouse)) {
720 init_xterm_mouse(sp);
721 } else if (strstr(SP_TERMTYPE term_names, "xterm") != 0) {
722 if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
723 init_xterm_mouse(sp);
731 _nc_mouse_init(SCREEN *sp)
732 /* initialize the mouse */
737 if (!sp->_mouse_initialized) {
740 sp->_mouse_initialized = TRUE;
742 TR(MY_TRACE, ("_nc_mouse_init() called"));
744 sp->_mouse_eventp = FirstEV(sp);
745 for (i = 0; i < EV_MAX; i++)
746 Invalidate(sp->_mouse_events + i);
748 initialize_mousetype(sp);
750 T(("_nc_mouse_init() set mousetype to %d", sp->_mouse_type));
752 result = sp->_mouse_initialized;
758 * Query to see if there is a pending mouse event. This is called from
759 * fifo_push() in lib_getch.c
762 _nc_mouse_event(SCREEN *sp)
764 MEVENT *eventp = sp->_mouse_eventp;
769 switch (sp->_mouse_type) {
771 /* xterm: never have to query, mouse events are in the keyboard stream */
776 int i, res = read(M_FD(sp), &kbuf, 3); /* Eat the prefix */
778 printf("Got %d chars instead of 3 for prefix.\n", res);
779 for (i = 0; i < res; i++) {
780 if (kbuf[i] != key_mouse[i])
781 printf("Got char %d instead of %d for prefix.\n",
782 (int) kbuf[i], (int) key_mouse[i]);
786 #endif /* USE_EMX_MOUSE */
791 if (sp->_mouse_fd >= 0) {
792 /* query server for event, return TRUE if we find one */
795 switch (my_Gpm_GetEvent(&ev)) {
797 /* Connection closed, drop the mouse. */
801 /* there's only one mouse... */
802 eventp->id = NORMAL_EVENT;
805 switch (ev.type & 0x0f) {
807 if (ev.buttons & GPM_B_LEFT)
808 eventp->bstate |= BUTTON1_PRESSED;
809 if (ev.buttons & GPM_B_MIDDLE)
810 eventp->bstate |= BUTTON2_PRESSED;
811 if (ev.buttons & GPM_B_RIGHT)
812 eventp->bstate |= BUTTON3_PRESSED;
815 if (ev.buttons & GPM_B_LEFT)
816 eventp->bstate |= BUTTON1_RELEASED;
817 if (ev.buttons & GPM_B_MIDDLE)
818 eventp->bstate |= BUTTON2_RELEASED;
819 if (ev.buttons & GPM_B_RIGHT)
820 eventp->bstate |= BUTTON3_RELEASED;
823 eventp->bstate |= REPORT_MOUSE_POSITION;
827 eventp->x = ev.x - 1;
828 eventp->y = ev.y - 1;
831 /* bump the next-free pointer into the circular list */
832 sp->_mouse_eventp = NEXT(eventp);
842 if (sp->_sysmouse_head < sp->_sysmouse_tail) {
843 *eventp = sp->_sysmouse_fifo[sp->_sysmouse_head];
846 * Point the fifo-head to the next possible location. If there
847 * are none, reset the indices. This may be interrupted by the
848 * signal handler, doing essentially the same reset.
850 sp->_sysmouse_head += 1;
851 if (sp->_sysmouse_head == sp->_sysmouse_tail) {
852 sp->_sysmouse_tail = 0;
853 sp->_sysmouse_head = 0;
856 /* bump the next-free pointer into the circular list */
857 sp->_mouse_eventp = eventp = NEXT(eventp);
861 #endif /* USE_SYSMOUSE */
863 #ifdef USE_TERM_DRIVER
865 while (sp->_drv_mouse_head < sp->_drv_mouse_tail) {
866 *eventp = sp->_drv_mouse_fifo[sp->_drv_mouse_head];
869 * Point the fifo-head to the next possible location. If there
870 * are none, reset the indices.
872 sp->_drv_mouse_head += 1;
873 if (sp->_drv_mouse_head == sp->_drv_mouse_tail) {
874 sp->_drv_mouse_tail = 0;
875 sp->_drv_mouse_head = 0;
878 /* bump the next-free pointer into the circular list */
879 sp->_mouse_eventp = eventp = NEXT(eventp);
889 return result; /* true if we found an event */
893 #define PRESS_POSITION(n) \
895 eventp->bstate = MASK_PRESS(n); \
896 sp->_mouse_bstate |= MASK_PRESS(n); \
897 if (button & 0x40) { \
898 eventp->bstate = MASK_RELEASE(n); \
899 sp->_mouse_bstate &= ~MASK_PRESS(n); \
903 #define PRESS_POSITION(n) \
905 eventp->bstate = (mmask_t) ((sp->_mouse_bstate & MASK_PRESS(n)) \
906 ? REPORT_MOUSE_POSITION \
908 sp->_mouse_bstate |= MASK_PRESS(n); \
913 handle_wheel(SCREEN *sp, MEVENT * eventp, int button, int wheel)
917 switch (button & 3) {
920 eventp->bstate = MASK_PRESS(4);
921 /* Do not record in sp->_mouse_bstate; there will be no
922 * corresponding release event.
930 #if NCURSES_MOUSE_VERSION == 2
931 eventp->bstate = MASK_PRESS(5);
932 /* See comment above for button 4 */
934 /* Ignore this event as it is not a true press of the button */
935 eventp->bstate = REPORT_MOUSE_POSITION;
952 decode_X10_bstate(SCREEN *sp, MEVENT * eventp, unsigned intro)
958 if (!handle_wheel(sp, eventp, (int) intro, (intro & 96) == 96)) {
961 * Release events aren't reported for individual buttons, just for
962 * the button set as a whole. However, because there are normally
963 * no mouse events under xterm that intervene between press and
964 * release, we can infer the button actually released by looking at
965 * the previous event.
967 if (sp->_mouse_bstate & BUTTON_PRESSED) {
970 eventp->bstate = BUTTON_RELEASED;
971 for (b = 1; b <= MAX_BUTTONS; ++b) {
972 if (!(sp->_mouse_bstate & MASK_PRESS(b)))
973 eventp->bstate &= ~MASK_RELEASE(b);
975 sp->_mouse_bstate = 0;
978 * xterm will return a stream of release-events to let the
979 * application know where the mouse is going, if private mode
980 * 1002 or 1003 is enabled.
982 eventp->bstate = REPORT_MOUSE_POSITION;
987 eventp->bstate |= BUTTON_SHIFT;
990 eventp->bstate |= BUTTON_ALT;
993 eventp->bstate |= BUTTON_CTRL;
995 result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
999 /* This code requires that your xterm entry contain the kmous capability and
1000 * that it be set to the \E[M documented in the Xterm Control Sequences
1001 * reference. This is how we arrange for mouse events to be reported via a
1002 * KEY_MOUSE return value from wgetch(). After this value is received,
1003 * _nc_mouse_inline() gets called and is immediately responsible for parsing
1004 * the mouse status information following the prefix.
1006 * The following quotes from the ctlseqs.ms document in the XTerm distribution,
1007 * describing the mouse tracking feature:
1009 * Parameters for all mouse tracking escape sequences generated by xterm encode
1010 * numeric parameters in a single character as value+040. For example, ! is
1013 * On button press or release, xterm sends ESC [ M CbCxCy. The low two bits of
1014 * Cb encode button information: 0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed,
1015 * 3=release. The upper bits encode what modifiers were down when the button
1016 * was pressed and are added together. 4=Shift, 8=Meta, 16=Control. Cx and Cy
1017 * are the x and y coordinates of the mouse event. The upper left corner is
1020 * (End quote) By the time we get here, we've eaten the key prefix. FYI, the
1021 * loop below is necessary because mouse click info isn't guaranteed to present
1022 * as a single clist item.
1024 * Wheel mice may return buttons 4 and 5 when the wheel is turned. We encode
1025 * those as button presses.
1028 decode_xterm_X10(SCREEN *sp, MEVENT * eventp)
1031 unsigned char kbuf[MAX_KBUF + 1];
1036 # if USE_PTHREADS_EINTR
1037 # if USE_WEAK_SYMBOLS
1038 if ((pthread_self) && (pthread_kill) && (pthread_equal))
1040 _nc_globals.read_thread = pthread_self();
1042 for (grabbed = 0; grabbed < MAX_KBUF; grabbed += (size_t) res) {
1044 /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
1047 (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
1051 kbuf + grabbed, (size_t) (MAX_KBUF - (int) grabbed));
1055 #if USE_PTHREADS_EINTR
1056 _nc_globals.read_thread = 0;
1058 kbuf[MAX_KBUF] = '\0';
1061 ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
1063 /* there's only one mouse... */
1064 eventp->id = NORMAL_EVENT;
1066 result = decode_X10_bstate(sp, eventp, kbuf[0]);
1068 eventp->x = (kbuf[1] - ' ') - 1;
1069 eventp->y = (kbuf[2] - ' ') - 1;
1074 #ifdef EXP_XTERM_1005
1076 * This is identical to X10/X11 responses except that there are two UTF-8
1077 * characters storing the ordinates instead of two bytes.
1080 decode_xterm_1005(SCREEN *sp, MEVENT * eventp)
1084 size_t limit = (sizeof(kbuf) - 1);
1091 # if USE_PTHREADS_EINTR
1092 # if USE_WEAK_SYMBOLS
1093 if ((pthread_self) && (pthread_kill) && (pthread_equal))
1095 _nc_globals.read_thread = pthread_self();
1097 for (grabbed = 0; grabbed < limit;) {
1102 (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
1106 (kbuf + grabbed), (size_t) 1);
1109 grabbed += (size_t) res;
1114 for (n = 0; n < 2; ++n) {
1117 if (check >= grabbed)
1119 rc = _nc_conv_to_utf32(&coords[n], kbuf + check, (unsigned)
1123 check += (size_t) rc;
1129 #if USE_PTHREADS_EINTR
1130 _nc_globals.read_thread = 0;
1134 ("_nc_mouse_inline sees the following xterm data: %s",
1135 _nc_visbufn(kbuf, (int) grabbed)));
1137 /* there's only one mouse... */
1138 eventp->id = NORMAL_EVENT;
1140 result = decode_X10_bstate(sp, eventp, UChar(kbuf[0]));
1142 eventp->x = (int) (coords[0] - ' ') - 1;
1143 eventp->y = (int) (coords[1] - ' ') - 1;
1147 #endif /* EXP_XTERM_1005 */
1150 * ECMA-48 section 5.4
1152 #define isInter(c) ((c) >= 0x20 && (c) <= 0x2f)
1153 #define isParam(c) ((c) >= 0x30 && (c) <= 0x3f)
1154 #define isFinal(c) ((c) >= 0x40 && (c) <= 0x7e)
1156 #define MAX_PARAMS 9
1159 int nerror; /* nonzero if there are unexpected chars */
1160 int nparam; /* number of numeric parameters */
1161 int params[MAX_PARAMS];
1162 int final; /* the final-character */
1166 read_SGR(SCREEN *sp, SGR_DATA * result)
1168 char kbuf[80]; /* bigger than any possible mouse response */
1174 memset(result, 0, sizeof(*result));
1175 # if USE_PTHREADS_EINTR
1176 # if USE_WEAK_SYMBOLS
1177 if ((pthread_self) && (pthread_kill) && (pthread_equal))
1179 _nc_globals.read_thread = pthread_self();
1187 (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
1191 (kbuf + grabbed), (size_t) 1);
1194 if ((grabbed + MAX_KBUF) >= (int) sizeof(kbuf)) {
1198 ch = UChar(kbuf[grabbed]);
1199 kbuf[grabbed + 1] = 0;
1213 result->nparam = (now + 1);
1216 result->params[now] = (result->params[now] * 10) + (ch - '0');
1221 result->nparam = (now + 1);
1226 if (ch < 32 || ch > 126) {
1228 * Technically other characters could be interspersed in the
1229 * response. Ignore those for now.
1233 } else if (isFinal(ch)) {
1244 } while (!isFinal(ch));
1245 #if USE_PTHREADS_EINTR
1246 _nc_globals.read_thread = 0;
1249 kbuf[++grabbed] = 0;
1251 ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
1252 return (grabbed > 0) && (result->nerror == 0);
1256 decode_xterm_SGR1006(SCREEN *sp, MEVENT * eventp)
1259 bool result = FALSE;
1260 if (read_SGR(sp, &data)) {
1261 int b = data.params[0];
1262 int b3 = 1 + (b & 3);
1264 eventp->id = NORMAL_EVENT;
1265 if (data.final == 'M') {
1266 (void) handle_wheel(sp, eventp, b, (b & 64) == 64);
1268 mmask_t pressed = (mmask_t) NCURSES_MOUSE_MASK(b3, NCURSES_BUTTON_PRESSED);
1269 mmask_t release = (mmask_t) NCURSES_MOUSE_MASK(b3, NCURSES_BUTTON_RELEASED);
1270 if (sp->_mouse_bstate & pressed) {
1271 eventp->bstate = release;
1272 sp->_mouse_bstate &= ~pressed;
1274 eventp->bstate = REPORT_MOUSE_POSITION;
1278 eventp->bstate |= BUTTON_SHIFT;
1281 eventp->bstate |= BUTTON_ALT;
1284 eventp->bstate |= BUTTON_CTRL;
1286 result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
1287 eventp->x = (data.params[1] ? (data.params[1] - 1) : 0);
1288 eventp->y = (data.params[2] ? (data.params[2] - 1) : 0);
1294 _nc_mouse_inline(SCREEN *sp)
1295 /* mouse report received in the keyboard stream -- parse its info */
1297 bool result = FALSE;
1298 MEVENT *eventp = sp->_mouse_eventp;
1300 TR(MY_TRACE, ("_nc_mouse_inline() called"));
1302 if (sp->_mouse_type == M_XTERM) {
1303 switch (sp->_mouse_format) {
1305 result = decode_xterm_X10(sp, eventp);
1308 result = decode_xterm_SGR1006(sp, eventp);
1310 #ifdef EXP_XTERM_1005
1312 result = decode_xterm_1005(sp, eventp);
1318 ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
1319 _nc_tracemouse(sp, eventp),
1320 (long) IndexEV(sp, eventp)));
1322 /* bump the next-free pointer into the circular list */
1323 sp->_mouse_eventp = NEXT(eventp);
1326 /* If this event is from a wheel-mouse, treat it like position
1327 * reports and avoid waiting for the release-events which will
1330 if (eventp->bstate & BUTTON_PRESSED) {
1333 for (b = 4; b <= MAX_BUTTONS; ++b) {
1334 if ((eventp->bstate & MASK_PRESS(b))) {
1347 mouse_activate(SCREEN *sp, int on)
1349 if (!on && !sp->_mouse_initialized)
1352 if (!_nc_mouse_init(sp))
1356 sp->_mouse_bstate = 0;
1357 switch (sp->_mouse_type) {
1359 #if NCURSES_EXT_FUNCS
1360 NCURSES_SP_NAME(keyok) (NCURSES_SP_ARGx KEY_MOUSE, on);
1362 TPUTS_TRACE("xterm mouse initialization");
1363 enable_xterm_mouse(sp, 1);
1367 if (enable_gpm_mouse(sp, TRUE)) {
1368 sp->_mouse_fd = *(my_gpm_fd);
1369 T(("GPM mouse_fd %d", sp->_mouse_fd));
1375 signal(SIGUSR2, handle_sysmouse);
1376 sp->_mouse_active = TRUE;
1379 #ifdef USE_TERM_DRIVER
1381 sp->_mouse_active = TRUE;
1387 /* Make runtime binding to cut down on object size of applications that
1388 * do not use the mouse (e.g., 'clear').
1390 sp->_mouse_event = _nc_mouse_event;
1391 sp->_mouse_inline = _nc_mouse_inline;
1392 sp->_mouse_parse = _nc_mouse_parse;
1393 sp->_mouse_resume = _nc_mouse_resume;
1394 sp->_mouse_wrap = _nc_mouse_wrap;
1397 switch (sp->_mouse_type) {
1399 TPUTS_TRACE("xterm mouse deinitialization");
1400 enable_xterm_mouse(sp, 0);
1404 enable_gpm_mouse(sp, FALSE);
1409 signal(SIGUSR2, SIG_IGN);
1410 sp->_mouse_active = FALSE;
1413 #ifdef USE_TERM_DRIVER
1415 sp->_mouse_active = FALSE;
1422 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1425 /**************************************************************************
1427 * Device-independent code
1429 **************************************************************************/
1432 _nc_mouse_parse(SCREEN *sp, int runcount)
1433 /* parse a run of atomic mouse events into a gesture */
1435 MEVENT *eventp = sp->_mouse_eventp;
1437 MEVENT *first_valid = NULL;
1438 MEVENT *first_invalid = NULL;
1444 TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));
1447 * When we enter this routine, the event list next-free pointer
1448 * points just past a run of mouse events that we know were separated
1449 * in time by less than the critical click interval. The job of this
1450 * routine is to collapse this run into a single higher-level event
1453 * We accomplish this in two passes. The first pass merges press/release
1454 * pairs into click events. The second merges runs of click events into
1455 * double or triple-click events.
1457 * It's possible that the run may not resolve to a single event (for
1458 * example, if the user quadruple-clicks). If so, leading events
1459 * in the run are ignored if user does not call getmouse in a loop (getting
1460 * them from newest to older).
1462 * Note that this routine is independent of the format of the specific
1463 * format of the pointing-device's reports. We can use it to parse
1464 * gestures on anything that reports press/release events on a per-
1465 * button basis, as long as the device-dependent mouse code puts stuff
1466 * on the queue in MEVENT format.
1470 * Reset all events that were not set, in case the user sometimes calls
1471 * getmouse only once and other times until there are no more events in
1474 * This also allows reaching the beginning of the run.
1477 for (n = runcount; n < EV_MAX; n++) {
1483 if (USE_TRACEF(TRACE_IEVENT)) {
1484 _trace_slot(sp, "before mouse press/release merge:");
1485 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1486 RunParams(sp, eventp, ep),
1488 _nc_unlock_global(tracef);
1492 /* first pass; merge press/release pairs */
1496 if (next == eventp) {
1497 /* Will end the loop, but compact before */
1501 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
1502 == !(next->bstate & MASK_RELEASE(x)))
1504 if (ValidEvent(ep) && ValidEvent(next)
1505 && ep->x == next->x && ep->y == next->y
1506 && (ep->bstate & BUTTON_PRESSED)
1507 && (!(next->bstate & BUTTON_PRESSED))) {
1508 bool changed = TRUE;
1510 for (b = 1; b <= MAX_BUTTONS; ++b) {
1511 if (!MASK_CHANGED(b)) {
1519 for (b = 1; b <= MAX_BUTTONS; ++b) {
1520 if ((sp->_mouse_mask & MASK_CLICK(b))
1521 && (ep->bstate & MASK_PRESS(b))) {
1522 next->bstate &= ~MASK_RELEASE(b);
1523 next->bstate |= MASK_CLICK(b);
1534 /* Compact valid events */
1535 if (!ValidEvent(ep)) {
1536 if ((first_valid != NULL) && (first_invalid == NULL)) {
1540 if (first_valid == NULL) {
1542 } else if (first_invalid != NULL) {
1543 *first_invalid = *ep;
1545 first_invalid = NEXT(first_invalid);
1552 if (first_invalid != NULL) {
1553 eventp = first_invalid;
1556 if (USE_TRACEF(TRACE_IEVENT)) {
1557 _trace_slot(sp, "before mouse click merge:");
1558 if (first_valid == NULL) {
1559 _tracef("_nc_mouse_parse: no valid event");
1561 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1562 RunParams(sp, eventp, first_valid),
1564 _nc_unlock_global(tracef);
1570 * Second pass; merge click runs. We merge click events forward in the
1571 * queue. For example, double click can be changed to triple click.
1573 * NOTE: There is a problem with this design! If the application
1574 * allows enough click events to pile up in the circular queue so
1575 * they wrap around, it will cheerfully merge the newest forward
1576 * into the oldest, creating a bogus doubleclick and confusing
1577 * the queue-traversal logic rather badly. Generally this won't
1578 * happen, because calling getmouse() marks old events invalid and
1579 * ineligible for merges. The true solution to this problem would
1580 * be to timestamp each MEVENT and perform the obvious sanity check,
1581 * but the timer element would have to have sub-second resolution,
1582 * which would get us into portability trouble.
1584 first_invalid = NULL;
1585 endLoop = (first_valid == NULL);
1590 if (next == eventp) {
1591 /* Will end the loop, but check event type and compact before */
1593 } else if (!ValidEvent(next)) {
1596 /* merge click events forward */
1597 if ((ep->bstate & BUTTON_CLICKED)
1598 && (next->bstate & BUTTON_CLICKED)) {
1600 for (b = 1; b <= MAX_BUTTONS; ++b) {
1601 if ((sp->_mouse_mask & MASK_DOUBLE_CLICK(b))
1602 && (ep->bstate & MASK_CLICK(b))
1603 && (next->bstate & MASK_CLICK(b))) {
1604 next->bstate &= ~MASK_CLICK(b);
1605 next->bstate |= MASK_DOUBLE_CLICK(b);
1614 /* merge double-click events forward */
1615 if ((ep->bstate & BUTTON_DOUBLE_CLICKED)
1616 && (next->bstate & BUTTON_CLICKED)) {
1618 for (b = 1; b <= MAX_BUTTONS; ++b) {
1619 if ((sp->_mouse_mask & MASK_TRIPLE_CLICK(b))
1620 && (ep->bstate & MASK_DOUBLE_CLICK(b))
1621 && (next->bstate & MASK_CLICK(b))) {
1622 next->bstate &= ~MASK_CLICK(b);
1623 next->bstate |= MASK_TRIPLE_CLICK(b);
1633 /* Discard event if it does not match event mask */
1634 if (!(ep->bstate & sp->_mouse_mask2)) {
1638 /* Compact valid events */
1639 if (!ValidEvent(ep)) {
1640 if (ep == first_valid) {
1642 } else if (first_invalid == NULL) {
1645 } else if (first_invalid != NULL) {
1646 *first_invalid = *ep;
1648 first_invalid = NEXT(first_invalid);
1654 if (first_invalid == NULL) {
1655 first_invalid = eventp;
1657 sp->_mouse_eventp = first_invalid;
1660 if (first_valid != NULL) {
1661 if (USE_TRACEF(TRACE_IEVENT)) {
1662 _trace_slot(sp, "after mouse event queue compaction:");
1663 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1664 RunParams(sp, first_invalid, first_valid),
1666 _nc_unlock_global(tracef);
1668 for (ep = first_valid; ep != first_invalid; ep = NEXT(ep)) {
1671 ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
1672 _nc_tracemouse(sp, ep),
1673 (long) IndexEV(sp, ep)));
1678 /* after all this, do we have a valid event? */
1679 return ValidEvent(PREV(first_invalid));
1683 _nc_mouse_wrap(SCREEN *sp)
1684 /* release mouse -- called by endwin() before shellout/exit */
1686 TR(MY_TRACE, ("_nc_mouse_wrap() called"));
1688 switch (sp->_mouse_type) {
1690 if (sp->_mouse_mask)
1691 mouse_activate(sp, FALSE);
1694 /* GPM: pass all mouse events to next client */
1696 if (sp->_mouse_mask)
1697 mouse_activate(sp, FALSE);
1702 mouse_activate(sp, FALSE);
1705 #ifdef USE_TERM_DRIVER
1707 mouse_activate(sp, FALSE);
1716 _nc_mouse_resume(SCREEN *sp)
1717 /* re-connect to mouse -- called by doupdate() after shellout */
1719 TR(MY_TRACE, ("_nc_mouse_resume() called"));
1721 switch (sp->_mouse_type) {
1723 /* xterm: re-enable reporting */
1724 if (sp->_mouse_mask)
1725 mouse_activate(sp, TRUE);
1730 /* GPM: reclaim our event set */
1731 if (sp->_mouse_mask)
1732 mouse_activate(sp, TRUE);
1738 mouse_activate(sp, TRUE);
1742 #ifdef USE_TERM_DRIVER
1744 mouse_activate(sp, TRUE);
1753 /**************************************************************************
1755 * Mouse interface entry points for the API
1757 **************************************************************************/
1760 NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1765 T((T_CALLED("getmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1767 if ((aevent != 0) &&
1769 (SP_PARM->_mouse_type != M_NONE) &&
1770 (eventp = SP_PARM->_mouse_eventp) != 0) {
1771 /* compute the current-event pointer */
1772 MEVENT *prev = PREV(eventp);
1775 * Discard events not matching mask (there could be still some if
1776 * _nc_mouse_parse was not called, e.g., when _nc_mouse_inline returns
1779 while (ValidEvent(prev) && (!(prev->bstate & SP_PARM->_mouse_mask2))) {
1783 if (ValidEvent(prev)) {
1784 /* copy the event we find there */
1787 TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
1788 _nc_tracemouse(SP_PARM, prev),
1789 (long) IndexEV(SP_PARM, prev)));
1791 Invalidate(prev); /* so the queue slot becomes free */
1792 SP_PARM->_mouse_eventp = prev;
1795 /* Reset the provided event */
1806 #if NCURSES_SP_FUNCS
1807 /* grab a copy of the current mouse event */
1809 getmouse(MEVENT * aevent)
1811 return NCURSES_SP_NAME(getmouse) (CURRENT_SCREEN, aevent);
1816 NCURSES_SP_NAME(ungetmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1821 T((T_CALLED("ungetmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1825 (eventp = SP_PARM->_mouse_eventp) != 0) {
1827 /* stick the given event in the next-free slot */
1830 /* bump the next-free pointer into the circular list */
1831 SP_PARM->_mouse_eventp = NEXT(eventp);
1833 /* push back the notification event on the keyboard queue */
1834 result = NCURSES_SP_NAME(ungetch) (NCURSES_SP_ARGx KEY_MOUSE);
1839 #if NCURSES_SP_FUNCS
1840 /* enqueue a synthesized mouse event to be seen by the next wgetch() */
1842 ungetmouse(MEVENT * aevent)
1844 return NCURSES_SP_NAME(ungetmouse) (CURRENT_SCREEN, aevent);
1848 NCURSES_EXPORT(mmask_t)
1849 NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
1850 /* set the mouse event mask */
1854 T((T_CALLED("mousemask(%p,%#lx,%p)"),
1856 (unsigned long) newmask,
1861 *oldmask = SP_PARM->_mouse_mask;
1863 if (newmask || SP_PARM->_mouse_initialized) {
1864 _nc_mouse_init(SP_PARM);
1866 if (SP_PARM->_mouse_type != M_NONE) {
1870 (REPORT_MOUSE_POSITION
1877 | BUTTON_DOUBLE_CLICKED
1878 | BUTTON_TRIPLE_CLICKED);
1880 mouse_activate(SP_PARM, (bool) (result != 0));
1882 SP_PARM->_mouse_mask = result;
1883 SP_PARM->_mouse_mask2 = result;
1886 * Make a mask corresponding to the states we will need to
1887 * retain (temporarily) while building up the state that the
1890 for (b = 1; b <= MAX_BUTTONS; ++b) {
1891 if (SP_PARM->_mouse_mask2 & MASK_TRIPLE_CLICK(b))
1892 SP_PARM->_mouse_mask2 |= MASK_DOUBLE_CLICK(b);
1893 if (SP_PARM->_mouse_mask2 & MASK_DOUBLE_CLICK(b))
1894 SP_PARM->_mouse_mask2 |= MASK_CLICK(b);
1895 if (SP_PARM->_mouse_mask2 & MASK_CLICK(b))
1896 SP_PARM->_mouse_mask2 |= (MASK_PRESS(b) |
1902 returnMMask(result);
1905 #if NCURSES_SP_FUNCS
1906 NCURSES_EXPORT(mmask_t)
1907 mousemask(mmask_t newmask, mmask_t * oldmask)
1909 return NCURSES_SP_NAME(mousemask) (CURRENT_SCREEN, newmask, oldmask);
1913 NCURSES_EXPORT(bool)
1914 wenclose(const WINDOW *win, int y, int x)
1915 /* check to see if given window encloses given screen location */
1917 bool result = FALSE;
1919 T((T_CALLED("wenclose(%p,%d,%d)"), (const void *) win, y, x));
1923 result = ((win->_begy <= y &&
1925 (win->_begx + win->_maxx) >= x &&
1926 (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
1932 NCURSES_SP_NAME(mouseinterval) (NCURSES_SP_DCLx int maxclick)
1933 /* set the maximum mouse interval within which to recognize a click */
1937 T((T_CALLED("mouseinterval(%p,%d)"), (void *) SP_PARM, maxclick));
1940 oldval = SP_PARM->_maxclick;
1942 SP_PARM->_maxclick = maxclick;
1944 oldval = DEFAULT_MAXCLICK;
1950 #if NCURSES_SP_FUNCS
1952 mouseinterval(int maxclick)
1954 return NCURSES_SP_NAME(mouseinterval) (CURRENT_SCREEN, maxclick);
1958 /* This may be used by other routines to ask for the existence of mouse
1960 NCURSES_EXPORT(bool)
1961 _nc_has_mouse(SCREEN *sp)
1963 return (((0 == sp) || (sp->_mouse_type == M_NONE)) ? FALSE : TRUE);
1966 NCURSES_EXPORT(bool)
1967 NCURSES_SP_NAME(has_mouse) (NCURSES_SP_DCL0)
1969 return _nc_has_mouse(SP_PARM);
1972 #if NCURSES_SP_FUNCS
1973 NCURSES_EXPORT(bool)
1976 return _nc_has_mouse(CURRENT_SCREEN);
1980 NCURSES_EXPORT(bool)
1981 wmouse_trafo(const WINDOW *win, int *pY, int *pX, bool to_screen)
1983 bool result = FALSE;
1985 T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"),
1991 if (win && pY && pX) {
1996 y += win->_begy + win->_yoffset;
1998 if (wenclose(win, y, x))
2001 if (wenclose(win, y, x)) {
2002 y -= (win->_begy + win->_yoffset);