(latexenc-find-file-coding-system): Don't inherit the EOL part of the
[emacs.git] / lisp / calendar / calendar.el
blobfdf565c7923bd85a3f5be36d00ac9b34e1ac7163
1 ;;; calendar.el --- calendar functions
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997,
4 ;; 2000, 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <gmorris@ast.cam.ac.uk>
8 ;; Keywords: calendar
9 ;; Human-Keywords: calendar, Gregorian calendar, diary, holidays
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; This collection of functions implements a calendar window. It
31 ;; generates a calendar for the current month, together with the
32 ;; previous and coming months, or for any other three-month period.
33 ;; The calendar can be scrolled forward and backward in the window to
34 ;; show months in the past or future; the cursor can move forward and
35 ;; backward by days, weeks, or months, making it possible, for
36 ;; instance, to jump to the date a specified number of days, weeks, or
37 ;; months from the date under the cursor. The user can display a list
38 ;; of holidays and other notable days for the period shown; the
39 ;; notable days can be marked on the calendar, if desired. The user
40 ;; can also specify that dates having corresponding diary entries (in
41 ;; a file that the user specifies) be marked; the diary entries for
42 ;; any date can be viewed in a separate window. The diary and the
43 ;; notable days can be viewed independently of the calendar. Dates
44 ;; can be translated from the (usual) Gregorian calendar to the day of
45 ;; the year/days remaining in year, to the ISO commercial calendar, to
46 ;; the Julian (old style) calendar, to the Hebrew calendar, to the
47 ;; Islamic calendar, to the Baha'i calendar, to the French
48 ;; Revolutionary calendar, to the Mayan calendar, to the Chinese
49 ;; calendar, to the Coptic calendar, to the Ethiopic calendar, and to
50 ;; the astronomical (Julian) day number. When floating point is
51 ;; available, times of sunrise/sunset can be displayed, as can the
52 ;; phases of the moon. Appointment notification for diary entries is
53 ;; available. Calendar printing via LaTeX is available.
55 ;; The following files are part of the calendar/diary code:
57 ;; appt.el Appointment notification
58 ;; cal-china.el Chinese calendar
59 ;; cal-coptic.el Coptic/Ethiopic calendars
60 ;; cal-dst.el Daylight savings time rules
61 ;; cal-hebrew.el Hebrew calendar
62 ;; cal-islam.el Islamic calendar
63 ;; cal-bahai.el Baha'i calendar
64 ;; cal-iso.el ISO calendar
65 ;; cal-julian.el Julian/astronomical calendars
66 ;; cal-mayan.el Mayan calendars
67 ;; cal-menu.el Menu support
68 ;; cal-move.el Movement in the calendar
69 ;; cal-persia.el Persian calendar
70 ;; cal-tex.el Calendars in LaTeX
71 ;; cal-x.el X-windows dedicated frame functions
72 ;; diary-lib.el Diary functions
73 ;; holidays.el Holiday functions
74 ;; lunar.el Phases of the moon
75 ;; solar.el Sunrise/sunset, equinoxes/solstices
77 ;; Technical details of all the calendrical calculations can be found in
78 ;; ``Calendrical Calculations: The Millennium Edition'' by Edward M. Reingold
79 ;; and Nachum Dershowitz, Cambridge University Press (2001).
81 ;; An earlier version of the technical details appeared in
82 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
83 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
84 ;; pages 899-928, and in ``Calendrical Calculations, Part II: Three Historical
85 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
86 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
87 ;; pages 383-404.
89 ;; Hard copies of these two papers can be obtained by sending email to
90 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
91 ;; the message BODY containing your mailing address (snail).
93 ;; Comments, corrections, and improvements should be sent to
94 ;; Edward M. Reingold Department of Computer Science
95 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
96 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
97 ;; Urbana, Illinois 61801
99 ;;; Code:
101 (eval-when-compile
102 (defvar displayed-month)
103 (defvar displayed-year)
104 (defvar calendar-month-name-array)
105 (defvar calendar-starred-day))
107 (defun calendar-version ()
108 (interactive)
109 (message "Version 6, October 12, 1995"))
111 (defgroup calendar nil
112 "Calendar and time management support."
113 :group 'applications)
115 (defgroup diary nil
116 "Emacs diary."
117 :group 'calendar)
119 (defgroup appt nil
120 "Appointment notification."
121 :group 'calendar)
123 (defgroup holidays nil
124 "Holidays support in calendar."
125 :group 'calendar
126 :prefix "calendar-"
127 :group 'local)
129 (defgroup chinese-calendar nil
130 "Chinese calendar support."
131 :group 'calendar)
133 (defgroup calendar-tex nil
134 "Options for printing calendar with LaTeX."
135 :prefix "cal-tex-"
136 :group 'calendar)
138 (defgroup calendar-hooks nil
139 "Calendar hooks."
140 :prefix "calendar-"
141 :group 'calendar)
144 (defconst calendar-buffer "*Calendar*"
145 "Name of the buffer used for the calendar.")
147 ;;;###autoload
148 (defcustom calendar-offset 0
149 "*The offset of the principal month from the center of the calendar window.
150 0 means the principal month is in the center (default), -1 means on the left,
151 +1 means on the right. Larger (or smaller) values push the principal month off
152 the screen."
153 :type 'integer
154 :group 'calendar)
156 ;;;###autoload
157 (defcustom view-diary-entries-initially nil
158 "*Non-nil means display current date's diary entries on entry to calendar.
159 The diary is displayed in another window when the calendar is first displayed,
160 if the current date is visible. The number of days of diary entries displayed
161 is governed by the variable `number-of-diary-entries'. This variable can
162 be overridden by the value of `calendar-setup'."
163 :type 'boolean
164 :group 'diary)
166 ;;;###autoload
167 (defcustom number-of-diary-entries 1
168 "*Specifies how many days of diary entries are to be displayed initially.
169 This variable affects the diary display when the command \\[diary] is used,
170 or if the value of the variable `view-diary-entries-initially' is t. For
171 example, if the default value 1 is used, then only the current day's diary
172 entries will be displayed. If the value 2 is used, then both the current
173 day's and the next day's entries will be displayed.
175 The value can also be a vector such as [0 2 2 2 2 4 1]; this value
176 says to display no diary entries on Sunday, the display the entries
177 for the current date and the day after on Monday through Thursday,
178 display Friday through Monday's entries on Friday, and display only
179 Saturday's entries on Saturday.
181 This variable does not affect the diary display with the `d' command
182 from the calendar; in that case, the prefix argument controls the
183 number of days of diary entries displayed."
184 :type '(choice (integer :tag "Entries")
185 (vector :value [0 0 0 0 0 0 0]
186 (integer :tag "Sunday")
187 (integer :tag "Monday")
188 (integer :tag "Tuesday")
189 (integer :tag "Wednesday")
190 (integer :tag "Thursday")
191 (integer :tag "Friday")
192 (integer :tag "Saturday")))
193 :group 'diary)
195 ;;;###autoload
196 (defcustom mark-diary-entries-in-calendar nil
197 "*Non-nil means mark dates with diary entries, in the calendar window.
198 The marking symbol is specified by the variable `diary-entry-marker'."
199 :type 'boolean
200 :group 'diary)
202 ;;;###autoload
203 (defcustom calendar-remove-frame-by-deleting nil
204 "*Determine how the calendar mode removes a frame no longer needed.
205 If nil, make an icon of the frame. If non-nil, delete the frame."
206 :type 'boolean
207 :group 'view)
209 (defvar diary-face 'diary-face
210 "Face name to use for diary entries.")
211 (defface diary-face
212 '((((min-colors 88) (class color) (background light))
213 :foreground "red1")
214 (((class color) (background light))
215 :foreground "red")
216 (((min-colors 88) (class color) (background dark))
217 :foreground "yellow1")
218 (((class color) (background dark))
219 :foreground "yellow")
221 :weight bold))
222 "Face for highlighting diary entries."
223 :group 'diary)
225 (defface calendar-today-face
226 '((t (:underline t)))
227 "Face for indicating today's date."
228 :group 'diary)
230 (defface holiday-face
231 '((((class color) (background light))
232 :background "pink")
233 (((class color) (background dark))
234 :background "chocolate4")
236 :inverse-video t))
237 "Face for indicating dates that have holidays."
238 :group 'diary)
240 (eval-after-load "facemenu"
241 '(progn
242 (add-to-list 'facemenu-unlisted-faces 'diary-face)
243 (add-to-list 'facemenu-unlisted-faces 'calendar-today-face)
244 (add-to-list 'facemenu-unlisted-faces 'holiday-face)))
246 (defcustom diary-entry-marker
247 (if (not (display-color-p))
249 'diary-face)
250 "*How to mark dates that have diary entries.
251 The value can be either a single-character string or a face."
252 :type '(choice string face)
253 :group 'diary)
255 (defcustom calendar-today-marker
256 (if (not (display-color-p))
258 'calendar-today-face)
259 "*How to mark today's date in the calendar.
260 The value can be either a single-character string or a face.
261 Marking today's date is done only if you set up `today-visible-calendar-hook'
262 to request that."
263 :type '(choice string face)
264 :group 'calendar)
266 (defcustom calendar-holiday-marker
267 (if (not (display-color-p))
269 'holiday-face)
270 "*How to mark notable dates in the calendar.
271 The value can be either a single-character string or a face."
272 :type '(choice string face)
273 :group 'calendar)
275 ;;;###autoload
276 (defcustom view-calendar-holidays-initially nil
277 "*Non-nil means display holidays for current three month period on entry.
278 The holidays are displayed in another window when the calendar is first
279 displayed."
280 :type 'boolean
281 :group 'holidays)
283 ;;;###autoload
284 (defcustom mark-holidays-in-calendar nil
285 "*Non-nil means mark dates of holidays in the calendar window.
286 The marking symbol is specified by the variable `calendar-holiday-marker'."
287 :type 'boolean
288 :group 'holidays)
290 ;;;###autoload
291 (defcustom all-hebrew-calendar-holidays nil
292 "*If nil, show only major holidays from the Hebrew calendar.
293 This means only those Jewish holidays that appear on secular calendars.
295 If t, show all the holidays that would appear in a complete Hebrew calendar."
296 :type 'boolean
297 :group 'holidays)
299 ;;;###autoload
300 (defcustom all-christian-calendar-holidays nil
301 "*If nil, show only major holidays from the Christian calendar.
302 This means only those Christian holidays that appear on secular calendars.
304 If t, show all the holidays that would appear in a complete Christian
305 calendar."
306 :type 'boolean
307 :group 'holidays)
309 ;;;###autoload
310 (defcustom all-islamic-calendar-holidays nil
311 "*If nil, show only major holidays from the Islamic calendar.
312 This means only those Islamic holidays that appear on secular calendars.
314 If t, show all the holidays that would appear in a complete Islamic
315 calendar."
316 :type 'boolean
317 :group 'holidays)
319 (defcustom diary-file-name-prefix-function (function (lambda (str) str))
320 "*The function that will take a diary file name and return the desired prefix."
321 :type 'function
322 :group 'diary)
324 ;;;###autoload
325 (defcustom all-bahai-calendar-holidays nil
326 "*If nil, show only major holidays from the Baha'i calendar.
327 These are the days on which work and school must be suspended.
329 If t, show all the holidays that would appear in a complete Baha'i
330 calendar."
331 :type 'boolean
332 :group 'holidays)
334 ;;;###autoload
335 (defcustom calendar-load-hook nil
336 "*List of functions to be called after the calendar is first loaded.
337 This is the place to add key bindings to `calendar-mode-map'."
338 :type 'hook
339 :group 'calendar-hooks)
341 ;;;###autoload
342 (defcustom initial-calendar-window-hook nil
343 "*List of functions to be called when the calendar window is first opened.
344 The functions invoked are called after the calendar window is opened, but
345 once opened is never called again. Leaving the calendar with the `q' command
346 and reentering it will cause these functions to be called again."
347 :type 'hook
348 :group 'calendar-hooks)
350 ;;;###autoload
351 (defcustom today-visible-calendar-hook nil
352 "*List of functions called whenever the current date is visible.
353 This can be used, for example, to replace today's date with asterisks; a
354 function `calendar-star-date' is included for this purpose:
355 (setq today-visible-calendar-hook 'calendar-star-date)
356 It can also be used to mark the current date with `calendar-today-marker';
357 a function is also provided for this:
358 (setq today-visible-calendar-hook 'calendar-mark-today)
360 The corresponding variable `today-invisible-calendar-hook' is the list of
361 functions called when the calendar function was called when the current
362 date is not visible in the window.
364 Other than the use of the provided functions, the changing of any
365 characters in the calendar buffer by the hooks may cause the failure of the
366 functions that move by days and weeks."
367 :type 'hook
368 :group 'calendar-hooks)
370 ;;;###autoload
371 (defcustom today-invisible-calendar-hook nil
372 "*List of functions called whenever the current date is not visible.
374 The corresponding variable `today-visible-calendar-hook' is the list of
375 functions called when the calendar function was called when the current
376 date is visible in the window.
378 Other than the use of the provided functions, the changing of any
379 characters in the calendar buffer by the hooks may cause the failure of the
380 functions that move by days and weeks."
381 :type 'hook
382 :group 'calendar-hooks)
384 ;;;###autoload
385 (defcustom calendar-move-hook nil
386 "*List of functions called whenever the cursor moves in the calendar.
388 For example,
390 (add-hook 'calendar-move-hook (lambda () (view-diary-entries 1)))
392 redisplays the diary for whatever date the cursor is moved to."
393 :type 'hook
394 :group 'calendar-hooks)
396 ;;;###autoload
397 (defcustom diary-file "~/diary"
398 "*Name of the file in which one's personal diary of dates is kept.
400 The file's entries are lines beginning with any of the forms
401 specified by the variable `american-date-diary-pattern', by default:
403 MONTH/DAY
404 MONTH/DAY/YEAR
405 MONTHNAME DAY
406 MONTHNAME DAY, YEAR
407 DAYNAME
409 with the remainder of the line being the diary entry string for
410 that date. MONTH and DAY are one or two digit numbers, YEAR is a
411 number and may be written in full or abbreviated to the final two
412 digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME
413 and DAYNAME can be spelled in full (as specified by the variables
414 `calendar-month-name-array' and `calendar-day-name-array'),
415 abbreviated (as specified by `calendar-month-abbrev-array' and
416 `calendar-day-abbrev-array') with or without a period,
417 capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be
418 `*' which matches any day, month, or year, respectively. If the
419 date does not contain a year, it is generic and applies to any
420 year. A DAYNAME entry applies to the appropriate day of the week
421 in every week.
423 The European style (in which the day precedes the month) can be
424 used instead, if you execute `european-calendar' when in the
425 calendar, or set `european-calendar-style' to t in your .emacs
426 file. The European forms (see `european-date-diary-pattern') are
428 DAY/MONTH
429 DAY/MONTH/YEAR
430 DAY MONTHNAME
431 DAY MONTHNAME YEAR
432 DAYNAME
434 To revert to the default American style from the European style, execute
435 `american-calendar' in the calendar.
437 A diary entry can be preceded by the character
438 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
439 nonmarking--that is, it will not be marked on dates in the calendar
440 window but will appear in a diary window.
442 Multiline diary entries are made by indenting lines after the first with
443 either a TAB or one or more spaces.
445 Lines not in one the above formats are ignored. Here are some sample diary
446 entries (in the default American style):
448 12/22/1988 Twentieth wedding anniversary!!
449 &1/1. Happy New Year!
450 10/22 Ruth's birthday.
451 21: Payday
452 Tuesday--weekly meeting with grad students at 10am
453 Supowit, Shen, Bitner, and Kapoor to attend.
454 1/13/89 Friday the thirteenth!!
455 &thu 4pm squash game with Lloyd.
456 mar 16 Dad's birthday
457 April 15, 1989 Income tax due.
458 &* 15 time cards due.
460 If the first line of a diary entry consists only of the date or day name with
461 no trailing blanks or punctuation, then that line is not displayed in the
462 diary window; only the continuation lines is shown. For example, the
463 single diary entry
465 02/11/1989
466 Bill Blattner visits Princeton today
467 2pm Cognitive Studies Committee meeting
468 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
469 4:00pm Jamie Tappenden
470 7:30pm Dinner at George and Ed's for Alan Ryan
471 7:30-10:00pm dance at Stewart Country Day School
473 will appear in the diary window without the date line at the beginning. This
474 facility allows the diary window to look neater, but can cause confusion if
475 used with more than one day's entries displayed.
477 Diary entries can be based on Lisp sexps. For example, the diary entry
479 %%(diary-block 11 1 1990 11 10 1990) Vacation
481 causes the diary entry \"Vacation\" to appear from November 1 through
482 November 10, 1990. Other functions available are `diary-float',
483 `diary-anniversary', `diary-cyclic', `diary-day-of-year',
484 `diary-iso-date', `diary-french-date', `diary-hebrew-date',
485 `diary-islamic-date', `diary-bahai-date', `diary-mayan-date',
486 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
487 `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset',
488 `diary-phases-of-moon', `diary-parasha', `diary-omer',
489 `diary-rosh-hodesh', and `diary-sabbath-candles'. See the
490 documentation for the function `list-sexp-diary-entries' for more
491 details.
493 Diary entries based on the Hebrew, the Islamic and/or the Baha'i
494 calendar are also possible, but because these are somewhat slow, they
495 are ignored unless you set the `nongregorian-diary-listing-hook' and
496 the `nongregorian-diary-marking-hook' appropriately. See the
497 documentation for these functions for details.
499 Diary files can contain directives to include the contents of other files; for
500 details, see the documentation for the variable `list-diary-entries-hook'."
501 :type 'file
502 :group 'diary)
504 ;;;###autoload
505 (defcustom diary-nonmarking-symbol "&"
506 "*Symbol indicating that a diary entry is not to be marked in the calendar."
507 :type 'string
508 :group 'diary)
510 ;;;###autoload
511 (defcustom hebrew-diary-entry-symbol "H"
512 "*Symbol indicating a diary entry according to the Hebrew calendar."
513 :type 'string
514 :group 'diary)
516 ;;;###autoload
517 (defcustom islamic-diary-entry-symbol "I"
518 "*Symbol indicating a diary entry according to the Islamic calendar."
519 :type 'string
520 :group 'diary)
522 ;;;###autoload
523 (defcustom bahai-diary-entry-symbol "B"
524 "*Symbol indicating a diary entry according to the Baha'i calendar."
525 :type 'string
526 :group 'diary)
528 ;;;###autoload
529 (defcustom diary-include-string "#include"
530 "*The string indicating inclusion of another file of diary entries.
531 See the documentation for the function `include-other-diary-files'."
532 :type 'string
533 :group 'diary)
535 (defcustom diary-glob-file-regexp-prefix "^\\#"
536 "*The regular expression that gets pre-pended to each of the attribute-regexp's for file-wide specifiers."
537 :type 'regexp
538 :group 'diary)
540 (defcustom diary-face-attrs
541 '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string)
542 (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string)
543 (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol)
544 (" *\\[height:\\([-0-9a-z]+\\)\\]$" 1 :height int)
545 (" *\\[weight:\\([-a-z]+\\)\\]$" 1 :weight symbol)
546 (" *\\[slant:\\([-a-z]+\\)\\]$" 1 :slant symbol)
547 (" *\\[underline:\\([-a-z]+\\)\\]$" 1 :underline stringtnil)
548 (" *\\[overline:\\([-a-z]+\\)\\]$" 1 :overline stringtnil)
549 (" *\\[strike-through:\\([-a-z]+\\)\\]$" 1 :strike-through stringtnil)
550 (" *\\[inverse-video:\\([-a-z]+\\)\\]$" 1 :inverse-video tnil)
551 (" *\\[face:\\([-0-9a-z]+\\)\\]$" 1 :face string)
552 (" *\\[font:\\([-a-z0-9]+\\)\\]$" 1 :font string)
553 ;; Unsupported.
554 ;;; (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box)
555 ;;; (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple)
557 "*A list of (regexp regnum attr attrtype) lists where the
558 regexp says how to find the tag, the regnum says which
559 parenthetical sub-regexp this regexp looks for, and the attr says
560 which attribute of the face (or that this _is_ a face) is being
561 modified."
562 :type 'sexp
563 :group 'diary)
565 (defcustom diary-file-name-prefix nil
566 "If non-nil each diary entry is prefixed with the name of the file where it is defined."
567 :type 'boolean
568 :group 'diary)
570 ;;;###autoload
571 (defcustom sexp-diary-entry-symbol "%%"
572 "*The string used to indicate a sexp diary entry in `diary-file'.
573 See the documentation for the function `list-sexp-diary-entries'."
574 :type 'string
575 :group 'diary)
577 ;;;###autoload
578 (defcustom abbreviated-calendar-year t
579 "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
580 For the Gregorian calendar; similarly for the Hebrew, Islamic and
581 Baha'i calendars. If this variable is nil, years must be written in
582 full."
583 :type 'boolean
584 :group 'diary)
586 ;;;###autoload
587 (defcustom european-calendar-style nil
588 "*Use the European style of dates in the diary and in any displays.
589 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
590 1990. The default European date styles (see `european-date-diary-pattern')
593 DAY/MONTH
594 DAY/MONTH/YEAR
595 DAY MONTHNAME
596 DAY MONTHNAME YEAR
597 DAYNAME
599 Names can be capitalized or not, written in full (as specified by the
600 variable `calendar-day-name-array'), or abbreviated (as specified by
601 `calendar-day-abbrev-array') with or without a period. To take effect,
602 this variable should be set before the calendar package and its associates
603 are loaded. Otherwise, use one of the functions `european-calendar' or
604 `american-calendar' to force the appropriate update."
605 :type 'boolean
606 :group 'diary)
608 ;;;###autoload
609 (defcustom american-date-diary-pattern
610 '((month "/" day "[^/0-9]")
611 (month "/" day "/" year "[^0-9]")
612 (monthname " *" day "[^,0-9]")
613 (monthname " *" day ", *" year "[^0-9]")
614 (dayname "\\W"))
615 "*List of pseudo-patterns describing the American patterns of date used.
616 See the documentation of `diary-date-forms' for an explanation."
617 :type '(repeat (choice (cons :tag "Backup"
618 :value (backup . nil)
619 (const backup)
620 (repeat (list :inline t :format "%v"
621 (symbol :tag "Keyword")
622 (choice symbol regexp))))
623 (repeat (list :inline t :format "%v"
624 (symbol :tag "Keyword")
625 (choice symbol regexp)))))
626 :group 'diary)
628 ;;;###autoload
629 (defcustom european-date-diary-pattern
630 '((day "/" month "[^/0-9]")
631 (day "/" month "/" year "[^0-9]")
632 (backup day " *" monthname "\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
633 (day " *" monthname " *" year "[^0-9]")
634 (dayname "\\W"))
635 "*List of pseudo-patterns describing the European patterns of date used.
636 See the documentation of `diary-date-forms' for an explanation."
637 :type '(repeat (choice (cons :tag "Backup"
638 :value (backup . nil)
639 (const backup)
640 (repeat (list :inline t :format "%v"
641 (symbol :tag "Keyword")
642 (choice symbol regexp))))
643 (repeat (list :inline t :format "%v"
644 (symbol :tag "Keyword")
645 (choice symbol regexp)))))
646 :group 'diary)
648 (defcustom diary-date-forms
649 (if european-calendar-style
650 european-date-diary-pattern
651 american-date-diary-pattern)
652 "*List of pseudo-patterns describing the forms of date used in the diary.
653 The patterns on the list must be MUTUALLY EXCLUSIVE and should not match
654 any portion of the diary entry itself, just the date component.
656 A pseudo-pattern is a list of regular expressions and the keywords `month',
657 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
658 match the name of the month (see `calendar-month-name-array'), capitalized
659 or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'),
660 followed by a period or not; it will also match `*'. Similarly, `dayname'
661 will match the name of the day (see `calendar-day-name-array'), capitalized or
662 not, or its user-specified abbreviation (see `calendar-day-abbrev-array'),
663 followed by a period or not. The keywords `month', `day', and `year' will
664 match those numerical values, preceded by arbitrarily many zeros; they will
665 also match `*'.
667 The matching of the diary entries with the date forms is done with the
668 standard syntax table from Fundamental mode, but with the `*' changed so
669 that it is a word constituent.
671 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
672 diary entry itself, the first element of the pattern MUST be `backup'. This
673 directive causes the date recognizer to back up to the beginning of the
674 current word of the diary entry, so in no case can the pattern match more than
675 a portion of the first word of the diary entry."
676 :type '(repeat (choice (cons :tag "Backup"
677 :value (backup . nil)
678 (const backup)
679 (repeat (list :inline t :format "%v"
680 (symbol :tag "Keyword")
681 (choice symbol regexp))))
682 (repeat (list :inline t :format "%v"
683 (symbol :tag "Keyword")
684 (choice symbol regexp)))))
685 :group 'diary)
687 ;;;###autoload
688 (defcustom european-calendar-display-form
689 '((if dayname (concat dayname ", ")) day " " monthname " " year)
690 "*Pseudo-pattern governing the way a date appears in the European style.
691 See the documentation of `calendar-date-display-form' for an explanation."
692 :type 'sexp
693 :group 'calendar)
695 ;;;###autoload
696 (defcustom american-calendar-display-form
697 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
698 "*Pseudo-pattern governing the way a date appears in the American style.
699 See the documentation of `calendar-date-display-form' for an explanation."
700 :type 'sexp
701 :group 'calendar)
703 (defcustom calendar-date-display-form
704 (if european-calendar-style
705 european-calendar-display-form
706 american-calendar-display-form)
707 "*Pseudo-pattern governing the way a date appears.
709 Used by the function `calendar-date-string', a pseudo-pattern is a list of
710 expressions that can involve the keywords `month', `day', and `year', all
711 numbers in string form, and `monthname' and `dayname', both alphabetic
712 strings. For example, the ISO standard would use the pseudo- pattern
714 '(year \"-\" month \"-\" day)
716 while a typical American form would be
718 '(month \"/\" day \"/\" (substring year -2))
722 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
724 would give the usual American style in fixed-length fields.
726 See the documentation of the function `calendar-date-string'."
727 :type 'sexp
728 :group 'calendar)
730 (defun european-calendar ()
731 "Set the interpretation and display of dates to the European style."
732 (interactive)
733 (setq european-calendar-style t)
734 (setq calendar-date-display-form european-calendar-display-form)
735 (setq diary-date-forms european-date-diary-pattern)
736 (update-calendar-mode-line))
738 (defun american-calendar ()
739 "Set the interpretation and display of dates to the American style."
740 (interactive)
741 (setq european-calendar-style nil)
742 (setq calendar-date-display-form american-calendar-display-form)
743 (setq diary-date-forms american-date-diary-pattern)
744 (update-calendar-mode-line))
746 ;;;###autoload
747 (defcustom print-diary-entries-hook 'lpr-buffer
748 "*List of functions called after a temporary diary buffer is prepared.
749 The buffer shows only the diary entries currently visible in the diary
750 buffer. The default just does the printing. Other uses might include, for
751 example, rearranging the lines into order by day and time, saving the buffer
752 instead of deleting it, or changing the function used to do the printing."
753 :type 'hook
754 :group 'diary)
756 ;;;###autoload
757 (defcustom list-diary-entries-hook nil
758 "*List of functions called after diary file is culled for relevant entries.
759 It is to be used for diary entries that are not found in the diary file.
761 A function `include-other-diary-files' is provided for use as the value of
762 this hook. This function enables you to use shared diary files together
763 with your own. The files included are specified in the diary file by lines
764 of the form
766 #include \"filename\"
768 This is recursive; that is, #include directives in files thus included are
769 obeyed. You can change the \"#include\" to some other string by changing
770 the variable `diary-include-string'. When you use `include-other-diary-files'
771 as part of the list-diary-entries-hook, you will probably also want to use the
772 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
774 For example, you could use
776 (setq list-diary-entries-hook
777 '(include-other-diary-files sort-diary-entries))
778 (setq diary-display-hook 'fancy-diary-display)
780 in your `.emacs' file to cause the fancy diary buffer to be displayed with
781 diary entries from various included files, each day's entries sorted into
782 lexicographic order."
783 :type 'hook
784 :options '(include-other-diary-files sort-diary-entries)
785 :group 'diary)
787 ;;;###autoload
788 (defcustom diary-hook nil
789 "*List of functions called after the display of the diary.
790 Can be used for appointment notification."
791 :type 'hook
792 :group 'diary)
794 ;;;###autoload
795 (defcustom diary-display-hook nil
796 "*List of functions that handle the display of the diary.
797 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
798 diary display.
800 Ordinarily, this just displays the diary buffer (with holidays indicated in
801 the mode line), if there are any relevant entries. At the time these
802 functions are called, the variable `diary-entries-list' is a list, in order
803 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
804 STRING), where string is the diary entry for the given date. This can be
805 used, for example, a different buffer for display (perhaps combined with
806 holidays), or produce hard copy output.
808 A function `fancy-diary-display' is provided as an alternative
809 choice for this hook; this function prepares a special noneditable diary
810 buffer with the relevant diary entries that has neat day-by-day arrangement
811 with headings. The fancy diary buffer will show the holidays unless the
812 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
813 diary buffer will not show days for which there are no diary entries, even
814 if that day is a holiday; if you want such days to be shown in the fancy
815 diary buffer, set the variable `diary-list-include-blanks' to t."
816 :type 'hook
817 :options '(fancy-diary-display)
818 :group 'diary)
820 ;;;###autoload
821 (defcustom nongregorian-diary-listing-hook nil
822 "*List of functions called for listing diary file and included files.
823 As the files are processed for diary entries, these functions are used
824 to cull relevant entries. You can use either or both of
825 `list-hebrew-diary-entries', `list-islamic-diary-entries' and
826 `list-bahai-diary-entries'. The documentation for these functions
827 describes the style of such diary entries."
828 :type 'hook
829 :options '(list-hebrew-diary-entries
830 list-islamic-diary-entries
831 list-bahai-diary-entries)
832 :group 'diary)
834 ;;;###autoload
835 (defcustom mark-diary-entries-hook nil
836 "*List of functions called after marking diary entries in the calendar.
838 A function `mark-included-diary-files' is also provided for use as the
839 `mark-diary-entries-hook'; it enables you to use shared diary files together
840 with your own. The files included are specified in the diary file by lines
841 of the form
842 #include \"filename\"
843 This is recursive; that is, #include directives in files thus included are
844 obeyed. You can change the \"#include\" to some other string by changing the
845 variable `diary-include-string'. When you use `mark-included-diary-files' as
846 part of the mark-diary-entries-hook, you will probably also want to use the
847 function `include-other-diary-files' as part of `list-diary-entries-hook'."
848 :type 'hook
849 :options '(mark-included-diary-files)
850 :group 'diary)
852 ;;;###autoload
853 (defcustom nongregorian-diary-marking-hook nil
854 "*List of functions called for marking diary file and included files.
855 As the files are processed for diary entries, these functions are used
856 to cull relevant entries. You can use either or both of
857 `mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
858 `mark-bahai-diary-entries'. The documentation for these functions
859 describes the style of such diary entries."
860 :type 'hook
861 :options '(mark-hebrew-diary-entries
862 mark-islamic-diary-entries
863 mark-bahai-diary-entries)
864 :group 'diary)
866 ;;;###autoload
867 (defcustom diary-list-include-blanks nil
868 "*If nil, do not include days with no diary entry in the list of diary entries.
869 Such days will then not be shown in the fancy diary buffer, even if they
870 are holidays."
871 :type 'boolean
872 :group 'diary)
874 ;;;###autoload
875 (defcustom holidays-in-diary-buffer t
876 "*Non-nil means include holidays in the diary display.
877 The holidays appear in the mode line of the diary buffer, or in the
878 fancy diary buffer next to the date. This slows down the diary functions
879 somewhat; setting it to nil makes the diary display faster."
880 :type 'boolean
881 :group 'holidays)
883 (defvar calendar-mark-ring nil)
885 ;;;###autoload
886 (put 'general-holidays 'risky-local-variable t)
887 ;;;###autoload
888 (defcustom general-holidays
889 '((holiday-fixed 1 1 "New Year's Day")
890 (holiday-float 1 1 3 "Martin Luther King Day")
891 (holiday-fixed 2 2 "Groundhog Day")
892 (holiday-fixed 2 14 "Valentine's Day")
893 (holiday-float 2 1 3 "President's Day")
894 (holiday-fixed 3 17 "St. Patrick's Day")
895 (holiday-fixed 4 1 "April Fools' Day")
896 (holiday-float 5 0 2 "Mother's Day")
897 (holiday-float 5 1 -1 "Memorial Day")
898 (holiday-fixed 6 14 "Flag Day")
899 (holiday-float 6 0 3 "Father's Day")
900 (holiday-fixed 7 4 "Independence Day")
901 (holiday-float 9 1 1 "Labor Day")
902 (holiday-float 10 1 2 "Columbus Day")
903 (holiday-fixed 10 31 "Halloween")
904 (holiday-fixed 11 11 "Veteran's Day")
905 (holiday-float 11 4 4 "Thanksgiving"))
906 "*General holidays. Default value is for the United States.
907 See the documentation for `calendar-holidays' for details."
908 :type 'sexp
909 :group 'holidays)
911 ;;;###autoload
912 (put 'oriental-holidays 'risky-local-variable t)
913 ;;;###autoload
914 (defcustom oriental-holidays
915 '((if (fboundp 'atan)
916 (holiday-chinese-new-year)))
917 "*Oriental holidays.
918 See the documentation for `calendar-holidays' for details."
919 :type 'sexp
920 :group 'holidays)
922 ;;;###autoload
923 (put 'local-holidays 'risky-local-variable t)
924 ;;;###autoload
925 (defcustom local-holidays nil
926 "*Local holidays.
927 See the documentation for `calendar-holidays' for details."
928 :type 'sexp
929 :group 'holidays)
931 ;;;###autoload
932 (put 'other-holidays 'risky-local-variable t)
933 ;;;###autoload
934 (defcustom other-holidays nil
935 "*User defined holidays.
936 See the documentation for `calendar-holidays' for details."
937 :type 'sexp
938 :group 'holidays)
940 ;;;###autoload
941 (put 'hebrew-holidays-1 'risky-local-variable t)
942 ;;;###autoload
943 (defvar hebrew-holidays-1
944 '((holiday-rosh-hashanah-etc)
945 (if all-hebrew-calendar-holidays
946 (holiday-julian
948 (let* ((m displayed-month)
949 (y displayed-year)
950 (year))
951 (increment-calendar-month m y -1)
952 (let ((year (extract-calendar-year
953 (calendar-julian-from-absolute
954 (calendar-absolute-from-gregorian
955 (list m 1 y))))))
956 (if (zerop (% (1+ year) 4))
958 21))) "\"Tal Umatar\" (evening)"))))
960 ;;;###autoload
961 (put 'hebrew-holidays-2 'risky-local-variable t)
962 ;;;###autoload
963 (defvar hebrew-holidays-2
964 '((if all-hebrew-calendar-holidays
965 (holiday-hanukkah)
966 (holiday-hebrew 9 25 "Hanukkah"))
967 (if all-hebrew-calendar-holidays
968 (holiday-hebrew
970 (let ((h-year (extract-calendar-year
971 (calendar-hebrew-from-absolute
972 (calendar-absolute-from-gregorian
973 (list displayed-month 28 displayed-year))))))
974 (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
977 11 10))
978 "Tzom Teveth"))
979 (if all-hebrew-calendar-holidays
980 (holiday-hebrew 11 15 "Tu B'Shevat"))))
982 ;;;###autoload
983 (put 'hebrew-holidays-3 'risky-local-variable t)
984 ;;;###autoload
985 (defvar hebrew-holidays-3
986 '((if all-hebrew-calendar-holidays
987 (holiday-hebrew
989 (let ((m displayed-month)
990 (y displayed-year))
991 (increment-calendar-month m y 1)
992 (let* ((h-year (extract-calendar-year
993 (calendar-hebrew-from-absolute
994 (calendar-absolute-from-gregorian
995 (list m
996 (calendar-last-day-of-month m y)
997 y)))))
998 (s-s
999 (calendar-hebrew-from-absolute
1000 (if (=
1001 (% (calendar-absolute-from-hebrew
1002 (list 7 1 h-year))
1005 (calendar-dayname-on-or-before
1006 6 (calendar-absolute-from-hebrew
1007 (list 11 17 h-year)))
1008 (calendar-dayname-on-or-before
1009 6 (calendar-absolute-from-hebrew
1010 (list 11 16 h-year))))))
1011 (day (extract-calendar-day s-s)))
1012 day))
1013 "Shabbat Shirah"))))
1015 ;;;###autoload
1016 (put 'hebrew-holidays-4 'risky-local-variable t)
1017 ;;;###autoload
1018 (defvar hebrew-holidays-4
1019 '((holiday-passover-etc)
1020 (if (and all-hebrew-calendar-holidays
1021 (let* ((m displayed-month)
1022 (y displayed-year)
1023 (year))
1024 (increment-calendar-month m y -1)
1025 (let ((year (extract-calendar-year
1026 (calendar-julian-from-absolute
1027 (calendar-absolute-from-gregorian
1028 (list m 1 y))))))
1029 (= 21 (% year 28)))))
1030 (holiday-julian 3 26 "Kiddush HaHamah"))
1031 (if all-hebrew-calendar-holidays
1032 (holiday-tisha-b-av-etc))))
1034 ;;;###autoload
1035 (put 'hebrew-holidays 'risky-local-variable t)
1036 ;;;###autoload
1037 (defcustom hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
1038 hebrew-holidays-3 hebrew-holidays-4)
1039 "*Jewish holidays.
1040 See the documentation for `calendar-holidays' for details."
1041 :type 'sexp
1042 :group 'holidays)
1044 ;;;###autoload
1045 (put 'christian-holidays 'risky-local-variable t)
1046 ;;;###autoload
1047 (defcustom christian-holidays
1048 '((if all-christian-calendar-holidays
1049 (holiday-fixed 1 6 "Epiphany"))
1050 (holiday-easter-etc 0 "Easter Sunday")
1051 (holiday-easter-etc -2 "Good Friday")
1052 (holiday-easter-etc -46 "Ash Wednesday")
1053 (if all-christian-calendar-holidays
1054 (holiday-easter-etc -63 "Septuagesima Sunday"))
1055 (if all-christian-calendar-holidays
1056 (holiday-easter-etc -56 "Sexagesima Sunday"))
1057 (if all-christian-calendar-holidays
1058 (holiday-easter-etc -49 "Shrove Sunday"))
1059 (if all-christian-calendar-holidays
1060 (holiday-easter-etc -48 "Shrove Monday"))
1061 (if all-christian-calendar-holidays
1062 (holiday-easter-etc -47 "Shrove Tuesday"))
1063 (if all-christian-calendar-holidays
1064 (holiday-easter-etc -14 "Passion Sunday"))
1065 (if all-christian-calendar-holidays
1066 (holiday-easter-etc -7 "Palm Sunday"))
1067 (if all-christian-calendar-holidays
1068 (holiday-easter-etc -3 "Maundy Thursday"))
1069 (if all-christian-calendar-holidays
1070 (holiday-easter-etc 35 "Rogation Sunday"))
1071 (if all-christian-calendar-holidays
1072 (holiday-easter-etc 39 "Ascension Day"))
1073 (if all-christian-calendar-holidays
1074 (holiday-easter-etc 49 "Pentecost (Whitsunday)"))
1075 (if all-christian-calendar-holidays
1076 (holiday-easter-etc 50 "Whitmonday"))
1077 (if all-christian-calendar-holidays
1078 (holiday-easter-etc 56 "Trinity Sunday"))
1079 (if all-christian-calendar-holidays
1080 (holiday-easter-etc 60 "Corpus Christi"))
1081 (if all-christian-calendar-holidays
1082 (holiday-greek-orthodox-easter))
1083 (if all-christian-calendar-holidays
1084 (holiday-fixed 8 15 "Assumption"))
1085 (if all-christian-calendar-holidays
1086 (holiday-advent 0 "Advent"))
1087 (holiday-fixed 12 25 "Christmas")
1088 (if all-christian-calendar-holidays
1089 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
1090 "*Christian holidays.
1091 See the documentation for `calendar-holidays' for details."
1092 :type 'sexp
1093 :group 'holidays)
1095 ;;;###autoload
1096 (put 'islamic-holidays 'risky-local-variable t)
1097 ;;;###autoload
1098 (defcustom islamic-holidays
1099 '((holiday-islamic
1101 (format "Islamic New Year %d"
1102 (let ((m displayed-month)
1103 (y displayed-year))
1104 (increment-calendar-month m y 1)
1105 (extract-calendar-year
1106 (calendar-islamic-from-absolute
1107 (calendar-absolute-from-gregorian
1108 (list
1109 m (calendar-last-day-of-month m y) y)))))))
1110 (if all-islamic-calendar-holidays
1111 (holiday-islamic 1 10 "Ashura"))
1112 (if all-islamic-calendar-holidays
1113 (holiday-islamic 3 12 "Mulad-al-Nabi"))
1114 (if all-islamic-calendar-holidays
1115 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
1116 (if all-islamic-calendar-holidays
1117 (holiday-islamic 8 15 "Shab-e-Bara't"))
1118 (holiday-islamic 9 1 "Ramadan Begins")
1119 (if all-islamic-calendar-holidays
1120 (holiday-islamic 9 27 "Shab-e Qadr"))
1121 (if all-islamic-calendar-holidays
1122 (holiday-islamic 10 1 "Id-al-Fitr"))
1123 (if all-islamic-calendar-holidays
1124 (holiday-islamic 12 10 "Id-al-Adha")))
1125 "*Islamic holidays.
1126 See the documentation for `calendar-holidays' for details."
1127 :type 'sexp
1128 :group 'holidays)
1130 ;;;###autoload
1131 (put 'bahai-holidays 'risky-local-variable t)
1132 ;;;###autoload
1133 (defcustom bahai-holidays
1134 '((holiday-fixed
1135 3 21
1136 (format "Baha'i New Year (Naw-Ruz) %d" (- displayed-year (1- 1844))))
1137 (holiday-fixed 4 21 "First Day of Ridvan")
1138 (if all-bahai-calendar-holidays
1139 (holiday-fixed 4 22 "Second Day of Ridvan"))
1140 (if all-bahai-calendar-holidays
1141 (holiday-fixed 4 23 "Third Day of Ridvan"))
1142 (if all-bahai-calendar-holidays
1143 (holiday-fixed 4 24 "Fourth Day of Ridvan"))
1144 (if all-bahai-calendar-holidays
1145 (holiday-fixed 4 25 "Fifth Day of Ridvan"))
1146 (if all-bahai-calendar-holidays
1147 (holiday-fixed 4 26 "Sixth Day of Ridvan"))
1148 (if all-bahai-calendar-holidays
1149 (holiday-fixed 4 27 "Seventh Day of Ridvan"))
1150 (if all-bahai-calendar-holidays
1151 (holiday-fixed 4 28 "Eighth Day of Ridvan"))
1152 (holiday-fixed 4 29 "Ninth Day of Ridvan")
1153 (if all-bahai-calendar-holidays
1154 (holiday-fixed 4 30 "Tenth Day of Ridvan"))
1155 (if all-bahai-calendar-holidays
1156 (holiday-fixed 5 1 "Eleventh Day of Ridvan"))
1157 (holiday-fixed 5 2 "Twelfth Day of Ridvan")
1158 (holiday-fixed 5 23 "Declaration of the Bab")
1159 (holiday-fixed 5 29 "Ascension of Baha'u'llah")
1160 (holiday-fixed 7 9 "Martyrdom of the Bab")
1161 (holiday-fixed 10 20 "Birth of the Bab")
1162 (holiday-fixed 11 12 "Birth of Baha'u'llah")
1163 (if all-bahai-calendar-holidays
1164 (holiday-fixed 11 26 "Day of the Covenant"))
1165 (if all-bahai-calendar-holidays
1166 (holiday-fixed 11 28 "Ascension of `Abdu'l-Baha")))
1167 "*Baha'i holidays.
1168 See the documentation for `calendar-holidays' for details."
1169 :type 'sexp
1170 :group 'holidays)
1172 ;;;###autoload
1173 (put 'solar-holidays 'risky-local-variable t)
1174 ;;;###autoload
1175 (defcustom solar-holidays
1176 '((if (fboundp 'atan)
1177 (solar-equinoxes-solstices))
1178 (if (progn
1179 (require 'cal-dst)
1181 (funcall
1182 'holiday-sexp
1183 calendar-daylight-savings-starts
1184 '(format "Daylight Savings Time Begins %s"
1185 (if (fboundp 'atan)
1186 (solar-time-string
1187 (/ calendar-daylight-savings-starts-time (float 60))
1188 calendar-standard-time-zone-name)
1189 ""))))
1190 (funcall
1191 'holiday-sexp
1192 calendar-daylight-savings-ends
1193 '(format "Daylight Savings Time Ends %s"
1194 (if (fboundp 'atan)
1195 (solar-time-string
1196 (/ calendar-daylight-savings-ends-time (float 60))
1197 calendar-daylight-time-zone-name)
1198 ""))))
1199 "*Sun-related holidays.
1200 See the documentation for `calendar-holidays' for details."
1201 :type 'sexp
1202 :group 'holidays)
1204 ;;;###autoload
1205 (put 'calendar-holidays 'risky-local-variable t)
1206 (defcustom calendar-holidays
1207 (append general-holidays local-holidays other-holidays
1208 christian-holidays hebrew-holidays islamic-holidays
1209 bahai-holidays oriental-holidays solar-holidays)
1210 "*List of notable days for the command \\[holidays].
1212 Additional holidays are easy to add to the list, just put them in the
1213 list `other-holidays' in your .emacs file. Similarly, by setting any
1214 of `general-holidays', `local-holidays' `christian-holidays',
1215 `hebrew-holidays', `islamic-holidays', `bahai-holidays',
1216 `oriental-holidays', or `solar-holidays' to nil in your .emacs file,
1217 you can eliminate unwanted categories of holidays. The intention is
1218 that (in the US) `local-holidays' be set in site-init.el and
1219 `other-holidays' be set by the user.
1221 Entries on the list are expressions that return (possibly empty) lists of
1222 items of the form ((month day year) string) of a holiday in the in the
1223 three-month period centered around `displayed-month' of `displayed-year'.
1224 Several basic functions are provided for this purpose:
1226 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1227 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1228 MONTH on the Gregorian calendar (0 for Sunday,
1229 etc.); K<0 means count back from the end of the
1230 month. An optional parameter DAY means the Kth
1231 DAYNAME after/before MONTH DAY.
1232 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1233 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1234 (holiday-bahai MONTH DAY STRING) a fixed date on the Baha'i calendar
1235 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1236 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
1237 in the variable `year'; if it evaluates to
1238 a visible date, that's the holiday; if it
1239 evaluates to nil, there's no holiday. STRING
1240 is an expression in the variable `date'.
1242 For example, to add Bastille Day, celebrated in France on July 14, add
1244 (holiday-fixed 7 14 \"Bastille Day\")
1246 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1247 Islands on the fourth Monday in August, add
1249 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
1251 to the list (the last Monday would be specified with `-1' instead of `4').
1252 To add the last day of Hanukkah to the list, use
1254 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
1256 since the Hebrew months are numbered with 1 starting from Nisan, while to
1257 add the Islamic feast celebrating Mohammed's birthday use
1259 (holiday-islamic 3 12 \"Mohammed's Birthday\")
1261 since the Islamic months are numbered from 1 starting with Muharram. To
1262 add an entry for the Baha'i festival of Ridvan, use
1264 (holiday-bahai 2 13 \"Festival of Ridvan\")
1266 since the Baha'i months are numbered from 1 starting with Baha. To
1267 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1269 (holiday-julian 4 2 \"Jefferson's Birthday\")
1271 To include a holiday conditionally, use the sexp form or a conditional. For
1272 example, to include American presidential elections, which occur on the first
1273 Tuesday after the first Monday in November of years divisible by 4, add
1275 (holiday-sexp
1276 '(if (zerop (% year 4))
1277 (calendar-gregorian-from-absolute
1278 (1+ (calendar-dayname-on-or-before
1279 1 (+ 6 (calendar-absolute-from-gregorian
1280 (list 11 1 year)))))))
1281 \"US Presidential Election\")
1285 (if (zerop (% displayed-year 4))
1286 (holiday-fixed 11
1287 (extract-calendar-day
1288 (calendar-gregorian-from-absolute
1289 (1+ (calendar-dayname-on-or-before
1290 1 (+ 6 (calendar-absolute-from-gregorian
1291 (list 11 1 displayed-year)))))))
1292 \"US Presidential Election\"))
1294 to the list. To include the phases of the moon, add
1296 (lunar-phases)
1298 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1299 you've written to return a (possibly empty) list of the relevant VISIBLE dates
1300 with descriptive strings such as
1302 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
1303 :type 'sexp
1304 :group 'holidays)
1306 (defconst holiday-buffer "*Holidays*"
1307 "Name of the buffer used for the displaying the holidays.")
1309 (defconst fancy-diary-buffer "*Fancy Diary Entries*"
1310 "Name of the buffer used for the optional fancy display of the diary.")
1312 (defconst other-calendars-buffer "*Other Calendars*"
1313 "Name of the buffer used for the display of date on other calendars.")
1315 (defconst lunar-phases-buffer "*Phases of Moon*"
1316 "Name of the buffer used for the lunar phases.")
1318 (defmacro increment-calendar-month (mon yr n)
1319 "Increment the variables MON and YR by N months.
1320 Forward if N is positive or backward if N is negative.
1321 A negative YR is interpreted as BC; -1 being 1 BC, and so on."
1322 `(let (macro-y)
1323 (if (< ,yr 0) (setq ,yr (1+ ,yr))) ; -1 BC -> 0 AD, etc
1324 (setq macro-y (+ (* ,yr 12) ,mon -1 ,n)
1325 ,mon (1+ (mod macro-y 12))
1326 ,yr (/ macro-y 12))
1327 (and (< macro-y 0) (> ,mon 1) (setq ,yr (1- ,yr)))
1328 (if (< ,yr 1) (setq ,yr (1- ,yr))))) ; 0 AD -> -1 BC, etc
1330 (defmacro calendar-for-loop (var from init to final do &rest body)
1331 "Execute a for loop."
1332 `(let ((,var (1- ,init)))
1333 (while (>= ,final (setq ,var (1+ ,var)))
1334 ,@body)))
1336 (defmacro calendar-sum (index initial condition expression)
1337 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
1338 `(let ((,index ,initial)
1339 (sum 0))
1340 (while ,condition
1341 (setq sum (+ sum ,expression))
1342 (setq ,index (1+ ,index)))
1343 sum))
1345 ;; The following are in-line for speed; they can be called thousands of times
1346 ;; when looking up holidays or processing the diary. Here, for example, are
1347 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1348 ;; fancy diary display, for a moderately complex diary file, with functions
1349 ;; used instead of macros. There were a total of 10000 such calls:
1351 ;; 1934 extract-calendar-month
1352 ;; 1852 extract-calendar-year
1353 ;; 1819 extract-calendar-day
1354 ;; 845 calendar-leap-year-p
1355 ;; 837 calendar-day-number
1356 ;; 775 calendar-absolute-from-gregorian
1357 ;; 346 calendar-last-day-of-month
1358 ;; 286 hebrew-calendar-last-day-of-month
1359 ;; 188 hebrew-calendar-leap-year-p
1360 ;; 180 hebrew-calendar-elapsed-days
1361 ;; 163 hebrew-calendar-last-month-of-year
1362 ;; 66 calendar-date-compare
1363 ;; 65 hebrew-calendar-days-in-year
1364 ;; 60 calendar-absolute-from-julian
1365 ;; 50 calendar-absolute-from-hebrew
1366 ;; 43 calendar-date-equal
1367 ;; 38 calendar-gregorian-from-absolute
1368 ;; .
1369 ;; .
1370 ;; .
1372 ;; The use of these seven macros eliminates the overhead of 92% of the function
1373 ;; calls; it's faster this way.
1375 (defsubst extract-calendar-month (date)
1376 "Extract the month part of DATE which has the form (month day year)."
1377 (car date))
1379 (defsubst extract-calendar-day (date)
1380 "Extract the day part of DATE which has the form (month day year)."
1381 (car (cdr date)))
1383 (defsubst extract-calendar-year (date)
1384 "Extract the year part of DATE which has the form (month day year)."
1385 (car (cdr (cdr date))))
1387 (defsubst calendar-leap-year-p (year)
1388 "Return t if YEAR is a Gregorian leap year.
1389 A negative year is interpreted as BC; -1 being 1 BC, and so on."
1390 ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc.
1391 (if (< year 0) (setq year (1- (abs year))))
1392 (and (zerop (% year 4))
1393 (or (not (zerop (% year 100)))
1394 (zerop (% year 400)))))
1396 ;; The foregoing is a bit faster, but not as clear as the following:
1398 ;;(defsubst calendar-leap-year-p (year)
1399 ;; "Returns t if YEAR is a Gregorian leap year."
1400 ;; (or
1401 ;; (and (= (% year 4) 0)
1402 ;; (/= (% year 100) 0))
1403 ;; (= (% year 400) 0)))
1405 (defsubst calendar-last-day-of-month (month year)
1406 "The last day in MONTH during YEAR."
1407 (if (and (= month 2) (calendar-leap-year-p year))
1409 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1411 ;; An explanation of the calculation can be found in PascAlgorithms by
1412 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1414 (defsubst calendar-day-number (date)
1415 "Return the day number within the year of the date DATE.
1416 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1417 while (calendar-day-number '(12 31 1980)) returns 366."
1418 (let* ((month (extract-calendar-month date))
1419 (day (extract-calendar-day date))
1420 (year (extract-calendar-year date))
1421 (day-of-year (+ day (* 31 (1- month)))))
1422 (if (> month 2)
1423 (progn
1424 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1425 (if (calendar-leap-year-p year)
1426 (setq day-of-year (1+ day-of-year)))))
1427 day-of-year))
1429 (defsubst calendar-absolute-from-gregorian (date)
1430 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1431 The Gregorian date Sunday, December 31, 1 BC is imaginary.
1432 DATE is a list of the form (month day year). A negative year is
1433 interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC
1434 return negative results."
1435 (let ((year (extract-calendar-year date))
1436 offset-years)
1437 (cond ((= year 0)
1438 (error "There was no year zero"))
1439 ((> year 0)
1440 (setq offset-years (1- year))
1441 (+ (calendar-day-number date) ; Days this year
1442 (* 365 offset-years) ; + Days in prior years
1443 (/ offset-years 4) ; + Julian leap years
1444 (- (/ offset-years 100)) ; - century years
1445 (/ offset-years 400))) ; + Gregorian leap years
1447 ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc).
1448 (setq offset-years (abs (1+ year)))
1449 (- (calendar-day-number date)
1450 (* 365 offset-years)
1451 (/ offset-years 4)
1452 (- (/ offset-years 100))
1453 (/ offset-years 400)
1454 (calendar-day-number '(12 31 -1))))))) ; days in year 1 BC
1456 (autoload 'calendar-goto-today "cal-move"
1457 "Reposition the calendar window so the current date is visible."
1460 (autoload 'calendar-forward-month "cal-move"
1461 "Move the cursor forward ARG months."
1464 (autoload 'calendar-forward-year "cal-move"
1465 "Move the cursor forward by ARG years."
1468 (autoload 'calendar-backward-month "cal-move"
1469 "Move the cursor backward by ARG months."
1472 (autoload 'calendar-backward-year "cal-move"
1473 "Move the cursor backward ARG years."
1476 (autoload 'scroll-calendar-left "cal-move"
1477 "Scroll the displayed calendar left by ARG months."
1480 (autoload 'scroll-calendar-right "cal-move"
1481 "Scroll the displayed calendar window right by ARG months."
1484 (autoload 'scroll-calendar-left-three-months "cal-move"
1485 "Scroll the displayed calendar window left by 3*ARG months."
1488 (autoload 'scroll-calendar-right-three-months "cal-move"
1489 "Scroll the displayed calendar window right by 3*ARG months."
1492 (autoload 'calendar-cursor-to-nearest-date "cal-move"
1493 "Move the cursor to the closest date."
1496 (autoload 'calendar-forward-day "cal-move"
1497 "Move the cursor forward ARG days."
1500 (autoload 'calendar-backward-day "cal-move"
1501 "Move the cursor back ARG days."
1504 (autoload 'calendar-forward-week "cal-move"
1505 "Move the cursor forward ARG weeks."
1508 (autoload 'calendar-backward-week "cal-move"
1509 "Move the cursor back ARG weeks."
1512 (autoload 'calendar-beginning-of-week "cal-move"
1513 "Move the cursor back ARG calendar-week-start-day's."
1516 (autoload 'calendar-end-of-week "cal-move"
1517 "Move the cursor forward ARG calendar-week-start-day+6's."
1520 (autoload 'calendar-beginning-of-month "cal-move"
1521 "Move the cursor backward ARG month beginnings."
1524 (autoload 'calendar-end-of-month "cal-move"
1525 "Move the cursor forward ARG month ends."
1528 (autoload 'calendar-beginning-of-year "cal-move"
1529 "Move the cursor backward ARG year beginnings."
1532 (autoload 'calendar-end-of-year "cal-move"
1533 "Move the cursor forward ARG year beginnings."
1536 (autoload 'calendar-cursor-to-visible-date "cal-move"
1537 "Move the cursor to DATE that is on the screen."
1540 (autoload 'calendar-goto-date "cal-move"
1541 "Move cursor to DATE."
1544 (autoload 'calendar-goto-day-of-year "cal-move"
1545 "Move cursor to day of year."
1548 (autoload 'calendar-only-one-frame-setup "cal-x"
1549 "Start calendar and display it in a dedicated frame.")
1551 (autoload 'calendar-one-frame-setup "cal-x"
1552 "Start calendar and display it in a dedicated frame together with the diary.")
1554 (autoload 'calendar-two-frame-setup "cal-x"
1555 "Start calendar and diary in separate, dedicated frames.")
1557 ;;;###autoload
1558 (defcustom calendar-setup nil
1559 "The frame setup of the calendar.
1560 The choices are: `one-frame' (calendar and diary together in one separate,
1561 dedicated frame); `two-frames' (calendar and diary in separate, dedicated
1562 frames); `calendar-only' (calendar in a separate, dedicated frame); with
1563 any other value the current frame is used. Using any of the first
1564 three options overrides the value of `view-diary-entries-initially'."
1565 :type '(choice
1566 (const :tag "calendar and diary in separate frame" one-frame)
1567 (const :tag "calendar and diary each in own frame" two-frames)
1568 (const :tag "calendar in separate frame" calendar-only)
1569 (const :tag "use current frame" nil))
1570 :group 'calendar)
1572 (defcustom calendar-minimum-window-height 8
1573 "Minimum height `generate-calendar-window' should use for calendar window."
1574 :type 'integer
1575 :version "22.1"
1576 :group 'calendar)
1578 ;;;###autoload
1579 (defun calendar (&optional arg)
1580 "Choose between the one frame, two frame, or basic calendar displays.
1581 If called with an optional prefix argument, prompts for month and year.
1583 The original function `calendar' has been renamed `calendar-basic-setup'.
1584 See the documentation of that function for more information."
1585 (interactive "P")
1586 (cond ((equal calendar-setup 'one-frame) (calendar-one-frame-setup arg))
1587 ((equal calendar-setup 'two-frames) (calendar-two-frame-setup arg))
1588 ((equal calendar-setup 'calendar-only)
1589 (calendar-only-one-frame-setup arg))
1590 (t (calendar-basic-setup arg))))
1592 (defun calendar-basic-setup (&optional arg)
1593 "Display a three-month calendar in another window.
1594 The three months appear side by side, with the current month in the middle
1595 surrounded by the previous and next months. The cursor is put on today's date.
1597 If called with an optional prefix argument, prompts for month and year.
1599 This function is suitable for execution in a .emacs file; appropriate setting
1600 of the variable `view-diary-entries-initially' will cause the diary entries for
1601 the current date to be displayed in another window. The value of the variable
1602 `number-of-diary-entries' controls the number of days of diary entries
1603 displayed upon initial display of the calendar.
1605 Once in the calendar window, future or past months can be moved into view.
1606 Arbitrary months can be displayed, or the calendar can be scrolled forward
1607 or backward.
1609 The cursor can be moved forward or backward by one day, one week, one month,
1610 or one year. All of these commands take prefix arguments which, when negative,
1611 cause movement in the opposite direction. For convenience, the digit keys
1612 and the minus sign are automatically prefixes. The window is replotted as
1613 necessary to display the desired date.
1615 Diary entries can be marked on the calendar or displayed in another window.
1617 Use \\[describe-mode] for details of the key bindings in the calendar window.
1619 The Gregorian calendar is assumed.
1621 After loading the calendar, the hooks given by the variable
1622 `calendar-load-hook' are run. This is the place to add key bindings to the
1623 calendar-mode-map.
1625 After preparing the calendar window initially, the hooks given by the variable
1626 `initial-calendar-window-hook' are run.
1628 The hooks given by the variable `today-visible-calendar-hook' are run
1629 every time the calendar window gets scrolled, if the current date is visible
1630 in the window. If it is not visible, the hooks given by the variable
1631 `today-invisible-calendar-hook' are run. Thus, for example, setting
1632 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1633 to be replaced by asterisks to highlight it whenever it is in the window."
1634 (interactive "P")
1635 (set-buffer (get-buffer-create calendar-buffer))
1636 (calendar-mode)
1637 (let* ((pop-up-windows t)
1638 (split-height-threshold 1000)
1639 (date (if arg
1640 (calendar-read-date t)
1641 (calendar-current-date)))
1642 (month (extract-calendar-month date))
1643 (year (extract-calendar-year date)))
1644 (pop-to-buffer calendar-buffer)
1645 (increment-calendar-month month year (- calendar-offset))
1646 (generate-calendar-window month year)
1647 (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
1648 (view-diary-entries
1649 (if (vectorp number-of-diary-entries)
1650 (aref number-of-diary-entries (calendar-day-of-week date))
1651 number-of-diary-entries))))
1652 (let* ((diary-buffer (get-file-buffer diary-file))
1653 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1654 (split-height-threshold (if diary-window 2 1000)))
1655 (if view-calendar-holidays-initially
1656 (list-calendar-holidays)))
1657 (run-hooks 'initial-calendar-window-hook))
1659 (autoload 'view-diary-entries "diary-lib"
1660 "Prepare and display a buffer with diary entries.
1661 Searches your diary file for entries that match ARG days starting with
1662 the date indicated by the cursor position in the displayed three-month
1663 calendar."
1666 (autoload 'view-other-diary-entries "diary-lib"
1667 "Prepare and display buffer of diary entries from an alternative diary file.
1668 Searches for entries that match ARG days, starting with the date indicated
1669 by the cursor position in the displayed three-month calendar.
1670 D-FILE specifies the file to use as the diary file."
1673 (autoload 'calendar-sunrise-sunset "solar"
1674 "Local time of sunrise and sunset for date under cursor."
1677 (autoload 'calendar-phases-of-moon "lunar"
1678 "Create a buffer of the phases of the moon for the current calendar window."
1681 (autoload 'calendar-print-french-date "cal-french"
1682 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1685 (autoload 'calendar-goto-french-date "cal-french"
1686 "Move cursor to French Revolutionary date."
1689 (autoload 'calendar-french-date-string "cal-french"
1690 "String of French Revolutionary date of Gregorian date."
1693 (autoload 'calendar-mayan-date-string "cal-mayan"
1694 "String of Mayan date of Gregorian date."
1697 (autoload 'calendar-print-mayan-date "cal-mayan"
1698 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1701 (autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
1702 "Move cursor to Mayan long count date."
1705 (autoload 'calendar-next-haab-date "cal-mayan"
1706 "Move cursor to next instance of Mayan Haab date."
1709 (autoload 'calendar-previous-haab-date "cal-mayan"
1710 "Move cursor to previous instance of Mayan Haab date."
1713 (autoload 'calendar-next-tzolkin-date "cal-mayan"
1714 "Move cursor to next instance of Mayan Tzolkin date."
1717 (autoload 'calendar-previous-tzolkin-date "cal-mayan"
1718 "Move cursor to previous instance of Mayan Tzolkin date."
1721 (autoload 'calendar-next-calendar-round-date "cal-mayan"
1722 "Move cursor to next instance of Mayan Haab/Tzolkin combination."
1725 (autoload 'calendar-previous-calendar-round-date "cal-mayan"
1726 "Move cursor to previous instance of Mayan Haab/Tzolkin combination."
1729 (autoload 'calendar-goto-chinese-date "cal-china"
1730 "Move cursor to Chinese date."
1733 (autoload 'calendar-print-chinese-date "cal-china"
1734 "Show the Chinese date equivalents of date."
1737 (autoload 'calendar-chinese-date-string "cal-china"
1738 "String of Chinese date of Gregorian date."
1741 (autoload 'calendar-absolute-from-astro "cal-julian"
1742 "Absolute date of astronomical (Julian) day number D."
1745 (autoload 'calendar-astro-from-absolute "cal-julian"
1746 "Astronomical (Julian) day number of absolute date D.")
1748 (autoload 'calendar-astro-date-string "cal-julian"
1749 "String of astronomical (Julian) day number of Gregorian date."
1752 (autoload 'calendar-goto-astro-day-number "cal-julian"
1753 "Move cursor to astronomical (Julian) day number."
1756 (autoload 'calendar-print-astro-day-number "cal-julian"
1757 "Show the astro date equivalents of date."
1760 (autoload 'calendar-julian-from-absolute "cal-julian"
1761 "Compute the Julian (month day year) corresponding to the absolute DATE.
1762 The absolute date is the number of days elapsed since the (imaginary)
1763 Gregorian date Sunday, December 31, 1 BC.")
1765 (autoload 'calendar-goto-julian-date "cal-julian"
1766 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1769 (autoload 'calendar-print-julian-date "cal-julian"
1770 "Show the Julian calendar equivalent of the date under the cursor."
1773 (autoload 'calendar-julian-date-string "cal-julian"
1774 "String of Julian date of Gregorian DATE.
1775 Defaults to today's date if DATE is not given.
1776 Driven by the variable `calendar-date-display-form'.")
1778 (autoload 'calendar-goto-iso-date "cal-iso"
1779 "Move cursor to ISO date."
1782 (autoload 'calendar-goto-iso-week "cal-iso"
1783 "Move cursor to start of ISO week."
1786 (autoload 'calendar-print-iso-date "cal-iso"
1787 "Show the ISO date equivalents of date."
1790 (autoload 'calendar-iso-date-string "cal-iso"
1791 "String of ISO date of Gregorian date."
1794 (autoload 'calendar-goto-islamic-date "cal-islam"
1795 "Move cursor to Islamic date."
1798 (autoload 'calendar-print-islamic-date "cal-islam"
1799 "Show the Islamic date equivalents of date."
1802 (autoload 'calendar-islamic-date-string "cal-islam"
1803 "String of Islamic date of Gregorian date."
1806 (autoload 'calendar-print-bahai-date "cal-bahai"
1807 "Show the Baha'i date equivalents of date."
1810 (autoload 'calendar-bahai-date-string "cal-bahai"
1811 "String of Baha'i date of Gregorian date."
1814 (autoload 'calendar-goto-hebrew-date "cal-hebrew"
1815 "Move cursor to Hebrew date date."
1818 (autoload 'calendar-print-hebrew-date "cal-hebrew"
1819 "Show the Hebrew date equivalents of date."
1822 (autoload 'calendar-hebrew-date-string "cal-hebrew"
1823 "String of Hebrew date of Gregorian date."
1826 (autoload 'calendar-goto-coptic-date "cal-coptic"
1827 "Move cursor to Coptic date date."
1830 (autoload 'calendar-print-coptic-date "cal-coptic"
1831 "Show the Coptic date equivalents of date."
1834 (autoload 'calendar-coptic-date-string "cal-coptic"
1835 "String of Coptic date of Gregorian date."
1838 (autoload 'calendar-goto-ethiopic-date "cal-coptic"
1839 "Move cursor to Ethiopic date date."
1842 (autoload 'calendar-print-ethiopic-date "cal-coptic"
1843 "Show the Ethiopic date equivalents of date."
1846 (autoload 'calendar-ethiopic-date-string "cal-coptic"
1847 "String of Ethiopic date of Gregorian date."
1850 (autoload 'calendar-goto-persian-date "cal-persia"
1851 "Move cursor to Persian date date."
1854 (autoload 'calendar-print-persian-date "cal-persia"
1855 "Show the Persian date equivalents of date."
1858 (autoload 'calendar-persian-date-string "cal-persia"
1859 "String of Persian date of Gregorian date."
1862 (autoload 'show-all-diary-entries "diary-lib"
1863 "Show all of the diary entries in the diary file.
1864 This function gets rid of the selective display of the diary file so that
1865 all entries, not just some, are visible. If there is no diary buffer, one
1866 is created."
1869 (autoload 'mark-diary-entries "diary-lib"
1870 "Mark days in the calendar window that have diary entries.
1871 Each entry in diary file visible in the calendar window is marked."
1874 (autoload 'make-diary-entry "diary-lib"
1875 "Insert a diary entry STRING which may be NONMARKING in FILE."
1878 (autoload 'insert-diary-entry "diary-lib"
1879 "Insert a diary entry for the date indicated by point."
1882 (autoload 'insert-weekly-diary-entry "diary-lib"
1883 "Insert a weekly diary entry for the day of the week indicated by point."
1887 (autoload 'insert-monthly-diary-entry "diary-lib"
1888 "Insert a monthly diary entry for the day of the month indicated by point."
1891 (autoload 'insert-yearly-diary-entry "diary-lib"
1892 "Insert an annual diary entry for the day of the year indicated by point."
1895 (autoload 'insert-anniversary-diary-entry "diary-lib"
1896 "Insert an anniversary diary entry for the date indicated by point."
1899 (autoload 'insert-block-diary-entry "diary-lib"
1900 "Insert a block diary entry for the dates indicated by point and mark."
1903 (autoload 'insert-cyclic-diary-entry "diary-lib"
1904 "Insert a cyclic diary entry starting at the date indicated by point."
1907 (autoload 'insert-hebrew-diary-entry "cal-hebrew"
1908 "Insert a diary entry for the Hebrew date corresponding to the date
1909 indicated by point."
1912 (autoload 'insert-monthly-hebrew-diary-entry "cal-hebrew"
1913 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1914 to the date indicated by point."
1917 (autoload 'insert-yearly-hebrew-diary-entry "cal-hebrew"
1918 "Insert an annual diary entry for the day of the Hebrew year corresponding
1919 to the date indicated by point."
1922 (autoload 'insert-islamic-diary-entry "cal-islam"
1923 "Insert a diary entry for the Islamic date corresponding to the date
1924 indicated by point."
1927 (autoload 'insert-monthly-islamic-diary-entry "cal-islam"
1928 "Insert a monthly diary entry for the day of the Islamic month corresponding
1929 to the date indicated by point."
1932 (autoload 'insert-yearly-islamic-diary-entry "cal-islam"
1933 "Insert an annual diary entry for the day of the Islamic year corresponding
1934 to the date indicated by point."
1937 (autoload 'insert-bahai-diary-entry "cal-bahai"
1938 "Insert a diary entry for the Baha'i date corresponding to the date
1939 indicated by point."
1942 (autoload 'insert-monthly-bahai-diary-entry "cal-bahai"
1943 "Insert a monthly diary entry for the day of the Baha'i month corresponding
1944 to the date indicated by point."
1947 (autoload 'insert-yearly-bahai-diary-entry "cal-bahai"
1948 "Insert an annual diary entry for the day of the Baha'i year corresponding
1949 to the date indicated by point."
1952 (autoload 'list-calendar-holidays "holidays"
1953 "Create a buffer containing the holidays for the current calendar window.
1954 The holidays are those in the list `calendar-notable-days'. Returns t if any
1955 holidays are found, nil if not."
1958 (autoload 'cal-tex-cursor-month "cal-tex"
1959 "Make a buffer with LaTeX commands for the month cursor is on.
1960 Optional prefix argument specifies number of months to be produced.
1961 Calendar is condensed onto one page.")
1963 (autoload 'cal-tex-cursor-month-landscape "cal-tex"
1964 "Make a buffer with LaTeX commands for the month cursor is on.
1965 Optional prefix argument specifies number of months to be produced.")
1967 (autoload 'cal-tex-cursor-day "cal-tex"
1968 "Make a buffer with LaTeX commands for the day cursor is on.")
1970 (autoload 'cal-tex-cursor-week "cal-tex"
1971 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1972 It applies to the week that point is in.
1973 Optional prefix argument specifies number of weeks.
1974 Holidays are included if `cal-tex-holidays' is t.")
1976 (autoload 'cal-tex-cursor-week2 "cal-tex"
1977 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1978 It applies to the week that point is in.
1979 Optional prefix argument specifies number of weeks.
1980 Holidays are included if `cal-tex-holidays' is t.")
1982 (autoload 'cal-tex-cursor-week-iso "cal-tex"
1983 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
1984 Optional prefix argument specifies number of weeks.
1985 Diary entries are included if `cal-tex-diary' is t.
1986 Holidays are included if `cal-tex-holidays' is t.")
1988 (autoload 'cal-tex-cursor-week-monday "cal-tex"
1989 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1990 It applies to the week that point is in, and starts on Monday.
1991 Optional prefix argument specifies number of weeks.
1992 Holidays are included if `cal-tex-holidays' is t.")
1994 (autoload 'cal-tex-cursor-filofax-2week "cal-tex"
1995 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
1996 Optional prefix argument specifies number of weeks.
1997 Diary entries are included if cal-tex-diary is t.
1998 Holidays are included if `cal-tex-holidays' is t.")
2000 (autoload 'cal-tex-cursor-filofax-week "cal-tex"
2001 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
2002 Optional prefix argument specifies number of weeks.
2003 Weeks start on Monday.
2004 Diary entries are included if cal-tex-diary is t.
2005 Holidays are included if `cal-tex-holidays' is t.")
2007 (autoload 'cal-tex-cursor-filofax-daily "cal-tex"
2008 "Day-per-page Filofax style calendar for week indicated by cursor.
2009 Optional prefix argument specifies number of weeks. Weeks start on Monday.
2010 Diary entries are included if `cal-tex-diary' is t.
2011 Holidays are included if `cal-tex-holidays' is t.")
2013 (autoload 'cal-tex-cursor-year "cal-tex"
2014 "Make a buffer with LaTeX commands for a year's calendar.
2015 Optional prefix argument specifies number of years.")
2017 (autoload 'cal-tex-cursor-year-landscape "cal-tex"
2018 "Make a buffer with LaTeX commands for a year's calendar (landscape).
2019 Optional prefix argument specifies number of years.")
2021 (autoload 'cal-tex-cursor-filofax-year "cal-tex"
2022 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
2023 Optional prefix argument specifies number of years.")
2025 (autoload 'mark-calendar-holidays "holidays"
2026 "Mark notable days in the calendar window."
2029 (autoload 'calendar-cursor-holidays "holidays"
2030 "Find holidays for the date specified by the cursor in the calendar window."
2033 (defun generate-calendar-window (&optional mon yr)
2034 "Generate the calendar window for the current date.
2035 Or, for optional MON, YR."
2036 (let* ((buffer-read-only nil)
2037 (today (calendar-current-date))
2038 (month (extract-calendar-month today))
2039 (day (extract-calendar-day today))
2040 (year (extract-calendar-year today))
2041 (today-visible
2042 (or (not mon)
2043 (let ((offset (calendar-interval mon yr month year)))
2044 (and (<= offset 1) (>= offset -1)))))
2045 (day-in-week (calendar-day-of-week today))
2046 (in-calendar-window (eq (window-buffer (selected-window))
2047 (get-buffer calendar-buffer))))
2048 (update-calendar-mode-line)
2049 (if mon
2050 (generate-calendar mon yr)
2051 (generate-calendar month year))
2052 (calendar-cursor-to-visible-date
2053 (if today-visible today (list displayed-month 1 displayed-year)))
2054 (set-buffer-modified-p nil)
2055 ;; Don't do any window-related stuff if we weren't called from a
2056 ;; window displaying the calendar
2057 (when in-calendar-window
2058 (if (or (one-window-p t) (/= (frame-width) (window-width)))
2059 ;; Don't mess with the window size, but ensure that the first
2060 ;; line is fully visible
2061 (set-window-vscroll nil 0)
2062 ;; Adjust the window to exactly fit the displayed calendar
2063 (fit-window-to-buffer nil nil calendar-minimum-window-height))
2064 (sit-for 0))
2065 (if (and (boundp 'font-lock-mode)
2066 font-lock-mode)
2067 (font-lock-fontify-buffer))
2068 (and mark-holidays-in-calendar
2069 ;;; (calendar-date-is-legal-p today) ; useful for BC dates
2070 (mark-calendar-holidays)
2071 (and in-calendar-window (sit-for 0)))
2072 (unwind-protect
2073 (if mark-diary-entries-in-calendar (mark-diary-entries))
2074 (if today-visible
2075 (run-hooks 'today-visible-calendar-hook)
2076 (run-hooks 'today-invisible-calendar-hook)))))
2078 (defun generate-calendar (month year)
2079 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
2080 ;;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on.
2081 ;;; Note that while calendars for years BC could be displayed as it
2082 ;;; stands, almost all other calendar functions (eg holidays) would
2083 ;;; at best have unpredictable results for such dates.
2084 (if (< (+ month (* 12 (1- year))) 2)
2085 (error "Months before January, 1 AD cannot be displayed"))
2086 (setq displayed-month month
2087 displayed-year year)
2088 (erase-buffer)
2089 (increment-calendar-month month year -1)
2090 (calendar-for-loop i from 0 to 2 do
2091 (generate-calendar-month month year (+ 5 (* 25 i)))
2092 (increment-calendar-month month year 1)))
2094 (defun generate-calendar-month (month year indent)
2095 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
2096 The calendar is inserted at the top of the buffer in which point is currently
2097 located, but indented INDENT spaces. The indentation is done from the first
2098 character on the line and does not disturb the first INDENT characters on the
2099 line."
2100 (let* ((blank-days;; at start of month
2101 (mod
2102 (- (calendar-day-of-week (list month 1 year))
2103 calendar-week-start-day)
2105 (last (calendar-last-day-of-month month year)))
2106 (goto-char (point-min))
2107 (calendar-insert-indented
2108 (calendar-string-spread
2109 (list (format "%s %d" (calendar-month-name month) year)) ? 20)
2110 indent t)
2111 (calendar-insert-indented "" indent);; Go to proper spot
2112 ;; Use the first two characters of each day to head the columns.
2113 (calendar-for-loop i from 0 to 6 do
2114 (insert
2115 (let ((string
2116 (calendar-day-name (mod (+ calendar-week-start-day i) 7) nil t)))
2117 (if enable-multibyte-characters
2118 (truncate-string-to-width string 2)
2119 (substring string 0 2)))
2120 " "))
2121 (calendar-insert-indented "" 0 t);; Force onto following line
2122 (calendar-insert-indented "" indent);; Go to proper spot
2123 ;; Add blank days before the first of the month
2124 (calendar-for-loop i from 1 to blank-days do (insert " "))
2125 ;; Put in the days of the month
2126 (calendar-for-loop i from 1 to last do
2127 (insert (format "%2d " i))
2128 (add-text-properties
2129 (- (point) 3) (1- (point))
2130 '(mouse-face highlight
2131 help-echo "mouse-2: menu of operations for this date"))
2132 (and (zerop (mod (+ i blank-days) 7))
2133 (/= i last)
2134 (calendar-insert-indented "" 0 t) ;; Force onto following line
2135 (calendar-insert-indented "" indent)))));; Go to proper spot
2137 (defun calendar-insert-indented (string indent &optional newline)
2138 "Insert STRING at column INDENT.
2139 If the optional parameter NEWLINE is t, leave point at start of next line,
2140 inserting a newline if there was no next line; otherwise, leave point after
2141 the inserted text. Value is always t."
2142 ;; Try to move to that column.
2143 (move-to-column indent)
2144 ;; If line is too short, indent out to that column.
2145 (if (< (current-column) indent)
2146 (indent-to indent))
2147 (insert string)
2148 ;; Advance to next line, if requested.
2149 (if newline
2150 (progn
2151 (end-of-line)
2152 (if (eobp)
2153 (newline)
2154 (forward-line 1))))
2157 (defun redraw-calendar ()
2158 "Redraw the calendar display, if `calendar-buffer' is live."
2159 (interactive)
2160 (if (get-buffer calendar-buffer)
2161 (with-current-buffer calendar-buffer
2162 (let ((cursor-date (calendar-cursor-to-nearest-date)))
2163 (generate-calendar-window displayed-month displayed-year)
2164 (calendar-cursor-to-visible-date cursor-date)))))
2166 ;;;###autoload
2167 (defcustom calendar-week-start-day 0
2168 "*The day of the week on which a week in the calendar begins.
2169 0 means Sunday (default), 1 means Monday, and so on.
2171 If you change this variable directly (without using customize)
2172 after starting `calendar', you should call `redraw-calendar' to
2173 update the calendar display to reflect the change, otherwise
2174 movement commands will not work correctly."
2175 :type 'integer
2176 :set (lambda (sym val)
2177 (set sym val)
2178 (redraw-calendar))
2179 :group 'calendar)
2181 (defcustom calendar-debug-sexp nil
2182 "*Turn debugging on when evaluating a sexp in the diary or holiday list."
2183 :type 'boolean
2184 :group 'calendar)
2186 (defvar calendar-mode-map nil)
2187 (if calendar-mode-map
2189 (setq calendar-mode-map (make-sparse-keymap))
2190 (require 'cal-menu)
2191 (calendar-for-loop i from 0 to 9 do
2192 (define-key calendar-mode-map (int-to-string i) 'digit-argument))
2193 (let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph
2194 'mark-defun 'mark-whole-buffer 'mark-page
2195 'downcase-region 'upcase-region 'kill-region
2196 'copy-region-as-kill 'capitalize-region 'write-region)))
2197 (while l
2198 (substitute-key-definition (car l) 'calendar-not-implemented
2199 calendar-mode-map global-map)
2200 (setq l (cdr l))))
2201 (define-key calendar-mode-map "-" 'negative-argument)
2202 (define-key calendar-mode-map "\C-x>" 'scroll-calendar-right)
2203 (define-key calendar-mode-map [prior] 'scroll-calendar-right-three-months)
2204 (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
2205 (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
2206 (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
2207 (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
2208 (define-key calendar-mode-map "\C-b" 'calendar-backward-day)
2209 (define-key calendar-mode-map "\C-p" 'calendar-backward-week)
2210 (define-key calendar-mode-map "\e{" 'calendar-backward-month)
2211 (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
2212 (define-key calendar-mode-map "\C-f" 'calendar-forward-day)
2213 (define-key calendar-mode-map "\C-n" 'calendar-forward-week)
2214 (define-key calendar-mode-map [left] 'calendar-backward-day)
2215 (define-key calendar-mode-map [up] 'calendar-backward-week)
2216 (define-key calendar-mode-map [right] 'calendar-forward-day)
2217 (define-key calendar-mode-map [down] 'calendar-forward-week)
2218 (define-key calendar-mode-map "\e}" 'calendar-forward-month)
2219 (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
2220 (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
2221 (define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
2222 (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month)
2223 (define-key calendar-mode-map "\ee" 'calendar-end-of-month)
2224 (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
2225 (define-key calendar-mode-map "\e>" 'calendar-end-of-year)
2226 (define-key calendar-mode-map "\C-@" 'calendar-set-mark)
2227 ;; Many people are used to typing C-SPC and getting C-@.
2228 (define-key calendar-mode-map [?\C- ] 'calendar-set-mark)
2229 (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
2230 (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
2231 (define-key calendar-mode-map "gd" 'calendar-goto-date)
2232 (define-key calendar-mode-map "gD" 'calendar-goto-day-of-year)
2233 (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
2234 (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
2235 (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
2236 (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
2237 (define-key calendar-mode-map "gb" 'calendar-goto-bahai-date)
2238 (define-key calendar-mode-map "gC" 'calendar-goto-chinese-date)
2239 (define-key calendar-mode-map "gk" 'calendar-goto-coptic-date)
2240 (define-key calendar-mode-map "ge" 'calendar-goto-ethiopic-date)
2241 (define-key calendar-mode-map "gp" 'calendar-goto-persian-date)
2242 (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
2243 (define-key calendar-mode-map "gw" 'calendar-goto-iso-week)
2244 (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
2245 (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
2246 (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
2247 (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
2248 (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
2249 (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
2250 (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
2251 (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
2252 (define-key calendar-mode-map "Aa" 'appt-add)
2253 (define-key calendar-mode-map "Ad" 'appt-delete)
2254 (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
2255 (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
2256 (define-key calendar-mode-map " " 'scroll-other-window)
2257 (define-key calendar-mode-map (kbd "DEL") 'scroll-other-window-down)
2258 (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
2259 (define-key calendar-mode-map "." 'calendar-goto-today)
2260 (define-key calendar-mode-map "o" 'calendar-other-month)
2261 (define-key calendar-mode-map "q" 'exit-calendar)
2262 (define-key calendar-mode-map "a" 'list-calendar-holidays)
2263 (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
2264 (define-key calendar-mode-map "x" 'mark-calendar-holidays)
2265 (define-key calendar-mode-map "u" 'calendar-unmark)
2266 (define-key calendar-mode-map "m" 'mark-diary-entries)
2267 (define-key calendar-mode-map "d" 'view-diary-entries)
2268 (define-key calendar-mode-map "D" 'view-other-diary-entries)
2269 (define-key calendar-mode-map "s" 'show-all-diary-entries)
2270 (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
2271 (define-key calendar-mode-map "pC" 'calendar-print-chinese-date)
2272 (define-key calendar-mode-map "pk" 'calendar-print-coptic-date)
2273 (define-key calendar-mode-map "pe" 'calendar-print-ethiopic-date)
2274 (define-key calendar-mode-map "pp" 'calendar-print-persian-date)
2275 (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
2276 (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
2277 (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
2278 (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
2279 (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
2280 (define-key calendar-mode-map "pb" 'calendar-print-bahai-date)
2281 (define-key calendar-mode-map "pf" 'calendar-print-french-date)
2282 (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
2283 (define-key calendar-mode-map "po" 'calendar-print-other-dates)
2284 (define-key calendar-mode-map "id" 'insert-diary-entry)
2285 (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
2286 (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
2287 (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
2288 (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
2289 (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
2290 (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
2291 (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
2292 (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
2293 (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
2294 (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
2295 (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
2296 (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
2297 (define-key calendar-mode-map "iBd" 'insert-bahai-diary-entry)
2298 (define-key calendar-mode-map "iBm" 'insert-monthly-bahai-diary-entry)
2299 (define-key calendar-mode-map "iBy" 'insert-yearly-bahai-diary-entry)
2300 (define-key calendar-mode-map "?" 'calendar-goto-info-node)
2301 (define-key calendar-mode-map "tm" 'cal-tex-cursor-month)
2302 (define-key calendar-mode-map "tM" 'cal-tex-cursor-month-landscape)
2303 (define-key calendar-mode-map "td" 'cal-tex-cursor-day)
2304 (define-key calendar-mode-map "tw1" 'cal-tex-cursor-week)
2305 (define-key calendar-mode-map "tw2" 'cal-tex-cursor-week2)
2306 (define-key calendar-mode-map "tw3" 'cal-tex-cursor-week-iso)
2307 (define-key calendar-mode-map "tw4" 'cal-tex-cursor-week-monday)
2308 (define-key calendar-mode-map "tfd" 'cal-tex-cursor-filofax-daily)
2309 (define-key calendar-mode-map "tfw" 'cal-tex-cursor-filofax-2week)
2310 (define-key calendar-mode-map "tfW" 'cal-tex-cursor-filofax-week)
2311 (define-key calendar-mode-map "tfy" 'cal-tex-cursor-filofax-year)
2312 (define-key calendar-mode-map "ty" 'cal-tex-cursor-year)
2313 (define-key calendar-mode-map "tY" 'cal-tex-cursor-year-landscape))
2315 (defun describe-calendar-mode ()
2316 "Create a help buffer with a brief description of the `calendar-mode'."
2317 (interactive)
2318 (with-output-to-temp-buffer "*Help*"
2319 (princ
2320 (format
2321 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
2322 (substitute-command-keys
2323 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
2324 (substitute-command-keys "\\{calendar-mode-map}")))
2325 (save-excursion
2326 (set-buffer standard-output)
2327 (help-mode))
2328 (print-help-return-message)))
2330 ;; Calendar mode is suitable only for specially formatted data.
2331 (put 'calendar-mode 'mode-class 'special)
2333 (defvar calendar-mode-line-format
2334 (list
2335 (propertize (substitute-command-keys
2336 "\\<calendar-mode-map>\\[scroll-calendar-left]")
2337 'help-echo "mouse-2: scroll left"
2338 'mouse-face 'mode-line-highlight
2339 'keymap (make-mode-line-mouse-map 'mouse-2
2340 'mouse-scroll-calendar-left))
2341 "Calendar"
2342 (concat
2343 (propertize
2344 (substitute-command-keys
2345 "\\<calendar-mode-map>\\[calendar-goto-info-node] info")
2346 'help-echo "mouse-2: read Info on Calendar"
2347 'mouse-face 'mode-line-highlight
2348 'keymap (make-mode-line-mouse-map 'mouse-2 'calendar-goto-info-node))
2350 (propertize
2351 (substitute-command-keys
2352 "\\<calendar-mode-map>\\[calendar-other-month] other")
2353 'help-echo "mouse-2: choose another month"
2354 'mouse-face 'mode-line-highlight
2355 'keymap (make-mode-line-mouse-map
2356 'mouse-2 'mouse-calendar-other-month))
2358 (propertize
2359 (substitute-command-keys
2360 "\\<calendar-mode-map>\\[calendar-goto-today] today")
2361 'help-echo "mouse-2: go to today's date"
2362 'mouse-face 'mode-line-highlight
2363 'keymap (make-mode-line-mouse-map 'mouse-2 #'calendar-goto-today)))
2364 '(calendar-date-string (calendar-current-date) t)
2365 (propertize (substitute-command-keys
2366 "\\<calendar-mode-map>\\[scroll-calendar-right]")
2367 'help-echo "mouse-2: scroll right"
2368 'mouse-face 'mode-line-highlight
2369 'keymap (make-mode-line-mouse-map
2370 'mouse-2 'mouse-scroll-calendar-right)))
2371 "The mode line of the calendar buffer.
2373 This must be a list of items that evaluate to strings--those strings are
2374 evaluated and concatenated together, evenly separated by blanks. The variable
2375 `date' is available for use as the date under (or near) the cursor; `date'
2376 defaults to the current date if it is otherwise undefined. Here is an example
2377 value that has the Hebrew date, the day number/days remaining in the year,
2378 and the ISO week/year numbers in the mode. When calendar-move-hook is set to
2379 'update-calendar-mode-line, these mode line shows these values for the date
2380 under the cursor:
2382 (list
2383 \"\"
2384 '(calendar-hebrew-date-string date)
2385 '(let* ((year (extract-calendar-year date))
2386 (d (calendar-day-number date))
2387 (days-remaining
2388 (- (calendar-day-number (list 12 31 year)) d)))
2389 (format \"%d/%d\" d days-remaining))
2390 '(let* ((d (calendar-absolute-from-gregorian date))
2391 (iso-date (calendar-iso-from-absolute d)))
2392 (format \"ISO week %d of %d\"
2393 (extract-calendar-month iso-date)
2394 (extract-calendar-year iso-date)))
2395 \"\"))
2398 (defun mouse-scroll-calendar-left (event)
2399 "Scroll the displayed calendar left by one month.
2400 Maintains the relative position of the cursor
2401 with respect to the calendar as well as possible."
2402 (interactive "e")
2403 (save-selected-window
2404 (select-window (posn-window (event-start event)))
2405 (scroll-calendar-left 1)))
2407 (defun mouse-scroll-calendar-right (event)
2408 "Scroll the displayed calendar right by one month.
2409 Maintains the relative position of the cursor
2410 with respect to the calendar as well as possible."
2411 (interactive "e")
2412 (save-selected-window
2413 (select-window (posn-window (event-start event)))
2414 (scroll-calendar-right 1)))
2416 (defun mouse-calendar-other-month (event)
2417 "Display a three-month calendar centered around a specified month and year."
2418 (interactive "e")
2419 (save-selected-window
2420 (select-window (posn-window (event-start event)))
2421 (call-interactively 'calendar-other-month)))
2423 (defun calendar-goto-info-node ()
2424 "Go to the info node for the calendar."
2425 (interactive)
2426 (require 'info)
2427 (let ((where (save-window-excursion
2428 (Info-find-emacs-command-nodes 'calendar))))
2429 (if (not where)
2430 (error "Couldn't find documentation for the calendar")
2431 (let (same-window-buffer-names)
2432 (info))
2433 (Info-find-node (car (car where)) (car (cdr (car where)))))))
2437 (defun calendar-mode ()
2438 "A major mode for the calendar window.
2440 For a complete description, type \
2441 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
2443 \\<calendar-mode-map>\\{calendar-mode-map}"
2445 (kill-all-local-variables)
2446 (setq major-mode 'calendar-mode)
2447 (setq mode-name "Calendar")
2448 (use-local-map calendar-mode-map)
2449 (setq buffer-read-only t)
2450 (setq indent-tabs-mode nil)
2451 (update-calendar-mode-line)
2452 (add-hook 'activate-menubar-hook 'cal-menu-update nil t)
2453 (make-local-variable 'calendar-mark-ring)
2454 (make-local-variable 'displayed-month);; Month in middle of window.
2455 (make-local-variable 'displayed-year) ;; Year in middle of window.
2456 (set (make-local-variable 'font-lock-defaults)
2457 '(calendar-font-lock-keywords t)))
2459 (defun calendar-string-spread (strings char length)
2460 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
2461 The effect is like mapconcat but the separating pieces are as balanced as
2462 possible. Each item of STRINGS is evaluated before concatenation so it can
2463 actually be an expression that evaluates to a string. If LENGTH is too short,
2464 the STRINGS are just concatenated and the result truncated."
2465 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
2466 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
2467 ;; Addison-Wesley, Reading, MA, 1989
2468 (let* ((strings (mapcar 'eval
2469 (if (< (length strings) 2)
2470 (append (list "") strings (list ""))
2471 strings)))
2472 (n (- length (length (apply 'concat strings))))
2473 (m (1- (length strings)))
2474 (s (car strings))
2475 (strings (cdr strings))
2476 (i 0))
2477 (while strings
2478 (setq s (concat s
2479 (make-string (max 0 (/ (+ n i) m)) char)
2480 (car strings)))
2481 (setq i (1+ i))
2482 (setq strings (cdr strings)))
2483 (substring s 0 length)))
2485 (defun update-calendar-mode-line ()
2486 "Update the calendar mode line with the current date and date style."
2487 (if (bufferp (get-buffer calendar-buffer))
2488 (save-excursion
2489 (set-buffer calendar-buffer)
2490 (setq mode-line-format
2491 (calendar-string-spread
2492 (let ((date (condition-case nil
2493 (calendar-cursor-to-nearest-date)
2494 (error (calendar-current-date)))))
2495 (mapcar 'eval calendar-mode-line-format))
2496 ? (frame-width)))
2497 (force-mode-line-update))))
2499 (defun calendar-window-list ()
2500 "List of all calendar-related windows."
2501 (let ((calendar-buffers (calendar-buffer-list))
2502 list)
2503 (walk-windows (lambda (w)
2504 (if (memq (window-buffer w) calendar-buffers)
2505 (setq list (cons w list))))
2506 nil t)
2507 list))
2509 (defun calendar-buffer-list ()
2510 "List of all calendar-related buffers."
2511 (let* ((diary-buffer (get-file-buffer diary-file))
2512 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
2513 fancy-diary-buffer diary-buffer calendar-buffer
2514 other-calendars-buffer))
2515 (buffer-list nil)
2517 (while buffers
2518 (setq b (car buffers))
2519 (setq b (cond ((stringp b) (get-buffer b))
2520 ((bufferp b) b)
2521 (t nil)))
2522 (if b (setq buffer-list (cons b buffer-list)))
2523 (setq buffers (cdr buffers)))
2524 buffer-list))
2526 (defun exit-calendar ()
2527 "Get out of the calendar window and hide it and related buffers."
2528 (interactive)
2529 (let* ((diary-buffer (get-file-buffer diary-file)))
2530 (if (or (not diary-buffer)
2531 (not (buffer-modified-p diary-buffer))
2532 (yes-or-no-p
2533 "Diary modified; do you really want to exit the calendar? "))
2534 ;; Need to do this multiple times because one time can replace some
2535 ;; calendar-related buffers with other calendar-related buffers
2536 (mapcar (lambda (x)
2537 (mapcar 'calendar-hide-window (calendar-window-list)))
2538 (calendar-window-list)))))
2540 (defun calendar-hide-window (window)
2541 "Hide WINDOW if it is calendar-related."
2542 (let ((buffer (if (window-live-p window) (window-buffer window))))
2543 (if (memq buffer (calendar-buffer-list))
2544 (cond
2545 ((and (display-multi-frame-p)
2546 (eq 'icon (cdr (assoc 'visibility
2547 (frame-parameters
2548 (window-frame window))))))
2549 nil)
2550 ((and (display-multi-frame-p) (window-dedicated-p window))
2551 (if calendar-remove-frame-by-deleting
2552 (delete-frame (window-frame window))
2553 (iconify-frame (window-frame window))))
2554 ((not (and (select-window window) (one-window-p window)))
2555 (delete-window window))
2556 (t (set-buffer buffer)
2557 (bury-buffer))))))
2559 (defun calendar-current-date ()
2560 "Return the current date in a list (month day year)."
2561 (let ((now (decode-time)))
2562 (list (nth 4 now) (nth 3 now) (nth 5 now))))
2564 (defun calendar-cursor-to-date (&optional error)
2565 "Return a list (month day year) of current cursor position.
2566 If cursor is not on a specific date, signals an error if optional parameter
2567 ERROR is t, otherwise just returns nil."
2568 (let* ((segment (/ (current-column) 25))
2569 (month (% (+ displayed-month segment -1) 12))
2570 (month (if (= 0 month) 12 month))
2571 (year
2572 (cond
2573 ((and (= 12 month) (= segment 0)) (1- displayed-year))
2574 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
2575 (t displayed-year))))
2576 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
2577 (< 2 (count-lines (point-min) (point))))
2578 (save-excursion
2579 (if (not (looking-at " "))
2580 (re-search-backward "[^0-9]"))
2581 (list month
2582 (string-to-number (buffer-substring (1+ (point)) (+ 4 (point))))
2583 year))
2584 (if (looking-at "\\*")
2585 (save-excursion
2586 (re-search-backward "[^*]")
2587 (if (looking-at ".\\*\\*")
2588 (list month calendar-starred-day year)
2589 (if error (error "Not on a date!"))))
2590 (if error (error "Not on a date!"))))))
2592 ;; The following version of calendar-gregorian-from-absolute is preferred for
2593 ;; reasons of clarity, BUT it's much slower than the version that follows it.
2595 ;;(defun calendar-gregorian-from-absolute (date)
2596 ;; "Compute the list (month day year) corresponding to the absolute DATE.
2597 ;;The absolute date is the number of days elapsed since the (imaginary)
2598 ;;Gregorian date Sunday, December 31, 1 BC."
2599 ;; (let* ((approx (/ date 366));; Approximation from below.
2600 ;; (year ;; Search forward from the approximation.
2601 ;; (+ approx
2602 ;; (calendar-sum y approx
2603 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2604 ;; 1)))
2605 ;; (month ;; Search forward from January.
2606 ;; (1+ (calendar-sum m 1
2607 ;; (> date
2608 ;; (calendar-absolute-from-gregorian
2609 ;; (list m (calendar-last-day-of-month m year) year)))
2610 ;; 1)))
2611 ;; (day ;; Calculate the day by subtraction.
2612 ;; (- date
2613 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2614 ;; (list month day year)))
2616 (defun calendar-gregorian-from-absolute (date)
2617 "Compute the list (month day year) corresponding to the absolute DATE.
2618 The absolute date is the number of days elapsed since the (imaginary)
2619 Gregorian date Sunday, December 31, 1 BC. This function does not
2620 handle dates in years BC."
2621 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2622 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2623 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2624 ;; (April, 1993), pages 383-404 for an explanation.
2625 (let* ((d0 (1- date))
2626 (n400 (/ d0 146097))
2627 (d1 (% d0 146097))
2628 (n100 (/ d1 36524))
2629 (d2 (% d1 36524))
2630 (n4 (/ d2 1461))
2631 (d3 (% d2 1461))
2632 (n1 (/ d3 365))
2633 (day (1+ (% d3 365)))
2634 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2635 (if (or (= n100 4) (= n1 4))
2636 (list 12 31 year)
2637 (let ((year (1+ year))
2638 (month 1))
2639 (while (let ((mdays (calendar-last-day-of-month month year)))
2640 (and (< mdays day)
2641 (setq day (- day mdays))))
2642 (setq month (1+ month)))
2643 (list month day year)))))
2645 (defun calendar-other-month (month year)
2646 "Display a three-month calendar centered around MONTH and YEAR."
2647 (interactive (calendar-read-date 'noday))
2648 (if (and (= month displayed-month)
2649 (= year displayed-year))
2651 (let ((old-date (calendar-cursor-to-date))
2652 (today (calendar-current-date)))
2653 (generate-calendar-window month year)
2654 (calendar-cursor-to-visible-date
2655 (cond
2656 ((calendar-date-is-visible-p old-date) old-date)
2657 ((calendar-date-is-visible-p today) today)
2658 (t (list month 1 year)))))))
2660 (defun calendar-set-mark (arg)
2661 "Mark the date under the cursor, or jump to marked date.
2662 With no prefix argument, push current date onto marked date ring.
2663 With argument, jump to mark, pop it, and put point at end of ring."
2664 (interactive "P")
2665 (let ((date (calendar-cursor-to-date t)))
2666 (if (null arg)
2667 (progn
2668 (setq calendar-mark-ring (cons date calendar-mark-ring))
2669 ;; Since the top of the mark ring is the marked date in the
2670 ;; calendar, the mark ring in the calendar is one longer than
2671 ;; in other buffers to get the same effect.
2672 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2673 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2674 (message "Mark set"))
2675 (if (null calendar-mark-ring)
2676 (error "No mark set in this buffer")
2677 (calendar-goto-date (car calendar-mark-ring))
2678 (setq calendar-mark-ring
2679 (cdr (nconc calendar-mark-ring (list date))))))))
2681 (defun calendar-exchange-point-and-mark ()
2682 "Exchange the current cursor position with the marked date."
2683 (interactive)
2684 (let ((mark (car calendar-mark-ring))
2685 (date (calendar-cursor-to-date t)))
2686 (if (null mark)
2687 (error "No mark set in this buffer")
2688 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2689 (calendar-goto-date mark))))
2691 (defun calendar-count-days-region ()
2692 "Count the number of days (inclusive) between point and the mark."
2693 (interactive)
2694 (let* ((days (- (calendar-absolute-from-gregorian
2695 (calendar-cursor-to-date t))
2696 (calendar-absolute-from-gregorian
2697 (or (car calendar-mark-ring)
2698 (error "No mark set in this buffer")))))
2699 (days (1+ (if (> days 0) days (- days)))))
2700 (message "Region has %d day%s (inclusive)"
2701 days (if (> days 1) "s" ""))))
2703 (defun calendar-not-implemented ()
2704 "Not implemented."
2705 (interactive)
2706 (error "%s not available in the calendar"
2707 (global-key-binding (this-command-keys))))
2709 (defun calendar-read (prompt acceptable &optional initial-contents)
2710 "Return an object read from the minibuffer.
2711 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2712 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2713 is a string to insert in the minibuffer before reading."
2714 (let ((value (read-minibuffer prompt initial-contents)))
2715 (while (not (funcall acceptable value))
2716 (setq value (read-minibuffer prompt initial-contents)))
2717 value))
2719 (defun calendar-read-date (&optional noday)
2720 "Prompt for Gregorian date. Return a list (month day year).
2721 If optional NODAY is t, does not ask for day, but just returns
2722 \(month nil year); if NODAY is any other non-nil value the value returned is
2723 \(month year)"
2724 (let* ((year (calendar-read
2725 "Year (>0): "
2726 (lambda (x) (> x 0))
2727 (int-to-string (extract-calendar-year
2728 (calendar-current-date)))))
2729 (month-array calendar-month-name-array)
2730 (completion-ignore-case t)
2731 (month (cdr (assoc-string
2732 (completing-read
2733 "Month name: "
2734 (mapcar 'list (append month-array nil))
2735 nil t)
2736 (calendar-make-alist month-array 1) t)))
2737 (last (calendar-last-day-of-month month year)))
2738 (if noday
2739 (if (eq noday t)
2740 (list month nil year)
2741 (list month year))
2742 (list month
2743 (calendar-read (format "Day (1-%d): " last)
2744 (lambda (x) (and (< 0 x) (<= x last))))
2745 year))))
2747 (defun calendar-interval (mon1 yr1 mon2 yr2)
2748 "The number of months difference between MON1, YR1 and MON2, YR2.
2749 The result is positive if the second date is later than the first.
2750 Negative years are interpreted as years BC; -1 being 1 BC, and so on."
2751 (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc
2752 (if (< yr2 0) (setq yr2 (1+ yr2)))
2753 (+ (* 12 (- yr2 yr1))
2754 (- mon2 mon1)))
2756 (defvar calendar-abbrev-length 3
2757 "*Length of abbreviations to be used for day and month names.
2758 See also `calendar-day-abbrev-array' and `calendar-month-abbrev-array'.")
2760 (defvar calendar-day-name-array
2761 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2762 "*Array of capitalized strings giving, in order, the day names.
2763 The first two characters of each string will be used to head the
2764 day columns in the calendar. See also the variable
2765 `calendar-day-abbrev-array'.")
2767 (defvar calendar-day-abbrev-array
2768 [nil nil nil nil nil nil nil]
2769 "*Array of capitalized strings giving the abbreviated day names.
2770 The order should be the same as that of the full names specified
2771 in `calendar-day-name-array'. These abbreviations may be used
2772 instead of the full names in the diary file. Do not include a
2773 trailing `.' in the strings specified in this variable, though
2774 you may use such in the diary file. If any element of this array
2775 is nil, then the abbreviation will be constructed as the first
2776 `calendar-abbrev-length' characters of the corresponding full name.")
2778 (defvar calendar-month-name-array
2779 ["January" "February" "March" "April" "May" "June"
2780 "July" "August" "September" "October" "November" "December"]
2781 "*Array of capitalized strings giving, in order, the month names.
2782 See also the variable `calendar-month-abbrev-array'.")
2784 (defvar calendar-month-abbrev-array
2785 [nil nil nil nil nil nil nil nil nil nil nil nil]
2786 "*Array of capitalized strings giving the abbreviated month names.
2787 The order should be the same as that of the full names specified
2788 in `calendar-month-name-array'. These abbreviations are used in
2789 the calendar menu entries, and can also be used in the diary
2790 file. Do not include a trailing `.' in the strings specified in
2791 this variable, though you may use such in the diary file. If any
2792 element of this array is nil, then the abbreviation will be
2793 constructed as the first `calendar-abbrev-length' characters of the
2794 corresponding full name.")
2796 (defun calendar-abbrev-construct (abbrev full &optional period)
2797 "Internal calendar function to return a complete abbreviation array.
2798 ABBREV is an array of abbreviations, FULL the corresponding array
2799 of full names. The return value is the ABBREV array, with any nil
2800 elements replaced by the first three characters taken from the
2801 corresponding element of FULL. If optional argument PERIOD is non-nil,
2802 each element returned has a final `.' character."
2803 (let (elem array name)
2804 (dotimes (i (length full))
2805 (setq name (aref full i)
2806 elem (or (aref abbrev i)
2807 (substring name 0
2808 (min calendar-abbrev-length (length name))))
2809 elem (format "%s%s" elem (if period "." ""))
2810 array (append array (list elem))))
2811 (vconcat array)))
2813 (defvar calendar-font-lock-keywords
2814 `((,(concat (regexp-opt (mapcar 'identity calendar-month-name-array) t)
2815 " -?[0-9]+")
2816 . font-lock-function-name-face) ; month and year
2817 (,(regexp-opt
2818 (list (substring (aref calendar-day-name-array 6) 0 2)
2819 (substring (aref calendar-day-name-array 0) 0 2)))
2820 ;; Saturdays and Sundays are hilited differently.
2821 . font-lock-comment-face)
2822 ;; First two chars of each day are used in the calendar.
2823 (,(regexp-opt (mapcar (lambda (x) (substring x 0 2)) calendar-day-name-array))
2824 . font-lock-reference-face))
2825 "Default keywords to highlight in Calendar mode.")
2827 (defun calendar-day-name (date &optional abbrev absolute)
2828 "Return a string with the name of the day of the week of DATE.
2829 DATE should be a list in the format (MONTH DAY YEAR), unless the
2830 optional argument ABSOLUTE is non-nil, in which case DATE should
2831 be an integer in the range 0 to 6 corresponding to the day of the
2832 week. Day names are taken from the variable `calendar-day-name-array',
2833 unless the optional argument ABBREV is non-nil, in which case
2834 the variable `calendar-day-abbrev-array' is used."
2835 (aref (if abbrev
2836 (calendar-abbrev-construct calendar-day-abbrev-array
2837 calendar-day-name-array)
2838 calendar-day-name-array)
2839 (if absolute date (calendar-day-of-week date))))
2841 (defun calendar-make-alist (sequence &optional start-index filter abbrevs)
2842 "Make an assoc list corresponding to SEQUENCE.
2843 Each element of sequence will be associated with an integer, starting
2844 from 1, or from START-INDEX if that is non-nil. If a sequence ABBREVS
2845 is supplied, the function `calendar-abbrev-construct' is used to
2846 construct abbreviations corresponding to the elements in SEQUENCE.
2847 Each abbreviation is entered into the alist with the same
2848 association index as the full name it represents.
2849 If FILTER is provided, apply it to each key in the alist."
2850 (let ((index 0)
2851 (offset (or start-index 1))
2852 (aseq (if abbrevs (calendar-abbrev-construct abbrevs sequence)))
2853 (aseqp (if abbrevs (calendar-abbrev-construct abbrevs sequence
2854 'period)))
2855 alist elem)
2856 (dotimes (i (length sequence) (reverse alist))
2857 (setq index (+ i offset)
2858 elem (elt sequence i)
2859 alist
2860 (cons (cons (if filter (funcall filter elem) elem) index) alist))
2861 (if aseq
2862 (setq elem (elt aseq i)
2863 alist (cons (cons (if filter (funcall filter elem) elem)
2864 index) alist)))
2865 (if aseqp
2866 (setq elem (elt aseqp i)
2867 alist (cons (cons (if filter (funcall filter elem) elem)
2868 index) alist))))))
2870 (defun calendar-month-name (month &optional abbrev)
2871 "Return a string with the name of month number MONTH.
2872 Months are numbered from one. Month names are taken from the
2873 variable `calendar-month-name-array', unless the optional
2874 argument ABBREV is non-nil, in which case
2875 `calendar-month-abbrev-array' is used."
2876 (aref (if abbrev
2877 (calendar-abbrev-construct calendar-month-abbrev-array
2878 calendar-month-name-array)
2879 calendar-month-name-array)
2880 (1- month)))
2882 (defun calendar-day-of-week (date)
2883 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc.
2884 DATE is a list of the form (month day year). A negative year is
2885 interpreted as BC; -1 being 1 BC, and so on."
2886 (mod (calendar-absolute-from-gregorian date) 7))
2888 (defun calendar-unmark ()
2889 "Delete all diary/holiday marks/highlighting from the calendar."
2890 (interactive)
2891 (setq mark-holidays-in-calendar nil)
2892 (setq mark-diary-entries-in-calendar nil)
2893 (redraw-calendar))
2895 (defun calendar-date-is-visible-p (date)
2896 "Return t if DATE is valid and is visible in the calendar window."
2897 (let ((gap (calendar-interval
2898 displayed-month displayed-year
2899 (extract-calendar-month date) (extract-calendar-year date))))
2900 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2902 (defun calendar-date-is-legal-p (date)
2903 "Return t if DATE is a valid date."
2904 (let ((month (extract-calendar-month date))
2905 (day (extract-calendar-day date))
2906 (year (extract-calendar-year date)))
2907 (and (<= 1 month) (<= month 12)
2908 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2909 ;; BC dates left as non-valid, to suppress errors from
2910 ;; complex holiday algorithms not suitable for years BC.
2911 ;; Note there are side effects on calendar navigation.
2912 (<= 1 year))))
2914 (defun calendar-date-equal (date1 date2)
2915 "Return t if the DATE1 and DATE2 are the same."
2916 (and
2917 (= (extract-calendar-month date1) (extract-calendar-month date2))
2918 (= (extract-calendar-day date1) (extract-calendar-day date2))
2919 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2921 (defun mark-visible-calendar-date (date &optional mark)
2922 "Mark DATE in the calendar window with MARK.
2923 MARK is a single-character string, a list of face attributes/values, or a face.
2924 MARK defaults to `diary-entry-marker'."
2925 (if (calendar-date-is-legal-p date)
2926 (save-excursion
2927 (set-buffer calendar-buffer)
2928 (calendar-cursor-to-visible-date date)
2929 (let ((mark (or (and (stringp mark) (= (length mark) 1) mark) ; single-char
2930 (and (listp mark) (> (length mark) 0) mark) ; attr list
2931 (and (facep mark) mark) ; face-name
2932 diary-entry-marker)))
2933 (if (facep mark)
2934 (progn ; face or an attr-list that contained a face
2935 (overlay-put
2936 (make-overlay (1- (point)) (1+ (point))) 'face mark))
2937 (if (and (stringp mark)
2938 (= (length mark) 1)) ; single-char
2939 (let ((buffer-read-only nil))
2940 (forward-char 1)
2941 (delete-char 1)
2942 (insert mark)
2943 (forward-char -2))
2944 (let ; attr list
2945 ((temp-face
2946 (make-symbol (apply 'concat "temp-face-"
2947 (mapcar '(lambda (sym)
2948 (cond ((symbolp sym) (symbol-name sym))
2949 ((numberp sym) (int-to-string sym))
2950 (t sym))) mark))))
2951 (faceinfo mark))
2952 (make-face temp-face)
2953 ;; Remove :face info from the mark, copy the face info into temp-face
2954 (while (setq faceinfo (memq :face faceinfo))
2955 (copy-face (read (nth 1 faceinfo)) temp-face)
2956 (setcar faceinfo nil)
2957 (setcar (cdr faceinfo) nil))
2958 (setq mark (delq nil mark))
2959 ;; Apply the font aspects
2960 (apply 'set-face-attribute temp-face nil mark)
2961 (overlay-put
2962 (make-overlay (1- (point)) (1+ (point))) 'face temp-face))))))))
2964 (defun calendar-star-date ()
2965 "Replace the date under the cursor in the calendar window with asterisks.
2966 This function can be used with the `today-visible-calendar-hook' run after the
2967 calendar window has been prepared."
2968 (let ((inhibit-read-only t))
2969 (make-local-variable 'calendar-starred-day)
2970 (forward-char 1)
2971 (setq calendar-starred-day
2972 (string-to-number
2973 (buffer-substring (point) (- (point) 2))))
2974 (delete-char -2)
2975 (insert "**")
2976 (backward-char 1)
2977 (set-buffer-modified-p nil)))
2979 (defun calendar-mark-today ()
2980 "Mark the date under the cursor in the calendar window.
2981 The date is marked with `calendar-today-marker'. This function can be used with
2982 the `today-visible-calendar-hook' run after the calendar window has been
2983 prepared."
2984 (mark-visible-calendar-date
2985 (calendar-cursor-to-date)
2986 calendar-today-marker))
2988 (defun calendar-date-compare (date1 date2)
2989 "Return t if DATE1 is before DATE2, nil otherwise.
2990 The actual dates are in the car of DATE1 and DATE2."
2991 (< (calendar-absolute-from-gregorian (car date1))
2992 (calendar-absolute-from-gregorian (car date2))))
2994 (defun calendar-date-string (date &optional abbreviate nodayname)
2995 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2996 An optional parameter ABBREVIATE, when non-nil, causes the month
2997 and day names to be abbreviated as specified by
2998 `calendar-month-abbrev-array' and `calendar-day-abbrev-array',
2999 respectively. An optional parameter NODAYNAME, when t, omits the
3000 name of the day of the week."
3001 (let* ((dayname
3002 (unless nodayname
3003 (calendar-day-name date abbreviate)))
3004 (month (extract-calendar-month date))
3005 (monthname (calendar-month-name month abbreviate))
3006 (day (int-to-string (extract-calendar-day date)))
3007 (month (int-to-string month))
3008 (year (int-to-string (extract-calendar-year date))))
3009 (mapconcat 'eval calendar-date-display-form "")))
3011 (defun calendar-dayname-on-or-before (dayname date)
3012 "Return the absolute date of the DAYNAME on or before absolute DATE.
3013 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
3015 Note: Applying this function to d+6 gives us the DAYNAME on or after an
3016 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
3017 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
3018 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
3019 (- date (% (- date dayname) 7)))
3021 (defun calendar-nth-named-absday (n dayname month year &optional day)
3022 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3023 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3024 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3025 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3027 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3028 (if (> n 0)
3029 (+ (* 7 (1- n))
3030 (calendar-dayname-on-or-before
3031 dayname
3032 (+ 6 (calendar-absolute-from-gregorian
3033 (list month (or day 1) year)))))
3034 (+ (* 7 (1+ n))
3035 (calendar-dayname-on-or-before
3036 dayname
3037 (calendar-absolute-from-gregorian
3038 (list month
3039 (or day (calendar-last-day-of-month month year))
3040 year))))))
3042 (defun calendar-nth-named-day (n dayname month year &optional day)
3043 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3044 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3045 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3046 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3048 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3049 (calendar-gregorian-from-absolute
3050 (calendar-nth-named-absday n dayname month year day)))
3052 (defun calendar-day-of-year-string (&optional date)
3053 "String of day number of year of Gregorian DATE.
3054 Defaults to today's date if DATE is not given."
3055 (let* ((d (or date (calendar-current-date)))
3056 (year (extract-calendar-year d))
3057 (day (calendar-day-number d))
3058 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
3059 (format "Day %d of %d; %d day%s remaining in the year"
3060 day year days-remaining (if (= days-remaining 1) "" "s"))))
3062 (defun calendar-print-other-dates ()
3063 "Show dates on other calendars for date under the cursor."
3064 (interactive)
3065 (let* ((date (calendar-cursor-to-date t)))
3066 (save-excursion
3067 (set-buffer (get-buffer-create other-calendars-buffer))
3068 (setq buffer-read-only nil)
3069 (calendar-set-mode-line
3070 (concat (calendar-date-string date) " (Gregorian)"))
3071 (erase-buffer)
3072 (insert
3073 (mapconcat 'identity
3074 (list (calendar-day-of-year-string date)
3075 (format "ISO date: %s" (calendar-iso-date-string date))
3076 (format "Julian date: %s"
3077 (calendar-julian-date-string date))
3078 (format
3079 "Astronomical (Julian) day number (at noon UTC): %s.0"
3080 (calendar-astro-date-string date))
3081 (format "Fixed (RD) date: %s"
3082 (calendar-absolute-from-gregorian date))
3083 (format "Hebrew date (before sunset): %s"
3084 (calendar-hebrew-date-string date))
3085 (format "Persian date: %s"
3086 (calendar-persian-date-string date))
3087 (let ((i (calendar-islamic-date-string date)))
3088 (if (not (string-equal i ""))
3089 (format "Islamic date (before sunset): %s" i)))
3090 (let ((b (calendar-bahai-date-string date)))
3091 (if (not (string-equal b ""))
3092 (format "Baha'i date (before sunset): %s" b)))
3093 (format "Chinese date: %s"
3094 (calendar-chinese-date-string date))
3095 (let ((c (calendar-coptic-date-string date)))
3096 (if (not (string-equal c ""))
3097 (format "Coptic date: %s" c)))
3098 (let ((e (calendar-ethiopic-date-string date)))
3099 (if (not (string-equal e ""))
3100 (format "Ethiopic date: %s" e)))
3101 (let ((f (calendar-french-date-string date)))
3102 (if (not (string-equal f ""))
3103 (format "French Revolutionary date: %s" f)))
3104 (format "Mayan date: %s"
3105 (calendar-mayan-date-string date)))
3106 "\n"))
3107 (goto-char (point-min))
3108 (set-buffer-modified-p nil)
3109 (setq buffer-read-only t)
3110 (display-buffer other-calendars-buffer))))
3112 (defun calendar-print-day-of-year ()
3113 "Show day number in year/days remaining in year for date under the cursor."
3114 (interactive)
3115 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
3117 (defun calendar-set-mode-line (str)
3118 "Set mode line to STR, centered, surrounded by dashes."
3119 (setq mode-line-format
3120 (calendar-string-spread
3121 (list str) ?-
3122 ;; As per doc of window-width, total visible mode-line length.
3123 (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))))))
3125 (defun calendar-mod (m n)
3126 "Non-negative remainder of M/N with N instead of 0."
3127 (1+ (mod (1- m) n)))
3129 (run-hooks 'calendar-load-hook)
3131 (provide 'calendar)
3133 ;;; Local variables:
3134 ;;; byte-compile-dynamic: t
3135 ;;; End:
3137 ;;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8
3138 ;;; calendar.el ends here