1 ;;; calendar.el --- calendar functions
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997,
4 ;; 2000, 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <gmorris@ast.cam.ac.uk>
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
102 (defvar displayed-month)
103 (defvar displayed-year)
104 (defvar calendar-month-name-array)
105 (defvar calendar-starred-day))
107 (defun calendar-version ()
109 (message "Version 6, October 12, 1995"))
111 (defgroup calendar nil
112 "Calendar and time management support."
113 :group 'applications)
120 "Appointment notification."
123 (defgroup holidays nil
124 "Holidays support in calendar."
129 (defgroup chinese-calendar nil
130 "Chinese calendar support."
133 (defgroup calendar-tex nil
134 "Options for printing calendar with LaTeX."
138 (defgroup calendar-hooks nil
144 (defconst calendar-buffer "*Calendar*"
145 "Name of the buffer used for the calendar.")
148 (defcustom calendar-offset 0
149 "*The offset of the principal month from the center of the calendar window.
150 0 means the principal month is in the center (default), -1 means on the left,
151 +1 means on the right. Larger (or smaller) values push the principal month off
157 (defcustom view-diary-entries-initially nil
158 "*Non-nil means display current date's diary entries on entry to calendar.
159 The diary is displayed in another window when the calendar is first displayed,
160 if the current date is visible. The number of days of diary entries displayed
161 is governed by the variable `number-of-diary-entries'. This variable can
162 be overridden by the value of `calendar-setup'."
167 (defcustom number-of-diary-entries 1
168 "*Specifies how many days of diary entries are to be displayed initially.
169 This variable affects the diary display when the command \\[diary] is used,
170 or if the value of the variable `view-diary-entries-initially' is t. For
171 example, if the default value 1 is used, then only the current day's diary
172 entries will be displayed. If the value 2 is used, then both the current
173 day's and the next day's entries will be displayed.
175 The value can also be a vector such as [0 2 2 2 2 4 1]; this value
176 says to display no diary entries on Sunday, the display the entries
177 for the current date and the day after on Monday through Thursday,
178 display Friday through Monday's entries on Friday, and display only
179 Saturday's entries on Saturday.
181 This variable does not affect the diary display with the `d' command
182 from the calendar; in that case, the prefix argument controls the
183 number of days of diary entries displayed."
184 :type '(choice (integer :tag "Entries")
185 (vector :value [0 0 0 0 0 0 0]
186 (integer :tag "Sunday")
187 (integer :tag "Monday")
188 (integer :tag "Tuesday")
189 (integer :tag "Wednesday")
190 (integer :tag "Thursday")
191 (integer :tag "Friday")
192 (integer :tag "Saturday")))
196 (defcustom mark-diary-entries-in-calendar nil
197 "*Non-nil means mark dates with diary entries, in the calendar window.
198 The marking symbol is specified by the variable `diary-entry-marker'."
203 (defcustom calendar-remove-frame-by-deleting nil
204 "*Determine how the calendar mode removes a frame no longer needed.
205 If nil, make an icon of the frame. If non-nil, delete the frame."
209 (defvar diary-face 'diary
210 "Face name to use for diary entries.")
212 '((((min-colors 88) (class color) (background light))
214 (((class color) (background light))
216 (((min-colors 88) (class color) (background dark))
217 :foreground "yellow1")
218 (((class color) (background dark))
219 :foreground "yellow")
222 "Face for highlighting diary entries."
224 ;; backward-compatibility alias
225 (put 'diary-face 'face-alias 'diary)
227 (defface calendar-today
228 '((t (:underline t)))
229 "Face for indicating today's date."
231 ;; backward-compatibility alias
232 (put 'calendar-today-face 'face-alias 'calendar-today)
235 '((((class color) (background light))
237 (((class color) (background dark))
238 :background "chocolate4")
241 "Face for indicating dates that have holidays."
243 ;; backward-compatibility alias
244 (put 'holiday-face 'face-alias 'holiday)
246 (eval-after-load "facemenu"
248 (add-to-list 'facemenu-unlisted-faces 'diary)
249 (add-to-list 'facemenu-unlisted-faces 'calendar-today)
250 (add-to-list 'facemenu-unlisted-faces 'holiday)))
252 (defcustom diary-entry-marker
253 (if (not (display-color-p))
256 "*How to mark dates that have diary entries.
257 The value can be either a single-character string or a face."
258 :type '(choice string face)
261 (defcustom calendar-today-marker
262 (if (not (display-color-p))
265 "*How to mark today's date in the calendar.
266 The value can be either a single-character string or a face.
267 Marking today's date is done only if you set up `today-visible-calendar-hook'
269 :type '(choice string face)
272 (defcustom calendar-holiday-marker
273 (if (not (display-color-p))
276 "*How to mark notable dates in the calendar.
277 The value can be either a single-character string or a face."
278 :type '(choice string face)
282 (defcustom view-calendar-holidays-initially nil
283 "*Non-nil means display holidays for current three month period on entry.
284 The holidays are displayed in another window when the calendar is first
290 (defcustom mark-holidays-in-calendar nil
291 "*Non-nil means mark dates of holidays in the calendar window.
292 The marking symbol is specified by the variable `calendar-holiday-marker'."
297 (defcustom all-hebrew-calendar-holidays nil
298 "*If nil, show only major holidays from the Hebrew calendar.
299 This means only those Jewish holidays that appear on secular calendars.
301 If t, show all the holidays that would appear in a complete Hebrew calendar."
306 (defcustom all-christian-calendar-holidays nil
307 "*If nil, show only major holidays from the Christian calendar.
308 This means only those Christian holidays that appear on secular calendars.
310 If t, show all the holidays that would appear in a complete Christian
316 (defcustom all-islamic-calendar-holidays nil
317 "*If nil, show only major holidays from the Islamic calendar.
318 This means only those Islamic holidays that appear on secular calendars.
320 If t, show all the holidays that would appear in a complete Islamic
325 (defcustom diary-file-name-prefix-function (function (lambda (str) str))
326 "*The function that will take a diary file name and return the desired prefix."
331 (defcustom all-bahai-calendar-holidays nil
332 "*If nil, show only major holidays from the Baha'i calendar.
333 These are the days on which work and school must be suspended.
335 If t, show all the holidays that would appear in a complete Baha'i
341 (defcustom calendar-load-hook nil
342 "*List of functions to be called after the calendar is first loaded.
343 This is the place to add key bindings to `calendar-mode-map'."
345 :group 'calendar-hooks)
348 (defcustom initial-calendar-window-hook nil
349 "*List of functions to be called when the calendar window is first opened.
350 The functions invoked are called after the calendar window is opened, but
351 once opened is never called again. Leaving the calendar with the `q' command
352 and reentering it will cause these functions to be called again."
354 :group 'calendar-hooks)
357 (defcustom today-visible-calendar-hook nil
358 "*List of functions called whenever the current date is visible.
359 This can be used, for example, to replace today's date with asterisks; a
360 function `calendar-star-date' is included for this purpose:
361 (setq today-visible-calendar-hook 'calendar-star-date)
362 It can also be used to mark the current date with `calendar-today-marker';
363 a function is also provided for this:
364 (setq today-visible-calendar-hook 'calendar-mark-today)
366 The corresponding variable `today-invisible-calendar-hook' is the list of
367 functions called when the calendar function was called when the current
368 date is not visible in the window.
370 Other than the use of the provided functions, the changing of any
371 characters in the calendar buffer by the hooks may cause the failure of the
372 functions that move by days and weeks."
374 :group 'calendar-hooks)
377 (defcustom today-invisible-calendar-hook nil
378 "*List of functions called whenever the current date is not visible.
380 The corresponding variable `today-visible-calendar-hook' is the list of
381 functions called when the calendar function was called when the current
382 date is visible in the window.
384 Other than the use of the provided functions, the changing of any
385 characters in the calendar buffer by the hooks may cause the failure of the
386 functions that move by days and weeks."
388 :group 'calendar-hooks)
391 (defcustom calendar-move-hook nil
392 "*List of functions called whenever the cursor moves in the calendar.
396 (add-hook 'calendar-move-hook (lambda () (view-diary-entries 1)))
398 redisplays the diary for whatever date the cursor is moved to."
400 :group 'calendar-hooks)
403 (defcustom diary-file "~/diary"
404 "*Name of the file in which one's personal diary of dates is kept.
406 The file's entries are lines beginning with any of the forms
407 specified by the variable `american-date-diary-pattern', by default:
415 with the remainder of the line being the diary entry string for
416 that date. MONTH and DAY are one or two digit numbers, YEAR is a
417 number and may be written in full or abbreviated to the final two
418 digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME
419 and DAYNAME can be spelled in full (as specified by the variables
420 `calendar-month-name-array' and `calendar-day-name-array'),
421 abbreviated (as specified by `calendar-month-abbrev-array' and
422 `calendar-day-abbrev-array') with or without a period,
423 capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be
424 `*' which matches any day, month, or year, respectively. If the
425 date does not contain a year, it is generic and applies to any
426 year. A DAYNAME entry applies to the appropriate day of the week
429 The European style (in which the day precedes the month) can be
430 used instead, if you execute `european-calendar' when in the
431 calendar, or set `european-calendar-style' to t in your .emacs
432 file. The European forms (see `european-date-diary-pattern') are
440 To revert to the default American style from the European style, execute
441 `american-calendar' in the calendar.
443 A diary entry can be preceded by the character
444 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
445 nonmarking--that is, it will not be marked on dates in the calendar
446 window but will appear in a diary window.
448 Multiline diary entries are made by indenting lines after the first with
449 either a TAB or one or more spaces.
451 Lines not in one the above formats are ignored. Here are some sample diary
452 entries (in the default American style):
454 12/22/1988 Twentieth wedding anniversary!!
455 &1/1. Happy New Year!
456 10/22 Ruth's birthday.
458 Tuesday--weekly meeting with grad students at 10am
459 Supowit, Shen, Bitner, and Kapoor to attend.
460 1/13/89 Friday the thirteenth!!
461 &thu 4pm squash game with Lloyd.
462 mar 16 Dad's birthday
463 April 15, 1989 Income tax due.
464 &* 15 time cards due.
466 If the first line of a diary entry consists only of the date or day name with
467 no trailing blanks or punctuation, then that line is not displayed in the
468 diary window; only the continuation lines is shown. For example, the
472 Bill Blattner visits Princeton today
473 2pm Cognitive Studies Committee meeting
474 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
475 4:00pm Jamie Tappenden
476 7:30pm Dinner at George and Ed's for Alan Ryan
477 7:30-10:00pm dance at Stewart Country Day School
479 will appear in the diary window without the date line at the beginning. This
480 facility allows the diary window to look neater, but can cause confusion if
481 used with more than one day's entries displayed.
483 Diary entries can be based on Lisp sexps. For example, the diary entry
485 %%(diary-block 11 1 1990 11 10 1990) Vacation
487 causes the diary entry \"Vacation\" to appear from November 1 through
488 November 10, 1990. Other functions available are `diary-float',
489 `diary-anniversary', `diary-cyclic', `diary-day-of-year',
490 `diary-iso-date', `diary-french-date', `diary-hebrew-date',
491 `diary-islamic-date', `diary-bahai-date', `diary-mayan-date',
492 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
493 `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset',
494 `diary-phases-of-moon', `diary-parasha', `diary-omer',
495 `diary-rosh-hodesh', and `diary-sabbath-candles'. See the
496 documentation for the function `list-sexp-diary-entries' for more
499 Diary entries based on the Hebrew, the Islamic and/or the Baha'i
500 calendar are also possible, but because these are somewhat slow, they
501 are ignored unless you set the `nongregorian-diary-listing-hook' and
502 the `nongregorian-diary-marking-hook' appropriately. See the
503 documentation for these functions for details.
505 Diary files can contain directives to include the contents of other files; for
506 details, see the documentation for the variable `list-diary-entries-hook'."
511 (defcustom diary-nonmarking-symbol "&"
512 "*Symbol indicating that a diary entry is not to be marked in the calendar."
517 (defcustom hebrew-diary-entry-symbol "H"
518 "*Symbol indicating a diary entry according to the Hebrew calendar."
523 (defcustom islamic-diary-entry-symbol "I"
524 "*Symbol indicating a diary entry according to the Islamic calendar."
529 (defcustom bahai-diary-entry-symbol "B"
530 "*Symbol indicating a diary entry according to the Baha'i calendar."
535 (defcustom diary-include-string "#include"
536 "*The string indicating inclusion of another file of diary entries.
537 See the documentation for the function `include-other-diary-files'."
541 (defcustom diary-glob-file-regexp-prefix "^\\#"
542 "*The regular expression that gets pre-pended to each of the attribute-regexp's for file-wide specifiers."
546 (defcustom diary-face-attrs
547 '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string)
548 (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string)
549 (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol)
550 (" *\\[height:\\([-0-9a-z]+\\)\\]$" 1 :height int)
551 (" *\\[weight:\\([-a-z]+\\)\\]$" 1 :weight symbol)
552 (" *\\[slant:\\([-a-z]+\\)\\]$" 1 :slant symbol)
553 (" *\\[underline:\\([-a-z]+\\)\\]$" 1 :underline stringtnil)
554 (" *\\[overline:\\([-a-z]+\\)\\]$" 1 :overline stringtnil)
555 (" *\\[strike-through:\\([-a-z]+\\)\\]$" 1 :strike-through stringtnil)
556 (" *\\[inverse-video:\\([-a-z]+\\)\\]$" 1 :inverse-video tnil)
557 (" *\\[face:\\([-0-9a-z]+\\)\\]$" 1 :face string)
558 (" *\\[font:\\([-a-z0-9]+\\)\\]$" 1 :font string)
560 ;;; (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box)
561 ;;; (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple)
563 "*A list of (regexp regnum attr attrtype) lists where the
564 regexp says how to find the tag, the regnum says which
565 parenthetical sub-regexp this regexp looks for, and the attr says
566 which attribute of the face (or that this _is_ a face) is being
571 (defcustom diary-file-name-prefix nil
572 "If non-nil each diary entry is prefixed with the name of the file where it is defined."
577 (defcustom sexp-diary-entry-symbol "%%"
578 "*The string used to indicate a sexp diary entry in `diary-file'.
579 See the documentation for the function `list-sexp-diary-entries'."
584 (defcustom abbreviated-calendar-year t
585 "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
586 For the Gregorian calendar; similarly for the Hebrew, Islamic and
587 Baha'i calendars. If this variable is nil, years must be written in
593 (defcustom european-calendar-style nil
594 "*Use the European style of dates in the diary and in any displays.
595 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
596 1990. The default European date styles (see `european-date-diary-pattern')
605 Names can be capitalized or not, written in full (as specified by the
606 variable `calendar-day-name-array'), or abbreviated (as specified by
607 `calendar-day-abbrev-array') with or without a period. To take effect,
608 this variable should be set before the calendar package and its associates
609 are loaded. Otherwise, use one of the functions `european-calendar' or
610 `american-calendar' to force the appropriate update."
615 (defcustom american-date-diary-pattern
616 '((month "/" day "[^/0-9]")
617 (month "/" day "/" year "[^0-9]")
618 (monthname " *" day "[^,0-9]")
619 (monthname " *" day ", *" year "[^0-9]")
621 "*List of pseudo-patterns describing the American patterns of date used.
622 See the documentation of `diary-date-forms' for an explanation."
623 :type '(repeat (choice (cons :tag "Backup"
624 :value (backup . nil)
626 (repeat (list :inline t :format "%v"
627 (symbol :tag "Keyword")
628 (choice symbol regexp))))
629 (repeat (list :inline t :format "%v"
630 (symbol :tag "Keyword")
631 (choice symbol regexp)))))
635 (defcustom european-date-diary-pattern
636 '((day "/" month "[^/0-9]")
637 (day "/" month "/" year "[^0-9]")
638 (backup day " *" monthname "\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
639 (day " *" monthname " *" year "[^0-9]")
641 "*List of pseudo-patterns describing the European patterns of date used.
642 See the documentation of `diary-date-forms' for an explanation."
643 :type '(repeat (choice (cons :tag "Backup"
644 :value (backup . nil)
646 (repeat (list :inline t :format "%v"
647 (symbol :tag "Keyword")
648 (choice symbol regexp))))
649 (repeat (list :inline t :format "%v"
650 (symbol :tag "Keyword")
651 (choice symbol regexp)))))
654 (defcustom diary-date-forms
655 (if european-calendar-style
656 european-date-diary-pattern
657 american-date-diary-pattern)
658 "*List of pseudo-patterns describing the forms of date used in the diary.
659 The patterns on the list must be MUTUALLY EXCLUSIVE and should not match
660 any portion of the diary entry itself, just the date component.
662 A pseudo-pattern is a list of regular expressions and the keywords `month',
663 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
664 match the name of the month (see `calendar-month-name-array'), capitalized
665 or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'),
666 followed by a period or not; it will also match `*'. Similarly, `dayname'
667 will match the name of the day (see `calendar-day-name-array'), capitalized or
668 not, or its user-specified abbreviation (see `calendar-day-abbrev-array'),
669 followed by a period or not. The keywords `month', `day', and `year' will
670 match those numerical values, preceded by arbitrarily many zeros; they will
673 The matching of the diary entries with the date forms is done with the
674 standard syntax table from Fundamental mode, but with the `*' changed so
675 that it is a word constituent.
677 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
678 diary entry itself, the first element of the pattern MUST be `backup'. This
679 directive causes the date recognizer to back up to the beginning of the
680 current word of the diary entry, so in no case can the pattern match more than
681 a portion of the first word of the diary entry."
682 :type '(repeat (choice (cons :tag "Backup"
683 :value (backup . nil)
685 (repeat (list :inline t :format "%v"
686 (symbol :tag "Keyword")
687 (choice symbol regexp))))
688 (repeat (list :inline t :format "%v"
689 (symbol :tag "Keyword")
690 (choice symbol regexp)))))
694 (defcustom european-calendar-display-form
695 '((if dayname (concat dayname ", ")) day " " monthname " " year)
696 "*Pseudo-pattern governing the way a date appears in the European style.
697 See the documentation of `calendar-date-display-form' for an explanation."
702 (defcustom american-calendar-display-form
703 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
704 "*Pseudo-pattern governing the way a date appears in the American style.
705 See the documentation of `calendar-date-display-form' for an explanation."
709 (defcustom calendar-date-display-form
710 (if european-calendar-style
711 european-calendar-display-form
712 american-calendar-display-form)
713 "*Pseudo-pattern governing the way a date appears.
715 Used by the function `calendar-date-string', a pseudo-pattern is a list of
716 expressions that can involve the keywords `month', `day', and `year', all
717 numbers in string form, and `monthname' and `dayname', both alphabetic
718 strings. For example, the ISO standard would use the pseudo- pattern
720 '(year \"-\" month \"-\" day)
722 while a typical American form would be
724 '(month \"/\" day \"/\" (substring year -2))
728 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
730 would give the usual American style in fixed-length fields.
732 See the documentation of the function `calendar-date-string'."
736 (defun european-calendar ()
737 "Set the interpretation and display of dates to the European style."
739 (setq european-calendar-style t)
740 (setq calendar-date-display-form european-calendar-display-form)
741 (setq diary-date-forms european-date-diary-pattern)
742 (update-calendar-mode-line))
744 (defun american-calendar ()
745 "Set the interpretation and display of dates to the American style."
747 (setq european-calendar-style nil)
748 (setq calendar-date-display-form american-calendar-display-form)
749 (setq diary-date-forms american-date-diary-pattern)
750 (update-calendar-mode-line))
753 (defcustom print-diary-entries-hook 'lpr-buffer
754 "*List of functions called after a temporary diary buffer is prepared.
755 The buffer shows only the diary entries currently visible in the diary
756 buffer. The default just does the printing. Other uses might include, for
757 example, rearranging the lines into order by day and time, saving the buffer
758 instead of deleting it, or changing the function used to do the printing."
763 (defcustom list-diary-entries-hook nil
764 "*List of functions called after diary file is culled for relevant entries.
765 It is to be used for diary entries that are not found in the diary file.
767 A function `include-other-diary-files' is provided for use as the value of
768 this hook. This function enables you to use shared diary files together
769 with your own. The files included are specified in the diary file by lines
772 #include \"filename\"
774 This is recursive; that is, #include directives in files thus included are
775 obeyed. You can change the \"#include\" to some other string by changing
776 the variable `diary-include-string'. When you use `include-other-diary-files'
777 as part of the list-diary-entries-hook, you will probably also want to use the
778 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
780 For example, you could use
782 (setq list-diary-entries-hook
783 '(include-other-diary-files sort-diary-entries))
784 (setq diary-display-hook 'fancy-diary-display)
786 in your `.emacs' file to cause the fancy diary buffer to be displayed with
787 diary entries from various included files, each day's entries sorted into
788 lexicographic order."
790 :options '(include-other-diary-files sort-diary-entries)
794 (defcustom diary-hook nil
795 "*List of functions called after the display of the diary.
796 Can be used for appointment notification."
801 (defcustom diary-display-hook nil
802 "*List of functions that handle the display of the diary.
803 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
806 Ordinarily, this just displays the diary buffer (with holidays indicated in
807 the mode line), if there are any relevant entries. At the time these
808 functions are called, the variable `diary-entries-list' is a list, in order
809 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
810 STRING), where string is the diary entry for the given date. This can be
811 used, for example, a different buffer for display (perhaps combined with
812 holidays), or produce hard copy output.
814 A function `fancy-diary-display' is provided as an alternative
815 choice for this hook; this function prepares a special noneditable diary
816 buffer with the relevant diary entries that has neat day-by-day arrangement
817 with headings. The fancy diary buffer will show the holidays unless the
818 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
819 diary buffer will not show days for which there are no diary entries, even
820 if that day is a holiday; if you want such days to be shown in the fancy
821 diary buffer, set the variable `diary-list-include-blanks' to t."
823 :options '(fancy-diary-display)
827 (defcustom nongregorian-diary-listing-hook nil
828 "*List of functions called for listing diary file and included files.
829 As the files are processed for diary entries, these functions are used
830 to cull relevant entries. You can use either or both of
831 `list-hebrew-diary-entries', `list-islamic-diary-entries' and
832 `list-bahai-diary-entries'. The documentation for these functions
833 describes the style of such diary entries."
835 :options '(list-hebrew-diary-entries
836 list-islamic-diary-entries
837 list-bahai-diary-entries)
841 (defcustom mark-diary-entries-hook nil
842 "*List of functions called after marking diary entries in the calendar.
844 A function `mark-included-diary-files' is also provided for use as the
845 `mark-diary-entries-hook'; it enables you to use shared diary files together
846 with your own. The files included are specified in the diary file by lines
848 #include \"filename\"
849 This is recursive; that is, #include directives in files thus included are
850 obeyed. You can change the \"#include\" to some other string by changing the
851 variable `diary-include-string'. When you use `mark-included-diary-files' as
852 part of the mark-diary-entries-hook, you will probably also want to use the
853 function `include-other-diary-files' as part of `list-diary-entries-hook'."
855 :options '(mark-included-diary-files)
859 (defcustom nongregorian-diary-marking-hook nil
860 "*List of functions called for marking diary file and included files.
861 As the files are processed for diary entries, these functions are used
862 to cull relevant entries. You can use either or both of
863 `mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
864 `mark-bahai-diary-entries'. The documentation for these functions
865 describes the style of such diary entries."
867 :options '(mark-hebrew-diary-entries
868 mark-islamic-diary-entries
869 mark-bahai-diary-entries)
873 (defcustom diary-list-include-blanks nil
874 "*If nil, do not include days with no diary entry in the list of diary entries.
875 Such days will then not be shown in the fancy diary buffer, even if they
881 (defcustom holidays-in-diary-buffer t
882 "*Non-nil means include holidays in the diary display.
883 The holidays appear in the mode line of the diary buffer, or in the
884 fancy diary buffer next to the date. This slows down the diary functions
885 somewhat; setting it to nil makes the diary display faster."
889 (defvar calendar-mark-ring nil)
892 (put 'general-holidays 'risky-local-variable t)
894 (defcustom general-holidays
895 '((holiday-fixed 1 1 "New Year's Day")
896 (holiday-float 1 1 3 "Martin Luther King Day")
897 (holiday-fixed 2 2 "Groundhog Day")
898 (holiday-fixed 2 14 "Valentine's Day")
899 (holiday-float 2 1 3 "President's Day")
900 (holiday-fixed 3 17 "St. Patrick's Day")
901 (holiday-fixed 4 1 "April Fools' Day")
902 (holiday-float 5 0 2 "Mother's Day")
903 (holiday-float 5 1 -1 "Memorial Day")
904 (holiday-fixed 6 14 "Flag Day")
905 (holiday-float 6 0 3 "Father's Day")
906 (holiday-fixed 7 4 "Independence Day")
907 (holiday-float 9 1 1 "Labor Day")
908 (holiday-float 10 1 2 "Columbus Day")
909 (holiday-fixed 10 31 "Halloween")
910 (holiday-fixed 11 11 "Veteran's Day")
911 (holiday-float 11 4 4 "Thanksgiving"))
912 "*General holidays. Default value is for the United States.
913 See the documentation for `calendar-holidays' for details."
918 (put 'oriental-holidays 'risky-local-variable t)
920 (defcustom oriental-holidays
921 '((if (fboundp 'atan)
922 (holiday-chinese-new-year)))
924 See the documentation for `calendar-holidays' for details."
929 (put 'local-holidays 'risky-local-variable t)
931 (defcustom local-holidays nil
933 See the documentation for `calendar-holidays' for details."
938 (put 'other-holidays 'risky-local-variable t)
940 (defcustom other-holidays nil
941 "*User defined holidays.
942 See the documentation for `calendar-holidays' for details."
947 (put 'hebrew-holidays-1 'risky-local-variable t)
949 (defvar hebrew-holidays-1
950 '((holiday-rosh-hashanah-etc)
951 (if all-hebrew-calendar-holidays
954 (let* ((m displayed-month)
957 (increment-calendar-month m y -1)
958 (let ((year (extract-calendar-year
959 (calendar-julian-from-absolute
960 (calendar-absolute-from-gregorian
962 (if (zerop (% (1+ year) 4))
964 21))) "\"Tal Umatar\" (evening)"))))
967 (put 'hebrew-holidays-2 'risky-local-variable t)
969 (defvar hebrew-holidays-2
970 '((if all-hebrew-calendar-holidays
972 (holiday-hebrew 9 25 "Hanukkah"))
973 (if all-hebrew-calendar-holidays
976 (let ((h-year (extract-calendar-year
977 (calendar-hebrew-from-absolute
978 (calendar-absolute-from-gregorian
979 (list displayed-month 28 displayed-year))))))
980 (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
985 (if all-hebrew-calendar-holidays
986 (holiday-hebrew 11 15 "Tu B'Shevat"))))
989 (put 'hebrew-holidays-3 'risky-local-variable t)
991 (defvar hebrew-holidays-3
992 '((if all-hebrew-calendar-holidays
995 (let ((m displayed-month)
997 (increment-calendar-month m y 1)
998 (let* ((h-year (extract-calendar-year
999 (calendar-hebrew-from-absolute
1000 (calendar-absolute-from-gregorian
1002 (calendar-last-day-of-month m y)
1005 (calendar-hebrew-from-absolute
1007 (% (calendar-absolute-from-hebrew
1011 (calendar-dayname-on-or-before
1012 6 (calendar-absolute-from-hebrew
1013 (list 11 17 h-year)))
1014 (calendar-dayname-on-or-before
1015 6 (calendar-absolute-from-hebrew
1016 (list 11 16 h-year))))))
1017 (day (extract-calendar-day s-s)))
1019 "Shabbat Shirah"))))
1022 (put 'hebrew-holidays-4 'risky-local-variable t)
1024 (defvar hebrew-holidays-4
1025 '((holiday-passover-etc)
1026 (if (and all-hebrew-calendar-holidays
1027 (let* ((m displayed-month)
1030 (increment-calendar-month m y -1)
1031 (let ((year (extract-calendar-year
1032 (calendar-julian-from-absolute
1033 (calendar-absolute-from-gregorian
1035 (= 21 (% year 28)))))
1036 (holiday-julian 3 26 "Kiddush HaHamah"))
1037 (if all-hebrew-calendar-holidays
1038 (holiday-tisha-b-av-etc))))
1041 (put 'hebrew-holidays 'risky-local-variable t)
1043 (defcustom hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
1044 hebrew-holidays-3 hebrew-holidays-4)
1046 See the documentation for `calendar-holidays' for details."
1051 (put 'christian-holidays 'risky-local-variable t)
1053 (defcustom christian-holidays
1054 '((if all-christian-calendar-holidays
1055 (holiday-fixed 1 6 "Epiphany"))
1056 (holiday-easter-etc 0 "Easter Sunday")
1057 (holiday-easter-etc -2 "Good Friday")
1058 (holiday-easter-etc -46 "Ash Wednesday")
1059 (if all-christian-calendar-holidays
1060 (holiday-easter-etc -63 "Septuagesima Sunday"))
1061 (if all-christian-calendar-holidays
1062 (holiday-easter-etc -56 "Sexagesima Sunday"))
1063 (if all-christian-calendar-holidays
1064 (holiday-easter-etc -49 "Shrove Sunday"))
1065 (if all-christian-calendar-holidays
1066 (holiday-easter-etc -48 "Shrove Monday"))
1067 (if all-christian-calendar-holidays
1068 (holiday-easter-etc -47 "Shrove Tuesday"))
1069 (if all-christian-calendar-holidays
1070 (holiday-easter-etc -14 "Passion Sunday"))
1071 (if all-christian-calendar-holidays
1072 (holiday-easter-etc -7 "Palm Sunday"))
1073 (if all-christian-calendar-holidays
1074 (holiday-easter-etc -3 "Maundy Thursday"))
1075 (if all-christian-calendar-holidays
1076 (holiday-easter-etc 35 "Rogation Sunday"))
1077 (if all-christian-calendar-holidays
1078 (holiday-easter-etc 39 "Ascension Day"))
1079 (if all-christian-calendar-holidays
1080 (holiday-easter-etc 49 "Pentecost (Whitsunday)"))
1081 (if all-christian-calendar-holidays
1082 (holiday-easter-etc 50 "Whitmonday"))
1083 (if all-christian-calendar-holidays
1084 (holiday-easter-etc 56 "Trinity Sunday"))
1085 (if all-christian-calendar-holidays
1086 (holiday-easter-etc 60 "Corpus Christi"))
1087 (if all-christian-calendar-holidays
1088 (holiday-greek-orthodox-easter))
1089 (if all-christian-calendar-holidays
1090 (holiday-fixed 8 15 "Assumption"))
1091 (if all-christian-calendar-holidays
1092 (holiday-advent 0 "Advent"))
1093 (holiday-fixed 12 25 "Christmas")
1094 (if all-christian-calendar-holidays
1095 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
1096 "*Christian holidays.
1097 See the documentation for `calendar-holidays' for details."
1102 (put 'islamic-holidays 'risky-local-variable t)
1104 (defcustom islamic-holidays
1107 (format "Islamic New Year %d"
1108 (let ((m displayed-month)
1110 (increment-calendar-month m y 1)
1111 (extract-calendar-year
1112 (calendar-islamic-from-absolute
1113 (calendar-absolute-from-gregorian
1115 m (calendar-last-day-of-month m y) y)))))))
1116 (if all-islamic-calendar-holidays
1117 (holiday-islamic 1 10 "Ashura"))
1118 (if all-islamic-calendar-holidays
1119 (holiday-islamic 3 12 "Mulad-al-Nabi"))
1120 (if all-islamic-calendar-holidays
1121 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
1122 (if all-islamic-calendar-holidays
1123 (holiday-islamic 8 15 "Shab-e-Bara't"))
1124 (holiday-islamic 9 1 "Ramadan Begins")
1125 (if all-islamic-calendar-holidays
1126 (holiday-islamic 9 27 "Shab-e Qadr"))
1127 (if all-islamic-calendar-holidays
1128 (holiday-islamic 10 1 "Id-al-Fitr"))
1129 (if all-islamic-calendar-holidays
1130 (holiday-islamic 12 10 "Id-al-Adha")))
1132 See the documentation for `calendar-holidays' for details."
1137 (put 'bahai-holidays 'risky-local-variable t)
1139 (defcustom bahai-holidays
1142 (format "Baha'i New Year (Naw-Ruz) %d" (- displayed-year (1- 1844))))
1143 (holiday-fixed 4 21 "First Day of Ridvan")
1144 (if all-bahai-calendar-holidays
1145 (holiday-fixed 4 22 "Second Day of Ridvan"))
1146 (if all-bahai-calendar-holidays
1147 (holiday-fixed 4 23 "Third Day of Ridvan"))
1148 (if all-bahai-calendar-holidays
1149 (holiday-fixed 4 24 "Fourth Day of Ridvan"))
1150 (if all-bahai-calendar-holidays
1151 (holiday-fixed 4 25 "Fifth Day of Ridvan"))
1152 (if all-bahai-calendar-holidays
1153 (holiday-fixed 4 26 "Sixth Day of Ridvan"))
1154 (if all-bahai-calendar-holidays
1155 (holiday-fixed 4 27 "Seventh Day of Ridvan"))
1156 (if all-bahai-calendar-holidays
1157 (holiday-fixed 4 28 "Eighth Day of Ridvan"))
1158 (holiday-fixed 4 29 "Ninth Day of Ridvan")
1159 (if all-bahai-calendar-holidays
1160 (holiday-fixed 4 30 "Tenth Day of Ridvan"))
1161 (if all-bahai-calendar-holidays
1162 (holiday-fixed 5 1 "Eleventh Day of Ridvan"))
1163 (holiday-fixed 5 2 "Twelfth Day of Ridvan")
1164 (holiday-fixed 5 23 "Declaration of the Bab")
1165 (holiday-fixed 5 29 "Ascension of Baha'u'llah")
1166 (holiday-fixed 7 9 "Martyrdom of the Bab")
1167 (holiday-fixed 10 20 "Birth of the Bab")
1168 (holiday-fixed 11 12 "Birth of Baha'u'llah")
1169 (if all-bahai-calendar-holidays
1170 (holiday-fixed 11 26 "Day of the Covenant"))
1171 (if all-bahai-calendar-holidays
1172 (holiday-fixed 11 28 "Ascension of `Abdu'l-Baha")))
1174 See the documentation for `calendar-holidays' for details."
1179 (put 'solar-holidays 'risky-local-variable t)
1181 (defcustom solar-holidays
1182 '((if (fboundp 'atan)
1183 (solar-equinoxes-solstices))
1189 calendar-daylight-savings-starts
1190 '(format "Daylight Savings Time Begins %s"
1193 (/ calendar-daylight-savings-starts-time (float 60))
1194 calendar-standard-time-zone-name)
1198 calendar-daylight-savings-ends
1199 '(format "Daylight Savings Time Ends %s"
1202 (/ calendar-daylight-savings-ends-time (float 60))
1203 calendar-daylight-time-zone-name)
1205 "*Sun-related holidays.
1206 See the documentation for `calendar-holidays' for details."
1211 (put 'calendar-holidays 'risky-local-variable t)
1212 (defcustom calendar-holidays
1213 (append general-holidays local-holidays other-holidays
1214 christian-holidays hebrew-holidays islamic-holidays
1215 bahai-holidays oriental-holidays solar-holidays)
1216 "*List of notable days for the command \\[holidays].
1218 Additional holidays are easy to add to the list, just put them in the
1219 list `other-holidays' in your .emacs file. Similarly, by setting any
1220 of `general-holidays', `local-holidays' `christian-holidays',
1221 `hebrew-holidays', `islamic-holidays', `bahai-holidays',
1222 `oriental-holidays', or `solar-holidays' to nil in your .emacs file,
1223 you can eliminate unwanted categories of holidays. The intention is
1224 that (in the US) `local-holidays' be set in site-init.el and
1225 `other-holidays' be set by the user.
1227 Entries on the list are expressions that return (possibly empty) lists of
1228 items of the form ((month day year) string) of a holiday in the in the
1229 three-month period centered around `displayed-month' of `displayed-year'.
1230 Several basic functions are provided for this purpose:
1232 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1233 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1234 MONTH on the Gregorian calendar (0 for Sunday,
1235 etc.); K<0 means count back from the end of the
1236 month. An optional parameter DAY means the Kth
1237 DAYNAME after/before MONTH DAY.
1238 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1239 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1240 (holiday-bahai MONTH DAY STRING) a fixed date on the Baha'i calendar
1241 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1242 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
1243 in the variable `year'; if it evaluates to
1244 a visible date, that's the holiday; if it
1245 evaluates to nil, there's no holiday. STRING
1246 is an expression in the variable `date'.
1248 For example, to add Bastille Day, celebrated in France on July 14, add
1250 (holiday-fixed 7 14 \"Bastille Day\")
1252 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1253 Islands on the fourth Monday in August, add
1255 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
1257 to the list (the last Monday would be specified with `-1' instead of `4').
1258 To add the last day of Hanukkah to the list, use
1260 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
1262 since the Hebrew months are numbered with 1 starting from Nisan, while to
1263 add the Islamic feast celebrating Mohammed's birthday use
1265 (holiday-islamic 3 12 \"Mohammed's Birthday\")
1267 since the Islamic months are numbered from 1 starting with Muharram. To
1268 add an entry for the Baha'i festival of Ridvan, use
1270 (holiday-bahai 2 13 \"Festival of Ridvan\")
1272 since the Baha'i months are numbered from 1 starting with Baha. To
1273 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1275 (holiday-julian 4 2 \"Jefferson's Birthday\")
1277 To include a holiday conditionally, use the sexp form or a conditional. For
1278 example, to include American presidential elections, which occur on the first
1279 Tuesday after the first Monday in November of years divisible by 4, add
1282 '(if (zerop (% year 4))
1283 (calendar-gregorian-from-absolute
1284 (1+ (calendar-dayname-on-or-before
1285 1 (+ 6 (calendar-absolute-from-gregorian
1286 (list 11 1 year)))))))
1287 \"US Presidential Election\")
1291 (if (zerop (% displayed-year 4))
1293 (extract-calendar-day
1294 (calendar-gregorian-from-absolute
1295 (1+ (calendar-dayname-on-or-before
1296 1 (+ 6 (calendar-absolute-from-gregorian
1297 (list 11 1 displayed-year)))))))
1298 \"US Presidential Election\"))
1300 to the list. To include the phases of the moon, add
1304 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1305 you've written to return a (possibly empty) list of the relevant VISIBLE dates
1306 with descriptive strings such as
1308 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
1312 (defconst holiday-buffer "*Holidays*"
1313 "Name of the buffer used for the displaying the holidays.")
1315 (defconst fancy-diary-buffer "*Fancy Diary Entries*"
1316 "Name of the buffer used for the optional fancy display of the diary.")
1318 (defconst other-calendars-buffer "*Other Calendars*"
1319 "Name of the buffer used for the display of date on other calendars.")
1321 (defconst lunar-phases-buffer "*Phases of Moon*"
1322 "Name of the buffer used for the lunar phases.")
1324 (defmacro increment-calendar-month (mon yr n)
1325 "Increment the variables MON and YR by N months.
1326 Forward if N is positive or backward if N is negative.
1327 A negative YR is interpreted as BC; -1 being 1 BC, and so on."
1329 (if (< ,yr 0) (setq ,yr (1+ ,yr))) ; -1 BC -> 0 AD, etc
1330 (setq macro-y (+ (* ,yr 12) ,mon -1 ,n)
1331 ,mon (1+ (mod macro-y 12))
1333 (and (< macro-y 0) (> ,mon 1) (setq ,yr (1- ,yr)))
1334 (if (< ,yr 1) (setq ,yr (1- ,yr))))) ; 0 AD -> -1 BC, etc
1336 (defmacro calendar-for-loop (var from init to final do &rest body)
1337 "Execute a for loop."
1338 `(let ((,var (1- ,init)))
1339 (while (>= ,final (setq ,var (1+ ,var)))
1342 (defmacro calendar-sum (index initial condition expression)
1343 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
1344 `(let ((,index ,initial)
1347 (setq sum (+ sum ,expression))
1348 (setq ,index (1+ ,index)))
1351 ;; The following are in-line for speed; they can be called thousands of times
1352 ;; when looking up holidays or processing the diary. Here, for example, are
1353 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1354 ;; fancy diary display, for a moderately complex diary file, with functions
1355 ;; used instead of macros. There were a total of 10000 such calls:
1357 ;; 1934 extract-calendar-month
1358 ;; 1852 extract-calendar-year
1359 ;; 1819 extract-calendar-day
1360 ;; 845 calendar-leap-year-p
1361 ;; 837 calendar-day-number
1362 ;; 775 calendar-absolute-from-gregorian
1363 ;; 346 calendar-last-day-of-month
1364 ;; 286 hebrew-calendar-last-day-of-month
1365 ;; 188 hebrew-calendar-leap-year-p
1366 ;; 180 hebrew-calendar-elapsed-days
1367 ;; 163 hebrew-calendar-last-month-of-year
1368 ;; 66 calendar-date-compare
1369 ;; 65 hebrew-calendar-days-in-year
1370 ;; 60 calendar-absolute-from-julian
1371 ;; 50 calendar-absolute-from-hebrew
1372 ;; 43 calendar-date-equal
1373 ;; 38 calendar-gregorian-from-absolute
1378 ;; The use of these seven macros eliminates the overhead of 92% of the function
1379 ;; calls; it's faster this way.
1381 (defsubst extract-calendar-month (date)
1382 "Extract the month part of DATE which has the form (month day year)."
1385 (defsubst extract-calendar-day (date)
1386 "Extract the day part of DATE which has the form (month day year)."
1389 (defsubst extract-calendar-year (date)
1390 "Extract the year part of DATE which has the form (month day year)."
1391 (car (cdr (cdr date))))
1393 (defsubst calendar-leap-year-p (year)
1394 "Return t if YEAR is a Gregorian leap year.
1395 A negative year is interpreted as BC; -1 being 1 BC, and so on."
1396 ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc.
1397 (if (< year 0) (setq year (1- (abs year))))
1398 (and (zerop (% year 4))
1399 (or (not (zerop (% year 100)))
1400 (zerop (% year 400)))))
1402 ;; The foregoing is a bit faster, but not as clear as the following:
1404 ;;(defsubst calendar-leap-year-p (year)
1405 ;; "Returns t if YEAR is a Gregorian leap year."
1407 ;; (and (= (% year 4) 0)
1408 ;; (/= (% year 100) 0))
1409 ;; (= (% year 400) 0)))
1411 (defsubst calendar-last-day-of-month (month year)
1412 "The last day in MONTH during YEAR."
1413 (if (and (= month 2) (calendar-leap-year-p year))
1415 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1417 ;; An explanation of the calculation can be found in PascAlgorithms by
1418 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1420 (defsubst calendar-day-number (date)
1421 "Return the day number within the year of the date DATE.
1422 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1423 while (calendar-day-number '(12 31 1980)) returns 366."
1424 (let* ((month (extract-calendar-month date))
1425 (day (extract-calendar-day date))
1426 (year (extract-calendar-year date))
1427 (day-of-year (+ day (* 31 (1- month)))))
1430 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1431 (if (calendar-leap-year-p year)
1432 (setq day-of-year (1+ day-of-year)))))
1435 (defsubst calendar-absolute-from-gregorian (date)
1436 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1437 The Gregorian date Sunday, December 31, 1 BC is imaginary.
1438 DATE is a list of the form (month day year). A negative year is
1439 interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC
1440 return negative results."
1441 (let ((year (extract-calendar-year date))
1444 (error "There was no year zero"))
1446 (setq offset-years (1- year))
1447 (+ (calendar-day-number date) ; Days this year
1448 (* 365 offset-years) ; + Days in prior years
1449 (/ offset-years 4) ; + Julian leap years
1450 (- (/ offset-years 100)) ; - century years
1451 (/ offset-years 400))) ; + Gregorian leap years
1453 ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc).
1454 (setq offset-years (abs (1+ year)))
1455 (- (calendar-day-number date)
1456 (* 365 offset-years)
1458 (- (/ offset-years 100))
1459 (/ offset-years 400)
1460 (calendar-day-number '(12 31 -1))))))) ; days in year 1 BC
1462 (autoload 'calendar-goto-today "cal-move"
1463 "Reposition the calendar window so the current date is visible."
1466 (autoload 'calendar-forward-month "cal-move"
1467 "Move the cursor forward ARG months."
1470 (autoload 'calendar-forward-year "cal-move"
1471 "Move the cursor forward by ARG years."
1474 (autoload 'calendar-backward-month "cal-move"
1475 "Move the cursor backward by ARG months."
1478 (autoload 'calendar-backward-year "cal-move"
1479 "Move the cursor backward ARG years."
1482 (autoload 'scroll-calendar-left "cal-move"
1483 "Scroll the displayed calendar left by ARG months."
1486 (autoload 'scroll-calendar-right "cal-move"
1487 "Scroll the displayed calendar window right by ARG months."
1490 (autoload 'scroll-calendar-left-three-months "cal-move"
1491 "Scroll the displayed calendar window left by 3*ARG months."
1494 (autoload 'scroll-calendar-right-three-months "cal-move"
1495 "Scroll the displayed calendar window right by 3*ARG months."
1498 (autoload 'calendar-cursor-to-nearest-date "cal-move"
1499 "Move the cursor to the closest date."
1502 (autoload 'calendar-forward-day "cal-move"
1503 "Move the cursor forward ARG days."
1506 (autoload 'calendar-backward-day "cal-move"
1507 "Move the cursor back ARG days."
1510 (autoload 'calendar-forward-week "cal-move"
1511 "Move the cursor forward ARG weeks."
1514 (autoload 'calendar-backward-week "cal-move"
1515 "Move the cursor back ARG weeks."
1518 (autoload 'calendar-beginning-of-week "cal-move"
1519 "Move the cursor back ARG calendar-week-start-day's."
1522 (autoload 'calendar-end-of-week "cal-move"
1523 "Move the cursor forward ARG calendar-week-start-day+6's."
1526 (autoload 'calendar-beginning-of-month "cal-move"
1527 "Move the cursor backward ARG month beginnings."
1530 (autoload 'calendar-end-of-month "cal-move"
1531 "Move the cursor forward ARG month ends."
1534 (autoload 'calendar-beginning-of-year "cal-move"
1535 "Move the cursor backward ARG year beginnings."
1538 (autoload 'calendar-end-of-year "cal-move"
1539 "Move the cursor forward ARG year beginnings."
1542 (autoload 'calendar-cursor-to-visible-date "cal-move"
1543 "Move the cursor to DATE that is on the screen."
1546 (autoload 'calendar-goto-date "cal-move"
1547 "Move cursor to DATE."
1550 (autoload 'calendar-goto-day-of-year "cal-move"
1551 "Move cursor to day of year."
1554 (autoload 'calendar-only-one-frame-setup "cal-x"
1555 "Start calendar and display it in a dedicated frame.")
1557 (autoload 'calendar-one-frame-setup "cal-x"
1558 "Start calendar and display it in a dedicated frame together with the diary.")
1560 (autoload 'calendar-two-frame-setup "cal-x"
1561 "Start calendar and diary in separate, dedicated frames.")
1564 (defcustom calendar-setup nil
1565 "The frame setup of the calendar.
1566 The choices are: `one-frame' (calendar and diary together in one separate,
1567 dedicated frame); `two-frames' (calendar and diary in separate, dedicated
1568 frames); `calendar-only' (calendar in a separate, dedicated frame); with
1569 any other value the current frame is used. Using any of the first
1570 three options overrides the value of `view-diary-entries-initially'."
1572 (const :tag "calendar and diary in separate frame" one-frame)
1573 (const :tag "calendar and diary each in own frame" two-frames)
1574 (const :tag "calendar in separate frame" calendar-only)
1575 (const :tag "use current frame" nil))
1578 (defcustom calendar-minimum-window-height 8
1579 "Minimum height `generate-calendar-window' should use for calendar window."
1585 (defun calendar (&optional arg)
1586 "Choose between the one frame, two frame, or basic calendar displays.
1587 If called with an optional prefix argument, prompts for month and year.
1589 The original function `calendar' has been renamed `calendar-basic-setup'.
1590 See the documentation of that function for more information."
1592 (cond ((equal calendar-setup 'one-frame) (calendar-one-frame-setup arg))
1593 ((equal calendar-setup 'two-frames) (calendar-two-frame-setup arg))
1594 ((equal calendar-setup 'calendar-only)
1595 (calendar-only-one-frame-setup arg))
1596 (t (calendar-basic-setup arg))))
1598 (defun calendar-basic-setup (&optional arg)
1599 "Display a three-month calendar in another window.
1600 The three months appear side by side, with the current month in the middle
1601 surrounded by the previous and next months. The cursor is put on today's date.
1603 If called with an optional prefix argument, prompts for month and year.
1605 This function is suitable for execution in a .emacs file; appropriate setting
1606 of the variable `view-diary-entries-initially' will cause the diary entries for
1607 the current date to be displayed in another window. The value of the variable
1608 `number-of-diary-entries' controls the number of days of diary entries
1609 displayed upon initial display of the calendar.
1611 Once in the calendar window, future or past months can be moved into view.
1612 Arbitrary months can be displayed, or the calendar can be scrolled forward
1615 The cursor can be moved forward or backward by one day, one week, one month,
1616 or one year. All of these commands take prefix arguments which, when negative,
1617 cause movement in the opposite direction. For convenience, the digit keys
1618 and the minus sign are automatically prefixes. The window is replotted as
1619 necessary to display the desired date.
1621 Diary entries can be marked on the calendar or displayed in another window.
1623 Use \\[describe-mode] for details of the key bindings in the calendar window.
1625 The Gregorian calendar is assumed.
1627 After loading the calendar, the hooks given by the variable
1628 `calendar-load-hook' are run. This is the place to add key bindings to the
1631 After preparing the calendar window initially, the hooks given by the variable
1632 `initial-calendar-window-hook' are run.
1634 The hooks given by the variable `today-visible-calendar-hook' are run
1635 every time the calendar window gets scrolled, if the current date is visible
1636 in the window. If it is not visible, the hooks given by the variable
1637 `today-invisible-calendar-hook' are run. Thus, for example, setting
1638 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1639 to be replaced by asterisks to highlight it whenever it is in the window."
1641 (set-buffer (get-buffer-create calendar-buffer))
1643 (let* ((pop-up-windows t)
1644 (split-height-threshold 1000)
1646 (calendar-read-date t)
1647 (calendar-current-date)))
1648 (month (extract-calendar-month date))
1649 (year (extract-calendar-year date)))
1650 (pop-to-buffer calendar-buffer)
1651 (increment-calendar-month month year (- calendar-offset))
1652 (generate-calendar-window month year)
1653 (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
1655 (if (vectorp number-of-diary-entries)
1656 (aref number-of-diary-entries (calendar-day-of-week date))
1657 number-of-diary-entries))))
1658 (let* ((diary-buffer (get-file-buffer diary-file))
1659 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1660 (split-height-threshold (if diary-window 2 1000)))
1661 (if view-calendar-holidays-initially
1662 (list-calendar-holidays)))
1663 (run-hooks 'initial-calendar-window-hook))
1665 (autoload 'view-diary-entries "diary-lib"
1666 "Prepare and display a buffer with diary entries.
1667 Searches your diary file for entries that match ARG days starting with
1668 the date indicated by the cursor position in the displayed three-month
1672 (autoload 'view-other-diary-entries "diary-lib"
1673 "Prepare and display buffer of diary entries from an alternative diary file.
1674 Searches for entries that match ARG days, starting with the date indicated
1675 by the cursor position in the displayed three-month calendar.
1676 D-FILE specifies the file to use as the diary file."
1679 (autoload 'calendar-sunrise-sunset "solar"
1680 "Local time of sunrise and sunset for date under cursor."
1683 (autoload 'calendar-phases-of-moon "lunar"
1684 "Create a buffer of the phases of the moon for the current calendar window."
1687 (autoload 'calendar-print-french-date "cal-french"
1688 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1691 (autoload 'calendar-goto-french-date "cal-french"
1692 "Move cursor to French Revolutionary date."
1695 (autoload 'calendar-french-date-string "cal-french"
1696 "String of French Revolutionary date of Gregorian date."
1699 (autoload 'calendar-mayan-date-string "cal-mayan"
1700 "String of Mayan date of Gregorian date."
1703 (autoload 'calendar-print-mayan-date "cal-mayan"
1704 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1707 (autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
1708 "Move cursor to Mayan long count date."
1711 (autoload 'calendar-next-haab-date "cal-mayan"
1712 "Move cursor to next instance of Mayan Haab date."
1715 (autoload 'calendar-previous-haab-date "cal-mayan"
1716 "Move cursor to previous instance of Mayan Haab date."
1719 (autoload 'calendar-next-tzolkin-date "cal-mayan"
1720 "Move cursor to next instance of Mayan Tzolkin date."
1723 (autoload 'calendar-previous-tzolkin-date "cal-mayan"
1724 "Move cursor to previous instance of Mayan Tzolkin date."
1727 (autoload 'calendar-next-calendar-round-date "cal-mayan"
1728 "Move cursor to next instance of Mayan Haab/Tzolkin combination."
1731 (autoload 'calendar-previous-calendar-round-date "cal-mayan"
1732 "Move cursor to previous instance of Mayan Haab/Tzolkin combination."
1735 (autoload 'calendar-goto-chinese-date "cal-china"
1736 "Move cursor to Chinese date."
1739 (autoload 'calendar-print-chinese-date "cal-china"
1740 "Show the Chinese date equivalents of date."
1743 (autoload 'calendar-chinese-date-string "cal-china"
1744 "String of Chinese date of Gregorian date."
1747 (autoload 'calendar-absolute-from-astro "cal-julian"
1748 "Absolute date of astronomical (Julian) day number D."
1751 (autoload 'calendar-astro-from-absolute "cal-julian"
1752 "Astronomical (Julian) day number of absolute date D.")
1754 (autoload 'calendar-astro-date-string "cal-julian"
1755 "String of astronomical (Julian) day number of Gregorian date."
1758 (autoload 'calendar-goto-astro-day-number "cal-julian"
1759 "Move cursor to astronomical (Julian) day number."
1762 (autoload 'calendar-print-astro-day-number "cal-julian"
1763 "Show the astro date equivalents of date."
1766 (autoload 'calendar-julian-from-absolute "cal-julian"
1767 "Compute the Julian (month day year) corresponding to the absolute DATE.
1768 The absolute date is the number of days elapsed since the (imaginary)
1769 Gregorian date Sunday, December 31, 1 BC.")
1771 (autoload 'calendar-goto-julian-date "cal-julian"
1772 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1775 (autoload 'calendar-print-julian-date "cal-julian"
1776 "Show the Julian calendar equivalent of the date under the cursor."
1779 (autoload 'calendar-julian-date-string "cal-julian"
1780 "String of Julian date of Gregorian DATE.
1781 Defaults to today's date if DATE is not given.
1782 Driven by the variable `calendar-date-display-form'.")
1784 (autoload 'calendar-goto-iso-date "cal-iso"
1785 "Move cursor to ISO date."
1788 (autoload 'calendar-goto-iso-week "cal-iso"
1789 "Move cursor to start of ISO week."
1792 (autoload 'calendar-print-iso-date "cal-iso"
1793 "Show the ISO date equivalents of date."
1796 (autoload 'calendar-iso-date-string "cal-iso"
1797 "String of ISO date of Gregorian date."
1800 (autoload 'calendar-goto-islamic-date "cal-islam"
1801 "Move cursor to Islamic date."
1804 (autoload 'calendar-print-islamic-date "cal-islam"
1805 "Show the Islamic date equivalents of date."
1808 (autoload 'calendar-islamic-date-string "cal-islam"
1809 "String of Islamic date of Gregorian date."
1812 (autoload 'calendar-print-bahai-date "cal-bahai"
1813 "Show the Baha'i date equivalents of date."
1816 (autoload 'calendar-bahai-date-string "cal-bahai"
1817 "String of Baha'i date of Gregorian date."
1820 (autoload 'calendar-goto-hebrew-date "cal-hebrew"
1821 "Move cursor to Hebrew date."
1824 (autoload 'calendar-print-hebrew-date "cal-hebrew"
1825 "Show the Hebrew date equivalents of date."
1828 (autoload 'calendar-hebrew-date-string "cal-hebrew"
1829 "String of Hebrew date of Gregorian date."
1832 (autoload 'calendar-goto-coptic-date "cal-coptic"
1833 "Move cursor to Coptic date."
1836 (autoload 'calendar-print-coptic-date "cal-coptic"
1837 "Show the Coptic date equivalents of date."
1840 (autoload 'calendar-coptic-date-string "cal-coptic"
1841 "String of Coptic date of Gregorian date."
1844 (autoload 'calendar-goto-ethiopic-date "cal-coptic"
1845 "Move cursor to Ethiopic date."
1848 (autoload 'calendar-print-ethiopic-date "cal-coptic"
1849 "Show the Ethiopic date equivalents of date."
1852 (autoload 'calendar-ethiopic-date-string "cal-coptic"
1853 "String of Ethiopic date of Gregorian date."
1856 (autoload 'calendar-goto-persian-date "cal-persia"
1857 "Move cursor to Persian date."
1860 (autoload 'calendar-print-persian-date "cal-persia"
1861 "Show the Persian date equivalents of date."
1864 (autoload 'calendar-persian-date-string "cal-persia"
1865 "String of Persian date of Gregorian date."
1868 (autoload 'show-all-diary-entries "diary-lib"
1869 "Show all of the diary entries in the diary file.
1870 This function gets rid of the selective display of the diary file so that
1871 all entries, not just some, are visible. If there is no diary buffer, one
1875 (autoload 'mark-diary-entries "diary-lib"
1876 "Mark days in the calendar window that have diary entries.
1877 Each entry in diary file visible in the calendar window is marked."
1880 (autoload 'make-diary-entry "diary-lib"
1881 "Insert a diary entry STRING which may be NONMARKING in FILE."
1884 (autoload 'insert-diary-entry "diary-lib"
1885 "Insert a diary entry for the date indicated by point."
1888 (autoload 'insert-weekly-diary-entry "diary-lib"
1889 "Insert a weekly diary entry for the day of the week indicated by point."
1893 (autoload 'insert-monthly-diary-entry "diary-lib"
1894 "Insert a monthly diary entry for the day of the month indicated by point."
1897 (autoload 'insert-yearly-diary-entry "diary-lib"
1898 "Insert an annual diary entry for the day of the year indicated by point."
1901 (autoload 'insert-anniversary-diary-entry "diary-lib"
1902 "Insert an anniversary diary entry for the date indicated by point."
1905 (autoload 'insert-block-diary-entry "diary-lib"
1906 "Insert a block diary entry for the dates indicated by point and mark."
1909 (autoload 'insert-cyclic-diary-entry "diary-lib"
1910 "Insert a cyclic diary entry starting at the date indicated by point."
1913 (autoload 'insert-hebrew-diary-entry "cal-hebrew"
1914 "Insert a diary entry for the Hebrew date corresponding to the date
1915 indicated by point."
1918 (autoload 'insert-monthly-hebrew-diary-entry "cal-hebrew"
1919 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1920 to the date indicated by point."
1923 (autoload 'insert-yearly-hebrew-diary-entry "cal-hebrew"
1924 "Insert an annual diary entry for the day of the Hebrew year corresponding
1925 to the date indicated by point."
1928 (autoload 'insert-islamic-diary-entry "cal-islam"
1929 "Insert a diary entry for the Islamic date corresponding to the date
1930 indicated by point."
1933 (autoload 'insert-monthly-islamic-diary-entry "cal-islam"
1934 "Insert a monthly diary entry for the day of the Islamic month corresponding
1935 to the date indicated by point."
1938 (autoload 'insert-yearly-islamic-diary-entry "cal-islam"
1939 "Insert an annual diary entry for the day of the Islamic year corresponding
1940 to the date indicated by point."
1943 (autoload 'insert-bahai-diary-entry "cal-bahai"
1944 "Insert a diary entry for the Baha'i date corresponding to the date
1945 indicated by point."
1948 (autoload 'insert-monthly-bahai-diary-entry "cal-bahai"
1949 "Insert a monthly diary entry for the day of the Baha'i month corresponding
1950 to the date indicated by point."
1953 (autoload 'insert-yearly-bahai-diary-entry "cal-bahai"
1954 "Insert an annual diary entry for the day of the Baha'i year corresponding
1955 to the date indicated by point."
1958 (autoload 'list-calendar-holidays "holidays"
1959 "Create a buffer containing the holidays for the current calendar window.
1960 The holidays are those in the list `calendar-notable-days'. Returns t if any
1961 holidays are found, nil if not."
1964 (autoload 'cal-tex-cursor-month "cal-tex"
1965 "Make a buffer with LaTeX commands for the month cursor is on.
1966 Optional prefix argument specifies number of months to be produced.
1967 Calendar is condensed onto one page.")
1969 (autoload 'cal-tex-cursor-month-landscape "cal-tex"
1970 "Make a buffer with LaTeX commands for the month cursor is on.
1971 Optional prefix argument specifies number of months to be produced.")
1973 (autoload 'cal-tex-cursor-day "cal-tex"
1974 "Make a buffer with LaTeX commands for the day cursor is on.")
1976 (autoload 'cal-tex-cursor-week "cal-tex"
1977 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1978 It applies to the week that point is in.
1979 Optional prefix argument specifies number of weeks.
1980 Holidays are included if `cal-tex-holidays' is t.")
1982 (autoload 'cal-tex-cursor-week2 "cal-tex"
1983 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1984 It applies to the week that point is in.
1985 Optional prefix argument specifies number of weeks.
1986 Holidays are included if `cal-tex-holidays' is t.")
1988 (autoload 'cal-tex-cursor-week-iso "cal-tex"
1989 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
1990 Optional prefix argument specifies number of weeks.
1991 Diary entries are included if `cal-tex-diary' is t.
1992 Holidays are included if `cal-tex-holidays' is t.")
1994 (autoload 'cal-tex-cursor-week-monday "cal-tex"
1995 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1996 It applies to the week that point is in, and starts on Monday.
1997 Optional prefix argument specifies number of weeks.
1998 Holidays are included if `cal-tex-holidays' is t.")
2000 (autoload 'cal-tex-cursor-filofax-2week "cal-tex"
2001 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
2002 Optional prefix argument specifies number of weeks.
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-week "cal-tex"
2007 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
2008 Optional prefix argument specifies number of weeks.
2009 Weeks start on Monday.
2010 Diary entries are included if cal-tex-diary is t.
2011 Holidays are included if `cal-tex-holidays' is t.")
2013 (autoload 'cal-tex-cursor-filofax-daily "cal-tex"
2014 "Day-per-page Filofax style calendar for week indicated by cursor.
2015 Optional prefix argument specifies number of weeks. Weeks start on Monday.
2016 Diary entries are included if `cal-tex-diary' is t.
2017 Holidays are included if `cal-tex-holidays' is t.")
2019 (autoload 'cal-tex-cursor-year "cal-tex"
2020 "Make a buffer with LaTeX commands for a year's calendar.
2021 Optional prefix argument specifies number of years.")
2023 (autoload 'cal-tex-cursor-year-landscape "cal-tex"
2024 "Make a buffer with LaTeX commands for a year's calendar (landscape).
2025 Optional prefix argument specifies number of years.")
2027 (autoload 'cal-tex-cursor-filofax-year "cal-tex"
2028 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
2029 Optional prefix argument specifies number of years.")
2031 (autoload 'mark-calendar-holidays "holidays"
2032 "Mark notable days in the calendar window."
2035 (autoload 'calendar-cursor-holidays "holidays"
2036 "Find holidays for the date specified by the cursor in the calendar window."
2039 (defun generate-calendar-window (&optional mon yr)
2040 "Generate the calendar window for the current date.
2041 Or, for optional MON, YR."
2042 (let* ((buffer-read-only nil)
2043 (today (calendar-current-date))
2044 (month (extract-calendar-month today))
2045 (day (extract-calendar-day today))
2046 (year (extract-calendar-year today))
2049 (let ((offset (calendar-interval mon yr month year)))
2050 (and (<= offset 1) (>= offset -1)))))
2051 (day-in-week (calendar-day-of-week today))
2052 (in-calendar-window (eq (window-buffer (selected-window))
2053 (get-buffer calendar-buffer))))
2054 (update-calendar-mode-line)
2056 (generate-calendar mon yr)
2057 (generate-calendar month year))
2058 (calendar-cursor-to-visible-date
2059 (if today-visible today (list displayed-month 1 displayed-year)))
2060 (set-buffer-modified-p nil)
2061 ;; Don't do any window-related stuff if we weren't called from a
2062 ;; window displaying the calendar
2063 (when in-calendar-window
2064 (if (or (one-window-p t) (/= (frame-width) (window-width)))
2065 ;; Don't mess with the window size, but ensure that the first
2066 ;; line is fully visible
2067 (set-window-vscroll nil 0)
2068 ;; Adjust the window to exactly fit the displayed calendar
2069 (fit-window-to-buffer nil nil calendar-minimum-window-height))
2071 (if (and (boundp 'font-lock-mode)
2073 (font-lock-fontify-buffer))
2074 (and mark-holidays-in-calendar
2075 ;;; (calendar-date-is-legal-p today) ; useful for BC dates
2076 (mark-calendar-holidays)
2077 (and in-calendar-window (sit-for 0)))
2079 (if mark-diary-entries-in-calendar (mark-diary-entries))
2081 (run-hooks 'today-visible-calendar-hook)
2082 (run-hooks 'today-invisible-calendar-hook)))))
2084 (defun generate-calendar (month year)
2085 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
2086 ;;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on.
2087 ;;; Note that while calendars for years BC could be displayed as it
2088 ;;; stands, almost all other calendar functions (eg holidays) would
2089 ;;; at best have unpredictable results for such dates.
2090 (if (< (+ month (* 12 (1- year))) 2)
2091 (error "Months before January, 1 AD cannot be displayed"))
2092 (setq displayed-month month
2093 displayed-year year)
2095 (increment-calendar-month month year -1)
2096 (calendar-for-loop i from 0 to 2 do
2097 (generate-calendar-month month year (+ 5 (* 25 i)))
2098 (increment-calendar-month month year 1)))
2100 (defun generate-calendar-month (month year indent)
2101 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
2102 The calendar is inserted at the top of the buffer in which point is currently
2103 located, but indented INDENT spaces. The indentation is done from the first
2104 character on the line and does not disturb the first INDENT characters on the
2106 (let* ((blank-days;; at start of month
2108 (- (calendar-day-of-week (list month 1 year))
2109 calendar-week-start-day)
2111 (last (calendar-last-day-of-month month year)))
2112 (goto-char (point-min))
2113 (calendar-insert-indented
2114 (calendar-string-spread
2115 (list (format "%s %d" (calendar-month-name month) year)) ? 20)
2117 (calendar-insert-indented "" indent);; Go to proper spot
2118 ;; Use the first two characters of each day to head the columns.
2119 (calendar-for-loop i from 0 to 6 do
2122 (calendar-day-name (mod (+ calendar-week-start-day i) 7) nil t)))
2123 (if enable-multibyte-characters
2124 (truncate-string-to-width string 2)
2125 (substring string 0 2)))
2127 (calendar-insert-indented "" 0 t);; Force onto following line
2128 (calendar-insert-indented "" indent);; Go to proper spot
2129 ;; Add blank days before the first of the month
2130 (calendar-for-loop i from 1 to blank-days do (insert " "))
2131 ;; Put in the days of the month
2132 (calendar-for-loop i from 1 to last do
2133 (insert (format "%2d " i))
2134 (add-text-properties
2135 (- (point) 3) (1- (point))
2136 '(mouse-face highlight
2137 help-echo "mouse-2: menu of operations for this date"))
2138 (and (zerop (mod (+ i blank-days) 7))
2140 (calendar-insert-indented "" 0 t) ;; Force onto following line
2141 (calendar-insert-indented "" indent)))));; Go to proper spot
2143 (defun calendar-insert-indented (string indent &optional newline)
2144 "Insert STRING at column INDENT.
2145 If the optional parameter NEWLINE is t, leave point at start of next line,
2146 inserting a newline if there was no next line; otherwise, leave point after
2147 the inserted text. Value is always t."
2148 ;; Try to move to that column.
2149 (move-to-column indent)
2150 ;; If line is too short, indent out to that column.
2151 (if (< (current-column) indent)
2154 ;; Advance to next line, if requested.
2163 (defun redraw-calendar ()
2164 "Redraw the calendar display, if `calendar-buffer' is live."
2166 (if (get-buffer calendar-buffer)
2167 (with-current-buffer calendar-buffer
2168 (let ((cursor-date (calendar-cursor-to-nearest-date)))
2169 (generate-calendar-window displayed-month displayed-year)
2170 (calendar-cursor-to-visible-date cursor-date)))))
2173 (defcustom calendar-week-start-day 0
2174 "*The day of the week on which a week in the calendar begins.
2175 0 means Sunday (default), 1 means Monday, and so on.
2177 If you change this variable directly (without using customize)
2178 after starting `calendar', you should call `redraw-calendar' to
2179 update the calendar display to reflect the change, otherwise
2180 movement commands will not work correctly."
2182 :set (lambda (sym val)
2187 (defcustom calendar-debug-sexp nil
2188 "*Turn debugging on when evaluating a sexp in the diary or holiday list."
2192 (defvar calendar-mode-map nil)
2193 (if calendar-mode-map
2195 (setq calendar-mode-map (make-sparse-keymap))
2197 (calendar-for-loop i from 0 to 9 do
2198 (define-key calendar-mode-map (int-to-string i) 'digit-argument))
2199 (let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph
2200 'mark-defun 'mark-whole-buffer 'mark-page
2201 'downcase-region 'upcase-region 'kill-region
2202 'copy-region-as-kill 'capitalize-region 'write-region)))
2204 (substitute-key-definition (car l) 'calendar-not-implemented
2205 calendar-mode-map global-map)
2207 (define-key calendar-mode-map "-" 'negative-argument)
2208 (define-key calendar-mode-map ">" 'scroll-calendar-right)
2209 (define-key calendar-mode-map "\C-x>" 'scroll-calendar-right)
2210 (define-key calendar-mode-map [prior] 'scroll-calendar-right-three-months)
2211 (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
2212 (define-key calendar-mode-map "<" 'scroll-calendar-left)
2213 (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
2214 (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
2215 (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
2216 (define-key calendar-mode-map "\C-b" 'calendar-backward-day)
2217 (define-key calendar-mode-map "\C-p" 'calendar-backward-week)
2218 (define-key calendar-mode-map "\e{" 'calendar-backward-month)
2219 (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
2220 (define-key calendar-mode-map "\C-f" 'calendar-forward-day)
2221 (define-key calendar-mode-map "\C-n" 'calendar-forward-week)
2222 (define-key calendar-mode-map [left] 'calendar-backward-day)
2223 (define-key calendar-mode-map [up] 'calendar-backward-week)
2224 (define-key calendar-mode-map [right] 'calendar-forward-day)
2225 (define-key calendar-mode-map [down] 'calendar-forward-week)
2226 (define-key calendar-mode-map "\e}" 'calendar-forward-month)
2227 (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
2228 (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
2229 (define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
2230 (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month)
2231 (define-key calendar-mode-map "\ee" 'calendar-end-of-month)
2232 (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
2233 (define-key calendar-mode-map "\e>" 'calendar-end-of-year)
2234 (define-key calendar-mode-map "\C-@" 'calendar-set-mark)
2235 ;; Many people are used to typing C-SPC and getting C-@.
2236 (define-key calendar-mode-map [?\C- ] 'calendar-set-mark)
2237 (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
2238 (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
2239 (define-key calendar-mode-map "gd" 'calendar-goto-date)
2240 (define-key calendar-mode-map "gD" 'calendar-goto-day-of-year)
2241 (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
2242 (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
2243 (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
2244 (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
2245 (define-key calendar-mode-map "gb" 'calendar-goto-bahai-date)
2246 (define-key calendar-mode-map "gC" 'calendar-goto-chinese-date)
2247 (define-key calendar-mode-map "gk" 'calendar-goto-coptic-date)
2248 (define-key calendar-mode-map "ge" 'calendar-goto-ethiopic-date)
2249 (define-key calendar-mode-map "gp" 'calendar-goto-persian-date)
2250 (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
2251 (define-key calendar-mode-map "gw" 'calendar-goto-iso-week)
2252 (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
2253 (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
2254 (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
2255 (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
2256 (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
2257 (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
2258 (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
2259 (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
2260 (define-key calendar-mode-map "Aa" 'appt-add)
2261 (define-key calendar-mode-map "Ad" 'appt-delete)
2262 (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
2263 (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
2264 (define-key calendar-mode-map " " 'scroll-other-window)
2265 (define-key calendar-mode-map (kbd "DEL") 'scroll-other-window-down)
2266 (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
2267 (define-key calendar-mode-map "." 'calendar-goto-today)
2268 (define-key calendar-mode-map "o" 'calendar-other-month)
2269 (define-key calendar-mode-map "q" 'exit-calendar)
2270 (define-key calendar-mode-map "a" 'list-calendar-holidays)
2271 (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
2272 (define-key calendar-mode-map "x" 'mark-calendar-holidays)
2273 (define-key calendar-mode-map "u" 'calendar-unmark)
2274 (define-key calendar-mode-map "m" 'mark-diary-entries)
2275 (define-key calendar-mode-map "d" 'view-diary-entries)
2276 (define-key calendar-mode-map "D" 'view-other-diary-entries)
2277 (define-key calendar-mode-map "s" 'show-all-diary-entries)
2278 (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
2279 (define-key calendar-mode-map "pC" 'calendar-print-chinese-date)
2280 (define-key calendar-mode-map "pk" 'calendar-print-coptic-date)
2281 (define-key calendar-mode-map "pe" 'calendar-print-ethiopic-date)
2282 (define-key calendar-mode-map "pp" 'calendar-print-persian-date)
2283 (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
2284 (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
2285 (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
2286 (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
2287 (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
2288 (define-key calendar-mode-map "pb" 'calendar-print-bahai-date)
2289 (define-key calendar-mode-map "pf" 'calendar-print-french-date)
2290 (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
2291 (define-key calendar-mode-map "po" 'calendar-print-other-dates)
2292 (define-key calendar-mode-map "id" 'insert-diary-entry)
2293 (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
2294 (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
2295 (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
2296 (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
2297 (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
2298 (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
2299 (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
2300 (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
2301 (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
2302 (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
2303 (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
2304 (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
2305 (define-key calendar-mode-map "iBd" 'insert-bahai-diary-entry)
2306 (define-key calendar-mode-map "iBm" 'insert-monthly-bahai-diary-entry)
2307 (define-key calendar-mode-map "iBy" 'insert-yearly-bahai-diary-entry)
2308 (define-key calendar-mode-map "?" 'calendar-goto-info-node)
2309 (define-key calendar-mode-map "tm" 'cal-tex-cursor-month)
2310 (define-key calendar-mode-map "tM" 'cal-tex-cursor-month-landscape)
2311 (define-key calendar-mode-map "td" 'cal-tex-cursor-day)
2312 (define-key calendar-mode-map "tw1" 'cal-tex-cursor-week)
2313 (define-key calendar-mode-map "tw2" 'cal-tex-cursor-week2)
2314 (define-key calendar-mode-map "tw3" 'cal-tex-cursor-week-iso)
2315 (define-key calendar-mode-map "tw4" 'cal-tex-cursor-week-monday)
2316 (define-key calendar-mode-map "tfd" 'cal-tex-cursor-filofax-daily)
2317 (define-key calendar-mode-map "tfw" 'cal-tex-cursor-filofax-2week)
2318 (define-key calendar-mode-map "tfW" 'cal-tex-cursor-filofax-week)
2319 (define-key calendar-mode-map "tfy" 'cal-tex-cursor-filofax-year)
2320 (define-key calendar-mode-map "ty" 'cal-tex-cursor-year)
2321 (define-key calendar-mode-map "tY" 'cal-tex-cursor-year-landscape))
2323 (defun describe-calendar-mode ()
2324 "Create a help buffer with a brief description of the `calendar-mode'."
2326 (with-output-to-temp-buffer "*Help*"
2329 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
2330 (substitute-command-keys
2331 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
2332 (substitute-command-keys "\\{calendar-mode-map}")))
2334 (set-buffer standard-output)
2336 (print-help-return-message)))
2338 ;; Calendar mode is suitable only for specially formatted data.
2339 (put 'calendar-mode 'mode-class 'special)
2341 (defvar calendar-mode-line-format
2343 (propertize (substitute-command-keys
2344 "\\<calendar-mode-map>\\[scroll-calendar-left]")
2345 'help-echo "mouse-2: scroll left"
2346 'mouse-face 'mode-line-highlight
2347 'keymap (make-mode-line-mouse-map 'mouse-2
2348 'mouse-scroll-calendar-left))
2352 (substitute-command-keys
2353 "\\<calendar-mode-map>\\[calendar-goto-info-node] info")
2354 'help-echo "mouse-2: read Info on Calendar"
2355 'mouse-face 'mode-line-highlight
2356 'keymap (make-mode-line-mouse-map 'mouse-2 'calendar-goto-info-node))
2359 (substitute-command-keys
2360 "\\<calendar-mode-map>\\[calendar-other-month] other")
2361 'help-echo "mouse-2: choose another month"
2362 'mouse-face 'mode-line-highlight
2363 'keymap (make-mode-line-mouse-map
2364 'mouse-2 'mouse-calendar-other-month))
2367 (substitute-command-keys
2368 "\\<calendar-mode-map>\\[calendar-goto-today] today")
2369 'help-echo "mouse-2: go to today's date"
2370 'mouse-face 'mode-line-highlight
2371 'keymap (make-mode-line-mouse-map 'mouse-2 #'calendar-goto-today)))
2372 '(calendar-date-string (calendar-current-date) t)
2373 (propertize (substitute-command-keys
2374 "\\<calendar-mode-map>\\[scroll-calendar-right]")
2375 'help-echo "mouse-2: scroll right"
2376 'mouse-face 'mode-line-highlight
2377 'keymap (make-mode-line-mouse-map
2378 'mouse-2 'mouse-scroll-calendar-right)))
2379 "The mode line of the calendar buffer.
2381 This must be a list of items that evaluate to strings--those strings are
2382 evaluated and concatenated together, evenly separated by blanks. The variable
2383 `date' is available for use as the date under (or near) the cursor; `date'
2384 defaults to the current date if it is otherwise undefined. Here is an example
2385 value that has the Hebrew date, the day number/days remaining in the year,
2386 and the ISO week/year numbers in the mode. When calendar-move-hook is set to
2387 'update-calendar-mode-line, these mode line shows these values for the date
2392 '(calendar-hebrew-date-string date)
2393 '(let* ((year (extract-calendar-year date))
2394 (d (calendar-day-number date))
2396 (- (calendar-day-number (list 12 31 year)) d)))
2397 (format \"%d/%d\" d days-remaining))
2398 '(let* ((d (calendar-absolute-from-gregorian date))
2399 (iso-date (calendar-iso-from-absolute d)))
2400 (format \"ISO week %d of %d\"
2401 (extract-calendar-month iso-date)
2402 (extract-calendar-year iso-date)))
2406 (defun mouse-scroll-calendar-left (event)
2407 "Scroll the displayed calendar left by one month.
2408 Maintains the relative position of the cursor
2409 with respect to the calendar as well as possible."
2411 (save-selected-window
2412 (select-window (posn-window (event-start event)))
2413 (scroll-calendar-left 1)))
2415 (defun mouse-scroll-calendar-right (event)
2416 "Scroll the displayed calendar right by one month.
2417 Maintains the relative position of the cursor
2418 with respect to the calendar as well as possible."
2420 (save-selected-window
2421 (select-window (posn-window (event-start event)))
2422 (scroll-calendar-right 1)))
2424 (defun mouse-calendar-other-month (event)
2425 "Display a three-month calendar centered around a specified month and year."
2427 (save-selected-window
2428 (select-window (posn-window (event-start event)))
2429 (call-interactively 'calendar-other-month)))
2431 (defun calendar-goto-info-node ()
2432 "Go to the info node for the calendar."
2435 (let ((where (save-window-excursion
2436 (Info-find-emacs-command-nodes 'calendar))))
2438 (error "Couldn't find documentation for the calendar")
2439 (let (same-window-buffer-names)
2441 (Info-find-node (car (car where)) (car (cdr (car where)))))))
2445 (defun calendar-mode ()
2446 "A major mode for the calendar window.
2448 For a complete description, type \
2449 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
2451 \\<calendar-mode-map>\\{calendar-mode-map}"
2452 (kill-all-local-variables)
2453 (setq major-mode 'calendar-mode)
2454 (setq mode-name "Calendar")
2455 (use-local-map calendar-mode-map)
2456 (setq buffer-read-only t)
2457 (setq indent-tabs-mode nil)
2458 (update-calendar-mode-line)
2459 (add-hook 'activate-menubar-hook 'cal-menu-update nil t)
2460 (make-local-variable 'calendar-mark-ring)
2461 (make-local-variable 'displayed-month);; Month in middle of window.
2462 (make-local-variable 'displayed-year) ;; Year in middle of window.
2463 (set (make-local-variable 'font-lock-defaults)
2464 '(calendar-font-lock-keywords t))
2465 (run-mode-hooks 'calendar-mode-hook))
2467 (defun calendar-string-spread (strings char length)
2468 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
2469 The effect is like mapconcat but the separating pieces are as balanced as
2470 possible. Each item of STRINGS is evaluated before concatenation so it can
2471 actually be an expression that evaluates to a string. If LENGTH is too short,
2472 the STRINGS are just concatenated and the result truncated."
2473 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
2474 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
2475 ;; Addison-Wesley, Reading, MA, 1989
2476 (let* ((strings (mapcar 'eval
2477 (if (< (length strings) 2)
2478 (append (list "") strings (list ""))
2480 (n (- length (length (apply 'concat strings))))
2481 (m (1- (length strings)))
2483 (strings (cdr strings))
2487 (make-string (max 0 (/ (+ n i) m)) char)
2490 (setq strings (cdr strings)))
2491 (substring s 0 length)))
2493 (defun update-calendar-mode-line ()
2494 "Update the calendar mode line with the current date and date style."
2495 (if (bufferp (get-buffer calendar-buffer))
2497 (set-buffer calendar-buffer)
2498 (setq mode-line-format
2499 (calendar-string-spread
2500 (let ((date (condition-case nil
2501 (calendar-cursor-to-nearest-date)
2502 (error (calendar-current-date)))))
2503 (mapcar 'eval calendar-mode-line-format))
2505 (force-mode-line-update))))
2507 (defun calendar-window-list ()
2508 "List of all calendar-related windows."
2509 (let ((calendar-buffers (calendar-buffer-list))
2511 (walk-windows (lambda (w)
2512 (if (memq (window-buffer w) calendar-buffers)
2513 (setq list (cons w list))))
2517 (defun calendar-buffer-list ()
2518 "List of all calendar-related buffers."
2519 (let* ((diary-buffer (get-file-buffer diary-file))
2520 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
2521 fancy-diary-buffer diary-buffer calendar-buffer
2522 other-calendars-buffer))
2526 (setq b (car buffers))
2527 (setq b (cond ((stringp b) (get-buffer b))
2530 (if b (setq buffer-list (cons b buffer-list)))
2531 (setq buffers (cdr buffers)))
2534 (defun exit-calendar ()
2535 "Get out of the calendar window and hide it and related buffers."
2537 (let* ((diary-buffer (get-file-buffer diary-file)))
2538 (if (or (not diary-buffer)
2539 (not (buffer-modified-p diary-buffer))
2541 "Diary modified; do you really want to exit the calendar? "))
2542 ;; Need to do this multiple times because one time can replace some
2543 ;; calendar-related buffers with other calendar-related buffers
2545 (mapcar 'calendar-hide-window (calendar-window-list)))
2546 (calendar-window-list)))))
2548 (defun calendar-hide-window (window)
2549 "Hide WINDOW if it is calendar-related."
2550 (let ((buffer (if (window-live-p window) (window-buffer window))))
2551 (if (memq buffer (calendar-buffer-list))
2553 ((and (display-multi-frame-p)
2554 (eq 'icon (cdr (assoc 'visibility
2556 (window-frame window))))))
2558 ((and (display-multi-frame-p) (window-dedicated-p window))
2559 (if calendar-remove-frame-by-deleting
2560 (delete-frame (window-frame window))
2561 (iconify-frame (window-frame window))))
2562 ((not (and (select-window window) (one-window-p window)))
2563 (delete-window window))
2564 (t (set-buffer buffer)
2567 (defun calendar-current-date ()
2568 "Return the current date in a list (month day year)."
2569 (let ((now (decode-time)))
2570 (list (nth 4 now) (nth 3 now) (nth 5 now))))
2572 (defun calendar-cursor-to-date (&optional error)
2573 "Return a list (month day year) of current cursor position.
2574 If cursor is not on a specific date, signals an error if optional parameter
2575 ERROR is t, otherwise just returns nil."
2576 (let* ((segment (/ (current-column) 25))
2577 (month (% (+ displayed-month segment -1) 12))
2578 (month (if (= 0 month) 12 month))
2581 ((and (= 12 month) (= segment 0)) (1- displayed-year))
2582 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
2583 (t displayed-year))))
2584 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
2585 (< 2 (count-lines (point-min) (point))))
2587 (if (not (looking-at " "))
2588 (re-search-backward "[^0-9]"))
2590 (string-to-number (buffer-substring (1+ (point)) (+ 4 (point))))
2592 (if (looking-at "\\*")
2594 (re-search-backward "[^*]")
2595 (if (looking-at ".\\*\\*")
2596 (list month calendar-starred-day year)
2597 (if error (error "Not on a date!"))))
2598 (if error (error "Not on a date!"))))))
2600 ;; The following version of calendar-gregorian-from-absolute is preferred for
2601 ;; reasons of clarity, BUT it's much slower than the version that follows it.
2603 ;;(defun calendar-gregorian-from-absolute (date)
2604 ;; "Compute the list (month day year) corresponding to the absolute DATE.
2605 ;;The absolute date is the number of days elapsed since the (imaginary)
2606 ;;Gregorian date Sunday, December 31, 1 BC."
2607 ;; (let* ((approx (/ date 366));; Approximation from below.
2608 ;; (year ;; Search forward from the approximation.
2610 ;; (calendar-sum y approx
2611 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2613 ;; (month ;; Search forward from January.
2614 ;; (1+ (calendar-sum m 1
2616 ;; (calendar-absolute-from-gregorian
2617 ;; (list m (calendar-last-day-of-month m year) year)))
2619 ;; (day ;; Calculate the day by subtraction.
2621 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2622 ;; (list month day year)))
2624 (defun calendar-gregorian-from-absolute (date)
2625 "Compute the list (month day year) corresponding to the absolute DATE.
2626 The absolute date is the number of days elapsed since the (imaginary)
2627 Gregorian date Sunday, December 31, 1 BC. This function does not
2628 handle dates in years BC."
2629 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2630 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2631 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2632 ;; (April, 1993), pages 383-404 for an explanation.
2633 (let* ((d0 (1- date))
2634 (n400 (/ d0 146097))
2641 (day (1+ (% d3 365)))
2642 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2643 (if (or (= n100 4) (= n1 4))
2645 (let ((year (1+ year))
2647 (while (let ((mdays (calendar-last-day-of-month month year)))
2649 (setq day (- day mdays))))
2650 (setq month (1+ month)))
2651 (list month day year)))))
2653 (defun calendar-other-month (month year)
2654 "Display a three-month calendar centered around MONTH and YEAR."
2655 (interactive (calendar-read-date 'noday))
2656 (if (and (= month displayed-month)
2657 (= year displayed-year))
2659 (let ((old-date (calendar-cursor-to-date))
2660 (today (calendar-current-date)))
2661 (generate-calendar-window month year)
2662 (calendar-cursor-to-visible-date
2664 ((calendar-date-is-visible-p old-date) old-date)
2665 ((calendar-date-is-visible-p today) today)
2666 (t (list month 1 year)))))))
2668 (defun calendar-set-mark (arg)
2669 "Mark the date under the cursor, or jump to marked date.
2670 With no prefix argument, push current date onto marked date ring.
2671 With argument, jump to mark, pop it, and put point at end of ring."
2673 (let ((date (calendar-cursor-to-date t)))
2676 (setq calendar-mark-ring (cons date calendar-mark-ring))
2677 ;; Since the top of the mark ring is the marked date in the
2678 ;; calendar, the mark ring in the calendar is one longer than
2679 ;; in other buffers to get the same effect.
2680 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2681 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2682 (message "Mark set"))
2683 (if (null calendar-mark-ring)
2684 (error "No mark set in this buffer")
2685 (calendar-goto-date (car calendar-mark-ring))
2686 (setq calendar-mark-ring
2687 (cdr (nconc calendar-mark-ring (list date))))))))
2689 (defun calendar-exchange-point-and-mark ()
2690 "Exchange the current cursor position with the marked date."
2692 (let ((mark (car calendar-mark-ring))
2693 (date (calendar-cursor-to-date t)))
2695 (error "No mark set in this buffer")
2696 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2697 (calendar-goto-date mark))))
2699 (defun calendar-count-days-region ()
2700 "Count the number of days (inclusive) between point and the mark."
2702 (let* ((days (- (calendar-absolute-from-gregorian
2703 (calendar-cursor-to-date t))
2704 (calendar-absolute-from-gregorian
2705 (or (car calendar-mark-ring)
2706 (error "No mark set in this buffer")))))
2707 (days (1+ (if (> days 0) days (- days)))))
2708 (message "Region has %d day%s (inclusive)"
2709 days (if (> days 1) "s" ""))))
2711 (defun calendar-not-implemented ()
2714 (error "%s not available in the calendar"
2715 (global-key-binding (this-command-keys))))
2717 (defun calendar-read (prompt acceptable &optional initial-contents)
2718 "Return an object read from the minibuffer.
2719 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2720 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2721 is a string to insert in the minibuffer before reading."
2722 (let ((value (read-minibuffer prompt initial-contents)))
2723 (while (not (funcall acceptable value))
2724 (setq value (read-minibuffer prompt initial-contents)))
2727 (defun calendar-read-date (&optional noday)
2728 "Prompt for Gregorian date. Return a list (month day year).
2729 If optional NODAY is t, does not ask for day, but just returns
2730 \(month nil year); if NODAY is any other non-nil value the value returned is
2732 (let* ((year (calendar-read
2734 (lambda (x) (> x 0))
2735 (int-to-string (extract-calendar-year
2736 (calendar-current-date)))))
2737 (month-array calendar-month-name-array)
2738 (completion-ignore-case t)
2739 (month (cdr (assoc-string
2742 (mapcar 'list (append month-array nil))
2744 (calendar-make-alist month-array 1) t)))
2745 (last (calendar-last-day-of-month month year)))
2748 (list month nil year)
2751 (calendar-read (format "Day (1-%d): " last)
2752 (lambda (x) (and (< 0 x) (<= x last))))
2755 (defun calendar-interval (mon1 yr1 mon2 yr2)
2756 "The number of months difference between MON1, YR1 and MON2, YR2.
2757 The result is positive if the second date is later than the first.
2758 Negative years are interpreted as years BC; -1 being 1 BC, and so on."
2759 (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc
2760 (if (< yr2 0) (setq yr2 (1+ yr2)))
2761 (+ (* 12 (- yr2 yr1))
2764 (defvar calendar-abbrev-length 3
2765 "*Length of abbreviations to be used for day and month names.
2766 See also `calendar-day-abbrev-array' and `calendar-month-abbrev-array'.")
2768 (defvar calendar-day-name-array
2769 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2770 "*Array of capitalized strings giving, in order, the day names.
2771 The first two characters of each string will be used to head the
2772 day columns in the calendar. See also the variable
2773 `calendar-day-abbrev-array'.")
2775 (defvar calendar-day-abbrev-array
2776 [nil nil nil nil nil nil nil]
2777 "*Array of capitalized strings giving the abbreviated day names.
2778 The order should be the same as that of the full names specified
2779 in `calendar-day-name-array'. These abbreviations may be used
2780 instead of the full names in the diary file. Do not include a
2781 trailing `.' in the strings specified in this variable, though
2782 you may use such in the diary file. If any element of this array
2783 is nil, then the abbreviation will be constructed as the first
2784 `calendar-abbrev-length' characters of the corresponding full name.")
2786 (defvar calendar-month-name-array
2787 ["January" "February" "March" "April" "May" "June"
2788 "July" "August" "September" "October" "November" "December"]
2789 "*Array of capitalized strings giving, in order, the month names.
2790 See also the variable `calendar-month-abbrev-array'.")
2792 (defvar calendar-month-abbrev-array
2793 [nil nil nil nil nil nil nil nil nil nil nil nil]
2794 "*Array of capitalized strings giving the abbreviated month names.
2795 The order should be the same as that of the full names specified
2796 in `calendar-month-name-array'. These abbreviations are used in
2797 the calendar menu entries, and can also be used in the diary
2798 file. Do not include a trailing `.' in the strings specified in
2799 this variable, though you may use such in the diary file. If any
2800 element of this array is nil, then the abbreviation will be
2801 constructed as the first `calendar-abbrev-length' characters of the
2802 corresponding full name.")
2804 (defun calendar-abbrev-construct (abbrev full &optional period)
2805 "Internal calendar function to return a complete abbreviation array.
2806 ABBREV is an array of abbreviations, FULL the corresponding array
2807 of full names. The return value is the ABBREV array, with any nil
2808 elements replaced by the first three characters taken from the
2809 corresponding element of FULL. If optional argument PERIOD is non-nil,
2810 each element returned has a final `.' character."
2811 (let (elem array name)
2812 (dotimes (i (length full))
2813 (setq name (aref full i)
2814 elem (or (aref abbrev i)
2816 (min calendar-abbrev-length (length name))))
2817 elem (format "%s%s" elem (if period "." ""))
2818 array (append array (list elem))))
2821 (defvar calendar-font-lock-keywords
2822 `((,(concat (regexp-opt (mapcar 'identity calendar-month-name-array) t)
2824 . font-lock-function-name-face) ; month and year
2826 (list (substring (aref calendar-day-name-array 6) 0 2)
2827 (substring (aref calendar-day-name-array 0) 0 2)))
2828 ;; Saturdays and Sundays are hilited differently.
2829 . font-lock-comment-face)
2830 ;; First two chars of each day are used in the calendar.
2831 (,(regexp-opt (mapcar (lambda (x) (substring x 0 2)) calendar-day-name-array))
2832 . font-lock-reference-face))
2833 "Default keywords to highlight in Calendar mode.")
2835 (defun calendar-day-name (date &optional abbrev absolute)
2836 "Return a string with the name of the day of the week of DATE.
2837 DATE should be a list in the format (MONTH DAY YEAR), unless the
2838 optional argument ABSOLUTE is non-nil, in which case DATE should
2839 be an integer in the range 0 to 6 corresponding to the day of the
2840 week. Day names are taken from the variable `calendar-day-name-array',
2841 unless the optional argument ABBREV is non-nil, in which case
2842 the variable `calendar-day-abbrev-array' is used."
2844 (calendar-abbrev-construct calendar-day-abbrev-array
2845 calendar-day-name-array)
2846 calendar-day-name-array)
2847 (if absolute date (calendar-day-of-week date))))
2849 (defun calendar-make-alist (sequence &optional start-index filter abbrevs)
2850 "Make an assoc list corresponding to SEQUENCE.
2851 Each element of sequence will be associated with an integer, starting
2852 from 1, or from START-INDEX if that is non-nil. If a sequence ABBREVS
2853 is supplied, the function `calendar-abbrev-construct' is used to
2854 construct abbreviations corresponding to the elements in SEQUENCE.
2855 Each abbreviation is entered into the alist with the same
2856 association index as the full name it represents.
2857 If FILTER is provided, apply it to each key in the alist."
2859 (offset (or start-index 1))
2860 (aseq (if abbrevs (calendar-abbrev-construct abbrevs sequence)))
2861 (aseqp (if abbrevs (calendar-abbrev-construct abbrevs sequence
2864 (dotimes (i (length sequence) (reverse alist))
2865 (setq index (+ i offset)
2866 elem (elt sequence i)
2868 (cons (cons (if filter (funcall filter elem) elem) index) alist))
2870 (setq elem (elt aseq i)
2871 alist (cons (cons (if filter (funcall filter elem) elem)
2874 (setq elem (elt aseqp i)
2875 alist (cons (cons (if filter (funcall filter elem) elem)
2878 (defun calendar-month-name (month &optional abbrev)
2879 "Return a string with the name of month number MONTH.
2880 Months are numbered from one. Month names are taken from the
2881 variable `calendar-month-name-array', unless the optional
2882 argument ABBREV is non-nil, in which case
2883 `calendar-month-abbrev-array' is used."
2885 (calendar-abbrev-construct calendar-month-abbrev-array
2886 calendar-month-name-array)
2887 calendar-month-name-array)
2890 (defun calendar-day-of-week (date)
2891 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc.
2892 DATE is a list of the form (month day year). A negative year is
2893 interpreted as BC; -1 being 1 BC, and so on."
2894 (mod (calendar-absolute-from-gregorian date) 7))
2896 (defun calendar-unmark ()
2897 "Delete all diary/holiday marks/highlighting from the calendar."
2899 (setq mark-holidays-in-calendar nil)
2900 (setq mark-diary-entries-in-calendar nil)
2903 (defun calendar-date-is-visible-p (date)
2904 "Return t if DATE is valid and is visible in the calendar window."
2905 (let ((gap (calendar-interval
2906 displayed-month displayed-year
2907 (extract-calendar-month date) (extract-calendar-year date))))
2908 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2910 (defun calendar-date-is-legal-p (date)
2911 "Return t if DATE is a valid date."
2912 (let ((month (extract-calendar-month date))
2913 (day (extract-calendar-day date))
2914 (year (extract-calendar-year date)))
2915 (and (<= 1 month) (<= month 12)
2916 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2917 ;; BC dates left as non-valid, to suppress errors from
2918 ;; complex holiday algorithms not suitable for years BC.
2919 ;; Note there are side effects on calendar navigation.
2922 (defun calendar-date-equal (date1 date2)
2923 "Return t if the DATE1 and DATE2 are the same."
2925 (= (extract-calendar-month date1) (extract-calendar-month date2))
2926 (= (extract-calendar-day date1) (extract-calendar-day date2))
2927 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2929 (defun mark-visible-calendar-date (date &optional mark)
2930 "Mark DATE in the calendar window with MARK.
2931 MARK is a single-character string, a list of face attributes/values, or a face.
2932 MARK defaults to `diary-entry-marker'."
2933 (if (calendar-date-is-legal-p date)
2935 (set-buffer calendar-buffer)
2936 (calendar-cursor-to-visible-date date)
2937 (let ((mark (or (and (stringp mark) (= (length mark) 1) mark) ; single-char
2938 (and (listp mark) (> (length mark) 0) mark) ; attr list
2939 (and (facep mark) mark) ; face-name
2940 diary-entry-marker)))
2942 (progn ; face or an attr-list that contained a face
2944 (make-overlay (1- (point)) (1+ (point))) 'face mark))
2945 (if (and (stringp mark)
2946 (= (length mark) 1)) ; single-char
2947 (let ((buffer-read-only nil))
2954 (make-symbol (apply 'concat "temp-"
2955 (mapcar '(lambda (sym)
2956 (cond ((symbolp sym) (symbol-name sym))
2957 ((numberp sym) (int-to-string sym))
2960 (make-face temp-face)
2961 ;; Remove :face info from the mark, copy the face info into temp-face
2962 (while (setq faceinfo (memq :face faceinfo))
2963 (copy-face (read (nth 1 faceinfo)) temp-face)
2964 (setcar faceinfo nil)
2965 (setcar (cdr faceinfo) nil))
2966 (setq mark (delq nil mark))
2967 ;; Apply the font aspects
2968 (apply 'set-face-attribute temp-face nil mark)
2970 (make-overlay (1- (point)) (1+ (point))) 'face temp-face))))))))
2972 (defun calendar-star-date ()
2973 "Replace the date under the cursor in the calendar window with asterisks.
2974 This function can be used with the `today-visible-calendar-hook' run after the
2975 calendar window has been prepared."
2976 (let ((inhibit-read-only t))
2977 (make-local-variable 'calendar-starred-day)
2979 (setq calendar-starred-day
2981 (buffer-substring (point) (- (point) 2))))
2985 (set-buffer-modified-p nil)))
2987 (defun calendar-mark-today ()
2988 "Mark the date under the cursor in the calendar window.
2989 The date is marked with `calendar-today-marker'. This function can be used with
2990 the `today-visible-calendar-hook' run after the calendar window has been
2992 (mark-visible-calendar-date
2993 (calendar-cursor-to-date)
2994 calendar-today-marker))
2996 (defun calendar-date-compare (date1 date2)
2997 "Return t if DATE1 is before DATE2, nil otherwise.
2998 The actual dates are in the car of DATE1 and DATE2."
2999 (< (calendar-absolute-from-gregorian (car date1))
3000 (calendar-absolute-from-gregorian (car date2))))
3002 (defun calendar-date-string (date &optional abbreviate nodayname)
3003 "A string form of DATE, driven by the variable `calendar-date-display-form'.
3004 An optional parameter ABBREVIATE, when non-nil, causes the month
3005 and day names to be abbreviated as specified by
3006 `calendar-month-abbrev-array' and `calendar-day-abbrev-array',
3007 respectively. An optional parameter NODAYNAME, when t, omits the
3008 name of the day of the week."
3011 (calendar-day-name date abbreviate)))
3012 (month (extract-calendar-month date))
3013 (monthname (calendar-month-name month abbreviate))
3014 (day (int-to-string (extract-calendar-day date)))
3015 (month (int-to-string month))
3016 (year (int-to-string (extract-calendar-year date))))
3017 (mapconcat 'eval calendar-date-display-form "")))
3019 (defun calendar-dayname-on-or-before (dayname date)
3020 "Return the absolute date of the DAYNAME on or before absolute DATE.
3021 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
3023 Note: Applying this function to d+6 gives us the DAYNAME on or after an
3024 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
3025 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
3026 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
3027 (- date (% (- date dayname) 7)))
3029 (defun calendar-nth-named-absday (n dayname month year &optional day)
3030 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3031 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3032 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3033 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3035 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3038 (calendar-dayname-on-or-before
3040 (+ 6 (calendar-absolute-from-gregorian
3041 (list month (or day 1) year)))))
3043 (calendar-dayname-on-or-before
3045 (calendar-absolute-from-gregorian
3047 (or day (calendar-last-day-of-month month year))
3050 (defun calendar-nth-named-day (n dayname month year &optional day)
3051 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3052 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3053 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3054 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3056 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3057 (calendar-gregorian-from-absolute
3058 (calendar-nth-named-absday n dayname month year day)))
3060 (defun calendar-day-of-year-string (&optional date)
3061 "String of day number of year of Gregorian DATE.
3062 Defaults to today's date if DATE is not given."
3063 (let* ((d (or date (calendar-current-date)))
3064 (year (extract-calendar-year d))
3065 (day (calendar-day-number d))
3066 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
3067 (format "Day %d of %d; %d day%s remaining in the year"
3068 day year days-remaining (if (= days-remaining 1) "" "s"))))
3070 (defun calendar-print-other-dates ()
3071 "Show dates on other calendars for date under the cursor."
3073 (let* ((date (calendar-cursor-to-date t)))
3075 (set-buffer (get-buffer-create other-calendars-buffer))
3076 (setq buffer-read-only nil)
3077 (calendar-set-mode-line
3078 (concat (calendar-date-string date) " (Gregorian)"))
3081 (mapconcat 'identity
3082 (list (calendar-day-of-year-string date)
3083 (format "ISO date: %s" (calendar-iso-date-string date))
3084 (format "Julian date: %s"
3085 (calendar-julian-date-string date))
3087 "Astronomical (Julian) day number (at noon UTC): %s.0"
3088 (calendar-astro-date-string date))
3089 (format "Fixed (RD) date: %s"
3090 (calendar-absolute-from-gregorian date))
3091 (format "Hebrew date (before sunset): %s"
3092 (calendar-hebrew-date-string date))
3093 (format "Persian date: %s"
3094 (calendar-persian-date-string date))
3095 (let ((i (calendar-islamic-date-string date)))
3096 (if (not (string-equal i ""))
3097 (format "Islamic date (before sunset): %s" i)))
3098 (let ((b (calendar-bahai-date-string date)))
3099 (if (not (string-equal b ""))
3100 (format "Baha'i date (before sunset): %s" b)))
3101 (format "Chinese date: %s"
3102 (calendar-chinese-date-string date))
3103 (let ((c (calendar-coptic-date-string date)))
3104 (if (not (string-equal c ""))
3105 (format "Coptic date: %s" c)))
3106 (let ((e (calendar-ethiopic-date-string date)))
3107 (if (not (string-equal e ""))
3108 (format "Ethiopic date: %s" e)))
3109 (let ((f (calendar-french-date-string date)))
3110 (if (not (string-equal f ""))
3111 (format "French Revolutionary date: %s" f)))
3112 (format "Mayan date: %s"
3113 (calendar-mayan-date-string date)))
3115 (goto-char (point-min))
3116 (set-buffer-modified-p nil)
3117 (setq buffer-read-only t)
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 (setq mode-line-format
3128 (calendar-string-spread
3130 ;; As per doc of window-width, total visible mode-line length.
3131 (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))))))
3133 (defun calendar-mod (m n)
3134 "Non-negative remainder of M/N with N instead of 0."
3135 (1+ (mod (1- m) n)))
3137 (run-hooks 'calendar-load-hook)
3141 ;;; Local variables:
3142 ;;; byte-compile-dynamic: t
3145 ;;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8
3146 ;;; calendar.el ends here