(calendar-cursor-to-nearest-date): Use or, when. Move definition before use.
[emacs.git] / lisp / calendar / calendar.el
blob049d80c45f986d8572acca2c44ee303464d9c73e
1 ;;; calendar.el --- calendar functions
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
8 ;; Maintainer: Glenn Morris <rgm@gnu.org>
9 ;; Keywords: calendar
10 ;; Human-Keywords: calendar, Gregorian calendar, diary, holidays
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 3, or (at your option)
17 ;; any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27 ;; Boston, MA 02110-1301, USA.
29 ;;; Commentary:
31 ;; This collection of functions implements a calendar window. It
32 ;; generates a calendar for the current month, together with the
33 ;; previous and coming months, or for any other three-month period.
34 ;; The calendar can be scrolled forward and backward in the window to
35 ;; show months in the past or future; the cursor can move forward and
36 ;; backward by days, weeks, or months, making it possible, for
37 ;; instance, to jump to the date a specified number of days, weeks, or
38 ;; months from the date under the cursor. The user can display a list
39 ;; of holidays and other notable days for the period shown; the
40 ;; notable days can be marked on the calendar, if desired. The user
41 ;; can also specify that dates having corresponding diary entries (in
42 ;; a file that the user specifies) be marked; the diary entries for
43 ;; any date can be viewed in a separate window. The diary and the
44 ;; notable days can be viewed independently of the calendar. Dates
45 ;; can be translated from the (usual) Gregorian calendar to the day of
46 ;; the year/days remaining in year, to the ISO commercial calendar, to
47 ;; the Julian (old style) calendar, to the Hebrew calendar, to the
48 ;; Islamic calendar, to the Baha'i calendar, to the French
49 ;; Revolutionary calendar, to the Mayan calendar, to the Chinese
50 ;; calendar, to the Coptic calendar, to the Ethiopic calendar, and to
51 ;; the astronomical (Julian) day number. When floating point is
52 ;; available, times of sunrise/sunset can be displayed, as can the
53 ;; phases of the moon. Appointment notification for diary entries is
54 ;; available. Calendar printing via LaTeX is available.
56 ;; The following files are part of the calendar/diary code:
58 ;; appt.el Appointment notification
59 ;; cal-china.el Chinese calendar
60 ;; cal-coptic.el Coptic/Ethiopic calendars
61 ;; cal-dst.el Daylight saving time rules
62 ;; cal-hebrew.el Hebrew calendar
63 ;; cal-islam.el Islamic calendar
64 ;; cal-bahai.el Baha'i calendar
65 ;; cal-iso.el ISO calendar
66 ;; cal-julian.el Julian/astronomical calendars
67 ;; cal-mayan.el Mayan calendars
68 ;; cal-menu.el Menu support
69 ;; cal-move.el Movement in the calendar
70 ;; cal-persia.el Persian calendar
71 ;; cal-tex.el Calendars in LaTeX
72 ;; cal-x.el X-windows dedicated frame functions
73 ;; diary-lib.el Diary functions
74 ;; holidays.el Holiday functions
75 ;; lunar.el Phases of the moon
76 ;; solar.el Sunrise/sunset, equinoxes/solstices
78 ;; Technical details of all the calendrical calculations can be found in
79 ;; ``Calendrical Calculations: The Millennium Edition'' by Edward M. Reingold
80 ;; and Nachum Dershowitz, Cambridge University Press (2001).
82 ;; An earlier version of the technical details appeared in
83 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
84 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
85 ;; pages 899-928, and in ``Calendrical Calculations, Part II: Three Historical
86 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
87 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
88 ;; pages 383-404.
90 ;; Hard copies of these two papers can be obtained by sending email to
91 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
92 ;; the message BODY containing your mailing address (snail).
94 ;;; Code:
96 ;; (elisp) Eval During Compile: "Effectively `require' is
97 ;; automatically `eval-and-compile'" [but `load' is not]
98 (eval-and-compile
99 (load "cal-loaddefs" nil 'quiet))
101 (require 'cal-menu)
104 (defgroup calendar nil
105 "Calendar and time management support."
106 :group 'applications)
108 (defgroup calendar-hooks nil
109 "Calendar hooks."
110 :prefix "calendar-"
111 :group 'calendar)
113 (defgroup diary nil
114 "Emacs diary."
115 :group 'calendar)
117 (defgroup holidays nil
118 "Holidays support in calendar."
119 :group 'calendar
120 :prefix "calendar-"
121 :group 'local)
124 (defcustom calendar-offset 0
125 "The offset of the principal month from the center of the calendar window.
126 0 means the principal month is in the center (default), -1 means on the left,
127 +1 means on the right. Larger (or smaller) values push the principal month off
128 the screen."
129 :type 'integer
130 :group 'calendar)
132 (defcustom calendar-setup nil
133 "The frame setup of the calendar.
134 The choices are: `one-frame' (calendar and diary together in one separate,
135 dedicated frame); `two-frames' (calendar and diary in separate, dedicated
136 frames); `calendar-only' (calendar in a separate, dedicated frame); with
137 any other value the current frame is used. Using any of the first
138 three options overrides the value of `view-diary-entries-initially'."
139 :type '(choice
140 (const :tag "calendar and diary in separate frame" one-frame)
141 (const :tag "calendar and diary each in own frame" two-frames)
142 (const :tag "calendar in separate frame" calendar-only)
143 (const :tag "use current frame" nil))
144 :group 'calendar)
146 (defcustom calendar-minimum-window-height 8
147 "Minimum height `generate-calendar-window' should use for calendar window."
148 :type 'integer
149 :version "22.1"
150 :group 'calendar)
152 (defcustom calendar-week-start-day 0
153 "The day of the week on which a week in the calendar begins.
154 0 means Sunday (default), 1 means Monday, and so on.
156 If you change this variable directly (without using customize)
157 after starting `calendar', you should call `redraw-calendar' to
158 update the calendar display to reflect the change, otherwise
159 movement commands will not work correctly."
160 :type 'integer
161 ;; Change the initialize so that if you reload calendar.el, it will not
162 ;; cause a redraw (which may fail, e.g. with "invalid byte-code in
163 ;; calendar.elc" because of the "byte-compile-dynamic").
164 :initialize 'custom-initialize-default
165 :set (lambda (sym val)
166 (set sym val)
167 (redraw-calendar))
168 :group 'calendar)
170 (defcustom view-diary-entries-initially nil
171 "Non-nil means display current date's diary entries on entry to calendar.
172 The diary is displayed in another window when the calendar is first displayed,
173 if the current date is visible. The number of days of diary entries displayed
174 is governed by the variable `number-of-diary-entries'. This variable can
175 be overridden by the value of `calendar-setup'."
176 :type 'boolean
177 :group 'diary)
179 (defcustom mark-diary-entries-in-calendar nil
180 "Non-nil means mark dates with diary entries, in the calendar window.
181 The marking symbol is specified by the variable `diary-entry-marker'."
182 :type 'boolean
183 :group 'diary)
185 (defcustom calendar-remove-frame-by-deleting nil
186 "Determine how the calendar mode removes a frame no longer needed.
187 If nil, make an icon of the frame. If non-nil, delete the frame."
188 :type 'boolean
189 :group 'view)
191 (defface calendar-today
192 '((t (:underline t)))
193 "Face for indicating today's date."
194 :group 'diary)
195 ;; Backward-compatibility alias. FIXME make obsolete.
196 (put 'calendar-today-face 'face-alias 'calendar-today)
198 (defface diary
199 '((((min-colors 88) (class color) (background light))
200 :foreground "red1")
201 (((class color) (background light))
202 :foreground "red")
203 (((min-colors 88) (class color) (background dark))
204 :foreground "yellow1")
205 (((class color) (background dark))
206 :foreground "yellow")
208 :weight bold))
209 "Face for highlighting diary entries."
210 :group 'diary)
211 ;; Backward-compatibility alias. FIXME make obsolete.
212 (put 'diary-face 'face-alias 'diary)
214 (defface holiday
215 '((((class color) (background light))
216 :background "pink")
217 (((class color) (background dark))
218 :background "chocolate4")
220 :inverse-video t))
221 "Face for indicating dates that have holidays."
222 :group 'diary)
223 ;; Backward-compatibility alias. FIXME make obsolete.
224 (put 'holiday-face 'face-alias 'holiday)
226 (defcustom diary-entry-marker (if (display-color-p) 'diary "+")
227 "How to mark dates that have diary entries.
228 The value can be either a single-character string or a face."
229 :type '(choice string face)
230 :group 'diary)
232 (defcustom calendar-today-marker (if (display-color-p) 'calendar-today "=")
233 "How to mark today's date in the calendar.
234 The value can be either a single-character string or a face.
235 Marking today's date is done only if you set up `today-visible-calendar-hook'
236 to request that."
237 :type '(choice string face)
238 :group 'calendar)
240 (defcustom calendar-holiday-marker (if (display-color-p) 'holiday "*")
241 "How to mark notable dates in the calendar.
242 The value can be either a single-character string or a face."
243 :type '(choice string face)
244 :group 'calendar)
246 (defcustom view-calendar-holidays-initially nil
247 "Non-nil means display holidays for current three month period on entry.
248 The holidays are displayed in another window when the calendar is first
249 displayed."
250 :type 'boolean
251 :group 'holidays)
253 (defcustom mark-holidays-in-calendar nil
254 "Non-nil means mark dates of holidays in the calendar window.
255 The marking symbol is specified by the variable `calendar-holiday-marker'."
256 :type 'boolean
257 :group 'holidays)
259 (defcustom calendar-mode-hook nil
260 "Hook run when entering `calendar-mode'."
261 :type 'hook
262 :group 'calendar-hooks)
264 (defcustom calendar-load-hook nil
265 "List of functions to be called after the calendar is first loaded.
266 This is the place to add key bindings to `calendar-mode-map'."
267 :type 'hook
268 :group 'calendar-hooks)
270 (defcustom initial-calendar-window-hook nil
271 "List of functions to be called when the calendar window is first opened.
272 The functions invoked are called after the calendar window is opened, but
273 once opened is never called again. Leaving the calendar with the `q' command
274 and reentering it will cause these functions to be called again."
275 :type 'hook
276 :group 'calendar-hooks)
278 (defcustom today-visible-calendar-hook nil
279 "List of functions called whenever the current date is visible.
280 This can be used, for example, to replace today's date with asterisks; a
281 function `calendar-star-date' is included for this purpose:
282 (setq today-visible-calendar-hook 'calendar-star-date)
283 It can also be used to mark the current date with `calendar-today-marker';
284 a function is also provided for this:
285 (setq today-visible-calendar-hook 'calendar-mark-today)
287 The corresponding variable `today-invisible-calendar-hook' is the list of
288 functions called when the calendar function was called when the current
289 date is not visible in the window.
291 Other than the use of the provided functions, the changing of any
292 characters in the calendar buffer by the hooks may cause the failure of the
293 functions that move by days and weeks."
294 :type 'hook
295 :group 'calendar-hooks)
297 (defcustom today-invisible-calendar-hook nil
298 "List of functions called whenever the current date is not visible.
300 The corresponding variable `today-visible-calendar-hook' is the list of
301 functions called when the calendar function was called when the current
302 date is visible in the window.
304 Other than the use of the provided functions, the changing of any
305 characters in the calendar buffer by the hooks may cause the failure of the
306 functions that move by days and weeks."
307 :type 'hook
308 :group 'calendar-hooks)
310 (defcustom calendar-move-hook nil
311 "List of functions called whenever the cursor moves in the calendar.
313 For example,
315 (add-hook 'calendar-move-hook (lambda () (diary-view-entries 1)))
317 redisplays the diary for whatever date the cursor is moved to."
318 :type 'hook
319 :group 'calendar-hooks)
321 ;;;###autoload
322 (defcustom diary-file "~/diary"
323 "Name of the file in which one's personal diary of dates is kept.
325 The file's entries are lines beginning with any of the forms
326 specified by the variable `american-date-diary-pattern', by default:
328 MONTH/DAY
329 MONTH/DAY/YEAR
330 MONTHNAME DAY
331 MONTHNAME DAY, YEAR
332 DAYNAME
334 with the remainder of the line being the diary entry string for
335 that date. MONTH and DAY are one or two digit numbers, YEAR is a
336 number and may be written in full or abbreviated to the final two
337 digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME
338 and DAYNAME can be spelled in full (as specified by the variables
339 `calendar-month-name-array' and `calendar-day-name-array'),
340 abbreviated (as specified by `calendar-month-abbrev-array' and
341 `calendar-day-abbrev-array') with or without a period,
342 capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be
343 `*' which matches any day, month, or year, respectively. If the
344 date does not contain a year, it is generic and applies to any
345 year. A DAYNAME entry applies to the appropriate day of the week
346 in every week.
348 The European style (in which the day precedes the month) can be
349 used instead, if you execute `european-calendar' when in the
350 calendar, or set `european-calendar-style' to t in your .emacs
351 file. The European forms (see `european-date-diary-pattern') are
353 DAY/MONTH
354 DAY/MONTH/YEAR
355 DAY MONTHNAME
356 DAY MONTHNAME YEAR
357 DAYNAME
359 To revert to the default American style from the European style, execute
360 `american-calendar' in the calendar.
362 A diary entry can be preceded by the character
363 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
364 nonmarking--that is, it will not be marked on dates in the calendar
365 window but will appear in a diary window.
367 Multiline diary entries are made by indenting lines after the first with
368 either a TAB or one or more spaces.
370 Lines not in one the above formats are ignored. Here are some sample diary
371 entries (in the default American style):
373 12/22/1988 Twentieth wedding anniversary!!
374 &1/1. Happy New Year!
375 10/22 Ruth's birthday.
376 21: Payday
377 Tuesday--weekly meeting with grad students at 10am
378 Supowit, Shen, Bitner, and Kapoor to attend.
379 1/13/89 Friday the thirteenth!!
380 &thu 4pm squash game with Lloyd.
381 mar 16 Dad's birthday
382 April 15, 1989 Income tax due.
383 &* 15 time cards due.
385 If the first line of a diary entry consists only of the date or day name with
386 no trailing blanks or punctuation, then that line is not displayed in the
387 diary window; only the continuation lines is shown. For example, the
388 single diary entry
390 02/11/1989
391 Bill Blattner visits Princeton today
392 2pm Cognitive Studies Committee meeting
393 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
394 4:00pm Jamie Tappenden
395 7:30pm Dinner at George and Ed's for Alan Ryan
396 7:30-10:00pm dance at Stewart Country Day School
398 will appear in the diary window without the date line at the beginning. This
399 facility allows the diary window to look neater, but can cause confusion if
400 used with more than one day's entries displayed.
402 Diary entries can be based on Lisp sexps. For example, the diary entry
404 %%(diary-block 11 1 1990 11 10 1990) Vacation
406 causes the diary entry \"Vacation\" to appear from November 1 through
407 November 10, 1990. Other functions available are `diary-float',
408 `diary-anniversary', `diary-cyclic', `diary-day-of-year',
409 `diary-iso-date', `diary-french-date', `diary-hebrew-date',
410 `diary-islamic-date', `diary-bahai-date', `diary-mayan-date',
411 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
412 `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset',
413 `diary-phases-of-moon', `diary-parasha', `diary-omer',
414 `diary-rosh-hodesh', and `diary-sabbath-candles'. See the
415 documentation for the function `list-sexp-diary-entries' for more
416 details.
418 Diary entries based on the Hebrew, the Islamic and/or the Baha'i
419 calendar are also possible, but because these are somewhat slow, they
420 are ignored unless you set the `nongregorian-diary-listing-hook' and
421 the `nongregorian-diary-marking-hook' appropriately. See the
422 documentation for these functions for details.
424 Diary files can contain directives to include the contents of other files; for
425 details, see the documentation for the variable `list-diary-entries-hook'."
426 :type 'file
427 :group 'diary)
429 (defcustom diary-nonmarking-symbol "&"
430 "Symbol indicating that a diary entry is not to be marked in the calendar."
431 :type 'string
432 :group 'diary)
434 (defcustom hebrew-diary-entry-symbol "H"
435 "Symbol indicating a diary entry according to the Hebrew calendar."
436 :type 'string
437 :group 'diary)
439 (defcustom islamic-diary-entry-symbol "I"
440 "Symbol indicating a diary entry according to the Islamic calendar."
441 :type 'string
442 :group 'diary)
444 (defcustom bahai-diary-entry-symbol "B"
445 "Symbol indicating a diary entry according to the Baha'i calendar."
446 :type 'string
447 :group 'diary)
449 (defcustom abbreviated-calendar-year t
450 "Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
451 For the Gregorian calendar; similarly for the Hebrew, Islamic and
452 Baha'i calendars. If this variable is nil, years must be written in
453 full."
454 :type 'boolean
455 :group 'diary)
457 ;;;###autoload
458 (defcustom european-calendar-style nil
459 "Use the European style of dates in the diary and in any displays.
460 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
461 1990. The default European date styles (see `european-date-diary-pattern')
464 DAY/MONTH
465 DAY/MONTH/YEAR
466 DAY MONTHNAME
467 DAY MONTHNAME YEAR
468 DAYNAME
470 Names can be capitalized or not, written in full (as specified by the
471 variable `calendar-day-name-array'), or abbreviated (as specified by
472 `calendar-day-abbrev-array') with or without a period.
474 Setting this variable directly does not take effect (if the
475 calendar package is already loaded). Rather, use either
476 \\[customize] or the functions `european-calendar' and
477 `american-calendar'."
478 :type 'boolean
479 ;; Without :initialize (require 'calendar) throws an error because
480 ;; american-calendar is undefined at this point.
481 :initialize 'custom-initialize-default
482 :set (lambda (symbol value)
483 (if value
484 (european-calendar)
485 (american-calendar)))
486 :group 'diary)
488 (defcustom american-date-diary-pattern
489 '((month "/" day "[^/0-9]")
490 (month "/" day "/" year "[^0-9]")
491 (monthname " *" day "[^,0-9]")
492 (monthname " *" day ", *" year "[^0-9]")
493 (dayname "\\W"))
494 "List of pseudo-patterns describing the American patterns of date used.
495 See the documentation of `diary-date-forms' for an explanation."
496 :type '(repeat (choice (cons :tag "Backup"
497 :value (backup . nil)
498 (const backup)
499 (repeat (list :inline t :format "%v"
500 (symbol :tag "Keyword")
501 (choice symbol regexp))))
502 (repeat (list :inline t :format "%v"
503 (symbol :tag "Keyword")
504 (choice symbol regexp)))))
505 :group 'diary)
507 (defcustom european-date-diary-pattern
508 '((day "/" month "[^/0-9]")
509 (day "/" month "/" year "[^0-9]")
510 (backup day " *" monthname "\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
511 (day " *" monthname " *" year "[^0-9]")
512 (dayname "\\W"))
513 "List of pseudo-patterns describing the European patterns of date used.
514 See the documentation of `diary-date-forms' for an explanation."
515 :type '(repeat (choice (cons :tag "Backup"
516 :value (backup . nil)
517 (const backup)
518 (repeat (list :inline t :format "%v"
519 (symbol :tag "Keyword")
520 (choice symbol regexp))))
521 (repeat (list :inline t :format "%v"
522 (symbol :tag "Keyword")
523 (choice symbol regexp)))))
524 :group 'diary)
526 (defvar diary-font-lock-keywords)
528 (defcustom diary-date-forms
529 (if european-calendar-style
530 european-date-diary-pattern
531 american-date-diary-pattern)
532 "List of pseudo-patterns describing the forms of date used in the diary.
533 The patterns on the list must be MUTUALLY EXCLUSIVE and should not match
534 any portion of the diary entry itself, just the date component.
536 A pseudo-pattern is a list of regular expressions and the keywords `month',
537 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
538 match the name of the month (see `calendar-month-name-array'), capitalized
539 or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'),
540 followed by a period or not; it will also match `*'. Similarly, `dayname'
541 will match the name of the day (see `calendar-day-name-array'), capitalized or
542 not, or its user-specified abbreviation (see `calendar-day-abbrev-array'),
543 followed by a period or not. The keywords `month', `day', and `year' will
544 match those numerical values, preceded by arbitrarily many zeros; they will
545 also match `*'.
547 The matching of the diary entries with the date forms is done with the
548 standard syntax table from Fundamental mode, but with the `*' changed so
549 that it is a word constituent.
551 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
552 diary entry itself, the first element of the pattern MUST be `backup'. This
553 directive causes the date recognizer to back up to the beginning of the
554 current word of the diary entry, so in no case can the pattern match more than
555 a portion of the first word of the diary entry."
556 :type '(repeat (choice (cons :tag "Backup"
557 :value (backup . nil)
558 (const backup)
559 (repeat (list :inline t :format "%v"
560 (symbol :tag "Keyword")
561 (choice symbol regexp))))
562 (repeat (list :inline t :format "%v"
563 (symbol :tag "Keyword")
564 (choice symbol regexp)))))
565 :initialize 'custom-initialize-default
566 :set (lambda (symbol value)
567 (unless (equal value (eval symbol))
568 (custom-set-default symbol value)
569 (setq diary-font-lock-keywords (diary-font-lock-keywords))
570 ;; Need to redraw not just to get new font-locking, but also
571 ;; to pick up any newly recognized entries.
572 (and (diary-live-p)
573 (diary))))
574 :group 'diary)
576 (defcustom european-calendar-display-form
577 '((if dayname (concat dayname ", ")) day " " monthname " " year)
578 "Pseudo-pattern governing the way a date appears in the European style.
579 See the documentation of `calendar-date-display-form' for an explanation."
580 :type 'sexp
581 :group 'calendar)
583 (defcustom american-calendar-display-form
584 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
585 "Pseudo-pattern governing the way a date appears in the American style.
586 See the documentation of `calendar-date-display-form' for an explanation."
587 :type 'sexp
588 :group 'calendar)
590 (defcustom calendar-date-display-form
591 (if european-calendar-style
592 european-calendar-display-form
593 american-calendar-display-form)
594 "Pseudo-pattern governing the way a date appears.
596 Used by the function `calendar-date-string', a pseudo-pattern is a list of
597 expressions that can involve the keywords `month', `day', and `year', all
598 numbers in string form, and `monthname' and `dayname', both alphabetic
599 strings. For example, the ISO standard would use the pseudo- pattern
601 '(year \"-\" month \"-\" day)
603 while a typical American form would be
605 '(month \"/\" day \"/\" (substring year -2))
609 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
611 would give the usual American style in fixed-length fields.
613 See the documentation of the function `calendar-date-string'."
614 :type 'sexp
615 :group 'calendar)
617 (defun european-calendar ()
618 "Set the interpretation and display of dates to the European style."
619 (interactive)
620 (setq european-calendar-style t)
621 (setq calendar-date-display-form european-calendar-display-form)
622 (setq diary-date-forms european-date-diary-pattern)
623 (update-calendar-mode-line))
625 (defun american-calendar ()
626 "Set the interpretation and display of dates to the American style."
627 (interactive)
628 (setq european-calendar-style nil)
629 (setq calendar-date-display-form american-calendar-display-form)
630 (setq diary-date-forms american-date-diary-pattern)
631 (update-calendar-mode-line))
633 ;; FIXME move to diary-lib and adjust appt.
634 (defcustom diary-hook nil
635 "List of functions called after the display of the diary.
636 Can be used for appointment notification."
637 :type 'hook
638 :group 'diary)
640 (defcustom diary-display-hook nil
641 "List of functions that handle the display of the diary.
642 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
643 diary display.
645 Ordinarily, this just displays the diary buffer (with holidays indicated in
646 the mode line), if there are any relevant entries. At the time these
647 functions are called, the variable `diary-entries-list' is a list, in order
648 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
649 STRING), where string is the diary entry for the given date. This can be
650 used, for example, a different buffer for display (perhaps combined with
651 holidays), or produce hard copy output.
653 A function `fancy-diary-display' is provided as an alternative
654 choice for this hook; this function prepares a special noneditable diary
655 buffer with the relevant diary entries that has neat day-by-day arrangement
656 with headings. The fancy diary buffer will show the holidays unless the
657 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
658 diary buffer will not show days for which there are no diary entries, even
659 if that day is a holiday; if you want such days to be shown in the fancy
660 diary buffer, set the variable `diary-list-include-blanks' to t."
661 :type 'hook
662 :options '(fancy-diary-display)
663 :initialize 'custom-initialize-default
664 :set 'diary-set-maybe-redraw
665 :group 'diary)
667 (defcustom holidays-in-diary-buffer t
668 "Non-nil means include holidays in the diary display.
669 The holidays appear in the mode line of the diary buffer, or in the
670 fancy diary buffer next to the date. This slows down the diary functions
671 somewhat; setting it to nil makes the diary display faster."
672 :type 'boolean
673 :group 'holidays)
675 (defcustom calendar-debug-sexp nil
676 "Turn debugging on when evaluating a sexp in the diary or holiday list."
677 :type 'boolean
678 :group 'calendar)
680 ;;;###autoload
681 (defcustom general-holidays
682 '((holiday-fixed 1 1 "New Year's Day")
683 (holiday-float 1 1 3 "Martin Luther King Day")
684 (holiday-fixed 2 2 "Groundhog Day")
685 (holiday-fixed 2 14 "Valentine's Day")
686 (holiday-float 2 1 3 "President's Day")
687 (holiday-fixed 3 17 "St. Patrick's Day")
688 (holiday-fixed 4 1 "April Fools' Day")
689 (holiday-float 5 0 2 "Mother's Day")
690 (holiday-float 5 1 -1 "Memorial Day")
691 (holiday-fixed 6 14 "Flag Day")
692 (holiday-float 6 0 3 "Father's Day")
693 (holiday-fixed 7 4 "Independence Day")
694 (holiday-float 9 1 1 "Labor Day")
695 (holiday-float 10 1 2 "Columbus Day")
696 (holiday-fixed 10 31 "Halloween")
697 (holiday-fixed 11 11 "Veteran's Day")
698 (holiday-float 11 4 4 "Thanksgiving"))
699 "General holidays. Default value is for the United States.
700 See the documentation for `calendar-holidays' for details."
701 :type 'sexp
702 :group 'holidays)
703 ;;;###autoload
704 (put 'general-holidays 'risky-local-variable t)
706 ;;;###autoload
707 (defcustom oriental-holidays
708 '((if (fboundp 'atan)
709 (holiday-chinese-new-year)))
710 "Oriental holidays.
711 See the documentation for `calendar-holidays' for details."
712 :type 'sexp
713 :group 'holidays)
714 ;;;###autoload
715 (put 'oriental-holidays 'risky-local-variable t)
717 ;;;###autoload
718 (defcustom local-holidays nil
719 "Local holidays.
720 See the documentation for `calendar-holidays' for details."
721 :type 'sexp
722 :group 'holidays)
723 ;;;###autoload
724 (put 'local-holidays 'risky-local-variable t)
726 ;;;###autoload
727 (defcustom other-holidays nil
728 "User defined holidays.
729 See the documentation for `calendar-holidays' for details."
730 :type 'sexp
731 :group 'holidays)
732 ;;;###autoload
733 (put 'other-holidays 'risky-local-variable t)
735 (defcustom all-hebrew-calendar-holidays nil
736 "If nil, show only major holidays from the Hebrew calendar.
737 This means only those Jewish holidays that appear on secular calendars.
738 Otherwise, show all the holidays that would appear in a complete Hebrew
739 calendar."
740 :type 'boolean
741 :group 'holidays)
743 ;;;###autoload
744 (defvar hebrew-holidays-1
745 '((holiday-rosh-hashanah-etc)
746 (if all-hebrew-calendar-holidays
747 (holiday-julian
749 (let* ((m displayed-month)
750 (y displayed-year)
751 (year))
752 (increment-calendar-month m y -1)
753 (let ((year (extract-calendar-year
754 (calendar-julian-from-absolute
755 (calendar-absolute-from-gregorian
756 (list m 1 y))))))
757 (if (zerop (% (1+ year) 4))
759 21))) "\"Tal Umatar\" (evening)")))
760 "Component of the default value of `hebrew-holidays'.")
761 ;;;###autoload
762 (put 'hebrew-holidays-1 'risky-local-variable t)
764 ;;;###autoload
765 (defvar hebrew-holidays-2
766 '((if all-hebrew-calendar-holidays
767 (holiday-hanukkah)
768 (holiday-hebrew 9 25 "Hanukkah"))
769 (if all-hebrew-calendar-holidays
770 (holiday-hebrew
772 (let ((h-year (extract-calendar-year
773 (calendar-hebrew-from-absolute
774 (calendar-absolute-from-gregorian
775 (list displayed-month 28 displayed-year))))))
776 (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
779 11 10))
780 "Tzom Teveth"))
781 (if all-hebrew-calendar-holidays
782 (holiday-hebrew 11 15 "Tu B'Shevat")))
783 "Component of the default value of `hebrew-holidays'.")
784 ;;;###autoload
785 (put 'hebrew-holidays-2 'risky-local-variable t)
787 ;;;###autoload
788 (defvar hebrew-holidays-3
789 '((if all-hebrew-calendar-holidays
790 (holiday-hebrew
792 (let ((m displayed-month)
793 (y displayed-year))
794 (increment-calendar-month m y 1)
795 (let* ((h-year (extract-calendar-year
796 (calendar-hebrew-from-absolute
797 (calendar-absolute-from-gregorian
798 (list m
799 (calendar-last-day-of-month m y)
800 y)))))
801 (s-s
802 (calendar-hebrew-from-absolute
803 (if (=
804 (% (calendar-absolute-from-hebrew
805 (list 7 1 h-year))
808 (calendar-dayname-on-or-before
809 6 (calendar-absolute-from-hebrew
810 (list 11 17 h-year)))
811 (calendar-dayname-on-or-before
812 6 (calendar-absolute-from-hebrew
813 (list 11 16 h-year))))))
814 (day (extract-calendar-day s-s)))
815 day))
816 "Shabbat Shirah")))
817 "Component of the default value of `hebrew-holidays'.")
818 ;;;###autoload
819 (put 'hebrew-holidays-3 'risky-local-variable t)
821 ;;;###autoload
822 (defvar hebrew-holidays-4
823 '((holiday-passover-etc)
824 (if (and all-hebrew-calendar-holidays
825 (let* ((m displayed-month)
826 (y displayed-year)
827 (year))
828 (increment-calendar-month m y -1)
829 (let ((year (extract-calendar-year
830 (calendar-julian-from-absolute
831 cd - (calendar-absolute-from-gregorian
832 (list m 1 y))))))
833 (= 21 (% year 28)))))
834 (holiday-julian 3 26 "Kiddush HaHamah"))
835 (if all-hebrew-calendar-holidays
836 (holiday-tisha-b-av-etc)))
837 "Component of the default value of `hebrew-holidays'.")
838 ;;;###autoload
839 (put 'hebrew-holidays-4 'risky-local-variable t)
841 ;;;###autoload
842 (defcustom hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
843 hebrew-holidays-3 hebrew-holidays-4)
844 "Jewish holidays.
845 See the documentation for `calendar-holidays' for details."
846 :type 'sexp
847 :group 'holidays)
848 ;;;###autoload
849 (put 'hebrew-holidays 'risky-local-variable t)
851 (defcustom all-christian-calendar-holidays nil
852 "If nil, show only major holidays from the Christian calendar.
853 This means only those Christian holidays that appear on secular calendars.
854 Otherwise, show all the holidays that would appear in a complete Christian
855 calendar."
856 :type 'boolean
857 :group 'holidays)
859 ;;;###autoload
860 (defcustom christian-holidays
861 '((if all-christian-calendar-holidays
862 (holiday-fixed 1 6 "Epiphany"))
863 (holiday-easter-etc 0 "Easter Sunday")
864 (holiday-easter-etc -2 "Good Friday")
865 (holiday-easter-etc -46 "Ash Wednesday")
866 (if all-christian-calendar-holidays
867 (holiday-easter-etc -63 "Septuagesima Sunday"))
868 (if all-christian-calendar-holidays
869 (holiday-easter-etc -56 "Sexagesima Sunday"))
870 (if all-christian-calendar-holidays
871 (holiday-easter-etc -49 "Shrove Sunday"))
872 (if all-christian-calendar-holidays
873 (holiday-easter-etc -48 "Shrove Monday"))
874 (if all-christian-calendar-holidays
875 (holiday-easter-etc -47 "Shrove Tuesday"))
876 (if all-christian-calendar-holidays
877 (holiday-easter-etc -14 "Passion Sunday"))
878 (if all-christian-calendar-holidays
879 (holiday-easter-etc -7 "Palm Sunday"))
880 (if all-christian-calendar-holidays
881 (holiday-easter-etc -3 "Maundy Thursday"))
882 (if all-christian-calendar-holidays
883 (holiday-easter-etc 35 "Rogation Sunday"))
884 (if all-christian-calendar-holidays
885 (holiday-easter-etc 39 "Ascension Day"))
886 (if all-christian-calendar-holidays
887 (holiday-easter-etc 49 "Pentecost (Whitsunday)"))
888 (if all-christian-calendar-holidays
889 (holiday-easter-etc 50 "Whitmonday"))
890 (if all-christian-calendar-holidays
891 (holiday-easter-etc 56 "Trinity Sunday"))
892 (if all-christian-calendar-holidays
893 (holiday-easter-etc 60 "Corpus Christi"))
894 (if all-christian-calendar-holidays
895 (holiday-greek-orthodox-easter))
896 (if all-christian-calendar-holidays
897 (holiday-fixed 8 15 "Assumption"))
898 (if all-christian-calendar-holidays
899 (holiday-advent 0 "Advent"))
900 (holiday-fixed 12 25 "Christmas")
901 (if all-christian-calendar-holidays
902 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
903 "Christian holidays.
904 See the documentation for `calendar-holidays' for details."
905 :type 'sexp
906 :group 'holidays)
907 ;;;###autoload
908 (put 'christian-holidays 'risky-local-variable t)
910 (defcustom all-islamic-calendar-holidays nil
911 "If nil, show only major holidays from the Islamic calendar.
912 This means only those Islamic holidays that appear on secular calendars.
913 Otherwise, show all the holidays that would appear in a complete Islamic
914 calendar."
915 :type 'boolean
916 :group 'holidays)
918 ;;;###autoload
919 (defcustom islamic-holidays
920 '((holiday-islamic
922 (format "Islamic New Year %d"
923 (let ((m displayed-month)
924 (y displayed-year))
925 (increment-calendar-month m y 1)
926 (extract-calendar-year
927 (calendar-islamic-from-absolute
928 (calendar-absolute-from-gregorian
929 (list
930 m (calendar-last-day-of-month m y) y)))))))
931 (if all-islamic-calendar-holidays
932 (holiday-islamic 1 10 "Ashura"))
933 (if all-islamic-calendar-holidays
934 (holiday-islamic 3 12 "Mulad-al-Nabi"))
935 (if all-islamic-calendar-holidays
936 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
937 (if all-islamic-calendar-holidays
938 (holiday-islamic 8 15 "Shab-e-Bara't"))
939 (holiday-islamic 9 1 "Ramadan Begins")
940 (if all-islamic-calendar-holidays
941 (holiday-islamic 9 27 "Shab-e Qadr"))
942 (if all-islamic-calendar-holidays
943 (holiday-islamic 10 1 "Id-al-Fitr"))
944 (if all-islamic-calendar-holidays
945 (holiday-islamic 12 10 "Id-al-Adha")))
946 "Islamic holidays.
947 See the documentation for `calendar-holidays' for details."
948 :type 'sexp
949 :group 'holidays)
950 ;;;###autoload
951 (put 'islamic-holidays 'risky-local-variable t)
953 (defcustom all-bahai-calendar-holidays nil
954 "If nil, show only major holidays from the Baha'i calendar.
955 These are the days on which work and school must be suspended.
956 Otherwise, show all the holidays that would appear in a complete Baha'i
957 calendar."
958 :type 'boolean
959 :group 'holidays)
961 ;;;###autoload
962 (defcustom bahai-holidays
963 '((holiday-fixed
964 3 21
965 (format "Baha'i New Year (Naw-Ruz) %d" (- displayed-year (1- 1844))))
966 (holiday-fixed 4 21 "First Day of Ridvan")
967 (if all-bahai-calendar-holidays
968 (holiday-fixed 4 22 "Second Day of Ridvan"))
969 (if all-bahai-calendar-holidays
970 (holiday-fixed 4 23 "Third Day of Ridvan"))
971 (if all-bahai-calendar-holidays
972 (holiday-fixed 4 24 "Fourth Day of Ridvan"))
973 (if all-bahai-calendar-holidays
974 (holiday-fixed 4 25 "Fifth Day of Ridvan"))
975 (if all-bahai-calendar-holidays
976 (holiday-fixed 4 26 "Sixth Day of Ridvan"))
977 (if all-bahai-calendar-holidays
978 (holiday-fixed 4 27 "Seventh Day of Ridvan"))
979 (if all-bahai-calendar-holidays
980 (holiday-fixed 4 28 "Eighth Day of Ridvan"))
981 (holiday-fixed 4 29 "Ninth Day of Ridvan")
982 (if all-bahai-calendar-holidays
983 (holiday-fixed 4 30 "Tenth Day of Ridvan"))
984 (if all-bahai-calendar-holidays
985 (holiday-fixed 5 1 "Eleventh Day of Ridvan"))
986 (holiday-fixed 5 2 "Twelfth Day of Ridvan")
987 (holiday-fixed 5 23 "Declaration of the Bab")
988 (holiday-fixed 5 29 "Ascension of Baha'u'llah")
989 (holiday-fixed 7 9 "Martyrdom of the Bab")
990 (holiday-fixed 10 20 "Birth of the Bab")
991 (holiday-fixed 11 12 "Birth of Baha'u'llah")
992 (if all-bahai-calendar-holidays
993 (holiday-fixed 11 26 "Day of the Covenant"))
994 (if all-bahai-calendar-holidays
995 (holiday-fixed 11 28 "Ascension of `Abdu'l-Baha")))
996 "Baha'i holidays.
997 See the documentation for `calendar-holidays' for details."
998 :type 'sexp
999 :group 'holidays)
1000 ;;;###autoload
1001 (put 'bahai-holidays 'risky-local-variable t)
1003 ;;;###autoload
1004 (defcustom solar-holidays
1005 '((if (fboundp 'atan)
1006 (solar-equinoxes-solstices))
1007 (if (require 'cal-dst)
1008 (funcall
1009 'holiday-sexp
1010 calendar-daylight-savings-starts
1011 '(format "Daylight Saving Time Begins %s"
1012 (if (fboundp 'atan)
1013 (solar-time-string
1014 (/ calendar-daylight-savings-starts-time (float 60))
1015 calendar-standard-time-zone-name)
1016 ""))))
1017 (funcall
1018 'holiday-sexp
1019 calendar-daylight-savings-ends
1020 '(format "Daylight Saving Time Ends %s"
1021 (if (fboundp 'atan)
1022 (solar-time-string
1023 (/ calendar-daylight-savings-ends-time (float 60))
1024 calendar-daylight-time-zone-name)
1025 ""))))
1026 "Sun-related holidays.
1027 See the documentation for `calendar-holidays' for details."
1028 :type 'sexp
1029 :group 'holidays)
1030 ;;;###autoload
1031 (put 'solar-holidays 'risky-local-variable t)
1033 ;;;###autoload
1034 (defcustom calendar-holidays
1035 (append general-holidays local-holidays other-holidays
1036 christian-holidays hebrew-holidays islamic-holidays
1037 bahai-holidays oriental-holidays solar-holidays)
1038 "List of notable days for the command \\[holidays].
1040 Additional holidays are easy to add to the list, just put them in the
1041 list `other-holidays' in your .emacs file. Similarly, by setting any
1042 of `general-holidays', `local-holidays' `christian-holidays',
1043 `hebrew-holidays', `islamic-holidays', `bahai-holidays',
1044 `oriental-holidays', or `solar-holidays' to nil in your .emacs file,
1045 you can eliminate unwanted categories of holidays.
1047 The aforementioned variables control the holiday choices offered
1048 by the function `holiday-list' when it is called interactively.
1050 They also initialize the default value of `calendar-holidays',
1051 which is the default list of holidays used by the function
1052 `holiday-list' in the non-interactive case. Note that these
1053 variables have no effect on `calendar-holidays' after it has been
1054 set (e.g. after the calendar is loaded). In that case, customize
1055 `calendar-holidays' directly.
1057 The intention is that (in the US) `local-holidays' be set in
1058 site-init.el and `other-holidays' be set by the user.
1060 Entries on the list are expressions that return (possibly empty) lists of
1061 items of the form ((month day year) string) of a holiday in the in the
1062 three-month period centered around `displayed-month' of `displayed-year'.
1063 Several basic functions are provided for this purpose:
1065 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1066 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1067 MONTH on the Gregorian calendar (0 for Sunday,
1068 etc.); K<0 means count back from the end of the
1069 month. An optional parameter DAY means the Kth
1070 DAYNAME after/before MONTH DAY.
1071 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1072 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1073 (holiday-bahai MONTH DAY STRING) a fixed date on the Baha'i calendar
1074 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1075 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
1076 in the variable `year'; if it evaluates to
1077 a visible date, that's the holiday; if it
1078 evaluates to nil, there's no holiday. STRING
1079 is an expression in the variable `date'.
1081 For example, to add Bastille Day, celebrated in France on July 14, add
1083 (holiday-fixed 7 14 \"Bastille Day\")
1085 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1086 Islands on the fourth Monday in August, add
1088 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
1090 to the list (the last Monday would be specified with `-1' instead of `4').
1091 To add the last day of Hanukkah to the list, use
1093 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
1095 since the Hebrew months are numbered with 1 starting from Nisan, while to
1096 add the Islamic feast celebrating Mohammed's birthday use
1098 (holiday-islamic 3 12 \"Mohammed's Birthday\")
1100 since the Islamic months are numbered from 1 starting with Muharram. To
1101 add an entry for the Baha'i festival of Ridvan, use
1103 (holiday-bahai 2 13 \"Festival of Ridvan\")
1105 since the Baha'i months are numbered from 1 starting with Baha. To
1106 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1108 (holiday-julian 4 2 \"Jefferson's Birthday\")
1110 To include a holiday conditionally, use the sexp form or a conditional. For
1111 example, to include American presidential elections, which occur on the first
1112 Tuesday after the first Monday in November of years divisible by 4, add
1114 (holiday-sexp
1115 '(if (zerop (% year 4))
1116 (calendar-gregorian-from-absolute
1117 (1+ (calendar-dayname-on-or-before
1118 1 (+ 6 (calendar-absolute-from-gregorian
1119 (list 11 1 year)))))))
1120 \"US Presidential Election\")
1124 (if (zerop (% displayed-year 4))
1125 (holiday-fixed 11
1126 (extract-calendar-day
1127 (calendar-gregorian-from-absolute
1128 (1+ (calendar-dayname-on-or-before
1129 1 (+ 6 (calendar-absolute-from-gregorian
1130 (list 11 1 displayed-year)))))))
1131 \"US Presidential Election\"))
1133 to the list. To include the phases of the moon, add
1135 (lunar-phases)
1137 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1138 you've written to return a (possibly empty) list of the relevant VISIBLE dates
1139 with descriptive strings such as
1141 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
1142 :type 'sexp
1143 :group 'holidays)
1144 ;;;###autoload
1145 (put 'calendar-holidays 'risky-local-variable t)
1147 ;;; End of user options.
1149 (defconst calendar-buffer "*Calendar*"
1150 "Name of the buffer used for the calendar.")
1152 (defconst holiday-buffer "*Holidays*"
1153 "Name of the buffer used for the displaying the holidays.")
1155 (defconst fancy-diary-buffer "*Fancy Diary Entries*"
1156 "Name of the buffer used for the optional fancy display of the diary.")
1158 (defconst other-calendars-buffer "*Other Calendars*"
1159 "Name of the buffer used for the display of date on other calendars.")
1161 (defconst lunar-phases-buffer "*Phases of Moon*"
1162 "Name of the buffer used for the lunar phases.")
1164 (defconst cal-hebrew-yahrzeit-buffer "*Yahrzeits*"
1165 "Name of the buffer used by `list-yahrzeit-dates'.")
1167 (defmacro increment-calendar-month (mon yr n)
1168 "Increment the variables MON and YR by N months.
1169 Forward if N is positive or backward if N is negative.
1170 A negative YR is interpreted as BC; -1 being 1 BC, and so on."
1171 `(let (macro-y)
1172 (if (< ,yr 0) (setq ,yr (1+ ,yr))) ; -1 BC -> 0 AD, etc
1173 (setq macro-y (+ (* ,yr 12) ,mon -1 ,n)
1174 ,mon (1+ (mod macro-y 12))
1175 ,yr (/ macro-y 12))
1176 (and (< macro-y 0) (> ,mon 1) (setq ,yr (1- ,yr)))
1177 (if (< ,yr 1) (setq ,yr (1- ,yr))))) ; 0 AD -> -1 BC, etc
1179 (defvar displayed-month)
1180 (defvar displayed-year)
1182 (defun calendar-increment-month (n &optional mon yr)
1183 "Return the Nth month after MON/YR.
1184 The return value is a pair (MONTH . YEAR).
1185 MON defaults to `displayed-month'. YR defaults to `displayed-year'."
1186 (unless mon (setq mon displayed-month))
1187 (unless yr (setq yr displayed-year))
1188 (increment-calendar-month mon yr n)
1189 (cons mon yr))
1191 (defmacro calendar-for-loop (var from init to final do &rest body)
1192 "Execute a for loop.
1193 Evaluate BODY with VAR bound to successive integers from INIT to FINAL,
1194 inclusive."
1195 (declare (debug (symbolp "from" form "to" form "do" body)))
1196 `(let ((,var (1- ,init)))
1197 (while (>= ,final (setq ,var (1+ ,var)))
1198 ,@body)))
1200 (defmacro calendar-sum (index initial condition expression)
1201 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
1202 (declare (debug (symbolp form form form)))
1203 `(let ((,index ,initial)
1204 (sum 0))
1205 (while ,condition
1206 (setq sum (+ sum ,expression))
1207 (setq ,index (1+ ,index)))
1208 sum))
1210 ;; The following are in-line for speed; they can be called thousands of times
1211 ;; when looking up holidays or processing the diary. Here, for example, are
1212 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1213 ;; fancy diary display, for a moderately complex diary file, with functions
1214 ;; used instead of macros. There were a total of 10000 such calls:
1216 ;; 1934 extract-calendar-month
1217 ;; 1852 extract-calendar-year
1218 ;; 1819 extract-calendar-day
1219 ;; 845 calendar-leap-year-p
1220 ;; 837 calendar-day-number
1221 ;; 775 calendar-absolute-from-gregorian
1222 ;; 346 calendar-last-day-of-month
1223 ;; 286 hebrew-calendar-last-day-of-month
1224 ;; 188 hebrew-calendar-leap-year-p
1225 ;; 180 hebrew-calendar-elapsed-days
1226 ;; 163 hebrew-calendar-last-month-of-year
1227 ;; 66 calendar-date-compare
1228 ;; 65 hebrew-calendar-days-in-year
1229 ;; 60 calendar-absolute-from-julian
1230 ;; 50 calendar-absolute-from-hebrew
1231 ;; 43 calendar-date-equal
1232 ;; 38 calendar-gregorian-from-absolute
1233 ;; .
1235 ;; The use of these seven macros eliminates the overhead of 92% of the function
1236 ;; calls; it's faster this way.
1238 (defsubst extract-calendar-month (date)
1239 "Extract the month part of DATE which has the form (month day year)."
1240 (car date))
1242 ;; Note gives wrong answer for result of (calendar-read-date 'noday).
1243 (defsubst extract-calendar-day (date)
1244 "Extract the day part of DATE which has the form (month day year)."
1245 (car (cdr date)))
1247 (defsubst extract-calendar-year (date)
1248 "Extract the year part of DATE which has the form (month day year)."
1249 (car (cdr (cdr date))))
1251 (defsubst calendar-leap-year-p (year)
1252 "Return t if YEAR is a Gregorian leap year.
1253 A negative year is interpreted as BC; -1 being 1 BC, and so on."
1254 ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc.
1255 (if (< year 0) (setq year (1- (abs year))))
1256 (and (zerop (% year 4))
1257 (or (not (zerop (% year 100)))
1258 (zerop (% year 400)))))
1260 ;; The foregoing is a bit faster, but not as clear as the following:
1262 ;;(defsubst calendar-leap-year-p (year)
1263 ;; "Return t if YEAR is a Gregorian leap year."
1264 ;; (or
1265 ;; (and (zerop (% year 4))
1266 ;; (not (zerop (% year 100))))
1267 ;; (zerop (% year 400)))
1269 (defsubst calendar-last-day-of-month (month year)
1270 "The last day in MONTH during YEAR."
1271 (if (and (= month 2) (calendar-leap-year-p year))
1273 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1275 ;; An explanation of the calculation can be found in PascAlgorithms by
1276 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1278 (defsubst calendar-day-number (date)
1279 "Return the day number within the year of the date DATE.
1280 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1281 while (calendar-day-number '(12 31 1980)) returns 366."
1282 (let* ((month (extract-calendar-month date))
1283 (day (extract-calendar-day date))
1284 (year (extract-calendar-year date))
1285 (day-of-year (+ day (* 31 (1- month)))))
1286 (if (> month 2)
1287 (progn
1288 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1289 (if (calendar-leap-year-p year)
1290 (setq day-of-year (1+ day-of-year)))))
1291 day-of-year))
1293 (defsubst calendar-absolute-from-gregorian (date)
1294 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1295 The Gregorian date Sunday, December 31, 1 BC is imaginary.
1296 DATE is a list of the form (month day year). A negative year is
1297 interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC
1298 return negative results."
1299 (let ((year (extract-calendar-year date))
1300 offset-years)
1301 (cond ((zerop year)
1302 (error "There was no year zero"))
1303 ((> year 0)
1304 (setq offset-years (1- year))
1305 (+ (calendar-day-number date) ; days this year
1306 (* 365 offset-years) ; + days in prior years
1307 (/ offset-years 4) ; + Julian leap years
1308 (- (/ offset-years 100)) ; - century years
1309 (/ offset-years 400))) ; + Gregorian leap years
1311 ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc).
1312 (setq offset-years (abs (1+ year)))
1313 (- (calendar-day-number date)
1314 (* 365 offset-years)
1315 (/ offset-years 4)
1316 (- (/ offset-years 100))
1317 (/ offset-years 400)
1318 (calendar-day-number '(12 31 -1))))))) ; days in year 1 BC
1320 ;;;###autoload
1321 (defun calendar (&optional arg)
1322 "Choose between the one frame, two frame, or basic calendar displays.
1323 If called with an optional prefix argument ARG, prompts for month and year.
1325 The original function `calendar' has been renamed `calendar-basic-setup'.
1326 See the documentation of that function for more information."
1327 (interactive "P")
1328 (cond ((equal calendar-setup 'one-frame) (calendar-one-frame-setup arg))
1329 ((equal calendar-setup 'two-frames) (calendar-two-frame-setup arg))
1330 ((equal calendar-setup 'calendar-only)
1331 (calendar-only-one-frame-setup arg))
1332 (t (calendar-basic-setup arg))))
1334 (defun calendar-basic-setup (&optional arg)
1335 "Display a three-month calendar in another window.
1336 The three months appear side by side, with the current month in the middle
1337 surrounded by the previous and next months. The cursor is put on today's date.
1339 If called with an optional prefix argument ARG, prompts for month and year.
1341 This function is suitable for execution in a .emacs file; appropriate setting
1342 of the variable `view-diary-entries-initially' will cause the diary entries for
1343 the current date to be displayed in another window. The value of the variable
1344 `number-of-diary-entries' controls the number of days of diary entries
1345 displayed upon initial display of the calendar.
1347 Once in the calendar window, future or past months can be moved into view.
1348 Arbitrary months can be displayed, or the calendar can be scrolled forward
1349 or backward.
1351 The cursor can be moved forward or backward by one day, one week, one month,
1352 or one year. All of these commands take prefix arguments which, when negative,
1353 cause movement in the opposite direction. For convenience, the digit keys
1354 and the minus sign are automatically prefixes. The window is replotted as
1355 necessary to display the desired date.
1357 Diary entries can be marked on the calendar or displayed in another window.
1359 Use \\[describe-mode] for details of the key bindings in the calendar window.
1361 The Gregorian calendar is assumed.
1363 After loading the calendar, the hooks given by the variable
1364 `calendar-load-hook' are run. This is the place to add key bindings to the
1365 `calendar-mode-map'.
1367 After preparing the calendar window initially, the hooks given by the variable
1368 `initial-calendar-window-hook' are run.
1370 The hooks given by the variable `today-visible-calendar-hook' are run
1371 every time the calendar window gets scrolled, if the current date is visible
1372 in the window. If it is not visible, the hooks given by the variable
1373 `today-invisible-calendar-hook' are run. Thus, for example, setting
1374 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1375 to be replaced by asterisks to highlight it whenever it is in the window."
1376 (interactive "P")
1377 (set-buffer (get-buffer-create calendar-buffer))
1378 (calendar-mode)
1379 (let* ((pop-up-windows t)
1380 (split-height-threshold 1000)
1381 (date (if arg
1382 (calendar-read-date t)
1383 (calendar-current-date)))
1384 (month (extract-calendar-month date))
1385 (year (extract-calendar-year date)))
1386 ;; (calendar-read-date t) returns a date with day = nil, which is
1387 ;; not a valid date for the visible test in the diary section.
1388 (if arg (setcar (cdr date) 1))
1389 (increment-calendar-month month year (- calendar-offset))
1390 ;; Display the buffer before calling generate-calendar-window so that it
1391 ;; can get a chance to adjust the window sizes to the frame size.
1392 (pop-to-buffer calendar-buffer)
1393 (generate-calendar-window month year)
1394 (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
1395 (diary-view-entries)))
1396 (let* ((diary-buffer (get-file-buffer diary-file))
1397 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1398 (split-height-threshold (if diary-window 2 1000)))
1399 (if view-calendar-holidays-initially
1400 (calendar-list-holidays)))
1401 (run-hooks 'initial-calendar-window-hook))
1403 (defun generate-calendar-window (&optional mon yr)
1404 "Generate the calendar window for the current date.
1405 Or, for optional MON, YR."
1406 (let* ((inhibit-read-only t)
1407 (today (calendar-current-date))
1408 (month (extract-calendar-month today))
1409 (day (extract-calendar-day today))
1410 (year (extract-calendar-year today))
1411 (today-visible
1412 (or (not mon)
1413 (let ((offset (calendar-interval mon yr month year)))
1414 (and (<= offset 1) (>= offset -1)))))
1415 (day-in-week (calendar-day-of-week today))
1416 (in-calendar-window (eq (window-buffer (selected-window))
1417 (get-buffer calendar-buffer))))
1418 (generate-calendar (or mon month) (or yr year))
1419 (update-calendar-mode-line)
1420 (calendar-cursor-to-visible-date
1421 (if today-visible today (list displayed-month 1 displayed-year)))
1422 (set-buffer-modified-p nil)
1423 ;; Don't do any window-related stuff if we weren't called from a
1424 ;; window displaying the calendar.
1425 (when in-calendar-window
1426 (if (or (one-window-p t) (not (window-full-width-p)))
1427 ;; Don't mess with the window size, but ensure that the first
1428 ;; line is fully visible.
1429 (set-window-vscroll nil 0)
1430 ;; Adjust the window to exactly fit the displayed calendar.
1431 (fit-window-to-buffer nil nil calendar-minimum-window-height))
1432 (sit-for 0))
1433 (if (and (boundp 'font-lock-mode)
1434 font-lock-mode)
1435 (font-lock-fontify-buffer))
1436 (and mark-holidays-in-calendar
1437 ;;; (calendar-date-is-valid-p today) ; useful for BC dates
1438 (calendar-mark-holidays)
1439 (and in-calendar-window (sit-for 0)))
1440 (unwind-protect
1441 (if mark-diary-entries-in-calendar (mark-diary-entries))
1442 (if today-visible
1443 (run-hooks 'today-visible-calendar-hook)
1444 (run-hooks 'today-invisible-calendar-hook)))))
1446 (defun generate-calendar (month year)
1447 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
1448 ;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on.
1449 ;; Note that while calendars for years BC could be displayed as it
1450 ;; stands, almost all other calendar functions (eg holidays) would
1451 ;; at best have unpredictable results for such dates.
1452 (if (< (+ month (* 12 (1- year))) 2)
1453 (error "Months before January, 1 AD cannot be displayed"))
1454 (setq displayed-month month
1455 displayed-year year)
1456 (erase-buffer)
1457 (increment-calendar-month month year -1)
1458 (dotimes (i 3)
1459 (generate-calendar-month month year (+ 5 (* 25 i)))
1460 (increment-calendar-month month year 1)))
1462 (defun generate-calendar-month (month year indent)
1463 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
1464 The calendar is inserted at the top of the buffer in which point is currently
1465 located, but indented INDENT spaces. The indentation is done from the first
1466 character on the line and does not disturb the first INDENT characters on the
1467 line."
1468 (let* ((blank-days ; at start of month
1469 (mod
1470 (- (calendar-day-of-week (list month 1 year))
1471 calendar-week-start-day)
1473 (last (calendar-last-day-of-month month year)))
1474 (goto-char (point-min))
1475 (calendar-insert-indented
1476 (calendar-string-spread
1477 (list (format "%s %d" (calendar-month-name month) year)) ? 20)
1478 indent t)
1479 (calendar-insert-indented "" indent) ; go to proper spot
1480 ;; Use the first two characters of each day to head the columns.
1481 (dotimes (i 7)
1482 (insert
1483 (let ((string
1484 (calendar-day-name (mod (+ calendar-week-start-day i) 7) nil t)))
1485 (if enable-multibyte-characters
1486 (truncate-string-to-width string 2)
1487 (substring string 0 2)))
1488 " "))
1489 (calendar-insert-indented "" 0 t) ; force onto following line
1490 (calendar-insert-indented "" indent) ; go to proper spot
1491 ;; Add blank days before the first of the month.
1492 (dotimes (idummy blank-days) (insert " "))
1493 ;; Put in the days of the month.
1494 (calendar-for-loop i from 1 to last do
1495 (insert (format "%2d " i))
1496 (add-text-properties
1497 (- (point) 3) (1- (point))
1498 '(mouse-face highlight
1499 help-echo "mouse-2: menu of operations for this date"))
1500 (and (zerop (mod (+ i blank-days) 7))
1501 (/= i last)
1502 (calendar-insert-indented "" 0 t) ; force onto following line
1503 (calendar-insert-indented "" indent))))) ; go to proper spot
1505 (defun calendar-insert-indented (string indent &optional newline)
1506 "Insert STRING at column INDENT.
1507 If the optional parameter NEWLINE is t, leave point at start of next line,
1508 inserting a newline if there was no next line; otherwise, leave point after
1509 the inserted text. Returns t."
1510 ;; Try to move to that column.
1511 (move-to-column indent)
1512 ;; If line is too short, indent out to that column.
1513 (if (< (current-column) indent)
1514 (indent-to indent))
1515 (insert string)
1516 ;; Advance to next line, if requested.
1517 (when newline
1518 (end-of-line)
1519 (if (eobp)
1520 (newline)
1521 (forward-line 1)))
1524 (defun redraw-calendar ()
1525 "Redraw the calendar display, if `calendar-buffer' is live."
1526 (interactive)
1527 (if (get-buffer calendar-buffer)
1528 (with-current-buffer calendar-buffer
1529 (let ((cursor-date (calendar-cursor-to-nearest-date)))
1530 (generate-calendar-window displayed-month displayed-year)
1531 (calendar-cursor-to-visible-date cursor-date)))))
1533 (defvar calendar-mode-map
1534 (let ((map (make-keymap)))
1535 (suppress-keymap map)
1536 (dolist (c '(narrow-to-region mark-word mark-sexp mark-paragraph
1537 mark-defun mark-whole-buffer mark-page
1538 downcase-region upcase-region kill-region
1539 copy-region-as-kill capitalize-region write-region))
1540 (define-key map (vector 'remap c) 'calendar-not-implemented))
1541 (define-key map "<" 'calendar-scroll-right)
1542 (define-key map "\C-x<" 'calendar-scroll-right)
1543 (define-key map [prior] 'calendar-scroll-right-three-months)
1544 (define-key map "\ev" 'calendar-scroll-right-three-months)
1545 (define-key map ">" 'calendar-scroll-left)
1546 (define-key map "\C-x>" 'calendar-scroll-left)
1547 (define-key map [next] 'calendar-scroll-left-three-months)
1548 (define-key map "\C-v" 'calendar-scroll-left-three-months)
1549 (define-key map "\C-b" 'calendar-backward-day)
1550 (define-key map "\C-p" 'calendar-backward-week)
1551 (define-key map "\e{" 'calendar-backward-month)
1552 (define-key map "\C-x[" 'calendar-backward-year)
1553 (define-key map "\C-f" 'calendar-forward-day)
1554 (define-key map "\C-n" 'calendar-forward-week)
1555 (define-key map [left] 'calendar-backward-day)
1556 (define-key map [up] 'calendar-backward-week)
1557 (define-key map [right] 'calendar-forward-day)
1558 (define-key map [down] 'calendar-forward-week)
1559 (define-key map "\e}" 'calendar-forward-month)
1560 (define-key map "\C-x]" 'calendar-forward-year)
1561 (define-key map "\C-a" 'calendar-beginning-of-week)
1562 (define-key map "\C-e" 'calendar-end-of-week)
1563 (define-key map "\ea" 'calendar-beginning-of-month)
1564 (define-key map "\ee" 'calendar-end-of-month)
1565 (define-key map "\e<" 'calendar-beginning-of-year)
1566 (define-key map "\e>" 'calendar-end-of-year)
1567 (define-key map "\C-@" 'calendar-set-mark)
1568 ;; Many people are used to typing C-SPC and getting C-@.
1569 (define-key map [?\C-\s] 'calendar-set-mark)
1570 (define-key map "\C-x\C-x" 'calendar-exchange-point-and-mark)
1571 (define-key map "\e=" 'calendar-count-days-region)
1572 (define-key map "gd" 'calendar-goto-date)
1573 (define-key map "gD" 'calendar-goto-day-of-year)
1574 (define-key map "gj" 'calendar-goto-julian-date)
1575 (define-key map "ga" 'calendar-goto-astro-day-number)
1576 (define-key map "gh" 'calendar-goto-hebrew-date)
1577 (define-key map "gi" 'calendar-goto-islamic-date)
1578 (define-key map "gb" 'calendar-bahai-goto-date)
1579 (define-key map "gC" 'calendar-goto-chinese-date)
1580 (define-key map "gk" 'calendar-goto-coptic-date)
1581 (define-key map "ge" 'calendar-goto-ethiopic-date)
1582 (define-key map "gp" 'calendar-goto-persian-date)
1583 (define-key map "gc" 'calendar-goto-iso-date)
1584 (define-key map "gw" 'calendar-goto-iso-week)
1585 (define-key map "gf" 'calendar-goto-french-date)
1586 (define-key map "gml" 'calendar-goto-mayan-long-count-date)
1587 (define-key map "gmpc" 'calendar-previous-calendar-round-date)
1588 (define-key map "gmnc" 'calendar-next-calendar-round-date)
1589 (define-key map "gmph" 'calendar-previous-haab-date)
1590 (define-key map "gmnh" 'calendar-next-haab-date)
1591 (define-key map "gmpt" 'calendar-previous-tzolkin-date)
1592 (define-key map "gmnt" 'calendar-next-tzolkin-date)
1593 (define-key map "Aa" 'appt-add)
1594 (define-key map "Ad" 'appt-delete)
1595 (define-key map "S" 'calendar-sunrise-sunset)
1596 (define-key map "M" 'calendar-phases-of-moon)
1597 (define-key map " " 'scroll-other-window)
1598 (define-key map (kbd "DEL") 'scroll-other-window-down)
1599 (define-key map "\C-c\C-l" 'redraw-calendar)
1600 (define-key map "." 'calendar-goto-today)
1601 (define-key map "o" 'calendar-other-month)
1602 (define-key map "q" 'exit-calendar)
1603 (define-key map "a" 'calendar-list-holidays)
1604 (define-key map "h" 'calendar-cursor-holidays)
1605 (define-key map "x" 'mark-calendar-holidays)
1606 (define-key map "u" 'calendar-unmark)
1607 (define-key map "m" 'mark-diary-entries)
1608 (define-key map "d" 'diary-view-entries)
1609 (define-key map "D" 'view-other-diary-entries)
1610 (define-key map "s" 'diary-show-all-entries)
1611 (define-key map "pd" 'calendar-print-day-of-year)
1612 (define-key map "pC" 'calendar-print-chinese-date)
1613 (define-key map "pk" 'calendar-print-coptic-date)
1614 (define-key map "pe" 'calendar-print-ethiopic-date)
1615 (define-key map "pp" 'calendar-print-persian-date)
1616 (define-key map "pc" 'calendar-print-iso-date)
1617 (define-key map "pj" 'calendar-print-julian-date)
1618 (define-key map "pa" 'calendar-print-astro-day-number)
1619 (define-key map "ph" 'calendar-print-hebrew-date)
1620 (define-key map "pi" 'calendar-print-islamic-date)
1621 (define-key map "pb" 'calendar-bahai-print-date)
1622 (define-key map "pf" 'calendar-print-french-date)
1623 (define-key map "pm" 'calendar-print-mayan-date)
1624 (define-key map "po" 'calendar-print-other-dates)
1625 (define-key map "id" 'insert-diary-entry)
1626 (define-key map "iw" 'insert-weekly-diary-entry)
1627 (define-key map "im" 'insert-monthly-diary-entry)
1628 (define-key map "iy" 'insert-yearly-diary-entry)
1629 (define-key map "ia" 'insert-anniversary-diary-entry)
1630 (define-key map "ib" 'insert-block-diary-entry)
1631 (define-key map "ic" 'insert-cyclic-diary-entry)
1632 (define-key map "ihd" 'insert-hebrew-diary-entry)
1633 (define-key map "ihm" 'insert-monthly-hebrew-diary-entry)
1634 (define-key map "ihy" 'insert-yearly-hebrew-diary-entry)
1635 (define-key map "iid" 'insert-islamic-diary-entry)
1636 (define-key map "iim" 'insert-monthly-islamic-diary-entry)
1637 (define-key map "iiy" 'insert-yearly-islamic-diary-entry)
1638 (define-key map "iBd" 'diary-bahai-insert-entry)
1639 (define-key map "iBm" 'diary-bahai-insert-monthly-entry)
1640 (define-key map "iBy" 'diary-bahai-insert-yearly-entry)
1641 (define-key map "?" 'calendar-goto-info-node)
1642 (define-key map "Hm" 'cal-html-cursor-month)
1643 (define-key map "Hy" 'cal-html-cursor-year)
1644 (define-key map "tm" 'cal-tex-cursor-month)
1645 (define-key map "tM" 'cal-tex-cursor-month-landscape)
1646 (define-key map "td" 'cal-tex-cursor-day)
1647 (define-key map "tw1" 'cal-tex-cursor-week)
1648 (define-key map "tw2" 'cal-tex-cursor-week2)
1649 (define-key map "tw3" 'cal-tex-cursor-week-iso)
1650 (define-key map "tw4" 'cal-tex-cursor-week-monday)
1651 (define-key map "tfd" 'cal-tex-cursor-filofax-daily)
1652 (define-key map "tfw" 'cal-tex-cursor-filofax-2week)
1653 (define-key map "tfW" 'cal-tex-cursor-filofax-week)
1654 (define-key map "tfy" 'cal-tex-cursor-filofax-year)
1655 (define-key map "ty" 'cal-tex-cursor-year)
1656 (define-key map "tY" 'cal-tex-cursor-year-landscape)
1658 (define-key map [menu-bar edit] 'undefined)
1659 (define-key map [menu-bar search] 'undefined)
1660 ;; This ignores the mouse-up event after the mouse-down that pops up the
1661 ;; context menu. It should not be necessary because the mouse-up event
1662 ;; should be eaten up by the menu-handling toolkit.
1663 ;; (define-key map [mouse-2] 'ignore)
1665 (easy-menu-define nil map nil cal-menu-moon-menu)
1666 (easy-menu-define nil map nil cal-menu-diary-menu)
1667 (easy-menu-define nil map nil cal-menu-holidays-menu)
1668 (easy-menu-define nil map nil cal-menu-goto-menu)
1669 (easy-menu-define nil map nil cal-menu-scroll-menu)
1671 (define-key map [down-mouse-3]
1672 (easy-menu-binding cal-menu-context-mouse-menu))
1673 (define-key map [down-mouse-2]
1674 (easy-menu-binding cal-menu-global-mouse-menu))
1676 map)
1677 "Keymap for `calendar-mode'.")
1679 (defun describe-calendar-mode ()
1680 "Create a help buffer with a brief description of the `calendar-mode'."
1681 (interactive)
1682 (help-setup-xref (list #'describe-calendar-mode) (interactive-p))
1683 (with-output-to-temp-buffer (help-buffer)
1684 (princ
1685 (format
1686 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
1687 (substitute-command-keys
1688 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
1689 (substitute-command-keys "\\{calendar-mode-map}")))
1690 (print-help-return-message)))
1692 ;; Calendar mode is suitable only for specially formatted data.
1693 (put 'calendar-mode 'mode-class 'special)
1695 ;; After calendar-mode-map.
1696 (defcustom calendar-mode-line-format
1697 (list
1698 (propertize "<"
1699 'help-echo "mouse-1: previous month"
1700 'mouse-face 'mode-line-highlight
1701 'keymap (make-mode-line-mouse-map 'mouse-1
1702 'calendar-scroll-right))
1703 "Calendar"
1704 (concat
1705 (propertize
1706 (substitute-command-keys
1707 "\\<calendar-mode-map>\\[calendar-goto-info-node] info")
1708 'help-echo "mouse-1: read Info on Calendar"
1709 'mouse-face 'mode-line-highlight
1710 'keymap (make-mode-line-mouse-map 'mouse-1 'calendar-goto-info-node))
1711 " / "
1712 (propertize
1713 (substitute-command-keys
1714 " \\<calendar-mode-map>\\[calendar-other-month] other")
1715 'help-echo "mouse-1: choose another month"
1716 'mouse-face 'mode-line-highlight
1717 'keymap (make-mode-line-mouse-map
1718 'mouse-1 'mouse-calendar-other-month))
1719 " / "
1720 (propertize
1721 (substitute-command-keys
1722 "\\<calendar-mode-map>\\[calendar-goto-today] today")
1723 'help-echo "mouse-1: go to today's date"
1724 'mouse-face 'mode-line-highlight
1725 'keymap (make-mode-line-mouse-map 'mouse-1 #'calendar-goto-today)))
1726 '(calendar-date-string (calendar-current-date) t)
1727 (propertize ">"
1728 'help-echo "mouse-1: next month"
1729 'mouse-face 'mode-line-highlight
1730 'keymap (make-mode-line-mouse-map
1731 'mouse-1 'calendar-scroll-left)))
1732 "The mode line of the calendar buffer.
1734 This must be a list of items that evaluate to strings--those strings are
1735 evaluated and concatenated together, evenly separated by blanks. The variable
1736 `date' is available for use as the date under (or near) the cursor; `date'
1737 defaults to the current date if it is otherwise undefined. Here is an example
1738 value that has the Hebrew date, the day number/days remaining in the year,
1739 and the ISO week/year numbers in the mode. When `calendar-move-hook' is set
1740 to `update-calendar-mode-line', the mode line shows these values for the date
1741 under the cursor:
1743 (list
1744 \"\"
1745 '(calendar-hebrew-date-string date)
1746 '(let* ((year (extract-calendar-year date))
1747 (d (calendar-day-number date))
1748 (days-remaining
1749 (- (calendar-day-number (list 12 31 year)) d)))
1750 (format \"%d/%d\" d days-remaining))
1751 '(let* ((d (calendar-absolute-from-gregorian date))
1752 (iso-date (calendar-iso-from-absolute d)))
1753 (format \"ISO week %d of %d\"
1754 (extract-calendar-month iso-date)
1755 (extract-calendar-year iso-date)))
1756 \"\"))"
1757 :type 'sexp
1758 :group 'calendar)
1760 (defun mouse-calendar-other-month (event)
1761 "Display a three-month calendar centered around a specified month and year."
1762 (interactive "e")
1763 (save-selected-window
1764 (select-window (posn-window (event-start event)))
1765 (call-interactively 'calendar-other-month)))
1767 (defun calendar-goto-info-node ()
1768 "Go to the info node for the calendar."
1769 (interactive)
1770 (info "(emacs)Calendar/Diary"))
1772 (defvar calendar-mark-ring nil
1773 "Used by `calendar-set-mark'.")
1775 (defvar calendar-starred-day nil
1776 "Stores the value of the last date that `calendar-star-date' replaced.")
1778 (defun calendar-mode ()
1779 "A major mode for the calendar window.
1781 For a complete description, type \
1782 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
1784 \\<calendar-mode-map>\\{calendar-mode-map}"
1785 (kill-all-local-variables)
1786 (setq major-mode 'calendar-mode
1787 mode-name "Calendar"
1788 buffer-read-only t
1789 indent-tabs-mode nil)
1790 (use-local-map calendar-mode-map)
1791 (update-calendar-mode-line)
1792 (make-local-variable 'calendar-mark-ring)
1793 (make-local-variable 'calendar-starred-day)
1794 (make-local-variable 'displayed-month) ; month in middle of window
1795 (make-local-variable 'displayed-year) ; year in middle of window
1796 ;; Most functions only work if displayed-month and displayed-year are set,
1797 ;; so let's make sure they're always set. Most likely, this will be reset
1798 ;; soon in generate-calendar, but better safe than sorry.
1799 (unless (boundp 'displayed-month) (setq displayed-month 1))
1800 (unless (boundp 'displayed-year) (setq displayed-year 2001))
1801 (set (make-local-variable 'font-lock-defaults)
1802 '(calendar-font-lock-keywords t))
1803 (run-mode-hooks 'calendar-mode-hook))
1805 (defun calendar-string-spread (strings char length)
1806 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
1807 The effect is like mapconcat but the separating pieces are as balanced as
1808 possible. Each item of STRINGS is evaluated before concatenation so it can
1809 actually be an expression that evaluates to a string. If LENGTH is too short,
1810 the STRINGS are just concatenated and the result truncated."
1811 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
1812 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
1813 ;; Addison-Wesley, Reading, MA, 1989.
1814 (let* ((strings (mapcar 'eval
1815 (if (< (length strings) 2)
1816 (append (list "") strings (list ""))
1817 strings)))
1818 (n (- length (length (apply 'concat strings))))
1819 (m (1- (length strings)))
1820 (s (car strings))
1821 (strings (cdr strings))
1822 (i 0))
1823 (dolist (string strings)
1824 (setq s (concat s
1825 (make-string (max 0 (/ (+ n i) m)) char)
1826 string))
1827 (setq i (1+ i)))
1828 (substring s 0 length)))
1830 (defun update-calendar-mode-line ()
1831 "Update the calendar mode line with the current date and date style."
1832 (if (bufferp (get-buffer calendar-buffer))
1833 (with-current-buffer calendar-buffer
1834 (setq mode-line-format
1835 (calendar-string-spread
1836 (let ((date (condition-case nil
1837 (calendar-cursor-to-nearest-date)
1838 (error (calendar-current-date)))))
1839 (mapcar 'eval calendar-mode-line-format))
1840 ? (frame-width)))
1841 (force-mode-line-update))))
1843 (defun calendar-window-list ()
1844 "List of all calendar-related windows."
1845 (let ((calendar-buffers (calendar-buffer-list))
1846 list)
1847 (walk-windows (lambda (w)
1848 (if (memq (window-buffer w) calendar-buffers)
1849 (push w list)))
1850 nil t)
1851 list))
1853 (defun calendar-buffer-list ()
1854 "List of all calendar-related buffers (as buffers, not strings)."
1855 (let (buffs)
1856 (dolist (b (list cal-hebrew-yahrzeit-buffer lunar-phases-buffer
1857 holiday-buffer fancy-diary-buffer
1858 (get-file-buffer diary-file)
1859 calendar-buffer other-calendars-buffer))
1860 (and b (setq b (get-buffer b))
1861 (push b buffs)))
1862 buffs))
1864 (defun exit-calendar ()
1865 "Get out of the calendar window and hide it and related buffers."
1866 (interactive)
1867 (let* ((diary-buffer (get-file-buffer diary-file)))
1868 (if (or (not diary-buffer)
1869 (not (buffer-modified-p diary-buffer))
1870 (yes-or-no-p
1871 "Diary modified; do you really want to exit the calendar? "))
1872 ;; Need to do this multiple times because one time can replace some
1873 ;; calendar-related buffers with other calendar-related buffers.
1874 (mapc (lambda (x)
1875 (mapc 'calendar-hide-window (calendar-window-list)))
1876 (calendar-window-list)))))
1878 (defun calendar-hide-window (window)
1879 "Hide WINDOW if it is calendar-related."
1880 (let ((buffer (if (window-live-p window) (window-buffer window))))
1881 (if (memq buffer (calendar-buffer-list))
1882 (cond
1883 ((and (display-multi-frame-p)
1884 (eq 'icon (cdr (assoc 'visibility
1885 (frame-parameters
1886 (window-frame window))))))
1887 nil)
1888 ((and (display-multi-frame-p) (window-dedicated-p window))
1889 (if calendar-remove-frame-by-deleting
1890 (delete-frame (window-frame window))
1891 (iconify-frame (window-frame window))))
1892 ((not (and (select-window window) (one-window-p window)))
1893 (delete-window window))
1894 (t (set-buffer buffer)
1895 (bury-buffer))))))
1897 (defun calendar-current-date ()
1898 "Return the current date in a list (month day year)."
1899 (let ((now (decode-time)))
1900 (list (nth 4 now) (nth 3 now) (nth 5 now))))
1902 (defun calendar-cursor-to-date (&optional error)
1903 "Return a list (month day year) of current cursor position.
1904 If cursor is not on a specific date, signals an error if optional parameter
1905 ERROR is t, otherwise just returns nil."
1906 (let* ((segment (/ (current-column) 25))
1907 (month (% (+ displayed-month segment -1) 12))
1908 (month (if (zerop month) 12 month))
1909 (year
1910 (cond
1911 ((and (= 12 month) (zerop segment)) (1- displayed-year))
1912 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
1913 (t displayed-year))))
1914 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
1915 (< 2 (count-lines (point-min) (point))))
1916 (save-excursion
1917 (if (not (looking-at " "))
1918 (re-search-backward "[^0-9]"))
1919 (list month
1920 (string-to-number (buffer-substring (1+ (point)) (+ 4 (point))))
1921 year))
1922 (if (and (looking-at "\\*")
1923 (save-excursion
1924 (re-search-backward "[^*]")
1925 (looking-at ".\\*\\*")))
1926 (list month calendar-starred-day year)
1927 (if error (error "Not on a date!"))))))
1929 (add-to-list 'debug-ignored-errors "Not on a date!")
1931 ;; The following version of calendar-gregorian-from-absolute is preferred for
1932 ;; reasons of clarity, BUT it's much slower than the version that follows it.
1934 ;;(defun calendar-gregorian-from-absolute (date)
1935 ;; "Compute the list (month day year) corresponding to the absolute DATE.
1936 ;;The absolute date is the number of days elapsed since the (imaginary)
1937 ;;Gregorian date Sunday, December 31, 1 BC."
1938 ;; (let* ((approx (/ date 366)) ; approximation from below
1939 ;; (year ; search forward from the approximation
1940 ;; (+ approx
1941 ;; (calendar-sum y approx
1942 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
1943 ;; 1)))
1944 ;; (month ; search forward from January
1945 ;; (1+ (calendar-sum m 1
1946 ;; (> date
1947 ;; (calendar-absolute-from-gregorian
1948 ;; (list m (calendar-last-day-of-month m year) year)))
1949 ;; 1)))
1950 ;; (day ; calculate the day by subtraction
1951 ;; (- date
1952 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
1953 ;; (list month day year)))
1955 (defun calendar-gregorian-from-absolute (date)
1956 "Compute the list (month day year) corresponding to the absolute DATE.
1957 The absolute date is the number of days elapsed since the (imaginary)
1958 Gregorian date Sunday, December 31, 1 BC. This function does not
1959 handle dates in years BC."
1960 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
1961 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
1962 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
1963 ;; (April, 1993), pages 383-404 for an explanation.
1964 (let* ((d0 (1- date))
1965 (n400 (/ d0 146097))
1966 (d1 (% d0 146097))
1967 (n100 (/ d1 36524))
1968 (d2 (% d1 36524))
1969 (n4 (/ d2 1461))
1970 (d3 (% d2 1461))
1971 (n1 (/ d3 365))
1972 (day (1+ (% d3 365)))
1973 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
1974 (if (or (= n100 4) (= n1 4))
1975 (list 12 31 year)
1976 (let ((year (1+ year))
1977 (month 1))
1978 (while (let ((mdays (calendar-last-day-of-month month year)))
1979 (and (< mdays day)
1980 (setq day (- day mdays))))
1981 (setq month (1+ month)))
1982 (list month day year)))))
1984 (defun calendar-other-month (month year)
1985 "Display a three-month calendar centered around MONTH and YEAR."
1986 (interactive (calendar-read-date 'noday))
1987 (if (and (= month displayed-month)
1988 (= year displayed-year))
1990 (let ((old-date (calendar-cursor-to-date))
1991 (today (calendar-current-date)))
1992 (generate-calendar-window month year)
1993 (calendar-cursor-to-visible-date
1994 (cond
1995 ((calendar-date-is-visible-p old-date) old-date)
1996 ((calendar-date-is-visible-p today) today)
1997 (t (list month 1 year)))))))
1999 (defun calendar-set-mark (arg)
2000 "Mark the date under the cursor, or jump to marked date.
2001 With no prefix argument, push current date onto marked date ring.
2002 With argument ARG, jump to mark, pop it, and put point at end of ring."
2003 (interactive "P")
2004 (let ((date (calendar-cursor-to-date t)))
2005 (if (null arg)
2006 (progn
2007 (push date calendar-mark-ring)
2008 ;; Since the top of the mark ring is the marked date in the
2009 ;; calendar, the mark ring in the calendar is one longer than
2010 ;; in other buffers to get the same effect.
2011 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2012 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2013 (message "Mark set"))
2014 (if (null calendar-mark-ring)
2015 (error "No mark set in this buffer")
2016 (calendar-goto-date (car calendar-mark-ring))
2017 (setq calendar-mark-ring
2018 (cdr (nconc calendar-mark-ring (list date))))))))
2020 (defun calendar-exchange-point-and-mark ()
2021 "Exchange the current cursor position with the marked date."
2022 (interactive)
2023 (let ((mark (car calendar-mark-ring))
2024 (date (calendar-cursor-to-date t)))
2025 (if (null mark)
2026 (error "No mark set in this buffer")
2027 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2028 (calendar-goto-date mark))))
2030 (defun calendar-count-days-region ()
2031 "Count the number of days (inclusive) between point and the mark."
2032 (interactive)
2033 (let* ((days (- (calendar-absolute-from-gregorian
2034 (calendar-cursor-to-date t))
2035 (calendar-absolute-from-gregorian
2036 (or (car calendar-mark-ring)
2037 (error "No mark set in this buffer")))))
2038 (days (1+ (if (> days 0) days (- days)))))
2039 (message "Region has %d day%s (inclusive)"
2040 days (if (> days 1) "s" ""))))
2042 (defun calendar-not-implemented ()
2043 "Not implemented."
2044 (interactive)
2045 (error "%s not available in the calendar"
2046 (global-key-binding (this-command-keys))))
2048 (defun calendar-read (prompt acceptable &optional initial-contents)
2049 "Return an object read from the minibuffer.
2050 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2051 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2052 is a string to insert in the minibuffer before reading."
2053 (let ((value (read-minibuffer prompt initial-contents)))
2054 (while (not (funcall acceptable value))
2055 (setq value (read-minibuffer prompt initial-contents)))
2056 value))
2059 (defvar calendar-abbrev-length 3
2060 "*Length of abbreviations to be used for day and month names.
2061 See also `calendar-day-abbrev-array' and `calendar-month-abbrev-array'.")
2063 (defvar calendar-day-name-array
2064 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2065 "*Array of capitalized strings giving, in order, the day names.
2066 The first two characters of each string will be used to head the
2067 day columns in the calendar. See also the variable
2068 `calendar-day-abbrev-array'.")
2070 (defvar calendar-day-abbrev-array
2071 [nil nil nil nil nil nil nil]
2072 "*Array of capitalized strings giving the abbreviated day names.
2073 The order should be the same as that of the full names specified
2074 in `calendar-day-name-array'. These abbreviations may be used
2075 instead of the full names in the diary file. Do not include a
2076 trailing `.' in the strings specified in this variable, though
2077 you may use such in the diary file. If any element of this array
2078 is nil, then the abbreviation will be constructed as the first
2079 `calendar-abbrev-length' characters of the corresponding full name.")
2081 (defvar calendar-month-name-array
2082 ["January" "February" "March" "April" "May" "June"
2083 "July" "August" "September" "October" "November" "December"]
2084 "*Array of capitalized strings giving, in order, the month names.
2085 See also the variable `calendar-month-abbrev-array'.")
2087 (defvar calendar-month-abbrev-array
2088 [nil nil nil nil nil nil nil nil nil nil nil nil]
2089 "*Array of capitalized strings giving the abbreviated month names.
2090 The order should be the same as that of the full names specified
2091 in `calendar-month-name-array'. These abbreviations are used in
2092 the calendar menu entries, and can also be used in the diary
2093 file. Do not include a trailing `.' in the strings specified in
2094 this variable, though you may use such in the diary file. If any
2095 element of this array is nil, then the abbreviation will be
2096 constructed as the first `calendar-abbrev-length' characters of the
2097 corresponding full name.")
2100 (defun calendar-read-date (&optional noday)
2101 "Prompt for Gregorian date. Return a list (month day year).
2102 If optional NODAY is t, does not ask for day, but just returns
2103 \(month nil year); if NODAY is any other non-nil value the value returned is
2104 \(month year)"
2105 (let* ((year (calendar-read
2106 "Year (>0): "
2107 (lambda (x) (> x 0))
2108 (int-to-string (extract-calendar-year
2109 (calendar-current-date)))))
2110 (month-array calendar-month-name-array)
2111 (completion-ignore-case t)
2112 (month (cdr (assoc-string
2113 (completing-read
2114 "Month name: "
2115 (mapcar 'list (append month-array nil))
2116 nil t)
2117 (calendar-make-alist month-array 1) t)))
2118 (last (calendar-last-day-of-month month year)))
2119 (if noday
2120 (if (eq noday t)
2121 (list month nil year)
2122 (list month year))
2123 (list month
2124 (calendar-read (format "Day (1-%d): " last)
2125 (lambda (x) (and (< 0 x) (<= x last))))
2126 year))))
2128 (defun calendar-interval (mon1 yr1 mon2 yr2)
2129 "The number of months difference between MON1, YR1 and MON2, YR2.
2130 The result is positive if the second date is later than the first.
2131 Negative years are interpreted as years BC; -1 being 1 BC, and so on."
2132 (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc
2133 (if (< yr2 0) (setq yr2 (1+ yr2)))
2134 (+ (* 12 (- yr2 yr1))
2135 (- mon2 mon1)))
2137 (defun calendar-abbrev-construct (abbrev full &optional period)
2138 "Internal calendar function to return a complete abbreviation array.
2139 ABBREV is an array of abbreviations, FULL the corresponding array
2140 of full names. The return value is the ABBREV array, with any nil
2141 elements replaced by the first three characters taken from the
2142 corresponding element of FULL. If optional argument PERIOD is non-nil,
2143 each element returned has a final `.' character."
2144 (let (elem array name)
2145 (dotimes (i (length full))
2146 (setq name (aref full i)
2147 elem (or (aref abbrev i)
2148 (substring name 0
2149 (min calendar-abbrev-length (length name))))
2150 elem (format "%s%s" elem (if period "." ""))
2151 array (append array (list elem))))
2152 (vconcat array)))
2154 (defvar calendar-font-lock-keywords
2155 `((,(concat (regexp-opt (mapcar 'identity calendar-month-name-array) t)
2156 " -?[0-9]+")
2157 . font-lock-function-name-face) ; month and year
2158 (,(regexp-opt
2159 (list (substring (aref calendar-day-name-array 6) 0 2)
2160 (substring (aref calendar-day-name-array 0) 0 2)))
2161 ;; Saturdays and Sundays are highlighted differently.
2162 . font-lock-comment-face)
2163 ;; First two chars of each day are used in the calendar.
2164 (,(regexp-opt (mapcar (lambda (x) (substring x 0 2))
2165 calendar-day-name-array))
2166 . font-lock-reference-face))
2167 "Default keywords to highlight in Calendar mode.")
2169 (defun calendar-day-name (date &optional abbrev absolute)
2170 "Return a string with the name of the day of the week of DATE.
2171 DATE should be a list in the format (MONTH DAY YEAR), unless the
2172 optional argument ABSOLUTE is non-nil, in which case DATE should
2173 be an integer in the range 0 to 6 corresponding to the day of the
2174 week. Day names are taken from the variable `calendar-day-name-array',
2175 unless the optional argument ABBREV is non-nil, in which case
2176 the variable `calendar-day-abbrev-array' is used."
2177 (aref (if abbrev
2178 (calendar-abbrev-construct calendar-day-abbrev-array
2179 calendar-day-name-array)
2180 calendar-day-name-array)
2181 (if absolute date (calendar-day-of-week date))))
2183 (defun calendar-make-alist (sequence &optional start-index filter abbrevs)
2184 "Make an assoc list corresponding to SEQUENCE.
2185 Each element of sequence will be associated with an integer, starting
2186 from 1, or from START-INDEX if that is non-nil. If a sequence ABBREVS
2187 is supplied, the function `calendar-abbrev-construct' is used to
2188 construct abbreviations corresponding to the elements in SEQUENCE.
2189 Each abbreviation is entered into the alist with the same
2190 association index as the full name it represents.
2191 If FILTER is provided, apply it to each key in the alist."
2192 (let ((index 0)
2193 (offset (or start-index 1))
2194 (aseq (if abbrevs (calendar-abbrev-construct abbrevs sequence)))
2195 (aseqp (if abbrevs (calendar-abbrev-construct abbrevs sequence
2196 'period)))
2197 alist elem)
2198 (dotimes (i (length sequence) (reverse alist))
2199 (setq index (+ i offset)
2200 elem (elt sequence i)
2201 alist
2202 (cons (cons (if filter (funcall filter elem) elem) index) alist))
2203 (if aseq
2204 (setq elem (elt aseq i)
2205 alist (cons (cons (if filter (funcall filter elem) elem)
2206 index) alist)))
2207 (if aseqp
2208 (setq elem (elt aseqp i)
2209 alist (cons (cons (if filter (funcall filter elem) elem)
2210 index) alist))))))
2212 (defun calendar-month-name (month &optional abbrev)
2213 "Return a string with the name of month number MONTH.
2214 Months are numbered from one. Month names are taken from the
2215 variable `calendar-month-name-array', unless the optional
2216 argument ABBREV is non-nil, in which case
2217 `calendar-month-abbrev-array' is used."
2218 (aref (if abbrev
2219 (calendar-abbrev-construct calendar-month-abbrev-array
2220 calendar-month-name-array)
2221 calendar-month-name-array)
2222 (1- month)))
2224 (defun calendar-day-of-week (date)
2225 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc.
2226 DATE is a list of the form (month day year). A negative year is
2227 interpreted as BC; -1 being 1 BC, and so on."
2228 (mod (calendar-absolute-from-gregorian date) 7))
2230 (defun calendar-unmark ()
2231 "Delete all diary/holiday marks/highlighting from the calendar."
2232 (interactive)
2233 (setq mark-holidays-in-calendar nil)
2234 (setq mark-diary-entries-in-calendar nil)
2235 (redraw-calendar))
2237 (defun calendar-date-is-visible-p (date)
2238 "Return t if DATE is valid and is visible in the calendar window."
2239 (let ((gap (calendar-interval
2240 displayed-month displayed-year
2241 (extract-calendar-month date) (extract-calendar-year date))))
2242 (and (calendar-date-is-valid-p date) (> 2 gap) (< -2 gap))))
2244 (defun calendar-date-is-valid-p (date)
2245 "Return t if DATE is a valid date."
2246 (let ((month (extract-calendar-month date))
2247 (day (extract-calendar-day date))
2248 (year (extract-calendar-year date)))
2249 (and (<= 1 month) (<= month 12)
2250 ;; (calendar-read-date t) returns a date with day = nil.
2251 ;; Should not be valid (?), since many funcs prob assume integer.
2252 ;; (calendar-read-date 'noday) returns (month year), which
2253 ;; currently results in extract-calendar-year returning nil.
2254 day year (<= 1 day) (<= day (calendar-last-day-of-month month year))
2255 ;; BC dates left as non-valid, to suppress errors from
2256 ;; complex holiday algorithms not suitable for years BC.
2257 ;; Note there are side effects on calendar navigation.
2258 (<= 1 year))))
2260 (define-obsolete-function-alias 'calendar-date-is-legal-p
2261 'calendar-date-is-valid-p "23.1")
2263 (defun calendar-date-equal (date1 date2)
2264 "Return t if the DATE1 and DATE2 are the same."
2265 (and
2266 (= (extract-calendar-month date1) (extract-calendar-month date2))
2267 (= (extract-calendar-day date1) (extract-calendar-day date2))
2268 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2270 (defun mark-visible-calendar-date (date &optional mark)
2271 "Mark DATE in the calendar window with MARK.
2272 MARK is a single-character string, a list of face attributes/values, or a face.
2273 MARK defaults to `diary-entry-marker'."
2274 (if (calendar-date-is-valid-p date)
2275 (with-current-buffer calendar-buffer
2276 (save-excursion
2277 (calendar-cursor-to-visible-date date)
2278 (setq mark
2279 (or (and (stringp mark) (= (length mark) 1) mark) ; single-char
2280 (and (listp mark) (> (length mark) 0) mark) ; attr list
2281 (and (facep mark) mark) ; face-name
2282 diary-entry-marker))
2283 (cond
2284 ;; Face or an attr-list that contained a face.
2285 ((facep mark)
2286 (overlay-put
2287 (make-overlay (1- (point)) (1+ (point))) 'face mark))
2288 ;; Single-character.
2289 ((and (stringp mark) (= (length mark) 1))
2290 (let ((inhibit-read-only t))
2291 (forward-char 1)
2292 ;; Insert before delete so as to better preserve markers.
2293 (insert mark)
2294 (delete-char 1)
2295 (forward-char -2)))
2296 (t ; attr list
2297 (let ((temp-face
2298 (make-symbol
2299 (apply 'concat "temp-"
2300 (mapcar (lambda (sym)
2301 (cond
2302 ((symbolp sym) (symbol-name sym))
2303 ((numberp sym) (number-to-string sym))
2304 (t sym)))
2305 mark))))
2306 (faceinfo mark))
2307 (make-face temp-face)
2308 ;; Remove :face info from mark, copy the face info into temp-face.
2309 (while (setq faceinfo (memq :face faceinfo))
2310 (copy-face (read (nth 1 faceinfo)) temp-face)
2311 (setcar faceinfo nil)
2312 (setcar (cdr faceinfo) nil))
2313 (setq mark (delq nil mark))
2314 ;; Apply the font aspects.
2315 (apply 'set-face-attribute temp-face nil mark)
2316 (overlay-put
2317 (make-overlay (1- (point)) (1+ (point))) 'face temp-face))))))))
2319 (defun calendar-star-date ()
2320 "Replace the date under the cursor in the calendar window with asterisks.
2321 This function can be used with the `today-visible-calendar-hook' run after the
2322 calendar window has been prepared."
2323 (let ((inhibit-read-only t)
2324 (modified (buffer-modified-p)))
2325 (forward-char 1)
2326 (setq calendar-starred-day
2327 (string-to-number (buffer-substring (point) (- (point) 2))))
2328 ;; Insert before deleting, to better preserve markers.
2329 (insert "**")
2330 (forward-char -2)
2331 (delete-char -2)
2332 (forward-char 1)
2333 (restore-buffer-modified-p modified)))
2335 (defun calendar-mark-today ()
2336 "Mark the date under the cursor in the calendar window.
2337 The date is marked with `calendar-today-marker'. This function can be used with
2338 the `today-visible-calendar-hook' run after the calendar window has been
2339 prepared."
2340 (mark-visible-calendar-date
2341 (calendar-cursor-to-date)
2342 calendar-today-marker))
2344 (defun calendar-date-compare (date1 date2)
2345 "Return t if DATE1 is before DATE2, nil otherwise.
2346 The actual dates are in the car of DATE1 and DATE2."
2347 (< (calendar-absolute-from-gregorian (car date1))
2348 (calendar-absolute-from-gregorian (car date2))))
2350 (defun calendar-date-string (date &optional abbreviate nodayname)
2351 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2352 An optional parameter ABBREVIATE, when non-nil, causes the month
2353 and day names to be abbreviated as specified by
2354 `calendar-month-abbrev-array' and `calendar-day-abbrev-array',
2355 respectively. An optional parameter NODAYNAME, when t, omits the
2356 name of the day of the week."
2357 (let* ((dayname
2358 (unless nodayname
2359 (calendar-day-name date abbreviate)))
2360 (month (extract-calendar-month date))
2361 (monthname (calendar-month-name month abbreviate))
2362 (day (int-to-string (extract-calendar-day date)))
2363 (month (int-to-string month))
2364 (year (int-to-string (extract-calendar-year date))))
2365 (mapconcat 'eval calendar-date-display-form "")))
2367 (defun calendar-dayname-on-or-before (dayname date)
2368 "Return the absolute date of the DAYNAME on or before absolute DATE.
2369 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
2371 Note: Applying this function to d+6 gives us the DAYNAME on or after an
2372 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
2373 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
2374 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
2375 (- date (% (- date dayname) 7)))
2377 (defun calendar-nth-named-absday (n dayname month year &optional day)
2378 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2379 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2380 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2381 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2383 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2384 (if (> n 0)
2385 (+ (* 7 (1- n))
2386 (calendar-dayname-on-or-before
2387 dayname
2388 (+ 6 (calendar-absolute-from-gregorian
2389 (list month (or day 1) year)))))
2390 (+ (* 7 (1+ n))
2391 (calendar-dayname-on-or-before
2392 dayname
2393 (calendar-absolute-from-gregorian
2394 (list month
2395 (or day (calendar-last-day-of-month month year))
2396 year))))))
2398 (defun calendar-nth-named-day (n dayname month year &optional day)
2399 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2400 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2401 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2402 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2404 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2405 (calendar-gregorian-from-absolute
2406 (calendar-nth-named-absday n dayname month year day)))
2408 (defun calendar-day-of-year-string (&optional date)
2409 "String of day number of year of Gregorian DATE.
2410 Defaults to today's date if DATE is not given."
2411 (let* ((d (or date (calendar-current-date)))
2412 (year (extract-calendar-year d))
2413 (day (calendar-day-number d))
2414 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
2415 (format "Day %d of %d; %d day%s remaining in the year"
2416 day year days-remaining (if (= days-remaining 1) "" "s"))))
2418 (defun calendar-print-other-dates ()
2419 "Show dates on other calendars for date under the cursor."
2420 (interactive)
2421 (let* ((date (calendar-cursor-to-date t)))
2422 (with-current-buffer (get-buffer-create other-calendars-buffer)
2423 (let ((inhibit-read-only t)
2424 (modified (buffer-modified-p)))
2425 (calendar-set-mode-line
2426 (concat (calendar-date-string date) " (Gregorian)"))
2427 (erase-buffer)
2428 (apply
2429 'insert
2430 (delq nil
2431 (list
2432 (calendar-day-of-year-string date) "\n"
2433 (format "ISO date: %s\n" (calendar-iso-date-string date))
2434 (format "Julian date: %s\n"
2435 (calendar-julian-date-string date))
2436 (format "Astronomical (Julian) day number (at noon UTC): %s.0\n"
2437 (calendar-astro-date-string date))
2438 (format "Fixed (RD) date: %s\n"
2439 (calendar-absolute-from-gregorian date))
2440 (format "Hebrew date (before sunset): %s\n"
2441 (calendar-hebrew-date-string date))
2442 (format "Persian date: %s\n"
2443 (calendar-persian-date-string date))
2444 (let ((i (calendar-islamic-date-string date)))
2445 (if (not (string-equal i ""))
2446 (format "Islamic date (before sunset): %s\n" i)))
2447 (let ((b (calendar-bahai-date-string date)))
2448 (if (not (string-equal b ""))
2449 (format "Baha'i date (before sunset): %s\n" b)))
2450 (format "Chinese date: %s\n"
2451 (calendar-chinese-date-string date))
2452 (let ((c (calendar-coptic-date-string date)))
2453 (if (not (string-equal c ""))
2454 (format "Coptic date: %s\n" c)))
2455 (let ((e (calendar-ethiopic-date-string date)))
2456 (if (not (string-equal e ""))
2457 (format "Ethiopic date: %s\n" e)))
2458 (let ((f (calendar-french-date-string date)))
2459 (if (not (string-equal f ""))
2460 (format "French Revolutionary date: %s\n" f)))
2461 (format "Mayan date: %s\n"
2462 (calendar-mayan-date-string date)))))
2463 (goto-char (point-min))
2464 (restore-buffer-modified-p modified))
2465 (display-buffer other-calendars-buffer))))
2467 (defun calendar-print-day-of-year ()
2468 "Show day number in year/days remaining in year for date under the cursor."
2469 (interactive)
2470 (message "%s" (calendar-day-of-year-string (calendar-cursor-to-date t))))
2472 (defun calendar-set-mode-line (str)
2473 "Set mode line to STR, centered, surrounded by dashes."
2474 (let* ((edges (window-edges))
2475 ;; As per doc of window-width, total visible mode-line length.
2476 (width (- (nth 2 edges) (nth 0 edges))))
2477 (setq mode-line-format
2478 (if buffer-file-name
2479 `("-" mode-line-modified
2480 ,(calendar-string-spread (list str) ?- (- width 6))
2481 "---")
2482 (calendar-string-spread (list str) ?- width)))))
2484 (defun calendar-mod (m n)
2485 "Non-negative remainder of M/N with N instead of 0."
2486 (1+ (mod (1- m) n)))
2489 (defun calendar-version ()
2490 "Display the Calendar version."
2491 (interactive)
2492 (message "GNU Emacs %s" emacs-version))
2494 (make-obsolete 'calendar-version 'emacs-version "23.1")
2497 (run-hooks 'calendar-load-hook)
2499 (provide 'calendar)
2501 ;; Local variables:
2502 ;; byte-compile-dynamic: t
2503 ;; End:
2505 ;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8
2506 ;;; calendar.el ends here