1 ;;; calendar.el --- calendar functions
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
9 ;; Human-Keywords: calendar, Gregorian calendar, diary, holidays
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; This collection of functions implements a calendar window. It
31 ;; generates a calendar for the current month, together with the
32 ;; previous and coming months, or for any other three-month period.
33 ;; The calendar can be scrolled forward and backward in the window to
34 ;; show months in the past or future; the cursor can move forward and
35 ;; backward by days, weeks, or months, making it possible, for
36 ;; instance, to jump to the date a specified number of days, weeks, or
37 ;; months from the date under the cursor. The user can display a list
38 ;; of holidays and other notable days for the period shown; the
39 ;; notable days can be marked on the calendar, if desired. The user
40 ;; can also specify that dates having corresponding diary entries (in
41 ;; a file that the user specifies) be marked; the diary entries for
42 ;; any date can be viewed in a separate window. The diary and the
43 ;; notable days can be viewed independently of the calendar. Dates
44 ;; can be translated from the (usual) Gregorian calendar to the day of
45 ;; the year/days remaining in year, to the ISO commercial calendar, to
46 ;; the Julian (old style) calendar, to the Hebrew calendar, to the
47 ;; Islamic calendar, to the Baha'i calendar, to the French
48 ;; Revolutionary calendar, to the Mayan calendar, to the Chinese
49 ;; calendar, to the Coptic calendar, to the Ethiopic calendar, and to
50 ;; the astronomical (Julian) day number. When floating point is
51 ;; available, times of sunrise/sunset can be displayed, as can the
52 ;; phases of the moon. Appointment notification for diary entries is
53 ;; available. Calendar printing via LaTeX is available.
55 ;; The following files are part of the calendar/diary code:
57 ;; appt.el Appointment notification
58 ;; cal-china.el Chinese calendar
59 ;; cal-coptic.el Coptic/Ethiopic calendars
60 ;; cal-dst.el Daylight savings time rules
61 ;; cal-hebrew.el Hebrew calendar
62 ;; cal-islam.el Islamic calendar
63 ;; cal-bahai.el Baha'i calendar
64 ;; cal-iso.el ISO calendar
65 ;; cal-julian.el Julian/astronomical calendars
66 ;; cal-mayan.el Mayan calendars
67 ;; cal-menu.el Menu support
68 ;; cal-move.el Movement in the calendar
69 ;; cal-persia.el Persian calendar
70 ;; cal-tex.el Calendars in LaTeX
71 ;; cal-x.el X-windows dedicated frame functions
72 ;; diary-lib.el Diary functions
73 ;; holidays.el Holiday functions
74 ;; lunar.el Phases of the moon
75 ;; solar.el Sunrise/sunset, equinoxes/solstices
77 ;; Technical details of all the calendrical calculations can be found in
78 ;; ``Calendrical Calculations: The Millennium Edition'' by Edward M. Reingold
79 ;; and Nachum Dershowitz, Cambridge University Press (2001).
81 ;; An earlier version of the technical details appeared in
82 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
83 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
84 ;; pages 899-928, and in ``Calendrical Calculations, Part II: Three Historical
85 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
86 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
89 ;; Hard copies of these two papers can be obtained by sending email to
90 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
91 ;; the message BODY containing your mailing address (snail).
93 ;; Comments, corrections, and improvements should be sent to
94 ;; Edward M. Reingold Department of Computer Science
95 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
96 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
97 ;; Urbana, Illinois 61801
101 (defvar displayed-month)
102 (defvar displayed-year)
103 (defvar calendar-month-name-array)
104 (defvar calendar-starred-day)
106 (defun calendar-version ()
108 (message "Version 6, October 12, 1995"))
110 (defgroup calendar nil
111 "Calendar and time management support."
112 :group 'applications)
119 "Appointment notification."
122 (defgroup holidays nil
123 "Holidays support in calendar."
128 (defgroup chinese-calendar nil
129 "Chinese calendar support."
132 (defgroup calendar-tex nil
133 "Options for printing calendar with LaTeX."
137 (defgroup calendar-hooks nil
143 (defconst calendar-buffer "*Calendar*"
144 "Name of the buffer used for the calendar.")
147 (defcustom calendar-offset 0
148 "The offset of the principal month from the center of the calendar window.
149 0 means the principal month is in the center (default), -1 means on the left,
150 +1 means on the right. Larger (or smaller) values push the principal month off
156 (defcustom view-diary-entries-initially nil
157 "Non-nil means display current date's diary entries on entry to calendar.
158 The diary is displayed in another window when the calendar is first displayed,
159 if the current date is visible. The number of days of diary entries displayed
160 is governed by the variable `number-of-diary-entries'. This variable can
161 be overridden by the value of `calendar-setup'."
166 (defcustom mark-diary-entries-in-calendar nil
167 "Non-nil means mark dates with diary entries, in the calendar window.
168 The marking symbol is specified by the variable `diary-entry-marker'."
173 (defcustom calendar-remove-frame-by-deleting nil
174 "Determine how the calendar mode removes a frame no longer needed.
175 If nil, make an icon of the frame. If non-nil, delete the frame."
179 (defvar diary-face 'diary
180 "Face name to use for diary entries.")
182 '((((min-colors 88) (class color) (background light))
184 (((class color) (background light))
186 (((min-colors 88) (class color) (background dark))
187 :foreground "yellow1")
188 (((class color) (background dark))
189 :foreground "yellow")
192 "Face for highlighting diary entries."
194 ;; backward-compatibility alias
195 (put 'diary-face 'face-alias 'diary)
197 (defface calendar-today
198 '((t (:underline t)))
199 "Face for indicating today's date."
201 ;; backward-compatibility alias
202 (put 'calendar-today-face 'face-alias 'calendar-today)
205 '((((class color) (background light))
207 (((class color) (background dark))
208 :background "chocolate4")
211 "Face for indicating dates that have holidays."
213 ;; backward-compatibility alias
214 (put 'holiday-face 'face-alias 'holiday)
216 (eval-after-load "facemenu"
218 (add-to-list 'facemenu-unlisted-faces 'diary)
219 (add-to-list 'facemenu-unlisted-faces 'calendar-today)
220 (add-to-list 'facemenu-unlisted-faces 'holiday)))
222 (defcustom diary-entry-marker
223 (if (not (display-color-p))
226 "How to mark dates that have diary entries.
227 The value can be either a single-character string or a face."
228 :type '(choice string face)
231 (defcustom calendar-today-marker
232 (if (not (display-color-p))
235 "How to mark today's date in the calendar.
236 The value can be either a single-character string or a face.
237 Marking today's date is done only if you set up `today-visible-calendar-hook'
239 :type '(choice string face)
242 (defcustom calendar-holiday-marker
243 (if (not (display-color-p))
246 "How to mark notable dates in the calendar.
247 The value can be either a single-character string or a face."
248 :type '(choice string face)
252 (defcustom view-calendar-holidays-initially nil
253 "Non-nil means display holidays for current three month period on entry.
254 The holidays are displayed in another window when the calendar is first
260 (defcustom mark-holidays-in-calendar nil
261 "Non-nil means mark dates of holidays in the calendar window.
262 The marking symbol is specified by the variable `calendar-holiday-marker'."
267 (defcustom all-hebrew-calendar-holidays nil
268 "If nil, show only major holidays from the Hebrew calendar.
269 This means only those Jewish holidays that appear on secular calendars.
271 If t, show all the holidays that would appear in a complete Hebrew calendar."
276 (defcustom all-christian-calendar-holidays nil
277 "If nil, show only major holidays from the Christian calendar.
278 This means only those Christian holidays that appear on secular calendars.
280 If t, show all the holidays that would appear in a complete Christian
286 (defcustom all-islamic-calendar-holidays nil
287 "If nil, show only major holidays from the Islamic calendar.
288 This means only those Islamic holidays that appear on secular calendars.
290 If t, show all the holidays that would appear in a complete Islamic
295 (defcustom diary-file-name-prefix-function (function (lambda (str) str))
296 "The function that will take a diary file name and return the desired prefix."
301 (defcustom all-bahai-calendar-holidays nil
302 "If nil, show only major holidays from the Baha'i calendar.
303 These are the days on which work and school must be suspended.
305 If t, show all the holidays that would appear in a complete Baha'i
311 (defcustom calendar-load-hook nil
312 "List of functions to be called after the calendar is first loaded.
313 This is the place to add key bindings to `calendar-mode-map'."
315 :group 'calendar-hooks)
318 (defcustom initial-calendar-window-hook nil
319 "List of functions to be called when the calendar window is first opened.
320 The functions invoked are called after the calendar window is opened, but
321 once opened is never called again. Leaving the calendar with the `q' command
322 and reentering it will cause these functions to be called again."
324 :group 'calendar-hooks)
327 (defcustom today-visible-calendar-hook nil
328 "List of functions called whenever the current date is visible.
329 This can be used, for example, to replace today's date with asterisks; a
330 function `calendar-star-date' is included for this purpose:
331 (setq today-visible-calendar-hook 'calendar-star-date)
332 It can also be used to mark the current date with `calendar-today-marker';
333 a function is also provided for this:
334 (setq today-visible-calendar-hook 'calendar-mark-today)
336 The corresponding variable `today-invisible-calendar-hook' is the list of
337 functions called when the calendar function was called when the current
338 date is not visible in the window.
340 Other than the use of the provided functions, the changing of any
341 characters in the calendar buffer by the hooks may cause the failure of the
342 functions that move by days and weeks."
344 :group 'calendar-hooks)
347 (defcustom today-invisible-calendar-hook nil
348 "List of functions called whenever the current date is not visible.
350 The corresponding variable `today-visible-calendar-hook' is the list of
351 functions called when the calendar function was called when the current
352 date is visible in the window.
354 Other than the use of the provided functions, the changing of any
355 characters in the calendar buffer by the hooks may cause the failure of the
356 functions that move by days and weeks."
358 :group 'calendar-hooks)
361 (defcustom calendar-move-hook nil
362 "List of functions called whenever the cursor moves in the calendar.
366 (add-hook 'calendar-move-hook (lambda () (diary-view-entries 1)))
368 redisplays the diary for whatever date the cursor is moved to."
370 :group 'calendar-hooks)
373 (defcustom diary-file "~/diary"
374 "Name of the file in which one's personal diary of dates is kept.
376 The file's entries are lines beginning with any of the forms
377 specified by the variable `american-date-diary-pattern', by default:
385 with the remainder of the line being the diary entry string for
386 that date. MONTH and DAY are one or two digit numbers, YEAR is a
387 number and may be written in full or abbreviated to the final two
388 digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME
389 and DAYNAME can be spelled in full (as specified by the variables
390 `calendar-month-name-array' and `calendar-day-name-array'),
391 abbreviated (as specified by `calendar-month-abbrev-array' and
392 `calendar-day-abbrev-array') with or without a period,
393 capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be
394 `*' which matches any day, month, or year, respectively. If the
395 date does not contain a year, it is generic and applies to any
396 year. A DAYNAME entry applies to the appropriate day of the week
399 The European style (in which the day precedes the month) can be
400 used instead, if you execute `european-calendar' when in the
401 calendar, or set `european-calendar-style' to t in your .emacs
402 file. The European forms (see `european-date-diary-pattern') are
410 To revert to the default American style from the European style, execute
411 `american-calendar' in the calendar.
413 A diary entry can be preceded by the character
414 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
415 nonmarking--that is, it will not be marked on dates in the calendar
416 window but will appear in a diary window.
418 Multiline diary entries are made by indenting lines after the first with
419 either a TAB or one or more spaces.
421 Lines not in one the above formats are ignored. Here are some sample diary
422 entries (in the default American style):
424 12/22/1988 Twentieth wedding anniversary!!
425 &1/1. Happy New Year!
426 10/22 Ruth's birthday.
428 Tuesday--weekly meeting with grad students at 10am
429 Supowit, Shen, Bitner, and Kapoor to attend.
430 1/13/89 Friday the thirteenth!!
431 &thu 4pm squash game with Lloyd.
432 mar 16 Dad's birthday
433 April 15, 1989 Income tax due.
434 &* 15 time cards due.
436 If the first line of a diary entry consists only of the date or day name with
437 no trailing blanks or punctuation, then that line is not displayed in the
438 diary window; only the continuation lines is shown. For example, the
442 Bill Blattner visits Princeton today
443 2pm Cognitive Studies Committee meeting
444 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
445 4:00pm Jamie Tappenden
446 7:30pm Dinner at George and Ed's for Alan Ryan
447 7:30-10:00pm dance at Stewart Country Day School
449 will appear in the diary window without the date line at the beginning. This
450 facility allows the diary window to look neater, but can cause confusion if
451 used with more than one day's entries displayed.
453 Diary entries can be based on Lisp sexps. For example, the diary entry
455 %%(diary-block 11 1 1990 11 10 1990) Vacation
457 causes the diary entry \"Vacation\" to appear from November 1 through
458 November 10, 1990. Other functions available are `diary-float',
459 `diary-anniversary', `diary-cyclic', `diary-day-of-year',
460 `diary-iso-date', `diary-french-date', `diary-hebrew-date',
461 `diary-islamic-date', `diary-bahai-date', `diary-mayan-date',
462 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
463 `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset',
464 `diary-phases-of-moon', `diary-parasha', `diary-omer',
465 `diary-rosh-hodesh', and `diary-sabbath-candles'. See the
466 documentation for the function `list-sexp-diary-entries' for more
469 Diary entries based on the Hebrew, the Islamic and/or the Baha'i
470 calendar are also possible, but because these are somewhat slow, they
471 are ignored unless you set the `nongregorian-diary-listing-hook' and
472 the `nongregorian-diary-marking-hook' appropriately. See the
473 documentation for these functions for details.
475 Diary files can contain directives to include the contents of other files; for
476 details, see the documentation for the variable `list-diary-entries-hook'."
481 (defcustom diary-nonmarking-symbol "&"
482 "Symbol indicating that a diary entry is not to be marked in the calendar."
487 (defcustom hebrew-diary-entry-symbol "H"
488 "Symbol indicating a diary entry according to the Hebrew calendar."
493 (defcustom islamic-diary-entry-symbol "I"
494 "Symbol indicating a diary entry according to the Islamic calendar."
499 (defcustom bahai-diary-entry-symbol "B"
500 "Symbol indicating a diary entry according to the Baha'i calendar."
505 (defcustom diary-include-string "#include"
506 "The string indicating inclusion of another file of diary entries.
507 See the documentation for the function `include-other-diary-files'."
511 (defcustom diary-glob-file-regexp-prefix "^\\#"
512 "The regular expression that gets pre-pended to each of the attribute-regexp's for file-wide specifiers."
516 (defcustom diary-face-attrs
517 '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string)
518 (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string)
519 (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol)
520 (" *\\[height:\\([-0-9a-z]+\\)\\]$" 1 :height int)
521 (" *\\[weight:\\([-a-z]+\\)\\]$" 1 :weight symbol)
522 (" *\\[slant:\\([-a-z]+\\)\\]$" 1 :slant symbol)
523 (" *\\[underline:\\([-a-z]+\\)\\]$" 1 :underline stringtnil)
524 (" *\\[overline:\\([-a-z]+\\)\\]$" 1 :overline stringtnil)
525 (" *\\[strike-through:\\([-a-z]+\\)\\]$" 1 :strike-through stringtnil)
526 (" *\\[inverse-video:\\([-a-z]+\\)\\]$" 1 :inverse-video tnil)
527 (" *\\[face:\\([-0-9a-z]+\\)\\]$" 1 :face string)
528 (" *\\[font:\\([-a-z0-9]+\\)\\]$" 1 :font string)
530 ;;; (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box)
531 ;;; (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple)
533 "A list of (regexp regnum attr attrtype) lists where the
534 regexp says how to find the tag, the regnum says which
535 parenthetical sub-regexp this regexp looks for, and the attr says
536 which attribute of the face (or that this _is_ a face) is being
541 (defcustom diary-file-name-prefix nil
542 "If non-nil each diary entry is prefixed with the name of the file where it is defined."
547 (defcustom sexp-diary-entry-symbol "%%"
548 "The string used to indicate a sexp diary entry in `diary-file'.
549 See the documentation for the function `list-sexp-diary-entries'."
554 (defcustom abbreviated-calendar-year t
555 "Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
556 For the Gregorian calendar; similarly for the Hebrew, Islamic and
557 Baha'i calendars. If this variable is nil, years must be written in
563 (defcustom european-calendar-style nil
564 "Use the European style of dates in the diary and in any displays.
565 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
566 1990. The default European date styles (see `european-date-diary-pattern')
575 Names can be capitalized or not, written in full (as specified by the
576 variable `calendar-day-name-array'), or abbreviated (as specified by
577 `calendar-day-abbrev-array') with or without a period. To take effect,
578 this variable should be set before the calendar package and its associates
579 are loaded. Otherwise, use one of the functions `european-calendar' or
580 `american-calendar' to force the appropriate update."
585 (defcustom american-date-diary-pattern
586 '((month "/" day "[^/0-9]")
587 (month "/" day "/" year "[^0-9]")
588 (monthname " *" day "[^,0-9]")
589 (monthname " *" day ", *" year "[^0-9]")
591 "List of pseudo-patterns describing the American patterns of date used.
592 See the documentation of `diary-date-forms' for an explanation."
593 :type '(repeat (choice (cons :tag "Backup"
594 :value (backup . nil)
596 (repeat (list :inline t :format "%v"
597 (symbol :tag "Keyword")
598 (choice symbol regexp))))
599 (repeat (list :inline t :format "%v"
600 (symbol :tag "Keyword")
601 (choice symbol regexp)))))
605 (defcustom european-date-diary-pattern
606 '((day "/" month "[^/0-9]")
607 (day "/" month "/" year "[^0-9]")
608 (backup day " *" monthname "\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
609 (day " *" monthname " *" year "[^0-9]")
611 "List of pseudo-patterns describing the European patterns of date used.
612 See the documentation of `diary-date-forms' for an explanation."
613 :type '(repeat (choice (cons :tag "Backup"
614 :value (backup . nil)
616 (repeat (list :inline t :format "%v"
617 (symbol :tag "Keyword")
618 (choice symbol regexp))))
619 (repeat (list :inline t :format "%v"
620 (symbol :tag "Keyword")
621 (choice symbol regexp)))))
624 (defcustom diary-date-forms
625 (if european-calendar-style
626 european-date-diary-pattern
627 american-date-diary-pattern)
628 "List of pseudo-patterns describing the forms of date used in the diary.
629 The patterns on the list must be MUTUALLY EXCLUSIVE and should not match
630 any portion of the diary entry itself, just the date component.
632 A pseudo-pattern is a list of regular expressions and the keywords `month',
633 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
634 match the name of the month (see `calendar-month-name-array'), capitalized
635 or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'),
636 followed by a period or not; it will also match `*'. Similarly, `dayname'
637 will match the name of the day (see `calendar-day-name-array'), capitalized or
638 not, or its user-specified abbreviation (see `calendar-day-abbrev-array'),
639 followed by a period or not. The keywords `month', `day', and `year' will
640 match those numerical values, preceded by arbitrarily many zeros; they will
643 The matching of the diary entries with the date forms is done with the
644 standard syntax table from Fundamental mode, but with the `*' changed so
645 that it is a word constituent.
647 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
648 diary entry itself, the first element of the pattern MUST be `backup'. This
649 directive causes the date recognizer to back up to the beginning of the
650 current word of the diary entry, so in no case can the pattern match more than
651 a portion of the first word of the diary entry."
652 :type '(repeat (choice (cons :tag "Backup"
653 :value (backup . nil)
655 (repeat (list :inline t :format "%v"
656 (symbol :tag "Keyword")
657 (choice symbol regexp))))
658 (repeat (list :inline t :format "%v"
659 (symbol :tag "Keyword")
660 (choice symbol regexp)))))
664 (defcustom european-calendar-display-form
665 '((if dayname (concat dayname ", ")) day " " monthname " " year)
666 "Pseudo-pattern governing the way a date appears in the European style.
667 See the documentation of `calendar-date-display-form' for an explanation."
672 (defcustom american-calendar-display-form
673 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
674 "Pseudo-pattern governing the way a date appears in the American style.
675 See the documentation of `calendar-date-display-form' for an explanation."
679 (defcustom calendar-date-display-form
680 (if european-calendar-style
681 european-calendar-display-form
682 american-calendar-display-form)
683 "Pseudo-pattern governing the way a date appears.
685 Used by the function `calendar-date-string', a pseudo-pattern is a list of
686 expressions that can involve the keywords `month', `day', and `year', all
687 numbers in string form, and `monthname' and `dayname', both alphabetic
688 strings. For example, the ISO standard would use the pseudo- pattern
690 '(year \"-\" month \"-\" day)
692 while a typical American form would be
694 '(month \"/\" day \"/\" (substring year -2))
698 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
700 would give the usual American style in fixed-length fields.
702 See the documentation of the function `calendar-date-string'."
706 (defun european-calendar ()
707 "Set the interpretation and display of dates to the European style."
709 (setq european-calendar-style t)
710 (setq calendar-date-display-form european-calendar-display-form)
711 (setq diary-date-forms european-date-diary-pattern)
712 (update-calendar-mode-line))
714 (defun american-calendar ()
715 "Set the interpretation and display of dates to the American style."
717 (setq european-calendar-style nil)
718 (setq calendar-date-display-form american-calendar-display-form)
719 (setq diary-date-forms american-date-diary-pattern)
720 (update-calendar-mode-line))
723 (defcustom print-diary-entries-hook 'lpr-buffer
724 "List of functions called after a temporary diary buffer is prepared.
725 The buffer shows only the diary entries currently visible in the diary
726 buffer. The default just does the printing. Other uses might include, for
727 example, rearranging the lines into order by day and time, saving the buffer
728 instead of deleting it, or changing the function used to do the printing."
733 (defcustom list-diary-entries-hook nil
734 "List of functions called after diary file is culled for relevant entries.
735 It is to be used for diary entries that are not found in the diary file.
737 A function `include-other-diary-files' is provided for use as the value of
738 this hook. This function enables you to use shared diary files together
739 with your own. The files included are specified in the diary file by lines
742 #include \"filename\"
744 This is recursive; that is, #include directives in files thus included are
745 obeyed. You can change the \"#include\" to some other string by changing
746 the variable `diary-include-string'. When you use `include-other-diary-files'
747 as part of the list-diary-entries-hook, you will probably also want to use the
748 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
750 For example, you could use
752 (setq list-diary-entries-hook
753 '(include-other-diary-files sort-diary-entries))
754 (setq diary-display-hook 'fancy-diary-display)
756 in your `.emacs' file to cause the fancy diary buffer to be displayed with
757 diary entries from various included files, each day's entries sorted into
758 lexicographic order."
760 :options '(include-other-diary-files sort-diary-entries)
764 (defcustom diary-hook nil
765 "List of functions called after the display of the diary.
766 Can be used for appointment notification."
771 (defcustom diary-display-hook nil
772 "List of functions that handle the display of the diary.
773 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
776 Ordinarily, this just displays the diary buffer (with holidays indicated in
777 the mode line), if there are any relevant entries. At the time these
778 functions are called, the variable `diary-entries-list' is a list, in order
779 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
780 STRING), where string is the diary entry for the given date. This can be
781 used, for example, a different buffer for display (perhaps combined with
782 holidays), or produce hard copy output.
784 A function `fancy-diary-display' is provided as an alternative
785 choice for this hook; this function prepares a special noneditable diary
786 buffer with the relevant diary entries that has neat day-by-day arrangement
787 with headings. The fancy diary buffer will show the holidays unless the
788 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
789 diary buffer will not show days for which there are no diary entries, even
790 if that day is a holiday; if you want such days to be shown in the fancy
791 diary buffer, set the variable `diary-list-include-blanks' to t."
793 :options '(fancy-diary-display)
797 (defcustom nongregorian-diary-listing-hook nil
798 "List of functions called for listing diary file and included files.
799 As the files are processed for diary entries, these functions are used
800 to cull relevant entries. You can use either or both of
801 `list-hebrew-diary-entries', `list-islamic-diary-entries' and
802 `list-bahai-diary-entries'. The documentation for these functions
803 describes the style of such diary entries."
805 :options '(list-hebrew-diary-entries
806 list-islamic-diary-entries
807 list-bahai-diary-entries)
811 (defcustom mark-diary-entries-hook nil
812 "List of functions called after marking diary entries in the calendar.
814 A function `mark-included-diary-files' is also provided for use as the
815 `mark-diary-entries-hook'; it enables you to use shared diary files together
816 with your own. The files included are specified in the diary file by lines
818 #include \"filename\"
819 This is recursive; that is, #include directives in files thus included are
820 obeyed. You can change the \"#include\" to some other string by changing the
821 variable `diary-include-string'. When you use `mark-included-diary-files' as
822 part of the mark-diary-entries-hook, you will probably also want to use the
823 function `include-other-diary-files' as part of `list-diary-entries-hook'."
825 :options '(mark-included-diary-files)
829 (defcustom nongregorian-diary-marking-hook nil
830 "List of functions called for marking diary file and included files.
831 As the files are processed for diary entries, these functions are used
832 to cull relevant entries. You can use either or both of
833 `mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
834 `mark-bahai-diary-entries'. The documentation for these functions
835 describes the style of such diary entries."
837 :options '(mark-hebrew-diary-entries
838 mark-islamic-diary-entries
839 mark-bahai-diary-entries)
843 (defcustom diary-list-include-blanks nil
844 "If nil, do not include days with no diary entry in the list of diary entries.
845 Such days will then not be shown in the fancy diary buffer, even if they
851 (defcustom holidays-in-diary-buffer t
852 "Non-nil means include holidays in the diary display.
853 The holidays appear in the mode line of the diary buffer, or in the
854 fancy diary buffer next to the date. This slows down the diary functions
855 somewhat; setting it to nil makes the diary display faster."
859 (defvar calendar-mark-ring nil)
862 (put 'general-holidays 'risky-local-variable t)
864 (defcustom general-holidays
865 '((holiday-fixed 1 1 "New Year's Day")
866 (holiday-float 1 1 3 "Martin Luther King Day")
867 (holiday-fixed 2 2 "Groundhog Day")
868 (holiday-fixed 2 14 "Valentine's Day")
869 (holiday-float 2 1 3 "President's Day")
870 (holiday-fixed 3 17 "St. Patrick's Day")
871 (holiday-fixed 4 1 "April Fools' Day")
872 (holiday-float 5 0 2 "Mother's Day")
873 (holiday-float 5 1 -1 "Memorial Day")
874 (holiday-fixed 6 14 "Flag Day")
875 (holiday-float 6 0 3 "Father's Day")
876 (holiday-fixed 7 4 "Independence Day")
877 (holiday-float 9 1 1 "Labor Day")
878 (holiday-float 10 1 2 "Columbus Day")
879 (holiday-fixed 10 31 "Halloween")
880 (holiday-fixed 11 11 "Veteran's Day")
881 (holiday-float 11 4 4 "Thanksgiving"))
882 "General holidays. Default value is for the United States.
883 See the documentation for `calendar-holidays' for details."
888 (put 'oriental-holidays 'risky-local-variable t)
890 (defcustom oriental-holidays
891 '((if (fboundp 'atan)
892 (holiday-chinese-new-year)))
894 See the documentation for `calendar-holidays' for details."
899 (put 'local-holidays 'risky-local-variable t)
901 (defcustom local-holidays nil
903 See the documentation for `calendar-holidays' for details."
908 (put 'other-holidays 'risky-local-variable t)
910 (defcustom other-holidays nil
911 "User defined holidays.
912 See the documentation for `calendar-holidays' for details."
917 (put 'hebrew-holidays-1 'risky-local-variable t)
919 (defvar hebrew-holidays-1
920 '((holiday-rosh-hashanah-etc)
921 (if all-hebrew-calendar-holidays
924 (let* ((m displayed-month)
927 (increment-calendar-month m y -1)
928 (let ((year (extract-calendar-year
929 (calendar-julian-from-absolute
930 (calendar-absolute-from-gregorian
932 (if (zerop (% (1+ year) 4))
934 21))) "\"Tal Umatar\" (evening)"))))
937 (put 'hebrew-holidays-2 'risky-local-variable t)
939 (defvar hebrew-holidays-2
940 '((if all-hebrew-calendar-holidays
942 (holiday-hebrew 9 25 "Hanukkah"))
943 (if all-hebrew-calendar-holidays
946 (let ((h-year (extract-calendar-year
947 (calendar-hebrew-from-absolute
948 (calendar-absolute-from-gregorian
949 (list displayed-month 28 displayed-year))))))
950 (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
955 (if all-hebrew-calendar-holidays
956 (holiday-hebrew 11 15 "Tu B'Shevat"))))
959 (put 'hebrew-holidays-3 'risky-local-variable t)
961 (defvar hebrew-holidays-3
962 '((if all-hebrew-calendar-holidays
965 (let ((m displayed-month)
967 (increment-calendar-month m y 1)
968 (let* ((h-year (extract-calendar-year
969 (calendar-hebrew-from-absolute
970 (calendar-absolute-from-gregorian
972 (calendar-last-day-of-month m y)
975 (calendar-hebrew-from-absolute
977 (% (calendar-absolute-from-hebrew
981 (calendar-dayname-on-or-before
982 6 (calendar-absolute-from-hebrew
983 (list 11 17 h-year)))
984 (calendar-dayname-on-or-before
985 6 (calendar-absolute-from-hebrew
986 (list 11 16 h-year))))))
987 (day (extract-calendar-day s-s)))
992 (put 'hebrew-holidays-4 'risky-local-variable t)
994 (defvar hebrew-holidays-4
995 '((holiday-passover-etc)
996 (if (and all-hebrew-calendar-holidays
997 (let* ((m displayed-month)
1000 (increment-calendar-month m y -1)
1001 (let ((year (extract-calendar-year
1002 (calendar-julian-from-absolute
1003 (calendar-absolute-from-gregorian
1005 (= 21 (% year 28)))))
1006 (holiday-julian 3 26 "Kiddush HaHamah"))
1007 (if all-hebrew-calendar-holidays
1008 (holiday-tisha-b-av-etc))))
1011 (put 'hebrew-holidays 'risky-local-variable t)
1013 (defcustom hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
1014 hebrew-holidays-3 hebrew-holidays-4)
1016 See the documentation for `calendar-holidays' for details."
1021 (put 'christian-holidays 'risky-local-variable t)
1023 (defcustom christian-holidays
1024 '((if all-christian-calendar-holidays
1025 (holiday-fixed 1 6 "Epiphany"))
1026 (holiday-easter-etc 0 "Easter Sunday")
1027 (holiday-easter-etc -2 "Good Friday")
1028 (holiday-easter-etc -46 "Ash Wednesday")
1029 (if all-christian-calendar-holidays
1030 (holiday-easter-etc -63 "Septuagesima Sunday"))
1031 (if all-christian-calendar-holidays
1032 (holiday-easter-etc -56 "Sexagesima Sunday"))
1033 (if all-christian-calendar-holidays
1034 (holiday-easter-etc -49 "Shrove Sunday"))
1035 (if all-christian-calendar-holidays
1036 (holiday-easter-etc -48 "Shrove Monday"))
1037 (if all-christian-calendar-holidays
1038 (holiday-easter-etc -47 "Shrove Tuesday"))
1039 (if all-christian-calendar-holidays
1040 (holiday-easter-etc -14 "Passion Sunday"))
1041 (if all-christian-calendar-holidays
1042 (holiday-easter-etc -7 "Palm Sunday"))
1043 (if all-christian-calendar-holidays
1044 (holiday-easter-etc -3 "Maundy Thursday"))
1045 (if all-christian-calendar-holidays
1046 (holiday-easter-etc 35 "Rogation Sunday"))
1047 (if all-christian-calendar-holidays
1048 (holiday-easter-etc 39 "Ascension Day"))
1049 (if all-christian-calendar-holidays
1050 (holiday-easter-etc 49 "Pentecost (Whitsunday)"))
1051 (if all-christian-calendar-holidays
1052 (holiday-easter-etc 50 "Whitmonday"))
1053 (if all-christian-calendar-holidays
1054 (holiday-easter-etc 56 "Trinity Sunday"))
1055 (if all-christian-calendar-holidays
1056 (holiday-easter-etc 60 "Corpus Christi"))
1057 (if all-christian-calendar-holidays
1058 (holiday-greek-orthodox-easter))
1059 (if all-christian-calendar-holidays
1060 (holiday-fixed 8 15 "Assumption"))
1061 (if all-christian-calendar-holidays
1062 (holiday-advent 0 "Advent"))
1063 (holiday-fixed 12 25 "Christmas")
1064 (if all-christian-calendar-holidays
1065 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
1066 "Christian holidays.
1067 See the documentation for `calendar-holidays' for details."
1072 (put 'islamic-holidays 'risky-local-variable t)
1074 (defcustom islamic-holidays
1077 (format "Islamic New Year %d"
1078 (let ((m displayed-month)
1080 (increment-calendar-month m y 1)
1081 (extract-calendar-year
1082 (calendar-islamic-from-absolute
1083 (calendar-absolute-from-gregorian
1085 m (calendar-last-day-of-month m y) y)))))))
1086 (if all-islamic-calendar-holidays
1087 (holiday-islamic 1 10 "Ashura"))
1088 (if all-islamic-calendar-holidays
1089 (holiday-islamic 3 12 "Mulad-al-Nabi"))
1090 (if all-islamic-calendar-holidays
1091 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
1092 (if all-islamic-calendar-holidays
1093 (holiday-islamic 8 15 "Shab-e-Bara't"))
1094 (holiday-islamic 9 1 "Ramadan Begins")
1095 (if all-islamic-calendar-holidays
1096 (holiday-islamic 9 27 "Shab-e Qadr"))
1097 (if all-islamic-calendar-holidays
1098 (holiday-islamic 10 1 "Id-al-Fitr"))
1099 (if all-islamic-calendar-holidays
1100 (holiday-islamic 12 10 "Id-al-Adha")))
1102 See the documentation for `calendar-holidays' for details."
1107 (put 'bahai-holidays 'risky-local-variable t)
1109 (defcustom bahai-holidays
1112 (format "Baha'i New Year (Naw-Ruz) %d" (- displayed-year (1- 1844))))
1113 (holiday-fixed 4 21 "First Day of Ridvan")
1114 (if all-bahai-calendar-holidays
1115 (holiday-fixed 4 22 "Second Day of Ridvan"))
1116 (if all-bahai-calendar-holidays
1117 (holiday-fixed 4 23 "Third Day of Ridvan"))
1118 (if all-bahai-calendar-holidays
1119 (holiday-fixed 4 24 "Fourth Day of Ridvan"))
1120 (if all-bahai-calendar-holidays
1121 (holiday-fixed 4 25 "Fifth Day of Ridvan"))
1122 (if all-bahai-calendar-holidays
1123 (holiday-fixed 4 26 "Sixth Day of Ridvan"))
1124 (if all-bahai-calendar-holidays
1125 (holiday-fixed 4 27 "Seventh Day of Ridvan"))
1126 (if all-bahai-calendar-holidays
1127 (holiday-fixed 4 28 "Eighth Day of Ridvan"))
1128 (holiday-fixed 4 29 "Ninth Day of Ridvan")
1129 (if all-bahai-calendar-holidays
1130 (holiday-fixed 4 30 "Tenth Day of Ridvan"))
1131 (if all-bahai-calendar-holidays
1132 (holiday-fixed 5 1 "Eleventh Day of Ridvan"))
1133 (holiday-fixed 5 2 "Twelfth Day of Ridvan")
1134 (holiday-fixed 5 23 "Declaration of the Bab")
1135 (holiday-fixed 5 29 "Ascension of Baha'u'llah")
1136 (holiday-fixed 7 9 "Martyrdom of the Bab")
1137 (holiday-fixed 10 20 "Birth of the Bab")
1138 (holiday-fixed 11 12 "Birth of Baha'u'llah")
1139 (if all-bahai-calendar-holidays
1140 (holiday-fixed 11 26 "Day of the Covenant"))
1141 (if all-bahai-calendar-holidays
1142 (holiday-fixed 11 28 "Ascension of `Abdu'l-Baha")))
1144 See the documentation for `calendar-holidays' for details."
1149 (put 'solar-holidays 'risky-local-variable t)
1151 (defcustom solar-holidays
1152 '((if (fboundp 'atan)
1153 (solar-equinoxes-solstices))
1159 calendar-daylight-savings-starts
1160 '(format "Daylight Savings Time Begins %s"
1163 (/ calendar-daylight-savings-starts-time (float 60))
1164 calendar-standard-time-zone-name)
1168 calendar-daylight-savings-ends
1169 '(format "Daylight Savings Time Ends %s"
1172 (/ calendar-daylight-savings-ends-time (float 60))
1173 calendar-daylight-time-zone-name)
1175 "Sun-related holidays.
1176 See the documentation for `calendar-holidays' for details."
1181 (put 'calendar-holidays 'risky-local-variable t)
1182 (defcustom calendar-holidays
1183 (append general-holidays local-holidays other-holidays
1184 christian-holidays hebrew-holidays islamic-holidays
1185 bahai-holidays oriental-holidays solar-holidays)
1186 "List of notable days for the command \\[holidays].
1188 Additional holidays are easy to add to the list, just put them in the
1189 list `other-holidays' in your .emacs file. Similarly, by setting any
1190 of `general-holidays', `local-holidays' `christian-holidays',
1191 `hebrew-holidays', `islamic-holidays', `bahai-holidays',
1192 `oriental-holidays', or `solar-holidays' to nil in your .emacs file,
1193 you can eliminate unwanted categories of holidays.
1195 The aforementioned variables control the holiday choices offered
1196 by the function `list-holidays' when it is called interactively.
1198 They also initialize the default value of `calendar-holidays',
1199 which is the default list of holidays used by the function
1200 `list-holidays' in the non-interactive case. Note that these
1201 variables have no effect on `calendar-holidays' after it has been
1202 set (e.g. after the calendar is loaded). In that case, customize
1203 `calendar-holidays' directly.
1205 The intention is that (in the US) `local-holidays' be set in
1206 site-init.el and `other-holidays' be set by the user.
1208 Entries on the list are expressions that return (possibly empty) lists of
1209 items of the form ((month day year) string) of a holiday in the in the
1210 three-month period centered around `displayed-month' of `displayed-year'.
1211 Several basic functions are provided for this purpose:
1213 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1214 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1215 MONTH on the Gregorian calendar (0 for Sunday,
1216 etc.); K<0 means count back from the end of the
1217 month. An optional parameter DAY means the Kth
1218 DAYNAME after/before MONTH DAY.
1219 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1220 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1221 (holiday-bahai MONTH DAY STRING) a fixed date on the Baha'i calendar
1222 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1223 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
1224 in the variable `year'; if it evaluates to
1225 a visible date, that's the holiday; if it
1226 evaluates to nil, there's no holiday. STRING
1227 is an expression in the variable `date'.
1229 For example, to add Bastille Day, celebrated in France on July 14, add
1231 (holiday-fixed 7 14 \"Bastille Day\")
1233 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1234 Islands on the fourth Monday in August, add
1236 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
1238 to the list (the last Monday would be specified with `-1' instead of `4').
1239 To add the last day of Hanukkah to the list, use
1241 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
1243 since the Hebrew months are numbered with 1 starting from Nisan, while to
1244 add the Islamic feast celebrating Mohammed's birthday use
1246 (holiday-islamic 3 12 \"Mohammed's Birthday\")
1248 since the Islamic months are numbered from 1 starting with Muharram. To
1249 add an entry for the Baha'i festival of Ridvan, use
1251 (holiday-bahai 2 13 \"Festival of Ridvan\")
1253 since the Baha'i months are numbered from 1 starting with Baha. To
1254 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1256 (holiday-julian 4 2 \"Jefferson's Birthday\")
1258 To include a holiday conditionally, use the sexp form or a conditional. For
1259 example, to include American presidential elections, which occur on the first
1260 Tuesday after the first Monday in November of years divisible by 4, add
1263 '(if (zerop (% year 4))
1264 (calendar-gregorian-from-absolute
1265 (1+ (calendar-dayname-on-or-before
1266 1 (+ 6 (calendar-absolute-from-gregorian
1267 (list 11 1 year)))))))
1268 \"US Presidential Election\")
1272 (if (zerop (% displayed-year 4))
1274 (extract-calendar-day
1275 (calendar-gregorian-from-absolute
1276 (1+ (calendar-dayname-on-or-before
1277 1 (+ 6 (calendar-absolute-from-gregorian
1278 (list 11 1 displayed-year)))))))
1279 \"US Presidential Election\"))
1281 to the list. To include the phases of the moon, add
1285 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1286 you've written to return a (possibly empty) list of the relevant VISIBLE dates
1287 with descriptive strings such as
1289 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
1293 (defconst holiday-buffer "*Holidays*"
1294 "Name of the buffer used for the displaying the holidays.")
1296 (defconst fancy-diary-buffer "*Fancy Diary Entries*"
1297 "Name of the buffer used for the optional fancy display of the diary.")
1299 (defconst other-calendars-buffer "*Other Calendars*"
1300 "Name of the buffer used for the display of date on other calendars.")
1302 (defconst lunar-phases-buffer "*Phases of Moon*"
1303 "Name of the buffer used for the lunar phases.")
1305 (defmacro increment-calendar-month (mon yr n)
1306 "Increment the variables MON and YR by N months.
1307 Forward if N is positive or backward if N is negative.
1308 A negative YR is interpreted as BC; -1 being 1 BC, and so on."
1310 (if (< ,yr 0) (setq ,yr (1+ ,yr))) ; -1 BC -> 0 AD, etc
1311 (setq macro-y (+ (* ,yr 12) ,mon -1 ,n)
1312 ,mon (1+ (mod macro-y 12))
1314 (and (< macro-y 0) (> ,mon 1) (setq ,yr (1- ,yr)))
1315 (if (< ,yr 1) (setq ,yr (1- ,yr))))) ; 0 AD -> -1 BC, etc
1317 (defun calendar-increment-month (n &optional mon yr)
1318 "Return the Nth month after MON/YR.
1319 The return value is a pair (MONTH . YEAR).
1320 MON defaults to `displayed-month'. YR defaults to `displayed-year'."
1321 (unless mon (setq mon displayed-month))
1322 (unless yr (setq yr displayed-year))
1323 (increment-calendar-month mon yr n)
1326 (defmacro calendar-for-loop (var from init to final do &rest body)
1327 "Execute a for loop."
1328 (declare (debug (symbolp "from" form "to" form "do" body)))
1329 `(let ((,var (1- ,init)))
1330 (while (>= ,final (setq ,var (1+ ,var)))
1333 (defmacro calendar-sum (index initial condition expression)
1334 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
1335 (declare (debug (symbolp form form form)))
1336 `(let ((,index ,initial)
1339 (setq sum (+ sum ,expression))
1340 (setq ,index (1+ ,index)))
1343 ;; The following are in-line for speed; they can be called thousands of times
1344 ;; when looking up holidays or processing the diary. Here, for example, are
1345 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1346 ;; fancy diary display, for a moderately complex diary file, with functions
1347 ;; used instead of macros. There were a total of 10000 such calls:
1349 ;; 1934 extract-calendar-month
1350 ;; 1852 extract-calendar-year
1351 ;; 1819 extract-calendar-day
1352 ;; 845 calendar-leap-year-p
1353 ;; 837 calendar-day-number
1354 ;; 775 calendar-absolute-from-gregorian
1355 ;; 346 calendar-last-day-of-month
1356 ;; 286 hebrew-calendar-last-day-of-month
1357 ;; 188 hebrew-calendar-leap-year-p
1358 ;; 180 hebrew-calendar-elapsed-days
1359 ;; 163 hebrew-calendar-last-month-of-year
1360 ;; 66 calendar-date-compare
1361 ;; 65 hebrew-calendar-days-in-year
1362 ;; 60 calendar-absolute-from-julian
1363 ;; 50 calendar-absolute-from-hebrew
1364 ;; 43 calendar-date-equal
1365 ;; 38 calendar-gregorian-from-absolute
1370 ;; The use of these seven macros eliminates the overhead of 92% of the function
1371 ;; calls; it's faster this way.
1373 (defsubst extract-calendar-month (date)
1374 "Extract the month part of DATE which has the form (month day year)."
1377 ;; Note gives wrong answer for result of (calendar-read-date 'noday).
1378 (defsubst extract-calendar-day (date)
1379 "Extract the day part of DATE which has the form (month day year)."
1382 (defsubst extract-calendar-year (date)
1383 "Extract the year part of DATE which has the form (month day year)."
1384 (car (cdr (cdr date))))
1386 (defsubst calendar-leap-year-p (year)
1387 "Return t if YEAR is a Gregorian leap year.
1388 A negative year is interpreted as BC; -1 being 1 BC, and so on."
1389 ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc.
1390 (if (< year 0) (setq year (1- (abs year))))
1391 (and (zerop (% year 4))
1392 (or (not (zerop (% year 100)))
1393 (zerop (% year 400)))))
1395 ;; The foregoing is a bit faster, but not as clear as the following:
1397 ;;(defsubst calendar-leap-year-p (year)
1398 ;; "Returns t if YEAR is a Gregorian leap year."
1400 ;; (and (= (% year 4) 0)
1401 ;; (/= (% year 100) 0))
1402 ;; (= (% year 400) 0)))
1404 (defsubst calendar-last-day-of-month (month year)
1405 "The last day in MONTH during YEAR."
1406 (if (and (= month 2) (calendar-leap-year-p year))
1408 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1410 ;; An explanation of the calculation can be found in PascAlgorithms by
1411 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1413 (defsubst calendar-day-number (date)
1414 "Return the day number within the year of the date DATE.
1415 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1416 while (calendar-day-number '(12 31 1980)) returns 366."
1417 (let* ((month (extract-calendar-month date))
1418 (day (extract-calendar-day date))
1419 (year (extract-calendar-year date))
1420 (day-of-year (+ day (* 31 (1- month)))))
1423 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1424 (if (calendar-leap-year-p year)
1425 (setq day-of-year (1+ day-of-year)))))
1428 (defsubst calendar-absolute-from-gregorian (date)
1429 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1430 The Gregorian date Sunday, December 31, 1 BC is imaginary.
1431 DATE is a list of the form (month day year). A negative year is
1432 interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC
1433 return negative results."
1434 (let ((year (extract-calendar-year date))
1437 (error "There was no year zero"))
1439 (setq offset-years (1- year))
1440 (+ (calendar-day-number date) ; Days this year
1441 (* 365 offset-years) ; + Days in prior years
1442 (/ offset-years 4) ; + Julian leap years
1443 (- (/ offset-years 100)) ; - century years
1444 (/ offset-years 400))) ; + Gregorian leap years
1446 ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc).
1447 (setq offset-years (abs (1+ year)))
1448 (- (calendar-day-number date)
1449 (* 365 offset-years)
1451 (- (/ offset-years 100))
1452 (/ offset-years 400)
1453 (calendar-day-number '(12 31 -1))))))) ; days in year 1 BC
1455 (autoload 'calendar-goto-today "cal-move"
1456 "Reposition the calendar window so the current date is visible."
1459 (autoload 'calendar-forward-month "cal-move"
1460 "Move the cursor forward ARG months."
1463 (autoload 'calendar-forward-year "cal-move"
1464 "Move the cursor forward by ARG years."
1467 (autoload 'calendar-backward-month "cal-move"
1468 "Move the cursor backward by ARG months."
1471 (autoload 'calendar-backward-year "cal-move"
1472 "Move the cursor backward ARG years."
1475 (autoload 'scroll-calendar-left "cal-move"
1476 "Scroll the displayed calendar left by ARG months."
1479 (autoload 'scroll-calendar-right "cal-move"
1480 "Scroll the displayed calendar window right by ARG months."
1483 (autoload 'scroll-calendar-left-three-months "cal-move"
1484 "Scroll the displayed calendar window left by 3*ARG months."
1487 (autoload 'scroll-calendar-right-three-months "cal-move"
1488 "Scroll the displayed calendar window right by 3*ARG months."
1491 (autoload 'calendar-cursor-to-nearest-date "cal-move"
1492 "Move the cursor to the closest date."
1495 (autoload 'calendar-forward-day "cal-move"
1496 "Move the cursor forward ARG days."
1499 (autoload 'calendar-backward-day "cal-move"
1500 "Move the cursor back ARG days."
1503 (autoload 'calendar-forward-week "cal-move"
1504 "Move the cursor forward ARG weeks."
1507 (autoload 'calendar-backward-week "cal-move"
1508 "Move the cursor back ARG weeks."
1511 (autoload 'calendar-beginning-of-week "cal-move"
1512 "Move the cursor back ARG calendar-week-start-day's."
1515 (autoload 'calendar-end-of-week "cal-move"
1516 "Move the cursor forward ARG calendar-week-start-day+6's."
1519 (autoload 'calendar-beginning-of-month "cal-move"
1520 "Move the cursor backward ARG month beginnings."
1523 (autoload 'calendar-end-of-month "cal-move"
1524 "Move the cursor forward ARG month ends."
1527 (autoload 'calendar-beginning-of-year "cal-move"
1528 "Move the cursor backward ARG year beginnings."
1531 (autoload 'calendar-end-of-year "cal-move"
1532 "Move the cursor forward ARG year beginnings."
1535 (autoload 'calendar-cursor-to-visible-date "cal-move"
1536 "Move the cursor to DATE that is on the screen."
1539 (autoload 'calendar-goto-date "cal-move"
1540 "Move cursor to DATE."
1543 (autoload 'calendar-goto-day-of-year "cal-move"
1544 "Move cursor to day of year."
1547 (autoload 'calendar-only-one-frame-setup "cal-x"
1548 "Start calendar and display it in a dedicated frame.")
1550 (autoload 'calendar-one-frame-setup "cal-x"
1551 "Start calendar and display it in a dedicated frame together with the diary.")
1553 (autoload 'calendar-two-frame-setup "cal-x"
1554 "Start calendar and diary in separate, dedicated frames.")
1557 (defcustom calendar-setup nil
1558 "The frame setup of the calendar.
1559 The choices are: `one-frame' (calendar and diary together in one separate,
1560 dedicated frame); `two-frames' (calendar and diary in separate, dedicated
1561 frames); `calendar-only' (calendar in a separate, dedicated frame); with
1562 any other value the current frame is used. Using any of the first
1563 three options overrides the value of `view-diary-entries-initially'."
1565 (const :tag "calendar and diary in separate frame" one-frame)
1566 (const :tag "calendar and diary each in own frame" two-frames)
1567 (const :tag "calendar in separate frame" calendar-only)
1568 (const :tag "use current frame" nil))
1571 (defcustom calendar-minimum-window-height 8
1572 "Minimum height `generate-calendar-window' should use for calendar window."
1578 (defun calendar (&optional arg)
1579 "Choose between the one frame, two frame, or basic calendar displays.
1580 If called with an optional prefix argument, prompts for month and year.
1582 The original function `calendar' has been renamed `calendar-basic-setup'.
1583 See the documentation of that function for more information."
1585 (cond ((equal calendar-setup 'one-frame) (calendar-one-frame-setup arg))
1586 ((equal calendar-setup 'two-frames) (calendar-two-frame-setup arg))
1587 ((equal calendar-setup 'calendar-only)
1588 (calendar-only-one-frame-setup arg))
1589 (t (calendar-basic-setup arg))))
1591 (defun calendar-basic-setup (&optional arg)
1592 "Display a three-month calendar in another window.
1593 The three months appear side by side, with the current month in the middle
1594 surrounded by the previous and next months. The cursor is put on today's date.
1596 If called with an optional prefix argument, prompts for month and year.
1598 This function is suitable for execution in a .emacs file; appropriate setting
1599 of the variable `view-diary-entries-initially' will cause the diary entries for
1600 the current date to be displayed in another window. The value of the variable
1601 `number-of-diary-entries' controls the number of days of diary entries
1602 displayed upon initial display of the calendar.
1604 Once in the calendar window, future or past months can be moved into view.
1605 Arbitrary months can be displayed, or the calendar can be scrolled forward
1608 The cursor can be moved forward or backward by one day, one week, one month,
1609 or one year. All of these commands take prefix arguments which, when negative,
1610 cause movement in the opposite direction. For convenience, the digit keys
1611 and the minus sign are automatically prefixes. The window is replotted as
1612 necessary to display the desired date.
1614 Diary entries can be marked on the calendar or displayed in another window.
1616 Use \\[describe-mode] for details of the key bindings in the calendar window.
1618 The Gregorian calendar is assumed.
1620 After loading the calendar, the hooks given by the variable
1621 `calendar-load-hook' are run. This is the place to add key bindings to the
1624 After preparing the calendar window initially, the hooks given by the variable
1625 `initial-calendar-window-hook' are run.
1627 The hooks given by the variable `today-visible-calendar-hook' are run
1628 every time the calendar window gets scrolled, if the current date is visible
1629 in the window. If it is not visible, the hooks given by the variable
1630 `today-invisible-calendar-hook' are run. Thus, for example, setting
1631 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1632 to be replaced by asterisks to highlight it whenever it is in the window."
1634 (set-buffer (get-buffer-create calendar-buffer))
1636 (let* ((pop-up-windows t)
1637 (split-height-threshold 1000)
1639 (calendar-read-date t)
1640 (calendar-current-date)))
1641 (month (extract-calendar-month date))
1642 (year (extract-calendar-year date)))
1643 ;; (calendar-read-date t) returns a date with day = nil, which is
1644 ;; not a legal date for the visible test in the diary section.
1645 (if arg (setcar (cdr date) 1))
1646 (pop-to-buffer calendar-buffer)
1647 (increment-calendar-month month year (- calendar-offset))
1648 (generate-calendar-window month year)
1649 (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
1650 (diary-view-entries)))
1651 (let* ((diary-buffer (get-file-buffer diary-file))
1652 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1653 (split-height-threshold (if diary-window 2 1000)))
1654 (if view-calendar-holidays-initially
1655 (list-calendar-holidays)))
1656 (run-hooks 'initial-calendar-window-hook))
1658 (autoload 'diary-view-entries "diary-lib"
1659 "Prepare and display a buffer with diary entries.
1660 Searches your diary file for entries that match ARG days starting with
1661 the date indicated by the cursor position in the displayed three-month
1665 (autoload 'view-other-diary-entries "diary-lib"
1666 "Prepare and display buffer of diary entries from an alternative diary file.
1667 Searches for entries that match ARG days, starting with the date indicated
1668 by the cursor position in the displayed three-month calendar.
1669 D-FILE specifies the file to use as the diary file."
1672 (autoload 'calendar-sunrise-sunset "solar"
1673 "Local time of sunrise and sunset for date under cursor."
1676 (autoload 'calendar-phases-of-moon "lunar"
1677 "Create a buffer of the phases of the moon for the current calendar window."
1680 (autoload 'calendar-print-french-date "cal-french"
1681 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1684 (autoload 'calendar-goto-french-date "cal-french"
1685 "Move cursor to French Revolutionary date."
1688 (autoload 'calendar-french-date-string "cal-french"
1689 "String of French Revolutionary date of Gregorian date."
1692 (autoload 'calendar-mayan-date-string "cal-mayan"
1693 "String of Mayan date of Gregorian date."
1696 (autoload 'calendar-print-mayan-date "cal-mayan"
1697 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1700 (autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
1701 "Move cursor to Mayan long count date."
1704 (autoload 'calendar-next-haab-date "cal-mayan"
1705 "Move cursor to next instance of Mayan Haab date."
1708 (autoload 'calendar-previous-haab-date "cal-mayan"
1709 "Move cursor to previous instance of Mayan Haab date."
1712 (autoload 'calendar-next-tzolkin-date "cal-mayan"
1713 "Move cursor to next instance of Mayan Tzolkin date."
1716 (autoload 'calendar-previous-tzolkin-date "cal-mayan"
1717 "Move cursor to previous instance of Mayan Tzolkin date."
1720 (autoload 'calendar-next-calendar-round-date "cal-mayan"
1721 "Move cursor to next instance of Mayan Haab/Tzolkin combination."
1724 (autoload 'calendar-previous-calendar-round-date "cal-mayan"
1725 "Move cursor to previous instance of Mayan Haab/Tzolkin combination."
1728 (autoload 'calendar-goto-chinese-date "cal-china"
1729 "Move cursor to Chinese date."
1732 (autoload 'calendar-print-chinese-date "cal-china"
1733 "Show the Chinese date equivalents of date."
1736 (autoload 'calendar-chinese-date-string "cal-china"
1737 "String of Chinese date of Gregorian date."
1740 (autoload 'calendar-absolute-from-astro "cal-julian"
1741 "Absolute date of astronomical (Julian) day number D."
1744 (autoload 'calendar-astro-from-absolute "cal-julian"
1745 "Astronomical (Julian) day number of absolute date D.")
1747 (autoload 'calendar-astro-date-string "cal-julian"
1748 "String of astronomical (Julian) day number of Gregorian date."
1751 (autoload 'calendar-goto-astro-day-number "cal-julian"
1752 "Move cursor to astronomical (Julian) day number."
1755 (autoload 'calendar-print-astro-day-number "cal-julian"
1756 "Show the astro date equivalents of date."
1759 (autoload 'calendar-julian-from-absolute "cal-julian"
1760 "Compute the Julian (month day year) corresponding to the absolute DATE.
1761 The absolute date is the number of days elapsed since the (imaginary)
1762 Gregorian date Sunday, December 31, 1 BC.")
1764 (autoload 'calendar-goto-julian-date "cal-julian"
1765 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1768 (autoload 'calendar-print-julian-date "cal-julian"
1769 "Show the Julian calendar equivalent of the date under the cursor."
1772 (autoload 'calendar-julian-date-string "cal-julian"
1773 "String of Julian date of Gregorian DATE.
1774 Defaults to today's date if DATE is not given.
1775 Driven by the variable `calendar-date-display-form'.")
1777 (autoload 'calendar-goto-iso-date "cal-iso"
1778 "Move cursor to ISO date."
1781 (autoload 'calendar-goto-iso-week "cal-iso"
1782 "Move cursor to start of ISO week."
1785 (autoload 'calendar-print-iso-date "cal-iso"
1786 "Show the ISO date equivalents of date."
1789 (autoload 'calendar-iso-date-string "cal-iso"
1790 "String of ISO date of Gregorian date."
1793 (autoload 'calendar-goto-islamic-date "cal-islam"
1794 "Move cursor to Islamic date."
1797 (autoload 'calendar-print-islamic-date "cal-islam"
1798 "Show the Islamic date equivalents of date."
1801 (autoload 'calendar-islamic-date-string "cal-islam"
1802 "String of Islamic date of Gregorian date."
1805 (autoload 'calendar-print-bahai-date "cal-bahai"
1806 "Show the Baha'i date equivalents of date."
1809 (autoload 'calendar-bahai-date-string "cal-bahai"
1810 "String of Baha'i date of Gregorian date."
1813 (autoload 'calendar-goto-hebrew-date "cal-hebrew"
1814 "Move cursor to Hebrew date."
1817 (autoload 'calendar-print-hebrew-date "cal-hebrew"
1818 "Show the Hebrew date equivalents of date."
1821 (autoload 'calendar-hebrew-date-string "cal-hebrew"
1822 "String of Hebrew date of Gregorian date."
1825 (autoload 'calendar-goto-coptic-date "cal-coptic"
1826 "Move cursor to Coptic date."
1829 (autoload 'calendar-print-coptic-date "cal-coptic"
1830 "Show the Coptic date equivalents of date."
1833 (autoload 'calendar-coptic-date-string "cal-coptic"
1834 "String of Coptic date of Gregorian date."
1837 (autoload 'calendar-goto-ethiopic-date "cal-coptic"
1838 "Move cursor to Ethiopic date."
1841 (autoload 'calendar-print-ethiopic-date "cal-coptic"
1842 "Show the Ethiopic date equivalents of date."
1845 (autoload 'calendar-ethiopic-date-string "cal-coptic"
1846 "String of Ethiopic date of Gregorian date."
1849 (autoload 'calendar-goto-persian-date "cal-persia"
1850 "Move cursor to Persian date."
1853 (autoload 'calendar-print-persian-date "cal-persia"
1854 "Show the Persian date equivalents of date."
1857 (autoload 'calendar-persian-date-string "cal-persia"
1858 "String of Persian date of Gregorian date."
1861 (autoload 'show-all-diary-entries "diary-lib"
1862 "Show all of the diary entries in the diary file.
1863 This function gets rid of the selective display of the diary file so that
1864 all entries, not just some, are visible. If there is no diary buffer, one
1868 (autoload 'mark-diary-entries "diary-lib"
1869 "Mark days in the calendar window that have diary entries.
1870 Each entry in diary file visible in the calendar window is marked."
1873 (autoload 'make-diary-entry "diary-lib"
1874 "Insert a diary entry STRING which may be NONMARKING in FILE."
1877 (autoload 'insert-diary-entry "diary-lib"
1878 "Insert a diary entry for the date indicated by point."
1881 (autoload 'insert-weekly-diary-entry "diary-lib"
1882 "Insert a weekly diary entry for the day of the week indicated by point."
1886 (autoload 'insert-monthly-diary-entry "diary-lib"
1887 "Insert a monthly diary entry for the day of the month indicated by point."
1890 (autoload 'insert-yearly-diary-entry "diary-lib"
1891 "Insert an annual diary entry for the day of the year indicated by point."
1894 (autoload 'insert-anniversary-diary-entry "diary-lib"
1895 "Insert an anniversary diary entry for the date indicated by point."
1898 (autoload 'insert-block-diary-entry "diary-lib"
1899 "Insert a block diary entry for the dates indicated by point and mark."
1902 (autoload 'insert-cyclic-diary-entry "diary-lib"
1903 "Insert a cyclic diary entry starting at the date indicated by point."
1906 (autoload 'insert-hebrew-diary-entry "cal-hebrew"
1907 "Insert a diary entry for the Hebrew date corresponding to the date
1908 indicated by point."
1911 (autoload 'insert-monthly-hebrew-diary-entry "cal-hebrew"
1912 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1913 to the date indicated by point."
1916 (autoload 'insert-yearly-hebrew-diary-entry "cal-hebrew"
1917 "Insert an annual diary entry for the day of the Hebrew year corresponding
1918 to the date indicated by point."
1921 (autoload 'insert-islamic-diary-entry "cal-islam"
1922 "Insert a diary entry for the Islamic date corresponding to the date
1923 indicated by point."
1926 (autoload 'insert-monthly-islamic-diary-entry "cal-islam"
1927 "Insert a monthly diary entry for the day of the Islamic month corresponding
1928 to the date indicated by point."
1931 (autoload 'insert-yearly-islamic-diary-entry "cal-islam"
1932 "Insert an annual diary entry for the day of the Islamic year corresponding
1933 to the date indicated by point."
1936 (autoload 'insert-bahai-diary-entry "cal-bahai"
1937 "Insert a diary entry for the Baha'i date corresponding to the date
1938 indicated by point."
1941 (autoload 'insert-monthly-bahai-diary-entry "cal-bahai"
1942 "Insert a monthly diary entry for the day of the Baha'i month corresponding
1943 to the date indicated by point."
1946 (autoload 'insert-yearly-bahai-diary-entry "cal-bahai"
1947 "Insert an annual diary entry for the day of the Baha'i year corresponding
1948 to the date indicated by point."
1951 (autoload 'list-calendar-holidays "holidays"
1952 "Create a buffer containing the holidays for the current calendar window.
1953 The holidays are those in the list `calendar-notable-days'. Returns t if any
1954 holidays are found, nil if not."
1957 (autoload 'cal-tex-cursor-month "cal-tex"
1958 "Make a buffer with LaTeX commands for the month cursor is on.
1959 Optional prefix argument specifies number of months to be produced.
1960 Calendar is condensed onto one page.")
1962 (autoload 'cal-tex-cursor-month-landscape "cal-tex"
1963 "Make a buffer with LaTeX commands for the month cursor is on.
1964 Optional prefix argument specifies number of months to be produced.")
1966 (autoload 'cal-tex-cursor-day "cal-tex"
1967 "Make a buffer with LaTeX commands for the day cursor is on.")
1969 (autoload 'cal-tex-cursor-week "cal-tex"
1970 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1971 It applies to the week that point is in.
1972 Optional prefix argument specifies number of weeks.
1973 Holidays are included if `cal-tex-holidays' is t.")
1975 (autoload 'cal-tex-cursor-week2 "cal-tex"
1976 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1977 It applies to the week that point is in.
1978 Optional prefix argument specifies number of weeks.
1979 Holidays are included if `cal-tex-holidays' is t.")
1981 (autoload 'cal-tex-cursor-week-iso "cal-tex"
1982 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
1983 Optional prefix argument specifies number of weeks.
1984 Diary entries are included if `cal-tex-diary' is t.
1985 Holidays are included if `cal-tex-holidays' is t.")
1987 (autoload 'cal-tex-cursor-week-monday "cal-tex"
1988 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1989 It applies to the week that point is in, and starts on Monday.
1990 Optional prefix argument specifies number of weeks.
1991 Holidays are included if `cal-tex-holidays' is t.")
1993 (autoload 'cal-tex-cursor-filofax-2week "cal-tex"
1994 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
1995 Optional prefix argument specifies number of weeks.
1996 Diary entries are included if cal-tex-diary is t.
1997 Holidays are included if `cal-tex-holidays' is t.")
1999 (autoload 'cal-tex-cursor-filofax-week "cal-tex"
2000 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
2001 Optional prefix argument specifies number of weeks.
2002 Weeks start on Monday.
2003 Diary entries are included if cal-tex-diary is t.
2004 Holidays are included if `cal-tex-holidays' is t.")
2006 (autoload 'cal-tex-cursor-filofax-daily "cal-tex"
2007 "Day-per-page Filofax style calendar for week indicated by cursor.
2008 Optional prefix argument specifies number of weeks. Weeks start on Monday.
2009 Diary entries are included if `cal-tex-diary' is t.
2010 Holidays are included if `cal-tex-holidays' is t.")
2012 (autoload 'cal-tex-cursor-year "cal-tex"
2013 "Make a buffer with LaTeX commands for a year's calendar.
2014 Optional prefix argument specifies number of years.")
2016 (autoload 'cal-tex-cursor-year-landscape "cal-tex"
2017 "Make a buffer with LaTeX commands for a year's calendar (landscape).
2018 Optional prefix argument specifies number of years.")
2020 (autoload 'cal-tex-cursor-filofax-year "cal-tex"
2021 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
2022 Optional prefix argument specifies number of years.")
2024 (autoload 'mark-calendar-holidays "holidays"
2025 "Mark notable days in the calendar window."
2028 (autoload 'calendar-cursor-holidays "holidays"
2029 "Find holidays for the date specified by the cursor in the calendar window."
2032 (defun generate-calendar-window (&optional mon yr)
2033 "Generate the calendar window for the current date.
2034 Or, for optional MON, YR."
2035 (let* ((buffer-read-only nil)
2036 (today (calendar-current-date))
2037 (month (extract-calendar-month today))
2038 (day (extract-calendar-day today))
2039 (year (extract-calendar-year today))
2042 (let ((offset (calendar-interval mon yr month year)))
2043 (and (<= offset 1) (>= offset -1)))))
2044 (day-in-week (calendar-day-of-week today))
2045 (in-calendar-window (eq (window-buffer (selected-window))
2046 (get-buffer calendar-buffer))))
2047 (update-calendar-mode-line)
2049 (generate-calendar mon yr)
2050 (generate-calendar month year))
2051 (calendar-cursor-to-visible-date
2052 (if today-visible today (list displayed-month 1 displayed-year)))
2053 (set-buffer-modified-p nil)
2054 ;; Don't do any window-related stuff if we weren't called from a
2055 ;; window displaying the calendar
2056 (when in-calendar-window
2057 (if (or (one-window-p t) (/= (frame-width) (window-width)))
2058 ;; Don't mess with the window size, but ensure that the first
2059 ;; line is fully visible
2060 (set-window-vscroll nil 0)
2061 ;; Adjust the window to exactly fit the displayed calendar
2062 (fit-window-to-buffer nil nil calendar-minimum-window-height))
2064 (if (and (boundp 'font-lock-mode)
2066 (font-lock-fontify-buffer))
2067 (and mark-holidays-in-calendar
2068 ;;; (calendar-date-is-legal-p today) ; useful for BC dates
2069 (mark-calendar-holidays)
2070 (and in-calendar-window (sit-for 0)))
2072 (if mark-diary-entries-in-calendar (mark-diary-entries))
2074 (run-hooks 'today-visible-calendar-hook)
2075 (run-hooks 'today-invisible-calendar-hook)))))
2077 (defun generate-calendar (month year)
2078 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
2079 ;;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on.
2080 ;;; Note that while calendars for years BC could be displayed as it
2081 ;;; stands, almost all other calendar functions (eg holidays) would
2082 ;;; at best have unpredictable results for such dates.
2083 (if (< (+ month (* 12 (1- year))) 2)
2084 (error "Months before January, 1 AD cannot be displayed"))
2085 (setq displayed-month month
2086 displayed-year year)
2088 (increment-calendar-month month year -1)
2089 (calendar-for-loop i from 0 to 2 do
2090 (generate-calendar-month month year (+ 5 (* 25 i)))
2091 (increment-calendar-month month year 1)))
2093 (defun generate-calendar-month (month year indent)
2094 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
2095 The calendar is inserted at the top of the buffer in which point is currently
2096 located, but indented INDENT spaces. The indentation is done from the first
2097 character on the line and does not disturb the first INDENT characters on the
2099 (let* ((blank-days;; at start of month
2101 (- (calendar-day-of-week (list month 1 year))
2102 calendar-week-start-day)
2104 (last (calendar-last-day-of-month month year)))
2105 (goto-char (point-min))
2106 (calendar-insert-indented
2107 (calendar-string-spread
2108 (list (format "%s %d" (calendar-month-name month) year)) ? 20)
2110 (calendar-insert-indented "" indent);; Go to proper spot
2111 ;; Use the first two characters of each day to head the columns.
2112 (calendar-for-loop i from 0 to 6 do
2115 (calendar-day-name (mod (+ calendar-week-start-day i) 7) nil t)))
2116 (if enable-multibyte-characters
2117 (truncate-string-to-width string 2)
2118 (substring string 0 2)))
2120 (calendar-insert-indented "" 0 t);; Force onto following line
2121 (calendar-insert-indented "" indent);; Go to proper spot
2122 ;; Add blank days before the first of the month
2123 (calendar-for-loop i from 1 to blank-days do (insert " "))
2124 ;; Put in the days of the month
2125 (calendar-for-loop i from 1 to last do
2126 (insert (format "%2d " i))
2127 (add-text-properties
2128 (- (point) 3) (1- (point))
2129 '(mouse-face highlight
2130 help-echo "mouse-2: menu of operations for this date"))
2131 (and (zerop (mod (+ i blank-days) 7))
2133 (calendar-insert-indented "" 0 t) ;; Force onto following line
2134 (calendar-insert-indented "" indent)))));; Go to proper spot
2136 (defun calendar-insert-indented (string indent &optional newline)
2137 "Insert STRING at column INDENT.
2138 If the optional parameter NEWLINE is t, leave point at start of next line,
2139 inserting a newline if there was no next line; otherwise, leave point after
2140 the inserted text. Value is always t."
2141 ;; Try to move to that column.
2142 (move-to-column indent)
2143 ;; If line is too short, indent out to that column.
2144 (if (< (current-column) indent)
2147 ;; Advance to next line, if requested.
2156 (defun redraw-calendar ()
2157 "Redraw the calendar display, if `calendar-buffer' is live."
2159 (if (get-buffer calendar-buffer)
2160 (with-current-buffer calendar-buffer
2161 (let ((cursor-date (calendar-cursor-to-nearest-date)))
2162 (generate-calendar-window displayed-month displayed-year)
2163 (calendar-cursor-to-visible-date cursor-date)))))
2166 (defcustom calendar-week-start-day 0
2167 "The day of the week on which a week in the calendar begins.
2168 0 means Sunday (default), 1 means Monday, and so on.
2170 If you change this variable directly (without using customize)
2171 after starting `calendar', you should call `redraw-calendar' to
2172 update the calendar display to reflect the change, otherwise
2173 movement commands will not work correctly."
2175 ;; Change the initialize so that if you reload calendar.el, it will not
2176 ;; cause a redraw (which may fail, e.g. with "invalid byte-code in
2177 ;; calendar.elc" because of the "byte-compile-dynamic").
2178 :initialize 'custom-initialize-default
2179 :set (lambda (sym val)
2184 (defcustom calendar-debug-sexp nil
2185 "Turn debugging on when evaluating a sexp in the diary or holiday list."
2189 (defvar calendar-mode-map nil)
2190 (if calendar-mode-map
2192 (let ((map (make-keymap)))
2193 (suppress-keymap map)
2194 (dolist (c '(narrow-to-region mark-word mark-sexp mark-paragraph
2195 mark-defun mark-whole-buffer mark-page
2196 downcase-region upcase-region kill-region
2197 copy-region-as-kill capitalize-region write-region))
2198 (define-key map (vector 'remap c) 'calendar-not-implemented))
2199 (define-key map ">" 'scroll-calendar-right)
2200 (define-key map "\C-x>" 'scroll-calendar-right)
2201 (define-key map [prior] 'scroll-calendar-right-three-months)
2202 (define-key map "\ev" 'scroll-calendar-right-three-months)
2203 (define-key map "<" 'scroll-calendar-left)
2204 (define-key map "\C-x<" 'scroll-calendar-left)
2205 (define-key map [next] 'scroll-calendar-left-three-months)
2206 (define-key map "\C-v" 'scroll-calendar-left-three-months)
2207 (define-key map "\C-b" 'calendar-backward-day)
2208 (define-key map "\C-p" 'calendar-backward-week)
2209 (define-key map "\e{" 'calendar-backward-month)
2210 (define-key map "\C-x[" 'calendar-backward-year)
2211 (define-key map "\C-f" 'calendar-forward-day)
2212 (define-key map "\C-n" 'calendar-forward-week)
2213 (define-key map [left] 'calendar-backward-day)
2214 (define-key map [up] 'calendar-backward-week)
2215 (define-key map [right] 'calendar-forward-day)
2216 (define-key map [down] 'calendar-forward-week)
2217 (define-key map "\e}" 'calendar-forward-month)
2218 (define-key map "\C-x]" 'calendar-forward-year)
2219 (define-key map "\C-a" 'calendar-beginning-of-week)
2220 (define-key map "\C-e" 'calendar-end-of-week)
2221 (define-key map "\ea" 'calendar-beginning-of-month)
2222 (define-key map "\ee" 'calendar-end-of-month)
2223 (define-key map "\e<" 'calendar-beginning-of-year)
2224 (define-key map "\e>" 'calendar-end-of-year)
2225 (define-key map "\C-@" 'calendar-set-mark)
2226 ;; Many people are used to typing C-SPC and getting C-@.
2227 (define-key map [?\C- ] 'calendar-set-mark)
2228 (define-key map "\C-x\C-x" 'calendar-exchange-point-and-mark)
2229 (define-key map "\e=" 'calendar-count-days-region)
2230 (define-key map "gd" 'calendar-goto-date)
2231 (define-key map "gD" 'calendar-goto-day-of-year)
2232 (define-key map "gj" 'calendar-goto-julian-date)
2233 (define-key map "ga" 'calendar-goto-astro-day-number)
2234 (define-key map "gh" 'calendar-goto-hebrew-date)
2235 (define-key map "gi" 'calendar-goto-islamic-date)
2236 (define-key map "gb" 'calendar-goto-bahai-date)
2237 (define-key map "gC" 'calendar-goto-chinese-date)
2238 (define-key map "gk" 'calendar-goto-coptic-date)
2239 (define-key map "ge" 'calendar-goto-ethiopic-date)
2240 (define-key map "gp" 'calendar-goto-persian-date)
2241 (define-key map "gc" 'calendar-goto-iso-date)
2242 (define-key map "gw" 'calendar-goto-iso-week)
2243 (define-key map "gf" 'calendar-goto-french-date)
2244 (define-key map "gml" 'calendar-goto-mayan-long-count-date)
2245 (define-key map "gmpc" 'calendar-previous-calendar-round-date)
2246 (define-key map "gmnc" 'calendar-next-calendar-round-date)
2247 (define-key map "gmph" 'calendar-previous-haab-date)
2248 (define-key map "gmnh" 'calendar-next-haab-date)
2249 (define-key map "gmpt" 'calendar-previous-tzolkin-date)
2250 (define-key map "gmnt" 'calendar-next-tzolkin-date)
2251 (define-key map "Aa" 'appt-add)
2252 (define-key map "Ad" 'appt-delete)
2253 (define-key map "S" 'calendar-sunrise-sunset)
2254 (define-key map "M" 'calendar-phases-of-moon)
2255 (define-key map " " 'scroll-other-window)
2256 (define-key map (kbd "DEL") 'scroll-other-window-down)
2257 (define-key map "\C-c\C-l" 'redraw-calendar)
2258 (define-key map "." 'calendar-goto-today)
2259 (define-key map "o" 'calendar-other-month)
2260 (define-key map "q" 'exit-calendar)
2261 (define-key map "a" 'list-calendar-holidays)
2262 (define-key map "h" 'calendar-cursor-holidays)
2263 (define-key map "x" 'mark-calendar-holidays)
2264 (define-key map "u" 'calendar-unmark)
2265 (define-key map "m" 'mark-diary-entries)
2266 (define-key map "d" 'diary-view-entries)
2267 (define-key map "D" 'view-other-diary-entries)
2268 (define-key map "s" 'show-all-diary-entries)
2269 (define-key map "pd" 'calendar-print-day-of-year)
2270 (define-key map "pC" 'calendar-print-chinese-date)
2271 (define-key map "pk" 'calendar-print-coptic-date)
2272 (define-key map "pe" 'calendar-print-ethiopic-date)
2273 (define-key map "pp" 'calendar-print-persian-date)
2274 (define-key map "pc" 'calendar-print-iso-date)
2275 (define-key map "pj" 'calendar-print-julian-date)
2276 (define-key map "pa" 'calendar-print-astro-day-number)
2277 (define-key map "ph" 'calendar-print-hebrew-date)
2278 (define-key map "pi" 'calendar-print-islamic-date)
2279 (define-key map "pb" 'calendar-print-bahai-date)
2280 (define-key map "pf" 'calendar-print-french-date)
2281 (define-key map "pm" 'calendar-print-mayan-date)
2282 (define-key map "po" 'calendar-print-other-dates)
2283 (define-key map "id" 'insert-diary-entry)
2284 (define-key map "iw" 'insert-weekly-diary-entry)
2285 (define-key map "im" 'insert-monthly-diary-entry)
2286 (define-key map "iy" 'insert-yearly-diary-entry)
2287 (define-key map "ia" 'insert-anniversary-diary-entry)
2288 (define-key map "ib" 'insert-block-diary-entry)
2289 (define-key map "ic" 'insert-cyclic-diary-entry)
2290 (define-key map "ihd" 'insert-hebrew-diary-entry)
2291 (define-key map "ihm" 'insert-monthly-hebrew-diary-entry)
2292 (define-key map "ihy" 'insert-yearly-hebrew-diary-entry)
2293 (define-key map "iid" 'insert-islamic-diary-entry)
2294 (define-key map "iim" 'insert-monthly-islamic-diary-entry)
2295 (define-key map "iiy" 'insert-yearly-islamic-diary-entry)
2296 (define-key map "iBd" 'insert-bahai-diary-entry)
2297 (define-key map "iBm" 'insert-monthly-bahai-diary-entry)
2298 (define-key map "iBy" 'insert-yearly-bahai-diary-entry)
2299 (define-key map "?" 'calendar-goto-info-node)
2300 (define-key map "tm" 'cal-tex-cursor-month)
2301 (define-key map "tM" 'cal-tex-cursor-month-landscape)
2302 (define-key map "td" 'cal-tex-cursor-day)
2303 (define-key map "tw1" 'cal-tex-cursor-week)
2304 (define-key map "tw2" 'cal-tex-cursor-week2)
2305 (define-key map "tw3" 'cal-tex-cursor-week-iso)
2306 (define-key map "tw4" 'cal-tex-cursor-week-monday)
2307 (define-key map "tfd" 'cal-tex-cursor-filofax-daily)
2308 (define-key map "tfw" 'cal-tex-cursor-filofax-2week)
2309 (define-key map "tfW" 'cal-tex-cursor-filofax-week)
2310 (define-key map "tfy" 'cal-tex-cursor-filofax-year)
2311 (define-key map "ty" 'cal-tex-cursor-year)
2312 (define-key map "tY" 'cal-tex-cursor-year-landscape)
2313 (setq calendar-mode-map map)
2314 ;; Require cal-menu after initializing calendar-mode-map because it uses it.
2315 (require 'cal-menu)))
2317 (defun describe-calendar-mode ()
2318 "Create a help buffer with a brief description of the `calendar-mode'."
2320 (help-setup-xref (list #'describe-calendar-mode) (interactive-p))
2321 (with-output-to-temp-buffer (help-buffer)
2324 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
2325 (substitute-command-keys
2326 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
2327 (substitute-command-keys "\\{calendar-mode-map}")))
2328 (print-help-return-message)))
2330 ;; Calendar mode is suitable only for specially formatted data.
2331 (put 'calendar-mode 'mode-class 'special)
2333 (defvar calendar-mode-line-format
2335 (propertize (substitute-command-keys
2336 "\\<calendar-mode-map>\\[scroll-calendar-left]")
2337 'help-echo "mouse-2: scroll left"
2338 'mouse-face 'mode-line-highlight
2339 'keymap (make-mode-line-mouse-map 'mouse-2
2340 'mouse-scroll-calendar-left))
2344 (substitute-command-keys
2345 "\\<calendar-mode-map>\\[calendar-goto-info-node] info")
2346 'help-echo "mouse-2: read Info on Calendar"
2347 'mouse-face 'mode-line-highlight
2348 'keymap (make-mode-line-mouse-map 'mouse-2 'calendar-goto-info-node))
2351 (substitute-command-keys
2352 "\\<calendar-mode-map>\\[calendar-other-month] other")
2353 'help-echo "mouse-2: choose another month"
2354 'mouse-face 'mode-line-highlight
2355 'keymap (make-mode-line-mouse-map
2356 'mouse-2 'mouse-calendar-other-month))
2359 (substitute-command-keys
2360 "\\<calendar-mode-map>\\[calendar-goto-today] today")
2361 'help-echo "mouse-2: go to today's date"
2362 'mouse-face 'mode-line-highlight
2363 'keymap (make-mode-line-mouse-map 'mouse-2 #'calendar-goto-today)))
2364 '(calendar-date-string (calendar-current-date) t)
2365 (propertize (substitute-command-keys
2366 "\\<calendar-mode-map>\\[scroll-calendar-right]")
2367 'help-echo "mouse-2: scroll right"
2368 'mouse-face 'mode-line-highlight
2369 'keymap (make-mode-line-mouse-map
2370 'mouse-2 'mouse-scroll-calendar-right)))
2371 "The mode line of the calendar buffer.
2373 This must be a list of items that evaluate to strings--those strings are
2374 evaluated and concatenated together, evenly separated by blanks. The variable
2375 `date' is available for use as the date under (or near) the cursor; `date'
2376 defaults to the current date if it is otherwise undefined. Here is an example
2377 value that has the Hebrew date, the day number/days remaining in the year,
2378 and the ISO week/year numbers in the mode. When calendar-move-hook is set to
2379 'update-calendar-mode-line, these mode line shows these values for the date
2384 '(calendar-hebrew-date-string date)
2385 '(let* ((year (extract-calendar-year date))
2386 (d (calendar-day-number date))
2388 (- (calendar-day-number (list 12 31 year)) d)))
2389 (format \"%d/%d\" d days-remaining))
2390 '(let* ((d (calendar-absolute-from-gregorian date))
2391 (iso-date (calendar-iso-from-absolute d)))
2392 (format \"ISO week %d of %d\"
2393 (extract-calendar-month iso-date)
2394 (extract-calendar-year iso-date)))
2398 (defun mouse-scroll-calendar-left (event)
2399 "Scroll the displayed calendar left by one month.
2400 Maintains the relative position of the cursor
2401 with respect to the calendar as well as possible."
2403 (save-selected-window
2404 (select-window (posn-window (event-start event)))
2405 (scroll-calendar-left 1)))
2407 (defun mouse-scroll-calendar-right (event)
2408 "Scroll the displayed calendar right by one month.
2409 Maintains the relative position of the cursor
2410 with respect to the calendar as well as possible."
2412 (save-selected-window
2413 (select-window (posn-window (event-start event)))
2414 (scroll-calendar-right 1)))
2416 (defun mouse-calendar-other-month (event)
2417 "Display a three-month calendar centered around a specified month and year."
2419 (save-selected-window
2420 (select-window (posn-window (event-start event)))
2421 (call-interactively 'calendar-other-month)))
2423 (defun calendar-goto-info-node ()
2424 "Go to the info node for the calendar."
2427 (let ((where (save-window-excursion
2428 (Info-find-emacs-command-nodes 'calendar))))
2430 (error "Couldn't find documentation for the calendar")
2431 (let (same-window-buffer-names)
2433 (Info-find-node (car (car where)) (car (cdr (car where)))))))
2437 (defun calendar-mode ()
2438 "A major mode for the calendar window.
2440 For a complete description, type \
2441 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
2443 \\<calendar-mode-map>\\{calendar-mode-map}"
2444 (kill-all-local-variables)
2445 (setq major-mode 'calendar-mode)
2446 (setq mode-name "Calendar")
2447 (use-local-map calendar-mode-map)
2448 (setq buffer-read-only t)
2449 (setq indent-tabs-mode nil)
2450 (update-calendar-mode-line)
2451 (add-hook 'activate-menubar-hook 'cal-menu-update nil t)
2452 (make-local-variable 'calendar-mark-ring)
2453 (make-local-variable 'displayed-month);; Month in middle of window.
2454 (make-local-variable 'displayed-year) ;; Year in middle of window.
2455 (set (make-local-variable 'font-lock-defaults)
2456 '(calendar-font-lock-keywords t))
2457 (run-mode-hooks 'calendar-mode-hook))
2459 (defun calendar-string-spread (strings char length)
2460 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
2461 The effect is like mapconcat but the separating pieces are as balanced as
2462 possible. Each item of STRINGS is evaluated before concatenation so it can
2463 actually be an expression that evaluates to a string. If LENGTH is too short,
2464 the STRINGS are just concatenated and the result truncated."
2465 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
2466 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
2467 ;; Addison-Wesley, Reading, MA, 1989
2468 (let* ((strings (mapcar 'eval
2469 (if (< (length strings) 2)
2470 (append (list "") strings (list ""))
2472 (n (- length (length (apply 'concat strings))))
2473 (m (1- (length strings)))
2475 (strings (cdr strings))
2477 (dolist (string strings)
2479 (make-string (max 0 (/ (+ n i) m)) char)
2482 (substring s 0 length)))
2484 (defun update-calendar-mode-line ()
2485 "Update the calendar mode line with the current date and date style."
2486 (if (bufferp (get-buffer calendar-buffer))
2487 (with-current-buffer calendar-buffer
2488 (setq mode-line-format
2489 (calendar-string-spread
2490 (let ((date (condition-case nil
2491 (calendar-cursor-to-nearest-date)
2492 (error (calendar-current-date)))))
2493 (mapcar 'eval calendar-mode-line-format))
2495 (force-mode-line-update))))
2497 (defun calendar-window-list ()
2498 "List of all calendar-related windows."
2499 (let ((calendar-buffers (calendar-buffer-list))
2501 (walk-windows (lambda (w)
2502 (if (memq (window-buffer w) calendar-buffers)
2507 (defun calendar-buffer-list ()
2508 "List of all calendar-related buffers."
2509 (let* ((diary-buffer (get-file-buffer diary-file))
2510 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
2511 fancy-diary-buffer diary-buffer calendar-buffer
2512 other-calendars-buffer))
2515 (setq b (cond ((stringp b) (get-buffer b))
2518 (if b (push b buffer-list)))
2521 (defun exit-calendar ()
2522 "Get out of the calendar window and hide it and related buffers."
2524 (let* ((diary-buffer (get-file-buffer diary-file)))
2525 (if (or (not diary-buffer)
2526 (not (buffer-modified-p diary-buffer))
2528 "Diary modified; do you really want to exit the calendar? "))
2529 ;; Need to do this multiple times because one time can replace some
2530 ;; calendar-related buffers with other calendar-related buffers
2532 (mapcar 'calendar-hide-window (calendar-window-list)))
2533 (calendar-window-list)))))
2535 (defun calendar-hide-window (window)
2536 "Hide WINDOW if it is calendar-related."
2537 (let ((buffer (if (window-live-p window) (window-buffer window))))
2538 (if (memq buffer (calendar-buffer-list))
2540 ((and (display-multi-frame-p)
2541 (eq 'icon (cdr (assoc 'visibility
2543 (window-frame window))))))
2545 ((and (display-multi-frame-p) (window-dedicated-p window))
2546 (if calendar-remove-frame-by-deleting
2547 (delete-frame (window-frame window))
2548 (iconify-frame (window-frame window))))
2549 ((not (and (select-window window) (one-window-p window)))
2550 (delete-window window))
2551 (t (set-buffer buffer)
2554 (defun calendar-current-date ()
2555 "Return the current date in a list (month day year)."
2556 (let ((now (decode-time)))
2557 (list (nth 4 now) (nth 3 now) (nth 5 now))))
2559 (defun calendar-cursor-to-date (&optional error)
2560 "Return a list (month day year) of current cursor position.
2561 If cursor is not on a specific date, signals an error if optional parameter
2562 ERROR is t, otherwise just returns nil."
2563 (let* ((segment (/ (current-column) 25))
2564 (month (% (+ displayed-month segment -1) 12))
2565 (month (if (= 0 month) 12 month))
2568 ((and (= 12 month) (= segment 0)) (1- displayed-year))
2569 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
2570 (t displayed-year))))
2571 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
2572 (< 2 (count-lines (point-min) (point))))
2574 (if (not (looking-at " "))
2575 (re-search-backward "[^0-9]"))
2577 (string-to-number (buffer-substring (1+ (point)) (+ 4 (point))))
2579 (if (and (looking-at "\\*")
2581 (re-search-backward "[^*]")
2582 (looking-at ".\\*\\*")))
2583 (list month calendar-starred-day year)
2584 (if error (error "Not on a date!"))))))
2586 (add-to-list 'debug-ignored-errors "Not on a date!")
2588 ;; The following version of calendar-gregorian-from-absolute is preferred for
2589 ;; reasons of clarity, BUT it's much slower than the version that follows it.
2591 ;;(defun calendar-gregorian-from-absolute (date)
2592 ;; "Compute the list (month day year) corresponding to the absolute DATE.
2593 ;;The absolute date is the number of days elapsed since the (imaginary)
2594 ;;Gregorian date Sunday, December 31, 1 BC."
2595 ;; (let* ((approx (/ date 366));; Approximation from below.
2596 ;; (year ;; Search forward from the approximation.
2598 ;; (calendar-sum y approx
2599 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2601 ;; (month ;; Search forward from January.
2602 ;; (1+ (calendar-sum m 1
2604 ;; (calendar-absolute-from-gregorian
2605 ;; (list m (calendar-last-day-of-month m year) year)))
2607 ;; (day ;; Calculate the day by subtraction.
2609 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2610 ;; (list month day year)))
2612 (defun calendar-gregorian-from-absolute (date)
2613 "Compute the list (month day year) corresponding to the absolute DATE.
2614 The absolute date is the number of days elapsed since the (imaginary)
2615 Gregorian date Sunday, December 31, 1 BC. This function does not
2616 handle dates in years BC."
2617 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2618 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2619 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2620 ;; (April, 1993), pages 383-404 for an explanation.
2621 (let* ((d0 (1- date))
2622 (n400 (/ d0 146097))
2629 (day (1+ (% d3 365)))
2630 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2631 (if (or (= n100 4) (= n1 4))
2633 (let ((year (1+ year))
2635 (while (let ((mdays (calendar-last-day-of-month month year)))
2637 (setq day (- day mdays))))
2638 (setq month (1+ month)))
2639 (list month day year)))))
2641 (defun calendar-other-month (month year)
2642 "Display a three-month calendar centered around MONTH and YEAR."
2643 (interactive (calendar-read-date 'noday))
2644 (if (and (= month displayed-month)
2645 (= year displayed-year))
2647 (let ((old-date (calendar-cursor-to-date))
2648 (today (calendar-current-date)))
2649 (generate-calendar-window month year)
2650 (calendar-cursor-to-visible-date
2652 ((calendar-date-is-visible-p old-date) old-date)
2653 ((calendar-date-is-visible-p today) today)
2654 (t (list month 1 year)))))))
2656 (defun calendar-set-mark (arg)
2657 "Mark the date under the cursor, or jump to marked date.
2658 With no prefix argument, push current date onto marked date ring.
2659 With argument, jump to mark, pop it, and put point at end of ring."
2661 (let ((date (calendar-cursor-to-date t)))
2664 (push date calendar-mark-ring)
2665 ;; Since the top of the mark ring is the marked date in the
2666 ;; calendar, the mark ring in the calendar is one longer than
2667 ;; in other buffers to get the same effect.
2668 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2669 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2670 (message "Mark set"))
2671 (if (null calendar-mark-ring)
2672 (error "No mark set in this buffer")
2673 (calendar-goto-date (car calendar-mark-ring))
2674 (setq calendar-mark-ring
2675 (cdr (nconc calendar-mark-ring (list date))))))))
2677 (defun calendar-exchange-point-and-mark ()
2678 "Exchange the current cursor position with the marked date."
2680 (let ((mark (car calendar-mark-ring))
2681 (date (calendar-cursor-to-date t)))
2683 (error "No mark set in this buffer")
2684 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2685 (calendar-goto-date mark))))
2687 (defun calendar-count-days-region ()
2688 "Count the number of days (inclusive) between point and the mark."
2690 (let* ((days (- (calendar-absolute-from-gregorian
2691 (calendar-cursor-to-date t))
2692 (calendar-absolute-from-gregorian
2693 (or (car calendar-mark-ring)
2694 (error "No mark set in this buffer")))))
2695 (days (1+ (if (> days 0) days (- days)))))
2696 (message "Region has %d day%s (inclusive)"
2697 days (if (> days 1) "s" ""))))
2699 (defun calendar-not-implemented ()
2702 (error "%s not available in the calendar"
2703 (global-key-binding (this-command-keys))))
2705 (defun calendar-read (prompt acceptable &optional initial-contents)
2706 "Return an object read from the minibuffer.
2707 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2708 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2709 is a string to insert in the minibuffer before reading."
2710 (let ((value (read-minibuffer prompt initial-contents)))
2711 (while (not (funcall acceptable value))
2712 (setq value (read-minibuffer prompt initial-contents)))
2715 (defun calendar-read-date (&optional noday)
2716 "Prompt for Gregorian date. Return a list (month day year).
2717 If optional NODAY is t, does not ask for day, but just returns
2718 \(month nil year); if NODAY is any other non-nil value the value returned is
2720 (let* ((year (calendar-read
2722 (lambda (x) (> x 0))
2723 (int-to-string (extract-calendar-year
2724 (calendar-current-date)))))
2725 (month-array calendar-month-name-array)
2726 (completion-ignore-case t)
2727 (month (cdr (assoc-string
2730 (mapcar 'list (append month-array nil))
2732 (calendar-make-alist month-array 1) t)))
2733 (last (calendar-last-day-of-month month year)))
2736 (list month nil year)
2739 (calendar-read (format "Day (1-%d): " last)
2740 (lambda (x) (and (< 0 x) (<= x last))))
2743 (defun calendar-interval (mon1 yr1 mon2 yr2)
2744 "The number of months difference between MON1, YR1 and MON2, YR2.
2745 The result is positive if the second date is later than the first.
2746 Negative years are interpreted as years BC; -1 being 1 BC, and so on."
2747 (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc
2748 (if (< yr2 0) (setq yr2 (1+ yr2)))
2749 (+ (* 12 (- yr2 yr1))
2752 (defvar calendar-abbrev-length 3
2753 "*Length of abbreviations to be used for day and month names.
2754 See also `calendar-day-abbrev-array' and `calendar-month-abbrev-array'.")
2756 (defvar calendar-day-name-array
2757 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2758 "*Array of capitalized strings giving, in order, the day names.
2759 The first two characters of each string will be used to head the
2760 day columns in the calendar. See also the variable
2761 `calendar-day-abbrev-array'.")
2763 (defvar calendar-day-abbrev-array
2764 [nil nil nil nil nil nil nil]
2765 "*Array of capitalized strings giving the abbreviated day names.
2766 The order should be the same as that of the full names specified
2767 in `calendar-day-name-array'. These abbreviations may be used
2768 instead of the full names in the diary file. Do not include a
2769 trailing `.' in the strings specified in this variable, though
2770 you may use such in the diary file. If any element of this array
2771 is nil, then the abbreviation will be constructed as the first
2772 `calendar-abbrev-length' characters of the corresponding full name.")
2774 (defvar calendar-month-name-array
2775 ["January" "February" "March" "April" "May" "June"
2776 "July" "August" "September" "October" "November" "December"]
2777 "*Array of capitalized strings giving, in order, the month names.
2778 See also the variable `calendar-month-abbrev-array'.")
2780 (defvar calendar-month-abbrev-array
2781 [nil nil nil nil nil nil nil nil nil nil nil nil]
2782 "*Array of capitalized strings giving the abbreviated month names.
2783 The order should be the same as that of the full names specified
2784 in `calendar-month-name-array'. These abbreviations are used in
2785 the calendar menu entries, and can also be used in the diary
2786 file. Do not include a trailing `.' in the strings specified in
2787 this variable, though you may use such in the diary file. If any
2788 element of this array is nil, then the abbreviation will be
2789 constructed as the first `calendar-abbrev-length' characters of the
2790 corresponding full name.")
2792 (defun calendar-abbrev-construct (abbrev full &optional period)
2793 "Internal calendar function to return a complete abbreviation array.
2794 ABBREV is an array of abbreviations, FULL the corresponding array
2795 of full names. The return value is the ABBREV array, with any nil
2796 elements replaced by the first three characters taken from the
2797 corresponding element of FULL. If optional argument PERIOD is non-nil,
2798 each element returned has a final `.' character."
2799 (let (elem array name)
2800 (dotimes (i (length full))
2801 (setq name (aref full i)
2802 elem (or (aref abbrev i)
2804 (min calendar-abbrev-length (length name))))
2805 elem (format "%s%s" elem (if period "." ""))
2806 array (append array (list elem))))
2809 (defvar calendar-font-lock-keywords
2810 `((,(concat (regexp-opt (mapcar 'identity calendar-month-name-array) t)
2812 . font-lock-function-name-face) ; month and year
2814 (list (substring (aref calendar-day-name-array 6) 0 2)
2815 (substring (aref calendar-day-name-array 0) 0 2)))
2816 ;; Saturdays and Sundays are hilited differently.
2817 . font-lock-comment-face)
2818 ;; First two chars of each day are used in the calendar.
2819 (,(regexp-opt (mapcar (lambda (x) (substring x 0 2)) calendar-day-name-array))
2820 . font-lock-reference-face))
2821 "Default keywords to highlight in Calendar mode.")
2823 (defun calendar-day-name (date &optional abbrev absolute)
2824 "Return a string with the name of the day of the week of DATE.
2825 DATE should be a list in the format (MONTH DAY YEAR), unless the
2826 optional argument ABSOLUTE is non-nil, in which case DATE should
2827 be an integer in the range 0 to 6 corresponding to the day of the
2828 week. Day names are taken from the variable `calendar-day-name-array',
2829 unless the optional argument ABBREV is non-nil, in which case
2830 the variable `calendar-day-abbrev-array' is used."
2832 (calendar-abbrev-construct calendar-day-abbrev-array
2833 calendar-day-name-array)
2834 calendar-day-name-array)
2835 (if absolute date (calendar-day-of-week date))))
2837 (defun calendar-make-alist (sequence &optional start-index filter abbrevs)
2838 "Make an assoc list corresponding to SEQUENCE.
2839 Each element of sequence will be associated with an integer, starting
2840 from 1, or from START-INDEX if that is non-nil. If a sequence ABBREVS
2841 is supplied, the function `calendar-abbrev-construct' is used to
2842 construct abbreviations corresponding to the elements in SEQUENCE.
2843 Each abbreviation is entered into the alist with the same
2844 association index as the full name it represents.
2845 If FILTER is provided, apply it to each key in the alist."
2847 (offset (or start-index 1))
2848 (aseq (if abbrevs (calendar-abbrev-construct abbrevs sequence)))
2849 (aseqp (if abbrevs (calendar-abbrev-construct abbrevs sequence
2852 (dotimes (i (length sequence) (reverse alist))
2853 (setq index (+ i offset)
2854 elem (elt sequence i)
2856 (cons (cons (if filter (funcall filter elem) elem) index) alist))
2858 (setq elem (elt aseq i)
2859 alist (cons (cons (if filter (funcall filter elem) elem)
2862 (setq elem (elt aseqp i)
2863 alist (cons (cons (if filter (funcall filter elem) elem)
2866 (defun calendar-month-name (month &optional abbrev)
2867 "Return a string with the name of month number MONTH.
2868 Months are numbered from one. Month names are taken from the
2869 variable `calendar-month-name-array', unless the optional
2870 argument ABBREV is non-nil, in which case
2871 `calendar-month-abbrev-array' is used."
2873 (calendar-abbrev-construct calendar-month-abbrev-array
2874 calendar-month-name-array)
2875 calendar-month-name-array)
2878 (defun calendar-day-of-week (date)
2879 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc.
2880 DATE is a list of the form (month day year). A negative year is
2881 interpreted as BC; -1 being 1 BC, and so on."
2882 (mod (calendar-absolute-from-gregorian date) 7))
2884 (defun calendar-unmark ()
2885 "Delete all diary/holiday marks/highlighting from the calendar."
2887 (setq mark-holidays-in-calendar nil)
2888 (setq mark-diary-entries-in-calendar nil)
2891 (defun calendar-date-is-visible-p (date)
2892 "Return t if DATE is valid and is visible in the calendar window."
2893 (let ((gap (calendar-interval
2894 displayed-month displayed-year
2895 (extract-calendar-month date) (extract-calendar-year date))))
2896 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2898 (defun calendar-date-is-legal-p (date)
2899 "Return t if DATE is a valid date."
2900 (let ((month (extract-calendar-month date))
2901 (day (extract-calendar-day date))
2902 (year (extract-calendar-year date)))
2903 (and (<= 1 month) (<= month 12)
2904 ;; (calendar-read-date t) returns a date with day = nil.
2905 ;; Should not be valid (?), since many funcs prob assume integer.
2906 ;; (calendar-read-date 'noday) returns (month year), which
2907 ;; currently results in extract-calendar-year returning nil.
2908 day year (<= 1 day) (<= day (calendar-last-day-of-month month year))
2909 ;; BC dates left as non-valid, to suppress errors from
2910 ;; complex holiday algorithms not suitable for years BC.
2911 ;; Note there are side effects on calendar navigation.
2914 (defun calendar-date-equal (date1 date2)
2915 "Return t if the DATE1 and DATE2 are the same."
2917 (= (extract-calendar-month date1) (extract-calendar-month date2))
2918 (= (extract-calendar-day date1) (extract-calendar-day date2))
2919 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2921 (defun mark-visible-calendar-date (date &optional mark)
2922 "Mark DATE in the calendar window with MARK.
2923 MARK is a single-character string, a list of face attributes/values, or a face.
2924 MARK defaults to `diary-entry-marker'."
2925 (if (calendar-date-is-legal-p date)
2926 (with-current-buffer calendar-buffer
2928 (calendar-cursor-to-visible-date date)
2930 (or (and (stringp mark) (= (length mark) 1) mark) ; single-char
2931 (and (listp mark) (> (length mark) 0) mark) ; attr list
2932 (and (facep mark) mark) ; face-name
2933 diary-entry-marker))
2935 ;; face or an attr-list that contained a face
2938 (make-overlay (1- (point)) (1+ (point))) 'face mark))
2940 ((and (stringp mark) (= (length mark) 1))
2941 (let ((inhibit-read-only t))
2943 ;; Insert before delete so as to better preserve markers.
2950 (apply 'concat "temp-"
2951 (mapcar (lambda (sym)
2953 ((symbolp sym) (symbol-name sym))
2954 ((numberp sym) (number-to-string sym))
2958 (make-face temp-face)
2959 ;; Remove :face info from the mark, copy the face info into
2961 (while (setq faceinfo (memq :face faceinfo))
2962 (copy-face (read (nth 1 faceinfo)) temp-face)
2963 (setcar faceinfo nil)
2964 (setcar (cdr faceinfo) nil))
2965 (setq mark (delq nil mark))
2966 ;; Apply the font aspects
2967 (apply 'set-face-attribute temp-face nil mark)
2969 (make-overlay (1- (point)) (1+ (point))) 'face temp-face))))))))
2971 (defun calendar-star-date ()
2972 "Replace the date under the cursor in the calendar window with asterisks.
2973 This function can be used with the `today-visible-calendar-hook' run after the
2974 calendar window has been prepared."
2975 (let ((inhibit-read-only t)
2976 (modified (buffer-modified-p)))
2978 (set (make-local-variable 'calendar-starred-day)
2980 (buffer-substring (point) (- (point) 2))))
2981 ;; Insert before deleting, to better preserve markers.
2986 (restore-buffer-modified-p modified)))
2988 (defun calendar-mark-today ()
2989 "Mark the date under the cursor in the calendar window.
2990 The date is marked with `calendar-today-marker'. This function can be used with
2991 the `today-visible-calendar-hook' run after the calendar window has been
2993 (mark-visible-calendar-date
2994 (calendar-cursor-to-date)
2995 calendar-today-marker))
2997 (defun calendar-date-compare (date1 date2)
2998 "Return t if DATE1 is before DATE2, nil otherwise.
2999 The actual dates are in the car of DATE1 and DATE2."
3000 (< (calendar-absolute-from-gregorian (car date1))
3001 (calendar-absolute-from-gregorian (car date2))))
3003 (defun calendar-date-string (date &optional abbreviate nodayname)
3004 "A string form of DATE, driven by the variable `calendar-date-display-form'.
3005 An optional parameter ABBREVIATE, when non-nil, causes the month
3006 and day names to be abbreviated as specified by
3007 `calendar-month-abbrev-array' and `calendar-day-abbrev-array',
3008 respectively. An optional parameter NODAYNAME, when t, omits the
3009 name of the day of the week."
3012 (calendar-day-name date abbreviate)))
3013 (month (extract-calendar-month date))
3014 (monthname (calendar-month-name month abbreviate))
3015 (day (int-to-string (extract-calendar-day date)))
3016 (month (int-to-string month))
3017 (year (int-to-string (extract-calendar-year date))))
3018 (mapconcat 'eval calendar-date-display-form "")))
3020 (defun calendar-dayname-on-or-before (dayname date)
3021 "Return the absolute date of the DAYNAME on or before absolute DATE.
3022 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
3024 Note: Applying this function to d+6 gives us the DAYNAME on or after an
3025 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
3026 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
3027 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
3028 (- date (% (- date dayname) 7)))
3030 (defun calendar-nth-named-absday (n dayname month year &optional day)
3031 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3032 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3033 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3034 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3036 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3039 (calendar-dayname-on-or-before
3041 (+ 6 (calendar-absolute-from-gregorian
3042 (list month (or day 1) year)))))
3044 (calendar-dayname-on-or-before
3046 (calendar-absolute-from-gregorian
3048 (or day (calendar-last-day-of-month month year))
3051 (defun calendar-nth-named-day (n dayname month year &optional day)
3052 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3053 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3054 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3055 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3057 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3058 (calendar-gregorian-from-absolute
3059 (calendar-nth-named-absday n dayname month year day)))
3061 (defun calendar-day-of-year-string (&optional date)
3062 "String of day number of year of Gregorian DATE.
3063 Defaults to today's date if DATE is not given."
3064 (let* ((d (or date (calendar-current-date)))
3065 (year (extract-calendar-year d))
3066 (day (calendar-day-number d))
3067 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
3068 (format "Day %d of %d; %d day%s remaining in the year"
3069 day year days-remaining (if (= days-remaining 1) "" "s"))))
3071 (defun calendar-print-other-dates ()
3072 "Show dates on other calendars for date under the cursor."
3074 (let* ((date (calendar-cursor-to-date t)))
3075 (with-current-buffer (get-buffer-create other-calendars-buffer)
3076 (let ((inhibit-read-only t)
3077 (modified (buffer-modified-p)))
3078 (calendar-set-mode-line
3079 (concat (calendar-date-string date) " (Gregorian)"))
3085 (calendar-day-of-year-string date) "\n"
3086 (format "ISO date: %s\n" (calendar-iso-date-string date))
3087 (format "Julian date: %s\n"
3088 (calendar-julian-date-string date))
3089 (format "Astronomical (Julian) day number (at noon UTC): %s.0\n"
3090 (calendar-astro-date-string date))
3091 (format "Fixed (RD) date: %s\n"
3092 (calendar-absolute-from-gregorian date))
3093 (format "Hebrew date (before sunset): %s\n"
3094 (calendar-hebrew-date-string date))
3095 (format "Persian date: %s\n"
3096 (calendar-persian-date-string date))
3097 (let ((i (calendar-islamic-date-string date)))
3098 (if (not (string-equal i ""))
3099 (format "Islamic date (before sunset): %s\n" i)))
3100 (let ((b (calendar-bahai-date-string date)))
3101 (if (not (string-equal b ""))
3102 (format "Baha'i date (before sunset): %s\n" b)))
3103 (format "Chinese date: %s\n"
3104 (calendar-chinese-date-string date))
3105 (let ((c (calendar-coptic-date-string date)))
3106 (if (not (string-equal c ""))
3107 (format "Coptic date: %s\n" c)))
3108 (let ((e (calendar-ethiopic-date-string date)))
3109 (if (not (string-equal e ""))
3110 (format "Ethiopic date: %s\n" e)))
3111 (let ((f (calendar-french-date-string date)))
3112 (if (not (string-equal f ""))
3113 (format "French Revolutionary date: %s\n" f)))
3114 (format "Mayan date: %s\n"
3115 (calendar-mayan-date-string date)))))
3116 (goto-char (point-min))
3117 (restore-buffer-modified-p modified))
3118 (display-buffer other-calendars-buffer))))
3120 (defun calendar-print-day-of-year ()
3121 "Show day number in year/days remaining in year for date under the cursor."
3123 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
3125 (defun calendar-set-mode-line (str)
3126 "Set mode line to STR, centered, surrounded by dashes."
3127 (let* ((edges (window-edges))
3128 ;; As per doc of window-width, total visible mode-line length.
3129 (width (- (nth 2 edges) (nth 0 edges))))
3130 (setq mode-line-format
3131 (if buffer-file-name
3132 `("-" mode-line-modified
3133 ,(calendar-string-spread (list str) ?- (- width 6))
3135 (calendar-string-spread (list str) ?- width)))))
3137 (defun calendar-mod (m n)
3138 "Non-negative remainder of M/N with N instead of 0."
3139 (1+ (mod (1- m) n)))
3141 (run-hooks 'calendar-load-hook)
3146 ;; byte-compile-dynamic: t
3149 ;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8
3150 ;;; calendar.el ends here