ncurses/base/lib_mouse.c

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