ncurses/base/lib_mouse.c

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