ncurses/base/lib_mouse.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2009,2010 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.112 2010/02/06 19:54:08 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 (__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 #define MY_TRACE TRACE_ICALLS|TRACE_IEVENT
 124
 125 #define MASK_RELEASE(x)         NCURSES_MOUSE_MASK(x, 001)
 126 #define MASK_PRESS(x)           NCURSES_MOUSE_MASK(x, 002)
 127 #define MASK_CLICK(x)           NCURSES_MOUSE_MASK(x, 004)
 128 #define MASK_DOUBLE_CLICK(x)    NCURSES_MOUSE_MASK(x, 010)
 129 #define MASK_TRIPLE_CLICK(x)    NCURSES_MOUSE_MASK(x, 020)
 130 #define MASK_RESERVED_EVENT(x)  NCURSES_MOUSE_MASK(x, 040)
 131
 132 #if NCURSES_MOUSE_VERSION == 1
 133 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED)
 134 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED)
 135 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED)
 136 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED)
 137 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED)
 138 #define MAX_BUTTONS  4
 139 #else
 140 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED        | BUTTON5_CLICKED)
 141 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED        | BUTTON5_PRESSED)
 142 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED       | BUTTON5_RELEASED)
 143 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED | BUTTON5_DOUBLE_CLICKED)
 144 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED | BUTTON5_TRIPLE_CLICKED)
 145 #define MAX_BUTTONS  5
 146 #endif
 147
 148 #define INVALID_EVENT   -1
 149 #define NORMAL_EVENT    0
 150
 151 #if USE_GPM_SUPPORT
 152
 153 #ifndef LIBGPM_SONAME
 154 #define LIBGPM_SONAME "libgpm.so"
 155 #endif
 156
 157 #define GET_DLSYM(name) (my_##name = (TYPE_##name) dlsym(sp->_dlopen_gpm, #name))
 158
 159 #endif                          /* USE_GPM_SUPPORT */
 160
 161 static bool _nc_mouse_parse(SCREEN *, int);
 162 static void _nc_mouse_resume(SCREEN *);
 163 static void _nc_mouse_wrap(SCREEN *);
 164
 165 /* maintain a circular list of mouse events */
 166
 167 #define FirstEV(sp)     ((sp)->_mouse_events)
 168 #define LastEV(sp)      ((sp)->_mouse_events + EV_MAX - 1)
 169
 170 #undef  NEXT
 171 #define NEXT(ep)        ((ep >= LastEV(SP_PARM)) \
 172                          ? FirstEV(SP_PARM) \
 173                          : ep + 1)
 174
 175 #undef  PREV
 176 #define PREV(ep)        ((ep <= FirstEV(SP_PARM)) \
 177                          ? LastEV(SP_PARM) \
 178                          : ep - 1)
 179
 180 #define IndexEV(sp, ep) (ep - FirstEV(sp))
 181
 182 #define RunParams(sp, eventp, runp) \
 183                 (long) IndexEV(sp, runp), \
 184                 (long) (IndexEV(sp, eventp) + (EV_MAX - 1)) % EV_MAX
 185
 186 #ifdef TRACE
 187 static void
 188 _trace_slot(SCREEN *sp, const char *tag)
 189 {
 190     MEVENT *ep;
 191
 192     _tracef(tag);
 193
 194     for (ep = FirstEV(sp); ep <= LastEV(sp); ep++)
 195         _tracef("mouse event queue slot %ld = %s",
 196                 (long) IndexEV(sp, ep),
 197                 _nc_tracemouse(sp, ep));
 198 }
 199 #endif
 200
 201 #if USE_EMX_MOUSE
 202
 203 #  define TOP_ROW          0
 204 #  define LEFT_COL         0
 205
 206 #  define M_FD(sp) sp->_mouse_fd
 207
 208 static void
 209 write_event(SCREEN *sp, int down, int button, int x, int y)
 210 {
 211     char buf[6];
 212     unsigned long ignore;
 213
 214     strncpy(buf, key_mouse, 3); /* should be "\033[M" */
 215     buf[3] = ' ' + (button - 1) + (down ? 0 : 0x40);
 216     buf[4] = ' ' + x - LEFT_COL + 1;
 217     buf[5] = ' ' + y - TOP_ROW + 1;
 218     DosWrite(sp->_emxmouse_wfd, buf, 6, &ignore);
 219 }
 220
 221 static void
 222 mouse_server(unsigned long param)
 223 {
 224     SCREEN *sp = (SCREEN *) param;
 225     unsigned short fWait = MOU_WAIT;
 226     /* NOPTRRECT mourt = { 0,0,24,79 }; */
 227     MOUEVENTINFO mouev;
 228     HMOU hmou;
 229     unsigned short mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN | MOUSE_BN3_DOWN;
 230     int nbuttons = 3;
 231     int oldstate = 0;
 232     char err[80];
 233     unsigned long rc;
 234
 235     /* open the handle for the mouse */
 236     if (MouOpen(NULL, &hmou) == 0) {
 237         rc = MouSetEventMask(&mask, hmou);
 238         if (rc) {               /* retry with 2 buttons */
 239             mask = MOUSE_BN1_DOWN | MOUSE_BN2_DOWN;
 240             rc = MouSetEventMask(&mask, hmou);
 241             nbuttons = 2;
 242         }
 243         if (rc == 0 && MouDrawPtr(hmou) == 0) {
 244             for (;;) {
 245                 /* sit and wait on the event queue */
 246                 rc = MouReadEventQue(&mouev, &fWait, hmou);
 247                 if (rc) {
 248                     sprintf(err, "Error reading mouse queue, rc=%lu.\r\n", rc);
 249                     break;
 250                 }
 251                 if (!sp->_emxmouse_activated)
 252                     goto finish;
 253
 254                 /*
 255                  * OS/2 numbers a 3-button mouse inconsistently from other
 256                  * platforms:
 257                  *      1 = left
 258                  *      2 = right
 259                  *      3 = middle.
 260                  */
 261                 if ((mouev.fs ^ oldstate) & MOUSE_BN1_DOWN)
 262                     write_event(sp, mouev.fs & MOUSE_BN1_DOWN,
 263                                 sp->_emxmouse_buttons[1], mouev.col, mouev.row);
 264                 if ((mouev.fs ^ oldstate) & MOUSE_BN2_DOWN)
 265                     write_event(sp, mouev.fs & MOUSE_BN2_DOWN,
 266                                 sp->_emxmouse_buttons[3], mouev.col, mouev.row);
 267                 if ((mouev.fs ^ oldstate) & MOUSE_BN3_DOWN)
 268                     write_event(sp, mouev.fs & MOUSE_BN3_DOWN,
 269                                 sp->_emxmouse_buttons[2], mouev.col, mouev.row);
 270
 271               finish:
 272                 oldstate = mouev.fs;
 273             }
 274         } else
 275             sprintf(err, "Error setting event mask, buttons=%d, rc=%lu.\r\n",
 276                     nbuttons, rc);
 277
 278         DosWrite(2, err, strlen(err), &rc);
 279         MouClose(hmou);
 280     }
 281     DosExit(EXIT_THREAD, 0L);
 282 }
 283
 284 #endif /* USE_EMX_MOUSE */
 285
 286 #if USE_SYSMOUSE
 287 static void
 288 sysmouse_server(SCREEN *sp)
 289 {
 290     struct mouse_info the_mouse;
 291     MEVENT *work;
 292
 293     the_mouse.operation = MOUSE_GETINFO;
 294     if (sp != 0
 295         && sp->_mouse_fd >= 0
 296         && sp->_sysmouse_tail < FIFO_SIZE
 297         && ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
 298
 299         if (sp->_sysmouse_head > sp->_sysmouse_tail) {
 300             sp->_sysmouse_tail = 0;
 301             sp->_sysmouse_head = 0;
 302         }
 303         work = &(sp->_sysmouse_fifo[sp->_sysmouse_tail]);
 304         memset(work, 0, sizeof(*work));
 305         work->id = NORMAL_EVENT;        /* there's only one mouse... */
 306
 307         sp->_sysmouse_old_buttons = sp->_sysmouse_new_buttons;
 308         sp->_sysmouse_new_buttons = the_mouse.u.data.buttons & 0x7;
 309
 310         if (sp->_sysmouse_new_buttons) {
 311             if (sp->_sysmouse_new_buttons & 1)
 312                 work->bstate |= BUTTON1_PRESSED;
 313             if (sp->_sysmouse_new_buttons & 2)
 314                 work->bstate |= BUTTON2_PRESSED;
 315             if (sp->_sysmouse_new_buttons & 4)
 316                 work->bstate |= BUTTON3_PRESSED;
 317         } else {
 318             if (sp->_sysmouse_old_buttons & 1)
 319                 work->bstate |= BUTTON1_RELEASED;
 320             if (sp->_sysmouse_old_buttons & 2)
 321                 work->bstate |= BUTTON2_RELEASED;
 322             if (sp->_sysmouse_old_buttons & 4)
 323                 work->bstate |= BUTTON3_RELEASED;
 324         }
 325
 326         /* for cosmetic bug in syscons.c on FreeBSD 3.[34] */
 327         the_mouse.operation = MOUSE_HIDE;
 328         ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
 329         the_mouse.operation = MOUSE_SHOW;
 330         ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
 331
 332         /*
 333          * We're only interested if the button is pressed or released.
 334          * FIXME: implement continuous event-tracking.
 335          */
 336         if (sp->_sysmouse_new_buttons != sp->_sysmouse_old_buttons) {
 337             sp->_sysmouse_tail += 1;
 338         }
 339         work->x = the_mouse.u.data.x / sp->_sysmouse_char_width;
 340         work->y = the_mouse.u.data.y / sp->_sysmouse_char_height;
 341     }
 342 }
 343
 344 static void
 345 handle_sysmouse(int sig GCC_UNUSED)
 346 {
 347     sysmouse_server(CURRENT_SCREEN);
 348 }
 349 #endif /* USE_SYSMOUSE */
 350
 351 #ifndef USE_TERM_DRIVER
 352 #define xterm_kmous "\033[M"
 353
 354 static void
 355 init_xterm_mouse(SCREEN *sp)
 356 {
 357     sp->_mouse_type = M_XTERM;
 358     sp->_mouse_xtermcap = tigetstr("XM");
 359     if (!VALID_STRING(sp->_mouse_xtermcap))
 360         sp->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
 361 }
 362 #endif
 363
 364 static void
 365 enable_xterm_mouse(SCREEN *sp, int enable)
 366 {
 367 #if USE_EMX_MOUSE
 368     sp->_emxmouse_activated = enable;
 369 #else
 370     NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
 371                                "xterm-mouse",
 372                                TPARM_1(sp->_mouse_xtermcap, enable));
 373 #endif
 374     sp->_mouse_active = enable;
 375 }
 376
 377 #if USE_GPM_SUPPORT
 378 static bool
 379 allow_gpm_mouse(void)
 380 {
 381     bool result = FALSE;
 382
 383     /* GPM does printf's without checking if stdout is a terminal */
 384     if (isatty(fileno(stdout))) {
 385         char *list = getenv("NCURSES_GPM_TERMS");
 386         char *env = getenv("TERM");
 387         if (list != 0) {
 388             if (env != 0) {
 389                 result = _nc_name_match(list, env, "|:");
 390             }
 391         } else {
 392             /* GPM checks the beginning of the $TERM variable to decide if it
 393              * should pass xterm events through.  There is no real advantage in
 394              * allowing GPM to do this.  Recent versions relax that check, and
 395              * pretend that GPM can work with any terminal having the kmous
 396              * capability.  Perhaps that works for someone.  If so, they can
 397              * set the environment variable (above).
 398              */
 399             if (env != 0 && strstr(env, "linux") != 0) {
 400                 result = TRUE;
 401             }
 402         }
 403     }
 404     return result;
 405 }
 406
 407 #ifdef HAVE_LIBDL
 408 static void
 409 unload_gpm_library(SCREEN *sp)
 410 {
 411     if (sp->_dlopen_gpm != 0) {
 412         T(("unload GPM library"));
 413         sp->_mouse_gpm_loaded = FALSE;
 414         sp->_mouse_fd = -1;
 415         dlclose(sp->_dlopen_gpm);
 416         sp->_dlopen_gpm = 0;
 417     }
 418 }
 419
 420 static void
 421 load_gpm_library(SCREEN *sp)
 422 {
 423     sp->_mouse_gpm_found = FALSE;
 424     if ((sp->_dlopen_gpm = dlopen(LIBGPM_SONAME, my_RTLD)) != 0) {
 425         if (GET_DLSYM(gpm_fd) == 0 ||
 426             GET_DLSYM(Gpm_Open) == 0 ||
 427             GET_DLSYM(Gpm_Close) == 0 ||
 428             GET_DLSYM(Gpm_GetEvent) == 0) {
 429             T(("GPM initialization failed: %s", dlerror()));
 430             unload_gpm_library(sp);
 431         } else {
 432             sp->_mouse_gpm_found = TRUE;
 433             sp->_mouse_gpm_loaded = TRUE;
 434         }
 435     }
 436 }
 437 #endif
 438
 439 static bool
 440 enable_gpm_mouse(SCREEN *sp, bool enable)
 441 {
 442     bool result;
 443
 444     T((T_CALLED("enable_gpm_mouse(%d)"), enable));
 445
 446     if (enable && !sp->_mouse_active) {
 447 #ifdef HAVE_LIBDL
 448         if (sp->_mouse_gpm_found && !sp->_mouse_gpm_loaded) {
 449             load_gpm_library(sp);
 450         }
 451 #endif
 452         if (sp->_mouse_gpm_loaded) {
 453             /* GPM: initialize connection to gpm server */
 454             sp->_mouse_gpm_connect.eventMask = GPM_DOWN | GPM_UP;
 455             sp->_mouse_gpm_connect.defaultMask =
 456                 (unsigned short) (~(sp->_mouse_gpm_connect.eventMask | GPM_HARD));
 457             sp->_mouse_gpm_connect.minMod = 0;
 458             sp->_mouse_gpm_connect.maxMod =
 459                 (unsigned short) (~((1 << KG_SHIFT) |
 460                                     (1 << KG_SHIFTL) |
 461                                     (1 << KG_SHIFTR)));
 462             /*
 463              * Note: GPM hardcodes \E[?1001s and \E[?1000h during its open.
 464              * The former is recognized by wscons (SunOS), and the latter by
 465              * xterm.  Those will not show up in ncurses' traces.
 466              */
 467             result = (my_Gpm_Open(&sp->_mouse_gpm_connect, 0) >= 0);
 468         } else {
 469             result = FALSE;
 470         }
 471         sp->_mouse_active = result;
 472         T(("GPM open %s", result ? "succeeded" : "failed"));
 473     } else {
 474         if (!enable && sp->_mouse_active) {
 475             /* GPM: close connection to gpm server */
 476             my_Gpm_Close();
 477             sp->_mouse_active = FALSE;
 478             T(("GPM closed"));
 479         }
 480         result = enable;
 481     }
 482 #ifdef HAVE_LIBDL
 483     if (!result) {
 484         unload_gpm_library(sp);
 485     }
 486 #endif
 487     returnBool(result);
 488 }
 489 #endif /* USE_GPM_SUPPORT */
 490
 491 static void
 492 initialize_mousetype(SCREEN *sp)
 493 {
 494     T((T_CALLED("initialize_mousetype()")));
 495
 496     /* Try gpm first, because gpm may be configured to run in xterm */
 497 #if USE_GPM_SUPPORT
 498     if (allow_gpm_mouse()) {
 499         if (!sp->_mouse_gpm_loaded) {
 500 #ifdef HAVE_LIBDL
 501             load_gpm_library(sp);
 502 #else /* !HAVE_LIBDL */
 503             sp->_mouse_gpm_found = TRUE;
 504             sp->_mouse_gpm_loaded = TRUE;
 505 #endif
 506         }
 507
 508         /*
 509          * The gpm_fd file-descriptor may be negative (xterm).  So we have to
 510          * maintain our notion of whether the mouse connection is active
 511          * without testing the file-descriptor.
 512          */
 513         if (sp->_mouse_gpm_found && enable_gpm_mouse(sp, TRUE)) {
 514             sp->_mouse_type = M_GPM;
 515             sp->_mouse_fd = *(my_gpm_fd);
 516             T(("GPM mouse_fd %d", sp->_mouse_fd));
 517             returnVoid;
 518         }
 519     }
 520 #endif /* USE_GPM_SUPPORT */
 521
 522     /* OS/2 VIO */
 523 #if USE_EMX_MOUSE
 524     if (!sp->_emxmouse_thread
 525         && strstr(TerminalOf(sp)->type.term_names, "xterm") == 0
 526         && key_mouse) {
 527         int handles[2];
 528
 529         if (pipe(handles) < 0) {
 530             perror("mouse pipe error");
 531             returnVoid;
 532         } else {
 533             int rc;
 534
 535             if (!sp->_emxmouse_buttons[0]) {
 536                 char *s = getenv("MOUSE_BUTTONS_123");
 537
 538                 sp->_emxmouse_buttons[0] = 1;
 539                 if (s && strlen(s) >= 3) {
 540                     sp->_emxmouse_buttons[1] = s[0] - '0';
 541                     sp->_emxmouse_buttons[2] = s[1] - '0';
 542                     sp->_emxmouse_buttons[3] = s[2] - '0';
 543                 } else {
 544                     sp->_emxmouse_buttons[1] = 1;
 545                     sp->_emxmouse_buttons[2] = 3;
 546                     sp->_emxmouse_buttons[3] = 2;
 547                 }
 548             }
 549             sp->_emxmouse_wfd = handles[1];
 550             M_FD(sp) = handles[0];
 551             /* Needed? */
 552             setmode(handles[0], O_BINARY);
 553             setmode(handles[1], O_BINARY);
 554             /* Do not use CRT functions, we may single-threaded. */
 555             rc = DosCreateThread((unsigned long *) &sp->_emxmouse_thread,
 556                                  mouse_server, (long) sp, 0, 8192);
 557             if (rc) {
 558                 printf("mouse thread error %d=%#x", rc, rc);
 559             } else {
 560                 sp->_mouse_type = M_XTERM;
 561             }
 562             returnVoid;
 563         }
 564     }
 565 #endif /* USE_EMX_MOUSE */
 566
 567 #if USE_SYSMOUSE
 568     {
 569         struct mouse_info the_mouse;
 570         char *the_device = 0;
 571
 572         if (isatty(sp->_ifd))
 573             the_device = ttyname(sp->_ifd);
 574         if (the_device == 0)
 575             the_device = "/dev/tty";
 576
 577         sp->_mouse_fd = open(the_device, O_RDWR);
 578
 579         if (sp->_mouse_fd >= 0) {
 580             /*
 581              * sysmouse does not have a usable user interface for obtaining
 582              * mouse events.  The logical way to proceed (reading data on a
 583              * stream) only works if one opens the device as root.  Even in
 584              * that mode, careful examination shows we lose events
 585              * occasionally.  The interface provided for user programs is to
 586              * establish a signal handler.  really.
 587              *
 588              * Take over SIGUSR2 for this purpose since SIGUSR1 is more
 589              * likely to be used by an application.  getch() will have to
 590              * handle the misleading EINTR's.
 591              */
 592             signal(SIGUSR2, SIG_IGN);
 593             the_mouse.operation = MOUSE_MODE;
 594             the_mouse.u.mode.mode = 0;
 595             the_mouse.u.mode.signal = SIGUSR2;
 596             if (ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
 597                 signal(SIGUSR2, handle_sysmouse);
 598                 the_mouse.operation = MOUSE_SHOW;
 599                 ioctl(sp->_mouse_fd, CONS_MOUSECTL, &the_mouse);
 600
 601 #if defined(FBIO_MODEINFO) || defined(CONS_MODEINFO)    /* FreeBSD > 2.x */
 602                 {
 603 #ifndef FBIO_GETMODE            /* FreeBSD 3.x */
 604 #define FBIO_GETMODE    CONS_GET
 605 #define FBIO_MODEINFO   CONS_MODEINFO
 606 #endif /* FBIO_GETMODE */
 607                     video_info_t the_video;
 608
 609                     if (ioctl(sp->_mouse_fd,
 610                               FBIO_GETMODE,
 611                               &the_video.vi_mode) != -1
 612                         && ioctl(sp->_mouse_fd,
 613                                  FBIO_MODEINFO,
 614                                  &the_video) != -1) {
 615                         sp->_sysmouse_char_width = the_video.vi_cwidth;
 616                         sp->_sysmouse_char_height = the_video.vi_cheight;
 617                     }
 618                 }
 619 #endif /* defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) */
 620
 621                 if (sp->_sysmouse_char_width <= 0)
 622                     sp->_sysmouse_char_width = 8;
 623                 if (sp->_sysmouse_char_height <= 0)
 624                     sp->_sysmouse_char_height = 16;
 625                 sp->_mouse_type = M_SYSMOUSE;
 626                 returnVoid;
 627             }
 628         }
 629     }
 630 #endif /* USE_SYSMOUSE */
 631
 632 #ifdef USE_TERM_DRIVER
 633     CallDriver(sp, initmouse);
 634 #else
 635     /* we know how to recognize mouse events under "xterm" */
 636     if (key_mouse != 0) {
 637         if (!strcmp(key_mouse, xterm_kmous)
 638             || strstr(TerminalOf(sp)->type.term_names, "xterm") != 0) {
 639             init_xterm_mouse(sp);
 640         }
 641     } else if (strstr(TerminalOf(sp)->type.term_names, "xterm") != 0) {
 642         if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
 643             init_xterm_mouse(sp);
 644     }
 645 #endif
 646
 647     returnVoid;
 648 }
 649
 650 static bool
 651 _nc_mouse_init(SCREEN *sp)
 652 /* initialize the mouse */
 653 {
 654     bool result = FALSE;
 655     int i;
 656
 657     if (sp != 0) {
 658         if (!sp->_mouse_initialized) {
 659             sp->_mouse_initialized = TRUE;
 660
 661             TR(MY_TRACE, ("_nc_mouse_init() called"));
 662
 663             sp->_mouse_eventp = FirstEV(sp);
 664             for (i = 0; i < EV_MAX; i++)
 665                 sp->_mouse_events[i].id = INVALID_EVENT;
 666
 667             initialize_mousetype(sp);
 668
 669             T(("_nc_mouse_init() set mousetype to %d", sp->_mouse_type));
 670         }
 671         result = sp->_mouse_initialized;
 672     }
 673     return result;
 674 }
 675
 676 /*
 677  * Query to see if there is a pending mouse event.  This is called from
 678  * fifo_push() in lib_getch.c
 679  */
 680 static bool
 681 _nc_mouse_event(SCREEN *sp)
 682 {
 683     MEVENT *eventp = sp->_mouse_eventp;
 684     bool result = FALSE;
 685
 686     (void) eventp;
 687
 688     switch (sp->_mouse_type) {
 689     case M_XTERM:
 690         /* xterm: never have to query, mouse events are in the keyboard stream */
 691 #if USE_EMX_MOUSE
 692         {
 693             char kbuf[3];
 694
 695             int i, res = read(M_FD(sp), &kbuf, 3);      /* Eat the prefix */
 696             if (res != 3)
 697                 printf("Got %d chars instead of 3 for prefix.\n", res);
 698             for (i = 0; i < res; i++) {
 699                 if (kbuf[i] != key_mouse[i])
 700                     printf("Got char %d instead of %d for prefix.\n",
 701                            (int) kbuf[i], (int) key_mouse[i]);
 702             }
 703             result = TRUE;
 704         }
 705 #endif /* USE_EMX_MOUSE */
 706         break;
 707
 708 #if USE_GPM_SUPPORT
 709     case M_GPM:
 710         if (sp->_mouse_fd >= 0) {
 711             /* query server for event, return TRUE if we find one */
 712             Gpm_Event ev;
 713
 714             switch (my_Gpm_GetEvent(&ev)) {
 715             case 0:
 716                 /* Connection closed, drop the mouse. */
 717                 sp->_mouse_fd = -1;
 718                 break;
 719             case 1:
 720                 /* there's only one mouse... */
 721                 eventp->id = NORMAL_EVENT;
 722
 723                 eventp->bstate = 0;
 724                 switch (ev.type & 0x0f) {
 725                 case (GPM_DOWN):
 726                     if (ev.buttons & GPM_B_LEFT)
 727                         eventp->bstate |= BUTTON1_PRESSED;
 728                     if (ev.buttons & GPM_B_MIDDLE)
 729                         eventp->bstate |= BUTTON2_PRESSED;
 730                     if (ev.buttons & GPM_B_RIGHT)
 731                         eventp->bstate |= BUTTON3_PRESSED;
 732                     break;
 733                 case (GPM_UP):
 734                     if (ev.buttons & GPM_B_LEFT)
 735                         eventp->bstate |= BUTTON1_RELEASED;
 736                     if (ev.buttons & GPM_B_MIDDLE)
 737                         eventp->bstate |= BUTTON2_RELEASED;
 738                     if (ev.buttons & GPM_B_RIGHT)
 739                         eventp->bstate |= BUTTON3_RELEASED;
 740                     break;
 741                 default:
 742                     break;
 743                 }
 744
 745                 eventp->x = ev.x - 1;
 746                 eventp->y = ev.y - 1;
 747                 eventp->z = 0;
 748
 749                 /* bump the next-free pointer into the circular list */
 750                 sp->_mouse_eventp = eventp = NEXT(eventp);
 751                 result = TRUE;
 752                 break;
 753             }
 754         }
 755         break;
 756 #endif
 757
 758 #if USE_SYSMOUSE
 759     case M_SYSMOUSE:
 760         if (sp->_sysmouse_head < sp->_sysmouse_tail) {
 761             *eventp = sp->_sysmouse_fifo[sp->_sysmouse_head];
 762
 763             /*
 764              * Point the fifo-head to the next possible location.  If there
 765              * are none, reset the indices.  This may be interrupted by the
 766              * signal handler, doing essentially the same reset.
 767              */
 768             sp->_sysmouse_head += 1;
 769             if (sp->_sysmouse_head == sp->_sysmouse_tail) {
 770                 sp->_sysmouse_tail = 0;
 771                 sp->_sysmouse_head = 0;
 772             }
 773
 774             /* bump the next-free pointer into the circular list */
 775             sp->_mouse_eventp = eventp = NEXT(eventp);
 776             result = TRUE;
 777         }
 778         break;
 779 #endif /* USE_SYSMOUSE */
 780
 781 #ifdef USE_TERM_DRIVER
 782     case M_TERM_DRIVER:
 783         while (sp->_drv_mouse_head < sp->_drv_mouse_tail) {
 784             *eventp = sp->_drv_mouse_fifo[sp->_drv_mouse_head];
 785
 786             /*
 787              * Point the fifo-head to the next possible location.  If there
 788              * are none, reset the indices.
 789              */
 790             sp->_drv_mouse_head += 1;
 791             if (sp->_drv_mouse_head == sp->_drv_mouse_tail) {
 792                 sp->_drv_mouse_tail = 0;
 793                 sp->_drv_mouse_head = 0;
 794             }
 795
 796             /* bump the next-free pointer into the circular list */
 797             sp->_mouse_eventp = eventp = NEXT(eventp);
 798             result = TRUE;
 799         }
 800         break;
 801 #endif
 802
 803     case M_NONE:
 804         break;
 805     }
 806
 807     return result;              /* true if we found an event */
 808 }
 809
 810 static bool
 811 _nc_mouse_inline(SCREEN *sp)
 812 /* mouse report received in the keyboard stream -- parse its info */
 813 {
 814     int b;
 815     bool result = FALSE;
 816     MEVENT *eventp = sp->_mouse_eventp;
 817
 818     TR(MY_TRACE, ("_nc_mouse_inline() called"));
 819
 820     if (sp->_mouse_type == M_XTERM) {
 821         unsigned char kbuf[4];
 822         mmask_t prev;
 823         size_t grabbed;
 824         int res;
 825
 826         /* This code requires that your xterm entry contain the kmous
 827          * capability and that it be set to the \E[M documented in the
 828          * Xterm Control Sequences reference.  This is how we
 829          * arrange for mouse events to be reported via a KEY_MOUSE
 830          * return value from wgetch().  After this value is received,
 831          * _nc_mouse_inline() gets called and is immediately
 832          * responsible for parsing the mouse status information
 833          * following the prefix.
 834          *
 835          * The following quotes from the ctrlseqs.ms document in the
 836          * X distribution, describing the X mouse tracking feature:
 837          *
 838          * Parameters for all mouse tracking escape sequences
 839          * generated by xterm encode numeric parameters in a single
 840          * character as value+040.  For example, !  is 1.
 841          *
 842          * On button press or release, xterm sends ESC [ M CbCxCy.
 843          * The low two bits of Cb encode button information: 0=MB1
 844          * pressed, 1=MB2 pressed, 2=MB3 pressed, 3=release.  The
 845          * upper bits encode what modifiers were down when the
 846          * button was pressed and are added together.  4=Shift,
 847          * 8=Meta, 16=Control.  Cx and Cy are the x and y coordinates
 848          * of the mouse event.  The upper left corner is (1,1).
 849          *
 850          * (End quote)  By the time we get here, we've eaten the
 851          * key prefix.  FYI, the loop below is necessary because
 852          * mouse click info isn't guaranteed to present as a
 853          * single clist item.
 854          *
 855          * Wheel mice may return buttons 4 and 5 when the wheel is turned.
 856          * We encode those as button presses.
 857          */
 858         for (grabbed = 0; grabbed < 3; grabbed += (size_t) res) {
 859
 860             /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
 861 #if USE_EMX_MOUSE
 862             res = read(M_FD(sp) >= 0 ? M_FD(sp) : sp->_ifd, &kbuf, 3);
 863 #else
 864             res = read(sp->_ifd, kbuf + grabbed, 3 - grabbed);
 865 #endif
 866             if (res == -1)
 867                 break;
 868         }
 869         kbuf[3] = '\0';
 870
 871         TR(TRACE_IEVENT,
 872            ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
 873
 874         /* there's only one mouse... */
 875         eventp->id = NORMAL_EVENT;
 876
 877         /* processing code goes here */
 878         eventp->bstate = 0;
 879         prev = PREV(eventp)->bstate;
 880
 881 #if USE_EMX_MOUSE
 882 #define PRESS_POSITION(n) \
 883         eventp->bstate = MASK_PRESS(n); \
 884         if (kbuf[0] & 0x40) \
 885             eventp->bstate = MASK_RELEASE(n)
 886 #else
 887 #define PRESS_POSITION(n) \
 888         eventp->bstate = (mmask_t) (prev & MASK_PRESS(n) \
 889                                     ? REPORT_MOUSE_POSITION \
 890                                     : MASK_PRESS(n))
 891 #endif
 892
 893         switch (kbuf[0] & 0x3) {
 894         case 0x0:
 895             if (kbuf[0] & 64)
 896                 eventp->bstate = MASK_PRESS(4);
 897             else
 898                 PRESS_POSITION(1);
 899             break;
 900
 901         case 0x1:
 902 #if NCURSES_MOUSE_VERSION == 2
 903             if (kbuf[0] & 64)
 904                 eventp->bstate = MASK_PRESS(5);
 905             else
 906 #endif
 907                 PRESS_POSITION(2);
 908             break;
 909
 910         case 0x2:
 911             PRESS_POSITION(3);
 912             break;
 913
 914         case 0x3:
 915             /*
 916              * Release events aren't reported for individual buttons, just for
 917              * the button set as a whole.  However, because there are normally
 918              * no mouse events under xterm that intervene between press and
 919              * release, we can infer the button actually released by looking at
 920              * the previous event.
 921              */
 922             if (prev & (BUTTON_PRESSED | BUTTON_RELEASED)) {
 923                 eventp->bstate = BUTTON_RELEASED;
 924                 for (b = 1; b <= MAX_BUTTONS; ++b) {
 925                     if (!(prev & MASK_PRESS(b)))
 926                         eventp->bstate &= ~MASK_RELEASE(b);
 927                 }
 928             } else {
 929                 /*
 930                  * XFree86 xterm will return a stream of release-events to
 931                  * let the application know where the mouse is going, if the
 932                  * private mode 1002 or 1003 is enabled.
 933                  */
 934                 eventp->bstate = REPORT_MOUSE_POSITION;
 935             }
 936             break;
 937         }
 938         result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
 939
 940         if (kbuf[0] & 4) {
 941             eventp->bstate |= BUTTON_SHIFT;
 942         }
 943         if (kbuf[0] & 8) {
 944             eventp->bstate |= BUTTON_ALT;
 945         }
 946         if (kbuf[0] & 16) {
 947             eventp->bstate |= BUTTON_CTRL;
 948         }
 949
 950         eventp->x = (kbuf[1] - ' ') - 1;
 951         eventp->y = (kbuf[2] - ' ') - 1;
 952         TR(MY_TRACE,
 953            ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
 954             _nc_tracemouse(sp, eventp),
 955             (long) IndexEV(sp, eventp)));
 956
 957         /* bump the next-free pointer into the circular list */
 958         sp->_mouse_eventp = NEXT(eventp);
 959 #if 0                           /* this return would be needed for QNX's mods to lib_getch.c */
 960         return (TRUE);
 961 #endif
 962     }
 963
 964     return (result);
 965 }
 966
 967 static void
 968 mouse_activate(SCREEN *sp, bool on)
 969 {
 970     if (!on && !sp->_mouse_initialized)
 971         return;
 972
 973     if (!_nc_mouse_init(sp))
 974         return;
 975
 976     if (on) {
 977
 978         switch (sp->_mouse_type) {
 979         case M_XTERM:
 980 #if NCURSES_EXT_FUNCS
 981             NCURSES_SP_NAME(keyok) (NCURSES_SP_ARGx KEY_MOUSE, on);
 982 #endif
 983             TPUTS_TRACE("xterm mouse initialization");
 984             enable_xterm_mouse(sp, 1);
 985             break;
 986 #if USE_GPM_SUPPORT
 987         case M_GPM:
 988             if (enable_gpm_mouse(sp, TRUE)) {
 989                 sp->_mouse_fd = *(my_gpm_fd);
 990                 T(("GPM mouse_fd %d", sp->_mouse_fd));
 991             }
 992             break;
 993 #endif
 994 #if USE_SYSMOUSE
 995         case M_SYSMOUSE:
 996             signal(SIGUSR2, handle_sysmouse);
 997             sp->_mouse_active = TRUE;
 998             break;
 999 #endif
1000 #ifdef USE_TERM_DRIVER
1001         case M_TERM_DRIVER:
1002             sp->_mouse_active = TRUE;
1003             break;
1004 #endif
1005         case M_NONE:
1006             return;
1007         }
1008         /* Make runtime binding to cut down on object size of applications that
1009          * do not use the mouse (e.g., 'clear').
1010          */
1011         sp->_mouse_event = _nc_mouse_event;
1012         sp->_mouse_inline = _nc_mouse_inline;
1013         sp->_mouse_parse = _nc_mouse_parse;
1014         sp->_mouse_resume = _nc_mouse_resume;
1015         sp->_mouse_wrap = _nc_mouse_wrap;
1016     } else {
1017
1018         switch (sp->_mouse_type) {
1019         case M_XTERM:
1020             TPUTS_TRACE("xterm mouse deinitialization");
1021             enable_xterm_mouse(sp, 0);
1022             break;
1023 #if USE_GPM_SUPPORT
1024         case M_GPM:
1025             enable_gpm_mouse(sp, FALSE);
1026             break;
1027 #endif
1028 #if USE_SYSMOUSE
1029         case M_SYSMOUSE:
1030             signal(SIGUSR2, SIG_IGN);
1031             sp->_mouse_active = FALSE;
1032             break;
1033 #endif
1034 #ifdef USE_TERM_DRIVER
1035         case M_TERM_DRIVER:
1036             sp->_mouse_active = FALSE;
1037             break;
1038 #endif
1039         case M_NONE:
1040             return;
1041         }
1042     }
1043     NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
1044 }
1045
1046 /**************************************************************************
1047  *
1048  * Device-independent code
1049  *
1050  **************************************************************************/
1051
1052 static bool
1053 _nc_mouse_parse(SCREEN *sp, int runcount)
1054 /* parse a run of atomic mouse events into a gesture */
1055 {
1056     MEVENT *eventp = sp->_mouse_eventp;
1057     MEVENT *ep, *runp, *next, *prev = PREV(eventp);
1058     int n;
1059     int b;
1060     bool merge;
1061
1062     TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));
1063
1064     /*
1065      * When we enter this routine, the event list next-free pointer
1066      * points just past a run of mouse events that we know were separated
1067      * in time by less than the critical click interval. The job of this
1068      * routine is to collapse this run into a single higher-level event
1069      * or gesture.
1070      *
1071      * We accomplish this in two passes.  The first pass merges press/release
1072      * pairs into click events.  The second merges runs of click events into
1073      * double or triple-click events.
1074      *
1075      * It's possible that the run may not resolve to a single event (for
1076      * example, if the user quadruple-clicks).  If so, leading events
1077      * in the run are ignored.
1078      *
1079      * Note that this routine is independent of the format of the specific
1080      * format of the pointing-device's reports.  We can use it to parse
1081      * gestures on anything that reports press/release events on a per-
1082      * button basis, as long as the device-dependent mouse code puts stuff
1083      * on the queue in MEVENT format.
1084      */
1085     if (runcount == 1) {
1086         TR(MY_TRACE,
1087            ("_nc_mouse_parse: returning simple mouse event %s at slot %ld",
1088             _nc_tracemouse(sp, prev),
1089             (long) IndexEV(sp, prev)));
1090         return (prev->id >= NORMAL_EVENT)
1091             ? ((prev->bstate & sp->_mouse_mask) ? TRUE : FALSE)
1092             : FALSE;
1093     }
1094
1095     /* find the start of the run */
1096     runp = eventp;
1097     for (n = runcount; n > 0; n--) {
1098         runp = PREV(runp);
1099     }
1100
1101 #ifdef TRACE
1102     if (USE_TRACEF(TRACE_IEVENT)) {
1103         _trace_slot(sp, "before mouse press/release merge:");
1104         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1105                 RunParams(sp, eventp, runp),
1106                 runcount);
1107         _nc_unlock_global(tracef);
1108     }
1109 #endif /* TRACE */
1110
1111     /* first pass; merge press/release pairs */
1112     do {
1113         merge = FALSE;
1114         for (ep = runp; (next = NEXT(ep)) != eventp; ep = next) {
1115
1116 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
1117                       == !(next->bstate & MASK_RELEASE(x)))
1118
1119             if (ep->x == next->x && ep->y == next->y
1120                 && (ep->bstate & BUTTON_PRESSED)
1121                 && MASK_CHANGED(1)
1122                 && MASK_CHANGED(2)
1123                 && MASK_CHANGED(3)
1124                 && MASK_CHANGED(4)
1125 #if NCURSES_MOUSE_VERSION == 2
1126                 && MASK_CHANGED(5)
1127 #endif
1128                 ) {
1129                 for (b = 1; b <= MAX_BUTTONS; ++b) {
1130                     if ((sp->_mouse_mask & MASK_CLICK(b))
1131                         && (ep->bstate & MASK_PRESS(b))) {
1132                         ep->bstate &= ~MASK_PRESS(b);
1133                         ep->bstate |= MASK_CLICK(b);
1134                         merge = TRUE;
1135                     }
1136                 }
1137                 if (merge)
1138                     next->id = INVALID_EVENT;
1139             }
1140         }
1141     } while
1142         (merge);
1143
1144 #ifdef TRACE
1145     if (USE_TRACEF(TRACE_IEVENT)) {
1146         _trace_slot(sp, "before mouse click merge:");
1147         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1148                 RunParams(sp, eventp, runp),
1149                 runcount);
1150         _nc_unlock_global(tracef);
1151     }
1152 #endif /* TRACE */
1153
1154     /*
1155      * Second pass; merge click runs.  At this point, click events are
1156      * each followed by one invalid event. We merge click events
1157      * forward in the queue.
1158      *
1159      * NOTE: There is a problem with this design!  If the application
1160      * allows enough click events to pile up in the circular queue so
1161      * they wrap around, it will cheerfully merge the newest forward
1162      * into the oldest, creating a bogus doubleclick and confusing
1163      * the queue-traversal logic rather badly.  Generally this won't
1164      * happen, because calling getmouse() marks old events invalid and
1165      * ineligible for merges.  The true solution to this problem would
1166      * be to timestamp each MEVENT and perform the obvious sanity check,
1167      * but the timer element would have to have sub-second resolution,
1168      * which would get us into portability trouble.
1169      */
1170     do {
1171         MEVENT *follower;
1172
1173         merge = FALSE;
1174         for (ep = runp; (next = NEXT(ep)) != eventp; ep = next)
1175             if (ep->id != INVALID_EVENT) {
1176                 if (next->id != INVALID_EVENT)
1177                     continue;
1178                 follower = NEXT(next);
1179                 if (follower->id == INVALID_EVENT)
1180                     continue;
1181
1182                 /* merge click events forward */
1183                 if ((ep->bstate & BUTTON_CLICKED)
1184                     && (follower->bstate & BUTTON_CLICKED)) {
1185                     for (b = 1; b <= MAX_BUTTONS; ++b) {
1186                         if ((sp->_mouse_mask & MASK_DOUBLE_CLICK(b))
1187                             && (follower->bstate & MASK_CLICK(b))) {
1188                             follower->bstate &= ~MASK_CLICK(b);
1189                             follower->bstate |= MASK_DOUBLE_CLICK(b);
1190                             merge = TRUE;
1191                         }
1192                     }
1193                     if (merge)
1194                         ep->id = INVALID_EVENT;
1195                 }
1196
1197                 /* merge double-click events forward */
1198                 if ((ep->bstate & BUTTON_DOUBLE_CLICKED)
1199                     && (follower->bstate & BUTTON_CLICKED)) {
1200                     for (b = 1; b <= MAX_BUTTONS; ++b) {
1201                         if ((sp->_mouse_mask & MASK_TRIPLE_CLICK(b))
1202                             && (follower->bstate & MASK_CLICK(b))) {
1203                             follower->bstate &= ~MASK_CLICK(b);
1204                             follower->bstate |= MASK_TRIPLE_CLICK(b);
1205                             merge = TRUE;
1206                         }
1207                     }
1208                     if (merge)
1209                         ep->id = INVALID_EVENT;
1210                 }
1211             }
1212     } while
1213         (merge);
1214
1215 #ifdef TRACE
1216     if (USE_TRACEF(TRACE_IEVENT)) {
1217         _trace_slot(sp, "before mouse event queue compaction:");
1218         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1219                 RunParams(sp, eventp, runp),
1220                 runcount);
1221         _nc_unlock_global(tracef);
1222     }
1223 #endif /* TRACE */
1224
1225     /*
1226      * Now try to throw away trailing events flagged invalid, or that
1227      * don't match the current event mask.
1228      */
1229     for (; runcount; prev = PREV(eventp), runcount--)
1230         if (prev->id == INVALID_EVENT || !(prev->bstate & sp->_mouse_mask)) {
1231             sp->_mouse_eventp = eventp = prev;
1232         }
1233 #ifdef TRACE
1234     if (USE_TRACEF(TRACE_IEVENT)) {
1235         _trace_slot(sp, "after mouse event queue compaction:");
1236         _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
1237                 RunParams(sp, eventp, runp),
1238                 runcount);
1239         _nc_unlock_global(tracef);
1240     }
1241     for (ep = runp; ep != eventp; ep = NEXT(ep))
1242         if (ep->id != INVALID_EVENT)
1243             TR(MY_TRACE,
1244                ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
1245                 _nc_tracemouse(sp, ep),
1246                 (long) IndexEV(sp, ep)));
1247 #endif /* TRACE */
1248
1249     /* after all this, do we have a valid event? */
1250     return (PREV(eventp)->id != INVALID_EVENT);
1251 }
1252
1253 static void
1254 _nc_mouse_wrap(SCREEN *sp)
1255 /* release mouse -- called by endwin() before shellout/exit */
1256 {
1257     TR(MY_TRACE, ("_nc_mouse_wrap() called"));
1258
1259     switch (sp->_mouse_type) {
1260     case M_XTERM:
1261         if (sp->_mouse_mask)
1262             mouse_activate(sp, FALSE);
1263         break;
1264 #if USE_GPM_SUPPORT
1265         /* GPM: pass all mouse events to next client */
1266     case M_GPM:
1267         if (sp->_mouse_mask)
1268             mouse_activate(sp, FALSE);
1269         break;
1270 #endif
1271 #if USE_SYSMOUSE
1272     case M_SYSMOUSE:
1273         mouse_activate(sp, FALSE);
1274         break;
1275 #endif
1276 #ifdef USE_TERM_DRIVER
1277     case M_TERM_DRIVER:
1278         mouse_activate(sp, FALSE);
1279         break;
1280 #endif
1281     case M_NONE:
1282         break;
1283     }
1284 }
1285
1286 static void
1287 _nc_mouse_resume(SCREEN *sp)
1288 /* re-connect to mouse -- called by doupdate() after shellout */
1289 {
1290     TR(MY_TRACE, ("_nc_mouse_resume() called"));
1291
1292     switch (sp->_mouse_type) {
1293     case M_XTERM:
1294         /* xterm: re-enable reporting */
1295         if (sp->_mouse_mask)
1296             mouse_activate(sp, TRUE);
1297         break;
1298
1299 #if USE_GPM_SUPPORT
1300     case M_GPM:
1301         /* GPM: reclaim our event set */
1302         if (sp->_mouse_mask)
1303             mouse_activate(sp, TRUE);
1304         break;
1305 #endif
1306
1307 #if USE_SYSMOUSE
1308     case M_SYSMOUSE:
1309         mouse_activate(sp, TRUE);
1310         break;
1311 #endif
1312
1313 #ifdef USE_TERM_DRIVER
1314     case M_TERM_DRIVER:
1315         mouse_activate(sp, TRUE);
1316         break;
1317 #endif
1318
1319     case M_NONE:
1320         break;
1321     }
1322 }
1323
1324 /**************************************************************************
1325  *
1326  * Mouse interface entry points for the API
1327  *
1328  **************************************************************************/
1329
1330 NCURSES_EXPORT(int)
1331 NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1332 {
1333     int result = ERR;
1334
1335     T((T_CALLED("getmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1336
1337     if ((aevent != 0) && (SP_PARM != 0) && (SP_PARM->_mouse_type != M_NONE)) {
1338         MEVENT *eventp = SP_PARM->_mouse_eventp;
1339         /* compute the current-event pointer */
1340         MEVENT *prev = PREV(eventp);
1341
1342         if (prev->id != INVALID_EVENT) {
1343             /* copy the event we find there */
1344             *aevent = *prev;
1345
1346             TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
1347                               _nc_tracemouse(SP_PARM, prev),
1348                               (long) IndexEV(SP_PARM, prev)));
1349
1350             prev->id = INVALID_EVENT;   /* so the queue slot becomes free */
1351             SP_PARM->_mouse_eventp = PREV(prev);
1352             result = OK;
1353         }
1354     }
1355     returnCode(result);
1356 }
1357
1358 #if NCURSES_SP_FUNCS
1359 /* grab a copy of the current mouse event */
1360 NCURSES_EXPORT(int)
1361 getmouse(MEVENT * aevent)
1362 {
1363     return NCURSES_SP_NAME(getmouse) (CURRENT_SCREEN, aevent);
1364 }
1365 #endif
1366
1367 NCURSES_EXPORT(int)
1368 NCURSES_SP_NAME(ungetmouse) (NCURSES_SP_DCLx MEVENT * aevent)
1369 {
1370     int result = ERR;
1371
1372     T((T_CALLED("ungetmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
1373
1374     if (aevent != 0 && SP_PARM != 0) {
1375         MEVENT *eventp = SP_PARM->_mouse_eventp;
1376
1377         /* stick the given event in the next-free slot */
1378         *eventp = *aevent;
1379
1380         /* bump the next-free pointer into the circular list */
1381         SP_PARM->_mouse_eventp = NEXT(eventp);
1382
1383         /* push back the notification event on the keyboard queue */
1384         result = NCURSES_SP_NAME(ungetch) (NCURSES_SP_ARGx KEY_MOUSE);
1385     }
1386     returnCode(result);
1387 }
1388
1389 #if NCURSES_SP_FUNCS
1390 /* enqueue a synthesized mouse event to be seen by the next wgetch() */
1391 NCURSES_EXPORT(int)
1392 ungetmouse(MEVENT * aevent)
1393 {
1394     return NCURSES_SP_NAME(ungetmouse) (CURRENT_SCREEN, aevent);
1395 }
1396 #endif
1397
1398 NCURSES_EXPORT(mmask_t)
1399 NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
1400 /* set the mouse event mask */
1401 {
1402     mmask_t result = 0;
1403
1404     T((T_CALLED("mousemask(%p,%#lx,%p)"),
1405        (void *) SP_PARM,
1406        (unsigned long) newmask,
1407        (void *) oldmask));
1408
1409     if (SP_PARM != 0) {
1410         if (oldmask)
1411             *oldmask = SP_PARM->_mouse_mask;
1412
1413         if (newmask || SP_PARM->_mouse_initialized) {
1414             _nc_mouse_init(SP_PARM);
1415             if (SP_PARM->_mouse_type != M_NONE) {
1416                 result = newmask &
1417                     (REPORT_MOUSE_POSITION
1418                      | BUTTON_ALT
1419                      | BUTTON_CTRL
1420                      | BUTTON_SHIFT
1421                      | BUTTON_PRESSED
1422                      | BUTTON_RELEASED
1423                      | BUTTON_CLICKED
1424                      | BUTTON_DOUBLE_CLICKED
1425                      | BUTTON_TRIPLE_CLICKED);
1426
1427                 mouse_activate(SP_PARM, (bool) (result != 0));
1428
1429                 SP_PARM->_mouse_mask = result;
1430             }
1431         }
1432     }
1433     returnBits(result);
1434 }
1435
1436 #if NCURSES_SP_FUNCS
1437 NCURSES_EXPORT(mmask_t)
1438 mousemask(mmask_t newmask, mmask_t * oldmask)
1439 {
1440     return NCURSES_SP_NAME(mousemask) (CURRENT_SCREEN, newmask, oldmask);
1441 }
1442 #endif
1443
1444 NCURSES_EXPORT(bool)
1445 wenclose(const WINDOW *win, int y, int x)
1446 /* check to see if given window encloses given screen location */
1447 {
1448     bool result = FALSE;
1449
1450     T((T_CALLED("wenclose(%p,%d,%d)"), (const void *) win, y, x));
1451
1452     if (win != 0) {
1453         y -= win->_yoffset;
1454         result = ((win->_begy <= y &&
1455                    win->_begx <= x &&
1456                    (win->_begx + win->_maxx) >= x &&
1457                    (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
1458     }
1459     returnBool(result);
1460 }
1461
1462 NCURSES_EXPORT(int)
1463 NCURSES_SP_NAME(mouseinterval) (NCURSES_SP_DCLx int maxclick)
1464 /* set the maximum mouse interval within which to recognize a click */
1465 {
1466     int oldval;
1467
1468     T((T_CALLED("mouseinterval(%p,%d)"), (void *) SP_PARM, maxclick));
1469
1470     if (SP_PARM != 0) {
1471         oldval = SP_PARM->_maxclick;
1472         if (maxclick >= 0)
1473             SP_PARM->_maxclick = maxclick;
1474     } else {
1475         oldval = DEFAULT_MAXCLICK;
1476     }
1477
1478     returnCode(oldval);
1479 }
1480
1481 #if NCURSES_SP_FUNCS
1482 NCURSES_EXPORT(int)
1483 mouseinterval(int maxclick)
1484 {
1485     return NCURSES_SP_NAME(mouseinterval) (CURRENT_SCREEN, maxclick);
1486 }
1487 #endif
1488
1489 /* This may be used by other routines to ask for the existence of mouse
1490    support */
1491 NCURSES_EXPORT(bool)
1492 _nc_has_mouse(SCREEN *sp)
1493 {
1494     return (((0 == sp) || (sp->_mouse_type == M_NONE)) ? FALSE : TRUE);
1495 }
1496
1497 NCURSES_EXPORT(bool)
1498 NCURSES_SP_NAME(has_mouse) (NCURSES_SP_DCL0)
1499 {
1500     return _nc_has_mouse(SP_PARM);
1501 }
1502
1503 #if NCURSES_SP_FUNCS
1504 NCURSES_EXPORT(bool)
1505 has_mouse(void)
1506 {
1507     return _nc_has_mouse(CURRENT_SCREEN);
1508 }
1509 #endif
1510
1511 NCURSES_EXPORT(bool)
1512 wmouse_trafo(const WINDOW *win, int *pY, int *pX, bool to_screen)
1513 {
1514     bool result = FALSE;
1515
1516     T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"),
1517        (const void *) win,
1518        (void *) pY,
1519        (void *) pX,
1520        to_screen));
1521
1522     if (win && pY && pX) {
1523         int y = *pY;
1524         int x = *pX;
1525
1526         if (to_screen) {
1527             y += win->_begy + win->_yoffset;
1528             x += win->_begx;
1529             if (wenclose(win, y, x))
1530                 result = TRUE;
1531         } else {
1532             if (wenclose(win, y, x)) {
1533                 y -= (win->_begy + win->_yoffset);
1534                 x -= win->_begx;
1535                 result = TRUE;
1536             }
1537         }
1538         if (result) {
1539             *pX = x;
1540             *pY = y;
1541         }
1542     }
1543     returnBool(result);
1544 }