afw_time.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Time Support Header
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_TIME_H__
#define __AFW_TIME_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
#define AFW_TIME_SECONDS_TO_MICROSECONDS(SECONDS) \
    (afw_integer_t)(SECONDS) * (afw_integer_t)1000000
 
#define AFW_TIME_MINUTES_TO_MICROSECONDS(MINUTES) \
    AFW_TIME_SECONDS_TO_MICROSECONDS( \
        (afw_integer_t)(MINUTES) * (afw_integer_t)60)
 
#define AFW_TIME_HOURS_TO_MICROSECONDS(HOURS) \
    AFW_TIME_MINUTES_TO_MICROSECONDS( \
        (afw_integer_t)(HOURS) * (afw_integer_t)60)
 
#define AFW_TIME_DAYS_TO_MICROSECONDS(DAYS) \
    AFW_TIME_HOURS_TO_MICROSECONDS( \
        (afw_integer_t)(DAYS) * (afw_integer_t)24)
 
 
AFW_DECLARE(void)
afw_date_set_from_parts(
    afw_date_t *date,
    int year,
    int month,
    int day,
    int tz_hours_offset,
    int tz_minutes_offset,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_date_t *)
afw_date_create_from_parts(
    int year,
    int month,
    int day,
    int tz_hours_offset,
    int tz_minutes_offset,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_dateTime_set_from_apr_time(
    afw_dateTime_t *dateTime,
    apr_time_t apr_time,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_dateTime_t *)
afw_dateTime_create_from_apr_time(
    apr_time_t apr_time,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_dateTime_set_from_parts(
    afw_dateTime_t *dateTime,
    int year,
    int month,
    int day,
    int hour,
    int minute,
    int second,
    int microsecond,
    int tz_hours_offset,
    int tz_minutes_offset,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_dateTime_t *)
afw_dateTime_create_from_parts(
    int year,
    int month,
    int day,
    int hour,
    int minute,
    int second,
    int microsecond,
    int tz_hours_offset,
    int tz_minutes_offset,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_dayTimeDuration_set_from_parts(
    afw_dayTimeDuration_t *dayTimeDuration,
    afw_boolean_t is_positive,
    int days,
    int hours,
    int minutes,
    int seconds,
    int microseconds,
    afw_xctx_t *xctx)
;
 
 
AFW_DECLARE(const afw_dayTimeDuration_t *)
afw_dayTimeDuration_create_from_parts(
    afw_boolean_t is_positive,
    afw_int32_t days,
    afw_int32_t hours,
    afw_int32_t minutes,
    afw_int32_t seconds,
    afw_int32_t microseconds,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_time_set_from_parts(
    afw_time_t *time,
    int hour,
    int minute,
    int second,
    int microsecond,
    int tz_hours_offset,
    int tz_minutes_offset,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_time_t *)
afw_time_create_from_parts(
    int hour,
    int minute,
    int second,
    int microsecond,
    int tz_hours_offset,
    int tz_minutes_offset,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_yearMonthDuration_set_from_parts(
    afw_yearMonthDuration_t *yearMonthDuration,
    afw_boolean_t is_positive,
    int years,
    int months,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_yearMonthDuration_t *)
afw_yearMonthDuration_create_from_parts(
    afw_boolean_t is_positive,
    afw_int32_t years,
    afw_int32_t months,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_dateTime_set_now(
    afw_dateTime_t *dateTime_local, afw_dateTime_t *dateTime_utc,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_time_set_now(
    afw_time_t *time_local, afw_time_t *time_utc,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_dateTime_t *)
afw_dateTime_now_utc(
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_time_t *)
afw_time_now_utc(
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_dateTime_t *)
afw_dateTime_now_local(
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_time_t *)
afw_time_now_local(
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(afw_integer_t)
afw_time_to_microseconds_utc(
    const afw_time_t *time, afw_xctx_t *xctx);
 
 
AFW_DECLARE(int)
afw_date_maximum_days_in_month(
    afw_integer_t year, afw_integer_t month);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_date_internal_to_utf8(
    const afw_date_t *date, const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_date_utf8_set_internal(
    const afw_utf8_t *utf8, afw_date_t *internal, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_dateTime_internal_to_utf8(
    const afw_dateTime_t *dateTime, const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_dateTime_utf8_set_internal(
    const afw_utf8_t *utf8, afw_dateTime_t *internal, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_dayTimeDuration_internal_to_utf8(
    const afw_dayTimeDuration_t *dayTimeDuration,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_dayTimeDuration_utf8_set_internal(
    const afw_utf8_t *utf8, afw_dayTimeDuration_t *internal, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_time_internal_to_utf8(
    const afw_time_t *time, const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_time_utf8_set_internal(
    const afw_utf8_t *utf8, afw_time_t *internal, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_yearMonthDuration_internal_to_utf8(
    const afw_yearMonthDuration_t *yearMonthDuration,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_yearMonthDuration_utf8_set_internal(
    const afw_utf8_t *utf8, afw_yearMonthDuration_t *internal,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(int)
afw_date_compare(const afw_date_t *v1, const afw_date_t *v2,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(int)
afw_dateTime_compare(const afw_dateTime_t *v1, const afw_dateTime_t *v2,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(int)
afw_time_compare(const afw_time_t *v1, const afw_time_t *v2,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(int)
afw_dayTimeDuration_compare(const afw_dayTimeDuration_t *v1,
    const afw_dayTimeDuration_t *v2, afw_xctx_t *xctx);
 
 
AFW_DECLARE(int)
afw_yearMonthDuration_compare(const afw_yearMonthDuration_t *v1,
    const afw_yearMonthDuration_t *v2, afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_date_add_yearMonthDuration(
    afw_date_t *date,
    const afw_yearMonthDuration_t *yearMonthDuration,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_date_subtract_yearMonthDuration(
    afw_date_t *date,
    const afw_yearMonthDuration_t *yearMonthDuration,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_dateTime_add_dayTimeDuration(
    afw_dateTime_t *dateTime,
    const afw_dayTimeDuration_t *dayTimeDuration,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_dateTime_subtract_dayTimeDuration(
    afw_dateTime_t *dateTime,
    const afw_dayTimeDuration_t *dayTimeDuration,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_dateTime_add_yearMonthDuration(
    afw_dateTime_t *dateTime,
    const afw_yearMonthDuration_t *yearMonthDuration,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_dateTime_subtract_yearMonthDuration(
    afw_dateTime_t *dateTime,
    const afw_yearMonthDuration_t *yearMonthDuration,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_dateType_internal_to_generalized_time(
    const afw_dateTime_t *dateTime,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
AFW_DECLARE(void)
afw_dataType_generalized_time_set_internal(
    const afw_utf8_t *generalized_time, afw_dateTime_t *internal,
    afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_TIME_H__ */