src/terminal/mouse.c

   1 /* Support for mouse interface */
   2
   3 #ifdef HAVE_CONFIG_H
   4 #include "config.h"
   5 #endif
   6
   7 /* TODO: cleanup includes */
   8
   9 #include <stdlib.h>
  10 #include <string.h>
  11 #ifdef HAVE_TERMIOS_H
  12 #include <termios.h>
  13 #endif
  14 #ifdef HAVE_UNISTD_H
  15 #include <unistd.h>
  16 #endif
  17 #ifdef __hpux__
  18 #include <limits.h>
  19 #define HPUX_PIPE       (len > PIPE_BUF || errno != EAGAIN)
  20 #else
  21 #define HPUX_PIPE       1
  22 #endif
  23
  24 #include "elinks.h"
  25
  26 #include "config/options.h"
  27 #include "intl/gettext/libintl.h"
  28 #include "main/select.h"
  29 #include "main/timer.h"
  30 #include "osdep/ascii.h"
  31 #include "osdep/osdep.h"
  32 #include "terminal/hardio.h"
  33 #include "terminal/itrm.h"
  34 #include "terminal/kbd.h"
  35 #include "terminal/mouse.h"
  36 #include "terminal/terminal.h"
  37 #include "util/error.h"
  38 #include "util/memory.h"
  39 #include "util/string.h"
  40 #include "util/time.h"
  41
  42 extern struct itrm *ditrm;
  43
  44 #define write_sequence(fd, seq) \
  45         hard_write(fd, seq, sizeof(seq) - 1)
  46
  47
  48 #define INIT_TWIN_MOUSE_SEQ     "\033[?9h"      /* Send MIT Mouse Row & Column on Button Press */
  49 #define INIT_XWIN_MOUSE_SEQ     "\033[?1000h"   /* Send Mouse X & Y on button press and release */
  50
  51 void
  52 send_mouse_init_sequence(int h)
  53 {
  54         write_sequence(h, INIT_TWIN_MOUSE_SEQ);
  55         write_sequence(h, INIT_XWIN_MOUSE_SEQ);
  56 }
  57
  58 #define DONE_TWIN_MOUSE_SEQ     "\033[?9l"      /* Don't Send MIT Mouse Row & Column on Button Press */
  59 #define DONE_XWIN_MOUSE_SEQ     "\033[?1000l"   /* Don't Send Mouse X & Y on button press and release */
  60
  61 void
  62 send_mouse_done_sequence(int h)
  63 {
  64         /* This is a hack to make xterm + alternate screen working,
  65          * if we send only DONE_XWIN_MOUSE_SEQ, mouse is not totally
  66          * released it seems, in rxvt and xterm... --Zas */
  67         write_sequence(h, DONE_TWIN_MOUSE_SEQ);
  68         write_sequence(h, DONE_XWIN_MOUSE_SEQ);
  69 }
  70
  71 static int mouse_enabled;
  72
  73 void
  74 disable_mouse(void)
  75 {
  76         int h = get_output_handle(); /* XXX: Is this all right? -- Miciah */
  77
  78         unhandle_mouse(ditrm->mouse_h);
  79         send_mouse_done_sequence(h);
  80
  81         mouse_enabled = 0;
  82 }
  83
  84 void
  85 enable_mouse(void)
  86 {
  87         int h = get_output_handle(); /* XXX: Is this all right? -- Miciah */
  88
  89         send_mouse_init_sequence(h);
  90         ditrm->mouse_h = handle_mouse(0, (void (*)(void *, unsigned char *, int)) itrm_queue_event, ditrm);
  91
  92         mouse_enabled = 1;
  93 }
  94
  95 void
  96 toggle_mouse(void)
  97 {
  98         if (mouse_enabled)
  99                 disable_mouse();
 100         else
 101                 enable_mouse();
 102 }
 103
 104 static int
 105 decode_mouse_position(struct itrm *itrm, int from)
 106 {
 107         int position;
 108
 109         position = (unsigned char) (itrm->in.queue.data[from]) - ' ' - 1
 110                  + ((int) ((unsigned char) (itrm->in.queue.data[from + 1]) - ' ' - 1) << 7);
 111
 112         return (position & (1 << 13)) ? 0 : position;
 113 }
 114
 115 #define get_mouse_x_position(itrm, esclen) decode_mouse_position(itrm, (esclen) + 1)
 116 #define get_mouse_y_position(itrm, esclen) decode_mouse_position(itrm, (esclen) + 3)
 117
 118 #define TW_BUTT_LEFT    1
 119 #define TW_BUTT_MIDDLE  2
 120 #define TW_BUTT_RIGHT   4
 121
 122 /* Returns length of the escape sequence or -1 if the caller needs to set up
 123  * the ESC delay timer. */
 124 int
 125 decode_terminal_mouse_escape_sequence(struct itrm *itrm, struct term_event *ev,
 126                                       int el, int v)
 127 {
 128         static int xterm_button = -1;
 129         struct term_event_mouse mouse;
 130
 131         if (itrm->in.queue.len - el < 3)
 132                 return -1;
 133
 134         if (v == 5) {
 135                 if (xterm_button == -1)
 136                         xterm_button = 0;
 137
 138                 if (itrm->in.queue.len - el < 5)
 139                         return -1;
 140
 141                 mouse.x = get_mouse_x_position(itrm, el);
 142                 mouse.y = get_mouse_y_position(itrm, el);
 143
 144                 switch ((itrm->in.queue.data[el] - ' ') ^ xterm_button) { /* Every event changes only one bit */
 145                 case TW_BUTT_LEFT:
 146                         mouse.button = B_LEFT | ((xterm_button & TW_BUTT_LEFT) ? B_UP : B_DOWN);
 147                         break;
 148                 case TW_BUTT_MIDDLE:
 149                         mouse.button = B_MIDDLE | ((xterm_button & TW_BUTT_MIDDLE) ? B_UP : B_DOWN);
 150                         break;
 151                 case TW_BUTT_RIGHT:
 152                         mouse.button = B_RIGHT | ((xterm_button & TW_BUTT_RIGHT) ? B_UP : B_DOWN);
 153                         break;
 154                 case 0:
 155                         mouse.button = B_DRAG;
 156                         break;
 157                 default:
 158                         mouse.button = 0; /* shut up warning */
 159                 /* default : Twin protocol error */
 160                 }
 161
 162                 xterm_button = itrm->in.queue.data[el] - ' ';
 163                 el += 5;
 164
 165         } else {
 166                 /* See terminal/mouse.h about details of the mouse reporting
 167                  * protocol and {struct term_event_mouse->button} bitmask
 168                  * structure. */
 169                 mouse.x = itrm->in.queue.data[el+1] - ' ' - 1;
 170                 mouse.y = itrm->in.queue.data[el+2] - ' ' - 1;
 171
 172                 /* There are rumours arising from remnants of code dating to
 173                  * the ancient Mikulas' times that bit 4 indicated B_DRAG.
 174                  * However, I didn't find on what terminal it should be ever
 175                  * supposed to work and it conflicts with wheels. So I removed
 176                  * the last remnants of the code as well. --pasky */
 177
 178                 mouse.button = (itrm->in.queue.data[el] & 7) | B_DOWN;
 179                 /* smartglasses1 - rxvt wheel: */
 180                 if (mouse.button == 3 && xterm_button != -1) {
 181                         mouse.button = xterm_button | B_UP;
 182                 }
 183                 /* xterm wheel: */
 184                 if ((itrm->in.queue.data[el] & 96) == 96) {
 185                         mouse.button = (itrm->in.queue.data[el] & 1) ? B_WHEEL_DOWN : B_WHEEL_UP;
 186                 }
 187
 188                 xterm_button = -1;
 189                 /* XXX: Eterm/aterm uses rxvt-like reporting, but sends the
 190                  * release sequence for wheel. rxvt itself sends only press
 191                  * sequence. Since we can't reliably guess what we're talking
 192                  * with from $TERM, we will rather support Eterm/aterm, as in
 193                  * rxvt, at least each second wheel up move will work. */
 194                 if (mouse_action_is(&mouse, B_DOWN))
 195                         xterm_button = mouse_get_button(&mouse);
 196
 197                 el += 3;
 198         }
 199
 200         /* Postpone changing of the event type until all sanity
 201          * checks have been done. */
 202         set_mouse_term_event(ev, mouse.x, mouse.y, mouse.button);
 203
 204         return el;
 205 }