Back to index

tetex-bin  3.0
Defines | Functions | Variables
lib_mouse.c File Reference
#include <curses.priv.h>
#include <term.h>
#include <tic.h>

Go to the source code of this file.

Defines

#define MY_TRACE   TRACE_ICALLS|TRACE_IEVENT
#define MASK_RELEASE(x)   ((001 << (6 * ((x) - 1))))
#define MASK_PRESS(x)   ((002 << (6 * ((x) - 1))))
#define MASK_CLICK(x)   ((004 << (6 * ((x) - 1))))
#define MASK_DOUBLE_CLICK(x)   ((010 << (6 * ((x) - 1))))
#define MASK_TRIPLE_CLICK(x)   ((020 << (6 * ((x) - 1))))
#define MASK_RESERVED_EVENT(x)   ((040 << (6 * ((x) - 1))))
#define BUTTON_CLICKED   (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED)
#define BUTTON_PRESSED   (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED)
#define BUTTON_RELEASED   (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED)
#define INVALID_EVENT   -1
#define NORMAL_EVENT   0
#define NEXT(ep)   ((ep == events + EV_MAX - 1) ? events : ep + 1)
#define PREV(ep)   ((ep == events) ? events + EV_MAX - 1 : ep - 1)
#define PRESS_POSITION(n)

Functions

static bool _nc_mouse_parse (int)
static void _nc_mouse_resume (SCREEN *)
static void _nc_mouse_wrap (SCREEN *)
static void init_xterm_mouse (void)
static void enable_xterm_mouse (int enable)
static void initialize_mousetype (void)
static void _nc_mouse_init (void)
static bool _nc_mouse_event (SCREEN *sp GCC_UNUSED)
static bool _nc_mouse_inline (SCREEN *sp)
static void mouse_activate (bool on)
static void _nc_mouse_wrap (SCREEN *sp GCC_UNUSED)
static void _nc_mouse_resume (SCREEN *sp GCC_UNUSED)
 getmouse (MEVENT *aevent)
 ungetmouse (MEVENT *aevent)
 mousemask (mmask_t newmask, mmask_t *oldmask)
 wenclose (const WINDOW *win, int y, int x)
 mouseinterval (int maxclick)
 _nc_has_mouse (void)
 wmouse_trafo (const WINDOW *win, int *pY, int *pX, bool to_screen)

Variables

static mmask_t eventmask
static MEVENT events [EV_MAX]
static MEVENT * eventp = events
static int initialized

Define Documentation

#define BUTTON_CLICKED   (BUTTON1_CLICKED | BUTTON2_CLICKED | BUTTON3_CLICKED)

Definition at line 124 of file lib_mouse.c.

#define BUTTON_PRESSED   (BUTTON1_PRESSED | BUTTON2_PRESSED | BUTTON3_PRESSED)

Definition at line 125 of file lib_mouse.c.

#define BUTTON_RELEASED   (BUTTON1_RELEASED | BUTTON2_RELEASED | BUTTON3_RELEASED)

Definition at line 126 of file lib_mouse.c.

#define INVALID_EVENT   -1

Definition at line 128 of file lib_mouse.c.

#define MASK_CLICK (   x)    ((004 << (6 * ((x) - 1))))

Definition at line 119 of file lib_mouse.c.

#define MASK_DOUBLE_CLICK (   x)    ((010 << (6 * ((x) - 1))))

Definition at line 120 of file lib_mouse.c.

#define MASK_PRESS (   x)    ((002 << (6 * ((x) - 1))))

Definition at line 118 of file lib_mouse.c.

#define MASK_RELEASE (   x)    ((001 << (6 * ((x) - 1))))

Definition at line 117 of file lib_mouse.c.

#define MASK_RESERVED_EVENT (   x)    ((040 << (6 * ((x) - 1))))

Definition at line 122 of file lib_mouse.c.

#define MASK_TRIPLE_CLICK (   x)    ((020 << (6 * ((x) - 1))))

Definition at line 121 of file lib_mouse.c.

#define MY_TRACE   TRACE_ICALLS|TRACE_IEVENT

Definition at line 115 of file lib_mouse.c.

#define NEXT (   ep)    ((ep == events + EV_MAX - 1) ? events : ep + 1)

Definition at line 156 of file lib_mouse.c.

#define NORMAL_EVENT   0

Definition at line 129 of file lib_mouse.c.

#define PRESS_POSITION (   n)
Value:
eventp->bstate = (prev & MASK_PRESS(n) \
                     ? REPORT_MOUSE_POSITION \
                     : MASK_PRESS(n))
#define PREV (   ep)    ((ep == events) ? events + EV_MAX - 1 : ep - 1)

Definition at line 159 of file lib_mouse.c.


Function Documentation

Definition at line 1262 of file lib_mouse.c.

{
    return (SP->_mouse_type == M_NONE ? 0 : 1);
}
static bool _nc_mouse_event ( SCREEN *sp  GCC_UNUSED) [static]

Definition at line 540 of file lib_mouse.c.

{
    bool result = FALSE;

    switch (SP->_mouse_type) {
    case M_XTERM:
       /* xterm: never have to query, mouse events are in the keyboard stream */
#if USE_EMX_MOUSE
       {
           char kbuf[3];

           int i, res = read(M_FD(sp), &kbuf, 3);       /* Eat the prefix */
           if (res != 3)
              printf("Got %d chars instead of 3 for prefix.\n", res);
           for (i = 0; i < res; i++) {
              if (kbuf[i] != key_mouse[i])
                  printf("Got char %d instead of %d for prefix.\n",
                        (int) kbuf[i], (int) key_mouse[i]);
           }
           result = TRUE;
       }
#endif /* USE_EMX_MOUSE */
       break;

#if USE_GPM_SUPPORT
    case M_GPM:
       {
           /* query server for event, return TRUE if we find one */
           Gpm_Event ev;

           if (my_Gpm_GetEvent(&ev) == 1) {
              /* there's only one mouse... */
              eventp->id = NORMAL_EVENT;

              eventp->bstate = 0;
              switch (ev.type & 0x0f) {
              case (GPM_DOWN):
                  if (ev.buttons & GPM_B_LEFT)
                     eventp->bstate |= BUTTON1_PRESSED;
                  if (ev.buttons & GPM_B_MIDDLE)
                     eventp->bstate |= BUTTON2_PRESSED;
                  if (ev.buttons & GPM_B_RIGHT)
                     eventp->bstate |= BUTTON3_PRESSED;
                  break;
              case (GPM_UP):
                  if (ev.buttons & GPM_B_LEFT)
                     eventp->bstate |= BUTTON1_RELEASED;
                  if (ev.buttons & GPM_B_MIDDLE)
                     eventp->bstate |= BUTTON2_RELEASED;
                  if (ev.buttons & GPM_B_RIGHT)
                     eventp->bstate |= BUTTON3_RELEASED;
                  break;
              default:
                  break;
              }

              eventp->x = ev.x - 1;
              eventp->y = ev.y - 1;
              eventp->z = 0;

              /* bump the next-free pointer into the circular list */
              eventp = NEXT(eventp);
              result = TRUE;
           }
       }
       break;
#endif

#if USE_SYSMOUSE
    case M_SYSMOUSE:
       if (SP->_sysmouse_head < SP->_sysmouse_tail) {
           *eventp = SP->_sysmouse_fifo[SP->_sysmouse_head];

           /*
            * Point the fifo-head to the next possible location.  If there
            * are none, reset the indices.  This may be interrupted by the
            * signal handler, doing essentially the same reset.
            */
           SP->_sysmouse_head += 1;
           if (SP->_sysmouse_head == SP->_sysmouse_tail) {
              SP->_sysmouse_tail = 0;
              SP->_sysmouse_head = 0;
           }

           /* bump the next-free pointer into the circular list */
           eventp = NEXT(eventp);
           result = TRUE;
       }
       break;
#endif /* USE_SYSMOUSE */

    case M_NONE:
       break;
    }

    return result;          /* true if we found an event */
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void _nc_mouse_init ( void  ) [static]

Definition at line 516 of file lib_mouse.c.

{
    int i;

    if (!initialized) {
       initialized = TRUE;

       TR(MY_TRACE, ("_nc_mouse_init() called"));

       for (i = 0; i < EV_MAX; i++)
           events[i].id = INVALID_EVENT;

       initialize_mousetype();

       T(("_nc_mouse_init() set mousetype to %d", SP->_mouse_type));
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

static bool _nc_mouse_inline ( SCREEN *  sp) [static]

Definition at line 639 of file lib_mouse.c.

{
    bool result = FALSE;

    TR(MY_TRACE, ("_nc_mouse_inline() called"));

    if (SP->_mouse_type == M_XTERM) {
       unsigned char kbuf[4];
       mmask_t prev;
       size_t grabbed;
       int res;

       /* 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.  It always does under Linux but often
        * fails to under Solaris.
        */
       for (grabbed = 0; grabbed < 3; grabbed += res) {

           /* For VIO mouse we add extra bit 64 to disambiguate button-up. */
#if USE_EMX_MOUSE
           res = read(M_FD(sp) >= 0 ? M_FD(sp) : sp->_ifd, &kbuf, 3);
#else
           res = read(sp->_ifd, kbuf + grabbed, 3 - grabbed);
#endif
           if (res == -1)
              break;
       }
       kbuf[3] = '\0';

       TR(TRACE_IEVENT,
          ("_nc_mouse_inline sees the following xterm data: '%s'", kbuf));

       /* there's only one mouse... */
       eventp->id = NORMAL_EVENT;

       /* processing code goes here */
       eventp->bstate = 0;
       prev = PREV(eventp)->bstate;

#if USE_EMX_MOUSE
#define PRESS_POSITION(n) \
       eventp->bstate = MASK_PRESS(n); \
       if (kbuf[0] & 0x40) \
           eventp->bstate = MASK_RELEASE(n)
#else
#define PRESS_POSITION(n) \
       eventp->bstate = (prev & MASK_PRESS(n) \
                     ? REPORT_MOUSE_POSITION \
                     : MASK_PRESS(n))
#endif

       switch (kbuf[0] & 0x3) {
       case 0x0:
           PRESS_POSITION(1);
           break;

       case 0x1:
           PRESS_POSITION(2);
           break;

       case 0x2:
           PRESS_POSITION(3);
           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 (prev & (BUTTON_PRESSED | BUTTON_RELEASED)) {
              eventp->bstate = BUTTON_RELEASED;
              if (!(prev & BUTTON1_PRESSED))
                  eventp->bstate &= ~BUTTON1_RELEASED;
              if (!(prev & BUTTON2_PRESSED))
                  eventp->bstate &= ~BUTTON2_RELEASED;
              if (!(prev & BUTTON3_PRESSED))
                  eventp->bstate &= ~BUTTON3_RELEASED;
           } else {
              /*
               * 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.
               */
              eventp->bstate = REPORT_MOUSE_POSITION;
           }
           break;
       }
       result = (eventp->bstate & REPORT_MOUSE_POSITION) ? TRUE : FALSE;

       if (kbuf[0] & 4) {
           eventp->bstate |= BUTTON_SHIFT;
       }
       if (kbuf[0] & 8) {
           eventp->bstate |= BUTTON_ALT;
       }
       if (kbuf[0] & 16) {
           eventp->bstate |= BUTTON_CTRL;
       }

       eventp->x = (kbuf[1] - ' ') - 1;
       eventp->y = (kbuf[2] - ' ') - 1;
       TR(MY_TRACE,
          ("_nc_mouse_inline: primitive mouse-event %s has slot %ld",
           _tracemouse(eventp),
           (long) (eventp - events)));

       /* bump the next-free pointer into the circular list */
       eventp = NEXT(eventp);
#if 0                       /* this return would be needed for QNX's mods to lib_getch.c */
       return (TRUE);
#endif
    }

    return (result);
}

Here is the caller graph for this function:

static bool _nc_mouse_parse ( int  runcount) [static]

Definition at line 863 of file lib_mouse.c.

{
    MEVENT *ep, *runp, *next, *prev = PREV(eventp);
    int n;
    bool merge;

    TR(MY_TRACE, ("_nc_mouse_parse(%d) called", runcount));

    /*
     * When we enter this routine, the event list next-free pointer
     * points just past a run of mouse events that we know were separated
     * in time by less than the critical click interval. The job of this
     * routine is to collapse this run into a single higher-level event
     * or gesture.
     *
     * We accomplish this in two passes.  The first pass merges press/release
     * pairs into click events.  The second merges runs of click events into
     * double or triple-click events.
     *
     * It's possible that the run may not resolve to a single event (for
     * example, if the user quadruple-clicks).  If so, leading events
     * in the run are ignored.
     *
     * Note that this routine is independent of the format of the specific
     * format of the pointing-device's reports.  We can use it to parse
     * gestures on anything that reports press/release events on a per-
     * button basis, as long as the device-dependent mouse code puts stuff
     * on the queue in MEVENT format.
     */
    if (runcount == 1) {
       TR(MY_TRACE,
          ("_nc_mouse_parse: returning simple mouse event %s at slot %ld",
           _tracemouse(prev),
           (long) (prev - events)));
       return (prev->id >= NORMAL_EVENT)
           ? ((prev->bstate & eventmask) ? TRUE : FALSE)
           : FALSE;
    }

    /* find the start of the run */
    runp = eventp;
    for (n = runcount; n > 0; n--) {
       runp = PREV(runp);
    }

#ifdef TRACE
    if (_nc_tracing & TRACE_IEVENT) {
       _trace_slot("before mouse press/release merge:");
       _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
              (long) (runp - events),
              (long) ((eventp - events) + (EV_MAX - 1)) % EV_MAX,
              runcount);
    }
#endif /* TRACE */

    /* first pass; merge press/release pairs */
    do {
       merge = FALSE;
       for (ep = runp; (next = NEXT(ep)) != eventp; ep = next) {
           if (ep->x == next->x && ep->y == next->y
              && (ep->bstate & BUTTON_PRESSED)
              && (!(ep->bstate & BUTTON1_PRESSED)
                  == !(next->bstate & BUTTON1_RELEASED))
              && (!(ep->bstate & BUTTON2_PRESSED)
                  == !(next->bstate & BUTTON2_RELEASED))
              && (!(ep->bstate & BUTTON3_PRESSED)
                  == !(next->bstate & BUTTON3_RELEASED))
              ) {
              if ((eventmask & BUTTON1_CLICKED)
                  && (ep->bstate & BUTTON1_PRESSED)) {
                  ep->bstate &= ~BUTTON1_PRESSED;
                  ep->bstate |= BUTTON1_CLICKED;
                  merge = TRUE;
              }
              if ((eventmask & BUTTON2_CLICKED)
                  && (ep->bstate & BUTTON2_PRESSED)) {
                  ep->bstate &= ~BUTTON2_PRESSED;
                  ep->bstate |= BUTTON2_CLICKED;
                  merge = TRUE;
              }
              if ((eventmask & BUTTON3_CLICKED)
                  && (ep->bstate & BUTTON3_PRESSED)) {
                  ep->bstate &= ~BUTTON3_PRESSED;
                  ep->bstate |= BUTTON3_CLICKED;
                  merge = TRUE;
              }
              if (merge)
                  next->id = INVALID_EVENT;
           }
       }
    } while
       (merge);

#ifdef TRACE
    if (_nc_tracing & TRACE_IEVENT) {
       _trace_slot("before mouse click merge:");
       _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
              (long) (runp - events),
              (long) ((eventp - events) + (EV_MAX - 1)) % EV_MAX,
              runcount);
    }
#endif /* TRACE */

    /*
     * Second pass; merge click runs.  At this point, click events are
     * each followed by one invalid event. We merge click events
     * forward in the queue.
     *
     * NOTE: There is a problem with this design!  If the application
     * allows enough click events to pile up in the circular queue so
     * they wrap around, it will cheerfully merge the newest forward
     * into the oldest, creating a bogus doubleclick and confusing
     * the queue-traversal logic rather badly.  Generally this won't
     * happen, because calling getmouse() marks old events invalid and
     * ineligible for merges.  The true solution to this problem would
     * be to timestamp each MEVENT and perform the obvious sanity check,
     * but the timer element would have to have sub-second resolution,
     * which would get us into portability trouble.
     */
    do {
       MEVENT *follower;

       merge = FALSE;
       for (ep = runp; (next = NEXT(ep)) != eventp; ep = next)
           if (ep->id != INVALID_EVENT) {
              if (next->id != INVALID_EVENT)
                  continue;
              follower = NEXT(next);
              if (follower->id == INVALID_EVENT)
                  continue;

              /* merge click events forward */
              if ((ep->bstate & BUTTON_CLICKED)
                  && (follower->bstate & BUTTON_CLICKED)) {
                  if ((eventmask & BUTTON1_DOUBLE_CLICKED)
                     && (follower->bstate & BUTTON1_CLICKED)) {
                     follower->bstate &= ~BUTTON1_CLICKED;
                     follower->bstate |= BUTTON1_DOUBLE_CLICKED;
                     merge = TRUE;
                  }
                  if ((eventmask & BUTTON2_DOUBLE_CLICKED)
                     && (follower->bstate & BUTTON2_CLICKED)) {
                     follower->bstate &= ~BUTTON2_CLICKED;
                     follower->bstate |= BUTTON2_DOUBLE_CLICKED;
                     merge = TRUE;
                  }
                  if ((eventmask & BUTTON3_DOUBLE_CLICKED)
                     && (follower->bstate & BUTTON3_CLICKED)) {
                     follower->bstate &= ~BUTTON3_CLICKED;
                     follower->bstate |= BUTTON3_DOUBLE_CLICKED;
                     merge = TRUE;
                  }
                  if (merge)
                     ep->id = INVALID_EVENT;
              }

              /* merge double-click events forward */
              if ((ep->bstate &
                   (BUTTON1_DOUBLE_CLICKED
                    | BUTTON2_DOUBLE_CLICKED
                    | BUTTON3_DOUBLE_CLICKED))
                  && (follower->bstate & BUTTON_CLICKED)) {
                  if ((eventmask & BUTTON1_TRIPLE_CLICKED)
                     && (follower->bstate & BUTTON1_CLICKED)) {
                     follower->bstate &= ~BUTTON1_CLICKED;
                     follower->bstate |= BUTTON1_TRIPLE_CLICKED;
                     merge = TRUE;
                  }
                  if ((eventmask & BUTTON2_TRIPLE_CLICKED)
                     && (follower->bstate & BUTTON2_CLICKED)) {
                     follower->bstate &= ~BUTTON2_CLICKED;
                     follower->bstate |= BUTTON2_TRIPLE_CLICKED;
                     merge = TRUE;
                  }
                  if ((eventmask & BUTTON3_TRIPLE_CLICKED)
                     && (follower->bstate & BUTTON3_CLICKED)) {
                     follower->bstate &= ~BUTTON3_CLICKED;
                     follower->bstate |= BUTTON3_TRIPLE_CLICKED;
                     merge = TRUE;
                  }
                  if (merge)
                     ep->id = INVALID_EVENT;
              }
           }
    } while
       (merge);

#ifdef TRACE
    if (_nc_tracing & TRACE_IEVENT) {
       _trace_slot("before mouse event queue compaction:");
       _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
              (long) (runp - events),
              (long) ((eventp - events) + (EV_MAX - 1)) % EV_MAX,
              runcount);
    }
#endif /* TRACE */

    /*
     * Now try to throw away trailing events flagged invalid, or that
     * don't match the current event mask.
     */
    for (; runcount; prev = PREV(eventp), runcount--)
       if (prev->id == INVALID_EVENT || !(prev->bstate & eventmask)) {
           eventp = prev;
       }
#ifdef TRACE
    if (_nc_tracing & TRACE_IEVENT) {
       _trace_slot("after mouse event queue compaction:");
       _tracef("_nc_mouse_parse: run starts at %ld, ends at %ld, count %d",
              (long) (runp - events),
              (long) ((eventp - events) + (EV_MAX - 1)) % EV_MAX,
              runcount);
    }
    for (ep = runp; ep != eventp; ep = NEXT(ep))
       if (ep->id != INVALID_EVENT)
           TR(MY_TRACE,
              ("_nc_mouse_parse: returning composite mouse event %s at slot %ld",
              _tracemouse(ep),
              (long) (ep - events)));
#endif /* TRACE */

    /* after all this, do we have a valid event? */
    return (PREV(eventp)->id != INVALID_EVENT);
}

Here is the caller graph for this function:

static void _nc_mouse_resume ( SCREEN *  ) [static]

Here is the caller graph for this function:

static void _nc_mouse_resume ( SCREEN *sp  GCC_UNUSED) [static]

Definition at line 1116 of file lib_mouse.c.

{
    TR(MY_TRACE, ("_nc_mouse_resume() called"));

    switch (SP->_mouse_type) {
    case M_XTERM:
       /* xterm: re-enable reporting */
       if (eventmask)
           mouse_activate(TRUE);
       break;

#if USE_GPM_SUPPORT
    case M_GPM:
       /* GPM: reclaim our event set */
       break;
#endif

#if USE_SYSMOUSE
    case M_SYSMOUSE:
       mouse_activate(TRUE);
       break;
#endif
    case M_NONE:
       break;
    }
}

Here is the call graph for this function:

static void _nc_mouse_wrap ( SCREEN *  ) [static]

Here is the caller graph for this function:

static void _nc_mouse_wrap ( SCREEN *sp  GCC_UNUSED) [static]

Definition at line 1090 of file lib_mouse.c.

{
    TR(MY_TRACE, ("_nc_mouse_wrap() called"));

    switch (SP->_mouse_type) {
    case M_XTERM:
       if (eventmask)
           mouse_activate(FALSE);
       break;
#if USE_GPM_SUPPORT
       /* GPM: pass all mouse events to next client */
    case M_GPM:
       break;
#endif
#if USE_SYSMOUSE
    case M_SYSMOUSE:
       mouse_activate(FALSE);
       break;
#endif
    case M_NONE:
       break;
    }
}

Here is the call graph for this function:

static void enable_xterm_mouse ( int  enable) [static]

Definition at line 344 of file lib_mouse.c.

{
    putp(tparm(SP->_mouse_xtermcap, enable));
}

Here is the call graph for this function:

Here is the caller graph for this function:

getmouse ( MEVENT *  aevent)

Definition at line 1151 of file lib_mouse.c.

{
    T((T_CALLED("getmouse(%p)"), aevent));

    if (aevent && (SP->_mouse_type != M_NONE)) {
       /* compute the current-event pointer */
       MEVENT *prev = PREV(eventp);

       /* copy the event we find there */
       *aevent = *prev;

       TR(TRACE_IEVENT, ("getmouse: returning event %s from slot %ld",
                       _tracemouse(prev),
                       (long) (prev - events)));

       prev->id = INVALID_EVENT;   /* so the queue slot becomes free */
       returnCode(OK);
    }
    returnCode(ERR);
}
static void init_xterm_mouse ( void  ) [static]

Definition at line 334 of file lib_mouse.c.

{
    SP->_mouse_type = M_XTERM;
    SP->_mouse_xtermcap = tigetstr("XM");
    if (!VALID_STRING(SP->_mouse_xtermcap))
       SP->_mouse_xtermcap = "\033[?1000%?%p1%{1}%=%th%el%;";
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void initialize_mousetype ( void  ) [static]

Definition at line 351 of file lib_mouse.c.

{
    static const char *xterm_kmous = "\033[M";

    /* Try gpm first, because gpm may be configured to run in xterm */
#if USE_GPM_SUPPORT
    /* GPM does printf's without checking if stdout is a terminal */
    if (isatty(fileno(stdout))) {
       static bool first = TRUE;
       static bool found = FALSE;

       if (first) {
           void *obj;
           first = FALSE;

           if ((obj = dlopen("libgpm.so", my_RTLD)) != 0) {
              if ((my_gpm_fd = dlsym(obj, "gpm_fd")) == 0 ||
                  (my_Gpm_Open = dlsym(obj, "Gpm_Open")) == 0 ||
                  (my_Gpm_GetEvent = dlsym(obj, "Gpm_GetEvent")) == 0) {
                  T(("GPM initialization failed: %s", dlerror()));
                  dlclose(obj);
              } else {
                  found = TRUE;
              }
           }
       }

       if (found) {
           /* GPM: initialize connection to gpm server */
           gpm_connect.eventMask = GPM_DOWN | GPM_UP;
           gpm_connect.defaultMask = ~(gpm_connect.eventMask | GPM_HARD);
           gpm_connect.minMod = 0;
           gpm_connect.maxMod = ~((1 << KG_SHIFT) |
                               (1 << KG_SHIFTL) |
                               (1 << KG_SHIFTR));
           if (my_Gpm_Open(&gpm_connect, 0) >= 0) {     /* returns the file-descriptor */
              SP->_mouse_type = M_GPM;
              SP->_mouse_fd = *my_gpm_fd;
              return;
           }
       }
    }
#endif

    /* OS/2 VIO */
#if USE_EMX_MOUSE
    if (!mouse_thread
       && strstr(cur_term->type.term_names, "xterm") == 0
       && key_mouse) {
       int handles[2];

       if (pipe(handles) < 0) {
           perror("mouse pipe error");
           return;
       } else {
           int rc;

           if (!mouse_buttons[0]) {
              char *s = getenv("MOUSE_BUTTONS_123");

              mouse_buttons[0] = 1;
              if (s && strlen(s) >= 3) {
                  mouse_buttons[1] = s[0] - '0';
                  mouse_buttons[2] = s[1] - '0';
                  mouse_buttons[3] = s[2] - '0';
              }
           }
           mouse_wfd = handles[1];
           M_FD(SP) = handles[0];
           /* Needed? */
           setmode(handles[0], O_BINARY);
           setmode(handles[1], O_BINARY);
           /* Do not use CRT functions, we may single-threaded. */
           rc = DosCreateThread((unsigned long *) &mouse_thread,
                             mouse_server, 0, 0, 8192);
           if (rc) {
              printf("mouse thread error %d=%#x", rc, rc);
              return;
           } else {
              SP->_mouse_type = M_XTERM;
              return;
           }
       }
    }
#endif

#if USE_SYSMOUSE
    {
       struct mouse_info the_mouse;
       char *the_device = 0;

       if (isatty(SP->_ifd))
           the_device = ttyname(SP->_ifd);
       if (the_device == 0)
           the_device = "/dev/tty";

       SP->_mouse_fd = open(the_device, O_RDWR);

       if (SP->_mouse_fd >= 0) {
           /*
            * sysmouse does not have a usable user interface for obtaining
            * mouse events.  The logical way to proceed (reading data on a
            * stream) only works if one opens the device as root.  Even in
            * that mode, careful examination shows we lose events
            * occasionally.  The interface provided for user programs is to
            * establish a signal handler.  really.
            *
            * Take over SIGUSR2 for this purpose since SIGUSR1 is more
            * likely to be used by an application.  getch() will have to
            * handle the misleading EINTR's.
            */
           signal(SIGUSR2, SIG_IGN);
           the_mouse.operation = MOUSE_MODE;
           the_mouse.u.mode.mode = 0;
           the_mouse.u.mode.signal = SIGUSR2;
           if (ioctl(SP->_mouse_fd, CONS_MOUSECTL, &the_mouse) != -1) {
              signal(SIGUSR2, handle_sysmouse);
              the_mouse.operation = MOUSE_SHOW;
              ioctl(SP->_mouse_fd, CONS_MOUSECTL, &the_mouse);

#if defined(FBIO_MODEINFO) || defined(CONS_MODEINFO)    /* FreeBSD > 2.x */
              {
#ifndef FBIO_GETMODE        /* FreeBSD 3.x */
#define FBIO_GETMODE    CONS_GET
#define FBIO_MODEINFO   CONS_MODEINFO
#endif /* FBIO_GETMODE */
                  video_info_t the_video;

                  if (ioctl(SP->_mouse_fd,
                           FBIO_GETMODE,
                           &the_video.vi_mode) != -1
                     && ioctl(SP->_mouse_fd,
                             FBIO_MODEINFO,
                             &the_video) != -1) {
                     SP->_sysmouse_char_width = the_video.vi_cwidth;
                     SP->_sysmouse_char_height = the_video.vi_cheight;
                  }
              }
#endif /* defined(FBIO_MODEINFO) || defined(CONS_MODEINFO) */

              if (SP->_sysmouse_char_width <= 0)
                  SP->_sysmouse_char_width = 8;
              if (SP->_sysmouse_char_height <= 0)
                  SP->_sysmouse_char_height = 16;
              SP->_mouse_type = M_SYSMOUSE;
              return;
           }
       }
    }
#endif /* USE_SYSMOUSE */

    /* we know how to recognize mouse events under "xterm" */
    if (key_mouse != 0) {
       if (!strcmp(key_mouse, xterm_kmous)) {
           init_xterm_mouse();
           return;
       }
    } else if (strstr(cur_term->type.term_names, "xterm") != 0) {
       (void) _nc_add_to_try(&(SP->_keytry), xterm_kmous, KEY_MOUSE);
       init_xterm_mouse();
       return;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void mouse_activate ( bool  on) [static]

Definition at line 786 of file lib_mouse.c.

{
    if (!on && !initialized)
       return;

    _nc_mouse_init();

    if (on) {

       switch (SP->_mouse_type) {
       case M_XTERM:
#if NCURSES_EXT_FUNCS
           keyok(KEY_MOUSE, on);
#endif
           TPUTS_TRACE("xterm mouse initialization");
#if USE_EMX_MOUSE
           server_state(1);
#else
           enable_xterm_mouse(1);
#endif
           break;
#if USE_GPM_SUPPORT
       case M_GPM:
           SP->_mouse_fd = *my_gpm_fd;
           break;
#endif
#if USE_SYSMOUSE
       case M_SYSMOUSE:
           signal(SIGUSR2, handle_sysmouse);
           break;
#endif
       case M_NONE:
           return;
       }
       /* Make runtime binding to cut down on object size of applications that
        * do not use the mouse (e.g., 'clear').
        */
       SP->_mouse_event = _nc_mouse_event;
       SP->_mouse_inline = _nc_mouse_inline;
       SP->_mouse_parse = _nc_mouse_parse;
       SP->_mouse_resume = _nc_mouse_resume;
       SP->_mouse_wrap = _nc_mouse_wrap;

    } else {

       switch (SP->_mouse_type) {
       case M_XTERM:
           TPUTS_TRACE("xterm mouse deinitialization");
#if USE_EMX_MOUSE
           server_state(0);
#else
           enable_xterm_mouse(0);
#endif
           break;
#if USE_GPM_SUPPORT
       case M_GPM:
           break;
#endif
#if USE_SYSMOUSE
       case M_SYSMOUSE:
           signal(SIGUSR2, SIG_IGN);
           break;
#endif
       case M_NONE:
           return;
       }
    }
    _nc_flush();
}

Here is the call graph for this function:

Here is the caller graph for this function:

mouseinterval ( int  maxclick)

Definition at line 1241 of file lib_mouse.c.

{
    int oldval;

    T((T_CALLED("mouseinterval(%d)"), maxclick));

    if (SP != 0) {
       oldval = SP->_maxclick;
       if (maxclick >= 0)
           SP->_maxclick = maxclick;
    } else {
       oldval = DEFAULT_MAXCLICK;
    }

    returnCode(oldval);
}
mousemask ( mmask_t  newmask,
mmask_t *  oldmask 
)

Definition at line 1190 of file lib_mouse.c.

{
    mmask_t result = 0;

    T((T_CALLED("mousemask(%#lx,%p)"), newmask, oldmask));

    if (oldmask)
       *oldmask = eventmask;

    if (!newmask && !initialized)
       returnBits(0);

    _nc_mouse_init();
    if (SP->_mouse_type != M_NONE) {
       eventmask = newmask &
           (REPORT_MOUSE_POSITION | BUTTON_ALT | BUTTON_CTRL | BUTTON_SHIFT
            | BUTTON_PRESSED
            | BUTTON_RELEASED
            | BUTTON_CLICKED
            | BUTTON1_DOUBLE_CLICKED | BUTTON1_TRIPLE_CLICKED
            | BUTTON2_DOUBLE_CLICKED | BUTTON2_TRIPLE_CLICKED
            | BUTTON3_DOUBLE_CLICKED | BUTTON3_TRIPLE_CLICKED);

       mouse_activate(eventmask != 0);

       result = eventmask;
    }

    returnBits(result);
}

Here is the call graph for this function:

ungetmouse ( MEVENT *  aevent)

Definition at line 1174 of file lib_mouse.c.

{
    T((T_CALLED("ungetmouse(%p)"), aevent));

    /* stick the given event in the next-free slot */
    *eventp = *aevent;

    /* bump the next-free pointer into the circular list */
    eventp = NEXT(eventp);

    /* push back the notification event on the keyboard queue */
    returnCode(ungetch(KEY_MOUSE));
}

Here is the call graph for this function:

wenclose ( const WINDOW win,
int  y,
int  x 
)

Definition at line 1223 of file lib_mouse.c.

{
    bool result = FALSE;

    T((T_CALLED("wenclose(%p,%d,%d)"), win, y, x));

    if (win != 0) {
       y -= win->_yoffset;
       result = ((win->_begy <= y &&
                 win->_begx <= x &&
                 (win->_begx + win->_maxx) >= x &&
                 (win->_begy + win->_maxy) >= y) ? TRUE : FALSE);
    }
    returnBool(result);
}

Here is the caller graph for this function:

wmouse_trafo ( const WINDOW win,
int pY,
int pX,
bool  to_screen 
)

Definition at line 1268 of file lib_mouse.c.

{
    bool result = FALSE;

    T((T_CALLED("wmouse_trafo(%p,%p,%p,%d)"), win, pY, pX, to_screen));

    if (win && pY && pX) {
       int y = *pY;
       int x = *pX;

       if (to_screen) {
           y += win->_begy + win->_yoffset;
           x += win->_begx;
           if (wenclose(win, y, x))
              result = TRUE;
       } else {
           if (wenclose(win, y, x)) {
              y -= (win->_begy + win->_yoffset);
              x -= win->_begx;
              result = TRUE;
           }
       }
       if (result) {
           *pX = x;
           *pY = y;
       }
    }
    returnBool(result);
}

Here is the call graph for this function:


Variable Documentation

mmask_t eventmask [static]

Definition at line 140 of file lib_mouse.c.

MEVENT* eventp = events [static]

Definition at line 153 of file lib_mouse.c.

MEVENT events[EV_MAX] [static]

Definition at line 152 of file lib_mouse.c.

int initialized [static]

Definition at line 331 of file lib_mouse.c.