ncurses/base/lib_mouse.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2017,2018 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.179 2018/10/20 18:33:23 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 #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         if (b & 4) {
1281             eventp->bstate |= BUTTON_SHIFT;
1282         }
1283         if (b & 8) {
1284             eventp->bstate |= BUTTON_ALT;
1285         }
1286         if (b & 16) {
1287             eventp->bstate |= BUTTON_CTRL;
1288         }
1289         result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
1290         eventp->x = (data.params[1] ? (data.params[1] - 1) : 0);
1291         eventp->y = (data.params[2] ? (data.params[2] - 1) : 0);
1292     }
1293     return result;
1294 }
1295
1296 static bool
1297 _nc_mouse_inline(SCREEN *sp)
1298 /* mouse report received in the keyboard stream -- parse its info */
1299 {
1300     bool result = FALSE;
1301     MEVENT *eventp = sp->_mouse_eventp;
1302
1303     TR(MY_TRACE, ("_nc_mouse_inline() called"));
1304
1305     if (sp->_mouse_type == M_XTERM) {
1306         switch (sp->_mouse_format) {
1307         case MF_X10:
1308             result = decode_xterm_X10(sp, eventp);
1309             break;
1310         case MF_SGR1006:
1311             result = decode_xterm_SGR1006(sp, eventp);
1312             break;
1313 #ifdef EXP_XTERM_1005
1314         case MF_XTERM_1005:
1315             result = decode_xterm_1005(sp, eventp);
1316             break;
1317 #endif
1318         }
1319
1320         TR(MY_TRACE,
1321            ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
1322             _nc_tracemouse(sp, eventp),
1323             (long) IndexEV(sp, eventp)));
1324
1325         /* bump the next-free pointer into the circular list */
1326         sp->_mouse_eventp = NEXT(eventp);
1327
1328         if (!result) {
1329             /* If this event is from a wheel-mouse, treat it like position
1330              * reports and avoid waiting for the release-events which will
1331              * never come.
1332              */
1333             if (eventp->bstate & BUTTON_PRESSED) {
1334                 int b;
1335
1336                 for (b = 4; b <= MAX_BUTTONS; ++b) {
1337                     if ((eventp->bstate & MASK_PRESS(b))) {
1338                         result = TRUE;
1339                         break;
1340                     }
1341                 }
1342             }
1343         }
1344     }
1345
1346     return (result);
1347 }
1348
1349 static void
1350 mouse_activate(SCREEN *sp, int on)
1351 {
1352     if (!on && !sp->_mouse_initialized)
1353         return;
1354
1355     if (!_nc_mouse_init(sp))
1356         return;
1357
1358     if (on) {
1359         sp->_mouse_bstate = 0;
1360         switch (sp->_mouse_type) {
1361         case M_XTERM:
1362 #if NCURSES_EXT_FUNCS
1363             NCURSES_SP_NAME(keyok) (NCURSES_SP_ARGx KEY_MOUSE, on);
1364 #endif
1365             TPUTS_TRACE("xterm mouse initialization");
1366             enable_xterm_mouse(sp, 1);
1367             break;
1368 #if USE_GPM_SUPPORT
1369         case M_GPM:
1370             if (enable_gpm_mouse(sp, TRUE)) {
1371                 sp->_mouse_fd = *(my_gpm_fd);
1372                 T(("GPM mouse_fd %d", sp->_mouse_fd));
1373             }
1374             break;
1375 #endif
1376 #if USE_SYSMOUSE
1377         case M_SYSMOUSE:
1378             signal(SIGUSR2, handle_sysmouse);
1379             sp->_mouse_active = TRUE;
1380             break;
1381 #endif
1382 #ifdef USE_TERM_DRIVER
1383         case M_TERM_DRIVER:
1384             sp->_mouse_active = TRUE;
1385             break;
1386 #endif
1387         case M_NONE:
1388             return;
1389         }
1390         /* Make runtime binding to cut down on object size of applications that
1391          * do not use the mouse (e.g., 'clear').
1392          */
1393         sp->_mouse_event = _nc_mouse_event;
1394         sp->_mouse_inline = _nc_mouse_inline;
1395         sp->_mouse_parse = _nc_mouse_parse;
1396         sp->_mouse_resume = _nc_mouse_resume;
1397         sp->_mouse_wrap = _nc_mouse_wrap;
1398     } else {
1399
1400         switch (sp->_mouse_type) {
1401         case M_XTERM:
1402             TPUTS_TRACE("xterm mouse deinitialization");
1403             enable_xterm_mouse(sp, 0);
1404             break;
1405 #if USE_GPM_SUPPORT
1406         case M_GPM:
1407             enable_gpm_mouse(sp, FALSE);
1408             break;
1409 #endif
1410 #if USE_SYSMOUSE
1411         case M_SYSMOUSE:
1412             signal(SIGUSR2, SIG_IGN);
1413             sp->_mouse_active = FALSE;
1414             break;
1415 #endif
1416 #ifdef USE_TERM_DRIVER
1417         case M_TERM_DRIVER:
1418             sp->_mouse_active = FALSE;
1419             break;
1420 #endif
1421         case M_NONE:
1422             return;
1423         }
1424     }
1425     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1426 }
1427
1428 /**************************************************************************
1429  *
1430  * Device-independent code
1431  *
1432  **************************************************************************/
1433
1434 static bool
1435 _nc_mouse_parse(SCREEN *sp, int runcount)
1436 /* parse a run of atomic mouse events into a gesture */
1437 {
1438     MEVENT *eventp = sp->_mouse_eventp;
1439     MEVENT *next, *ep;
1440     MEVENT *first_valid = NULL;
1441     MEVENT *first_invalid = NULL;
1442     int n;
1443     int b;
1444     bool merge;
1445     bool endLoop;
1446
1447     TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));
1448
1449     /*
1450      * When we enter this routine, the event list next-free pointer
1451      * points just past a run of mouse events that we know were separated
1452      * in time by less than the critical click interval. The job of this
1453      * routine is to collapse this run into a single higher-level event
1454      * or gesture.
1455      *
1456      * We accomplish this in two passes.  The first pass merges press/release
1457      * pairs into click events.  The second merges runs of click events into
1458      * double or triple-click events.
1459      *
1460      * It's possible that the run may not resolve to a single event (for
1461      * example, if the user quadruple-clicks).  If so, leading events
1462      * in the run are ignored if user does not call getmouse in a loop (getting
1463      * them from newest to older).
1464      *
1465      * Note that this routine is independent of the format of the specific
1466      * format of the pointing-device's reports.  We can use it to parse
1467      * gestures on anything that reports press/release events on a per-
1468      * button basis, as long as the device-dependent mouse code puts stuff
1469      * on the queue in MEVENT format.
1470      */
1471
1472     /*
1473      * Reset all events that were not set, in case the user sometimes calls
1474      * getmouse only once and other times until there are no more events in
1475      * queue.
1476      *
1477      * This also allows reaching the beginning of the run.
1478      */
1479     ep = eventp;
1480     for (n = runcount; n < EV_MAX; n++) {
1481         Invalidate(ep);
1482         ep = NEXT(ep);
1483     }
1484
1485 #ifdef TRACE
1486     if (USE_TRACEF(TRACE_IEVENT)) {
1487         _trace_slot(sp, "before mouse press/release merge:");
1488         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1489                 RunParams(sp, eventp, ep),
1490                 runcount);
1491         _nc_unlock_global(tracef);
1492     }
1493 #endif /* TRACE */
1494
1495     /* first pass; merge press/release pairs */
1496     endLoop = FALSE;
1497     while (!endLoop) {
1498         next = NEXT(ep);
1499         if (next == eventp) {
1500             /* Will end the loop, but compact before */
1501             endLoop = TRUE;
1502         } else {
1503
1504 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
1505                       == !(next->bstate & MASK_RELEASE(x)))
1506
1507             if (ValidEvent(ep) && ValidEvent(next)
1508                 && ep->x == next->x && ep->y == next->y
1509                 && (ep->bstate & BUTTON_PRESSED)
1510                 && (!(next->bstate & BUTTON_PRESSED))) {
1511                 bool changed = TRUE;
1512
1513                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1514                     if (!MASK_CHANGED(b)) {
1515                         changed = FALSE;
1516                         break;
1517                     }
1518                 }
1519
1520                 if (changed) {
1521                     merge = FALSE;
1522                     for (b = 1; b <= MAX_BUTTONS; ++b) {
1523                         if ((sp->_mouse_mask & MASK_CLICK(b))
1524                             && (ep->bstate & MASK_PRESS(b))) {
1525                             next->bstate &= ~MASK_RELEASE(b);
1526                             next->bstate |= MASK_CLICK(b);
1527                             merge = TRUE;
1528                         }
1529                     }
1530                     if (merge) {
1531                         Invalidate(ep);
1532                     }
1533                 }
1534             }
1535         }
1536
1537         /* Compact valid events */
1538         if (!ValidEvent(ep)) {
1539             if ((first_valid != NULL) && (first_invalid == NULL)) {
1540                 first_invalid = ep;
1541             }
1542         } else {
1543             if (first_valid == NULL) {
1544                 first_valid = ep;
1545             } else if (first_invalid != NULL) {
1546                 *first_invalid = *ep;
1547                 Invalidate(ep);
1548                 first_invalid = NEXT(first_invalid);
1549             }
1550         }
1551
1552         ep = next;
1553     }
1554
1555     if (first_invalid != NULL) {
1556         eventp = first_invalid;
1557     }
1558 #ifdef TRACE
1559     if (USE_TRACEF(TRACE_IEVENT)) {
1560         _trace_slot(sp, "before mouse click merge:");
1561         if (first_valid == NULL) {
1562             _tracef("_nc_mouse_parse: no valid event");
1563         } else {
1564             _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1565                     RunParams(sp, eventp, first_valid),
1566                     runcount);
1567             _nc_unlock_global(tracef);
1568         }
1569     }
1570 #endif /* TRACE */
1571
1572     /*
1573      * Second pass; merge click runs.  We merge click events forward in the
1574      * queue.  For example, double click can be changed to triple click.
1575      *
1576      * NOTE: There is a problem with this design!  If the application
1577      * allows enough click events to pile up in the circular queue so
1578      * they wrap around, it will cheerfully merge the newest forward
1579      * into the oldest, creating a bogus doubleclick and confusing
1580      * the queue-traversal logic rather badly.  Generally this won't
1581      * happen, because calling getmouse() marks old events invalid and
1582      * ineligible for merges.  The true solution to this problem would
1583      * be to timestamp each MEVENT and perform the obvious sanity check,
1584      * but the timer element would have to have sub-second resolution,
1585      * which would get us into portability trouble.
1586      */
1587     first_invalid = NULL;
1588     endLoop = (first_valid == NULL);
1589     ep = first_valid;
1590     while (!endLoop) {
1591         next = NEXT(ep);
1592
1593         if (next == eventp) {
1594             /* Will end the loop, but check event type and compact before */
1595             endLoop = TRUE;
1596         } else if (!ValidEvent(next)) {
1597             continue;
1598         } else {
1599             /* merge click events forward */
1600             if ((ep->bstate & BUTTON_CLICKED)
1601                 && (next->bstate & BUTTON_CLICKED)) {
1602                 merge = FALSE;
1603                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1604                     if ((sp->_mouse_mask & MASK_DOUBLE_CLICK(b))
1605                         && (ep->bstate & MASK_CLICK(b))
1606                         && (next->bstate & MASK_CLICK(b))) {
1607                         next->bstate &= ~MASK_CLICK(b);
1608                         next->bstate |= MASK_DOUBLE_CLICK(b);
1609                         merge = TRUE;
1610                     }
1611                 }
1612                 if (merge) {
1613                     Invalidate(ep);
1614                 }
1615             }
1616
1617             /* merge double-click events forward */
1618             if ((ep->bstate & BUTTON_DOUBLE_CLICKED)
1619                 && (next->bstate & BUTTON_CLICKED)) {
1620                 merge = FALSE;
1621                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1622                     if ((sp->_mouse_mask & MASK_TRIPLE_CLICK(b))
1623                         && (ep->bstate & MASK_DOUBLE_CLICK(b))
1624                         && (next->bstate & MASK_CLICK(b))) {
1625                         next->bstate &= ~MASK_CLICK(b);
1626                         next->bstate |= MASK_TRIPLE_CLICK(b);
1627                         merge = TRUE;
1628                     }
1629                 }
1630                 if (merge) {
1631                     Invalidate(ep);
1632                 }
1633             }
1634         }
1635
1636         /* Discard event if it does not match event mask */
1637         if (!(ep->bstate & sp->_mouse_mask2)) {
1638             Invalidate(ep);
1639         }
1640
1641         /* Compact valid events */
1642         if (!ValidEvent(ep)) {
1643             if (ep == first_valid) {
1644                 first_valid = next;
1645             } else if (first_invalid == NULL) {
1646                 first_invalid = ep;
1647             }
1648         } else if (first_invalid != NULL) {
1649             *first_invalid = *ep;
1650             Invalidate(ep);
1651             first_invalid = NEXT(first_invalid);
1652         }
1653
1654         ep = next;
1655     }
1656
1657     if (first_invalid == NULL) {
1658         first_invalid = eventp;
1659     }
1660     sp->_mouse_eventp = first_invalid;
1661
1662 #ifdef TRACE
1663     if (first_valid != NULL) {
1664         if (USE_TRACEF(TRACE_IEVENT)) {
1665             _trace_slot(sp, "after mouse event queue compaction:");
1666             _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1667                     RunParams(sp, first_invalid, first_valid),
1668                     runcount);
1669             _nc_unlock_global(tracef);
1670         }
1671         for (ep = first_valid; ep != first_invalid; ep = NEXT(ep)) {
1672             if (ValidEvent(ep))
1673                 TR(MY_TRACE,
1674                    ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
1675                     _nc_tracemouse(sp, ep),
1676                     (long) IndexEV(sp, ep)));
1677         }
1678     }
1679 #endif /* TRACE */
1680
1681     /* after all this, do we have a valid event? */
1682     return ValidEvent(PREV(first_invalid));
1683 }
1684
1685 static void
1686 _nc_mouse_wrap(SCREEN *sp)
1687 /* release mouse -- called by endwin() before shellout/exit */
1688 {
1689     TR(MY_TRACE, ("_nc_mouse_wrap() called"));
1690
1691     switch (sp->_mouse_type) {
1692     case M_XTERM:
1693         if (sp->_mouse_mask)
1694             mouse_activate(sp, FALSE);
1695         break;
1696 #if USE_GPM_SUPPORT
1697         /* GPM: pass all mouse events to next client */
1698     case M_GPM:
1699         if (sp->_mouse_mask)
1700             mouse_activate(sp, FALSE);
1701         break;
1702 #endif
1703 #if USE_SYSMOUSE
1704     case M_SYSMOUSE:
1705         mouse_activate(sp, FALSE);
1706         break;
1707 #endif
1708 #ifdef USE_TERM_DRIVER
1709     case M_TERM_DRIVER:
1710         mouse_activate(sp, FALSE);
1711         break;
1712 #endif
1713     case M_NONE:
1714         break;
1715     }
1716 }
1717
1718 static void
1719 _nc_mouse_resume(SCREEN *sp)
1720 /* re-connect to mouse -- called by doupdate() after shellout */
1721 {
1722     TR(MY_TRACE, ("_nc_mouse_resume() called"));
1723
1724     switch (sp->_mouse_type) {
1725     case M_XTERM:
1726         /* xterm: re-enable reporting */
1727         if (sp->_mouse_mask)
1728             mouse_activate(sp, TRUE);
1729         break;
1730
1731 #if USE_GPM_SUPPORT
1732     case M_GPM:
1733         /* GPM: reclaim our event set */
1734         if (sp->_mouse_mask)
1735             mouse_activate(sp, TRUE);
1736         break;
1737 #endif
1738
1739 #if USE_SYSMOUSE
1740     case M_SYSMOUSE:
1741         mouse_activate(sp, TRUE);
1742         break;
1743 #endif
1744
1745 #ifdef USE_TERM_DRIVER
1746     case M_TERM_DRIVER:
1747         mouse_activate(sp, TRUE);
1748         break;
1749 #endif
1750
1751     case M_NONE:
1752         break;
1753     }
1754 }
1755
1756 /**************************************************************************
1757  *
1758  * Mouse interface entry points for the API
1759  *
1760  **************************************************************************/
1761
1762 NCURSES_EXPORT(int)
1763 NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1764 {
1765     int result = ERR;
1766     MEVENT *eventp;
1767
1768     T((T_CALLED("getmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1769
1770     if ((aevent != 0) &&
1771         (SP_PARM != 0) &&
1772         (SP_PARM->_mouse_type != M_NONE) &&
1773         (eventp = SP_PARM->_mouse_eventp) != 0) {
1774         /* compute the current-event pointer */
1775         MEVENT *prev = PREV(eventp);
1776
1777         /*
1778          * Discard events not matching mask (there could be still some if
1779          * _nc_mouse_parse was not called, e.g., when _nc_mouse_inline returns
1780          * false).
1781          */
1782         while (ValidEvent(prev) && (!(prev->bstate & SP_PARM->_mouse_mask2))) {
1783             Invalidate(prev);
1784             prev = PREV(prev);
1785         }
1786         if (ValidEvent(prev)) {
1787             /* copy the event we find there */
1788             *aevent = *prev;
1789
1790             TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
1791                               _nc_tracemouse(SP_PARM, prev),
1792                               (long) IndexEV(SP_PARM, prev)));
1793
1794             Invalidate(prev);   /* so the queue slot becomes free */
1795             SP_PARM->_mouse_eventp = prev;
1796             result = OK;
1797         } else {
1798             /* Reset the provided event */
1799             aevent->bstate = 0;
1800             Invalidate(aevent);
1801             aevent->x = 0;
1802             aevent->y = 0;
1803             aevent->z = 0;
1804         }
1805     }
1806     returnCode(result);
1807 }
1808
1809 #if NCURSES_SP_FUNCS
1810 /* grab a copy of the current mouse event */
1811 NCURSES_EXPORT(int)
1812 getmouse(MEVENT * aevent)
1813 {
1814     return NCURSES_SP_NAME(getmouse) (CURRENT_SCREEN, aevent);
1815 }
1816 #endif
1817
1818 NCURSES_EXPORT(int)
1819 NCURSES_SP_NAME(ungetmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1820 {
1821     int result = ERR;
1822     MEVENT *eventp;
1823
1824     T((T_CALLED("ungetmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1825
1826     if (aevent != 0 &&
1827         SP_PARM != 0 &&
1828         (eventp = SP_PARM->_mouse_eventp) != 0) {
1829
1830         /* stick the given event in the next-free slot */
1831         *eventp = *aevent;
1832
1833         /* bump the next-free pointer into the circular list */
1834         SP_PARM->_mouse_eventp = NEXT(eventp);
1835
1836         /* push back the notification event on the keyboard queue */
1837         result = NCURSES_SP_NAME(ungetch) (NCURSES_SP_ARGx KEY_MOUSE);
1838     }
1839     returnCode(result);
1840 }
1841
1842 #if NCURSES_SP_FUNCS
1843 /* enqueue a synthesized mouse event to be seen by the next wgetch() */
1844 NCURSES_EXPORT(int)
1845 ungetmouse(MEVENT * aevent)
1846 {
1847     return NCURSES_SP_NAME(ungetmouse) (CURRENT_SCREEN, aevent);
1848 }
1849 #endif
1850
1851 NCURSES_EXPORT(mmask_t)
1852 NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
1853 /* set the mouse event mask */
1854 {
1855     mmask_t result = 0;
1856
1857     T((T_CALLED("mousemask(%p,%#lx,%p)"),
1858        (void *) SP_PARM,
1859        (unsigned long) newmask,
1860        (void *) oldmask));
1861
1862     if (SP_PARM != 0) {
1863         if (oldmask)
1864             *oldmask = SP_PARM->_mouse_mask;
1865
1866         if (newmask || SP_PARM->_mouse_initialized) {
1867             _nc_mouse_init(SP_PARM);
1868
1869             if (SP_PARM->_mouse_type != M_NONE) {
1870                 int b;
1871
1872                 result = newmask &
1873                     (REPORT_MOUSE_POSITION
1874                      | BUTTON_ALT
1875                      | BUTTON_CTRL
1876                      | BUTTON_SHIFT
1877                      | BUTTON_PRESSED
1878                      | BUTTON_RELEASED
1879                      | BUTTON_CLICKED
1880                      | BUTTON_DOUBLE_CLICKED
1881                      | BUTTON_TRIPLE_CLICKED);
1882
1883                 mouse_activate(SP_PARM, (bool) (result != 0));
1884
1885                 SP_PARM->_mouse_mask = result;
1886                 SP_PARM->_mouse_mask2 = result;
1887
1888                 /*
1889                  * Make a mask corresponding to the states we will need to
1890                  * retain (temporarily) while building up the state that the
1891                  * user asked for.
1892                  */
1893                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1894                     if (SP_PARM->_mouse_mask2 & MASK_TRIPLE_CLICK(b))
1895                         SP_PARM->_mouse_mask2 |= MASK_DOUBLE_CLICK(b);
1896                     if (SP_PARM->_mouse_mask2 & MASK_DOUBLE_CLICK(b))
1897                         SP_PARM->_mouse_mask2 |= MASK_CLICK(b);
1898                     if (SP_PARM->_mouse_mask2 & MASK_CLICK(b))
1899                         SP_PARM->_mouse_mask2 |= (MASK_PRESS(b) |
1900                                                   MASK_RELEASE(b));
1901                 }
1902             }
1903         }
1904     }
1905     returnMMask(result);
1906 }
1907
1908 #if NCURSES_SP_FUNCS
1909 NCURSES_EXPORT(mmask_t)
1910 mousemask(mmask_t newmask, mmask_t * oldmask)
1911 {
1912     return NCURSES_SP_NAME(mousemask) (CURRENT_SCREEN, newmask, oldmask);
1913 }
1914 #endif
1915
1916 NCURSES_EXPORT(bool)
1917 wenclose(const WINDOW *win, int y, int x)
1918 /* check to see if given window encloses given screen location */
1919 {
1920     bool result = FALSE;
1921
1922     T((T_CALLED("wenclose(%p,%d,%d)"), (const void *) win, y, x));
1923
1924     if (win != 0) {
1925         y -= win->_yoffset;
1926         result = ((win->_begy <= y &&
1927                    win->_begx <= x &&
1928                    (win->_begx + win->_maxx) >= x &&
1929                    (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
1930     }
1931     returnBool(result);
1932 }
1933
1934 NCURSES_EXPORT(int)
1935 NCURSES_SP_NAME(mouseinterval) (NCURSES_SP_DCLx int maxclick)
1936 /* set the maximum mouse interval within which to recognize a click */
1937 {
1938     int oldval;
1939
1940     T((T_CALLED("mouseinterval(%p,%d)"), (void *) SP_PARM, maxclick));
1941
1942     if (SP_PARM != 0) {
1943         oldval = SP_PARM->_maxclick;
1944         if (maxclick >= 0)
1945             SP_PARM->_maxclick = maxclick;
1946     } else {
1947         oldval = DEFAULT_MAXCLICK;
1948     }
1949
1950     returnCode(oldval);
1951 }
1952
1953 #if NCURSES_SP_FUNCS
1954 NCURSES_EXPORT(int)
1955 mouseinterval(int maxclick)
1956 {
1957     return NCURSES_SP_NAME(mouseinterval) (CURRENT_SCREEN, maxclick);
1958 }
1959 #endif
1960
1961 /* This may be used by other routines to ask for the existence of mouse
1962    support */
1963 NCURSES_EXPORT(bool)
1964 _nc_has_mouse(SCREEN *sp)
1965 {
1966     return (((0 == sp) || (sp->_mouse_type == M_NONE)) ? FALSE : TRUE);
1967 }
1968
1969 NCURSES_EXPORT(bool)
1970 NCURSES_SP_NAME(has_mouse) (NCURSES_SP_DCL0)
1971 {
1972     return _nc_has_mouse(SP_PARM);
1973 }
1974
1975 #if NCURSES_SP_FUNCS
1976 NCURSES_EXPORT(bool)
1977 has_mouse(void)
1978 {
1979     return _nc_has_mouse(CURRENT_SCREEN);
1980 }
1981 #endif
1982
1983 NCURSES_EXPORT(bool)
1984 wmouse_trafo(const WINDOW *win, int *pY, int *pX, bool to_screen)
1985 {
1986     bool result = FALSE;
1987
1988     T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"),
1989        (const void *) win,
1990        (void *) pY,
1991        (void *) pX,
1992        to_screen));
1993
1994     if (win && pY && pX) {
1995         int y = *pY;
1996         int x = *pX;
1997
1998         if (to_screen) {
1999             y += win->_begy + win->_yoffset;
2000             x += win->_begx;
2001             if (wenclose(win, y, x))
2002                 result = TRUE;
2003         } else {
2004             if (wenclose(win, y, x)) {
2005                 y -= (win->_begy + win->_yoffset);
2006                 x -= win->_begx;
2007                 result = TRUE;
2008             }
2009         }
2010         if (result) {
2011             *pX = x;
2012             *pY = y;
2013         }
2014     }
2015     returnBool(result);
2016 }