gnc-date.h

Go to the documentation of this file.

/***************************************************************************
 *            gnc-date.h (to be renamed qofdate.h)
 *
 *  Copyright (C) 1997 Robin D. Clark <rclark@cs.hmc.edu>
 *  Copyright (C) 1998-2000, 2003 Linas Vepstas <linas@linas.org>
 *  Copyright  2005  Neil Williams <linux@codehelp.co.uk>
 ****************************************************************************/
/********************************************************************\
 * 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       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
\********************************************************************/
#ifndef GNC_DATE_H
#define GNC_DATE_H

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

GType timespec_get_type( void );
#define GNC_TYPE_TIMESPEC (timespec_get_type ())

extern const char *gnc_default_strftime_date_format;

#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

typedef enum
{
    QOF_DATE_COMPLETION_THISYEAR, 
    QOF_DATE_COMPLETION_SLIDING,  
} QofDateCompletion;

#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 gchar* gnc_date_dateformat_to_string(QofDateFormat format);

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

const gchar* gnc_date_monthformat_to_string(GNCDateMonthFormat format);

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

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

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

typedef struct timespec64 Timespec;


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

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

gint      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);

Timespec timespec_now (void);

void timespecFromTime_t( Timespec *ts, time_t t );

time_t timespecToTime_t (Timespec ts);

GDate* gnc_g_date_new_today (void);

GDate timespec_to_gdate (Timespec ts);

Timespec gdate_to_timespec (GDate d);

GDate gnc_dmy2gdate (gint day, gint month, gint year);

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

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

Timespec gnc_iso8601_to_timespec_gmt(const gchar *);

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

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

/* \warning hack alert XXX FIXME -- these date routines return incorrect
 * values for dates before 1970.  Most of them are good only up
 * till 2038.  This needs fixing ...
 *
 * XXX  This routine should be modified to assume that the
 * the user wanted the time at noon, localtime.  The returned
 * time_t should be seconds (at GMT) of the local noon-time.
*/
/* time_t xaccDMYToSec (gint day, gint month, gint year); */

glong gnc_timezone (const 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);
// @}

void qof_date_completion_set(QofDateCompletion dc, int backmonths);

gchar dateSeparator(void);

// @{
/* qof_format_time takes a format specification in UTF-8 and a broken-down time,
 *  tries to call strftime with a sufficiently large buffer and, if successful,
 *  return a newly allocated string in UTF-8 for the printing result.
 *
 *  @param format A format specification in UTF-8.
 *
 *  @param tm A broken-down time.
 *
 *  @return A newly allocated string on success, or NULL otherwise.
 */
/* gchar *qof_format_time(const gchar *format, const struct tm *tm); */

gsize qof_strftime(gchar *buf, gsize max, const gchar *format,
                   const struct tm *tm);

size_t qof_print_date_dmy_buff (gchar * 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, const GDate *gd);

char * qof_print_date (time_t secs);

const char * gnc_print_date(Timespec ts);

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

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

/* ------------------------------------------------------------------ */
/* The xaccDateUtilGetStamp() routine will take the given time in
 *  seconds and return a buffer containing a textual for the date.
 *  @param thyme The time in seconds to convert.
 *  @return A pointer to the generated string.
 *  @note The caller owns this buffer and must free it when done. */
/* 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;
}

time_t gnc_timet_get_day_start(time_t time_val);

time_t gnc_timet_get_day_end(time_t time_val);

int date_get_last_mday(const struct tm *tm);

gboolean date_is_last_mday(const 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);

#define MIN_BUF_LEN 10

void gnc_dow_abbrev(gchar *buf, int buf_len, int dow);


#endif /* GNC_DATE_H */