1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
32 #include "glibconfig.h"
38 #endif /* HAVE_UNISTD_H */
44 #endif /* G_OS_WIN32 */
48 #endif /* G_OS_WIN32 */
53 #include "gstrfuncs.h"
54 #include "gtestutils.h"
60 * @short_description: keep track of elapsed time
62 * #GTimer records a start time, and counts microseconds elapsed since
63 * that time. This is done somewhat differently on different platforms,
64 * and can be tricky to get exactly right, so #GTimer provides a
65 * portable/convenient interface.
68 * #GTimer uses a higher-quality clock when thread support is available.
69 * Therefore, calling g_thread_init() while timers are running may lead to
70 * unreliable results. It is best to call g_thread_init() before starting any
71 * timers, if you are using threads at all.
75 #define G_NSEC_PER_SEC 1000000000
77 #define GETTIME(v) (v = g_thread_gettime ())
82 * Opaque datatype that records a start time.
94 * @Returns: a new #GTimer.
96 * Creates a new timer, and starts timing (i.e. g_timer_start() is
97 * implicitly called for you).
104 timer = g_new (GTimer, 1);
105 timer->active = TRUE;
107 GETTIME (timer->start);
114 * @timer: a #GTimer to destroy.
116 * Destroys a timer, freeing associated resources.
119 g_timer_destroy (GTimer *timer)
121 g_return_if_fail (timer != NULL);
130 * Marks a start time, so that future calls to g_timer_elapsed() will
131 * report the time since g_timer_start() was called. g_timer_new()
132 * automatically marks the start time, so no need to call
133 * g_timer_start() immediately after creating the timer.
136 g_timer_start (GTimer *timer)
138 g_return_if_fail (timer != NULL);
140 timer->active = TRUE;
142 GETTIME (timer->start);
149 * Marks an end time, so calls to g_timer_elapsed() will return the
150 * difference between this end time and the start time.
153 g_timer_stop (GTimer *timer)
155 g_return_if_fail (timer != NULL);
157 timer->active = FALSE;
159 GETTIME (timer->end);
166 * This function is useless; it's fine to call g_timer_start() on an
167 * already-started timer to reset the start time, so g_timer_reset()
171 g_timer_reset (GTimer *timer)
173 g_return_if_fail (timer != NULL);
175 GETTIME (timer->start);
182 * Resumes a timer that has previously been stopped with
183 * g_timer_stop(). g_timer_stop() must be called before using this
189 g_timer_continue (GTimer *timer)
193 g_return_if_fail (timer != NULL);
194 g_return_if_fail (timer->active == FALSE);
196 /* Get elapsed time and reset timer start time
197 * to the current time minus the previously
201 elapsed = timer->end - timer->start;
203 GETTIME (timer->start);
205 timer->start -= elapsed;
207 timer->active = TRUE;
213 * @microseconds: return location for the fractional part of seconds
214 * elapsed, in microseconds (that is, the total number
215 * of microseconds elapsed, modulo 1000000), or %NULL
216 * @Returns: seconds elapsed as a floating point value, including any
219 * If @timer has been started but not stopped, obtains the time since
220 * the timer was started. If @timer has been stopped, obtains the
221 * elapsed time between the time it was started and the time it was
222 * stopped. The return value is the number of seconds elapsed,
223 * including any fractional part. The @microseconds out parameter is
224 * essentially useless.
227 * Calling initialization functions, in particular g_thread_init(), while a
228 * timer is running will cause invalid return values from this function.
232 g_timer_elapsed (GTimer *timer,
233 gulong *microseconds)
238 g_return_val_if_fail (timer != NULL, 0);
241 GETTIME (timer->end);
243 elapsed = timer->end - timer->start;
245 total = elapsed / 1e9;
248 *microseconds = (elapsed / 1000) % 1000000;
254 g_usleep (gulong microseconds)
257 Sleep (microseconds / 1000);
258 #else /* !G_OS_WIN32 */
259 # ifdef HAVE_NANOSLEEP
260 struct timespec request, remaining;
261 request.tv_sec = microseconds / G_USEC_PER_SEC;
262 request.tv_nsec = 1000 * (microseconds % G_USEC_PER_SEC);
263 while (nanosleep (&request, &remaining) == -1 && errno == EINTR)
265 # else /* !HAVE_NANOSLEEP */
267 /* on AIX, nsleep is analogous to nanosleep */
268 struct timespec request, remaining;
269 request.tv_sec = microseconds / G_USEC_PER_SEC;
270 request.tv_nsec = 1000 * (microseconds % G_USEC_PER_SEC);
271 while (nsleep (&request, &remaining) == -1 && errno == EINTR)
273 # else /* !HAVE_NSLEEP */
274 if (g_thread_supported ())
276 static GStaticMutex mutex = G_STATIC_MUTEX_INIT;
277 static GCond* cond = NULL;
280 g_get_current_time (&end_time);
281 if (microseconds > G_MAXLONG)
283 microseconds -= G_MAXLONG;
284 g_time_val_add (&end_time, G_MAXLONG);
286 g_time_val_add (&end_time, microseconds);
288 g_static_mutex_lock (&mutex);
291 cond = g_cond_new ();
293 while (g_cond_timed_wait (cond, g_static_mutex_get_mutex (&mutex),
297 g_static_mutex_unlock (&mutex);
302 tv.tv_sec = microseconds / G_USEC_PER_SEC;
303 tv.tv_usec = microseconds % G_USEC_PER_SEC;
304 select(0, NULL, NULL, NULL, &tv);
306 # endif /* !HAVE_NSLEEP */
307 # endif /* !HAVE_NANOSLEEP */
308 #endif /* !G_OS_WIN32 */
313 * @time_: a #GTimeVal
314 * @microseconds: number of microseconds to add to @time
316 * Adds the given number of microseconds to @time_. @microseconds can
317 * also be negative to decrease the value of @time_.
320 g_time_val_add (GTimeVal *time_, glong microseconds)
322 g_return_if_fail (time_->tv_usec >= 0 && time_->tv_usec < G_USEC_PER_SEC);
324 if (microseconds >= 0)
326 time_->tv_usec += microseconds % G_USEC_PER_SEC;
327 time_->tv_sec += microseconds / G_USEC_PER_SEC;
328 if (time_->tv_usec >= G_USEC_PER_SEC)
330 time_->tv_usec -= G_USEC_PER_SEC;
337 time_->tv_usec -= microseconds % G_USEC_PER_SEC;
338 time_->tv_sec -= microseconds / G_USEC_PER_SEC;
339 if (time_->tv_usec < 0)
341 time_->tv_usec += G_USEC_PER_SEC;
347 /* converts a broken down date representation, relative to UTC, to
348 * a timestamp; it uses timegm() if it's available.
351 mktime_utc (struct tm *tm)
356 static const gint days_before[] =
358 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
363 if (tm->tm_mon < 0 || tm->tm_mon > 11)
366 retval = (tm->tm_year - 70) * 365;
367 retval += (tm->tm_year - 68) / 4;
368 retval += days_before[tm->tm_mon] + tm->tm_mday - 1;
370 if (tm->tm_year % 4 == 0 && tm->tm_mon < 2)
373 retval = ((((retval * 24) + tm->tm_hour) * 60) + tm->tm_min) * 60 + tm->tm_sec;
375 retval = timegm (tm);
376 #endif /* !HAVE_TIMEGM */
382 * g_time_val_from_iso8601:
383 * @iso_date: an ISO 8601 encoded date string
384 * @time_: a #GTimeVal
386 * Converts a string containing an ISO 8601 encoded date and time
387 * to a #GTimeVal and puts it into @time_.
389 * Return value: %TRUE if the conversion was successful.
394 g_time_val_from_iso8601 (const gchar *iso_date,
400 g_return_val_if_fail (iso_date != NULL, FALSE);
401 g_return_val_if_fail (time_ != NULL, FALSE);
403 /* Ensure that the first character is a digit,
404 * the first digit of the date, otherwise we don't
405 * have an ISO 8601 date */
406 while (g_ascii_isspace (*iso_date))
409 if (*iso_date == '\0')
412 if (!g_ascii_isdigit (*iso_date) && *iso_date != '-' && *iso_date != '+')
415 val = strtoul (iso_date, (char **)&iso_date, 10);
416 if (*iso_date == '-')
419 tm.tm_year = val - 1900;
421 tm.tm_mon = strtoul (iso_date, (char **)&iso_date, 10) - 1;
423 if (*iso_date++ != '-')
426 tm.tm_mday = strtoul (iso_date, (char **)&iso_date, 10);
431 tm.tm_mday = val % 100;
432 tm.tm_mon = (val % 10000) / 100 - 1;
433 tm.tm_year = val / 10000 - 1900;
436 if (*iso_date != 'T')
439 if (*iso_date == '\0')
446 /* If there is a 'T' then there has to be a time */
447 if (!g_ascii_isdigit (*iso_date))
450 val = strtoul (iso_date, (char **)&iso_date, 10);
451 if (*iso_date == ':')
456 tm.tm_min = strtoul (iso_date, (char **)&iso_date, 10);
458 if (*iso_date++ != ':')
461 tm.tm_sec = strtoul (iso_date, (char **)&iso_date, 10);
466 tm.tm_sec = val % 100;
467 tm.tm_min = (val % 10000) / 100;
468 tm.tm_hour = val / 10000;
473 if (*iso_date == ',' || *iso_date == '.')
477 while (g_ascii_isdigit (*++iso_date))
479 time_->tv_usec += (*iso_date - '0') * mul;
484 /* Now parse the offset and convert tm to a time_t */
485 if (*iso_date == 'Z')
488 time_->tv_sec = mktime_utc (&tm);
490 else if (*iso_date == '+' || *iso_date == '-')
492 gint sign = (*iso_date == '+') ? -1 : 1;
494 val = strtoul (iso_date + 1, (char **)&iso_date, 10);
496 if (*iso_date == ':')
497 val = 60 * val + strtoul (iso_date + 1, (char **)&iso_date, 10);
499 val = 60 * (val / 100) + (val % 100);
501 time_->tv_sec = mktime_utc (&tm) + (time_t) (60 * val * sign);
505 /* No "Z" or offset, so local time */
506 tm.tm_isdst = -1; /* locale selects DST */
507 time_->tv_sec = mktime (&tm);
510 while (g_ascii_isspace (*iso_date))
513 return *iso_date == '\0';
517 * g_time_val_to_iso8601:
518 * @time_: a #GTimeVal
520 * Converts @time_ into an ISO 8601 encoded string, relative to the
521 * Coordinated Universal Time (UTC).
523 * Return value: a newly allocated string containing an ISO 8601 date
528 g_time_val_to_iso8601 (GTimeVal *time_)
537 g_return_val_if_fail (time_->tv_usec >= 0 && time_->tv_usec < G_USEC_PER_SEC, NULL);
539 secs = time_->tv_sec;
544 tm = gmtime_r (&secs, &tm_);
550 if (time_->tv_usec != 0)
552 /* ISO 8601 date and time format, with fractionary seconds:
553 * YYYY-MM-DDTHH:MM:SS.MMMMMMZ
555 retval = g_strdup_printf ("%4d-%02d-%02dT%02d:%02d:%02d.%06ldZ",
566 /* ISO 8601 date and time format:
567 * YYYY-MM-DDTHH:MM:SSZ
569 retval = g_strdup_printf ("%4d-%02d-%02dT%02d:%02d:%02dZ",