glib.Date.Date Class Reference

List of all members.

Detailed Description

Description The GDate data structure represents a day between January 1, Year 1, and sometime a few thousand years in the future (right now it will go to the year 65535 or so, but g_date_set_parse() only parses up to the year 8000 or so - just count on "a few thousand").

GDate is meant to represent everyday dates, not astronomical dates or historical dates or ISO timestamps or the like. It extrapolates the current Gregorian calendar forward and backward in time; there is no attempt to change the calendar to match time periods or locations. GDate does not store time information; it represents a day. The GDate implementation has several nice features; it is only a 64-bit struct, so storing large numbers of dates is very efficient. It can keep both a Julian and day-month-year representation of the date, since some calculations are much easier with one representation or the other. A Julian representation is simply a count of days since some fixed day in the past; for GDate the fixed day is January 1, 1 AD. ("Julian" dates in the GDate API aren't really Julian dates in the technical sense; technically, Julian dates count from the start of the Julian period, Jan 1, 4713 BC). GDate is simple to use. First you need a "blank" date; you can get a dynamically allocated date from g_date_new(), or you can declare an automatic variable or array and initialize it to a sane state by calling g_date_clear(). A cleared date is sane; it's safe to call g_date_set_dmy() and the other mutator functions to initialize the value of a cleared date. However, a cleared date is initially invalid, meaning that it doesn't represent a day that exists. It is undefined to call any of the date calculation routines on an invalid date. If you obtain a date from a user or other unpredictable source, you should check its validity with the g_date_valid() predicate. g_date_valid() is also used to check for errors with g_date_set_parse() and other functions that can fail. Dates can be invalidated by calling g_date_clear() again. It is very important to use the API to access the GDate struct. Often only the day-month-year or only the Julian representation is valid. Sometimes neither is valid. Use the API. GLib doesn't contain any time-manipulation functions; however, there is a GTime typedef and a GTimeVal struct which represents a more precise time (with microseconds). You can request the current time as a GTimeVal with g_get_current_time().


Public Member Functions

GDategetDateStruct ()
 this (GDate *gDate)
 Sets our main struct and passes it to the parent class.
 this ()
 Allocates a GDate and initializes it to a sane state.
 this (GDateDay day, GDateMonth month, GDateYear year)
 Like g_date_new(), but also sets the value of the date.
 this (uint julianDay)
 Like g_date_new(), but also sets the value of the date.
void clear (uint nDates)
 Initializes one or more GDate structs to a sane but invalid state.
void free ()
 Frees a GDate returned from g_date_new().
void setDay (GDateDay day)
 Sets the day of the month for a GDate.
void setMonth (GDateMonth month)
 Sets the month of the year for a GDate.
void setYear (GDateYear year)
 Sets the year for a GDate.
void setDmy (GDateDay day, GDateMonth month, GDateYear y)
 Sets the value of a GDate from a day, month, and year.
void setJulian (uint julianDate)
 Sets the value of a GDate from a Julian day number.
void setTime (GTime time)
 Warning g_date_set_time is deprecated and should not be used in newly-written code.
void setTimeT (uint timet)
 Sets the value of a date from a time_t value.
void setTimeVal (GTimeVal *timeval)
 Sets the value of a date from a GTimeVal value.
void setParse (char[] str)
 Parses a user-inputted string str, and try to figure out what date it represents, taking the current locale into account.
void addDays (uint nDays)
 Increments a date some number of days.
void subtractDays (uint nDays)
 Moves a date some number of days into the past.
void addMonths (uint nMonths)
 Increments a date by some number of months.
void subtractMonths (uint nMonths)
 Moves a date some number of months into the past.
void addYears (uint nYears)
 Increments a date by some number of years.
void subtractYears (uint nYears)
 Moves a date some number of years into the past.
int daysBetween (Date date2)
 Computes the number of days between two dates.
int compare (Date rhs)
 qsort()-style comparsion function for dates.
void clamp (Date minDate, Date maxDate)
 If date is prior to min_date, sets date equal to min_date.
void order (Date date2)
 Checks if date1 is less than or equal to date2, and swap the values if this is not the case.
GDateDay getDay ()
 Returns the day of the month.
GDateMonth getMonth ()
 Returns the month of the year.
GDateYear getYear ()
 Returns the year of a GDate.
uint getJulian ()
 Returns the Julian day or "serial number" of the GDate.
GDateWeekday getWeekday ()
 Returns the day of the week for a GDate.
uint getDayOfYear ()
 Returns the day of the year, where Jan 1 is the first day of the year.
int isFirstOfMonth ()
 Returns TRUE if the date is on the first of a month.
int isLastOfMonth ()
 Returns TRUE if the date is the last day of the month.
uint getMondayWeekOfYear ()
 Returns the week of the year, where weeks are understood to start on Monday.
uint getSundayWeekOfYear ()
 Returns the week of the year during which this date falls, if weeks are understood to being on Sunday.
uint getIso8601_WeekOfYear ()
 Returns the week of the year, where weeks are interpreted according to ISO 8601.
void toStructTm (void *tm)
 Fills in the date-related bits of a struct tm using the date value.
int valid ()
 Returns TRUE if the GDate represents an existing day.

Static Public Member Functions

static void gGetCurrentTime (GTimeVal *result)
 Equivalent to the UNIX gettimeofday() function, but portable.
static void gUsleep (uint microseconds)
 Pauses the current thread for the given number of microseconds.
static void gTimeValAdd (GTimeVal *time, int microseconds)
 Adds the given number of microseconds to time_.
static int gTimeValFromIso8601 (char[] isoDate, GTimeVal *time)
 Converts a string containing an ISO 8601 encoded date and time to a GTimeVal and puts it into time_.
static char[] gTimeValToIso8601 (GTimeVal *time)
 Converts time_ into a ISO 8601 encoded string, relative to the Coordinated Universal Time (UTC).
static byte getDaysInMonth (GDateMonth month, GDateYear year)
 Returns the number of days in a month, taking leap years into account.
static int isLeapYear (GDateYear year)
 Returns TRUE if the year is a leap year.
static byte getMondayWeeksInYear (GDateYear year)
 Returns the number of weeks in the year, where weeks are taken to start on Monday.
static byte getSundayWeeksInYear (GDateYear year)
 Returns the number of weeks in the year, where weeks are taken to start on Sunday.
static uint strftime (char[] s, uint slen, char[] format, Date date)
 Generates a printed representation of the date, in a locale-specific way.
static int validDay (GDateDay day)
 Returns TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive).
static int validMonth (GDateMonth month)
 Returns TRUE if the month value is valid.
static int validYear (GDateYear year)
 Returns TRUE if the year is valid.
static int validDmy (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).
static int validJulian (uint julianDate)
 Returns TRUE if the Julian day is valid.
static int validWeekday (GDateWeekday weekday)
 Returns TRUE if the weekday is valid.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

GDategDate
 the main Gtk struct


Constructor & Destructor Documentation

glib.Date.Date.this ( GDate gDate  ) 

Sets our main struct and passes it to the parent class.

glib.Date.Date.this (  ) 

Allocates a GDate and initializes it to a sane state.

The new date will be cleared (as if you'd called g_date_clear()) but invalid (it won't represent an existing day). Free the return value with g_date_free(). Returns: a newly-allocated GDate.

glib.Date.Date.this ( GDateDay  day,
GDateMonth  month,
GDateYear  year 
)

Like g_date_new(), but also sets the value of the date.

Assuming the day-month-year triplet you pass in represents an existing day, the returned date will be valid. day: day of the month. month: month of the year. year: year Returns: a newly-allocated GDate initialized with day, month, and year.

glib.Date.Date.this ( uint  julianDay  ) 

Like g_date_new(), but also sets the value of the date.

Assuming the Julian day number you pass in is valid (greater than 0, less than an unreasonably large number), the returned date will be valid. julian_day: days since January 1, Year 1. Returns: a newly-allocated GDate initialized with julian_day.


Member Function Documentation

void glib.Date.Date.addDays ( uint  nDays  ) 

Increments a date some number of days.

To move forward by weeks, add weeks*7 days. The date must be valid. date: a GDate to increment. n_days: number of days to move the date forward.

void glib.Date.Date.addMonths ( uint  nMonths  ) 

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. date: a GDate to increment. n_months: number of months to move forward.

void glib.Date.Date.addYears ( uint  nYears  ) 

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. date: a GDate to increment. n_years: number of years to move forward.

void glib.Date.Date.clamp ( Date  minDate,
Date  maxDate 
)

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. date: a GDate to clamp. min_date: minimum accepted value for date. max_date: maximum accepted value for date.

void glib.Date.Date.clear ( uint  nDates  ) 

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(). date: pointer to one or more dates to clear. n_dates: number of dates to clear.

int glib.Date.Date.compare ( Date  rhs  ) 

qsort()-style comparsion function for dates.

Both dates must be valid. lhs: first date to compare. rhs: second date to compare. Returns: 0 for equal, less than zero if lhs is less than rhs, greater than zero if lhs is greater than rhs.

int glib.Date.Date.daysBetween ( Date  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. date1: the first date. date2: the second date. Returns: the number of days between date1 and date2.

void glib.Date.Date.free (  ) 

Frees a GDate returned from g_date_new().

date: a GDate.

GDate* glib.Date.Date.getDateStruct (  ) 

GDateDay glib.Date.Date.getDay (  ) 

Returns the day of the month.

The date must be valid. date: a GDate to extract the day of the month from. Returns: day of the month.

uint glib.Date.Date.getDayOfYear (  ) 

Returns the day of the year, where Jan 1 is the first day of the year.

The date must be valid. date: a GDate to extract day of year from. Returns: day of the year.

static byte glib.Date.Date.getDaysInMonth ( GDateMonth  month,
GDateYear  year 
) [static]

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

month: month. year: year. Returns: number of days in month during the year.

uint glib.Date.Date.getIso8601_WeekOfYear (  ) 

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

date: a valid GDate Returns: ISO 8601 week number of the year. Since 2.6

uint glib.Date.Date.getJulian (  ) 

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. date: a GDate to extract the Julian day from. Returns: Julian day.

uint glib.Date.Date.getMondayWeekOfYear (  ) 

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. date: a GDate. Returns: week of the year.

static byte glib.Date.Date.getMondayWeeksInYear ( GDateYear  year  )  [static]

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 telling you how many Mondays are in the year, i.e. there are 53 Mondays if one of the extra days happens to be a Monday.) year: a year. Returns: number of Mondays in the year.

GDateMonth glib.Date.Date.getMonth (  ) 

Returns the month of the year.

The date must be valid. date: a GDate to get the month from. Returns: month of the year as a GDateMonth.

void* glib.Date.Date.getStruct (  )  [protected]

the main Gtk struct as a void*

uint glib.Date.Date.getSundayWeekOfYear (  ) 

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. date: a GDate. Returns: week number.

static byte glib.Date.Date.getSundayWeeksInYear ( GDateYear  year  )  [static]

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's a leap year. This function is basically telling you how many Sundays are in the year, i.e. there are 53 Sundays if one of the extra days happens to be a Sunday.) year: year to count weeks in. Returns: number of weeks.

GDateWeekday glib.Date.Date.getWeekday (  ) 

Returns the day of the week for a GDate.

The date must be valid. date: a GDate. Returns: day of the week as a GDateWeekday.

GDateYear glib.Date.Date.getYear (  ) 

Returns the year of a GDate.

The date must be valid. date: a GDate. Returns: year in which the date falls.

static void glib.Date.Date.gGetCurrentTime ( GTimeVal result  )  [static]

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

result: GTimeVal structure in which to store current time.

static void glib.Date.Date.gTimeValAdd ( GTimeVal time,
int  microseconds 
) [static]

Adds the given number of microseconds to time_.

microseconds can also be negative to decrease the value of time_. time_: a GTimeVal microseconds: number of microseconds to add to time

static int glib.Date.Date.gTimeValFromIso8601 ( char[]  isoDate,
GTimeVal time 
) [static]

Converts a string containing an ISO 8601 encoded date and time to a GTimeVal and puts it into time_.

iso_date: a ISO 8601 encoded date string time_: a GTimeVal Returns: TRUE if the conversion was successful. Since 2.12

static char [] glib.Date.Date.gTimeValToIso8601 ( GTimeVal time  )  [static]

Converts time_ into a ISO 8601 encoded string, relative to the Coordinated Universal Time (UTC).

time_: a GTimeVal Returns: a newly allocated string containing a ISO 8601 date Since 2.12

static void glib.Date.Date.gUsleep ( uint  microseconds  )  [static]

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; don't rely on the exact length of the sleep. microseconds: number of microseconds to pause.

int glib.Date.Date.isFirstOfMonth (  ) 

Returns TRUE if the date is on the first of a month.

The date must be valid. date: a GDate to check. Returns: TRUE if the date is the first of the month.

int glib.Date.Date.isLastOfMonth (  ) 

Returns TRUE if the date is the last day of the month.

The date must be valid. date: a GDate to check. Returns: TRUE if the date is the last day of the month.

static int glib.Date.Date.isLeapYear ( GDateYear  year  )  [static]

Returns TRUE if the year is a leap year.

year: year to check. Returns: TRUE if the year is a leap year.

void glib.Date.Date.order ( Date  date2  ) 

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

date1: the first date. date2: the second date.

void glib.Date.Date.setDay ( 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. date: a GDate. day: day to set.

void glib.Date.Date.setDmy ( 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 you aren't sure it is, call g_date_valid_dmy() to check before you set it. date: a GDate. day: day. month: month. y: year.

void glib.Date.Date.setJulian ( uint  julianDate  ) 

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

date: a GDate. julian_date: Julian day number (days since January 1, Year 1).

void glib.Date.Date.setMonth ( 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. date: a GDate. month: month to set.

void glib.Date.Date.setParse ( char[]  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. You should check using g_date_valid() to see whether the parsing succeeded. This function is not appropriate for file formats and the like; it isn't very precise, and its exact behavior varies with the locale. It's 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). date: a GDate to fill in. str: string to parse.

void glib.Date.Date.setTime ( GTime  time  ) 

Warning g_date_set_time is deprecated and should not be used in newly-written code.

Sets the value of a date from a GTime value. Deprecated:2.10: Use g_date_set_time_t() instead. date: a GDate. time_: GTime value to set.

void glib.Date.Date.setTimeT ( uint  timet  ) 

Sets the value of a date from a time_t value.

To set the value of a date to the current day, you could write: g_date_set_time_t (date, time (NULL)); date: a GDate timet: time_t value to set Since 2.10

void glib.Date.Date.setTimeVal ( GTimeVal timeval  ) 

Sets the value of a date from a GTimeVal value.

Note that the tv_usec member is ignored, because GDate can't make use of the additional precision. date: a GDate timeval: GTimeVal value to set Since 2.10

void glib.Date.Date.setYear ( GDateYear  year  ) 

Sets the year for a GDate.

If the resulting day-month-year triplet is invalid, the date will be invalid. date: a GDate. year: year to set.

static uint glib.Date.Date.strftime ( char[]  s,
uint  slen,
char[]  format,
Date  date 
) [static]

Generates a printed representation of the date, in a locale-specific way.

Works just like the platform's C library strftime() function, but only accepts date-related formats; time-related formats give undefined results. Date must be valid. Unlike strftime() (which uses the locale encoding), works on a UTF-8 format string and stores a UTF-8 result. This function does not provide any conversion specifiers in addition to those implemented by the platform's C library. For example, don't expect that using g_date_strftime() would make the F provided by the C99 strftime() work on Windows where the C library only complies to C89. s: destination buffer. slen: buffer size. format: format string. date: valid GDate. Returns: number of characters written to the buffer, or 0 the buffer was too small.

void glib.Date.Date.subtractDays ( uint  nDays  ) 

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. date: a GDate to decrement. n_days: number of days to move.

void glib.Date.Date.subtractMonths ( uint  nMonths  ) 

Moves a date some number of months into the past.

If the current day of the month doesn't exist in the destination month, the day of the month may change. The date must be valid. date: a GDate to decrement. n_months: number of months to move.

void glib.Date.Date.subtractYears ( uint  nYears  ) 

Moves a date some number of years into the past.

If the current day doesn't exist in the destination year (i.e. it's February 29 and you move to a non-leap-year) then the day is changed to February 29. The date must be valid. date: a GDate to decrement. n_years: number of years to move.

void glib.Date.Date.toStructTm ( void *  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. date: a GDate to set the struct tm from. tm: struct tm to fill.

int glib.Date.Date.valid (  ) 

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 wasn't allocated by one of the g_date_new() variants. date: a GDate to check. Returns: Whether the date is valid.

static int glib.Date.Date.validDay ( GDateDay  day  )  [static]

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

day: day to check. Returns: TRUE if the day is valid.

static int glib.Date.Date.validDmy ( GDateDay  day,
GDateMonth  month,
GDateYear  year 
) [static]

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).

day: day. month: month. year: year. Returns: TRUE if the date is a valid one.

static int glib.Date.Date.validJulian ( uint  julianDate  )  [static]

Returns TRUE if the Julian day is valid.

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

static int glib.Date.Date.validMonth ( GDateMonth  month  )  [static]

Returns TRUE if the month value is valid.

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

static int glib.Date.Date.validWeekday ( GDateWeekday  weekday  )  [static]

Returns TRUE if the weekday is valid.

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

static int glib.Date.Date.validYear ( GDateYear  year  )  [static]

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. year: year. Returns: TRUE if the year is valid.


Member Data Documentation

GDate* glib.Date.Date.gDate [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo