ncurses 5.7 - patch 20100327
[ncurses.git] / ncurses / base / lib_mouse.c
1 /****************************************************************************
2  * Copyright (c) 1998-2009,2010 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.113 2010/03/24 23:06:46 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)         NCURSES_MOUSE_MASK(x, 001)
126 #define MASK_PRESS(x)           NCURSES_MOUSE_MASK(x, 002)
127 #define MASK_CLICK(x)           NCURSES_MOUSE_MASK(x, 004)
128 #define MASK_DOUBLE_CLICK(x)    NCURSES_MOUSE_MASK(x, 010)
129 #define MASK_TRIPLE_CLICK(x)    NCURSES_MOUSE_MASK(x, 020)
130 #define MASK_RESERVED_EVENT(x)  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(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                     break;
754                 }
755
756                 eventp->x = ev.x - 1;
757                 eventp->y = ev.y - 1;
758                 eventp->z = 0;
759
760                 /* bump the next-free pointer into the circular list */
761                 sp->_mouse_eventp = eventp = NEXT(eventp);
762                 result = TRUE;
763                 break;
764             }
765         }
766         break;
767 #endif
768
769 #if USE_SYSMOUSE
770     case M_SYSMOUSE:
771         if (sp->_sysmouse_head < sp->_sysmouse_tail) {
772             *eventp = sp->_sysmouse_fifo[sp->_sysmouse_head];
773
774             /*
775              * Point the fifo-head to the next possible location.  If there
776              * are none, reset the indices.  This may be interrupted by the
777              * signal handler, doing essentially the same reset.
778              */
779             sp->_sysmouse_head += 1;
780             if (sp->_sysmouse_head == sp->_sysmouse_tail) {
781                 sp->_sysmouse_tail = 0;
782                 sp->_sysmouse_head = 0;
783             }
784
785             /* bump the next-free pointer into the circular list */
786             sp->_mouse_eventp = eventp = NEXT(eventp);
787             result = TRUE;
788         }
789         break;
790 #endif /* USE_SYSMOUSE */
791
792 #ifdef USE_TERM_DRIVER
793     case M_TERM_DRIVER:
794         while (sp->_drv_mouse_head < sp->_drv_mouse_tail) {
795             *eventp = sp->_drv_mouse_fifo[sp->_drv_mouse_head];
796
797             /*
798              * Point the fifo-head to the next possible location.  If there
799              * are none, reset the indices.
800              */
801             sp->_drv_mouse_head += 1;
802             if (sp->_drv_mouse_head == sp->_drv_mouse_tail) {
803                 sp->_drv_mouse_tail = 0;
804                 sp->_drv_mouse_head = 0;
805             }
806
807             /* bump the next-free pointer into the circular list */
808             sp->_mouse_eventp = eventp = NEXT(eventp);
809             result = TRUE;
810         }
811         break;
812 #endif
813
814     case M_NONE:
815         break;
816     }
817
818     return result;              /* true if we found an event */
819 }
820
821 static bool
822 _nc_mouse_inline(SCREEN *sp)
823 /* mouse report received in the keyboard stream -- parse its info */
824 {
825     int b;
826     bool result = FALSE;
827     MEVENT *eventp = sp->_mouse_eventp;
828
829     TR(MY_TRACE, ("_nc_mouse_inline() called"));
830
831     if (sp->_mouse_type == M_XTERM) {
832         unsigned char kbuf[4];
833         mmask_t prev;
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         for (grabbed = 0; grabbed < 3; grabbed += (size_t) res) {
870
871             /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
872 #if USE_EMX_MOUSE
873             res = read(M_FD(sp) >= 0 ? M_FD(sp) : sp->_ifd, &kbuf, 3);
874 #else
875             res = read(sp->_ifd, kbuf + grabbed, 3 - grabbed);
876 #endif
877             if (res == -1)
878                 break;
879         }
880         kbuf[3] = '\0';
881
882         TR(TRACE_IEVENT,
883            ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
884
885         /* there's only one mouse... */
886         eventp->id = NORMAL_EVENT;
887
888         /* processing code goes here */
889         eventp->bstate = 0;
890         prev = PREV(eventp)->bstate;
891
892 #if USE_EMX_MOUSE
893 #define PRESS_POSITION(n) \
894         eventp->bstate = MASK_PRESS(n); \
895         if (kbuf[0] & 0x40) \
896             eventp->bstate = MASK_RELEASE(n)
897 #else
898 #define PRESS_POSITION(n) \
899         eventp->bstate = (mmask_t) (prev & MASK_PRESS(n) \
900                                     ? REPORT_MOUSE_POSITION \
901                                     : MASK_PRESS(n))
902 #endif
903
904         switch (kbuf[0] & 0x3) {
905         case 0x0:
906             if (kbuf[0] & 64)
907                 eventp->bstate = MASK_PRESS(4);
908             else
909                 PRESS_POSITION(1);
910             break;
911
912         case 0x1:
913 #if NCURSES_MOUSE_VERSION == 2
914             if (kbuf[0] & 64)
915                 eventp->bstate = MASK_PRESS(5);
916             else
917 #endif
918                 PRESS_POSITION(2);
919             break;
920
921         case 0x2:
922             PRESS_POSITION(3);
923             break;
924
925         case 0x3:
926             /*
927              * Release events aren't reported for individual buttons, just for
928              * the button set as a whole.  However, because there are normally
929              * no mouse events under xterm that intervene between press and
930              * release, we can infer the button actually released by looking at
931              * the previous event.
932              */
933             if (prev & (BUTTON_PRESSED | BUTTON_RELEASED)) {
934                 eventp->bstate = BUTTON_RELEASED;
935                 for (b = 1; b <= MAX_BUTTONS; ++b) {
936                     if (!(prev & MASK_PRESS(b)))
937                         eventp->bstate &= ~MASK_RELEASE(b);
938                 }
939             } else {
940                 /*
941                  * XFree86 xterm will return a stream of release-events to
942                  * let the application know where the mouse is going, if the
943                  * private mode 1002 or 1003 is enabled.
944                  */
945                 eventp->bstate = REPORT_MOUSE_POSITION;
946             }
947             break;
948         }
949         result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
950
951         if (kbuf[0] & 4) {
952             eventp->bstate |= BUTTON_SHIFT;
953         }
954         if (kbuf[0] & 8) {
955             eventp->bstate |= BUTTON_ALT;
956         }
957         if (kbuf[0] & 16) {
958             eventp->bstate |= BUTTON_CTRL;
959         }
960
961         eventp->x = (kbuf[1] - ' ') - 1;
962         eventp->y = (kbuf[2] - ' ') - 1;
963         TR(MY_TRACE,
964            ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
965             _nc_tracemouse(sp, eventp),
966             (long) IndexEV(sp, eventp)));
967
968         /* bump the next-free pointer into the circular list */
969         sp->_mouse_eventp = NEXT(eventp);
970 #if 0                           /* this return would be needed for QNX's mods to lib_getch.c */
971         return (TRUE);
972 #endif
973     }
974
975     return (result);
976 }
977
978 static void
979 mouse_activate(SCREEN *sp, bool on)
980 {
981     if (!on && !sp->_mouse_initialized)
982         return;
983
984     if (!_nc_mouse_init(sp))
985         return;
986
987     if (on) {
988
989         switch (sp->_mouse_type) {
990         case M_XTERM:
991 #if NCURSES_EXT_FUNCS
992             NCURSES_SP_NAME(keyok) (NCURSES_SP_ARGx KEY_MOUSE, on);
993 #endif
994             TPUTS_TRACE("xterm mouse initialization");
995             enable_xterm_mouse(sp, 1);
996             break;
997 #if USE_GPM_SUPPORT
998         case M_GPM:
999             if (enable_gpm_mouse(sp, TRUE)) {
1000                 sp->_mouse_fd = *(my_gpm_fd);
1001                 T(("GPM mouse_fd %d", sp->_mouse_fd));
1002             }
1003             break;
1004 #endif
1005 #if USE_SYSMOUSE
1006         case M_SYSMOUSE:
1007             signal(SIGUSR2, handle_sysmouse);
1008             sp->_mouse_active = TRUE;
1009             break;
1010 #endif
1011 #ifdef USE_TERM_DRIVER
1012         case M_TERM_DRIVER:
1013             sp->_mouse_active = TRUE;
1014             break;
1015 #endif
1016         case M_NONE:
1017             return;
1018         }
1019         /* Make runtime binding to cut down on object size of applications that
1020          * do not use the mouse (e.g., 'clear').
1021          */
1022         sp->_mouse_event = _nc_mouse_event;
1023         sp->_mouse_inline = _nc_mouse_inline;
1024         sp->_mouse_parse = _nc_mouse_parse;
1025         sp->_mouse_resume = _nc_mouse_resume;
1026         sp->_mouse_wrap = _nc_mouse_wrap;
1027     } else {
1028
1029         switch (sp->_mouse_type) {
1030         case M_XTERM:
1031             TPUTS_TRACE("xterm mouse deinitialization");
1032             enable_xterm_mouse(sp, 0);
1033             break;
1034 #if USE_GPM_SUPPORT
1035         case M_GPM:
1036             enable_gpm_mouse(sp, FALSE);
1037             break;
1038 #endif
1039 #if USE_SYSMOUSE
1040         case M_SYSMOUSE:
1041             signal(SIGUSR2, SIG_IGN);
1042             sp->_mouse_active = FALSE;
1043             break;
1044 #endif
1045 #ifdef USE_TERM_DRIVER
1046         case M_TERM_DRIVER:
1047             sp->_mouse_active = FALSE;
1048             break;
1049 #endif
1050         case M_NONE:
1051             return;
1052         }
1053     }
1054     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1055 }
1056
1057 /**************************************************************************
1058  *
1059  * Device-independent code
1060  *
1061  **************************************************************************/
1062
1063 static bool
1064 _nc_mouse_parse(SCREEN *sp, int runcount)
1065 /* parse a run of atomic mouse events into a gesture */
1066 {
1067     MEVENT *eventp = sp->_mouse_eventp;
1068     MEVENT *ep, *runp, *next, *prev = PREV(eventp);
1069     int n;
1070     int b;
1071     bool merge;
1072
1073     TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));
1074
1075     /*
1076      * When we enter this routine, the event list next-free pointer
1077      * points just past a run of mouse events that we know were separated
1078      * in time by less than the critical click interval. The job of this
1079      * routine is to collapse this run into a single higher-level event
1080      * or gesture.
1081      *
1082      * We accomplish this in two passes.  The first pass merges press/release
1083      * pairs into click events.  The second merges runs of click events into
1084      * double or triple-click events.
1085      *
1086      * It's possible that the run may not resolve to a single event (for
1087      * example, if the user quadruple-clicks).  If so, leading events
1088      * in the run are ignored.
1089      *
1090      * Note that this routine is independent of the format of the specific
1091      * format of the pointing-device's reports.  We can use it to parse
1092      * gestures on anything that reports press/release events on a per-
1093      * button basis, as long as the device-dependent mouse code puts stuff
1094      * on the queue in MEVENT format.
1095      */
1096     if (runcount == 1) {
1097         TR(MY_TRACE,
1098            ("_nc_mouse_parse: returning simple mouse event %s at slot %ld",
1099             _nc_tracemouse(sp, prev),
1100             (long) IndexEV(sp, prev)));
1101         return (prev->id >= NORMAL_EVENT)
1102             ? ((prev->bstate & sp->_mouse_mask) ? TRUE : FALSE)
1103             : FALSE;
1104     }
1105
1106     /* find the start of the run */
1107     runp = eventp;
1108     for (n = runcount; n > 0; n--) {
1109         runp = PREV(runp);
1110     }
1111
1112 #ifdef TRACE
1113     if (USE_TRACEF(TRACE_IEVENT)) {
1114         _trace_slot(sp, "before mouse press/release merge:");
1115         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1116                 RunParams(sp, eventp, runp),
1117                 runcount);
1118         _nc_unlock_global(tracef);
1119     }
1120 #endif /* TRACE */
1121
1122     /* first pass; merge press/release pairs */
1123     do {
1124         merge = FALSE;
1125         for (ep = runp; (next = NEXT(ep)) != eventp; ep = next) {
1126
1127 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
1128                       == !(next->bstate & MASK_RELEASE(x)))
1129
1130             if (ep->x == next->x && ep->y == next->y
1131                 && (ep->bstate & BUTTON_PRESSED)
1132                 && MASK_CHANGED(1)
1133                 && MASK_CHANGED(2)
1134                 && MASK_CHANGED(3)
1135                 && MASK_CHANGED(4)
1136 #if NCURSES_MOUSE_VERSION == 2
1137                 && MASK_CHANGED(5)
1138 #endif
1139                 ) {
1140                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1141                     if ((sp->_mouse_mask & MASK_CLICK(b))
1142                         && (ep->bstate & MASK_PRESS(b))) {
1143                         ep->bstate &= ~MASK_PRESS(b);
1144                         ep->bstate |= MASK_CLICK(b);
1145                         merge = TRUE;
1146                     }
1147                 }
1148                 if (merge)
1149                     next->id = INVALID_EVENT;
1150             }
1151         }
1152     } while
1153         (merge);
1154
1155 #ifdef TRACE
1156     if (USE_TRACEF(TRACE_IEVENT)) {
1157         _trace_slot(sp, "before mouse click merge:");
1158         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1159                 RunParams(sp, eventp, runp),
1160                 runcount);
1161         _nc_unlock_global(tracef);
1162     }
1163 #endif /* TRACE */
1164
1165     /*
1166      * Second pass; merge click runs.  At this point, click events are
1167      * each followed by one invalid event. We merge click events
1168      * forward in the queue.
1169      *
1170      * NOTE: There is a problem with this design!  If the application
1171      * allows enough click events to pile up in the circular queue so
1172      * they wrap around, it will cheerfully merge the newest forward
1173      * into the oldest, creating a bogus doubleclick and confusing
1174      * the queue-traversal logic rather badly.  Generally this won't
1175      * happen, because calling getmouse() marks old events invalid and
1176      * ineligible for merges.  The true solution to this problem would
1177      * be to timestamp each MEVENT and perform the obvious sanity check,
1178      * but the timer element would have to have sub-second resolution,
1179      * which would get us into portability trouble.
1180      */
1181     do {
1182         MEVENT *follower;
1183
1184         merge = FALSE;
1185         for (ep = runp; (next = NEXT(ep)) != eventp; ep = next)
1186             if (ep->id != INVALID_EVENT) {
1187                 if (next->id != INVALID_EVENT)
1188                     continue;
1189                 follower = NEXT(next);
1190                 if (follower->id == INVALID_EVENT)
1191                     continue;
1192
1193                 /* merge click events forward */
1194                 if ((ep->bstate & BUTTON_CLICKED)
1195                     && (follower->bstate & BUTTON_CLICKED)) {
1196                     for (b = 1; b <= MAX_BUTTONS; ++b) {
1197                         if ((sp->_mouse_mask & MASK_DOUBLE_CLICK(b))
1198                             && (follower->bstate & MASK_CLICK(b))) {
1199                             follower->bstate &= ~MASK_CLICK(b);
1200                             follower->bstate |= MASK_DOUBLE_CLICK(b);
1201                             merge = TRUE;
1202                         }
1203                     }
1204                     if (merge)
1205                         ep->id = INVALID_EVENT;
1206                 }
1207
1208                 /* merge double-click events forward */
1209                 if ((ep->bstate & BUTTON_DOUBLE_CLICKED)
1210                     && (follower->bstate & BUTTON_CLICKED)) {
1211                     for (b = 1; b <= MAX_BUTTONS; ++b) {
1212                         if ((sp->_mouse_mask & MASK_TRIPLE_CLICK(b))
1213                             && (follower->bstate & MASK_CLICK(b))) {
1214                             follower->bstate &= ~MASK_CLICK(b);
1215                             follower->bstate |= MASK_TRIPLE_CLICK(b);
1216                             merge = TRUE;
1217                         }
1218                     }
1219                     if (merge)
1220                         ep->id = INVALID_EVENT;
1221                 }
1222             }
1223     } while
1224         (merge);
1225
1226 #ifdef TRACE
1227     if (USE_TRACEF(TRACE_IEVENT)) {
1228         _trace_slot(sp, "before mouse event queue compaction:");
1229         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1230                 RunParams(sp, eventp, runp),
1231                 runcount);
1232         _nc_unlock_global(tracef);
1233     }
1234 #endif /* TRACE */
1235
1236     /*
1237      * Now try to throw away trailing events flagged invalid, or that
1238      * don't match the current event mask.
1239      */
1240     for (; runcount; prev = PREV(eventp), runcount--)
1241         if (prev->id == INVALID_EVENT || !(prev->bstate & sp->_mouse_mask)) {
1242             sp->_mouse_eventp = eventp = prev;
1243         }
1244 #ifdef TRACE
1245     if (USE_TRACEF(TRACE_IEVENT)) {
1246         _trace_slot(sp, "after mouse event queue compaction:");
1247         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1248                 RunParams(sp, eventp, runp),
1249                 runcount);
1250         _nc_unlock_global(tracef);
1251     }
1252     for (ep = runp; ep != eventp; ep = NEXT(ep))
1253         if (ep->id != INVALID_EVENT)
1254             TR(MY_TRACE,
1255                ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
1256                 _nc_tracemouse(sp, ep),
1257                 (long) IndexEV(sp, ep)));
1258 #endif /* TRACE */
1259
1260     /* after all this, do we have a valid event? */
1261     return (PREV(eventp)->id != INVALID_EVENT);
1262 }
1263
1264 static void
1265 _nc_mouse_wrap(SCREEN *sp)
1266 /* release mouse -- called by endwin() before shellout/exit */
1267 {
1268     TR(MY_TRACE, ("_nc_mouse_wrap() called"));
1269
1270     switch (sp->_mouse_type) {
1271     case M_XTERM:
1272         if (sp->_mouse_mask)
1273             mouse_activate(sp, FALSE);
1274         break;
1275 #if USE_GPM_SUPPORT
1276         /* GPM: pass all mouse events to next client */
1277     case M_GPM:
1278         if (sp->_mouse_mask)
1279             mouse_activate(sp, FALSE);
1280         break;
1281 #endif
1282 #if USE_SYSMOUSE
1283     case M_SYSMOUSE:
1284         mouse_activate(sp, FALSE);
1285         break;
1286 #endif
1287 #ifdef USE_TERM_DRIVER
1288     case M_TERM_DRIVER:
1289         mouse_activate(sp, FALSE);
1290         break;
1291 #endif
1292     case M_NONE:
1293         break;
1294     }
1295 }
1296
1297 static void
1298 _nc_mouse_resume(SCREEN *sp)
1299 /* re-connect to mouse -- called by doupdate() after shellout */
1300 {
1301     TR(MY_TRACE, ("_nc_mouse_resume() called"));
1302
1303     switch (sp->_mouse_type) {
1304     case M_XTERM:
1305         /* xterm: re-enable reporting */
1306         if (sp->_mouse_mask)
1307             mouse_activate(sp, TRUE);
1308         break;
1309
1310 #if USE_GPM_SUPPORT
1311     case M_GPM:
1312         /* GPM: reclaim our event set */
1313         if (sp->_mouse_mask)
1314             mouse_activate(sp, TRUE);
1315         break;
1316 #endif
1317
1318 #if USE_SYSMOUSE
1319     case M_SYSMOUSE:
1320         mouse_activate(sp, TRUE);
1321         break;
1322 #endif
1323
1324 #ifdef USE_TERM_DRIVER
1325     case M_TERM_DRIVER:
1326         mouse_activate(sp, TRUE);
1327         break;
1328 #endif
1329
1330     case M_NONE:
1331         break;
1332     }
1333 }
1334
1335 /**************************************************************************
1336  *
1337  * Mouse interface entry points for the API
1338  *
1339  **************************************************************************/
1340
1341 NCURSES_EXPORT(int)
1342 NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1343 {
1344     int result = ERR;
1345
1346     T((T_CALLED("getmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1347
1348     if ((aevent != 0) && (SP_PARM != 0) && (SP_PARM->_mouse_type != M_NONE)) {
1349         MEVENT *eventp = SP_PARM->_mouse_eventp;
1350         /* compute the current-event pointer */
1351         MEVENT *prev = PREV(eventp);
1352
1353         if (prev->id != INVALID_EVENT) {
1354             /* copy the event we find there */
1355             *aevent = *prev;
1356
1357             TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
1358                               _nc_tracemouse(SP_PARM, prev),
1359                               (long) IndexEV(SP_PARM, prev)));
1360
1361             prev->id = INVALID_EVENT;   /* so the queue slot becomes free */
1362             SP_PARM->_mouse_eventp = PREV(prev);
1363             result = OK;
1364         }
1365     }
1366     returnCode(result);
1367 }
1368
1369 #if NCURSES_SP_FUNCS
1370 /* grab a copy of the current mouse event */
1371 NCURSES_EXPORT(int)
1372 getmouse(MEVENT * aevent)
1373 {
1374     return NCURSES_SP_NAME(getmouse) (CURRENT_SCREEN, aevent);
1375 }
1376 #endif
1377
1378 NCURSES_EXPORT(int)
1379 NCURSES_SP_NAME(ungetmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1380 {
1381     int result = ERR;
1382
1383     T((T_CALLED("ungetmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1384
1385     if (aevent != 0 && SP_PARM != 0) {
1386         MEVENT *eventp = SP_PARM->_mouse_eventp;
1387
1388         /* stick the given event in the next-free slot */
1389         *eventp = *aevent;
1390
1391         /* bump the next-free pointer into the circular list */
1392         SP_PARM->_mouse_eventp = NEXT(eventp);
1393
1394         /* push back the notification event on the keyboard queue */
1395         result = NCURSES_SP_NAME(ungetch) (NCURSES_SP_ARGx KEY_MOUSE);
1396     }
1397     returnCode(result);
1398 }
1399
1400 #if NCURSES_SP_FUNCS
1401 /* enqueue a synthesized mouse event to be seen by the next wgetch() */
1402 NCURSES_EXPORT(int)
1403 ungetmouse(MEVENT * aevent)
1404 {
1405     return NCURSES_SP_NAME(ungetmouse) (CURRENT_SCREEN, aevent);
1406 }
1407 #endif
1408
1409 NCURSES_EXPORT(mmask_t)
1410 NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
1411 /* set the mouse event mask */
1412 {
1413     mmask_t result = 0;
1414
1415     T((T_CALLED("mousemask(%p,%#lx,%p)"),
1416        (void *) SP_PARM,
1417        (unsigned long) newmask,
1418        (void *) oldmask));
1419
1420     if (SP_PARM != 0) {
1421         if (oldmask)
1422             *oldmask = SP_PARM->_mouse_mask;
1423
1424         if (newmask || SP_PARM->_mouse_initialized) {
1425             _nc_mouse_init(SP_PARM);
1426             if (SP_PARM->_mouse_type != M_NONE) {
1427                 result = newmask &
1428                     (REPORT_MOUSE_POSITION
1429                      | BUTTON_ALT
1430                      | BUTTON_CTRL
1431                      | BUTTON_SHIFT
1432                      | BUTTON_PRESSED
1433                      | BUTTON_RELEASED
1434                      | BUTTON_CLICKED
1435                      | BUTTON_DOUBLE_CLICKED
1436                      | BUTTON_TRIPLE_CLICKED);
1437
1438                 mouse_activate(SP_PARM, (bool) (result != 0));
1439
1440                 SP_PARM->_mouse_mask = result;
1441             }
1442         }
1443     }
1444     returnBits(result);
1445 }
1446
1447 #if NCURSES_SP_FUNCS
1448 NCURSES_EXPORT(mmask_t)
1449 mousemask(mmask_t newmask, mmask_t * oldmask)
1450 {
1451     return NCURSES_SP_NAME(mousemask) (CURRENT_SCREEN, newmask, oldmask);
1452 }
1453 #endif
1454
1455 NCURSES_EXPORT(bool)
1456 wenclose(const WINDOW *win, int y, int x)
1457 /* check to see if given window encloses given screen location */
1458 {
1459     bool result = FALSE;
1460
1461     T((T_CALLED("wenclose(%p,%d,%d)"), (const void *) win, y, x));
1462
1463     if (win != 0) {
1464         y -= win->_yoffset;
1465         result = ((win->_begy <= y &&
1466                    win->_begx <= x &&
1467                    (win->_begx + win->_maxx) >= x &&
1468                    (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
1469     }
1470     returnBool(result);
1471 }
1472
1473 NCURSES_EXPORT(int)
1474 NCURSES_SP_NAME(mouseinterval) (NCURSES_SP_DCLx int maxclick)
1475 /* set the maximum mouse interval within which to recognize a click */
1476 {
1477     int oldval;
1478
1479     T((T_CALLED("mouseinterval(%p,%d)"), (void *) SP_PARM, maxclick));
1480
1481     if (SP_PARM != 0) {
1482         oldval = SP_PARM->_maxclick;
1483         if (maxclick >= 0)
1484             SP_PARM->_maxclick = maxclick;
1485     } else {
1486         oldval = DEFAULT_MAXCLICK;
1487     }
1488
1489     returnCode(oldval);
1490 }
1491
1492 #if NCURSES_SP_FUNCS
1493 NCURSES_EXPORT(int)
1494 mouseinterval(int maxclick)
1495 {
1496     return NCURSES_SP_NAME(mouseinterval) (CURRENT_SCREEN, maxclick);
1497 }
1498 #endif
1499
1500 /* This may be used by other routines to ask for the existence of mouse
1501    support */
1502 NCURSES_EXPORT(bool)
1503 _nc_has_mouse(SCREEN *sp)
1504 {
1505     return (((0 == sp) || (sp->_mouse_type == M_NONE)) ? FALSE : TRUE);
1506 }
1507
1508 NCURSES_EXPORT(bool)
1509 NCURSES_SP_NAME(has_mouse) (NCURSES_SP_DCL0)
1510 {
1511     return _nc_has_mouse(SP_PARM);
1512 }
1513
1514 #if NCURSES_SP_FUNCS
1515 NCURSES_EXPORT(bool)
1516 has_mouse(void)
1517 {
1518     return _nc_has_mouse(CURRENT_SCREEN);
1519 }
1520 #endif
1521
1522 NCURSES_EXPORT(bool)
1523 wmouse_trafo(const WINDOW *win, int *pY, int *pX, bool to_screen)
1524 {
1525     bool result = FALSE;
1526
1527     T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"),
1528        (const void *) win,
1529        (void *) pY,
1530        (void *) pX,
1531        to_screen));
1532
1533     if (win && pY && pX) {
1534         int y = *pY;
1535         int x = *pX;
1536
1537         if (to_screen) {
1538             y += win->_begy + win->_yoffset;
1539             x += win->_begx;
1540             if (wenclose(win, y, x))
1541                 result = TRUE;
1542         } else {
1543             if (wenclose(win, y, x)) {
1544                 y -= (win->_begy + win->_yoffset);
1545                 x -= win->_begx;
1546                 result = TRUE;
1547             }
1548         }
1549         if (result) {
1550             *pX = x;
1551             *pY = y;
1552         }
1553     }
1554     returnBool(result);
1555 }