-;; Calendar functions.
-;; Copyright (C) 1988, 1989, 1990, 1991 Free Software Foundation, Inc.
+;;; calendar.el --- Calendar functions.
+
+;;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994 Free Software
+;;; Foundation, Inc.
+
+;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
+;; Keywords: calendar
+;; Human-Keywords: calendar, Gregorian calendar, Julian calendar,
+;; Hebrew calendar, Islamic calendar, ISO calendar, Julian day number,
+;; diary, holidays
;; This file is part of GNU Emacs.
+;; GNU Emacs is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 2, or (at your option)
+;; any later version.
+
;; GNU Emacs is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY. No author or distributor
-;; accepts responsibility to anyone for the consequences of using it
-;; or for whether it serves any particular purpose or works at all,
-;; unless he says so in writing. Refer to the GNU Emacs General Public
-;; License for full details.
-
-;; Everyone is granted permission to copy, modify and redistribute
-;; GNU Emacs, but only under the conditions described in the
-;; GNU Emacs General Public License. A copy of this license is
-;; supposed to have been given to you along with GNU Emacs so you
-;; can know your rights and responsibilities. It should be in a
-;; file named COPYING. Among other things, the copyright notice
-;; and this notice must be preserved on all copies.
-
-;; This collection of functions implements a calendar window. It generates
-;; generates a calendar for the current month, together with the previous and
-;; coming months, or for any other three-month period. The calendar can be
-;; scrolled forward and backward in the window to show months in the past or
-;; future; the cursor can move forward and backward by days, weeks, or months,
-;; making it possible, for instance, to jump to the date a specified number of
-;; days, weeks, or months from the date under the cursor. The user can
-;; display a list of holidays and other notable days for the period shown; the
-;; notable days can be marked on the calendar, if desired. The user can also
-;; specify that dates having corresponding diary entries (in a file that the
-;; user specifies) be marked; the diary entries for any date can be viewed in
-;; a separate window. The diary and the notable days can be viewed
-;; independently of the calendar. Dates can be translated from the (usual)
-;; Gregorian calendar to the day of the year/days remaining in year, to the
-;; ISO commercial calendar, to the Julian (old style) calendar, to the Hebrew
-;; calendar, to the Islamic calendar, and to the French Revolutionary calendar.
-
-;; The diary related functions are in diary.el; the holiday related functions
-;; are in holiday.el
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING. If not, write to
+;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+
+;;; Commentary:
+
+;; This collection of functions implements a calendar window. It
+;; generates a calendar for the current month, together with the previous
+;; and coming months, or for any other three-month period. The calendar
+;; can be scrolled forward and backward in the window to show months in
+;; the past or future; the cursor can move forward and backward by days,
+;; weeks, or months, making it possible, for instance, to jump to the
+;; date a specified number of days, weeks, or months from the date under
+;; the cursor. The user can display a list of holidays and other notable
+;; days for the period shown; the notable days can be marked on the
+;; calendar, if desired. The user can also specify that dates having
+;; corresponding diary entries (in a file that the user specifies) be
+;; marked; the diary entries for any date can be viewed in a separate
+;; window. The diary and the notable days can be viewed independently of
+;; the calendar. Dates can be translated from the (usual) Gregorian
+;; calendar to the day of the year/days remaining in year, to the ISO
+;; commercial calendar, to the Julian (old style) calendar, to the Hebrew
+;; calendar, to the Islamic calendar, to the French Revolutionary calendar,
+;; to the Mayan calendar, and to the astronomical (Julian) day number.
+;; When floating point is available, times of sunrise/sunset can be displayed,
+;; as can the phases of the moon. Appointment notification for diary entries
+;; is available.
+
+;; The following files are part of the calendar/diary code:
+
+;; cal-menu.el Menu support
+;; diary.el, diary-ins.el Diary functions
+;; holidays.el Holiday functions
+;; cal-french.el French Revolutionary calendar
+;; cal-mayan.el Mayan calendars
+;; cal-dst.el Daylight savings time rules
+;; solar.el Sunrise/sunset, equinoxes/solstices
+;; lunar.el Phases of the moon
+;; appt.el Appointment notification
;; Comments, corrections, and improvements should be sent to
;; Edward M. Reingold Department of Computer Science
;; Urbana, Illinois 61801
;; Technical details of all the calendrical calculations can be found in
+
;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
-;; pages 899-928.
+;; pages 899-928. ``Calendrical Calculations, Part II: Three Historical
+;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
+;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
+;; pages 383-404.
-(defconst calendar-version "Version 4.01, released August 20, 1991")
+;; Hard copies of these two papers can be obtained by sending email to
+;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
+;; the message BODY containing your mailing address (snail).
+
+;;; Code:
+
+(defun calendar-version ()
+ (interactive)
+ (message "Version 5.3, January 25, 1994"))
+;;;###autoload
+(defvar calendar-week-start-day 0
+ "*The day of the week on which a week in the calendar begins.
+0 means Sunday (default), 1 means Monday, and so on.")
+
+;;;###autoload
(defvar view-diary-entries-initially nil
- "*If T, the diary entries for the current date will be displayed on entry.
+ "*Non-nil means display current date's diary entries on entry.
The diary is displayed in another window when the calendar is first displayed,
if the current date is visible. The number of days of diary entries displayed
is governed by the variable `number-of-diary-entries'.")
+;;;###autoload
(defvar number-of-diary-entries 1
"*Specifies how many days of diary entries are to be displayed initially.
This variable affects the diary display when the command M-x diary is used,
or if the value of the variable `view-diary-entries-initially' is t. For
example, if the default value 1 is used, then only the current day's diary
entries will be displayed. If the value 2 is used, then both the current
-day's and the next day's entries will be displayed. The value can also be
-a vector such as [0 2 2 2 2 4 1]; this value will cause no diary entries to
-be displayed on Sunday, the current date's and the next day's diary entries
-to be displayed Monday through Thursday, Friday through Monday's entries to
-be displayed on Friday, and only Saturday's entries to be displayed on
-Saturday. This variable does not affect the diary display with the `d'
-command from the calendar; in that case, the prefix argument controls the
+day's and the next day's entries will be displayed.
+
+The value can also be a vector such as [0 2 2 2 2 4 1]; this value
+says to display no diary entries on Sunday, the display the entries
+for the current date and the day after on Monday through Thursday,
+display Friday through Monday's entries on Friday, and display only
+Saturday's entries on Saturday.
+
+This variable does not affect the diary display with the `d' command
+from the calendar; in that case, the prefix argument controls the
number of days of diary entries displayed.")
+;;;###autoload
(defvar mark-diary-entries-in-calendar nil
- "*If t, dates with diary entries will be marked in the calendar window.
+ "*Non-nil means mark dates with diary entries, in the calendar window.
The marking symbol is specified by the variable `diary-entry-marker'.")
-(defvar diary-entry-marker "+"
- "*The symbol used to mark dates that have diary entries.")
-
+(defvar diary-entry-marker
+ (if (not window-system)
+ "+"
+ (require 'faces)
+ (make-face 'diary-face)
+ (if (x-display-color-p)
+ (set-face-foreground 'diary-face "red")
+ (copy-face 'bold 'diary-face))
+ 'diary-face)
+ "*Used to mark dates that have diary entries.
+Can be either a single-character string or a face.")
+
+(defvar calendar-today-marker
+ (if (not window-system)
+ "="
+ (require 'faces)
+ (make-face 'calendar-today-face)
+ (set-face-underline-p 'calendar-today-face t)
+ 'calendar-today-face)
+ "*Used to mark today's date.
+Can be either a single-character string or a face.")
+
+(defvar calendar-holiday-marker
+ (if (not window-system)
+ "*"
+ (require 'faces)
+ (make-face 'holiday-face)
+ (if (x-display-color-p)
+ (set-face-background 'holiday-face "pink")
+ (set-face-background 'holiday-face "black")
+ (set-face-foreground 'holiday-face "white"))
+ 'holiday-face)
+ "*Used to mark notable dates in the calendar.
+Can be either a single-character string or a face.")
+
+;;;###autoload
(defvar view-calendar-holidays-initially nil
- "*If t, the holidays for the current three month period will be displayed
-on entry. The holidays are displayed in another window when the calendar is
-first displayed.")
+ "*Non-nil means display holidays for current three month period on entry.
+The holidays are displayed in another window when the calendar is first
+displayed.")
+;;;###autoload
(defvar mark-holidays-in-calendar nil
- "*If t, dates of holidays will be marked in the calendar window.
+ "*Non-nil means mark dates of holidays in the calendar window.
The marking symbol is specified by the variable `calendar-holiday-marker'.")
-(defvar calendar-holiday-marker "*"
- "*The symbol used to mark notable dates in the calendar.")
-
+;;;###autoload
(defvar all-hebrew-calendar-holidays nil
- "*If nil, the holidays from the Hebrew calendar that are shown will
-include only those days of such major interest as to appear on secular
-calendars. If t, the holidays shown in the calendar will include all
-special days that would be shown on a complete Hebrew calendar.")
+ "*If nil, show only major holidays from the Hebrew calendar.
+This means only those Jewish holidays that appear on secular calendars.
+
+If t, show all the holidays that would appear in a complete Hebrew calendar.")
+;;;###autoload
(defvar all-christian-calendar-holidays nil
- "*If nil, the holidays from the Christian calendar that are shown will
-include only those days of such major interest as to appear on secular
-calendars. If t, the holidays shown in the calendar will include all
-special days that would be shown on a complete Christian calendar.")
+ "*If nil, show only major holidays from the Christian calendar.
+This means only those Christian holidays that appear on secular calendars.
+If t, show all the holidays that would appear in a complete Christian
+calendar.")
+
+;;;###autoload
(defvar all-islamic-calendar-holidays nil
- "*If nil, the holidays from the Islamic calendar that are shown will
-include only those days of such major interest as to appear on secular
-calendars. If t, the holidays shown in the calendar will include all
-special days that would be shown on a complete Islamic calendar.")
+ "*If nil, show only major holidays from the Islamic calendar.
+This means only those Islamic holidays that appear on secular calendars.
+
+If t, show all the holidays that would appear in a complete Islamic
+calendar.")
+;;;###autoload
+(defvar calendar-load-hook nil
+ "*List of functions to be called after the calendar is first loaded.
+This is the place to add key bindings to `calendar-mode-map'.")
+
+;;;###autoload
(defvar initial-calendar-window-hook nil
"*List of functions to be called when the calendar window is first opened.
The functions invoked are called after the calendar window is opened, but
once opened is never called again. Leaving the calendar with the `q' command
and reentering it will cause these functions to be called again.")
+;;;###autoload
(defvar today-visible-calendar-hook nil
"*List of functions called whenever the current date is visible.
This can be used, for example, to replace today's date with asterisks; a
function `calendar-star-date' is included for this purpose:
(setq today-visible-calendar-hook 'calendar-star-date)
-It could also be used to mark the current date with `='; a function is also
-provided for this:
+It can also be used to mark the current date with `calendar-today-marker';
+a function is also provided for this:
(setq today-visible-calendar-hook 'calendar-mark-today)
The corresponding variable `today-invisible-calendar-hook' is the list of
characters in the calendar buffer by the hooks may cause the failure of the
functions that move by days and weeks.")
+;;;###autoload
(defvar today-invisible-calendar-hook nil
"*List of functions called whenever the current date is not visible.
characters in the calendar buffer by the hooks may cause the failure of the
functions that move by days and weeks.")
+;;;###autoload
(defvar diary-file "~/diary"
"*Name of the file in which one's personal diary of dates is kept.
To revert to the default American style from the European style, execute
`american-calendar' in the calendar.
-A diary entry can be preceded by a diary-nonmarking-symbol (ordinarily `&')
-to make that entry nonmarking--that is, it will not be marked on dates in
-the calendar window but will appear in a diary window.
+A diary entry can be preceded by the character
+`diary-nonmarking-symbol' (ordinarily `&') to make that entry
+nonmarking--that is, it will not be marked on dates in the calendar
+window but will appear in a diary window.
Multiline diary entries are made by indenting lines after the first with
either a TAB or one or more spaces.
&* 15 time cards due.
If the first line of a diary entry consists only of the date or day name with
-no trailing blanks or punctuation, then that line will not be displayed in the
-diary window; only the continuation lines will be shown. For example, the
+no trailing blanks or punctuation, then that line is not displayed in the
+diary window; only the continuation lines is shown. For example, the
single diary entry
02/11/1989
causes the diary entry \"Vacation\" to appear from November 1 through November
10, 1990. Other functions available are `diary-float', `diary-anniversary',
-`diary-cyclic', `day-of-year', `iso-date', `commercial-date', `french-date',
-`hebrew-date', `islamic-date', `parasha', `omer', and `rosh-hodesh'. See the
-documentation for the function `list-sexp-diary-entries' for more details.
+`diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date',
+`diary-hebrew-date', `diary-islamic-date', `diary-mayan-date',
+`diary-yahrzeit', `diary-sunrise-sunset', `diary-phases-of-moon',
+`diary-parasha', `diary-omer', `diary-rosh-hodesh', and
+`diary-sabbath-candles'. See the documentation for the function
+`list-sexp-diary-entries' for more details.
Diary entries based on the Hebrew and/or the Islamic calendar are also
possible, but because these are somewhat slow, they are ignored
Diary files can contain directives to include the contents of other files; for
details, see the documentation for the variable `list-diary-entries-hook'.")
+;;;###autoload
(defvar diary-nonmarking-symbol "&"
- "*The symbol used to indicate that a diary entry is not to be marked in the
-calendar window.")
+ "*Symbol indicating that a diary entry is not to be marked in the calendar.")
+;;;###autoload
(defvar hebrew-diary-entry-symbol "H"
- "*The symbol used to indicate that a diary entry is according to the
-Hebrew calendar.")
+ "*Symbol indicating a diary entry according to the Hebrew calendar.")
+;;;###autoload
(defvar islamic-diary-entry-symbol "I"
- "*The symbol used to indicate that a diary entry is according to the
-Islamic calendar.")
+ "*Symbol indicating a diary entry according to the Islamic calendar.")
+;;;###autoload
(defvar diary-include-string "#include"
- "*The string used to indicate the inclusion of another file of diary entries
-in diary-file. See the documentation for the function
-`include-other-diary-files'.")
+ "*The string indicating inclusion of another file of diary entries.
+See the documentation for the function `include-other-diary-files'.")
+;;;###autoload
(defvar sexp-diary-entry-symbol "%%"
"*The string used to indicate a sexp diary entry in diary-file.
See the documentation for the function `list-sexp-diary-entries'.")
+;;;###autoload
(defvar abbreviated-calendar-year t
- "*Interpret a two-digit year DD in a diary entry as being either 19DD or
-20DD, as appropriate, for the Gregorian calendar; similarly for the Hebrew and
-Islamic calendars. If this variable is nil, years must be written in full.")
+ "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
+For the Gregorian calendar; similarly for the Hebrew and Islamic calendars.
+If this variable is nil, years must be written in full.")
+;;;###autoload
(defvar european-calendar-style nil
- "*Use the European style of dates in the diary and in any displays. If this
-variable is t, a date 1/2/1990 would be interpreted as February 1, 1990.
-The accepted European date styles are
+ "*Use the European style of dates in the diary and in any displays.
+If this variable is t, a date 1/2/1990 would be interpreted as February 1,
+1990. The accepted European date styles are
DAY/MONTH
DAY/MONTH/YEAR
Names can be capitalized or not, written in full, or abbreviated to three
characters with or without a period.")
+;;;###autoload
(defvar american-date-diary-pattern
'((month "/" day "[^/0-9]")
(month "/" day "/" year "[^0-9]")
(monthname " *" day ", *" year "[^0-9]")
(dayname "\\W"))
"*List of pseudo-patterns describing the American patterns of date used.
-See the documentation of diary-date-forms for an explanantion.")
+See the documentation of `diary-date-forms' for an explanation.")
+;;;###autoload
(defvar european-date-diary-pattern
'((day "/" month "[^/0-9]")
(day "/" month "/" year "[^0-9]")
(day " *" monthname " *" year "[^0-9]")
(dayname "\\W"))
"*List of pseudo-patterns describing the European patterns of date used.
-See the documentation of diary-date-forms for an explanantion.")
+See the documentation of `diary-date-forms' for an explanation.")
(defvar diary-date-forms
(if european-calendar-style
If, to be mutually exclusive, a pseudo-pattern must match a portion of the
diary entry itself, the first element of the pattern MUST be `backup'. This
-directive causes the the date recognizer to back up to the beginning of the
-current word of the diary entry, so in no case can the pattern match more
-than a portion of the first word of the diary entry.")
+directive causes the date recognizer to back up to the beginning of the
+current word of the diary entry, so in no case can the pattern match more than
+a portion of the first word of the diary entry.")
+;;;###autoload
(defvar european-calendar-display-form
- '(dayname ", " day " " monthname " " year)
- "*The pseudo-pattern that governs the way a Gregorian date is formatted
-in the European style. See the documentation of calendar-date-display-forms
-for an explanantion.")
+ '((if dayname (concat dayname ", ")) day " " monthname " " year)
+ "*Pseudo-pattern governing the way a date appears in the European style.
+See the documentation of calendar-date-display-form for an explanation.")
+;;;###autoload
(defvar american-calendar-display-form
- '(dayname ", " monthname " " day ", " year)
- "*The pseudo-pattern that governs the way a Gregorian date is formatted
-in the American style. See the documentation of calendar-date-display-forms
-for an explanantion.")
+ '((if dayname (concat dayname ", ")) monthname " " day ", " year)
+ "*Pseudo-pattern governing the way a date appears in the American style.
+See the documentation of `calendar-date-display-form' for an explanation.")
(defvar calendar-date-display-form
(if european-calendar-style
european-calendar-display-form
american-calendar-display-form)
- "*The pseudo-pattern that governs the way a Gregorian date is formatted
-as a string by the function `calendar-date-string'. A pseudo-pattern is a
-list of expressions that can involve the keywords `month', `day', and
-`year', all numbers in string form, and `monthname' and `dayname', both
-alphabetic strings. For example, the ISO standard would use the pseudo-
-pattern
+ "*Pseudo-pattern governing the way a date appears.
+
+Used by the function `calendar-date-string', a pseudo-pattern is a list of
+expressions that can involve the keywords `month', `day', and `year', all
+numbers in string form, and `monthname' and `dayname', both alphabetic
+strings. For example, the ISO standard would use the pseudo- pattern
'(year \"-\" month \"-\" day)
(setq diary-date-forms american-date-diary-pattern)
(update-calendar-mode-line))
-(defvar print-diary-entries-hook
- '(add-diary-heading lpr-buffer (lambda nil (kill-buffer temp-buffer)))
- "*List of functions to be called after a temporary buffer is prepared
-with the diary entries currently visible in the diary buffer. The default
-value adds a heading (formed from the information in the mode line of the
-diary buffer), does the printing, and kills the buffer. Other uses might
-include, for example, rearranging the lines into order by day and time,
-saving the buffer instead of deleting it, or changing the function used to
-do the printing.")
+;;;###autoload
+(defvar print-diary-entries-hook 'lpr-buffer
+ "*List of functions called after a temporary diary buffer is prepared.
+The buffer shows only the diary entries currently visible in the diary
+buffer. The default just does the printing. Other uses might include, for
+example, rearranging the lines into order by day and time, saving the buffer
+instead of deleting it, or changing the function used to do the printing.")
+;;;###autoload
(defvar list-diary-entries-hook nil
- "*List of functions to be called after the diary file is culled for
-relevant entries. It is to be used for diary entries that are not found in
-the diary file.
+ "*List of functions called after diary file is culled for relevant entries.
+It is to be used for diary entries that are not found in the diary file.
A function `include-other-diary-files' is provided for use as the value of
this hook. This function enables you to use shared diary files together
-with your own. The files included are specified in the diary-file by lines
+with your own. The files included are specified in the diary file by lines
of the form
#include \"filename\"
obeyed. You can change the \"#include\" to some other string by changing
the variable `diary-include-string'. When you use `include-other-diary-files'
as part of the list-diary-entries-hook, you will probably also want to use the
-function `mark-included-diary-files' as part of the mark-diary-entries-hook.
+function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
For example, you could use
(setq list-diary-entries-hook
- '(include-other-diary-files
- (lambda nil
- (setq diary-entries-list
- (sort diary-entries-list 'diary-entry-compare)))))
+ '(include-other-diary-files sort-diary-entries))
(setq diary-display-hook 'fancy-diary-display)
-in your .emacs file to cause the fancy diary buffer to be displayed with
+in your `.emacs' file to cause the fancy diary buffer to be displayed with
diary entries from various included files, each day's entries sorted into
lexicographic order.")
-(defvar diary-display-hook 'simple-diary-display
+;;;###autoload
+(defvar diary-hook nil
+ "*List of functions called after the display of the diary.
+Can be used for appointment notification.")
+
+;;;###autoload
+(defvar diary-display-hook nil
"*List of functions that handle the display of the diary.
+If nil (the default), `simple-diary-display' is used. Use `ignore' for no
+diary display.
Ordinarily, this just displays the diary buffer (with holidays indicated in
the mode line), if there are any relevant entries. At the time these
functions are called, the variable `diary-entries-list' is a list, in order
by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
STRING), where string is the diary entry for the given date. This can be
-used, for example, to handle appointment notification, prepare a different
-buffer for display (perhaps combined with holidays), or produce hard copy
-output.
+used, for example, a different buffer for display (perhaps combined with
+holidays), or produce hard copy output.
A function `fancy-diary-display' is provided as an alternative
choice for this hook; this function prepares a special noneditable diary
if that day is a holiday; if you want such days to be shown in the fancy
diary buffer, set the variable `diary-list-include-blanks' to t.")
+;;;###autoload
(defvar nongregorian-diary-listing-hook nil
- "*List of functions to be called for the diary file and included files as
-they are processed for listing diary entries. You can use any or all of
-`list-hebrew-diary-entries', `yahrzeit-diary-entry', and
-`list-islamic-diary-entries'. The documentation for these functions
+ "*List of functions called for listing diary file and included files.
+As the files are processed for diary entries, these functions are used to cull
+relevant entries. You can use either or both of `list-hebrew-diary-entries'
+and `list-islamic-diary-entries'. The documentation for these functions
describes the style of such diary entries.")
+;;;###autoload
(defvar mark-diary-entries-hook nil
"*List of functions called after marking diary entries in the calendar.
A function `mark-included-diary-files' is also provided for use as the
mark-diary-entries-hook; it enables you to use shared diary files together
-with your own. The files included are specified in the diary-file by lines
+with your own. The files included are specified in the diary file by lines
of the form
#include \"filename\"
This is recursive; that is, #include directives in files thus included are
obeyed. You can change the \"#include\" to some other string by changing the
variable `diary-include-string'. When you use `mark-included-diary-files' as
part of the mark-diary-entries-hook, you will probably also want to use the
-function `include-other-diary-files' as part of the list-diary-entries-hook.")
+function `include-other-diary-files' as part of `list-diary-entries-hook'.")
+;;;###autoload
(defvar nongregorian-diary-marking-hook nil
- "*List of functions to be called as the diary file and included files are
-processed for marking diary entries. You can use either or both of
-mark-hebrew-diary-entries and mark-islamic-diary-entries. The documentation
-for these functions describes the style of such diary entries.")
+ "*List of functions called for marking diary file and included files.
+As the files are processed for diary entries, these functions are used to cull
+relevant entries. You can use either or both of `mark-hebrew-diary-entries'
+and `mark-islamic-diary-entries'. The documentation for these functions
+describes the style of such diary entries.")
+;;;###autoload
(defvar diary-list-include-blanks nil
- "*If nil, do not include days with no diary entry in the list of diary
-entries. Such days will then not be shown in the the fancy diary buffer,
-even if they are holidays.")
+ "*If nil, do not include days with no diary entry in the list of diary entries.
+Such days will then not be shown in the the fancy diary buffer, even if they
+are holidays.")
+;;;###autoload
(defvar holidays-in-diary-buffer t
- "*If t, the holidays will be indicated in the mode line of the diary buffer
-(or in the fancy diary buffer next to the date). This slows down the diary
-functions somewhat; setting it to nil will make the diary display faster.")
-
-(defvar calendar-holidays
- '(
-;; General Holidays (American)
- (fixed 1 1 "New Year's Day")
- (float 1 1 3 "Martin Luther King Day")
- (fixed 2 2 "Ground Hog Day")
- (fixed 2 14 "Valentine's Day")
- (float 2 1 3 "President's Day")
- (fixed 3 17 "St. Patrick's Day")
- (fixed 4 1 "April Fool's Day")
- (float 4 0 1 "Daylight Savings Time Begins")
- (float 5 0 2 "Mother's Day")
- (float 5 1 -1 "Memorial Day")
- (fixed 6 14 "Flag Day")
- (float 6 0 3 "Father's Day")
- (fixed 7 4 "Independence Day")
- (float 9 1 1 "Labor Day")
- (float 10 1 2 "Columbus Day")
- (float 10 0 -1 "Daylight Savings Time Ends")
- (fixed 10 31 "Halloween")
- (fixed 11 11 "Veteran's Day")
- (float 11 4 4 "Thanksgiving")
-
-;; Christian Holidays
- (if all-christian-calendar-holidays
- (fixed 1 6 "Epiphany"))
- (easter-etc)
- (if all-christian-calendar-holidays
- (fixed 8 15 "Assumption"))
- (if all-christian-calendar-holidays
- (advent))
- (fixed 12 25 "Christmas")
- (if all-christian-calendar-holidays
- (julian 12 25 "Eastern Orthodox Christmas"))
-
-;; Jewish Holidays
- (rosh-hashanah-etc)
+ "*Non-nil means include holidays in the diary display.
+The holidays appear in the mode line of the diary buffer, or in the
+fancy diary buffer next to the date. This slows down the diary functions
+somewhat; setting it to nil makes the diary display faster.")
+
+(defvar calendar-mark-ring nil)
+
+;;;###autoload
+(put 'general-holidays 'risky-local-variable t)
+;;;###autoload
+(defvar general-holidays
+ '((holiday-fixed 1 1 "New Year's Day")
+ (holiday-float 1 1 3 "Martin Luther King Day")
+ (holiday-fixed 2 2 "Ground Hog Day")
+ (holiday-fixed 2 14 "Valentine's Day")
+ (holiday-float 2 1 3 "President's Day")
+ (holiday-fixed 3 17 "St. Patrick's Day")
+ (holiday-fixed 4 1 "April Fool's Day")
+ (holiday-float 5 0 2 "Mother's Day")
+ (holiday-float 5 1 -1 "Memorial Day")
+ (holiday-fixed 6 14 "Flag Day")
+ (holiday-float 6 0 3 "Father's Day")
+ (holiday-fixed 7 4 "Independence Day")
+ (holiday-float 9 1 1 "Labor Day")
+ (holiday-float 10 1 2 "Columbus Day")
+ (holiday-fixed 10 31 "Halloween")
+ (holiday-fixed 11 11 "Veteran's Day")
+ (holiday-float 11 4 4 "Thanksgiving"))
+ "*General holidays. Default value is for the United States.
+See the documentation for `calendar-holidays' for details.")
+
+;;;###autoload
+(put 'local-holidays 'risky-local-variable t)
+;;;###autoload
+(defvar local-holidays nil
+ "*Local holidays.
+See the documentation for `calendar-holidays' for details.")
+
+;;;###autoload
+(put 'other-holidays 'risky-local-variable t)
+;;;###autoload
+(defvar other-holidays nil
+ "*User defined holidays.
+See the documentation for `calendar-holidays' for details.")
+
+;;;###autoload
+(put 'hebrew-holidays-1 'risky-local-variable t)
+;;;###autoload
+(defvar hebrew-holidays-1
+ '((holiday-rosh-hashanah-etc)
(if all-hebrew-calendar-holidays
- (julian 11
- (let* ((m displayed-month)
- (y displayed-year)
- (year))
- (increment-calendar-month m y -1)
- (let ((year (extract-calendar-year
- (calendar-julian-from-absolute
- (calendar-absolute-from-gregorian
- (list m 1 y))))))
- (if (zerop (% (1+ year) 4))
- 22
- 21))) "\"Tal Umatar\" (evening)"))
- (if all-hebrew-calendar-holidays
- (hanukkah)
- (hebrew 9 25 "Hanukkah"))
- (if all-hebrew-calendar-holidays
- (hebrew 10
- (let ((h-year (extract-calendar-year
- (calendar-hebrew-from-absolute
- (calendar-absolute-from-gregorian
- (list displayed-month 28 displayed-year))))))
- (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
- 7)
- 6)
- 11 10))
- "Tzom Teveth"))
+ (holiday-julian
+ 11
+ (let* ((m displayed-month)
+ (y displayed-year)
+ (year))
+ (increment-calendar-month m y -1)
+ (let ((year (extract-calendar-year
+ (calendar-julian-from-absolute
+ (calendar-absolute-from-gregorian
+ (list m 1 y))))))
+ (if (zerop (% (1+ year) 4))
+ 22
+ 21))) "\"Tal Umatar\" (evening)"))))
+
+;;;###autoload
+(put 'hebrew-holidays-2 'risky-local-variable t)
+;;;###autoload
+(defvar hebrew-holidays-2
+ '((if all-hebrew-calendar-holidays
+ (holiday-hanukkah)
+ (holiday-hebrew 9 25 "Hanukkah"))
(if all-hebrew-calendar-holidays
- (hebrew 11 15 "Tu B'Shevat"))
+ (holiday-hebrew
+ 10
+ (let ((h-year (extract-calendar-year
+ (calendar-hebrew-from-absolute
+ (calendar-absolute-from-gregorian
+ (list displayed-month 28 displayed-year))))))
+ (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
+ 7)
+ 6)
+ 11 10))
+ "Tzom Teveth"))
(if all-hebrew-calendar-holidays
- (hebrew
+ (holiday-hebrew 11 15 "Tu B'Shevat"))))
+
+;;;###autoload
+(put 'hebrew-holidays-3 'risky-local-variable t)
+;;;###autoload
+(defvar hebrew-holidays-3
+ '((if all-hebrew-calendar-holidays
+ (holiday-hebrew
11
(let ((m displayed-month)
(y displayed-year))
(list 11 16 h-year))))))
(day (extract-calendar-day s-s)))
day))
- "Shabbat Shirah"))
- (passover-etc)
+ "Shabbat Shirah"))))
+
+;;;###autoload
+(put 'hebrew-holidays-4 'risky-local-variable t)
+;;;###autoload
+(defvar hebrew-holidays-4
+ '((holiday-passover-etc)
(if (and all-hebrew-calendar-holidays
(let* ((m displayed-month)
(y displayed-year)
(calendar-absolute-from-gregorian
(list m 1 y))))))
(= 21 (% year 28)))))
- (julian 3 26 "Kiddush HaHamah"))
+ (holiday-julian 3 26 "Kiddush HaHamah"))
(if all-hebrew-calendar-holidays
- (tisha-b-av-etc))
-
-;; Islamic Holidays
- (islamic 1 1 (format "Islamic New Year %d"
- (let ((m displayed-month)
- (y displayed-year))
- (increment-calendar-month m y 1)
- (extract-calendar-year
- (calendar-islamic-from-absolute
- (calendar-absolute-from-gregorian
- (list m (calendar-last-day-of-month m y) y)))))))
+ (holiday-tisha-b-av-etc))))
+
+;;;###autoload
+(put 'hebrew-holidays 'risky-local-variable t)
+;;;###autoload
+(defvar hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
+ hebrew-holidays-3 hebrew-holidays-4)
+ "*Jewish holidays.
+See the documentation for `calendar-holidays' for details.")
+
+;;;###autoload
+(put 'christian-holidays 'risky-local-variable t)
+;;;###autoload
+(defvar christian-holidays
+ '((if all-christian-calendar-holidays
+ (holiday-fixed 1 6 "Epiphany"))
+ (holiday-easter-etc)
+ (if all-christian-calendar-holidays
+ (holiday-greek-orthodox-easter))
+ (if all-christian-calendar-holidays
+ (holiday-fixed 8 15 "Assumption"))
+ (if all-christian-calendar-holidays
+ (holiday-advent))
+ (holiday-fixed 12 25 "Christmas")
+ (if all-christian-calendar-holidays
+ (holiday-julian 12 25 "Eastern Orthodox Christmas")))
+ "*Christian holidays.
+See the documentation for `calendar-holidays' for details.")
+
+;;;###autoload
+(put 'islamic-holidays 'risky-local-variable t)
+;;;###autoload
+(defvar islamic-holidays
+ '((holiday-islamic
+ 1 1
+ (format "Islamic New Year %d"
+ (let ((m displayed-month)
+ (y displayed-year))
+ (increment-calendar-month m y 1)
+ (extract-calendar-year
+ (calendar-islamic-from-absolute
+ (calendar-absolute-from-gregorian
+ (list
+ m (calendar-last-day-of-month m y) y)))))))
(if all-islamic-calendar-holidays
- (islamic 1 10 "Ashura"))
+ (holiday-islamic 1 10 "Ashura"))
(if all-islamic-calendar-holidays
- (islamic 3 12 "Mulad-al-Nabi"))
+ (holiday-islamic 3 12 "Mulad-al-Nabi"))
(if all-islamic-calendar-holidays
- (islamic 7 26 "Shab-e-Mi'raj"))
+ (holiday-islamic 7 26 "Shab-e-Mi'raj"))
(if all-islamic-calendar-holidays
- (islamic 8 15 "Shab-e-Bara't"))
- (islamic 9 1 "Ramadan Begins")
+ (holiday-islamic 8 15 "Shab-e-Bara't"))
+ (holiday-islamic 9 1 "Ramadan Begins")
(if all-islamic-calendar-holidays
- (islamic 9 27 "Shab-e Qadr"))
+ (holiday-islamic 9 27 "Shab-e Qadr"))
(if all-islamic-calendar-holidays
- (islamic 10 1 "Id-al-Fitr"))
+ (holiday-islamic 10 1 "Id-al-Fitr"))
(if all-islamic-calendar-holidays
- (islamic 12 10 "Id-al-Adha")))
- "List of notable days for the command M-x holidays.
-Additional holidays are easy to add to the list. The possible holiday-forms
-are as follows:
-
- (fixed MONTH DAY STRING) a fixed date on the Gregorian calendar
- (float MONTH DAYNAME K STRING) the Kth DAYNAME in MONTH on the Gregorian
- calendar (0 for Sunday, etc.); K<0 means
- count back from the end of the month
- (hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
- (islamic MONTH DAY STRING) a fixed date on the Islamic calendar
- (julian MONTH DAY STRING) a fixed date on the Julian calendar
- (if BOOLEAN HOLIDAY-FORM &optional HOLIDAY-FORM) gives a choice between
- two holidays based on the value of BOOLEAN
- (FUNCTION &optional ARGS) dates requiring special computation; ARGS,
- if any, are passed in a list to the function
- `calendar-holiday-function-FUNCTION'
+ (holiday-islamic 12 10 "Id-al-Adha")))
+ "*Islamic holidays.
+See the documentation for `calendar-holidays' for details.")
+
+;;;###autoload
+(put 'solar-holidays 'risky-local-variable t)
+;;;###autoload
+(defvar solar-holidays
+ '((if (fboundp 'atan)
+ (solar-equinoxes-solstices))
+ (if (progn
+ (require 'cal-dst)
+ t)
+ (funcall
+ 'holiday-sexp
+ calendar-daylight-savings-starts
+ '(format "Daylight Savings Time Begins %s"
+ (if (fboundp 'atan)
+ (solar-time-string
+ (/ calendar-daylight-savings-starts-time
+ (float 60))
+ date
+ 'standard)
+ ""))))
+ (funcall
+ 'holiday-sexp
+ calendar-daylight-savings-ends
+ '(format "Daylight Savings Time Ends %s"
+ (if (fboundp 'atan)
+ (solar-time-string
+ (/ (- calendar-daylight-savings-ends-time
+ calendar-daylight-time-offset)
+ (float 60))
+ date
+ 'daylight)
+ ""))))
+ "*Sun-related holidays.
+See the documentation for `calendar-holidays' for details.")
+
+;;;###autoload
+(put 'calendar-holidays 'risky-local-variable t)
+(defvar calendar-holidays
+ (append general-holidays local-holidays other-holidays
+ christian-holidays hebrew-holidays islamic-holidays
+ solar-holidays)
+ "*List of notable days for the command M-x holidays.
+
+Additional holidays are easy to add to the list, just put them in the list
+`other-holidays' in your .emacs file. Similarly, by setting any of
+`general-holidays', `local-holidays' `christian-holidays', `hebrew-holidays',
+`islamic-holidays', or `solar-holidays' to nil in your .emacs file, you can
+eliminate unwanted categories of holidays. The intention is that (in the US)
+`local-holidays' be set in site-init.el and `other-holidays' be set by the
+user.
+
+Entries on the list are expressions that return (possibly empty) lists of
+items of the form ((month day year) string) of a holiday in the in the
+three-month period centered around `displayed-month' of `displayed-year'.
+Several basic functions are provided for this purpose:
+
+ (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
+ (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
+ MONTH on the Gregorian calendar (0 for Sunday,
+ etc.); K<0 means count back from the end of the
+ month. An optional parameter DAY means the Kth
+ DAYNAME after/before MONTH DAY.
+ (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
+ (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
+ (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
+ (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
+ in the variable `year'; if it evaluates to
+ a visible date, that's the holiday; if it
+ evaluates to nil, there's no holiday. STRING
+ is an expression in the variable `date'.
For example, to add Bastille Day, celebrated in France on July 14, add
- (fixed 7 14 \"Bastille Day\")
+ (holiday-fixed 7 14 \"Bastille Day\")
to the list. To add Hurricane Supplication Day, celebrated in the Virgin
Islands on the fourth Monday in August, add
- (float 8 1 4 \"Hurricane Supplication Day\")
+ (holiday-float 8 1 4 \"Hurricane Supplication Day\")
to the list (the last Monday would be specified with `-1' instead of `4').
-To add the last day of Hanukah to the list, use
+To add the last day of Hanukkah to the list, use
- (hebrew 10 2 \"Last day of Hanukah\")
+ (holiday-hebrew 10 2 \"Last day of Hanukkah\")
since the Hebrew months are numbered with 1 starting from Nisan, while to
add the Islamic feast celebrating Mohammed's birthday use
- (islamic 3 12 \"Mohammed's Birthday\")
+ (holiday-islamic 3 12 \"Mohammed's Birthday\")
since the Islamic months are numbered from 1 starting with Muharram. To
add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
- (julian 4 2 \"Jefferson's Birthday\")
+ (holiday-julian 4 2 \"Jefferson's Birthday\")
+
+To include a holiday conditionally, use the sexp form or a conditional. For
+example, to include American presidential elections, which occur on the first
+Tuesday after the first Monday in November of years divisible by 4, add
+
+ (holiday-sexp
+ (if (zerop (% year 4))
+ (calendar-gregorian-from-absolute
+ (1+ (calendar-dayname-on-or-before
+ 1 (+ 6 (calendar-absolute-from-gregorian
+ (list 11 1 year)))))))
+ \"US Presidential Election\")
-To include a holiday conditionally, use the if form. For example, to
-include American presidential elections, which occur on the first Tuesday
-after the first Monday in November of years divisble by 4, add
+or
(if (zerop (% displayed-year 4))
- (fixed 11
+ (holiday-fixed 11
(extract-calendar-day
(calendar-gregorian-from-absolute
(1+ (calendar-dayname-on-or-before
(lunar-phases)
-to the holiday list, where `calendar-holiday-function-lunar-phases' is an
-Emacs-Lisp function that you've written to return a (possibly empty) list of
-the relevant VISIBLE dates with descriptive strings such as
-
- (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )
-
-The fixed, float, hebrew, islamic, julian and if forms are implemented by
-the inclusion of the functions `calendar-holiday-function-fixed',
-`calendar-holiday-function-float', `calendar-holiday-function-hebrew',
-`calendar-holiday-function-islamic', `calendar-holiday-function-julian',
-and `calendar-holiday-function-if', respectively.")
+to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
+you've written to return a (possibly empty) list of the relevant VISIBLE dates
+with descriptive strings such as
+ (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... ).")
(defconst calendar-buffer "*Calendar*"
"Name of the buffer used for the calendar.")
"Name of the buffer used for the optional fancy display of the diary.")
(defmacro increment-calendar-month (mon yr n)
- "Move the variables MON and YR to the month and year N months forward
-if N is positive or backward if N is negative."
+ "Move the variables MON and YR to the month and year by N months.
+Forward if N is positive or backward if N is negative."
(` (let (( macro-y (+ (* (, yr) 12) (, mon) -1 (, n) )))
(setq (, mon) (1+ (% macro-y 12) ))
(setq (, yr) (/ macro-y 12)))))
(,@ body)))))
(defmacro calendar-sum (index initial condition expression)
- "For INDEX = INITIAL and successive integers, as long as CONDITION holds,
-sum EXPRESSION."
+ "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
(` (let (( (, index) (, initial))
(sum 0))
(while (, condition)
(setq (, index) (1+ (, index))))
sum)))
+;; The following macros are for speed; the code would be clearer if they
+;; were functions, but they can be called thousands of times when
+;; looking up holidays or processing the diary. Here, for example, are the
+;; numbers of calls to calendar/diary/holiday functions in preparing the
+;; fancy diary display, for a moderately complex diary file, with functions
+;; used instead of macros. There were a total of 10000 such calls:
+;;
+;; 1934 extract-calendar-month
+;; 1852 extract-calendar-year
+;; 1819 extract-calendar-day
+;; 845 calendar-leap-year-p
+;; 837 calendar-day-number
+;; 775 calendar-absolute-from-gregorian
+;; 346 calendar-last-day-of-month
+;; 286 hebrew-calendar-last-day-of-month
+;; 188 hebrew-calendar-leap-year-p
+;; 180 hebrew-calendar-elapsed-days
+;; 163 hebrew-calendar-last-month-of-year
+;; 66 calendar-date-compare
+;; 65 hebrew-calendar-days-in-year
+;; 60 calendar-absolute-from-julian
+;; 50 calendar-absolute-from-hebrew
+;; 43 calendar-date-equal
+;; 38 calendar-gregorian-from-absolute
+;; .
+;; .
+;; .
+;;
+;; The use of these seven macros eliminates the overhead of 92% of the function
+;; calls; it's faster this way. For clarity, the defun form of each is given
+;; in comments after the defmacro form.
+
(defmacro extract-calendar-month (date)
"Extract the month part of DATE which has the form (month day year)."
(` (car (, date))))
+;;(defun extract-calendar-month (date)
+;; "Extract the month part of DATE which has the form (month day year)."
+;; (car date))
(defmacro extract-calendar-day (date)
"Extract the day part of DATE which has the form (month day year)."
(` (car (cdr (, date)))))
+;;(defun extract-calendar-day (date)
+;; "Extract the day part of DATE which has the form (month day year)."
+;; (car (cdr date)))
(defmacro extract-calendar-year (date)
"Extract the year part of DATE which has the form (month day year)."
(` (car (cdr (cdr (, date))))))
+;;(defun extract-calendar-year (date)
+;; "Extract the year part of DATE which has the form (month day year)."
+;; (car (cdr (cdr date))))
+(defmacro calendar-leap-year-p (year)
+ "Returns t if YEAR is a Gregorian leap year."
+ (` (and
+ (zerop (% (, year) 4))
+ (or (not (zerop (% (, year) 100)))
+ (zerop (% (, year) 400))))))
+;;(defun calendar-leap-year-p (year)
+;; "Returns t if YEAR is a Gregorian leap year."
+;; (and
+;; (zerop (% year 4))
+;; (or ((not (zerop (% year 100))))
+;; (zerop (% year 400)))))
+;;
+;; The foregoing is a bit faster, but not as clear as the following:
+;;
+;;(defmacro calendar-leap-year-p (year)
+;; "Returns t if YEAR is a Gregorian leap year."
+;; (` (or
+;; (and (= (% (, year) 4) 0)
+;; (/= (% (, year) 100) 0))
+;; (= (% (, year) 400) 0))))
+;;(defun calendar-leap-year-p (year)
+;; "Returns t if YEAR is a Gregorian leap year."
+;; (or
+;; (and (= (% year 4) 0)
+;; (/= (% year 100) 0))
+;; (= (% year 400) 0)))
+
+(defmacro calendar-last-day-of-month (month year)
+ "The last day in MONTH during YEAR."
+ (` (if (and
+ (= (, month) 2)
+ (, (macroexpand (` (calendar-leap-year-p (, year))))))
+ 29
+ (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- (, month))))))
+;;(defun calendar-last-day-of-month (month year)
+;; "The last day in MONTH during YEAR."
+;; (if (and (= month 2) (calendar-leap-year-p year))
+;; 29
+;; (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
+
+(defmacro calendar-day-number (date)
+ "Return the day number within the year of the date DATE.
+For example, (calendar-day-number '(1 1 1987)) returns the value 1,
+while (calendar-day-number '(12 31 1980)) returns 366."
+;;
+;; An explanation of the calculation can be found in PascAlgorithms by
+;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
+;;
+ (` (let* ((month (, (macroexpand (` (extract-calendar-month (, date))))))
+ (day (, (macroexpand (` (extract-calendar-day (, date))))))
+ (year (, (macroexpand (` (extract-calendar-year (, date))))))
+ (day-of-year (+ day (* 31 (1- month)))))
+ (if (> month 2)
+ (progn
+ (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
+ (if (, (macroexpand (` (calendar-leap-year-p year))))
+ (setq day-of-year (1+ day-of-year)))))
+ day-of-year)))
+;;(defun calendar-day-number (date)
+;; "Return the day number within the year of the date DATE.
+;;For example, (calendar-day-number '(1 1 1987)) returns the value 1,
+;;while (calendar-day-number '(12 31 1980)) returns 366."
+;; (let* ((month (extract-calendar-month date))
+;; (day (extract-calendar-day date))
+;; (year (extract-calendar-year date))
+;; (day-of-year (+ day (* 31 (1- month)))))
+;; (if (> month 2)
+;; (progn
+;; (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
+;; (if (calendar-leap-year-p year)
+;; (setq day-of-year (1+ day-of-year)))))
+;; day-of-year))
+
+(defmacro calendar-absolute-from-gregorian (date)
+ "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
+The Gregorian date Sunday, December 31, 1 BC is imaginary."
+ (` (let ((prior-years
+ (1- (, (macroexpand (` (extract-calendar-year (, date))))))))
+ (+ (, (macroexpand (` (calendar-day-number (, date)))));; Days this year
+ (* 365 prior-years);; + Days in prior years
+ (/ prior-years 4);; + Julian leap years
+ (- (/ prior-years 100));; - century years
+ (/ prior-years 400)))));; + Gregorian leap years
+;;(defun calendar-absolute-from-gregorian (date)
+;; "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
+;;The Gregorian date Sunday, December 31, 1 BC is imaginary."
+;; (let ((prior-years (1- (extract-calendar-year date))))
+;; (+ (calendar-day-number date);; Days this year
+;; (* 365 prior-years);; + Days in prior years
+;; (/ prior-years 4);; + Julian leap years
+;; (- (/ prior-years 100));; - century years
+;; (/ prior-years 400))));; + Gregorian leap years
+
+;;;###autoload
(defun calendar (&optional arg)
"Display a three-month calendar in another window.
The three months appear side by side, with the current month in the middle
surrounded by the previous and next months. The cursor is put on today's date.
+If called with an optional prefix argument, prompts for month and year.
+
This function is suitable for execution in a .emacs file; appropriate setting
of the variable `view-diary-entries-initially' will cause the diary entries for
the current date to be displayed in another window. The value of the variable
The Gregorian calendar is assumed.
+After loading the calendar, the hooks given by the variable
+`calendar-load-hook' are run. This the place to add key bindings to the
+calendar-mode-map.
+
After preparing the calendar window initially, the hooks given by the variable
`initial-calendar-window-hook' are run.
`today-visible-calendar-hook' to 'calendar-star-date will cause today's date
to be replaced by asterisks to highlight it whenever it is in the window."
(interactive "P")
- (setq arg (if arg (prefix-numeric-value arg) 0))
(set-buffer (get-buffer-create calendar-buffer))
(calendar-mode)
(setq calendar-window-configuration (current-window-configuration))
- (let ((pop-up-windows t)
- (split-height-threshold 1000))
+ (let* ((completion-ignore-case t)
+ (pop-up-windows t)
+ (split-height-threshold 1000)
+ (date (calendar-current-date))
+ (month
+ (if arg
+ (cdr (assoc
+ (capitalize
+ (completing-read
+ "Month name: "
+ (mapcar 'list (append calendar-month-name-array nil))
+ nil t))
+ (calendar-make-alist calendar-month-name-array)))
+ (extract-calendar-month date)))
+ (year
+ (if arg
+ (calendar-read
+ "Year (>0): "
+ '(lambda (x) (> x 0))
+ (int-to-string (extract-calendar-year date)))
+ (extract-calendar-year date))))
(pop-to-buffer calendar-buffer)
- (regenerate-calendar-window arg)
- (let ((date (list current-month current-day current-year)))
- (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
- (view-diary-entries
- (if (vectorp number-of-diary-entries)
- (aref number-of-diary-entries (calendar-day-of-week date))
- number-of-diary-entries))))
- (let* ((diary-buffer (get-file-buffer diary-file))
- (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
- (split-height-threshold (if diary-window 2 1000)))
- (if view-calendar-holidays-initially
- (list-calendar-holidays))))
+ (generate-calendar-window month year)
+ (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
+ (view-diary-entries
+ (if (vectorp number-of-diary-entries)
+ (aref number-of-diary-entries (calendar-day-of-week date))
+ number-of-diary-entries))))
+ (let* ((diary-buffer (get-file-buffer diary-file))
+ (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
+ (split-height-threshold (if diary-window 2 1000)))
+ (if view-calendar-holidays-initially
+ (list-calendar-holidays)))
(run-hooks 'initial-calendar-window-hook))
(autoload 'view-diary-entries "diary"
"Prepare and display a buffer with diary entries.
-Searches the file diary-file for entries that match ARG days starting with
+Searches your diary file for entries that match ARG days starting with
the date indicated by the cursor position in the displayed three-month
calendar."
t)
+(autoload 'calendar-sunrise-sunset "solar"
+ "Local time of sunrise and sunset for date under cursor."
+ t)
+
+(autoload 'calendar-phases-of-moon "lunar"
+ "Create a buffer of the phases of the moon for the current calendar window."
+ t)
+
+(autoload 'calendar-print-french-date "cal-french"
+ "Show the French Revolutionary calendar equivalent of the date under the cursor."
+ t)
+
+(autoload 'calendar-goto-french-date "cal-french"
+ "Move cursor to French Revolutionary date."
+ t)
+
+(autoload 'calendar-french-date-string "cal-french"
+ "String of French Revolutionary date of Gregorian DATE."
+ t)
+
+(autoload 'calendar-mayan-date-string "cal-mayan"
+ "String of Mayan date of Gregorian DATE."
+ t)
+
+(autoload 'calendar-print-mayan-date "cal-mayan"
+ "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
+ t)
+
+(autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
+ "Move cursor to Mayan long count date."
+ t)
+
+(autoload 'calendar-next-haab-date "cal-mayan"
+ "Move cursor to next instance of Mayan Haab date."
+ t)
+
+(autoload 'calendar-previous-haab-date "cal-mayan"
+ "Move cursor to previous instance of Mayan Haab date."
+ t)
+
+(autoload 'calendar-next-tzolkin-date "cal-mayan"
+ "Move cursor to next instance of Mayan Tzolkin date."
+ t)
+
+(autoload 'calendar-previous-tzolkin-date "cal-mayan"
+ "Move cursor to previous instance of Mayan Tzolkin date."
+ t)
+
+(autoload 'calendar-next-calendar-round-date "cal-mayan"
+ "Move cursor to next instance of Mayan Haab/Tzoklin combination."
+ t)
+
+(autoload 'calendar-previous-calendar-round-date "cal-mayan"
+ "Move cursor to previous instance of Mayan Haab/Tzoklin combination."
+ t)
+
(autoload 'show-all-diary-entries "diary"
- "Show all of the diary entries in the diary-file.
-This function gets rid of the selective display of the diary-file so that
+ "Show all of the diary entries in the diary file.
+This function gets rid of the selective display of the diary file so that
all entries, not just some, are visible. If there is no diary buffer, one
is created."
t)
(autoload 'mark-diary-entries "diary"
"Mark days in the calendar window that have diary entries.
-Each entry in diary-file visible in the calendar window is marked."
+Each entry in diary file visible in the calendar window is marked."
t)
-(autoload 'insert-diary-entry "diary"
+(autoload 'insert-diary-entry "diary-ins"
"Insert a diary entry for the date indicated by point."
t)
-(autoload 'insert-weekly-diary-entry "diary"
+(autoload 'insert-weekly-diary-entry "diary-ins"
"Insert a weekly diary entry for the day of the week indicated by point."
t)
-(autoload 'insert-monthly-diary-entry "diary"
+
+(autoload 'insert-monthly-diary-entry "diary-ins"
"Insert a monthly diary entry for the day of the month indicated by point."
t)
-(autoload 'insert-yearly-diary-entry "diary"
+(autoload 'insert-yearly-diary-entry "diary-ins"
"Insert an annual diary entry for the day of the year indicated by point."
t)
-(autoload 'insert-anniversary-diary-entry "diary"
+(autoload 'insert-anniversary-diary-entry "diary-ins"
"Insert an anniversary diary entry for the date indicated by point."
t)
-(autoload 'insert-block-diary-entry "diary"
+(autoload 'insert-block-diary-entry "diary-ins"
"Insert a block diary entry for the dates indicated by point and mark."
t)
-(autoload 'insert-cyclic-diary-entry "diary"
+(autoload 'insert-cyclic-diary-entry "diary-ins"
"Insert a cyclic diary entry starting at the date indicated by point."
t)
-(autoload 'insert-hebrew-diary-entry "diary"
+(autoload 'insert-hebrew-diary-entry "diary-ins"
"Insert a diary entry for the Hebrew date corresponding to the date
indicated by point."
t)
-(autoload 'insert-monthly-hebrew-diary-entry "diary"
+(autoload 'insert-monthly-hebrew-diary-entry "diary-ins"
"Insert a monthly diary entry for the day of the Hebrew month corresponding
to the date indicated by point."
t)
-(autoload 'insert-yearly-hebrew-diary-entry "diary"
+(autoload 'insert-yearly-hebrew-diary-entry "diary-ins"
"Insert an annual diary entry for the day of the Hebrew year corresponding
to the date indicated by point."
t)
-(autoload 'insert-islamic-diary-entry "diary"
+(autoload 'insert-islamic-diary-entry "diary-ins"
"Insert a diary entry for the Islamic date corresponding to the date
indicated by point."
t)
-(autoload 'insert-monthly-islamic-diary-entry "diary"
+(autoload 'insert-monthly-islamic-diary-entry "diary-ins"
"Insert a monthly diary entry for the day of the Islamic month corresponding
to the date indicated by point."
t)
-(autoload 'insert-yearly-islamic-diary-entry "diary"
+(autoload 'insert-yearly-islamic-diary-entry "diary-ins"
"Insert an annual diary entry for the day of the Islamic year corresponding
to the date indicated by point."
t)
"Find holidays for the date specified by the cursor in the calendar window."
t)
-(defun regenerate-calendar-window (&optional arg)
- "Generate the calendar window, offset from the current date by ARG months."
- (if (not arg) (setq arg 0))
+(defun generate-calendar-window (&optional mon yr)
+ "Generate the calendar window for the current date.
+Or, for optional MON, YR."
(let* ((buffer-read-only nil)
- (today-visible (and (<= arg 1) (>= arg -1)))
(today (calendar-current-date))
(month (extract-calendar-month today))
(day (extract-calendar-day today))
(year (extract-calendar-year today))
+ (today-visible
+ (or (not mon)
+ (let ((offset (calendar-interval mon yr month year)))
+ (and (<= offset 1) (>= offset -1)))))
(day-in-week (calendar-day-of-week today)))
(update-calendar-mode-line)
- (setq current-month month)
- (setq current-day day)
- (setq current-year year)
- (increment-calendar-month month year arg)
- (generate-calendar month year)
+ (if mon
+ (generate-calendar mon yr)
+ (generate-calendar month year))
(calendar-cursor-to-visible-date
(if today-visible today (list displayed-month 1 displayed-year)))
(set-buffer-modified-p nil)
(or (one-window-p t)
- (/= (screen-width) (window-width))
+ (/= (frame-width) (window-width))
(shrink-window (- (window-height) 9)))
(sit-for 0)
(and mark-holidays-in-calendar
is currently located, but indented INDENT spaces. The indentation is done
from the first character on the line and does not disturb the first INDENT
characters on the line."
- (let* ((first-day-of-month (calendar-day-of-week (list month 1 year)))
- (first-saturday (- 7 first-day-of-month))
- (last (calendar-last-day-of-month month year)))
- (goto-char (point-min))
- (calendar-insert-indented
- (format " %s %d" (calendar-month-name month) year) indent t)
- (calendar-insert-indented " S M Tu W Th F S" indent t)
- (calendar-insert-indented "" indent);; Move to appropriate spot on line
- ;; Add blank days before the first of the month
- (calendar-for-loop i from 1 to first-day-of-month do
- (insert " "))
- ;; Put in the days of the month
- (calendar-for-loop i from 1 to last do
- (insert (format "%2d " i))
- (and (= (% i 7) (% first-saturday 7))
- (/= i last)
- (calendar-insert-indented "" 0 t) ;; Force onto following line
- (calendar-insert-indented "" indent)))));; Go to proper spot
+ (let* ((blank-days;; at start of month
+ (calendar-mod
+ (- (calendar-day-of-week (list month 1 year))
+ calendar-week-start-day)
+ 7))
+ (last (calendar-last-day-of-month month year)))
+ (goto-char (point-min))
+ (calendar-insert-indented
+ (calendar-string-spread
+ (list "" (format "%s %d" (calendar-month-name month) year) "") ? 20)
+ indent t)
+ (calendar-insert-indented "" indent);; Go to proper spot
+ (calendar-for-loop i from 0 to 6 do
+ (insert (substring (aref calendar-day-name-array
+ (calendar-mod (+ calendar-week-start-day i) 7))
+ 0 2))
+ (insert " "))
+ (calendar-insert-indented "" 0 t);; Force onto following line
+ (calendar-insert-indented "" indent);; Go to proper spot
+ ;; Add blank days before the first of the month
+ (calendar-for-loop i from 1 to blank-days do (insert " "))
+ ;; Put in the days of the month
+ (calendar-for-loop i from 1 to last do
+ (insert (format "%2d " i))
+ (put-text-property (- (point) 3) (1- (point)) 'mouse-face 'highlight)
+ (and (zerop (calendar-mod (+ i blank-days) 7))
+ (/= i last)
+ (calendar-insert-indented "" 0 t) ;; Force onto following line
+ (calendar-insert-indented "" indent)))));; Go to proper spot
(defun calendar-insert-indented (string indent &optional newline)
"Insert STRING at column INDENT.
"Redraw the calendar display."
(interactive)
(let ((cursor-date (calendar-cursor-to-date)))
- (regenerate-calendar-window
- (calendar-interval current-month current-year
- displayed-month displayed-year))
+ (generate-calendar-window displayed-month displayed-year)
(calendar-cursor-to-visible-date cursor-date)))
+(defvar calendar-debug-sexp nil
+ "*Turn debugging on when evaluating a sexp in the diary or holiday list.")
+
(defvar calendar-mode-map nil)
(if calendar-mode-map
nil
(setq calendar-mode-map (make-sparse-keymap))
+ (if window-system (require 'cal-menu))
(calendar-for-loop i from 0 to 9 do
(define-key calendar-mode-map (int-to-string i) 'digit-argument))
+ ;; kill-region and copy-region-as-kill are omitted from this list
+ ;; because they cause an ugly second pane in the Edit menu.
(let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph
- 'mark-defun 'mark-whole-buffer 'mark-page 'kill-region
- 'copy-region-as-kill 'downcase-region 'upcase-region
+ 'mark-defun 'mark-whole-buffer 'mark-page
+ 'downcase-region 'upcase-region
'capitalize-region 'write-region)))
- (while (car l)
- (let ((k (where-is-internal (car l))))
- (while (car k)
- (define-key calendar-mode-map (car k) 'calendar-not-implemented)
- (setq k (cdr k)))
- (setq l (cdr l)))))
+
+ (while l
+ (substitute-key-definition (car l) 'calendar-not-implemented
+ calendar-mode-map global-map)
+ (setq l (cdr l))))
(define-key calendar-mode-map "-" 'negative-argument)
(define-key calendar-mode-map "\C-x>" 'scroll-calendar-right)
+ (define-key calendar-mode-map [prior] 'scroll-calendar-right-three-months)
(define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
(define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
+ (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
(define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
(define-key calendar-mode-map "\C-b" 'calendar-backward-day)
(define-key calendar-mode-map "\C-p" 'calendar-backward-week)
- (define-key calendar-mode-map "\e[" 'calendar-backward-month)
+ (define-key calendar-mode-map "\e{" 'calendar-backward-month)
(define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
(define-key calendar-mode-map "\C-f" 'calendar-forward-day)
(define-key calendar-mode-map "\C-n" 'calendar-forward-week)
- (define-key calendar-mode-map "\e]" 'calendar-forward-month)
+ (define-key calendar-mode-map [left] 'calendar-backward-day)
+ (define-key calendar-mode-map [up] 'calendar-backward-week)
+ (define-key calendar-mode-map [right] 'calendar-forward-day)
+ (define-key calendar-mode-map [down] 'calendar-forward-week)
+ (define-key calendar-mode-map "\e}" 'calendar-forward-month)
(define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
(define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
(define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
(define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
(define-key calendar-mode-map "\e>" 'calendar-end-of-year)
(define-key calendar-mode-map "\C-@" 'calendar-set-mark)
+ ;; Many people are used to typing C-SPC and getting C-@.
+ (define-key calendar-mode-map [?\C-\ ] 'calendar-set-mark)
(define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
- (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
- (define-key calendar-mode-map "gd" 'calendar-goto-date)
- (define-key calendar-mode-map "gJ" 'calendar-goto-julian-date)
- (define-key calendar-mode-map "gH" 'calendar-goto-hebrew-date)
- (define-key calendar-mode-map "gI" 'calendar-goto-islamic-date)
- (define-key calendar-mode-map "gC" 'calendar-goto-iso-date)
- (define-key calendar-mode-map " " 'scroll-other-window)
+ (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
+ (define-key calendar-mode-map "gd" 'calendar-goto-date)
+ (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
+ (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
+ (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
+ (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
+ (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
+ (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
+ (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
+ (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
+ (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
+ (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
+ (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
+ (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
+ (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
+ (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
+ (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
+ (define-key calendar-mode-map " " 'scroll-other-window)
(define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
- (define-key calendar-mode-map "c" 'calendar-current-month)
- (define-key calendar-mode-map "o" 'calendar-other-month)
- (define-key calendar-mode-map "q" 'exit-calendar)
- (define-key calendar-mode-map "a" 'list-calendar-holidays)
- (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
- (define-key calendar-mode-map "x" 'mark-calendar-holidays)
- (define-key calendar-mode-map "u" 'calendar-unmark)
- (define-key calendar-mode-map "m" 'mark-diary-entries)
- (define-key calendar-mode-map "d" 'view-diary-entries)
- (define-key calendar-mode-map "s" 'show-all-diary-entries)
- (define-key calendar-mode-map "D" 'cursor-to-calendar-day-of-year)
- (define-key calendar-mode-map "C" 'cursor-to-iso-calendar-date)
- (define-key calendar-mode-map "J" 'cursor-to-julian-calendar-date)
- (define-key calendar-mode-map "H" 'cursor-to-hebrew-calendar-date)
- (define-key calendar-mode-map "I" 'cursor-to-islamic-calendar-date)
- (define-key calendar-mode-map "F" 'cursor-to-french-calendar-date)
- (define-key calendar-mode-map "\C-cd" 'insert-diary-entry)
- (define-key calendar-mode-map "\C-cw" 'insert-weekly-diary-entry)
- (define-key calendar-mode-map "\C-cm" 'insert-monthly-diary-entry)
- (define-key calendar-mode-map "\C-cy" 'insert-yearly-diary-entry)
- (define-key calendar-mode-map "\C-ca" 'insert-anniversary-diary-entry)
- (define-key calendar-mode-map "\C-cb" 'insert-block-diary-entry)
- (define-key calendar-mode-map "\C-cc" 'insert-cyclic-diary-entry)
- (define-key calendar-mode-map "\C-cHd" 'insert-hebrew-diary-entry)
- (define-key calendar-mode-map "\C-cHm" 'insert-monthly-hebrew-diary-entry)
- (define-key calendar-mode-map "\C-cHy" 'insert-yearly-hebrew-diary-entry)
- (define-key calendar-mode-map "\C-cId" 'insert-islamic-diary-entry)
- (define-key calendar-mode-map "\C-cIm" 'insert-monthly-islamic-diary-entry)
- (define-key calendar-mode-map "\C-cIy" 'insert-yearly-islamic-diary-entry)
- (define-key calendar-mode-map "?" 'describe-calendar-mode))
+ (define-key calendar-mode-map "." 'calendar-current-month)
+ (define-key calendar-mode-map "o" 'calendar-other-month)
+ (define-key calendar-mode-map "q" 'exit-calendar)
+ (define-key calendar-mode-map "a" 'list-calendar-holidays)
+ (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
+ (define-key calendar-mode-map "x" 'mark-calendar-holidays)
+ (define-key calendar-mode-map "u" 'calendar-unmark)
+ (define-key calendar-mode-map "m" 'mark-diary-entries)
+ (define-key calendar-mode-map "d" 'view-diary-entries)
+ (define-key calendar-mode-map "s" 'show-all-diary-entries)
+ (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
+ (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
+ (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
+ (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
+ (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
+ (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
+ (define-key calendar-mode-map "pf" 'calendar-print-french-date)
+ (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
+ (define-key calendar-mode-map "id" 'insert-diary-entry)
+ (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
+ (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
+ (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
+ (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
+ (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
+ (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
+ (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
+ (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
+ (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
+ (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
+ (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
+ (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
+ (define-key calendar-mode-map "?" 'describe-calendar-mode))
(defun describe-calendar-mode ()
"Create a help buffer with a brief description of the calendar-mode."
(put 'calendar-mode 'mode-class 'special)
(defvar calendar-mode-line-format
- (substitute-command-keys
- "\\<calendar-mode-map>\\[scroll-calendar-left] Calendar \\[describe-calendar-mode] help/\\[calendar-other-month] other/\\[calendar-current-month] current %17s \\[scroll-calendar-right]")
+ (list
+ (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-left]")
+ "Calendar"
+ (substitute-command-keys "\\<calendar-mode-map>\\[describe-calendar-mode] help/\\[calendar-other-month] other/\\[calendar-current-month] today")
+ '(calendar-date-string (calendar-current-date) t)
+ (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-right]"))
"The mode line of the calendar buffer.")
(defun calendar-mode ()
- "A major mode for the sliding calendar window and diary.
+ "A major mode for the calendar window.
The commands for cursor movement are:\\<calendar-mode-map>
- \\[calendar-forward-day] one day forward \\[calendar-backward-day] one day backward
- \\[calendar-forward-week] one week forward \\[calendar-backward-week] one week backward
+ \\[calendar-forward-day] one day forward \\[calendar-backward-day] one day backward
+ \\[calendar-forward-week] one week forward \\[calendar-backward-week] one week backward
\\[calendar-forward-month] one month forward \\[calendar-backward-month] one month backward
- \\[calendar-forward-year] one year forward \\[calendar-backward-year] one year backward
- \\[calendar-beginning-of-week] beginning of week \\[calendar-end-of-week] end of week
+ \\[calendar-forward-year] one year forward \\[calendar-backward-year] one year backward
+ \\[calendar-beginning-of-week] beginning of week \\[calendar-end-of-week] end of week
\\[calendar-beginning-of-month] beginning of month \\[calendar-end-of-month] end of month
\\[calendar-beginning-of-year] beginning of year \\[calendar-end-of-year] end of year
- \\[calendar-goto-date] go to date \\[calendar-goto-julian-date] go to Julian date
- \\[calendar-goto-hebrew-date] go to Hebrew date \\[calendar-goto-islamic-date] go to Islamic date
- \\[calendar-goto-iso-date] go to ISO date
+
+ \\[calendar-goto-date] go to date
+
+ \\[calendar-goto-julian-date] go to Julian date \\[calendar-goto-astro-day-number] go to astronomical (Julian) day number
+ \\[calendar-goto-hebrew-date] go to Hebrew date \\[calendar-goto-islamic-date] go to Islamic date
+ \\[calendar-goto-iso-date] go to ISO date \\[calendar-goto-french-date] go to French Revolutionary date
+
+ \\[calendar-goto-mayan-long-count-date] go to Mayan Long Count date
+ \\[calendar-next-haab-date] go to next occurrence of Mayan Haab date
+ \\[calendar-previous-haab-date] go to previous occurrence of Mayan Haab date
+ \\[calendar-next-tzolkin-date] go to next occurrence of Mayan Tzolkin date
+ \\[calendar-previous-tzolkin-date] go to previous occurrence of Mayan Tzolkin date
+ \\[calendar-next-calendar-round-date] go to next occurrence of Mayan Calendar Round date
+ \\[calendar-previous-calendar-round-date] go to previous occurrence of Mayan Calendar Round date
You can mark a date in the calendar and switch the point and mark:
+
\\[calendar-set-mark] mark date \\[calendar-exchange-point-and-mark] exchange point and mark
+
You can determine the number of days (inclusive) between the point and mark by
+
\\[calendar-count-days-region] count days in the region
The commands for calendar movement are:
- \\[scroll-calendar-right] scroll one month right \\[scroll-calendar-left] scroll one month left
+ \\[scroll-calendar-right] scroll one month right \\[scroll-calendar-left] scroll one month left
\\[scroll-calendar-right-three-months] scroll 3 months right \\[scroll-calendar-left-three-months] scroll 3 months left
- \\[calendar-current-month] display current month \\[calendar-other-month] display another month
+ \\[calendar-current-month] display current month \\[calendar-other-month] display another month
Whenever it makes sense, the above commands take prefix arguments that
multiply their affect. For convenience, the digit keys and the minus sign
\\[view-diary-entries] display diary entries \\[show-all-diary-entries] show all diary entries
\\[print-diary-entries] print diary entries
-Displaying the diary entries causes the diary entries from the diary-file
-(for the date indicated by the cursor in the calendar window) to be
+Displaying the diary entries causes the diary entries from the diary file
+\(for the date indicated by the cursor in the calendar window) to be
displayed in another window. This function takes an integer argument that
specifies the number of days of calendar entries to be displayed, starting
with the date indicated by the cursor.
governed by number-of-diary-entries.
The format of the entries in the diary file is described in the
-documentation string for the variable diary-file.
+documentation string for the variable `diary-file'.
When diary entries are in view in the window, they can be edited. It is
important to keep in mind that the buffer displayed contains the entire
The day number in the year and the number of days remaining in the year can be
determined by
- \\[cursor-to-calendar-day-of-year] show day number and the number of days remaining in the year
+ \\[calendar-print-day-of-year] show day number and the number of days remaining in the year
+
+Equivalent dates on the ISO commercial, Julian, Hebrew, Islamic, French
+Revolutionary, and Mayan calendars can be determined by
+
+ \\[calendar-print-iso-date] show equivalent date on the ISO commercial calendar
+ \\[calendar-print-julian-date] show equivalent date on the Julian calendar
+ \\[calendar-print-hebrew-date] show equivalent date on the Hebrew calendar
+ \\[calendar-print-islamic-date] show equivalent date on the Islamic calendar
+ \\[calendar-print-french-date] show equivalent date on the French Revolutionary calendar
+ \\[calendar-print-mayan-date] show equivalent date on the Mayan calendar
+
+The astronomical (Julian) day number of a date is found with
+
+ \\[calendar-print-astro-day-number] show equivalent astronomical (Julian) day number
-Equivalent dates on the ISO commercial, Julian, Hebrew, Islamic and French
-Revolutionary calendars can be determined by
+To find the times of sunrise and sunset and lunar phases use
- \\[cursor-to-iso-calendar-date] show equivalent date on the ISO commercial calendar
- \\[cursor-to-julian-calendar-date] show equivalent date on the Julian calendar
- \\[cursor-to-hebrew-calendar-date] show equivalent date on the Hebrew calendar
- \\[cursor-to-islamic-calendar-date] show equivalent date on the Islamic calendar
- \\[cursor-to-french-calendar-date] show equivalent date on the French Revolutionary calendar
+ \\[calendar-sunrise-sunset] show times of sunrise and sunset
+ \\[calendar-phases-of-moon] show times of quarters of the moon
+
+The times given apply to location `calendar-location-name' at latitude
+`calendar-latitude', longitude `calendar-longitude'; set these variables for
+your location. The following variables are also consulted, and you must set
+them if your system does not initialize them properly: `calendar-time-zone',
+`calendar-daylight-time-offset', `calendar-standard-time-zone-name',
+`calendar-daylight-time-zone-name', `calendar-daylight-savings-starts',
+`calendar-daylight-savings-ends', `calendar-daylight-savings-starts-time',
+`calendar-daylight-savings-ends-time'.
To exit from the calendar use
\\[exit-calendar] exit from calendar
-The variable `view-diary-entries-initially', whose default is nil, can be
-set to to t cause diary entries for the current date will be displayed in
+Set `view-diary-entries-initially' to a non-nil value to display
+diary entries for the current date in
another window when the calendar is first displayed, if the current date is
visible. The variable `number-of-diary-entries' controls number of days of
-diary entries that will be displayed initially or with the command M-x
-diary. For example, if the default value 1 is used, then only the current
-day's diary entries will be displayed. If the value 2 is used, both the
-current day's and the next day's entries will be displayed. The value can
-also be a vector: If the value is [0 2 2 2 2 4 1] then no diary entries
-will be displayed on Sunday, the current date's and the next day's diary
-entries will be displayed Monday through Thursday, Friday through Monday's
-entries will be displayed on Friday, while on Saturday only that day's
-entries will be displayed.
-
-The variable `view-calendar-holidays-initially' can be set to t to cause
-the holidays for the current three month period will be displayed on entry
-to the calendar. The holidays are displayed in another window.
-
-The variable `mark-diary-entries-in-calendar' can be set to t to cause any
-dates visible with calendar entries to be marked with the symbol specified
-by the variable `diary-entry-marker', normally a plus sign.
-
-The variable `initial-calendar-window-hook', whose default value is nil,
-is list of functions to be called when the calendar window is first opened.
-The functions invoked are called after the calendar window is opened, but
-once opened is never called again. Leaving the calendar with the `q' command
-and reentering it will cause these functions to be called again.
-
-The variable `today-visible-calendar-hook', whose default value is nil,
-is the list of functions called after the calendar buffer has been prepared
-with the calendar when the current date is visible in the window.
-This can be used, for example, to replace today's date with asterisks; a
-function calendar-star-date is included for this purpose:
- (setq today-visible-calendar-hook 'calendar-star-date)
-It could also be used to mark the current date with `*'; a function is also
-provided for this:
- (setq today-visible-calendar-hook 'calendar-mark-today)
-
-The variable `today-invisible-calendar-hook', whose default value is nil,
-is the list of functions called after the calendar buffer has been prepared
-with the calendar when the current date is not visible in the window.
-
-The variable `diary-display-hook' is the list of functions called
-after the diary buffer is prepared. The default value simply displays the
-diary file using selective-display to conceal irrelevant diary entries. An
-alternative function `fancy-diary-display' is provided that, when
-used as the `diary-display-hook', causes a noneditable buffer to be
-prepared with a neatly organized day-by-day listing of relevant diary
-entries, together with any known holidays. The inclusion of the holidays
-slows this fancy display of the diary; to speed it up, set the variable
-`holidays-in-diary-buffer' to nil.
-
-The variable `print-diary-entries-hook' is the list of functions called
-after a temporary buffer is prepared with the diary entries currently
-visible in the diary buffer. The default value of this hook adds a heading
-(composed from the diary buffer's mode line), does the printing with the
-command lpr-buffer, and kills the temporary buffer. Other uses might
-include, for example, rearranging the lines into order by day and time.
+diary entries that to display initially or with the command M-x
+diary. For example, the default value 1 says to display only the current
+day's diary entries. The value 2 says to display both the
+current day's and the next day's entries.
+
+The value can also be a vector such as [0 2 2 2 2 4 1]; this value
+says to display no diary entries on Sunday, the display the entries
+for the current date and the day after on Monday through Thursday,
+display Friday through Monday's entries on Friday, and display only
+Saturday's entries on Saturday.
+
+Set `view-calendar-holidays-initially' to a non-nil value to display
+holidays for the current three month period on entry to the calendar.
+
+Set `mark-diary-entries-in-calendar' to a non-nil value to mark in the
+calendar all the dates that have diary entries. The variable
+`diary-entry-marker' controls how to mark them.
+
+The variable `calendar-load-hook', whose default value is nil, is list of
+functions to be called when the calendar is first loaded.
+
+The variable `initial-calendar-window-hook', whose default value is nil, is
+list of functions to be called when the calendar window is first opened. The
+functions invoked are called after the calendar window is opened, but once
+opened is never called again. Leaving the calendar with the `q' command and
+reentering it will cause these functions to be called again.
+
+The variable `today-visible-calendar-hook', whose default value is nil, is the
+list of functions called after the calendar buffer has been prepared with the
+calendar when the current date is visible in the window. This can be used,
+for example, to replace today's date with asterisks; a function
+calendar-star-date is included for this purpose:
+ (setq today-visible-calendar-hook 'calendar-star-date)
+It could also be used to mark the current date; a function is also provided
+for this:
+ (setq today-visible-calendar-hook 'calendar-mark-today)
+
+The variable `today-invisible-calendar-hook', whose default value is nil, is
+the list of functions called after the calendar buffer has been prepared with
+the calendar when the current date is not visible in the window.
+
+The variable `diary-display-hook' is the list of functions called after the
+diary buffer is prepared. The default value simply displays the diary file
+using selective-display to conceal irrelevant diary entries. An alternative
+function `fancy-diary-display' is provided that, when used as the
+`diary-display-hook', causes a noneditable buffer to be prepared with a neatly
+organized day-by-day listing of relevant diary entries, together with any
+known holidays. The inclusion of the holidays slows this fancy display of the
+diary; to speed it up, set the variable `holidays-in-diary-buffer' to nil.
+
+The variable `print-diary-entries-hook' is the list of functions called after
+a temporary buffer is prepared with the diary entries currently visible in the
+diary buffer. The default value of this hook adds a heading (composed from
+the diary buffer's mode line), does the printing with the command lpr-buffer,
+and kills the temporary buffer. Other uses might include, for example,
+rearranging the lines into order by day and time.
The Gregorian calendar is assumed."
(use-local-map calendar-mode-map)
(setq buffer-read-only t)
(setq indent-tabs-mode nil)
+ (update-calendar-mode-line)
(make-local-variable 'calendar-window-configuration);; Windows on entry.
(make-local-variable 'calendar-mark-ring)
- (make-local-variable 'current-month) ;; Current month.
- (make-local-variable 'current-day) ;; Current day.
- (make-local-variable 'current-year) ;; Current year.
(make-local-variable 'displayed-month);; Month in middle of window.
(make-local-variable 'displayed-year));; Year in middle of window.
+(defun calendar-string-spread (strings char length)
+ "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH
+There must be at least 2 strings. The effect is like mapconcat but the
+separating pieces are as balanced as possible. Each item of STRINGS is
+evaluated before concatenation so it can actually be an expression that
+evaluates to a string. If LENGTH is too short, the STRINGS are just
+concatenated and the result truncated."
+;; The algorithm is based on equation (3.25) on page 85 of Concrete
+;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
+;; Addison-Wesley, Reading, MA, 1989
+ (let* ((strings (mapcar 'eval strings))
+ (n (- length (length (apply 'concat strings))))
+ (m (1- (length strings)))
+ (s (car strings))
+ (strings (cdr strings))
+ (i 0))
+ (while strings
+ (setq s (concat s
+ (make-string (max 0 (/ (+ n i) m)) char)
+ (car strings)))
+ (setq i (1+ i))
+ (setq strings (cdr strings)))
+ (substring s 0 length)))
+
(defun update-calendar-mode-line ()
"Update the calendar mode line with the current date and date style."
(if (bufferp (get-buffer calendar-buffer))
(save-excursion
(set-buffer calendar-buffer)
(setq mode-line-format
- (format calendar-mode-line-format
- (calendar-date-string (calendar-current-date) t))))))
+ (calendar-string-spread
+ calendar-mode-line-format ? (frame-width))))))
(defun exit-calendar ()
- "Get out of the calendar window and destroy it and related buffers."
+ "Get out of the calendar window and bury it and related buffers."
(interactive)
(let ((diary-buffer (get-file-buffer diary-file))
(d-buffer (get-buffer fancy-diary-buffer))
(if (not diary-buffer)
(progn
(set-window-configuration calendar-window-configuration)
- (kill-buffer calendar-buffer)
- (if d-buffer (kill-buffer d-buffer))
- (if h-buffer (kill-buffer h-buffer)))
+ (bury-buffer calendar-buffer)
+ (if d-buffer (bury-buffer d-buffer))
+ (if h-buffer (bury-buffer h-buffer)))
(if (or (not (buffer-modified-p diary-buffer))
(yes-or-no-p "Diary modified; do you really want to exit the calendar? "))
(progn
(set-window-configuration calendar-window-configuration)
- (kill-buffer calendar-buffer)
- (if d-buffer (kill-buffer d-buffer))
- (if h-buffer (kill-buffer h-buffer))
+ (bury-buffer calendar-buffer)
+ (if d-buffer (bury-buffer d-buffer))
+ (if h-buffer (bury-buffer h-buffer))
(set-buffer diary-buffer)
(set-buffer-modified-p nil)
- (kill-buffer diary-buffer))))))
+ (bury-buffer diary-buffer))))))
(defun calendar-current-month ()
"Reposition the calendar window so the current date is visible."
(interactive)
(let ((today (calendar-current-date)));; The date might have changed.
(if (not (calendar-date-is-visible-p today))
- (regenerate-calendar-window)
+ (generate-calendar-window)
(update-calendar-mode-line)
(calendar-cursor-to-visible-date today))))
Movement is backward if ARG is negative."
(interactive "p")
(calendar-cursor-to-nearest-date)
- (let* ((cursor-date (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!")))
+ (let* ((cursor-date (calendar-cursor-to-date t))
(month (extract-calendar-month cursor-date))
(day (extract-calendar-day cursor-date))
(year (extract-calendar-year cursor-date)))
(today (calendar-current-date)))
(if (/= arg 0)
(progn
- (regenerate-calendar-window
- (+ arg (calendar-interval current-month current-year
- displayed-month displayed-year)))
+ (increment-calendar-month displayed-month displayed-year arg)
+ (generate-calendar-window displayed-month displayed-year)
(calendar-cursor-to-visible-date
(cond
((calendar-date-is-visible-p old-date) old-date)
(month
(cdr (assoc
(substring date (match-beginning 2) (match-end 2))
- (calendar-make-alist
- calendar-month-name-array
- 1
- '(lambda (x) (substring x 0 3))))))
+ '(("Jan" . 1) ("Feb" . 2) ("Mar" . 3) ("Apr" . 4)
+ ("May" . 5) ("Jun" . 6) ("Jul" . 7) ("Aug" . 8)
+ ("Sep" . 9) ("Oct" . 10) ("Nov" . 11) ("Dec" . 12)))))
(day
(string-to-int (substring date (match-beginning 3) (match-end 3))))
(year
(string-to-int (substring date (match-beginning 4) (match-end 4)))))
- (if (equal (current-buffer) (get-buffer calendar-buffer))
- (progn
- (setq current-month month)
- (setq current-day day)
- (setq current-year year)))
(list month day year)))
-(defun calendar-cursor-to-date ()
+(defun calendar-cursor-to-date (&optional error)
"Returns a list of the month, day, and year of current cursor position.
-Returns nil if the cursor is not on a specific day."
- (if (and (looking-at "[*0-9]")
- (< 2 (count-lines (point-min) (point))))
- (save-excursion
- (re-search-backward "[^0-9]")
- (forward-char 1)
- (let*
- ((day (string-to-int (buffer-substring (point) (+ 3 (point)))))
- (day (if (= 0 day) current-day day));; Starred date.
- (segment (/ (current-column) 25))
- (month (% (+ displayed-month segment -1) 12))
- (month (if (= 0 month) 12 month))
- (year
- (cond
- ((and (= 12 month) (= segment 0)) (1- displayed-year))
- ((and (= 1 month) (= segment 2)) (1+ displayed-year))
- (t displayed-year))))
- (list month day year)))))
+If cursor is not on a specific date, signals an error if optional parameter
+ERROR is t, otherwise just returns nil."
+ (let* ((segment (/ (current-column) 25))
+ (month (% (+ displayed-month segment -1) 12))
+ (month (if (= 0 month) 12 month))
+ (year
+ (cond
+ ((and (= 12 month) (= segment 0)) (1- displayed-year))
+ ((and (= 1 month) (= segment 2)) (1+ displayed-year))
+ (t displayed-year))))
+ (if (and (looking-at "[0-9]")
+ (< 2 (count-lines (point-min) (point))))
+ (save-excursion
+ (re-search-backward "[^0-9]")
+ (list month
+ (string-to-int (buffer-substring (1+ (point)) (+ 4 (point))))
+ year))
+ (if (looking-at "\\*")
+ (save-excursion
+ (re-search-backward "[^*]")
+ (if (looking-at ".\\*\\*")
+ (list month calendar-starred-day year)
+ (if error (error "Not on a date!"))))
+ (if error (error "Not on a date!"))))))
(defun calendar-cursor-to-nearest-date ()
"Move the cursor to the closest date.
(calendar-forward-day (* arg -7)))
(defun calendar-beginning-of-week (arg)
- "Move the cursor back ARG Sundays."
+ "Move the cursor back ARG calendar-week-start-day's."
(interactive "p")
(calendar-cursor-to-nearest-date)
(let ((day (calendar-day-of-week (calendar-cursor-to-date))))
(calendar-backward-day
- (if (= day 0) (* 7 arg) (+ day (* 7 (1- arg)))))))
+ (if (= day calendar-week-start-day)
+ (* 7 arg)
+ (+ (calendar-mod (- day calendar-week-start-day) 7)
+ (* 7 (1- arg)))))))
(defun calendar-end-of-week (arg)
- "Move the cursor forward ARG Saturdays."
+ "Move the cursor forward ARG calendar-week-start-day+6's."
(interactive "p")
(calendar-cursor-to-nearest-date)
(let ((day (calendar-day-of-week (calendar-cursor-to-date))))
(calendar-forward-day
- (if (= day 6) (* 7 arg) (+ (- 6 day) (* 7 (1- arg)))))))
+ (if (= day (calendar-mod (1- calendar-week-start-day) 7))
+ (* 7 arg)
+ (+ (- 6 (calendar-mod (- day calendar-week-start-day) 7))
+ (* 7 (1- arg)))))))
(defun calendar-beginning-of-month (arg)
"Move the cursor backward ARG month beginnings."
(calendar-other-month 12 (- year (1- arg)))
(calendar-cursor-to-visible-date (list 12 31 displayed-year))))))
+;; The following version of calendar-gregorian-from-absolute is preferred for
+;; reasons of clarity, BUT it's much slower than the version that follows it.
+
+;;(defun calendar-gregorian-from-absolute (date)
+;; "Compute the list (month day year) corresponding to the absolute DATE.
+;;The absolute date is the number of days elapsed since the (imaginary)
+;;Gregorian date Sunday, December 31, 1 BC."
+;; (let* ((approx (/ date 366));; Approximation from below.
+;; (year ;; Search forward from the approximation.
+;; (+ approx
+;; (calendar-sum y approx
+;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
+;; 1)))
+;; (month ;; Search forward from January.
+;; (1+ (calendar-sum m 1
+;; (> date
+;; (calendar-absolute-from-gregorian
+;; (list m (calendar-last-day-of-month m year) year)))
+;; 1)))
+;; (day ;; Calculate the day by subtraction.
+;; (- date
+;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
+;; (list month day year)))
+
(defun calendar-gregorian-from-absolute (date)
"Compute the list (month day year) corresponding to the absolute DATE.
The absolute date is the number of days elapsed since the (imaginary)
Gregorian date Sunday, December 31, 1 BC."
- (let* ((approx (/ date 366));; Approximation from below.
- (year ;; Search forward from the approximation.
- (+ approx
- (calendar-sum y approx
- (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
- 1)))
- (month ;; Search forward from January.
- (1+ (calendar-sum m 1
- (> date
- (calendar-absolute-from-gregorian
- (list m (calendar-last-day-of-month m year) year)))
- 1)))
- (day ;; Calculate the day by subtraction.
- (- date
- (1- (calendar-absolute-from-gregorian (list month 1 year))))))
- (list month day year)))
+;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
+;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
+;; Clamen, Software--Practice and Experience, Volume 23, Number 4
+;; (April, 1993), pages 383-404 for an explanation.
+ (let* ((d0 (1- date))
+ (n400 (/ d0 146097))
+ (d1 (% d0 146097))
+ (n100 (/ d1 36524))
+ (d2 (% d1 36524))
+ (n4 (/ d2 1461))
+ (d3 (% d2 1461))
+ (n1 (/ d3 365))
+ (day (1+ (% d3 365)))
+ (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
+ (if (or (= n100 4) (= n1 4))
+ (list 12 31 year)
+ (let ((year (1+ year))
+ (month 1))
+ (while (let ((mdays (calendar-last-day-of-month month year)))
+ (and (< mdays day)
+ (setq day (- day mdays))))
+ (setq month (1+ month)))
+ (list month day year)))))
+
+(defun calendar-mod (x y)
+ "Returns X % Y; value is *always* non-negative."
+ (let ((v (mod x y)))
+ (if (> 0 v)
+ (+ v y)
+ v)))
(defun calendar-cursor-to-visible-date (date)
"Move the cursor to DATE that is on the screen."
- (let ((month (extract-calendar-month date))
- (day (extract-calendar-day date))
- (year (extract-calendar-year date)))
- (goto-line (+ 3
- (/ (+ day -1
- (calendar-day-of-week (list month 1 year)))
- 7)))
- (move-to-column (+ 6
- (* 25
- (1+ (calendar-interval
- displayed-month displayed-year month year)))
- (* 3 (calendar-day-of-week date))))))
+ (let* ((month (extract-calendar-month date))
+ (day (extract-calendar-day date))
+ (year (extract-calendar-year date))
+ (first-of-month-weekday (calendar-day-of-week (list month 1 year))))
+ (goto-line (+ 3
+ (/ (+ day -1
+ (calendar-mod
+ (- (calendar-day-of-week (list month 1 year))
+ calendar-week-start-day)
+ 7))
+ 7)))
+ (move-to-column (+ 6
+ (* 25
+ (1+ (calendar-interval
+ displayed-month displayed-year month year)))
+ (* 3 (calendar-mod
+ (- (calendar-day-of-week date)
+ calendar-week-start-day)
+ 7))))))
(defun calendar-other-month (month year)
"Display a three-month calendar centered around MONTH and YEAR."
(year (calendar-read
"Year (>0): "
'(lambda (x) (> x 0))
- (int-to-string current-year))))
+ (int-to-string
+ (extract-calendar-year (calendar-current-date))))))
(list month year)))
(if (and (= month displayed-month)
(= year displayed-year))
nil
(let ((old-date (calendar-cursor-to-date))
(today (calendar-current-date)))
- (regenerate-calendar-window
- (calendar-interval current-month current-year month year))
+ (generate-calendar-window month year)
(calendar-cursor-to-visible-date
(cond
((calendar-date-is-visible-p old-date) old-date)
With no prefix argument, push current date onto marked date ring.
With argument, jump to mark, pop it, and put point at end of ring."
(interactive "P")
- (let ((date (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!"))))
+ (let ((date (calendar-cursor-to-date t)))
(if (null arg)
(progn
(setq calendar-mark-ring (cons date calendar-mark-ring))
"Exchange the current cursor position with the marked date."
(interactive)
(let ((mark (car calendar-mark-ring))
- (date (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!"))))
+ (date (calendar-cursor-to-date t)))
(if (null mark)
(error "No mark set in this buffer")
(setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
"Count the number of days (inclusive) between point and the mark."
(interactive)
(let* ((days (- (calendar-absolute-from-gregorian
- (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!")))
+ (calendar-cursor-to-date t))
(calendar-absolute-from-gregorian
(or (car calendar-mark-ring)
(error "No mark set in this buffer")))))
(setq value (read-minibuffer prompt initial-contents)))
value))
+(defun calendar-read-date ()
+ "Prompt for Gregorian date. Returns a list (month day year)."
+ (let* ((year (calendar-read
+ "Year (>0): "
+ '(lambda (x) (> x 0))
+ (int-to-string (extract-calendar-year
+ (calendar-current-date)))))
+ (month-array calendar-month-name-array)
+ (completion-ignore-case t)
+ (month (cdr (assoc
+ (capitalize
+ (completing-read
+ "Month name: "
+ (mapcar 'list (append month-array nil))
+ nil t))
+ (calendar-make-alist month-array 1 'capitalize))))
+ (last (calendar-last-day-of-month month year))
+ (day (calendar-read
+ (format "Day (1-%d): " last)
+ '(lambda (x) (and (< 0 x) (<= x last))))))
+ (list month day year)))
+
(defun calendar-goto-date (date)
"Move cursor to DATE."
- (interactive
- (let* ((year (calendar-read
- "Year (>0): "
- '(lambda (x) (> x 0))
- (int-to-string current-year)))
- (month-array calendar-month-name-array)
- (completion-ignore-case t)
- (month (cdr (assoc
- (capitalize
- (completing-read
- "Month name: "
- (mapcar 'list (append month-array nil))
- nil t))
- (calendar-make-alist month-array 1 'capitalize))))
- (last (calendar-last-day-of-month month year))
- (day (calendar-read
- (format "Day (1-%d): " last)
- '(lambda (x) (and (< 0 x) (<= x last))))))
- (list (list month day year))))
+ (interactive (list (calendar-read-date)))
(let ((month (extract-calendar-month date))
(year (extract-calendar-year date)))
(if (not (calendar-date-is-visible-p date))
(defun calendar-goto-julian-date (date &optional noecho)
"Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
(interactive
- (let* ((year (calendar-read
+ (let* ((today (calendar-current-date))
+ (year (calendar-read
"Julian calendar year (>0): "
'(lambda (x) (> x 0))
(int-to-string
(extract-calendar-year
(calendar-julian-from-absolute
(calendar-absolute-from-gregorian
- (list current-month 1 current-year)))))))
+ today))))))
(month-array calendar-month-name-array)
(completion-ignore-case t)
(month (cdr (assoc
(list (list month day year))))
(calendar-goto-date (calendar-gregorian-from-absolute
(calendar-absolute-from-julian date)))
- (or noecho (cursor-to-julian-calendar-date)))
+ (or noecho (calendar-print-julian-date)))
(defun calendar-goto-hebrew-date (date &optional noecho)
"Move cursor to Hebrew DATE; echo Hebrew date unless NOECHO is t."
(interactive
- (let* ((year (calendar-read
+ (let* ((today (calendar-current-date))
+ (year (calendar-read
"Hebrew calendar year (>3760): "
'(lambda (x) (> x 3760))
(int-to-string
(extract-calendar-year
(calendar-hebrew-from-absolute
- (calendar-absolute-from-gregorian
- (list current-month 1 current-year)))))))
+ (calendar-absolute-from-gregorian today))))))
(month-array (if (hebrew-calendar-leap-year-p year)
calendar-hebrew-month-name-array-leap-year
calendar-hebrew-month-name-array-common-year))
(list (list month day year))))
(calendar-goto-date (calendar-gregorian-from-absolute
(calendar-absolute-from-hebrew date)))
- (or noecho (cursor-to-hebrew-calendar-date)))
+ (or noecho (calendar-print-hebrew-date)))
(defun calendar-goto-islamic-date (date &optional noecho)
"Move cursor to Islamic DATE; echo Islamic date unless NOECHO is t."
(interactive
- (let* ((year (calendar-read
+ (let* ((today (calendar-current-date))
+ (year (calendar-read
"Islamic calendar year (>0): "
'(lambda (x) (> x 0))
(int-to-string
(extract-calendar-year
(calendar-islamic-from-absolute
- (calendar-absolute-from-gregorian
- (list current-month 1 current-year)))))))
+ (calendar-absolute-from-gregorian today))))))
(month-array calendar-islamic-month-name-array)
(completion-ignore-case t)
(month (cdr (assoc
(list (list month day year))))
(calendar-goto-date (calendar-gregorian-from-absolute
(calendar-absolute-from-islamic date)))
- (or noecho (cursor-to-islamic-calendar-date)))
+ (or noecho (calendar-print-islamic-date)))
(defun calendar-goto-iso-date (date &optional noecho)
"Move cursor to ISO DATE; echo ISO date unless NOECHO is t."
(interactive
- (let* ((year (calendar-read
+ (let* ((today (calendar-current-date))
+ (year (calendar-read
"ISO calendar year (>0): "
'(lambda (x) (> x 0))
- (int-to-string current-year)))
+ (int-to-string (extract-calendar-year today))))
(no-weeks (extract-calendar-month
(calendar-iso-from-absolute
(1-
(list (list week day year))))
(calendar-goto-date (calendar-gregorian-from-absolute
(calendar-absolute-from-iso date)))
- (or noecho (cursor-to-iso-calendar-date)))
+ (or noecho (calendar-print-iso-date)))
(defun calendar-interval (mon1 yr1 mon2 yr2)
- "The number of months difference between the two specified months."
+ "The number of months difference between MON1, YR1 and MON2, YR2."
(+ (* 12 (- yr2 yr1))
(- mon2 mon1)))
-(defun calendar-leap-year-p (year)
- "Returns t if YEAR is a Gregorian leap year."
- (or
- (and (= (% year 4) 0)
- (/= (% year 100) 0))
- (= (% year 400) 0)))
-
-(defun calendar-day-number (date)
- "Return the day number within the year of the date DATE.
-For example, (calendar-day-number '(1 1 1987)) returns the value 1,
-while (calendar-day-number '(12 31 1980)) returns 366."
-;;
-;; An explanation of the calculation can be found in PascAlgorithms by
-;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
-;;
- (let* ((month (extract-calendar-month date))
- (day (extract-calendar-day date))
- (year (extract-calendar-year date))
- (day-of-year (+ day (* 31 (1- month)))))
- (if (> month 2)
- (progn
- (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
- (if (calendar-leap-year-p year)
- (setq day-of-year (1+ day-of-year)))))
- day-of-year))
-
(defun calendar-day-name (date)
"Returns a string with the name of the day of the week of DATE."
(aref calendar-day-name-array (calendar-day-of-week date)))
-(defconst calendar-day-name-array
+(defvar calendar-day-name-array
["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"])
-(defun calendar-last-day-of-month (month year)
- "The last day in MONTH during YEAR."
- (if (and (calendar-leap-year-p year) (= month 2))
- 29
- (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
-
-(defconst calendar-month-name-array
+(defvar calendar-month-name-array
["January" "February" "March" "April" "May" "June"
"July" "August" "September" "October" "November" "December"])
"Returns the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc."
(% (calendar-absolute-from-gregorian date) 7))
-(defun calendar-absolute-from-gregorian (date)
- "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
-The Gregorian date Sunday, December 31, 1 BC is imaginary."
- (let ((month (extract-calendar-month date))
- (day (extract-calendar-day date))
- (year (extract-calendar-year date)))
- (+ (calendar-day-number date);; Days this year
- (* 365 (1- year));; + Days in prior years
- (/ (1- year) 4);; + Julian leap years
- (- (/ (1- year) 100));; - century years
- (/ (1- year) 400))));; + Gregorian leap years
-
(defun calendar-unmark ()
- "Delete the diary and holiday marks from the calendar."
+ "Delete all diary/holiday marks/highlighting from the calendar."
(interactive)
- (setq mark-diary-entries-in-calendar nil)
(setq mark-holidays-in-calendar nil)
- (save-excursion
- (goto-line 3)
- (beginning-of-line)
- (let ((buffer-read-only nil)
- (start (point))
- (star-date (search-forward "**" nil t))
- (star-point (point)))
- (if star-date
- (progn ;; Don't delete today as left by calendar-star-date
- (subst-char-in-region start (- star-point 2)
- (string-to-char diary-entry-marker) ? t)
- (subst-char-in-region start (- star-point 2)
- (string-to-char calendar-holiday-marker) ? t)
- (subst-char-in-region star-point (point-max)
- (string-to-char diary-entry-marker) ? t)
- (subst-char-in-region star-point (point-max)
- (string-to-char calendar-holiday-marker) ? t))
- (subst-char-in-region start (point-max)
- (string-to-char diary-entry-marker) ? t)
- (subst-char-in-region start (point-max)
- (string-to-char calendar-holiday-marker) ? t))
- (set-buffer-modified-p nil))))
+ (setq mark-diary-entries-in-calendar nil)
+ (redraw-calendar))
(defun calendar-date-is-visible-p (date)
"Returns t if DATE is legal and is visible in the calendar window."
(= (extract-calendar-year date1) (extract-calendar-year date2))))
(defun mark-visible-calendar-date (date &optional mark)
- "Leave mark DATE with MARK. MARK defaults to diary-entry-marker."
+ "Mark DATE in the calendar window with MARK.
+MARK is either a single-character string or a face.
+MARK defaults to diary-entry-marker."
(if (calendar-date-is-legal-p date)
(save-excursion
(set-buffer calendar-buffer)
(calendar-cursor-to-visible-date date)
- (forward-char 1)
- (let ((buffer-read-only nil))
- (delete-char 1)
- (insert (if mark mark diary-entry-marker))
- (forward-char -2))
- (set-buffer-modified-p nil))))
+ (let ((mark (or mark diary-entry-marker)))
+ (if (stringp mark)
+ (let ((buffer-read-only nil))
+ (forward-char 1)
+ (delete-char 1)
+ (insert mark)
+ (forward-char -2))
+ (overlay-put
+ (make-overlay (1-(point)) (1+ (point))) 'face mark))))))
(defun calendar-star-date ()
"Replace the date under the cursor in the calendar window with asterisks.
This function can be used with the today-visible-calendar-hook run after the
calendar window has been prepared."
(let ((buffer-read-only nil))
+ (make-variable-buffer-local 'calendar-starred-day)
(forward-char 1)
+ (setq calendar-starred-day
+ (string-to-int
+ (buffer-substring (point) (- (point) 2))))
(delete-char -2)
(insert "**")
(backward-char 1)
(set-buffer-modified-p nil)))
(defun calendar-mark-today ()
- "Mark the date under the cursor in the calendar window with an equal sign.
-This function can be used with the today-visible-calendar-hook run after the
-calendar window has been prepared."
- (let ((buffer-read-only nil))
- (forward-char 1)
- (delete-char 1)
- (insert "=")
- (backward-char 2)
- (set-buffer-modified-p nil)))
+ "Mark the date under the cursor in the calendar window.
+The date is marked with calendar-today-marker. This function can be used with
+the today-visible-calendar-hook run after the calendar window has been
+prepared."
+ (mark-visible-calendar-date
+ (calendar-cursor-to-date)
+ calendar-today-marker))
(defun calendar-date-compare (date1 date2)
"Returns t if DATE1 is before DATE2, nil otherwise.
omits the name of the day of the week."
(let* ((dayname
(if nodayname
- ""
+ nil
(if abbreviate
(substring (calendar-day-name date) 0 3)
(calendar-day-name date))))
date d, and applying it to d+7 gives the DAYNAME following absolute date d."
(- date (% (- date dayname) 7)))
-(defun calendar-nth-named-day (n dayname month year)
- "Returns the date of the Nth DAYNAME in MONTH, YEAR.
-A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0, the
-date returned is the Nth DAYNAME from the end of MONTH, YEAR (that is, -1 is
-the last DAYNAME, -2 is the penultimate DAYNAME, and so on."
+(defun calendar-nth-named-absday (n dayname month year &optional day)
+ "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
+A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
+return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
+If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
+
+If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
+ (if (> n 0)
+ (+ (* 7 (1- n))
+ (calendar-dayname-on-or-before
+ dayname
+ (+ 6 (calendar-absolute-from-gregorian
+ (list month (or day 1) year)))))
+ (+ (* 7 (1+ n))
+ (calendar-dayname-on-or-before
+ dayname
+ (calendar-absolute-from-gregorian
+ (list month
+ (or day (calendar-last-day-of-month month year))
+ year))))))
+
+(defun calendar-nth-named-day (n dayname month year &optional day)
+ "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
+A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
+return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
+If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
+
+If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
(calendar-gregorian-from-absolute
- (if (> n 0)
- (+ (calendar-dayname-on-or-before
- dayname (calendar-absolute-from-gregorian (list month 7 year)))
- (* 7 (1- n)))
- (+ (calendar-dayname-on-or-before
- dayname
- (calendar-absolute-from-gregorian
- (list month (calendar-last-day-of-month month year) year)))
- (* 7 (1+ n))))))
-
-(defun cursor-to-calendar-day-of-year ()
- "Show the day number in the year and the number of days remaining in the
-year for the date under the cursor."
- (interactive)
- (let* ((date (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!")))
- (year (extract-calendar-year date))
- (day (calendar-day-number date))
+ (calendar-nth-named-absday n dayname month year day)))
+
+(defun calendar-day-of-year-string (&optional date)
+ "String of day number of year of Gregorian DATE.
+Defaults to today's date if DATE is not given."
+ (let* ((d (or date (calendar-current-date)))
+ (year (extract-calendar-year d))
+ (day (calendar-day-number d))
(days-remaining (- (calendar-day-number (list 12 31 year)) day)))
- (message "Day %d of %d; %d day%s remaining in the year"
- day year days-remaining (if (= days-remaining 1) "" "s"))))
+ (format "Day %d of %d; %d day%s remaining in the year"
+ day year days-remaining (if (= days-remaining 1) "" "s"))))
+
+(defun calendar-print-day-of-year ()
+ "Show day number in year/days remaining in year for date under the cursor."
+ (interactive)
+ (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
(defun calendar-absolute-from-iso (date)
- "The number of days elapsed between the Gregorian date 12/31/1 BC and
-DATE. The `ISO year' corresponds approximately to the Gregorian year, but
+ "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
+The `ISO year' corresponds approximately to the Gregorian year, but
weeks start on Monday and end on Sunday. The first week of the ISO year is
the first such week in which at least 4 days are in a year. The ISO
commercial DATE has the form (week day year) in which week is in the range
1..52 and day is in the range 0..6 (1 = Monday, 2 = Tuesday, ..., 0 =
-Sunday). The The Gregorian date Sunday, December 31, 1 BC is imaginary."
+Sunday). The Gregorian date Sunday, December 31, 1 BC is imaginary."
(let* ((week (extract-calendar-month date))
(day (extract-calendar-day date))
(year (extract-calendar-year date)))
(% date 7)
year)))
-(defun cursor-to-iso-calendar-date ()
- "Show the equivalent date on the `ISO commercial calendar' for the date
-under the cursor."
+(defun calendar-iso-date-string (&optional date)
+ "String of ISO date of Gregorian DATE.
+Defaults to today's date if DATE is not given."
+ (let* ((d (calendar-absolute-from-gregorian
+ (or date (calendar-current-date))))
+ (day (% d 7))
+ (iso-date (calendar-iso-from-absolute d)))
+ (format "Day %s of week %d of %d"
+ (if (zerop day) 7 day)
+ (extract-calendar-month iso-date)
+ (extract-calendar-year iso-date))))
+
+(defun calendar-print-iso-date ()
+ "Show equivalent ISO date for the date under the cursor."
(interactive)
- (let* ((greg-date
- (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!")))
- (day (% (calendar-absolute-from-gregorian greg-date) 7))
- (iso-date (calendar-iso-from-absolute
- (calendar-absolute-from-gregorian greg-date))))
- (message "ISO date: Day %s of week %d of %d."
- (if (zerop day) 7 day)
- (extract-calendar-month iso-date)
- (extract-calendar-year iso-date))))
+ (message "ISO date: %s"
+ (calendar-iso-date-string (calendar-cursor-to-date t))))
(defun calendar-julian-from-absolute (date)
"Compute the Julian (month day year) corresponding to the absolute DATE.
(/ (1- year) 4)
-2)))
-(defun cursor-to-julian-calendar-date ()
+(defun calendar-julian-date-string (&optional date)
+ "String of Julian date of Gregorian DATE.
+Defaults to today's date if DATE is not given.
+Driven by the variable `calendar-date-display-form'."
+ (calendar-date-string
+ (calendar-julian-from-absolute
+ (calendar-absolute-from-gregorian
+ (or date (calendar-current-date))))
+ nil t))
+
+(defun calendar-print-julian-date ()
"Show the Julian calendar equivalent of the date under the cursor."
(interactive)
- (let ((calendar-date-display-form
- (if european-calendar-style
- '(day " " monthname " " year)
- '(monthname " " day ", " year))))
- (message "Julian date: %s"
- (calendar-date-string
- (calendar-julian-from-absolute
- (calendar-absolute-from-gregorian
- (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!"))))))))
+ (message "Julian date: %s"
+ (calendar-julian-date-string (calendar-cursor-to-date t))))
(defun islamic-calendar-leap-year-p (year)
"Returns t if YEAR is a leap year on the Islamic calendar."
(1- (calendar-absolute-from-islamic (list month 1 year))))))
(list month day year))))
-(defconst calendar-islamic-month-name-array
+(defvar calendar-islamic-month-name-array
["Muharram" "Safar" "Rabi I" "Rabi II" "Jumada I" "Jumada II"
"Rajab" "Sha'ban" "Ramadan" "Shawwal" "Dhu al-Qada" "Dhu al-Hijjah"])
-(defun cursor-to-islamic-calendar-date ()
- "Show the Islamic calendar equivalent of the date under the cursor."
- (interactive)
- (let ((calendar-date-display-form
- (if european-calendar-style
- '(day " " monthname " " year)
- '(monthname " " day ", " year)))
- (calendar-month-name-array calendar-islamic-month-name-array)
+(defun calendar-islamic-date-string (&optional date)
+ "String of Islamic date before sunset of Gregorian DATE.
+Returns the empty string if DATE is pre-Islamic.
+Defaults to today's date if DATE is not given.
+Driven by the variable `calendar-date-display-form'."
+ (let ((calendar-month-name-array calendar-islamic-month-name-array)
(islamic-date (calendar-islamic-from-absolute
(calendar-absolute-from-gregorian
- (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!"))))))
+ (or date (calendar-current-date))))))
(if (< (extract-calendar-year islamic-date) 1)
+ ""
+ (calendar-date-string islamic-date nil t))))
+
+(defun calendar-print-islamic-date ()
+ "Show the Islamic calendar equivalent of the date under the cursor."
+ (interactive)
+ (let ((i (calendar-islamic-date-string (calendar-cursor-to-date t))))
+ (if (string-equal i "")
(message "Date is pre-Islamic")
- (message "Islamic date: %s" (calendar-date-string islamic-date nil t)))))
+ (message "Islamic date (until sunset): %s" i))))
(defun calendar-hebrew-from-absolute (date)
"Compute the Hebrew date (month day year) corresponding to absolute DATE.
30))
(defun hebrew-calendar-elapsed-days (year)
- "Number of days elapsed from the Sunday prior to the start of the Hebrew
-calendar to the mean conjunction of Tishri of Hebrew YEAR."
+ "Days from Sun. prior to start of Hebrew calendar to mean conjunction of Tishri of Hebrew YEAR."
(let* ((months-elapsed
(+ (* 235 (/ (1- year) 19));; Months in complete cycles so far.
(* 12 (% (1- year) 19)) ;; Regular months in this cycle
(hebrew-calendar-elapsed-days year);; Days in prior years.
-1373429))) ;; Days elapsed before absolute date 1.
-(defconst calendar-hebrew-month-name-array-common-year
+(defvar calendar-hebrew-month-name-array-common-year
["Nisan" "Iyar" "Sivan" "Tammuz" "Av" "Elul" "Tishri"
"Heshvan" "Kislev" "Teveth" "Shevat" "Adar"])
-(defconst calendar-hebrew-month-name-array-leap-year
+(defvar calendar-hebrew-month-name-array-leap-year
["Nisan" "Iyar" "Sivan" "Tammuz" "Av" "Elul" "Tishri"
"Heshvan" "Kislev" "Teveth" "Shevat" "Adar I" "Adar II"])
-(defun cursor-to-hebrew-calendar-date ()
- "Show the Hebrew calendar equivalent of the date under the cursor."
- (interactive)
- (let* ((calendar-date-display-form
- (if european-calendar-style
- '(day " " monthname " " year)
- '(monthname " " day ", " year)))
- (hebrew-date (calendar-hebrew-from-absolute
+(defun calendar-hebrew-date-string (&optional date)
+ "String of Hebrew date before sunset of Gregorian DATE.
+Defaults to today's date if DATE is not given.
+Driven by the variable `calendar-date-display-form'."
+ (let* ((hebrew-date (calendar-hebrew-from-absolute
(calendar-absolute-from-gregorian
- (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!")))))
+ (or date (calendar-current-date)))))
(calendar-month-name-array
(if (hebrew-calendar-leap-year-p (extract-calendar-year hebrew-date))
calendar-hebrew-month-name-array-leap-year
calendar-hebrew-month-name-array-common-year)))
- (message "Hebrew date: %s" (calendar-date-string hebrew-date nil t))))
-
-(defun french-calendar-leap-year-p (year)
- "True if YEAR is a leap year on the French Revolutionary calendar.
-For Gregorian years 1793 to 1805, the years of actual operation of the
-calendar, uses historical practice based on equinoxes is followed (years 3, 7,
-and 11 were leap years; 15 and 20 would have been leap years). For later
-years uses the proposed rule of Romme (never adopted)--leap years fall every
-four years except century years not divisible 400 and century years that are
-multiples of 4000."
- (or (memq year '(3 7 11));; Actual practice--based on equinoxes
- (memq year '(15 20)) ;; Anticipated practice--based on equinoxes
- (and (> year 20) ;; Romme's proposal--never adopted
- (zerop (% year 4))
- (not (memq (% year 400) '(100 200 300)))
- (not (zerop (% year 4000))))))
-
-(defun french-calendar-last-day-of-month (month year)
- "Last day of MONTH, YEAR on the French Revolutionary calendar.
-The 13th month is not really a month, but the 5 (6 in leap years) day period of
-`sansculottides' at the end of the year."
- (if (< month 13)
- 30
- (if (french-calendar-leap-year-p year)
- 6
- 5)))
-
-(defun calendar-absolute-from-french (date)
- "Absolute date of French Revolutionary DATE.
-The absolute date is the number of days elapsed since the (imaginary)
-Gregorian date Sunday, December 31, 1 BC."
- (let ((month (extract-calendar-month date))
- (day (extract-calendar-day date))
- (year (extract-calendar-year date)))
- (+ (* 365 (1- year));; Days in prior years
- ;; Leap days in prior years
- (if (< year 20)
- (/ year 4);; Actual and anticipated practice (years 3, 7, 11, 15)
- ;; Romme's proposed rule (using the Principle of Inclusion/Exclusion)
- (+ (/ (1- year) 4);; Luckily, there were 4 leap years before year 20
- (- (/ (1- year) 100))
- (/ (1- year) 400)
- (- (/ (1- year) 4000))))
- (* 30 (1- month));; Days in prior months this year
- day;; Days so far this month
- 654414)));; Days before start of calendar (September 22, 1792).
-
-(defun calendar-french-from-absolute (date)
- "Compute the French Revolutionary date (month day year) corresponding to
-absolute DATE. The absolute date is the number of days elapsed since the
-(imaginary) Gregorian date Sunday, December 31, 1 BC."
- (if (< date 654415)
- (list 0 0 0);; pre-French Revolutionary date
- (let* ((approx (/ (- date 654414) 366));; Approximation from below.
- (year ;; Search forward from the approximation.
- (+ approx
- (calendar-sum y approx
- (>= date (calendar-absolute-from-french (list 1 1 (1+ y))))
- 1)))
- (month ;; Search forward from Vendemiaire.
- (1+ (calendar-sum m 1
- (> date
- (calendar-absolute-from-french
- (list m
- (french-calendar-last-day-of-month m year)
- year)))
- 1)))
- (day ;; Calculate the day by subtraction.
- (- date
- (1- (calendar-absolute-from-french (list month 1 year))))))
- (list month day year))))
+ (calendar-date-string hebrew-date nil t)))
-(defun cursor-to-french-calendar-date ()
- "Show the French Revolutionary calendar equivalent of the date under the
-cursor."
+(defun calendar-print-hebrew-date ()
+ "Show the Hebrew calendar equivalent of the date under the cursor."
(interactive)
- (let* ((french-date (calendar-french-from-absolute
- (calendar-absolute-from-gregorian
- (or (calendar-cursor-to-date)
- (error "Cursor is not on a date!")))))
- (y (extract-calendar-year french-date))
- (m (extract-calendar-month french-date))
- (d (extract-calendar-day french-date)))
- (if (< y 1)
- (message "Date is pre-French Revolution")
- (if (= m 13)
- (message "Jour %s de l'Annee %d de la Revolution"
- (aref french-calendar-special-days-array (1- d))
- y)
- (message "Decade %s, %s de %s de l'Annee %d de la Revolution"
- (make-string (1+ (/ (1- d) 10)) ?I)
- (aref french-calendar-day-name-array (% (1- d) 10))
- (aref french-calendar-month-name-array (1- m))
- y)))))
-
-(defconst french-calendar-month-name-array
- ["Vendemiaire" "Brumaire" "Frimaire" "Nivose" "Pluviose" "Ventose" "Germinal"
- "Floreal" "Prairial" "Messidor" "Thermidor" "Fructidor"])
-;; Very loosely translated as
-;; Slippy, Nippy, Drippy, Freezy, Wheezy, Sneezy,
-;; Showery, Flowery, Bowery, Heaty, Wheaty, Sweety.
-
-(defconst french-calendar-day-name-array
- ["Primidi" "Duodi" "Tridi" "Quartidi" "Quintidi" "Sextidi" "Septidi"
- "Octidi" "Nonidi" "Decadi"])
-
-(defconst french-calendar-special-days-array
- ["de la Vertu" "du Genie" "du Labour" "de la Raison" "de la Recompense"
- "de la Revolution"])
+ (message "Hebrew date (until sunset): %s"
+ (calendar-hebrew-date-string (calendar-cursor-to-date t))))
+
+(defun hebrew-calendar-yahrzeit (death-date year)
+ "Absolute date of the anniversary of Hebrew DEATH-DATE in Hebrew YEAR."
+ (let* ((death-day (extract-calendar-day death-date))
+ (death-month (extract-calendar-month death-date))
+ (death-year (extract-calendar-year death-date)))
+ (cond
+ ;; If it's Heshvan 30 it depends on the first anniversary; if
+ ;; that was not Heshvan 30, use the day before Kislev 1.
+ ((and (= death-month 8)
+ (= death-day 30)
+ (not (hebrew-calendar-long-heshvan-p (1+ death-year))))
+ (1- (calendar-absolute-from-hebrew (list 9 1 year))))
+ ;; If it's Kislev 30 it depends on the first anniversary; if
+ ;; that was not Kislev 30, use the day before Teveth 1.
+ ((and (= death-month 9)
+ (= death-day 30)
+ (hebrew-calendar-short-kislev-p (1+ death-year)))
+ (1- (calendar-absolute-from-hebrew (list 10 1 year))))
+ ;; If it's Adar II, use the same day in last month of
+ ;; year (Adar or Adar II).
+ ((= death-month 13)
+ (calendar-absolute-from-hebrew
+ (list (hebrew-calendar-last-month-of-year year) death-day year)))
+ ;; If it's the 30th in Adar I and year is not a leap year
+ ;; (so Adar has only 29 days), use the last day in Shevat.
+ ((and (= death-day 30)
+ (= death-month 12)
+ (not (hebrew-calendar-leap-year-p year)))
+ (calendar-absolute-from-hebrew (list 11 30 year)))
+ ;; In all other cases, use the normal anniversary of the date of death.
+ (t (calendar-absolute-from-hebrew
+ (list death-month death-day year))))))
+
+(defun calendar-set-mode-line (str)
+ "Set mode line to STR, centered, surrounded by dashes."
+ (setq mode-line-format
+ (calendar-string-spread (list "" str "") ?- (frame-width))))
+
+;;;###autoload
+(defun list-yahrzeit-dates (death-date start-year end-year)
+ "List Yahrzeit dates for *Gregorian* DEATH-DATE from START-YEAR to END-YEAR.
+When called interactively from the calendar window, the date of death is taken
+from the cursor position."
+ (interactive
+ (let* ((death-date
+ (if (equal (current-buffer) (get-buffer calendar-buffer))
+ (calendar-cursor-to-date)
+ (let* ((today (calendar-current-date))
+ (year (calendar-read
+ "Year of death (>0): "
+ '(lambda (x) (> x 0))
+ (int-to-string (extract-calendar-year today))))
+ (month-array calendar-month-name-array)
+ (completion-ignore-case t)
+ (month (cdr (assoc
+ (capitalize
+ (completing-read
+ "Month of death (name): "
+ (mapcar 'list (append month-array nil))
+ nil t))
+ (calendar-make-alist
+ month-array 1 'capitalize))))
+ (last (calendar-last-day-of-month month year))
+ (day (calendar-read
+ (format "Day of death (1-%d): " last)
+ '(lambda (x) (and (< 0 x) (<= x last))))))
+ (list month day year))))
+ (death-year (extract-calendar-year death-date))
+ (start-year (calendar-read
+ (format "Starting year of Yahrzeit table (>%d): "
+ death-year)
+ '(lambda (x) (> x death-year))
+ (int-to-string (1+ death-year))))
+ (end-year (calendar-read
+ (format "Ending year of Yahrzeit table (>=%d): "
+ start-year)
+ '(lambda (x) (>= x start-year)))))
+ (list death-date start-year end-year)))
+ (message "Computing yahrzeits...")
+ (let* ((yahrzeit-buffer "*Yahrzeits*")
+ (h-date (calendar-hebrew-from-absolute
+ (calendar-absolute-from-gregorian death-date)))
+ (h-month (extract-calendar-month h-date))
+ (h-day (extract-calendar-day h-date))
+ (h-year (extract-calendar-year h-date)))
+ (set-buffer (get-buffer-create yahrzeit-buffer))
+ (setq buffer-read-only nil)
+ (calendar-set-mode-line
+ (format "Yahrzeit dates for %s = %s"
+ (calendar-date-string death-date)
+ (let ((calendar-month-name-array
+ (if (hebrew-calendar-leap-year-p h-year)
+ calendar-hebrew-month-name-array-leap-year
+ calendar-hebrew-month-name-array-common-year)))
+ (calendar-date-string h-date nil t))))
+ (erase-buffer)
+ (goto-char (point-min))
+ (calendar-for-loop i from start-year to end-year do
+ (insert
+ (calendar-date-string
+ (calendar-gregorian-from-absolute
+ (hebrew-calendar-yahrzeit
+ h-date
+ (extract-calendar-year
+ (calendar-hebrew-from-absolute
+ (calendar-absolute-from-gregorian (list 1 1 i))))))) "\n"))
+ (goto-char (point-min))
+ (set-buffer-modified-p nil)
+ (setq buffer-read-only t)
+ (display-buffer yahrzeit-buffer)
+ (message "Computing yahrzeits...done")))
+
+(defun calendar-astro-date-string (&optional date)
+ "String of astronomical (Julian) day number of afternoon of Gregorian DATE.
+Defaults to today's date if DATE is not given."
+ (int-to-string
+ (+ 1721425 (calendar-absolute-from-gregorian
+ (or date (calendar-current-date))))))
+
+(defun calendar-print-astro-day-number ()
+ "Show astronomical (Julian) day number of afternoon on date shown by cursor."
+ (interactive)
+ (message
+ "Astronomical (Julian) day number after noon UTC: %s"
+ (calendar-astro-date-string (calendar-cursor-to-date t))))
+
+(defun calendar-goto-astro-day-number (daynumber &optional noecho)
+ "Move cursor to astronomical (Julian) DAYNUMBER.
+Echo astronomical (Julian) day number unless NOECHO is t."
+ (interactive (list (calendar-read
+ "Astronomical (Julian) day number (>1721425): "
+ '(lambda (x) (> x 1721425)))))
+ (calendar-goto-date (calendar-gregorian-from-absolute (- daynumber 1721425)))
+ (or noecho (calendar-print-astro-day-number)))
+
+(run-hooks 'calendar-load-hook)
(provide 'calendar)
+;;; calendar.el ends here