ncurses 6.2 - patch 20210213
[ncurses.git] / ncurses / base / lib_mouse.c
index cd46d0c9e21250db77404b061c7f9b2812341ee3..6caef327a3c02b404e420da90fc42494d9706e5a 100644 (file)
@@ -1,5 +1,6 @@
 /****************************************************************************
- * Copyright (c) 1998-2013,2014 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.162 2014/10/12 00:03:37 tom Exp $")
+MODULE_ID("$Id: lib_mouse.c,v 1.192 2021/02/14 00:17:09 tom Exp $")
 
 #include <tic.h>
 
@@ -141,19 +142,29 @@ 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
@@ -225,7 +236,7 @@ write_event(SCREEN *sp, int down, int button, int x, int y)
     char buf[6];
     unsigned long ignore;
 
-    strcpy(buf, "\033[M");     /* should be the same as key_mouse */
+    _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;
@@ -425,20 +436,20 @@ enable_xterm_mouse(SCREEN *sp, int enable)
 #if USE_EMX_MOUSE
     sp->_emxmouse_activated = enable;
 #else
-    NCURSES_PUTP2("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(SCREEN *sp)
+allow_gpm_mouse(SCREEN *sp GCC_UNUSED)
 {
     bool result = FALSE;
 
 #if USE_WEAK_SYMBOLS
     /* Danger Robinson: do not use dlopen for libgpm if already loaded */
-    if ((Gpm_Wgetch)) {
+    if ((Gpm_Wgetch) != 0) {
        if (!sp->_mouse_gpm_loaded) {
            T(("GPM library was already dlopen'd, not by us"));
        }
@@ -446,8 +457,8 @@ allow_gpm_mouse(SCREEN *sp)
 #endif
        /* GPM does printf's without checking if stdout is a terminal */
     if (NC_ISATTY(fileno(stdout))) {
-       char *list = getenv("NCURSES_GPM_TERMS");
-       char *env = getenv("TERM");
+       const char *list = getenv("NCURSES_GPM_TERMS");
+       const char *env = getenv("TERM");
        if (list != 0) {
            if (env != 0) {
                result = _nc_name_match(list, env, "|:");
@@ -476,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;
     }
 }
 
@@ -485,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)
@@ -597,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) {
@@ -608,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) {
@@ -641,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 (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);
 
@@ -708,12 +734,9 @@ initialize_mousetype(SCREEN *sp)
     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);
     }
@@ -727,10 +750,11 @@ _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"));
@@ -888,7 +912,7 @@ _nc_mouse_event(SCREEN *sp)
     do { \
            eventp->bstate = MASK_PRESS(n); \
            sp->_mouse_bstate |= MASK_PRESS(n); \
-           if (kbuf[0] & 0x40) { \
+           if (button & 0x40) { \
                    eventp->bstate = MASK_RELEASE(n); \
                    sp->_mouse_bstate &= ~MASK_PRESS(n); \
            } \
@@ -896,7 +920,7 @@ _nc_mouse_event(SCREEN *sp)
 #else
 #define PRESS_POSITION(n) \
     do { \
-           eventp->bstate = (mmask_t) (sp->_mouse_bstate & MASK_PRESS(n) \
+           eventp->bstate = (mmask_t) ((sp->_mouse_bstate & MASK_PRESS(n)) \
                                    ? REPORT_MOUSE_POSITION \
                                    : MASK_PRESS(n)); \
            sp->_mouse_bstate |= MASK_PRESS(n); \
@@ -921,7 +945,7 @@ handle_wheel(SCREEN *sp, MEVENT * eventp, int button, int wheel)
        break;
     case 1:
        if (wheel) {
-#if NCURSES_MOUSE_VERSION == 2
+#if NCURSES_MOUSE_VERSION >= 2
            eventp->bstate = MASK_PRESS(5);
            /* See comment above for button 4 */
 #else
@@ -946,11 +970,25 @@ static bool
 decode_X10_bstate(SCREEN *sp, MEVENT * eventp, unsigned intro)
 {
     bool result;
-    int b;
+    int button = 0;
+    int wheel = (intro & 96) == 96;
 
     eventp->bstate = 0;
 
-    if (!handle_wheel(sp, eventp, (int) intro, (intro & 96) == 96)) {
+    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
@@ -959,6 +997,8 @@ decode_X10_bstate(SCREEN *sp, MEVENT * eventp, unsigned intro)
         * 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)))
@@ -1019,7 +1059,8 @@ decode_X10_bstate(SCREEN *sp, MEVENT * eventp, unsigned intro)
 static bool
 decode_xterm_X10(SCREEN *sp, MEVENT * eventp)
 {
-    unsigned char kbuf[4];
+#define MAX_KBUF 3
+    unsigned char kbuf[MAX_KBUF + 1];
     size_t grabbed;
     int res;
     bool result;
@@ -1030,7 +1071,7 @@ decode_xterm_X10(SCREEN *sp, MEVENT * eventp)
 #  endif
        _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. */
        res = (int) read(
@@ -1039,14 +1080,14 @@ decode_xterm_X10(SCREEN *sp, MEVENT * eventp)
 #else
                            sp->_ifd,
 #endif
-                           kbuf + grabbed, 3 - grabbed);
+                           kbuf + grabbed, (size_t) (MAX_KBUF - (int) grabbed));
        if (res == -1)
            break;
     }
 #if USE_PTHREADS_EINTR
     _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));
@@ -1074,7 +1115,6 @@ decode_xterm_1005(SCREEN *sp, MEVENT * eventp)
     size_t grabbed;
     size_t limit = (sizeof(kbuf) - 1);
     unsigned coords[2];
-    int res;
     bool result;
 
     coords[0] = 0;
@@ -1087,6 +1127,7 @@ decode_xterm_1005(SCREEN *sp, MEVENT * eventp)
        _nc_globals.read_thread = pthread_self();
 # endif
     for (grabbed = 0; grabbed < limit;) {
+       int res;
 
        res = (int) read(
 #if USE_EMX_MOUSE
@@ -1094,21 +1135,24 @@ decode_xterm_1005(SCREEN *sp, MEVENT * eventp)
 #else
                            sp->_ifd,
 #endif
-                           kbuf + grabbed, 1);
+                           (kbuf + grabbed), (size_t) 1);
        if (res == -1)
            break;
-       grabbed += res;
+       grabbed += (size_t) res;
        if (grabbed > 1) {
            size_t check = 1;
            int n;
-           int rc;
+
            for (n = 0; n < 2; ++n) {
+               int rc;
+
                if (check >= grabbed)
                    break;
-               rc = _nc_conv_to_utf32(&coords[n], kbuf + check, grabbed - check);
+               rc = _nc_conv_to_utf32(&coords[n], kbuf + check, (unsigned)
+                                      (grabbed - check));
                if (!rc)
                    break;
-               check += rc;
+               check += (size_t) rc;
            }
            if (n >= 2)
                break;
@@ -1127,8 +1171,8 @@ decode_xterm_1005(SCREEN *sp, MEVENT * eventp)
 
     result = decode_X10_bstate(sp, eventp, UChar(kbuf[0]));
 
-    eventp->x = (coords[0] - ' ') - 1;
-    eventp->y = (coords[1] - ' ') - 1;
+    eventp->x = (int) (coords[0] - ' ') - 1;
+    eventp->y = (int) (coords[1] - ' ') - 1;
 
     return result;
 }
@@ -1155,7 +1199,6 @@ read_SGR(SCREEN *sp, SGR_DATA * result)
 {
     char kbuf[80];             /* bigger than any possible mouse response */
     int grabbed = 0;
-    int res;
     int ch = 0;
     int now = -1;
     int marker = 1;
@@ -1167,17 +1210,20 @@ read_SGR(SCREEN *sp, SGR_DATA * result)
 #  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
                            sp->_ifd,
 #endif
-                           kbuf + grabbed, 1);
+                           (kbuf + grabbed), (size_t) 1);
        if (res == -1)
            break;
-       if ((grabbed + 3) >= (int) sizeof(kbuf)) {
+       if ((grabbed + MAX_KBUF) >= (int) sizeof(kbuf)) {
            result->nerror++;
            break;
        }
@@ -1246,11 +1292,21 @@ decode_xterm_SGR1006(SCREEN *sp, MEVENT * eventp)
     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 */
+       }
 
-       result = TRUE;
        eventp->id = NORMAL_EVENT;
        if (data.final == 'M') {
-           (void) handle_wheel(sp, eventp, b, (b & 64) == 64);
+           (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);
@@ -1261,6 +1317,15 @@ decode_xterm_SGR1006(SCREEN *sp, MEVENT * eventp)
                eventp->bstate = REPORT_MOUSE_POSITION;
            }
        }
+       if (b & 4) {
+           eventp->bstate |= BUTTON_SHIFT;
+       }
+       if (b & 8) {
+           eventp->bstate |= BUTTON_ALT;
+       }
+       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);
@@ -1738,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);
 
@@ -1791,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;
@@ -1823,7 +1893,6 @@ NCURSES_SP_NAME(mousemask) (NCURSES_SP_DCLx mmask_t newmask, mmask_t * oldmask)
 /* set the mouse event mask */
 {
     mmask_t result = 0;
-    int b;
 
     T((T_CALLED("mousemask(%p,%#lx,%p)"),
        (void *) SP_PARM,
@@ -1836,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