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.
86 * Creates a new timer, and starts timing (i.e. g_timer_start() is
87 * implicitly called for you).
89 * Returns: a new #GTimer.
96 timer
= g_new (GTimer
, 1);
99 timer
->start
= g_get_monotonic_time ();
106 * @timer: a #GTimer to destroy.
108 * Destroys a timer, freeing associated resources.
111 g_timer_destroy (GTimer
*timer
)
113 g_return_if_fail (timer
!= NULL
);
122 * Marks a start time, so that future calls to g_timer_elapsed() will
123 * report the time since g_timer_start() was called. g_timer_new()
124 * automatically marks the start time, so no need to call
125 * g_timer_start() immediately after creating the timer.
128 g_timer_start (GTimer
*timer
)
130 g_return_if_fail (timer
!= NULL
);
132 timer
->active
= TRUE
;
134 timer
->start
= g_get_monotonic_time ();
141 * Marks an end time, so calls to g_timer_elapsed() will return the
142 * difference between this end time and the start time.
145 g_timer_stop (GTimer
*timer
)
147 g_return_if_fail (timer
!= NULL
);
149 timer
->active
= FALSE
;
151 timer
->end
= g_get_monotonic_time ();
158 * This function is useless; it's fine to call g_timer_start() on an
159 * already-started timer to reset the start time, so g_timer_reset()
163 g_timer_reset (GTimer
*timer
)
165 g_return_if_fail (timer
!= NULL
);
167 timer
->start
= g_get_monotonic_time ();
174 * Resumes a timer that has previously been stopped with
175 * g_timer_stop(). g_timer_stop() must be called before using this
181 g_timer_continue (GTimer
*timer
)
185 g_return_if_fail (timer
!= NULL
);
186 g_return_if_fail (timer
->active
== FALSE
);
188 /* Get elapsed time and reset timer start time
189 * to the current time minus the previously
193 elapsed
= timer
->end
- timer
->start
;
195 timer
->start
= g_get_monotonic_time ();
197 timer
->start
-= elapsed
;
199 timer
->active
= TRUE
;
205 * @microseconds: return location for the fractional part of seconds
206 * elapsed, in microseconds (that is, the total number
207 * of microseconds elapsed, modulo 1000000), or %NULL
209 * If @timer has been started but not stopped, obtains the time since
210 * the timer was started. If @timer has been stopped, obtains the
211 * elapsed time between the time it was started and the time it was
212 * stopped. The return value is the number of seconds elapsed,
213 * including any fractional part. The @microseconds out parameter is
214 * essentially useless.
216 * Returns: seconds elapsed as a floating point value, including any
220 g_timer_elapsed (GTimer
*timer
,
221 gulong
*microseconds
)
226 g_return_val_if_fail (timer
!= NULL
, 0);
229 timer
->end
= g_get_monotonic_time ();
231 elapsed
= timer
->end
- timer
->start
;
233 total
= elapsed
/ 1e6
;
236 *microseconds
= elapsed
% 1000000;
243 * @microseconds: number of microseconds to pause
245 * Pauses the current thread for the given number of microseconds.
247 * There are 1 million microseconds per second (represented by the
248 * #G_USEC_PER_SEC macro). g_usleep() may have limited precision,
249 * depending on hardware and operating system; don't rely on the exact
250 * length of the sleep.
253 g_usleep (gulong microseconds
)
256 Sleep (microseconds
/ 1000);
258 struct timespec request
, remaining
;
259 request
.tv_sec
= microseconds
/ G_USEC_PER_SEC
;
260 request
.tv_nsec
= 1000 * (microseconds
% G_USEC_PER_SEC
);
261 while (nanosleep (&request
, &remaining
) == -1 && errno
== EINTR
)
268 * @time_: a #GTimeVal
269 * @microseconds: number of microseconds to add to @time
271 * Adds the given number of microseconds to @time_. @microseconds can
272 * also be negative to decrease the value of @time_.
275 g_time_val_add (GTimeVal
*time_
, glong microseconds
)
277 g_return_if_fail (time_
->tv_usec
>= 0 && time_
->tv_usec
< G_USEC_PER_SEC
);
279 if (microseconds
>= 0)
281 time_
->tv_usec
+= microseconds
% G_USEC_PER_SEC
;
282 time_
->tv_sec
+= microseconds
/ G_USEC_PER_SEC
;
283 if (time_
->tv_usec
>= G_USEC_PER_SEC
)
285 time_
->tv_usec
-= G_USEC_PER_SEC
;
292 time_
->tv_usec
-= microseconds
% G_USEC_PER_SEC
;
293 time_
->tv_sec
-= microseconds
/ G_USEC_PER_SEC
;
294 if (time_
->tv_usec
< 0)
296 time_
->tv_usec
+= G_USEC_PER_SEC
;
302 /* converts a broken down date representation, relative to UTC, to
303 * a timestamp; it uses timegm() if it's available.
306 mktime_utc (struct tm
*tm
)
311 static const gint days_before
[] =
313 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
318 if (tm
->tm_mon
< 0 || tm
->tm_mon
> 11)
321 retval
= (tm
->tm_year
- 70) * 365;
322 retval
+= (tm
->tm_year
- 68) / 4;
323 retval
+= days_before
[tm
->tm_mon
] + tm
->tm_mday
- 1;
325 if (tm
->tm_year
% 4 == 0 && tm
->tm_mon
< 2)
328 retval
= ((((retval
* 24) + tm
->tm_hour
) * 60) + tm
->tm_min
) * 60 + tm
->tm_sec
;
330 retval
= timegm (tm
);
331 #endif /* !HAVE_TIMEGM */
337 * g_time_val_from_iso8601:
338 * @iso_date: an ISO 8601 encoded date string
339 * @time_: (out): a #GTimeVal
341 * Converts a string containing an ISO 8601 encoded date and time
342 * to a #GTimeVal and puts it into @time_.
344 * @iso_date must include year, month, day, hours, minutes, and
345 * seconds. It can optionally include fractions of a second and a time
346 * zone indicator. (In the absence of any time zone indication, the
347 * timestamp is assumed to be in local time.)
349 * Return value: %TRUE if the conversion was successful.
354 g_time_val_from_iso8601 (const gchar
*iso_date
,
360 g_return_val_if_fail (iso_date
!= NULL
, FALSE
);
361 g_return_val_if_fail (time_
!= NULL
, FALSE
);
363 /* Ensure that the first character is a digit,
364 * the first digit of the date, otherwise we don't
365 * have an ISO 8601 date */
366 while (g_ascii_isspace (*iso_date
))
369 if (*iso_date
== '\0')
372 if (!g_ascii_isdigit (*iso_date
) && *iso_date
!= '-' && *iso_date
!= '+')
375 val
= strtoul (iso_date
, (char **)&iso_date
, 10);
376 if (*iso_date
== '-')
379 tm
.tm_year
= val
- 1900;
381 tm
.tm_mon
= strtoul (iso_date
, (char **)&iso_date
, 10) - 1;
383 if (*iso_date
++ != '-')
386 tm
.tm_mday
= strtoul (iso_date
, (char **)&iso_date
, 10);
391 tm
.tm_mday
= val
% 100;
392 tm
.tm_mon
= (val
% 10000) / 100 - 1;
393 tm
.tm_year
= val
/ 10000 - 1900;
396 if (*iso_date
!= 'T')
399 if (*iso_date
== '\0')
406 /* If there is a 'T' then there has to be a time */
407 if (!g_ascii_isdigit (*iso_date
))
410 val
= strtoul (iso_date
, (char **)&iso_date
, 10);
411 if (*iso_date
== ':')
416 tm
.tm_min
= strtoul (iso_date
, (char **)&iso_date
, 10);
418 if (*iso_date
++ != ':')
421 tm
.tm_sec
= strtoul (iso_date
, (char **)&iso_date
, 10);
426 tm
.tm_sec
= val
% 100;
427 tm
.tm_min
= (val
% 10000) / 100;
428 tm
.tm_hour
= val
/ 10000;
433 if (*iso_date
== ',' || *iso_date
== '.')
437 while (g_ascii_isdigit (*++iso_date
))
439 time_
->tv_usec
+= (*iso_date
- '0') * mul
;
444 /* Now parse the offset and convert tm to a time_t */
445 if (*iso_date
== 'Z')
448 time_
->tv_sec
= mktime_utc (&tm
);
450 else if (*iso_date
== '+' || *iso_date
== '-')
452 gint sign
= (*iso_date
== '+') ? -1 : 1;
454 val
= strtoul (iso_date
+ 1, (char **)&iso_date
, 10);
456 if (*iso_date
== ':')
457 val
= 60 * val
+ strtoul (iso_date
+ 1, (char **)&iso_date
, 10);
459 val
= 60 * (val
/ 100) + (val
% 100);
461 time_
->tv_sec
= mktime_utc (&tm
) + (time_t) (60 * val
* sign
);
465 /* No "Z" or offset, so local time */
466 tm
.tm_isdst
= -1; /* locale selects DST */
467 time_
->tv_sec
= mktime (&tm
);
470 while (g_ascii_isspace (*iso_date
))
473 return *iso_date
== '\0';
477 * g_time_val_to_iso8601:
478 * @time_: a #GTimeVal
480 * Converts @time_ into an RFC 3339 encoded string, relative to the
481 * Coordinated Universal Time (UTC). This is one of the many formats
482 * allowed by ISO 8601.
484 * ISO 8601 allows a large number of date/time formats, with or without
485 * punctuation and optional elements. The format returned by this function
486 * is a complete date and time, with optional punctuation included, the
487 * UTC time zone represented as "Z", and the @tv_usec part included if
488 * and only if it is nonzero, i.e. either
489 * "YYYY-MM-DDTHH:MM:SSZ" or "YYYY-MM-DDTHH:MM:SS.fffffZ".
491 * This corresponds to the Internet date/time format defined by
492 * <ulink url="https://www.ietf.org/rfc/rfc3339.txt">RFC 3339</ulink>, and
493 * to either of the two most-precise formats defined by
494 * <ulink url="http://www.w3.org/TR/NOTE-datetime-19980827">the W3C Note
495 * "Date and Time Formats"</ulink>. Both of these documents are profiles of
498 * Use g_date_time_format() or g_strdup_printf() if a different
499 * variation of ISO 8601 format is required.
501 * Return value: a newly allocated string containing an ISO 8601 date
506 g_time_val_to_iso8601 (GTimeVal
*time_
)
515 g_return_val_if_fail (time_
->tv_usec
>= 0 && time_
->tv_usec
< G_USEC_PER_SEC
, NULL
);
517 secs
= time_
->tv_sec
;
522 tm
= gmtime_r (&secs
, &tm_
);
528 if (time_
->tv_usec
!= 0)
530 /* ISO 8601 date and time format, with fractionary seconds:
531 * YYYY-MM-DDTHH:MM:SS.MMMMMMZ
533 retval
= g_strdup_printf ("%4d-%02d-%02dT%02d:%02d:%02d.%06ldZ",
544 /* ISO 8601 date and time format:
545 * YYYY-MM-DDTHH:MM:SSZ
547 retval
= g_strdup_printf ("%4d-%02d-%02dT%02d:%02d:%02dZ",