Gjsify LogoGjsify Logo

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's declared on the stack, it will contain garbage so must be initialized with g_date_clear(). g_date_clear() makes the date invalid but safe. An invalid date doesn't represent a day, it's "empty." A date becomes valid after you set it to a Julian day or you set a day, month, and year.

record

Hierarchy

  • Date

Index

Constructors

  • Allocates a #GDate and initializes it to a safe 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 GLib.Date

Properties

day: number

the day of the day-month-year representation of the date, as a number between 1 and 31

field
dmy: number

this is set if day, month and year are valid

field
julian: number

this bit is set if julian_days is valid

field
julian_days: number

the Julian representation of the date

field
month: number

the day of the day-month-year representation of the date, as a number between 1 and 12

field
year: number

the day of the day-month-year representation of the date

field
name: string

Methods

  • add_days(n_days: number): void
  • Increments a date some number of days. To move forward by weeks, add weeks*7 days. The date must be valid.

    Parameters

    • n_days: number

      number of days to move the date forward

    Returns void

  • add_months(n_months: number): void
  • 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.

    Parameters

    • n_months: number

      number of months to move forward

    Returns void

  • add_years(n_years: number): void
  • 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.

    Parameters

    • n_years: number

      number of years to move forward

    Returns void

  • 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. Otherwise, date is unchanged. Either of min_date and max_date may be %NULL. All non-%NULL dates must be valid.

    Parameters

    • min_date: GLib.Date

      minimum accepted value for date

    • max_date: GLib.Date

      maximum accepted value for date

    Returns void

  • clear(n_dates: number): void
  • Initializes one or more #GDate structs to a safe 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().

    Parameters

    • n_dates: number

      number of dates to clear

    Returns void

  • Copies a GDate to a newly-allocated GDate. If the input was invalid (as determined by g_date_valid()), the invalid state will be copied as is into the new object.

    Returns GLib.Date

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

    Parameters

    Returns number

  • free(): void
  • get_day(): number
  • get_day_of_year(): number
  • Returns the day of the year, where Jan 1 is the first day of the year. The date must be valid.

    Returns number

  • get_iso8601_week_of_year(): number
  • get_julian(): number
  • 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.

    Returns number

  • get_monday_week_of_year(): number
  • 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.

    Returns number

  • get_sunday_week_of_year(): number
  • Returns the week of the year during which this date falls, if weeks are understood to begin on Sunday. The date must be valid. Can return 0 if the day is before the first Sunday of the year.

    Returns number

  • get_year(): number
  • is_first_of_month(): boolean
  • is_last_of_month(): boolean
  • Checks if date1 is less than or equal to date2, and swap the values if this is not the case.

    Parameters

    Returns void

  • set_day(day: number): void
  • Sets the day of the month for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.

    Parameters

    • day: number

      day to set

    Returns void

  • set_dmy(day: number, month: DateMonth, y: number): void
  • 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.

    Parameters

    • day: number

      day

    • month: DateMonth

      month

    • y: number

      year

    Returns void

  • set_julian(julian_date: number): void
  • Sets the value of a #GDate from a Julian day number.

    Parameters

    • julian_date: number

      Julian day number (days since January 1, Year 1)

    Returns void

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

    Parameters

    Returns void

  • set_parse(str: string): void
  • Parses a user-inputted string str, and try to figure out what date it represents, taking the [current locale][setlocale] 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).

    Parameters

    • str: string

      string to parse

    Returns void

  • set_time(time_: number): void
  • Sets the value of a date from a #GTime value. The time to date conversion is done using the user's current timezone.

    Parameters

    • time_: number

      #GTime value to set.

    Returns void

  • set_time_t(timet: number): void
  • Sets the value of a date to the date corresponding to a time specified as a time_t. The time to date conversion is done using the user's current timezone.

    To set the value of a date to the current day, you could write:

     time_t now = time (NULL);
    if (now == (time_t) -1)
    // handle the error
    g_date_set_time_t (date, now);

    Parameters

    • timet: number

      time_t value to set

    Returns void

  • set_time_val(timeval: TimeVal): void
  • 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.

    The time to date conversion is done using the user's current timezone.

    Parameters

    • timeval: TimeVal

      #GTimeVal value to set

    Returns void

  • set_year(year: number): void
  • Sets the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.

    Parameters

    • year: number

      year to set

    Returns void

  • subtract_days(n_days: number): void
  • 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.

    Parameters

    • n_days: number

      number of days to move

    Returns void

  • subtract_months(n_months: number): void
  • 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.

    Parameters

    • n_months: number

      number of months to move

    Returns void

  • subtract_years(n_years: number): void
  • 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.

    Parameters

    • n_years: number

      number of years to move

    Returns void

  • to_struct_tm(tm: object): void
  • Fills in the date-related bits of a struct tm using the date value. Initializes the non-date parts with something safe but meaningless.

    Parameters

    • tm: object

      struct tm to fill

    Returns void

  • valid(): boolean
  • 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.

    Returns boolean

  • get_days_in_month(month: DateMonth, year: number): number
  • get_monday_weeks_in_year(year: number): number
  • 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.)

    Parameters

    • year: number

      a year

    Returns number

  • get_sunday_weeks_in_year(year: number): number
  • 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.)

    Parameters

    • year: number

      year to count weeks in

    Returns number

  • is_leap_year(year: number): boolean
  • Returns %TRUE if the year is a leap year.

    For the purposes of this function, leap year is every year divisible by 4 unless that year is divisible by 100. If it is divisible by 100 it would be a leap year only if that year is also divisible by 400.

    Parameters

    • year: number

      year to check

    Returns boolean

  • Allocates a #GDate and initializes it to a safe 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 GLib.Date

  • Create a new #GDate representing the given day-month-year triplet.

    The triplet you pass in must represent a valid date. Use g_date_valid_dmy() if needed to validate it. The returned #GDate is guaranteed to be non-%NULL and valid.

    Parameters

    • day: number

      day of the month

    • month: DateMonth

      month of the year

    • year: number

      year

    Returns GLib.Date

  • new_julian(julian_day: number): GLib.Date
  • Create a new #GDate representing the given Julian date.

    The julian_day you pass in must be valid. Use g_date_valid_julian() if needed to validate it. The returned #GDate is guaranteed to be non-%NULL and valid.

    Parameters

    • julian_day: number

      days since January 1, Year 1

    Returns GLib.Date

  • strftime(s: string, slen: number, format: string, date: GLib.Date): number
  • Generates a printed representation of the date, in a [locale][setlocale]-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.

    Parameters

    • s: string

      destination buffer

    • slen: number

      buffer size

    • format: string

      format string

    • date: GLib.Date

      valid #GDate

    Returns number

  • valid_day(day: number): boolean
  • Returns %TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive).

    Parameters

    • day: number

      day to check

    Returns boolean

  • valid_dmy(day: number, month: DateMonth, year: number): boolean
  • 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).

    Parameters

    • day: number

      day

    • month: DateMonth

      month

    • year: number

      year

    Returns boolean

  • valid_julian(julian_date: number): boolean
  • Returns %TRUE if the Julian day is valid. Anything greater than zero is basically a valid Julian, though there is a 32-bit limit.

    Parameters

    • julian_date: number

      Julian day to check

    Returns boolean

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

    Parameters

    Returns boolean

  • Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration values are the only valid weekdays.

    Parameters

    Returns boolean

  • valid_year(year: number): boolean
  • 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.

    Parameters

    • year: number

      year

    Returns boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method