include/crm/common/iso8601.h

/* */
   1 /*
   2  * Copyright 2005-2020 the Pacemaker project contributors
   3  *
   4  * The version control history for this file may have further details.
   5  *
   6  * This source code is licensed under the GNU Lesser General Public License
   7  * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
   8  */
   9 
  10 #ifndef PCMK__CRM_COMMON_ISO8601__H
  11 #  define PCMK__CRM_COMMON_ISO8601__H
  12 
  13 #  include <time.h>
  14 #  include <ctype.h>
  15 #  include <stdint.h>   // uint32_t
  16 #  include <stdbool.h>  // bool
  17 
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21 
  22 /**
  23  * \file
  24  * \brief ISO_8601 Date handling
  25  * \ingroup date
  26  */
  27 
  28 /*
  29  * See https://en.wikipedia.org/wiki/ISO_8601
  30  */
  31 
  32 typedef struct crm_time_s crm_time_t;
  33 
  34 typedef struct crm_time_period_s {
  35     crm_time_t *start;
  36     crm_time_t *end;
  37     crm_time_t *diff;
  38 } crm_time_period_t;
  39 
  40 /* Creates a new date/time object conforming to ISO 8601, for example:
  41  *   Ordinal:   2010-01 12:00:00 +10:00
  42  *   Gregorian: 2010-01-01 12:00:00 +10:00
  43  *   ISO Week:  2010-W53-6 12:00:00 +10:00
  44  *
  45  * Notes:
  46  *   Only one of date, time is required
  47  *   If date or timezone is unspecified, they default to the current one
  48  *   Supplying NULL results in the current date/time
  49  *   Dashes may be omitted from dates
  50  *   Colons may be omitted from times and timezones
  51  *   A timezone of 'Z' denotes UTC time
  52  */
  53 crm_time_t *crm_time_new(const char *string);
  54 crm_time_t *crm_time_new_undefined(void);
  55 void crm_time_free(crm_time_t * dt);
  56 
  57 bool crm_time_is_defined(const crm_time_t *t);
  58 char *crm_time_as_string(const crm_time_t *dt, int flags);
  59 
  60 #define crm_time_log(level, prefix, dt, flags)  \
  61     crm_time_log_alias(level, __FILE__, __func__, __LINE__, prefix, dt, flags)
  62 
  63 void crm_time_log_alias(int log_level, const char *file, const char *function,
  64                         int line, const char *prefix,
  65                         const crm_time_t *date_time, int flags);
  66 
  67 #  define crm_time_log_date          0x001
  68 #  define crm_time_log_timeofday     0x002
  69 #  define crm_time_log_with_timezone 0x004
  70 #  define crm_time_log_duration      0x008
  71 
  72 #  define crm_time_ordinal           0x010
  73 #  define crm_time_weeks             0x020
  74 #  define crm_time_seconds           0x100
  75 #  define crm_time_epoch             0x200
  76 
  77 crm_time_t *crm_time_parse_duration(const char *duration_str);
  78 crm_time_t *crm_time_calculate_duration(const crm_time_t *dt,
  79                                         const crm_time_t *value);
  80 crm_time_period_t *crm_time_parse_period(const char *period_str);
  81 void crm_time_free_period(crm_time_period_t *period);
  82 
  83 int crm_time_compare(const crm_time_t *a, const crm_time_t *b);
  84 
  85 int crm_time_get_timeofday(const crm_time_t *dt, uint32_t *h, uint32_t *m,
  86                            uint32_t *s);
  87 int crm_time_get_timezone(const crm_time_t *dt, uint32_t *h, uint32_t *m);
  88 int crm_time_get_gregorian(const crm_time_t *dt, uint32_t *y, uint32_t *m,
  89                            uint32_t *d);
  90 int crm_time_get_ordinal(const crm_time_t *dt, uint32_t *y, uint32_t *d);
  91 int crm_time_get_isoweek(const crm_time_t *dt, uint32_t *y, uint32_t *w,
  92                          uint32_t * d);
  93 
  94 /* Time in seconds since 0000-01-01 00:00:00Z */
  95 long long crm_time_get_seconds(const crm_time_t *dt);
  96 
  97 /* Time in seconds since 1970-01-01 00:00:00Z */
  98 long long crm_time_get_seconds_since_epoch(const crm_time_t *dt);
  99 
 100 void crm_time_set(crm_time_t *target, const crm_time_t *source);
 101 void crm_time_set_timet(crm_time_t *target, const time_t *source);
 102 
 103 /* Returns a new time object */
 104 crm_time_t *pcmk_copy_time(const crm_time_t *source);
 105 crm_time_t *crm_time_add(const crm_time_t *dt, const crm_time_t *value);
 106 crm_time_t *crm_time_subtract(const crm_time_t *dt, const crm_time_t *value);
 107 
 108 /* All crm_time_add_... functions support negative values */
 109 void crm_time_add_seconds(crm_time_t * dt, int value);
 110 void crm_time_add_minutes(crm_time_t * dt, int value);
 111 void crm_time_add_hours(crm_time_t * dt, int value);
 112 void crm_time_add_days(crm_time_t * dt, int value);
 113 void crm_time_add_weeks(crm_time_t * dt, int value);
 114 void crm_time_add_months(crm_time_t * dt, int value);
 115 void crm_time_add_years(crm_time_t * dt, int value);
 116 
 117 /* Useful helper functions */
 118 int crm_time_january1_weekday(int year);
 119 int crm_time_weeks_in_year(int year);
 120 int crm_time_days_in_month(int month, int year);
 121 
 122 bool crm_time_leapyear(int year);
 123 bool crm_time_check(const crm_time_t *dt);
 124 
 125 #ifdef __cplusplus
 126 }
 127 #endif
 128 
 129 #endif
/* */
root/include/crm/common/iso8601.h

INCLUDED FROM
