]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - ncurses/tty/lib_twait.c
ncurses 5.6 - patch 20071201
[ncurses.git] / ncurses / tty / lib_twait.c
index 6d24d8ddc6cb3e83b34f2e4f439b262f012b0519..1e4546dec0c00517d6bef2e20fe8ce73386162c1 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998,1999,2000 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2006,2007 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            *
@@ -29,6 +29,7 @@
 /****************************************************************************
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *     and: Thomas E. Dickey                        1996-on                 *
  ****************************************************************************/
 
 /*
 **     comments, none of the original code remains - T.Dickey).
 */
 
+#include <curses.priv.h>
+
 #ifdef __BEOS__
+#undef false
+#undef true
 #include <OS.h>
 #endif
 
-#include <curses.priv.h>
-
 #if USE_FUNC_POLL
 # if HAVE_SYS_TIME_H
 #  include <sys/time.h>
 # endif
 #endif
 
-MODULE_ID("$Id: lib_twait.c,v 1.39 2000/08/26 19:34:15 tom Exp $")
+MODULE_ID("$Id: lib_twait.c,v 1.54 2007/08/11 16:32:48 tom Exp $")
+
+#if HAVE_GETTIMEOFDAY
+# define PRECISE_GETTIME 1
+# define TimeType struct timeval
+#else
+# define PRECISE_GETTIME 0
+# define TimeType time_t
+#endif
 
 static long
-_nc_gettime(bool first)
+_nc_gettime(TimeType * t0, bool first)
 {
     long res;
 
-#if HAVE_GETTIMEOFDAY
-# define PRECISE_GETTIME 1
-    static struct timeval t0;
-    struct timeval t1;
+#if PRECISE_GETTIME
+    TimeType t1;
     gettimeofday(&t1, (struct timezone *) 0);
     if (first) {
-       t0 = t1;
+       *t0 = t1;
+       res = 0;
+    } else {
+       /* .tv_sec and .tv_usec are unsigned, be careful when subtracting */
+       if (t0->tv_usec > t1.tv_usec) {
+           t1.tv_usec += 1000000;      /* Convert 1s in 1e6 microsecs */
+           t1.tv_sec--;
+       }
+       res = (t1.tv_sec - t0->tv_sec) * 1000
+           + (t1.tv_usec - t0->tv_usec) / 1000;
     }
-    res = (t1.tv_sec - t0.tv_sec) * 1000
-       + (t1.tv_usec - t0.tv_usec) / 1000;
 #else
-# define PRECISE_GETTIME 0
-    static time_t t0;
     time_t t1 = time((time_t *) 0);
     if (first) {
-       t0 = t1;
+       *t0 = t1;
     }
-    res = (t1 - t0) * 1000;
+    res = (t1 - *t0) * 1000;
 #endif
-    T(("%s time: %ld msec", first ? "get" : "elapsed", res));
+    TR(TRACE_IEVENT, ("%s time: %ld msec", first ? "get" : "elapsed", res));
     return res;
 }
 
+#ifdef NCURSES_WGETCH_EVENTS
+NCURSES_EXPORT(int)
+_nc_eventlist_timeout(_nc_eventlist * evl)
+{
+    int event_delay = -1;
+    int n;
+
+    if (evl != 0) {
+
+       for (n = 0; n < evl->count; ++n) {
+           _nc_event *ev = evl->events[n];
+
+           if (ev->type == _NC_EVENT_TIMEOUT_MSEC) {
+               event_delay = ev->data.timeout_msec;
+               if (event_delay < 0)
+                   event_delay = INT_MAX;      /* FIXME Is this defined? */
+           }
+       }
+    }
+    return event_delay;
+}
+#endif /* NCURSES_WGETCH_EVENTS */
+
 /*
  * Wait a specified number of milliseconds, returning nonzero if the timer
  * didn't expire before there is activity on the specified file descriptors.
@@ -97,39 +134,78 @@ _nc_gettime(bool first)
  *     1 - ncurses' normal input-descriptor
  *     2 - mouse descriptor, if any
  *     3 - either input or mouse.
+ *
+ * Experimental:  if NCURSES_WGETCH_EVENTS is defined, (mode & 4) determines
+ * whether to pay attention to evl argument.  If set, the smallest of
+ * millisecond and of timeout of evl is taken.
+ *
  * We return a mask that corresponds to the mode (e.g., 2 for mouse activity).
  *
  * If the milliseconds given are -1, the wait blocks until activity on the
  * descriptors.
  */
-int
-_nc_timed_wait(int mode, int milliseconds, int *timeleft)
+NCURSES_EXPORT(int)
+_nc_timed_wait(int mode,
+              int milliseconds,
+              int *timeleft
+              EVENTLIST_2nd(_nc_eventlist * evl))
 {
     int fd;
     int count;
+    int result = 0;
+    TimeType t0;
 
-    int result;
+#ifdef NCURSES_WGETCH_EVENTS
+    int timeout_is_event = 0;
+    int n;
+#endif
 
 #if USE_FUNC_POLL
-    struct pollfd fds[2];
+#define MIN_FDS 2
+    struct pollfd fd_list[MIN_FDS];
+    struct pollfd *fds = fd_list;
 #elif defined(__BEOS__)
 #elif HAVE_SELECT
-    static fd_set set;
+    fd_set set;
 #endif
 
     long starttime, returntime;
 
-    T(("start twait: %d milliseconds, mode: %d", milliseconds, mode));
+    TR(TRACE_IEVENT, ("start twait: %d milliseconds, mode: %d",
+                     milliseconds, mode));
 
-#if PRECISE_GETTIME
+#ifdef NCURSES_WGETCH_EVENTS
+    if (mode & 4) {
+       int event_delay = _nc_eventlist_timeout(evl);
+
+       if (event_delay >= 0
+           && (milliseconds >= event_delay || milliseconds < 0)) {
+           milliseconds = event_delay;
+           timeout_is_event = 1;
+       }
+    }
+#endif
+
+#if PRECISE_GETTIME && HAVE_NANOSLEEP
   retry:
 #endif
-    starttime = _nc_gettime(TRUE);
+    starttime = _nc_gettime(&t0, TRUE);
 
     count = 0;
 
+#ifdef NCURSES_WGETCH_EVENTS
+    if ((mode & 4) && evl)
+       evl->result_flags = 0;
+#endif
+
 #if USE_FUNC_POLL
-    memset(fds, 0, sizeof(fds));
+    memset(fd_list, 0, sizeof(fd_list));
+
+#ifdef NCURSES_WGETCH_EVENTS
+    if ((mode & 4) && evl)
+       fds = typeMalloc(struct pollfd, MIN_FDS + evl->count);
+#endif
+
     if (mode & 1) {
        fds[count].fd = SP->_ifd;
        fds[count].events = POLLIN;
@@ -141,7 +217,53 @@ _nc_timed_wait(int mode, int milliseconds, int *timeleft)
        fds[count].events = POLLIN;
        count++;
     }
-    result = poll(fds, count, milliseconds);
+#ifdef NCURSES_WGETCH_EVENTS
+    if ((mode & 4) && evl) {
+       for (n = 0; n < evl->count; ++n) {
+           _nc_event *ev = evl->events[n];
+
+           if (ev->type == _NC_EVENT_FILE
+               && (ev->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
+               fds[count].fd = ev->data.fev.fd;
+               fds[count].events = POLLIN;
+               count++;
+           }
+       }
+    }
+#endif
+
+    result = poll(fds, (unsigned) count, milliseconds);
+
+#ifdef NCURSES_WGETCH_EVENTS
+    if ((mode & 4) && evl) {
+       int c;
+
+       if (!result)
+           count = 0;
+
+       for (n = 0; n < evl->count; ++n) {
+           _nc_event *ev = evl->events[n];
+
+           if (ev->type == _NC_EVENT_FILE
+               && (ev->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
+               ev->data.fev.result = 0;
+               for (c = 0; c < count; c++)
+                   if (fds[c].fd == ev->data.fev.fd
+                       && fds[c].revents & POLLIN) {
+                       ev->data.fev.result |= _NC_EVENT_FILE_READABLE;
+                       evl->result_flags |= _NC_EVENT_FILE_READABLE;
+                   }
+           } else if (ev->type == _NC_EVENT_TIMEOUT_MSEC
+                      && !result && timeout_is_event) {
+               evl->result_flags |= _NC_EVENT_TIMEOUT_MSEC;
+           }
+       }
+    }
+
+    if (fds != fd_list)
+       free((char *) fds);
+
+#endif
 
 #elif defined(__BEOS__)
     /*
@@ -152,26 +274,34 @@ _nc_timed_wait(int mode, int milliseconds, int *timeleft)
      *
      * FIXME: the return values from the ioctl aren't very clear if we get
      * interrupted.
+     *
+     * FIXME: this assumes mode&1 if milliseconds < 0 (see lib_getch.c).
      */
     result = 0;
     if (mode & 1) {
+       int step = (milliseconds < 0) ? 0 : 5000;
        bigtime_t d;
        bigtime_t useconds = milliseconds * 1000;
        int n, howmany;
 
-       if (useconds == 0)      /* we're here to go _through_ the loop */
+       if (useconds <= 0)      /* we're here to go _through_ the loop */
            useconds = 1;
 
-       for (d = 0; d < useconds; d += 5000) {
+       for (d = 0; d < useconds; d += step) {
            n = 0;
            howmany = ioctl(0, 'ichr', &n);
            if (howmany >= 0 && n > 0) {
                result = 1;
                break;
            }
-           if (useconds > 1)
-               snooze(5000);
-           milliseconds -= 5;
+           if (useconds > 1 && step > 0) {
+               snooze(step);
+               milliseconds -= (step / 1000);
+               if (milliseconds <= 0) {
+                   milliseconds = 0;
+                   break;
+               }
+           }
        }
     } else if (milliseconds > 0) {
        snooze(milliseconds * 1000);
@@ -193,6 +323,19 @@ _nc_timed_wait(int mode, int milliseconds, int *timeleft)
        FD_SET(fd, &set);
        count = max(fd, count) + 1;
     }
+#ifdef NCURSES_WGETCH_EVENTS
+    if ((mode & 4) && evl) {
+       for (n = 0; n < evl->count; ++n) {
+           _nc_event *ev = evl->events[n];
+
+           if (ev->type == _NC_EVENT_FILE
+               && (ev->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
+               FD_SET(ev->data.fev.fd, &set);
+               count = max(ev->data.fev.fd + 1, count);
+           }
+       }
+    }
+#endif
 
     if (milliseconds >= 0) {
        struct timeval ntimeout;
@@ -202,14 +345,53 @@ _nc_timed_wait(int mode, int milliseconds, int *timeleft)
     } else {
        result = select(count, &set, NULL, NULL, NULL);
     }
+
+#ifdef NCURSES_WGETCH_EVENTS
+    if ((mode & 4) && evl) {
+       evl->result_flags = 0;
+       for (n = 0; n < evl->count; ++n) {
+           _nc_event *ev = evl->events[n];
+
+           if (ev->type == _NC_EVENT_FILE
+               && (ev->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
+               ev->data.fev.result = 0;
+               if (FD_ISSET(ev->data.fev.fd, &set)) {
+                   ev->data.fev.result |= _NC_EVENT_FILE_READABLE;
+                   evl->result_flags |= _NC_EVENT_FILE_READABLE;
+               }
+           } else if (ev->type == _NC_EVENT_TIMEOUT_MSEC
+                      && !result && timeout_is_event)
+               evl->result_flags |= _NC_EVENT_TIMEOUT_MSEC;
+       }
+    }
 #endif
 
-    returntime = _nc_gettime(FALSE);
+#endif /* USE_FUNC_POLL, etc */
+
+    returntime = _nc_gettime(&t0, FALSE);
 
     if (milliseconds >= 0)
        milliseconds -= (returntime - starttime);
 
-#if PRECISE_GETTIME
+#ifdef NCURSES_WGETCH_EVENTS
+    if (evl) {
+       evl->result_flags = 0;
+       for (n = 0; n < evl->count; ++n) {
+           _nc_event *ev = evl->events[n];
+
+           if (ev->type == _NC_EVENT_TIMEOUT_MSEC) {
+               long diff = (returntime - starttime);
+               if (ev->data.timeout_msec <= diff)
+                   ev->data.timeout_msec = 0;
+               else
+                   ev->data.timeout_msec -= diff;
+           }
+
+       }
+    }
+#endif
+
+#if PRECISE_GETTIME && HAVE_NANOSLEEP
     /*
      * If the timeout hasn't expired, and we've gotten no data,
      * this is probably a system where 'select()' needs to be left
@@ -217,7 +399,7 @@ _nc_timed_wait(int mode, int milliseconds, int *timeleft)
      * then come back for more.
      */
     if (result == 0 && milliseconds > 100) {
-       napms(100);
+       napms(100);             /* FIXME: this won't be right if I recur! */
        milliseconds -= 100;
        goto retry;
     }
@@ -227,8 +409,8 @@ _nc_timed_wait(int mode, int milliseconds, int *timeleft)
     if (timeleft)
        *timeleft = milliseconds;
 
-    T(("end twait: returned %d (%d), remaining time %d msec",
-       result, errno, milliseconds));
+    TR(TRACE_IEVENT, ("end twait: returned %d (%d), remaining time %d msec",
+                     result, errno, milliseconds));
 
     /*
      * Both 'poll()' and 'select()' return the number of file descriptors
@@ -240,7 +422,7 @@ _nc_timed_wait(int mode, int milliseconds, int *timeleft)
        if (result > 0) {
            result = 0;
 #if USE_FUNC_POLL
-           for (count = 0; count < 2; count++) {
+           for (count = 0; count < MIN_FDS; count++) {
                if ((mode & (1 << count))
                    && (fds[count].revents & POLLIN)) {
                    result |= (1 << count);
@@ -260,6 +442,10 @@ _nc_timed_wait(int mode, int milliseconds, int *timeleft)
        } else
            result = 0;
     }
+#ifdef NCURSES_WGETCH_EVENTS
+    if ((mode & 4) && evl && evl->result_flags)
+       result |= 4;
+#endif
 
     return (result);
 }