1 /****************************************************************************
2 * Copyright (c) 1998-2007,2008 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 ****************************************************************************/
36 * This module is intended to encapsulate ncurses's interface to pointing
39 * The primary method used is xterm's internal mouse-tracking facility.
40 * Additional methods depend on the platform:
41 * Alessandro Rubini's GPM server (Linux)
43 * special-purpose mouse interface for OS/2 EMX.
45 * Notes for implementors of new mouse-interface methods:
47 * The code is logically split into a lower level that accepts event reports
48 * in a device-dependent format and an upper level that parses mouse gestures
49 * and filters events. The mediating data structure is a circular queue of
52 * Functionally, the lower level's job is to pick up primitive events and
53 * put them on the circular queue. This can happen in one of two ways:
54 * either (a) _nc_mouse_event() detects a series of incoming mouse reports
55 * and queues them, or (b) code in lib_getch.c detects the kmous prefix in
56 * the keyboard input stream and calls _nc_mouse_inline to queue up a series
57 * of adjacent mouse reports.
59 * In either case, _nc_mouse_parse() should be called after the series is
60 * accepted to parse the digested mouse reports (low-level MEVENTs) into
61 * a gesture (a high-level or composite MEVENT).
63 * Don't be too shy about adding new event types or modifiers, if you can find
64 * room for them in the 32-bit mask. The API is written so that users get
65 * feedback on which theoretical event types they won't see when they call
66 * mousemask. There's one bit per button (the RESERVED_EVENT bit) not being
67 * used yet, and a couple of bits open at the high end.
76 # define INCL_DOSPROCESS
77 # include <os2.h> /* Need to include before the others */
80 #include <curses.priv.h>
82 MODULE_ID("$Id: lib_mouse.c,v 1.97 2008/08/16 18:55:01 tom Exp $")
88 #include <linux/keyboard.h> /* defines KG_* macros */
91 /* use dynamic loader to avoid linkage dependency */
95 #define my_RTLD RTLD_NOW
98 #define my_RTLD RTLD_LAZY
102 #endif /* RTLD_NOW */
103 #endif /* HAVE_LIBDL */
105 #endif /* USE_GPM_SUPPORT */
108 #undef buttons /* symbol conflict in consio.h */
109 #undef mouse_info /* symbol conflict in consio.h */
110 #include <osreldate.h>
111 #if (__FreeBSD_version >= 400017)
112 #include <sys/consio.h>
113 #include <sys/fbio.h>
115 #include <machine/console.h>
117 #endif /* use_SYSMOUSE */
119 #define MY_TRACE TRACE_ICALLS|TRACE_IEVENT
121 #define MASK_RELEASE(x) NCURSES_MOUSE_MASK(x, 001)
122 #define MASK_PRESS(x) NCURSES_MOUSE_MASK(x, 002)
123 #define MASK_CLICK(x) NCURSES_MOUSE_MASK(x, 004)
124 #define MASK_DOUBLE_CLICK(x) NCURSES_MOUSE_MASK(x, 010)
125 #define MASK_TRIPLE_CLICK(x) NCURSES_MOUSE_MASK(x, 020)
126 #define MASK_RESERVED_EVENT(x) NCURSES_MOUSE_MASK(x, 040)
128 #if NCURSES_MOUSE_VERSION == 1
129 #define BUTTON_CLICKED (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED | BUTTON4_CLICKED)
130 #define BUTTON_PRESSED (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED | BUTTON4_PRESSED)
131 #define BUTTON_RELEASED (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED | BUTTON4_RELEASED)
132 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED)
133 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED)
134 #define MAX_BUTTONS 4
136 #define BUTTON_CLICKED (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED | BUTTON4_CLICKED | BUTTON5_CLICKED)
137 #define BUTTON_PRESSED (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED | BUTTON4_PRESSED | BUTTON5_PRESSED)
138 #define BUTTON_RELEASED (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED | BUTTON4_RELEASED | BUTTON5_RELEASED)
139 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED | BUTTON5_DOUBLE_CLICKED)
140 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED | BUTTON5_TRIPLE_CLICKED)
141 #define MAX_BUTTONS 5
144 #define INVALID_EVENT -1
145 #define NORMAL_EVENT 0
149 #ifndef LIBGPM_SONAME
150 #define LIBGPM_SONAME "libgpm.so"
153 #define GET_DLSYM(name) (my_##name = (TYPE_##name) dlsym(obj, #name))
155 #endif /* USE_GPM_SUPPORT */
157 static bool _nc_mouse_parse(SCREEN *, int);
158 static void _nc_mouse_resume(SCREEN *);
159 static void _nc_mouse_wrap(SCREEN *);
161 /* maintain a circular list of mouse events */
163 #define FirstEV(sp) ((sp)->_mouse_events)
164 #define LastEV(sp) ((sp)->_mouse_events + EV_MAX - 1)
167 #define NEXT(ep) ((ep >= LastEV(sp)) \
172 #define PREV(ep) ((ep <= FirstEV(sp)) \
176 #define IndexEV(sp, ep) (ep - FirstEV(sp))
178 #define RunParams(sp, eventp, runp) \
179 (long) IndexEV(sp, runp), \
180 (long) (IndexEV(sp, eventp) + (EV_MAX - 1)) % EV_MAX
184 _trace_slot(SCREEN *sp, const char *tag)
190 for (ep = FirstEV(sp); ep <= LastEV(sp); ep++)
191 _tracef("mouse event queue slot %ld = %s",
192 (long) IndexEV(sp, ep),
193 _nc_tracemouse(sp, ep));
202 # define M_FD(sp) sp->_mouse_fd
205 write_event(SCREEN *sp, int down, int button, int x, int y)
208 unsigned long ignore;
210 strncpy(buf, key_mouse, 3); /* should be "\033[M" */
211 buf[3] = ' ' + (button - 1) + (down ? 0 : 0x40);
212 buf[4] = ' ' + x - LEFT_COL + 1;
213 buf[5] = ' ' + y - TOP_ROW + 1;
214 DosWrite(sp->_emxmouse_wfd, buf, 6, &ignore);
218 mouse_server(unsigned long param)
220 SCREEN *sp = (SCREEN *) param;
221 unsigned short fWait = MOU_WAIT;
222 /* NOPTRRECT mourt = { 0,0,24,79 }; */
225 unsigned short mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN | MOUSE_BN3_DOWN;
231 /* open the handle for the mouse */
232 if (MouOpen(NULL, &hmou) == 0) {
233 rc = MouSetEventMask(&mask, hmou);
234 if (rc) { /* retry with 2 buttons */
235 mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN;
236 rc = MouSetEventMask(&mask, hmou);
239 if (rc == 0 && MouDrawPtr(hmou) == 0) {
241 /* sit and wait on the event queue */
242 rc = MouReadEventQue(&mouev, &fWait, hmou);
244 sprintf(err, "Error reading mouse queue, rc=%lu.\r\n", rc);
247 if (!sp->_emxmouse_activated)
251 * OS/2 numbers a 3-button mouse inconsistently from other
257 if ((mouev.fs ^ oldstate) & MOUSE_BN1_DOWN)
258 write_event(mouev.fs & MOUSE_BN1_DOWN,
259 sp->_emxmouse_buttons[1], mouev.col, mouev.row);
260 if ((mouev.fs ^ oldstate) & MOUSE_BN2_DOWN)
261 write_event(mouev.fs & MOUSE_BN2_DOWN,
262 sp->_emxmouse_buttons[3], mouev.col, mouev.row);
263 if ((mouev.fs ^ oldstate) & MOUSE_BN3_DOWN)
264 write_event(mouev.fs & MOUSE_BN3_DOWN,
265 sp->_emxmouse_buttons[2], mouev.col, mouev.row);
271 sprintf(err, "Error setting event mask, buttons=%d, rc=%lu.\r\n",
274 DosWrite(2, err, strlen(err), &rc);
277 DosExit(EXIT_THREAD, 0L);
280 #endif /* USE_EMX_MOUSE */
284 sysmouse_server(SCREEN *sp)
286 struct mouse_info the_mouse;
289 the_mouse.operation = MOUSE_GETINFO;
291 && sp->_mouse_fd >= 0
292 && sp->_sysmouse_tail < FIFO_SIZE
293 && ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
295 if (sp->_sysmouse_head > sp->_sysmouse_tail) {
296 sp->_sysmouse_tail = 0;
297 sp->_sysmouse_head = 0;
299 work = &(sp->_sysmouse_fifo[sp->_sysmouse_tail]);
300 memset(work, 0, sizeof(*work));
301 work->id = NORMAL_EVENT; /* there's only one mouse... */
303 sp->_sysmouse_old_buttons = sp->_sysmouse_new_buttons;
304 sp->_sysmouse_new_buttons = the_mouse.u.data.buttons & 0x7;
306 if (sp->_sysmouse_new_buttons) {
307 if (sp->_sysmouse_new_buttons & 1)
308 work->bstate |= BUTTON1_PRESSED;
309 if (sp->_sysmouse_new_buttons & 2)
310 work->bstate |= BUTTON2_PRESSED;
311 if (sp->_sysmouse_new_buttons & 4)
312 work->bstate |= BUTTON3_PRESSED;
314 if (sp->_sysmouse_old_buttons & 1)
315 work->bstate |= BUTTON1_RELEASED;
316 if (sp->_sysmouse_old_buttons & 2)
317 work->bstate |= BUTTON2_RELEASED;
318 if (sp->_sysmouse_old_buttons & 4)
319 work->bstate |= BUTTON3_RELEASED;
322 /* for cosmetic bug in syscons.c on FreeBSD 3.[34] */
323 the_mouse.operation = MOUSE_HIDE;
324 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
325 the_mouse.operation = MOUSE_SHOW;
326 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
329 * We're only interested if the button is pressed or released.
330 * FIXME: implement continuous event-tracking.
332 if (sp->_sysmouse_new_buttons != sp->_sysmouse_old_buttons) {
333 sp->_sysmouse_tail += 1;
335 work->x = the_mouse.u.data.x / sp->_sysmouse_char_width;
336 work->y = the_mouse.u.data.y / sp->_sysmouse_char_height;
341 handle_sysmouse(int sig GCC_UNUSED)
345 #endif /* USE_SYSMOUSE */
348 init_xterm_mouse(SCREEN *sp)
350 sp->_mouse_type = M_XTERM;
351 sp->_mouse_xtermcap = tigetstr("XM");
352 if (!VALID_STRING(sp->_mouse_xtermcap))
353 sp->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
357 enable_xterm_mouse(SCREEN *sp, int enable)
360 sp->_emxmouse_activated = enable;
362 putp(TPARM_1(sp->_mouse_xtermcap, enable));
364 sp->_mouse_active = enable;
369 allow_gpm_mouse(void)
371 /* GPM does printf's without checking if stdout is a terminal */
372 if (isatty(fileno(stdout))) {
373 char *env = getenv("TERM");
374 /* GPM checks the beginning of the $TERM variable to decide if
375 * it should pass xterm events through. There is no real advantage
376 * in allowing GPM to do this.
378 if (env == 0 || strncmp(env, "xterm", 5))
385 enable_gpm_mouse(SCREEN *sp, int enable)
389 T((T_CALLED("enable_gpm_mouse(%d)"), enable));
391 if (enable && !sp->_mouse_active) {
392 /* GPM: initialize connection to gpm server */
393 sp->_mouse_gpm_connect.eventMask = GPM_DOWN | GPM_UP;
394 sp->_mouse_gpm_connect.defaultMask =
395 (unsigned short) (~(sp->_mouse_gpm_connect.eventMask | GPM_HARD));
396 sp->_mouse_gpm_connect.minMod = 0;
397 sp->_mouse_gpm_connect.maxMod =
398 (unsigned short) (~((1 << KG_SHIFT) |
402 * Note: GPM hardcodes \E[?1001s and \E[?1000h during its open.
403 * The former is recognized by wscons (SunOS), and the latter by
404 * xterm. Those will not show up in ncurses' traces.
406 result = (my_Gpm_Open(&sp->_mouse_gpm_connect, 0) >= 0);
407 sp->_mouse_active = result;
408 T(("GPM open %s", result ? "succeeded" : "failed"));
410 if (!enable && sp->_mouse_active) {
411 /* GPM: close connection to gpm server */
413 sp->_mouse_active = FALSE;
420 #endif /* USE_GPM_SUPPORT */
422 #define xterm_kmous "\033[M"
425 initialize_mousetype(SCREEN *sp)
427 T((T_CALLED("initialize_mousetype()")));
429 /* Try gpm first, because gpm may be configured to run in xterm */
431 if (allow_gpm_mouse()) {
432 if (!sp->_mouse_gpm_loaded) {
436 if ((obj = dlopen(LIBGPM_SONAME, my_RTLD)) != 0) {
437 if (GET_DLSYM(gpm_fd) == 0 ||
438 GET_DLSYM(Gpm_Open) == 0 ||
439 GET_DLSYM(Gpm_Close) == 0 ||
440 GET_DLSYM(Gpm_GetEvent) == 0) {
441 T(("GPM initialization failed: %s", dlerror()));
444 sp->_mouse_gpm_found = TRUE;
447 #else /* !HAVE_LIBDL */
448 sp->_mouse_gpm_found = TRUE;
450 sp->_mouse_gpm_loaded = TRUE;
454 * The gpm_fd file-descriptor may be negative (xterm). So we have to
455 * maintain our notion of whether the mouse connection is active
456 * without testing the file-descriptor.
458 if (sp->_mouse_gpm_found && enable_gpm_mouse(sp, TRUE)) {
459 sp->_mouse_type = M_GPM;
460 sp->_mouse_fd = *(my_gpm_fd);
461 T(("GPM mouse_fd %d", sp->_mouse_fd));
465 #endif /* USE_GPM_SUPPORT */
469 if (!sp->_emxmouse_thread
470 && strstr(cur_term->type.term_names, "xterm") == 0
474 if (pipe(handles) < 0) {
475 perror("mouse pipe error");
480 if (!sp->_emxmouse_buttons[0]) {
481 char *s = getenv("MOUSE_BUTTONS_123");
483 sp->_emxmouse_buttons[0] = 1;
484 if (s && strlen(s) >= 3) {
485 sp->_emxmouse_buttons[1] = s[0] - '0';
486 sp->_emxmouse_buttons[2] = s[1] - '0';
487 sp->_emxmouse_buttons[3] = s[2] - '0';
489 sp->_emxmouse_buttons[1] = 1;
490 sp->_emxmouse_buttons[2] = 3;
491 sp->_emxmouse_buttons[3] = 2;
494 sp->_emxmouse_wfd = handles[1];
495 M_FD(sp) = handles[0];
497 setmode(handles[0], O_BINARY);
498 setmode(handles[1], O_BINARY);
499 /* Do not use CRT functions, we may single-threaded. */
500 rc = DosCreateThread((unsigned long *) &sp->_emxmouse_thread,
501 mouse_server, sp, 0, 8192);
503 printf("mouse thread error %d=%#x", rc, rc);
505 sp->_mouse_type = M_XTERM;
510 #endif /* USE_EMX_MOUSE */
514 struct mouse_info the_mouse;
515 char *the_device = 0;
517 if (isatty(sp->_ifd))
518 the_device = ttyname(sp->_ifd);
520 the_device = "/dev/tty";
522 sp->_mouse_fd = open(the_device, O_RDWR);
524 if (sp->_mouse_fd >= 0) {
526 * sysmouse does not have a usable user interface for obtaining
527 * mouse events. The logical way to proceed (reading data on a
528 * stream) only works if one opens the device as root. Even in
529 * that mode, careful examination shows we lose events
530 * occasionally. The interface provided for user programs is to
531 * establish a signal handler. really.
533 * Take over SIGUSR2 for this purpose since SIGUSR1 is more
534 * likely to be used by an application. getch() will have to
535 * handle the misleading EINTR's.
537 signal(SIGUSR2, SIG_IGN);
538 the_mouse.operation = MOUSE_MODE;
539 the_mouse.u.mode.mode = 0;
540 the_mouse.u.mode.signal = SIGUSR2;
541 if (ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
542 signal(SIGUSR2, handle_sysmouse);
543 the_mouse.operation = MOUSE_SHOW;
544 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
546 #if defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) /* FreeBSD > 2.x */
548 #ifndef FBIO_GETMODE /* FreeBSD 3.x */
549 #define FBIO_GETMODE CONS_GET
550 #define FBIO_MODEINFO CONS_MODEINFO
551 #endif /* FBIO_GETMODE */
552 video_info_t the_video;
554 if (ioctl(sp->_mouse_fd,
556 &the_video.vi_mode) != -1
557 && ioctl(sp->_mouse_fd,
560 sp->_sysmouse_char_width = the_video.vi_cwidth;
561 sp->_sysmouse_char_height = the_video.vi_cheight;
564 #endif /* defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) */
566 if (sp->_sysmouse_char_width <= 0)
567 sp->_sysmouse_char_width = 8;
568 if (sp->_sysmouse_char_height <= 0)
569 sp->_sysmouse_char_height = 16;
570 sp->_mouse_type = M_SYSMOUSE;
575 #endif /* USE_SYSMOUSE */
577 /* we know how to recognize mouse events under "xterm" */
578 if (key_mouse != 0) {
579 if (!strcmp(key_mouse, xterm_kmous)
580 || strstr(cur_term->type.term_names, "xterm") != 0) {
581 init_xterm_mouse(sp);
583 } else if (strstr(cur_term->type.term_names, "xterm") != 0) {
584 if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
585 init_xterm_mouse(sp);
591 _nc_mouse_init(SCREEN *sp)
592 /* initialize the mouse */
598 if (!sp->_mouse_initialized) {
599 sp->_mouse_initialized = TRUE;
601 TR(MY_TRACE, ("_nc_mouse_init() called"));
603 sp->_mouse_eventp = FirstEV(sp);
604 for (i = 0; i < EV_MAX; i++)
605 sp->_mouse_events[i].id = INVALID_EVENT;
607 initialize_mousetype(sp);
609 T(("_nc_mouse_init() set mousetype to %d", sp->_mouse_type));
611 result = sp->_mouse_initialized;
617 * Query to see if there is a pending mouse event. This is called from
618 * fifo_push() in lib_getch.c
621 _nc_mouse_event(SCREEN *sp GCC_UNUSED)
623 MEVENT *eventp = sp->_mouse_eventp;
628 switch (sp->_mouse_type) {
630 /* xterm: never have to query, mouse events are in the keyboard stream */
635 int i, res = read(M_FD(sp), &kbuf, 3); /* Eat the prefix */
637 printf("Got %d chars instead of 3 for prefix.\n", res);
638 for (i = 0; i < res; i++) {
639 if (kbuf[i] != key_mouse[i])
640 printf("Got char %d instead of %d for prefix.\n",
641 (int) kbuf[i], (int) key_mouse[i]);
645 #endif /* USE_EMX_MOUSE */
651 /* query server for event, return TRUE if we find one */
654 if (my_Gpm_GetEvent(&ev) == 1) {
655 /* there's only one mouse... */
656 eventp->id = NORMAL_EVENT;
659 switch (ev.type & 0x0f) {
661 if (ev.buttons & GPM_B_LEFT)
662 eventp->bstate |= BUTTON1_PRESSED;
663 if (ev.buttons & GPM_B_MIDDLE)
664 eventp->bstate |= BUTTON2_PRESSED;
665 if (ev.buttons & GPM_B_RIGHT)
666 eventp->bstate |= BUTTON3_PRESSED;
669 if (ev.buttons & GPM_B_LEFT)
670 eventp->bstate |= BUTTON1_RELEASED;
671 if (ev.buttons & GPM_B_MIDDLE)
672 eventp->bstate |= BUTTON2_RELEASED;
673 if (ev.buttons & GPM_B_RIGHT)
674 eventp->bstate |= BUTTON3_RELEASED;
680 eventp->x = ev.x - 1;
681 eventp->y = ev.y - 1;
684 /* bump the next-free pointer into the circular list */
685 sp->_mouse_eventp = eventp = NEXT(eventp);
694 if (sp->_sysmouse_head < sp->_sysmouse_tail) {
695 *eventp = sp->_sysmouse_fifo[sp->_sysmouse_head];
698 * Point the fifo-head to the next possible location. If there
699 * are none, reset the indices. This may be interrupted by the
700 * signal handler, doing essentially the same reset.
702 sp->_sysmouse_head += 1;
703 if (sp->_sysmouse_head == sp->_sysmouse_tail) {
704 sp->_sysmouse_tail = 0;
705 sp->_sysmouse_head = 0;
708 /* bump the next-free pointer into the circular list */
709 sp->_mouse_eventp = eventp = NEXT(eventp);
713 #endif /* USE_SYSMOUSE */
719 return result; /* true if we found an event */
723 _nc_mouse_inline(SCREEN *sp)
724 /* mouse report received in the keyboard stream -- parse its info */
728 MEVENT *eventp = sp->_mouse_eventp;
730 TR(MY_TRACE, ("_nc_mouse_inline() called"));
732 if (sp->_mouse_type == M_XTERM) {
733 unsigned char kbuf[4];
738 /* This code requires that your xterm entry contain the kmous
739 * capability and that it be set to the \E[M documented in the
740 * Xterm Control Sequences reference. This is how we
741 * arrange for mouse events to be reported via a KEY_MOUSE
742 * return value from wgetch(). After this value is received,
743 * _nc_mouse_inline() gets called and is immediately
744 * responsible for parsing the mouse status information
745 * following the prefix.
747 * The following quotes from the ctrlseqs.ms document in the
748 * X distribution, describing the X mouse tracking feature:
750 * Parameters for all mouse tracking escape sequences
751 * generated by xterm encode numeric parameters in a single
752 * character as value+040. For example, ! is 1.
754 * On button press or release, xterm sends ESC [ M CbCxCy.
755 * The low two bits of Cb encode button information: 0=MB1
756 * pressed, 1=MB2 pressed, 2=MB3 pressed, 3=release. The
757 * upper bits encode what modifiers were down when the
758 * button was pressed and are added together. 4=Shift,
759 * 8=Meta, 16=Control. Cx and Cy are the x and y coordinates
760 * of the mouse event. The upper left corner is (1,1).
762 * (End quote) By the time we get here, we've eaten the
763 * key prefix. FYI, the loop below is necessary because
764 * mouse click info isn't guaranteed to present as a
767 * Wheel mice may return buttons 4 and 5 when the wheel is turned.
768 * We encode those as button presses.
770 for (grabbed = 0; grabbed < 3; grabbed += (size_t) res) {
772 /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
774 res = read(M_FD(sp) >= 0 ? M_FD(sp) : sp->_ifd, &kbuf, 3);
776 res = read(sp->_ifd, kbuf + grabbed, 3 - grabbed);
784 ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
786 /* there's only one mouse... */
787 eventp->id = NORMAL_EVENT;
789 /* processing code goes here */
791 prev = PREV(eventp)->bstate;
794 #define PRESS_POSITION(n) \
795 eventp->bstate = MASK_PRESS(n); \
796 if (kbuf[0] & 0x40) \
797 eventp->bstate = MASK_RELEASE(n)
799 #define PRESS_POSITION(n) \
800 eventp->bstate = (mmask_t) (prev & MASK_PRESS(n) \
801 ? REPORT_MOUSE_POSITION \
805 switch (kbuf[0] & 0x3) {
808 eventp->bstate = MASK_PRESS(4);
814 #if NCURSES_MOUSE_VERSION == 2
816 eventp->bstate = MASK_PRESS(5);
828 * Release events aren't reported for individual buttons, just for
829 * the button set as a whole. However, because there are normally
830 * no mouse events under xterm that intervene between press and
831 * release, we can infer the button actually released by looking at
832 * the previous event.
834 if (prev & (BUTTON_PRESSED | BUTTON_RELEASED)) {
835 eventp->bstate = BUTTON_RELEASED;
836 for (b = 1; b <= MAX_BUTTONS; ++b) {
837 if (!(prev & MASK_PRESS(b)))
838 eventp->bstate &= ~MASK_RELEASE(b);
842 * XFree86 xterm will return a stream of release-events to
843 * let the application know where the mouse is going, if the
844 * private mode 1002 or 1003 is enabled.
846 eventp->bstate = REPORT_MOUSE_POSITION;
850 result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
853 eventp->bstate |= BUTTON_SHIFT;
856 eventp->bstate |= BUTTON_ALT;
859 eventp->bstate |= BUTTON_CTRL;
862 eventp->x = (kbuf[1] - ' ') - 1;
863 eventp->y = (kbuf[2] - ' ') - 1;
865 ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
866 _nc_tracemouse(sp, eventp),
867 (long) IndexEV(sp, eventp)));
869 /* bump the next-free pointer into the circular list */
870 sp->_mouse_eventp = NEXT(eventp);
871 #if 0 /* this return would be needed for QNX's mods to lib_getch.c */
880 mouse_activate(SCREEN *sp, bool on)
882 if (!on && !sp->_mouse_initialized)
885 if (!_nc_mouse_init(sp))
890 switch (sp->_mouse_type) {
892 #if NCURSES_EXT_FUNCS
893 keyok(KEY_MOUSE, on);
895 TPUTS_TRACE("xterm mouse initialization");
896 enable_xterm_mouse(sp, 1);
900 if (enable_gpm_mouse(sp, 1)) {
901 sp->_mouse_fd = *(my_gpm_fd);
902 T(("GPM mouse_fd %d", sp->_mouse_fd));
908 signal(SIGUSR2, handle_sysmouse);
909 sp->_mouse_active = TRUE;
915 /* Make runtime binding to cut down on object size of applications that
916 * do not use the mouse (e.g., 'clear').
918 sp->_mouse_event = _nc_mouse_event;
919 sp->_mouse_inline = _nc_mouse_inline;
920 sp->_mouse_parse = _nc_mouse_parse;
921 sp->_mouse_resume = _nc_mouse_resume;
922 sp->_mouse_wrap = _nc_mouse_wrap;
925 switch (sp->_mouse_type) {
927 TPUTS_TRACE("xterm mouse deinitialization");
928 enable_xterm_mouse(sp, 0);
932 enable_gpm_mouse(sp, 0);
937 signal(SIGUSR2, SIG_IGN);
938 sp->_mouse_active = FALSE;
948 /**************************************************************************
950 * Device-independent code
952 **************************************************************************/
955 _nc_mouse_parse(SCREEN *sp, int runcount)
956 /* parse a run of atomic mouse events into a gesture */
958 MEVENT *eventp = sp->_mouse_eventp;
959 MEVENT *ep, *runp, *next, *prev = PREV(eventp);
964 TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));
967 * When we enter this routine, the event list next-free pointer
968 * points just past a run of mouse events that we know were separated
969 * in time by less than the critical click interval. The job of this
970 * routine is to collapse this run into a single higher-level event
973 * We accomplish this in two passes. The first pass merges press/release
974 * pairs into click events. The second merges runs of click events into
975 * double or triple-click events.
977 * It's possible that the run may not resolve to a single event (for
978 * example, if the user quadruple-clicks). If so, leading events
979 * in the run are ignored.
981 * Note that this routine is independent of the format of the specific
982 * format of the pointing-device's reports. We can use it to parse
983 * gestures on anything that reports press/release events on a per-
984 * button basis, as long as the device-dependent mouse code puts stuff
985 * on the queue in MEVENT format.
989 ("_nc_mouse_parse: returning simple mouse event %s at slot %ld",
990 _nc_tracemouse(sp, prev),
991 (long) IndexEV(sp, prev)));
992 return (prev->id >= NORMAL_EVENT)
993 ? ((prev->bstate & sp->_mouse_mask) ? TRUE : FALSE)
997 /* find the start of the run */
999 for (n = runcount; n > 0; n--) {
1004 if (USE_TRACEF(TRACE_IEVENT)) {
1005 _trace_slot(sp, "before mouse press/release merge:");
1006 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1007 RunParams(sp, eventp, runp),
1009 _nc_unlock_global(tracef);
1013 /* first pass; merge press/release pairs */
1016 for (ep = runp; (next = NEXT(ep)) != eventp; ep = next) {
1018 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
1019 == !(next->bstate & MASK_RELEASE(x)))
1021 if (ep->x == next->x && ep->y == next->y
1022 && (ep->bstate & BUTTON_PRESSED)
1027 #if NCURSES_MOUSE_VERSION == 2
1031 for (b = 1; b <= MAX_BUTTONS; ++b) {
1032 if ((sp->_mouse_mask & MASK_CLICK(b))
1033 && (ep->bstate & MASK_PRESS(b))) {
1034 ep->bstate &= ~MASK_PRESS(b);
1035 ep->bstate |= MASK_CLICK(b);
1040 next->id = INVALID_EVENT;
1047 if (USE_TRACEF(TRACE_IEVENT)) {
1048 _trace_slot(sp, "before mouse click merge:");
1049 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1050 RunParams(sp, eventp, runp),
1052 _nc_unlock_global(tracef);
1057 * Second pass; merge click runs. At this point, click events are
1058 * each followed by one invalid event. We merge click events
1059 * forward in the queue.
1061 * NOTE: There is a problem with this design! If the application
1062 * allows enough click events to pile up in the circular queue so
1063 * they wrap around, it will cheerfully merge the newest forward
1064 * into the oldest, creating a bogus doubleclick and confusing
1065 * the queue-traversal logic rather badly. Generally this won't
1066 * happen, because calling getmouse() marks old events invalid and
1067 * ineligible for merges. The true solution to this problem would
1068 * be to timestamp each MEVENT and perform the obvious sanity check,
1069 * but the timer element would have to have sub-second resolution,
1070 * which would get us into portability trouble.
1076 for (ep = runp; (next = NEXT(ep)) != eventp; ep = next)
1077 if (ep->id != INVALID_EVENT) {
1078 if (next->id != INVALID_EVENT)
1080 follower = NEXT(next);
1081 if (follower->id == INVALID_EVENT)
1084 /* merge click events forward */
1085 if ((ep->bstate & BUTTON_CLICKED)
1086 && (follower->bstate & BUTTON_CLICKED)) {
1087 for (b = 1; b <= MAX_BUTTONS; ++b) {
1088 if ((sp->_mouse_mask & MASK_DOUBLE_CLICK(b))
1089 && (follower->bstate & MASK_CLICK(b))) {
1090 follower->bstate &= ~MASK_CLICK(b);
1091 follower->bstate |= MASK_DOUBLE_CLICK(b);
1096 ep->id = INVALID_EVENT;
1099 /* merge double-click events forward */
1100 if ((ep->bstate & BUTTON_DOUBLE_CLICKED)
1101 && (follower->bstate & BUTTON_CLICKED)) {
1102 for (b = 1; b <= MAX_BUTTONS; ++b) {
1103 if ((sp->_mouse_mask & MASK_TRIPLE_CLICK(b))
1104 && (follower->bstate & MASK_CLICK(b))) {
1105 follower->bstate &= ~MASK_CLICK(b);
1106 follower->bstate |= MASK_TRIPLE_CLICK(b);
1111 ep->id = INVALID_EVENT;
1118 if (USE_TRACEF(TRACE_IEVENT)) {
1119 _trace_slot(sp, "before mouse event queue compaction:");
1120 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1121 RunParams(sp, eventp, runp),
1123 _nc_unlock_global(tracef);
1128 * Now try to throw away trailing events flagged invalid, or that
1129 * don't match the current event mask.
1131 for (; runcount; prev = PREV(eventp), runcount--)
1132 if (prev->id == INVALID_EVENT || !(prev->bstate & sp->_mouse_mask)) {
1133 sp->_mouse_eventp = eventp = prev;
1136 if (USE_TRACEF(TRACE_IEVENT)) {
1137 _trace_slot(sp, "after mouse event queue compaction:");
1138 _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1139 RunParams(sp, eventp, runp),
1141 _nc_unlock_global(tracef);
1143 for (ep = runp; ep != eventp; ep = NEXT(ep))
1144 if (ep->id != INVALID_EVENT)
1146 ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
1147 _nc_tracemouse(sp, ep),
1148 (long) IndexEV(sp, ep)));
1151 /* after all this, do we have a valid event? */
1152 return (PREV(eventp)->id != INVALID_EVENT);
1156 _nc_mouse_wrap(SCREEN *sp)
1157 /* release mouse -- called by endwin() before shellout/exit */
1159 TR(MY_TRACE, ("_nc_mouse_wrap() called"));
1161 switch (sp->_mouse_type) {
1163 if (sp->_mouse_mask)
1164 mouse_activate(sp, FALSE);
1167 /* GPM: pass all mouse events to next client */
1169 if (sp->_mouse_mask)
1170 mouse_activate(sp, FALSE);
1175 mouse_activate(sp, FALSE);
1184 _nc_mouse_resume(SCREEN *sp)
1185 /* re-connect to mouse -- called by doupdate() after shellout */
1187 TR(MY_TRACE, ("_nc_mouse_resume() called"));
1189 switch (sp->_mouse_type) {
1191 /* xterm: re-enable reporting */
1192 if (sp->_mouse_mask)
1193 mouse_activate(sp, TRUE);
1198 /* GPM: reclaim our event set */
1199 if (sp->_mouse_mask)
1200 mouse_activate(sp, TRUE);
1206 mouse_activate(sp, TRUE);
1214 /**************************************************************************
1216 * Mouse interface entry points for the API
1218 **************************************************************************/
1221 _nc_getmouse(SCREEN *sp, MEVENT * aevent)
1223 T((T_CALLED("getmouse(%p)"), aevent));
1225 if ((aevent != 0) && (sp != 0) && (sp->_mouse_type != M_NONE)) {
1226 MEVENT *eventp = sp->_mouse_eventp;
1227 /* compute the current-event pointer */
1228 MEVENT *prev = PREV(eventp);
1230 /* copy the event we find there */
1233 TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
1234 _nc_tracemouse(sp, prev),
1235 (long) IndexEV(sp, prev)));
1237 prev->id = INVALID_EVENT; /* so the queue slot becomes free */
1243 /* grab a copy of the current mouse event */
1245 getmouse(MEVENT * aevent)
1247 return _nc_getmouse(SP, aevent);
1251 _nc_ungetmouse(SCREEN *sp, MEVENT * aevent)
1255 T((T_CALLED("ungetmouse(%p)"), aevent));
1257 if (aevent != 0 && sp != 0) {
1258 MEVENT *eventp = sp->_mouse_eventp;
1260 /* stick the given event in the next-free slot */
1263 /* bump the next-free pointer into the circular list */
1264 sp->_mouse_eventp = NEXT(eventp);
1266 /* push back the notification event on the keyboard queue */
1267 result = _nc_ungetch(sp, KEY_MOUSE);
1272 /* enqueue a synthesized mouse event to be seen by the next wgetch() */
1274 ungetmouse(MEVENT * aevent)
1276 return _nc_ungetmouse(SP, aevent);
1279 NCURSES_EXPORT(mmask_t)
1280 mousemask(mmask_t newmask, mmask_t * oldmask)
1281 /* set the mouse event mask */
1285 T((T_CALLED("mousemask(%#lx,%p)"), (unsigned long) newmask, oldmask));
1289 *oldmask = SP->_mouse_mask;
1291 if (newmask || SP->_mouse_initialized) {
1293 if (SP->_mouse_type != M_NONE) {
1295 (REPORT_MOUSE_POSITION
1302 | BUTTON_DOUBLE_CLICKED
1303 | BUTTON_TRIPLE_CLICKED);
1305 mouse_activate(SP, (bool) (result != 0));
1307 SP->_mouse_mask = result;
1314 NCURSES_EXPORT(bool)
1315 wenclose(const WINDOW *win, int y, int x)
1316 /* check to see if given window encloses given screen location */
1318 bool result = FALSE;
1320 T((T_CALLED("wenclose(%p,%d,%d)"), win, y, x));
1324 result = ((win->_begy <= y &&
1326 (win->_begx + win->_maxx) >= x &&
1327 (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
1333 mouseinterval(int maxclick)
1334 /* set the maximum mouse interval within which to recognize a click */
1338 T((T_CALLED("mouseinterval(%d)"), maxclick));
1341 oldval = SP->_maxclick;
1343 SP->_maxclick = maxclick;
1345 oldval = DEFAULT_MAXCLICK;
1351 /* This may be used by other routines to ask for the existence of mouse
1356 return (SP->_mouse_type == M_NONE ? 0 : 1);
1359 NCURSES_EXPORT(bool)
1360 wmouse_trafo(const WINDOW *win, int *pY, int *pX, bool to_screen)
1362 bool result = FALSE;
1364 T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"), win, pY, pX, to_screen));
1366 if (win && pY && pX) {
1371 y += win->_begy + win->_yoffset;
1373 if (wenclose(win, y, x))
1376 if (wenclose(win, y, x)) {
1377 y -= (win->_begy + win->_yoffset);