rtime.h

Go to the documentation of this file.

/* RLIB - Convenience library for useful things
 * Copyright (C) 2015  Haakon Sporsheim <haakon.sporsheim@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.
 * See the COPYING file at the root of the source repository.
 */
#ifndef __R_TIME_H__
#define __R_TIME_H__
 
#if !defined(__RLIB_H_INCLUDE_GUARD__) && !defined(RLIB_COMPILATION)
#error "#include <rlib.h> only please."
#endif
 
#include <rlib/rtypes.h>
 
#define R_CLOCK_TIME_IS_VALID(time)   (((RClockTime)(time)) != R_CLOCK_TIME_NONE)
 
#define R_NSECOND                     RINT64_CONSTANT (1)
#define R_USECOND                     RINT64_CONSTANT (1000)
#define R_MSECOND                     RINT64_CONSTANT (1000000)
#define R_SECOND                      RINT64_CONSTANT (1000000000)
#define R_MSEC_PER_SEC                1000
#define R_USEC_PER_SEC                1000000
#define R_NSEC_PER_SEC                1000000000
#define R_TIME_AS_HOURS(time)         ((time) / (R_SECOND * 60 * 60))
#define R_TIME_AS_MINUTES(time)       ((time) / (R_SECOND * 60))
#define R_TIME_AS_SECONDS(time)       ((time) / R_SECOND)
#define R_TIME_AS_MSECONDS(time)      ((time) / R_MSECOND)
#define R_TIME_AS_USECONDS(time)      ((time) / R_USECOND)
#define R_TIME_AS_NSECONDS(time)      ((time) / R_NSECOND)
 
#define R_CLOCK_DIFF(s, e)            (RClockTimeDiff)((e) - (s))
 
#define R_TIMESPEC_TO_TIME(ts)        (RClockTime)((ts).tv_sec * R_SECOND + (ts).tv_nsec * R_NSECOND)
#define R_TIME_TO_TIMESPEC(t,ts)                                            \
R_STMT_START {                                                              \
  (ts).tv_sec  = (rlong) ( (t) / R_SECOND);                                 \
  (ts).tv_nsec = (rlong) (((t) % R_SECOND) / R_NSECOND);                    \
} R_STMT_END
#define R_TIME_TIMESPEC_INIT(t) { (rlong) ( (t) / R_SECOND),                \
                                  (rlong) (((t) % R_SECOND) / R_NSECOND) }
 
#define R_TIMEVAL_TO_TIME(tv)         (RClockTime)((tv).tv_sec * R_SECOND + (tv).tv_usec * R_USECOND)
#define R_TIME_TO_TIMEVAL(t,tv)                                             \
R_STMT_START {                                                              \
  (tv).tv_sec  = (rlong) ( (t) / R_SECOND);                                 \
  (tv).tv_usec = (rlong) (((t) % R_SECOND) / R_USECOND);                    \
} R_STMT_END
#define R_TIME_TIMEVAL_INIT(t)  { (rlong) ( (t) / R_SECOND),                \
                                  (rlong) (((t) % R_SECOND) / R_USECOND) }
 
#define R_TIME_FORMAT                 "u:%02u:%02u.%09u"
#define R_TIME_ARGS(t)                                                      \
  R_CLOCK_TIME_IS_VALID (t) ? (ruint) R_TIME_AS_HOURS (t) : 99,             \
  R_CLOCK_TIME_IS_VALID (t) ? (ruint) R_TIME_AS_MINUTES (t) % 60 : 99,      \
  R_CLOCK_TIME_IS_VALID (t) ? (ruint) R_TIME_AS_SECONDS (t) % 60 : 99,      \
  R_CLOCK_TIME_IS_VALID (t) ? (ruint) ((t) % R_SECOND) : 999999999
 
R_BEGIN_DECLS
 
R_API RClockTime r_time_get_ts_wallclock (void);
R_API RClockTime r_time_get_ts_monotonic (void);
R_API RClockTime r_time_get_ts_raw (void);
 
R_API ruint64 r_time_get_uptime (void);
 
R_API rboolean r_time_is_leap_year (ruint16 year);
R_API ruint16 r_time_leap_years (ruint16 from, ruint16 to);
R_API rint8 r_time_days_in_month (ruint16 year, ruint8 month);
R_API ruint64 r_time_create_unix_time (ruint16 year, ruint8 month, ruint8 day,
    ruint8 hour, ruint8 minute, ruint8 second);
R_API rboolean r_time_parse_unix_time (ruint64 time,
    ruint16 * year, ruint8 * month, ruint8 * day,
    ruint8 * hour, ruint8 * minute, ruint8 * second);
 
R_API ruint64 r_time_get_unix_time (void);
#define r_time_get_time_since_epoch() r_time_get_unix_time ()
 
R_END_DECLS
 
#endif /* __R_TIME_H__ */