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.181 2018/11/24 17:28:37 tom Exp $")
  88
  89 #include <tic.h>
  90
  91 #if USE_GPM_SUPPORT
  92 #include <linux/keyboard.h>     /* defines KG_* macros */
  93
  94 #ifdef HAVE_LIBDL
  95 /* use dynamic loader to avoid linkage dependency */
  96 #include <dlfcn.h>
  97
  98 #ifdef RTLD_NOW
  99 #define my_RTLD RTLD_NOW
 100 #else
 101 #ifdef RTLD_LAZY
 102 #define my_RTLD RTLD_LAZY
 103 #else
 104 make an error
 105 #endif
 106 #endif                          /* RTLD_NOW */
 107 #endif                          /* HAVE_LIBDL */
 108
 109 #endif                          /* USE_GPM_SUPPORT */
 110
 111 #if USE_SYSMOUSE
 112 #undef buttons                  /* symbol conflict in consio.h */
 113 #undef mouse_info               /* symbol conflict in consio.h */
 114 #include <osreldate.h>
 115 #if defined(__DragonFly_version) || (defined(__FreeBSD__) && (__FreeBSD_version >= 400017))
 116 #include <sys/consio.h>
 117 #include <sys/fbio.h>
 118 #else
 119 #include <machine/console.h>
 120 #endif
 121 #endif                          /* use_SYSMOUSE */
 122
 123 #if USE_KLIBC_MOUSE
 124 #include <sys/socket.h>
 125 #define pipe(handles) socketpair(AF_LOCAL, SOCK_STREAM, 0, handles)
 126 #define DosWrite(hfile, pbuffer, cbwrite, pcbactual) \
 127                 write(hfile, pbuffer, cbwrite)
 128 #define DosExit(action, result )        /* do nothing */
 129 #define DosCreateThread(ptid, pfn, param, flag, cbStack) \
 130                 (*(ptid) = _beginthread(pfn, NULL, cbStack, \
 131                                         (void *)param), (*(ptid) == -1))
 132 #endif
 133
 134 #define MY_TRACE TRACE_ICALLS|TRACE_IEVENT
 135
 136 #define MASK_RELEASE(x)         (mmask_t) NCURSES_MOUSE_MASK(x, 001)
 137 #define MASK_PRESS(x)           (mmask_t) NCURSES_MOUSE_MASK(x, 002)
 138 #define MASK_CLICK(x)           (mmask_t) NCURSES_MOUSE_MASK(x, 004)
 139 #define MASK_DOUBLE_CLICK(x)    (mmask_t) NCURSES_MOUSE_MASK(x, 010)
 140 #define MASK_TRIPLE_CLICK(x)    (mmask_t) NCURSES_MOUSE_MASK(x, 020)
 141 #define MASK_RESERVED_EVENT(x)  (mmask_t) NCURSES_MOUSE_MASK(x, 040)
 142
 143 #if NCURSES_MOUSE_VERSION == 1
 144 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED)
 145 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED)
 146 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED)
 147 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED)
 148 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED)
 149 #define MAX_BUTTONS  4
 150 #else
 151 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED        | BUTTON5_CLICKED)
 152 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED        | BUTTON5_PRESSED)
 153 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED       | BUTTON5_RELEASED)
 154 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED | BUTTON5_DOUBLE_CLICKED)
 155 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED | BUTTON5_TRIPLE_CLICKED)
 156 #define MAX_BUTTONS  5
 157 #endif
 158
 159 #define INVALID_EVENT   -1
 160 #define NORMAL_EVENT    0
 161
 162 #define ValidEvent(ep) ((ep)->id != INVALID_EVENT)
 163 #define Invalidate(ep) (ep)->id = INVALID_EVENT
 164
 165 #if USE_GPM_SUPPORT
 166
 167 #ifndef LIBGPM_SONAME
 168 #define LIBGPM_SONAME "libgpm.so"
 169 #endif
 170
 171 #define GET_DLSYM(name) (my_##name = (TYPE_##name) dlsym(sp->_dlopen_gpm, #name))
 172
 173 #endif                          /* USE_GPM_SUPPORT */
 174
 175 static bool _nc_mouse_parse(SCREEN *, int);
 176 static void _nc_mouse_resume(SCREEN *);
 177 static void _nc_mouse_wrap(SCREEN *);
 178
 179 /* maintain a circular list of mouse events */
 180
 181 #define FirstEV(sp)     ((sp)->_mouse_events)
 182 #define LastEV(sp)      ((sp)->_mouse_events + EV_MAX - 1)
 183
 184 #undef  NEXT
 185 #define NEXT(ep)        ((ep >= LastEV(SP_PARM)) \
 186                          ? FirstEV(SP_PARM) \
 187                          : ep + 1)
 188
 189 #undef  PREV
 190 #define PREV(ep)        ((ep <= FirstEV(SP_PARM)) \
 191                          ? LastEV(SP_PARM) \
 192                          : ep - 1)
 193
 194 #define IndexEV(sp, ep) (ep - FirstEV(sp))
 195
 196 #define RunParams(sp, eventp, runp) \
 197                 (long) IndexEV(sp, runp), \
 198                 (long) (IndexEV(sp, eventp) + (EV_MAX - 1)) % EV_MAX
 199
 200 #ifdef TRACE
 201 static void
 202 _trace_slot(SCREEN *sp, const char *tag)
 203 {
 204     MEVENT *ep;
 205
 206     _tracef("%s", tag);
 207
 208     for (ep = FirstEV(sp); ep <= LastEV(sp); ep++)
 209         _tracef("mouse event queue slot %ld = %s",
 210                 (long) IndexEV(sp, ep),
 211                 _nc_tracemouse(sp, ep));
 212 }
 213 #endif
 214
 215 #if USE_EMX_MOUSE
 216
 217 #  define TOP_ROW          0
 218 #  define LEFT_COL         0
 219
 220 #  define M_FD(sp) sp->_mouse_fd
 221
 222 static void
 223 write_event(SCREEN *sp, int down, int button, int x, int y)
 224 {
 225     char buf[6];
 226     unsigned long ignore;
 227
 228     _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         && NonEmpty(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 (NonEmpty(key_mouse)) {
 720         init_xterm_mouse(sp);
 721     } else if (strstr(SP_TERMTYPE term_names, "xterm") != 0) {
 722         if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
 723             init_xterm_mouse(sp);
 724     }
 725 #endif
 726
 727     returnVoid;
 728 }
 729
 730 static bool
 731 _nc_mouse_init(SCREEN *sp)
 732 /* initialize the mouse */
 733 {
 734     bool result = FALSE;
 735
 736     if (sp != 0) {
 737         if (!sp->_mouse_initialized) {
 738             int i;
 739
 740             sp->_mouse_initialized = TRUE;
 741
 742             TR(MY_TRACE, ("_nc_mouse_init() called"));
 743
 744             sp->_mouse_eventp = FirstEV(sp);
 745             for (i = 0; i < EV_MAX; i++)
 746                 Invalidate(sp->_mouse_events + i);
 747
 748             initialize_mousetype(sp);
 749
 750             T(("_nc_mouse_init() set mousetype to %d", sp->_mouse_type));
 751         }
 752         result = sp->_mouse_initialized;
 753     }
 754     return result;
 755 }
 756
 757 /*
 758  * Query to see if there is a pending mouse event.  This is called from
 759  * fifo_push() in lib_getch.c
 760  */
 761 static bool
 762 _nc_mouse_event(SCREEN *sp)
 763 {
 764     MEVENT *eventp = sp->_mouse_eventp;
 765     bool result = FALSE;
 766
 767     (void) eventp;
 768
 769     switch (sp->_mouse_type) {
 770     case M_XTERM:
 771         /* xterm: never have to query, mouse events are in the keyboard stream */
 772 #if USE_EMX_MOUSE
 773         {
 774             char kbuf[3];
 775
 776             int i, res = read(M_FD(sp), &kbuf, 3);      /* Eat the prefix */
 777             if (res != 3)
 778                 printf("Got %d chars instead of 3 for prefix.\n", res);
 779             for (i = 0; i < res; i++) {
 780                 if (kbuf[i] != key_mouse[i])
 781                     printf("Got char %d instead of %d for prefix.\n",
 782                            (int) kbuf[i], (int) key_mouse[i]);
 783             }
 784             result = TRUE;
 785         }
 786 #endif /* USE_EMX_MOUSE */
 787         break;
 788
 789 #if USE_GPM_SUPPORT
 790     case M_GPM:
 791         if (sp->_mouse_fd >= 0) {
 792             /* query server for event, return TRUE if we find one */
 793             Gpm_Event ev;
 794
 795             switch (my_Gpm_GetEvent(&ev)) {
 796             case 0:
 797                 /* Connection closed, drop the mouse. */
 798                 sp->_mouse_fd = -1;
 799                 break;
 800             case 1:
 801                 /* there's only one mouse... */
 802                 eventp->id = NORMAL_EVENT;
 803
 804                 eventp->bstate = 0;
 805                 switch (ev.type & 0x0f) {
 806                 case (GPM_DOWN):
 807                     if (ev.buttons & GPM_B_LEFT)
 808                         eventp->bstate |= BUTTON1_PRESSED;
 809                     if (ev.buttons & GPM_B_MIDDLE)
 810                         eventp->bstate |= BUTTON2_PRESSED;
 811                     if (ev.buttons & GPM_B_RIGHT)
 812                         eventp->bstate |= BUTTON3_PRESSED;
 813                     break;
 814                 case (GPM_UP):
 815                     if (ev.buttons & GPM_B_LEFT)
 816                         eventp->bstate |= BUTTON1_RELEASED;
 817                     if (ev.buttons & GPM_B_MIDDLE)
 818                         eventp->bstate |= BUTTON2_RELEASED;
 819                     if (ev.buttons & GPM_B_RIGHT)
 820                         eventp->bstate |= BUTTON3_RELEASED;
 821                     break;
 822                 default:
 823                     eventp->bstate |= REPORT_MOUSE_POSITION;
 824                     break;
 825                 }
 826
 827                 eventp->x = ev.x - 1;
 828                 eventp->y = ev.y - 1;
 829                 eventp->z = 0;
 830
 831                 /* bump the next-free pointer into the circular list */
 832                 sp->_mouse_eventp = NEXT(eventp);
 833                 result = TRUE;
 834                 break;
 835             }
 836         }
 837         break;
 838 #endif
 839
 840 #if USE_SYSMOUSE
 841     case M_SYSMOUSE:
 842         if (sp->_sysmouse_head < sp->_sysmouse_tail) {
 843             *eventp = sp->_sysmouse_fifo[sp->_sysmouse_head];
 844
 845             /*
 846              * Point the fifo-head to the next possible location.  If there
 847              * are none, reset the indices.  This may be interrupted by the
 848              * signal handler, doing essentially the same reset.
 849              */
 850             sp->_sysmouse_head += 1;
 851             if (sp->_sysmouse_head == sp->_sysmouse_tail) {
 852                 sp->_sysmouse_tail = 0;
 853                 sp->_sysmouse_head = 0;
 854             }
 855
 856             /* bump the next-free pointer into the circular list */
 857             sp->_mouse_eventp = eventp = NEXT(eventp);
 858             result = TRUE;
 859         }
 860         break;
 861 #endif /* USE_SYSMOUSE */
 862
 863 #ifdef USE_TERM_DRIVER
 864     case M_TERM_DRIVER:
 865         while (sp->_drv_mouse_head < sp->_drv_mouse_tail) {
 866             *eventp = sp->_drv_mouse_fifo[sp->_drv_mouse_head];
 867
 868             /*
 869              * Point the fifo-head to the next possible location.  If there
 870              * are none, reset the indices.
 871              */
 872             sp->_drv_mouse_head += 1;
 873             if (sp->_drv_mouse_head == sp->_drv_mouse_tail) {
 874                 sp->_drv_mouse_tail = 0;
 875                 sp->_drv_mouse_head = 0;
 876             }
 877
 878             /* bump the next-free pointer into the circular list */
 879             sp->_mouse_eventp = eventp = NEXT(eventp);
 880             result = TRUE;
 881         }
 882         break;
 883 #endif
 884
 885     case M_NONE:
 886         break;
 887     }
 888
 889     return result;              /* true if we found an event */
 890 }
 891
 892 #if USE_EMX_MOUSE
 893 #define PRESS_POSITION(n) \
 894     do { \
 895             eventp->bstate = MASK_PRESS(n); \
 896             sp->_mouse_bstate |= MASK_PRESS(n); \
 897             if (button & 0x40) { \
 898                     eventp->bstate = MASK_RELEASE(n); \
 899                     sp->_mouse_bstate &= ~MASK_PRESS(n); \
 900             } \
 901     } while (0)
 902 #else
 903 #define PRESS_POSITION(n) \
 904     do { \
 905             eventp->bstate = (mmask_t) ((sp->_mouse_bstate & MASK_PRESS(n)) \
 906                                     ? REPORT_MOUSE_POSITION \
 907                                     : MASK_PRESS(n)); \
 908             sp->_mouse_bstate |= MASK_PRESS(n); \
 909     } while (0)
 910 #endif
 911
 912 static bool
 913 handle_wheel(SCREEN *sp, MEVENT * eventp, int button, int wheel)
 914 {
 915     bool result = TRUE;
 916
 917     switch (button & 3) {
 918     case 0:
 919         if (wheel) {
 920             eventp->bstate = MASK_PRESS(4);
 921             /* Do not record in sp->_mouse_bstate; there will be no
 922              * corresponding release event.
 923              */
 924         } else {
 925             PRESS_POSITION(1);
 926         }
 927         break;
 928     case 1:
 929         if (wheel) {
 930 #if NCURSES_MOUSE_VERSION == 2
 931             eventp->bstate = MASK_PRESS(5);
 932             /* See comment above for button 4 */
 933 #else
 934             /* Ignore this event as it is not a true press of the button */
 935             eventp->bstate = REPORT_MOUSE_POSITION;
 936 #endif
 937         } else {
 938             PRESS_POSITION(2);
 939         }
 940         break;
 941     case 2:
 942         PRESS_POSITION(3);
 943         break;
 944     default:
 945         result = FALSE;
 946         break;
 947     }
 948     return result;
 949 }
 950
 951 static bool
 952 decode_X10_bstate(SCREEN *sp, MEVENT * eventp, unsigned intro)
 953 {
 954     bool result;
 955
 956     eventp->bstate = 0;
 957
 958     if (!handle_wheel(sp, eventp, (int) intro, (intro & 96) == 96)) {
 959
 960         /*
 961          * Release events aren't reported for individual buttons, just for
 962          * the button set as a whole.  However, because there are normally
 963          * no mouse events under xterm that intervene between press and
 964          * release, we can infer the button actually released by looking at
 965          * the previous event.
 966          */
 967         if (sp->_mouse_bstate & BUTTON_PRESSED) {
 968             int b;
 969
 970             eventp->bstate = BUTTON_RELEASED;
 971             for (b = 1; b <= MAX_BUTTONS; ++b) {
 972                 if (!(sp->_mouse_bstate & MASK_PRESS(b)))
 973                     eventp->bstate &= ~MASK_RELEASE(b);
 974             }
 975             sp->_mouse_bstate = 0;
 976         } else {
 977             /*
 978              * xterm will return a stream of release-events to let the
 979              * application know where the mouse is going, if private mode
 980              * 1002 or 1003 is enabled.
 981              */
 982             eventp->bstate = REPORT_MOUSE_POSITION;
 983         }
 984     }
 985
 986     if (intro & 4) {
 987         eventp->bstate |= BUTTON_SHIFT;
 988     }
 989     if (intro & 8) {
 990         eventp->bstate |= BUTTON_ALT;
 991     }
 992     if (intro & 16) {
 993         eventp->bstate |= BUTTON_CTRL;
 994     }
 995     result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
 996     return result;
 997 }
 998
 999 /* This code requires that your xterm entry contain the kmous capability and
1000  * that it be set to the \E[M documented in the Xterm Control Sequences
1001  * reference.  This is how we arrange for mouse events to be reported via a
1002  * KEY_MOUSE return value from wgetch().  After this value is received,
1003  * _nc_mouse_inline() gets called and is immediately responsible for parsing
1004  * the mouse status information following the prefix.
1005  *
1006  * The following quotes from the ctlseqs.ms document in the XTerm distribution,
1007  * describing the mouse tracking feature:
1008  *
1009  * Parameters for all mouse tracking escape sequences generated by xterm encode
1010  * numeric parameters in a single character as value+040.  For example, ! is
1011  * 1.
1012  *
1013  * On button press or release, xterm sends ESC [ M CbCxCy.  The low two bits of
1014  * Cb encode button information:  0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed,
1015  * 3=release.  The upper bits encode what modifiers were down when the button
1016  * was pressed and are added together.  4=Shift, 8=Meta, 16=Control.  Cx and Cy
1017  * are the x and y coordinates of the mouse event.  The upper left corner is
1018  * (1,1).
1019  *
1020  * (End quote) By the time we get here, we've eaten the key prefix.  FYI, the
1021  * loop below is necessary because mouse click info isn't guaranteed to present
1022  * as a single clist item.
1023  *
1024  * Wheel mice may return buttons 4 and 5 when the wheel is turned.  We encode
1025  * those as button presses.
1026  */
1027 static bool
1028 decode_xterm_X10(SCREEN *sp, MEVENT * eventp)
1029 {
1030 #define MAX_KBUF 3
1031     unsigned char kbuf[MAX_KBUF + 1];
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 < MAX_KBUF; 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, (size_t) (MAX_KBUF - (int) grabbed));
1052         if (res == -1)
1053             break;
1054     }
1055 #if USE_PTHREADS_EINTR
1056     _nc_globals.read_thread = 0;
1057 #endif
1058     kbuf[MAX_KBUF] = '\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 + MAX_KBUF) >= (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         if (b & 4) {
1278             eventp->bstate |= BUTTON_SHIFT;
1279         }
1280         if (b & 8) {
1281             eventp->bstate |= BUTTON_ALT;
1282         }
1283         if (b & 16) {
1284             eventp->bstate |= BUTTON_CTRL;
1285         }
1286         result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
1287         eventp->x = (data.params[1] ? (data.params[1] - 1) : 0);
1288         eventp->y = (data.params[2] ? (data.params[2] - 1) : 0);
1289     }
1290     return result;
1291 }
1292
1293 static bool
1294 _nc_mouse_inline(SCREEN *sp)
1295 /* mouse report received in the keyboard stream -- parse its info */
1296 {
1297     bool result = FALSE;
1298     MEVENT *eventp = sp->_mouse_eventp;
1299
1300     TR(MY_TRACE, ("_nc_mouse_inline() called"));
1301
1302     if (sp->_mouse_type == M_XTERM) {
1303         switch (sp->_mouse_format) {
1304         case MF_X10:
1305             result = decode_xterm_X10(sp, eventp);
1306             break;
1307         case MF_SGR1006:
1308             result = decode_xterm_SGR1006(sp, eventp);
1309             break;
1310 #ifdef EXP_XTERM_1005
1311         case MF_XTERM_1005:
1312             result = decode_xterm_1005(sp, eventp);
1313             break;
1314 #endif
1315         }
1316
1317         TR(MY_TRACE,
1318            ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
1319             _nc_tracemouse(sp, eventp),
1320             (long) IndexEV(sp, eventp)));
1321
1322         /* bump the next-free pointer into the circular list */
1323         sp->_mouse_eventp = NEXT(eventp);
1324
1325         if (!result) {
1326             /* If this event is from a wheel-mouse, treat it like position
1327              * reports and avoid waiting for the release-events which will
1328              * never come.
1329              */
1330             if (eventp->bstate & BUTTON_PRESSED) {
1331                 int b;
1332
1333                 for (b = 4; b <= MAX_BUTTONS; ++b) {
1334                     if ((eventp->bstate & MASK_PRESS(b))) {
1335                         result = TRUE;
1336                         break;
1337                     }
1338                 }
1339             }
1340         }
1341     }
1342
1343     return (result);
1344 }
1345
1346 static void
1347 mouse_activate(SCREEN *sp, int on)
1348 {
1349     if (!on && !sp->_mouse_initialized)
1350         return;
1351
1352     if (!_nc_mouse_init(sp))
1353         return;
1354
1355     if (on) {
1356         sp->_mouse_bstate = 0;
1357         switch (sp->_mouse_type) {
1358         case M_XTERM:
1359 #if NCURSES_EXT_FUNCS
1360             NCURSES_SP_NAME(keyok) (NCURSES_SP_ARGx KEY_MOUSE, on);
1361 #endif
1362             TPUTS_TRACE("xterm mouse initialization");
1363             enable_xterm_mouse(sp, 1);
1364             break;
1365 #if USE_GPM_SUPPORT
1366         case M_GPM:
1367             if (enable_gpm_mouse(sp, TRUE)) {
1368                 sp->_mouse_fd = *(my_gpm_fd);
1369                 T(("GPM mouse_fd %d", sp->_mouse_fd));
1370             }
1371             break;
1372 #endif
1373 #if USE_SYSMOUSE
1374         case M_SYSMOUSE:
1375             signal(SIGUSR2, handle_sysmouse);
1376             sp->_mouse_active = TRUE;
1377             break;
1378 #endif
1379 #ifdef USE_TERM_DRIVER
1380         case M_TERM_DRIVER:
1381             sp->_mouse_active = TRUE;
1382             break;
1383 #endif
1384         case M_NONE:
1385             return;
1386         }
1387         /* Make runtime binding to cut down on object size of applications that
1388          * do not use the mouse (e.g., 'clear').
1389          */
1390         sp->_mouse_event = _nc_mouse_event;
1391         sp->_mouse_inline = _nc_mouse_inline;
1392         sp->_mouse_parse = _nc_mouse_parse;
1393         sp->_mouse_resume = _nc_mouse_resume;
1394         sp->_mouse_wrap = _nc_mouse_wrap;
1395     } else {
1396
1397         switch (sp->_mouse_type) {
1398         case M_XTERM:
1399             TPUTS_TRACE("xterm mouse deinitialization");
1400             enable_xterm_mouse(sp, 0);
1401             break;
1402 #if USE_GPM_SUPPORT
1403         case M_GPM:
1404             enable_gpm_mouse(sp, FALSE);
1405             break;
1406 #endif
1407 #if USE_SYSMOUSE
1408         case M_SYSMOUSE:
1409             signal(SIGUSR2, SIG_IGN);
1410             sp->_mouse_active = FALSE;
1411             break;
1412 #endif
1413 #ifdef USE_TERM_DRIVER
1414         case M_TERM_DRIVER:
1415             sp->_mouse_active = FALSE;
1416             break;
1417 #endif
1418         case M_NONE:
1419             return;
1420         }
1421     }
1422     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1423 }
1424
1425 /**************************************************************************
1426  *
1427  * Device-independent code
1428  *
1429  **************************************************************************/
1430
1431 static bool
1432 _nc_mouse_parse(SCREEN *sp, int runcount)
1433 /* parse a run of atomic mouse events into a gesture */
1434 {
1435     MEVENT *eventp = sp->_mouse_eventp;
1436     MEVENT *next, *ep;
1437     MEVENT *first_valid = NULL;
1438     MEVENT *first_invalid = NULL;
1439     int n;
1440     int b;
1441     bool merge;
1442     bool endLoop;
1443
1444     TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));
1445
1446     /*
1447      * When we enter this routine, the event list next-free pointer
1448      * points just past a run of mouse events that we know were separated
1449      * in time by less than the critical click interval. The job of this
1450      * routine is to collapse this run into a single higher-level event
1451      * or gesture.
1452      *
1453      * We accomplish this in two passes.  The first pass merges press/release
1454      * pairs into click events.  The second merges runs of click events into
1455      * double or triple-click events.
1456      *
1457      * It's possible that the run may not resolve to a single event (for
1458      * example, if the user quadruple-clicks).  If so, leading events
1459      * in the run are ignored if user does not call getmouse in a loop (getting
1460      * them from newest to older).
1461      *
1462      * Note that this routine is independent of the format of the specific
1463      * format of the pointing-device's reports.  We can use it to parse
1464      * gestures on anything that reports press/release events on a per-
1465      * button basis, as long as the device-dependent mouse code puts stuff
1466      * on the queue in MEVENT format.
1467      */
1468
1469     /*
1470      * Reset all events that were not set, in case the user sometimes calls
1471      * getmouse only once and other times until there are no more events in
1472      * queue.
1473      *
1474      * This also allows reaching the beginning of the run.
1475      */
1476     ep = eventp;
1477     for (n = runcount; n < EV_MAX; n++) {
1478         Invalidate(ep);
1479         ep = NEXT(ep);
1480     }
1481
1482 #ifdef TRACE
1483     if (USE_TRACEF(TRACE_IEVENT)) {
1484         _trace_slot(sp, "before mouse press/release merge:");
1485         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1486                 RunParams(sp, eventp, ep),
1487                 runcount);
1488         _nc_unlock_global(tracef);
1489     }
1490 #endif /* TRACE */
1491
1492     /* first pass; merge press/release pairs */
1493     endLoop = FALSE;
1494     while (!endLoop) {
1495         next = NEXT(ep);
1496         if (next == eventp) {
1497             /* Will end the loop, but compact before */
1498             endLoop = TRUE;
1499         } else {
1500
1501 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
1502                       == !(next->bstate & MASK_RELEASE(x)))
1503
1504             if (ValidEvent(ep) && ValidEvent(next)
1505                 && ep->x == next->x && ep->y == next->y
1506                 && (ep->bstate & BUTTON_PRESSED)
1507                 && (!(next->bstate & BUTTON_PRESSED))) {
1508                 bool changed = TRUE;
1509
1510                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1511                     if (!MASK_CHANGED(b)) {
1512                         changed = FALSE;
1513                         break;
1514                     }
1515                 }
1516
1517                 if (changed) {
1518                     merge = FALSE;
1519                     for (b = 1; b <= MAX_BUTTONS; ++b) {
1520                         if ((sp->_mouse_mask & MASK_CLICK(b))
1521                             && (ep->bstate & MASK_PRESS(b))) {
1522                             next->bstate &= ~MASK_RELEASE(b);
1523                             next->bstate |= MASK_CLICK(b);
1524                             merge = TRUE;
1525                         }
1526                     }
1527                     if (merge) {
1528                         Invalidate(ep);
1529                     }
1530                 }
1531             }
1532         }
1533
1534         /* Compact valid events */
1535         if (!ValidEvent(ep)) {
1536             if ((first_valid != NULL) && (first_invalid == NULL)) {
1537                 first_invalid = ep;
1538             }
1539         } else {
1540             if (first_valid == NULL) {
1541                 first_valid = ep;
1542             } else if (first_invalid != NULL) {
1543                 *first_invalid = *ep;
1544                 Invalidate(ep);
1545                 first_invalid = NEXT(first_invalid);
1546             }
1547         }
1548
1549         ep = next;
1550     }
1551
1552     if (first_invalid != NULL) {
1553         eventp = first_invalid;
1554     }
1555 #ifdef TRACE
1556     if (USE_TRACEF(TRACE_IEVENT)) {
1557         _trace_slot(sp, "before mouse click merge:");
1558         if (first_valid == NULL) {
1559             _tracef("_nc_mouse_parse: no valid event");
1560         } else {
1561             _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1562                     RunParams(sp, eventp, first_valid),
1563                     runcount);
1564             _nc_unlock_global(tracef);
1565         }
1566     }
1567 #endif /* TRACE */
1568
1569     /*
1570      * Second pass; merge click runs.  We merge click events forward in the
1571      * queue.  For example, double click can be changed to triple click.
1572      *
1573      * NOTE: There is a problem with this design!  If the application
1574      * allows enough click events to pile up in the circular queue so
1575      * they wrap around, it will cheerfully merge the newest forward
1576      * into the oldest, creating a bogus doubleclick and confusing
1577      * the queue-traversal logic rather badly.  Generally this won't
1578      * happen, because calling getmouse() marks old events invalid and
1579      * ineligible for merges.  The true solution to this problem would
1580      * be to timestamp each MEVENT and perform the obvious sanity check,
1581      * but the timer element would have to have sub-second resolution,
1582      * which would get us into portability trouble.
1583      */
1584     first_invalid = NULL;
1585     endLoop = (first_valid == NULL);
1586     ep = first_valid;
1587     while (!endLoop) {
1588         next = NEXT(ep);
1589
1590         if (next == eventp) {
1591             /* Will end the loop, but check event type and compact before */
1592             endLoop = TRUE;
1593         } else if (!ValidEvent(next)) {
1594             continue;
1595         } else {
1596             /* merge click events forward */
1597             if ((ep->bstate & BUTTON_CLICKED)
1598                 && (next->bstate & BUTTON_CLICKED)) {
1599                 merge = FALSE;
1600                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1601                     if ((sp->_mouse_mask & MASK_DOUBLE_CLICK(b))
1602                         && (ep->bstate & MASK_CLICK(b))
1603                         && (next->bstate & MASK_CLICK(b))) {
1604                         next->bstate &= ~MASK_CLICK(b);
1605                         next->bstate |= MASK_DOUBLE_CLICK(b);
1606                         merge = TRUE;
1607                     }
1608                 }
1609                 if (merge) {
1610                     Invalidate(ep);
1611                 }
1612             }
1613
1614             /* merge double-click events forward */
1615             if ((ep->bstate & BUTTON_DOUBLE_CLICKED)
1616                 && (next->bstate & BUTTON_CLICKED)) {
1617                 merge = FALSE;
1618                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1619                     if ((sp->_mouse_mask & MASK_TRIPLE_CLICK(b))
1620                         && (ep->bstate & MASK_DOUBLE_CLICK(b))
1621                         && (next->bstate & MASK_CLICK(b))) {
1622                         next->bstate &= ~MASK_CLICK(b);
1623                         next->bstate |= MASK_TRIPLE_CLICK(b);
1624                         merge = TRUE;
1625                     }
1626                 }
1627                 if (merge) {
1628                     Invalidate(ep);
1629                 }
1630             }
1631         }
1632
1633         /* Discard event if it does not match event mask */
1634         if (!(ep->bstate & sp->_mouse_mask2)) {
1635             Invalidate(ep);
1636         }
1637
1638         /* Compact valid events */
1639         if (!ValidEvent(ep)) {
1640             if (ep == first_valid) {
1641                 first_valid = next;
1642             } else if (first_invalid == NULL) {
1643                 first_invalid = ep;
1644             }
1645         } else if (first_invalid != NULL) {
1646             *first_invalid = *ep;
1647             Invalidate(ep);
1648             first_invalid = NEXT(first_invalid);
1649         }
1650
1651         ep = next;
1652     }
1653
1654     if (first_invalid == NULL) {
1655         first_invalid = eventp;
1656     }
1657     sp->_mouse_eventp = first_invalid;
1658
1659 #ifdef TRACE
1660     if (first_valid != NULL) {
1661         if (USE_TRACEF(TRACE_IEVENT)) {
1662             _trace_slot(sp, "after mouse event queue compaction:");
1663             _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1664                     RunParams(sp, first_invalid, first_valid),
1665                     runcount);
1666             _nc_unlock_global(tracef);
1667         }
1668         for (ep = first_valid; ep != first_invalid; ep = NEXT(ep)) {
1669             if (ValidEvent(ep))
1670                 TR(MY_TRACE,
1671                    ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
1672                     _nc_tracemouse(sp, ep),
1673                     (long) IndexEV(sp, ep)));
1674         }
1675     }
1676 #endif /* TRACE */
1677
1678     /* after all this, do we have a valid event? */
1679     return ValidEvent(PREV(first_invalid));
1680 }
1681
1682 static void
1683 _nc_mouse_wrap(SCREEN *sp)
1684 /* release mouse -- called by endwin() before shellout/exit */
1685 {
1686     TR(MY_TRACE, ("_nc_mouse_wrap() called"));
1687
1688     switch (sp->_mouse_type) {
1689     case M_XTERM:
1690         if (sp->_mouse_mask)
1691             mouse_activate(sp, FALSE);
1692         break;
1693 #if USE_GPM_SUPPORT
1694         /* GPM: pass all mouse events to next client */
1695     case M_GPM:
1696         if (sp->_mouse_mask)
1697             mouse_activate(sp, FALSE);
1698         break;
1699 #endif
1700 #if USE_SYSMOUSE
1701     case M_SYSMOUSE:
1702         mouse_activate(sp, FALSE);
1703         break;
1704 #endif
1705 #ifdef USE_TERM_DRIVER
1706     case M_TERM_DRIVER:
1707         mouse_activate(sp, FALSE);
1708         break;
1709 #endif
1710     case M_NONE:
1711         break;
1712     }
1713 }
1714
1715 static void
1716 _nc_mouse_resume(SCREEN *sp)
1717 /* re-connect to mouse -- called by doupdate() after shellout */
1718 {
1719     TR(MY_TRACE, ("_nc_mouse_resume() called"));
1720
1721     switch (sp->_mouse_type) {
1722     case M_XTERM:
1723         /* xterm: re-enable reporting */
1724         if (sp->_mouse_mask)
1725             mouse_activate(sp, TRUE);
1726         break;
1727
1728 #if USE_GPM_SUPPORT
1729     case M_GPM:
1730         /* GPM: reclaim our event set */
1731         if (sp->_mouse_mask)
1732             mouse_activate(sp, TRUE);
1733         break;
1734 #endif
1735
1736 #if USE_SYSMOUSE
1737     case M_SYSMOUSE:
1738         mouse_activate(sp, TRUE);
1739         break;
1740 #endif
1741
1742 #ifdef USE_TERM_DRIVER
1743     case M_TERM_DRIVER:
1744         mouse_activate(sp, TRUE);
1745         break;
1746 #endif
1747
1748     case M_NONE:
1749         break;
1750     }
1751 }
1752
1753 /**************************************************************************
1754  *
1755  * Mouse interface entry points for the API
1756  *
1757  **************************************************************************/
1758
1759 NCURSES_EXPORT(int)
1760 NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1761 {
1762     int result = ERR;
1763     MEVENT *eventp;
1764
1765     T((T_CALLED("getmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1766
1767     if ((aevent != 0) &&
1768         (SP_PARM != 0) &&
1769         (SP_PARM->_mouse_type != M_NONE) &&
1770         (eventp = SP_PARM->_mouse_eventp) != 0) {
1771         /* compute the current-event pointer */
1772         MEVENT *prev = PREV(eventp);
1773
1774         /*
1775          * Discard events not matching mask (there could be still some if
1776          * _nc_mouse_parse was not called, e.g., when _nc_mouse_inline returns
1777          * false).
1778          */
1779         while (ValidEvent(prev) && (!(prev->bstate & SP_PARM->_mouse_mask2))) {
1780             Invalidate(prev);
1781             prev = PREV(prev);
1782         }
1783         if (ValidEvent(prev)) {
1784             /* copy the event we find there */
1785             *aevent = *prev;
1786
1787             TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
1788                               _nc_tracemouse(SP_PARM, prev),
1789                               (long) IndexEV(SP_PARM, prev)));
1790
1791             Invalidate(prev);   /* so the queue slot becomes free */
1792             SP_PARM->_mouse_eventp = prev;
1793             result = OK;
1794         } else {
1795             /* Reset the provided event */
1796             aevent->bstate = 0;
1797             Invalidate(aevent);
1798             aevent->x = 0;
1799             aevent->y = 0;
1800             aevent->z = 0;
1801         }
1802     }
1803     returnCode(result);
1804 }
1805
1806 #if NCURSES_SP_FUNCS
1807 /* grab a copy of the current mouse event */
1808 NCURSES_EXPORT(int)
1809 getmouse(MEVENT * aevent)
1810 {
1811     return NCURSES_SP_NAME(getmouse) (CURRENT_SCREEN, aevent);
1812 }
1813 #endif
1814
1815 NCURSES_EXPORT(int)
1816 NCURSES_SP_NAME(ungetmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1817 {
1818     int result = ERR;
1819     MEVENT *eventp;
1820
1821     T((T_CALLED("ungetmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1822
1823     if (aevent != 0 &&
1824         SP_PARM != 0 &&
1825         (eventp = SP_PARM->_mouse_eventp) != 0) {
1826
1827         /* stick the given event in the next-free slot */
1828         *eventp = *aevent;
1829
1830         /* bump the next-free pointer into the circular list */
1831         SP_PARM->_mouse_eventp = NEXT(eventp);
1832
1833         /* push back the notification event on the keyboard queue */
1834         result = NCURSES_SP_NAME(ungetch) (NCURSES_SP_ARGx KEY_MOUSE);
1835     }
1836     returnCode(result);
1837 }
1838
1839 #if NCURSES_SP_FUNCS
1840 /* enqueue a synthesized mouse event to be seen by the next wgetch() */
1841 NCURSES_EXPORT(int)
1842 ungetmouse(MEVENT * aevent)
1843 {
1844     return NCURSES_SP_NAME(ungetmouse) (CURRENT_SCREEN, aevent);
1845 }
1846 #endif
1847
1848 NCURSES_EXPORT(mmask_t)
1849 NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
1850 /* set the mouse event mask */
1851 {
1852     mmask_t result = 0;
1853
1854     T((T_CALLED("mousemask(%p,%#lx,%p)"),
1855        (void *) SP_PARM,
1856        (unsigned long) newmask,
1857        (void *) oldmask));
1858
1859     if (SP_PARM != 0) {
1860         if (oldmask)
1861             *oldmask = SP_PARM->_mouse_mask;
1862
1863         if (newmask || SP_PARM->_mouse_initialized) {
1864             _nc_mouse_init(SP_PARM);
1865
1866             if (SP_PARM->_mouse_type != M_NONE) {
1867                 int b;
1868
1869                 result = newmask &
1870                     (REPORT_MOUSE_POSITION
1871                      | BUTTON_ALT
1872                      | BUTTON_CTRL
1873                      | BUTTON_SHIFT
1874                      | BUTTON_PRESSED
1875                      | BUTTON_RELEASED
1876                      | BUTTON_CLICKED
1877                      | BUTTON_DOUBLE_CLICKED
1878                      | BUTTON_TRIPLE_CLICKED);
1879
1880                 mouse_activate(SP_PARM, (bool) (result != 0));
1881
1882                 SP_PARM->_mouse_mask = result;
1883                 SP_PARM->_mouse_mask2 = result;
1884
1885                 /*
1886                  * Make a mask corresponding to the states we will need to
1887                  * retain (temporarily) while building up the state that the
1888                  * user asked for.
1889                  */
1890                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1891                     if (SP_PARM->_mouse_mask2 & MASK_TRIPLE_CLICK(b))
1892                         SP_PARM->_mouse_mask2 |= MASK_DOUBLE_CLICK(b);
1893                     if (SP_PARM->_mouse_mask2 & MASK_DOUBLE_CLICK(b))
1894                         SP_PARM->_mouse_mask2 |= MASK_CLICK(b);
1895                     if (SP_PARM->_mouse_mask2 & MASK_CLICK(b))
1896                         SP_PARM->_mouse_mask2 |= (MASK_PRESS(b) |
1897                                                   MASK_RELEASE(b));
1898                 }
1899             }
1900         }
1901     }
1902     returnMMask(result);
1903 }
1904
1905 #if NCURSES_SP_FUNCS
1906 NCURSES_EXPORT(mmask_t)
1907 mousemask(mmask_t newmask, mmask_t * oldmask)
1908 {
1909     return NCURSES_SP_NAME(mousemask) (CURRENT_SCREEN, newmask, oldmask);
1910 }
1911 #endif
1912
1913 NCURSES_EXPORT(bool)
1914 wenclose(const WINDOW *win, int y, int x)
1915 /* check to see if given window encloses given screen location */
1916 {
1917     bool result = FALSE;
1918
1919     T((T_CALLED("wenclose(%p,%d,%d)"), (const void *) win, y, x));
1920
1921     if (win != 0) {
1922         y -= win->_yoffset;
1923         result = ((win->_begy <= y &&
1924                    win->_begx <= x &&
1925                    (win->_begx + win->_maxx) >= x &&
1926                    (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
1927     }
1928     returnBool(result);
1929 }
1930
1931 NCURSES_EXPORT(int)
1932 NCURSES_SP_NAME(mouseinterval) (NCURSES_SP_DCLx int maxclick)
1933 /* set the maximum mouse interval within which to recognize a click */
1934 {
1935     int oldval;
1936
1937     T((T_CALLED("mouseinterval(%p,%d)"), (void *) SP_PARM, maxclick));
1938
1939     if (SP_PARM != 0) {
1940         oldval = SP_PARM->_maxclick;
1941         if (maxclick >= 0)
1942             SP_PARM->_maxclick = maxclick;
1943     } else {
1944         oldval = DEFAULT_MAXCLICK;
1945     }
1946
1947     returnCode(oldval);
1948 }
1949
1950 #if NCURSES_SP_FUNCS
1951 NCURSES_EXPORT(int)
1952 mouseinterval(int maxclick)
1953 {
1954     return NCURSES_SP_NAME(mouseinterval) (CURRENT_SCREEN, maxclick);
1955 }
1956 #endif
1957
1958 /* This may be used by other routines to ask for the existence of mouse
1959    support */
1960 NCURSES_EXPORT(bool)
1961 _nc_has_mouse(SCREEN *sp)
1962 {
1963     return (((0 == sp) || (sp->_mouse_type == M_NONE)) ? FALSE : TRUE);
1964 }
1965
1966 NCURSES_EXPORT(bool)
1967 NCURSES_SP_NAME(has_mouse) (NCURSES_SP_DCL0)
1968 {
1969     return _nc_has_mouse(SP_PARM);
1970 }
1971
1972 #if NCURSES_SP_FUNCS
1973 NCURSES_EXPORT(bool)
1974 has_mouse(void)
1975 {
1976     return _nc_has_mouse(CURRENT_SCREEN);
1977 }
1978 #endif
1979
1980 NCURSES_EXPORT(bool)
1981 wmouse_trafo(const WINDOW *win, int *pY, int *pX, bool to_screen)
1982 {
1983     bool result = FALSE;
1984
1985     T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"),
1986        (const void *) win,
1987        (void *) pY,
1988        (void *) pX,
1989        to_screen));
1990
1991     if (win && pY && pX) {
1992         int y = *pY;
1993         int x = *pX;
1994
1995         if (to_screen) {
1996             y += win->_begy + win->_yoffset;
1997             x += win->_begx;
1998             if (wenclose(win, y, x))
1999                 result = TRUE;
2000         } else {
2001             if (wenclose(win, y, x)) {
2002                 y -= (win->_begy + win->_yoffset);
2003                 x -= win->_begx;
2004                 result = TRUE;
2005             }
2006         }
2007         if (result) {
2008             *pX = x;
2009             *pY = y;
2010         }
2011     }
2012     returnBool(result);
2013 }