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 */
40 #ifdef HAVE_SYS_TIME_H
46 #endif /* G_OS_WIN32 */
50 #endif /* G_OS_WIN32 */
55 #include "gstrfuncs.h"
56 #include "gtestutils.h"
62 * @short_description: keep track of elapsed time
64 * #GTimer records a start time, and counts microseconds elapsed since
65 * that time. This is done somewhat differently on different platforms,
66 * and can be tricky to get exactly right, so #GTimer provides a
67 * portable/convenient interface.
73 * Opaque datatype that records a start time.
85 * @Returns: a new #GTimer.
87 * Creates a new timer, and starts timing (i.e. g_timer_start() is
88 * implicitly called for you).
95 timer
= g_new (GTimer
, 1);
98 timer
->start
= g_get_monotonic_time ();
105 * @timer: a #GTimer to destroy.
107 * Destroys a timer, freeing associated resources.
110 g_timer_destroy (GTimer
*timer
)
112 g_return_if_fail (timer
!= NULL
);
121 * Marks a start time, so that future calls to g_timer_elapsed() will
122 * report the time since g_timer_start() was called. g_timer_new()
123 * automatically marks the start time, so no need to call
124 * g_timer_start() immediately after creating the timer.
127 g_timer_start (GTimer
*timer
)
129 g_return_if_fail (timer
!= NULL
);
131 timer
->active
= TRUE
;
133 timer
->start
= g_get_monotonic_time ();
140 * Marks an end time, so calls to g_timer_elapsed() will return the
141 * difference between this end time and the start time.
144 g_timer_stop (GTimer
*timer
)
146 g_return_if_fail (timer
!= NULL
);
148 timer
->active
= FALSE
;
150 timer
->end
= g_get_monotonic_time ();
157 * This function is useless; it's fine to call g_timer_start() on an
158 * already-started timer to reset the start time, so g_timer_reset()
162 g_timer_reset (GTimer
*timer
)
164 g_return_if_fail (timer
!= NULL
);
166 timer
->start
= g_get_monotonic_time ();
173 * Resumes a timer that has previously been stopped with
174 * g_timer_stop(). g_timer_stop() must be called before using this
180 g_timer_continue (GTimer
*timer
)
184 g_return_if_fail (timer
!= NULL
);
185 g_return_if_fail (timer
->active
== FALSE
);
187 /* Get elapsed time and reset timer start time
188 * to the current time minus the previously
192 elapsed
= timer
->end
- timer
->start
;
194 timer
->start
= g_get_monotonic_time ();
196 timer
->start
-= elapsed
;
198 timer
->active
= TRUE
;
204 * @microseconds: return location for the fractional part of seconds
205 * elapsed, in microseconds (that is, the total number
206 * of microseconds elapsed, modulo 1000000), or %NULL
207 * @Returns: seconds elapsed as a floating point value, including any
210 * If @timer has been started but not stopped, obtains the time since
211 * the timer was started. If @timer has been stopped, obtains the
212 * elapsed time between the time it was started and the time it was
213 * stopped. The return value is the number of seconds elapsed,
214 * including any fractional part. The @microseconds out parameter is
215 * essentially useless.
218 * Calling initialization functions, in particular g_thread_init(), while a
219 * timer is running will cause invalid return values from this function.
223 g_timer_elapsed (GTimer
*timer
,
224 gulong
*microseconds
)
229 g_return_val_if_fail (timer
!= NULL
, 0);
232 timer
->end
= g_get_monotonic_time ();
234 elapsed
= timer
->end
- timer
->start
;
236 total
= elapsed
/ 1e6
;
239 *microseconds
= elapsed
% 1000000;
245 g_usleep (gulong microseconds
)
248 Sleep (microseconds
/ 1000);
250 struct timespec request
, remaining
;
251 request
.tv_sec
= microseconds
/ G_USEC_PER_SEC
;
252 request
.tv_nsec
= 1000 * (microseconds
% G_USEC_PER_SEC
);
253 while (nanosleep (&request
, &remaining
) == -1 && errno
== EINTR
)
260 * @time_: a #GTimeVal
261 * @microseconds: number of microseconds to add to @time
263 * Adds the given number of microseconds to @time_. @microseconds can
264 * also be negative to decrease the value of @time_.
267 g_time_val_add (GTimeVal
*time_
, glong microseconds
)
269 g_return_if_fail (time_
->tv_usec
>= 0 && time_
->tv_usec
< G_USEC_PER_SEC
);
271 if (microseconds
>= 0)
273 time_
->tv_usec
+= microseconds
% G_USEC_PER_SEC
;
274 time_
->tv_sec
+= microseconds
/ G_USEC_PER_SEC
;
275 if (time_
->tv_usec
>= G_USEC_PER_SEC
)
277 time_
->tv_usec
-= G_USEC_PER_SEC
;
284 time_
->tv_usec
-= microseconds
% G_USEC_PER_SEC
;
285 time_
->tv_sec
-= microseconds
/ G_USEC_PER_SEC
;
286 if (time_
->tv_usec
< 0)
288 time_
->tv_usec
+= G_USEC_PER_SEC
;
294 /* converts a broken down date representation, relative to UTC, to
295 * a timestamp; it uses timegm() if it's available.
298 mktime_utc (struct tm
*tm
)
303 static const gint days_before
[] =
305 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
310 if (tm
->tm_mon
< 0 || tm
->tm_mon
> 11)
313 retval
= (tm
->tm_year
- 70) * 365;
314 retval
+= (tm
->tm_year
- 68) / 4;
315 retval
+= days_before
[tm
->tm_mon
] + tm
->tm_mday
- 1;
317 if (tm
->tm_year
% 4 == 0 && tm
->tm_mon
< 2)
320 retval
= ((((retval
* 24) + tm
->tm_hour
) * 60) + tm
->tm_min
) * 60 + tm
->tm_sec
;
322 retval
= timegm (tm
);
323 #endif /* !HAVE_TIMEGM */
329 * g_time_val_from_iso8601:
330 * @iso_date: an ISO 8601 encoded date string
331 * @time_: a #GTimeVal
333 * Converts a string containing an ISO 8601 encoded date and time
334 * to a #GTimeVal and puts it into @time_.
336 * Return value: %TRUE if the conversion was successful.
341 g_time_val_from_iso8601 (const gchar
*iso_date
,
347 g_return_val_if_fail (iso_date
!= NULL
, FALSE
);
348 g_return_val_if_fail (time_
!= NULL
, FALSE
);
350 /* Ensure that the first character is a digit,
351 * the first digit of the date, otherwise we don't
352 * have an ISO 8601 date */
353 while (g_ascii_isspace (*iso_date
))
356 if (*iso_date
== '\0')
359 if (!g_ascii_isdigit (*iso_date
) && *iso_date
!= '-' && *iso_date
!= '+')
362 val
= strtoul (iso_date
, (char **)&iso_date
, 10);
363 if (*iso_date
== '-')
366 tm
.tm_year
= val
- 1900;
368 tm
.tm_mon
= strtoul (iso_date
, (char **)&iso_date
, 10) - 1;
370 if (*iso_date
++ != '-')
373 tm
.tm_mday
= strtoul (iso_date
, (char **)&iso_date
, 10);
378 tm
.tm_mday
= val
% 100;
379 tm
.tm_mon
= (val
% 10000) / 100 - 1;
380 tm
.tm_year
= val
/ 10000 - 1900;
383 if (*iso_date
!= 'T')
386 if (*iso_date
== '\0')
393 /* If there is a 'T' then there has to be a time */
394 if (!g_ascii_isdigit (*iso_date
))
397 val
= strtoul (iso_date
, (char **)&iso_date
, 10);
398 if (*iso_date
== ':')
403 tm
.tm_min
= strtoul (iso_date
, (char **)&iso_date
, 10);
405 if (*iso_date
++ != ':')
408 tm
.tm_sec
= strtoul (iso_date
, (char **)&iso_date
, 10);
413 tm
.tm_sec
= val
% 100;
414 tm
.tm_min
= (val
% 10000) / 100;
415 tm
.tm_hour
= val
/ 10000;
420 if (*iso_date
== ',' || *iso_date
== '.')
424 while (g_ascii_isdigit (*++iso_date
))
426 time_
->tv_usec
+= (*iso_date
- '0') * mul
;
431 /* Now parse the offset and convert tm to a time_t */
432 if (*iso_date
== 'Z')
435 time_
->tv_sec
= mktime_utc (&tm
);
437 else if (*iso_date
== '+' || *iso_date
== '-')
439 gint sign
= (*iso_date
== '+') ? -1 : 1;
441 val
= strtoul (iso_date
+ 1, (char **)&iso_date
, 10);
443 if (*iso_date
== ':')
444 val
= 60 * val
+ strtoul (iso_date
+ 1, (char **)&iso_date
, 10);
446 val
= 60 * (val
/ 100) + (val
% 100);
448 time_
->tv_sec
= mktime_utc (&tm
) + (time_t) (60 * val
* sign
);
452 /* No "Z" or offset, so local time */
453 tm
.tm_isdst
= -1; /* locale selects DST */
454 time_
->tv_sec
= mktime (&tm
);
457 while (g_ascii_isspace (*iso_date
))
460 return *iso_date
== '\0';
464 * g_time_val_to_iso8601:
465 * @time_: a #GTimeVal
467 * Converts @time_ into an ISO 8601 encoded string, relative to the
468 * Coordinated Universal Time (UTC).
470 * Return value: a newly allocated string containing an ISO 8601 date
475 g_time_val_to_iso8601 (GTimeVal
*time_
)
484 g_return_val_if_fail (time_
->tv_usec
>= 0 && time_
->tv_usec
< G_USEC_PER_SEC
, NULL
);
486 secs
= time_
->tv_sec
;
491 tm
= gmtime_r (&secs
, &tm_
);
497 if (time_
->tv_usec
!= 0)
499 /* ISO 8601 date and time format, with fractionary seconds:
500 * YYYY-MM-DDTHH:MM:SS.MMMMMMZ
502 retval
= g_strdup_printf ("%4d-%02d-%02dT%02d:%02d:%02d.%06ldZ",
513 /* ISO 8601 date and time format:
514 * YYYY-MM-DDTHH:MM:SSZ
516 retval
= g_strdup_printf ("%4d-%02d-%02dT%02d:%02d:%02dZ",