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