1 /****************************************************************************
2 * Copyright (c) 1998-2004,2006 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 ****************************************************************************/
37 ** The routine _nc_timed_wait().
39 ** (This file was originally written by Eric Raymond; however except for
40 ** comments, none of the original code remains - T.Dickey).
43 #include <curses.priv.h>
53 # include <sys/time.h>
56 # if HAVE_SYS_TIME_H && HAVE_SYS_TIME_SELECT
57 # include <sys/time.h>
59 # if HAVE_SYS_SELECT_H
60 # include <sys/select.h>
64 MODULE_ID("$Id: lib_twait.c,v 1.51 2006/05/27 21:57:43 tom Exp $")
67 _nc_gettime(bool first)
72 # define PRECISE_GETTIME 1
73 static struct timeval t0;
75 gettimeofday(&t1, (struct timezone *) 0);
80 /* .tv_sec and .tv_usec are unsigned, be careful when subtracting */
81 if (t0.tv_usec > t1.tv_usec) { /* Convert 1s in 1e6 microsecs */
82 t1.tv_usec += 1000000;
85 res = (t1.tv_sec - t0.tv_sec) * 1000
86 + (t1.tv_usec - t0.tv_usec) / 1000;
89 # define PRECISE_GETTIME 0
91 time_t t1 = time((time_t *) 0);
95 res = (t1 - t0) * 1000;
97 TR(TRACE_IEVENT, ("%s time: %ld msec", first ? "get" : "elapsed", res));
101 #ifdef NCURSES_WGETCH_EVENTS
103 _nc_eventlist_timeout(_nc_eventlist * evl)
105 int event_delay = -1;
110 for (n = 0; n < evl->count; ++n) {
111 _nc_event *ev = evl->events[n];
113 if (ev->type == _NC_EVENT_TIMEOUT_MSEC) {
114 event_delay = ev->data.timeout_msec;
116 event_delay = INT_MAX; /* FIXME Is this defined? */
122 #endif /* NCURSES_WGETCH_EVENTS */
125 * Wait a specified number of milliseconds, returning nonzero if the timer
126 * didn't expire before there is activity on the specified file descriptors.
127 * The file-descriptors are specified by the mode:
128 * 0 - none (absolute time)
129 * 1 - ncurses' normal input-descriptor
130 * 2 - mouse descriptor, if any
131 * 3 - either input or mouse.
133 * Experimental: if NCURSES_WGETCH_EVENTS is defined, (mode & 4) determines
134 * whether to pay attention to evl argument. If set, the smallest of
135 * millisecond and of timeout of evl is taken.
137 * We return a mask that corresponds to the mode (e.g., 2 for mouse activity).
139 * If the milliseconds given are -1, the wait blocks until activity on the
143 _nc_timed_wait(int mode,
146 EVENTLIST_2nd(_nc_eventlist * evl))
152 #ifdef NCURSES_WGETCH_EVENTS
153 int timeout_is_event = 0;
159 struct pollfd fd_list[MIN_FDS];
160 struct pollfd *fds = fd_list;
161 #elif defined(__BEOS__)
166 long starttime, returntime;
168 TR(TRACE_IEVENT, ("start twait: %d milliseconds, mode: %d",
169 milliseconds, mode));
171 #ifdef NCURSES_WGETCH_EVENTS
173 int event_delay = _nc_eventlist_timeout(evl);
176 && (milliseconds >= event_delay || milliseconds < 0)) {
177 milliseconds = event_delay;
178 timeout_is_event = 1;
186 starttime = _nc_gettime(TRUE);
190 #ifdef NCURSES_WGETCH_EVENTS
191 if ((mode & 4) && evl)
192 evl->result_flags = 0;
196 memset(fd_list, 0, sizeof(fd_list));
198 #ifdef NCURSES_WGETCH_EVENTS
199 if ((mode & 4) && evl)
200 fds = typeMalloc(struct pollfd, MIN_FDS + evl->count);
204 fds[count].fd = SP->_ifd;
205 fds[count].events = POLLIN;
209 && (fd = SP->_mouse_fd) >= 0) {
211 fds[count].events = POLLIN;
214 #ifdef NCURSES_WGETCH_EVENTS
215 if ((mode & 4) && evl) {
216 for (n = 0; n < evl->count; ++n) {
217 _nc_event *ev = evl->events[n];
219 if (ev->type == _NC_EVENT_FILE
220 && (ev->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
221 fds[count].fd = ev->data.fev.fd;
222 fds[count].events = POLLIN;
229 result = poll(fds, (unsigned) count, milliseconds);
231 #ifdef NCURSES_WGETCH_EVENTS
232 if ((mode & 4) && evl) {
238 for (n = 0; n < evl->count; ++n) {
239 _nc_event *ev = evl->events[n];
241 if (ev->type == _NC_EVENT_FILE
242 && (ev->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
243 ev->data.fev.result = 0;
244 for (c = 0; c < count; c++)
245 if (fds[c].fd == ev->data.fev.fd
246 && fds[c].revents & POLLIN) {
247 ev->data.fev.result |= _NC_EVENT_FILE_READABLE;
248 evl->result_flags |= _NC_EVENT_FILE_READABLE;
250 } else if (ev->type == _NC_EVENT_TIMEOUT_MSEC
251 && !result && timeout_is_event) {
252 evl->result_flags |= _NC_EVENT_TIMEOUT_MSEC;
262 #elif defined(__BEOS__)
264 * BeOS's select() is declared in socket.h, so the configure script does
265 * not see it. That's just as well, since that function works only for
266 * sockets. This (using snooze and ioctl) was distilled from Be's patch
267 * for ncurses which uses a separate thread to simulate select().
269 * FIXME: the return values from the ioctl aren't very clear if we get
272 * FIXME: this assumes mode&1 if milliseconds < 0 (see lib_getch.c).
276 int step = (milliseconds < 0) ? 0 : 5000;
278 bigtime_t useconds = milliseconds * 1000;
281 if (useconds <= 0) /* we're here to go _through_ the loop */
284 for (d = 0; d < useconds; d += step) {
286 howmany = ioctl(0, 'ichr', &n);
287 if (howmany >= 0 && n > 0) {
291 if (useconds > 1 && step > 0) {
293 milliseconds -= (step / 1000);
294 if (milliseconds <= 0) {
300 } else if (milliseconds > 0) {
301 snooze(milliseconds * 1000);
306 * select() modifies the fd_set arguments; do this in the
312 FD_SET(SP->_ifd, &set);
313 count = SP->_ifd + 1;
316 && (fd = SP->_mouse_fd) >= 0) {
318 count = max(fd, count) + 1;
320 #ifdef NCURSES_WGETCH_EVENTS
321 if ((mode & 4) && evl) {
322 for (n = 0; n < evl->count; ++n) {
323 _nc_event *ev = evl->events[n];
325 if (ev->type == _NC_EVENT_FILE
326 && (ev->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
327 FD_SET(ev->data.fev.fd, &set);
328 count = max(ev->data.fev.fd + 1, count);
334 if (milliseconds >= 0) {
335 struct timeval ntimeout;
336 ntimeout.tv_sec = milliseconds / 1000;
337 ntimeout.tv_usec = (milliseconds % 1000) * 1000;
338 result = select(count, &set, NULL, NULL, &ntimeout);
340 result = select(count, &set, NULL, NULL, NULL);
343 #ifdef NCURSES_WGETCH_EVENTS
344 if ((mode & 4) && evl) {
345 evl->result_flags = 0;
346 for (n = 0; n < evl->count; ++n) {
347 _nc_event *ev = evl->events[n];
349 if (ev->type == _NC_EVENT_FILE
350 && (ev->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
351 ev->data.fev.result = 0;
352 if (FD_ISSET(ev->data.fev.fd, &set)) {
353 ev->data.fev.result |= _NC_EVENT_FILE_READABLE;
354 evl->result_flags |= _NC_EVENT_FILE_READABLE;
356 } else if (ev->type == _NC_EVENT_TIMEOUT_MSEC
357 && !result && timeout_is_event)
358 evl->result_flags |= _NC_EVENT_TIMEOUT_MSEC;
363 #endif /* USE_FUNC_POLL, etc */
365 returntime = _nc_gettime(FALSE);
367 if (milliseconds >= 0)
368 milliseconds -= (returntime - starttime);
370 #ifdef NCURSES_WGETCH_EVENTS
372 evl->result_flags = 0;
373 for (n = 0; n < evl->count; ++n) {
374 _nc_event *ev = evl->events[n];
376 if (ev->type == _NC_EVENT_TIMEOUT_MSEC) {
377 long diff = (returntime - starttime);
378 if (ev->data.timeout_msec <= diff)
379 ev->data.timeout_msec = 0;
381 ev->data.timeout_msec -= diff;
388 #if PRECISE_GETTIME && HAVE_NANOSLEEP
390 * If the timeout hasn't expired, and we've gotten no data,
391 * this is probably a system where 'select()' needs to be left
392 * alone so that it can complete. Make this process sleep,
393 * then come back for more.
395 if (result == 0 && milliseconds > 100) {
396 napms(100); /* FIXME: this won't be right if I recur! */
402 /* return approximate time left in milliseconds */
404 *timeleft = milliseconds;
406 TR(TRACE_IEVENT, ("end twait: returned %d (%d), remaining time %d msec",
407 result, errno, milliseconds));
410 * Both 'poll()' and 'select()' return the number of file descriptors
411 * that are active. Translate this back to the mask that denotes which
412 * file-descriptors, so that we don't need all of this system-specific
419 for (count = 0; count < MIN_FDS; count++) {
420 if ((mode & (1 << count))
421 && (fds[count].revents & POLLIN)) {
422 result |= (1 << count);
425 #elif defined(__BEOS__)
426 result = 1; /* redundant, but simple */
429 && (fd = SP->_mouse_fd) >= 0
430 && FD_ISSET(fd, &set))
433 && FD_ISSET(SP->_ifd, &set))
439 #ifdef NCURSES_WGETCH_EVENTS
440 if ((mode & 4) && evl && evl->result_flags)