350eaa7b8c7bf49d4fb629a7d359ec55fe93a971
[ncurses.git] / ncurses / base / lib_mouse.c
1 /****************************************************************************
2  * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc.              *
3  *                                                                          *
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:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
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.                               *
22  *                                                                          *
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       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
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  ****************************************************************************/
35
36 /*
37  * This module is intended to encapsulate ncurses's interface to pointing
38  * devices.
39  *
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)
43  *      sysmouse (FreeBSD)
44  *      special-purpose mouse interface for OS/2 EMX.
45  *
46  * Notes for implementors of new mouse-interface methods:
47  *
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
51  * MEVENT structures.
52  *
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.
59  *
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).
63  *
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.
69  */
70
71 #ifdef __EMX__
72 #  include <io.h>
73 #  define  INCL_DOS
74 #  define  INCL_VIO
75 #  define  INCL_KBD
76 #  define  INCL_MOU
77 #  define  INCL_DOSPROCESS
78 #  include <os2.h>              /* Need to include before the others */
79 #endif
80
81 #include <curses.priv.h>
82
83 #ifndef CUR
84 #define CUR SP_TERMTYPE
85 #endif
86
87 MODULE_ID("$Id: lib_mouse.c,v 1.129 2011/09/17 21:52:30 tom Exp $")
88
89 #include <tic.h>
90
91 #if USE_GPM_SUPPORT
92 #include <linux/keyboard.h>     /* defines KG_* macros */
93
94 #ifdef HAVE_LIBDL
95 /* use dynamic loader to avoid linkage dependency */
96 #include <dlfcn.h>
97
98 #ifdef RTLD_NOW
99 #define my_RTLD RTLD_NOW
100 #else
101 #ifdef RTLD_LAZY
102 #define my_RTLD RTLD_LAZY
103 #else
104 make an error
105 #endif
106 #endif                          /* RTLD_NOW */
107 #endif                          /* HAVE_LIBDL */
108
109 #endif                          /* USE_GPM_SUPPORT */
110
111 #if USE_SYSMOUSE
112 #undef buttons                  /* symbol conflict in consio.h */
113 #undef mouse_info               /* symbol conflict in consio.h */
114 #include <osreldate.h>
115 #if (__FreeBSD_version >= 400017)
116 #include <sys/consio.h>
117 #include <sys/fbio.h>
118 #else
119 #include <machine/console.h>
120 #endif
121 #endif                          /* use_SYSMOUSE */
122
123 #define MY_TRACE TRACE_ICALLS|TRACE_IEVENT
124
125 #define MASK_RELEASE(x)         (mmask_t) NCURSES_MOUSE_MASK(x, 001)
126 #define MASK_PRESS(x)           (mmask_t) NCURSES_MOUSE_MASK(x, 002)
127 #define MASK_CLICK(x)           (mmask_t) NCURSES_MOUSE_MASK(x, 004)
128 #define MASK_DOUBLE_CLICK(x)    (mmask_t) NCURSES_MOUSE_MASK(x, 010)
129 #define MASK_TRIPLE_CLICK(x)    (mmask_t) NCURSES_MOUSE_MASK(x, 020)
130 #define MASK_RESERVED_EVENT(x)  (mmask_t) NCURSES_MOUSE_MASK(x, 040)
131
132 #if NCURSES_MOUSE_VERSION == 1
133 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED)
134 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED)
135 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED)
136 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED)
137 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED)
138 #define MAX_BUTTONS  4
139 #else
140 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED        | BUTTON5_CLICKED)
141 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED        | BUTTON5_PRESSED)
142 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED       | BUTTON5_RELEASED)
143 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED | BUTTON5_DOUBLE_CLICKED)
144 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED | BUTTON5_TRIPLE_CLICKED)
145 #define MAX_BUTTONS  5
146 #endif
147
148 #define INVALID_EVENT   -1
149 #define NORMAL_EVENT    0
150
151 #if USE_GPM_SUPPORT
152
153 #ifndef LIBGPM_SONAME
154 #define LIBGPM_SONAME "libgpm.so"
155 #endif
156
157 #define GET_DLSYM(name) (my_##name = (TYPE_##name) dlsym(sp->_dlopen_gpm, #name))
158
159 #endif                          /* USE_GPM_SUPPORT */
160
161 static bool _nc_mouse_parse(SCREEN *, int);
162 static void _nc_mouse_resume(SCREEN *);
163 static void _nc_mouse_wrap(SCREEN *);
164
165 /* maintain a circular list of mouse events */
166
167 #define FirstEV(sp)     ((sp)->_mouse_events)
168 #define LastEV(sp)      ((sp)->_mouse_events + EV_MAX - 1)
169
170 #undef  NEXT
171 #define NEXT(ep)        ((ep >= LastEV(SP_PARM)) \
172                          ? FirstEV(SP_PARM) \
173                          : ep + 1)
174
175 #undef  PREV
176 #define PREV(ep)        ((ep <= FirstEV(SP_PARM)) \
177                          ? LastEV(SP_PARM) \
178                          : ep - 1)
179
180 #define IndexEV(sp, ep) (ep - FirstEV(sp))
181
182 #define RunParams(sp, eventp, runp) \
183                 (long) IndexEV(sp, runp), \
184                 (long) (IndexEV(sp, eventp) + (EV_MAX - 1)) % EV_MAX
185
186 #ifdef TRACE
187 static void
188 _trace_slot(SCREEN *sp, const char *tag)
189 {
190     MEVENT *ep;
191
192     _tracef("%s", tag);
193
194     for (ep = FirstEV(sp); ep <= LastEV(sp); ep++)
195         _tracef("mouse event queue slot %ld = %s",
196                 (long) IndexEV(sp, ep),
197                 _nc_tracemouse(sp, ep));
198 }
199 #endif
200
201 #if USE_EMX_MOUSE
202
203 #  define TOP_ROW          0
204 #  define LEFT_COL         0
205
206 #  define M_FD(sp) sp->_mouse_fd
207
208 static void
209 write_event(SCREEN *sp, int down, int button, int x, int y)
210 {
211     char buf[6];
212     unsigned long ignore;
213
214     strncpy(buf, key_mouse, 3); /* should be "\033[M" */
215     buf[3] = ' ' + (button - 1) + (down ? 0 : 0x40);
216     buf[4] = ' ' + x - LEFT_COL + 1;
217     buf[5] = ' ' + y - TOP_ROW + 1;
218     DosWrite(sp->_emxmouse_wfd, buf, 6, &ignore);
219 }
220
221 static void
222 mouse_server(unsigned long param)
223 {
224     SCREEN *sp = (SCREEN *) param;
225     unsigned short fWait = MOU_WAIT;
226     /* NOPTRRECT mourt = { 0,0,24,79 }; */
227     MOUEVENTINFO mouev;
228     HMOU hmou;
229     unsigned short mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN | MOUSE_BN3_DOWN;
230     int nbuttons = 3;
231     int oldstate = 0;
232     char err[80];
233     unsigned long rc;
234
235     /* open the handle for the mouse */
236     if (MouOpen(NULL, &hmou) == 0) {
237         rc = MouSetEventMask(&mask, hmou);
238         if (rc) {               /* retry with 2 buttons */
239             mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN;
240             rc = MouSetEventMask(&mask, hmou);
241             nbuttons = 2;
242         }
243         if (rc == 0 && MouDrawPtr(hmou) == 0) {
244             for (;;) {
245                 /* sit and wait on the event queue */
246                 rc = MouReadEventQue(&mouev, &fWait, hmou);
247                 if (rc) {
248                     sprintf(err, "Error reading mouse queue, rc=%lu.\r\n", rc);
249                     break;
250                 }
251                 if (!sp->_emxmouse_activated)
252                     goto finish;
253
254                 /*
255                  * OS/2 numbers a 3-button mouse inconsistently from other
256                  * platforms:
257                  *      1 = left
258                  *      2 = right
259                  *      3 = middle.
260                  */
261                 if ((mouev.fs ^ oldstate) & MOUSE_BN1_DOWN)
262                     write_event(sp, mouev.fs & MOUSE_BN1_DOWN,
263                                 sp->_emxmouse_buttons[1], mouev.col, mouev.row);
264                 if ((mouev.fs ^ oldstate) & MOUSE_BN2_DOWN)
265                     write_event(sp, mouev.fs & MOUSE_BN2_DOWN,
266                                 sp->_emxmouse_buttons[3], mouev.col, mouev.row);
267                 if ((mouev.fs ^ oldstate) & MOUSE_BN3_DOWN)
268                     write_event(sp, mouev.fs & MOUSE_BN3_DOWN,
269                                 sp->_emxmouse_buttons[2], mouev.col, mouev.row);
270
271               finish:
272                 oldstate = mouev.fs;
273             }
274         } else
275             sprintf(err, "Error setting event mask, buttons=%d, rc=%lu.\r\n",
276                     nbuttons, rc);
277
278         DosWrite(2, err, strlen(err), &rc);
279         MouClose(hmou);
280     }
281     DosExit(EXIT_THREAD, 0L);
282 }
283
284 #endif /* USE_EMX_MOUSE */
285
286 #if USE_SYSMOUSE
287 static void
288 sysmouse_server(SCREEN *sp)
289 {
290     struct mouse_info the_mouse;
291     MEVENT *work;
292
293     the_mouse.operation = MOUSE_GETINFO;
294     if (sp != 0
295         && sp->_mouse_fd >= 0
296         && sp->_sysmouse_tail < FIFO_SIZE
297         && ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
298
299         if (sp->_sysmouse_head > sp->_sysmouse_tail) {
300             sp->_sysmouse_tail = 0;
301             sp->_sysmouse_head = 0;
302         }
303         work = &(sp->_sysmouse_fifo[sp->_sysmouse_tail]);
304         memset(work, 0, sizeof(*work));
305         work->id = NORMAL_EVENT;        /* there's only one mouse... */
306
307         sp->_sysmouse_old_buttons = sp->_sysmouse_new_buttons;
308         sp->_sysmouse_new_buttons = the_mouse.u.data.buttons & 0x7;
309
310         if (sp->_sysmouse_new_buttons) {
311             if (sp->_sysmouse_new_buttons & 1)
312                 work->bstate |= BUTTON1_PRESSED;
313             if (sp->_sysmouse_new_buttons & 2)
314                 work->bstate |= BUTTON2_PRESSED;
315             if (sp->_sysmouse_new_buttons & 4)
316                 work->bstate |= BUTTON3_PRESSED;
317         } else {
318             if (sp->_sysmouse_old_buttons & 1)
319                 work->bstate |= BUTTON1_RELEASED;
320             if (sp->_sysmouse_old_buttons & 2)
321                 work->bstate |= BUTTON2_RELEASED;
322             if (sp->_sysmouse_old_buttons & 4)
323                 work->bstate |= BUTTON3_RELEASED;
324         }
325
326         /* for cosmetic bug in syscons.c on FreeBSD 3.[34] */
327         the_mouse.operation = MOUSE_HIDE;
328         ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
329         the_mouse.operation = MOUSE_SHOW;
330         ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
331
332         /*
333          * We're only interested if the button is pressed or released.
334          * FIXME: implement continuous event-tracking.
335          */
336         if (sp->_sysmouse_new_buttons != sp->_sysmouse_old_buttons) {
337             sp->_sysmouse_tail += 1;
338         }
339         work->x = the_mouse.u.data.x / sp->_sysmouse_char_width;
340         work->y = the_mouse.u.data.y / sp->_sysmouse_char_height;
341     }
342 }
343
344 static void
345 handle_sysmouse(int sig GCC_UNUSED)
346 {
347     sysmouse_server(CURRENT_SCREEN);
348 }
349 #endif /* USE_SYSMOUSE */
350
351 #ifndef USE_TERM_DRIVER
352 #define xterm_kmous "\033[M"
353
354 static void
355 init_xterm_mouse(SCREEN *sp)
356 {
357     sp->_mouse_type = M_XTERM;
358     sp->_mouse_xtermcap = tigetstr("XM");
359     if (!VALID_STRING(sp->_mouse_xtermcap))
360         sp->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
361 }
362 #endif
363
364 static void
365 enable_xterm_mouse(SCREEN *sp, int enable)
366 {
367 #if USE_EMX_MOUSE
368     sp->_emxmouse_activated = enable;
369 #else
370     NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
371                                "xterm-mouse",
372                                TPARM_1(sp->_mouse_xtermcap, enable));
373 #endif
374     sp->_mouse_active = enable;
375 }
376
377 #if USE_GPM_SUPPORT
378 static bool
379 allow_gpm_mouse(void)
380 {
381     bool result = FALSE;
382
383     /* GPM does printf's without checking if stdout is a terminal */
384     if (isatty(fileno(stdout))) {
385         char *list = getenv("NCURSES_GPM_TERMS");
386         char *env = getenv("TERM");
387         if (list != 0) {
388             if (env != 0) {
389                 result = _nc_name_match(list, env, "|:");
390             }
391         } else {
392             /* GPM checks the beginning of the $TERM variable to decide if it
393              * should pass xterm events through.  There is no real advantage in
394              * allowing GPM to do this.  Recent versions relax that check, and
395              * pretend that GPM can work with any terminal having the kmous
396              * capability.  Perhaps that works for someone.  If so, they can
397              * set the environment variable (above).
398              */
399             if (env != 0 && strstr(env, "linux") != 0) {
400                 result = TRUE;
401             }
402         }
403     }
404     return result;
405 }
406
407 #ifdef HAVE_LIBDL
408 static void
409 unload_gpm_library(SCREEN *sp)
410 {
411     if (sp->_dlopen_gpm != 0) {
412         T(("unload GPM library"));
413         sp->_mouse_gpm_loaded = FALSE;
414         sp->_mouse_fd = -1;
415         dlclose(sp->_dlopen_gpm);
416         sp->_dlopen_gpm = 0;
417     }
418 }
419
420 static void
421 load_gpm_library(SCREEN *sp)
422 {
423     sp->_mouse_gpm_found = FALSE;
424     if ((sp->_dlopen_gpm = dlopen(LIBGPM_SONAME, my_RTLD)) != 0) {
425         if (GET_DLSYM(gpm_fd) == 0 ||
426             GET_DLSYM(Gpm_Open) == 0 ||
427             GET_DLSYM(Gpm_Close) == 0 ||
428             GET_DLSYM(Gpm_GetEvent) == 0) {
429             T(("GPM initialization failed: %s", dlerror()));
430             unload_gpm_library(sp);
431         } else {
432             sp->_mouse_gpm_found = TRUE;
433             sp->_mouse_gpm_loaded = TRUE;
434         }
435     }
436 }
437 #endif
438
439 static bool
440 enable_gpm_mouse(SCREEN *sp, bool enable)
441 {
442     bool result;
443
444     T((T_CALLED("enable_gpm_mouse(%d)"), enable));
445
446     if (enable && !sp->_mouse_active) {
447 #ifdef HAVE_LIBDL
448         if (sp->_mouse_gpm_found && !sp->_mouse_gpm_loaded) {
449             load_gpm_library(sp);
450         }
451 #endif
452         if (sp->_mouse_gpm_loaded) {
453             int code;
454
455             /* GPM: initialize connection to gpm server */
456             sp->_mouse_gpm_connect.eventMask = GPM_DOWN | GPM_UP;
457             sp->_mouse_gpm_connect.defaultMask =
458                 (unsigned short) (~(sp->_mouse_gpm_connect.eventMask | GPM_HARD));
459             sp->_mouse_gpm_connect.minMod = 0;
460             sp->_mouse_gpm_connect.maxMod =
461                 (unsigned short) (~((1 << KG_SHIFT) |
462                                     (1 << KG_SHIFTL) |
463                                     (1 << KG_SHIFTR)));
464             /*
465              * Note: GPM hardcodes \E[?1001s and \E[?1000h during its open.
466              * The former is recognized by wscons (SunOS), and the latter by
467              * xterm.  Those will not show up in ncurses' traces.
468              */
469             code = my_Gpm_Open(&sp->_mouse_gpm_connect, 0);
470             result = (code >= 0);
471
472             /*
473              * GPM can return a -2 if it is trying to do something with xterm.
474              * Ignore that, since it conflicts with our use of stdin.
475              */
476             if (code == -2) {
477                 my_Gpm_Close();
478             }
479         } else {
480             result = FALSE;
481         }
482         sp->_mouse_active = result;
483         T(("GPM open %s", result ? "succeeded" : "failed"));
484     } else {
485         if (!enable && sp->_mouse_active) {
486             /* GPM: close connection to gpm server */
487             my_Gpm_Close();
488             sp->_mouse_active = FALSE;
489             T(("GPM closed"));
490         }
491         result = enable;
492     }
493 #ifdef HAVE_LIBDL
494     if (!result) {
495         unload_gpm_library(sp);
496     }
497 #endif
498     returnBool(result);
499 }
500 #endif /* USE_GPM_SUPPORT */
501
502 static void
503 initialize_mousetype(SCREEN *sp)
504 {
505     T((T_CALLED("initialize_mousetype()")));
506
507     /* Try gpm first, because gpm may be configured to run in xterm */
508 #if USE_GPM_SUPPORT
509     if (allow_gpm_mouse()) {
510         if (!sp->_mouse_gpm_loaded) {
511 #ifdef HAVE_LIBDL
512             load_gpm_library(sp);
513 #else /* !HAVE_LIBDL */
514             sp->_mouse_gpm_found = TRUE;
515             sp->_mouse_gpm_loaded = TRUE;
516 #endif
517         }
518
519         /*
520          * The gpm_fd file-descriptor may be negative (xterm).  So we have to
521          * maintain our notion of whether the mouse connection is active
522          * without testing the file-descriptor.
523          */
524         if (sp->_mouse_gpm_found && enable_gpm_mouse(sp, TRUE)) {
525             sp->_mouse_type = M_GPM;
526             sp->_mouse_fd = *(my_gpm_fd);
527             T(("GPM mouse_fd %d", sp->_mouse_fd));
528             returnVoid;
529         }
530     }
531 #endif /* USE_GPM_SUPPORT */
532
533     /* OS/2 VIO */
534 #if USE_EMX_MOUSE
535     if (!sp->_emxmouse_thread
536         && strstr(TerminalOf(sp)->type.term_names, "xterm") == 0
537         && key_mouse) {
538         int handles[2];
539
540         if (pipe(handles) < 0) {
541             perror("mouse pipe error");
542             returnVoid;
543         } else {
544             int rc;
545
546             if (!sp->_emxmouse_buttons[0]) {
547                 char *s = getenv("MOUSE_BUTTONS_123");
548
549                 sp->_emxmouse_buttons[0] = 1;
550                 if (s && strlen(s) >= 3) {
551                     sp->_emxmouse_buttons[1] = s[0] - '0';
552                     sp->_emxmouse_buttons[2] = s[1] - '0';
553                     sp->_emxmouse_buttons[3] = s[2] - '0';
554                 } else {
555                     sp->_emxmouse_buttons[1] = 1;
556                     sp->_emxmouse_buttons[2] = 3;
557                     sp->_emxmouse_buttons[3] = 2;
558                 }
559             }
560             sp->_emxmouse_wfd = handles[1];
561             M_FD(sp) = handles[0];
562             /* Needed? */
563             setmode(handles[0], O_BINARY);
564             setmode(handles[1], O_BINARY);
565             /* Do not use CRT functions, we may single-threaded. */
566             rc = DosCreateThread((unsigned long *) &sp->_emxmouse_thread,
567                                  mouse_server, (long) sp, 0, 8192);
568             if (rc) {
569                 printf("mouse thread error %d=%#x", rc, rc);
570             } else {
571                 sp->_mouse_type = M_XTERM;
572             }
573             returnVoid;
574         }
575     }
576 #endif /* USE_EMX_MOUSE */
577
578 #if USE_SYSMOUSE
579     {
580         struct mouse_info the_mouse;
581         char *the_device = 0;
582
583         if (isatty(sp->_ifd))
584             the_device = ttyname(sp->_ifd);
585         if (the_device == 0)
586             the_device = "/dev/tty";
587
588         sp->_mouse_fd = open(the_device, O_RDWR);
589
590         if (sp->_mouse_fd >= 0) {
591             /*
592              * sysmouse does not have a usable user interface for obtaining
593              * mouse events.  The logical way to proceed (reading data on a
594              * stream) only works if one opens the device as root.  Even in
595              * that mode, careful examination shows we lose events
596              * occasionally.  The interface provided for user programs is to
597              * establish a signal handler.  really.
598              *
599              * Take over SIGUSR2 for this purpose since SIGUSR1 is more
600              * likely to be used by an application.  getch() will have to
601              * handle the misleading EINTR's.
602              */
603             signal(SIGUSR2, SIG_IGN);
604             the_mouse.operation = MOUSE_MODE;
605             the_mouse.u.mode.mode = 0;
606             the_mouse.u.mode.signal = SIGUSR2;
607             if (ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
608                 signal(SIGUSR2, handle_sysmouse);
609                 the_mouse.operation = MOUSE_SHOW;
610                 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
611
612 #if defined(FBIO_MODEINFO) || defined(CONS_MODEINFO)    /* FreeBSD > 2.x */
613                 {
614 #ifndef FBIO_GETMODE            /* FreeBSD 3.x */
615 #define FBIO_GETMODE    CONS_GET
616 #define FBIO_MODEINFO   CONS_MODEINFO
617 #endif /* FBIO_GETMODE */
618                     video_info_t the_video;
619
620                     if (ioctl(sp->_mouse_fd,
621                               FBIO_GETMODE,
622                               &the_video.vi_mode) != -1
623                         && ioctl(sp->_mouse_fd,
624                                  FBIO_MODEINFO,
625                                  &the_video) != -1) {
626                         sp->_sysmouse_char_width = the_video.vi_cwidth;
627                         sp->_sysmouse_char_height = the_video.vi_cheight;
628                     }
629                 }
630 #endif /* defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) */
631
632                 if (sp->_sysmouse_char_width <= 0)
633                     sp->_sysmouse_char_width = 8;
634                 if (sp->_sysmouse_char_height <= 0)
635                     sp->_sysmouse_char_height = 16;
636                 sp->_mouse_type = M_SYSMOUSE;
637                 returnVoid;
638             }
639         }
640     }
641 #endif /* USE_SYSMOUSE */
642
643 #ifdef USE_TERM_DRIVER
644     CallDriver(sp, initmouse);
645 #else
646     /* we know how to recognize mouse events under "xterm" */
647     if (key_mouse != 0) {
648         if (!strcmp(key_mouse, xterm_kmous)
649             || strstr(TerminalOf(sp)->type.term_names, "xterm") != 0) {
650             init_xterm_mouse(sp);
651         }
652     } else if (strstr(TerminalOf(sp)->type.term_names, "xterm") != 0) {
653         if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
654             init_xterm_mouse(sp);
655     }
656 #endif
657
658     returnVoid;
659 }
660
661 static bool
662 _nc_mouse_init(SCREEN *sp)
663 /* initialize the mouse */
664 {
665     bool result = FALSE;
666     int i;
667
668     if (sp != 0) {
669         if (!sp->_mouse_initialized) {
670             sp->_mouse_initialized = TRUE;
671
672             TR(MY_TRACE, ("_nc_mouse_init() called"));
673
674             sp->_mouse_eventp = FirstEV(sp);
675             for (i = 0; i < EV_MAX; i++)
676                 sp->_mouse_events[i].id = INVALID_EVENT;
677
678             initialize_mousetype(sp);
679
680             T(("_nc_mouse_init() set mousetype to %d", sp->_mouse_type));
681         }
682         result = sp->_mouse_initialized;
683     }
684     return result;
685 }
686
687 /*
688  * Query to see if there is a pending mouse event.  This is called from
689  * fifo_push() in lib_getch.c
690  */
691 static bool
692 _nc_mouse_event(SCREEN *sp)
693 {
694     MEVENT *eventp = sp->_mouse_eventp;
695     bool result = FALSE;
696
697     (void) eventp;
698
699     switch (sp->_mouse_type) {
700     case M_XTERM:
701         /* xterm: never have to query, mouse events are in the keyboard stream */
702 #if USE_EMX_MOUSE
703         {
704             char kbuf[3];
705
706             int i, res = read(M_FD(sp), &kbuf, 3);      /* Eat the prefix */
707             if (res != 3)
708                 printf("Got %d chars instead of 3 for prefix.\n", res);
709             for (i = 0; i < res; i++) {
710                 if (kbuf[i] != key_mouse[i])
711                     printf("Got char %d instead of %d for prefix.\n",
712                            (int) kbuf[i], (int) key_mouse[i]);
713             }
714             result = TRUE;
715         }
716 #endif /* USE_EMX_MOUSE */
717         break;
718
719 #if USE_GPM_SUPPORT
720     case M_GPM:
721         if (sp->_mouse_fd >= 0) {
722             /* query server for event, return TRUE if we find one */
723             Gpm_Event ev;
724
725             switch (my_Gpm_GetEvent(&ev)) {
726             case 0:
727                 /* Connection closed, drop the mouse. */
728                 sp->_mouse_fd = -1;
729                 break;
730             case 1:
731                 /* there's only one mouse... */
732                 eventp->id = NORMAL_EVENT;
733
734                 eventp->bstate = 0;
735                 switch (ev.type & 0x0f) {
736                 case (GPM_DOWN):
737                     if (ev.buttons & GPM_B_LEFT)
738                         eventp->bstate |= BUTTON1_PRESSED;
739                     if (ev.buttons & GPM_B_MIDDLE)
740                         eventp->bstate |= BUTTON2_PRESSED;
741                     if (ev.buttons & GPM_B_RIGHT)
742                         eventp->bstate |= BUTTON3_PRESSED;
743                     break;
744                 case (GPM_UP):
745                     if (ev.buttons & GPM_B_LEFT)
746                         eventp->bstate |= BUTTON1_RELEASED;
747                     if (ev.buttons & GPM_B_MIDDLE)
748                         eventp->bstate |= BUTTON2_RELEASED;
749                     if (ev.buttons & GPM_B_RIGHT)
750                         eventp->bstate |= BUTTON3_RELEASED;
751                     break;
752                 default:
753                     eventp->bstate |= REPORT_MOUSE_POSITION;
754                     break;
755                 }
756
757                 eventp->x = ev.x - 1;
758                 eventp->y = ev.y - 1;
759                 eventp->z = 0;
760
761                 /* bump the next-free pointer into the circular list */
762                 sp->_mouse_eventp = NEXT(eventp);
763                 result = TRUE;
764                 break;
765             }
766         }
767         break;
768 #endif
769
770 #if USE_SYSMOUSE
771     case M_SYSMOUSE:
772         if (sp->_sysmouse_head < sp->_sysmouse_tail) {
773             *eventp = sp->_sysmouse_fifo[sp->_sysmouse_head];
774
775             /*
776              * Point the fifo-head to the next possible location.  If there
777              * are none, reset the indices.  This may be interrupted by the
778              * signal handler, doing essentially the same reset.
779              */
780             sp->_sysmouse_head += 1;
781             if (sp->_sysmouse_head == sp->_sysmouse_tail) {
782                 sp->_sysmouse_tail = 0;
783                 sp->_sysmouse_head = 0;
784             }
785
786             /* bump the next-free pointer into the circular list */
787             sp->_mouse_eventp = eventp = NEXT(eventp);
788             result = TRUE;
789         }
790         break;
791 #endif /* USE_SYSMOUSE */
792
793 #ifdef USE_TERM_DRIVER
794     case M_TERM_DRIVER:
795         while (sp->_drv_mouse_head < sp->_drv_mouse_tail) {
796             *eventp = sp->_drv_mouse_fifo[sp->_drv_mouse_head];
797
798             /*
799              * Point the fifo-head to the next possible location.  If there
800              * are none, reset the indices.
801              */
802             sp->_drv_mouse_head += 1;
803             if (sp->_drv_mouse_head == sp->_drv_mouse_tail) {
804                 sp->_drv_mouse_tail = 0;
805                 sp->_drv_mouse_head = 0;
806             }
807
808             /* bump the next-free pointer into the circular list */
809             sp->_mouse_eventp = eventp = NEXT(eventp);
810             result = TRUE;
811         }
812         break;
813 #endif
814
815     case M_NONE:
816         break;
817     }
818
819     return result;              /* true if we found an event */
820 }
821
822 static bool
823 _nc_mouse_inline(SCREEN *sp)
824 /* mouse report received in the keyboard stream -- parse its info */
825 {
826     int b;
827     bool result = FALSE;
828     MEVENT *eventp = sp->_mouse_eventp;
829
830     TR(MY_TRACE, ("_nc_mouse_inline() called"));
831
832     if (sp->_mouse_type == M_XTERM) {
833         unsigned char kbuf[4];
834         size_t grabbed;
835         int res;
836
837         /* This code requires that your xterm entry contain the kmous
838          * capability and that it be set to the \E[M documented in the
839          * Xterm Control Sequences reference.  This is how we
840          * arrange for mouse events to be reported via a KEY_MOUSE
841          * return value from wgetch().  After this value is received,
842          * _nc_mouse_inline() gets called and is immediately
843          * responsible for parsing the mouse status information
844          * following the prefix.
845          *
846          * The following quotes from the ctrlseqs.ms document in the
847          * X distribution, describing the X mouse tracking feature:
848          *
849          * Parameters for all mouse tracking escape sequences
850          * generated by xterm encode numeric parameters in a single
851          * character as value+040.  For example, !  is 1.
852          *
853          * On button press or release, xterm sends ESC [ M CbCxCy.
854          * The low two bits of Cb encode button information: 0=MB1
855          * pressed, 1=MB2 pressed, 2=MB3 pressed, 3=release.  The
856          * upper bits encode what modifiers were down when the
857          * button was pressed and are added together.  4=Shift,
858          * 8=Meta, 16=Control.  Cx and Cy are the x and y coordinates
859          * of the mouse event.  The upper left corner is (1,1).
860          *
861          * (End quote)  By the time we get here, we've eaten the
862          * key prefix.  FYI, the loop below is necessary because
863          * mouse click info isn't guaranteed to present as a
864          * single clist item.
865          *
866          * Wheel mice may return buttons 4 and 5 when the wheel is turned.
867          * We encode those as button presses.
868          */
869 # if USE_PTHREADS_EINTR
870 #  if USE_WEAK_SYMBOLS
871         if ((pthread_self) && (pthread_kill) && (pthread_equal))
872 #  endif
873             _nc_globals.read_thread = pthread_self();
874 # endif
875         for (grabbed = 0; grabbed < 3; grabbed += (size_t) res) {
876
877             /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
878 #if USE_EMX_MOUSE
879             res = (int) read(M_FD(sp) >= 0 ? M_FD(sp) : sp->_ifd, &kbuf, 3);
880 #else
881             res = (int) read(sp->_ifd, kbuf + grabbed, 3 - grabbed);
882 #endif
883             if (res == -1)
884                 break;
885         }
886 #if USE_PTHREADS_EINTR
887         _nc_globals.read_thread = 0;
888 #endif
889         kbuf[3] = '\0';
890
891         TR(TRACE_IEVENT,
892            ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
893
894         /* there's only one mouse... */
895         eventp->id = NORMAL_EVENT;
896
897         /* processing code goes here */
898         eventp->bstate = 0;
899
900 #if USE_EMX_MOUSE
901 #define PRESS_POSITION(n) \
902         do { \
903                 eventp->bstate = MASK_PRESS(n); \
904                 sp->_mouse_bstate |= MASK_PRESS(n); \
905                 if (kbuf[0] & 0x40) { \
906                         eventp->bstate = MASK_RELEASE(n); \
907                         sp->_mouse_bstate &= ~MASK_PRESS(n); \
908                 } \
909         } while (0)
910 #else
911 #define PRESS_POSITION(n) \
912         do { \
913                 eventp->bstate = (mmask_t) (sp->_mouse_bstate & MASK_PRESS(n) \
914                                         ? REPORT_MOUSE_POSITION \
915                                         : MASK_PRESS(n)); \
916                 sp->_mouse_bstate |= MASK_PRESS(n); \
917         } while (0)
918 #endif
919
920         switch (kbuf[0] & 0x3) {
921         case 0x0:
922             if ((kbuf[0] & 96) == 96) {
923                 eventp->bstate = MASK_PRESS(4);
924                 /* Do not record in sp->_mouse_bstate; there will be no
925                  * corresponding release event.
926                  */
927             } else {
928                 PRESS_POSITION(1);
929             }
930             break;
931
932         case 0x1:
933             if ((kbuf[0] & 96) == 96) {
934 #if NCURSES_MOUSE_VERSION == 2
935                 eventp->bstate = MASK_PRESS(5);
936                 /* See comment above for button 4 */
937 #else
938                 /* Ignore this event as it is not a true press of the button */
939                 eventp->bstate = REPORT_MOUSE_POSITION;
940 #endif
941             } else {
942                 PRESS_POSITION(2);
943             }
944             break;
945
946         case 0x2:
947             PRESS_POSITION(3);
948             break;
949
950         case 0x3:
951             /*
952              * Release events aren't reported for individual buttons, just for
953              * the button set as a whole.  However, because there are normally
954              * no mouse events under xterm that intervene between press and
955              * release, we can infer the button actually released by looking at
956              * the previous event.
957              */
958             if (sp->_mouse_bstate & BUTTON_PRESSED) {
959                 eventp->bstate = BUTTON_RELEASED;
960                 for (b = 1; b <= MAX_BUTTONS; ++b) {
961                     if (!(sp->_mouse_bstate & MASK_PRESS(b)))
962                         eventp->bstate &= ~MASK_RELEASE(b);
963                 }
964                 sp->_mouse_bstate = 0;
965             } else {
966                 /*
967                  * XFree86 xterm will return a stream of release-events to
968                  * let the application know where the mouse is going, if the
969                  * private mode 1002 or 1003 is enabled.
970                  */
971                 eventp->bstate = REPORT_MOUSE_POSITION;
972             }
973             break;
974         }
975         result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
976
977         if (kbuf[0] & 4) {
978             eventp->bstate |= BUTTON_SHIFT;
979         }
980         if (kbuf[0] & 8) {
981             eventp->bstate |= BUTTON_ALT;
982         }
983         if (kbuf[0] & 16) {
984             eventp->bstate |= BUTTON_CTRL;
985         }
986
987         eventp->x = (kbuf[1] - ' ') - 1;
988         eventp->y = (kbuf[2] - ' ') - 1;
989         TR(MY_TRACE,
990            ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
991             _nc_tracemouse(sp, eventp),
992             (long) IndexEV(sp, eventp)));
993
994         /* bump the next-free pointer into the circular list */
995         sp->_mouse_eventp = NEXT(eventp);
996 #if 0                           /* this return would be needed for QNX's mods to lib_getch.c */
997         return (TRUE);
998 #endif
999     }
1000
1001     return (result);
1002 }
1003
1004 static void
1005 mouse_activate(SCREEN *sp, bool on)
1006 {
1007     if (!on && !sp->_mouse_initialized)
1008         return;
1009
1010     if (!_nc_mouse_init(sp))
1011         return;
1012
1013     if (on) {
1014         sp->_mouse_bstate = 0;
1015         switch (sp->_mouse_type) {
1016         case M_XTERM:
1017 #if NCURSES_EXT_FUNCS
1018             NCURSES_SP_NAME(keyok) (NCURSES_SP_ARGx KEY_MOUSE, on);
1019 #endif
1020             TPUTS_TRACE("xterm mouse initialization");
1021             enable_xterm_mouse(sp, 1);
1022             break;
1023 #if USE_GPM_SUPPORT
1024         case M_GPM:
1025             if (enable_gpm_mouse(sp, TRUE)) {
1026                 sp->_mouse_fd = *(my_gpm_fd);
1027                 T(("GPM mouse_fd %d", sp->_mouse_fd));
1028             }
1029             break;
1030 #endif
1031 #if USE_SYSMOUSE
1032         case M_SYSMOUSE:
1033             signal(SIGUSR2, handle_sysmouse);
1034             sp->_mouse_active = TRUE;
1035             break;
1036 #endif
1037 #ifdef USE_TERM_DRIVER
1038         case M_TERM_DRIVER:
1039             sp->_mouse_active = TRUE;
1040             break;
1041 #endif
1042         case M_NONE:
1043             return;
1044         }
1045         /* Make runtime binding to cut down on object size of applications that
1046          * do not use the mouse (e.g., 'clear').
1047          */
1048         sp->_mouse_event = _nc_mouse_event;
1049         sp->_mouse_inline = _nc_mouse_inline;
1050         sp->_mouse_parse = _nc_mouse_parse;
1051         sp->_mouse_resume = _nc_mouse_resume;
1052         sp->_mouse_wrap = _nc_mouse_wrap;
1053     } else {
1054
1055         switch (sp->_mouse_type) {
1056         case M_XTERM:
1057             TPUTS_TRACE("xterm mouse deinitialization");
1058             enable_xterm_mouse(sp, 0);
1059             break;
1060 #if USE_GPM_SUPPORT
1061         case M_GPM:
1062             enable_gpm_mouse(sp, FALSE);
1063             break;
1064 #endif
1065 #if USE_SYSMOUSE
1066         case M_SYSMOUSE:
1067             signal(SIGUSR2, SIG_IGN);
1068             sp->_mouse_active = FALSE;
1069             break;
1070 #endif
1071 #ifdef USE_TERM_DRIVER
1072         case M_TERM_DRIVER:
1073             sp->_mouse_active = FALSE;
1074             break;
1075 #endif
1076         case M_NONE:
1077             return;
1078         }
1079     }
1080     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1081 }
1082
1083 /**************************************************************************
1084  *
1085  * Device-independent code
1086  *
1087  **************************************************************************/
1088
1089 static bool
1090 _nc_mouse_parse(SCREEN *sp, int runcount)
1091 /* parse a run of atomic mouse events into a gesture */
1092 {
1093     MEVENT *eventp = sp->_mouse_eventp;
1094     MEVENT *next, *ep;
1095     MEVENT *first_valid = NULL;
1096     MEVENT *first_invalid = NULL;
1097     int n;
1098     int b;
1099     bool merge;
1100     bool endLoop;
1101
1102     TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));
1103
1104     /*
1105      * When we enter this routine, the event list next-free pointer
1106      * points just past a run of mouse events that we know were separated
1107      * in time by less than the critical click interval. The job of this
1108      * routine is to collapse this run into a single higher-level event
1109      * or gesture.
1110      *
1111      * We accomplish this in two passes.  The first pass merges press/release
1112      * pairs into click events.  The second merges runs of click events into
1113      * double or triple-click events.
1114      *
1115      * It's possible that the run may not resolve to a single event (for
1116      * example, if the user quadruple-clicks).  If so, leading events
1117      * in the run are ignored if user does not call getmouse in a loop (getting
1118      * them from newest to older).
1119      *
1120      * Note that this routine is independent of the format of the specific
1121      * format of the pointing-device's reports.  We can use it to parse
1122      * gestures on anything that reports press/release events on a per-
1123      * button basis, as long as the device-dependent mouse code puts stuff
1124      * on the queue in MEVENT format.
1125      */
1126
1127     /*
1128      * Reset all events that were not set, in case the user sometimes calls
1129      * getmouse only once and other times until there are no more events in
1130      * queue.
1131      *
1132      * This also allows reaching the beginning of the run.
1133      */
1134     ep = eventp;
1135     for (n = runcount; n < EV_MAX; n++) {
1136         ep->id = INVALID_EVENT;
1137         ep = NEXT(ep);
1138     }
1139
1140 #ifdef TRACE
1141     if (USE_TRACEF(TRACE_IEVENT)) {
1142         _trace_slot(sp, "before mouse press/release merge:");
1143         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1144                 RunParams(sp, eventp, ep),
1145                 runcount);
1146         _nc_unlock_global(tracef);
1147     }
1148 #endif /* TRACE */
1149
1150     /* first pass; merge press/release pairs */
1151     endLoop = FALSE;
1152     while (!endLoop) {
1153         next = NEXT(ep);
1154         if (next == eventp) {
1155             /* Will end the loop, but compact before */
1156             endLoop = TRUE;
1157         } else {
1158
1159 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
1160                       == !(next->bstate & MASK_RELEASE(x)))
1161
1162             if (ep->id != INVALID_EVENT && next->id != INVALID_EVENT
1163                 && ep->x == next->x && ep->y == next->y
1164                 && (ep->bstate & BUTTON_PRESSED)
1165                 && (!(next->bstate & BUTTON_PRESSED))) {
1166                 bool changed = TRUE;
1167
1168                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1169                     if (!MASK_CHANGED(b)) {
1170                         changed = FALSE;
1171                         break;
1172                     }
1173                 }
1174
1175                 if (changed) {
1176                     merge = FALSE;
1177                     for (b = 1; b <= MAX_BUTTONS; ++b) {
1178                         if ((sp->_mouse_mask & MASK_CLICK(b))
1179                             && (ep->bstate & MASK_PRESS(b))) {
1180                             next->bstate &= ~MASK_RELEASE(b);
1181                             next->bstate |= MASK_CLICK(b);
1182                             merge = TRUE;
1183                         }
1184                     }
1185                     if (merge)
1186                         ep->id = INVALID_EVENT;
1187                 }
1188             }
1189         }
1190
1191         /* Compact valid events */
1192         if (ep->id == INVALID_EVENT) {
1193             if ((first_valid != NULL) && (first_invalid == NULL)) {
1194                 first_invalid = ep;
1195             }
1196         } else {
1197             if (first_valid == NULL) {
1198                 first_valid = ep;
1199             } else if (first_invalid != NULL) {
1200                 *first_invalid = *ep;
1201                 ep->id = INVALID_EVENT;
1202                 first_invalid = NEXT(first_invalid);
1203             }
1204         }
1205
1206         ep = next;
1207     }
1208
1209     if (first_invalid != NULL) {
1210         eventp = first_invalid;
1211     }
1212 #ifdef TRACE
1213     if (USE_TRACEF(TRACE_IEVENT)) {
1214         _trace_slot(sp, "before mouse click merge:");
1215         if (first_valid == NULL) {
1216             _tracef("_nc_mouse_parse: no valid event");
1217         } else {
1218             _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1219                     RunParams(sp, eventp, first_valid),
1220                     runcount);
1221             _nc_unlock_global(tracef);
1222         }
1223     }
1224 #endif /* TRACE */
1225
1226     /*
1227      * Second pass; merge click runs.  We merge click events forward in the
1228      * queue.  For example, double click can be changed to triple click.
1229      *
1230      * NOTE: There is a problem with this design!  If the application
1231      * allows enough click events to pile up in the circular queue so
1232      * they wrap around, it will cheerfully merge the newest forward
1233      * into the oldest, creating a bogus doubleclick and confusing
1234      * the queue-traversal logic rather badly.  Generally this won't
1235      * happen, because calling getmouse() marks old events invalid and
1236      * ineligible for merges.  The true solution to this problem would
1237      * be to timestamp each MEVENT and perform the obvious sanity check,
1238      * but the timer element would have to have sub-second resolution,
1239      * which would get us into portability trouble.
1240      */
1241     first_invalid = NULL;
1242     endLoop = (first_valid == NULL);
1243     ep = first_valid;
1244     while (!endLoop) {
1245         next = NEXT(ep);
1246
1247         if (next == eventp) {
1248             /* Will end the loop, but check event type and compact before */
1249             endLoop = true;
1250         } else {
1251             /* merge click events forward */
1252             if ((ep->bstate & BUTTON_CLICKED)
1253                 && (next->bstate & BUTTON_CLICKED)) {
1254                 merge = FALSE;
1255                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1256                     if ((sp->_mouse_mask & MASK_DOUBLE_CLICK(b))
1257                         && (ep->bstate & MASK_CLICK(b))
1258                         && (next->bstate & MASK_CLICK(b))) {
1259                         next->bstate &= ~MASK_CLICK(b);
1260                         next->bstate |= MASK_DOUBLE_CLICK(b);
1261                         merge = TRUE;
1262                     }
1263                 }
1264                 if (merge)
1265                     ep->id = INVALID_EVENT;
1266             }
1267
1268             /* merge double-click events forward */
1269             if ((ep->bstate & BUTTON_DOUBLE_CLICKED)
1270                 && (next->bstate & BUTTON_CLICKED)) {
1271                 merge = FALSE;
1272                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1273                     if ((sp->_mouse_mask & MASK_TRIPLE_CLICK(b))
1274                         && (ep->bstate & MASK_DOUBLE_CLICK(b))
1275                         && (next->bstate & MASK_CLICK(b))) {
1276                         next->bstate &= ~MASK_CLICK(b);
1277                         next->bstate |= MASK_TRIPLE_CLICK(b);
1278                         merge = TRUE;
1279                     }
1280                 }
1281                 if (merge)
1282                     ep->id = INVALID_EVENT;
1283             }
1284         }
1285
1286         /* Discard event if it does not match event mask */
1287         if (!(ep->bstate & sp->_mouse_mask)) {
1288             ep->id = INVALID_EVENT;
1289         }
1290
1291         /* Compact valid events */
1292         if (ep->id == INVALID_EVENT) {
1293             if (ep == first_valid) {
1294                 first_valid = next;
1295             } else if (first_invalid == NULL) {
1296                 first_invalid = ep;
1297             }
1298         } else if (first_invalid != NULL) {
1299             *first_invalid = *ep;
1300             ep->id = INVALID_EVENT;
1301             first_invalid = NEXT(first_invalid);
1302         }
1303
1304         ep = next;
1305     }
1306
1307     if (first_invalid == NULL) {
1308         first_invalid = eventp;
1309     }
1310     sp->_mouse_eventp = first_invalid;
1311
1312 #ifdef TRACE
1313     if (first_valid != NULL) {
1314         if (USE_TRACEF(TRACE_IEVENT)) {
1315             _trace_slot(sp, "after mouse event queue compaction:");
1316             _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1317                     RunParams(sp, first_invalid, first_valid),
1318                     runcount);
1319             _nc_unlock_global(tracef);
1320         }
1321         for (ep = first_valid; ep != first_invalid; ep = NEXT(ep)) {
1322             if (ep->id != INVALID_EVENT)
1323                 TR(MY_TRACE,
1324                    ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
1325                     _nc_tracemouse(sp, ep),
1326                     (long) IndexEV(sp, ep)));
1327         }
1328     }
1329 #endif /* TRACE */
1330
1331     /* after all this, do we have a valid event? */
1332     return (PREV(first_invalid)->id != INVALID_EVENT);
1333 }
1334
1335 static void
1336 _nc_mouse_wrap(SCREEN *sp)
1337 /* release mouse -- called by endwin() before shellout/exit */
1338 {
1339     TR(MY_TRACE, ("_nc_mouse_wrap() called"));
1340
1341     switch (sp->_mouse_type) {
1342     case M_XTERM:
1343         if (sp->_mouse_mask)
1344             mouse_activate(sp, FALSE);
1345         break;
1346 #if USE_GPM_SUPPORT
1347         /* GPM: pass all mouse events to next client */
1348     case M_GPM:
1349         if (sp->_mouse_mask)
1350             mouse_activate(sp, FALSE);
1351         break;
1352 #endif
1353 #if USE_SYSMOUSE
1354     case M_SYSMOUSE:
1355         mouse_activate(sp, FALSE);
1356         break;
1357 #endif
1358 #ifdef USE_TERM_DRIVER
1359     case M_TERM_DRIVER:
1360         mouse_activate(sp, FALSE);
1361         break;
1362 #endif
1363     case M_NONE:
1364         break;
1365     }
1366 }
1367
1368 static void
1369 _nc_mouse_resume(SCREEN *sp)
1370 /* re-connect to mouse -- called by doupdate() after shellout */
1371 {
1372     TR(MY_TRACE, ("_nc_mouse_resume() called"));
1373
1374     switch (sp->_mouse_type) {
1375     case M_XTERM:
1376         /* xterm: re-enable reporting */
1377         if (sp->_mouse_mask)
1378             mouse_activate(sp, TRUE);
1379         break;
1380
1381 #if USE_GPM_SUPPORT
1382     case M_GPM:
1383         /* GPM: reclaim our event set */
1384         if (sp->_mouse_mask)
1385             mouse_activate(sp, TRUE);
1386         break;
1387 #endif
1388
1389 #if USE_SYSMOUSE
1390     case M_SYSMOUSE:
1391         mouse_activate(sp, TRUE);
1392         break;
1393 #endif
1394
1395 #ifdef USE_TERM_DRIVER
1396     case M_TERM_DRIVER:
1397         mouse_activate(sp, TRUE);
1398         break;
1399 #endif
1400
1401     case M_NONE:
1402         break;
1403     }
1404 }
1405
1406 /**************************************************************************
1407  *
1408  * Mouse interface entry points for the API
1409  *
1410  **************************************************************************/
1411
1412 NCURSES_EXPORT(int)
1413 NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1414 {
1415     int result = ERR;
1416
1417     T((T_CALLED("getmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1418
1419     if ((aevent != 0) && (SP_PARM != 0) && (SP_PARM->_mouse_type != M_NONE)) {
1420         MEVENT *eventp = SP_PARM->_mouse_eventp;
1421         /* compute the current-event pointer */
1422         MEVENT *prev = PREV(eventp);
1423
1424         /*
1425          * Discard events not matching mask (there could be still some if
1426          * _nc_mouse_parse was not called, e.g., when _nc_mouse_inline returns
1427          * false).
1428          */
1429         while ((prev->id != INVALID_EVENT) && (!(prev->bstate & SP_PARM->_mouse_mask))) {
1430             prev->id = INVALID_EVENT;
1431             prev = PREV(prev);
1432         }
1433         if (prev->id != INVALID_EVENT) {
1434             /* copy the event we find there */
1435             *aevent = *prev;
1436
1437             TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
1438                               _nc_tracemouse(SP_PARM, prev),
1439                               (long) IndexEV(SP_PARM, prev)));
1440
1441             prev->id = INVALID_EVENT;   /* so the queue slot becomes free */
1442             SP_PARM->_mouse_eventp = prev;
1443             result = OK;
1444         } else {
1445             /* Reset the provided event */
1446             aevent->bstate = 0;
1447             aevent->id = INVALID_EVENT;
1448             aevent->x = 0;
1449             aevent->y = 0;
1450             aevent->z = 0;
1451         }
1452     }
1453     returnCode(result);
1454 }
1455
1456 #if NCURSES_SP_FUNCS
1457 /* grab a copy of the current mouse event */
1458 NCURSES_EXPORT(int)
1459 getmouse(MEVENT * aevent)
1460 {
1461     return NCURSES_SP_NAME(getmouse) (CURRENT_SCREEN, aevent);
1462 }
1463 #endif
1464
1465 NCURSES_EXPORT(int)
1466 NCURSES_SP_NAME(ungetmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1467 {
1468     int result = ERR;
1469
1470     T((T_CALLED("ungetmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1471
1472     if (aevent != 0 && SP_PARM != 0) {
1473         MEVENT *eventp = SP_PARM->_mouse_eventp;
1474
1475         /* stick the given event in the next-free slot */
1476         *eventp = *aevent;
1477
1478         /* bump the next-free pointer into the circular list */
1479         SP_PARM->_mouse_eventp = NEXT(eventp);
1480
1481         /* push back the notification event on the keyboard queue */
1482         result = NCURSES_SP_NAME(ungetch) (NCURSES_SP_ARGx KEY_MOUSE);
1483     }
1484     returnCode(result);
1485 }
1486
1487 #if NCURSES_SP_FUNCS
1488 /* enqueue a synthesized mouse event to be seen by the next wgetch() */
1489 NCURSES_EXPORT(int)
1490 ungetmouse(MEVENT * aevent)
1491 {
1492     return NCURSES_SP_NAME(ungetmouse) (CURRENT_SCREEN, aevent);
1493 }
1494 #endif
1495
1496 NCURSES_EXPORT(mmask_t)
1497 NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
1498 /* set the mouse event mask */
1499 {
1500     mmask_t result = 0;
1501
1502     T((T_CALLED("mousemask(%p,%#lx,%p)"),
1503        (void *) SP_PARM,
1504        (unsigned long) newmask,
1505        (void *) oldmask));
1506
1507     if (SP_PARM != 0) {
1508         if (oldmask)
1509             *oldmask = SP_PARM->_mouse_mask;
1510
1511         if (newmask || SP_PARM->_mouse_initialized) {
1512             _nc_mouse_init(SP_PARM);
1513             if (SP_PARM->_mouse_type != M_NONE) {
1514                 result = newmask &
1515                     (REPORT_MOUSE_POSITION
1516                      | BUTTON_ALT
1517                      | BUTTON_CTRL
1518                      | BUTTON_SHIFT
1519                      | BUTTON_PRESSED
1520                      | BUTTON_RELEASED
1521                      | BUTTON_CLICKED
1522                      | BUTTON_DOUBLE_CLICKED
1523                      | BUTTON_TRIPLE_CLICKED);
1524
1525                 mouse_activate(SP_PARM, (bool) (result != 0));
1526
1527                 SP_PARM->_mouse_mask = result;
1528             }
1529         }
1530     }
1531     returnMMask(result);
1532 }
1533
1534 #if NCURSES_SP_FUNCS
1535 NCURSES_EXPORT(mmask_t)
1536 mousemask(mmask_t newmask, mmask_t * oldmask)
1537 {
1538     return NCURSES_SP_NAME(mousemask) (CURRENT_SCREEN, newmask, oldmask);
1539 }
1540 #endif
1541
1542 NCURSES_EXPORT(bool)
1543 wenclose(const WINDOW *win, int y, int x)
1544 /* check to see if given window encloses given screen location */
1545 {
1546     bool result = FALSE;
1547
1548     T((T_CALLED("wenclose(%p,%d,%d)"), (const void *) win, y, x));
1549
1550     if (win != 0) {
1551         y -= win->_yoffset;
1552         result = ((win->_begy <= y &&
1553                    win->_begx <= x &&
1554                    (win->_begx + win->_maxx) >= x &&
1555                    (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
1556     }
1557     returnBool(result);
1558 }
1559
1560 NCURSES_EXPORT(int)
1561 NCURSES_SP_NAME(mouseinterval) (NCURSES_SP_DCLx int maxclick)
1562 /* set the maximum mouse interval within which to recognize a click */
1563 {
1564     int oldval;
1565
1566     T((T_CALLED("mouseinterval(%p,%d)"), (void *) SP_PARM, maxclick));
1567
1568     if (SP_PARM != 0) {
1569         oldval = SP_PARM->_maxclick;
1570         if (maxclick >= 0)
1571             SP_PARM->_maxclick = maxclick;
1572     } else {
1573         oldval = DEFAULT_MAXCLICK;
1574     }
1575
1576     returnCode(oldval);
1577 }
1578
1579 #if NCURSES_SP_FUNCS
1580 NCURSES_EXPORT(int)
1581 mouseinterval(int maxclick)
1582 {
1583     return NCURSES_SP_NAME(mouseinterval) (CURRENT_SCREEN, maxclick);
1584 }
1585 #endif
1586
1587 /* This may be used by other routines to ask for the existence of mouse
1588    support */
1589 NCURSES_EXPORT(bool)
1590 _nc_has_mouse(SCREEN *sp)
1591 {
1592     return (((0 == sp) || (sp->_mouse_type == M_NONE)) ? FALSE : TRUE);
1593 }
1594
1595 NCURSES_EXPORT(bool)
1596 NCURSES_SP_NAME(has_mouse) (NCURSES_SP_DCL0)
1597 {
1598     return _nc_has_mouse(SP_PARM);
1599 }
1600
1601 #if NCURSES_SP_FUNCS
1602 NCURSES_EXPORT(bool)
1603 has_mouse(void)
1604 {
1605     return _nc_has_mouse(CURRENT_SCREEN);
1606 }
1607 #endif
1608
1609 NCURSES_EXPORT(bool)
1610 wmouse_trafo(const WINDOW *win, int *pY, int *pX, bool to_screen)
1611 {
1612     bool result = FALSE;
1613
1614     T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"),
1615        (const void *) win,
1616        (void *) pY,
1617        (void *) pX,
1618        to_screen));
1619
1620     if (win && pY && pX) {
1621         int y = *pY;
1622         int x = *pX;
1623
1624         if (to_screen) {
1625             y += win->_begy + win->_yoffset;
1626             x += win->_begx;
1627             if (wenclose(win, y, x))
1628                 result = TRUE;
1629         } else {
1630             if (wenclose(win, y, x)) {
1631                 y -= (win->_begy + win->_yoffset);
1632                 x -= win->_begx;
1633                 result = TRUE;
1634             }
1635         }
1636         if (result) {
1637             *pX = x;
1638             *pY = y;
1639         }
1640     }
1641     returnBool(result);
1642 }