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