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