gnc-date.h

Go to the documentation of this file.

/********************************************************************\
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program 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 General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 59 Temple Place - Suite 330        Fax:    +1-617-542-2652       *
 * Boston, MA  02111-1307,  USA       gnu@gnu.org                   *
\********************************************************************/
#ifndef GNC_DATE_H
#define GNC_DATE_H

#include <glib.h>
#include <time.h>

#define MAX_DATE_LENGTH 31

#define QOF_UTC_DATE_FORMAT     "%Y-%m-%dT%H:%M:%SZ"

typedef enum
{
  QOF_DATE_FORMAT_US,       
  QOF_DATE_FORMAT_UK,       
  QOF_DATE_FORMAT_CE,       
  QOF_DATE_FORMAT_ISO,      
  QOF_DATE_FORMAT_UTC,      
  QOF_DATE_FORMAT_LOCALE,   
  QOF_DATE_FORMAT_CUSTOM    
} QofDateFormat;

#define DATE_FORMAT_FIRST QOF_DATE_FORMAT_US
#define DATE_FORMAT_LAST  QOF_DATE_FORMAT_LOCALE

#define qof_date_format_get_format qof_date_text_format_get_string

typedef enum {
  GNCDATE_MONTH_NUMBER,
  GNCDATE_MONTH_ABBREV,
  GNCDATE_MONTH_NAME
} GNCDateMonthFormat;



const char* gnc_date_dateformat_to_string(QofDateFormat format);

gboolean gnc_date_string_to_dateformat(const char* format_string,
                                       QofDateFormat *format);

const char* gnc_date_monthformat_to_string(GNCDateMonthFormat format);

gboolean gnc_date_string_to_monthformat(const char *format_string,
                                        GNCDateMonthFormat *format);
// @}

/* Datatypes *******************************************************/

#ifndef SWIG   /* swig 1.1p5 can't hack the long long type */
struct timespec64
{
   long long int tv_sec;     
   long int tv_nsec;
};
#endif /* SWIG */

typedef struct timespec64 Timespec;


/* Prototypes ******************************************************/

// @{ 
gboolean timespec_equal(const Timespec *ta, const Timespec *tb);

int      timespec_cmp(const Timespec *ta, const Timespec *tb);

Timespec timespec_diff(const Timespec *ta, const Timespec *tb);

Timespec timespec_abs(const Timespec *t);

Timespec timespecCanonicalDayTime(Timespec t);

void timespecFromTime_t( Timespec *ts, time_t t );

time_t timespecToTime_t (Timespec ts);

Timespec gnc_dmy2timespec (int day, int month, int year);

Timespec gnc_dmy2timespec_end (int day, int month, int year);

Timespec gnc_iso8601_to_timespec_gmt(const char *);

char * gnc_timespec_to_iso8601_buff (Timespec ts, char * buff);

void gnc_timespec2dmy (Timespec ts, int *day, int *month, int *year);

void date_add_months (struct tm *tm, int months, gboolean track_last_day);

time_t xaccDMYToSec (int day, int month, int year);

long int gnc_timezone (struct tm *tm);
// @}

/* ------------------------------------------------------------------------ */
// @{
QofDateFormat qof_date_format_get(void);

void qof_date_format_set(QofDateFormat df);

const gchar *qof_date_format_get_string(QofDateFormat df);

const gchar *qof_date_text_format_get_string(QofDateFormat df);
// @}

char dateSeparator(void);

// @{
size_t qof_print_date_dmy_buff (char * buff, size_t buflen, int day, int month, int year);

size_t qof_print_date_buff (char * buff, size_t buflen, time_t secs);

size_t qof_print_gdate( char *buf, size_t bufflen, GDate *gd );

char * qof_print_date (time_t secs);

const char * gnc_print_date(Timespec ts);

/* ------------------------------------------------------------------ */
/* time printing utilities */

size_t qof_print_hours_elapsed_buff (char * buff, size_t len, int secs, gboolean show_secs);
size_t qof_print_minutes_elapsed_buff (char * buff, size_t len, int secs, gboolean show_secs);

size_t qof_print_time_buff (char * buff, size_t len, time_t secs);
size_t qof_print_date_time_buff (char * buff, size_t len, time_t secs);

gboolean qof_is_same_day (time_t, time_t);

/* ------------------------------------------------------------------ */
char * xaccDateUtilGetStamp (time_t thyme);
 
gboolean qof_scan_date (const char *buff, int *day, int *month, int *year);

gboolean qof_scan_date_secs (const char *buff, time_t *secs);

// @}
// @{

static inline
void gnc_tm_set_day_start (struct tm *tm)
{
  /* First second of the day */
  tm->tm_hour = 0;
  tm->tm_min = 0;
  tm->tm_sec = 0;
  tm->tm_isdst = -1;
}

static inline
void gnc_tm_set_day_middle (struct tm *tm)
{
  /* First second of the day */
  tm->tm_hour = 12;
  tm->tm_min = 0;
  tm->tm_sec = 0;
  tm->tm_isdst = -1;
}

static inline
void gnc_tm_set_day_end (struct tm *tm)
{
  /* Last second of the day */
  tm->tm_hour = 23;
  tm->tm_min = 59;
  tm->tm_sec = 59;
  tm->tm_isdst = -1;
}

void   gnc_tm_get_day_start(struct tm *tm, time_t time_val);

void   gnc_tm_get_day_end(struct tm *tm, time_t time_val);

time_t gnc_timet_get_day_start(time_t time_val);

time_t gnc_timet_get_day_end(time_t time_val);

#ifndef GNUCASH_MAJOR_VERSION

time_t gnc_timet_get_day_start_gdate (GDate *date);

time_t gnc_timet_get_day_end_gdate (GDate *date);
#endif /* GNUCASH_MAJOR_VERSION */

int date_get_last_mday(struct tm *tm);

gboolean date_is_last_mday(struct tm *tm);

int gnc_date_my_last_mday (int month, int year);
int gnc_timespec_last_mday (Timespec ts);
// @}

/* ======================================================== */

// @{
void   gnc_tm_get_today_start(struct tm *tm);

void   gnc_tm_get_today_end(struct tm *tm);

time_t gnc_timet_get_today_start(void);

time_t gnc_timet_get_today_end(void);

char * xaccDateUtilGetStampNow (void);


#endif /* GNC_DATE_H */

---