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