pico/osdep/mouse.c

   1 /*
   2  * ========================================================================
   3  * Copyright 2006-2007 University of Washington
   4  * Copyright 2013-2022 Eduardo Chappa
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * ========================================================================
  13  */
  14
  15 #include <system.h>
  16 #include <general.h>
  17
  18 #include "../headers.h"
  19
  20 #include "getkey.h"
  21
  22 #ifdef _WINDOWS
  23 #include "mswin.h"
  24 #endif
  25
  26 #include "mouse.h"
  27
  28 #ifdef  MOUSE
  29
  30
  31 #ifndef _WINDOWS
  32
  33 /* useful definitions */
  34 #define XTERM_MOUSE_ON  "\033[?1000h"   /* DECSET with parm 1000 */
  35 #define XTERM_MOUSE_OFF "\033[?1000l"   /* DECRST with parm 1000  */
  36
  37
  38 /* useful declarations */
  39 static int mexist = 0;          /* is the mouse driver installed? */
  40 static unsigned mnoop;
  41
  42
  43
  44 /* internal prototypes */
  45 void    mouseon(void);
  46 void    mouseoff(void);
  47
  48
  49
  50 /*
  51  * init_mouse - check for xterm and initialize mouse tracking if present...
  52  */
  53 int
  54 init_mouse(void)
  55 {
  56     if(mexist)
  57       return(TRUE);
  58
  59     if(getenv("DISPLAY")){
  60         mouseon();
  61         kpinsert("\033[M", KEY_XTERM_MOUSE, 1);
  62         return(mexist = TRUE);
  63     }
  64     else
  65       return(FALSE);
  66 }
  67
  68
  69 /*
  70  * end_mouse - clear xterm mouse tracking if present...
  71  */
  72 void
  73 end_mouse(void)
  74 {
  75     if(mexist){
  76         mexist = 0;                     /* just see if it exists here. */
  77         mouseoff();
  78     }
  79 }
  80
  81
  82 /*
  83  * mouseexist - function to let outsiders know if mouse is turned on
  84  *              or not.
  85  */
  86 int
  87 mouseexist(void)
  88 {
  89     return(mexist);
  90 }
  91
  92
  93 /*
  94  * mouseon - call made available for programs calling pico to turn ON the
  95  *           mouse cursor.
  96  */
  97 void
  98 mouseon(void)
  99 {
 100     fputs(XTERM_MOUSE_ON, stdout);
 101 }
 102
 103
 104 /*
 105  * mouseon - call made available for programs calling pico to turn OFF the
 106  *           mouse cursor.
 107  */
 108 void
 109 mouseoff(void)
 110 {
 111     fputs(XTERM_MOUSE_OFF, stdout);
 112 }
 113
 114
 115 /*
 116  * checkmouse - look for mouse events in key menu and return
 117  *              appropriate value.
 118  */
 119 int
 120 checkmouse(unsigned long *ch, int down, int mcol, int mrow)
 121 {
 122     static int oindex;
 123     int i = 0, rv = 0;
 124     MENUITEM *mp;
 125
 126     if(!mexist || mcol < 0 || mrow < 0)
 127       return(FALSE);
 128
 129     if(down)                    /* button down */
 130       oindex = -1;
 131
 132     for(mp = mfunc; mp; mp = mp->next)
 133       if(mp->action && M_ACTIVE(mrow, mcol, mp))
 134         break;
 135
 136     if(mp){
 137         unsigned long r;
 138
 139         r = (*mp->action)(down ? M_EVENT_DOWN : M_EVENT_UP,
 140                           mrow, mcol, M_BUTTON_LEFT, 0);
 141         if(r){
 142             *ch = r;
 143             rv  = TRUE;
 144         }
 145     }
 146     else{
 147         while(1){                       /* see if we understand event */
 148             if(i >= 12){
 149                 i = -1;
 150                 break;
 151             }
 152
 153             if(M_ACTIVE(mrow, mcol, &menuitems[i]))
 154               break;
 155
 156             i++;
 157         }
 158
 159         if(down){                       /* button down */
 160             oindex = i;                 /* remember where */
 161             if(i != -1
 162                && menuitems[i].label_hiliter != NULL
 163                && menuitems[i].val != mnoop)  /* invert label */
 164               (*menuitems[i].label_hiliter)(1, &menuitems[i]);
 165         }
 166         else{                           /* button up */
 167             if(oindex != -1){
 168                 if(i == oindex){
 169                     *ch = menuitems[i].val;
 170                     rv = TRUE;
 171                 }
 172             }
 173         }
 174     }
 175
 176     /* restore label */
 177     if(!down
 178        && oindex != -1
 179        && menuitems[oindex].label_hiliter != NULL
 180        && menuitems[oindex].val != mnoop)
 181       (*menuitems[oindex].label_hiliter)(0, &menuitems[oindex]);
 182
 183     return(rv);
 184 }
 185
 186
 187 /*
 188  * invert_label - highlight the label of the given menu item.
 189  */
 190 void
 191 invert_label(int state, MENUITEM *m)
 192 {
 193     unsigned i, j;
 194     int   col_offset, savettrow, savettcol;
 195     char *lp;
 196
 197     get_cursor(&savettrow, &savettcol);
 198
 199     /*
 200      * Leave the command name bold
 201      */
 202     col_offset = (state || !(lp=strchr(m->label, ' '))) ? 0 : (lp - m->label);
 203     movecursor((int)m->tl.r, (int)m->tl.c + col_offset);
 204     flip_inv(state);
 205
 206     for(i = m->tl.r; i <= m->br.r; i++)
 207       for(j = m->tl.c + col_offset; j <= m->br.c; j++)
 208         if(i == m->lbl.r && j == m->lbl.c + col_offset && m->label){
 209             lp = m->label + col_offset;         /* show label?? */
 210             while(*lp && j++ < m->br.c)
 211               putc(*lp++, stdout);
 212
 213             continue;
 214         }
 215         else
 216           putc(' ', stdout);
 217
 218     if(state)
 219       flip_inv(FALSE);
 220
 221     movecursor(savettrow, savettcol);
 222 }
 223
 224 #else /* _WINDOWS */
 225
 226 #define MOUSE_BUTTONS           3
 227
 228 static int mexist = 0;                  /* is the mouse driver installed? */
 229 static int nbuttons;                    /* number of buttons on the mouse */
 230 static unsigned mnoop;
 231
 232 /*
 233  * init_mouse - check for and initialize mouse driver...
 234  */
 235
 236 int
 237 init_mouse(void)
 238 {
 239     nbuttons = MOUSE_BUTTONS;
 240     return (mexist = TRUE);             /* Mouse always exists under windows */
 241 }
 242
 243 /*
 244  * end_mouse - a no-op on Windows
 245  */
 246 void
 247 end_mouse(void)
 248 {
 249 }
 250
 251 /*
 252  * mouseexist - function to let outsiders know if mouse is turned on
 253  *              or not.
 254  */
 255 int
 256 mouseexist(void)
 257 {
 258     return(mexist);
 259 }
 260
 261 /*
 262  * checkmouse - Check mouse and return mapped command.
 263  *
 264  *      EXPORTED to pico.
 265  *      NOTE: "down", "xxx", and "yyy" aren't used under windows.
 266  */
 267 int
 268 checkmouse (unsigned long *ch, int ddd, int xxx, int yyy)
 269 {
 270     static int  oindex;         /* Index of previous mouse down. */
 271     int         mcol;           /* current mouse column */
 272     int         mrow;           /* current mouse row */
 273     unsigned long r;
 274     int         rv = 0;         /* TRUE when we have something to return. */
 275     MEvent      mouse;
 276     int         i = 0;
 277     MENUITEM    *mp;
 278
 279
 280     *ch = 0;
 281
 282     /* Mouse installed? */
 283     if (!mexist)
 284         return (FALSE);
 285
 286     if (!mswin_getmouseevent (&mouse))
 287         return (FALSE);
 288
 289
 290     /* Location of mouse event. */
 291     mcol = mouse.nColumn;
 292     mrow = mouse.nRow;
 293
 294
 295
 296     /*
 297      * If there is a tracking function it gets all the mouse events
 298      * regardless of where they occur.
 299      */
 300     if (mtrack != NULL) {
 301         r = mtrack (mouse.event, mrow, mcol, mouse.button, mouse.keys);
 302         if (r & 0xffff){
 303             *ch = r;
 304             rv  = TRUE;
 305         }
 306         return (rv);
 307     }
 308
 309
 310
 311
 312     /* Mouse down or up? */
 313     if (mouse.event == M_EVENT_DOWN) {  /* button down */
 314         oindex = -1;    /* No Previous mouse down. */
 315     }
 316
 317
 318     /* In special screen region? */
 319     for(mp = mfunc; mp; mp = mp->next)
 320       if(mp->action && M_ACTIVE(mrow, mcol, mp))
 321         break;
 322
 323     if(mp){
 324
 325         r = (*mp->action)(mouse.event, mrow, mcol, mouse.button, mouse.keys);
 326         if (r){
 327             *ch = r;
 328             rv  = TRUE;
 329         }
 330     }
 331     else if(mouse.button == M_BUTTON_LEFT){
 332
 333         /* In any of the menuitems? */
 334         while(1){       /* see if we understand event */
 335             if(i >= 12){
 336                 i = -1; /* Not Found. */
 337                 break;
 338             }
 339
 340             if(M_ACTIVE(mrow, mcol, &menuitems[i]))
 341                 break;  /* Found. */
 342
 343             i++;                /* Next. */
 344         }
 345
 346         /* Now, was that a mouse down or mouse up? */
 347         if (mouse.event == M_EVENT_DOWN) {      /* button down */
 348             oindex = i;                 /* remember where */
 349             if(i != -1){                /* invert label */
 350                 if(menuitems[i].label_hiliter != NULL)
 351                   (*menuitems[i].label_hiliter)(1, &menuitems[i]);
 352                 else
 353                     invert_label(1, &menuitems[i]);
 354             }
 355         }
 356         else if (mouse.event == M_EVENT_UP) {/* button up */
 357             if (oindex != -1) {           /* If up in menu item. */
 358                 if (i == oindex){         /* And same item down in. */
 359                     *ch = menuitems[i].val; /* Return menu character. */
 360                     rv = 1;
 361                 }
 362             }
 363         }
 364     }
 365     else if(mouse.button == M_BUTTON_RIGHT){
 366         if (mouse.event == M_EVENT_UP) {
 367             mswin_keymenu_popup();
 368         }
 369     }
 370
 371     /* If this is mouse up AND there was a mouse down in a menu item
 372      * then uninvert that menu item */
 373     if(mouse.event == M_EVENT_UP && oindex != -1){
 374         if(menuitems[oindex].label_hiliter != NULL)
 375           (*menuitems[oindex].label_hiliter)(0, &menuitems[oindex]);
 376         else
 377           invert_label(0, &menuitems[oindex]);
 378     }
 379
 380     return(rv);
 381 }
 382
 383 /*
 384  * invert_label - highlight the label of the given menu item.
 385  */
 386 void
 387 invert_label(int state, MENUITEM *m)
 388 {
 389     int                 r, c;
 390     unsigned            i, j;
 391     char                *lp;
 392     int                 old_state;
 393     int                 wasShown;
 394     int                 col_offset;
 395     COLOR_PAIR          *lastc = NULL;
 396     if(m->val == mnoop)
 397       return;
 398
 399
 400     mswin_getpos (&r, &c);                      /* get cursor position */
 401     wasShown = mswin_showcaret (0);
 402     old_state = mswin_getrevstate ();
 403     /*
 404      * Leave the command name bold
 405      */
 406     col_offset = (state || !(lp=strchr(m->label, ' '))) ? 0 : (lp - m->label);
 407     (*term.t_move)(m->tl.r, m->tl.c + col_offset);
 408     if(state && m->kncp)
 409       lastc = pico_set_colorp(m->kncp, PSC_REV|PSC_RET);
 410     else if(!state && m->klcp)
 411       lastc = pico_set_colorp(m->klcp, PSC_NORM|PSC_RET);
 412     else
 413       (*term.t_rev)(state);
 414
 415     for(i = m->tl.r; i <= m->br.r; i++) {
 416       for(j = m->tl.c + col_offset; j <= m->br.c; j++) {
 417         if(i == m->lbl.r && j == m->lbl.c + col_offset){ /* show label?? */
 418               lp = m->label + col_offset;
 419               while(*lp && j++ < m->br.c)
 420                 (*term.t_putchar)(*lp++);
 421
 422               continue;
 423             }
 424             else
 425               (*term.t_putchar)(' ');
 426       }
 427     }
 428
 429     if(lastc){
 430         (void)pico_set_colorp(lastc, PSC_NONE);
 431         free_color_pair(&lastc);
 432     }
 433     else
 434         (*term.t_rev)(old_state);
 435     mswin_move (r, c);
 436     mswin_showcaret (wasShown);
 437 }
 438
 439
 440 #endif /* _WINDOWS */
 441
 442 #endif /* MOUSE */