(generate-calendar-month): Add help-echo to mouse-highlighted text.
[bpt/emacs.git] / lisp / calendar / calendar.el
CommitLineData
b578f267 1;;; calendar.el --- Calendar functions.
fd7fa35a 2
ae0317df 3;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997, 2000
b032077a 4;; Free Software Foundation, Inc.
3a801d0c 5
fd7fa35a 6;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
e9571d2a 7;; Keywords: calendar
3076647c 8;; Human-Keywords: calendar, Gregorian calendar, diary, holidays
fd7fa35a 9
ecaa0527
RS
10;; This file is part of GNU Emacs.
11
e555fdd8
RS
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
ecaa0527 17;; GNU Emacs is distributed in the hope that it will be useful,
e555fdd8
RS
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
b578f267
EN
23;; along with GNU Emacs; see the file COPYING. If not, write to the
24;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25;; Boston, MA 02111-1307, USA.
ecaa0527 26
fd7fa35a
ER
27;;; Commentary:
28
b0e6051a
GM
29;; This collection of functions implements a calendar window. It generates a
30;; calendar for the current month, together with the previous and coming
31;; months, or for any other three-month period. The calendar can be scrolled
32;; forward and backward in the window to show months in the past or future;
33;; the cursor can move forward and backward by days, weeks, or months, making
34;; it possible, for instance, to jump to the date a specified number of days,
35;; weeks, or months from the date under the cursor. The user can display a
36;; list of holidays and other notable days for the period shown; the notable
37;; days can be marked on the calendar, if desired. The user can also specify
38;; that dates having corresponding diary entries (in a file that the user
39;; specifies) be marked; the diary entries for any date can be viewed in a
40;; separate window. The diary and the notable days can be viewed
41;; independently of the calendar. Dates can be translated from the (usual)
42;; Gregorian calendar to the day of the year/days remaining in year, to the
43;; ISO commercial calendar, to the Julian (old style) calendar, to the Hebrew
44;; calendar, to the Islamic calendar, to the French Revolutionary calendar, to
45;; the Mayan calendar, to the Chinese calendar, to the Coptic calendar, to the
46;; Ethiopic calendar, and to the astronomical (Julian) day number. When
47;; floating point is available, times of sunrise/sunset can be displayed, as
48;; can the phases of the moon. Appointment notification for diary entries is
3076647c 49;; available. Calendar printing via LaTeX is available.
7e1dae73
JB
50
51;; The following files are part of the calendar/diary code:
52
3076647c 53;; appt.el Appointment notification
327b6868 54;; cal-china.el Chinese calendar
3076647c
ER
55;; cal-coptic.el Coptic/Ethiopic calendars
56;; cal-dst.el Daylight savings time rules
57;; cal-hebrew.el Hebrew calendar
327b6868 58;; cal-islam.el Islamic calendar
3076647c
ER
59;; cal-iso.el ISO calendar
60;; cal-julian.el Julian/astronomical calendars
61;; cal-mayan.el Mayan calendars
6a2aa94c 62;; cal-menu.el Menu support
7086b78e 63;; cal-move.el Movement in the calendar
a45eee72 64;; cal-persia.el Persian calendar
3076647c 65;; cal-tex.el Calendars in LaTeX
bcbb4a0a 66;; cal-x.el X-windows dedicated frame functions
f5e13137 67;; diary-lib.el Diary functions
7e1dae73 68;; holidays.el Holiday functions
7e1dae73 69;; lunar.el Phases of the moon
3076647c 70;; solar.el Sunrise/sunset, equinoxes/solstices
ecaa0527 71
ecaa0527 72;; Technical details of all the calendrical calculations can be found in
a96a5fca
PE
73;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
74;; Cambridge University Press (1997).
7e1dae73 75
a96a5fca 76;; An earlier version of the technical details appeared in
ecaa0527
RS
77;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
78;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
7e1dae73
JB
79;; pages 899-928. ``Calendrical Calculations, Part II: Three Historical
80;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
e4c61e50
JB
81;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
82;; pages 383-404.
7e1dae73
JB
83
84;; Hard copies of these two papers can be obtained by sending email to
85;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
86;; the message BODY containing your mailing address (snail).
ecaa0527 87
a96a5fca
PE
88;; Comments, corrections, and improvements should be sent to
89;; Edward M. Reingold Department of Computer Science
90;; (217) 333-6733 University of Illinois at Urbana-Champaign
91;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
92;; Urbana, Illinois 61801
93
fd7fa35a 94;;; Code:
ecaa0527 95
d4ff5db9
DL
96(eval-when-compile
97 (defvar displayed-month)
98 (defvar displayed-year)
99 (defvar calendar-month-name-array)
100 (defvar calendar-starred-day))
101
e555fdd8
RS
102(defun calendar-version ()
103 (interactive)
3076647c 104 (message "Version 6, October 12, 1995"))
e555fdd8 105
b032077a
RS
106(defgroup calendar nil
107 "Calendar and time management support."
108 :group 'applications)
109
110(defgroup diary nil
111 "Emacs diary."
112 :group 'calendar)
113
114(defgroup appt nil
115 "Appointment notification."
116 :group 'calendar)
117
118(defgroup holidays nil
119 "Holidays support in calendar."
120 :group 'calendar
121 :prefix "calendar-"
122 :group 'local)
123
124(defgroup chinese-calendar nil
125 "Chinese calendar support."
126 :group 'calendar)
127
128(defgroup calendar-tex nil
129 "Options for printing calendar with LaTeX."
130 :prefix "cal-tex-"
131 :group 'calendar)
132
133(defgroup calendar-hooks nil
134 "Calendar hooks."
135 :prefix "calendar-"
136 :group 'calendar)
137
138
d8a200a7 139;;;###autoload
b032077a 140(defcustom calendar-week-start-day 0
d8a200a7 141 "*The day of the week on which a week in the calendar begins.
b032077a
RS
1420 means Sunday (default), 1 means Monday, and so on."
143 :type 'integer
144 :group 'calendar)
d8a200a7 145
cba0c253 146;;;###autoload
b032077a 147(defcustom calendar-offset 0
cba0c253
ER
148 "*The offset of the principal month from the center of the calendar window.
1490 means the principal month is in the center (default), -1 means on the left,
150+1 means on the right. Larger (or smaller) values push the principal month off
b032077a
RS
151the screen."
152 :type 'integer
153 :group 'calendar)
cba0c253 154
7e1dae73 155;;;###autoload
b032077a 156(defcustom view-diary-entries-initially nil
e555fdd8 157 "*Non-nil means display current date's diary entries on entry.
ecaa0527
RS
158The diary is displayed in another window when the calendar is first displayed,
159if the current date is visible. The number of days of diary entries displayed
b032077a
RS
160is governed by the variable `number-of-diary-entries'."
161 :type 'boolean
162 :group 'diary)
ecaa0527 163
7e1dae73 164;;;###autoload
b032077a 165(defcustom number-of-diary-entries 1
ecaa0527 166 "*Specifies how many days of diary entries are to be displayed initially.
3cbb4860 167This variable affects the diary display when the command \\[diary] is used,
ecaa0527
RS
168or if the value of the variable `view-diary-entries-initially' is t. For
169example, if the default value 1 is used, then only the current day's diary
170entries will be displayed. If the value 2 is used, then both the current
e555fdd8
RS
171day's and the next day's entries will be displayed.
172
173The value can also be a vector such as [0 2 2 2 2 4 1]; this value
174says to display no diary entries on Sunday, the display the entries
175for the current date and the day after on Monday through Thursday,
176display Friday through Monday's entries on Friday, and display only
177Saturday's entries on Saturday.
178
179This variable does not affect the diary display with the `d' command
180from the calendar; in that case, the prefix argument controls the
b032077a
RS
181number of days of diary entries displayed."
182 :type '(choice (integer :tag "Entries")
183 (vector :value [0 0 0 0 0 0 0]
184 (integer :tag "Sunday")
185 (integer :tag "Monday")
186 (integer :tag "Tuesday")
187 (integer :tag "Wednesday")
188 (integer :tag "Thursday")
189 (integer :tag "Friday")
190 (integer :tag "Saturday")))
191 :group 'diary)
ecaa0527 192
7e1dae73 193;;;###autoload
b032077a 194(defcustom mark-diary-entries-in-calendar nil
e555fdd8 195 "*Non-nil means mark dates with diary entries, in the calendar window.
b032077a
RS
196The marking symbol is specified by the variable `diary-entry-marker'."
197 :type 'boolean
198 :group 'diary)
ecaa0527 199
7e1e5cf1
SS
200;;;###autoload
201(defcustom calendar-remove-frame-by-deleting nil
202 "*Determine how the calendar mode removes a frame no longer needed.
203If nil, make an icon of the frame. If non-nil, delete the frame."
204 :type 'boolean
205 :group 'view)
206
9c887ada
MB
207(add-to-list 'facemenu-unlisted-faces 'diary-face)
208(defface diary-face
209 '((((class color) (background light))
42121c23 210 :foreground "red")
9c887ada 211 (((class color) (background dark))
42121c23 212 :foreground "yellow")
9c887ada 213 (t
42121c23 214 :bold t))
9c887ada
MB
215 "Face for highlighting diary entries."
216 :group 'diary)
217
218(add-to-list 'facemenu-unlisted-faces 'calendar-today-face)
219(defface calendar-today-face
220 '((t (:underline t)))
221 "Face for indicating today's date."
222 :group 'diary)
223
224(add-to-list 'facemenu-unlisted-faces 'holiday-face)
225(defface holiday-face
226 '((((class color) (background light))
42121c23 227 :background "pink")
9c887ada 228 (((class color) (background dark))
42121c23 229 :background "chocolate4")
9c887ada 230 (t
42121c23 231 :inverse-video t))
9c887ada
MB
232 "Face for indicating dates that have holidays."
233 :group 'diary)
a69e7dae 234
b032077a 235(defcustom diary-entry-marker
13f0f988 236 (if (not (display-color-p))
6a2aa94c 237 "+"
6a2aa94c 238 'diary-face)
a69e7dae
RS
239 "*How to mark dates that have diary entries.
240The value can be either a single-character string or a face."
b032077a
RS
241 :type '(choice string face)
242 :group 'diary)
6a2aa94c 243
b032077a 244(defcustom calendar-today-marker
13f0f988 245 (if (not (display-color-p))
6a2aa94c 246 "="
6a2aa94c 247 'calendar-today-face)
a69e7dae
RS
248 "*How to mark today's date in the calendar.
249The value can be either a single-character string or a face.
250Marking today's date is done only if you set up `today-visible-calendar-hook'
251to request that."
b032077a
RS
252 :type '(choice string face)
253 :group 'calendar)
6a2aa94c 254
b032077a 255(defcustom calendar-holiday-marker
13f0f988 256 (if (not (display-color-p))
6a2aa94c 257 "*"
6a2aa94c 258 'holiday-face)
a69e7dae
RS
259 "*How to mark notable dates in the calendar.
260The value can be either a single-character string or a face."
b032077a
RS
261 :type '(choice string face)
262 :group 'calendar)
ecaa0527 263
7e1dae73 264;;;###autoload
b032077a 265(defcustom view-calendar-holidays-initially nil
e555fdd8 266 "*Non-nil means display holidays for current three month period on entry.
354d0644 267The holidays are displayed in another window when the calendar is first
b032077a
RS
268displayed."
269 :type 'boolean
270 :group 'holidays)
ecaa0527 271
e5d77022 272;;;###autoload
b032077a 273(defcustom mark-holidays-in-calendar nil
e555fdd8 274 "*Non-nil means mark dates of holidays in the calendar window.
b032077a
RS
275The marking symbol is specified by the variable `calendar-holiday-marker'."
276 :type 'boolean
277 :group 'holidays)
ecaa0527 278
e5d77022 279;;;###autoload
b032077a 280(defcustom all-hebrew-calendar-holidays nil
354d0644 281 "*If nil, show only major holidays from the Hebrew calendar.
e555fdd8 282This means only those Jewish holidays that appear on secular calendars.
354d0644 283
b032077a
RS
284If t, show all the holidays that would appear in a complete Hebrew calendar."
285 :type 'boolean
286 :group 'holidays)
ecaa0527 287
e5d77022 288;;;###autoload
b032077a 289(defcustom all-christian-calendar-holidays nil
354d0644 290 "*If nil, show only major holidays from the Christian calendar.
e555fdd8 291This means only those Christian holidays that appear on secular calendars.
354d0644 292
e555fdd8 293If t, show all the holidays that would appear in a complete Christian
b032077a
RS
294calendar."
295 :type 'boolean
296 :group 'holidays)
ecaa0527 297
e5d77022 298;;;###autoload
b032077a 299(defcustom all-islamic-calendar-holidays nil
354d0644 300 "*If nil, show only major holidays from the Islamic calendar.
e555fdd8 301This means only those Islamic holidays that appear on secular calendars.
354d0644 302
e555fdd8 303If t, show all the holidays that would appear in a complete Islamic
b032077a
RS
304calendar."
305 :type 'boolean
306 :group 'holidays)
ecaa0527 307
7e1dae73 308;;;###autoload
b032077a 309(defcustom calendar-load-hook nil
7e1dae73 310 "*List of functions to be called after the calendar is first loaded.
b032077a
RS
311This is the place to add key bindings to `calendar-mode-map'."
312 :type 'hook
313 :group 'calendar-hooks)
7e1dae73
JB
314
315;;;###autoload
b032077a 316(defcustom initial-calendar-window-hook nil
ecaa0527
RS
317 "*List of functions to be called when the calendar window is first opened.
318The functions invoked are called after the calendar window is opened, but
319once opened is never called again. Leaving the calendar with the `q' command
b032077a
RS
320and reentering it will cause these functions to be called again."
321 :type 'hook
322 :group 'calendar-hooks)
ecaa0527 323
7e1dae73 324;;;###autoload
b032077a 325(defcustom today-visible-calendar-hook nil
ecaa0527
RS
326 "*List of functions called whenever the current date is visible.
327This can be used, for example, to replace today's date with asterisks; a
328function `calendar-star-date' is included for this purpose:
329 (setq today-visible-calendar-hook 'calendar-star-date)
6b1abbd1 330It can also be used to mark the current date with `calendar-today-marker';
6a2aa94c 331a function is also provided for this:
ecaa0527
RS
332 (setq today-visible-calendar-hook 'calendar-mark-today)
333
334The corresponding variable `today-invisible-calendar-hook' is the list of
335functions called when the calendar function was called when the current
336date is not visible in the window.
337
338Other than the use of the provided functions, the changing of any
339characters in the calendar buffer by the hooks may cause the failure of the
b032077a
RS
340functions that move by days and weeks."
341 :type 'hook
342 :group 'calendar-hooks)
ecaa0527 343
7e1dae73 344;;;###autoload
b032077a 345(defcustom today-invisible-calendar-hook nil
ecaa0527
RS
346 "*List of functions called whenever the current date is not visible.
347
348The corresponding variable `today-visible-calendar-hook' is the list of
349functions called when the calendar function was called when the current
350date is visible in the window.
351
352Other than the use of the provided functions, the changing of any
353characters in the calendar buffer by the hooks may cause the failure of the
b032077a
RS
354functions that move by days and weeks."
355 :type 'hook
356 :group 'calendar-hooks)
ecaa0527 357
5c9705e5
RS
358;;;###autoload
359(defcustom calendar-move-hook nil
360 "*List of functions called whenever the cursor moves in the calendar.
361
7e1e5cf1 362For example,
5c9705e5
RS
363
364 (add-hook 'calendar-move-hook (lambda () (view-diary-entries 1)))
365
366redisplays the diary for whatever date the cursor is moved to."
367 :type 'hook
368 :group 'calendar-hooks)
369
7e1dae73 370;;;###autoload
b032077a 371(defcustom diary-file "~/diary"
ecaa0527
RS
372 "*Name of the file in which one's personal diary of dates is kept.
373
374The file's entries are lines in any of the forms
375
376 MONTH/DAY
377 MONTH/DAY/YEAR
378 MONTHNAME DAY
379 MONTHNAME DAY, YEAR
380 DAYNAME
381
382at the beginning of the line; the remainder of the line is the diary entry
383string for that date. MONTH and DAY are one or two digit numbers, YEAR is
384a number and may be written in full or abbreviated to the final two digits.
385If the date does not contain a year, it is generic and applies to any year.
386DAYNAME entries apply to any date on which is on that day of the week.
387MONTHNAME and DAYNAME can be spelled in full, abbreviated to three
388characters (with or without a period), capitalized or not. Any of DAY,
389MONTH, or MONTHNAME, YEAR can be `*' which matches any day, month, or year,
390respectively.
391
392The European style (in which the day precedes the month) can be used
393instead, if you execute `european-calendar' when in the calendar, or set
394`european-calendar-style' to t in your .emacs file. The European forms are
395
396 DAY/MONTH
397 DAY/MONTH/YEAR
398 DAY MONTHNAME
399 DAY MONTHNAME YEAR
400 DAYNAME
401
402To revert to the default American style from the European style, execute
403`american-calendar' in the calendar.
404
6b1abbd1
RS
405A diary entry can be preceded by the character
406`diary-nonmarking-symbol' (ordinarily `&') to make that entry
407nonmarking--that is, it will not be marked on dates in the calendar
408window but will appear in a diary window.
ecaa0527
RS
409
410Multiline diary entries are made by indenting lines after the first with
411either a TAB or one or more spaces.
412
413Lines not in one the above formats are ignored. Here are some sample diary
414entries (in the default American style):
415
416 12/22/1988 Twentieth wedding anniversary!!
417 &1/1. Happy New Year!
418 10/22 Ruth's birthday.
419 21: Payday
420 Tuesday--weekly meeting with grad students at 10am
421 Supowit, Shen, Bitner, and Kapoor to attend.
422 1/13/89 Friday the thirteenth!!
423 &thu 4pm squash game with Lloyd.
424 mar 16 Dad's birthday
425 April 15, 1989 Income tax due.
426 &* 15 time cards due.
427
428If the first line of a diary entry consists only of the date or day name with
e555fdd8
RS
429no trailing blanks or punctuation, then that line is not displayed in the
430diary window; only the continuation lines is shown. For example, the
ecaa0527
RS
431single diary entry
432
433 02/11/1989
434 Bill Blattner visits Princeton today
435 2pm Cognitive Studies Committee meeting
436 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
437 4:00pm Jamie Tappenden
438 7:30pm Dinner at George and Ed's for Alan Ryan
439 7:30-10:00pm dance at Stewart Country Day School
440
441will appear in the diary window without the date line at the beginning. This
442facility allows the diary window to look neater, but can cause confusion if
443used with more than one day's entries displayed.
444
445Diary entries can be based on Lisp sexps. For example, the diary entry
446
447 %%(diary-block 11 1 1990 11 10 1990) Vacation
448
b0e6051a
GM
449causes the diary entry \"Vacation\" to appear from November 1 through November
45010, 1990. Other functions available are `diary-float', `diary-anniversary',
451`diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date',
452`diary-hebrew-date', `diary-islamic-date', `diary-mayan-date',
7086b78e 453`diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
c21eb13d 454`diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset',
b0e6051a
GM
455`diary-phases-of-moon', `diary-parasha', `diary-omer', `diary-rosh-hodesh',
456and `diary-sabbath-candles'. See the documentation for the function
457`list-sexp-diary-entries' for more details.
ecaa0527 458
b0e6051a
GM
459Diary entries based on the Hebrew and/or the Islamic calendar are also
460possible, but because these are somewhat slow, they are ignored
461unless you set the `nongregorian-diary-listing-hook' and the
462`nongregorian-diary-marking-hook' appropriately. See the documentation
463for these functions for details.
ecaa0527
RS
464
465Diary files can contain directives to include the contents of other files; for
b032077a
RS
466details, see the documentation for the variable `list-diary-entries-hook'."
467 :type 'file
468 :group 'diary)
ecaa0527 469
7e1dae73 470;;;###autoload
b032077a
RS
471(defcustom diary-nonmarking-symbol "&"
472 "*Symbol indicating that a diary entry is not to be marked in the calendar."
473 :type 'string
474 :group 'diary)
ecaa0527 475
7e1dae73 476;;;###autoload
b032077a
RS
477(defcustom hebrew-diary-entry-symbol "H"
478 "*Symbol indicating a diary entry according to the Hebrew calendar."
479 :type 'string
480 :group 'diary)
ecaa0527 481
7e1dae73 482;;;###autoload
b032077a
RS
483(defcustom islamic-diary-entry-symbol "I"
484 "*Symbol indicating a diary entry according to the Islamic calendar."
485 :type 'string
486 :group 'diary)
ecaa0527 487
7e1dae73 488;;;###autoload
b032077a 489(defcustom diary-include-string "#include"
354d0644 490 "*The string indicating inclusion of another file of diary entries.
b032077a
RS
491See the documentation for the function `include-other-diary-files'."
492 :type 'string
493 :group 'diary)
ecaa0527 494
7e1dae73 495;;;###autoload
b032077a 496(defcustom sexp-diary-entry-symbol "%%"
3cbb4860 497 "*The string used to indicate a sexp diary entry in `diary-file'.
b032077a
RS
498See the documentation for the function `list-sexp-diary-entries'."
499 :type 'string
500 :group 'diary)
ecaa0527 501
7e1dae73 502;;;###autoload
b032077a 503(defcustom abbreviated-calendar-year t
354d0644 504 "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
b0e6051a
GM
505For the Gregorian calendar; similarly for the Hebrew and Islamic calendars.
506If this variable is nil, years must be written in full."
b032077a
RS
507 :type 'boolean
508 :group 'diary)
ecaa0527 509
7e1dae73 510;;;###autoload
b032077a 511(defcustom european-calendar-style nil
354d0644
JB
512 "*Use the European style of dates in the diary and in any displays.
513If this variable is t, a date 1/2/1990 would be interpreted as February 1,
5141990. The accepted European date styles are
ecaa0527
RS
515
516 DAY/MONTH
517 DAY/MONTH/YEAR
518 DAY MONTHNAME
519 DAY MONTHNAME YEAR
520 DAYNAME
521
522Names can be capitalized or not, written in full, or abbreviated to three
b032077a
RS
523characters with or without a period."
524 :type 'boolean
525 :group 'diary)
ecaa0527 526
7e1dae73 527;;;###autoload
b032077a 528(defcustom american-date-diary-pattern
ecaa0527
RS
529 '((month "/" day "[^/0-9]")
530 (month "/" day "/" year "[^0-9]")
531 (monthname " *" day "[^,0-9]")
532 (monthname " *" day ", *" year "[^0-9]")
533 (dayname "\\W"))
534 "*List of pseudo-patterns describing the American patterns of date used.
b032077a
RS
535See the documentation of `diary-date-forms' for an explanation."
536 :type '(repeat (choice (cons :tag "Backup"
537 :value (backup . nil)
538 (const backup)
539 (repeat (list :inline t :format "%v"
540 (symbol :tag "Keyword")
541 (choice symbol regexp))))
542 (repeat (list :inline t :format "%v"
543 (symbol :tag "Keyword")
544 (choice symbol regexp)))))
545 :group 'diary)
ecaa0527 546
7e1dae73 547;;;###autoload
b032077a 548(defcustom european-date-diary-pattern
ecaa0527
RS
549 '((day "/" month "[^/0-9]")
550 (day "/" month "/" year "[^0-9]")
bb0541f8 551 (backup day " *" monthname "\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
ecaa0527
RS
552 (day " *" monthname " *" year "[^0-9]")
553 (dayname "\\W"))
554 "*List of pseudo-patterns describing the European patterns of date used.
b032077a
RS
555See the documentation of `diary-date-forms' for an explanation."
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 :group 'diary)
566
567(defcustom diary-date-forms
ecaa0527
RS
568 (if european-calendar-style
569 european-date-diary-pattern
570 american-date-diary-pattern)
571 "*List of pseudo-patterns describing the forms of date used in the diary.
572The patterns on the list must be MUTUALLY EXCLUSIVE and must should not match
573any portion of the diary entry itself, just the date component.
574
575A pseudo-pattern is a list of regular expressions and the keywords `month',
576`day', `year', `monthname', and `dayname'. The keyword `monthname' will
577match the name of the month, capitalized or not, or its three-letter
578abbreviation, followed by a period or not; it will also match `*'.
579Similarly, `dayname' will match the name of the day, capitalized or not, or
580its three-letter abbreviation, followed by a period or not. The keywords
581`month', `day', and `year' will match those numerical values, preceded by
582arbitrarily many zeros; they will also match `*'.
583
584The matching of the diary entries with the date forms is done with the
585standard syntax table from Fundamental mode, but with the `*' changed so
586that it is a word constituent.
587
588If, to be mutually exclusive, a pseudo-pattern must match a portion of the
589diary entry itself, the first element of the pattern MUST be `backup'. This
7e1dae73
JB
590directive causes the date recognizer to back up to the beginning of the
591current word of the diary entry, so in no case can the pattern match more than
b032077a
RS
592a portion of the first word of the diary entry."
593 :type '(repeat (choice (cons :tag "Backup"
594 :value (backup . nil)
595 (const backup)
596 (repeat (list :inline t :format "%v"
597 (symbol :tag "Keyword")
598 (choice symbol regexp))))
599 (repeat (list :inline t :format "%v"
600 (symbol :tag "Keyword")
601 (choice symbol regexp)))))
602 :group 'diary)
ecaa0527 603
7e1dae73 604;;;###autoload
b032077a 605(defcustom european-calendar-display-form
7e1dae73 606 '((if dayname (concat dayname ", ")) day " " monthname " " year)
354d0644 607 "*Pseudo-pattern governing the way a date appears in the European style.
b032077a
RS
608See the documentation of calendar-date-display-form for an explanation."
609 :type 'sexp
610 :group 'calendar)
ecaa0527 611
7e1dae73 612;;;###autoload
b032077a 613(defcustom american-calendar-display-form
7e1dae73 614 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
354d0644 615 "*Pseudo-pattern governing the way a date appears in the American style.
b032077a
RS
616See the documentation of `calendar-date-display-form' for an explanation."
617 :type 'sexp
618 :group 'calendar)
ecaa0527 619
b032077a 620(defcustom calendar-date-display-form
ecaa0527
RS
621 (if european-calendar-style
622 european-calendar-display-form
623 american-calendar-display-form)
354d0644
JB
624 "*Pseudo-pattern governing the way a date appears.
625
626Used by the function `calendar-date-string', a pseudo-pattern is a list of
627expressions that can involve the keywords `month', `day', and `year', all
628numbers in string form, and `monthname' and `dayname', both alphabetic
629strings. For example, the ISO standard would use the pseudo- pattern
ecaa0527
RS
630
631 '(year \"-\" month \"-\" day)
632
633while a typical American form would be
634
635 '(month \"/\" day \"/\" (substring year -2))
636
637and
638
639 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
640
641would give the usual American style in fixed-length fields.
642
b032077a
RS
643See the documentation of the function `calendar-date-string'."
644 :type 'sexp
645 :group 'calendar)
ecaa0527
RS
646
647(defun european-calendar ()
648 "Set the interpretation and display of dates to the European style."
649 (interactive)
650 (setq european-calendar-style t)
651 (setq calendar-date-display-form european-calendar-display-form)
652 (setq diary-date-forms european-date-diary-pattern)
653 (update-calendar-mode-line))
654
655(defun american-calendar ()
656 "Set the interpretation and display of dates to the American style."
657 (interactive)
658 (setq european-calendar-style nil)
659 (setq calendar-date-display-form american-calendar-display-form)
660 (setq diary-date-forms american-date-diary-pattern)
661 (update-calendar-mode-line))
662
7e1dae73 663;;;###autoload
b032077a 664(defcustom print-diary-entries-hook 'lpr-buffer
354d0644
JB
665 "*List of functions called after a temporary diary buffer is prepared.
666The buffer shows only the diary entries currently visible in the diary
667buffer. The default just does the printing. Other uses might include, for
668example, rearranging the lines into order by day and time, saving the buffer
b032077a
RS
669instead of deleting it, or changing the function used to do the printing."
670 :type 'hook
671 :group 'diary)
ecaa0527 672
e5d77022 673;;;###autoload
b032077a 674(defcustom list-diary-entries-hook nil
354d0644
JB
675 "*List of functions called after diary file is culled for relevant entries.
676It is to be used for diary entries that are not found in the diary file.
ecaa0527
RS
677
678A function `include-other-diary-files' is provided for use as the value of
679this hook. This function enables you to use shared diary files together
6b1abbd1 680with your own. The files included are specified in the diary file by lines
ecaa0527
RS
681of the form
682
683 #include \"filename\"
684
685This is recursive; that is, #include directives in files thus included are
686obeyed. You can change the \"#include\" to some other string by changing
687the variable `diary-include-string'. When you use `include-other-diary-files'
688as part of the list-diary-entries-hook, you will probably also want to use the
6b1abbd1 689function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
ecaa0527
RS
690
691For example, you could use
692
693 (setq list-diary-entries-hook
7e1dae73 694 '(include-other-diary-files sort-diary-entries))
ecaa0527
RS
695 (setq diary-display-hook 'fancy-diary-display)
696
6b1abbd1 697in your `.emacs' file to cause the fancy diary buffer to be displayed with
ecaa0527 698diary entries from various included files, each day's entries sorted into
b032077a
RS
699lexicographic order."
700 :type 'hook
701 :group 'diary)
ecaa0527 702
e5d77022 703;;;###autoload
b032077a 704(defcustom diary-hook nil
34fa2dc2 705 "*List of functions called after the display of the diary.
b032077a
RS
706Can be used for appointment notification."
707 :type 'hook
708 :group 'diary)
34fa2dc2
RS
709
710;;;###autoload
b032077a 711(defcustom diary-display-hook nil
ecaa0527 712 "*List of functions that handle the display of the diary.
e555fdd8 713If nil (the default), `simple-diary-display' is used. Use `ignore' for no
34fa2dc2 714diary display.
ecaa0527
RS
715
716Ordinarily, this just displays the diary buffer (with holidays indicated in
717the mode line), if there are any relevant entries. At the time these
718functions are called, the variable `diary-entries-list' is a list, in order
719by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
720STRING), where string is the diary entry for the given date. This can be
34fa2dc2
RS
721used, for example, a different buffer for display (perhaps combined with
722holidays), or produce hard copy output.
ecaa0527
RS
723
724A function `fancy-diary-display' is provided as an alternative
725choice for this hook; this function prepares a special noneditable diary
726buffer with the relevant diary entries that has neat day-by-day arrangement
727with headings. The fancy diary buffer will show the holidays unless the
728variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
729diary buffer will not show days for which there are no diary entries, even
730if that day is a holiday; if you want such days to be shown in the fancy
b032077a
RS
731diary buffer, set the variable `diary-list-include-blanks' to t."
732 :type 'hook
733 :group 'diary)
ecaa0527 734
e5d77022 735;;;###autoload
b032077a 736(defcustom nongregorian-diary-listing-hook nil
354d0644 737 "*List of functions called for listing diary file and included files.
b0e6051a
GM
738As the files are processed for diary entries, these functions are used to cull
739relevant entries. You can use either or both of `list-hebrew-diary-entries'
740and `list-islamic-diary-entries'. The documentation for these functions
b032077a
RS
741describes the style of such diary entries."
742 :type 'hook
743 :group 'diary)
ecaa0527 744
7e1dae73 745;;;###autoload
b032077a 746(defcustom mark-diary-entries-hook nil
ecaa0527
RS
747 "*List of functions called after marking diary entries in the calendar.
748
749A function `mark-included-diary-files' is also provided for use as the
3cbb4860 750`mark-diary-entries-hook'; it enables you to use shared diary files together
6b1abbd1 751with your own. The files included are specified in the diary file by lines
ecaa0527
RS
752of the form
753 #include \"filename\"
754This is recursive; that is, #include directives in files thus included are
755obeyed. You can change the \"#include\" to some other string by changing the
756variable `diary-include-string'. When you use `mark-included-diary-files' as
757part of the mark-diary-entries-hook, you will probably also want to use the
b032077a
RS
758function `include-other-diary-files' as part of `list-diary-entries-hook'."
759 :type 'hook
760 :group 'diary)
ecaa0527 761
e5d77022 762;;;###autoload
b032077a 763(defcustom nongregorian-diary-marking-hook nil
354d0644 764 "*List of functions called for marking diary file and included files.
b0e6051a
GM
765As the files are processed for diary entries, these functions are used to cull
766relevant entries. You can use either or both of `mark-hebrew-diary-entries'
767and `mark-islamic-diary-entries'. The documentation for these functions
b032077a
RS
768describes the style of such diary entries."
769 :type 'hook
770 :group 'diary)
ecaa0527 771
e5d77022 772;;;###autoload
b032077a 773(defcustom diary-list-include-blanks nil
354d0644 774 "*If nil, do not include days with no diary entry in the list of diary entries.
ac96331d 775Such days will then not be shown in the fancy diary buffer, even if they
b032077a
RS
776are holidays."
777 :type 'boolean
778 :group 'diary)
ecaa0527 779
7e1dae73 780;;;###autoload
b032077a 781(defcustom holidays-in-diary-buffer t
e555fdd8
RS
782 "*Non-nil means include holidays in the diary display.
783The holidays appear in the mode line of the diary buffer, or in the
354d0644 784fancy diary buffer next to the date. This slows down the diary functions
b032077a
RS
785somewhat; setting it to nil makes the diary display faster."
786 :type 'boolean
787 :group 'holidays)
ecaa0527 788
2ec778d0
RS
789(defvar calendar-mark-ring nil)
790
e555fdd8
RS
791;;;###autoload
792(put 'general-holidays 'risky-local-variable t)
7e1dae73 793;;;###autoload
b032077a 794(defcustom general-holidays
354d0644
JB
795 '((holiday-fixed 1 1 "New Year's Day")
796 (holiday-float 1 1 3 "Martin Luther King Day")
11f23ea2 797 (holiday-fixed 2 2 "Groundhog Day")
354d0644
JB
798 (holiday-fixed 2 14 "Valentine's Day")
799 (holiday-float 2 1 3 "President's Day")
800 (holiday-fixed 3 17 "St. Patrick's Day")
9e32719f 801 (holiday-fixed 4 1 "April Fools' Day")
354d0644
JB
802 (holiday-float 5 0 2 "Mother's Day")
803 (holiday-float 5 1 -1 "Memorial Day")
804 (holiday-fixed 6 14 "Flag Day")
805 (holiday-float 6 0 3 "Father's Day")
806 (holiday-fixed 7 4 "Independence Day")
807 (holiday-float 9 1 1 "Labor Day")
808 (holiday-float 10 1 2 "Columbus Day")
809 (holiday-fixed 10 31 "Halloween")
810 (holiday-fixed 11 11 "Veteran's Day")
811 (holiday-float 11 4 4 "Thanksgiving"))
812 "*General holidays. Default value is for the United States.
b032077a
RS
813See the documentation for `calendar-holidays' for details."
814 :type 'sexp
815 :group 'holidays)
ecaa0527 816
7086b78e
ER
817;;;###autoload
818(put 'oriental-holidays 'risky-local-variable t)
819;;;###autoload
b032077a 820(defcustom oriental-holidays
7086b78e
ER
821 '((if (fboundp 'atan)
822 (holiday-chinese-new-year)))
823 "*Oriental holidays.
b032077a
RS
824See the documentation for `calendar-holidays' for details."
825 :type 'sexp
826 :group 'holidays)
7086b78e 827
e555fdd8
RS
828;;;###autoload
829(put 'local-holidays 'risky-local-variable t)
7e1dae73 830;;;###autoload
b032077a 831(defcustom local-holidays nil
7e1dae73 832 "*Local holidays.
b032077a
RS
833See the documentation for `calendar-holidays' for details."
834 :type 'sexp
835 :group 'holidays)
7e1dae73 836
e555fdd8
RS
837;;;###autoload
838(put 'other-holidays 'risky-local-variable t)
7e1dae73 839;;;###autoload
b032077a 840(defcustom other-holidays nil
7e1dae73 841 "*User defined holidays.
b032077a
RS
842See the documentation for `calendar-holidays' for details."
843 :type 'sexp
844 :group 'holidays)
ecaa0527 845
e555fdd8
RS
846;;;###autoload
847(put 'hebrew-holidays-1 'risky-local-variable t)
7e1dae73 848;;;###autoload
97344751 849(defvar hebrew-holidays-1
354d0644 850 '((holiday-rosh-hashanah-etc)
ecaa0527 851 (if all-hebrew-calendar-holidays
354d0644
JB
852 (holiday-julian
853 11
854 (let* ((m displayed-month)
855 (y displayed-year)
856 (year))
857 (increment-calendar-month m y -1)
858 (let ((year (extract-calendar-year
859 (calendar-julian-from-absolute
860 (calendar-absolute-from-gregorian
861 (list m 1 y))))))
862 (if (zerop (% (1+ year) 4))
863 22
97344751
RS
864 21))) "\"Tal Umatar\" (evening)"))))
865
e555fdd8
RS
866;;;###autoload
867(put 'hebrew-holidays-2 'risky-local-variable t)
97344751
RS
868;;;###autoload
869(defvar hebrew-holidays-2
870 '((if all-hebrew-calendar-holidays
354d0644
JB
871 (holiday-hanukkah)
872 (holiday-hebrew 9 25 "Hanukkah"))
ecaa0527 873 (if all-hebrew-calendar-holidays
354d0644
JB
874 (holiday-hebrew
875 10
876 (let ((h-year (extract-calendar-year
877 (calendar-hebrew-from-absolute
878 (calendar-absolute-from-gregorian
879 (list displayed-month 28 displayed-year))))))
880 (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
881 7)
882 6)
883 11 10))
884 "Tzom Teveth"))
ecaa0527 885 (if all-hebrew-calendar-holidays
97344751
RS
886 (holiday-hebrew 11 15 "Tu B'Shevat"))))
887
e555fdd8
RS
888;;;###autoload
889(put 'hebrew-holidays-3 'risky-local-variable t)
97344751 890;;;###autoload
d7fa63b2 891(defvar hebrew-holidays-3
97344751 892 '((if all-hebrew-calendar-holidays
354d0644 893 (holiday-hebrew
ecaa0527
RS
894 11
895 (let ((m displayed-month)
896 (y displayed-year))
897 (increment-calendar-month m y 1)
898 (let* ((h-year (extract-calendar-year
899 (calendar-hebrew-from-absolute
900 (calendar-absolute-from-gregorian
901 (list m
902 (calendar-last-day-of-month m y)
903 y)))))
904 (s-s
905 (calendar-hebrew-from-absolute
906 (if (=
907 (% (calendar-absolute-from-hebrew
908 (list 7 1 h-year))
909 7)
910 6)
911 (calendar-dayname-on-or-before
912 6 (calendar-absolute-from-hebrew
913 (list 11 17 h-year)))
914 (calendar-dayname-on-or-before
915 6 (calendar-absolute-from-hebrew
916 (list 11 16 h-year))))))
917 (day (extract-calendar-day s-s)))
918 day))
97344751
RS
919 "Shabbat Shirah"))))
920
e555fdd8
RS
921;;;###autoload
922(put 'hebrew-holidays-4 'risky-local-variable t)
97344751
RS
923;;;###autoload
924(defvar hebrew-holidays-4
925 '((holiday-passover-etc)
ecaa0527
RS
926 (if (and all-hebrew-calendar-holidays
927 (let* ((m displayed-month)
928 (y displayed-year)
929 (year))
930 (increment-calendar-month m y -1)
931 (let ((year (extract-calendar-year
932 (calendar-julian-from-absolute
933 (calendar-absolute-from-gregorian
934 (list m 1 y))))))
935 (= 21 (% year 28)))))
354d0644 936 (holiday-julian 3 26 "Kiddush HaHamah"))
ecaa0527 937 (if all-hebrew-calendar-holidays
97344751
RS
938 (holiday-tisha-b-av-etc))))
939
e555fdd8
RS
940;;;###autoload
941(put 'hebrew-holidays 'risky-local-variable t)
97344751 942;;;###autoload
b032077a 943(defcustom hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
97344751 944 hebrew-holidays-3 hebrew-holidays-4)
7e1dae73 945 "*Jewish holidays.
b032077a
RS
946See the documentation for `calendar-holidays' for details."
947 :type 'sexp
948 :group 'holidays)
7e1dae73 949
e555fdd8
RS
950;;;###autoload
951(put 'christian-holidays 'risky-local-variable t)
7e1dae73 952;;;###autoload
b032077a 953(defcustom christian-holidays
7e1dae73 954 '((if all-christian-calendar-holidays
354d0644
JB
955 (holiday-fixed 1 6 "Epiphany"))
956 (holiday-easter-etc)
7e1dae73 957 (if all-christian-calendar-holidays
354d0644 958 (holiday-greek-orthodox-easter))
7e1dae73 959 (if all-christian-calendar-holidays
354d0644 960 (holiday-fixed 8 15 "Assumption"))
7e1dae73 961 (if all-christian-calendar-holidays
354d0644
JB
962 (holiday-advent))
963 (holiday-fixed 12 25 "Christmas")
7e1dae73 964 (if all-christian-calendar-holidays
354d0644 965 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
7e1dae73 966 "*Christian holidays.
b032077a
RS
967See the documentation for `calendar-holidays' for details."
968 :type 'sexp
969 :group 'holidays)
ecaa0527 970
e555fdd8
RS
971;;;###autoload
972(put 'islamic-holidays 'risky-local-variable t)
7e1dae73 973;;;###autoload
b032077a 974(defcustom islamic-holidays
354d0644
JB
975 '((holiday-islamic
976 1 1
977 (format "Islamic New Year %d"
978 (let ((m displayed-month)
979 (y displayed-year))
980 (increment-calendar-month m y 1)
981 (extract-calendar-year
982 (calendar-islamic-from-absolute
983 (calendar-absolute-from-gregorian
984 (list
985 m (calendar-last-day-of-month m y) y)))))))
ecaa0527 986 (if all-islamic-calendar-holidays
354d0644 987 (holiday-islamic 1 10 "Ashura"))
ecaa0527 988 (if all-islamic-calendar-holidays
354d0644 989 (holiday-islamic 3 12 "Mulad-al-Nabi"))
ecaa0527 990 (if all-islamic-calendar-holidays
354d0644 991 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
ecaa0527 992 (if all-islamic-calendar-holidays
354d0644
JB
993 (holiday-islamic 8 15 "Shab-e-Bara't"))
994 (holiday-islamic 9 1 "Ramadan Begins")
ecaa0527 995 (if all-islamic-calendar-holidays
354d0644 996 (holiday-islamic 9 27 "Shab-e Qadr"))
ecaa0527 997 (if all-islamic-calendar-holidays
354d0644 998 (holiday-islamic 10 1 "Id-al-Fitr"))
ecaa0527 999 (if all-islamic-calendar-holidays
354d0644 1000 (holiday-islamic 12 10 "Id-al-Adha")))
7e1dae73 1001 "*Islamic holidays.
b032077a
RS
1002See the documentation for `calendar-holidays' for details."
1003 :type 'sexp
1004 :group 'holidays)
7e1dae73 1005
e555fdd8
RS
1006;;;###autoload
1007(put 'solar-holidays 'risky-local-variable t)
7e1dae73 1008;;;###autoload
b032077a 1009(defcustom solar-holidays
7e1dae73
JB
1010 '((if (fboundp 'atan)
1011 (solar-equinoxes-solstices))
3b92bdd2
RS
1012 (if (progn
1013 (require 'cal-dst)
1014 t)
354d0644 1015 (funcall
3b92bdd2 1016 'holiday-sexp
354d0644
JB
1017 calendar-daylight-savings-starts
1018 '(format "Daylight Savings Time Begins %s"
1019 (if (fboundp 'atan)
1020 (solar-time-string
8a7cdf3a
ER
1021 (/ calendar-daylight-savings-starts-time (float 60))
1022 calendar-standard-time-zone-name)
354d0644
JB
1023 ""))))
1024 (funcall
1025 'holiday-sexp
1026 calendar-daylight-savings-ends
1027 '(format "Daylight Savings Time Ends %s"
1028 (if (fboundp 'atan)
1029 (solar-time-string
8a7cdf3a
ER
1030 (/ calendar-daylight-savings-ends-time (float 60))
1031 calendar-daylight-time-zone-name)
354d0644 1032 ""))))
7e1dae73 1033 "*Sun-related holidays.
b032077a
RS
1034See the documentation for `calendar-holidays' for details."
1035 :type 'sexp
1036 :group 'holidays)
7e1dae73 1037
e555fdd8
RS
1038;;;###autoload
1039(put 'calendar-holidays 'risky-local-variable t)
b032077a 1040(defcustom calendar-holidays
354d0644
JB
1041 (append general-holidays local-holidays other-holidays
1042 christian-holidays hebrew-holidays islamic-holidays
b0e6051a 1043 oriental-holidays solar-holidays)
3cbb4860 1044 "*List of notable days for the command \\[holidays].
7e1dae73 1045
b0e6051a
GM
1046Additional holidays are easy to add to the list, just put them in the list
1047`other-holidays' in your .emacs file. Similarly, by setting any of
1048`general-holidays', `local-holidays' `christian-holidays', `hebrew-holidays',
1049`islamic-holidays', `oriental-holidays', or `solar-holidays' to nil in your
1050.emacs file, you can eliminate unwanted categories of holidays. The intention
1051is that (in the US) `local-holidays' be set in site-init.el and
7086b78e 1052`other-holidays' be set by the user.
7e1dae73 1053
354d0644
JB
1054Entries on the list are expressions that return (possibly empty) lists of
1055items of the form ((month day year) string) of a holiday in the in the
1056three-month period centered around `displayed-month' of `displayed-year'.
1057Several basic functions are provided for this purpose:
1058
1059 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1060 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1061 MONTH on the Gregorian calendar (0 for Sunday,
1062 etc.); K<0 means count back from the end of the
3cbb4860 1063 month. An optional parameter DAY means the Kth
354d0644
JB
1064 DAYNAME after/before MONTH DAY.
1065 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1066 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1067 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1068 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
7e1dae73
JB
1069 in the variable `year'; if it evaluates to
1070 a visible date, that's the holiday; if it
354d0644
JB
1071 evaluates to nil, there's no holiday. STRING
1072 is an expression in the variable `date'.
ecaa0527
RS
1073
1074For example, to add Bastille Day, celebrated in France on July 14, add
1075
354d0644 1076 (holiday-fixed 7 14 \"Bastille Day\")
ecaa0527
RS
1077
1078to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1079Islands on the fourth Monday in August, add
1080
354d0644 1081 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
ecaa0527
RS
1082
1083to the list (the last Monday would be specified with `-1' instead of `4').
7e1dae73 1084To add the last day of Hanukkah to the list, use
ecaa0527 1085
354d0644 1086 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
ecaa0527
RS
1087
1088since the Hebrew months are numbered with 1 starting from Nisan, while to
1089add the Islamic feast celebrating Mohammed's birthday use
1090
354d0644 1091 (holiday-islamic 3 12 \"Mohammed's Birthday\")
ecaa0527
RS
1092
1093since the Islamic months are numbered from 1 starting with Muharram. To
1094add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1095
354d0644 1096 (holiday-julian 4 2 \"Jefferson's Birthday\")
ecaa0527 1097
354d0644
JB
1098To include a holiday conditionally, use the sexp form or a conditional. For
1099example, to include American presidential elections, which occur on the first
1100Tuesday after the first Monday in November of years divisible by 4, add
ecaa0527 1101
354d0644
JB
1102 (holiday-sexp
1103 (if (zerop (% year 4))
1104 (calendar-gregorian-from-absolute
1105 (1+ (calendar-dayname-on-or-before
1106 1 (+ 6 (calendar-absolute-from-gregorian
1107 (list 11 1 year)))))))
1108 \"US Presidential Election\")
7e1dae73
JB
1109
1110or
1111
ecaa0527 1112 (if (zerop (% displayed-year 4))
354d0644 1113 (holiday-fixed 11
ecaa0527
RS
1114 (extract-calendar-day
1115 (calendar-gregorian-from-absolute
1116 (1+ (calendar-dayname-on-or-before
1117 1 (+ 6 (calendar-absolute-from-gregorian
1118 (list 11 1 displayed-year)))))))
1119 \"US Presidential Election\"))
1120
1121to the list. To include the phases of the moon, add
1122
1123 (lunar-phases)
1124
354d0644
JB
1125to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1126you've written to return a (possibly empty) list of the relevant VISIBLE dates
1127with descriptive strings such as
ecaa0527 1128
b032077a
RS
1129 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
1130 :type 'sexp
1131 :group 'holidays)
ecaa0527 1132
ecaa0527
RS
1133(defconst calendar-buffer "*Calendar*"
1134 "Name of the buffer used for the calendar.")
1135
1136(defconst holiday-buffer "*Holidays*"
1137 "Name of the buffer used for the displaying the holidays.")
1138
1139(defconst fancy-diary-buffer "*Fancy Diary Entries*"
1140 "Name of the buffer used for the optional fancy display of the diary.")
1141
726669d8
ER
1142(defconst other-calendars-buffer "*Other Calendars*"
1143 "Name of the buffer used for the display of date on other calendars.")
1144
cba0c253
ER
1145(defconst lunar-phases-buffer "*Phases of Moon*"
1146 "Name of the buffer used for the lunar phases.")
1147
ecaa0527 1148(defmacro increment-calendar-month (mon yr n)
354d0644
JB
1149 "Move the variables MON and YR to the month and year by N months.
1150Forward if N is positive or backward if N is negative."
7e1e5cf1
SS
1151 `(let ((macro-y (+ (* ,yr 12) ,mon -1 ,n)))
1152 (setq ,mon (1+ (% macro-y 12)))
1153 (setq ,yr (/ macro-y 12))))
ecaa0527
RS
1154
1155(defmacro calendar-for-loop (var from init to final do &rest body)
1156 "Execute a for loop."
7e1e5cf1
SS
1157 `(let ((,var (1- ,init)))
1158 (while (>= ,final (setq ,var (1+ ,var)))
1159 ,@body)))
ecaa0527
RS
1160
1161(defmacro calendar-sum (index initial condition expression)
354d0644 1162 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
7e1e5cf1
SS
1163 `(let ((,index ,initial)
1164 (sum 0))
1165 (while ,condition
1166 (setq sum (+ sum ,expression))
1167 (setq ,index (1+ ,index)))
1168 sum))
ecaa0527 1169
cba0c253
ER
1170;; The following are in-line for speed; they can be called thousands of times
1171;; when looking up holidays or processing the diary. Here, for example, are
1172;; the numbers of calls to calendar/diary/holiday functions in preparing the
e5d77022
JB
1173;; fancy diary display, for a moderately complex diary file, with functions
1174;; used instead of macros. There were a total of 10000 such calls:
1175;;
1176;; 1934 extract-calendar-month
1177;; 1852 extract-calendar-year
1178;; 1819 extract-calendar-day
1179;; 845 calendar-leap-year-p
1180;; 837 calendar-day-number
1181;; 775 calendar-absolute-from-gregorian
1182;; 346 calendar-last-day-of-month
1183;; 286 hebrew-calendar-last-day-of-month
1184;; 188 hebrew-calendar-leap-year-p
1185;; 180 hebrew-calendar-elapsed-days
1186;; 163 hebrew-calendar-last-month-of-year
1187;; 66 calendar-date-compare
1188;; 65 hebrew-calendar-days-in-year
1189;; 60 calendar-absolute-from-julian
1190;; 50 calendar-absolute-from-hebrew
1191;; 43 calendar-date-equal
1192;; 38 calendar-gregorian-from-absolute
1193;; .
1194;; .
1195;; .
1196;;
1197;; The use of these seven macros eliminates the overhead of 92% of the function
cba0c253 1198;; calls; it's faster this way.
e5d77022 1199
cba0c253 1200(defsubst extract-calendar-month (date)
ecaa0527 1201 "Extract the month part of DATE which has the form (month day year)."
cba0c253 1202 (car date))
ecaa0527 1203
cba0c253 1204(defsubst extract-calendar-day (date)
ecaa0527 1205 "Extract the day part of DATE which has the form (month day year)."
cba0c253 1206 (car (cdr date)))
ecaa0527 1207
cba0c253 1208(defsubst extract-calendar-year (date)
ecaa0527 1209 "Extract the year part of DATE which has the form (month day year)."
cba0c253 1210 (car (cdr (cdr date))))
ecaa0527 1211
cba0c253 1212(defsubst calendar-leap-year-p (year)
3cbb4860 1213 "Return t if YEAR is a Gregorian leap year."
cba0c253
ER
1214 (and (zerop (% year 4))
1215 (or (not (zerop (% year 100)))
1216 (zerop (% year 400)))))
1217
354d0644
JB
1218;; The foregoing is a bit faster, but not as clear as the following:
1219;;
cba0c253 1220;;(defsubst calendar-leap-year-p (year)
7e1dae73
JB
1221;; "Returns t if YEAR is a Gregorian leap year."
1222;; (or
1223;; (and (= (% year 4) 0)
1224;; (/= (% year 100) 0))
1225;; (= (% year 400) 0)))
e5d77022 1226
cba0c253 1227(defsubst calendar-last-day-of-month (month year)
e5d77022 1228 "The last day in MONTH during YEAR."
cba0c253
ER
1229 (if (and (= month 2) (calendar-leap-year-p year))
1230 29
1231 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1232
1233;; An explanation of the calculation can be found in PascAlgorithms by
1234;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1235
1236(defsubst calendar-day-number (date)
e5d77022
JB
1237 "Return the day number within the year of the date DATE.
1238For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1239while (calendar-day-number '(12 31 1980)) returns 366."
cba0c253
ER
1240 (let* ((month (extract-calendar-month date))
1241 (day (extract-calendar-day date))
1242 (year (extract-calendar-year date))
1243 (day-of-year (+ day (* 31 (1- month)))))
1244 (if (> month 2)
1245 (progn
1246 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1247 (if (calendar-leap-year-p year)
e5d77022 1248 (setq day-of-year (1+ day-of-year)))))
cba0c253
ER
1249 day-of-year))
1250
1251(defsubst calendar-absolute-from-gregorian (date)
e5d77022
JB
1252 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1253The Gregorian date Sunday, December 31, 1 BC is imaginary."
cba0c253
ER
1254 (let ((prior-years (1- (extract-calendar-year date))))
1255 (+ (calendar-day-number date);; Days this year
1256 (* 365 prior-years);; + Days in prior years
1257 (/ prior-years 4);; + Julian leap years
1258 (- (/ prior-years 100));; - century years
1259 (/ prior-years 400))));; + Gregorian leap years
e5d77022 1260
7086b78e
ER
1261(autoload 'calendar-goto-today "cal-move"
1262 "Reposition the calendar window so the current date is visible."
1263 t)
1264
1265(autoload 'calendar-forward-month "cal-move"
1266 "Move the cursor forward ARG months."
1267 t)
1268
1269(autoload 'calendar-forward-year "cal-move"
1270 "Move the cursor forward by ARG years."
1271 t)
1272
1273(autoload 'calendar-backward-month "cal-move"
1274 "Move the cursor backward by ARG months."
1275 t)
1276
1277(autoload 'calendar-backward-year "cal-move"
1278 "Move the cursor backward ARG years."
1279 t)
1280
1281(autoload 'scroll-calendar-left "cal-move"
1282 "Scroll the displayed calendar left by ARG months."
1283 t)
1284
1285(autoload 'scroll-calendar-right "cal-move"
1286 "Scroll the displayed calendar window right by ARG months."
1287 t)
1288
1289(autoload 'scroll-calendar-left-three-months "cal-move"
1290 "Scroll the displayed calendar window left by 3*ARG months."
1291 t)
1292
1293(autoload 'scroll-calendar-right-three-months "cal-move"
1294 "Scroll the displayed calendar window right by 3*ARG months."
1295 t)
1296
1297(autoload 'calendar-cursor-to-nearest-date "cal-move"
1298 "Move the cursor to the closest date."
1299 t)
1300
1301(autoload 'calendar-forward-day "cal-move"
1302 "Move the cursor forward ARG days."
1303 t)
1304
1305(autoload 'calendar-backward-day "cal-move"
1306 "Move the cursor back ARG days."
1307 t)
1308
1309(autoload 'calendar-forward-week "cal-move"
1310 "Move the cursor forward ARG weeks."
1311 t)
1312
1313(autoload 'calendar-backward-week "cal-move"
1314 "Move the cursor back ARG weeks."
1315 t)
1316
1317(autoload 'calendar-beginning-of-week "cal-move"
1318 "Move the cursor back ARG calendar-week-start-day's."
1319 t)
1320
1321(autoload 'calendar-end-of-week "cal-move"
1322 "Move the cursor forward ARG calendar-week-start-day+6's."
1323 t)
1324
1325(autoload 'calendar-beginning-of-month "cal-move"
1326 "Move the cursor backward ARG month beginnings."
1327 t)
1328
1329(autoload 'calendar-end-of-month "cal-move"
1330 "Move the cursor forward ARG month ends."
1331 t)
1332
1333(autoload 'calendar-beginning-of-year "cal-move"
1334 "Move the cursor backward ARG year beginnings."
1335 t)
1336
1337(autoload 'calendar-end-of-year "cal-move"
1338 "Move the cursor forward ARG year beginnings."
1339 t)
1340
1341(autoload 'calendar-cursor-to-visible-date "cal-move"
1342 "Move the cursor to DATE that is on the screen."
1343 t)
1344
1345(autoload 'calendar-goto-date "cal-move"
1346 "Move cursor to DATE."
1347 t)
1348
1349(autoload 'calendar-one-frame-setup "cal-x"
1350 "Start calendar and display it in a dedicated frame together with the diary.")
1351
1352(autoload 'calendar-two-frame-setup "cal-x"
1353 "Start calendar and diary in separate, dedicated frames.")
7e1e5cf1 1354
7086b78e
ER
1355;;;###autoload
1356(defvar calendar-setup nil
1357 "The frame set up of the calendar.
1358The choices are `one-frame' (calendar and diary together in one separate,
a4410177
KH
1359dedicated frame), `two-frames' (calendar and diary in separate, dedicated
1360frames), `calendar-only' (calendar in a separate, dedicated frame); with
1361any other value the current frame is used.")
7086b78e 1362
94b304d7 1363;;;###autoload
ecaa0527 1364(defun calendar (&optional arg)
7086b78e
ER
1365 "Choose between the one frame, two frame, or basic calendar displays.
1366The original function `calendar' has been renamed `calendar-basic-setup'."
1367 (interactive "P")
1368 (cond ((equal calendar-setup 'one-frame) (calendar-one-frame-setup arg))
1369 ((equal calendar-setup 'two-frames) (calendar-two-frame-setup arg))
a4410177
KH
1370 ((equal calendar-setup 'calendar-only)
1371 (calendar-only-one-frame-setup arg))
7086b78e
ER
1372 (t (calendar-basic-setup arg))))
1373
1374(defun calendar-basic-setup (&optional arg)
ecaa0527
RS
1375 "Display a three-month calendar in another window.
1376The three months appear side by side, with the current month in the middle
1377surrounded by the previous and next months. The cursor is put on today's date.
1378
7e1dae73
JB
1379If called with an optional prefix argument, prompts for month and year.
1380
ecaa0527
RS
1381This function is suitable for execution in a .emacs file; appropriate setting
1382of the variable `view-diary-entries-initially' will cause the diary entries for
1383the current date to be displayed in another window. The value of the variable
1384`number-of-diary-entries' controls the number of days of diary entries
1385displayed upon initial display of the calendar.
1386
ecaa0527
RS
1387Once in the calendar window, future or past months can be moved into view.
1388Arbitrary months can be displayed, or the calendar can be scrolled forward
1389or backward.
1390
1391The cursor can be moved forward or backward by one day, one week, one month,
1392or one year. All of these commands take prefix arguments which, when negative,
1393cause movement in the opposite direction. For convenience, the digit keys
1394and the minus sign are automatically prefixes. The window is replotted as
1395necessary to display the desired date.
1396
1397Diary entries can be marked on the calendar or displayed in another window.
1398
3cbb4860 1399Use \\[describe-mode] for details of the key bindings in the calendar window.
ecaa0527
RS
1400
1401The Gregorian calendar is assumed.
1402
7e1dae73 1403After loading the calendar, the hooks given by the variable
2b803765 1404`calendar-load-hook' are run. This is the place to add key bindings to the
7e1dae73
JB
1405calendar-mode-map.
1406
ecaa0527
RS
1407After preparing the calendar window initially, the hooks given by the variable
1408`initial-calendar-window-hook' are run.
1409
1410The hooks given by the variable `today-visible-calendar-hook' are run
a69472b3 1411every time the calendar window gets scrolled, if the current date is visible
ecaa0527
RS
1412in the window. If it is not visible, the hooks given by the variable
1413`today-invisible-calendar-hook' are run. Thus, for example, setting
1414`today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1415to be replaced by asterisks to highlight it whenever it is in the window."
1416 (interactive "P")
ecaa0527
RS
1417 (set-buffer (get-buffer-create calendar-buffer))
1418 (calendar-mode)
ecd42d42 1419 (let* ((pop-up-windows t)
7e1dae73 1420 (split-height-threshold 1000)
cba0c253
ER
1421 (date (if arg
1422 (calendar-read-date t)
1423 (calendar-current-date)))
1424 (month (extract-calendar-month date))
1425 (year (extract-calendar-year date)))
ecaa0527 1426 (pop-to-buffer calendar-buffer)
cba0c253 1427 (increment-calendar-month month year (- calendar-offset))
7e1dae73
JB
1428 (generate-calendar-window month year)
1429 (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
1430 (view-diary-entries
1431 (if (vectorp number-of-diary-entries)
1432 (aref number-of-diary-entries (calendar-day-of-week date))
1433 number-of-diary-entries))))
1434 (let* ((diary-buffer (get-file-buffer diary-file))
1435 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1436 (split-height-threshold (if diary-window 2 1000)))
1437 (if view-calendar-holidays-initially
1438 (list-calendar-holidays)))
ecaa0527
RS
1439 (run-hooks 'initial-calendar-window-hook))
1440
fb30f0ce 1441(autoload 'view-diary-entries "diary-lib"
ecaa0527 1442 "Prepare and display a buffer with diary entries.
6b1abbd1 1443Searches your diary file for entries that match ARG days starting with
ecaa0527
RS
1444the date indicated by the cursor position in the displayed three-month
1445calendar."
1446 t)
1447
7e1dae73
JB
1448(autoload 'calendar-sunrise-sunset "solar"
1449 "Local time of sunrise and sunset for date under cursor."
1450 t)
1451
1452(autoload 'calendar-phases-of-moon "lunar"
1453 "Create a buffer of the phases of the moon for the current calendar window."
1454 t)
1455
1456(autoload 'calendar-print-french-date "cal-french"
6a2aa94c 1457 "Show the French Revolutionary calendar equivalent of the date under the cursor."
7e1dae73
JB
1458 t)
1459
1460(autoload 'calendar-goto-french-date "cal-french"
1461 "Move cursor to French Revolutionary date."
1462 t)
1463
6a2aa94c 1464(autoload 'calendar-french-date-string "cal-french"
7086b78e 1465 "String of French Revolutionary date of Gregorian date."
6a2aa94c
RS
1466 t)
1467
1468(autoload 'calendar-mayan-date-string "cal-mayan"
7086b78e 1469 "String of Mayan date of Gregorian date."
6a2aa94c
RS
1470 t)
1471
7e1dae73 1472(autoload 'calendar-print-mayan-date "cal-mayan"
6a2aa94c 1473 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
7e1dae73
JB
1474 t)
1475
1476(autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
1477 "Move cursor to Mayan long count date."
1478 t)
1479
1480(autoload 'calendar-next-haab-date "cal-mayan"
1481 "Move cursor to next instance of Mayan Haab date."
1482 t)
1483
1484(autoload 'calendar-previous-haab-date "cal-mayan"
1485 "Move cursor to previous instance of Mayan Haab date."
1486 t)
1487
1488(autoload 'calendar-next-tzolkin-date "cal-mayan"
1489 "Move cursor to next instance of Mayan Tzolkin date."
1490 t)
1491
1492(autoload 'calendar-previous-tzolkin-date "cal-mayan"
1493 "Move cursor to previous instance of Mayan Tzolkin date."
1494 t)
1495
1496(autoload 'calendar-next-calendar-round-date "cal-mayan"
a69472b3 1497 "Move cursor to next instance of Mayan Haab/Tzolkin combination."
7e1dae73
JB
1498 t)
1499
1500(autoload 'calendar-previous-calendar-round-date "cal-mayan"
a69472b3 1501 "Move cursor to previous instance of Mayan Haab/Tzolkin combination."
7e1dae73
JB
1502 t)
1503
327b6868 1504(autoload 'calendar-goto-chinese-date "cal-china"
6cf0fb79 1505 "Move cursor to Chinese date."
7086b78e
ER
1506 t)
1507
327b6868 1508(autoload 'calendar-print-chinese-date "cal-china"
7086b78e
ER
1509 "Show the Chinese date equivalents of date."
1510 t)
1511
327b6868 1512(autoload 'calendar-chinese-date-string "cal-china"
7086b78e
ER
1513 "String of Chinese date of Gregorian date."
1514 t)
1515
d1b8adf7 1516(autoload 'calendar-absolute-from-astro "cal-julian"
6cf0fb79 1517 "Absolute date of astronomical (Julian) day number D."
d1b8adf7 1518 t )
6cf0fb79 1519
14fcc701
KH
1520(autoload 'calendar-astro-from-absolute "cal-julian"
1521 "Astronomical (Julian) day number of absolute date D.")
1522
6cf0fb79
ER
1523(autoload 'calendar-astro-date-string "cal-julian"
1524 "String of astronomical (Julian) day number of Gregorian date."
1525 t)
1526
435d749c 1527(autoload 'calendar-goto-astro-day-number "cal-julian"
6cf0fb79
ER
1528 "Move cursor to astronomical (Julian) day number."
1529 t)
1530
d1b8adf7
GM
1531(autoload 'calendar-print-astro-day-number "cal-julian"
1532 "Show the astro date equivalents of date."
1533 t)
1534
6dcba8a3
RS
1535(autoload 'calendar-julian-from-absolute "cal-julian"
1536 "Compute the Julian (month day year) corresponding to the absolute DATE.
1537The absolute date is the number of days elapsed since the (imaginary)
1538Gregorian date Sunday, December 31, 1 BC.")
1539
7086b78e
ER
1540(autoload 'calendar-goto-julian-date "cal-julian"
1541 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1542 t)
1543
2b3f69c8
RS
1544(autoload 'calendar-print-julian-date "cal-julian"
1545 "Show the Julian calendar equivalent of the date under the cursor."
1546 t)
1547
07986bc4
RS
1548(autoload 'calendar-julian-date-string "cal-julian"
1549 "String of Julian date of Gregorian DATE.
1550Defaults to today's date if DATE is not given.
bfca0f6b 1551Driven by the variable `calendar-date-display-form'.")
07986bc4 1552
7086b78e
ER
1553(autoload 'calendar-goto-iso-date "cal-iso"
1554 "Move cursor to ISO date."
1555 t)
1556
1557(autoload 'calendar-print-iso-date "cal-iso"
1558 "Show the ISO date equivalents of date."
1559 t)
1560
1561(autoload 'calendar-iso-date-string "cal-iso"
1562 "String of ISO date of Gregorian date."
1563 t)
1564
327b6868 1565(autoload 'calendar-print-islamic-date "cal-islam"
7086b78e
ER
1566 "Show the Islamic date equivalents of date."
1567 t)
1568
327b6868 1569(autoload 'calendar-islamic-date-string "cal-islam"
7086b78e
ER
1570 "String of Islamic date of Gregorian date."
1571 t)
1572
1573(autoload 'calendar-goto-hebrew-date "cal-hebrew"
1574 "Move cursor to Hebrew date date."
1575 t)
1576
1577(autoload 'calendar-print-hebrew-date "cal-hebrew"
1578 "Show the Hebrew date equivalents of date."
1579 t)
1580
1581(autoload 'calendar-hebrew-date-string "cal-hebrew"
1582 "String of Hebrew date of Gregorian date."
1583 t)
1584
1585(autoload 'calendar-goto-coptic-date "cal-coptic"
1586 "Move cursor to Coptic date date."
1587 t)
1588
1589(autoload 'calendar-print-coptic-date "cal-coptic"
1590 "Show the Coptic date equivalents of date."
1591 t)
1592
1593(autoload 'calendar-coptic-date-string "cal-coptic"
1594 "String of Coptic date of Gregorian date."
1595 t)
1596
1597(autoload 'calendar-goto-ethiopic-date "cal-coptic"
1598 "Move cursor to Ethiopic date date."
1599 t)
1600
1601(autoload 'calendar-print-ethiopic-date "cal-coptic"
1602 "Show the Ethiopic date equivalents of date."
1603 t)
1604
1605(autoload 'calendar-ethiopic-date-string "cal-coptic"
1606 "String of Ethiopic date of Gregorian date."
1607 t)
1608
a45eee72 1609(autoload 'calendar-goto-persian-date "cal-persia"
c21eb13d
ER
1610 "Move cursor to Persian date date."
1611 t)
1612
a45eee72 1613(autoload 'calendar-print-persian-date "cal-persia"
c21eb13d
ER
1614 "Show the Persian date equivalents of date."
1615 t)
1616
a45eee72 1617(autoload 'calendar-persian-date-string "cal-persia"
c21eb13d
ER
1618 "String of Persian date of Gregorian date."
1619 t)
1620
fb30f0ce 1621(autoload 'show-all-diary-entries "diary-lib"
6b1abbd1
RS
1622 "Show all of the diary entries in the diary file.
1623This function gets rid of the selective display of the diary file so that
ecaa0527
RS
1624all entries, not just some, are visible. If there is no diary buffer, one
1625is created."
1626 t)
1627
fb30f0ce 1628(autoload 'mark-diary-entries "diary-lib"
ecaa0527 1629 "Mark days in the calendar window that have diary entries.
6b1abbd1 1630Each entry in diary file visible in the calendar window is marked."
ecaa0527
RS
1631 t)
1632
fb30f0ce 1633(autoload 'make-diary-entry "diary-lib"
7086b78e
ER
1634 "Insert a diary entry STRING which may be NONMARKING in FILE."
1635 t)
1636
fb30f0ce 1637(autoload 'insert-diary-entry "diary-lib"
ecaa0527
RS
1638 "Insert a diary entry for the date indicated by point."
1639 t)
1640
fb30f0ce 1641(autoload 'insert-weekly-diary-entry "diary-lib"
ecaa0527
RS
1642 "Insert a weekly diary entry for the day of the week indicated by point."
1643 t)
1644
354d0644 1645
fb30f0ce 1646(autoload 'insert-monthly-diary-entry "diary-lib"
ecaa0527
RS
1647 "Insert a monthly diary entry for the day of the month indicated by point."
1648 t)
1649
fb30f0ce 1650(autoload 'insert-yearly-diary-entry "diary-lib"
ecaa0527
RS
1651 "Insert an annual diary entry for the day of the year indicated by point."
1652 t)
1653
fb30f0ce 1654(autoload 'insert-anniversary-diary-entry "diary-lib"
ecaa0527
RS
1655 "Insert an anniversary diary entry for the date indicated by point."
1656 t)
1657
fb30f0ce 1658(autoload 'insert-block-diary-entry "diary-lib"
ecaa0527
RS
1659 "Insert a block diary entry for the dates indicated by point and mark."
1660 t)
1661
fb30f0ce 1662(autoload 'insert-cyclic-diary-entry "diary-lib"
ecaa0527
RS
1663 "Insert a cyclic diary entry starting at the date indicated by point."
1664 t)
1665
7086b78e 1666(autoload 'insert-hebrew-diary-entry "cal-hebrew"
ecaa0527
RS
1667 "Insert a diary entry for the Hebrew date corresponding to the date
1668indicated by point."
1669 t)
1670
7086b78e 1671(autoload 'insert-monthly-hebrew-diary-entry "cal-hebrew"
ecaa0527
RS
1672 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1673to the date indicated by point."
1674 t)
1675
7086b78e 1676(autoload 'insert-yearly-hebrew-diary-entry "cal-hebrew"
ecaa0527
RS
1677 "Insert an annual diary entry for the day of the Hebrew year corresponding
1678to the date indicated by point."
1679 t)
1680
327b6868 1681(autoload 'insert-islamic-diary-entry "cal-islam"
ecaa0527
RS
1682 "Insert a diary entry for the Islamic date corresponding to the date
1683indicated by point."
1684 t)
1685
327b6868 1686(autoload 'insert-monthly-islamic-diary-entry "cal-islam"
ecaa0527
RS
1687 "Insert a monthly diary entry for the day of the Islamic month corresponding
1688to the date indicated by point."
1689 t)
1690
327b6868 1691(autoload 'insert-yearly-islamic-diary-entry "cal-islam"
ecaa0527
RS
1692 "Insert an annual diary entry for the day of the Islamic year corresponding
1693to the date indicated by point."
1694 t)
1695
1696(autoload 'list-calendar-holidays "holidays"
1697 "Create a buffer containing the holidays for the current calendar window.
1698The holidays are those in the list `calendar-notable-days'. Returns t if any
1699holidays are found, nil if not."
1700 t)
1701
3076647c
ER
1702(autoload 'cal-tex-cursor-month "cal-tex"
1703 "Make a buffer with LaTeX commands for the month cursor is on.
1704Optional prefix argument specifies number of months to be produced.
1705Calendar is condensed onto one page.")
1706
1707(autoload 'cal-tex-cursor-month-landscape "cal-tex"
1708 "Make a buffer with LaTeX commands for the month cursor is on.
1709Optional prefix argument specifies number of months to be produced.")
1710
1711(autoload 'cal-tex-cursor-day "cal-tex"
1712 "Make a buffer with LaTeX commands for the day cursor is on.")
1713
1714(autoload 'cal-tex-cursor-week "cal-tex"
5a2c140a
RS
1715 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1716It applies to the week that point is in.
1717Optional prefix argument specifies number of weeks.
1718Holidays are included if `cal-tex-holidays' is t.")
1719
7e1e5cf1 1720(autoload 'cal-tex-cursor-week2 "cal-tex"
5a2c140a
RS
1721 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1722It applies to the week that point is in.
1723Optional prefix argument specifies number of weeks.
1724Holidays are included if `cal-tex-holidays' is t.")
1725
1726(autoload 'cal-tex-cursor-week-iso "cal-tex"
1727 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
07e4feff 1728Optional prefix argument specifies number of weeks.
5a2c140a
RS
1729Diary entries are included if `cal-tex-diary' is t.
1730Holidays are included if `cal-tex-holidays' is t.")
1731
1732(autoload 'cal-tex-cursor-week-monday "cal-tex"
1733 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1734It applies to the week that point is in, and starts on Monday.
1735Optional prefix argument specifies number of weeks.
1736Holidays are included if `cal-tex-holidays' is t.")
1737
1738(autoload 'cal-tex-cursor-filofax-2week "cal-tex"
1739 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
1740Optional prefix argument specifies number of weeks.
1741Diary entries are included if cal-tex-diary is t.
1742Holidays are included if `cal-tex-holidays' is t.")
1743
1744(autoload 'cal-tex-cursor-filofax-week "cal-tex"
1745 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
1746Optional prefix argument specifies number of weeks.
7e1e5cf1 1747Weeks start on Monday.
5a2c140a
RS
1748Diary entries are included if cal-tex-diary is t.
1749Holidays are included if `cal-tex-holidays' is t.")
3076647c 1750
9018e77d
KH
1751(autoload 'cal-tex-cursor-filofax-daily "cal-tex"
1752 "Day-per-page Filofax style calendar for week indicated by cursor.
7e1e5cf1 1753Optional prefix argument specifies number of weeks. Weeks start on Monday.
9018e77d
KH
1754Diary entries are included if `cal-tex-diary' is t.
1755Holidays are included if `cal-tex-holidays' is t.")
1756
3076647c
ER
1757(autoload 'cal-tex-cursor-year "cal-tex"
1758 "Make a buffer with LaTeX commands for a year's calendar.
a69472b3 1759Optional prefix argument specifies number of years.")
3076647c
ER
1760
1761(autoload 'cal-tex-cursor-year-landscape "cal-tex"
1762 "Make a buffer with LaTeX commands for a year's calendar (landscape).
1763Optional prefix argument specifies number of years.")
1764
1765(autoload 'cal-tex-cursor-filofax-year "cal-tex"
1766 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
1767Optional prefix argument specifies number of years.")
1768
ecaa0527
RS
1769(autoload 'mark-calendar-holidays "holidays"
1770 "Mark notable days in the calendar window."
1771 t)
1772
1773(autoload 'calendar-cursor-holidays "holidays"
1774 "Find holidays for the date specified by the cursor in the calendar window."
1775 t)
1776
7e1dae73
JB
1777(defun generate-calendar-window (&optional mon yr)
1778 "Generate the calendar window for the current date.
1779Or, for optional MON, YR."
ecaa0527 1780 (let* ((buffer-read-only nil)
ecaa0527
RS
1781 (today (calendar-current-date))
1782 (month (extract-calendar-month today))
1783 (day (extract-calendar-day today))
1784 (year (extract-calendar-year today))
7e1dae73
JB
1785 (today-visible
1786 (or (not mon)
1787 (let ((offset (calendar-interval mon yr month year)))
1788 (and (<= offset 1) (>= offset -1)))))
ecaa0527
RS
1789 (day-in-week (calendar-day-of-week today)))
1790 (update-calendar-mode-line)
7e1dae73
JB
1791 (if mon
1792 (generate-calendar mon yr)
1793 (generate-calendar month year))
ecaa0527
RS
1794 (calendar-cursor-to-visible-date
1795 (if today-visible today (list displayed-month 1 displayed-year)))
1796 (set-buffer-modified-p nil)
31754518
MB
1797 (if (or (one-window-p t) (/= (frame-width) (window-width)))
1798 ;; Don't mess with the window size, but ensure that the first
1799 ;; line is fully visible
1800 (set-window-vscroll nil 0)
1801 ;; Adjust the window to exactly fit the displayed calendar
b85fa13c 1802 (fit-window-to-buffer))
ecaa0527
RS
1803 (sit-for 0)
1804 (and mark-holidays-in-calendar
1805 (mark-calendar-holidays)
1806 (sit-for 0))
1807 (unwind-protect
1808 (if mark-diary-entries-in-calendar (mark-diary-entries))
1809 (if today-visible
1810 (run-hooks 'today-visible-calendar-hook)
1811 (run-hooks 'today-invisible-calendar-hook)))))
1812
1813(defun generate-calendar (month year)
1814 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
1815 (if (< (+ month (* 12 (1- year))) 2)
1816 (error "Months before February, 1 AD are not available."))
1817 (setq displayed-month month)
1818 (setq displayed-year year)
1819 (erase-buffer)
1820 (increment-calendar-month month year -1)
1821 (calendar-for-loop i from 0 to 2 do
1822 (generate-calendar-month month year (+ 5 (* 25 i)))
1823 (increment-calendar-month month year 1)))
1824
1825(defun generate-calendar-month (month year indent)
1826 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
1827The calendar is inserted in the buffer starting at the line on which point
1828is currently located, but indented INDENT spaces. The indentation is done
1829from the first character on the line and does not disturb the first INDENT
1830characters on the line."
d8a200a7 1831 (let* ((blank-days;; at start of month
b6c0aabf 1832 (mod
d8a200a7
RS
1833 (- (calendar-day-of-week (list month 1 year))
1834 calendar-week-start-day)
1835 7))
1836 (last (calendar-last-day-of-month month year)))
1837 (goto-char (point-min))
1838 (calendar-insert-indented
1839 (calendar-string-spread
cbecb9f9 1840 (list (format "%s %d" (calendar-month-name month) year)) ? 20)
d8a200a7
RS
1841 indent t)
1842 (calendar-insert-indented "" indent);; Go to proper spot
1843 (calendar-for-loop i from 0 to 6 do
ae58b7ad
RS
1844 (insert (calendar-day-name (mod (+ calendar-week-start-day i) 7)
1845 2 t))
d8a200a7
RS
1846 (insert " "))
1847 (calendar-insert-indented "" 0 t);; Force onto following line
1848 (calendar-insert-indented "" indent);; Go to proper spot
1849 ;; Add blank days before the first of the month
1850 (calendar-for-loop i from 1 to blank-days do (insert " "))
1851 ;; Put in the days of the month
1852 (calendar-for-loop i from 1 to last do
1853 (insert (format "%2d " i))
218abc51
EZ
1854 (add-text-properties
1855 (- (point) 3) (1- (point))
1856 '(mouse-face highlight
1857 help-echo "mouse-2: menu of operations for this date"))
b6c0aabf 1858 (and (zerop (mod (+ i blank-days) 7))
d8a200a7
RS
1859 (/= i last)
1860 (calendar-insert-indented "" 0 t) ;; Force onto following line
1861 (calendar-insert-indented "" indent)))));; Go to proper spot
ecaa0527
RS
1862
1863(defun calendar-insert-indented (string indent &optional newline)
1864 "Insert STRING at column INDENT.
1865If the optional parameter NEWLINE is t, leave point at start of next line,
1866inserting a newline if there was no next line; otherwise, leave point after
1867the inserted text. Value is always t."
1868 ;; Try to move to that column.
1869 (move-to-column indent)
1870 ;; If line is too short, indent out to that column.
1871 (if (< (current-column) indent)
1872 (indent-to indent))
1873 (insert string)
1874 ;; Advance to next line, if requested.
1875 (if newline
1876 (progn
1877 (end-of-line)
1878 (if (eobp)
1879 (newline)
1880 (forward-line 1))))
1881 t)
1882
1883(defun redraw-calendar ()
1884 "Redraw the calendar display."
1885 (interactive)
d172e3e4 1886 (let ((cursor-date (calendar-cursor-to-nearest-date)))
7e1dae73 1887 (generate-calendar-window displayed-month displayed-year)
ecaa0527
RS
1888 (calendar-cursor-to-visible-date cursor-date)))
1889
b032077a
RS
1890(defcustom calendar-debug-sexp nil
1891 "*Turn debugging on when evaluating a sexp in the diary or holiday list."
1892 :type 'boolean
1893 :group 'calendar)
354d0644 1894
ecaa0527
RS
1895(defvar calendar-mode-map nil)
1896(if calendar-mode-map
1897 nil
1898 (setq calendar-mode-map (make-sparse-keymap))
13f0f988 1899 (if (display-popup-menus-p) (require 'cal-menu))
ecaa0527
RS
1900 (calendar-for-loop i from 0 to 9 do
1901 (define-key calendar-mode-map (int-to-string i) 'digit-argument))
1902 (let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph
6b39e127 1903 'mark-defun 'mark-whole-buffer 'mark-page
8f12817f
ER
1904 'downcase-region 'upcase-region 'kill-region
1905 'copy-region-as-kill 'capitalize-region 'write-region)))
6b39e127
RS
1906 (while l
1907 (substitute-key-definition (car l) 'calendar-not-implemented
1908 calendar-mode-map global-map)
1909 (setq l (cdr l))))
ecaa0527
RS
1910 (define-key calendar-mode-map "-" 'negative-argument)
1911 (define-key calendar-mode-map "\C-x>" 'scroll-calendar-right)
0d336f18 1912 (define-key calendar-mode-map [prior] 'scroll-calendar-right-three-months)
ff4373ed 1913 (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
ecaa0527 1914 (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
0d336f18 1915 (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
ff4373ed 1916 (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
ecaa0527
RS
1917 (define-key calendar-mode-map "\C-b" 'calendar-backward-day)
1918 (define-key calendar-mode-map "\C-p" 'calendar-backward-week)
7e1dae73 1919 (define-key calendar-mode-map "\e{" 'calendar-backward-month)
ecaa0527
RS
1920 (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
1921 (define-key calendar-mode-map "\C-f" 'calendar-forward-day)
1922 (define-key calendar-mode-map "\C-n" 'calendar-forward-week)
e9c78f07
RS
1923 (define-key calendar-mode-map [left] 'calendar-backward-day)
1924 (define-key calendar-mode-map [up] 'calendar-backward-week)
1925 (define-key calendar-mode-map [right] 'calendar-forward-day)
1926 (define-key calendar-mode-map [down] 'calendar-forward-week)
7e1dae73 1927 (define-key calendar-mode-map "\e}" 'calendar-forward-month)
ecaa0527
RS
1928 (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
1929 (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
1930 (define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
1931 (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month)
1932 (define-key calendar-mode-map "\ee" 'calendar-end-of-month)
1933 (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
1934 (define-key calendar-mode-map "\e>" 'calendar-end-of-year)
1935 (define-key calendar-mode-map "\C-@" 'calendar-set-mark)
5e2a0ae4 1936 ;; Many people are used to typing C-SPC and getting C-@.
e68e61b5 1937 (define-key calendar-mode-map [?\C- ] 'calendar-set-mark)
ecaa0527 1938 (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
7e1dae73
JB
1939 (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
1940 (define-key calendar-mode-map "gd" 'calendar-goto-date)
1941 (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
1942 (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
1943 (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
1944 (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
7086b78e
ER
1945 (define-key calendar-mode-map "gC" 'calendar-goto-chinese-date)
1946 (define-key calendar-mode-map "gk" 'calendar-goto-coptic-date)
1947 (define-key calendar-mode-map "ge" 'calendar-goto-ethiopic-date)
c21eb13d 1948 (define-key calendar-mode-map "gp" 'calendar-goto-persian-date)
7e1dae73
JB
1949 (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
1950 (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
1951 (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
1952 (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
1953 (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
1954 (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
1955 (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
1956 (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
1957 (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
14f1a889
ER
1958 (define-key calendar-mode-map "Aa" 'appt-add)
1959 (define-key calendar-mode-map "Ad" 'appt-delete)
7e1dae73
JB
1960 (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
1961 (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
1962 (define-key calendar-mode-map " " 'scroll-other-window)
ecaa0527 1963 (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
899b130e 1964 (define-key calendar-mode-map "." 'calendar-goto-today)
7e1dae73
JB
1965 (define-key calendar-mode-map "o" 'calendar-other-month)
1966 (define-key calendar-mode-map "q" 'exit-calendar)
1967 (define-key calendar-mode-map "a" 'list-calendar-holidays)
1968 (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
1969 (define-key calendar-mode-map "x" 'mark-calendar-holidays)
1970 (define-key calendar-mode-map "u" 'calendar-unmark)
1971 (define-key calendar-mode-map "m" 'mark-diary-entries)
1972 (define-key calendar-mode-map "d" 'view-diary-entries)
46e07c15 1973 (define-key calendar-mode-map "D" 'view-other-diary-entries)
7e1dae73
JB
1974 (define-key calendar-mode-map "s" 'show-all-diary-entries)
1975 (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
7086b78e
ER
1976 (define-key calendar-mode-map "pC" 'calendar-print-chinese-date)
1977 (define-key calendar-mode-map "pk" 'calendar-print-coptic-date)
1978 (define-key calendar-mode-map "pe" 'calendar-print-ethiopic-date)
c21eb13d 1979 (define-key calendar-mode-map "pp" 'calendar-print-persian-date)
7e1dae73
JB
1980 (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
1981 (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
1982 (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
1983 (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
1984 (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
1985 (define-key calendar-mode-map "pf" 'calendar-print-french-date)
1986 (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
726669d8 1987 (define-key calendar-mode-map "po" 'calendar-print-other-dates)
7e1dae73
JB
1988 (define-key calendar-mode-map "id" 'insert-diary-entry)
1989 (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
1990 (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
1991 (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
1992 (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
1993 (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
1994 (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
1995 (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
1996 (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
1997 (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
1998 (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
1999 (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
2000 (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
3076647c
ER
2001 (define-key calendar-mode-map "?" 'calendar-goto-info-node)
2002 (define-key calendar-mode-map "tm" 'cal-tex-cursor-month)
2003 (define-key calendar-mode-map "tM" 'cal-tex-cursor-month-landscape)
2004 (define-key calendar-mode-map "td" 'cal-tex-cursor-day)
2005 (define-key calendar-mode-map "tw1" 'cal-tex-cursor-week)
2006 (define-key calendar-mode-map "tw2" 'cal-tex-cursor-week2)
5a2c140a
RS
2007 (define-key calendar-mode-map "tw3" 'cal-tex-cursor-week-iso)
2008 (define-key calendar-mode-map "tw4" 'cal-tex-cursor-week-monday)
9018e77d 2009 (define-key calendar-mode-map "tfd" 'cal-tex-cursor-filofax-daily)
5a2c140a
RS
2010 (define-key calendar-mode-map "tfw" 'cal-tex-cursor-filofax-2week)
2011 (define-key calendar-mode-map "tfW" 'cal-tex-cursor-filofax-week)
3076647c
ER
2012 (define-key calendar-mode-map "tfy" 'cal-tex-cursor-filofax-year)
2013 (define-key calendar-mode-map "ty" 'cal-tex-cursor-year)
2014 (define-key calendar-mode-map "tY" 'cal-tex-cursor-year-landscape))
ecaa0527
RS
2015
2016(defun describe-calendar-mode ()
2017 "Create a help buffer with a brief description of the calendar-mode."
2018 (interactive)
2019 (with-output-to-temp-buffer "*Help*"
2020 (princ
2021 (format
2022 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
2023 (substitute-command-keys
2024 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
2025 (substitute-command-keys "\\{calendar-mode-map}")))
ddbfcbde
KH
2026 (save-excursion
2027 (set-buffer standard-output)
2028 (help-mode))
ecaa0527
RS
2029 (print-help-return-message)))
2030
2031;; Calendar mode is suitable only for specially formatted data.
2032(put 'calendar-mode 'mode-class 'special)
2033
2034(defvar calendar-mode-line-format
7e1dae73 2035 (list
d4ff5db9
DL
2036 (propertize (substitute-command-keys
2037 "\\<calendar-mode-map>\\[scroll-calendar-left]")
2038 'help-echo "mouse-2: scroll left"
2039 'keymap (make-mode-line-mouse2-map #'scroll-calendar-left))
7e1dae73 2040 "Calendar"
d4ff5db9
DL
2041 (concat
2042 (propertize
2043 (substitute-command-keys
2044 "\\<calendar-mode-map>\\[calendar-goto-info-node] info")
2045 'help-echo "mouse-2: read Info on Calendar"
2046 'keymap (make-mode-line-mouse2-map #'calendar-goto-info-node))
2047 "/"
2048 (propertize
2049 (substitute-command-keys
2050 "\\<calendar-mode-map>\\[calendar-other-month] other")
2051 'help-echo "mouse-2: choose another month"
2052 'keymap (make-mode-line-mouse2-map (lambda ()
2053 (interactive)
2054 (call-interactively
2055 'calendar-other-month))))
2056 "/"
2057 (propertize
2058 (substitute-command-keys
2059 "\\<calendar-mode-map>\\[calendar-goto-today] today")
2060 'help-echo "mouse-2: go to today's date"
2061 'keymap (make-mode-line-mouse2-map #'calendar-goto-today)))
7e1dae73 2062 '(calendar-date-string (calendar-current-date) t)
d4ff5db9
DL
2063 (propertize (substitute-command-keys
2064 "\\<calendar-mode-map>\\[scroll-calendar-right]")
2065 'help-echo "mouse-2: scroll right"
2066 'keymap (make-mode-line-mouse2-map #'scroll-calendar-right)))
ecaa0527
RS
2067 "The mode line of the calendar buffer.")
2068
cba0c253
ER
2069(defun calendar-goto-info-node ()
2070 "Go to the info node for the calendar."
2071 (interactive)
2072 (require 'info)
83ff5106
RS
2073 (let ((where (save-window-excursion
2074 (Info-find-emacs-command-nodes 'calendar))))
cba0c253
ER
2075 (if (not where)
2076 (error "Couldn't find documentation for the calendar.")
83ff5106
RS
2077 (let (same-window-buffer-names)
2078 (info))
cba0c253
ER
2079 (Info-find-node (car (car where)) (car (cdr (car where)))))))
2080
ecaa0527 2081(defun calendar-mode ()
7e1dae73 2082 "A major mode for the calendar window.
ecaa0527 2083
cba0c253
ER
2084For a complete description, type \
2085\\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
ecaa0527 2086
cba0c253 2087\\<calendar-mode-map>\\{calendar-mode-map}"
ecaa0527
RS
2088
2089 (kill-all-local-variables)
2090 (setq major-mode 'calendar-mode)
2091 (setq mode-name "Calendar")
2092 (use-local-map calendar-mode-map)
2093 (setq buffer-read-only t)
2094 (setq indent-tabs-mode nil)
7e1dae73 2095 (update-calendar-mode-line)
13f0f988 2096 (if (display-popup-menus-p)
9c73a356
ER
2097 (progn
2098 (make-local-hook 'activate-menubar-hook)
2099 (add-hook 'activate-menubar-hook 'cal-menu-update nil t)))
ecaa0527 2100 (make-local-variable 'calendar-mark-ring)
ecaa0527
RS
2101 (make-local-variable 'displayed-month);; Month in middle of window.
2102 (make-local-variable 'displayed-year));; Year in middle of window.
2103
7e1dae73 2104(defun calendar-string-spread (strings char length)
cbecb9f9
ER
2105 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
2106The effect is like mapconcat but the separating pieces are as balanced as
2107possible. Each item of STRINGS is evaluated before concatenation so it can
2108actually be an expression that evaluates to a string. If LENGTH is too short,
2109the STRINGS are just concatenated and the result truncated."
7e1dae73
JB
2110;; The algorithm is based on equation (3.25) on page 85 of Concrete
2111;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
2112;; Addison-Wesley, Reading, MA, 1989
cbecb9f9
ER
2113 (let* ((strings (mapcar 'eval
2114 (if (< (length strings) 2)
2115 (append (list "") strings (list ""))
2116 strings)))
7e1dae73
JB
2117 (n (- length (length (apply 'concat strings))))
2118 (m (1- (length strings)))
2119 (s (car strings))
2120 (strings (cdr strings))
2121 (i 0))
2122 (while strings
2123 (setq s (concat s
2124 (make-string (max 0 (/ (+ n i) m)) char)
2125 (car strings)))
2126 (setq i (1+ i))
2127 (setq strings (cdr strings)))
2128 (substring s 0 length)))
2129
ecaa0527
RS
2130(defun update-calendar-mode-line ()
2131 "Update the calendar mode line with the current date and date style."
2132 (if (bufferp (get-buffer calendar-buffer))
2133 (save-excursion
2134 (set-buffer calendar-buffer)
2135 (setq mode-line-format
7e1dae73
JB
2136 (calendar-string-spread
2137 calendar-mode-line-format ? (frame-width))))))
ecaa0527 2138
cba0c253
ER
2139(defun calendar-window-list ()
2140 "List of all calendar-related windows."
2141 (let ((calendar-buffers (calendar-buffer-list))
2142 list)
d4ff5db9
DL
2143 (walk-windows (lambda (w)
2144 (if (memq (window-buffer w) calendar-buffers)
2145 (setq list (cons w list))))
cba0c253
ER
2146 nil t)
2147 list))
2148
2149(defun calendar-buffer-list ()
2150 "List of all calendar-related buffers."
2151 (let* ((diary-buffer (get-file-buffer diary-file))
2152 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
9c73a356
ER
2153 fancy-diary-buffer diary-buffer calendar-buffer
2154 other-calendars-buffer))
cba0c253
ER
2155 (buffer-list nil)
2156 b)
2157 (while buffers
2158 (setq b (car buffers))
2159 (setq b (cond ((stringp b) (get-buffer b))
2160 ((bufferp b) b)
2161 (t nil)))
2162 (if b (setq buffer-list (cons b buffer-list)))
2163 (setq buffers (cdr buffers)))
2164 buffer-list))
2165
ecaa0527 2166(defun exit-calendar ()
cba0c253 2167 "Get out of the calendar window and hide it and related buffers."
ecaa0527 2168 (interactive)
cba0c253 2169 (let* ((diary-buffer (get-file-buffer diary-file)))
38023020
ER
2170 (if (or (not diary-buffer)
2171 (not (buffer-modified-p diary-buffer))
2172 (yes-or-no-p
2173 "Diary modified; do you really want to exit the calendar? "))
cba0c253
ER
2174 ;; Need to do this multiple times because one time can replace some
2175 ;; calendar-related buffers with other calendar-related buffers
2176 (mapcar (lambda (x)
2177 (mapcar 'calendar-hide-window (calendar-window-list)))
2178 (calendar-window-list)))))
2179
2180(defun calendar-hide-window (window)
2181 "Hide WINDOW if it is calendar-related."
2182 (let ((buffer (if (window-live-p window) (window-buffer window))))
2183 (if (memq buffer (calendar-buffer-list))
2184 (cond
13f0f988 2185 ((and (display-multi-frame-p)
cba0c253
ER
2186 (eq 'icon (cdr (assoc 'visibility
2187 (frame-parameters
2188 (window-frame window))))))
2189 nil)
13f0f988 2190 ((and (display-multi-frame-p) (window-dedicated-p window))
7e1e5cf1
SS
2191 (if calendar-remove-frame-by-deleting
2192 (delete-frame (window-frame window))
2193 (iconify-frame (window-frame window))))
cba0c253
ER
2194 ((not (and (select-window window) (one-window-p window)))
2195 (delete-window window))
2196 (t (set-buffer buffer)
2197 (bury-buffer))))))
ecaa0527 2198
ecaa0527 2199(defun calendar-current-date ()
3cbb4860 2200 "Return the current date in a list (month day year)."
d8396371
RS
2201 (let ((now (decode-time)))
2202 (list (nth 4 now) (nth 3 now) (nth 5 now))))
ecaa0527 2203
ffd82264 2204(defun calendar-cursor-to-date (&optional error)
3cbb4860 2205 "Return a list (month day year) of current cursor position.
ffd82264
RS
2206If cursor is not on a specific date, signals an error if optional parameter
2207ERROR is t, otherwise just returns nil."
c93b9aae
ER
2208 (let* ((segment (/ (current-column) 25))
2209 (month (% (+ displayed-month segment -1) 12))
2210 (month (if (= 0 month) 12 month))
2211 (year
2212 (cond
2213 ((and (= 12 month) (= segment 0)) (1- displayed-year))
2214 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
2215 (t displayed-year))))
7086b78e 2216 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
c93b9aae
ER
2217 (< 2 (count-lines (point-min) (point))))
2218 (save-excursion
7086b78e
ER
2219 (if (not (looking-at " "))
2220 (re-search-backward "[^0-9]"))
c93b9aae
ER
2221 (list month
2222 (string-to-int (buffer-substring (1+ (point)) (+ 4 (point))))
2223 year))
21c8986e
ER
2224 (if (looking-at "\\*")
2225 (save-excursion
2226 (re-search-backward "[^*]")
2227 (if (looking-at ".\\*\\*")
3a7f8079 2228 (list month calendar-starred-day year)
21c8986e
ER
2229 (if error (error "Not on a date!"))))
2230 (if error (error "Not on a date!"))))))
ecaa0527 2231
354d0644
JB
2232;; The following version of calendar-gregorian-from-absolute is preferred for
2233;; reasons of clarity, BUT it's much slower than the version that follows it.
2234
2235;;(defun calendar-gregorian-from-absolute (date)
2236;; "Compute the list (month day year) corresponding to the absolute DATE.
2237;;The absolute date is the number of days elapsed since the (imaginary)
2238;;Gregorian date Sunday, December 31, 1 BC."
2239;; (let* ((approx (/ date 366));; Approximation from below.
2240;; (year ;; Search forward from the approximation.
2241;; (+ approx
2242;; (calendar-sum y approx
2243;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2244;; 1)))
2245;; (month ;; Search forward from January.
2246;; (1+ (calendar-sum m 1
2247;; (> date
2248;; (calendar-absolute-from-gregorian
2249;; (list m (calendar-last-day-of-month m year) year)))
2250;; 1)))
2251;; (day ;; Calculate the day by subtraction.
2252;; (- date
2253;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2254;; (list month day year)))
2255
ecaa0527
RS
2256(defun calendar-gregorian-from-absolute (date)
2257 "Compute the list (month day year) corresponding to the absolute DATE.
2258The absolute date is the number of days elapsed since the (imaginary)
2259Gregorian date Sunday, December 31, 1 BC."
354d0644
JB
2260;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2261;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2262;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2263;; (April, 1993), pages 383-404 for an explanation.
2264 (let* ((d0 (1- date))
2265 (n400 (/ d0 146097))
2266 (d1 (% d0 146097))
2267 (n100 (/ d1 36524))
2268 (d2 (% d1 36524))
2269 (n4 (/ d2 1461))
2270 (d3 (% d2 1461))
2271 (n1 (/ d3 365))
2272 (day (1+ (% d3 365)))
2273 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2274 (if (or (= n100 4) (= n1 4))
2275 (list 12 31 year)
2276 (let ((year (1+ year))
2277 (month 1))
2278 (while (let ((mdays (calendar-last-day-of-month month year)))
2279 (and (< mdays day)
2280 (setq day (- day mdays))))
2281 (setq month (1+ month)))
2282 (list month day year)))))
ecaa0527 2283
ecaa0527
RS
2284(defun calendar-other-month (month year)
2285 "Display a three-month calendar centered around MONTH and YEAR."
ecd42d42 2286 (interactive (calendar-read-date 'noday))
ecaa0527
RS
2287 (if (and (= month displayed-month)
2288 (= year displayed-year))
2289 nil
2290 (let ((old-date (calendar-cursor-to-date))
2291 (today (calendar-current-date)))
7e1dae73 2292 (generate-calendar-window month year)
ecaa0527
RS
2293 (calendar-cursor-to-visible-date
2294 (cond
2295 ((calendar-date-is-visible-p old-date) old-date)
2296 ((calendar-date-is-visible-p today) today)
2297 (t (list month 1 year)))))))
2298
2299(defun calendar-set-mark (arg)
2300 "Mark the date under the cursor, or jump to marked date.
2301With no prefix argument, push current date onto marked date ring.
2302With argument, jump to mark, pop it, and put point at end of ring."
2303 (interactive "P")
ffd82264 2304 (let ((date (calendar-cursor-to-date t)))
ecaa0527
RS
2305 (if (null arg)
2306 (progn
2307 (setq calendar-mark-ring (cons date calendar-mark-ring))
2308 ;; Since the top of the mark ring is the marked date in the
2309 ;; calendar, the mark ring in the calendar is one longer than
2310 ;; in other buffers to get the same effect.
2311 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2312 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2313 (message "Mark set"))
2314 (if (null calendar-mark-ring)
2315 (error "No mark set in this buffer")
2316 (calendar-goto-date (car calendar-mark-ring))
2317 (setq calendar-mark-ring
2318 (cdr (nconc calendar-mark-ring (list date))))))))
2319
2320(defun calendar-exchange-point-and-mark ()
2321 "Exchange the current cursor position with the marked date."
2322 (interactive)
2323 (let ((mark (car calendar-mark-ring))
ffd82264 2324 (date (calendar-cursor-to-date t)))
ecaa0527
RS
2325 (if (null mark)
2326 (error "No mark set in this buffer")
2327 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2328 (calendar-goto-date mark))))
2329
2330(defun calendar-count-days-region ()
2331 "Count the number of days (inclusive) between point and the mark."
2332 (interactive)
2333 (let* ((days (- (calendar-absolute-from-gregorian
ffd82264 2334 (calendar-cursor-to-date t))
ecaa0527
RS
2335 (calendar-absolute-from-gregorian
2336 (or (car calendar-mark-ring)
2337 (error "No mark set in this buffer")))))
2338 (days (1+ (if (> days 0) days (- days)))))
2339 (message "Region has %d day%s (inclusive)"
2340 days (if (> days 1) "s" ""))))
2341
2342(defun calendar-not-implemented ()
2343 "Not implemented."
2344 (interactive)
2345 (error "%s not available in the calendar"
2346 (global-key-binding (this-command-keys))))
2347
2348(defun calendar-read (prompt acceptable &optional initial-contents)
2349 "Return an object read from the minibuffer.
2350Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2351entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2352is a string to insert in the minibuffer before reading."
2353 (let ((value (read-minibuffer prompt initial-contents)))
2354 (while (not (funcall acceptable value))
2355 (setq value (read-minibuffer prompt initial-contents)))
2356 value))
2357
cba0c253 2358(defun calendar-read-date (&optional noday)
3cbb4860 2359 "Prompt for Gregorian date. Return a list (month day year).
cba0c253 2360If optional NODAY is t, does not ask for day, but just returns
ae58b7ad 2361\(month nil year); if NODAY is any other non-nil value the value returned is
3cbb4860 2362\(month year)"
7e1dae73
JB
2363 (let* ((year (calendar-read
2364 "Year (>0): "
d4ff5db9 2365 (lambda (x) (> x 0))
7e1dae73
JB
2366 (int-to-string (extract-calendar-year
2367 (calendar-current-date)))))
2368 (month-array calendar-month-name-array)
2369 (completion-ignore-case t)
bf51dce3 2370 (month (cdr (assoc-ignore-case
7e1dae73
JB
2371 (completing-read
2372 "Month name: "
2373 (mapcar 'list (append month-array nil))
bf51dce3
RS
2374 nil t)
2375 (calendar-make-alist month-array 1))))
cba0c253 2376 (last (calendar-last-day-of-month month year)))
ecd42d42
ER
2377 (if noday
2378 (if (eq noday t)
2379 (list month nil year)
2380 (list month year))
2381 (list month
2382 (calendar-read (format "Day (1-%d): " last)
d4ff5db9 2383 (lambda (x) (and (< 0 x) (<= x last))))
ecd42d42 2384 year))))
7e1dae73 2385
ecaa0527 2386(defun calendar-interval (mon1 yr1 mon2 yr2)
7e1dae73 2387 "The number of months difference between MON1, YR1 and MON2, YR2."
ecaa0527
RS
2388 (+ (* 12 (- yr2 yr1))
2389 (- mon2 mon1)))
2390
ae58b7ad 2391(defun calendar-day-name (date &optional width absolute)
3cbb4860 2392 "Return a string with the name of the day of the week of DATE.
ae58b7ad 2393If WIDTH is non-nil, return just the first WIDTH characters of the name.
ed80a8e4 2394If ABSOLUTE is non-nil, then DATE is actually the day-of-the-week
ae58b7ad
RS
2395rather than a date."
2396 (let ((string (aref calendar-day-name-array
2397 (if absolute date (calendar-day-of-week date)))))
ed80a8e4
KH
2398 (cond ((null width) string)
2399 (enable-multibyte-characters (truncate-string-to-width string width))
2400 (t (substring string 0 width)))))
ecaa0527 2401
d8a200a7 2402(defvar calendar-day-name-array
b642d11e
ER
2403 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2404 "Array of capitalized strings giving, in order, the day names.")
ecaa0527 2405
d8a200a7 2406(defvar calendar-month-name-array
ecaa0527 2407 ["January" "February" "March" "April" "May" "June"
b642d11e
ER
2408 "July" "August" "September" "October" "November" "December"]
2409 "Array of capitalized strings giving, in order, the month names.")
ecaa0527
RS
2410
2411(defun calendar-make-alist (sequence &optional start-index filter)
2412 "Make an assoc list corresponding to SEQUENCE.
2413Start at index 1, unless optional START-INDEX is provided.
2414If FILTER is provided, apply it to each item in the list."
2415 (let ((index (if start-index (1- start-index) 0)))
2416 (mapcar
3cbb4860 2417 (lambda (x)
ecaa0527
RS
2418 (setq index (1+ index))
2419 (cons (if filter (funcall filter x) x)
2420 index))
2421 (append sequence nil))))
2422
ae58b7ad
RS
2423(defun calendar-month-name (month &optional width)
2424 "The name of MONTH.
2425If WIDTH is non-nil, return just the first WIDTH characters of the name."
2426 (let ((string (aref calendar-month-name-array (1- month))))
2427 (if width
2428 (let ((i 0) (result "") (pos 0))
2429 (while (< i width)
d4ff5db9 2430 (let ((chartext (char-to-string (aref string pos))))
ae58b7ad
RS
2431 (setq pos (+ pos (length chartext)))
2432 (setq result (concat result chartext)))
2433 (setq i (1+ i)))
2434 result)
2435 string)))
ecaa0527
RS
2436
2437(defun calendar-day-of-week (date)
3cbb4860 2438 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc."
ecaa0527
RS
2439 (% (calendar-absolute-from-gregorian date) 7))
2440
ecaa0527 2441(defun calendar-unmark ()
6a2aa94c 2442 "Delete all diary/holiday marks/highlighting from the calendar."
ecaa0527 2443 (interactive)
ecaa0527 2444 (setq mark-holidays-in-calendar nil)
6a2aa94c
RS
2445 (setq mark-diary-entries-in-calendar nil)
2446 (redraw-calendar))
ecaa0527
RS
2447
2448(defun calendar-date-is-visible-p (date)
3cbb4860 2449 "Return t if DATE is legal and is visible in the calendar window."
ecaa0527
RS
2450 (let ((gap (calendar-interval
2451 displayed-month displayed-year
2452 (extract-calendar-month date) (extract-calendar-year date))))
2453 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2454
2455(defun calendar-date-is-legal-p (date)
3cbb4860 2456 "Return t if DATE is a legal date."
ecaa0527
RS
2457 (let ((month (extract-calendar-month date))
2458 (day (extract-calendar-day date))
2459 (year (extract-calendar-year date)))
2460 (and (<= 1 month) (<= month 12)
2461 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2462 (<= 1 year))))
2463
2464(defun calendar-date-equal (date1 date2)
3cbb4860 2465 "Return t if the DATE1 and DATE2 are the same."
ecaa0527
RS
2466 (and
2467 (= (extract-calendar-month date1) (extract-calendar-month date2))
2468 (= (extract-calendar-day date1) (extract-calendar-day date2))
2469 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2470
2471(defun mark-visible-calendar-date (date &optional mark)
6a2aa94c
RS
2472 "Mark DATE in the calendar window with MARK.
2473MARK is either a single-character string or a face.
2474MARK defaults to diary-entry-marker."
ecaa0527
RS
2475 (if (calendar-date-is-legal-p date)
2476 (save-excursion
2477 (set-buffer calendar-buffer)
2478 (calendar-cursor-to-visible-date date)
6a2aa94c
RS
2479 (let ((mark (or mark diary-entry-marker)))
2480 (if (stringp mark)
2481 (let ((buffer-read-only nil))
2482 (forward-char 1)
2483 (delete-char 1)
2484 (insert mark)
2485 (forward-char -2))
2486 (overlay-put
7086b78e 2487 (make-overlay (1- (point)) (1+ (point))) 'face mark))))))
ecaa0527
RS
2488
2489(defun calendar-star-date ()
2490 "Replace the date under the cursor in the calendar window with asterisks.
3cbb4860 2491This function can be used with the `today-visible-calendar-hook' run after the
ecaa0527 2492calendar window has been prepared."
3cbb4860
SM
2493 (let ((inhibit-read-only t))
2494 (make-local-variable 'calendar-starred-day)
ecaa0527 2495 (forward-char 1)
c00f638d 2496 (setq calendar-starred-day
7e1dae73
JB
2497 (string-to-int
2498 (buffer-substring (point) (- (point) 2))))
ecaa0527
RS
2499 (delete-char -2)
2500 (insert "**")
2501 (backward-char 1)
2502 (set-buffer-modified-p nil)))
2503
2504(defun calendar-mark-today ()
6a2aa94c
RS
2505 "Mark the date under the cursor in the calendar window.
2506The date is marked with calendar-today-marker. This function can be used with
3cbb4860 2507the `today-visible-calendar-hook' run after the calendar window has been
6a2aa94c
RS
2508prepared."
2509 (mark-visible-calendar-date
2510 (calendar-cursor-to-date)
2511 calendar-today-marker))
ecaa0527
RS
2512
2513(defun calendar-date-compare (date1 date2)
3cbb4860 2514 "Return t if DATE1 is before DATE2, nil otherwise.
ecaa0527
RS
2515The actual dates are in the car of DATE1 and DATE2."
2516 (< (calendar-absolute-from-gregorian (car date1))
2517 (calendar-absolute-from-gregorian (car date2))))
2518
2519(defun calendar-date-string (date &optional abbreviate nodayname)
2520 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2521An optional parameter ABBREVIATE, when t, causes the month and day names to be
2522abbreviated to three characters. An optional parameter NODAYNAME, when t,
2523omits the name of the day of the week."
2524 (let* ((dayname
2525 (if nodayname
7e1dae73 2526 nil
ecaa0527 2527 (if abbreviate
ae58b7ad 2528 (calendar-day-name date 3)
ecaa0527
RS
2529 (calendar-day-name date))))
2530 (month (extract-calendar-month date))
2531 (monthname
2532 (if abbreviate
ae58b7ad 2533 (calendar-month-name month 3)
ecaa0527
RS
2534 (calendar-month-name month)))
2535 (day (int-to-string (extract-calendar-day date)))
2536 (month (int-to-string month))
2537 (year (int-to-string (extract-calendar-year date))))
2538 (mapconcat 'eval calendar-date-display-form "")))
2539
2540(defun calendar-dayname-on-or-before (dayname date)
3cbb4860 2541 "Return the absolute date of the DAYNAME on or before absolute DATE.
ecaa0527
RS
2542DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
2543
2544Note: Applying this function to d+6 gives us the DAYNAME on or after an
2545absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
2546absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
2547date d, and applying it to d+7 gives the DAYNAME following absolute date d."
2548 (- date (% (- date dayname) 7)))
2549
04d5d338
PE
2550(defun calendar-nth-named-absday (n dayname month year &optional day)
2551 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2552A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2553return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2554If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2555
2556If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2557 (if (> n 0)
2558 (+ (* 7 (1- n))
2559 (calendar-dayname-on-or-before
2560 dayname
2561 (+ 6 (calendar-absolute-from-gregorian
2562 (list month (or day 1) year)))))
2563 (+ (* 7 (1+ n))
2564 (calendar-dayname-on-or-before
2565 dayname
2566 (calendar-absolute-from-gregorian
2567 (list month
2568 (or day (calendar-last-day-of-month month year))
2569 year))))))
2570
354d0644
JB
2571(defun calendar-nth-named-day (n dayname month year &optional day)
2572 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2573A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2574return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2575If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2576
2577If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
ecaa0527 2578 (calendar-gregorian-from-absolute
04d5d338 2579 (calendar-nth-named-absday n dayname month year day)))
ecaa0527 2580
6a2aa94c
RS
2581(defun calendar-day-of-year-string (&optional date)
2582 "String of day number of year of Gregorian DATE.
2583Defaults to today's date if DATE is not given."
2584 (let* ((d (or date (calendar-current-date)))
2585 (year (extract-calendar-year d))
2586 (day (calendar-day-number d))
2587 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
2588 (format "Day %d of %d; %d day%s remaining in the year"
2589 day year days-remaining (if (= days-remaining 1) "" "s"))))
2590
726669d8
ER
2591(defun calendar-print-other-dates ()
2592 "Show dates on other calendars for date under the cursor."
2593 (interactive)
2594 (let* ((date (calendar-cursor-to-date t)))
2595 (save-excursion
2596 (set-buffer (get-buffer-create other-calendars-buffer))
2597 (setq buffer-read-only nil)
2598 (calendar-set-mode-line
2599 (concat (calendar-date-string date) " (Gregorian)"))
2600 (erase-buffer)
2601 (insert
2602 (mapconcat 'identity
2603 (list (calendar-day-of-year-string date)
2604 (format "ISO date: %s" (calendar-iso-date-string date))
2605 (format "Julian date: %s"
2606 (calendar-julian-date-string date))
2607 (format
2608 "Astronomical (Julian) day number (at noon UTC): %s.0"
2609 (calendar-astro-date-string date))
2610 (format "Fixed (RD) date: %s"
2611 (calendar-absolute-from-gregorian date))
2612 (format "Hebrew date (before sunset): %s"
2613 (calendar-hebrew-date-string date))
2614 (format "Persian date: %s"
2615 (calendar-persian-date-string date))
2616 (let ((i (calendar-islamic-date-string date)))
2617 (if (not (string-equal i ""))
2618 (format "Islamic date (before sunset): %s" i)))
2619 (format "Chinese date: %s"
2620 (calendar-chinese-date-string date))
2621 (let ((c (calendar-coptic-date-string date)))
2622 (if (not (string-equal c ""))
2623 (format "Coptic date: %s" c)))
2624 (let ((e (calendar-ethiopic-date-string date)))
2625 (if (not (string-equal e ""))
2626 (format "Ethiopic date: %s" e)))
2627 (let ((f (calendar-french-date-string date)))
2628 (if (not (string-equal f ""))
2629 (format "French Revolutionary date: %s" f)))
2630 (format "Mayan date: %s"
2631 (calendar-mayan-date-string date)))
2632 "\n"))
2633 (goto-char (point-min))
2634 (set-buffer-modified-p nil)
2635 (setq buffer-read-only t)
2636 (display-buffer other-calendars-buffer))))
2637
7e1dae73 2638(defun calendar-print-day-of-year ()
6a2aa94c 2639 "Show day number in year/days remaining in year for date under the cursor."
ecaa0527 2640 (interactive)
ffd82264 2641 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
ecaa0527 2642
7e1dae73
JB
2643(defun calendar-set-mode-line (str)
2644 "Set mode line to STR, centered, surrounded by dashes."
2645 (setq mode-line-format
cbecb9f9 2646 (calendar-string-spread (list str) ?- (frame-width))))
7e1dae73 2647
7086b78e
ER
2648(defun calendar-mod (m n)
2649 "Non-negative remainder of M/N with N instead of 0."
2650 (1+ (mod (1- m) n)))
7e1dae73
JB
2651
2652(run-hooks 'calendar-load-hook)
ecaa0527
RS
2653
2654(provide 'calendar)
2655
b578f267
EN
2656;;; Local variables:
2657;;; byte-compile-dynamic: t
2658;;; End:
2659
94b304d7 2660;;; calendar.el ends here