include/gammu-datetime.h

   1 /**
   2  * \file gammu-datetime.h
   3  * \author Michal Čihař
   4  *
   5  * Date and time manipulations.
   6  */
   7 #ifndef __gammu_datetime_h
   8 #define __gammu_datetime_h
   9
  10 /**
  11  * \defgroup DateTime Date and time
  12  * Date and time handling.
  13  */
  14
  15 #include <time.h>
  16 #include <gammu-error.h>
  17 #include <gammu-statemachine.h>
  18
  19 /**
  20  * Structure used for saving date and time
  21  *
  22  * \ingroup DateTime
  23  */
  24 typedef struct {
  25         /**
  26          * The difference between local time and GMT in seconds
  27          */
  28         int Timezone;
  29
  30         /**
  31          * Seconds.
  32          */
  33         int Second;
  34         /**
  35          * Minutes.
  36          */
  37         int Minute;
  38         /**
  39          * Hours.
  40          */
  41         int Hour;
  42
  43         /**
  44          * Days.
  45          */
  46         int Day;
  47         /**
  48          * January = 1, February = 2, etc.
  49          */
  50         int Month;
  51         /**
  52          * Complete year number. Not 03, but 2003
  53          */
  54         int Year;
  55 } GSM_DateTime;
  56
  57 /**
  58  * Structure used for saving relative date and time
  59  *
  60  * \ingroup DateTime
  61  */
  62 typedef struct {
  63         /**
  64          * The difference of timezones in seconds
  65          */
  66         int Timezone;
  67
  68         /**
  69          * Seconds diff.
  70          */
  71         int Second;
  72         /**
  73          * Minutes diff.
  74          */
  75         int Minute;
  76         /**
  77          * Hours diff.
  78          */
  79         int Hour;
  80
  81         /**
  82          * Days diff.
  83          */
  84         int Day;
  85         /**
  86          * Months diff.
  87          */
  88         int Month;
  89         /**
  90          * Years diff.
  91          */
  92         int Year;
  93 } GSM_DeltaTime;
  94
  95 /**
  96  * Returns string for current day of week.
  97  *
  98  * \param year Year.
  99  * \param month Month.
 100  * \param day Day.
 101  *
 102  * \return Pointer to static buffer containing day of week string.
 103  *
 104  * \ingroup DateTime
 105  */
 106 char *DayOfWeek(unsigned int year, unsigned int month, unsigned int day);
 107
 108 /**
 109  * Returns current timestamp.
 110  *
 111  * \param Date Storage for date time structure.
 112  *
 113  * \ingroup DateTime
 114  */
 115 void GSM_GetCurrentDateTime(GSM_DateTime * Date);
 116
 117 /**
 118  * Converts \ref GSM_DateTime to time_t.
 119  *
 120  * \param DT Input timestamp.
 121  *
 122  * \return time_t value.
 123  *
 124  * \ingroup DateTime
 125  */
 126 time_t Fill_Time_T(GSM_DateTime DT);
 127
 128 /**
 129  * Returns the local timezone offset in seconds.
 130  * For example 7200 for CEST.
 131  *
 132  * \return Timezone offset seconds.
 133  *
 134  * \ingroup DateTime
 135  */
 136 int GSM_GetLocalTimezoneOffset(void);
 137
 138 /**
 139  * Converts time_t to gammu \ref GSM_DateTime structure.
 140  *
 141  * \param Date Storage for date.
 142  * \param timet Input date.
 143  *
 144  * \ingroup DateTime
 145  */
 146 void Fill_GSM_DateTime(GSM_DateTime * Date, time_t timet);
 147
 148 /**
 149  * Converts string (seconds since epoch) to gammu \ref GSM_DateTime structure.
 150  *
 151  * \param Date Storage for date.
 152  * \param str Input date.
 153  *
 154  * \ingroup DateTime
 155  */
 156 void GSM_DateTimeFromTimestamp(GSM_DateTime *Date, const char *str);
 157
 158 /**
 159  * Converts gammu \ref GSM_DateTime structure to string (seconds since epoch).
 160  *
 161  * \param Date Date.
 162  * \param str Strorage for string.
 163  *
 164  * \ingroup DateTime
 165  */
 166 void GSM_DateTimeToTimestamp(GSM_DateTime *Date, char *str);
 167
 168 /**
 169  * Converts timestamp to string according to OS settings.
 170  *
 171  * \param dt Input timestamp.
 172  * \param TimeZone Whether to include time zone.
 173  *
 174  * \return Pointer to static buffer containing string.
 175  *
 176  * \ingroup DateTime
 177  */
 178 char *OSDateTime(GSM_DateTime dt, gboolean TimeZone);
 179
 180 /**
 181  * Converts date from timestamp to string according to OS settings.
 182  *
 183  * \param dt Input timestamp.
 184  *
 185  * \return Pointer to static buffer containing string.
 186  *
 187  * \ingroup DateTime
 188  */
 189 char *OSDate(GSM_DateTime dt);
 190
 191 /**
 192  * Checks whether date is valid. This does not check time, see
 193  * \ref CheckTime for this.
 194  *
 195  * \param date Structure where to check date.
 196  *
 197  * \return True if date is correct.
 198  *
 199  * \ingroup DateTime
 200  */
 201 gboolean CheckDate(GSM_DateTime * date);
 202
 203 /**
 204  * Checks whether time is valid. This does not check date, see
 205  * \ref CheckDate for this.
 206  *
 207  * \param date Structure where to check time.
 208  *
 209  * \return True if time is correct.
 210  *
 211  * \ingroup DateTime
 212  */
 213 gboolean CheckTime(GSM_DateTime * date);
 214
 215 /**
 216  * Reads date and time from phone.
 217  *
 218  * \param s State machine pointer.
 219  * \param date_time Storage for date.
 220  *
 221  * \return Error code
 222  *
 223  * \ingroup Category
 224  */
 225 GSM_Error GSM_GetDateTime(GSM_StateMachine * s, GSM_DateTime * date_time);
 226
 227 /**
 228  * Sets date and time in phone.
 229  *
 230  * \param s State machine pointer.
 231  * \param date_time Date to set.
 232  *
 233  * \return Error code
 234  *
 235  * \ingroup Category
 236  */
 237 GSM_Error GSM_SetDateTime(GSM_StateMachine * s, GSM_DateTime * date_time);
 238 #endif
 239
 240 /* Editor configuration
 241  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 242  */