Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Date::Calc.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CALC 1"
.TH CALC 1 "2002-09-28" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
Date::Calc \- Gregorian calendar date calculations
.SH "MOTTO"
.IX Header "MOTTO"
Keep it small, fast and simple
.SH "PREFACE"
.IX Header "PREFACE"
This package consists of a C library and a Perl module (which uses
the C library, internally) for all kinds of date calculations based
on the Gregorian calendar (the one used in all western countries today),
thereby complying with all relevant norms and standards: \s-1ISO/R\s0\ 2015\-1971,
\&\s-1DIN\s0\ 1355 and, to some extent, \s-1ISO\s0\ 8601 (where applicable).
.PP
(See also http://www.engelschall.com/u/sb/download/Date\-Calc/DIN1355/
for a scan of part of the "\s-1DIN\s0\ 1355" document (in German)).
.PP
The module of course handles year numbers of 2000 and above correctly
(\*(L"Year 2000\*(R" or \*(L"Y2K\*(R" compliance) \*(-- actually all year numbers from 1
to the largest positive integer representable on your system (which
is at least 32767) can be dealt with.
.PP
This is not true, however, for the import/export functions in this
package which are an interface to the internal \s-1POSIX\s0 date and time
functions of your system, which can only cover dates in the following
ranges:
.PP
.Vb 3
\& 01-Jan-1970 00:00:00 GMT .. 19-Jan-2038 03:14:07 GMT [Unix etc.]
\& 01-Jan-1904 00:00:00 LT  .. 06-Feb-2040 06:28:15 LT  [MacOS Classic]
\& (LT = local time)
.Ve
.PP
Note that this package projects the Gregorian calendar back until the
year 1\ A.D. \*(-- even though the Gregorian calendar was only adopted
in 1582, mostly by the Catholic European countries, in obedience to the
corresponding decree of Pope Gregory\ \s-1XIII\s0 in that year.
.PP
Some (mainly protestant) countries continued to use the Julian calendar
(used until then) until as late as the beginning of the 20th century.
.PP
Finally, note that this package is not intended to do everything you could
ever imagine automagically for you; it is rather intended to serve as a
toolbox (in the best of \s-1UNIX\s0 spirit and traditions) which should, however,
always get you where you want to go.
.PP
See the section \*(L"\s-1RECIPES\s0\*(R" at the bottom of this document for solutions
to common problems!
.PP
If nevertheless you can't figure out how to solve a particular problem,
please let me know! (See e\-mail address at the end of this document.)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 66
\&  use Date::Calc qw(
\&      Days_in_Year
\&      Days_in_Month
\&      Weeks_in_Year
\&      leap_year
\&      check_date
\&      check_time
\&      check_business_date
\&      Day_of_Year
\&      Date_to_Days
\&      Day_of_Week
\&      Week_Number
\&      Week_of_Year
\&      Monday_of_Week
\&      Nth_Weekday_of_Month_Year
\&      Standard_to_Business
\&      Business_to_Standard
\&      Delta_Days
\&      Delta_DHMS
\&      Delta_YMD
\&      Delta_YMDHMS
\&      Normalize_DHMS
\&      Add_Delta_Days
\&      Add_Delta_DHMS
\&      Add_Delta_YM
\&      Add_Delta_YMD
\&      Add_Delta_YMDHMS
\&      System_Clock
\&      Today
\&      Now
\&      Today_and_Now
\&      This_Year
\&      Gmtime
\&      Localtime
\&      Mktime
\&      Timezone
\&      Date_to_Time
\&      Time_to_Date
\&      Easter_Sunday
\&      Decode_Month
\&      Decode_Day_of_Week
\&      Decode_Language
\&      Decode_Date_EU
\&      Decode_Date_US
\&      Fixed_Window
\&      Moving_Window
\&      Compress
\&      Uncompress
\&      check_compressed
\&      Compressed_to_Text
\&      Date_to_Text
\&      Date_to_Text_Long
\&      English_Ordinal
\&      Calendar
\&      Month_to_Text
\&      Day_of_Week_to_Text
\&      Day_of_Week_Abbreviation
\&      Language_to_Text
\&      Language
\&      Languages
\&      Decode_Date_EU2
\&      Decode_Date_US2
\&      Parse_Date
\&      ISO_LC
\&      ISO_UC
\&  );
.Ve
.PP
.Vb 1
\&  use Date::Calc qw(:all);
.Ve
.PP
.Vb 2
\&  Days_in_Year
\&      $days = Days_in_Year($year,$month);
.Ve
.PP
.Vb 2
\&  Days_in_Month
\&      $days = Days_in_Month($year,$month);
.Ve
.PP
.Vb 2
\&  Weeks_in_Year
\&      $weeks = Weeks_in_Year($year);
.Ve
.PP
.Vb 2
\&  leap_year
\&      if (leap_year($year))
.Ve
.PP
.Vb 2
\&  check_date
\&      if (check_date($year,$month,$day))
.Ve
.PP
.Vb 2
\&  check_time
\&      if (check_time($hour,$min,$sec))
.Ve
.PP
.Vb 2
\&  check_business_date
\&      if (check_business_date($year,$week,$dow))
.Ve
.PP
.Vb 2
\&  Day_of_Year
\&      $doy = Day_of_Year($year,$month,$day);
.Ve
.PP
.Vb 2
\&  Date_to_Days
\&      $days = Date_to_Days($year,$month,$day);
.Ve
.PP
.Vb 2
\&  Day_of_Week
\&      $dow = Day_of_Week($year,$month,$day);
.Ve
.PP
.Vb 2
\&  Week_Number
\&      $week = Week_Number($year,$month,$day);          # DEPRECATED
.Ve
.PP
.Vb 3
\&  Week_of_Year
\&      ($week,$year) = Week_of_Year($year,$month,$day); # RECOMMENDED
\&      $week = Week_of_Year($year,$month,$day);         # DANGEROUS
.Ve
.PP
.Vb 2
\&  Monday_of_Week
\&      ($year,$month,$day) = Monday_of_Week($week,$year);
.Ve
.PP
.Vb 3
\&  Nth_Weekday_of_Month_Year
\&      if (($year,$month,$day) =
\&      Nth_Weekday_of_Month_Year($year,$month,$dow,$n))
.Ve
.PP
.Vb 3
\&  Standard_to_Business
\&      ($year,$week,$dow) =
\&      Standard_to_Business($year,$month,$day);
.Ve
.PP
.Vb 3
\&  Business_to_Standard
\&      ($year,$month,$day) =
\&      Business_to_Standard($year,$week,$dow);
.Ve
.PP
.Vb 3
\&  Delta_Days
\&      $Dd = Delta_Days($year1,$month1,$day1,
\&                       $year2,$month2,$day2);
.Ve
.PP
.Vb 4
\&  Delta_DHMS
\&      ($Dd,$Dh,$Dm,$Ds) =
\&      Delta_DHMS($year1,$month1,$day1, $hour1,$min1,$sec1,
\&                 $year2,$month2,$day2, $hour2,$min2,$sec2);
.Ve
.PP
.Vb 4
\&  Delta_YMD
\&      ($Dy,$Dm,$Dd) =
\&      Delta_YMD($year1,$month1,$day1,
\&                $year2,$month2,$day2);
.Ve
.PP
.Vb 4
\&  Delta_YMDHMS
\&      ($D_y,$D_m,$D_d, $Dh,$Dm,$Ds) =
\&      Delta_YMDHMS($year1,$month1,$day1, $hour1,$min1,$sec1,
\&                   $year2,$month2,$day2, $hour2,$min2,$sec2);
.Ve
.PP
.Vb 3
\&  Normalize_DHMS
\&      ($Dd,$Dh,$Dm,$Ds) =
\&      Normalize_DHMS($Dd,$Dh,$Dm,$Ds);
.Ve
.PP
.Vb 4
\&  Add_Delta_Days
\&      ($year,$month,$day) =
\&      Add_Delta_Days($year,$month,$day,
\&                     $Dd);
.Ve
.PP
.Vb 4
\&  Add_Delta_DHMS
\&      ($year,$month,$day, $hour,$min,$sec) =
\&      Add_Delta_DHMS($year,$month,$day, $hour,$min,$sec,
\&                     $Dd,$Dh,$Dm,$Ds);
.Ve
.PP
.Vb 4
\&  Add_Delta_YM
\&      ($year,$month,$day) =
\&      Add_Delta_YM($year,$month,$day,
\&                   $Dy,$Dm);
.Ve
.PP
.Vb 4
\&  Add_Delta_YMD
\&      ($year,$month,$day) =
\&      Add_Delta_YMD($year,$month,$day,
\&                    $Dy,$Dm,$Dd);
.Ve
.PP
.Vb 4
\&  Add_Delta_YMDHMS
\&      ($year,$month,$day, $hour,$min,$sec) =
\&      Add_Delta_YMDHMS($year,$month,$day, $hour,$min,$sec,
\&                       $D_y,$D_m,$D_d, $Dh,$Dm,$Ds);
.Ve
.PP
.Vb 3
\&  System_Clock
\&      ($year,$month,$day, $hour,$min,$sec, $doy,$dow,$dst) =
\&      System_Clock([$gmt]);
.Ve
.PP
.Vb 2
\&  Today
\&      ($year,$month,$day) = Today([$gmt]);
.Ve
.PP
.Vb 2
\&  Now
\&      ($hour,$min,$sec) = Now([$gmt]);
.Ve
.PP
.Vb 2
\&  Today_and_Now
\&      ($year,$month,$day, $hour,$min,$sec) = Today_and_Now([$gmt]);
.Ve
.PP
.Vb 2
\&  This_Year
\&      $year = This_Year([$gmt]);
.Ve
.PP
.Vb 3
\&  Gmtime
\&      ($year,$month,$day, $hour,$min,$sec, $doy,$dow,$dst) =
\&      Gmtime([time]);
.Ve
.PP
.Vb 3
\&  Localtime
\&      ($year,$month,$day, $hour,$min,$sec, $doy,$dow,$dst) =
\&      Localtime([time]);
.Ve
.PP
.Vb 2
\&  Mktime
\&      $time = Mktime($year,$month,$day, $hour,$min,$sec);
.Ve
.PP
.Vb 2
\&  Timezone
\&      ($D_y,$D_m,$D_d, $Dh,$Dm,$Ds, $dst) = Timezone([time]);
.Ve
.PP
.Vb 2
\&  Date_to_Time
\&      $time = Date_to_Time($year,$month,$day, $hour,$min,$sec);
.Ve
.PP
.Vb 2
\&  Time_to_Date
\&      ($year,$month,$day, $hour,$min,$sec) = Time_to_Date([time]);
.Ve
.PP
.Vb 2
\&  Easter_Sunday
\&      ($year,$month,$day) = Easter_Sunday($year);
.Ve
.PP
.Vb 2
\&  Decode_Month
\&      if ($month = Decode_Month($string))
.Ve
.PP
.Vb 2
\&  Decode_Day_of_Week
\&      if ($dow = Decode_Day_of_Week($string))
.Ve
.PP
.Vb 2
\&  Decode_Language
\&      if ($lang = Decode_Language($string))
.Ve
.PP
.Vb 2
\&  Decode_Date_EU
\&      if (($year,$month,$day) = Decode_Date_EU($string))
.Ve
.PP
.Vb 2
\&  Decode_Date_US
\&      if (($year,$month,$day) = Decode_Date_US($string))
.Ve
.PP
.Vb 2
\&  Fixed_Window
\&      $year = Fixed_Window($yy);
.Ve
.PP
.Vb 2
\&  Moving_Window
\&      $year = Moving_Window($yy);
.Ve
.PP
.Vb 2
\&  Compress
\&      $date = Compress($year,$month,$day);
.Ve
.PP
.Vb 2
\&  Uncompress
\&      if (($century,$year,$month,$day) = Uncompress($date))
.Ve
.PP
.Vb 2
\&  check_compressed
\&      if (check_compressed($date))
.Ve
.PP
.Vb 2
\&  Compressed_to_Text
\&      $string = Compressed_to_Text($date);
.Ve
.PP
.Vb 2
\&  Date_to_Text
\&      $string = Date_to_Text($year,$month,$day);
.Ve
.PP
.Vb 2
\&  Date_to_Text_Long
\&      $string = Date_to_Text_Long($year,$month,$day);
.Ve
.PP
.Vb 2
\&  English_Ordinal
\&      $string = English_Ordinal($number);
.Ve
.PP
.Vb 2
\&  Calendar
\&      $string = Calendar($year,$month[,$orthodox]);
.Ve
.PP
.Vb 2
\&  Month_to_Text
\&      $string = Month_to_Text($month);
.Ve
.PP
.Vb 2
\&  Day_of_Week_to_Text
\&      $string = Day_of_Week_to_Text($dow);
.Ve
.PP
.Vb 2
\&  Day_of_Week_Abbreviation
\&      $string = Day_of_Week_Abbreviation($dow);
.Ve
.PP
.Vb 2
\&  Language_to_Text
\&      $string = Language_to_Text($lang);
.Ve
.PP
.Vb 4
\&  Language
\&      $lang = Language();
\&      Language($lang);
\&      $oldlang = Language($newlang);
.Ve
.PP
.Vb 2
\&  Languages
\&      $max_lang = Languages();
.Ve
.PP
.Vb 2
\&  Decode_Date_EU2
\&      if (($year,$month,$day) = Decode_Date_EU2($string))
.Ve
.PP
.Vb 2
\&  Decode_Date_US2
\&      if (($year,$month,$day) = Decode_Date_US2($string))
.Ve
.PP
.Vb 2
\&  Parse_Date
\&      if (($year,$month,$day) = Parse_Date($string))
.Ve
.PP
.Vb 2
\&  ISO_LC
\&      $lower = ISO_LC($string);
.Ve
.PP
.Vb 2
\&  ISO_UC
\&      $upper = ISO_UC($string);
.Ve
.PP
.Vb 2
\&  Version
\&      $string = Date::Calc::Version();
.Ve
.SH "IMPORTANT NOTES"
.IX Header "IMPORTANT NOTES"
(See the section \*(L"\s-1RECIPES\s0\*(R" at the bottom of this document for
solutions to common problems!)
.IP "\(bu" 2
\&\*(L"Year 2000\*(R" (\*(L"Y2K\*(R") compliance
.Sp
The upper limit for any year number in this module is only given
by the size of the largest positive integer that can be represented
in a variable of the C type \*(L"int\*(R" on your system, which is at least
32767, according to the \s-1ANSI\s0 C standard (exceptions see below).
.Sp
In order to simplify calculations, this module projects the gregorian
calendar back until the year 1\ A.D. \*(-- i.e., back \fB\s-1BEYOND\s0\fR the
year 1582 when this calendar was first decreed by the Catholic Pope
Gregory\ \s-1XIII\s0!
.Sp
Therefore, \fB\s-1BE\s0 \s-1SURE\s0 \s-1TO\s0 \s-1ALWAYS\s0 \s-1SPECIFY\s0 \*(L"1998\*(R" \s-1WHEN\s0 \s-1YOU\s0 \s-1MEAN\s0 \*(L"1998\*(R"\fR,
for instance, and \fB\s-1DO\s0 \s-1NOT\s0 \s-1WRITE\s0 \*(L"98\*(R" \s-1INSTEAD\s0\fR, because this will
in fact perform a calculation based on the year \*(L"98\*(R" A.D. and
\&\fB\s-1NOT\s0\fR \*(L"1998\*(R"!
.Sp
An exception from this rule are the functions which contain the
word \*(L"compress\*(R" in their names (which can only handle years between
1970 and 2069 and also accept the abbreviations \*(L"00\*(R" to \*(L"99\*(R"), and
the functions whose names begin with \*(L"Decode_Date_\*(R" (which translate
year numbers below 100 using a technique known as \*(L"moving window\*(R").
.Sp
If you want to convert a two-digit year number into a full\-fledged,
four-digit (at least for some years to come \f(CW\*(C`;\-)\*(C'\fR) year number,
use the two functions \*(L"\fIFixed_Window()\fR\*(R" and \*(L"\fIMoving_Window()\fR\*(R"
(see their description further below).
.Sp
Note also that the following import/export functions (which are
interfaces to the \s-1POSIX\s0 functions \*(L"\fItime()\fR\*(R", \*(L"\fIgmtime()\fR\*(R", \*(L"\fIlocaltime()\fR\*(R"
and \*(L"\fImktime()\fR\*(R" or (the last two) substitutes for the \s-1BSD\s0 function
\&\*(L"\fItimegm()\fR\*(R" and the \s-1POSIX\s0 function \*(L"\fIgmtime()\fR\*(R") have a very limited
range of representable dates (in contrast to all other functions
in this package, which cover virtually any date including and
after January\ 1st\ 1\ A.D.):
.Sp
.Vb 11
\&              System_Clock()
\&              Today()
\&              Now()
\&              Today_and_Now()
\&              This_Year()
\&              Gmtime()
\&              Localtime()
\&              Mktime()
\&              Timezone()
\&              Date_to_Time()
\&              Time_to_Date()
.Ve
.Sp
These functions can only deal with dates in the range from
01\-Jan\-1970\ 00:00:00\ \s-1GMT\s0 to 19\-Jan\-2038\ 03:14:07\ \s-1GMT\s0
(the latter limit is only authoritative on 32\ bit systems,
however, and can (in principle, through a few code changes)
be extended somewhat \f(CW\*(C`:\-)\*(C'\fR on 64\ bit systems).
.Sp
On MacOS Classic, the valid range of dates is between
(both included) 01\-Jan\-1904\ 00:00:00 (local time)
to 06\-Feb\-2040\ 06:28:15 (local time).
.Sp
Note further that the function \*(L"\fIEaster_Sunday()\fR\*(R" can only
be used for years in the range 1583 to 2299.
.IP "\(bu" 2
First index
.Sp
\&\fB\s-1ALL\s0\fR ranges in this module start with "\f(CW1\fR", \fB\s-1NOT\s0\fR "\f(CW0\fR"!
.Sp
I.e., the day of month, day of week, day of year, month of year,
week of year, first valid year number and language \fB\s-1ALL\s0\fR start
counting at one, \fB\s-1NOT\s0\fR zero!
.Sp
The only exception is the function "\f(CW\*(C`Week_Number()\*(C'\fR\*(L", which may
in fact return \*(R"\f(CW0\fR" when the given date actually lies in the
last week of the \fB\s-1PREVIOUS\s0\fR year, and of course the numbers for
hours (\f(CW0..23\fR), minutes (\f(CW0..59\fR) and seconds (\f(CW0..59\fR).
.IP "\(bu" 2
Function naming conventions
.Sp
Function names completely in lower case indicate a boolean return value.
.IP "\(bu" 2
Boolean values
.Sp
Boolean values in this module are always a numeric zero ("\f(CW0\fR\*(L") for
\&\*(R"false\*(L" and a numeric one (\*(R"\f(CW1\fR\*(L") for \*(R"true".
.IP "\(bu" 2
Exception handling
.Sp
The functions in this module will usually die with a corresponding error
message if their input parameters, intermediate results or output values
are out of range.
.Sp
The following functions handle errors differently:
.Sp
.Vb 4
\&  -  check_date()
\&  -  check_time()
\&  -  check_business_date()
\&  -  check_compressed()
.Ve
.Sp
(which return a \*(L"false\*(R" return value when the given input does not represent
a valid date or time),
.Sp
.Vb 1
\&  -  Nth_Weekday_of_Month_Year()
.Ve
.Sp
(which returns an empty list if the requested 5th day of week does not exist),
.Sp
.Vb 6
\&  -  Decode_Month()
\&  -  Decode_Day_of_Week()
\&  -  Decode_Language()
\&  -  Fixed_Window()
\&  -  Moving_Window()
\&  -  Compress()
.Ve
.Sp
(which return "\f(CW0\fR" upon failure or invalid input), and
.Sp
.Vb 6
\&  -  Decode_Date_EU()
\&  -  Decode_Date_US()
\&  -  Decode_Date_EU2()
\&  -  Decode_Date_US2()
\&  -  Parse_Date()
\&  -  Uncompress()
.Ve
.Sp
(which return an empty list upon failure or invalid input).
.Sp
Note that you can always catch an exception thrown by any of the functions
in this module and handle it yourself by enclosing the function call in an
"\f(CW\*(C`eval\*(C'\fR\*(L" with curly brackets and checking the special variable \*(R"\f(CW$@\fR"
(see \*(L"eval\*(R" in \fIperlfunc\fR\|(1) for details).
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.IP "\(bu" 2
\&\f(CW\*(C`use Date::Calc qw( Days_in_Year Days_in_Month ... );\*(C'\fR
.IP "\(bu" 2
\&\f(CW\*(C`use Date::Calc qw(:all);\*(C'\fR
.Sp
You can either specify the functions you want to import explicitly by
enumerating them between the parentheses of the "\f(CW\*(C`qw()\*(C'\fR\*(L" operator, or
you can use the \*(R"\f(CW\*(C`:all\*(C'\fR" tag instead to import \fB\s-1ALL\s0\fR available functions.
.IP "\(bu" 2
\&\f(CW\*(C`$days = Days_in_Year($year,$month);\*(C'\fR
.Sp
This function returns the sum of the number of days in the months starting
with January up to and including "\f(CW$month\fR\*(L" in the given year \*(R"\f(CW$year\fR".
.Sp
I.e., "\f(CW\*(C`Days_in_Year(1998,1)\*(C'\fR\*(L" returns \*(R"\f(CW31\fR\*(L", \*(R"\f(CW\*(C`Days_in_Year(1998,2)\*(C'\fR\*(L"
returns \*(R"\f(CW59\fR\*(L", \*(R"\f(CW\*(C`Days_in_Year(1998,3)\*(C'\fR\*(L" returns \*(R"\f(CW90\fR", and so on.
.Sp
Note that "\f(CW\*(C`Days_in_Year($year,12)\*(C'\fR\*(L" returns the number of days in the
given year \*(R"\f(CW$year\fR\*(L", i.e., either \*(R"\f(CW365\fR\*(L" or \*(R"\f(CW366\fR".
.IP "\(bu" 2
\&\f(CW\*(C`$days = Days_in_Month($year,$month);\*(C'\fR
.Sp
This function returns the number of days in the given month "\f(CW$month\fR\*(L" of
the given year \*(R"\f(CW$year\fR".
.Sp
The year must always be supplied, even though it is only needed when the
month is February, in order to determine whether it is a leap year or not.
.Sp
I.e., "\f(CW\*(C`Days_in_Month(1998,1)\*(C'\fR\*(L" returns \*(R"\f(CW31\fR\*(L", \*(R"\f(CW\*(C`Days_in_Month(1998,2)\*(C'\fR\*(L"
returns \*(R"\f(CW28\fR\*(L", \*(R"\f(CW\*(C`Days_in_Month(2000,2)\*(C'\fR\*(L" returns \*(R"\f(CW29\fR\*(L",
\&\*(R"\f(CW\*(C`Days_in_Month(1998,3)\*(C'\fR\*(L" returns \*(R"\f(CW31\fR", and so on.
.IP "\(bu" 2
\&\f(CW\*(C`$weeks = Weeks_in_Year($year);\*(C'\fR
.Sp
This function returns the number of weeks in the given year "\f(CW$year\fR\*(L",
i.e., either \*(R"\f(CW52\fR\*(L" or \*(R"\f(CW53\fR".
.IP "\(bu" 2
\&\f(CW\*(C`if (leap_year($year))\*(C'\fR
.Sp
This function returns \*(L"true\*(R" ("\f(CW1\fR\*(L") if the given year \*(R"\f(CW$year\fR\*(L" is
a leap year and \*(R"false\*(L" (\*(R"\f(CW0\fR") otherwise.
.IP "\(bu" 2
\&\f(CW\*(C`if (check_date($year,$month,$day))\*(C'\fR
.Sp
This function returns \*(L"true\*(R" ("\f(CW1\fR\*(L") if the given three numerical
values \*(R"\f(CW$year\fR\*(L", \*(R"\f(CW$month\fR\*(L" and \*(R"\f(CW$day\fR\*(L" constitute a valid date,
and \*(R"false\*(L" (\*(R"\f(CW0\fR") otherwise.
.IP "\(bu" 2
\&\f(CW\*(C`if (check_time($hour,$min,$sec))\*(C'\fR
.Sp
This function returns \*(L"true\*(R" ("\f(CW1\fR\*(L") if the given three numerical
values \*(R"\f(CW$hour\fR\*(L", \*(R"\f(CW$min\fR\*(L" and \*(R"\f(CW$sec\fR" constitute a valid time
(\f(CW\*(C`0 <= $hour < 24\*(C'\fR, \f(CW\*(C`0 <= $min < 60\*(C'\fR and
\&\f(CW\*(C`0 <= $sec < 60\*(C'\fR), and \*(L"false\*(R" ("\f(CW0\fR") otherwise.
.IP "\(bu" 2
\&\f(CW\*(C`if (check_business_date($year,$week,$dow))\*(C'\fR
.Sp
This function returns \*(L"true\*(R" ("\f(CW1\fR\*(L") if the given three numerical
values \*(R"\f(CW$year\fR\*(L", \*(R"\f(CW$week\fR\*(L" and \*(R"\f(CW$dow\fR\*(L" constitute a valid date
in business format, and \*(R"false\*(L" (\*(R"\f(CW0\fR") otherwise.
.Sp
\&\fBBeware\fR that this function does \fB\s-1NOT\s0\fR compute whether a given date
is a business day (i.e., Monday to Friday)!
.Sp
To do so, use "\f(CW\*(C`(Day_of_Week($year,$month,$day) < 6)\*(C'\fR" instead.
.IP "\(bu" 2
\&\f(CW\*(C`$doy = Day_of_Year($year,$month,$day);\*(C'\fR
.Sp
This function returns the (relative) number of the day of the given date
in the given year.
.Sp
E.g., "\f(CW\*(C`Day_of_Year($year,1,1)\*(C'\fR\*(L" returns \*(R"\f(CW1\fR\*(L",
\&\*(R"\f(CW\*(C`Day_of_Year($year,2,1)\*(C'\fR\*(L" returns \*(R"\f(CW32\fR\*(L", and
\&\*(R"\f(CW\*(C`Day_of_Year($year,12,31)\*(C'\fR\*(L" returns either \*(R"\f(CW365\fR\*(L" or \*(R"\f(CW366\fR".
.IP "\(bu" 2
\&\f(CW\*(C`$days = Date_to_Days($year,$month,$day);\*(C'\fR
.Sp
This function returns the (absolute) number of the day of the given date,
where counting starts at the 1st of January of the year 1\ A.D.
.Sp
I.e., "\f(CW\*(C`Date_to_Days(1,1,1)\*(C'\fR\*(L" returns \*(R"\f(CW1\fR\*(L", \*(R"\f(CW\*(C`Date_to_Days(1,12,31)\*(C'\fR\*(L"
returns \*(R"\f(CW365\fR\*(L", \*(R"\f(CW\*(C`Date_to_Days(2,1,1)\*(C'\fR\*(L" returns \*(R"\f(CW366\fR\*(L",
\&\*(R"\f(CW\*(C`Date_to_Days(1998,5,1)\*(C'\fR\*(L" returns \*(R"\f(CW729510\fR", and so on.
.Sp
This is sometimes also referred to (not quite correctly) as the Julian
date (or day). This may cause confusion, because also the number of the
day in a year (from 1 to 365 or 366) is frequently called the \*(L"Julian date\*(R".
.Sp
In fact the calendar that was used \fB\s-1BEFORE\s0\fR the Gregorian calendar
was the Julian calendar \- named after famous Julius Caesar, who had
instituted it in Roman times. The Julian calendar was less precise
because it had too many leap years compared to the true mean length
of a year, and because rulers often changed it arbitrarily, in order
to lengthen their own reign, for instance.
.Sp
In order to convert the number returned by this function back into
a date, use the function "\f(CW\*(C`Add_Delta_Days()\*(C'\fR" (described further
below), as follows:
.Sp
.Vb 2
\&  $days = Date_to_Days($year,$month,$day);
\&  ($year,$month,$day) = Add_Delta_Days(1,1,1, $days - 1);
.Ve
.IP "\(bu" 2
\&\f(CW\*(C`$dow = Day_of_Week($year,$month,$day);\*(C'\fR
.Sp
This function returns the number of the day of week of the given date.
.Sp
The function returns "\f(CW1\fR\*(L" for Monday, \*(R"\f(CW2\fR\*(L" for Tuesday and so on
until \*(R"\f(CW7\fR" for Sunday.
.Sp
Note that in the Hebrew calendar (on which the Christian calendar is based),
the week starts with Sunday and ends with the Sabbath or Saturday (where
according to the Genesis (as described in the Bible) the Lord rested from
creating the world).
.Sp
In medieval times, Catholic Popes have decreed the Sunday to be the official
day of rest, in order to dissociate the Christian from the Hebrew belief.
.Sp
Nowadays, the Sunday \fB\s-1AND\s0\fR the Saturday are commonly considered (and
used as) days of rest, usually referred to as the \*(L"week\-end\*(R".
.Sp
Consistent with this practice, current norms and standards (such as
\&\s-1ISO/R\s0\ 2015\-1971, \s-1DIN\s0\ 1355 and \s-1ISO\s0\ 8601) define the Monday
as the first day of the week.
.IP "\(bu" 2
\&\f(CW\*(C`$week = Week_Number($year,$month,$day);\*(C'\fR
.Sp
This function returns the number of the week the given date lies in.
.Sp
If the given date lies in the \fB\s-1LAST\s0\fR week of the \fB\s-1PREVIOUS\s0\fR year,
"\f(CW0\fR" is returned.
.Sp
If the given date lies in the \fB\s-1FIRST\s0\fR week of the \fB\s-1NEXT\s0\fR year,
"\f(CW\*(C`Weeks_in_Year($year) + 1\*(C'\fR" is returned.
.IP "\(bu" 2
\&\f(CW\*(C`($week,$year) = Week_of_Year($year,$month,$day);\*(C'\fR
.Sp
This function returns the number of the week the given date lies in,
as well as the year that week belongs to.
.Sp
I.e., if the given date lies in the \fB\s-1LAST\s0\fR week of the \fB\s-1PREVIOUS\s0\fR year,
"\f(CW\*(C`(Weeks_in_Year($year\-1), $year\-1)\*(C'\fR" is returned.
.Sp
If the given date lies in the \fB\s-1FIRST\s0\fR week of the \fB\s-1NEXT\s0\fR year,
"\f(CW\*(C`(1, $year+1)\*(C'\fR" is returned.
.Sp
Otherwise, "\f(CW\*(C`(Week_Number($year,$month,$day), $year)\*(C'\fR" is returned.
.IP "\(bu" 2
\&\f(CW\*(C`$week = Week_of_Year($year,$month,$day);\*(C'\fR
.Sp
In scalar context, this function returns just the week number. This
allows you to write "\f(CW\*(C`$week = Week_of_Year($year,$month,$day);\*(C'\fR\*(L"
instead of \*(R"\f(CW\*(C`($week) = Week_of_Year($year,$month,$day);\*(C'\fR\*(L" (note
the parentheses around \*(R"\f(CW$week\fR").
.Sp
If the given date lies in the \fB\s-1LAST\s0\fR week of the \fB\s-1PREVIOUS\s0\fR year,
"\f(CW\*(C`Weeks_in_Year($year\-1)\*(C'\fR" is returned.
.Sp
If the given date lies in the \fB\s-1FIRST\s0\fR week of the \fB\s-1NEXT\s0\fR year,
"\f(CW1\fR" is returned.
.Sp
Otherwise the return value is identical with that of
"\f(CW\*(C`Week_Number($year,$month,$day)\*(C'\fR".
.Sp
\&\fB\s-1BEWARE\s0\fR that using this function in scalar context is a \fB\s-1DANGEROUS\s0\fR
feature, because without knowing which year the week belongs to, you
might inadvertently assume the wrong one!
.Sp
If for instance you are iterating through an interval of dates, you might
assume that the week always belongs to the same year as the given date,
which unfortunately is \fB\s-1WRONG\s0\fR in some cases!
.Sp
In many years, the 31st of December for instance belongs to week number
one of the \fB\s-1FOLLOWING\s0\fR year. Assuming that the year is the same as your
date (31st of December, in this example), sends you back to the first week
of the \fB\s-1CURRENT\s0\fR year \- the Monday of which, by the way, in case of bad
luck, might actually lie in the year \fB\s-1BEFORE\s0\fR the current year!
.Sp
This actually happens in 2002, for example.
.Sp
So you always need to provide the correct corresponding year number
by other means, keeping track of it yourself.
.Sp
In case you do not understand this, never mind, but then simply
\&\fB\s-1DO\s0 \s-1NOT\s0 \s-1USE\s0\fR this function in scalar context!
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day) = Monday_of_Week($week,$year);\*(C'\fR
.Sp
This function returns the date of the first day of the given week, i.e.,
the Monday.
.Sp
"\f(CW$year\fR\*(L" must be greater than or equal to \*(R"\f(CW1\fR\*(L", and \*(R"\f(CW$week\fR\*(L" must
lie in the range \*(R"\f(CW1\fR\*(L" to \*(R"\f(CW\*(C`Weeks_in_Year($year)\*(C'\fR".
.Sp
Note that you can write
"\f(CW\*(C`($year,$month,$day) = Monday_of_Week(Week_of_Year($year,$month,$day));\*(C'\fR"
in order to calculate the date of the Monday of the same week as the
given date.
.Sp
If you want to calculate any other day of week in the same week as a
given date, use
.Sp
.Vb 1
\&  @date = Add_Delta_Days(Monday_of_Week(Week_of_Year(@date)),$offset);
.Ve
.Sp
where \f(CW\*(C`$offset = 1\*(C'\fR for Tuesday, \f(CW2\fR for Wednesday etc.
.IP "\(bu" 2
\&\f(CW\*(C`if (($year,$month,$day) = Nth_Weekday_of_Month_Year($year,$month,$dow,$n))\*(C'\fR
.Sp
This function calculates the date of the "\f(CW$n\fR\*(L"th day of week \*(R"\f(CW$dow\fR\*(L"
in the given month \*(R"\f(CW$month\fR\*(L" and year \*(R"\f(CW$year\fR"; such as, for example,
the 3rd Thursday of a given month and year.
.Sp
This can be used to send a notification mail to the members of a group
which meets regularly on every 3rd Thursday of a month, for instance.
.Sp
(See the section \*(L"\s-1RECIPES\s0\*(R" near the end of this document for a code
snippet to actually do so.)
.Sp
"\f(CW$year\fR\*(L" must be greater than or equal to \*(R"\f(CW1\fR\*(L", \*(R"\f(CW$month\fR\*(L" must lie
in the range \*(R"\f(CW1\fR\*(L" to \*(R"\f(CW12\fR\*(L", \*(R"\f(CW$dow\fR\*(L" must lie in the range \*(R"\f(CW1\fR\*(L"
to \*(R"\f(CW7\fR\*(L" and \*(R"\f(CW$n\fR\*(L" must lie in the range \*(R"\f(CW1\fR\*(L" to \*(R"\f(CW5\fR", or a fatal
error (with appropriate error message) occurs.
.Sp
The function returns an empty list when the 5th of a given day of week
does not exist in the given month and year.
.IP "\(bu" 2
\&\f(CW\*(C`($year,$week,$dow) = Standard_to_Business($year,$month,$day);\*(C'\fR
.Sp
This function converts a given date from standard notation (year,
month, day (of month)) to business notation (year, week, day of week).
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day) = Business_to_Standard($year,$week,$dow);\*(C'\fR
.Sp
This function converts a given date from business notation (year,
week, day of week) to standard notation (year, month, day (of month)).
.IP "\(bu" 2
\&\f(CW\*(C`$Dd = Delta_Days($year1,$month1,$day1, $year2,$month2,$day2);\*(C'\fR
.Sp
This function returns the difference in days between the two given
dates.
.Sp
The result is positive if the two dates are in chronological order,
i.e., if date #1 comes chronologically \fB\s-1BEFORE\s0\fR date #2, and negative
if the order of the two dates is reversed.
.Sp
The result is zero if the two dates are identical.
.IP "\(bu" 2
\&\f(CW\*(C`($Dd,$Dh,$Dm,$Ds) = Delta_DHMS($year1,$month1,$day1, $hour1,$min1,$sec1, $year2,$month2,$day2, $hour2,$min2,$sec2);\*(C'\fR
.Sp
This function returns the difference in days, hours, minutes and seconds
between the two given dates with times.
.Sp
All four return values will be positive if the two dates are in chronological
order, i.e., if date #1 comes chronologically \fB\s-1BEFORE\s0\fR date #2, and negative
(in all four return values!) if the order of the two dates is reversed.
.Sp
This is so that the two functions "\f(CW\*(C`Delta_DHMS()\*(C'\fR\*(L" and \*(R"\f(CW\*(C`Add_Delta_DHMS()\*(C'\fR"
(description see further below) are complementary, i.e., mutually inverse:
.Sp
.Vb 1
\&  Add_Delta_DHMS(@date1,@time1, Delta_DHMS(@date1,@time1, @date2,@time2))
.Ve
.Sp
yields "\f(CW\*(C`(@date2,@time2)\*(C'\fR" again, whereas
.Sp
.Vb 2
\&  Add_Delta_DHMS(@date2,@time2,
\&      map(-$_, Delta_DHMS(@date1,@time1, @date2,@time2)))
.Ve
.Sp
yields "\f(CW\*(C`(@date1,@time1)\*(C'\fR", and
.Sp
.Vb 1
\&  Delta_DHMS(@date1,@time1, Add_Delta_DHMS(@date1,@time1, @delta))
.Ve
.Sp
yields "\f(CW@delta\fR" again.
.Sp
The result is zero (in all four return values) if the two dates and times
are identical.
.IP "\(bu" 2
\&\f(CW\*(C`($Dy,$Dm,$Dd) = Delta_YMD($year1,$month1,$day1, $year2,$month2,$day2);\*(C'\fR
.Sp
This function returns the vector
.Sp
.Vb 1
\&    ( $year2 - $year1, $month2 - $month1, $day2 - $day1 )
.Ve
.Sp
An error occurs if any of the two dates is invalid.
.IP "\(bu" 2
\&\f(CW\*(C`($D_y,$D_m,$D_d, $Dh,$Dm,$Ds) = Delta_YMDHMS($year1,$month1,$day1, $hour1,$min1,$sec1, $year2,$month2,$day2, $hour2,$min2,$sec2);\*(C'\fR
.Sp
This function is based on the function \*(L"\fIDelta_YMD()\fR\*(R" above but additionally
calculates the time difference. When a carry over from the time difference
occurs, the value of "\f(CW$D_d\fR" is adjusted accordingly, thus giving the
correct total date/time difference.
.Sp
Arguments are expected to be in chronological order to yield a (usually)
positive result.
.Sp
In any case, adding the result of this function to the first date/time value
(\f(CW\*(C`$year1,$month1,$day1,\*(C'\fR \f(CW\*(C`$hour1,$min1,$sec1\*(C'\fR) always gives the second
date/time value (\f(CW\*(C`$year2,$month2,$day2,\*(C'\fR \f(CW\*(C`$hour2,$min2,$sec2\*(C'\fR) again,
and adding the negative result (all elements of the result vector negated)
to the second date/time value gives the first date/time value.
.Sp
See the function \*(L"\fIAdd_Delta_YMDHMS()\fR\*(R" further below for adding a date/time
value and a date/time difference.
.Sp
An error occurs if any of the two date/time values is invalid.
.IP "\(bu" 2
\&\f(CW\*(C`($Dd,$Dh,$Dm,$Ds) = Normalize_DHMS($Dd,$Dh,$Dm,$Ds);\*(C'\fR
.Sp
This function takes four arbitrary values for days, hours, minutes
and seconds (which may have different signs) and renormalizes them
so that the values for hours, minutes and seconds will lie in the
ranges \f(CW\*(C`[\-23..23]\*(C'\fR, \f(CW\*(C`[\-59..59]\*(C'\fR and \f(CW\*(C`[\-59..59]\*(C'\fR, respectively,
and so that all four values have the same sign (or are zero).
.Sp
The given values are left untouched, i.e., unchanged.
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day) = Add_Delta_Days($year,$month,$day, $Dd);\*(C'\fR
.Sp
This function has two principal uses:
.Sp
First, it can be used to calculate a new date, given an initial date and
an offset (which may be positive or negative) in days, in order to answer
questions like \*(L"today plus 90 days \*(-- which date gives that?\*(R".
.Sp
(In order to add a weeks offset, simply multiply the weeks offset with
"\f(CW7\fR" and use that as your days offset.)
.Sp
Second, it can be used to convert the canonical representation of a date,
i.e., the number of that day (where counting starts at the 1st of January
in 1\ A.D.), back into a date given as year, month and day.
.Sp
Because counting starts at "\f(CW1\fR\*(L", you will actually have to subtract \*(R"\f(CW1\fR"
from the canonical date in order to get back the original date:
.Sp
.Vb 1
\&  $canonical = Date_to_Days($year,$month,$day);
.Ve
.Sp
.Vb 1
\&  ($year,$month,$day) = Add_Delta_Days(1,1,1, $canonical - 1);
.Ve
.Sp
Moreover, this function is the inverse of the function "\f(CW\*(C`Delta_Days()\*(C'\fR":
.Sp
.Vb 1
\&  Add_Delta_Days(@date1, Delta_Days(@date1, @date2))
.Ve
.Sp
yields "\f(CW@date2\fR" again, whereas
.Sp
.Vb 1
\&  Add_Delta_Days(@date2, -Delta_Days(@date1, @date2))
.Ve
.Sp
yields "\f(CW@date1\fR", and
.Sp
.Vb 1
\&  Delta_Days(@date1, Add_Delta_Days(@date1, $delta))
.Ve
.Sp
yields "\f(CW$delta\fR" again.
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day, $hour,$min,$sec) = Add_Delta_DHMS($year,$month,$day, $hour,$min,$sec, $Dd,$Dh,$Dm,$Ds);\*(C'\fR
.Sp
This function serves to add a days, hours, minutes and seconds offset to a
given date and time, in order to answer questions like \*(L"today and now plus
7 days but minus 5 hours and then plus 30 minutes, what date and time gives
that?\*(R":
.Sp
.Vb 1
\&  ($y,$m,$d,$H,$M,$S) = Add_Delta_DHMS(Today_and_Now(), +7,-5,+30,0);
.Ve
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day) = Add_Delta_YM($year,$month,$day, $Dy,$Dm);\*(C'\fR
.Sp
This function can be used to add a year and/or month offset to a given
date.
.Sp
In contrast to the function described immediately below
("\f(CW\*(C`Add_Delta_YMD()\*(C'\fR\*(L"), this function does no \*(R"wrapping" into
the next month if the day happens to lie outside the valid range
for the resulting year and month (after adding the year and month
offsets). Instead, it simply truncates the day to the last possible
day of the resulting month.
.Sp
Examples:
.Sp
Adding an offset of 0 years, 1 month to the date (1999,1,31) would result
in the (invalid) date (1999,2,31). The function replaces this result by
the (valid) date (1999,2,28).
.Sp
Adding an offset of 1 year, 1 month to the same date (1999,1,31) as above
would result in the (still invalid) date (2000,2,31). The function replaces
this result by the valid date (2000,2,29) (because 2000 is a leap year).
.Sp
Note that the year and month offsets can be negative, and that they can
have different signs.
.Sp
If you want to additionally add a days offset, use the function
"\f(CW\*(C`Add_Delta_Days()\*(C'\fR\*(L" before or after calling \*(R"\f(CW\*(C`Add_Delta_YM()\*(C'\fR":
.Sp
.Vb 2
\&  @date2 = Add_Delta_Days( Add_Delta_YM(@date1, $Dy,$Dm), $Dd );
\&  @date2 = Add_Delta_YM( Add_Delta_Days(@date1, $Dd), $Dy,$Dm );
.Ve
.Sp
Note that your result may depend on the order in which you call
these two functions!
.Sp
Consider the date (1999,2,28) and the offsets 0 years, 1 month
and 1 day:
.Sp
(1999,2,28) plus one month is (1999,3,28), plus one day is
(1999,3,29). (1999,2,28) plus one day is (1999,3,1), plus
one month is (1999,4,1).
.Sp
(Which is also the reason why the "\f(CW\*(C`Add_Delta_YM()\*(C'\fR" function
does not allow to add a days offset, because this would actually
require \s-1TWO\s0 functions: One for adding the days offset \s-1BEFORE\s0 and
one for adding it \s-1AFTER\s0 applying the year/month offsets.)
.Sp
An error occurs if the initial date is not valid.
.Sp
Note that "\f(CW\*(C`Add_Delta_YM( Add_Delta_YM(@date, $Dy,$Dm), \-$Dy,\-$Dm );\*(C'\fR\*(L"
will not, in general, return the original date \*(R"\f(CW@date\fR" (consider
the examples given above!).
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day) = Add_Delta_YMD($year,$month,$day, $Dy,$Dm,$Dd);\*(C'\fR
.Sp
This function serves to add a years, months and days offset to a given date.
.Sp
(In order to add a weeks offset, simply multiply the weeks offset with "\f(CW7\fR"
and add this number to your days offset.)
.Sp
Note that the three offsets for years, months and days are applied
independently from each other. This also allows them to have
different signs.
.Sp
The years and months offsets are applied first, and the days offset
is applied last.
.Sp
If the resulting date happens to fall on a day after the end of the
resulting month, like the 32nd of April or the 30th of February, then
the date is simply counted forward into the next month (possibly also
into the next year) by the number of excessive days (e.g., the 32nd of
April will become the 2nd of May).
.Sp
\&\fB\s-1BEWARE\s0\fR that this behaviour differs from that of previous versions
of this module! In previous versions, the day was simply truncated to
the maximum number of days in the resulting month.
.Sp
If you want the previous behaviour, use the new function "\f(CW\*(C`Add_Delta_YM()\*(C'\fR\*(L"
(described immediately above) plus the function \*(R"\f(CW\*(C`Add_Delta_Days()\*(C'\fR"
instead.
.Sp
\&\fB\s-1BEWARE\s0\fR also that because a year and a month offset is not equivalent
to a fixed number of days, the transformation performed by this function
is \fB\s-1NOT\s0 \s-1ALWAYS\s0 \s-1REVERSIBLE\s0\fR!
.Sp
This is in contrast to the functions "\f(CW\*(C`Add_Delta_Days()\*(C'\fR\*(L" and
\&\*(R"\f(CW\*(C`Add_Delta_DHMS()\*(C'\fR\*(L", which are fully and truly reversible (with
the help of the functions \*(R"\f(CW\*(C`Delta_Days()\*(C'\fR\*(L" and \*(R"\f(CW\*(C`Delta_DHMS()\*(C'\fR",
for instance).
.Sp
Note that for this same reason,
.Sp
.Vb 2
\&  @date = Add_Delta_YMD(
\&          Add_Delta_YMD(@date, $Dy,$Dm,$Dd), -$Dy,-$Dm,-$Dd);
.Ve
.Sp
will in general \fB\s-1NOT\s0\fR return the initial date "\f(CW@date\fR".
.Sp
Note that this is \fB\s-1NOT\s0\fR a program bug but \fB\s-1NECESSARILY\s0\fR so
because of the variable lengths of years and months!
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day, $hour,$min,$sec) = Add_Delta_YMDHMS($year,$month,$day, $hour,$min,$sec, $D_y,$D_m,$D_d, $Dh,$Dm,$Ds);\*(C'\fR
.Sp
Same as the function above, except that a time offset may be given in
addition to the year, month and day offset.
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day, $hour,$min,$sec, $doy,$dow,$dst) = System_Clock([$gmt]);\*(C'\fR
.Sp
If your operating system supports the corresponding system calls
("\f(CW\*(C`time()\*(C'\fR\*(L" and \*(R"\f(CW\*(C`localtime()\*(C'\fR\*(L" or \*(R"\f(CW\*(C`gmtime()\*(C'\fR"), this function
will return the information provided by your system clock, i.e.,
the current date and time, the number of the day of year, the number
of the day of week and a flag signaling whether daylight savings time
is currently in effect or not.
.Sp
The ranges of values returned (and their meanings) are as follows:
.Sp
.Vb 2
\&        $year   :   1970..2038 (or more)  [Unix etc.]
\&        $year   :   1904..2040            [MacOS Classic]
.Ve
.Sp
.Vb 8
\&        $month  :   1..12
\&        $day    :   1..31
\&        $hour   :   0..23
\&        $min    :   0..59
\&        $sec    :   0..59    (0..61 on some systems)
\&        $doy    :   1..366
\&        $dow    :   1..7
\&        $dst    :  -1..1
.Ve
.Sp
"\f(CW$doy\fR\*(L" is the day of year, sometimes also referred to as the
\&\*(R"julian date\*(L", which starts at \*(R"\f(CW1\fR" and goes up to the number
of days in that year.
.Sp
The day of week ("\f(CW$dow\fR\*(L") will be \*(R"\f(CW1\fR\*(L" for Monday, \*(R"\f(CW2\fR\*(L" for
Tuesday and so on until \*(R"\f(CW7\fR" for Sunday.
.Sp
The daylight savings time flag ("\f(CW$dst\fR\*(L") will be \*(R"\f(CW\*(C`\-1\*(C'\fR\*(L" if this
information is not available on your system, \*(R"\f(CW0\fR\*(L" for no daylight
savings time (i.e., winter time) and \*(R"\f(CW1\fR" when daylight savings
time is in effect.
.Sp
If your operating system does not provide the necessary system calls,
calling this function will result in a fatal \*(L"not available on this
system\*(R" error message.
.Sp
If you want to handle this exception yourself, use "\f(CW\*(C`eval\*(C'\fR" as follows:
.Sp
.Vb 2
\&  eval { ($year,$month,$day, $hour,$min,$sec, $doy,$dow,$dst) =
\&    System_Clock(); };
.Ve
.Sp
.Vb 5
\&  if ($@)
\&  {
\&      # Handle missing system clock
\&      # (For instance, ask user to enter this information manually)
\&  }
.Ve
.Sp
Note that curlies (\*(L"{\*(R" and \*(L"}\*(R") are used here to delimit the statement to
be \*(L"eval\*(R"ed (which is the way to catch exceptions in Perl), and not quotes
(which is a way to evaluate Perl expressions at runtime).
.Sp
If the optional (boolean) input parameter "\f(CW$gmt\fR\*(L" is given, a \*(R"true\*(L"
value (\*(R"\f(CW1\fR\*(L") will cause \*(R"\f(CW\*(C`gmtime()\*(C'\fR\*(L" to be used instead of \*(R"\f(CW\*(C`localtime()\*(C'\fR",
internally, thus returning Greenwich Mean Time (\s-1GMT\s0, or \s-1UTC\s0) instead of
local time.
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day) = Today([$gmt]);\*(C'\fR
.Sp
This function returns a subset of the values returned by the function
"\f(CW\*(C`System_Clock()\*(C'\fR" (see above for details), namely the current year,
month and day.
.Sp
A fatal \*(L"not available on this system\*(R" error message will appear if the
corresponding system calls are not supported by your current operating
system.
.Sp
If the optional (boolean) input parameter "\f(CW$gmt\fR\*(L" is given, a \*(R"true\*(L"
value (\*(R"\f(CW1\fR\*(L") will cause \*(R"\f(CW\*(C`gmtime()\*(C'\fR\*(L" to be used instead of \*(R"\f(CW\*(C`localtime()\*(C'\fR",
internally, thus returning Greenwich Mean Time (\s-1GMT\s0, or \s-1UTC\s0) instead of
local time.
.IP "\(bu" 2
\&\f(CW\*(C`($hour,$min,$sec) = Now([$gmt]);\*(C'\fR
.Sp
This function returns a subset of the values returned by the function
"\f(CW\*(C`System_Clock()\*(C'\fR" (see above for details), namely the current time
(hours, minutes and full seconds).
.Sp
A fatal \*(L"not available on this system\*(R" error message will appear if the
corresponding system calls are not supported by your current operating
system.
.Sp
If the optional (boolean) input parameter "\f(CW$gmt\fR\*(L" is given, a \*(R"true\*(L"
value (\*(R"\f(CW1\fR\*(L") will cause \*(R"\f(CW\*(C`gmtime()\*(C'\fR\*(L" to be used instead of \*(R"\f(CW\*(C`localtime()\*(C'\fR",
internally, thus returning Greenwich Mean Time (\s-1GMT\s0, or \s-1UTC\s0) instead of
local time.
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day, $hour,$min,$sec) = Today_and_Now([$gmt]);\*(C'\fR
.Sp
This function returns a subset of the values returned by the function
"\f(CW\*(C`System_Clock()\*(C'\fR" (see above for details), namely the current date
(year, month, day) and time (hours, minutes and full seconds).
.Sp
A fatal \*(L"not available on this system\*(R" error message will appear if the
corresponding system calls are not supported by your current operating
system.
.Sp
If the optional (boolean) input parameter "\f(CW$gmt\fR\*(L" is given, a \*(R"true\*(L"
value (\*(R"\f(CW1\fR\*(L") will cause \*(R"\f(CW\*(C`gmtime()\*(C'\fR\*(L" to be used instead of \*(R"\f(CW\*(C`localtime()\*(C'\fR",
internally, thus returning Greenwich Mean Time (\s-1GMT\s0, or \s-1UTC\s0) instead of
local time.
.IP "\(bu" 2
\&\f(CW\*(C`$year = This_Year([$gmt]);\*(C'\fR
.Sp
This function returns the current year, according to local time.
.Sp
A fatal \*(L"not available on this system\*(R" error message will appear if the
corresponding system calls are not supported by your current operating
system.
.Sp
If the optional (boolean) input parameter "\f(CW$gmt\fR\*(L" is given, a \*(R"true\*(L"
value (\*(R"\f(CW1\fR\*(L") will cause \*(R"\f(CW\*(C`gmtime()\*(C'\fR\*(L" to be used instead of \*(R"\f(CW\*(C`localtime()\*(C'\fR",
internally, thus returning Greenwich Mean Time (\s-1GMT\s0, or \s-1UTC\s0) instead of
local time. However, this will only make a difference within a few hours
around New Year (unless you are on a Pacific island, where this can
be almost 24 hours).
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day, $hour,$min,$sec, $doy,$dow,$dst) = Gmtime([time]);\*(C'\fR
.Sp
This is Date::Calc's equivalent of Perl's built-in \*(L"\fIgmtime()\fR\*(R" function.
See also \*(L"gmtime\*(R" in perlfunc.
.Sp
The ranges of values returned (and their meanings) are as follows:
.Sp
.Vb 2
\&        $year   :   1970..2038 (or more)  [Unix etc.]
\&        $year   :   1904..2040            [MacOS Classic]
.Ve
.Sp
.Vb 8
\&        $month  :   1..12
\&        $day    :   1..31
\&        $hour   :   0..23
\&        $min    :   0..59
\&        $sec    :   0..59
\&        $doy    :   1..366
\&        $dow    :   1..7
\&        $dst    :  -1..1
.Ve
.Sp
"\f(CW$doy\fR\*(L" is the day of year, sometimes also referred to as the
\&\*(R"julian date\*(L", which starts at \*(R"\f(CW1\fR" and goes up to the number
of days in that year.
.Sp
The day of week ("\f(CW$dow\fR\*(L") will be \*(R"\f(CW1\fR\*(L" for Monday, \*(R"\f(CW2\fR\*(L" for
Tuesday and so on until \*(R"\f(CW7\fR" for Sunday.
.Sp
The daylight savings time flag ("\f(CW$dst\fR\*(L") will be \*(R"\f(CW\*(C`\-1\*(C'\fR\*(L" if this
information is not available on your system, \*(R"\f(CW0\fR\*(L" for no daylight
savings time (i.e., winter time) and \*(R"\f(CW1\fR" when daylight savings
time is in effect.
.Sp
A fatal \*(L"time out of range\*(R" error will occur if the given time value
is out of range \f(CW\*(C`[0..(~0>>1)]\*(C'\fR.
.Sp
If the time value is omitted, the \*(L"\fItime()\fR\*(R" function is called instead,
internally.
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day, $hour,$min,$sec, $doy,$dow,$dst) = Localtime([time]);\*(C'\fR
.Sp
This is Date::Calc's equivalent of Perl's built-in \*(L"\fIlocaltime()\fR\*(R" function.
See also \*(L"localtime\*(R" in perlfunc.
.Sp
The ranges of values returned (and their meanings) are as follows:
.Sp
.Vb 2
\&        $year   :   1970..2038 (or more)  [Unix etc.]
\&        $year   :   1904..2040            [MacOS Classic]
.Ve
.Sp
.Vb 8
\&        $month  :   1..12
\&        $day    :   1..31
\&        $hour   :   0..23
\&        $min    :   0..59
\&        $sec    :   0..59
\&        $doy    :   1..366
\&        $dow    :   1..7
\&        $dst    :  -1..1
.Ve
.Sp
"\f(CW$doy\fR\*(L" is the day of year, sometimes also referred to as the
\&\*(R"julian date\*(L", which starts at \*(R"\f(CW1\fR" and goes up to the number
of days in that year.
.Sp
The day of week ("\f(CW$dow\fR\*(L") will be \*(R"\f(CW1\fR\*(L" for Monday, \*(R"\f(CW2\fR\*(L" for
Tuesday and so on until \*(R"\f(CW7\fR" for Sunday.
.Sp
The daylight savings time flag ("\f(CW$dst\fR\*(L") will be \*(R"\f(CW\*(C`\-1\*(C'\fR\*(L" if this
information is not available on your system, \*(R"\f(CW0\fR\*(L" for no daylight
savings time (i.e., winter time) and \*(R"\f(CW1\fR" when daylight savings
time is in effect.
.Sp
A fatal \*(L"time out of range\*(R" error will occur if the given time value is
out of range \f(CW\*(C`[0..(~0>>1)]\*(C'\fR.
.Sp
If the time value is omitted, the \*(L"\fItime()\fR\*(R" function is called instead,
internally.
.IP "\(bu" 2
\&\f(CW\*(C`$time = Mktime($year,$month,$day, $hour,$min,$sec);\*(C'\fR
.Sp
This function converts a date into a time value, i.e., into the number
of seconds since whatever moment in time your system considers to be
the \*(L"epoch\*(R". On Unix and most other systems this is the number of seconds
since January 1st 1970 at midnight (\s-1GMT\s0). On MacOS Classic this is the
number of seconds since January 1st 1904 at midnight (local time).
.Sp
The function is similar to the \*(L"\fIPOSIX::mktime()\fR\*(R" function (see \*(L"mktime\*(R" in \s-1POSIX\s0
for more details), but in contrast to the latter, it expects dates in the
usual ranges used throughout this module: The year 2001 stays year 2001,
and months are numbered from 1 to 12.
.Sp
A fatal \*(L"date out of range\*(R" error will occur if the given date cannot
be expressed in terms of seconds since the epoch (this happens for
instance when the date lies before the epoch, or if it is later than
19\-Jan\-2038\ 03:14:07\ \s-1GMT\s0 on 32\ bit Unix systems, or later than
06\-Feb\-2040\ 06:28:15 (local time) on a Macintosh with MacOS Classic).
.Sp
Just like the \*(L"\fIPOSIX::mktime()\fR\*(R" function, this function uses the
\&\*(L"\fImktime()\fR\*(R" system call, internally.
.Sp
This means that the given date and time is considered to be in local time,
and that the value returned by this function will depend on your machine's
local settings such as the time zone, whether daylight savings time is
(or was, at the time) in effect, and the system clock itself.
.Sp
\&\fB\s-1BEWARE\s0\fR that \*(L"\fImktime()\fR\*(R" does not always return the same time value
as fed into \*(L"\fIlocaltime()\fR\*(R", when you feed the output of \*(L"\fIlocaltime()\fR\*(R"
back into \*(L"\fImktime()\fR\*(R", on some systems!
.Sp
I.e., "\f(CW\*(C`Mktime((Localtime($time))[0..5])\*(C'\fR\*(L" will not always return
the same value as given in \*(R"\f(CW$time\fR"!
.IP "\(bu" 2
\&\f(CW\*(C`($D_y,$D_m,$D_d, $Dh,$Dm,$Ds, $dst) = Timezone([time]);\*(C'\fR
.Sp
This function returns the difference between "\f(CW\*(C`localtime(time)\*(C'\fR\*(L" and
\&\*(R"\f(CW\*(C`gmtime(time)\*(C'\fR\*(L", which is the timezone offset in effect for the current
location and the given \*(R"\f(CW\*(C`time\*(C'\fR".
.Sp
This offset is positive if you are located to the east of Greenwich,
and is usually negative (except during daylight savings time, in some
locations) if you are located to the west of Greenwich.
.Sp
Note that this offset is influenced by all of the relevant system
settings and parameters on your machine; such as locales, environment
variables (e.g. "\f(CW\*(C`TZ\*(C'\fR") and the system clock itself. See the
relevant documentation on your system for more details.
.Sp
If the "\f(CW\*(C`time\*(C'\fR\*(L" is omitted, the \*(R"\f(CW\*(C`time()\*(C'\fR\*(L" function will
be called automatically, internally (similar to the built-in
functions \*(R"\f(CW\*(C`localtime()\*(C'\fR\*(L" and \*(R"\f(CW\*(C`gmtime()\*(C'\fR" in Perl).
.Sp
A fatal \*(L"time out of range\*(R" error will occur if the given time value
is out of range \f(CW\*(C`[0..(~0>>1)]\*(C'\fR.
.Sp
The last item of the returned list is a flag which indicates whether
daylight savings time is currently in effect. This flag is negative
(\-1) if this information is not available on your system. It is zero
(0) when daylight savings time is off, and positive (+1) when daylight
savings time is on.
.Sp
Thus you can check very quickly whether daylight savings time is
currently in effect by evaluating this function in scalar context
(in scalar context, Perl returns the last item of a list):
.Sp
.Vb 1
\&  if (scalar Timezone > 0) { # yes, daylight savings time
.Ve
.Sp
However, a slightly more efficient way would be this:
.Sp
.Vb 1
\&  if (scalar System_Clock > 0) { # yes, daylight savings time
.Ve
.IP "\(bu" 2
\&\f(CW\*(C`$time = Date_to_Time($year,$month,$day, $hour,$min,$sec);\*(C'\fR
.Sp
This function is a replacement for the \s-1BSD\s0 function \*(L"\fItimegm()\fR\*(R"
(which is not available on all Unix systems), which converts
a given date and time into a time value, i.e., into the number
of seconds since whatever moment in time your system considers to be
the \*(L"epoch\*(R". On Unix and most other systems this is the number of seconds
since January 1st 1970 at midnight (\s-1GMT\s0). On MacOS Classic this is the
number of seconds since January 1st 1904 at midnight (local time).
.Sp
Under Unix, the date and time are considered to be in \s-1UTC\s0
(\*(L"Universal Time Coordinated\*(R", and so is the resulting time value.
.Sp
\&\s-1UTC\s0 is almost the same as \s-1GMT\s0 (or \*(L"Greenwich Mean Time\*(R"), except
that \s-1UTC\s0 has leap seconds (in order to account for small variations
in the rotation of the earth, for instance), whereas \s-1GMT\s0 does not.
.Sp
Under MacOS Classic, however, both input and output are
considered to be in local time.
.Sp
The ranges of year and month follow the same rules as throughout
the rest of this module (and not the contorted rules of its Unix
equivalent), i.e., the year \*(L"2001\*(R" stays \*(L"2001\*(R" and the month
ranges from 1 to 12.
.Sp
A fatal \*(L"date out of range\*(R" error will occur if the given date cannot
be expressed in terms of seconds since the epoch (this happens for
instance when the date lies before the epoch, or if it is later than
19\-Jan\-2038\ 03:14:07\ \s-1GMT\s0 on 32\ bit Unix systems, or later than
06\-Feb\-2040\ 06:28:15 (local time) on a Macintosh with MacOS Classic).
.Sp
This function should be very fast, because it is implemented in
a very straightforward manner and doesn't use any internal system
calls.
.Sp
Moreover, the functions \*(L"\fIDate_to_Time()\fR\*(R" and \*(L"\fITime_to_Date()\fR\*(R"
are guaranteed to be complementary, i.e., that
"\f(CW\*(C`Date_to_Time(Time_to_Date($time))\*(C'\fR\*(L" and
\&\*(R"\f(CW\*(C`Time_to_Date(Date_to_Time($year,$month,$day, $hour,$min,$sec))\*(C'\fR"
will always return the initial values.
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day, $hour,$min,$sec) = Time_to_Date([time]);\*(C'\fR
.Sp
This function is an alternative to the \s-1POSIX\s0 \*(L"\fIgmtime()\fR\*(R" function
(and its built-in Perl equivalent), which converts a given time
value into the corresponding date and time. The given time value
must be the number of seconds since whatever moment in time your
system considers to be the \*(L"epoch\*(R". On Unix and most other systems
this is the number of seconds since January 1st 1970 at midnight
(\s-1GMT\s0). On MacOS Classic this is the number of seconds since
January 1st 1904 at midnight (local time).
.Sp
Under Unix, the given time value is considered to be in \s-1UTC\s0
(\*(L"Universal Time Coordinated\*(R", and so is the resulting date
and time.
.Sp
\&\s-1UTC\s0 is almost the same as \s-1GMT\s0 (or \*(L"Greenwich Mean Time\*(R"), except
that \s-1UTC\s0 has leap seconds (in order to account for small variations
in the rotation of the earth, for instance), whereas \s-1GMT\s0 does not.
.Sp
Under MacOS Classic, however, both input and output
are considered to be in local time.
.Sp
If the input value "\f(CW\*(C`time\*(C'\fR\*(L" is omitted, the \*(R"\f(CW\*(C`time()\*(C'\fR\*(L" function
will be called automatically, internally (similar to the built-in
functions \*(R"\f(CW\*(C`localtime()\*(C'\fR\*(L" and \*(R"\f(CW\*(C`gmtime()\*(C'\fR" in Perl).
.Sp
A fatal \*(L"time out of range\*(R" error will occur if the given time
value is negative.
.Sp
This function should be very fast, because it is implemented in
a very straightforward manner and doesn't use any internal system
calls (except for \*(L"\fItime()\fR\*(R", if the input value is omitted).
.Sp
Moreover, the functions \*(L"\fIDate_to_Time()\fR\*(R" and \*(L"\fITime_to_Date()\fR\*(R"
are guaranteed to be complementary, i.e., that
"\f(CW\*(C`Date_to_Time(Time_to_Date($time))\*(C'\fR\*(L" and
\&\*(R"\f(CW\*(C`Time_to_Date(Date_to_Time($year,$month,$day, $hour,$min,$sec))\*(C'\fR"
will always return the initial values.
.IP "\(bu" 2
\&\f(CW\*(C`($year,$month,$day) = Easter_Sunday($year);\*(C'\fR
.Sp
This function calculates the date of Easter Sunday for all years in the
range from 1583 to 2299 (all other year numbers will result in a fatal
\&\*(L"year out of range\*(R" error message) using the method known as the \*(L"Gaussian
Rule\*(R".
.Sp
Some related christian feast days which depend on the date of Easter Sunday:
.Sp
.Vb 11
\&  Carnival Monday / Rosenmontag / Veille du Mardi Gras   =  -48 days
\&  Mardi Gras / Karnevalsdienstag / Mardi Gras            =  -47 days
\&  Ash Wednesday / Aschermittwoch / Mercredi des Cendres  =  -46 days
\&  Palm Sunday / Palmsonntag / Dimanche des Rameaux       =   -7 days
\&  Easter Friday / Karfreitag / Vendredi Saint            =   -2 days
\&  Easter Saturday / Ostersamstag / Samedi de Paques      =   -1 day
\&  Easter Monday / Ostermontag / Lundi de Paques          =   +1 day
\&  Ascension of Christ / Christi Himmelfahrt / Ascension  =  +39 days
\&  Whitsunday / Pfingstsonntag / Dimanche de Pentecote    =  +49 days
\&  Whitmonday / Pfingstmontag / Lundi de Pentecote        =  +50 days
\&  Feast of Corpus Christi / Fronleichnam / Fete-Dieu     =  +60 days
.Ve
.Sp
Use the offsets shown above to calculate the date of the corresponding
feast day as follows:
.Sp
.Vb 1
\&  ($year,$month,$day) = Add_Delta_Days(Easter_Sunday($year), $offset));
.Ve
.IP "\(bu" 2
\&\f(CW\*(C`if ($month = Decode_Month($string))\*(C'\fR
.Sp
This function takes a string as its argument, which should contain the
name of a month \fB\s-1IN\s0 \s-1THE\s0 \s-1CURRENTLY\s0 \s-1SELECTED\s0 \s-1LANGUAGE\s0\fR (see further below
for details about the multi-language support of this package), or any uniquely
identifying abbreviation of a month's name (i.e., the first few letters),
and returns the corresponding number (1..12) upon a successful match, or
"\f(CW0\fR\*(L" otherwise (therefore, the return value can also be used as the
conditional expression in an \*(R"if" statement).
.Sp
Note that the input string may not contain any other characters which do not
pertain to the month's name, especially no leading or trailing whitespace.
.Sp
Note also that matching is performed in a case-insensitive manner (this may
depend on the \*(L"locale\*(R" setting on your current system, though!)
.Sp
With \*(L"English\*(R" as the currently selected language (which is the default),
the following examples will all return the value "\f(CW9\fR":
.Sp
.Vb 4
\&  $month = Decode_Month("s");
\&  $month = Decode_Month("Sep");
\&  $month = Decode_Month("septemb");
\&  $month = Decode_Month("September");
.Ve
.IP "\(bu" 2
\&\f(CW\*(C`if ($dow = Decode_Day_of_Week($string))\*(C'\fR
.Sp
This function takes a string as its argument, which should contain the
name of a day of week \fB\s-1IN\s0 \s-1THE\s0 \s-1CURRENTLY\s0 \s-1SELECTED\s0 \s-1LANGUAGE\s0\fR (see further
below for details about the multi-language support of this package), or any
uniquely identifying abbreviation of the name of a day of week (i.e., the
first few letters), and returns the corresponding number (1..7) upon a
successful match, or "\f(CW0\fR\*(L" otherwise (therefore, the return value can
also be used as the conditional expression in an \*(R"if" statement).
.Sp
Note that the input string may not contain any other characters which
do not pertain to the name of the day of week, especially no leading
or trailing whitespace.
.Sp
Note also that matching is performed in a case-insensitive manner (this may
depend on the \*(L"locale\*(R" setting on your current system, though!)
.Sp
With \*(L"English\*(R" as the currently selected language (which is the default),
the following examples will all return the value "\f(CW3\fR":
.Sp
.Vb 4
\&  $dow = Decode_Day_of_Week("w");
\&  $dow = Decode_Day_of_Week("Wed");
\&  $dow = Decode_Day_of_Week("wednes");
\&  $dow = Decode_Day_of_Week("Wednesday");
.Ve
.IP "\(bu" 2
\&\f(CW\*(C`if ($lang = Decode_Language($string))\*(C'\fR
.Sp
This function takes a string as its argument, which should contain the
name of one of the languages supported by this package (\fB\s-1IN\s0 \s-1THIS\s0 \s-1VERY\s0
\&\s-1LANGUAGE\s0 \s-1ITSELF\s0\fR), or any uniquely identifying abbreviation of the name
of a language (i.e., the first few letters), and returns its corresponding
internal number (1..13 in the original distribution) upon a successful match,
or "\f(CW0\fR\*(L" otherwise (therefore, the return value can also be used as the
conditional expression in an \*(R"if" statement).
.Sp
Note that the input string may not contain any other characters which do
not pertain to the name of a language, especially no leading or trailing
whitespace.
.Sp
Note also that matching is performed in a case-insensitive manner (this may
depend on the \*(L"locale\*(R" setting on your current system, though!)
.Sp
The original distribution supports the following thirteen languages:
.Sp
.Vb 13
\&            English                    ==>    1    (default)