Name

G_USEC_PER_SEC

#define G_USEC_PER_SEC 1000000

Number of microseconds in one second (1 million). This macro is provided for code readability.

GTimeVal

typedef struct {
  glong tv_sec;
  glong tv_usec;
} GTimeVal;

Represents a precise time, with seconds and microseconds. Similar to the struct timeval returned by the gettimeofday() UNIX call.

g_get_current_time ()

void        g_get_current_time           (GTimeVal *result);

Equivalent to the UNIX gettimeofday() function, but portable.

g_usleep ()

void        g_usleep                     (gulong microseconds);

Pauses the current thread for the given number of microseconds. There are 1 million microseconds per second (represented by the G_USEC_PER_SEC macro). g_usleep() may have limited precision, depending on hardware and operating system; do not rely on the exact length of the sleep.

g_time_val_add ()

void        g_time_val_add               (GTimeVal *time_, glong microseconds);

Adds the given number of microseconds to time_. microseconds can also be negative to decrease the value of time_.

GDate

typedef struct {
  guint julian_days : 32; /* julian days representation - we use a
                           *  bitfield hoping that 64 bit platforms
                           *  will pack this whole struct in one big
                           *  int
                           */

  guint julian : 1;    /* julian is valid */
  guint dmy    : 1;    /* dmy is valid */

  /* DMY representation */
  guint day    : 6;
  guint month  : 4;
  guint year   : 16;
} GDate;

Represents a day between January 1, Year 1 and a few thousand years in the future. None of its members should be accessed directly. If the GDate is obtained from g_date_new(), it will be safe to mutate but invalid and thus not safe for calendrical computations. If it is declared on the stack, it will contain garbage so must be initialized with g_date_clear(). g_date_clear() makes the date invalid but sane. An invalid date does not represent a day, it's "empty." A date becomes valid after it is set  to a Julian day or to a day, month, and year.

GTime

typedef gint32  GTime;

Simply a replacement for time_t. Unrelated to GTimer.

Note that GTime is defined to always be a 32bit integer, unlike time_t which may be 64bit on some systems. Therefore, GType will overflow in the year 2038, and the address of a GTime variable as argument to the UNIX time() function cannot be used. Instead, do the following:

time_t ttime;
GTime gtime;

time (&ttime);
gtime = (GTime)ttime;

enum GDateDMY

typedef enum
{
  G_DATE_DAY   = 0,
  G_DATE_MONTH = 1,
  G_DATE_YEAR  = 2
} GDateDMY;

This enumeration is not used in the API, but may be useful if there is a need to mark a number as a day, month, or year.

GDateDay

typedef guint8  GDateDay;   /* day of the month */

Integer representing a day of the month; between 1 and 31. G_DATE_BAD_DAY represents an invalid day of the month.

enum GDateMonth

typedef enum
{
  G_DATE_BAD_MONTH = 0,
  G_DATE_JANUARY   = 1,
  G_DATE_FEBRUARY  = 2,
  G_DATE_MARCH     = 3,
  G_DATE_APRIL     = 4,
  G_DATE_MAY       = 5,
  G_DATE_JUNE      = 6,
  G_DATE_JULY      = 7,
  G_DATE_AUGUST    = 8,
  G_DATE_SEPTEMBER = 9,
  G_DATE_OCTOBER   = 10,
  G_DATE_NOVEMBER  = 11,
  G_DATE_DECEMBER  = 12
} GDateMonth;

Enumeration representing a month; values are G_DATE_JANUARY, G_DATE_FEBRUARY, etc. G_DATE_BAD_MONTH is the invalid value.

GDateYear

typedef guint16 GDateYear;

Integer representing a year; G_DATE_BAD_YEAR is the invalid value. The year must be 1 or higher; negative (BC) years are not allowed. The year is represented with four digits.

enum GDateWeekday

typedef enum
{
  G_DATE_BAD_WEEKDAY  = 0,
  G_DATE_MONDAY       = 1,
  G_DATE_TUESDAY      = 2,
  G_DATE_WEDNESDAY    = 3,
  G_DATE_THURSDAY     = 4,
  G_DATE_FRIDAY       = 5,
  G_DATE_SATURDAY     = 6,
  G_DATE_SUNDAY       = 7
} GDateWeekday;

Enumeration representing a day of the week; G_DATE_MONDAY, G_DATE_TUESDAY, etc. G_DATE_BAD_WEEKDAY is an invalid weekday.

G_DATE_BAD_DAY

#define G_DATE_BAD_DAY    0U

Represents an invalid GDateDay.

G_DATE_BAD_JULIAN

#define G_DATE_BAD_JULIAN 0U

Represents an invalid Julian day number.

G_DATE_BAD_YEAR

#define G_DATE_BAD_YEAR   0U

Represents an invalid year.

g_date_new ()

GDate*      g_date_new                    (void);

Allocates a GDate and initializes it to a sane state. The new date will be cleared (as if  g_date_clear()) was called but invalid (it will not represent an existing day). Free the return value with g_date_free().

g_date_new_dmy ()

GDate*      g_date_new_dmy                (GDateDay day, GDateMonth month, GDateYear year);

Like g_date_new(), but also sets the value of the date. Assuming the day-month-year triplet passed represents an existing day, the returned date will be valid.

g_date_new_julian ()

GDate*      g_date_new_julian             (guint32 julian_day);

Like g_date_new(), but also sets the value of the date. Assuming the Julian day number passed is valid (greater than 0, less than an unreasonably large number), the returned date will be valid.

g_date_clear ()

void        g_date_clear                  (GDate *date, guint n_dates);

Initializes one or more GDate structs to a sane but invalid state. The cleared dates will not represent an existing date, but will not contain garbage. Useful to init a date declared on the stack. Validity can be tested with g_date_valid().

g_date_free ()

void        g_date_free                   (GDate *date);

Frees a GDate returned from g_date_new().

g_date_set_day ()

void        g_date_set_day                (GDate *date, GDateDay day);

Sets the day of the month for a GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.

g_date_set_month ()

void        g_date_set_month              (GDate *date, GDateMonth month);

Sets the month of the year for a GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.

g_date_set_year ()

void        g_date_set_year               (GDate *date, GDateYear year);

Sets the year for a GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.

g_date_set_dmy ()

void        g_date_set_dmy                (GDate *date, GDateDay day, GDateMonth month, GDateYear y);

Sets the value of a GDate from a day, month, and year. The day-month-year triplet must be valid; if not sure, call g_date_valid_dmy() to check before it is set.

g_date_set_julian ()

void        g_date_set_julian             (GDate *date, guint32 julian_date);

Sets the value of a GDate from a Julian day number.

g_date_set_time ()

void        g_date_set_time               (GDate *date, GTime time_);

void        g_date_set_time_t           (GDate *date, time_t timet);

 
g_date_set_time_t (date, time (NULL)); 

void        g_date_set_time_val             (GDate *date, GTimeVal *timeval);

g_date_set_parse ()

void        g_date_set_parse               (GDate *date, const gchar *str);

Parses a user-inputted string str, and try to figure out what date it represents, taking the current locale into account. If the string is successfully parsed, the date will be valid after the call. Otherwise, it will be invalid. To check whether the parsing succeeded use g_date_valid().

This function is not appropriate for file formats and the like; it is not very precise, and it's exact behavior varies with the locale. It is intended to be a heuristic routine that guesses what the user means by a given string (and it does work pretty well in that capacity).

g_date_add_days ()

void        g_date_add_days                (GDate *date, guint n_days);

Increments a date some number of days. To move forward by weeks, add weeks*7 days. The date must be valid.

g_date_subtract_days ()

void        g_date_subtract_days           (GDate *date, guint n_days);

Moves a date some number of days into the past. To move by weeks, just move by weeks*7 days. The date must be valid.

g_date_add_months ()

void        g_date_add_months              (GDate *date, guint n_months);

Increments a date by some number of months. If the day of the month is greater than 28, this routine may change the day of the month (because the destination month may not have the current day in it). The date must be valid.

g_date_subtract_months ()

void        g_date_subtract_months         (GDate *date, guint n_months);

Moves a date some number of months into the past. If the current day of the month does not exist in the destination month, the day of the month may change. The date must be valid.

g_date_add_years ()

void        g_date_add_years               (GDate *date, guint n_years);

Increments a date by some number of years. If the date is February 29, and the destination year is not a leap year, the date will be changed to February 28. The date must be valid.

g_date_subtract_years ()

void        g_date_subtract_years          (GDate *date, guint n_years);

Moves a date some number of years into the past. If the current day does not exist in the destination year (i.e. it's February 29 and moved to a non-leap-year) then the day is changed to February 29. The date must be valid.

g_date_days_between ()

gint        g_date_days_between            (const GDate *date1, const GDate *date2);

Computes the number of days between two dates. If date2 is prior to date1, the returned value is negative. Both dates must be valid.

g_date_compare ()

gint        g_date_compare                 (const GDate *lhs, const GDate *rhs);

qsort()-style comparsion function for dates. Both dates must be valid.

g_date_clamp ()

void        g_date_clamp                   (GDate *date, const GDate *min_date, const GDate *max_date);

If date is prior to min_date, sets date equal to min_date. If date falls after max_date, sets date equal to max_date. Either min_date and max_date may be NULL. All non-NULL dates must be valid.

g_date_order ()

void        g_date_order                   (GDate *date1, GDate *date2);

Checks if date1 is less than or equal to date2, and swap the values if this is not the case.

g_date_get_day ()

GDateDay    g_date_get_day                 (const GDate *date);

Returns the day of the month. The date must be valid.

g_date_get_month ()

GDateMonth  g_date_get_month               (const GDate *date);

Returns the month of the year. The date must be valid.

g_date_get_year ()

GDateYear   g_date_get_year                (const GDate *date);

Returns the year of a GDate. The date must be valid.

g_date_get_julian ()

guint32     g_date_get_julian              (const GDate *date);

Returns the Julian day or "serial number" of the GDate. The Julian day is simply the number of days since January 1, Year 1; i.e., January 1, Year 1 is Julian day 1; January 2, Year 1 is Julian day 2, etc. The date must be valid.

g_date_get_weekday ()

GDateWeekday g_date_get_weekday            (const GDate *date);

Returns the day of the week for a GDate. The date must be valid.

g_date_get_day_of_year ()

guint       g_date_get_day_of_year         (const GDate *date);

Returns the day of the year, where Jan 1 is the first day of the year. The date must be valid.

g_date_get_days_in_month ()

guint8      g_date_get_days_in_month       (GDateMonth month, GDateYear year);

Returns the number of days in a month, taking leap years into account.

g_date_is_first_of_month ()

gboolean    g_date_is_first_of_month       (const GDate *date);

Returns TRUE if the date is on the first of a month. The date must be valid.

g_date_is_last_of_month ()

gboolean    g_date_is_last_of_month        (const GDate *date);

Returns TRUE if the date is the last day of the month. The date must be valid.

g_date_is_leap_year ()

gboolean    g_date_is_leap_year             (GDateYear year);

Returns TRUE if the year is a leap year.

g_date_get_monday_week_of_year ()

guint       g_date_get_monday_week_of_year  (const GDate *date);

Returns the week of the year, where weeks are understood to start on Monday. If the date is before the first Monday of the year, return 0. The date must be valid.

g_date_get_monday_weeks_in_year ()

guint8      g_date_get_monday_weeks_in_year (GDateYear year);

Returns the number of weeks in the year, where weeks are taken to start on Monday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap year. This function is basically tells how many Mondays are in the year, i.e. there are 53 Mondays if one of the extra days happens to be a Monday.)

g_date_get_sunday_week_of_year ()

guint       g_date_get_sunday_week_of_year  (const GDate *date);

Returns the week of the year during which this date falls, if weeks are understood to being on Sunday. The date must be valid. Can return 0 if the day is before the first Sunday of the year.

g_date_get_sunday_weeks_in_year ()

guint8      g_date_get_sunday_weeks_in_year (GDateYear year);

Returns the number of weeks in the year, where weeks are taken to start on Sunday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it is a leap year. This function is basically tells how many Sundays are in the year, i.e. there are 53 Sundays if one of the extra days happens to be a Sunday.)

g_date_get_iso8601_week_of_year ()

guint       g_date_get_iso8601_week_of_year (const GDate *date);

Returns the week of the year, where weeks are interpreted according to ISO 8601.

g_date_strftime ()

gsize       g_date_strftime           (gchar *s, gsize slen, const gchar *format, const GDate *date);

Generates a printed representation of the date, in a locale-specific way. Works just like the standard C strftime() function, but only accepts date-related formats; time-related formats give undefined results. Date must be valid.

g_date_to_struct_tm ()

void        g_date_to_struct_tm       (const GDate *date, struct tm *tm);

Fills in the date-related bits of a struct tm using the date value. Initializes the non-date parts with something sane but meaningless.

g_date_valid ()

gboolean    g_date_valid              (const GDate *date);

Returns TRUE if the GDate represents an existing day. The date must not contain garbage; it should have been initialized with g_date_clear() if it was not allocated by one of the g_date_new() variants.

g_date_valid_day ()

gboolean    g_date_valid_day          (GDateDay day);

Returns TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive).

g_date_valid_month ()

gboolean    g_date_valid_month        (GDateMonth month);

Returns TRUE if the month value is valid. The 12 GDateMonth enumeration values are the only valid months.

g_date_valid_year ()

gboolean    g_date_valid_year         (GDateYear year);

Returns TRUE if the year is valid. Any year greater than 0 is valid, though there is a 16-bit limit to what GDate will understand.

g_date_valid_dmy ()

gboolean    g_date_valid_dmy          (GDateDay day, GDateMonth month, GDateYear year);

Returns TRUE if the day-month-year triplet forms a valid, existing day in the range of days GDate understands (Year 1 or later, no more than a few thousand years in the future).

g_date_valid_julian ()

gboolean    g_date_valid_julian        (guint32 julian_date);

Returns TRUE if the Julian day is valid. Anything greater than zero is basically a valid Julian, though there is a 32-bit limit.

g_date_valid_weekday ()

gboolean    g_date_valid_weekday       (GDateWeekday weekday);

Returns TRUE if the weekday is valid. The 7 GDateWeekday enumeration values are the only valid weekdays.