1 ;;; calendar.el --- calendar functions
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
9 ;; Human-Keywords: calendar, Gregorian calendar, diary, holidays
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; This collection of functions implements a calendar window. It
31 ;; generates a calendar for the current month, together with the
32 ;; previous and coming months, or for any other three-month period.
33 ;; The calendar can be scrolled forward and backward in the window to
34 ;; show months in the past or future; the cursor can move forward and
35 ;; backward by days, weeks, or months, making it possible, for
36 ;; instance, to jump to the date a specified number of days, weeks, or
37 ;; months from the date under the cursor. The user can display a list
38 ;; of holidays and other notable days for the period shown; the
39 ;; notable days can be marked on the calendar, if desired. The user
40 ;; can also specify that dates having corresponding diary entries (in
41 ;; a file that the user specifies) be marked; the diary entries for
42 ;; any date can be viewed in a separate window. The diary and the
43 ;; notable days can be viewed independently of the calendar. Dates
44 ;; can be translated from the (usual) Gregorian calendar to the day of
45 ;; the year/days remaining in year, to the ISO commercial calendar, to
46 ;; the Julian (old style) calendar, to the Hebrew calendar, to the
47 ;; Islamic calendar, to the Baha'i calendar, to the French
48 ;; Revolutionary calendar, to the Mayan calendar, to the Chinese
49 ;; calendar, to the Coptic calendar, to the Ethiopic calendar, and to
50 ;; the astronomical (Julian) day number. When floating point is
51 ;; available, times of sunrise/sunset can be displayed, as can the
52 ;; phases of the moon. Appointment notification for diary entries is
53 ;; available. Calendar printing via LaTeX is available.
55 ;; The following files are part of the calendar/diary code:
57 ;; appt.el Appointment notification
58 ;; cal-china.el Chinese calendar
59 ;; cal-coptic.el Coptic/Ethiopic calendars
60 ;; cal-dst.el Daylight savings time rules
61 ;; cal-hebrew.el Hebrew calendar
62 ;; cal-islam.el Islamic calendar
63 ;; cal-bahai.el Baha'i calendar
64 ;; cal-iso.el ISO calendar
65 ;; cal-julian.el Julian/astronomical calendars
66 ;; cal-mayan.el Mayan calendars
67 ;; cal-menu.el Menu support
68 ;; cal-move.el Movement in the calendar
69 ;; cal-persia.el Persian calendar
70 ;; cal-tex.el Calendars in LaTeX
71 ;; cal-x.el X-windows dedicated frame functions
72 ;; diary-lib.el Diary functions
73 ;; holidays.el Holiday functions
74 ;; lunar.el Phases of the moon
75 ;; solar.el Sunrise/sunset, equinoxes/solstices
77 ;; Technical details of all the calendrical calculations can be found in
78 ;; ``Calendrical Calculations: The Millennium Edition'' by Edward M. Reingold
79 ;; and Nachum Dershowitz, Cambridge University Press (2001).
81 ;; An earlier version of the technical details appeared in
82 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
83 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
84 ;; pages 899-928, and in ``Calendrical Calculations, Part II: Three Historical
85 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
86 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
89 ;; Hard copies of these two papers can be obtained by sending email to
90 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
91 ;; the message BODY containing your mailing address (snail).
93 ;; Comments, corrections, and improvements should be sent to
94 ;; Edward M. Reingold Department of Computer Science
95 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
96 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
97 ;; Urbana, Illinois 61801
102 (defvar displayed-month
)
103 (defvar displayed-year
)
104 (defvar calendar-month-name-array
)
105 (defvar calendar-starred-day
))
107 (defun calendar-version ()
109 (message "Version 6, October 12, 1995"))
111 (defgroup calendar nil
112 "Calendar and time management support."
113 :group
'applications
)
120 "Appointment notification."
123 (defgroup holidays nil
124 "Holidays support in calendar."
129 (defgroup chinese-calendar nil
130 "Chinese calendar support."
133 (defgroup calendar-tex nil
134 "Options for printing calendar with LaTeX."
138 (defgroup calendar-hooks nil
144 (defconst calendar-buffer
"*Calendar*"
145 "Name of the buffer used for the calendar.")
148 (defcustom calendar-offset
0
149 "*The offset of the principal month from the center of the calendar window.
150 0 means the principal month is in the center (default), -1 means on the left,
151 +1 means on the right. Larger (or smaller) values push the principal month off
157 (defcustom view-diary-entries-initially nil
158 "*Non-nil means display current date's diary entries on entry to calendar.
159 The diary is displayed in another window when the calendar is first displayed,
160 if the current date is visible. The number of days of diary entries displayed
161 is governed by the variable `number-of-diary-entries'. This variable can
162 be overridden by the value of `calendar-setup'."
167 (defcustom mark-diary-entries-in-calendar nil
168 "*Non-nil means mark dates with diary entries, in the calendar window.
169 The marking symbol is specified by the variable `diary-entry-marker'."
174 (defcustom calendar-remove-frame-by-deleting nil
175 "*Determine how the calendar mode removes a frame no longer needed.
176 If nil, make an icon of the frame. If non-nil, delete the frame."
180 (defvar diary-face
'diary
181 "Face name to use for diary entries.")
183 '((((min-colors 88) (class color
) (background light
))
185 (((class color
) (background light
))
187 (((min-colors 88) (class color
) (background dark
))
188 :foreground
"yellow1")
189 (((class color
) (background dark
))
190 :foreground
"yellow")
193 "Face for highlighting diary entries."
195 ;; backward-compatibility alias
196 (put 'diary-face
'face-alias
'diary
)
198 (defface calendar-today
199 '((t (:underline t
)))
200 "Face for indicating today's date."
202 ;; backward-compatibility alias
203 (put 'calendar-today-face
'face-alias
'calendar-today
)
206 '((((class color
) (background light
))
208 (((class color
) (background dark
))
209 :background
"chocolate4")
212 "Face for indicating dates that have holidays."
214 ;; backward-compatibility alias
215 (put 'holiday-face
'face-alias
'holiday
)
217 (eval-after-load "facemenu"
219 (add-to-list 'facemenu-unlisted-faces
'diary
)
220 (add-to-list 'facemenu-unlisted-faces
'calendar-today
)
221 (add-to-list 'facemenu-unlisted-faces
'holiday
)))
223 (defcustom diary-entry-marker
224 (if (not (display-color-p))
227 "*How to mark dates that have diary entries.
228 The value can be either a single-character string or a face."
229 :type
'(choice string face
)
232 (defcustom calendar-today-marker
233 (if (not (display-color-p))
236 "*How to mark today's date in the calendar.
237 The value can be either a single-character string or a face.
238 Marking today's date is done only if you set up `today-visible-calendar-hook'
240 :type
'(choice string face
)
243 (defcustom calendar-holiday-marker
244 (if (not (display-color-p))
247 "*How to mark notable dates in the calendar.
248 The value can be either a single-character string or a face."
249 :type
'(choice string face
)
253 (defcustom view-calendar-holidays-initially nil
254 "*Non-nil means display holidays for current three month period on entry.
255 The holidays are displayed in another window when the calendar is first
261 (defcustom mark-holidays-in-calendar nil
262 "*Non-nil means mark dates of holidays in the calendar window.
263 The marking symbol is specified by the variable `calendar-holiday-marker'."
268 (defcustom all-hebrew-calendar-holidays nil
269 "*If nil, show only major holidays from the Hebrew calendar.
270 This means only those Jewish holidays that appear on secular calendars.
272 If t, show all the holidays that would appear in a complete Hebrew calendar."
277 (defcustom all-christian-calendar-holidays nil
278 "*If nil, show only major holidays from the Christian calendar.
279 This means only those Christian holidays that appear on secular calendars.
281 If t, show all the holidays that would appear in a complete Christian
287 (defcustom all-islamic-calendar-holidays nil
288 "*If nil, show only major holidays from the Islamic calendar.
289 This means only those Islamic holidays that appear on secular calendars.
291 If t, show all the holidays that would appear in a complete Islamic
296 (defcustom diary-file-name-prefix-function
(function (lambda (str) str
))
297 "*The function that will take a diary file name and return the desired prefix."
302 (defcustom all-bahai-calendar-holidays nil
303 "*If nil, show only major holidays from the Baha'i calendar.
304 These are the days on which work and school must be suspended.
306 If t, show all the holidays that would appear in a complete Baha'i
312 (defcustom calendar-load-hook nil
313 "*List of functions to be called after the calendar is first loaded.
314 This is the place to add key bindings to `calendar-mode-map'."
316 :group
'calendar-hooks
)
319 (defcustom initial-calendar-window-hook nil
320 "*List of functions to be called when the calendar window is first opened.
321 The functions invoked are called after the calendar window is opened, but
322 once opened is never called again. Leaving the calendar with the `q' command
323 and reentering it will cause these functions to be called again."
325 :group
'calendar-hooks
)
328 (defcustom today-visible-calendar-hook nil
329 "*List of functions called whenever the current date is visible.
330 This can be used, for example, to replace today's date with asterisks; a
331 function `calendar-star-date' is included for this purpose:
332 (setq today-visible-calendar-hook 'calendar-star-date)
333 It can also be used to mark the current date with `calendar-today-marker';
334 a function is also provided for this:
335 (setq today-visible-calendar-hook 'calendar-mark-today)
337 The corresponding variable `today-invisible-calendar-hook' is the list of
338 functions called when the calendar function was called when the current
339 date is not visible in the window.
341 Other than the use of the provided functions, the changing of any
342 characters in the calendar buffer by the hooks may cause the failure of the
343 functions that move by days and weeks."
345 :group
'calendar-hooks
)
348 (defcustom today-invisible-calendar-hook nil
349 "*List of functions called whenever the current date is not visible.
351 The corresponding variable `today-visible-calendar-hook' is the list of
352 functions called when the calendar function was called when the current
353 date is visible in the window.
355 Other than the use of the provided functions, the changing of any
356 characters in the calendar buffer by the hooks may cause the failure of the
357 functions that move by days and weeks."
359 :group
'calendar-hooks
)
362 (defcustom calendar-move-hook nil
363 "*List of functions called whenever the cursor moves in the calendar.
367 (add-hook 'calendar-move-hook (lambda () (diary-view-entries 1)))
369 redisplays the diary for whatever date the cursor is moved to."
371 :group
'calendar-hooks
)
374 (defcustom diary-file
"~/diary"
375 "*Name of the file in which one's personal diary of dates is kept.
377 The file's entries are lines beginning with any of the forms
378 specified by the variable `american-date-diary-pattern', by default:
386 with the remainder of the line being the diary entry string for
387 that date. MONTH and DAY are one or two digit numbers, YEAR is a
388 number and may be written in full or abbreviated to the final two
389 digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME
390 and DAYNAME can be spelled in full (as specified by the variables
391 `calendar-month-name-array' and `calendar-day-name-array'),
392 abbreviated (as specified by `calendar-month-abbrev-array' and
393 `calendar-day-abbrev-array') with or without a period,
394 capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be
395 `*' which matches any day, month, or year, respectively. If the
396 date does not contain a year, it is generic and applies to any
397 year. A DAYNAME entry applies to the appropriate day of the week
400 The European style (in which the day precedes the month) can be
401 used instead, if you execute `european-calendar' when in the
402 calendar, or set `european-calendar-style' to t in your .emacs
403 file. The European forms (see `european-date-diary-pattern') are
411 To revert to the default American style from the European style, execute
412 `american-calendar' in the calendar.
414 A diary entry can be preceded by the character
415 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
416 nonmarking--that is, it will not be marked on dates in the calendar
417 window but will appear in a diary window.
419 Multiline diary entries are made by indenting lines after the first with
420 either a TAB or one or more spaces.
422 Lines not in one the above formats are ignored. Here are some sample diary
423 entries (in the default American style):
425 12/22/1988 Twentieth wedding anniversary!!
426 &1/1. Happy New Year!
427 10/22 Ruth's birthday.
429 Tuesday--weekly meeting with grad students at 10am
430 Supowit, Shen, Bitner, and Kapoor to attend.
431 1/13/89 Friday the thirteenth!!
432 &thu 4pm squash game with Lloyd.
433 mar 16 Dad's birthday
434 April 15, 1989 Income tax due.
435 &* 15 time cards due.
437 If the first line of a diary entry consists only of the date or day name with
438 no trailing blanks or punctuation, then that line is not displayed in the
439 diary window; only the continuation lines is shown. For example, the
443 Bill Blattner visits Princeton today
444 2pm Cognitive Studies Committee meeting
445 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
446 4:00pm Jamie Tappenden
447 7:30pm Dinner at George and Ed's for Alan Ryan
448 7:30-10:00pm dance at Stewart Country Day School
450 will appear in the diary window without the date line at the beginning. This
451 facility allows the diary window to look neater, but can cause confusion if
452 used with more than one day's entries displayed.
454 Diary entries can be based on Lisp sexps. For example, the diary entry
456 %%(diary-block 11 1 1990 11 10 1990) Vacation
458 causes the diary entry \"Vacation\" to appear from November 1 through
459 November 10, 1990. Other functions available are `diary-float',
460 `diary-anniversary', `diary-cyclic', `diary-day-of-year',
461 `diary-iso-date', `diary-french-date', `diary-hebrew-date',
462 `diary-islamic-date', `diary-bahai-date', `diary-mayan-date',
463 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
464 `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset',
465 `diary-phases-of-moon', `diary-parasha', `diary-omer',
466 `diary-rosh-hodesh', and `diary-sabbath-candles'. See the
467 documentation for the function `list-sexp-diary-entries' for more
470 Diary entries based on the Hebrew, the Islamic and/or the Baha'i
471 calendar are also possible, but because these are somewhat slow, they
472 are ignored unless you set the `nongregorian-diary-listing-hook' and
473 the `nongregorian-diary-marking-hook' appropriately. See the
474 documentation for these functions for details.
476 Diary files can contain directives to include the contents of other files; for
477 details, see the documentation for the variable `list-diary-entries-hook'."
482 (defcustom diary-nonmarking-symbol
"&"
483 "*Symbol indicating that a diary entry is not to be marked in the calendar."
488 (defcustom hebrew-diary-entry-symbol
"H"
489 "*Symbol indicating a diary entry according to the Hebrew calendar."
494 (defcustom islamic-diary-entry-symbol
"I"
495 "*Symbol indicating a diary entry according to the Islamic calendar."
500 (defcustom bahai-diary-entry-symbol
"B"
501 "*Symbol indicating a diary entry according to the Baha'i calendar."
506 (defcustom diary-include-string
"#include"
507 "*The string indicating inclusion of another file of diary entries.
508 See the documentation for the function `include-other-diary-files'."
512 (defcustom diary-glob-file-regexp-prefix
"^\\#"
513 "*The regular expression that gets pre-pended to each of the attribute-regexp's for file-wide specifiers."
517 (defcustom diary-face-attrs
518 '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string
)
519 (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string
)
520 (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol
)
521 (" *\\[height:\\([-0-9a-z]+\\)\\]$" 1 :height int
)
522 (" *\\[weight:\\([-a-z]+\\)\\]$" 1 :weight symbol
)
523 (" *\\[slant:\\([-a-z]+\\)\\]$" 1 :slant symbol
)
524 (" *\\[underline:\\([-a-z]+\\)\\]$" 1 :underline stringtnil
)
525 (" *\\[overline:\\([-a-z]+\\)\\]$" 1 :overline stringtnil
)
526 (" *\\[strike-through:\\([-a-z]+\\)\\]$" 1 :strike-through stringtnil
)
527 (" *\\[inverse-video:\\([-a-z]+\\)\\]$" 1 :inverse-video tnil
)
528 (" *\\[face:\\([-0-9a-z]+\\)\\]$" 1 :face string
)
529 (" *\\[font:\\([-a-z0-9]+\\)\\]$" 1 :font string
)
531 ;;; (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box)
532 ;;; (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple)
534 "*A list of (regexp regnum attr attrtype) lists where the
535 regexp says how to find the tag, the regnum says which
536 parenthetical sub-regexp this regexp looks for, and the attr says
537 which attribute of the face (or that this _is_ a face) is being
542 (defcustom diary-file-name-prefix nil
543 "If non-nil each diary entry is prefixed with the name of the file where it is defined."
548 (defcustom sexp-diary-entry-symbol
"%%"
549 "*The string used to indicate a sexp diary entry in `diary-file'.
550 See the documentation for the function `list-sexp-diary-entries'."
555 (defcustom abbreviated-calendar-year t
556 "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
557 For the Gregorian calendar; similarly for the Hebrew, Islamic and
558 Baha'i calendars. If this variable is nil, years must be written in
564 (defcustom european-calendar-style nil
565 "*Use the European style of dates in the diary and in any displays.
566 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
567 1990. The default European date styles (see `european-date-diary-pattern')
576 Names can be capitalized or not, written in full (as specified by the
577 variable `calendar-day-name-array'), or abbreviated (as specified by
578 `calendar-day-abbrev-array') with or without a period. To take effect,
579 this variable should be set before the calendar package and its associates
580 are loaded. Otherwise, use one of the functions `european-calendar' or
581 `american-calendar' to force the appropriate update."
586 (defcustom american-date-diary-pattern
587 '((month "/" day
"[^/0-9]")
588 (month "/" day
"/" year
"[^0-9]")
589 (monthname " *" day
"[^,0-9]")
590 (monthname " *" day
", *" year
"[^0-9]")
592 "*List of pseudo-patterns describing the American patterns of date used.
593 See the documentation of `diary-date-forms' for an explanation."
594 :type
'(repeat (choice (cons :tag
"Backup"
595 :value
(backup . nil
)
597 (repeat (list :inline t
:format
"%v"
598 (symbol :tag
"Keyword")
599 (choice symbol regexp
))))
600 (repeat (list :inline t
:format
"%v"
601 (symbol :tag
"Keyword")
602 (choice symbol regexp
)))))
606 (defcustom european-date-diary-pattern
607 '((day "/" month
"[^/0-9]")
608 (day "/" month
"/" year
"[^0-9]")
609 (backup day
" *" monthname
"\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
610 (day " *" monthname
" *" year
"[^0-9]")
612 "*List of pseudo-patterns describing the European patterns of date used.
613 See the documentation of `diary-date-forms' for an explanation."
614 :type
'(repeat (choice (cons :tag
"Backup"
615 :value
(backup . nil
)
617 (repeat (list :inline t
:format
"%v"
618 (symbol :tag
"Keyword")
619 (choice symbol regexp
))))
620 (repeat (list :inline t
:format
"%v"
621 (symbol :tag
"Keyword")
622 (choice symbol regexp
)))))
625 (defcustom diary-date-forms
626 (if european-calendar-style
627 european-date-diary-pattern
628 american-date-diary-pattern
)
629 "*List of pseudo-patterns describing the forms of date used in the diary.
630 The patterns on the list must be MUTUALLY EXCLUSIVE and should not match
631 any portion of the diary entry itself, just the date component.
633 A pseudo-pattern is a list of regular expressions and the keywords `month',
634 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
635 match the name of the month (see `calendar-month-name-array'), capitalized
636 or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'),
637 followed by a period or not; it will also match `*'. Similarly, `dayname'
638 will match the name of the day (see `calendar-day-name-array'), capitalized or
639 not, or its user-specified abbreviation (see `calendar-day-abbrev-array'),
640 followed by a period or not. The keywords `month', `day', and `year' will
641 match those numerical values, preceded by arbitrarily many zeros; they will
644 The matching of the diary entries with the date forms is done with the
645 standard syntax table from Fundamental mode, but with the `*' changed so
646 that it is a word constituent.
648 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
649 diary entry itself, the first element of the pattern MUST be `backup'. This
650 directive causes the date recognizer to back up to the beginning of the
651 current word of the diary entry, so in no case can the pattern match more than
652 a portion of the first word of the diary entry."
653 :type
'(repeat (choice (cons :tag
"Backup"
654 :value
(backup . nil
)
656 (repeat (list :inline t
:format
"%v"
657 (symbol :tag
"Keyword")
658 (choice symbol regexp
))))
659 (repeat (list :inline t
:format
"%v"
660 (symbol :tag
"Keyword")
661 (choice symbol regexp
)))))
665 (defcustom european-calendar-display-form
666 '((if dayname
(concat dayname
", ")) day
" " monthname
" " year
)
667 "*Pseudo-pattern governing the way a date appears in the European style.
668 See the documentation of `calendar-date-display-form' for an explanation."
673 (defcustom american-calendar-display-form
674 '((if dayname
(concat dayname
", ")) monthname
" " day
", " year
)
675 "*Pseudo-pattern governing the way a date appears in the American style.
676 See the documentation of `calendar-date-display-form' for an explanation."
680 (defcustom calendar-date-display-form
681 (if european-calendar-style
682 european-calendar-display-form
683 american-calendar-display-form
)
684 "*Pseudo-pattern governing the way a date appears.
686 Used by the function `calendar-date-string', a pseudo-pattern is a list of
687 expressions that can involve the keywords `month', `day', and `year', all
688 numbers in string form, and `monthname' and `dayname', both alphabetic
689 strings. For example, the ISO standard would use the pseudo- pattern
691 '(year \"-\" month \"-\" day)
693 while a typical American form would be
695 '(month \"/\" day \"/\" (substring year -2))
699 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
701 would give the usual American style in fixed-length fields.
703 See the documentation of the function `calendar-date-string'."
707 (defun european-calendar ()
708 "Set the interpretation and display of dates to the European style."
710 (setq european-calendar-style t
)
711 (setq calendar-date-display-form european-calendar-display-form
)
712 (setq diary-date-forms european-date-diary-pattern
)
713 (update-calendar-mode-line))
715 (defun american-calendar ()
716 "Set the interpretation and display of dates to the American style."
718 (setq european-calendar-style nil
)
719 (setq calendar-date-display-form american-calendar-display-form
)
720 (setq diary-date-forms american-date-diary-pattern
)
721 (update-calendar-mode-line))
724 (defcustom print-diary-entries-hook
'lpr-buffer
725 "*List of functions called after a temporary diary buffer is prepared.
726 The buffer shows only the diary entries currently visible in the diary
727 buffer. The default just does the printing. Other uses might include, for
728 example, rearranging the lines into order by day and time, saving the buffer
729 instead of deleting it, or changing the function used to do the printing."
734 (defcustom list-diary-entries-hook nil
735 "*List of functions called after diary file is culled for relevant entries.
736 It is to be used for diary entries that are not found in the diary file.
738 A function `include-other-diary-files' is provided for use as the value of
739 this hook. This function enables you to use shared diary files together
740 with your own. The files included are specified in the diary file by lines
743 #include \"filename\"
745 This is recursive; that is, #include directives in files thus included are
746 obeyed. You can change the \"#include\" to some other string by changing
747 the variable `diary-include-string'. When you use `include-other-diary-files'
748 as part of the list-diary-entries-hook, you will probably also want to use the
749 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
751 For example, you could use
753 (setq list-diary-entries-hook
754 '(include-other-diary-files sort-diary-entries))
755 (setq diary-display-hook 'fancy-diary-display)
757 in your `.emacs' file to cause the fancy diary buffer to be displayed with
758 diary entries from various included files, each day's entries sorted into
759 lexicographic order."
761 :options
'(include-other-diary-files sort-diary-entries
)
765 (defcustom diary-hook nil
766 "*List of functions called after the display of the diary.
767 Can be used for appointment notification."
772 (defcustom diary-display-hook nil
773 "*List of functions that handle the display of the diary.
774 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
777 Ordinarily, this just displays the diary buffer (with holidays indicated in
778 the mode line), if there are any relevant entries. At the time these
779 functions are called, the variable `diary-entries-list' is a list, in order
780 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
781 STRING), where string is the diary entry for the given date. This can be
782 used, for example, a different buffer for display (perhaps combined with
783 holidays), or produce hard copy output.
785 A function `fancy-diary-display' is provided as an alternative
786 choice for this hook; this function prepares a special noneditable diary
787 buffer with the relevant diary entries that has neat day-by-day arrangement
788 with headings. The fancy diary buffer will show the holidays unless the
789 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
790 diary buffer will not show days for which there are no diary entries, even
791 if that day is a holiday; if you want such days to be shown in the fancy
792 diary buffer, set the variable `diary-list-include-blanks' to t."
794 :options
'(fancy-diary-display)
798 (defcustom nongregorian-diary-listing-hook nil
799 "*List of functions called for listing diary file and included files.
800 As the files are processed for diary entries, these functions are used
801 to cull relevant entries. You can use either or both of
802 `list-hebrew-diary-entries', `list-islamic-diary-entries' and
803 `list-bahai-diary-entries'. The documentation for these functions
804 describes the style of such diary entries."
806 :options
'(list-hebrew-diary-entries
807 list-islamic-diary-entries
808 list-bahai-diary-entries
)
812 (defcustom mark-diary-entries-hook nil
813 "*List of functions called after marking diary entries in the calendar.
815 A function `mark-included-diary-files' is also provided for use as the
816 `mark-diary-entries-hook'; it enables you to use shared diary files together
817 with your own. The files included are specified in the diary file by lines
819 #include \"filename\"
820 This is recursive; that is, #include directives in files thus included are
821 obeyed. You can change the \"#include\" to some other string by changing the
822 variable `diary-include-string'. When you use `mark-included-diary-files' as
823 part of the mark-diary-entries-hook, you will probably also want to use the
824 function `include-other-diary-files' as part of `list-diary-entries-hook'."
826 :options
'(mark-included-diary-files)
830 (defcustom nongregorian-diary-marking-hook nil
831 "*List of functions called for marking diary file and included files.
832 As the files are processed for diary entries, these functions are used
833 to cull relevant entries. You can use either or both of
834 `mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
835 `mark-bahai-diary-entries'. The documentation for these functions
836 describes the style of such diary entries."
838 :options
'(mark-hebrew-diary-entries
839 mark-islamic-diary-entries
840 mark-bahai-diary-entries
)
844 (defcustom diary-list-include-blanks nil
845 "*If nil, do not include days with no diary entry in the list of diary entries.
846 Such days will then not be shown in the fancy diary buffer, even if they
852 (defcustom holidays-in-diary-buffer t
853 "*Non-nil means include holidays in the diary display.
854 The holidays appear in the mode line of the diary buffer, or in the
855 fancy diary buffer next to the date. This slows down the diary functions
856 somewhat; setting it to nil makes the diary display faster."
860 (defvar calendar-mark-ring nil
)
863 (put 'general-holidays
'risky-local-variable t
)
865 (defcustom general-holidays
866 '((holiday-fixed 1 1 "New Year's Day")
867 (holiday-float 1 1 3 "Martin Luther King Day")
868 (holiday-fixed 2 2 "Groundhog Day")
869 (holiday-fixed 2 14 "Valentine's Day")
870 (holiday-float 2 1 3 "President's Day")
871 (holiday-fixed 3 17 "St. Patrick's Day")
872 (holiday-fixed 4 1 "April Fools' Day")
873 (holiday-float 5 0 2 "Mother's Day")
874 (holiday-float 5 1 -
1 "Memorial Day")
875 (holiday-fixed 6 14 "Flag Day")
876 (holiday-float 6 0 3 "Father's Day")
877 (holiday-fixed 7 4 "Independence Day")
878 (holiday-float 9 1 1 "Labor Day")
879 (holiday-float 10 1 2 "Columbus Day")
880 (holiday-fixed 10 31 "Halloween")
881 (holiday-fixed 11 11 "Veteran's Day")
882 (holiday-float 11 4 4 "Thanksgiving"))
883 "*General holidays. Default value is for the United States.
884 See the documentation for `calendar-holidays' for details."
889 (put 'oriental-holidays
'risky-local-variable t
)
891 (defcustom oriental-holidays
892 '((if (fboundp 'atan
)
893 (holiday-chinese-new-year)))
895 See the documentation for `calendar-holidays' for details."
900 (put 'local-holidays
'risky-local-variable t
)
902 (defcustom local-holidays nil
904 See the documentation for `calendar-holidays' for details."
909 (put 'other-holidays
'risky-local-variable t
)
911 (defcustom other-holidays nil
912 "*User defined holidays.
913 See the documentation for `calendar-holidays' for details."
918 (put 'hebrew-holidays-1
'risky-local-variable t
)
920 (defvar hebrew-holidays-1
921 '((holiday-rosh-hashanah-etc)
922 (if all-hebrew-calendar-holidays
925 (let* ((m displayed-month
)
928 (increment-calendar-month m y -
1)
929 (let ((year (extract-calendar-year
930 (calendar-julian-from-absolute
931 (calendar-absolute-from-gregorian
933 (if (zerop (%
(1+ year
) 4))
935 21))) "\"Tal Umatar\" (evening)"))))
938 (put 'hebrew-holidays-2
'risky-local-variable t
)
940 (defvar hebrew-holidays-2
941 '((if all-hebrew-calendar-holidays
943 (holiday-hebrew 9 25 "Hanukkah"))
944 (if all-hebrew-calendar-holidays
947 (let ((h-year (extract-calendar-year
948 (calendar-hebrew-from-absolute
949 (calendar-absolute-from-gregorian
950 (list displayed-month
28 displayed-year
))))))
951 (if (= (%
(calendar-absolute-from-hebrew (list 10 10 h-year
))
956 (if all-hebrew-calendar-holidays
957 (holiday-hebrew 11 15 "Tu B'Shevat"))))
960 (put 'hebrew-holidays-3
'risky-local-variable t
)
962 (defvar hebrew-holidays-3
963 '((if all-hebrew-calendar-holidays
966 (let ((m displayed-month
)
968 (increment-calendar-month m y
1)
969 (let* ((h-year (extract-calendar-year
970 (calendar-hebrew-from-absolute
971 (calendar-absolute-from-gregorian
973 (calendar-last-day-of-month m y
)
976 (calendar-hebrew-from-absolute
978 (%
(calendar-absolute-from-hebrew
982 (calendar-dayname-on-or-before
983 6 (calendar-absolute-from-hebrew
984 (list 11 17 h-year
)))
985 (calendar-dayname-on-or-before
986 6 (calendar-absolute-from-hebrew
987 (list 11 16 h-year
))))))
988 (day (extract-calendar-day s-s
)))
993 (put 'hebrew-holidays-4
'risky-local-variable t
)
995 (defvar hebrew-holidays-4
996 '((holiday-passover-etc)
997 (if (and all-hebrew-calendar-holidays
998 (let* ((m displayed-month
)
1001 (increment-calendar-month m y -
1)
1002 (let ((year (extract-calendar-year
1003 (calendar-julian-from-absolute
1004 (calendar-absolute-from-gregorian
1006 (= 21 (% year
28)))))
1007 (holiday-julian 3 26 "Kiddush HaHamah"))
1008 (if all-hebrew-calendar-holidays
1009 (holiday-tisha-b-av-etc))))
1012 (put 'hebrew-holidays
'risky-local-variable t
)
1014 (defcustom hebrew-holidays
(append hebrew-holidays-1 hebrew-holidays-2
1015 hebrew-holidays-3 hebrew-holidays-4
)
1017 See the documentation for `calendar-holidays' for details."
1022 (put 'christian-holidays
'risky-local-variable t
)
1024 (defcustom christian-holidays
1025 '((if all-christian-calendar-holidays
1026 (holiday-fixed 1 6 "Epiphany"))
1027 (holiday-easter-etc 0 "Easter Sunday")
1028 (holiday-easter-etc -
2 "Good Friday")
1029 (holiday-easter-etc -
46 "Ash Wednesday")
1030 (if all-christian-calendar-holidays
1031 (holiday-easter-etc -
63 "Septuagesima Sunday"))
1032 (if all-christian-calendar-holidays
1033 (holiday-easter-etc -
56 "Sexagesima Sunday"))
1034 (if all-christian-calendar-holidays
1035 (holiday-easter-etc -
49 "Shrove Sunday"))
1036 (if all-christian-calendar-holidays
1037 (holiday-easter-etc -
48 "Shrove Monday"))
1038 (if all-christian-calendar-holidays
1039 (holiday-easter-etc -
47 "Shrove Tuesday"))
1040 (if all-christian-calendar-holidays
1041 (holiday-easter-etc -
14 "Passion Sunday"))
1042 (if all-christian-calendar-holidays
1043 (holiday-easter-etc -
7 "Palm Sunday"))
1044 (if all-christian-calendar-holidays
1045 (holiday-easter-etc -
3 "Maundy Thursday"))
1046 (if all-christian-calendar-holidays
1047 (holiday-easter-etc 35 "Rogation Sunday"))
1048 (if all-christian-calendar-holidays
1049 (holiday-easter-etc 39 "Ascension Day"))
1050 (if all-christian-calendar-holidays
1051 (holiday-easter-etc 49 "Pentecost (Whitsunday)"))
1052 (if all-christian-calendar-holidays
1053 (holiday-easter-etc 50 "Whitmonday"))
1054 (if all-christian-calendar-holidays
1055 (holiday-easter-etc 56 "Trinity Sunday"))
1056 (if all-christian-calendar-holidays
1057 (holiday-easter-etc 60 "Corpus Christi"))
1058 (if all-christian-calendar-holidays
1059 (holiday-greek-orthodox-easter))
1060 (if all-christian-calendar-holidays
1061 (holiday-fixed 8 15 "Assumption"))
1062 (if all-christian-calendar-holidays
1063 (holiday-advent 0 "Advent"))
1064 (holiday-fixed 12 25 "Christmas")
1065 (if all-christian-calendar-holidays
1066 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
1067 "*Christian holidays.
1068 See the documentation for `calendar-holidays' for details."
1073 (put 'islamic-holidays
'risky-local-variable t
)
1075 (defcustom islamic-holidays
1078 (format "Islamic New Year %d"
1079 (let ((m displayed-month
)
1081 (increment-calendar-month m y
1)
1082 (extract-calendar-year
1083 (calendar-islamic-from-absolute
1084 (calendar-absolute-from-gregorian
1086 m
(calendar-last-day-of-month m y
) y
)))))))
1087 (if all-islamic-calendar-holidays
1088 (holiday-islamic 1 10 "Ashura"))
1089 (if all-islamic-calendar-holidays
1090 (holiday-islamic 3 12 "Mulad-al-Nabi"))
1091 (if all-islamic-calendar-holidays
1092 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
1093 (if all-islamic-calendar-holidays
1094 (holiday-islamic 8 15 "Shab-e-Bara't"))
1095 (holiday-islamic 9 1 "Ramadan Begins")
1096 (if all-islamic-calendar-holidays
1097 (holiday-islamic 9 27 "Shab-e Qadr"))
1098 (if all-islamic-calendar-holidays
1099 (holiday-islamic 10 1 "Id-al-Fitr"))
1100 (if all-islamic-calendar-holidays
1101 (holiday-islamic 12 10 "Id-al-Adha")))
1103 See the documentation for `calendar-holidays' for details."
1108 (put 'bahai-holidays
'risky-local-variable t
)
1110 (defcustom bahai-holidays
1113 (format "Baha'i New Year (Naw-Ruz) %d" (- displayed-year
(1- 1844))))
1114 (holiday-fixed 4 21 "First Day of Ridvan")
1115 (if all-bahai-calendar-holidays
1116 (holiday-fixed 4 22 "Second Day of Ridvan"))
1117 (if all-bahai-calendar-holidays
1118 (holiday-fixed 4 23 "Third Day of Ridvan"))
1119 (if all-bahai-calendar-holidays
1120 (holiday-fixed 4 24 "Fourth Day of Ridvan"))
1121 (if all-bahai-calendar-holidays
1122 (holiday-fixed 4 25 "Fifth Day of Ridvan"))
1123 (if all-bahai-calendar-holidays
1124 (holiday-fixed 4 26 "Sixth Day of Ridvan"))
1125 (if all-bahai-calendar-holidays
1126 (holiday-fixed 4 27 "Seventh Day of Ridvan"))
1127 (if all-bahai-calendar-holidays
1128 (holiday-fixed 4 28 "Eighth Day of Ridvan"))
1129 (holiday-fixed 4 29 "Ninth Day of Ridvan")
1130 (if all-bahai-calendar-holidays
1131 (holiday-fixed 4 30 "Tenth Day of Ridvan"))
1132 (if all-bahai-calendar-holidays
1133 (holiday-fixed 5 1 "Eleventh Day of Ridvan"))
1134 (holiday-fixed 5 2 "Twelfth Day of Ridvan")
1135 (holiday-fixed 5 23 "Declaration of the Bab")
1136 (holiday-fixed 5 29 "Ascension of Baha'u'llah")
1137 (holiday-fixed 7 9 "Martyrdom of the Bab")
1138 (holiday-fixed 10 20 "Birth of the Bab")
1139 (holiday-fixed 11 12 "Birth of Baha'u'llah")
1140 (if all-bahai-calendar-holidays
1141 (holiday-fixed 11 26 "Day of the Covenant"))
1142 (if all-bahai-calendar-holidays
1143 (holiday-fixed 11 28 "Ascension of `Abdu'l-Baha")))
1145 See the documentation for `calendar-holidays' for details."
1150 (put 'solar-holidays
'risky-local-variable t
)
1152 (defcustom solar-holidays
1153 '((if (fboundp 'atan
)
1154 (solar-equinoxes-solstices))
1160 calendar-daylight-savings-starts
1161 '(format "Daylight Savings Time Begins %s"
1164 (/ calendar-daylight-savings-starts-time
(float 60))
1165 calendar-standard-time-zone-name
)
1169 calendar-daylight-savings-ends
1170 '(format "Daylight Savings Time Ends %s"
1173 (/ calendar-daylight-savings-ends-time
(float 60))
1174 calendar-daylight-time-zone-name
)
1176 "*Sun-related holidays.
1177 See the documentation for `calendar-holidays' for details."
1182 (put 'calendar-holidays
'risky-local-variable t
)
1183 (defcustom calendar-holidays
1184 (append general-holidays local-holidays other-holidays
1185 christian-holidays hebrew-holidays islamic-holidays
1186 bahai-holidays oriental-holidays solar-holidays
)
1187 "*List of notable days for the command \\[holidays].
1189 Additional holidays are easy to add to the list, just put them in the
1190 list `other-holidays' in your .emacs file. Similarly, by setting any
1191 of `general-holidays', `local-holidays' `christian-holidays',
1192 `hebrew-holidays', `islamic-holidays', `bahai-holidays',
1193 `oriental-holidays', or `solar-holidays' to nil in your .emacs file,
1194 you can eliminate unwanted categories of holidays. The intention is
1195 that (in the US) `local-holidays' be set in site-init.el and
1196 `other-holidays' be set by the user.
1198 Entries on the list are expressions that return (possibly empty) lists of
1199 items of the form ((month day year) string) of a holiday in the in the
1200 three-month period centered around `displayed-month' of `displayed-year'.
1201 Several basic functions are provided for this purpose:
1203 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1204 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1205 MONTH on the Gregorian calendar (0 for Sunday,
1206 etc.); K<0 means count back from the end of the
1207 month. An optional parameter DAY means the Kth
1208 DAYNAME after/before MONTH DAY.
1209 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1210 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1211 (holiday-bahai MONTH DAY STRING) a fixed date on the Baha'i calendar
1212 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1213 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
1214 in the variable `year'; if it evaluates to
1215 a visible date, that's the holiday; if it
1216 evaluates to nil, there's no holiday. STRING
1217 is an expression in the variable `date'.
1219 For example, to add Bastille Day, celebrated in France on July 14, add
1221 (holiday-fixed 7 14 \"Bastille Day\")
1223 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1224 Islands on the fourth Monday in August, add
1226 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
1228 to the list (the last Monday would be specified with `-1' instead of `4').
1229 To add the last day of Hanukkah to the list, use
1231 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
1233 since the Hebrew months are numbered with 1 starting from Nisan, while to
1234 add the Islamic feast celebrating Mohammed's birthday use
1236 (holiday-islamic 3 12 \"Mohammed's Birthday\")
1238 since the Islamic months are numbered from 1 starting with Muharram. To
1239 add an entry for the Baha'i festival of Ridvan, use
1241 (holiday-bahai 2 13 \"Festival of Ridvan\")
1243 since the Baha'i months are numbered from 1 starting with Baha. To
1244 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1246 (holiday-julian 4 2 \"Jefferson's Birthday\")
1248 To include a holiday conditionally, use the sexp form or a conditional. For
1249 example, to include American presidential elections, which occur on the first
1250 Tuesday after the first Monday in November of years divisible by 4, add
1253 '(if (zerop (% year 4))
1254 (calendar-gregorian-from-absolute
1255 (1+ (calendar-dayname-on-or-before
1256 1 (+ 6 (calendar-absolute-from-gregorian
1257 (list 11 1 year)))))))
1258 \"US Presidential Election\")
1262 (if (zerop (% displayed-year 4))
1264 (extract-calendar-day
1265 (calendar-gregorian-from-absolute
1266 (1+ (calendar-dayname-on-or-before
1267 1 (+ 6 (calendar-absolute-from-gregorian
1268 (list 11 1 displayed-year)))))))
1269 \"US Presidential Election\"))
1271 to the list. To include the phases of the moon, add
1275 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1276 you've written to return a (possibly empty) list of the relevant VISIBLE dates
1277 with descriptive strings such as
1279 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
1283 (defconst holiday-buffer
"*Holidays*"
1284 "Name of the buffer used for the displaying the holidays.")
1286 (defconst fancy-diary-buffer
"*Fancy Diary Entries*"
1287 "Name of the buffer used for the optional fancy display of the diary.")
1289 (defconst other-calendars-buffer
"*Other Calendars*"
1290 "Name of the buffer used for the display of date on other calendars.")
1292 (defconst lunar-phases-buffer
"*Phases of Moon*"
1293 "Name of the buffer used for the lunar phases.")
1295 (defmacro increment-calendar-month
(mon yr n
)
1296 "Increment the variables MON and YR by N months.
1297 Forward if N is positive or backward if N is negative.
1298 A negative YR is interpreted as BC; -1 being 1 BC, and so on."
1300 (if (< ,yr
0) (setq ,yr
(1+ ,yr
))) ; -1 BC -> 0 AD, etc
1301 (setq macro-y
(+ (* ,yr
12) ,mon -
1 ,n
)
1302 ,mon
(1+ (mod macro-y
12))
1304 (and (< macro-y
0) (> ,mon
1) (setq ,yr
(1- ,yr
)))
1305 (if (< ,yr
1) (setq ,yr
(1- ,yr
))))) ; 0 AD -> -1 BC, etc
1307 (defmacro calendar-for-loop
(var from init to final do
&rest body
)
1308 "Execute a for loop."
1309 (declare (debug (symbolp "from" form
"to" form
"do" body
)))
1310 `(let ((,var
(1- ,init
)))
1311 (while (>= ,final
(setq ,var
(1+ ,var
)))
1314 (defmacro calendar-sum
(index initial condition expression
)
1315 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
1316 `(let ((,index
,initial
)
1319 (setq sum
(+ sum
,expression
))
1320 (setq ,index
(1+ ,index
)))
1323 ;; The following are in-line for speed; they can be called thousands of times
1324 ;; when looking up holidays or processing the diary. Here, for example, are
1325 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1326 ;; fancy diary display, for a moderately complex diary file, with functions
1327 ;; used instead of macros. There were a total of 10000 such calls:
1329 ;; 1934 extract-calendar-month
1330 ;; 1852 extract-calendar-year
1331 ;; 1819 extract-calendar-day
1332 ;; 845 calendar-leap-year-p
1333 ;; 837 calendar-day-number
1334 ;; 775 calendar-absolute-from-gregorian
1335 ;; 346 calendar-last-day-of-month
1336 ;; 286 hebrew-calendar-last-day-of-month
1337 ;; 188 hebrew-calendar-leap-year-p
1338 ;; 180 hebrew-calendar-elapsed-days
1339 ;; 163 hebrew-calendar-last-month-of-year
1340 ;; 66 calendar-date-compare
1341 ;; 65 hebrew-calendar-days-in-year
1342 ;; 60 calendar-absolute-from-julian
1343 ;; 50 calendar-absolute-from-hebrew
1344 ;; 43 calendar-date-equal
1345 ;; 38 calendar-gregorian-from-absolute
1350 ;; The use of these seven macros eliminates the overhead of 92% of the function
1351 ;; calls; it's faster this way.
1353 (defsubst extract-calendar-month
(date)
1354 "Extract the month part of DATE which has the form (month day year)."
1357 (defsubst extract-calendar-day
(date)
1358 "Extract the day part of DATE which has the form (month day year)."
1361 (defsubst extract-calendar-year
(date)
1362 "Extract the year part of DATE which has the form (month day year)."
1363 (car (cdr (cdr date
))))
1365 (defsubst calendar-leap-year-p
(year)
1366 "Return t if YEAR is a Gregorian leap year.
1367 A negative year is interpreted as BC; -1 being 1 BC, and so on."
1368 ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc.
1369 (if (< year
0) (setq year
(1- (abs year
))))
1370 (and (zerop (% year
4))
1371 (or (not (zerop (% year
100)))
1372 (zerop (% year
400)))))
1374 ;; The foregoing is a bit faster, but not as clear as the following:
1376 ;;(defsubst calendar-leap-year-p (year)
1377 ;; "Returns t if YEAR is a Gregorian leap year."
1379 ;; (and (= (% year 4) 0)
1380 ;; (/= (% year 100) 0))
1381 ;; (= (% year 400) 0)))
1383 (defsubst calendar-last-day-of-month
(month year
)
1384 "The last day in MONTH during YEAR."
1385 (if (and (= month
2) (calendar-leap-year-p year
))
1387 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month
))))
1389 ;; An explanation of the calculation can be found in PascAlgorithms by
1390 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1392 (defsubst calendar-day-number
(date)
1393 "Return the day number within the year of the date DATE.
1394 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1395 while (calendar-day-number '(12 31 1980)) returns 366."
1396 (let* ((month (extract-calendar-month date
))
1397 (day (extract-calendar-day date
))
1398 (year (extract-calendar-year date
))
1399 (day-of-year (+ day
(* 31 (1- month
)))))
1402 (setq day-of-year
(- day-of-year
(/ (+ 23 (* 4 month
)) 10)))
1403 (if (calendar-leap-year-p year
)
1404 (setq day-of-year
(1+ day-of-year
)))))
1407 (defsubst calendar-absolute-from-gregorian
(date)
1408 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1409 The Gregorian date Sunday, December 31, 1 BC is imaginary.
1410 DATE is a list of the form (month day year). A negative year is
1411 interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC
1412 return negative results."
1413 (let ((year (extract-calendar-year date
))
1416 (error "There was no year zero"))
1418 (setq offset-years
(1- year
))
1419 (+ (calendar-day-number date
) ; Days this year
1420 (* 365 offset-years
) ; + Days in prior years
1421 (/ offset-years
4) ; + Julian leap years
1422 (- (/ offset-years
100)) ; - century years
1423 (/ offset-years
400))) ; + Gregorian leap years
1425 ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc).
1426 (setq offset-years
(abs (1+ year
)))
1427 (- (calendar-day-number date
)
1428 (* 365 offset-years
)
1430 (- (/ offset-years
100))
1431 (/ offset-years
400)
1432 (calendar-day-number '(12 31 -
1))))))) ; days in year 1 BC
1434 (autoload 'calendar-goto-today
"cal-move"
1435 "Reposition the calendar window so the current date is visible."
1438 (autoload 'calendar-forward-month
"cal-move"
1439 "Move the cursor forward ARG months."
1442 (autoload 'calendar-forward-year
"cal-move"
1443 "Move the cursor forward by ARG years."
1446 (autoload 'calendar-backward-month
"cal-move"
1447 "Move the cursor backward by ARG months."
1450 (autoload 'calendar-backward-year
"cal-move"
1451 "Move the cursor backward ARG years."
1454 (autoload 'scroll-calendar-left
"cal-move"
1455 "Scroll the displayed calendar left by ARG months."
1458 (autoload 'scroll-calendar-right
"cal-move"
1459 "Scroll the displayed calendar window right by ARG months."
1462 (autoload 'scroll-calendar-left-three-months
"cal-move"
1463 "Scroll the displayed calendar window left by 3*ARG months."
1466 (autoload 'scroll-calendar-right-three-months
"cal-move"
1467 "Scroll the displayed calendar window right by 3*ARG months."
1470 (autoload 'calendar-cursor-to-nearest-date
"cal-move"
1471 "Move the cursor to the closest date."
1474 (autoload 'calendar-forward-day
"cal-move"
1475 "Move the cursor forward ARG days."
1478 (autoload 'calendar-backward-day
"cal-move"
1479 "Move the cursor back ARG days."
1482 (autoload 'calendar-forward-week
"cal-move"
1483 "Move the cursor forward ARG weeks."
1486 (autoload 'calendar-backward-week
"cal-move"
1487 "Move the cursor back ARG weeks."
1490 (autoload 'calendar-beginning-of-week
"cal-move"
1491 "Move the cursor back ARG calendar-week-start-day's."
1494 (autoload 'calendar-end-of-week
"cal-move"
1495 "Move the cursor forward ARG calendar-week-start-day+6's."
1498 (autoload 'calendar-beginning-of-month
"cal-move"
1499 "Move the cursor backward ARG month beginnings."
1502 (autoload 'calendar-end-of-month
"cal-move"
1503 "Move the cursor forward ARG month ends."
1506 (autoload 'calendar-beginning-of-year
"cal-move"
1507 "Move the cursor backward ARG year beginnings."
1510 (autoload 'calendar-end-of-year
"cal-move"
1511 "Move the cursor forward ARG year beginnings."
1514 (autoload 'calendar-cursor-to-visible-date
"cal-move"
1515 "Move the cursor to DATE that is on the screen."
1518 (autoload 'calendar-goto-date
"cal-move"
1519 "Move cursor to DATE."
1522 (autoload 'calendar-goto-day-of-year
"cal-move"
1523 "Move cursor to day of year."
1526 (autoload 'calendar-only-one-frame-setup
"cal-x"
1527 "Start calendar and display it in a dedicated frame.")
1529 (autoload 'calendar-one-frame-setup
"cal-x"
1530 "Start calendar and display it in a dedicated frame together with the diary.")
1532 (autoload 'calendar-two-frame-setup
"cal-x"
1533 "Start calendar and diary in separate, dedicated frames.")
1536 (defcustom calendar-setup nil
1537 "The frame setup of the calendar.
1538 The choices are: `one-frame' (calendar and diary together in one separate,
1539 dedicated frame); `two-frames' (calendar and diary in separate, dedicated
1540 frames); `calendar-only' (calendar in a separate, dedicated frame); with
1541 any other value the current frame is used. Using any of the first
1542 three options overrides the value of `view-diary-entries-initially'."
1544 (const :tag
"calendar and diary in separate frame" one-frame
)
1545 (const :tag
"calendar and diary each in own frame" two-frames
)
1546 (const :tag
"calendar in separate frame" calendar-only
)
1547 (const :tag
"use current frame" nil
))
1550 (defcustom calendar-minimum-window-height
8
1551 "Minimum height `generate-calendar-window' should use for calendar window."
1557 (defun calendar (&optional arg
)
1558 "Choose between the one frame, two frame, or basic calendar displays.
1559 If called with an optional prefix argument, prompts for month and year.
1561 The original function `calendar' has been renamed `calendar-basic-setup'.
1562 See the documentation of that function for more information."
1564 (cond ((equal calendar-setup
'one-frame
) (calendar-one-frame-setup arg
))
1565 ((equal calendar-setup
'two-frames
) (calendar-two-frame-setup arg
))
1566 ((equal calendar-setup
'calendar-only
)
1567 (calendar-only-one-frame-setup arg
))
1568 (t (calendar-basic-setup arg
))))
1570 (defun calendar-basic-setup (&optional arg
)
1571 "Display a three-month calendar in another window.
1572 The three months appear side by side, with the current month in the middle
1573 surrounded by the previous and next months. The cursor is put on today's date.
1575 If called with an optional prefix argument, prompts for month and year.
1577 This function is suitable for execution in a .emacs file; appropriate setting
1578 of the variable `view-diary-entries-initially' will cause the diary entries for
1579 the current date to be displayed in another window. The value of the variable
1580 `number-of-diary-entries' controls the number of days of diary entries
1581 displayed upon initial display of the calendar.
1583 Once in the calendar window, future or past months can be moved into view.
1584 Arbitrary months can be displayed, or the calendar can be scrolled forward
1587 The cursor can be moved forward or backward by one day, one week, one month,
1588 or one year. All of these commands take prefix arguments which, when negative,
1589 cause movement in the opposite direction. For convenience, the digit keys
1590 and the minus sign are automatically prefixes. The window is replotted as
1591 necessary to display the desired date.
1593 Diary entries can be marked on the calendar or displayed in another window.
1595 Use \\[describe-mode] for details of the key bindings in the calendar window.
1597 The Gregorian calendar is assumed.
1599 After loading the calendar, the hooks given by the variable
1600 `calendar-load-hook' are run. This is the place to add key bindings to the
1603 After preparing the calendar window initially, the hooks given by the variable
1604 `initial-calendar-window-hook' are run.
1606 The hooks given by the variable `today-visible-calendar-hook' are run
1607 every time the calendar window gets scrolled, if the current date is visible
1608 in the window. If it is not visible, the hooks given by the variable
1609 `today-invisible-calendar-hook' are run. Thus, for example, setting
1610 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1611 to be replaced by asterisks to highlight it whenever it is in the window."
1613 (set-buffer (get-buffer-create calendar-buffer
))
1615 (let* ((pop-up-windows t
)
1616 (split-height-threshold 1000)
1618 (calendar-read-date t
)
1619 (calendar-current-date)))
1620 (month (extract-calendar-month date
))
1621 (year (extract-calendar-year date
)))
1622 (pop-to-buffer calendar-buffer
)
1623 (increment-calendar-month month year
(- calendar-offset
))
1624 (generate-calendar-window month year
)
1625 (if (and view-diary-entries-initially
(calendar-date-is-visible-p date
))
1626 (diary-view-entries)))
1627 (let* ((diary-buffer (get-file-buffer diary-file
))
1628 (diary-window (if diary-buffer
(get-buffer-window diary-buffer
)))
1629 (split-height-threshold (if diary-window
2 1000)))
1630 (if view-calendar-holidays-initially
1631 (list-calendar-holidays)))
1632 (run-hooks 'initial-calendar-window-hook
))
1634 (autoload 'diary-view-entries
"diary-lib"
1635 "Prepare and display a buffer with diary entries.
1636 Searches your diary file for entries that match ARG days starting with
1637 the date indicated by the cursor position in the displayed three-month
1641 (autoload 'view-other-diary-entries
"diary-lib"
1642 "Prepare and display buffer of diary entries from an alternative diary file.
1643 Searches for entries that match ARG days, starting with the date indicated
1644 by the cursor position in the displayed three-month calendar.
1645 D-FILE specifies the file to use as the diary file."
1648 (autoload 'calendar-sunrise-sunset
"solar"
1649 "Local time of sunrise and sunset for date under cursor."
1652 (autoload 'calendar-phases-of-moon
"lunar"
1653 "Create a buffer of the phases of the moon for the current calendar window."
1656 (autoload 'calendar-print-french-date
"cal-french"
1657 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1660 (autoload 'calendar-goto-french-date
"cal-french"
1661 "Move cursor to French Revolutionary date."
1664 (autoload 'calendar-french-date-string
"cal-french"
1665 "String of French Revolutionary date of Gregorian date."
1668 (autoload 'calendar-mayan-date-string
"cal-mayan"
1669 "String of Mayan date of Gregorian date."
1672 (autoload 'calendar-print-mayan-date
"cal-mayan"
1673 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1676 (autoload 'calendar-goto-mayan-long-count-date
"cal-mayan"
1677 "Move cursor to Mayan long count date."
1680 (autoload 'calendar-next-haab-date
"cal-mayan"
1681 "Move cursor to next instance of Mayan Haab date."
1684 (autoload 'calendar-previous-haab-date
"cal-mayan"
1685 "Move cursor to previous instance of Mayan Haab date."
1688 (autoload 'calendar-next-tzolkin-date
"cal-mayan"
1689 "Move cursor to next instance of Mayan Tzolkin date."
1692 (autoload 'calendar-previous-tzolkin-date
"cal-mayan"
1693 "Move cursor to previous instance of Mayan Tzolkin date."
1696 (autoload 'calendar-next-calendar-round-date
"cal-mayan"
1697 "Move cursor to next instance of Mayan Haab/Tzolkin combination."
1700 (autoload 'calendar-previous-calendar-round-date
"cal-mayan"
1701 "Move cursor to previous instance of Mayan Haab/Tzolkin combination."
1704 (autoload 'calendar-goto-chinese-date
"cal-china"
1705 "Move cursor to Chinese date."
1708 (autoload 'calendar-print-chinese-date
"cal-china"
1709 "Show the Chinese date equivalents of date."
1712 (autoload 'calendar-chinese-date-string
"cal-china"
1713 "String of Chinese date of Gregorian date."
1716 (autoload 'calendar-absolute-from-astro
"cal-julian"
1717 "Absolute date of astronomical (Julian) day number D."
1720 (autoload 'calendar-astro-from-absolute
"cal-julian"
1721 "Astronomical (Julian) day number of absolute date D.")
1723 (autoload 'calendar-astro-date-string
"cal-julian"
1724 "String of astronomical (Julian) day number of Gregorian date."
1727 (autoload 'calendar-goto-astro-day-number
"cal-julian"
1728 "Move cursor to astronomical (Julian) day number."
1731 (autoload 'calendar-print-astro-day-number
"cal-julian"
1732 "Show the astro date equivalents of date."
1735 (autoload 'calendar-julian-from-absolute
"cal-julian"
1736 "Compute the Julian (month day year) corresponding to the absolute DATE.
1737 The absolute date is the number of days elapsed since the (imaginary)
1738 Gregorian date Sunday, December 31, 1 BC.")
1740 (autoload 'calendar-goto-julian-date
"cal-julian"
1741 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1744 (autoload 'calendar-print-julian-date
"cal-julian"
1745 "Show the Julian calendar equivalent of the date under the cursor."
1748 (autoload 'calendar-julian-date-string
"cal-julian"
1749 "String of Julian date of Gregorian DATE.
1750 Defaults to today's date if DATE is not given.
1751 Driven by the variable `calendar-date-display-form'.")
1753 (autoload 'calendar-goto-iso-date
"cal-iso"
1754 "Move cursor to ISO date."
1757 (autoload 'calendar-goto-iso-week
"cal-iso"
1758 "Move cursor to start of ISO week."
1761 (autoload 'calendar-print-iso-date
"cal-iso"
1762 "Show the ISO date equivalents of date."
1765 (autoload 'calendar-iso-date-string
"cal-iso"
1766 "String of ISO date of Gregorian date."
1769 (autoload 'calendar-goto-islamic-date
"cal-islam"
1770 "Move cursor to Islamic date."
1773 (autoload 'calendar-print-islamic-date
"cal-islam"
1774 "Show the Islamic date equivalents of date."
1777 (autoload 'calendar-islamic-date-string
"cal-islam"
1778 "String of Islamic date of Gregorian date."
1781 (autoload 'calendar-print-bahai-date
"cal-bahai"
1782 "Show the Baha'i date equivalents of date."
1785 (autoload 'calendar-bahai-date-string
"cal-bahai"
1786 "String of Baha'i date of Gregorian date."
1789 (autoload 'calendar-goto-hebrew-date
"cal-hebrew"
1790 "Move cursor to Hebrew date."
1793 (autoload 'calendar-print-hebrew-date
"cal-hebrew"
1794 "Show the Hebrew date equivalents of date."
1797 (autoload 'calendar-hebrew-date-string
"cal-hebrew"
1798 "String of Hebrew date of Gregorian date."
1801 (autoload 'calendar-goto-coptic-date
"cal-coptic"
1802 "Move cursor to Coptic date."
1805 (autoload 'calendar-print-coptic-date
"cal-coptic"
1806 "Show the Coptic date equivalents of date."
1809 (autoload 'calendar-coptic-date-string
"cal-coptic"
1810 "String of Coptic date of Gregorian date."
1813 (autoload 'calendar-goto-ethiopic-date
"cal-coptic"
1814 "Move cursor to Ethiopic date."
1817 (autoload 'calendar-print-ethiopic-date
"cal-coptic"
1818 "Show the Ethiopic date equivalents of date."
1821 (autoload 'calendar-ethiopic-date-string
"cal-coptic"
1822 "String of Ethiopic date of Gregorian date."
1825 (autoload 'calendar-goto-persian-date
"cal-persia"
1826 "Move cursor to Persian date."
1829 (autoload 'calendar-print-persian-date
"cal-persia"
1830 "Show the Persian date equivalents of date."
1833 (autoload 'calendar-persian-date-string
"cal-persia"
1834 "String of Persian date of Gregorian date."
1837 (autoload 'show-all-diary-entries
"diary-lib"
1838 "Show all of the diary entries in the diary file.
1839 This function gets rid of the selective display of the diary file so that
1840 all entries, not just some, are visible. If there is no diary buffer, one
1844 (autoload 'mark-diary-entries
"diary-lib"
1845 "Mark days in the calendar window that have diary entries.
1846 Each entry in diary file visible in the calendar window is marked."
1849 (autoload 'make-diary-entry
"diary-lib"
1850 "Insert a diary entry STRING which may be NONMARKING in FILE."
1853 (autoload 'insert-diary-entry
"diary-lib"
1854 "Insert a diary entry for the date indicated by point."
1857 (autoload 'insert-weekly-diary-entry
"diary-lib"
1858 "Insert a weekly diary entry for the day of the week indicated by point."
1862 (autoload 'insert-monthly-diary-entry
"diary-lib"
1863 "Insert a monthly diary entry for the day of the month indicated by point."
1866 (autoload 'insert-yearly-diary-entry
"diary-lib"
1867 "Insert an annual diary entry for the day of the year indicated by point."
1870 (autoload 'insert-anniversary-diary-entry
"diary-lib"
1871 "Insert an anniversary diary entry for the date indicated by point."
1874 (autoload 'insert-block-diary-entry
"diary-lib"
1875 "Insert a block diary entry for the dates indicated by point and mark."
1878 (autoload 'insert-cyclic-diary-entry
"diary-lib"
1879 "Insert a cyclic diary entry starting at the date indicated by point."
1882 (autoload 'insert-hebrew-diary-entry
"cal-hebrew"
1883 "Insert a diary entry for the Hebrew date corresponding to the date
1884 indicated by point."
1887 (autoload 'insert-monthly-hebrew-diary-entry
"cal-hebrew"
1888 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1889 to the date indicated by point."
1892 (autoload 'insert-yearly-hebrew-diary-entry
"cal-hebrew"
1893 "Insert an annual diary entry for the day of the Hebrew year corresponding
1894 to the date indicated by point."
1897 (autoload 'insert-islamic-diary-entry
"cal-islam"
1898 "Insert a diary entry for the Islamic date corresponding to the date
1899 indicated by point."
1902 (autoload 'insert-monthly-islamic-diary-entry
"cal-islam"
1903 "Insert a monthly diary entry for the day of the Islamic month corresponding
1904 to the date indicated by point."
1907 (autoload 'insert-yearly-islamic-diary-entry
"cal-islam"
1908 "Insert an annual diary entry for the day of the Islamic year corresponding
1909 to the date indicated by point."
1912 (autoload 'insert-bahai-diary-entry
"cal-bahai"
1913 "Insert a diary entry for the Baha'i date corresponding to the date
1914 indicated by point."
1917 (autoload 'insert-monthly-bahai-diary-entry
"cal-bahai"
1918 "Insert a monthly diary entry for the day of the Baha'i month corresponding
1919 to the date indicated by point."
1922 (autoload 'insert-yearly-bahai-diary-entry
"cal-bahai"
1923 "Insert an annual diary entry for the day of the Baha'i year corresponding
1924 to the date indicated by point."
1927 (autoload 'list-calendar-holidays
"holidays"
1928 "Create a buffer containing the holidays for the current calendar window.
1929 The holidays are those in the list `calendar-notable-days'. Returns t if any
1930 holidays are found, nil if not."
1933 (autoload 'cal-tex-cursor-month
"cal-tex"
1934 "Make a buffer with LaTeX commands for the month cursor is on.
1935 Optional prefix argument specifies number of months to be produced.
1936 Calendar is condensed onto one page.")
1938 (autoload 'cal-tex-cursor-month-landscape
"cal-tex"
1939 "Make a buffer with LaTeX commands for the month cursor is on.
1940 Optional prefix argument specifies number of months to be produced.")
1942 (autoload 'cal-tex-cursor-day
"cal-tex"
1943 "Make a buffer with LaTeX commands for the day cursor is on.")
1945 (autoload 'cal-tex-cursor-week
"cal-tex"
1946 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1947 It applies to the week that point is in.
1948 Optional prefix argument specifies number of weeks.
1949 Holidays are included if `cal-tex-holidays' is t.")
1951 (autoload 'cal-tex-cursor-week2
"cal-tex"
1952 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1953 It applies to the week that point is in.
1954 Optional prefix argument specifies number of weeks.
1955 Holidays are included if `cal-tex-holidays' is t.")
1957 (autoload 'cal-tex-cursor-week-iso
"cal-tex"
1958 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
1959 Optional prefix argument specifies number of weeks.
1960 Diary entries are included if `cal-tex-diary' is t.
1961 Holidays are included if `cal-tex-holidays' is t.")
1963 (autoload 'cal-tex-cursor-week-monday
"cal-tex"
1964 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1965 It applies to the week that point is in, and starts on Monday.
1966 Optional prefix argument specifies number of weeks.
1967 Holidays are included if `cal-tex-holidays' is t.")
1969 (autoload 'cal-tex-cursor-filofax-2week
"cal-tex"
1970 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
1971 Optional prefix argument specifies number of weeks.
1972 Diary entries are included if cal-tex-diary is t.
1973 Holidays are included if `cal-tex-holidays' is t.")
1975 (autoload 'cal-tex-cursor-filofax-week
"cal-tex"
1976 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
1977 Optional prefix argument specifies number of weeks.
1978 Weeks start on Monday.
1979 Diary entries are included if cal-tex-diary is t.
1980 Holidays are included if `cal-tex-holidays' is t.")
1982 (autoload 'cal-tex-cursor-filofax-daily
"cal-tex"
1983 "Day-per-page Filofax style calendar for week indicated by cursor.
1984 Optional prefix argument specifies number of weeks. Weeks start on Monday.
1985 Diary entries are included if `cal-tex-diary' is t.
1986 Holidays are included if `cal-tex-holidays' is t.")
1988 (autoload 'cal-tex-cursor-year
"cal-tex"
1989 "Make a buffer with LaTeX commands for a year's calendar.
1990 Optional prefix argument specifies number of years.")
1992 (autoload 'cal-tex-cursor-year-landscape
"cal-tex"
1993 "Make a buffer with LaTeX commands for a year's calendar (landscape).
1994 Optional prefix argument specifies number of years.")
1996 (autoload 'cal-tex-cursor-filofax-year
"cal-tex"
1997 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
1998 Optional prefix argument specifies number of years.")
2000 (autoload 'mark-calendar-holidays
"holidays"
2001 "Mark notable days in the calendar window."
2004 (autoload 'calendar-cursor-holidays
"holidays"
2005 "Find holidays for the date specified by the cursor in the calendar window."
2008 (defun generate-calendar-window (&optional mon yr
)
2009 "Generate the calendar window for the current date.
2010 Or, for optional MON, YR."
2011 (let* ((buffer-read-only nil
)
2012 (today (calendar-current-date))
2013 (month (extract-calendar-month today
))
2014 (day (extract-calendar-day today
))
2015 (year (extract-calendar-year today
))
2018 (let ((offset (calendar-interval mon yr month year
)))
2019 (and (<= offset
1) (>= offset -
1)))))
2020 (day-in-week (calendar-day-of-week today
))
2021 (in-calendar-window (eq (window-buffer (selected-window))
2022 (get-buffer calendar-buffer
))))
2023 (update-calendar-mode-line)
2025 (generate-calendar mon yr
)
2026 (generate-calendar month year
))
2027 (calendar-cursor-to-visible-date
2028 (if today-visible today
(list displayed-month
1 displayed-year
)))
2029 (set-buffer-modified-p nil
)
2030 ;; Don't do any window-related stuff if we weren't called from a
2031 ;; window displaying the calendar
2032 (when in-calendar-window
2033 (if (or (one-window-p t
) (/= (frame-width) (window-width)))
2034 ;; Don't mess with the window size, but ensure that the first
2035 ;; line is fully visible
2036 (set-window-vscroll nil
0)
2037 ;; Adjust the window to exactly fit the displayed calendar
2038 (fit-window-to-buffer nil nil calendar-minimum-window-height
))
2040 (if (and (boundp 'font-lock-mode
)
2042 (font-lock-fontify-buffer))
2043 (and mark-holidays-in-calendar
2044 ;;; (calendar-date-is-legal-p today) ; useful for BC dates
2045 (mark-calendar-holidays)
2046 (and in-calendar-window
(sit-for 0)))
2048 (if mark-diary-entries-in-calendar
(mark-diary-entries))
2050 (run-hooks 'today-visible-calendar-hook
)
2051 (run-hooks 'today-invisible-calendar-hook
)))))
2053 (defun generate-calendar (month year
)
2054 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
2055 ;;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on.
2056 ;;; Note that while calendars for years BC could be displayed as it
2057 ;;; stands, almost all other calendar functions (eg holidays) would
2058 ;;; at best have unpredictable results for such dates.
2059 (if (< (+ month
(* 12 (1- year
))) 2)
2060 (error "Months before January, 1 AD cannot be displayed"))
2061 (setq displayed-month month
2062 displayed-year year
)
2064 (increment-calendar-month month year -
1)
2065 (calendar-for-loop i from
0 to
2 do
2066 (generate-calendar-month month year
(+ 5 (* 25 i
)))
2067 (increment-calendar-month month year
1)))
2069 (defun generate-calendar-month (month year indent
)
2070 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
2071 The calendar is inserted at the top of the buffer in which point is currently
2072 located, but indented INDENT spaces. The indentation is done from the first
2073 character on the line and does not disturb the first INDENT characters on the
2075 (let* ((blank-days;; at start of month
2077 (- (calendar-day-of-week (list month
1 year
))
2078 calendar-week-start-day
)
2080 (last (calendar-last-day-of-month month year
)))
2081 (goto-char (point-min))
2082 (calendar-insert-indented
2083 (calendar-string-spread
2084 (list (format "%s %d" (calendar-month-name month
) year
)) ?
20)
2086 (calendar-insert-indented "" indent
);; Go to proper spot
2087 ;; Use the first two characters of each day to head the columns.
2088 (calendar-for-loop i from
0 to
6 do
2091 (calendar-day-name (mod (+ calendar-week-start-day i
) 7) nil t
)))
2092 (if enable-multibyte-characters
2093 (truncate-string-to-width string
2)
2094 (substring string
0 2)))
2096 (calendar-insert-indented "" 0 t
);; Force onto following line
2097 (calendar-insert-indented "" indent
);; Go to proper spot
2098 ;; Add blank days before the first of the month
2099 (calendar-for-loop i from
1 to blank-days do
(insert " "))
2100 ;; Put in the days of the month
2101 (calendar-for-loop i from
1 to last do
2102 (insert (format "%2d " i
))
2103 (add-text-properties
2104 (- (point) 3) (1- (point))
2105 '(mouse-face highlight
2106 help-echo
"mouse-2: menu of operations for this date"))
2107 (and (zerop (mod (+ i blank-days
) 7))
2109 (calendar-insert-indented "" 0 t
) ;; Force onto following line
2110 (calendar-insert-indented "" indent
)))));; Go to proper spot
2112 (defun calendar-insert-indented (string indent
&optional newline
)
2113 "Insert STRING at column INDENT.
2114 If the optional parameter NEWLINE is t, leave point at start of next line,
2115 inserting a newline if there was no next line; otherwise, leave point after
2116 the inserted text. Value is always t."
2117 ;; Try to move to that column.
2118 (move-to-column indent
)
2119 ;; If line is too short, indent out to that column.
2120 (if (< (current-column) indent
)
2123 ;; Advance to next line, if requested.
2132 (defun redraw-calendar ()
2133 "Redraw the calendar display, if `calendar-buffer' is live."
2135 (if (get-buffer calendar-buffer
)
2136 (with-current-buffer calendar-buffer
2137 (let ((cursor-date (calendar-cursor-to-nearest-date)))
2138 (generate-calendar-window displayed-month displayed-year
)
2139 (calendar-cursor-to-visible-date cursor-date
)))))
2142 (defcustom calendar-week-start-day
0
2143 "*The day of the week on which a week in the calendar begins.
2144 0 means Sunday (default), 1 means Monday, and so on.
2146 If you change this variable directly (without using customize)
2147 after starting `calendar', you should call `redraw-calendar' to
2148 update the calendar display to reflect the change, otherwise
2149 movement commands will not work correctly."
2151 :set
(lambda (sym val
)
2156 (defcustom calendar-debug-sexp nil
2157 "*Turn debugging on when evaluating a sexp in the diary or holiday list."
2161 (defvar calendar-mode-map nil
)
2162 (if calendar-mode-map
2164 (setq calendar-mode-map
(make-sparse-keymap))
2166 (calendar-for-loop i from
0 to
9 do
2167 (define-key calendar-mode-map
(int-to-string i
) 'digit-argument
))
2168 (let ((l (list 'narrow-to-region
'mark-word
'mark-sexp
'mark-paragraph
2169 'mark-defun
'mark-whole-buffer
'mark-page
2170 'downcase-region
'upcase-region
'kill-region
2171 'copy-region-as-kill
'capitalize-region
'write-region
)))
2173 (substitute-key-definition (car l
) 'calendar-not-implemented
2174 calendar-mode-map global-map
)
2176 (define-key calendar-mode-map
"-" 'negative-argument
)
2177 (define-key calendar-mode-map
">" 'scroll-calendar-right
)
2178 (define-key calendar-mode-map
"\C-x>" 'scroll-calendar-right
)
2179 (define-key calendar-mode-map
[prior] 'scroll-calendar-right-three-months)
2180 (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
2181 (define-key calendar-mode-map "<" 'scroll-calendar-left)
2182 (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
2183 (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
2184 (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
2185 (define-key calendar-mode-map "\C-b" 'calendar-backward-day)
2186 (define-key calendar-mode-map "\C-p" 'calendar-backward-week)
2187 (define-key calendar-mode-map "\e{" 'calendar-backward-month)
2188 (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
2189 (define-key calendar-mode-map "\C-f" 'calendar-forward-day)
2190 (define-key calendar-mode-map "\C-n" 'calendar-forward-week)
2191 (define-key calendar-mode-map [left] 'calendar-backward-day)
2192 (define-key calendar-mode-map [up] 'calendar-backward-week)
2193 (define-key calendar-mode-map [right] 'calendar-forward-day)
2194 (define-key calendar-mode-map [down] 'calendar-forward-week)
2195 (define-key calendar-mode-map "\e}" 'calendar-forward-month)
2196 (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
2197 (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
2198 (define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
2199 (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month)
2200 (define-key calendar-mode-map "\ee" 'calendar-end-of-month)
2201 (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
2202 (define-key calendar-mode-map "\e>" 'calendar-end-of-year)
2203 (define-key calendar-mode-map "\C-@" 'calendar-set-mark)
2204 ;; Many people are used to typing C-SPC and getting C-@.
2205 (define-key calendar-mode-map [?\C- ] 'calendar-set-mark)
2206 (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
2207 (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
2208 (define-key calendar-mode-map "gd" 'calendar-goto-date)
2209 (define-key calendar-mode-map "gD" 'calendar-goto-day-of-year)
2210 (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
2211 (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
2212 (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
2213 (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
2214 (define-key calendar-mode-map "gb" 'calendar-goto-bahai-date)
2215 (define-key calendar-mode-map "gC" 'calendar-goto-chinese-date)
2216 (define-key calendar-mode-map "gk" 'calendar-goto-coptic-date)
2217 (define-key calendar-mode-map "ge" 'calendar-goto-ethiopic-date)
2218 (define-key calendar-mode-map "gp" 'calendar-goto-persian-date)
2219 (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
2220 (define-key calendar-mode-map "gw" 'calendar-goto-iso-week)
2221 (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
2222 (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
2223 (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
2224 (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
2225 (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
2226 (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
2227 (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
2228 (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
2229 (define-key calendar-mode-map "Aa" 'appt-add)
2230 (define-key calendar-mode-map "Ad" 'appt-delete)
2231 (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
2232 (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
2233 (define-key calendar-mode-map " " 'scroll-other-window)
2234 (define-key calendar-mode-map (kbd "DEL") 'scroll-other-window-down)
2235 (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
2236 (define-key calendar-mode-map "." 'calendar-goto-today)
2237 (define-key calendar-mode-map "o" 'calendar-other-month)
2238 (define-key calendar-mode-map "q" 'exit-calendar)
2239 (define-key calendar-mode-map "a" 'list-calendar-holidays)
2240 (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
2241 (define-key calendar-mode-map "x" 'mark-calendar-holidays)
2242 (define-key calendar-mode-map "u" 'calendar-unmark)
2243 (define-key calendar-mode-map "m" 'mark-diary-entries)
2244 (define-key calendar-mode-map "d" 'diary-view-entries)
2245 (define-key calendar-mode-map "D" 'view-other-diary-entries)
2246 (define-key calendar-mode-map "s" 'show-all-diary-entries)
2247 (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
2248 (define-key calendar-mode-map "pC" 'calendar-print-chinese-date)
2249 (define-key calendar-mode-map "pk" 'calendar-print-coptic-date)
2250 (define-key calendar-mode-map "pe" 'calendar-print-ethiopic-date)
2251 (define-key calendar-mode-map "pp" 'calendar-print-persian-date)
2252 (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
2253 (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
2254 (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
2255 (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
2256 (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
2257 (define-key calendar-mode-map "pb" 'calendar-print-bahai-date)
2258 (define-key calendar-mode-map "pf" 'calendar-print-french-date)
2259 (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
2260 (define-key calendar-mode-map "po" 'calendar-print-other-dates)
2261 (define-key calendar-mode-map "id" 'insert-diary-entry)
2262 (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
2263 (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
2264 (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
2265 (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
2266 (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
2267 (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
2268 (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
2269 (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
2270 (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
2271 (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
2272 (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
2273 (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
2274 (define-key calendar-mode-map "iBd" 'insert-bahai-diary-entry)
2275 (define-key calendar-mode-map "iBm" 'insert-monthly-bahai-diary-entry)
2276 (define-key calendar-mode-map "iBy" 'insert-yearly-bahai-diary-entry)
2277 (define-key calendar-mode-map "?" 'calendar-goto-info-node)
2278 (define-key calendar-mode-map "tm" 'cal-tex-cursor-month)
2279 (define-key calendar-mode-map "tM" 'cal-tex-cursor-month-landscape)
2280 (define-key calendar-mode-map "td" 'cal-tex-cursor-day)
2281 (define-key calendar-mode-map "tw1" 'cal-tex-cursor-week)
2282 (define-key calendar-mode-map "tw2" 'cal-tex-cursor-week2)
2283 (define-key calendar-mode-map "tw3" 'cal-tex-cursor-week-iso)
2284 (define-key calendar-mode-map "tw4" 'cal-tex-cursor-week-monday)
2285 (define-key calendar-mode-map "tfd" 'cal-tex-cursor-filofax-daily)
2286 (define-key calendar-mode-map "tfw" 'cal-tex-cursor-filofax-2week)
2287 (define-key calendar-mode-map "tfW" 'cal-tex-cursor-filofax-week)
2288 (define-key calendar-mode-map "tfy" 'cal-tex-cursor-filofax-year)
2289 (define-key calendar-mode-map "ty" 'cal-tex-cursor-year)
2290 (define-key calendar-mode-map "tY" 'cal-tex-cursor-year-landscape))
2292 (defun describe-calendar-mode ()
2293 "Create a help buffer with a brief description of the `calendar-mode'."
2295 (with-output-to-temp-buffer "*Help*"
2298 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
2299 (substitute-command-keys
2300 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
2301 (substitute-command-keys "\\{calendar-mode-map}")))
2303 (set-buffer standard-output)
2305 (print-help-return-message)))
2307 ;; Calendar mode is suitable only for specially formatted data.
2308 (put 'calendar-mode 'mode-class 'special)
2310 (defvar calendar-mode-line-format
2312 (propertize (substitute-command-keys
2313 "\\<calendar-mode-map>\\[scroll-calendar-left]")
2314 'help-echo "mouse-2: scroll left"
2315 'mouse-face 'mode-line-highlight
2316 'keymap (make-mode-line-mouse-map 'mouse-2
2317 'mouse-scroll-calendar-left))
2321 (substitute-command-keys
2322 "\\<calendar-mode-map>\\[calendar-goto-info-node] info")
2323 'help-echo "mouse-2: read Info on Calendar"
2324 'mouse-face 'mode-line-highlight
2325 'keymap (make-mode-line-mouse-map 'mouse-2 'calendar-goto-info-node))
2328 (substitute-command-keys
2329 "\\<calendar-mode-map>\\[calendar-other-month] other")
2330 'help-echo "mouse-2: choose another month"
2331 'mouse-face 'mode-line-highlight
2332 'keymap (make-mode-line-mouse-map
2333 'mouse-2 'mouse-calendar-other-month))
2336 (substitute-command-keys
2337 "\\<calendar-mode-map>\\[calendar-goto-today] today")
2338 'help-echo "mouse-2: go to today's date"
2339 'mouse-face 'mode-line-highlight
2340 'keymap (make-mode-line-mouse-map 'mouse-2 #'calendar-goto-today)))
2341 '(calendar-date-string (calendar-current-date) t)
2342 (propertize (substitute-command-keys
2343 "\\<calendar-mode-map>\\[scroll-calendar-right]")
2344 'help-echo "mouse-2: scroll right"
2345 'mouse-face 'mode-line-highlight
2346 'keymap (make-mode-line-mouse-map
2347 'mouse-2 'mouse-scroll-calendar-right)))
2348 "The mode line of the calendar buffer.
2350 This must be a list of items that evaluate to strings--those strings are
2351 evaluated and concatenated together, evenly separated by blanks. The variable
2352 `date' is available for use as the date under (or near) the cursor; `date'
2353 defaults to the current date if it is otherwise undefined. Here is an example
2354 value that has the Hebrew date, the day number/days remaining in the year,
2355 and the ISO week/year numbers in the mode. When calendar-move-hook is set to
2356 'update-calendar-mode-line, these mode line shows these values for the date
2361 '(calendar-hebrew-date-string date)
2362 '(let* ((year (extract-calendar-year date))
2363 (d (calendar-day-number date))
2365 (- (calendar-day-number (list 12 31 year)) d)))
2366 (format \"%d/%d\" d days-remaining))
2367 '(let* ((d (calendar-absolute-from-gregorian date))
2368 (iso-date (calendar-iso-from-absolute d)))
2369 (format \"ISO week %d of %d\"
2370 (extract-calendar-month iso-date)
2371 (extract-calendar-year iso-date)))
2375 (defun mouse-scroll-calendar-left (event)
2376 "Scroll the displayed calendar left by one month.
2377 Maintains the relative position of the cursor
2378 with respect to the calendar as well as possible."
2380 (save-selected-window
2381 (select-window (posn-window (event-start event)))
2382 (scroll-calendar-left 1)))
2384 (defun mouse-scroll-calendar-right (event)
2385 "Scroll the displayed calendar right by one month.
2386 Maintains the relative position of the cursor
2387 with respect to the calendar as well as possible."
2389 (save-selected-window
2390 (select-window (posn-window (event-start event)))
2391 (scroll-calendar-right 1)))
2393 (defun mouse-calendar-other-month (event)
2394 "Display a three-month calendar centered around a specified month and year."
2396 (save-selected-window
2397 (select-window (posn-window (event-start event)))
2398 (call-interactively 'calendar-other-month)))
2400 (defun calendar-goto-info-node ()
2401 "Go to the info node for the calendar."
2404 (let ((where (save-window-excursion
2405 (Info-find-emacs-command-nodes 'calendar))))
2407 (error "Couldn't find documentation for the calendar")
2408 (let (same-window-buffer-names)
2410 (Info-find-node (car (car where)) (car (cdr (car where)))))))
2414 (defun calendar-mode ()
2415 "A major mode for the calendar window.
2417 For a complete description, type \
2418 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
2420 \\<calendar-mode-map>\\{calendar-mode-map}"
2421 (kill-all-local-variables)
2422 (setq major-mode 'calendar-mode)
2423 (setq mode-name "Calendar")
2424 (use-local-map calendar-mode-map)
2425 (setq buffer-read-only t)
2426 (setq indent-tabs-mode nil)
2427 (update-calendar-mode-line)
2428 (add-hook 'activate-menubar-hook 'cal-menu-update nil t)
2429 (make-local-variable 'calendar-mark-ring)
2430 (make-local-variable 'displayed-month);; Month in middle of window.
2431 (make-local-variable 'displayed-year) ;; Year in middle of window.
2432 (set (make-local-variable 'font-lock-defaults)
2433 '(calendar-font-lock-keywords t))
2434 (run-mode-hooks 'calendar-mode-hook))
2436 (defun calendar-string-spread (strings char length)
2437 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
2438 The effect is like mapconcat but the separating pieces are as balanced as
2439 possible. Each item of STRINGS is evaluated before concatenation so it can
2440 actually be an expression that evaluates to a string. If LENGTH is too short,
2441 the STRINGS are just concatenated and the result truncated."
2442 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
2443 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
2444 ;; Addison-Wesley, Reading, MA, 1989
2445 (let* ((strings (mapcar 'eval
2446 (if (< (length strings) 2)
2447 (append (list "") strings (list ""))
2449 (n (- length (length (apply 'concat strings))))
2450 (m (1- (length strings)))
2452 (strings (cdr strings))
2456 (make-string (max 0 (/ (+ n i) m)) char)
2459 (setq strings (cdr strings)))
2460 (substring s 0 length)))
2462 (defun update-calendar-mode-line ()
2463 "Update the calendar mode line with the current date and date style."
2464 (if (bufferp (get-buffer calendar-buffer))
2465 (with-current-buffer calendar-buffer
2466 (setq mode-line-format
2467 (calendar-string-spread
2468 (let ((date (condition-case nil
2469 (calendar-cursor-to-nearest-date)
2470 (error (calendar-current-date)))))
2471 (mapcar 'eval calendar-mode-line-format))
2473 (force-mode-line-update))))
2475 (defun calendar-window-list ()
2476 "List of all calendar-related windows."
2477 (let ((calendar-buffers (calendar-buffer-list))
2479 (walk-windows (lambda (w)
2480 (if (memq (window-buffer w) calendar-buffers)
2481 (setq list (cons w list))))
2485 (defun calendar-buffer-list ()
2486 "List of all calendar-related buffers."
2487 (let* ((diary-buffer (get-file-buffer diary-file))
2488 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
2489 fancy-diary-buffer diary-buffer calendar-buffer
2490 other-calendars-buffer))
2494 (setq b (car buffers))
2495 (setq b (cond ((stringp b) (get-buffer b))
2498 (if b (setq buffer-list (cons b buffer-list)))
2499 (setq buffers (cdr buffers)))
2502 (defun exit-calendar ()
2503 "Get out of the calendar window and hide it and related buffers."
2505 (let* ((diary-buffer (get-file-buffer diary-file)))
2506 (if (or (not diary-buffer)
2507 (not (buffer-modified-p diary-buffer))
2509 "Diary modified; do you really want to exit the calendar? "))
2510 ;; Need to do this multiple times because one time can replace some
2511 ;; calendar-related buffers with other calendar-related buffers
2513 (mapcar 'calendar-hide-window (calendar-window-list)))
2514 (calendar-window-list)))))
2516 (defun calendar-hide-window (window)
2517 "Hide WINDOW if it is calendar-related."
2518 (let ((buffer (if (window-live-p window) (window-buffer window))))
2519 (if (memq buffer (calendar-buffer-list))
2521 ((and (display-multi-frame-p)
2522 (eq 'icon (cdr (assoc 'visibility
2524 (window-frame window))))))
2526 ((and (display-multi-frame-p) (window-dedicated-p window))
2527 (if calendar-remove-frame-by-deleting
2528 (delete-frame (window-frame window))
2529 (iconify-frame (window-frame window))))
2530 ((not (and (select-window window) (one-window-p window)))
2531 (delete-window window))
2532 (t (set-buffer buffer)
2535 (defun calendar-current-date ()
2536 "Return the current date in a list (month day year)."
2537 (let ((now (decode-time)))
2538 (list (nth 4 now) (nth 3 now) (nth 5 now))))
2540 (defun calendar-cursor-to-date (&optional error)
2541 "Return a list (month day year) of current cursor position.
2542 If cursor is not on a specific date, signals an error if optional parameter
2543 ERROR is t, otherwise just returns nil."
2544 (let* ((segment (/ (current-column) 25))
2545 (month (% (+ displayed-month segment -1) 12))
2546 (month (if (= 0 month) 12 month))
2549 ((and (= 12 month) (= segment 0)) (1- displayed-year))
2550 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
2551 (t displayed-year))))
2552 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
2553 (< 2 (count-lines (point-min) (point))))
2555 (if (not (looking-at " "))
2556 (re-search-backward "[^0-9]"))
2558 (string-to-number (buffer-substring (1+ (point)) (+ 4 (point))))
2560 (if (and (looking-at "\\*")
2562 (re-search-backward "[^*]")
2563 (looking-at ".\\*\\*")))
2564 (list month calendar-starred-day year)
2565 (if error (error "Not on a date!"))))))
2567 (add-to-list 'debug-ignored-errors "Not on a date!")
2569 ;; The following version of calendar-gregorian-from-absolute is preferred for
2570 ;; reasons of clarity, BUT it's much slower than the version that follows it.
2572 ;;(defun calendar-gregorian-from-absolute (date)
2573 ;; "Compute the list (month day year) corresponding to the absolute DATE.
2574 ;;The absolute date is the number of days elapsed since the (imaginary)
2575 ;;Gregorian date Sunday, December 31, 1 BC."
2576 ;; (let* ((approx (/ date 366));; Approximation from below.
2577 ;; (year ;; Search forward from the approximation.
2579 ;; (calendar-sum y approx
2580 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2582 ;; (month ;; Search forward from January.
2583 ;; (1+ (calendar-sum m 1
2585 ;; (calendar-absolute-from-gregorian
2586 ;; (list m (calendar-last-day-of-month m year) year)))
2588 ;; (day ;; Calculate the day by subtraction.
2590 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2591 ;; (list month day year)))
2593 (defun calendar-gregorian-from-absolute (date)
2594 "Compute the list (month day year) corresponding to the absolute DATE.
2595 The absolute date is the number of days elapsed since the (imaginary)
2596 Gregorian date Sunday, December 31, 1 BC. This function does not
2597 handle dates in years BC."
2598 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2599 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2600 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2601 ;; (April, 1993), pages 383-404 for an explanation.
2602 (let* ((d0 (1- date))
2603 (n400 (/ d0 146097))
2610 (day (1+ (% d3 365)))
2611 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2612 (if (or (= n100 4) (= n1 4))
2614 (let ((year (1+ year))
2616 (while (let ((mdays (calendar-last-day-of-month month year)))
2618 (setq day (- day mdays))))
2619 (setq month (1+ month)))
2620 (list month day year)))))
2622 (defun calendar-other-month (month year)
2623 "Display a three-month calendar centered around MONTH and YEAR."
2624 (interactive (calendar-read-date 'noday))
2625 (if (and (= month displayed-month)
2626 (= year displayed-year))
2628 (let ((old-date (calendar-cursor-to-date))
2629 (today (calendar-current-date)))
2630 (generate-calendar-window month year)
2631 (calendar-cursor-to-visible-date
2633 ((calendar-date-is-visible-p old-date) old-date)
2634 ((calendar-date-is-visible-p today) today)
2635 (t (list month 1 year)))))))
2637 (defun calendar-set-mark (arg)
2638 "Mark the date under the cursor, or jump to marked date.
2639 With no prefix argument, push current date onto marked date ring.
2640 With argument, jump to mark, pop it, and put point at end of ring."
2642 (let ((date (calendar-cursor-to-date t)))
2645 (setq calendar-mark-ring (cons date calendar-mark-ring))
2646 ;; Since the top of the mark ring is the marked date in the
2647 ;; calendar, the mark ring in the calendar is one longer than
2648 ;; in other buffers to get the same effect.
2649 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2650 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2651 (message "Mark set"))
2652 (if (null calendar-mark-ring)
2653 (error "No mark set in this buffer")
2654 (calendar-goto-date (car calendar-mark-ring))
2655 (setq calendar-mark-ring
2656 (cdr (nconc calendar-mark-ring (list date))))))))
2658 (defun calendar-exchange-point-and-mark ()
2659 "Exchange the current cursor position with the marked date."
2661 (let ((mark (car calendar-mark-ring))
2662 (date (calendar-cursor-to-date t)))
2664 (error "No mark set in this buffer")
2665 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2666 (calendar-goto-date mark))))
2668 (defun calendar-count-days-region ()
2669 "Count the number of days (inclusive) between point and the mark."
2671 (let* ((days (- (calendar-absolute-from-gregorian
2672 (calendar-cursor-to-date t))
2673 (calendar-absolute-from-gregorian
2674 (or (car calendar-mark-ring)
2675 (error "No mark set in this buffer")))))
2676 (days (1+ (if (> days 0) days (- days)))))
2677 (message "Region has %d day%s (inclusive)"
2678 days (if (> days 1) "s" ""))))
2680 (defun calendar-not-implemented ()
2683 (error "%s not available in the calendar"
2684 (global-key-binding (this-command-keys))))
2686 (defun calendar-read (prompt acceptable &optional initial-contents)
2687 "Return an object read from the minibuffer.
2688 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2689 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2690 is a string to insert in the minibuffer before reading."
2691 (let ((value (read-minibuffer prompt initial-contents)))
2692 (while (not (funcall acceptable value))
2693 (setq value (read-minibuffer prompt initial-contents)))
2696 (defun calendar-read-date (&optional noday)
2697 "Prompt for Gregorian date. Return a list (month day year).
2698 If optional NODAY is t, does not ask for day, but just returns
2699 \(month nil year); if NODAY is any other non-nil value the value returned is
2701 (let* ((year (calendar-read
2703 (lambda (x) (> x 0))
2704 (int-to-string (extract-calendar-year
2705 (calendar-current-date)))))
2706 (month-array calendar-month-name-array)
2707 (completion-ignore-case t)
2708 (month (cdr (assoc-string
2711 (mapcar 'list (append month-array nil))
2713 (calendar-make-alist month-array 1) t)))
2714 (last (calendar-last-day-of-month month year)))
2717 (list month nil year)
2720 (calendar-read (format "Day (1-%d): " last)
2721 (lambda (x) (and (< 0 x) (<= x last))))
2724 (defun calendar-interval (mon1 yr1 mon2 yr2)
2725 "The number of months difference between MON1, YR1 and MON2, YR2.
2726 The result is positive if the second date is later than the first.
2727 Negative years are interpreted as years BC; -1 being 1 BC, and so on."
2728 (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc
2729 (if (< yr2 0) (setq yr2 (1+ yr2)))
2730 (+ (* 12 (- yr2 yr1))
2733 (defvar calendar-abbrev-length 3
2734 "*Length of abbreviations to be used for day and month names.
2735 See also `calendar-day-abbrev-array' and `calendar-month-abbrev-array'.")
2737 (defvar calendar-day-name-array
2738 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2739 "*Array of capitalized strings giving, in order, the day names.
2740 The first two characters of each string will be used to head the
2741 day columns in the calendar. See also the variable
2742 `calendar-day-abbrev-array'.")
2744 (defvar calendar-day-abbrev-array
2745 [nil nil nil nil nil nil nil]
2746 "*Array of capitalized strings giving the abbreviated day names.
2747 The order should be the same as that of the full names specified
2748 in `calendar-day-name-array'. These abbreviations may be used
2749 instead of the full names in the diary file. Do not include a
2750 trailing `.' in the strings specified in this variable, though
2751 you may use such in the diary file. If any element of this array
2752 is nil, then the abbreviation will be constructed as the first
2753 `calendar-abbrev-length' characters of the corresponding full name.")
2755 (defvar calendar-month-name-array
2756 ["January" "February" "March" "April" "May" "June"
2757 "July" "August" "September" "October" "November" "December"]
2758 "*Array of capitalized strings giving, in order, the month names.
2759 See also the variable `calendar-month-abbrev-array'.")
2761 (defvar calendar-month-abbrev-array
2762 [nil nil nil nil nil nil nil nil nil nil nil nil]
2763 "*Array of capitalized strings giving the abbreviated month names.
2764 The order should be the same as that of the full names specified
2765 in `calendar-month-name-array'. These abbreviations are used in
2766 the calendar menu entries, and can also be used in the diary
2767 file. Do not include a trailing `.' in the strings specified in
2768 this variable, though you may use such in the diary file. If any
2769 element of this array is nil, then the abbreviation will be
2770 constructed as the first `calendar-abbrev-length' characters of the
2771 corresponding full name.")
2773 (defun calendar-abbrev-construct (abbrev full &optional period)
2774 "Internal calendar function to return a complete abbreviation array.
2775 ABBREV is an array of abbreviations, FULL the corresponding array
2776 of full names. The return value is the ABBREV array, with any nil
2777 elements replaced by the first three characters taken from the
2778 corresponding element of FULL. If optional argument PERIOD is non-nil,
2779 each element returned has a final `.' character."
2780 (let (elem array name)
2781 (dotimes (i (length full))
2782 (setq name (aref full i)
2783 elem (or (aref abbrev i)
2785 (min calendar-abbrev-length (length name))))
2786 elem (format "%s%s" elem (if period "." ""))
2787 array (append array (list elem))))
2790 (defvar calendar-font-lock-keywords
2791 `((,(concat (regexp-opt (mapcar 'identity calendar-month-name-array) t)
2793 . font-lock-function-name-face) ; month and year
2795 (list (substring (aref calendar-day-name-array 6) 0 2)
2796 (substring (aref calendar-day-name-array 0) 0 2)))
2797 ;; Saturdays and Sundays are hilited differently.
2798 . font-lock-comment-face)
2799 ;; First two chars of each day are used in the calendar.
2800 (,(regexp-opt (mapcar (lambda (x) (substring x 0 2)) calendar-day-name-array))
2801 . font-lock-reference-face))
2802 "Default keywords to highlight in Calendar mode.")
2804 (defun calendar-day-name (date &optional abbrev absolute)
2805 "Return a string with the name of the day of the week of DATE.
2806 DATE should be a list in the format (MONTH DAY YEAR), unless the
2807 optional argument ABSOLUTE is non-nil, in which case DATE should
2808 be an integer in the range 0 to 6 corresponding to the day of the
2809 week. Day names are taken from the variable `calendar-day-name-array',
2810 unless the optional argument ABBREV is non-nil, in which case
2811 the variable `calendar-day-abbrev-array' is used."
2813 (calendar-abbrev-construct calendar-day-abbrev-array
2814 calendar-day-name-array)
2815 calendar-day-name-array)
2816 (if absolute date (calendar-day-of-week date))))
2818 (defun calendar-make-alist (sequence &optional start-index filter abbrevs)
2819 "Make an assoc list corresponding to SEQUENCE.
2820 Each element of sequence will be associated with an integer, starting
2821 from 1, or from START-INDEX if that is non-nil. If a sequence ABBREVS
2822 is supplied, the function `calendar-abbrev-construct' is used to
2823 construct abbreviations corresponding to the elements in SEQUENCE.
2824 Each abbreviation is entered into the alist with the same
2825 association index as the full name it represents.
2826 If FILTER is provided, apply it to each key in the alist."
2828 (offset (or start-index 1))
2829 (aseq (if abbrevs (calendar-abbrev-construct abbrevs sequence)))
2830 (aseqp (if abbrevs (calendar-abbrev-construct abbrevs sequence
2833 (dotimes (i (length sequence) (reverse alist))
2834 (setq index (+ i offset)
2835 elem (elt sequence i)
2837 (cons (cons (if filter (funcall filter elem) elem) index) alist))
2839 (setq elem (elt aseq i)
2840 alist (cons (cons (if filter (funcall filter elem) elem)
2843 (setq elem (elt aseqp i)
2844 alist (cons (cons (if filter (funcall filter elem) elem)
2847 (defun calendar-month-name (month &optional abbrev)
2848 "Return a string with the name of month number MONTH.
2849 Months are numbered from one. Month names are taken from the
2850 variable `calendar-month-name-array', unless the optional
2851 argument ABBREV is non-nil, in which case
2852 `calendar-month-abbrev-array' is used."
2854 (calendar-abbrev-construct calendar-month-abbrev-array
2855 calendar-month-name-array)
2856 calendar-month-name-array)
2859 (defun calendar-day-of-week (date)
2860 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc.
2861 DATE is a list of the form (month day year). A negative year is
2862 interpreted as BC; -1 being 1 BC, and so on."
2863 (mod (calendar-absolute-from-gregorian date) 7))
2865 (defun calendar-unmark ()
2866 "Delete all diary/holiday marks/highlighting from the calendar."
2868 (setq mark-holidays-in-calendar nil)
2869 (setq mark-diary-entries-in-calendar nil)
2872 (defun calendar-date-is-visible-p (date)
2873 "Return t if DATE is valid and is visible in the calendar window."
2874 (let ((gap (calendar-interval
2875 displayed-month displayed-year
2876 (extract-calendar-month date) (extract-calendar-year date))))
2877 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2879 (defun calendar-date-is-legal-p (date)
2880 "Return t if DATE is a valid date."
2881 (let ((month (extract-calendar-month date))
2882 (day (extract-calendar-day date))
2883 (year (extract-calendar-year date)))
2884 (and (<= 1 month) (<= month 12)
2885 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2886 ;; BC dates left as non-valid, to suppress errors from
2887 ;; complex holiday algorithms not suitable for years BC.
2888 ;; Note there are side effects on calendar navigation.
2891 (defun calendar-date-equal (date1 date2)
2892 "Return t if the DATE1 and DATE2 are the same."
2894 (= (extract-calendar-month date1) (extract-calendar-month date2))
2895 (= (extract-calendar-day date1) (extract-calendar-day date2))
2896 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2898 (defun mark-visible-calendar-date (date &optional mark)
2899 "Mark DATE in the calendar window with MARK.
2900 MARK is a single-character string, a list of face attributes/values, or a face.
2901 MARK defaults to `diary-entry-marker'."
2902 (if (calendar-date-is-legal-p date)
2903 (with-current-buffer calendar-buffer
2905 (calendar-cursor-to-visible-date date)
2907 (or (and (stringp mark) (= (length mark) 1) mark) ; single-char
2908 (and (listp mark) (> (length mark) 0) mark) ; attr list
2909 (and (facep mark) mark) ; face-name
2910 diary-entry-marker))
2912 ;; face or an attr-list that contained a face
2915 (make-overlay (1- (point)) (1+ (point))) 'face mark))
2917 ((and (stringp mark) (= (length mark) 1))
2918 (let ((inhibit-read-only t))
2920 ;; Insert before delete so as to better preserve markers.
2927 (apply 'concat "temp-"
2928 (mapcar (lambda (sym)
2930 ((symbolp sym) (symbol-name sym))
2931 ((numberp sym) (number-to-string sym))
2935 (make-face temp-face)
2936 ;; Remove :face info from the mark, copy the face info into
2938 (while (setq faceinfo (memq :face faceinfo))
2939 (copy-face (read (nth 1 faceinfo)) temp-face)
2940 (setcar faceinfo nil)
2941 (setcar (cdr faceinfo) nil))
2942 (setq mark (delq nil mark))
2943 ;; Apply the font aspects
2944 (apply 'set-face-attribute temp-face nil mark)
2946 (make-overlay (1- (point)) (1+ (point))) 'face temp-face))))))))
2948 (defun calendar-star-date ()
2949 "Replace the date under the cursor in the calendar window with asterisks.
2950 This function can be used with the `today-visible-calendar-hook' run after the
2951 calendar window has been prepared."
2952 (let ((inhibit-read-only t))
2953 (make-local-variable 'calendar-starred-day)
2955 (setq calendar-starred-day
2957 (buffer-substring (point) (- (point) 2))))
2961 (set-buffer-modified-p nil)))
2963 (defun calendar-mark-today ()
2964 "Mark the date under the cursor in the calendar window.
2965 The date is marked with `calendar-today-marker'. This function can be used with
2966 the `today-visible-calendar-hook' run after the calendar window has been
2968 (mark-visible-calendar-date
2969 (calendar-cursor-to-date)
2970 calendar-today-marker))
2972 (defun calendar-date-compare (date1 date2)
2973 "Return t if DATE1 is before DATE2, nil otherwise.
2974 The actual dates are in the car of DATE1 and DATE2."
2975 (< (calendar-absolute-from-gregorian (car date1))
2976 (calendar-absolute-from-gregorian (car date2))))
2978 (defun calendar-date-string (date &optional abbreviate nodayname)
2979 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2980 An optional parameter ABBREVIATE, when non-nil, causes the month
2981 and day names to be abbreviated as specified by
2982 `calendar-month-abbrev-array' and `calendar-day-abbrev-array',
2983 respectively. An optional parameter NODAYNAME, when t, omits the
2984 name of the day of the week."
2987 (calendar-day-name date abbreviate)))
2988 (month (extract-calendar-month date))
2989 (monthname (calendar-month-name month abbreviate))
2990 (day (int-to-string (extract-calendar-day date)))
2991 (month (int-to-string month))
2992 (year (int-to-string (extract-calendar-year date))))
2993 (mapconcat 'eval calendar-date-display-form "")))
2995 (defun calendar-dayname-on-or-before (dayname date)
2996 "Return the absolute date of the DAYNAME on or before absolute DATE.
2997 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
2999 Note: Applying this function to d+6 gives us the DAYNAME on or after an
3000 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
3001 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
3002 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
3003 (- date (% (- date dayname) 7)))
3005 (defun calendar-nth-named-absday (n dayname month year &optional day)
3006 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3007 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3008 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3009 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3011 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3014 (calendar-dayname-on-or-before
3016 (+ 6 (calendar-absolute-from-gregorian
3017 (list month (or day 1) year)))))
3019 (calendar-dayname-on-or-before
3021 (calendar-absolute-from-gregorian
3023 (or day (calendar-last-day-of-month month year))
3026 (defun calendar-nth-named-day (n dayname month year &optional day)
3027 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3028 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3029 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3030 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3032 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3033 (calendar-gregorian-from-absolute
3034 (calendar-nth-named-absday n dayname month year day)))
3036 (defun calendar-day-of-year-string (&optional date)
3037 "String of day number of year of Gregorian DATE.
3038 Defaults to today's date if DATE is not given."
3039 (let* ((d (or date (calendar-current-date)))
3040 (year (extract-calendar-year d))
3041 (day (calendar-day-number d))
3042 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
3043 (format "Day %d of %d; %d day%s remaining in the year"
3044 day year days-remaining (if (= days-remaining 1) "" "s"))))
3046 (defun calendar-print-other-dates ()
3047 "Show dates on other calendars for date under the cursor."
3049 (let* ((date (calendar-cursor-to-date t)))
3050 (with-current-buffer (get-buffer-create other-calendars-buffer)
3051 (setq buffer-read-only nil)
3052 (calendar-set-mode-line
3053 (concat (calendar-date-string date) " (Gregorian)"))
3056 (mapconcat 'identity
3057 (list (calendar-day-of-year-string date)
3058 (format "ISO date: %s" (calendar-iso-date-string date))
3059 (format "Julian date: %s"
3060 (calendar-julian-date-string date))
3062 "Astronomical (Julian) day number (at noon UTC): %s.0"
3063 (calendar-astro-date-string date))
3064 (format "Fixed (RD) date: %s"
3065 (calendar-absolute-from-gregorian date))
3066 (format "Hebrew date (before sunset): %s"
3067 (calendar-hebrew-date-string date))
3068 (format "Persian date: %s"
3069 (calendar-persian-date-string date))
3070 (let ((i (calendar-islamic-date-string date)))
3071 (if (not (string-equal i ""))
3072 (format "Islamic date (before sunset): %s" i)))
3073 (let ((b (calendar-bahai-date-string date)))
3074 (if (not (string-equal b ""))
3075 (format "Baha'i date (before sunset): %s" b)))
3076 (format "Chinese date: %s"
3077 (calendar-chinese-date-string date))
3078 (let ((c (calendar-coptic-date-string date)))
3079 (if (not (string-equal c ""))
3080 (format "Coptic date: %s" c)))
3081 (let ((e (calendar-ethiopic-date-string date)))
3082 (if (not (string-equal e ""))
3083 (format "Ethiopic date: %s" e)))
3084 (let ((f (calendar-french-date-string date)))
3085 (if (not (string-equal f ""))
3086 (format "French Revolutionary date: %s" f)))
3087 (format "Mayan date: %s"
3088 (calendar-mayan-date-string date)))
3090 (goto-char (point-min))
3091 (set-buffer-modified-p nil)
3092 (setq buffer-read-only t)
3093 (display-buffer other-calendars-buffer))))
3095 (defun calendar-print-day-of-year ()
3096 "Show day number in year/days remaining in year for date under the cursor."
3098 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
3100 (defun calendar-set-mode-line (str)
3101 "Set mode line to STR, centered, surrounded by dashes."
3102 (setq mode-line-format
3103 (calendar-string-spread
3105 ;; As per doc of window-width, total visible mode-line length.
3106 (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))))))
3108 (defun calendar-mod (m n)
3109 "Non-negative remainder of M/N with N instead of 0."
3110 (1+ (mod (1- m) n)))
3112 (run-hooks 'calendar-load-hook)
3117 ;; byte-compile-dynamic: t
3120 ;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8
3121 ;;; calendar.el ends here
HCoop / bpt / emacs.git / blob