gnc-date.h File Reference

Date and Time handling routines. More...

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

Go to the source code of this file.

Data Structures
struct	Time64

Macros
#define	MAX_DATE_LENGTH   34
	The maximum length of a string created by the date printers.
#define	QOF_UTC_DATE_FORMAT   "%Y-%m-%dT%H:%M:%SZ"
	Constants. More...
#define	DATE_FORMAT_FIRST   QOF_DATE_FORMAT_US
#define	DATE_FORMAT_LAST   QOF_DATE_FORMAT_UTC

Typedefs
typedef gint64	time64
	Most systems that are currently maintained, including Microsoft Windows, BSD-derived Unixes and Linux, support 64-bit time_t even on 32-bit architectures. More...

Enumerations
enum	QofDateFormat {   QOF_DATE_FORMAT_US, QOF_DATE_FORMAT_UK, QOF_DATE_FORMAT_CE, QOF_DATE_FORMAT_ISO,   QOF_DATE_FORMAT_LOCALE, QOF_DATE_FORMAT_UTC, QOF_DATE_FORMAT_CUSTOM, QOF_DATE_FORMAT_UNSET }
	Enum for determining a date format. More...
enum	QofDateCompletion { QOF_DATE_COMPLETION_THISYEAR, QOF_DATE_COMPLETION_SLIDING }
	Enum for date completion modes (for dates entered without year) More...
enum	GNCDateMonthFormat { GNCDATE_MONTH_NUMBER, GNCDATE_MONTH_ABBREV, GNCDATE_MONTH_NAME }
	This is how to format the month, as a number, an abbreviated string, or the full name.

Functions
struct tm *	gnc_localtime (const time64 *secs)
	fill out a time struct from a 64-bit time value. More...
struct tm *	gnc_localtime_r (const time64 *secs, struct tm *time)
	fill out a time struct from a 64-bit time value adjusted for the current time zone. More...
struct tm *	gnc_gmtime (const time64 *secs)
	fill out a time struct from a 64-bit time value More...
gint	gnc_start_of_week (void)
	returns an integer corresponding to locale start of week More...
time64	gnc_mktime (struct tm *time)
	calculate seconds from the epoch given a time struct More...
time64	gnc_timegm (struct tm *time)
	calculate seconds from the epoch given a time struct More...
gchar *	gnc_ctime (const time64 *secs)
	Return a string representation of a date from a 64-bit time value. More...
time64	gnc_time (time64 *tbuf)
	get the current time More...
gdouble	gnc_difftime (const time64 secs1, const time64 secs2)
	Find the difference in seconds between two time values (deprecated) More...
void	gnc_tm_free (struct tm *time)
	free a struct tm* created with gnc_localtime() or gnc_gmtime() More...
time64	time64CanonicalDayTime (time64 t)
	convert a time64 on a certain day (localtime) to the time64 representing midday on that day. More...
time64	gdate_to_time64 (GDate d)
	Turns a GDate into a time64, returning the first second of the day.
time64	gnc_dmy2time64 (gint day, gint month, gint year)
	Convert a day, month, and year to a time64, returning the first second of the day.
time64	gnc_dmy2time64_neutral (gint day, gint month, gint year)
	Converts a day, month, and year to a time64 representing 11:00:00 UTC 11:00:00 UTC falls on the same time in almost all timezones, the exceptions being the +13, +14, and -12 timezones used by countries along the International Date Line. More...
time64	gnc_dmy2time64_end (gint day, gint month, gint year)
	Same as gnc_dmy2time64, but last second of the day.
time64	gnc_iso8601_to_time64_gmt (const gchar *)
	The gnc_iso8601_to_time64_gmt() routine converts an ISO-8601 style date/time string to time64. More...
gchar *	gnc_time64_to_iso8601_buff (time64, char *buff)
	The gnc_time64_to_iso8601_buff() routine takes the input UTC time64 value and prints it as an ISO-8601 style string. More...
void	qof_date_completion_set (QofDateCompletion dc, int backmonths)
	The qof_date_completion_set() routing sets the date completion method to one of QOF_DATE_COMPLETION_THISYEAR (for completing the year to the current calendar year) or QOF_DATE_COMPLETION_SLIDING (for using a sliding 12-month window). More...
gchar	dateSeparator (void)
	dateSeparator Return the field separator for the current date format More...
String / DateFormat conversion.
const gchar *	gnc_date_dateformat_to_string (QofDateFormat format)
	The string->value versions return FALSE on success and TRUE on failure.
gboolean	gnc_date_string_to_dateformat (const gchar *format_string, QofDateFormat *format)
	Converts the date format to a printable string. More...
const gchar *	gnc_date_monthformat_to_string (GNCDateMonthFormat format)
gboolean	gnc_date_string_to_monthformat (const gchar *format_string, GNCDateMonthFormat *format)
	Converts the month format to a printable string. More...
char *	gnc_print_time64 (time64 time, const char *format)
	print a time64 as a date string per format More...
GDate time64 setters
GDate *	gnc_g_date_new_today (void)
	Returns a newly allocated date of the current clock time, taken from time(2). More...
void	gnc_gdate_set_today (GDate *gd)
	Set a GDate to the current day. More...
void	gnc_gdate_set_time64 (GDate *gd, time64 time)
	Set a GDate to a time64. More...
QofDateFormat functions
QofDateFormat	qof_date_format_get (void)
	The qof_date_format_get routine returns the date format that the date printing will use when printing a date, and the scanning routines will assume when parsing a date. More...
void	qof_date_format_set (QofDateFormat df)
	The qof_date_format_set() routine sets date format to one of US, UK, CE, OR ISO. More...
const gchar *	qof_date_format_get_string (QofDateFormat df)
	This function returns a strftime formatting string for printing an all numeric date (e.g. More...
const gchar *	qof_date_text_format_get_string (QofDateFormat df)
	This function returns a strftime formatting string for printing a date using words and numbers (e.g. More...
Date Printing/Scanning functions
gsize	qof_strftime (gchar *buf, gsize max, const gchar *format, const struct tm *tm)
	qof_strftime calls qof_format_time to print a given time and afterwards tries to put the result into a buffer of fixed size. More...
size_t	qof_print_date_dmy_buff (gchar *buff, size_t buflen, int day, int month, int year)
	qof_print_date_dmy_buff Convert a date as day / month / year integers into a localized string representation More...
size_t	qof_print_date_buff (char *buff, size_t buflen, time64 secs)
	Convenience: calls through to qof_print_date_dmy_buff(). More...
size_t	qof_print_gdate (char *buf, size_t bufflen, const GDate *gd)
	Convenience; calls through to qof_print_date_dmy_buff(). More...
char *	qof_print_date (time64 secs)
	Convenience; calls through to qof_print_date_dmy_buff(). More...
size_t	qof_print_date_time_buff (char *buff, size_t len, time64 secs)
	Returns the number of bytes printed.
gboolean	qof_scan_date (const char *buff, int *day, int *month, int *year)
	qof_scan_date Convert a string into day / month / year integers according to the current dateFormat value. More...
Date Start/End Adjustment routines
Given a time value, adjust it to be the beginning or end of that day.
void	gnc_tm_set_day_neutral (struct tm *tm)
	The gnc_tm_set_day_neutral() inline routine will set the appropriate fields in the struct tm to indicate 10:59am of that day.
time64	gnc_time64_get_day_start (time64 time_val)
	The gnc_time64_get_day_start() routine will take the given time in seconds and adjust it to the first second of that day. More...
time64	gnc_time64_get_day_neutral (time64 time_val)
	The gnc_time64_get_day_neutral() routine will take the given time in seconds and adjust it to 10:59:00Z of that day. More...
time64	gnc_time64_get_day_end (time64 time_val)
	The gnc_time64_get_day_end() routine will take the given time in seconds and adjust it to the last second of that day. More...
int	gnc_date_get_last_mday (int month, int year)
	Get the numerical last date of the month. More...
GDate hash table support
gint	gnc_gdate_equal (gconstpointer gda, gconstpointer gdb)
	Compares two GDate*'s for equality; useful for using GDate*'s as GHashTable keys. More...
guint	gnc_gdate_hash (gconstpointer gd)
	Provides a "hash" of a GDate* value; useful for using GDate*'s as GHashTable keys. More...
GDate to time64 conversions
GDate	time64_to_gdate (time64 t)
	Returns the GDate in which the time64 occurs. More...
time64	gnc_time64_get_day_start_gdate (const GDate *date)
	The gnc_time64_get_day_start() routine will take the given time in GLib GDate format and adjust it to the first second of that day.
time64	gnc_time64_get_day_end_gdate (const GDate *date)
	The gnc_time64_get_day_end() routine will take the given time in GLib GDate format and adjust it to the last second of that day.
Date Manipulation
void	gnc_gdate_set_month_start (GDate *date)
	This function modifies a GDate to set it to the first day of the month in which it falls. More...
void	gnc_gdate_set_month_end (GDate *date)
	This function modifies a GDate to set it to the last day of the month in which it falls. More...
void	gnc_gdate_set_prev_month_start (GDate *date)
	This function modifies a GDate to set it to the first day of the month prior to the one in which it falls. More...
void	gnc_gdate_set_prev_month_end (GDate *date)
	This function modifies a GDate to set it to the last day of the month prior to the one in which it falls. More...
void	gnc_gdate_set_quarter_start (GDate *date)
	This function modifies a GDate to set it to the first day of the quarter in which it falls. More...
void	gnc_gdate_set_quarter_end (GDate *date)
	This function modifies a GDate to set it to the last day of the quarter in which it falls. More...
void	gnc_gdate_set_prev_quarter_start (GDate *date)
	This function modifies a GDate to set it to the first day of the quarter prior to the one in which it falls. More...
void	gnc_gdate_set_prev_quarter_end (GDate *date)
	This function modifies a GDate to set it to the last day of the quarter prior to the one in which it falls. More...
void	gnc_gdate_set_year_start (GDate *date)
	This function modifies a GDate to set it to the first day of the year in which it falls. More...
void	gnc_gdate_set_year_end (GDate *date)
	This function modifies a GDate to set it to the last day of the year in which it falls. More...
void	gnc_gdate_set_prev_year_start (GDate *date)
	This function modifies a GDate to set it to the first day of the year prior to the one in which it falls. More...
void	gnc_gdate_set_prev_year_end (GDate *date)
	This function modifies a GDate to set it to the last day of the year prior to the one in which it falls. More...
void	gnc_gdate_set_fiscal_year_start (GDate *date, const GDate *year_end)
	This function modifies a GDate to set it to the first day of the fiscal year in which it falls. More...
void	gnc_gdate_set_fiscal_year_end (GDate *date, const GDate *year_end)
	This function modifies a GDate to set it to the last day of the fiscal year in which it falls. More...
void	gnc_gdate_set_prev_fiscal_year_start (GDate *date, const GDate *year_end)
	This function modifies a GDate to set it to the first day of the fiscal year prior to the one in which it falls. More...
void	gnc_gdate_set_prev_fiscal_year_end (GDate *date, const GDate *year_end)
	This function modifies a GDate to set it to the last day of the fiscal year prior to the one in which it falls. More...

Variables
const char *	gnc_default_strftime_date_format
	The default date format for use with strftime. More...

GValue
#define	GNC_TYPE_TIME64   (time64_get_type ())
GType	time64_get_type (void)

Today's Date
#define	MIN_BUF_LEN   10
void	gnc_tm_get_today_start (struct tm *tm)
	The gnc_tm_get_today_start() routine takes a pointer to a struct tm and fills it in with the first second of the today. More...
void	gnc_tm_get_today_neutral (struct tm *tm)
	The gnc_tm_get_today_start() routine takes a pointer to a struct tm and fills it in with the timezone neutral time (10:59:00Z). More...
void	gnc_tm_get_today_end (struct tm *tm)
	The gnc_tm_get_today_end() routine takes a pointer to a struct tm and fills it in with the last second of the today. More...
time64	gnc_time64_get_today_start (void)
	The gnc_time64_get_today_start() routine returns a time64 value corresponding to the first second of today. More...
time64	gnc_time64_get_today_end (void)
	The gnc_time64_get_today_end() routine returns a time64 value corresponding to the last second of today. More...
char *	gnc_date_timestamp (void)
	Make a timestamp in YYYYMMDDHHMMSS format. More...
void	gnc_dow_abbrev (gchar *buf, int buf_len, int dow)
	Localized DOW abbreviation. More...

Detailed Description

Date and Time handling routines.

Definition in file gnc-date.h.

Function Documentation

dateSeparator()

gchar dateSeparator

(

void

)

dateSeparator Return the field separator for the current date format

Args: none

Return: date character

Globals: global dateFormat value

Definition at line 926 of file gnc-date.cpp.

{
    static char locale_separator = '\0';

    switch (dateFormat)
    {
    case QOF_DATE_FORMAT_CE:
        return '.';
    case QOF_DATE_FORMAT_ISO:
    case QOF_DATE_FORMAT_UTC:
        return '-';
    case QOF_DATE_FORMAT_US:
    case QOF_DATE_FORMAT_UK:
    default:
        return '/';
    case QOF_DATE_FORMAT_LOCALE:
        if (locale_separator != '\0')
            return locale_separator;
        else
        {
            /* Make a guess */
            gchar string[256];
            struct tm tm;
            time64 secs;
            gchar *s;

            secs = gnc_time (nullptr);
            gnc_localtime_r(&secs, &tm);
            auto normalized_fmt =
                normalize_format(qof_date_format_get_string(dateFormat));
            qof_strftime(string, sizeof(string), normalized_fmt.c_str(), &tm);

            for (s = string; *s != '\0'; s++)
                if (!isdigit(*s))
                    return (locale_separator = *s);
        }
        break;
    }
    return '\0';
}

gnc_date_get_last_mday()

int gnc_date_get_last_mday	(	int	month,
		int	year
	)

Get the numerical last date of the month.

(28, 29, 30, 31)

Definition at line 412 of file gnc-date.cpp.

{
    static int last_day_of_month[12] =
        {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
  
    g_assert(month >= 0 && month < 12);

    // To be a leap year, the year number must be divisible by four,
    // except for end-of-century years, which must be divisible by 400.

    return last_day_of_month[month] +
        (month == 1 && year % 4 == 0 && !(year % 100 == 0 && year % 400 != 0) ?
        1 : 0);
}

gnc_date_timestamp()

char* gnc_date_timestamp

(

void

)

Make a timestamp in YYYYMMDDHHMMSS format.

Returns

A pointer to the generated string.

Note

The caller owns this buffer and must g_free it when done.

Definition at line 1101 of file gnc-date.cpp.

{
    auto timestamp = GncDateTime::timestamp();
    return g_strdup(timestamp.c_str());
}

gnc_dow_abbrev()

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

Localized DOW abbreviation.

Parameters

buf_len	at least MIN_BUF_LEN
dow	struct tm semantics: 0=sunday .. 6=saturday

Definition at line 1365 of file gnc-date.cpp.

{
    struct tm my_tm;
    int i;

    memset(buf, 0, buf_len);
    memset(&my_tm, 0, sizeof(struct tm));
    my_tm.tm_wday = dow;
    i = qof_strftime(buf, buf_len, "%a", &my_tm);
    buf[i] = 0;
}

gnc_gdate_equal()

gint gnc_gdate_equal	(	gconstpointer	gda,
		gconstpointer	gdb
	)

Compares two GDate*'s for equality; useful for using GDate*'s as GHashTable keys.

Definition at line 1401 of file gnc-date.cpp.

{
    return (g_date_compare( (GDate*)gda, (GDate*)gdb ) == 0 ? TRUE : FALSE);
}

gnc_gdate_hash()

guint gnc_gdate_hash

(

gconstpointer

gd

)

Provides a "hash" of a GDate* value; useful for using GDate*'s as GHashTable keys.

Definition at line 1407 of file gnc-date.cpp.

{
    gint val = (g_date_get_year( (GDate*)gd ) * 10000)
               + (g_date_get_month( (GDate*)gd ) * 100)
               + g_date_get_day( (GDate*)gd );
    return g_int_hash( &val );
}

gnc_gdate_set_fiscal_year_end()

void gnc_gdate_set_fiscal_year_end	(	GDate *	date,
		const GDate *	year_end
	)

This function modifies a GDate to set it to the last day of the fiscal year in which it falls.

For example, if this function is called with a date of 2003-09-24 and a fiscal year ending July 31st, the date will be modified to 2004-07-31.

Parameters

date	The GDate to modify.
year_end	A GDate containing the last month and day of the fiscal year. The year field of this argument is ignored.

Definition at line 1604 of file gnc-date.cpp.

{
    GDate temp;
    gboolean new_fy;

    g_return_if_fail(date);
    g_return_if_fail(fy_end);

    /* Compute the FY end that occurred this CY */
    temp = *fy_end;
    g_date_set_year(&temp, g_date_get_year(date));

    /* Has it already passed? */
    new_fy = (g_date_compare(date, &temp) > 0);

    /* Set end date */
    *date = temp;
    if (new_fy)
        g_date_add_years(date, 1);
}

gnc_gdate_set_fiscal_year_start()

void gnc_gdate_set_fiscal_year_start	(	GDate *	date,
		const GDate *	year_end
	)

This function modifies a GDate to set it to the first day of the fiscal year in which it falls.

For example, if this function is called with a date of 2003-09-24 and a fiscal year ending July 31st, the date will be modified to 2003-08-01.

Parameters

date	The GDate to modify.
year_end	A GDate containing the last month and day of the fiscal year. The year field of this argument is ignored.

Definition at line 1580 of file gnc-date.cpp.

{
    GDate temp;
    gboolean new_fy;

    g_return_if_fail(date);
    g_return_if_fail(fy_end);

    /* Compute the FY end that occurred this CY */
    temp = *fy_end;
    g_date_set_year(&temp, g_date_get_year(date));

    /* Has it already passed? */
    new_fy = (g_date_compare(date, &temp) > 0);

    /* Set start date */
    *date = temp;
    g_date_add_days(date, 1);
    if (!new_fy)
        g_date_subtract_years(date, 1);
}

gnc_gdate_set_month_end()

void gnc_gdate_set_month_end

(

GDate *

date

)

This function modifies a GDate to set it to the last day of the month in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-09-30.

Parameters

date	The GDate to modify.

This function modifies a GDate to set it to the last day of the month in which it falls.

This routine has no knowledge of how many days are in a month, whether its a leap year, etc. All that information is contained in the glib date functions.

Parameters

date	The GDate to modify.

Definition at line 1467 of file gnc-date.cpp.

{
    /* First set the start of next month. */
    g_date_set_day(date, 1);
    g_date_add_months(date, 1);

    /* Then back up one day */
    g_date_subtract_days(date, 1);
}

gnc_gdate_set_month_start()

void gnc_gdate_set_month_start

(

GDate *

date

)

This function modifies a GDate to set it to the first day of the month in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-09-01.

Parameters

date	The GDate to modify.

Definition at line 1454 of file gnc-date.cpp.

{
    g_date_set_day(date, 1);
}

gnc_gdate_set_prev_fiscal_year_end()

void gnc_gdate_set_prev_fiscal_year_end	(	GDate *	date,
		const GDate *	year_end
	)

This function modifies a GDate to set it to the last day of the fiscal year prior to the one in which it falls.

For example, if this function is called with a date of 2003-09-24 and a fiscal year ending July 31st, the date will be modified to 2003-07-31.

Parameters

date	The GDate to modify.
year_end	A GDate containing the last month and day of the fiscal year. The year field of this argument is ignored.

Definition at line 1638 of file gnc-date.cpp.

{
    g_return_if_fail(date);
    g_return_if_fail(fy_end);

    gnc_gdate_set_fiscal_year_end(date, fy_end);
    g_date_subtract_years(date, 1);
}

gnc_gdate_set_prev_fiscal_year_start()

void gnc_gdate_set_prev_fiscal_year_start	(	GDate *	date,
		const GDate *	year_end
	)

This function modifies a GDate to set it to the first day of the fiscal year prior to the one in which it falls.

For example, if this function is called with a date of 2003-09-24 and a fiscal year ending July 31st, the date will be modified to 2002-08-01.

Parameters

date	The GDate to modify.
year_end	A GDate containing the last month and day of the fiscal year. The year field of this argument is ignored.

Definition at line 1627 of file gnc-date.cpp.

{
    g_return_if_fail(date);
    g_return_if_fail(fy_end);

    gnc_gdate_set_fiscal_year_start(date, fy_end);
    g_date_subtract_years(date, 1);
}

gnc_gdate_set_prev_month_end()

void gnc_gdate_set_prev_month_end

(

GDate *

date

)

This function modifies a GDate to set it to the last day of the month prior to the one in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-08-31.

Parameters

date	The GDate to modify.

This function modifies a GDate to set it to the last day of the month prior to the one in which it falls.

This routine has no knowledge of how many days are in a month, whether its a leap year, etc. All that information is contained in the glib date functions.

Parameters

date	The GDate to modify.

Definition at line 1499 of file gnc-date.cpp.

{
    /* This will correctly handle the varying month lengths */
    g_date_set_day(date, 1);
    g_date_subtract_days(date, 1);
}

gnc_gdate_set_prev_month_start()

void gnc_gdate_set_prev_month_start

(

GDate *

date

)

This function modifies a GDate to set it to the first day of the month prior to the one in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-08-01.

Parameters

date	The GDate to modify.

This function modifies a GDate to set it to the first day of the month prior to the one in which it falls.

This routine has no knowledge of how many days are in a month, whether its a leap year, etc. All that information is contained in the glib date functions.

Parameters

date	The GDate to modify.

Definition at line 1485 of file gnc-date.cpp.

{
    g_date_set_day(date, 1);
    g_date_subtract_months(date, 1);
}

gnc_gdate_set_prev_quarter_end()

void gnc_gdate_set_prev_quarter_end

(

GDate *

date

)

This function modifies a GDate to set it to the last day of the quarter prior to the one in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-06-30.

Parameters

date	The GDate to modify.

Definition at line 1541 of file gnc-date.cpp.

{
    g_date_subtract_months(date, 3);
    gnc_gdate_set_quarter_end(date);
}

gnc_gdate_set_prev_quarter_start()

void gnc_gdate_set_prev_quarter_start

(

GDate *

date

)

This function modifies a GDate to set it to the first day of the quarter prior to the one in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-04-01.

Parameters

date	The GDate to modify.

Definition at line 1534 of file gnc-date.cpp.

{
    g_date_subtract_months(date, 3);
    gnc_gdate_set_quarter_start(date);
}

gnc_gdate_set_prev_year_end()

void gnc_gdate_set_prev_year_end

(

GDate *

date

)

This function modifies a GDate to set it to the last day of the year prior to the one in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2002-12-31.

Parameters

date	The GDate to modify.

Definition at line 1571 of file gnc-date.cpp.

{
    gnc_gdate_set_year_end(date);
    g_date_subtract_years(date, 1);
}

gnc_gdate_set_prev_year_start()

void gnc_gdate_set_prev_year_start

(

GDate *

date

)

This function modifies a GDate to set it to the first day of the year prior to the one in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2002-01-01.

Parameters

date	The GDate to modify.

Definition at line 1564 of file gnc-date.cpp.

{
    gnc_gdate_set_year_start(date);
    g_date_subtract_years(date, 1);
}

gnc_gdate_set_quarter_end()

void gnc_gdate_set_quarter_end

(

GDate *

date

)

This function modifies a GDate to set it to the last day of the quarter in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-09-30.

Parameters

date	The GDate to modify.

Definition at line 1522 of file gnc-date.cpp.

{
     const GDateMonth months[] = {G_DATE_MARCH, G_DATE_JUNE,
                                  G_DATE_SEPTEMBER, G_DATE_DECEMBER};
     const GDateDay days[] = {31, 30, 30, 31};
     int quarter = (g_date_get_month (date) - 1) / 3;

     g_date_set_month (date, months[quarter]);
     g_date_set_day (date, days[quarter]);
}

gnc_gdate_set_quarter_start()

void gnc_gdate_set_quarter_start

(

GDate *

date

)

This function modifies a GDate to set it to the first day of the quarter in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-07-01.

Parameters

date	The GDate to modify.

Definition at line 1509 of file gnc-date.cpp.

{
    gint months;

    /* Set the date to the first day of the specified month. */
    g_date_set_day(date, 1);

    /* Back up 0-2 months */
    months = (g_date_get_month(date) - G_DATE_JANUARY) % 3;
    g_date_subtract_months(date, months);
}

gnc_gdate_set_year_end()

void gnc_gdate_set_year_end

(

GDate *

date

)

This function modifies a GDate to set it to the last day of the year in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-12-31.

Parameters

date	The GDate to modify.

Definition at line 1557 of file gnc-date.cpp.

{
    g_date_set_month(date, G_DATE_DECEMBER);
    g_date_set_day(date, 31);
}

gnc_gdate_set_year_start()

void gnc_gdate_set_year_start

(

GDate *

date

)

This function modifies a GDate to set it to the first day of the year in which it falls.

For example, if this function is called with a date of 2003-09-24 the date will be modified to 2003-01-01.

Parameters

date	The GDate to modify.

Definition at line 1550 of file gnc-date.cpp.

{
    g_date_set_month(date, G_DATE_JANUARY);
    g_date_set_day(date, 1);
}

gnc_time64_get_day_end()

time64 gnc_time64_get_day_end

(

time64

time_val

)

The gnc_time64_get_day_end() routine will take the given time in seconds and adjust it to the last second of that day.

Definition at line 1316 of file gnc-date.cpp.

{
    struct tm tm;
    time64 new_time;

    gnc_tm_get_day_end(&tm, time_val);
    new_time = gnc_mktime(&tm);
    return new_time;
}

gnc_time64_get_day_neutral()

time64 gnc_time64_get_day_neutral

(

time64

time_val

)

The gnc_time64_get_day_neutral() routine will take the given time in seconds and adjust it to 10:59:00Z of that day.

Definition at line 1307 of file gnc-date.cpp.

{
    struct tm tm;
    gnc_localtime_r(&time_val, &tm);
    return gnc_dmy2time64_internal(tm.tm_mday, tm.tm_mon + 1, tm.tm_year + 1900,
                                   DayPart::neutral);
}

gnc_time64_get_day_start()

time64 gnc_time64_get_day_start

(

time64

time_val

)

The gnc_time64_get_day_start() routine will take the given time in seconds and adjust it to the first second of that day.

Definition at line 1296 of file gnc-date.cpp.

{
    struct tm tm;
    time64 new_time;

    gnc_tm_get_day_start(&tm, time_val);
    new_time = gnc_mktime(&tm);
    return new_time;
}

gnc_time64_get_today_end()

time64 gnc_time64_get_today_end

(

void

)

The gnc_time64_get_today_end() routine returns a time64 value corresponding to the last second of today.

Definition at line 1356 of file gnc-date.cpp.

{
    struct tm tm;

    gnc_tm_get_day_end(&tm, gnc_time(nullptr));
    return gnc_mktime(&tm);
}

gnc_time64_get_today_start()

time64 gnc_time64_get_today_start

(

void

)

The gnc_time64_get_today_start() routine returns a time64 value corresponding to the first second of today.

Definition at line 1347 of file gnc-date.cpp.

{
    struct tm tm;

    gnc_tm_get_day_start(&tm, gnc_time(nullptr));
    return gnc_mktime(&tm);
}

gnc_tm_get_today_end()

void gnc_tm_get_today_end

(

struct tm *

tm

)

The gnc_tm_get_today_end() routine takes a pointer to a struct tm and fills it in with the last second of the today.

Definition at line 1341 of file gnc-date.cpp.

{
    gnc_tm_get_day_end(tm, gnc_time(nullptr));
}

gnc_tm_get_today_neutral()

void gnc_tm_get_today_neutral

(

struct tm *

tm

)

The gnc_tm_get_today_start() routine takes a pointer to a struct tm and fills it in with the timezone neutral time (10:59:00Z).

Definition at line 1335 of file gnc-date.cpp.

{
    gnc_tm_get_day_neutral(tm, gnc_time(nullptr));
}

gnc_tm_get_today_start()

void gnc_tm_get_today_start

(

struct tm *

tm

)

The gnc_tm_get_today_start() routine takes a pointer to a struct tm and fills it in with the first second of the today.

Definition at line 1329 of file gnc-date.cpp.

{
    gnc_tm_get_day_start(tm, gnc_time(nullptr));
}

qof_date_completion_set()

void qof_date_completion_set	(	QofDateCompletion	dc,
		int	backmonths
	)

The qof_date_completion_set() routing sets the date completion method to one of QOF_DATE_COMPLETION_THISYEAR (for completing the year to the current calendar year) or QOF_DATE_COMPLETION_SLIDING (for using a sliding 12-month window).

The sliding window starts 'backmonth' months before the current month (0-11)

Definition at line 467 of file gnc-date.cpp.

{
    if (dc == QOF_DATE_COMPLETION_THISYEAR ||
            dc == QOF_DATE_COMPLETION_SLIDING)
    {
        dateCompletion = dc;
    }
    else
    {
        /* hack alert - Use a neutral default. */
        PERR("non-existent date completion set attempted. Setting current year completion as default");
        dateCompletion = QOF_DATE_COMPLETION_THISYEAR;
    }

    if (backmonths < 0)
    {
        backmonths = 0;
    }
    else if (backmonths > 11)
    {
        backmonths = 11;
    }
    dateCompletionBackMonths = backmonths;

    return;
}

qof_date_format_get()

QofDateFormat qof_date_format_get

(

void

)

The qof_date_format_get routine returns the date format that the date printing will use when printing a date, and the scanning routines will assume when parsing a date.

Returns

: the one of the enumerated date formats.

Definition at line 427 of file gnc-date.cpp.

{
    return dateFormat;
}

qof_date_format_get_string()

const gchar* qof_date_format_get_string

(

QofDateFormat

df

)

This function returns a strftime formatting string for printing an all numeric date (e.g.

2005-09-14). The string returned is based upon the location specified.

Parameters

df	The date style (us, uk, iso, etc) that should be provided.

Returns

A formatting string that will print a date in the requested style

Definition at line 501 of file gnc-date.cpp.

{
    switch (df)
    {
    case QOF_DATE_FORMAT_US:
        return "%m/%d/%Y";
    case QOF_DATE_FORMAT_UK:
        return "%d/%m/%Y";
    case QOF_DATE_FORMAT_CE:
        return "%d.%m.%Y";
    case QOF_DATE_FORMAT_UTC:
        return "%Y-%m-%dT%H:%M:%SZ";
    case QOF_DATE_FORMAT_ISO:
        return "%Y-%m-%d";
    case QOF_DATE_FORMAT_UNSET: // use global
        return qof_date_format_get_string (dateFormat);
    case QOF_DATE_FORMAT_LOCALE:
    default:
        break;
    };
    return GNC_D_FMT;
}

qof_date_format_set()

void qof_date_format_set

(

QofDateFormat

df

)

The qof_date_format_set() routine sets date format to one of US, UK, CE, OR ISO.

Checks to make sure it's a legal value. Args: QofDateFormat: enumeration indicating preferred format

Definition at line 432 of file gnc-date.cpp.

{
//avoid UB if df is out of range
    auto dfi{static_cast<uint8_t>(df)};
    if (dfi >= DATE_FORMAT_FIRST && dfi <= DATE_FORMAT_LAST)
    {
        prevQofDateFormat = dateFormat;
        dateFormat = df;
    }
    else
    {
        /* hack alert - Use a neutral default. */
        PERR("non-existent date format set attempted. Setting ISO default");
        prevQofDateFormat = dateFormat;
        dateFormat = QOF_DATE_FORMAT_ISO;
    }

    return;
}

qof_date_text_format_get_string()

const gchar* qof_date_text_format_get_string

(

QofDateFormat

df

)

This function returns a strftime formatting string for printing a date using words and numbers (e.g.

2005-September-14). The string returned is based upon the location specified.

Parameters

df	The date style (us, uk, iso, etc) that should be provided.

Returns

A formatting string that will print a date in the requested style

Definition at line 524 of file gnc-date.cpp.

{
    switch (df)
    {
    case QOF_DATE_FORMAT_US:
        return "%b %d, %Y";
    case QOF_DATE_FORMAT_UK:
    case QOF_DATE_FORMAT_CE:
        return "%d %b %Y";
    case QOF_DATE_FORMAT_UTC:
        return "%Y-%m-%dT%H:%M:%SZ";
    case QOF_DATE_FORMAT_ISO:
        return "%Y-%b-%d";
    case QOF_DATE_FORMAT_UNSET: // use global
        return qof_date_text_format_get_string (dateFormat);
    case QOF_DATE_FORMAT_LOCALE:
    default:
        break;
    };
    return GNC_D_FMT;
}

qof_print_date()

char* qof_print_date

(

time64

secs

)

Convenience; calls through to qof_print_date_dmy_buff().

Return: string, which should be freed when no longer needed.

Definition at line 609 of file gnc-date.cpp.

{
    char buff[MAX_DATE_LENGTH + 1];
    memset (buff, 0, sizeof (buff));
    qof_print_date_buff (buff, MAX_DATE_LENGTH, t);
    return g_strdup (buff);
}

qof_print_date_buff()

size_t qof_print_date_buff	(	char *	buff,
		size_t	buflen,
		time64	secs
	)

Convenience: calls through to qof_print_date_dmy_buff().

Definition at line 573 of file gnc-date.cpp.

{
    if (!buff) return 0;

    try
    {
        GncDateTime gncdt(t);
        std::string str = gncdt.format(qof_date_format_get_string(dateFormat));
        strncpy(buff, str.c_str(), len);
        if (str.length() >= len)
            buff[len - 1] = '\0';
    }
    catch(std::logic_error& err)
    {
        PWARN("Error processing time64 %" PRId64 ": %s", t, err.what());
    }
    catch(std::runtime_error& err)
    {
        PWARN("Error processing time64 %" PRId64 ": %s", t, err.what());
    }
    return strlen(buff);
}

qof_print_date_dmy_buff()

size_t qof_print_date_dmy_buff	(	gchar *	buff,
		size_t	buflen,
		int	day,
		int	month,
		int	year
	)

qof_print_date_dmy_buff Convert a date as day / month / year integers into a localized string representation

Args: buff - pointer to previously allocated character array; its size must be at lease MAX_DATE_LENTH bytes. len - length of the buffer, in bytes. day - day of the month as 1 ... 31 month - month of the year as 1 ... 12 year - year (4-digit)

Returns: number of characters printed

Globals: global dateFormat value

qof_print_gdate()

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

Convenience; calls through to qof_print_date_dmy_buff().

Definition at line 597 of file gnc-date.cpp.

{
    GDate date;
    g_date_clear (&date, 1);
    date = *gd;
    return qof_print_date_dmy_buff( buf, len,
                                    g_date_get_day(&date),
                                    g_date_get_month(&date),
                                    g_date_get_year(&date) );
}

qof_scan_date()

gboolean qof_scan_date	(	const char *	buff,
		int *	day,
		int *	month,
		int *	year
	)

qof_scan_date Convert a string into day / month / year integers according to the current dateFormat value.

Args: buff - pointer to date string day - will store day of the month as 1 ... 31 month - will store month of the year as 1 ... 12 year - will store the year (4-digit)

Return: TRUE if the string seemed to be a valid date; else FALSE.

Globals: uses global dateFormat value to assist in parsing.

Definition at line 918 of file gnc-date.cpp.

{
    return qof_scan_date_internal(buff, day, month, year, dateFormat);
}

qof_strftime()

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

qof_strftime calls qof_format_time to print a given time and afterwards tries to put the result into a buffer of fixed size.

Warning

HACK ALERT – the scan and print routines should probably be moved to somewhere else. The engine really isn't involved with things like printing formats. This is needed mostly by the GUI and so on. If a file-io thing needs date handling, it should do it itself, instead of depending on the routines here.

Parameters

buf	A buffer.
max	The size of buf in bytes.
format	A format specification in UTF-8.
tm	A broken-down time.

Returns

The number of characters written, not include the null byte, if the complete string, including the null byte, fits into the buffer. Otherwise 0.

Definition at line 1056 of file gnc-date.cpp.

{
    gsize convlen, retval;
    gchar *convbuf;

    g_return_val_if_fail(buf, 0);
    g_return_val_if_fail(max > 0, 0);
    g_return_val_if_fail(format, 0);
    g_return_val_if_fail(tm, 0);

    convbuf = qof_format_time(format, tm);
    if (!convbuf)
    {
        buf[0] = '\0';
        return 0;
    }

    convlen = strlen(convbuf);

    if (max <= convlen)
    {
        /* Ensure only whole characters are copied into the buffer. */
        gchar *end = g_utf8_find_prev_char(convbuf, convbuf + max);
        g_assert(end != nullptr);
        convlen = end - convbuf;

        /* Return 0 because the buffer isn't large enough. */
        retval = 0;
    }
    else
    {
        retval = convlen;
    }

    memcpy(buf, convbuf, convlen);
    buf[convlen] = '\0';
    g_free(convbuf);

    return retval;
}

time64_to_gdate()

GDate time64_to_gdate

(

time64

t

)

Returns the GDate in which the time64 occurs.

Parameters

t	The time64

Returns

A GDate for the day in which the time64 occurs.

Definition at line 1211 of file gnc-date.cpp.

{
    GDate result;

    g_date_clear (&result, 1);
    GncDateTime time(t);
    auto date = time.date().year_month_day();
    g_date_set_dmy (&result, date.day, static_cast<GDateMonth>(date.month),
                    date.year);
    g_assert(g_date_valid (&result));

    return result;
}