gtimer.c 9.31 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4
/* GLIB - Library of useful routines for C programming
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Owen Taylor's avatar
Owen Taylor committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Owen Taylor's avatar
Owen Taylor committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Owen Taylor's avatar
Owen Taylor committed
15 16 17 18
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
19

20
/*
21
 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GLib Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GLib at ftp://ftp.gtk.org/pub/gtk/. 
 */

27 28 29 30
/* 
 * MT safe
 */

31
#include "config.h"
32
#include "glibconfig.h"
33

Emmanuele Bassi's avatar
Emmanuele Bassi committed
34 35
#include <stdlib.h>

36 37 38
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif /* HAVE_UNISTD_H */
39

40
#ifndef G_OS_WIN32
41
#include <sys/time.h>
42 43
#include <time.h>
#include <errno.h>
44
#endif /* G_OS_WIN32 */
Owen Taylor's avatar
Owen Taylor committed
45

46
#ifdef G_OS_WIN32
47
#include <windows.h>
48
#endif /* G_OS_WIN32 */
Owen Taylor's avatar
Owen Taylor committed
49

50
#include "glib.h"
51
#include "gthread.h"
52
#include "galias.h"
53

54
#define G_NSEC_PER_SEC 1000000000
55

56
#define GETTIME(v) (v = g_thread_gettime ())
Matthias Clasen's avatar
Matthias Clasen committed
57

58
struct _GTimer
Owen Taylor's avatar
Owen Taylor committed
59
{
60 61
  guint64 start;
  guint64 end;
Owen Taylor's avatar
Owen Taylor committed
62

63 64
  guint active : 1;
};
Owen Taylor's avatar
Owen Taylor committed
65

66

Owen Taylor's avatar
Owen Taylor committed
67 68 69
GTimer*
g_timer_new (void)
{
70
  GTimer *timer;
Owen Taylor's avatar
Owen Taylor committed
71

72
  timer = g_new (GTimer, 1);
Owen Taylor's avatar
Owen Taylor committed
73 74
  timer->active = TRUE;

75
  GETTIME (timer->start);
Owen Taylor's avatar
Owen Taylor committed
76

77
  return timer;
Owen Taylor's avatar
Owen Taylor committed
78 79 80 81 82
}

void
g_timer_destroy (GTimer *timer)
{
83
  g_return_if_fail (timer != NULL);
Owen Taylor's avatar
Owen Taylor committed
84 85 86 87 88 89 90

  g_free (timer);
}

void
g_timer_start (GTimer *timer)
{
91
  g_return_if_fail (timer != NULL);
Owen Taylor's avatar
Owen Taylor committed
92

93
  timer->active = TRUE;
94

95
  GETTIME (timer->start);
Owen Taylor's avatar
Owen Taylor committed
96 97 98 99 100
}

void
g_timer_stop (GTimer *timer)
{
101
  g_return_if_fail (timer != NULL);
Owen Taylor's avatar
Owen Taylor committed
102

103
  timer->active = FALSE;
104

105
  GETTIME (timer->end);
Owen Taylor's avatar
Owen Taylor committed
106 107 108 109 110
}

void
g_timer_reset (GTimer *timer)
{
111
  g_return_if_fail (timer != NULL);
Owen Taylor's avatar
Owen Taylor committed
112

113
  GETTIME (timer->start);
Owen Taylor's avatar
Owen Taylor committed
114 115
}

116 117 118
void
g_timer_continue (GTimer *timer)
{
119
  guint64 elapsed;
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137

  g_return_if_fail (timer != NULL);
  g_return_if_fail (timer->active == FALSE);

  /* Get elapsed time and reset timer start time
   *  to the current time minus the previously
   *  elapsed interval.
   */

  elapsed = timer->end - timer->start;

  GETTIME (timer->start);

  timer->start -= elapsed;

  timer->active = TRUE;
}

Owen Taylor's avatar
Owen Taylor committed
138 139 140 141 142
gdouble
g_timer_elapsed (GTimer *timer,
		 gulong *microseconds)
{
  gdouble total;
143
  gint64 elapsed;
Owen Taylor's avatar
Owen Taylor committed
144

145
  g_return_val_if_fail (timer != NULL, 0);
Owen Taylor's avatar
Owen Taylor committed
146

147
  if (timer->active)
148
    GETTIME (timer->end);
149

150 151
  elapsed = timer->end - timer->start;

152
  total = elapsed / 1e9;
153 154

  if (microseconds)
155
    *microseconds = (elapsed / 1000) % 1000000;
Owen Taylor's avatar
Owen Taylor committed
156 157 158

  return total;
}
159 160 161 162

void
g_usleep (gulong microseconds)
{
163
#ifdef G_OS_WIN32
164
  Sleep (microseconds / 1000);
165 166 167 168 169
#else /* !G_OS_WIN32 */
# ifdef HAVE_NANOSLEEP
  struct timespec request, remaining;
  request.tv_sec = microseconds / G_USEC_PER_SEC;
  request.tv_nsec = 1000 * (microseconds % G_USEC_PER_SEC);
170 171
  while (nanosleep (&request, &remaining) == -1 && errno == EINTR)
    request = remaining;
172
# else /* !HAVE_NANOSLEEP */
173 174 175 176 177 178 179 180
#  ifdef HAVE_NSLEEP
  /* on AIX, nsleep is analogous to nanosleep */
  struct timespec request, remaining;
  request.tv_sec = microseconds / G_USEC_PER_SEC;
  request.tv_nsec = 1000 * (microseconds % G_USEC_PER_SEC);
  while (nsleep (&request, &remaining) == -1 && errno == EINTR)
    request = remaining;
#  else /* !HAVE_NSLEEP */
181 182 183 184 185 186 187
  if (g_thread_supported ())
    {
      static GStaticMutex mutex = G_STATIC_MUTEX_INIT;
      static GCond* cond = NULL;
      GTimeVal end_time;
      
      g_get_current_time (&end_time);
188
      if (microseconds > G_MAXLONG)
189
	{
190 191
	  microseconds -= G_MAXLONG;
	  g_time_val_add (&end_time, G_MAXLONG);
192
	}
193 194
      g_time_val_add (&end_time, microseconds);

195 196 197 198 199 200 201 202 203 204 205 206 207 208
      g_static_mutex_lock (&mutex);
      
      if (!cond)
	cond = g_cond_new ();
      
      while (g_cond_timed_wait (cond, g_static_mutex_get_mutex (&mutex), 
				&end_time))
	/* do nothing */;
      
      g_static_mutex_unlock (&mutex);
    }
  else
    {
      struct timeval tv;
209 210
      tv.tv_sec = microseconds / G_USEC_PER_SEC;
      tv.tv_usec = microseconds % G_USEC_PER_SEC;
211 212
      select(0, NULL, NULL, NULL, &tv);
    }
213
#  endif /* !HAVE_NSLEEP */
214 215
# endif /* !HAVE_NANOSLEEP */
#endif /* !G_OS_WIN32 */
216 217
}

218 219
/**
 * g_time_val_add:
220
 * @time_: a #GTimeVal
221 222
 * @microseconds: number of microseconds to add to @time
 *
223 224
 * Adds the given number of microseconds to @time_. @microseconds can
 * also be negative to decrease the value of @time_.
225 226
 **/
void 
227
g_time_val_add (GTimeVal *time_, glong microseconds)
228
{
229
  g_return_if_fail (time_->tv_usec >= 0 && time_->tv_usec < G_USEC_PER_SEC);
230 231 232

  if (microseconds >= 0)
    {
233 234 235
      time_->tv_usec += microseconds % G_USEC_PER_SEC;
      time_->tv_sec += microseconds / G_USEC_PER_SEC;
      if (time_->tv_usec >= G_USEC_PER_SEC)
236
       {
237 238
         time_->tv_usec -= G_USEC_PER_SEC;
         time_->tv_sec++;
239 240 241 242 243
       }
    }
  else
    {
      microseconds *= -1;
244 245 246
      time_->tv_usec -= microseconds % G_USEC_PER_SEC;
      time_->tv_sec -= microseconds / G_USEC_PER_SEC;
      if (time_->tv_usec < 0)
247
       {
248 249
         time_->tv_usec += G_USEC_PER_SEC;
         time_->tv_sec--;
250 251 252
       }      
    }
}
253

Emmanuele Bassi's avatar
Emmanuele Bassi committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
/* converts a broken down date representation, relative to UTC, to
 * a timestamp; it uses timegm() if it's available.
 */
static time_t
mktime_utc (struct tm *tm)
{
  time_t retval;
  
#ifndef HAVE_TIMEGM
  static const gint days_before[] =
  {
    0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
  };
#endif

#ifndef HAVE_TIMEGM
  if (tm->tm_mon < 0 || tm->tm_mon > 11)
    return (time_t) -1;

  retval = (tm->tm_year - 70) * 365;
  retval += (tm->tm_year - 68) / 4;
  retval += days_before[tm->tm_mon] + tm->tm_mday - 1;
  
277
  if (tm->tm_year % 4 == 0 && tm->tm_mon < 2)
Emmanuele Bassi's avatar
Emmanuele Bassi committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
    retval -= 1;
  
  retval = ((((retval * 24) + tm->tm_hour) * 60) + tm->tm_min) * 60 + tm->tm_sec;
#else
  retval = timegm (tm);
#endif /* !HAVE_TIMEGM */
  
  return retval;
}

/**
 * g_time_val_from_iso8601:
 * @iso_date: a ISO 8601 encoded date string
 * @time_: a #GTimeVal
 *
 * Converts a string containing an ISO 8601 encoded date and time
 * to a #GTimeVal and puts it into @time_.
 *
 * Return value: %TRUE if the conversion was successful.
 *
Matthias Clasen's avatar
Matthias Clasen committed
298
 * Since: 2.12
Emmanuele Bassi's avatar
Emmanuele Bassi committed
299 300 301 302 303 304 305 306 307 308 309
 */
gboolean
g_time_val_from_iso8601 (const gchar *iso_date,
			 GTimeVal    *time_)
{
  struct tm tm;
  long val;

  g_return_val_if_fail (iso_date != NULL, FALSE);
  g_return_val_if_fail (time_ != NULL, FALSE);

310 311 312 313 314
  /* Ensure that the first character is a digit,
   * the first digit of the date, otherwise we don't
   * have an ISO 8601 date */
  while (g_ascii_isspace (*iso_date))
    iso_date++;
315

316 317
  if (*iso_date == '\0')
    return FALSE;
318 319

  if (!g_ascii_isdigit (*iso_date) && *iso_date != '-' && *iso_date != '+')
320 321
    return FALSE;

Emmanuele Bassi's avatar
Emmanuele Bassi committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
  val = strtoul (iso_date, (char **)&iso_date, 10);
  if (*iso_date == '-')
    {
      /* YYYY-MM-DD */
      tm.tm_year = val - 1900;
      iso_date++;
      tm.tm_mon = strtoul (iso_date, (char **)&iso_date, 10) - 1;
      
      if (*iso_date++ != '-')
       	return FALSE;
      
      tm.tm_mday = strtoul (iso_date, (char **)&iso_date, 10);
    }
  else
    {
      /* YYYYMMDD */
      tm.tm_mday = val % 100;
      tm.tm_mon = (val % 10000) / 100 - 1;
      tm.tm_year = val / 10000 - 1900;
    }

  if (*iso_date++ != 'T')
    return FALSE;
  
  val = strtoul (iso_date, (char **)&iso_date, 10);
  if (*iso_date == ':')
    {
      /* hh:mm:ss */
      tm.tm_hour = val;
      iso_date++;
      tm.tm_min = strtoul (iso_date, (char **)&iso_date, 10);
      
      if (*iso_date++ != ':')
        return FALSE;
      
      tm.tm_sec = strtoul (iso_date, (char **)&iso_date, 10);
    }
  else
    {
      /* hhmmss */
      tm.tm_sec = val % 100;
      tm.tm_min = (val % 10000) / 100;
      tm.tm_hour = val / 10000;
    }

  time_->tv_sec = mktime_utc (&tm);
  time_->tv_usec = 1;
  
  if (*iso_date == '.')
    time_->tv_usec = strtoul (iso_date + 1, (char **)&iso_date, 10);
    
  if (*iso_date == '+' || *iso_date == '-')
    {
      gint sign = (*iso_date == '+') ? -1 : 1;
      
      val = 60 * strtoul (iso_date + 1, (char **)&iso_date, 10);
      
      if (*iso_date == ':')
	val = 60 * val + strtoul (iso_date + 1, NULL, 10);
      else
        val = 60 * (val / 100) + (val % 100);

      time_->tv_sec += (time_t) (val * sign);
    }

  return TRUE;
}

/**
 * g_time_val_to_iso8601:
 * @time_: a #GTimeVal
 * 
 * Converts @time_ into a ISO 8601 encoded string, relative to the
 * Coordinated Universal Time (UTC).
 *
 * Return value: a newly allocated string containing a ISO 8601 date
 *
Matthias Clasen's avatar
Matthias Clasen committed
399
 * Since: 2.12
Emmanuele Bassi's avatar
Emmanuele Bassi committed
400 401 402 403 404
 */
gchar *
g_time_val_to_iso8601 (GTimeVal *time_)
{
  gchar *retval;
405 406 407 408
#ifdef HAVE_GMTIME_R
  struct tm tm_;
#endif
  
Emmanuele Bassi's avatar
Emmanuele Bassi committed
409 410 411 412 413
  g_return_val_if_fail (time_->tv_usec >= 0 && time_->tv_usec < G_USEC_PER_SEC, NULL);

#define ISO_8601_LEN 	21
#define ISO_8601_FORMAT "%Y-%m-%dT%H:%M:%SZ"
  retval = g_new0 (gchar, ISO_8601_LEN + 1);
414

Emmanuele Bassi's avatar
Emmanuele Bassi committed
415 416
  strftime (retval, ISO_8601_LEN,
	    ISO_8601_FORMAT,
417 418 419 420 421 422
#ifdef HAVE_GMTIME_R
	    gmtime_r (&(time_->tv_sec), &tm_)
#else
	    gmtime (&(time_->tv_sec))
#endif
            );
Emmanuele Bassi's avatar
Emmanuele Bassi committed
423 424 425 426
  
  return retval;
}

427 428
#define __G_TIMER_C__
#include "galiasdef.c"