time.h

Go to the documentation of this file.

/*
  Copyright (C) 2016  Brazil
  Copyright (C) 2022-2026  Sutou Kouhei <kou@clear-code.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 2.1 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; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/
 
#pragma once
 
#include <time.h>
 
#ifdef  __cplusplus
extern "C" {
#endif
 
#define GRN_TIMEVAL_TO_MSEC(timeval)                    \
  (((timeval)->tv_sec * GRN_TIME_MSEC_PER_SEC) +        \
   ((timeval)->tv_nsec / GRN_TIME_NSEC_PER_MSEC))
 
#define GRN_TIMEVAL_TO_NSEC(timeval)                    \
  (((timeval)->tv_sec * GRN_TIME_NSEC_PER_SEC) + (timeval)->tv_nsec)
 
#define GRN_TIME_NSEC_PER_SEC 1000000000
#define GRN_TIME_NSEC_PER_SEC_F 1000000000.0
#define GRN_TIME_NSEC_PER_MSEC 1000000
#define GRN_TIME_NSEC_PER_USEC 1000
#define GRN_TIME_NSEC_TO_USEC(nsec) ((nsec) / GRN_TIME_NSEC_PER_USEC)
#define GRN_TIME_USEC_TO_NSEC(usec) ((usec) * GRN_TIME_NSEC_PER_USEC)
 
#define GRN_TIME_MSEC_PER_SEC 1000
 
#define GRN_TIME_USEC_PER_SEC 1000000
#define GRN_TIME_USEC_PER_SEC_F 1000000.0
#define GRN_TIME_USEC_PER_MSEC 1000
#define GRN_TIME_USEC_TO_SEC(usec) ((usec) / GRN_TIME_USEC_PER_SEC)
 
#define GRN_TIME_MSEC_TO_USEC(msec) ((msec) * GRN_TIME_USEC_PER_MSEC)
 
#define GRN_TIME_PACK(sec, usec) ((int64_t)(sec) * GRN_TIME_USEC_PER_SEC + (usec))
#define GRN_TIME_UNPACK(time_value, sec, usec) do {\
  sec = (time_value) / GRN_TIME_USEC_PER_SEC;\
  usec = (int32_t)((time_value) % GRN_TIME_USEC_PER_SEC);\
} while (0)
 
GRN_API grn_rc grn_timeval_now(grn_ctx *ctx, grn_timeval *tv);
GRN_API grn_timeval grn_timeval_from_double(grn_ctx *ctx, double value);
 
GRN_API void grn_time_now(grn_ctx *ctx, grn_obj *obj);
 
#define GRN_TIME_NOW(ctx,obj) (grn_time_now((ctx), (obj)))
 
GRN_API bool grn_time_to_tm(grn_ctx *ctx,
                            int64_t time,
                            struct tm *tm);
GRN_API bool grn_time_from_tm(grn_ctx *ctx,
                              int64_t *time,
                              struct tm *tm);
 
/* Return the offset of the local time from UTC in seconds at the given
 * UNIX time. */
typedef int32_t (*grn_time_utc_offset_func)(int64_t unix_time,
                                            void *user_data);
/* Use the given function instead of localtime() and mktime() to
 * convert between UNIX time and local time. This is for an environment
 * that doesn't have time zone information such as WASI. */
GRN_API void grn_time_set_utc_offset_func(grn_time_utc_offset_func func,
                                          void *user_data);
 
#ifdef __cplusplus
}
#endif