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