ncurses/base/lib_mouse.c

   1 /****************************************************************************
   2  * Copyright 2018-2021,2022 Thomas E. Dickey                                *
   3  * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
   4  *                                                                          *
   5  * Permission is hereby granted, free of charge, to any person obtaining a  *
   6  * copy of this software and associated documentation files (the            *
   7  * "Software"), to deal in the Software without restriction, including      *
   8  * without limitation the rights to use, copy, modify, merge, publish,      *
   9  * distribute, distribute with modifications, sublicense, and/or sell       *
  10  * copies of the Software, and to permit persons to whom the Software is    *
  11  * furnished to do so, subject to the following conditions:                 *
  12  *                                                                          *
  13  * The above copyright notice and this permission notice shall be included  *
  14  * in all copies or substantial portions of the Software.                   *
  15  *                                                                          *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23  *                                                                          *
  24  * Except as contained in this notice, the name(s) of the above copyright   *
  25  * holders shall not be used in advertising or otherwise to promote the     *
  26  * sale, use or other dealings in this Software without prior written       *
  27  * authorization.                                                           *
  28  ****************************************************************************/
  29
  30 /****************************************************************************
  31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  33  *     and: Thomas E. Dickey                        1996-on                 *
  34  *     and: Juergen Pfeifer                         2008                    *
  35  ****************************************************************************/
  36
  37 /*
  38  * This module is intended to encapsulate ncurses's interface to pointing
  39  * devices.
  40  *
  41  * The primary method used is xterm's internal mouse-tracking facility.
  42  * Additional methods depend on the platform:
  43  *      Alessandro Rubini's GPM server (Linux)
  44  *      sysmouse (FreeBSD)
  45  *      special-purpose mouse interface for OS/2 EMX.
  46  *
  47  * Notes for implementors of new mouse-interface methods:
  48  *
  49  * The code is logically split into a lower level that accepts event reports
  50  * in a device-dependent format and an upper level that parses mouse gestures
  51  * and filters events.  The mediating data structure is a circular queue of
  52  * MEVENT structures.
  53  *
  54  * Functionally, the lower level's job is to pick up primitive events and
  55  * put them on the circular queue.  This can happen in one of two ways:
  56  * either (a) _nc_mouse_event() detects a series of incoming mouse reports
  57  * and queues them, or (b) code in lib_getch.c detects the kmous prefix in
  58  * the keyboard input stream and calls _nc_mouse_inline to queue up a series
  59  * of adjacent mouse reports.
  60  *
  61  * In either case, _nc_mouse_parse() should be called after the series is
  62  * accepted to parse the digested mouse reports (low-level MEVENTs) into
  63  * a gesture (a high-level or composite MEVENT).
  64  *
  65  * Don't be too shy about adding new event types or modifiers, if you can find
  66  * room for them in the 32-bit mask.  The API is written so that users get
  67  * feedback on which theoretical event types they won't see when they call
  68  * mousemask. There's one bit per button (the RESERVED_EVENT bit) not being
  69  * used yet, and a couple of bits open at the high end.
  70  */
  71
  72 #ifdef __EMX__
  73 #  include <io.h>
  74 #  define  INCL_DOS
  75 #  define  INCL_VIO
  76 #  define  INCL_KBD
  77 #  define  INCL_MOU
  78 #  define  INCL_DOSPROCESS
  79 #  include <os2.h>              /* Need to include before the others */
  80 #endif
  81
  82 #include <curses.priv.h>
  83
  84 #ifndef CUR
  85 #define CUR SP_TERMTYPE
  86 #endif
  87
  88 MODULE_ID("$Id: lib_mouse.c,v 1.197 2022/08/13 14:13:12 tom Exp $")
  89
  90 #include <tic.h>
  91
  92 #if USE_GPM_SUPPORT
  93 #include <linux/keyboard.h>     /* defines KG_* macros */
  94
  95 #ifdef HAVE_LIBDL
  96 /* use dynamic loader to avoid linkage dependency */
  97 #include <dlfcn.h>
  98
  99 #ifdef RTLD_NOW
 100 #define my_RTLD RTLD_NOW
 101 #else
 102 #ifdef RTLD_LAZY
 103 #define my_RTLD RTLD_LAZY
 104 #else
 105 make an error
 106 #endif
 107 #endif                          /* RTLD_NOW */
 108 #endif                          /* HAVE_LIBDL */
 109
 110 #endif                          /* USE_GPM_SUPPORT */
 111
 112 #if USE_SYSMOUSE
 113 #undef buttons                  /* symbol conflict in consio.h */
 114 #undef mouse_info               /* symbol conflict in consio.h */
 115 #include <osreldate.h>
 116 #if defined(__DragonFly_version) || (defined(__FreeBSD__) && (__FreeBSD_version >= 400017))
 117 #include <sys/consio.h>
 118 #include <sys/fbio.h>
 119 #else
 120 #include <machine/console.h>
 121 #endif
 122 #endif                          /* use_SYSMOUSE */
 123
 124 #if USE_KLIBC_MOUSE
 125 #include <sys/socket.h>
 126 #define pipe(handles) socketpair(AF_LOCAL, SOCK_STREAM, 0, handles)
 127 #define DosWrite(hfile, pbuffer, cbwrite, pcbactual) \
 128                 write(hfile, pbuffer, cbwrite)
 129 #define DosExit(action, result )        /* do nothing */
 130 #define DosCreateThread(ptid, pfn, param, flag, cbStack) \
 131                 (*(ptid) = _beginthread(pfn, NULL, cbStack, \
 132                                         (void *)param), (*(ptid) == -1))
 133 #endif
 134
 135 #define MY_TRACE TRACE_ICALLS|TRACE_IEVENT
 136
 137 #define MASK_RELEASE(x)         (mmask_t) NCURSES_MOUSE_MASK(x, 001)
 138 #define MASK_PRESS(x)           (mmask_t) NCURSES_MOUSE_MASK(x, 002)
 139 #define MASK_CLICK(x)           (mmask_t) NCURSES_MOUSE_MASK(x, 004)
 140 #define MASK_DOUBLE_CLICK(x)    (mmask_t) NCURSES_MOUSE_MASK(x, 010)
 141 #define MASK_TRIPLE_CLICK(x)    (mmask_t) NCURSES_MOUSE_MASK(x, 020)
 142 #define MASK_RESERVED_EVENT(x)  (mmask_t) NCURSES_MOUSE_MASK(x, 040)
 143
 144 #if NCURSES_MOUSE_VERSION == 1
 145
 146 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED)
 147 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED)
 148 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED)
 149 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED)
 150 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED)
 151
 152 #define MAX_BUTTONS  4
 153
 154 #else
 155
 156 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED        | BUTTON5_CLICKED)
 157 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED        | BUTTON5_PRESSED)
 158 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED       | BUTTON5_RELEASED)
 159 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED | BUTTON5_DOUBLE_CLICKED)
 160 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED | BUTTON5_TRIPLE_CLICKED)
 161
 162 #if NCURSES_MOUSE_VERSION == 2
 163 #define MAX_BUTTONS  5
 164 #else
 165 #define MAX_BUTTONS  11
 166 #endif
 167
 168 #endif
 169
 170 #define INVALID_EVENT   -1
 171 #define NORMAL_EVENT    0
 172
 173 #define ValidEvent(ep) ((ep)->id != INVALID_EVENT)
 174 #define Invalidate(ep) (ep)->id = INVALID_EVENT
 175
 176 #if USE_GPM_SUPPORT
 177
 178 #ifndef LIBGPM_SONAME
 179 #define LIBGPM_SONAME "libgpm.so"
 180 #endif
 181
 182 #define GET_DLSYM(name) (my_##name = (TYPE_##name) dlsym(sp->_dlopen_gpm, #name))
 183
 184 #endif                          /* USE_GPM_SUPPORT */
 185
 186 static bool _nc_mouse_parse(SCREEN *, int);
 187 static void _nc_mouse_resume(SCREEN *);
 188 static void _nc_mouse_wrap(SCREEN *);
 189
 190 /* maintain a circular list of mouse events */
 191
 192 #define FirstEV(sp)     ((sp)->_mouse_events)
 193 #define LastEV(sp)      ((sp)->_mouse_events + EV_MAX - 1)
 194
 195 #undef  NEXT
 196 #define NEXT(ep)        ((ep >= LastEV(SP_PARM)) \
 197                          ? FirstEV(SP_PARM) \
 198                          : ep + 1)
 199
 200 #undef  PREV
 201 #define PREV(ep)        ((ep <= FirstEV(SP_PARM)) \
 202                          ? LastEV(SP_PARM) \
 203                          : ep - 1)
 204
 205 #define IndexEV(sp, ep) (ep - FirstEV(sp))
 206
 207 #define RunParams(sp, eventp, runp) \
 208                 (long) IndexEV(sp, runp), \
 209                 (long) (IndexEV(sp, eventp) + (EV_MAX - 1)) % EV_MAX
 210
 211 #ifdef TRACE
 212 static void
 213 _trace_slot(SCREEN *sp, const char *tag)
 214 {
 215     MEVENT *ep;
 216
 217     _tracef("%s", tag);
 218
 219     for (ep = FirstEV(sp); ep <= LastEV(sp); ep++)
 220         _tracef("mouse event queue slot %ld = %s",
 221                 (long) IndexEV(sp, ep),
 222                 _nc_tracemouse(sp, ep));
 223 }
 224 #endif
 225
 226 #if USE_EMX_MOUSE
 227
 228 #  define TOP_ROW          0
 229 #  define LEFT_COL         0
 230
 231 #  define M_FD(sp) sp->_mouse_fd
 232
 233 static void
 234 write_event(SCREEN *sp, int down, int button, int x, int y)
 235 {
 236     char buf[6];
 237     unsigned long ignore;
 238
 239     _nc_STRCPY(buf, "\033[M", sizeof(buf));     /* should be the same as key_mouse */
 240     buf[3] = ' ' + (button - 1) + (down ? 0 : 0x40);
 241     buf[4] = ' ' + x - LEFT_COL + 1;
 242     buf[5] = ' ' + y - TOP_ROW + 1;
 243     DosWrite(sp->_emxmouse_wfd, buf, 6, &ignore);
 244 }
 245
 246 static void
 247 #if USE_KLIBC_MOUSE
 248 mouse_server(void *param)
 249 #else
 250 mouse_server(unsigned long param)
 251 #endif
 252 {
 253     SCREEN *sp = (SCREEN *) param;
 254     unsigned short fWait = MOU_WAIT;
 255     /* NOPTRRECT mourt = { 0,0,24,79 }; */
 256     MOUEVENTINFO mouev;
 257     HMOU hmou;
 258     unsigned short mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN | MOUSE_BN3_DOWN;
 259     int nbuttons = 3;
 260     int oldstate = 0;
 261     char err[80];
 262     unsigned long rc;
 263
 264     /* open the handle for the mouse */
 265     if (MouOpen(NULL, &hmou) == 0) {
 266         rc = MouSetEventMask(&mask, hmou);
 267         if (rc) {               /* retry with 2 buttons */
 268             mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN;
 269             rc = MouSetEventMask(&mask, hmou);
 270             nbuttons = 2;
 271         }
 272         if (rc == 0 && MouDrawPtr(hmou) == 0) {
 273             for (;;) {
 274                 /* sit and wait on the event queue */
 275                 rc = MouReadEventQue(&mouev, &fWait, hmou);
 276                 if (rc) {
 277                     _nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
 278                                 "Error reading mouse queue, rc=%lu.\r\n", rc);
 279                     break;
 280                 }
 281                 if (!sp->_emxmouse_activated)
 282                     goto finish;
 283
 284                 /*
 285                  * OS/2 numbers a 3-button mouse inconsistently from other
 286                  * platforms:
 287                  *      1 = left
 288                  *      2 = right
 289                  *      3 = middle.
 290                  */
 291                 if ((mouev.fs ^ oldstate) & MOUSE_BN1_DOWN)
 292                     write_event(sp, mouev.fs & MOUSE_BN1_DOWN,
 293                                 sp->_emxmouse_buttons[1], mouev.col, mouev.row);
 294                 if ((mouev.fs ^ oldstate) & MOUSE_BN2_DOWN)
 295                     write_event(sp, mouev.fs & MOUSE_BN2_DOWN,
 296                                 sp->_emxmouse_buttons[3], mouev.col, mouev.row);
 297                 if ((mouev.fs ^ oldstate) & MOUSE_BN3_DOWN)
 298                     write_event(sp, mouev.fs & MOUSE_BN3_DOWN,
 299                                 sp->_emxmouse_buttons[2], mouev.col, mouev.row);
 300
 301               finish:
 302                 oldstate = mouev.fs;
 303             }
 304         } else {
 305             _nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
 306                         "Error setting event mask, buttons=%d, rc=%lu.\r\n",
 307                         nbuttons, rc);
 308         }
 309
 310         DosWrite(2, err, strlen(err), &rc);
 311         MouClose(hmou);
 312     }
 313     DosExit(EXIT_THREAD, 0L);
 314 }
 315
 316 #endif /* USE_EMX_MOUSE */
 317
 318 #if USE_SYSMOUSE
 319 static void
 320 sysmouse_server(SCREEN *sp)
 321 {
 322     struct mouse_info the_mouse;
 323     MEVENT *work;
 324
 325     the_mouse.operation = MOUSE_GETINFO;
 326     if (sp != 0
 327         && sp->_mouse_fd >= 0
 328         && sp->_sysmouse_tail < FIFO_SIZE
 329         && ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
 330
 331         if (sp->_sysmouse_head > sp->_sysmouse_tail) {
 332             sp->_sysmouse_tail = 0;
 333             sp->_sysmouse_head = 0;
 334         }
 335         work = &(sp->_sysmouse_fifo[sp->_sysmouse_tail]);
 336         memset(work, 0, sizeof(*work));
 337         work->id = NORMAL_EVENT;        /* there's only one mouse... */
 338
 339         sp->_sysmouse_old_buttons = sp->_sysmouse_new_buttons;
 340         sp->_sysmouse_new_buttons = the_mouse.u.data.buttons & 0x7;
 341
 342         if (sp->_sysmouse_new_buttons) {
 343             if (sp->_sysmouse_new_buttons & 1)
 344                 work->bstate |= BUTTON1_PRESSED;
 345             if (sp->_sysmouse_new_buttons & 2)
 346                 work->bstate |= BUTTON2_PRESSED;
 347             if (sp->_sysmouse_new_buttons & 4)
 348                 work->bstate |= BUTTON3_PRESSED;
 349         } else {
 350             if (sp->_sysmouse_old_buttons & 1)
 351                 work->bstate |= BUTTON1_RELEASED;
 352             if (sp->_sysmouse_old_buttons & 2)
 353                 work->bstate |= BUTTON2_RELEASED;
 354             if (sp->_sysmouse_old_buttons & 4)
 355                 work->bstate |= BUTTON3_RELEASED;
 356         }
 357
 358         /* for cosmetic bug in syscons.c on FreeBSD 3.[34] */
 359         the_mouse.operation = MOUSE_HIDE;
 360         ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
 361         the_mouse.operation = MOUSE_SHOW;
 362         ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
 363
 364         /*
 365          * We're only interested if the button is pressed or released.
 366          * FIXME: implement continuous event-tracking.
 367          */
 368         if (sp->_sysmouse_new_buttons != sp->_sysmouse_old_buttons) {
 369             sp->_sysmouse_tail += 1;
 370         }
 371         work->x = the_mouse.u.data.x / sp->_sysmouse_char_width;
 372         work->y = the_mouse.u.data.y / sp->_sysmouse_char_height;
 373     }
 374 }
 375
 376 static void
 377 handle_sysmouse(int sig GCC_UNUSED)
 378 {
 379     sysmouse_server(CURRENT_SCREEN);
 380 }
 381 #endif /* USE_SYSMOUSE */
 382
 383 #ifndef USE_TERM_DRIVER
 384 #define xterm_kmous "\033[M"
 385
 386 static void
 387 init_xterm_mouse(SCREEN *sp)
 388 {
 389     sp->_mouse_type = M_XTERM;
 390     sp->_mouse_format = MF_X10;
 391     sp->_mouse_xtermcap = tigetstr("XM");
 392     if (VALID_STRING(sp->_mouse_xtermcap)) {
 393         char *code = strstr(sp->_mouse_xtermcap, "[?");
 394         if (code != 0) {
 395             code += 2;
 396             while ((*code >= '0') && (*code <= '9')) {
 397                 char *next = code;
 398                 while ((*next >= '0') && (*next <= '9')) {
 399                     ++next;
 400                 }
 401                 if (!strncmp(code, "1006", (size_t) (next - code))) {
 402                     sp->_mouse_format = MF_SGR1006;
 403                 }
 404 #ifdef EXP_XTERM_1005
 405                 if (!strncmp(code, "1005", (size_t) (next - code))) {
 406                     sp->_mouse_format = MF_XTERM_1005;
 407                 }
 408 #endif
 409                 if (*next == ';') {
 410                     while (*next == ';') {
 411                         ++next;
 412                     }
 413                     code = next;
 414                 } else {
 415                     break;
 416                 }
 417             }
 418         }
 419     } else {
 420         int code = tigetnum("XM");
 421         switch (code) {
 422 #ifdef EXP_XTERM_1005
 423         case 1005:
 424             /* see "xterm+sm+1005" */
 425             sp->_mouse_xtermcap = "\033[?1005;1000%?%p1%{1}%=%th%el%;";
 426             sp->_mouse_format = MF_XTERM_1005;
 427             break;
 428 #endif
 429         case 1006:
 430             /* see "xterm+sm+1006" */
 431             sp->_mouse_xtermcap = "\033[?1006;1000%?%p1%{1}%=%th%el%;";
 432             sp->_mouse_format = MF_SGR1006;
 433             break;
 434         default:
 435             sp->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
 436             break;
 437         }
 438     }
 439 }
 440 #endif
 441
 442 static void
 443 enable_xterm_mouse(SCREEN *sp, int enable)
 444 {
 445 #if USE_EMX_MOUSE
 446     sp->_emxmouse_activated = enable;
 447 #else
 448     NCURSES_PUTP2("xterm-mouse", TIPARM_1(sp->_mouse_xtermcap, enable));
 449 #endif
 450     sp->_mouse_active = enable;
 451 }
 452
 453 #if USE_GPM_SUPPORT
 454 static bool
 455 allow_gpm_mouse(SCREEN *sp GCC_UNUSED)
 456 {
 457     bool result = FALSE;
 458
 459 #if USE_WEAK_SYMBOLS
 460     /* Danger Robinson: do not use dlopen for libgpm if already loaded */
 461     if ((Gpm_Wgetch) != 0) {
 462         if (!sp->_mouse_gpm_loaded) {
 463             T(("GPM library was already dlopen'd, not by us"));
 464         }
 465     } else
 466 #endif
 467         /* GPM does printf's without checking if stdout is a terminal */
 468     if (NC_ISATTY(fileno(stdout))) {
 469         const char *list = getenv("NCURSES_GPM_TERMS");
 470         const char *env = getenv("TERM");
 471         if (list != 0) {
 472             if (env != 0) {
 473                 result = _nc_name_match(list, env, "|:");
 474             }
 475         } else {
 476             /* GPM checks the beginning of the $TERM variable to decide if it
 477              * should pass xterm events through.  There is no real advantage in
 478              * allowing GPM to do this.  Recent versions relax that check, and
 479              * pretend that GPM can work with any terminal having the kmous
 480              * capability.  Perhaps that works for someone.  If so, they can
 481              * set the environment variable (above).
 482              */
 483             if (env != 0 && strstr(env, "linux") != 0) {
 484                 result = TRUE;
 485             }
 486         }
 487     }
 488     return result;
 489 }
 490
 491 #ifdef HAVE_LIBDL
 492 static void
 493 unload_gpm_library(SCREEN *sp)
 494 {
 495     if (sp->_dlopen_gpm != 0) {
 496         T(("unload GPM library"));
 497         sp->_mouse_gpm_loaded = FALSE;
 498         sp->_mouse_fd = -1;
 499     }
 500 }
 501
 502 static void
 503 load_gpm_library(SCREEN *sp)
 504 {
 505     sp->_mouse_gpm_found = FALSE;
 506
 507     /*
 508      * If we already had a successful dlopen, reuse it.
 509      */
 510     if (sp->_dlopen_gpm != 0) {
 511         sp->_mouse_gpm_found = TRUE;
 512         sp->_mouse_gpm_loaded = TRUE;
 513     } else if ((sp->_dlopen_gpm = dlopen(LIBGPM_SONAME, my_RTLD)) != 0) {
 514 #if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
 515 #pragma GCC diagnostic push
 516 #pragma GCC diagnostic ignored "-Wpedantic"
 517 #endif
 518         if (GET_DLSYM(gpm_fd) == 0 ||
 519             GET_DLSYM(Gpm_Open) == 0 ||
 520             GET_DLSYM(Gpm_Close) == 0 ||
 521             GET_DLSYM(Gpm_GetEvent) == 0) {
 522 #if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
 523 #pragma GCC diagnostic pop
 524 #endif
 525             T(("GPM initialization failed: %s", dlerror()));
 526             unload_gpm_library(sp);
 527             dlclose(sp->_dlopen_gpm);
 528             sp->_dlopen_gpm = 0;
 529         } else {
 530             sp->_mouse_gpm_found = TRUE;
 531             sp->_mouse_gpm_loaded = TRUE;
 532         }
 533     }
 534 }
 535 #endif /* HAVE_LIBDL */
 536
 537 static bool
 538 enable_gpm_mouse(SCREEN *sp, bool enable)
 539 {
 540     bool result;
 541
 542     T((T_CALLED("enable_gpm_mouse(%d)"), enable));
 543
 544     if (enable && !sp->_mouse_active) {
 545 #ifdef HAVE_LIBDL
 546         if (sp->_mouse_gpm_found && !sp->_mouse_gpm_loaded) {
 547             load_gpm_library(sp);
 548         }
 549 #endif
 550         if (sp->_mouse_gpm_loaded) {
 551             int code;
 552
 553             /* GPM: initialize connection to gpm server */
 554             sp->_mouse_gpm_connect.eventMask = GPM_DOWN | GPM_UP;
 555             sp->_mouse_gpm_connect.defaultMask =
 556                 (unsigned short) (~(sp->_mouse_gpm_connect.eventMask | GPM_HARD));
 557             sp->_mouse_gpm_connect.minMod = 0;
 558             sp->_mouse_gpm_connect.maxMod =
 559                 (unsigned short) (~((1 << KG_SHIFT) |
 560                                     (1 << KG_SHIFTL) |
 561                                     (1 << KG_SHIFTR)));
 562             /*
 563              * Note: GPM hardcodes \E[?1001s and \E[?1000h during its open.
 564              * The former is recognized by wscons (SunOS), and the latter by
 565              * xterm.  Those will not show up in ncurses' traces.
 566              */
 567             code = my_Gpm_Open(&sp->_mouse_gpm_connect, 0);
 568             result = (code >= 0);
 569
 570             /*
 571              * GPM can return a -2 if it is trying to do something with xterm.
 572              * Ignore that, since it conflicts with our use of stdin.
 573              */
 574             if (code == -2) {
 575                 my_Gpm_Close();
 576             }
 577         } else {
 578             result = FALSE;
 579         }
 580         sp->_mouse_active = result;
 581         T(("GPM open %s", result ? "succeeded" : "failed"));
 582     } else {
 583         if (!enable && sp->_mouse_active) {
 584             /* GPM: close connection to gpm server */
 585             my_Gpm_Close();
 586             sp->_mouse_active = FALSE;
 587             T(("GPM closed"));
 588         }
 589         result = enable;
 590     }
 591 #ifdef HAVE_LIBDL
 592     if (!result) {
 593         unload_gpm_library(sp);
 594     }
 595 #endif
 596     returnBool(result);
 597 }
 598 #endif /* USE_GPM_SUPPORT */
 599
 600 static void
 601 initialize_mousetype(SCREEN *sp)
 602 {
 603     T((T_CALLED("initialize_mousetype()")));
 604
 605     /* Try gpm first, because gpm may be configured to run in xterm */
 606 #if USE_GPM_SUPPORT
 607     if (allow_gpm_mouse(sp)) {
 608         if (!sp->_mouse_gpm_loaded) {
 609 #ifdef HAVE_LIBDL
 610             load_gpm_library(sp);
 611 #else /* !HAVE_LIBDL */
 612             sp->_mouse_gpm_found = TRUE;
 613             sp->_mouse_gpm_loaded = TRUE;
 614 #endif
 615         }
 616
 617         /*
 618          * The gpm_fd file-descriptor may be negative (xterm).  So we have to
 619          * maintain our notion of whether the mouse connection is active
 620          * without testing the file-descriptor.
 621          */
 622         if (sp->_mouse_gpm_found && enable_gpm_mouse(sp, TRUE)) {
 623             sp->_mouse_type = M_GPM;
 624             sp->_mouse_fd = *(my_gpm_fd);
 625             T(("GPM mouse_fd %d", sp->_mouse_fd));
 626             returnVoid;
 627         }
 628     }
 629 #endif /* USE_GPM_SUPPORT */
 630
 631     /* OS/2 VIO */
 632 #if USE_EMX_MOUSE
 633     if (!sp->_emxmouse_thread
 634         && strstr(SP_TERMTYPE term_names, "xterm") == 0
 635         && NonEmpty(key_mouse)) {
 636         int handles[2];
 637
 638         if (pipe(handles) < 0) {
 639             perror("mouse pipe error");
 640             returnVoid;
 641         } else {
 642             int rc;
 643
 644             if (!sp->_emxmouse_buttons[0]) {
 645                 const char *s = getenv("MOUSE_BUTTONS_123");
 646
 647                 sp->_emxmouse_buttons[0] = 1;
 648                 if (s && strlen(s) >= 3) {
 649                     sp->_emxmouse_buttons[1] = s[0] - '0';
 650                     sp->_emxmouse_buttons[2] = s[1] - '0';
 651                     sp->_emxmouse_buttons[3] = s[2] - '0';
 652                 } else {
 653                     sp->_emxmouse_buttons[1] = 1;
 654                     sp->_emxmouse_buttons[2] = 3;
 655                     sp->_emxmouse_buttons[3] = 2;
 656                 }
 657             }
 658             sp->_emxmouse_wfd = handles[1];
 659             M_FD(sp) = handles[0];
 660             /* Needed? */
 661             setmode(handles[0], O_BINARY);
 662             setmode(handles[1], O_BINARY);
 663             /* Do not use CRT functions, we may single-threaded. */
 664             rc = DosCreateThread((unsigned long *) &sp->_emxmouse_thread,
 665                                  mouse_server, (long) sp, 0, 8192);
 666             if (rc) {
 667                 printf("mouse thread error %d=%#x", rc, rc);
 668             } else {
 669                 sp->_mouse_type = M_XTERM;
 670             }
 671             returnVoid;
 672         }
 673     }
 674 #endif /* USE_EMX_MOUSE */
 675
 676 #if USE_SYSMOUSE
 677     {
 678         static char dev_tty[] = "/dev/tty";
 679         struct mouse_info the_mouse;
 680         char *the_device = 0;
 681
 682         if (NC_ISATTY(sp->_ifd))
 683             the_device = ttyname(sp->_ifd);
 684         if (the_device == 0)
 685             the_device = dev_tty;
 686
 687         sp->_mouse_fd = open(the_device, O_RDWR);
 688
 689         if (sp->_mouse_fd >= 0) {
 690             /*
 691              * sysmouse does not have a usable user interface for obtaining
 692              * mouse events.  The logical way to proceed (reading data on a
 693              * stream) only works if one opens the device as root.  Even in
 694              * that mode, careful examination shows we lose events
 695              * occasionally.  The interface provided for user programs is to
 696              * establish a signal handler.  really.
 697              *
 698              * Take over SIGUSR2 for this purpose since SIGUSR1 is more
 699              * likely to be used by an application.  getch() will have to
 700              * handle the misleading EINTR's.
 701              */
 702             signal(SIGUSR2, SIG_IGN);
 703             the_mouse.operation = MOUSE_MODE;
 704             the_mouse.u.mode.mode = 0;
 705             the_mouse.u.mode.signal = SIGUSR2;
 706             if (ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
 707                 signal(SIGUSR2, handle_sysmouse);
 708                 the_mouse.operation = MOUSE_SHOW;
 709                 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
 710
 711 #if defined(FBIO_MODEINFO) || defined(CONS_MODEINFO)    /* FreeBSD > 2.x */
 712                 {
 713 #ifndef FBIO_GETMODE            /* FreeBSD 3.x */
 714 #define FBIO_GETMODE    CONS_GET
 715 #define FBIO_MODEINFO   CONS_MODEINFO
 716 #endif /* FBIO_GETMODE */
 717                     video_info_t the_video;
 718
 719                     if (ioctl(sp->_mouse_fd,
 720                               FBIO_GETMODE,
 721                               &the_video.vi_mode) != -1
 722                         && ioctl(sp->_mouse_fd,
 723                                  FBIO_MODEINFO,
 724                                  &the_video) != -1) {
 725                         sp->_sysmouse_char_width = the_video.vi_cwidth;
 726                         sp->_sysmouse_char_height = the_video.vi_cheight;
 727                     }
 728                 }
 729 #endif /* defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) */
 730
 731                 if (sp->_sysmouse_char_width <= 0)
 732                     sp->_sysmouse_char_width = 8;
 733                 if (sp->_sysmouse_char_height <= 0)
 734                     sp->_sysmouse_char_height = 16;
 735                 sp->_mouse_type = M_SYSMOUSE;
 736                 returnVoid;
 737             }
 738         }
 739     }
 740 #endif /* USE_SYSMOUSE */
 741
 742 #ifdef USE_TERM_DRIVER
 743     CallDriver(sp, td_initmouse);
 744 #else
 745     /* we know how to recognize mouse events under "xterm" */
 746     if (NonEmpty(key_mouse)) {
 747         init_xterm_mouse(sp);
 748     } else if (strstr(SP_TERMTYPE term_names, "xterm") != 0) {
 749         if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
 750             init_xterm_mouse(sp);
 751     }
 752 #endif
 753
 754     returnVoid;
 755 }
 756
 757 static bool
 758 _nc_mouse_init(SCREEN *sp)
 759 /* initialize the mouse */
 760 {
 761     bool result = FALSE;
 762
 763     if (sp != 0) {
 764         if (!sp->_mouse_initialized) {
 765             int i;
 766
 767             sp->_mouse_initialized = TRUE;
 768
 769             TR(MY_TRACE, ("_nc_mouse_init() called"));
 770
 771             sp->_mouse_eventp = FirstEV(sp);
 772             for (i = 0; i < EV_MAX; i++)
 773                 Invalidate(sp->_mouse_events + i);
 774
 775             initialize_mousetype(sp);
 776
 777             T(("_nc_mouse_init() set mousetype to %d", sp->_mouse_type));
 778         }
 779         result = sp->_mouse_initialized;
 780     }
 781     return result;
 782 }
 783
 784 /*
 785  * Query to see if there is a pending mouse event.  This is called from
 786  * fifo_push() in lib_getch.c
 787  */
 788 static bool
 789 _nc_mouse_event(SCREEN *sp)
 790 {
 791     MEVENT *eventp = sp->_mouse_eventp;
 792     bool result = FALSE;
 793
 794     (void) eventp;
 795
 796     switch (sp->_mouse_type) {
 797     case M_XTERM:
 798         /* xterm: never have to query, mouse events are in the keyboard stream */
 799 #if USE_EMX_MOUSE
 800         {
 801             char kbuf[3];
 802
 803             int i, res = read(M_FD(sp), &kbuf, 3);      /* Eat the prefix */
 804             if (res != 3)
 805                 printf("Got %d chars instead of 3 for prefix.\n", res);
 806             for (i = 0; i < res; i++) {
 807                 if (kbuf[i] != key_mouse[i])
 808                     printf("Got char %d instead of %d for prefix.\n",
 809                            (int) kbuf[i], (int) key_mouse[i]);
 810             }
 811             result = TRUE;
 812         }
 813 #endif /* USE_EMX_MOUSE */
 814         break;
 815
 816 #if USE_GPM_SUPPORT
 817     case M_GPM:
 818         if (sp->_mouse_fd >= 0) {
 819             /* query server for event, return TRUE if we find one */
 820             Gpm_Event ev;
 821
 822             switch (my_Gpm_GetEvent(&ev)) {
 823             case 0:
 824                 /* Connection closed, drop the mouse. */
 825                 sp->_mouse_fd = -1;
 826                 break;
 827             case 1:
 828                 /* there's only one mouse... */
 829                 eventp->id = NORMAL_EVENT;
 830
 831                 eventp->bstate = 0;
 832                 switch (ev.type & 0x0f) {
 833                 case (GPM_DOWN):
 834                     if (ev.buttons & GPM_B_LEFT)
 835                         eventp->bstate |= BUTTON1_PRESSED;
 836                     if (ev.buttons & GPM_B_MIDDLE)
 837                         eventp->bstate |= BUTTON2_PRESSED;
 838                     if (ev.buttons & GPM_B_RIGHT)
 839                         eventp->bstate |= BUTTON3_PRESSED;
 840                     break;
 841                 case (GPM_UP):
 842                     if (ev.buttons & GPM_B_LEFT)
 843                         eventp->bstate |= BUTTON1_RELEASED;
 844                     if (ev.buttons & GPM_B_MIDDLE)
 845                         eventp->bstate |= BUTTON2_RELEASED;
 846                     if (ev.buttons & GPM_B_RIGHT)
 847                         eventp->bstate |= BUTTON3_RELEASED;
 848                     break;
 849                 default:
 850                     eventp->bstate |= REPORT_MOUSE_POSITION;
 851                     break;
 852                 }
 853
 854                 eventp->x = ev.x - 1;
 855                 eventp->y = ev.y - 1;
 856                 eventp->z = 0;
 857
 858                 /* bump the next-free pointer into the circular list */
 859                 sp->_mouse_eventp = NEXT(eventp);
 860                 result = TRUE;
 861                 break;
 862             }
 863         }
 864         break;
 865 #endif
 866
 867 #if USE_SYSMOUSE
 868     case M_SYSMOUSE:
 869         if (sp->_sysmouse_head < sp->_sysmouse_tail) {
 870             *eventp = sp->_sysmouse_fifo[sp->_sysmouse_head];
 871
 872             /*
 873              * Point the fifo-head to the next possible location.  If there
 874              * are none, reset the indices.  This may be interrupted by the
 875              * signal handler, doing essentially the same reset.
 876              */
 877             sp->_sysmouse_head += 1;
 878             if (sp->_sysmouse_head == sp->_sysmouse_tail) {
 879                 sp->_sysmouse_tail = 0;
 880                 sp->_sysmouse_head = 0;
 881             }
 882
 883             /* bump the next-free pointer into the circular list */
 884             sp->_mouse_eventp = eventp = NEXT(eventp);
 885             result = TRUE;
 886         }
 887         break;
 888 #endif /* USE_SYSMOUSE */
 889
 890 #ifdef USE_TERM_DRIVER
 891     case M_TERM_DRIVER:
 892         while (sp->_drv_mouse_head < sp->_drv_mouse_tail) {
 893             *eventp = sp->_drv_mouse_fifo[sp->_drv_mouse_head];
 894
 895             /*
 896              * Point the fifo-head to the next possible location.  If there
 897              * are none, reset the indices.
 898              */
 899             sp->_drv_mouse_head += 1;
 900             if (sp->_drv_mouse_head == sp->_drv_mouse_tail) {
 901                 sp->_drv_mouse_tail = 0;
 902                 sp->_drv_mouse_head = 0;
 903             }
 904
 905             /* bump the next-free pointer into the circular list */
 906             sp->_mouse_eventp = eventp = NEXT(eventp);
 907             result = TRUE;
 908         }
 909         break;
 910 #endif
 911
 912     case M_NONE:
 913         break;
 914     }
 915
 916     return result;              /* true if we found an event */
 917 }
 918
 919 #if USE_EMX_MOUSE
 920 #define PRESS_POSITION(n) \
 921     do { \
 922             eventp->bstate = MASK_PRESS(n); \
 923             sp->_mouse_bstate |= MASK_PRESS(n); \
 924             if (button & 0x40) { \
 925                     eventp->bstate = MASK_RELEASE(n); \
 926                     sp->_mouse_bstate &= ~MASK_PRESS(n); \
 927             } \
 928     } while (0)
 929 #else
 930 #define PRESS_POSITION(n) \
 931     do { \
 932             eventp->bstate = (mmask_t) ((sp->_mouse_bstate & MASK_PRESS(n)) \
 933                                     ? REPORT_MOUSE_POSITION \
 934                                     : MASK_PRESS(n)); \
 935             sp->_mouse_bstate |= MASK_PRESS(n); \
 936     } while (0)
 937 #endif
 938
 939 static bool
 940 handle_wheel(SCREEN *sp, MEVENT * eventp, int button, int wheel)
 941 {
 942     bool result = TRUE;
 943
 944     switch (button & 3) {
 945     case 0:
 946         if (wheel) {
 947             eventp->bstate = MASK_PRESS(4);
 948             /* Do not record in sp->_mouse_bstate; there will be no
 949              * corresponding release event.
 950              */
 951         } else {
 952             PRESS_POSITION(1);
 953         }
 954         break;
 955     case 1:
 956         if (wheel) {
 957 #if NCURSES_MOUSE_VERSION >= 2
 958             eventp->bstate = MASK_PRESS(5);
 959             /* See comment above for button 4 */
 960 #else
 961             /* Ignore this event as it is not a true press of the button */
 962             eventp->bstate = REPORT_MOUSE_POSITION;
 963 #endif
 964         } else {
 965             PRESS_POSITION(2);
 966         }
 967         break;
 968     case 2:
 969         PRESS_POSITION(3);
 970         break;
 971     default:
 972         /*
 973          * case 3 is sent when the mouse buttons are released.
 974          *
 975          * If the terminal uses xterm mode 1003, a continuous series of
 976          * button-release events is sent as the mouse moves around the screen,
 977          * or as the wheel mouse is rotated.
 978          *
 979          * Return false in this case, so that when running in X10 mode, we will
 980          * recalculate bstate.
 981          */
 982         eventp->bstate = REPORT_MOUSE_POSITION;
 983         result = FALSE;
 984         break;
 985     }
 986     return result;
 987 }
 988
 989 static bool
 990 decode_X10_bstate(SCREEN *sp, MEVENT * eventp, unsigned intro)
 991 {
 992     bool result;
 993     int button = 0;
 994     int wheel = (intro & 96) == 96;
 995
 996     eventp->bstate = 0;
 997
 998     if (intro >= 96) {
 999         if (intro >= 160) {
1000             button = (int) (intro - 152);       /* buttons 8-11 */
1001         } else {
1002             button = (int) (intro - 92);        /* buttons 4-7 */
1003         }
1004     } else {
1005         button = (intro & 3);
1006     }
1007
1008     if (button > MAX_BUTTONS) {
1009         eventp->bstate = REPORT_MOUSE_POSITION;
1010     } else if (!handle_wheel(sp, eventp, (int) intro, wheel)) {
1011
1012         /*
1013          * Release events aren't reported for individual buttons, just for
1014          * the button set as a whole.  However, because there are normally
1015          * no mouse events under xterm that intervene between press and
1016          * release, we can infer the button actually released by looking at
1017          * the previous event.
1018          */
1019         if (sp->_mouse_bstate & BUTTON_PRESSED) {
1020             int b;
1021
1022             eventp->bstate = BUTTON_RELEASED;
1023             for (b = 1; b <= MAX_BUTTONS; ++b) {
1024                 if (!(sp->_mouse_bstate & MASK_PRESS(b)))
1025                     eventp->bstate &= ~MASK_RELEASE(b);
1026             }
1027             sp->_mouse_bstate = 0;
1028         } else {
1029             /*
1030              * xterm will return a stream of release-events to let the
1031              * application know where the mouse is going, if private mode
1032              * 1002 or 1003 is enabled.
1033              */
1034             eventp->bstate = REPORT_MOUSE_POSITION;
1035         }
1036     }
1037
1038     if (intro & 4) {
1039         eventp->bstate |= BUTTON_SHIFT;
1040     }
1041     if (intro & 8) {
1042         eventp->bstate |= BUTTON_ALT;
1043     }
1044     if (intro & 16) {
1045         eventp->bstate |= BUTTON_CTRL;
1046     }
1047     result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
1048     return result;
1049 }
1050
1051 /* This code requires that your xterm entry contain the kmous capability and
1052  * that it be set to the \E[M documented in the Xterm Control Sequences
1053  * reference.  This is how we arrange for mouse events to be reported via a
1054  * KEY_MOUSE return value from wgetch().  After this value is received,
1055  * _nc_mouse_inline() gets called and is immediately responsible for parsing
1056  * the mouse status information following the prefix.
1057  *
1058  * The following quotes from the ctlseqs.ms document in the XTerm distribution,
1059  * describing the mouse tracking feature:
1060  *
1061  * Parameters for all mouse tracking escape sequences generated by xterm encode
1062  * numeric parameters in a single character as value+040.  For example, ! is
1063  * 1.
1064  *
1065  * On button press or release, xterm sends ESC [ M CbCxCy.  The low two bits of
1066  * Cb encode button information:  0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed,
1067  * 3=release.  The upper bits encode what modifiers were down when the button
1068  * was pressed and are added together.  4=Shift, 8=Meta, 16=Control.  Cx and Cy
1069  * are the x and y coordinates of the mouse event.  The upper left corner is
1070  * (1,1).
1071  *
1072  * (End quote) By the time we get here, we've eaten the key prefix.  FYI, the
1073  * loop below is necessary because mouse click info isn't guaranteed to present
1074  * as a single clist item.
1075  *
1076  * Wheel mice may return buttons 4 and 5 when the wheel is turned.  We encode
1077  * those as button presses.
1078  */
1079 static bool
1080 decode_xterm_X10(SCREEN *sp, MEVENT * eventp)
1081 {
1082 #define MAX_KBUF 3
1083     unsigned char kbuf[MAX_KBUF + 1];
1084     size_t grabbed;
1085     int res;
1086     bool result;
1087
1088     _nc_set_read_thread(TRUE);
1089     for (grabbed = 0; grabbed < MAX_KBUF; grabbed += (size_t) res) {
1090
1091         /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
1092         res = (int) read(
1093 #if USE_EMX_MOUSE
1094                             (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
1095 #else
1096                             sp->_ifd,
1097 #endif
1098                             kbuf + grabbed, (size_t) (MAX_KBUF - (int) grabbed));
1099         if (res == -1)
1100             break;
1101     }
1102     _nc_set_read_thread(FALSE);
1103     kbuf[MAX_KBUF] = '\0';
1104
1105     TR(TRACE_IEVENT,
1106        ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
1107
1108     /* there's only one mouse... */
1109     eventp->id = NORMAL_EVENT;
1110
1111     result = decode_X10_bstate(sp, eventp, kbuf[0]);
1112
1113     eventp->x = (kbuf[1] - ' ') - 1;
1114     eventp->y = (kbuf[2] - ' ') - 1;
1115
1116     return result;
1117 }
1118
1119 #ifdef EXP_XTERM_1005
1120 /*
1121  * This is identical to X10/X11 responses except that there are two UTF-8
1122  * characters storing the ordinates instead of two bytes.
1123  */
1124 static bool
1125 decode_xterm_1005(SCREEN *sp, MEVENT * eventp)
1126 {
1127     char kbuf[80];
1128     size_t grabbed;
1129     size_t limit = (sizeof(kbuf) - 1);
1130     unsigned coords[2];
1131     bool result;
1132
1133     coords[0] = 0;
1134     coords[1] = 0;
1135
1136     _nc_set_read_thread(TRUE);
1137     for (grabbed = 0; grabbed < limit;) {
1138         int res;
1139
1140         res = (int) read(
1141 #if USE_EMX_MOUSE
1142                             (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
1143 #else
1144                             sp->_ifd,
1145 #endif
1146                             (kbuf + grabbed), (size_t) 1);
1147         if (res == -1)
1148             break;
1149         grabbed += (size_t) res;
1150         if (grabbed > 1) {
1151             size_t check = 1;
1152             int n;
1153
1154             for (n = 0; n < 2; ++n) {
1155                 int rc;
1156
1157                 if (check >= grabbed)
1158                     break;
1159                 rc = _nc_conv_to_utf32(&coords[n], kbuf + check, (unsigned)
1160                                        (grabbed - check));
1161                 if (!rc)
1162                     break;
1163                 check += (size_t) rc;
1164             }
1165             if (n >= 2)
1166                 break;
1167         }
1168     }
1169     _nc_set_read_thread(FALSE);
1170
1171     TR(TRACE_IEVENT,
1172        ("_nc_mouse_inline sees the following xterm data: %s",
1173         _nc_visbufn(kbuf, (int) grabbed)));
1174
1175     /* there's only one mouse... */
1176     eventp->id = NORMAL_EVENT;
1177
1178     result = decode_X10_bstate(sp, eventp, UChar(kbuf[0]));
1179
1180     eventp->x = (int) (coords[0] - ' ') - 1;
1181     eventp->y = (int) (coords[1] - ' ') - 1;
1182
1183     return result;
1184 }
1185 #endif /* EXP_XTERM_1005 */
1186
1187 /*
1188  * ECMA-48 section 5.4
1189  */
1190 #define isInter(c) ((c) >= 0x20 && (c) <= 0x2f)
1191 #define isParam(c) ((c) >= 0x30 && (c) <= 0x3f)
1192 #define isFinal(c) ((c) >= 0x40 && (c) <= 0x7e)
1193
1194 #define MAX_PARAMS 9
1195
1196 typedef struct {
1197     int nerror;                 /* nonzero if there are unexpected chars */
1198     int nparam;                 /* number of numeric parameters */
1199     int params[MAX_PARAMS];
1200     int final;                  /* the final-character */
1201 } SGR_DATA;
1202
1203 static bool
1204 read_SGR(SCREEN *sp, SGR_DATA * result)
1205 {
1206     char kbuf[80];              /* bigger than any possible mouse response */
1207     int grabbed = 0;
1208     int ch = 0;
1209     int now = -1;
1210     int marker = 1;
1211
1212     memset(result, 0, sizeof(*result));
1213     _nc_set_read_thread(TRUE);
1214
1215     do {
1216         int res;
1217
1218         res = (int) read(
1219 #if USE_EMX_MOUSE
1220                             (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
1221 #else
1222                             sp->_ifd,
1223 #endif
1224                             (kbuf + grabbed), (size_t) 1);
1225         if (res == -1)
1226             break;
1227         if ((grabbed + MAX_KBUF) >= (int) sizeof(kbuf)) {
1228             result->nerror++;
1229             break;
1230         }
1231         ch = UChar(kbuf[grabbed]);
1232         kbuf[grabbed + 1] = 0;
1233         switch (ch) {
1234         case '0':
1235         case '1':
1236         case '2':
1237         case '3':
1238         case '4':
1239         case '5':
1240         case '6':
1241         case '7':
1242         case '8':
1243         case '9':
1244             if (marker) {
1245                 ++now;
1246                 result->nparam = (now + 1);
1247             }
1248             marker = 0;
1249             result->params[now] = (result->params[now] * 10) + (ch - '0');
1250             break;
1251         case ';':
1252             if (marker) {
1253                 ++now;
1254                 result->nparam = (now + 1);
1255             }
1256             marker = 1;
1257             break;
1258         default:
1259             if (ch < 32 || ch > 126) {
1260                 /*
1261                  * Technically other characters could be interspersed in the
1262                  * response.  Ignore those for now.
1263                  */
1264                 result->nerror++;
1265                 continue;
1266             } else if (isFinal(ch)) {
1267                 if (marker) {
1268                     result->nparam++;
1269                 }
1270                 result->final = ch;
1271             } else {
1272                 result->nerror++;
1273             }
1274             break;
1275         }
1276         ++grabbed;
1277     } while (!isFinal(ch));
1278     _nc_set_read_thread(FALSE);
1279
1280     kbuf[++grabbed] = 0;
1281     TR(TRACE_IEVENT,
1282        ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
1283     return (grabbed > 0) && (result->nerror == 0);
1284 }
1285
1286 static bool
1287 decode_xterm_SGR1006(SCREEN *sp, MEVENT * eventp)
1288 {
1289     SGR_DATA data;
1290     bool result = FALSE;
1291     if (read_SGR(sp, &data)) {
1292         int b = data.params[0];
1293         int b3 = 1 + (b & 3);
1294         int wheel = ((b & 64) == 64);
1295
1296         if (b >= 132) {
1297             b3 = MAX_BUTTONS + 1;
1298         } else if (b >= 128) {
1299             b3 = (b - 120);     /* buttons 8-11 */
1300         } else if (b >= 64) {
1301             b3 = (b - 60);      /* buttons 6-7 */
1302         }
1303
1304         eventp->id = NORMAL_EVENT;
1305         if (data.final == 'M') {
1306             (void) handle_wheel(sp, eventp, b, wheel);
1307         } else if (b3 > MAX_BUTTONS) {
1308             eventp->bstate = REPORT_MOUSE_POSITION;
1309         } else {
1310             mmask_t pressed = (mmask_t) NCURSES_MOUSE_MASK(b3, NCURSES_BUTTON_PRESSED);
1311             mmask_t release = (mmask_t) NCURSES_MOUSE_MASK(b3, NCURSES_BUTTON_RELEASED);
1312             if (sp->_mouse_bstate & pressed) {
1313                 eventp->bstate = release;
1314                 sp->_mouse_bstate &= ~pressed;
1315             } else {
1316                 eventp->bstate = REPORT_MOUSE_POSITION;
1317             }
1318         }
1319         if (b & 4) {
1320             eventp->bstate |= BUTTON_SHIFT;
1321         }
1322         if (b & 8) {
1323             eventp->bstate |= BUTTON_ALT;
1324         }
1325         if (b & 16) {
1326             eventp->bstate |= BUTTON_CTRL;
1327         }
1328         result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
1329         eventp->x = (data.params[1] ? (data.params[1] - 1) : 0);
1330         eventp->y = (data.params[2] ? (data.params[2] - 1) : 0);
1331     }
1332     return result;
1333 }
1334
1335 static bool
1336 _nc_mouse_inline(SCREEN *sp)
1337 /* mouse report received in the keyboard stream -- parse its info */
1338 {
1339     bool result = FALSE;
1340     MEVENT *eventp = sp->_mouse_eventp;
1341
1342     TR(MY_TRACE, ("_nc_mouse_inline() called"));
1343
1344     if (sp->_mouse_type == M_XTERM) {
1345         switch (sp->_mouse_format) {
1346         case MF_X10:
1347             result = decode_xterm_X10(sp, eventp);
1348             break;
1349         case MF_SGR1006:
1350             result = decode_xterm_SGR1006(sp, eventp);
1351             break;
1352 #ifdef EXP_XTERM_1005
1353         case MF_XTERM_1005:
1354             result = decode_xterm_1005(sp, eventp);
1355             break;
1356 #endif
1357         }
1358
1359         TR(MY_TRACE,
1360            ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
1361             _nc_tracemouse(sp, eventp),
1362             (long) IndexEV(sp, eventp)));
1363
1364         /* bump the next-free pointer into the circular list */
1365         sp->_mouse_eventp = NEXT(eventp);
1366
1367         if (!result) {
1368             /* If this event is from a wheel-mouse, treat it like position
1369              * reports and avoid waiting for the release-events which will
1370              * never come.
1371              */
1372             if (eventp->bstate & BUTTON_PRESSED) {
1373                 int b;
1374
1375                 for (b = 4; b <= MAX_BUTTONS; ++b) {
1376                     if ((eventp->bstate & MASK_PRESS(b))) {
1377                         result = TRUE;
1378                         break;
1379                     }
1380                 }
1381             }
1382         }
1383     }
1384
1385     return (result);
1386 }
1387
1388 static void
1389 mouse_activate(SCREEN *sp, int on)
1390 {
1391     if (!on && !sp->_mouse_initialized)
1392         return;
1393
1394     if (!_nc_mouse_init(sp))
1395         return;
1396
1397     if (on) {
1398         sp->_mouse_bstate = 0;
1399         switch (sp->_mouse_type) {
1400         case M_XTERM:
1401 #if NCURSES_EXT_FUNCS
1402             NCURSES_SP_NAME(keyok) (NCURSES_SP_ARGx KEY_MOUSE, on);
1403 #endif
1404             TPUTS_TRACE("xterm mouse initialization");
1405             enable_xterm_mouse(sp, 1);
1406             break;
1407 #if USE_GPM_SUPPORT
1408         case M_GPM:
1409             if (enable_gpm_mouse(sp, TRUE)) {
1410                 sp->_mouse_fd = *(my_gpm_fd);
1411                 T(("GPM mouse_fd %d", sp->_mouse_fd));
1412             }
1413             break;
1414 #endif
1415 #if USE_SYSMOUSE
1416         case M_SYSMOUSE:
1417             signal(SIGUSR2, handle_sysmouse);
1418             sp->_mouse_active = TRUE;
1419             break;
1420 #endif
1421 #ifdef USE_TERM_DRIVER
1422         case M_TERM_DRIVER:
1423             sp->_mouse_active = TRUE;
1424             break;
1425 #endif
1426         case M_NONE:
1427             return;
1428         }
1429         /* Make runtime binding to cut down on object size of applications that
1430          * do not use the mouse (e.g., 'clear').
1431          */
1432         sp->_mouse_event = _nc_mouse_event;
1433         sp->_mouse_inline = _nc_mouse_inline;
1434         sp->_mouse_parse = _nc_mouse_parse;
1435         sp->_mouse_resume = _nc_mouse_resume;
1436         sp->_mouse_wrap = _nc_mouse_wrap;
1437     } else {
1438
1439         switch (sp->_mouse_type) {
1440         case M_XTERM:
1441             TPUTS_TRACE("xterm mouse deinitialization");
1442             enable_xterm_mouse(sp, 0);
1443             break;
1444 #if USE_GPM_SUPPORT
1445         case M_GPM:
1446             enable_gpm_mouse(sp, FALSE);
1447             break;
1448 #endif
1449 #if USE_SYSMOUSE
1450         case M_SYSMOUSE:
1451             signal(SIGUSR2, SIG_IGN);
1452             sp->_mouse_active = FALSE;
1453             break;
1454 #endif
1455 #ifdef USE_TERM_DRIVER
1456         case M_TERM_DRIVER:
1457             sp->_mouse_active = FALSE;
1458             break;
1459 #endif
1460         case M_NONE:
1461             return;
1462         }
1463     }
1464     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1465 }
1466
1467 /**************************************************************************
1468  *
1469  * Device-independent code
1470  *
1471  **************************************************************************/
1472
1473 static bool
1474 _nc_mouse_parse(SCREEN *sp, int runcount)
1475 /* parse a run of atomic mouse events into a gesture */
1476 {
1477     MEVENT *eventp = sp->_mouse_eventp;
1478     MEVENT *next, *ep;
1479     MEVENT *first_valid = NULL;
1480     MEVENT *first_invalid = NULL;
1481     int n;
1482     int b;
1483     bool merge;
1484     bool endLoop;
1485
1486     TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));
1487
1488     /*
1489      * When we enter this routine, the event list next-free pointer
1490      * points just past a run of mouse events that we know were separated
1491      * in time by less than the critical click interval. The job of this
1492      * routine is to collapse this run into a single higher-level event
1493      * or gesture.
1494      *
1495      * We accomplish this in two passes.  The first pass merges press/release
1496      * pairs into click events.  The second merges runs of click events into
1497      * double or triple-click events.
1498      *
1499      * It's possible that the run may not resolve to a single event (for
1500      * example, if the user quadruple-clicks).  If so, leading events
1501      * in the run are ignored if user does not call getmouse in a loop (getting
1502      * them from newest to older).
1503      *
1504      * Note that this routine is independent of the format of the specific
1505      * format of the pointing-device's reports.  We can use it to parse
1506      * gestures on anything that reports press/release events on a per-
1507      * button basis, as long as the device-dependent mouse code puts stuff
1508      * on the queue in MEVENT format.
1509      */
1510
1511     /*
1512      * Reset all events that were not set, in case the user sometimes calls
1513      * getmouse only once and other times until there are no more events in
1514      * queue.
1515      *
1516      * This also allows reaching the beginning of the run.
1517      */
1518     ep = eventp;
1519     for (n = runcount; n < EV_MAX; n++) {
1520         Invalidate(ep);
1521         ep = NEXT(ep);
1522     }
1523
1524 #ifdef TRACE
1525     if (USE_TRACEF(TRACE_IEVENT)) {
1526         _trace_slot(sp, "before mouse press/release merge:");
1527         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1528                 RunParams(sp, eventp, ep),
1529                 runcount);
1530         _nc_unlock_global(tracef);
1531     }
1532 #endif /* TRACE */
1533
1534     /* first pass; merge press/release pairs */
1535     endLoop = FALSE;
1536     while (!endLoop) {
1537         next = NEXT(ep);
1538         if (next == eventp) {
1539             /* Will end the loop, but compact before */
1540             endLoop = TRUE;
1541         } else {
1542
1543 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
1544                       == !(next->bstate & MASK_RELEASE(x)))
1545
1546             if (ValidEvent(ep) && ValidEvent(next)
1547                 && ep->x == next->x && ep->y == next->y
1548                 && (ep->bstate & BUTTON_PRESSED)
1549                 && (!(next->bstate & BUTTON_PRESSED))) {
1550                 bool changed = TRUE;
1551
1552                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1553                     if (!MASK_CHANGED(b)) {
1554                         changed = FALSE;
1555                         break;
1556                     }
1557                 }
1558
1559                 if (changed) {
1560                     merge = FALSE;
1561                     for (b = 1; b <= MAX_BUTTONS; ++b) {
1562                         if ((sp->_mouse_mask2 & MASK_CLICK(b))
1563                             && (ep->bstate & MASK_PRESS(b))) {
1564                             next->bstate &= ~MASK_RELEASE(b);
1565                             next->bstate |= MASK_CLICK(b);
1566                             merge = TRUE;
1567                         }
1568                     }
1569                     if (merge) {
1570                         Invalidate(ep);
1571                     }
1572                 }
1573             }
1574         }
1575
1576         /* Compact valid events */
1577         if (!ValidEvent(ep)) {
1578             if ((first_valid != NULL) && (first_invalid == NULL)) {
1579                 first_invalid = ep;
1580             }
1581         } else {
1582             if (first_valid == NULL) {
1583                 first_valid = ep;
1584             } else if (first_invalid != NULL) {
1585                 *first_invalid = *ep;
1586                 Invalidate(ep);
1587                 first_invalid = NEXT(first_invalid);
1588             }
1589         }
1590
1591         ep = next;
1592     }
1593
1594     if (first_invalid != NULL) {
1595         eventp = first_invalid;
1596     }
1597 #ifdef TRACE
1598     if (USE_TRACEF(TRACE_IEVENT)) {
1599         _trace_slot(sp, "before mouse click merge:");
1600         if (first_valid == NULL) {
1601             _tracef("_nc_mouse_parse: no valid event");
1602         } else {
1603             _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1604                     RunParams(sp, eventp, first_valid),
1605                     runcount);
1606             _nc_unlock_global(tracef);
1607         }
1608     }
1609 #endif /* TRACE */
1610
1611     /*
1612      * Second pass; merge click runs.  We merge click events forward in the
1613      * queue.  For example, double click can be changed to triple click.
1614      *
1615      * NOTE: There is a problem with this design!  If the application
1616      * allows enough click events to pile up in the circular queue so
1617      * they wrap around, it will cheerfully merge the newest forward
1618      * into the oldest, creating a bogus doubleclick and confusing
1619      * the queue-traversal logic rather badly.  Generally this won't
1620      * happen, because calling getmouse() marks old events invalid and
1621      * ineligible for merges.  The true solution to this problem would
1622      * be to timestamp each MEVENT and perform the obvious sanity check,
1623      * but the timer element would have to have sub-second resolution,
1624      * which would get us into portability trouble.
1625      */
1626     first_invalid = NULL;
1627     endLoop = (first_valid == NULL);
1628     ep = first_valid;
1629     while (!endLoop) {
1630         next = NEXT(ep);
1631
1632         if (next == eventp) {
1633             /* Will end the loop, but check event type and compact before */
1634             endLoop = TRUE;
1635         } else if (!ValidEvent(next)) {
1636             continue;
1637         } else {
1638             /* merge click events forward */
1639             if ((ep->bstate & BUTTON_CLICKED)
1640                 && (next->bstate & BUTTON_CLICKED)) {
1641                 merge = FALSE;
1642                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1643                     if ((sp->_mouse_mask2 & MASK_DOUBLE_CLICK(b))
1644                         && (ep->bstate & MASK_CLICK(b))
1645                         && (next->bstate & MASK_CLICK(b))) {
1646                         next->bstate &= ~MASK_CLICK(b);
1647                         next->bstate |= MASK_DOUBLE_CLICK(b);
1648                         merge = TRUE;
1649                     }
1650                 }
1651                 if (merge) {
1652                     Invalidate(ep);
1653                 }
1654             }
1655
1656             /* merge double-click events forward */
1657             if ((ep->bstate & BUTTON_DOUBLE_CLICKED)
1658                 && (next->bstate & BUTTON_CLICKED)) {
1659                 merge = FALSE;
1660                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1661                     if ((sp->_mouse_mask2 & MASK_TRIPLE_CLICK(b))
1662                         && (ep->bstate & MASK_DOUBLE_CLICK(b))
1663                         && (next->bstate & MASK_CLICK(b))) {
1664                         next->bstate &= ~MASK_CLICK(b);
1665                         next->bstate |= MASK_TRIPLE_CLICK(b);
1666                         merge = TRUE;
1667                     }
1668                 }
1669                 if (merge) {
1670                     Invalidate(ep);
1671                 }
1672             }
1673         }
1674
1675         /* Discard event if it does not match event mask */
1676         if (!(ep->bstate & sp->_mouse_mask2)) {
1677             Invalidate(ep);
1678         }
1679
1680         /* Compact valid events */
1681         if (!ValidEvent(ep)) {
1682             if (ep == first_valid) {
1683                 first_valid = next;
1684             } else if (first_invalid == NULL) {
1685                 first_invalid = ep;
1686             }
1687         } else if (first_invalid != NULL) {
1688             *first_invalid = *ep;
1689             Invalidate(ep);
1690             first_invalid = NEXT(first_invalid);
1691         }
1692
1693         ep = next;
1694     }
1695
1696     if (first_invalid == NULL) {
1697         first_invalid = eventp;
1698     }
1699     sp->_mouse_eventp = first_invalid;
1700
1701 #ifdef TRACE
1702     if (first_valid != NULL) {
1703         if (USE_TRACEF(TRACE_IEVENT)) {
1704             _trace_slot(sp, "after mouse event queue compaction:");
1705             _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1706                     RunParams(sp, first_invalid, first_valid),
1707                     runcount);
1708             _nc_unlock_global(tracef);
1709         }
1710         for (ep = first_valid; ep != first_invalid; ep = NEXT(ep)) {
1711             if (ValidEvent(ep))
1712                 TR(MY_TRACE,
1713                    ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
1714                     _nc_tracemouse(sp, ep),
1715                     (long) IndexEV(sp, ep)));
1716         }
1717     }
1718 #endif /* TRACE */
1719
1720     /* after all this, do we have a valid event? */
1721     ep = PREV(first_invalid);
1722     return ValidEvent(ep) && ((ep->bstate & sp->_mouse_mask) != 0);
1723 }
1724
1725 static void
1726 _nc_mouse_wrap(SCREEN *sp)
1727 /* release mouse -- called by endwin() before shellout/exit */
1728 {
1729     TR(MY_TRACE, ("_nc_mouse_wrap() called"));
1730
1731     switch (sp->_mouse_type) {
1732     case M_XTERM:
1733         if (sp->_mouse_mask)
1734             mouse_activate(sp, FALSE);
1735         break;
1736 #if USE_GPM_SUPPORT
1737         /* GPM: pass all mouse events to next client */
1738     case M_GPM:
1739         if (sp->_mouse_mask)
1740             mouse_activate(sp, FALSE);
1741         break;
1742 #endif
1743 #if USE_SYSMOUSE
1744     case M_SYSMOUSE:
1745         mouse_activate(sp, FALSE);
1746         break;
1747 #endif
1748 #ifdef USE_TERM_DRIVER
1749     case M_TERM_DRIVER:
1750         mouse_activate(sp, FALSE);
1751         break;
1752 #endif
1753     case M_NONE:
1754         break;
1755     }
1756 }
1757
1758 static void
1759 _nc_mouse_resume(SCREEN *sp)
1760 /* re-connect to mouse -- called by doupdate() after shellout */
1761 {
1762     TR(MY_TRACE, ("_nc_mouse_resume() called"));
1763
1764     switch (sp->_mouse_type) {
1765     case M_XTERM:
1766         /* xterm: re-enable reporting */
1767         if (sp->_mouse_mask)
1768             mouse_activate(sp, TRUE);
1769         break;
1770
1771 #if USE_GPM_SUPPORT
1772     case M_GPM:
1773         /* GPM: reclaim our event set */
1774         if (sp->_mouse_mask)
1775             mouse_activate(sp, TRUE);
1776         break;
1777 #endif
1778
1779 #if USE_SYSMOUSE
1780     case M_SYSMOUSE:
1781         mouse_activate(sp, TRUE);
1782         break;
1783 #endif
1784
1785 #ifdef USE_TERM_DRIVER
1786     case M_TERM_DRIVER:
1787         mouse_activate(sp, TRUE);
1788         break;
1789 #endif
1790
1791     case M_NONE:
1792         break;
1793     }
1794 }
1795
1796 /**************************************************************************
1797  *
1798  * Mouse interface entry points for the API
1799  *
1800  **************************************************************************/
1801
1802 NCURSES_EXPORT(int)
1803 NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1804 {
1805     int result = ERR;
1806     MEVENT *eventp;
1807
1808     T((T_CALLED("getmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1809
1810     if ((aevent != 0) &&
1811         (SP_PARM != 0) &&
1812         (SP_PARM->_mouse_type != M_NONE) &&
1813         (eventp = SP_PARM->_mouse_eventp) != 0) {
1814         /* compute the current-event pointer */
1815         MEVENT *prev = PREV(eventp);
1816
1817         /*
1818          * Discard events not matching mask (there could be still some if
1819          * _nc_mouse_parse was not called, e.g., when _nc_mouse_inline returns
1820          * false).
1821          */
1822         while (ValidEvent(prev) && (!(prev->bstate & SP_PARM->_mouse_mask2))) {
1823             Invalidate(prev);
1824             prev = PREV(prev);
1825         }
1826         if (ValidEvent(prev)) {
1827             /* copy the event we find there */
1828             *aevent = *prev;
1829
1830             TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
1831                               _nc_tracemouse(SP_PARM, prev),
1832                               (long) IndexEV(SP_PARM, prev)));
1833
1834             Invalidate(prev);   /* so the queue slot becomes free */
1835             SP_PARM->_mouse_eventp = prev;
1836             result = OK;
1837         } else {
1838             /* Reset the provided event */
1839             aevent->bstate = 0;
1840             Invalidate(aevent);
1841             aevent->x = 0;
1842             aevent->y = 0;
1843             aevent->z = 0;
1844         }
1845     }
1846     returnCode(result);
1847 }
1848
1849 #if NCURSES_SP_FUNCS
1850 /* grab a copy of the current mouse event */
1851 NCURSES_EXPORT(int)
1852 getmouse(MEVENT * aevent)
1853 {
1854     return NCURSES_SP_NAME(getmouse) (CURRENT_SCREEN, aevent);
1855 }
1856 #endif
1857
1858 NCURSES_EXPORT(int)
1859 NCURSES_SP_NAME(ungetmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1860 {
1861     int result = ERR;
1862     MEVENT *eventp;
1863
1864     T((T_CALLED("ungetmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1865
1866     if (aevent != 0 &&
1867         SP_PARM != 0 &&
1868         (eventp = SP_PARM->_mouse_eventp) != 0) {
1869
1870         /* stick the given event in the next-free slot */
1871         *eventp = *aevent;
1872
1873         /* bump the next-free pointer into the circular list */
1874         SP_PARM->_mouse_eventp = NEXT(eventp);
1875
1876         /* push back the notification event on the keyboard queue */
1877         result = NCURSES_SP_NAME(ungetch) (NCURSES_SP_ARGx KEY_MOUSE);
1878     }
1879     returnCode(result);
1880 }
1881
1882 #if NCURSES_SP_FUNCS
1883 /* enqueue a synthesized mouse event to be seen by the next wgetch() */
1884 NCURSES_EXPORT(int)
1885 ungetmouse(MEVENT * aevent)
1886 {
1887     return NCURSES_SP_NAME(ungetmouse) (CURRENT_SCREEN, aevent);
1888 }
1889 #endif
1890
1891 NCURSES_EXPORT(mmask_t)
1892 NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
1893 /* set the mouse event mask */
1894 {
1895     mmask_t result = 0;
1896
1897     T((T_CALLED("mousemask(%p,%#lx,%p)"),
1898        (void *) SP_PARM,
1899        (unsigned long) newmask,
1900        (void *) oldmask));
1901
1902     if (SP_PARM != 0) {
1903         if (oldmask)
1904             *oldmask = SP_PARM->_mouse_mask;
1905
1906         if (newmask || SP_PARM->_mouse_initialized) {
1907             _nc_mouse_init(SP_PARM);
1908
1909             if (SP_PARM->_mouse_type != M_NONE) {
1910                 int b;
1911
1912                 result = newmask &
1913                     (REPORT_MOUSE_POSITION
1914                      | BUTTON_ALT
1915                      | BUTTON_CTRL
1916                      | BUTTON_SHIFT
1917                      | BUTTON_PRESSED
1918                      | BUTTON_RELEASED
1919                      | BUTTON_CLICKED
1920                      | BUTTON_DOUBLE_CLICKED
1921                      | BUTTON_TRIPLE_CLICKED);
1922
1923                 mouse_activate(SP_PARM, (bool) (result != 0));
1924
1925                 SP_PARM->_mouse_mask = result;
1926                 SP_PARM->_mouse_mask2 = result;
1927
1928                 /*
1929                  * Make a mask corresponding to the states we will need to
1930                  * retain (temporarily) while building up the state that the
1931                  * user asked for.
1932                  */
1933                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1934                     if (SP_PARM->_mouse_mask2 & MASK_TRIPLE_CLICK(b))
1935                         SP_PARM->_mouse_mask2 |= MASK_DOUBLE_CLICK(b);
1936                     if (SP_PARM->_mouse_mask2 & MASK_DOUBLE_CLICK(b))
1937                         SP_PARM->_mouse_mask2 |= MASK_CLICK(b);
1938                     if (SP_PARM->_mouse_mask2 & MASK_CLICK(b))
1939                         SP_PARM->_mouse_mask2 |= (MASK_PRESS(b) |
1940                                                   MASK_RELEASE(b));
1941                 }
1942             }
1943         }
1944     }
1945     returnMMask(result);
1946 }
1947
1948 #if NCURSES_SP_FUNCS
1949 NCURSES_EXPORT(mmask_t)
1950 mousemask(mmask_t newmask, mmask_t * oldmask)
1951 {
1952     return NCURSES_SP_NAME(mousemask) (CURRENT_SCREEN, newmask, oldmask);
1953 }
1954 #endif
1955
1956 NCURSES_EXPORT(bool)
1957 wenclose(const WINDOW *win, int y, int x)
1958 /* check to see if given window encloses given screen location */
1959 {
1960     bool result = FALSE;
1961
1962     T((T_CALLED("wenclose(%p,%d,%d)"), (const void *) win, y, x));
1963
1964     if (win != 0) {
1965         y -= win->_yoffset;
1966         result = ((win->_begy <= y &&
1967                    win->_begx <= x &&
1968                    (win->_begx + win->_maxx) >= x &&
1969                    (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
1970     }
1971     returnBool(result);
1972 }
1973
1974 NCURSES_EXPORT(int)
1975 NCURSES_SP_NAME(mouseinterval) (NCURSES_SP_DCLx int maxclick)
1976 /* set the maximum mouse interval within which to recognize a click */
1977 {
1978     int oldval;
1979
1980     T((T_CALLED("mouseinterval(%p,%d)"), (void *) SP_PARM, maxclick));
1981
1982     if (SP_PARM != 0) {
1983         oldval = SP_PARM->_maxclick;
1984         if (maxclick >= 0)
1985             SP_PARM->_maxclick = maxclick;
1986     } else {
1987         oldval = DEFAULT_MAXCLICK;
1988     }
1989
1990     returnCode(oldval);
1991 }
1992
1993 #if NCURSES_SP_FUNCS
1994 NCURSES_EXPORT(int)
1995 mouseinterval(int maxclick)
1996 {
1997     return NCURSES_SP_NAME(mouseinterval) (CURRENT_SCREEN, maxclick);
1998 }
1999 #endif
2000
2001 /* This may be used by other routines to ask for the existence of mouse
2002    support */
2003 NCURSES_EXPORT(bool)
2004 _nc_has_mouse(SCREEN *sp)
2005 {
2006     return (((0 == sp) || (sp->_mouse_type == M_NONE)) ? FALSE : TRUE);
2007 }
2008
2009 NCURSES_EXPORT(bool)
2010 NCURSES_SP_NAME(has_mouse) (NCURSES_SP_DCL0)
2011 {
2012     return _nc_has_mouse(SP_PARM);
2013 }
2014
2015 #if NCURSES_SP_FUNCS
2016 NCURSES_EXPORT(bool)
2017 has_mouse(void)
2018 {
2019     return _nc_has_mouse(CURRENT_SCREEN);
2020 }
2021 #endif
2022
2023 NCURSES_EXPORT(bool)
2024 wmouse_trafo(const WINDOW *win, int *pY, int *pX, bool to_screen)
2025 {
2026     bool result = FALSE;
2027
2028     T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"),
2029        (const void *) win,
2030        (void *) pY,
2031        (void *) pX,
2032        to_screen));
2033
2034     if (win && pY && pX) {
2035         int y = *pY;
2036         int x = *pX;
2037
2038         if (to_screen) {
2039             y += win->_begy + win->_yoffset;
2040             x += win->_begx;
2041             if (wenclose(win, y, x))
2042                 result = TRUE;
2043         } else {
2044             if (wenclose(win, y, x)) {
2045                 y -= (win->_begy + win->_yoffset);
2046                 x -= win->_begx;
2047                 result = TRUE;
2048             }
2049         }
2050         if (result) {
2051             *pX = x;
2052             *pY = y;
2053         }
2054     }
2055     returnBool(result);
2056 }