1 /****************************************************************************
2 * Copyright (c) 1998-2002,2003 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.49 2003/11/30 00:34:36 Philippe.Blain 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 _nc_event **ev, **last;
106 int event_delay = -1;
111 last = ev + evl->count;
114 if ((*ev)->type == _NC_EVENT_TIMEOUT_MSEC) {
115 event_delay = (*ev)->data.timeout_msec;
117 event_delay = LONG_MAX; /* FIXME Is this defined? */
123 #endif /* NCURSES_WGETCH_EVENTS */
126 * Wait a specified number of milliseconds, returning nonzero if the timer
127 * didn't expire before there is activity on the specified file descriptors.
128 * The file-descriptors are specified by the mode:
129 * 0 - none (absolute time)
130 * 1 - ncurses' normal input-descriptor
131 * 2 - mouse descriptor, if any
132 * 3 - either input or mouse.
134 * Experimental: if NCURSES_WGETCH_EVENTS is defined, (mode & 4) determines
135 * whether to pay attention to evl argument. If set, the smallest of
136 * millisecond and of timeout of evl is taken.
138 * We return a mask that corresponds to the mode (e.g., 2 for mouse activity).
140 * If the milliseconds given are -1, the wait blocks until activity on the
144 _nc_timed_wait(int mode,
147 EVENTLIST_2nd(_nc_eventlist * evl))
153 #ifdef NCURSES_WGETCH_EVENTS
154 int timeout_is_event = 0;
158 struct pollfd fd_list[2];
159 struct pollfd *fds = fd_list;
160 #elif defined(__BEOS__)
165 long starttime, returntime;
167 TR(TRACE_IEVENT, ("start twait: %d milliseconds, mode: %d",
168 milliseconds, mode));
170 #ifdef NCURSES_WGETCH_EVENTS
172 int event_delay = _nc_eventlist_timeout(evl);
175 && (milliseconds >= event_delay || milliseconds < 0)) {
176 milliseconds = event_delay;
177 timeout_is_event = 1;
185 starttime = _nc_gettime(TRUE);
189 #ifdef NCURSES_WGETCH_EVENTS
190 if ((mode & 4) && evl)
191 evl->result_flags = 0;
195 memset(fd_list, 0, sizeof(fd_list));
197 #ifdef NCURSES_WGETCH_EVENTS
198 if ((mode & 4) && evl)
199 fds = typeMalloc(struct pollfd, 2 + evl->count);
203 fds[count].fd = SP->_ifd;
204 fds[count].events = POLLIN;
208 && (fd = SP->_mouse_fd) >= 0) {
210 fds[count].events = POLLIN;
213 #ifdef NCURSES_WGETCH_EVENTS
214 if ((mode & 4) && evl) {
215 _nc_event **ev = evl->events;
216 _nc_event **last = ev + evl->count;
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, count, milliseconds);
231 #ifdef NCURSES_WGETCH_EVENTS
232 if ((mode & 4) && evl) {
233 _nc_event **ev = evl->events;
234 _nc_event **last = ev + evl->count;
240 if ((*ev)->type == _NC_EVENT_FILE
241 && ((*ev)->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
242 (*ev)->data.fev.result = 0;
243 for (c = 0; c < count; c++)
244 if (fds[c].fd == (*ev)->data.fev.fd
245 && fds[c].revents & POLLIN) {
246 (*ev)->data.fev.result |= _NC_EVENT_FILE_READABLE;
247 evl->result_flags |= _NC_EVENT_FILE_READABLE;
249 } else if ((*ev)->type == _NC_EVENT_TIMEOUT_MSEC
250 && !result && timeout_is_event) {
251 evl->result_flags |= _NC_EVENT_TIMEOUT_MSEC;
261 #elif defined(__BEOS__)
263 * BeOS's select() is declared in socket.h, so the configure script does
264 * not see it. That's just as well, since that function works only for
265 * sockets. This (using snooze and ioctl) was distilled from Be's patch
266 * for ncurses which uses a separate thread to simulate select().
268 * FIXME: the return values from the ioctl aren't very clear if we get
271 * FIXME: this assumes mode&1 if milliseconds < 0 (see lib_getch.c).
275 int step = (milliseconds < 0) ? 0 : 5000;
277 bigtime_t useconds = milliseconds * 1000;
280 if (useconds <= 0) /* we're here to go _through_ the loop */
283 for (d = 0; d < useconds; d += step) {
285 howmany = ioctl(0, 'ichr', &n);
286 if (howmany >= 0 && n > 0) {
290 if (useconds > 1 && step > 0) {
292 milliseconds -= (step / 1000);
293 if (milliseconds <= 0) {
299 } else if (milliseconds > 0) {
300 snooze(milliseconds * 1000);
305 * select() modifies the fd_set arguments; do this in the
311 FD_SET(SP->_ifd, &set);
312 count = SP->_ifd + 1;
315 && (fd = SP->_mouse_fd) >= 0) {
317 count = max(fd, count) + 1;
319 #ifdef NCURSES_WGETCH_EVENTS
320 if ((mode & 4) && evl) {
321 _nc_event **ev = evl->events;
322 _nc_event **last = ev + evl->count;
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 _nc_event **ev = evl->events;
346 _nc_event **last = ev + evl->count;
348 evl->result_flags = 0;
350 if ((*ev)->type == _NC_EVENT_FILE
351 && ((*ev)->data.fev.flags & _NC_EVENT_FILE_READABLE)) {
352 (*ev)->data.fev.result = 0;
353 if (FD_ISSET((*ev)->data.fev.fd, &set)) {
354 (*ev)->data.fev.result |= _NC_EVENT_FILE_READABLE;
355 evl->result_flags |= _NC_EVENT_FILE_READABLE;
357 } else if ((*ev)->type == _NC_EVENT_TIMEOUT_MSEC
358 && !result && timeout_is_event)
359 evl->result_flags |= _NC_EVENT_TIMEOUT_MSEC;
364 #endif /* USE_FUNC_POLL, etc */
366 returntime = _nc_gettime(FALSE);
368 if (milliseconds >= 0)
369 milliseconds -= (returntime - starttime);
371 #ifdef NCURSES_WGETCH_EVENTS
373 _nc_event **ev = evl->events;
374 _nc_event **last = ev + evl->count;
376 evl->result_flags = 0;
378 if ((*ev)->type == _NC_EVENT_TIMEOUT_MSEC) {
379 long diff = (returntime - starttime);
380 if ((*ev)->data.timeout_msec <= diff)
381 (*ev)->data.timeout_msec = 0;
383 (*ev)->data.timeout_msec -= diff;
390 #if PRECISE_GETTIME && HAVE_NANOSLEEP
392 * If the timeout hasn't expired, and we've gotten no data,
393 * this is probably a system where 'select()' needs to be left
394 * alone so that it can complete. Make this process sleep,
395 * then come back for more.
397 if (result == 0 && milliseconds > 100) {
398 napms(100); /* FIXME: this won't be right if I recur! */
404 /* return approximate time left in milliseconds */
406 *timeleft = milliseconds;
408 TR(TRACE_IEVENT, ("end twait: returned %d (%d), remaining time %d msec",
409 result, errno, milliseconds));
412 * Both 'poll()' and 'select()' return the number of file descriptors
413 * that are active. Translate this back to the mask that denotes which
414 * file-descriptors, so that we don't need all of this system-specific
421 for (count = 0; count < 2; count++) {
422 if ((mode & (1 << count))
423 && (fds[count].revents & POLLIN)) {
424 result |= (1 << count);
427 #elif defined(__BEOS__)
428 result = 1; /* redundant, but simple */
431 && (fd = SP->_mouse_fd) >= 0
432 && FD_ISSET(fd, &set))
435 && FD_ISSET(SP->_ifd, &set))
441 #ifdef NCURSES_WGETCH_EVENTS
442 if ((mode & 4) && evl && evl->result_flags)