qofdate.h

Go to the documentation of this file.

/********************************************************************
 *       qofdate.h - QofDate, 64bit UTC date handling.
 *       Rewritten from scratch for QOF 0.7.0
 *
 *  Fri May  5 15:05:24 2006
 *  Copyright (C) 2006 Free Software Foundation, Inc.
 ********************************************************************/
/*
 *  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, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor Boston, MA  02110-1301,  USA
 */
#ifndef QOFDATE_H
#define QOFDATE_H

#include "qoftime.h"

#define MAX_DATE_LENGTH 41

#define MAX_DATE_BUFFER 256

#define SECS_PER_DAY 86400

#define SECS_PER_HOUR 3600

#define QOF_MOD_DATE "qof-dates"

typedef struct QofDate_s
{
    glong qd_nanosecs;
    gint64 qd_sec;
    glong qd_min;
    glong qd_hour;
    glong qd_mday;
    glong qd_mon;
    gint64 qd_year;
    gshort qd_wday;
    gshort qd_yday;
    gshort qd_is_dst;
    glong qd_gmt_off;
    const gchar *qd_zone;
    gboolean qd_valid;
} QofDate;

# define qof_date_isleap(year)  \
  ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))

void qof_date_init (void);

void qof_date_close (void);

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

#define QOF_DATE_FORMAT_US      1

#define QOF_DATE_FORMAT_UK      2

#define QOF_DATE_FORMAT_CE      3

#define QOF_DATE_FORMAT_ISO     4

#define QOF_DATE_FORMAT_UTC     5

#define QOF_DATE_FORMAT_ISO8601 6

#define QOF_DATE_FORMAT_LOCALE  7

#define QOF_DATE_FORMAT_CUSTOM  8

#define DATE_FORMAT_LAST  QOF_DATE_FORMAT_CUSTOM

#define QOF_HOUR_TO_SEC(x) (x * SECS_PER_HOUR)

#define QOF_MIN_TO_SEC(x) (x * 60)

#define QOF_DAYS_TO_SEC(x) (x * SECS_PER_DAY)

typedef gint QofDateFormat;

gboolean 
qof_date_format_add (const gchar * str, QofDateFormat  *identifier);

const gchar *
qof_date_format_to_name (QofDateFormat format);

QofDateFormat 
qof_date_format_from_name (const gchar * name);

gboolean 
qof_date_format_set_name (const gchar * name, QofDateFormat format);

QofDateFormat 
qof_date_format_get_current (void);

gboolean 
qof_date_format_set_current (QofDateFormat df);

const gchar *
qof_date_format_get_format (QofDateFormat df);

gchar 
qof_date_format_get_date_separator (QofDateFormat df);

gboolean
qof_date_format_set_date_separator (const gchar sep, QofDateFormat df);
QofDate *
qof_date_new (void);

QofDate *
qof_date_get_current (void);

QofDate *
qof_date_new_dmy (gint day, gint month, gint64 year);

void 
qof_date_free (QofDate * date);

QofTime*
qof_date_time_difference (const QofDate * date1, const QofDate * date2);

gboolean
qof_date_is_last_mday (const QofDate *qd);

gboolean
qof_date_addmonths (QofDate * qd, gint months,
    gboolean track_last_day);

gboolean
qof_date_equal (const QofDate *d1, const QofDate *d2);

gint
qof_date_compare (const QofDate * d1, const QofDate * d2);

gboolean
qof_date_valid (QofDate *date);

guint16
qof_date_get_yday (gint mday, gint month, gint64 year);

guint8
qof_date_get_mday (gint month, gint64 year);

QofDate *
qof_date_from_qtime (const QofTime *qt);

QofTime *
qof_date_to_qtime (const QofDate *qd);

QofDate *
qof_date_from_struct_tm (const struct tm *stm);

gboolean 
qof_date_to_struct_tm (const QofDate * qt, struct tm *stm, glong * nanosecs);

gboolean
qof_date_to_gdate (const QofDate *qd, GDate *gd);

QofDate *
qof_date_from_gdate (const GDate *gd);

gboolean 
qof_date_adddays (QofDate * qd, gint days);

gboolean
qof_date_set_day_end (QofDate * qd);

gboolean
qof_date_set_day_start (QofDate * qd);

gboolean
qof_date_set_day_middle (QofDate * qd);

gchar *
qof_date_print (const QofDate * date, QofDateFormat df);

QofDate *
qof_date_parse (const gchar * str, QofDateFormat df);

#endif /* QOFDATE_H */

---