ncurses 6.2 - patch 20210213
[ncurses.git] / ncurses / base / lib_mouse.c
index 8b807cce948c24c19df7edb8dfeabb4093468611..6caef327a3c02b404e420da90fc42494d9706e5a 100644 (file)
@@ -1,5 +1,6 @@
 /****************************************************************************
- * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc.              *
+ * Copyright 2018-2020,2021 Thomas E. Dickey                                *
+ * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
@@ -84,7 +85,7 @@
 #define CUR SP_TERMTYPE
 #endif
 
-MODULE_ID("$Id: lib_mouse.c,v 1.130 2011/09/24 00:42:25 tom Exp $")
+MODULE_ID("$Id: lib_mouse.c,v 1.192 2021/02/14 00:17:09 tom Exp $")
 
 #include <tic.h>
 
@@ -112,7 +113,7 @@ make an error
 #undef buttons                 /* symbol conflict in consio.h */
 #undef mouse_info              /* symbol conflict in consio.h */
 #include <osreldate.h>
-#if (__FreeBSD_version >= 400017)
+#if defined(__DragonFly_version) || (defined(__FreeBSD__) && (__FreeBSD_version >= 400017))
 #include <sys/consio.h>
 #include <sys/fbio.h>
 #else
@@ -120,6 +121,17 @@ make an error
 #endif
 #endif                         /* use_SYSMOUSE */
 
+#if USE_KLIBC_MOUSE
+#include <sys/socket.h>
+#define pipe(handles) socketpair(AF_LOCAL, SOCK_STREAM, 0, handles)
+#define DosWrite(hfile, pbuffer, cbwrite, pcbactual) \
+               write(hfile, pbuffer, cbwrite)
+#define DosExit(action, result )       /* do nothing */
+#define DosCreateThread(ptid, pfn, param, flag, cbStack) \
+               (*(ptid) = _beginthread(pfn, NULL, cbStack, \
+                                       (void *)param), (*(ptid) == -1))
+#endif
+
 #define MY_TRACE TRACE_ICALLS|TRACE_IEVENT
 
 #define        MASK_RELEASE(x)         (mmask_t) NCURSES_MOUSE_MASK(x, 001)
@@ -130,24 +142,37 @@ make an error
 #define        MASK_RESERVED_EVENT(x)  (mmask_t) NCURSES_MOUSE_MASK(x, 040)
 
 #if NCURSES_MOUSE_VERSION == 1
+
 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED)
 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED)
 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED)
 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED)
 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED)
+
 #define MAX_BUTTONS  4
+
 #else
+
 #define BUTTON_CLICKED        (BUTTON1_CLICKED        | BUTTON2_CLICKED        | BUTTON3_CLICKED        | BUTTON4_CLICKED        | BUTTON5_CLICKED)
 #define BUTTON_PRESSED        (BUTTON1_PRESSED        | BUTTON2_PRESSED        | BUTTON3_PRESSED        | BUTTON4_PRESSED        | BUTTON5_PRESSED)
 #define BUTTON_RELEASED       (BUTTON1_RELEASED       | BUTTON2_RELEASED       | BUTTON3_RELEASED       | BUTTON4_RELEASED       | BUTTON5_RELEASED)
 #define BUTTON_DOUBLE_CLICKED (BUTTON1_DOUBLE_CLICKED | BUTTON2_DOUBLE_CLICKED | BUTTON3_DOUBLE_CLICKED | BUTTON4_DOUBLE_CLICKED | BUTTON5_DOUBLE_CLICKED)
 #define BUTTON_TRIPLE_CLICKED (BUTTON1_TRIPLE_CLICKED | BUTTON2_TRIPLE_CLICKED | BUTTON3_TRIPLE_CLICKED | BUTTON4_TRIPLE_CLICKED | BUTTON5_TRIPLE_CLICKED)
+
+#if NCURSES_MOUSE_VERSION == 2
 #define MAX_BUTTONS  5
+#else
+#define MAX_BUTTONS  11
+#endif
+
 #endif
 
 #define INVALID_EVENT  -1
 #define NORMAL_EVENT   0
 
+#define ValidEvent(ep) ((ep)->id != INVALID_EVENT)
+#define Invalidate(ep) (ep)->id = INVALID_EVENT
+
 #if USE_GPM_SUPPORT
 
 #ifndef LIBGPM_SONAME
@@ -211,7 +236,7 @@ write_event(SCREEN *sp, int down, int button, int x, int y)
     char buf[6];
     unsigned long ignore;
 
-    strncpy(buf, key_mouse, 3);        /* should be "\033[M" */
+    _nc_STRCPY(buf, "\033[M", sizeof(buf));    /* should be the same as key_mouse */
     buf[3] = ' ' + (button - 1) + (down ? 0 : 0x40);
     buf[4] = ' ' + x - LEFT_COL + 1;
     buf[5] = ' ' + y - TOP_ROW + 1;
@@ -219,7 +244,11 @@ write_event(SCREEN *sp, int down, int button, int x, int y)
 }
 
 static void
+#if USE_KLIBC_MOUSE
+mouse_server(void *param)
+#else
 mouse_server(unsigned long param)
+#endif
 {
     SCREEN *sp = (SCREEN *) param;
     unsigned short fWait = MOU_WAIT;
@@ -245,7 +274,8 @@ mouse_server(unsigned long param)
                /* sit and wait on the event queue */
                rc = MouReadEventQue(&mouev, &fWait, hmou);
                if (rc) {
-                   sprintf(err, "Error reading mouse queue, rc=%lu.\r\n", rc);
+                   _nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
+                               "Error reading mouse queue, rc=%lu.\r\n", rc);
                    break;
                }
                if (!sp->_emxmouse_activated)
@@ -271,9 +301,11 @@ mouse_server(unsigned long param)
              finish:
                oldstate = mouev.fs;
            }
-       } else
-           sprintf(err, "Error setting event mask, buttons=%d, rc=%lu.\r\n",
-                   nbuttons, rc);
+       } else {
+           _nc_SPRINTF(err, _nc_SLIMIT(sizeof(err))
+                       "Error setting event mask, buttons=%d, rc=%lu.\r\n",
+                       nbuttons, rc);
+       }
 
        DosWrite(2, err, strlen(err), &rc);
        MouClose(hmou);
@@ -355,9 +387,46 @@ static void
 init_xterm_mouse(SCREEN *sp)
 {
     sp->_mouse_type = M_XTERM;
+    sp->_mouse_format = MF_X10;
     sp->_mouse_xtermcap = tigetstr("XM");
-    if (!VALID_STRING(sp->_mouse_xtermcap))
+    if (VALID_STRING(sp->_mouse_xtermcap)) {
+       char *code = strstr(sp->_mouse_xtermcap, "[?");
+       if (code != 0) {
+           code += 2;
+           while ((*code >= '0') && (*code <= '9')) {
+               char *next = code;
+               while ((*next >= '0') && (*next <= '9')) {
+                   ++next;
+               }
+               if (!strncmp(code, "1006", (size_t) (next - code))) {
+                   sp->_mouse_format = MF_SGR1006;
+               }
+#ifdef EXP_XTERM_1005
+               if (!strncmp(code, "1005", (size_t) (next - code))) {
+                   sp->_mouse_format = MF_XTERM_1005;
+               }
+#endif
+               if (*next == ';') {
+                   while (*next == ';') {
+                       ++next;
+                   }
+                   code = next;
+               } else {
+                   break;
+               }
+           }
+       }
+    } else {
+       int code = tigetnum("XM");
+       switch (code) {
+       case 1006:
+           break;
+       default:
+           code = 1000;
+           break;
+       }
        sp->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
+    }
 }
 #endif
 
@@ -367,23 +436,29 @@ enable_xterm_mouse(SCREEN *sp, int enable)
 #if USE_EMX_MOUSE
     sp->_emxmouse_activated = enable;
 #else
-    NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_ARGx
-                              "xterm-mouse",
-                              TPARM_1(sp->_mouse_xtermcap, enable));
+    NCURSES_PUTP2("xterm-mouse", TIPARM_1(sp->_mouse_xtermcap, enable));
 #endif
     sp->_mouse_active = enable;
 }
 
 #if USE_GPM_SUPPORT
 static bool
-allow_gpm_mouse(void)
+allow_gpm_mouse(SCREEN *sp GCC_UNUSED)
 {
     bool result = FALSE;
 
-    /* GPM does printf's without checking if stdout is a terminal */
-    if (isatty(fileno(stdout))) {
-       char *list = getenv("NCURSES_GPM_TERMS");
-       char *env = getenv("TERM");
+#if USE_WEAK_SYMBOLS
+    /* Danger Robinson: do not use dlopen for libgpm if already loaded */
+    if ((Gpm_Wgetch) != 0) {
+       if (!sp->_mouse_gpm_loaded) {
+           T(("GPM library was already dlopen'd, not by us"));
+       }
+    } else
+#endif
+       /* GPM does printf's without checking if stdout is a terminal */
+    if (NC_ISATTY(fileno(stdout))) {
+       const char *list = getenv("NCURSES_GPM_TERMS");
+       const char *env = getenv("TERM");
        if (list != 0) {
            if (env != 0) {
                result = _nc_name_match(list, env, "|:");
@@ -412,8 +487,6 @@ unload_gpm_library(SCREEN *sp)
        T(("unload GPM library"));
        sp->_mouse_gpm_loaded = FALSE;
        sp->_mouse_fd = -1;
-       dlclose(sp->_dlopen_gpm);
-       sp->_dlopen_gpm = 0;
     }
 }
 
@@ -421,20 +494,36 @@ static void
 load_gpm_library(SCREEN *sp)
 {
     sp->_mouse_gpm_found = FALSE;
-    if ((sp->_dlopen_gpm = dlopen(LIBGPM_SONAME, my_RTLD)) != 0) {
+
+    /*
+     * If we already had a successful dlopen, reuse it.
+     */
+    if (sp->_dlopen_gpm != 0) {
+       sp->_mouse_gpm_found = TRUE;
+       sp->_mouse_gpm_loaded = TRUE;
+    } else if ((sp->_dlopen_gpm = dlopen(LIBGPM_SONAME, my_RTLD)) != 0) {
+#if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wpedantic"
+#endif
        if (GET_DLSYM(gpm_fd) == 0 ||
            GET_DLSYM(Gpm_Open) == 0 ||
            GET_DLSYM(Gpm_Close) == 0 ||
            GET_DLSYM(Gpm_GetEvent) == 0) {
+#if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
+#pragma GCC diagnostic pop
+#endif
            T(("GPM initialization failed: %s", dlerror()));
            unload_gpm_library(sp);
+           dlclose(sp->_dlopen_gpm);
+           sp->_dlopen_gpm = 0;
        } else {
            sp->_mouse_gpm_found = TRUE;
            sp->_mouse_gpm_loaded = TRUE;
        }
     }
 }
-#endif
+#endif /* HAVE_LIBDL */
 
 static bool
 enable_gpm_mouse(SCREEN *sp, bool enable)
@@ -506,7 +595,7 @@ initialize_mousetype(SCREEN *sp)
 
     /* Try gpm first, because gpm may be configured to run in xterm */
 #if USE_GPM_SUPPORT
-    if (allow_gpm_mouse()) {
+    if (allow_gpm_mouse(sp)) {
        if (!sp->_mouse_gpm_loaded) {
 #ifdef HAVE_LIBDL
            load_gpm_library(sp);
@@ -533,8 +622,8 @@ initialize_mousetype(SCREEN *sp)
     /* OS/2 VIO */
 #if USE_EMX_MOUSE
     if (!sp->_emxmouse_thread
-       && strstr(TerminalOf(sp)->type.term_names, "xterm") == 0
-       && key_mouse) {
+       && strstr(SP_TERMTYPE term_names, "xterm") == 0
+       && NonEmpty(key_mouse)) {
        int handles[2];
 
        if (pipe(handles) < 0) {
@@ -544,7 +633,7 @@ initialize_mousetype(SCREEN *sp)
            int rc;
 
            if (!sp->_emxmouse_buttons[0]) {
-               char *s = getenv("MOUSE_BUTTONS_123");
+               const char *s = getenv("MOUSE_BUTTONS_123");
 
                sp->_emxmouse_buttons[0] = 1;
                if (s && strlen(s) >= 3) {
@@ -577,13 +666,14 @@ initialize_mousetype(SCREEN *sp)
 
 #if USE_SYSMOUSE
     {
+       static char dev_tty[] = "/dev/tty";
        struct mouse_info the_mouse;
        char *the_device = 0;
 
-       if (isatty(sp->_ifd))
+       if (NC_ISATTY(sp->_ifd))
            the_device = ttyname(sp->_ifd);
        if (the_device == 0)
-           the_device = "/dev/tty";
+           the_device = dev_tty;
 
        sp->_mouse_fd = open(the_device, O_RDWR);
 
@@ -641,15 +731,12 @@ initialize_mousetype(SCREEN *sp)
 #endif /* USE_SYSMOUSE */
 
 #ifdef USE_TERM_DRIVER
-    CallDriver(sp, initmouse);
+    CallDriver(sp, td_initmouse);
 #else
     /* we know how to recognize mouse events under "xterm" */
-    if (key_mouse != 0) {
-       if (!strcmp(key_mouse, xterm_kmous)
-           || strstr(TerminalOf(sp)->type.term_names, "xterm") != 0) {
-           init_xterm_mouse(sp);
-       }
-    } else if (strstr(TerminalOf(sp)->type.term_names, "xterm") != 0) {
+    if (NonEmpty(key_mouse)) {
+       init_xterm_mouse(sp);
+    } else if (strstr(SP_TERMTYPE term_names, "xterm") != 0) {
        if (_nc_add_to_try(&(sp->_keytry), xterm_kmous, KEY_MOUSE) == OK)
            init_xterm_mouse(sp);
     }
@@ -663,17 +750,18 @@ _nc_mouse_init(SCREEN *sp)
 /* initialize the mouse */
 {
     bool result = FALSE;
-    int i;
 
     if (sp != 0) {
        if (!sp->_mouse_initialized) {
+           int i;
+
            sp->_mouse_initialized = TRUE;
 
            TR(MY_TRACE, ("_nc_mouse_init() called"));
 
            sp->_mouse_eventp = FirstEV(sp);
            for (i = 0; i < EV_MAX; i++)
-               sp->_mouse_events[i].id = INVALID_EVENT;
+               Invalidate(sp->_mouse_events + i);
 
            initialize_mousetype(sp);
 
@@ -819,173 +907,456 @@ _nc_mouse_event(SCREEN *sp)
     return result;             /* true if we found an event */
 }
 
+#if USE_EMX_MOUSE
+#define PRESS_POSITION(n) \
+    do { \
+           eventp->bstate = MASK_PRESS(n); \
+           sp->_mouse_bstate |= MASK_PRESS(n); \
+           if (button & 0x40) { \
+                   eventp->bstate = MASK_RELEASE(n); \
+                   sp->_mouse_bstate &= ~MASK_PRESS(n); \
+           } \
+    } while (0)
+#else
+#define PRESS_POSITION(n) \
+    do { \
+           eventp->bstate = (mmask_t) ((sp->_mouse_bstate & MASK_PRESS(n)) \
+                                   ? REPORT_MOUSE_POSITION \
+                                   : MASK_PRESS(n)); \
+           sp->_mouse_bstate |= MASK_PRESS(n); \
+    } while (0)
+#endif
+
 static bool
-_nc_mouse_inline(SCREEN *sp)
-/* mouse report received in the keyboard stream -- parse its info */
+handle_wheel(SCREEN *sp, MEVENT * eventp, int button, int wheel)
 {
-    int b;
-    bool result = FALSE;
-    MEVENT *eventp = sp->_mouse_eventp;
+    bool result = TRUE;
+
+    switch (button & 3) {
+    case 0:
+       if (wheel) {
+           eventp->bstate = MASK_PRESS(4);
+           /* Do not record in sp->_mouse_bstate; there will be no
+            * corresponding release event.
+            */
+       } else {
+           PRESS_POSITION(1);
+       }
+       break;
+    case 1:
+       if (wheel) {
+#if NCURSES_MOUSE_VERSION >= 2
+           eventp->bstate = MASK_PRESS(5);
+           /* See comment above for button 4 */
+#else
+           /* Ignore this event as it is not a true press of the button */
+           eventp->bstate = REPORT_MOUSE_POSITION;
+#endif
+       } else {
+           PRESS_POSITION(2);
+       }
+       break;
+    case 2:
+       PRESS_POSITION(3);
+       break;
+    default:
+       result = FALSE;
+       break;
+    }
+    return result;
+}
 
-    TR(MY_TRACE, ("_nc_mouse_inline() called"));
+static bool
+decode_X10_bstate(SCREEN *sp, MEVENT * eventp, unsigned intro)
+{
+    bool result;
+    int button = 0;
+    int wheel = (intro & 96) == 96;
 
-    if (sp->_mouse_type == M_XTERM) {
-       unsigned char kbuf[4];
-       size_t grabbed;
-       int res;
+    eventp->bstate = 0;
 
-       /* This code requires that your xterm entry contain the kmous
-        * capability and that it be set to the \E[M documented in the
-        * Xterm Control Sequences reference.  This is how we
-        * arrange for mouse events to be reported via a KEY_MOUSE
-        * return value from wgetch().  After this value is received,
-        * _nc_mouse_inline() gets called and is immediately
-        * responsible for parsing the mouse status information
-        * following the prefix.
-        *
-        * The following quotes from the ctrlseqs.ms document in the
-        * X distribution, describing the X mouse tracking feature:
-        *
-        * Parameters for all mouse tracking escape sequences
-        * generated by xterm encode numeric parameters in a single
-        * character as value+040.  For example, !  is 1.
-        *
-        * On button press or release, xterm sends ESC [ M CbCxCy.
-        * The low two bits of Cb encode button information: 0=MB1
-        * pressed, 1=MB2 pressed, 2=MB3 pressed, 3=release.  The
-        * upper bits encode what modifiers were down when the
-        * button was pressed and are added together.  4=Shift,
-        * 8=Meta, 16=Control.  Cx and Cy are the x and y coordinates
-        * of the mouse event.  The upper left corner is (1,1).
-        *
-        * (End quote)  By the time we get here, we've eaten the
-        * key prefix.  FYI, the loop below is necessary because
-        * mouse click info isn't guaranteed to present as a
-        * single clist item.
-        *
-        * Wheel mice may return buttons 4 and 5 when the wheel is turned.
-        * We encode those as button presses.
+    if (intro >= 96) {
+       if (intro >= 160) {
+           button = (int) (intro - 152);       /* buttons 8-11 */
+       } else {
+           button = (int) (intro - 92);        /* buttons 4-7 */
+       }
+    } else {
+       button = (intro & 3);
+    }
+
+    if (button > MAX_BUTTONS) {
+       eventp->bstate = REPORT_MOUSE_POSITION;
+    } else if (!handle_wheel(sp, eventp, (int) intro, wheel)) {
+
+       /*
+        * Release events aren't reported for individual buttons, just for
+        * the button set as a whole.  However, because there are normally
+        * no mouse events under xterm that intervene between press and
+        * release, we can infer the button actually released by looking at
+        * the previous event.
         */
+       if (sp->_mouse_bstate & BUTTON_PRESSED) {
+           int b;
+
+           eventp->bstate = BUTTON_RELEASED;
+           for (b = 1; b <= MAX_BUTTONS; ++b) {
+               if (!(sp->_mouse_bstate & MASK_PRESS(b)))
+                   eventp->bstate &= ~MASK_RELEASE(b);
+           }
+           sp->_mouse_bstate = 0;
+       } else {
+           /*
+            * xterm will return a stream of release-events to let the
+            * application know where the mouse is going, if private mode
+            * 1002 or 1003 is enabled.
+            */
+           eventp->bstate = REPORT_MOUSE_POSITION;
+       }
+    }
+
+    if (intro & 4) {
+       eventp->bstate |= BUTTON_SHIFT;
+    }
+    if (intro & 8) {
+       eventp->bstate |= BUTTON_ALT;
+    }
+    if (intro & 16) {
+       eventp->bstate |= BUTTON_CTRL;
+    }
+    result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
+    return result;
+}
+
+/* This code requires that your xterm entry contain the kmous capability and
+ * that it be set to the \E[M documented in the Xterm Control Sequences
+ * reference.  This is how we arrange for mouse events to be reported via a
+ * KEY_MOUSE return value from wgetch().  After this value is received,
+ * _nc_mouse_inline() gets called and is immediately responsible for parsing
+ * the mouse status information following the prefix.
+ *
+ * The following quotes from the ctlseqs.ms document in the XTerm distribution,
+ * describing the mouse tracking feature:
+ *
+ * Parameters for all mouse tracking escape sequences generated by xterm encode
+ * numeric parameters in a single character as value+040.  For example, ! is
+ * 1.
+ *
+ * On button press or release, xterm sends ESC [ M CbCxCy.  The low two bits of
+ * Cb encode button information:  0=MB1 pressed, 1=MB2 pressed, 2=MB3 pressed,
+ * 3=release.  The upper bits encode what modifiers were down when the button
+ * was pressed and are added together.  4=Shift, 8=Meta, 16=Control.  Cx and Cy
+ * are the x and y coordinates of the mouse event.  The upper left corner is
+ * (1,1).
+ *
+ * (End quote) By the time we get here, we've eaten the key prefix.  FYI, the
+ * loop below is necessary because mouse click info isn't guaranteed to present
+ * as a single clist item.
+ *
+ * Wheel mice may return buttons 4 and 5 when the wheel is turned.  We encode
+ * those as button presses.
+ */
+static bool
+decode_xterm_X10(SCREEN *sp, MEVENT * eventp)
+{
+#define MAX_KBUF 3
+    unsigned char kbuf[MAX_KBUF + 1];
+    size_t grabbed;
+    int res;
+    bool result;
+
 # if USE_PTHREADS_EINTR
 #  if USE_WEAK_SYMBOLS
-       if ((pthread_self) && (pthread_kill) && (pthread_equal))
+    if ((pthread_self) && (pthread_kill) && (pthread_equal))
 #  endif
-           _nc_globals.read_thread = pthread_self();
+       _nc_globals.read_thread = pthread_self();
 # endif
-       for (grabbed = 0; grabbed < 3; grabbed += (size_t) res) {
+    for (grabbed = 0; grabbed < MAX_KBUF; grabbed += (size_t) res) {
 
-           /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
+       /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
+       res = (int) read(
 #if USE_EMX_MOUSE
-           res = (int) read(M_FD(sp) >= 0 ? M_FD(sp) : sp->_ifd, &kbuf, 3);
+                           (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
 #else
-           res = (int) read(sp->_ifd, kbuf + grabbed, 3 - grabbed);
+                           sp->_ifd,
 #endif
-           if (res == -1)
-               break;
-       }
+                           kbuf + grabbed, (size_t) (MAX_KBUF - (int) grabbed));
+       if (res == -1)
+           break;
+    }
 #if USE_PTHREADS_EINTR
-       _nc_globals.read_thread = 0;
+    _nc_globals.read_thread = 0;
 #endif
-       kbuf[3] = '\0';
+    kbuf[MAX_KBUF] = '\0';
 
-       TR(TRACE_IEVENT,
-          ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
+    TR(TRACE_IEVENT,
+       ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
 
-       /* there's only one mouse... */
-       eventp->id = NORMAL_EVENT;
+    /* there's only one mouse... */
+    eventp->id = NORMAL_EVENT;
+
+    result = decode_X10_bstate(sp, eventp, kbuf[0]);
 
-       /* processing code goes here */
-       eventp->bstate = 0;
+    eventp->x = (kbuf[1] - ' ') - 1;
+    eventp->y = (kbuf[2] - ' ') - 1;
 
+    return result;
+}
+
+#ifdef EXP_XTERM_1005
+/*
+ * This is identical to X10/X11 responses except that there are two UTF-8
+ * characters storing the ordinates instead of two bytes.
+ */
+static bool
+decode_xterm_1005(SCREEN *sp, MEVENT * eventp)
+{
+    char kbuf[80];
+    size_t grabbed;
+    size_t limit = (sizeof(kbuf) - 1);
+    unsigned coords[2];
+    bool result;
+
+    coords[0] = 0;
+    coords[1] = 0;
+
+# if USE_PTHREADS_EINTR
+#  if USE_WEAK_SYMBOLS
+    if ((pthread_self) && (pthread_kill) && (pthread_equal))
+#  endif
+       _nc_globals.read_thread = pthread_self();
+# endif
+    for (grabbed = 0; grabbed < limit;) {
+       int res;
+
+       res = (int) read(
 #if USE_EMX_MOUSE
-#define PRESS_POSITION(n) \
-       do { \
-               eventp->bstate = MASK_PRESS(n); \
-               sp->_mouse_bstate |= MASK_PRESS(n); \
-               if (kbuf[0] & 0x40) { \
-                       eventp->bstate = MASK_RELEASE(n); \
-                       sp->_mouse_bstate &= ~MASK_PRESS(n); \
-               } \
-       } while (0)
+                           (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
 #else
-#define PRESS_POSITION(n) \
-       do { \
-               eventp->bstate = (mmask_t) (sp->_mouse_bstate & MASK_PRESS(n) \
-                                       ? REPORT_MOUSE_POSITION \
-                                       : MASK_PRESS(n)); \
-               sp->_mouse_bstate |= MASK_PRESS(n); \
-       } while (0)
+                           sp->_ifd,
 #endif
+                           (kbuf + grabbed), (size_t) 1);
+       if (res == -1)
+           break;
+       grabbed += (size_t) res;
+       if (grabbed > 1) {
+           size_t check = 1;
+           int n;
 
-       switch (kbuf[0] & 0x3) {
-       case 0x0:
-           if ((kbuf[0] & 96) == 96) {
-               eventp->bstate = MASK_PRESS(4);
-               /* Do not record in sp->_mouse_bstate; there will be no
-                * corresponding release event.
-                */
-           } else {
-               PRESS_POSITION(1);
+           for (n = 0; n < 2; ++n) {
+               int rc;
+
+               if (check >= grabbed)
+                   break;
+               rc = _nc_conv_to_utf32(&coords[n], kbuf + check, (unsigned)
+                                      (grabbed - check));
+               if (!rc)
+                   break;
+               check += (size_t) rc;
            }
-           break;
+           if (n >= 2)
+               break;
+       }
+    }
+#if USE_PTHREADS_EINTR
+    _nc_globals.read_thread = 0;
+#endif
 
-       case 0x1:
-           if ((kbuf[0] & 96) == 96) {
-#if NCURSES_MOUSE_VERSION == 2
-               eventp->bstate = MASK_PRESS(5);
-               /* See comment above for button 4 */
+    TR(TRACE_IEVENT,
+       ("_nc_mouse_inline sees the following xterm data: %s",
+       _nc_visbufn(kbuf, (int) grabbed)));
+
+    /* there's only one mouse... */
+    eventp->id = NORMAL_EVENT;
+
+    result = decode_X10_bstate(sp, eventp, UChar(kbuf[0]));
+
+    eventp->x = (int) (coords[0] - ' ') - 1;
+    eventp->y = (int) (coords[1] - ' ') - 1;
+
+    return result;
+}
+#endif /* EXP_XTERM_1005 */
+
+/*
+ * ECMA-48 section 5.4
+ */
+#define isInter(c) ((c) >= 0x20 && (c) <= 0x2f)
+#define isParam(c) ((c) >= 0x30 && (c) <= 0x3f)
+#define isFinal(c) ((c) >= 0x40 && (c) <= 0x7e)
+
+#define MAX_PARAMS 9
+
+typedef struct {
+    int nerror;                        /* nonzero if there are unexpected chars */
+    int nparam;                        /* number of numeric parameters */
+    int params[MAX_PARAMS];
+    int final;                 /* the final-character */
+} SGR_DATA;
+
+static bool
+read_SGR(SCREEN *sp, SGR_DATA * result)
+{
+    char kbuf[80];             /* bigger than any possible mouse response */
+    int grabbed = 0;
+    int ch = 0;
+    int now = -1;
+    int marker = 1;
+
+    memset(result, 0, sizeof(*result));
+# if USE_PTHREADS_EINTR
+#  if USE_WEAK_SYMBOLS
+    if ((pthread_self) && (pthread_kill) && (pthread_equal))
+#  endif
+       _nc_globals.read_thread = pthread_self();
+# endif
+
+    do {
+       int res;
+
+       res = (int) read(
+#if USE_EMX_MOUSE
+                           (M_FD(sp) >= 0) ? M_FD(sp) : sp->_ifd,
 #else
-               /* Ignore this event as it is not a true press of the button */
-               eventp->bstate = REPORT_MOUSE_POSITION;
+                           sp->_ifd,
 #endif
-           } else {
-               PRESS_POSITION(2);
+                           (kbuf + grabbed), (size_t) 1);
+       if (res == -1)
+           break;
+       if ((grabbed + MAX_KBUF) >= (int) sizeof(kbuf)) {
+           result->nerror++;
+           break;
+       }
+       ch = UChar(kbuf[grabbed]);
+       kbuf[grabbed + 1] = 0;
+       switch (ch) {
+       case '0':
+       case '1':
+       case '2':
+       case '3':
+       case '4':
+       case '5':
+       case '6':
+       case '7':
+       case '8':
+       case '9':
+           if (marker) {
+               ++now;
+               result->nparam = (now + 1);
            }
+           marker = 0;
+           result->params[now] = (result->params[now] * 10) + (ch - '0');
            break;
-
-       case 0x2:
-           PRESS_POSITION(3);
+       case ';':
+           if (marker) {
+               ++now;
+               result->nparam = (now + 1);
+           }
+           marker = 1;
            break;
-
-       case 0x3:
-           /*
-            * Release events aren't reported for individual buttons, just for
-            * the button set as a whole.  However, because there are normally
-            * no mouse events under xterm that intervene between press and
-            * release, we can infer the button actually released by looking at
-            * the previous event.
-            */
-           if (sp->_mouse_bstate & BUTTON_PRESSED) {
-               eventp->bstate = BUTTON_RELEASED;
-               for (b = 1; b <= MAX_BUTTONS; ++b) {
-                   if (!(sp->_mouse_bstate & MASK_PRESS(b)))
-                       eventp->bstate &= ~MASK_RELEASE(b);
-               }
-               sp->_mouse_bstate = 0;
-           } else {
+       default:
+           if (ch < 32 || ch > 126) {
                /*
-                * XFree86 xterm will return a stream of release-events to
-                * let the application know where the mouse is going, if the
-                * private mode 1002 or 1003 is enabled.
+                * Technically other characters could be interspersed in the
+                * response.  Ignore those for now.
                 */
-               eventp->bstate = REPORT_MOUSE_POSITION;
+               result->nerror++;
+               continue;
+           } else if (isFinal(ch)) {
+               if (marker) {
+                   result->nparam++;
+               }
+               result->final = ch;
+           } else {
+               result->nerror++;
            }
            break;
        }
-       result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
+       ++grabbed;
+    } while (!isFinal(ch));
+#if USE_PTHREADS_EINTR
+    _nc_globals.read_thread = 0;
+#endif
 
-       if (kbuf[0] & 4) {
+    kbuf[++grabbed] = 0;
+    TR(TRACE_IEVENT,
+       ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));
+    return (grabbed > 0) && (result->nerror == 0);
+}
+
+static bool
+decode_xterm_SGR1006(SCREEN *sp, MEVENT * eventp)
+{
+    SGR_DATA data;
+    bool result = FALSE;
+    if (read_SGR(sp, &data)) {
+       int b = data.params[0];
+       int b3 = 1 + (b & 3);
+       int wheel = ((b & 64) == 64);
+
+       if (b >= 132) {
+           b3 = MAX_BUTTONS + 1;
+       } else if (b >= 128) {
+           b3 = (b - 120);     /* buttons 8-11 */
+       } else if (b >= 64) {
+           b3 = (b - 60);      /* buttons 6-7 */
+       }
+
+       eventp->id = NORMAL_EVENT;
+       if (data.final == 'M') {
+           (void) handle_wheel(sp, eventp, b, wheel);
+       } else if (b3 > MAX_BUTTONS) {
+           eventp->bstate = REPORT_MOUSE_POSITION;
+       } else {
+           mmask_t pressed = (mmask_t) NCURSES_MOUSE_MASK(b3, NCURSES_BUTTON_PRESSED);
+           mmask_t release = (mmask_t) NCURSES_MOUSE_MASK(b3, NCURSES_BUTTON_RELEASED);
+           if (sp->_mouse_bstate & pressed) {
+               eventp->bstate = release;
+               sp->_mouse_bstate &= ~pressed;
+           } else {
+               eventp->bstate = REPORT_MOUSE_POSITION;
+           }
+       }
+       if (b & 4) {
            eventp->bstate |= BUTTON_SHIFT;
        }
-       if (kbuf[0] & 8) {
+       if (b & 8) {
            eventp->bstate |= BUTTON_ALT;
        }
-       if (kbuf[0] & 16) {
+       if (b & 16) {
            eventp->bstate |= BUTTON_CTRL;
        }
+       result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;
+       eventp->x = (data.params[1] ? (data.params[1] - 1) : 0);
+       eventp->y = (data.params[2] ? (data.params[2] - 1) : 0);
+    }
+    return result;
+}
+
+static bool
+_nc_mouse_inline(SCREEN *sp)
+/* mouse report received in the keyboard stream -- parse its info */
+{
+    bool result = FALSE;
+    MEVENT *eventp = sp->_mouse_eventp;
+
+    TR(MY_TRACE, ("_nc_mouse_inline() called"));
+
+    if (sp->_mouse_type == M_XTERM) {
+       switch (sp->_mouse_format) {
+       case MF_X10:
+           result = decode_xterm_X10(sp, eventp);
+           break;
+       case MF_SGR1006:
+           result = decode_xterm_SGR1006(sp, eventp);
+           break;
+#ifdef EXP_XTERM_1005
+       case MF_XTERM_1005:
+           result = decode_xterm_1005(sp, eventp);
+           break;
+#endif
+       }
 
-       eventp->x = (kbuf[1] - ' ') - 1;
-       eventp->y = (kbuf[2] - ' ') - 1;
        TR(MY_TRACE,
           ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
            _nc_tracemouse(sp, eventp),
@@ -993,16 +1364,30 @@ _nc_mouse_inline(SCREEN *sp)
 
        /* bump the next-free pointer into the circular list */
        sp->_mouse_eventp = NEXT(eventp);
-#if 0                          /* this return would be needed for QNX's mods to lib_getch.c */
-       return (TRUE);
-#endif
+
+       if (!result) {
+           /* If this event is from a wheel-mouse, treat it like position
+            * reports and avoid waiting for the release-events which will
+            * never come.
+            */
+           if (eventp->bstate & BUTTON_PRESSED) {
+               int b;
+
+               for (b = 4; b <= MAX_BUTTONS; ++b) {
+                   if ((eventp->bstate & MASK_PRESS(b))) {
+                       result = TRUE;
+                       break;
+                   }
+               }
+           }
+       }
     }
 
     return (result);
 }
 
 static void
-mouse_activate(SCREEN *sp, bool on)
+mouse_activate(SCREEN *sp, int on)
 {
     if (!on && !sp->_mouse_initialized)
        return;
@@ -1133,7 +1518,7 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
      */
     ep = eventp;
     for (n = runcount; n < EV_MAX; n++) {
-       ep->id = INVALID_EVENT;
+       Invalidate(ep);
        ep = NEXT(ep);
     }
 
@@ -1159,7 +1544,7 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
 #define MASK_CHANGED(x) (!(ep->bstate & MASK_PRESS(x)) \
                      == !(next->bstate & MASK_RELEASE(x)))
 
-           if (ep->id != INVALID_EVENT && next->id != INVALID_EVENT
+           if (ValidEvent(ep) && ValidEvent(next)
                && ep->x == next->x && ep->y == next->y
                && (ep->bstate & BUTTON_PRESSED)
                && (!(next->bstate & BUTTON_PRESSED))) {
@@ -1182,14 +1567,15 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
                            merge = TRUE;
                        }
                    }
-                   if (merge)
-                       ep->id = INVALID_EVENT;
+                   if (merge) {
+                       Invalidate(ep);
+                   }
                }
            }
        }
 
        /* Compact valid events */
-       if (ep->id == INVALID_EVENT) {
+       if (!ValidEvent(ep)) {
            if ((first_valid != NULL) && (first_invalid == NULL)) {
                first_invalid = ep;
            }
@@ -1198,7 +1584,7 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
                first_valid = ep;
            } else if (first_invalid != NULL) {
                *first_invalid = *ep;
-               ep->id = INVALID_EVENT;
+               Invalidate(ep);
                first_invalid = NEXT(first_invalid);
            }
        }
@@ -1247,6 +1633,8 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
        if (next == eventp) {
            /* Will end the loop, but check event type and compact before */
            endLoop = TRUE;
+       } else if (!ValidEvent(next)) {
+           continue;
        } else {
            /* merge click events forward */
            if ((ep->bstate & BUTTON_CLICKED)
@@ -1261,8 +1649,9 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
                        merge = TRUE;
                    }
                }
-               if (merge)
-                   ep->id = INVALID_EVENT;
+               if (merge) {
+                   Invalidate(ep);
+               }
            }
 
            /* merge double-click events forward */
@@ -1278,18 +1667,19 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
                        merge = TRUE;
                    }
                }
-               if (merge)
-                   ep->id = INVALID_EVENT;
+               if (merge) {
+                   Invalidate(ep);
+               }
            }
        }
 
        /* Discard event if it does not match event mask */
-       if (!(ep->bstate & sp->_mouse_mask)) {
-           ep->id = INVALID_EVENT;
+       if (!(ep->bstate & sp->_mouse_mask2)) {
+           Invalidate(ep);
        }
 
        /* Compact valid events */
-       if (ep->id == INVALID_EVENT) {
+       if (!ValidEvent(ep)) {
            if (ep == first_valid) {
                first_valid = next;
            } else if (first_invalid == NULL) {
@@ -1297,7 +1687,7 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
            }
        } else if (first_invalid != NULL) {
            *first_invalid = *ep;
-           ep->id = INVALID_EVENT;
+           Invalidate(ep);
            first_invalid = NEXT(first_invalid);
        }
 
@@ -1319,7 +1709,7 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
            _nc_unlock_global(tracef);
        }
        for (ep = first_valid; ep != first_invalid; ep = NEXT(ep)) {
-           if (ep->id != INVALID_EVENT)
+           if (ValidEvent(ep))
                TR(MY_TRACE,
                   ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
                    _nc_tracemouse(sp, ep),
@@ -1329,7 +1719,7 @@ _nc_mouse_parse(SCREEN *sp, int runcount)
 #endif /* TRACE */
 
     /* after all this, do we have a valid event? */
-    return (PREV(first_invalid)->id != INVALID_EVENT);
+    return ValidEvent(PREV(first_invalid));
 }
 
 static void
@@ -1413,11 +1803,14 @@ NCURSES_EXPORT(int)
 NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
 {
     int result = ERR;
+    MEVENT *eventp;
 
     T((T_CALLED("getmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
 
-    if ((aevent != 0) && (SP_PARM != 0) && (SP_PARM->_mouse_type != M_NONE)) {
-       MEVENT *eventp = SP_PARM->_mouse_eventp;
+    if ((aevent != 0) &&
+       (SP_PARM != 0) &&
+       (SP_PARM->_mouse_type != M_NONE) &&
+       (eventp = SP_PARM->_mouse_eventp) != 0) {
        /* compute the current-event pointer */
        MEVENT *prev = PREV(eventp);
 
@@ -1426,11 +1819,11 @@ NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
         * _nc_mouse_parse was not called, e.g., when _nc_mouse_inline returns
         * false).
         */
-       while ((prev->id != INVALID_EVENT) && (!(prev->bstate & SP_PARM->_mouse_mask))) {
-           prev->id = INVALID_EVENT;
+       while (ValidEvent(prev) && (!(prev->bstate & SP_PARM->_mouse_mask2))) {
+           Invalidate(prev);
            prev = PREV(prev);
        }
-       if (prev->id != INVALID_EVENT) {
+       if (ValidEvent(prev)) {
            /* copy the event we find there */
            *aevent = *prev;
 
@@ -1438,13 +1831,13 @@ NCURSES_SP_NAME(getmouse) (NCURSES_SP_DCLx MEVENT * aevent)
                              _nc_tracemouse(SP_PARM, prev),
                              (long) IndexEV(SP_PARM, prev)));
 
-           prev->id = INVALID_EVENT;   /* so the queue slot becomes free */
+           Invalidate(prev);   /* so the queue slot becomes free */
            SP_PARM->_mouse_eventp = prev;
            result = OK;
        } else {
            /* Reset the provided event */
            aevent->bstate = 0;
-           aevent->id = INVALID_EVENT;
+           Invalidate(aevent);
            aevent->x = 0;
            aevent->y = 0;
            aevent->z = 0;
@@ -1466,11 +1859,13 @@ NCURSES_EXPORT(int)
 NCURSES_SP_NAME(ungetmouse) (NCURSES_SP_DCLx MEVENT * aevent)
 {
     int result = ERR;
+    MEVENT *eventp;
 
     T((T_CALLED("ungetmouse(%p,%p)"), (void *) SP_PARM, (void *) aevent));
 
-    if (aevent != 0 && SP_PARM != 0) {
-       MEVENT *eventp = SP_PARM->_mouse_eventp;
+    if (aevent != 0 &&
+       SP_PARM != 0 &&
+       (eventp = SP_PARM->_mouse_eventp) != 0) {
 
        /* stick the given event in the next-free slot */
        *eventp = *aevent;
@@ -1510,7 +1905,10 @@ NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
 
        if (newmask || SP_PARM->_mouse_initialized) {
            _nc_mouse_init(SP_PARM);
+
            if (SP_PARM->_mouse_type != M_NONE) {
+               int b;
+
                result = newmask &
                    (REPORT_MOUSE_POSITION
                     | BUTTON_ALT
@@ -1525,6 +1923,22 @@ NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
                mouse_activate(SP_PARM, (bool) (result != 0));
 
                SP_PARM->_mouse_mask = result;
+               SP_PARM->_mouse_mask2 = result;
+
+               /*
+                * Make a mask corresponding to the states we will need to
+                * retain (temporarily) while building up the state that the
+                * user asked for.
+                */
+               for (b = 1; b <= MAX_BUTTONS; ++b) {
+                   if (SP_PARM->_mouse_mask2 & MASK_TRIPLE_CLICK(b))
+                       SP_PARM->_mouse_mask2 |= MASK_DOUBLE_CLICK(b);
+                   if (SP_PARM->_mouse_mask2 & MASK_DOUBLE_CLICK(b))
+                       SP_PARM->_mouse_mask2 |= MASK_CLICK(b);
+                   if (SP_PARM->_mouse_mask2 & MASK_CLICK(b))
+                       SP_PARM->_mouse_mask2 |= (MASK_PRESS(b) |
+                                                 MASK_RELEASE(b));
+               }
            }
        }
     }