1 ;;; calendar.el --- calendar functions
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
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
101 (defvar displayed-month
)
102 (defvar displayed-year
)
103 (defvar calendar-month-name-array
)
104 (defvar calendar-starred-day
)
106 (defun calendar-version ()
108 (message "Version 6, October 12, 1995"))
110 (defgroup calendar nil
111 "Calendar and time management support."
112 :group
'applications
)
119 "Appointment notification."
122 (defgroup holidays nil
123 "Holidays support in calendar."
128 (defgroup chinese-calendar nil
129 "Chinese calendar support."
132 (defgroup calendar-tex nil
133 "Options for printing calendar with LaTeX."
137 (defgroup calendar-hooks nil
143 (defconst calendar-buffer
"*Calendar*"
144 "Name of the buffer used for the calendar.")
147 (defcustom calendar-offset
0
148 "The offset of the principal month from the center of the calendar window.
149 0 means the principal month is in the center (default), -1 means on the left,
150 +1 means on the right. Larger (or smaller) values push the principal month off
156 (defcustom view-diary-entries-initially nil
157 "Non-nil means display current date's diary entries on entry to calendar.
158 The diary is displayed in another window when the calendar is first displayed,
159 if the current date is visible. The number of days of diary entries displayed
160 is governed by the variable `number-of-diary-entries'. This variable can
161 be overridden by the value of `calendar-setup'."
166 (defcustom mark-diary-entries-in-calendar nil
167 "Non-nil means mark dates with diary entries, in the calendar window.
168 The marking symbol is specified by the variable `diary-entry-marker'."
173 (defcustom calendar-remove-frame-by-deleting nil
174 "Determine how the calendar mode removes a frame no longer needed.
175 If nil, make an icon of the frame. If non-nil, delete the frame."
179 (defvar diary-face
'diary
180 "Face name to use for diary entries.")
182 '((((min-colors 88) (class color
) (background light
))
184 (((class color
) (background light
))
186 (((min-colors 88) (class color
) (background dark
))
187 :foreground
"yellow1")
188 (((class color
) (background dark
))
189 :foreground
"yellow")
192 "Face for highlighting diary entries."
194 ;; backward-compatibility alias
195 (put 'diary-face
'face-alias
'diary
)
197 (defface calendar-today
198 '((t (:underline t
)))
199 "Face for indicating today's date."
201 ;; backward-compatibility alias
202 (put 'calendar-today-face
'face-alias
'calendar-today
)
205 '((((class color
) (background light
))
207 (((class color
) (background dark
))
208 :background
"chocolate4")
211 "Face for indicating dates that have holidays."
213 ;; backward-compatibility alias
214 (put 'holiday-face
'face-alias
'holiday
)
216 (defcustom diary-entry-marker
217 (if (not (display-color-p))
220 "How to mark dates that have diary entries.
221 The value can be either a single-character string or a face."
222 :type
'(choice string face
)
225 (defcustom calendar-today-marker
226 (if (not (display-color-p))
229 "How to mark today's date in the calendar.
230 The value can be either a single-character string or a face.
231 Marking today's date is done only if you set up `today-visible-calendar-hook'
233 :type
'(choice string face
)
236 (defcustom calendar-holiday-marker
237 (if (not (display-color-p))
240 "How to mark notable dates in the calendar.
241 The value can be either a single-character string or a face."
242 :type
'(choice string face
)
246 (defcustom view-calendar-holidays-initially nil
247 "Non-nil means display holidays for current three month period on entry.
248 The holidays are displayed in another window when the calendar is first
254 (defcustom mark-holidays-in-calendar nil
255 "Non-nil means mark dates of holidays in the calendar window.
256 The marking symbol is specified by the variable `calendar-holiday-marker'."
261 (defcustom all-hebrew-calendar-holidays nil
262 "If nil, show only major holidays from the Hebrew calendar.
263 This means only those Jewish holidays that appear on secular calendars.
265 If t, show all the holidays that would appear in a complete Hebrew calendar."
270 (defcustom all-christian-calendar-holidays nil
271 "If nil, show only major holidays from the Christian calendar.
272 This means only those Christian holidays that appear on secular calendars.
274 If t, show all the holidays that would appear in a complete Christian
280 (defcustom all-islamic-calendar-holidays nil
281 "If nil, show only major holidays from the Islamic calendar.
282 This means only those Islamic holidays that appear on secular calendars.
284 If t, show all the holidays that would appear in a complete Islamic
289 (defcustom diary-file-name-prefix-function
(function (lambda (str) str
))
290 "The function that will take a diary file name and return the desired prefix."
295 (defcustom all-bahai-calendar-holidays nil
296 "If nil, show only major holidays from the Baha'i calendar.
297 These are the days on which work and school must be suspended.
299 If t, show all the holidays that would appear in a complete Baha'i
305 (defcustom calendar-load-hook nil
306 "List of functions to be called after the calendar is first loaded.
307 This is the place to add key bindings to `calendar-mode-map'."
309 :group
'calendar-hooks
)
312 (defcustom initial-calendar-window-hook nil
313 "List of functions to be called when the calendar window is first opened.
314 The functions invoked are called after the calendar window is opened, but
315 once opened is never called again. Leaving the calendar with the `q' command
316 and reentering it will cause these functions to be called again."
318 :group
'calendar-hooks
)
321 (defcustom today-visible-calendar-hook nil
322 "List of functions called whenever the current date is visible.
323 This can be used, for example, to replace today's date with asterisks; a
324 function `calendar-star-date' is included for this purpose:
325 (setq today-visible-calendar-hook 'calendar-star-date)
326 It can also be used to mark the current date with `calendar-today-marker';
327 a function is also provided for this:
328 (setq today-visible-calendar-hook 'calendar-mark-today)
330 The corresponding variable `today-invisible-calendar-hook' is the list of
331 functions called when the calendar function was called when the current
332 date is not visible in the window.
334 Other than the use of the provided functions, the changing of any
335 characters in the calendar buffer by the hooks may cause the failure of the
336 functions that move by days and weeks."
338 :group
'calendar-hooks
)
341 (defcustom today-invisible-calendar-hook nil
342 "List of functions called whenever the current date is not visible.
344 The corresponding variable `today-visible-calendar-hook' is the list of
345 functions called when the calendar function was called when the current
346 date is visible in the window.
348 Other than the use of the provided functions, the changing of any
349 characters in the calendar buffer by the hooks may cause the failure of the
350 functions that move by days and weeks."
352 :group
'calendar-hooks
)
355 (defcustom calendar-move-hook nil
356 "List of functions called whenever the cursor moves in the calendar.
360 (add-hook 'calendar-move-hook (lambda () (diary-view-entries 1)))
362 redisplays the diary for whatever date the cursor is moved to."
364 :group
'calendar-hooks
)
367 (defcustom diary-file
"~/diary"
368 "Name of the file in which one's personal diary of dates is kept.
370 The file's entries are lines beginning with any of the forms
371 specified by the variable `american-date-diary-pattern', by default:
379 with the remainder of the line being the diary entry string for
380 that date. MONTH and DAY are one or two digit numbers, YEAR is a
381 number and may be written in full or abbreviated to the final two
382 digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME
383 and DAYNAME can be spelled in full (as specified by the variables
384 `calendar-month-name-array' and `calendar-day-name-array'),
385 abbreviated (as specified by `calendar-month-abbrev-array' and
386 `calendar-day-abbrev-array') with or without a period,
387 capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be
388 `*' which matches any day, month, or year, respectively. If the
389 date does not contain a year, it is generic and applies to any
390 year. A DAYNAME entry applies to the appropriate day of the week
393 The European style (in which the day precedes the month) can be
394 used instead, if you execute `european-calendar' when in the
395 calendar, or set `european-calendar-style' to t in your .emacs
396 file. The European forms (see `european-date-diary-pattern') are
404 To revert to the default American style from the European style, execute
405 `american-calendar' in the calendar.
407 A diary entry can be preceded by the character
408 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
409 nonmarking--that is, it will not be marked on dates in the calendar
410 window but will appear in a diary window.
412 Multiline diary entries are made by indenting lines after the first with
413 either a TAB or one or more spaces.
415 Lines not in one the above formats are ignored. Here are some sample diary
416 entries (in the default American style):
418 12/22/1988 Twentieth wedding anniversary!!
419 &1/1. Happy New Year!
420 10/22 Ruth's birthday.
422 Tuesday--weekly meeting with grad students at 10am
423 Supowit, Shen, Bitner, and Kapoor to attend.
424 1/13/89 Friday the thirteenth!!
425 &thu 4pm squash game with Lloyd.
426 mar 16 Dad's birthday
427 April 15, 1989 Income tax due.
428 &* 15 time cards due.
430 If the first line of a diary entry consists only of the date or day name with
431 no trailing blanks or punctuation, then that line is not displayed in the
432 diary window; only the continuation lines is shown. For example, the
436 Bill Blattner visits Princeton today
437 2pm Cognitive Studies Committee meeting
438 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
439 4:00pm Jamie Tappenden
440 7:30pm Dinner at George and Ed's for Alan Ryan
441 7:30-10:00pm dance at Stewart Country Day School
443 will appear in the diary window without the date line at the beginning. This
444 facility allows the diary window to look neater, but can cause confusion if
445 used with more than one day's entries displayed.
447 Diary entries can be based on Lisp sexps. For example, the diary entry
449 %%(diary-block 11 1 1990 11 10 1990) Vacation
451 causes the diary entry \"Vacation\" to appear from November 1 through
452 November 10, 1990. Other functions available are `diary-float',
453 `diary-anniversary', `diary-cyclic', `diary-day-of-year',
454 `diary-iso-date', `diary-french-date', `diary-hebrew-date',
455 `diary-islamic-date', `diary-bahai-date', `diary-mayan-date',
456 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
457 `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset',
458 `diary-phases-of-moon', `diary-parasha', `diary-omer',
459 `diary-rosh-hodesh', and `diary-sabbath-candles'. See the
460 documentation for the function `list-sexp-diary-entries' for more
463 Diary entries based on the Hebrew, the Islamic and/or the Baha'i
464 calendar are also possible, but because these are somewhat slow, they
465 are ignored unless you set the `nongregorian-diary-listing-hook' and
466 the `nongregorian-diary-marking-hook' appropriately. See the
467 documentation for these functions for details.
469 Diary files can contain directives to include the contents of other files; for
470 details, see the documentation for the variable `list-diary-entries-hook'."
475 (defcustom diary-nonmarking-symbol
"&"
476 "Symbol indicating that a diary entry is not to be marked in the calendar."
481 (defcustom hebrew-diary-entry-symbol
"H"
482 "Symbol indicating a diary entry according to the Hebrew calendar."
487 (defcustom islamic-diary-entry-symbol
"I"
488 "Symbol indicating a diary entry according to the Islamic calendar."
493 (defcustom bahai-diary-entry-symbol
"B"
494 "Symbol indicating a diary entry according to the Baha'i calendar."
499 (defcustom diary-include-string
"#include"
500 "The string indicating inclusion of another file of diary entries.
501 See the documentation for the function `include-other-diary-files'."
505 (defcustom diary-glob-file-regexp-prefix
"^\\#"
506 "The regular expression that gets pre-pended to each of the attribute-regexp's for file-wide specifiers."
510 (defcustom diary-face-attrs
511 '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string
)
512 (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string
)
513 (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol
)
514 (" *\\[height:\\([-0-9a-z]+\\)\\]$" 1 :height int
)
515 (" *\\[weight:\\([-a-z]+\\)\\]$" 1 :weight symbol
)
516 (" *\\[slant:\\([-a-z]+\\)\\]$" 1 :slant symbol
)
517 (" *\\[underline:\\([-a-z]+\\)\\]$" 1 :underline stringtnil
)
518 (" *\\[overline:\\([-a-z]+\\)\\]$" 1 :overline stringtnil
)
519 (" *\\[strike-through:\\([-a-z]+\\)\\]$" 1 :strike-through stringtnil
)
520 (" *\\[inverse-video:\\([-a-z]+\\)\\]$" 1 :inverse-video tnil
)
521 (" *\\[face:\\([-0-9a-z]+\\)\\]$" 1 :face string
)
522 (" *\\[font:\\([-a-z0-9]+\\)\\]$" 1 :font string
)
524 ;;; (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box)
525 ;;; (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple)
527 "A list of (regexp regnum attr attrtype) lists where the
528 regexp says how to find the tag, the regnum says which
529 parenthetical sub-regexp this regexp looks for, and the attr says
530 which attribute of the face (or that this _is_ a face) is being
535 (defcustom diary-file-name-prefix nil
536 "If non-nil each diary entry is prefixed with the name of the file where it is defined."
541 (defcustom sexp-diary-entry-symbol
"%%"
542 "The string used to indicate a sexp diary entry in `diary-file'.
543 See the documentation for the function `list-sexp-diary-entries'."
548 (defcustom abbreviated-calendar-year t
549 "Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
550 For the Gregorian calendar; similarly for the Hebrew, Islamic and
551 Baha'i calendars. If this variable is nil, years must be written in
557 (defcustom european-calendar-style nil
558 "Use the European style of dates in the diary and in any displays.
559 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
560 1990. The default European date styles (see `european-date-diary-pattern')
569 Names can be capitalized or not, written in full (as specified by the
570 variable `calendar-day-name-array'), or abbreviated (as specified by
571 `calendar-day-abbrev-array') with or without a period.
573 Setting this variable directly does not take effect (if the
574 calendar package is already loaded). Rather, use either
575 \\[customize] or the functions `european-calendar' and
576 `american-calendar'."
578 ;; Without :initialize (require 'calendar) throws an error because
579 ;; american-calendar is undefined at this point.
580 :initialize
'custom-initialize-default
581 :set
(lambda (symbol value
)
584 (american-calendar)))
588 (defcustom american-date-diary-pattern
589 '((month "/" day
"[^/0-9]")
590 (month "/" day
"/" year
"[^0-9]")
591 (monthname " *" day
"[^,0-9]")
592 (monthname " *" day
", *" year
"[^0-9]")
594 "List of pseudo-patterns describing the American patterns of date used.
595 See the documentation of `diary-date-forms' for an explanation."
596 :type
'(repeat (choice (cons :tag
"Backup"
597 :value
(backup . nil
)
599 (repeat (list :inline t
:format
"%v"
600 (symbol :tag
"Keyword")
601 (choice symbol regexp
))))
602 (repeat (list :inline t
:format
"%v"
603 (symbol :tag
"Keyword")
604 (choice symbol regexp
)))))
608 (defcustom european-date-diary-pattern
609 '((day "/" month
"[^/0-9]")
610 (day "/" month
"/" year
"[^0-9]")
611 (backup day
" *" monthname
"\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
612 (day " *" monthname
" *" year
"[^0-9]")
614 "List of pseudo-patterns describing the European patterns of date used.
615 See the documentation of `diary-date-forms' for an explanation."
616 :type
'(repeat (choice (cons :tag
"Backup"
617 :value
(backup . nil
)
619 (repeat (list :inline t
:format
"%v"
620 (symbol :tag
"Keyword")
621 (choice symbol regexp
))))
622 (repeat (list :inline t
:format
"%v"
623 (symbol :tag
"Keyword")
624 (choice symbol regexp
)))))
627 (defcustom diary-date-forms
628 (if european-calendar-style
629 european-date-diary-pattern
630 american-date-diary-pattern
)
631 "List of pseudo-patterns describing the forms of date used in the diary.
632 The patterns on the list must be MUTUALLY EXCLUSIVE and should not match
633 any portion of the diary entry itself, just the date component.
635 A pseudo-pattern is a list of regular expressions and the keywords `month',
636 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
637 match the name of the month (see `calendar-month-name-array'), capitalized
638 or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'),
639 followed by a period or not; it will also match `*'. Similarly, `dayname'
640 will match the name of the day (see `calendar-day-name-array'), capitalized or
641 not, or its user-specified abbreviation (see `calendar-day-abbrev-array'),
642 followed by a period or not. The keywords `month', `day', and `year' will
643 match those numerical values, preceded by arbitrarily many zeros; they will
646 The matching of the diary entries with the date forms is done with the
647 standard syntax table from Fundamental mode, but with the `*' changed so
648 that it is a word constituent.
650 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
651 diary entry itself, the first element of the pattern MUST be `backup'. This
652 directive causes the date recognizer to back up to the beginning of the
653 current word of the diary entry, so in no case can the pattern match more than
654 a portion of the first word of the diary entry."
655 :type
'(repeat (choice (cons :tag
"Backup"
656 :value
(backup . nil
)
658 (repeat (list :inline t
:format
"%v"
659 (symbol :tag
"Keyword")
660 (choice symbol regexp
))))
661 (repeat (list :inline t
:format
"%v"
662 (symbol :tag
"Keyword")
663 (choice symbol regexp
)))))
667 (defcustom european-calendar-display-form
668 '((if dayname
(concat dayname
", ")) day
" " monthname
" " year
)
669 "Pseudo-pattern governing the way a date appears in the European style.
670 See the documentation of `calendar-date-display-form' for an explanation."
675 (defcustom american-calendar-display-form
676 '((if dayname
(concat dayname
", ")) monthname
" " day
", " year
)
677 "Pseudo-pattern governing the way a date appears in the American style.
678 See the documentation of `calendar-date-display-form' for an explanation."
682 (defcustom calendar-date-display-form
683 (if european-calendar-style
684 european-calendar-display-form
685 american-calendar-display-form
)
686 "Pseudo-pattern governing the way a date appears.
688 Used by the function `calendar-date-string', a pseudo-pattern is a list of
689 expressions that can involve the keywords `month', `day', and `year', all
690 numbers in string form, and `monthname' and `dayname', both alphabetic
691 strings. For example, the ISO standard would use the pseudo- pattern
693 '(year \"-\" month \"-\" day)
695 while a typical American form would be
697 '(month \"/\" day \"/\" (substring year -2))
701 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
703 would give the usual American style in fixed-length fields.
705 See the documentation of the function `calendar-date-string'."
709 (defun european-calendar ()
710 "Set the interpretation and display of dates to the European style."
712 (setq european-calendar-style t
)
713 (setq calendar-date-display-form european-calendar-display-form
)
714 (setq diary-date-forms european-date-diary-pattern
)
715 (update-calendar-mode-line))
717 (defun american-calendar ()
718 "Set the interpretation and display of dates to the American style."
720 (setq european-calendar-style nil
)
721 (setq calendar-date-display-form american-calendar-display-form
)
722 (setq diary-date-forms american-date-diary-pattern
)
723 (update-calendar-mode-line))
726 (defcustom print-diary-entries-hook
'lpr-buffer
727 "List of functions called after a temporary diary buffer is prepared.
728 The buffer shows only the diary entries currently visible in the diary
729 buffer. The default just does the printing. Other uses might include, for
730 example, rearranging the lines into order by day and time, saving the buffer
731 instead of deleting it, or changing the function used to do the printing."
736 (defcustom list-diary-entries-hook nil
737 "List of functions called after diary file is culled for relevant entries.
738 It is to be used for diary entries that are not found in the diary file.
740 A function `include-other-diary-files' is provided for use as the value of
741 this hook. This function enables you to use shared diary files together
742 with your own. The files included are specified in the diary file by lines
745 #include \"filename\"
747 This is recursive; that is, #include directives in files thus included are
748 obeyed. You can change the \"#include\" to some other string by changing
749 the variable `diary-include-string'. When you use `include-other-diary-files'
750 as part of the list-diary-entries-hook, you will probably also want to use the
751 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
753 For example, you could use
755 (setq list-diary-entries-hook
756 '(include-other-diary-files sort-diary-entries))
757 (setq diary-display-hook 'fancy-diary-display)
759 in your `.emacs' file to cause the fancy diary buffer to be displayed with
760 diary entries from various included files, each day's entries sorted into
761 lexicographic order."
763 :options
'(include-other-diary-files sort-diary-entries
)
767 (defcustom diary-hook nil
768 "List of functions called after the display of the diary.
769 Can be used for appointment notification."
774 (defcustom diary-display-hook nil
775 "List of functions that handle the display of the diary.
776 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
779 Ordinarily, this just displays the diary buffer (with holidays indicated in
780 the mode line), if there are any relevant entries. At the time these
781 functions are called, the variable `diary-entries-list' is a list, in order
782 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
783 STRING), where string is the diary entry for the given date. This can be
784 used, for example, a different buffer for display (perhaps combined with
785 holidays), or produce hard copy output.
787 A function `fancy-diary-display' is provided as an alternative
788 choice for this hook; this function prepares a special noneditable diary
789 buffer with the relevant diary entries that has neat day-by-day arrangement
790 with headings. The fancy diary buffer will show the holidays unless the
791 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
792 diary buffer will not show days for which there are no diary entries, even
793 if that day is a holiday; if you want such days to be shown in the fancy
794 diary buffer, set the variable `diary-list-include-blanks' to t."
796 :options
'(fancy-diary-display)
800 (defcustom nongregorian-diary-listing-hook nil
801 "List of functions called for listing diary file and included files.
802 As the files are processed for diary entries, these functions are used
803 to cull relevant entries. You can use either or both of
804 `list-hebrew-diary-entries', `list-islamic-diary-entries' and
805 `list-bahai-diary-entries'. The documentation for these functions
806 describes the style of such diary entries."
808 :options
'(list-hebrew-diary-entries
809 list-islamic-diary-entries
810 list-bahai-diary-entries
)
814 (defcustom mark-diary-entries-hook nil
815 "List of functions called after marking diary entries in the calendar.
817 A function `mark-included-diary-files' is also provided for use as the
818 `mark-diary-entries-hook'; it enables you to use shared diary files together
819 with your own. The files included are specified in the diary file by lines
821 #include \"filename\"
822 This is recursive; that is, #include directives in files thus included are
823 obeyed. You can change the \"#include\" to some other string by changing the
824 variable `diary-include-string'. When you use `mark-included-diary-files' as
825 part of the mark-diary-entries-hook, you will probably also want to use the
826 function `include-other-diary-files' as part of `list-diary-entries-hook'."
828 :options
'(mark-included-diary-files)
832 (defcustom nongregorian-diary-marking-hook nil
833 "List of functions called for marking diary file and included files.
834 As the files are processed for diary entries, these functions are used
835 to cull relevant entries. You can use either or both of
836 `mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
837 `mark-bahai-diary-entries'. The documentation for these functions
838 describes the style of such diary entries."
840 :options
'(mark-hebrew-diary-entries
841 mark-islamic-diary-entries
842 mark-bahai-diary-entries
)
846 (defcustom diary-list-include-blanks nil
847 "If nil, do not include days with no diary entry in the list of diary entries.
848 Such days will then not be shown in the fancy diary buffer, even if they
854 (defcustom holidays-in-diary-buffer t
855 "Non-nil means include holidays in the diary display.
856 The holidays appear in the mode line of the diary buffer, or in the
857 fancy diary buffer next to the date. This slows down the diary functions
858 somewhat; setting it to nil makes the diary display faster."
862 (defvar calendar-mark-ring nil
)
865 (put 'general-holidays
'risky-local-variable t
)
867 (defcustom general-holidays
868 '((holiday-fixed 1 1 "New Year's Day")
869 (holiday-float 1 1 3 "Martin Luther King Day")
870 (holiday-fixed 2 2 "Groundhog Day")
871 (holiday-fixed 2 14 "Valentine's Day")
872 (holiday-float 2 1 3 "President's Day")
873 (holiday-fixed 3 17 "St. Patrick's Day")
874 (holiday-fixed 4 1 "April Fools' Day")
875 (holiday-float 5 0 2 "Mother's Day")
876 (holiday-float 5 1 -
1 "Memorial Day")
877 (holiday-fixed 6 14 "Flag Day")
878 (holiday-float 6 0 3 "Father's Day")
879 (holiday-fixed 7 4 "Independence Day")
880 (holiday-float 9 1 1 "Labor Day")
881 (holiday-float 10 1 2 "Columbus Day")
882 (holiday-fixed 10 31 "Halloween")
883 (holiday-fixed 11 11 "Veteran's Day")
884 (holiday-float 11 4 4 "Thanksgiving"))
885 "General holidays. Default value is for the United States.
886 See the documentation for `calendar-holidays' for details."
891 (put 'oriental-holidays
'risky-local-variable t
)
893 (defcustom oriental-holidays
894 '((if (fboundp 'atan
)
895 (holiday-chinese-new-year)))
897 See the documentation for `calendar-holidays' for details."
902 (put 'local-holidays
'risky-local-variable t
)
904 (defcustom local-holidays nil
906 See the documentation for `calendar-holidays' for details."
911 (put 'other-holidays
'risky-local-variable t
)
913 (defcustom other-holidays nil
914 "User defined holidays.
915 See the documentation for `calendar-holidays' for details."
920 (put 'hebrew-holidays-1
'risky-local-variable t
)
922 (defvar hebrew-holidays-1
923 '((holiday-rosh-hashanah-etc)
924 (if all-hebrew-calendar-holidays
927 (let* ((m displayed-month
)
930 (increment-calendar-month m y -
1)
931 (let ((year (extract-calendar-year
932 (calendar-julian-from-absolute
933 (calendar-absolute-from-gregorian
935 (if (zerop (%
(1+ year
) 4))
937 21))) "\"Tal Umatar\" (evening)"))))
940 (put 'hebrew-holidays-2
'risky-local-variable t
)
942 (defvar hebrew-holidays-2
943 '((if all-hebrew-calendar-holidays
945 (holiday-hebrew 9 25 "Hanukkah"))
946 (if all-hebrew-calendar-holidays
949 (let ((h-year (extract-calendar-year
950 (calendar-hebrew-from-absolute
951 (calendar-absolute-from-gregorian
952 (list displayed-month
28 displayed-year
))))))
953 (if (= (%
(calendar-absolute-from-hebrew (list 10 10 h-year
))
958 (if all-hebrew-calendar-holidays
959 (holiday-hebrew 11 15 "Tu B'Shevat"))))
962 (put 'hebrew-holidays-3
'risky-local-variable t
)
964 (defvar hebrew-holidays-3
965 '((if all-hebrew-calendar-holidays
968 (let ((m displayed-month
)
970 (increment-calendar-month m y
1)
971 (let* ((h-year (extract-calendar-year
972 (calendar-hebrew-from-absolute
973 (calendar-absolute-from-gregorian
975 (calendar-last-day-of-month m y
)
978 (calendar-hebrew-from-absolute
980 (%
(calendar-absolute-from-hebrew
984 (calendar-dayname-on-or-before
985 6 (calendar-absolute-from-hebrew
986 (list 11 17 h-year
)))
987 (calendar-dayname-on-or-before
988 6 (calendar-absolute-from-hebrew
989 (list 11 16 h-year
))))))
990 (day (extract-calendar-day s-s
)))
995 (put 'hebrew-holidays-4
'risky-local-variable t
)
997 (defvar hebrew-holidays-4
998 '((holiday-passover-etc)
999 (if (and all-hebrew-calendar-holidays
1000 (let* ((m displayed-month
)
1003 (increment-calendar-month m y -
1)
1004 (let ((year (extract-calendar-year
1005 (calendar-julian-from-absolute
1006 (calendar-absolute-from-gregorian
1008 (= 21 (% year
28)))))
1009 (holiday-julian 3 26 "Kiddush HaHamah"))
1010 (if all-hebrew-calendar-holidays
1011 (holiday-tisha-b-av-etc))))
1014 (put 'hebrew-holidays
'risky-local-variable t
)
1016 (defcustom hebrew-holidays
(append hebrew-holidays-1 hebrew-holidays-2
1017 hebrew-holidays-3 hebrew-holidays-4
)
1019 See the documentation for `calendar-holidays' for details."
1024 (put 'christian-holidays
'risky-local-variable t
)
1026 (defcustom christian-holidays
1027 '((if all-christian-calendar-holidays
1028 (holiday-fixed 1 6 "Epiphany"))
1029 (holiday-easter-etc 0 "Easter Sunday")
1030 (holiday-easter-etc -
2 "Good Friday")
1031 (holiday-easter-etc -
46 "Ash Wednesday")
1032 (if all-christian-calendar-holidays
1033 (holiday-easter-etc -
63 "Septuagesima Sunday"))
1034 (if all-christian-calendar-holidays
1035 (holiday-easter-etc -
56 "Sexagesima Sunday"))
1036 (if all-christian-calendar-holidays
1037 (holiday-easter-etc -
49 "Shrove Sunday"))
1038 (if all-christian-calendar-holidays
1039 (holiday-easter-etc -
48 "Shrove Monday"))
1040 (if all-christian-calendar-holidays
1041 (holiday-easter-etc -
47 "Shrove Tuesday"))
1042 (if all-christian-calendar-holidays
1043 (holiday-easter-etc -
14 "Passion Sunday"))
1044 (if all-christian-calendar-holidays
1045 (holiday-easter-etc -
7 "Palm Sunday"))
1046 (if all-christian-calendar-holidays
1047 (holiday-easter-etc -
3 "Maundy Thursday"))
1048 (if all-christian-calendar-holidays
1049 (holiday-easter-etc 35 "Rogation Sunday"))
1050 (if all-christian-calendar-holidays
1051 (holiday-easter-etc 39 "Ascension Day"))
1052 (if all-christian-calendar-holidays
1053 (holiday-easter-etc 49 "Pentecost (Whitsunday)"))
1054 (if all-christian-calendar-holidays
1055 (holiday-easter-etc 50 "Whitmonday"))
1056 (if all-christian-calendar-holidays
1057 (holiday-easter-etc 56 "Trinity Sunday"))
1058 (if all-christian-calendar-holidays
1059 (holiday-easter-etc 60 "Corpus Christi"))
1060 (if all-christian-calendar-holidays
1061 (holiday-greek-orthodox-easter))
1062 (if all-christian-calendar-holidays
1063 (holiday-fixed 8 15 "Assumption"))
1064 (if all-christian-calendar-holidays
1065 (holiday-advent 0 "Advent"))
1066 (holiday-fixed 12 25 "Christmas")
1067 (if all-christian-calendar-holidays
1068 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
1069 "Christian holidays.
1070 See the documentation for `calendar-holidays' for details."
1075 (put 'islamic-holidays
'risky-local-variable t
)
1077 (defcustom islamic-holidays
1080 (format "Islamic New Year %d"
1081 (let ((m displayed-month
)
1083 (increment-calendar-month m y
1)
1084 (extract-calendar-year
1085 (calendar-islamic-from-absolute
1086 (calendar-absolute-from-gregorian
1088 m
(calendar-last-day-of-month m y
) y
)))))))
1089 (if all-islamic-calendar-holidays
1090 (holiday-islamic 1 10 "Ashura"))
1091 (if all-islamic-calendar-holidays
1092 (holiday-islamic 3 12 "Mulad-al-Nabi"))
1093 (if all-islamic-calendar-holidays
1094 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
1095 (if all-islamic-calendar-holidays
1096 (holiday-islamic 8 15 "Shab-e-Bara't"))
1097 (holiday-islamic 9 1 "Ramadan Begins")
1098 (if all-islamic-calendar-holidays
1099 (holiday-islamic 9 27 "Shab-e Qadr"))
1100 (if all-islamic-calendar-holidays
1101 (holiday-islamic 10 1 "Id-al-Fitr"))
1102 (if all-islamic-calendar-holidays
1103 (holiday-islamic 12 10 "Id-al-Adha")))
1105 See the documentation for `calendar-holidays' for details."
1110 (put 'bahai-holidays
'risky-local-variable t
)
1112 (defcustom bahai-holidays
1115 (format "Baha'i New Year (Naw-Ruz) %d" (- displayed-year
(1- 1844))))
1116 (holiday-fixed 4 21 "First Day of Ridvan")
1117 (if all-bahai-calendar-holidays
1118 (holiday-fixed 4 22 "Second Day of Ridvan"))
1119 (if all-bahai-calendar-holidays
1120 (holiday-fixed 4 23 "Third Day of Ridvan"))
1121 (if all-bahai-calendar-holidays
1122 (holiday-fixed 4 24 "Fourth Day of Ridvan"))
1123 (if all-bahai-calendar-holidays
1124 (holiday-fixed 4 25 "Fifth Day of Ridvan"))
1125 (if all-bahai-calendar-holidays
1126 (holiday-fixed 4 26 "Sixth Day of Ridvan"))
1127 (if all-bahai-calendar-holidays
1128 (holiday-fixed 4 27 "Seventh Day of Ridvan"))
1129 (if all-bahai-calendar-holidays
1130 (holiday-fixed 4 28 "Eighth Day of Ridvan"))
1131 (holiday-fixed 4 29 "Ninth Day of Ridvan")
1132 (if all-bahai-calendar-holidays
1133 (holiday-fixed 4 30 "Tenth Day of Ridvan"))
1134 (if all-bahai-calendar-holidays
1135 (holiday-fixed 5 1 "Eleventh Day of Ridvan"))
1136 (holiday-fixed 5 2 "Twelfth Day of Ridvan")
1137 (holiday-fixed 5 23 "Declaration of the Bab")
1138 (holiday-fixed 5 29 "Ascension of Baha'u'llah")
1139 (holiday-fixed 7 9 "Martyrdom of the Bab")
1140 (holiday-fixed 10 20 "Birth of the Bab")
1141 (holiday-fixed 11 12 "Birth of Baha'u'llah")
1142 (if all-bahai-calendar-holidays
1143 (holiday-fixed 11 26 "Day of the Covenant"))
1144 (if all-bahai-calendar-holidays
1145 (holiday-fixed 11 28 "Ascension of `Abdu'l-Baha")))
1147 See the documentation for `calendar-holidays' for details."
1152 (put 'solar-holidays
'risky-local-variable t
)
1154 (defcustom solar-holidays
1155 '((if (fboundp 'atan
)
1156 (solar-equinoxes-solstices))
1162 calendar-daylight-savings-starts
1163 '(format "Daylight Savings Time Begins %s"
1166 (/ calendar-daylight-savings-starts-time
(float 60))
1167 calendar-standard-time-zone-name
)
1171 calendar-daylight-savings-ends
1172 '(format "Daylight Savings Time Ends %s"
1175 (/ calendar-daylight-savings-ends-time
(float 60))
1176 calendar-daylight-time-zone-name
)
1178 "Sun-related holidays.
1179 See the documentation for `calendar-holidays' for details."
1184 (put 'calendar-holidays
'risky-local-variable t
)
1185 (defcustom calendar-holidays
1186 (append general-holidays local-holidays other-holidays
1187 christian-holidays hebrew-holidays islamic-holidays
1188 bahai-holidays oriental-holidays solar-holidays
)
1189 "List of notable days for the command \\[holidays].
1191 Additional holidays are easy to add to the list, just put them in the
1192 list `other-holidays' in your .emacs file. Similarly, by setting any
1193 of `general-holidays', `local-holidays' `christian-holidays',
1194 `hebrew-holidays', `islamic-holidays', `bahai-holidays',
1195 `oriental-holidays', or `solar-holidays' to nil in your .emacs file,
1196 you can eliminate unwanted categories of holidays.
1198 The aforementioned variables control the holiday choices offered
1199 by the function `list-holidays' when it is called interactively.
1201 They also initialize the default value of `calendar-holidays',
1202 which is the default list of holidays used by the function
1203 `list-holidays' in the non-interactive case. Note that these
1204 variables have no effect on `calendar-holidays' after it has been
1205 set (e.g. after the calendar is loaded). In that case, customize
1206 `calendar-holidays' directly.
1208 The intention is that (in the US) `local-holidays' be set in
1209 site-init.el and `other-holidays' be set by the user.
1211 Entries on the list are expressions that return (possibly empty) lists of
1212 items of the form ((month day year) string) of a holiday in the in the
1213 three-month period centered around `displayed-month' of `displayed-year'.
1214 Several basic functions are provided for this purpose:
1216 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1217 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1218 MONTH on the Gregorian calendar (0 for Sunday,
1219 etc.); K<0 means count back from the end of the
1220 month. An optional parameter DAY means the Kth
1221 DAYNAME after/before MONTH DAY.
1222 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1223 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1224 (holiday-bahai MONTH DAY STRING) a fixed date on the Baha'i calendar
1225 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1226 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
1227 in the variable `year'; if it evaluates to
1228 a visible date, that's the holiday; if it
1229 evaluates to nil, there's no holiday. STRING
1230 is an expression in the variable `date'.
1232 For example, to add Bastille Day, celebrated in France on July 14, add
1234 (holiday-fixed 7 14 \"Bastille Day\")
1236 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1237 Islands on the fourth Monday in August, add
1239 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
1241 to the list (the last Monday would be specified with `-1' instead of `4').
1242 To add the last day of Hanukkah to the list, use
1244 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
1246 since the Hebrew months are numbered with 1 starting from Nisan, while to
1247 add the Islamic feast celebrating Mohammed's birthday use
1249 (holiday-islamic 3 12 \"Mohammed's Birthday\")
1251 since the Islamic months are numbered from 1 starting with Muharram. To
1252 add an entry for the Baha'i festival of Ridvan, use
1254 (holiday-bahai 2 13 \"Festival of Ridvan\")
1256 since the Baha'i months are numbered from 1 starting with Baha. To
1257 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1259 (holiday-julian 4 2 \"Jefferson's Birthday\")
1261 To include a holiday conditionally, use the sexp form or a conditional. For
1262 example, to include American presidential elections, which occur on the first
1263 Tuesday after the first Monday in November of years divisible by 4, add
1266 '(if (zerop (% year 4))
1267 (calendar-gregorian-from-absolute
1268 (1+ (calendar-dayname-on-or-before
1269 1 (+ 6 (calendar-absolute-from-gregorian
1270 (list 11 1 year)))))))
1271 \"US Presidential Election\")
1275 (if (zerop (% displayed-year 4))
1277 (extract-calendar-day
1278 (calendar-gregorian-from-absolute
1279 (1+ (calendar-dayname-on-or-before
1280 1 (+ 6 (calendar-absolute-from-gregorian
1281 (list 11 1 displayed-year)))))))
1282 \"US Presidential Election\"))
1284 to the list. To include the phases of the moon, add
1288 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1289 you've written to return a (possibly empty) list of the relevant VISIBLE dates
1290 with descriptive strings such as
1292 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
1296 (defconst holiday-buffer
"*Holidays*"
1297 "Name of the buffer used for the displaying the holidays.")
1299 (defconst fancy-diary-buffer
"*Fancy Diary Entries*"
1300 "Name of the buffer used for the optional fancy display of the diary.")
1302 (defconst other-calendars-buffer
"*Other Calendars*"
1303 "Name of the buffer used for the display of date on other calendars.")
1305 (defconst lunar-phases-buffer
"*Phases of Moon*"
1306 "Name of the buffer used for the lunar phases.")
1308 (defmacro increment-calendar-month
(mon yr n
)
1309 "Increment the variables MON and YR by N months.
1310 Forward if N is positive or backward if N is negative.
1311 A negative YR is interpreted as BC; -1 being 1 BC, and so on."
1313 (if (< ,yr
0) (setq ,yr
(1+ ,yr
))) ; -1 BC -> 0 AD, etc
1314 (setq macro-y
(+ (* ,yr
12) ,mon -
1 ,n
)
1315 ,mon
(1+ (mod macro-y
12))
1317 (and (< macro-y
0) (> ,mon
1) (setq ,yr
(1- ,yr
)))
1318 (if (< ,yr
1) (setq ,yr
(1- ,yr
))))) ; 0 AD -> -1 BC, etc
1320 (defun calendar-increment-month (n &optional mon yr
)
1321 "Return the Nth month after MON/YR.
1322 The return value is a pair (MONTH . YEAR).
1323 MON defaults to `displayed-month'. YR defaults to `displayed-year'."
1324 (unless mon
(setq mon displayed-month
))
1325 (unless yr
(setq yr displayed-year
))
1326 (increment-calendar-month mon yr n
)
1329 (defmacro calendar-for-loop
(var from init to final do
&rest body
)
1330 "Execute a for loop."
1331 (declare (debug (symbolp "from" form
"to" form
"do" body
)))
1332 `(let ((,var
(1- ,init
)))
1333 (while (>= ,final
(setq ,var
(1+ ,var
)))
1336 (defmacro calendar-sum
(index initial condition expression
)
1337 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
1338 (declare (debug (symbolp form form form
)))
1339 `(let ((,index
,initial
)
1342 (setq sum
(+ sum
,expression
))
1343 (setq ,index
(1+ ,index
)))
1346 ;; The following are in-line for speed; they can be called thousands of times
1347 ;; when looking up holidays or processing the diary. Here, for example, are
1348 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1349 ;; fancy diary display, for a moderately complex diary file, with functions
1350 ;; used instead of macros. There were a total of 10000 such calls:
1352 ;; 1934 extract-calendar-month
1353 ;; 1852 extract-calendar-year
1354 ;; 1819 extract-calendar-day
1355 ;; 845 calendar-leap-year-p
1356 ;; 837 calendar-day-number
1357 ;; 775 calendar-absolute-from-gregorian
1358 ;; 346 calendar-last-day-of-month
1359 ;; 286 hebrew-calendar-last-day-of-month
1360 ;; 188 hebrew-calendar-leap-year-p
1361 ;; 180 hebrew-calendar-elapsed-days
1362 ;; 163 hebrew-calendar-last-month-of-year
1363 ;; 66 calendar-date-compare
1364 ;; 65 hebrew-calendar-days-in-year
1365 ;; 60 calendar-absolute-from-julian
1366 ;; 50 calendar-absolute-from-hebrew
1367 ;; 43 calendar-date-equal
1368 ;; 38 calendar-gregorian-from-absolute
1373 ;; The use of these seven macros eliminates the overhead of 92% of the function
1374 ;; calls; it's faster this way.
1376 (defsubst extract-calendar-month
(date)
1377 "Extract the month part of DATE which has the form (month day year)."
1380 ;; Note gives wrong answer for result of (calendar-read-date 'noday).
1381 (defsubst extract-calendar-day
(date)
1382 "Extract the day part of DATE which has the form (month day year)."
1385 (defsubst extract-calendar-year
(date)
1386 "Extract the year part of DATE which has the form (month day year)."
1387 (car (cdr (cdr date
))))
1389 (defsubst calendar-leap-year-p
(year)
1390 "Return t if YEAR is a Gregorian leap year.
1391 A negative year is interpreted as BC; -1 being 1 BC, and so on."
1392 ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc.
1393 (if (< year
0) (setq year
(1- (abs year
))))
1394 (and (zerop (% year
4))
1395 (or (not (zerop (% year
100)))
1396 (zerop (% year
400)))))
1398 ;; The foregoing is a bit faster, but not as clear as the following:
1400 ;;(defsubst calendar-leap-year-p (year)
1401 ;; "Returns t if YEAR is a Gregorian leap year."
1403 ;; (and (= (% year 4) 0)
1404 ;; (/= (% year 100) 0))
1405 ;; (= (% year 400) 0)))
1407 (defsubst calendar-last-day-of-month
(month year
)
1408 "The last day in MONTH during YEAR."
1409 (if (and (= month
2) (calendar-leap-year-p year
))
1411 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month
))))
1413 ;; An explanation of the calculation can be found in PascAlgorithms by
1414 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1416 (defsubst calendar-day-number
(date)
1417 "Return the day number within the year of the date DATE.
1418 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1419 while (calendar-day-number '(12 31 1980)) returns 366."
1420 (let* ((month (extract-calendar-month date
))
1421 (day (extract-calendar-day date
))
1422 (year (extract-calendar-year date
))
1423 (day-of-year (+ day
(* 31 (1- month
)))))
1426 (setq day-of-year
(- day-of-year
(/ (+ 23 (* 4 month
)) 10)))
1427 (if (calendar-leap-year-p year
)
1428 (setq day-of-year
(1+ day-of-year
)))))
1431 (defsubst calendar-absolute-from-gregorian
(date)
1432 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1433 The Gregorian date Sunday, December 31, 1 BC is imaginary.
1434 DATE is a list of the form (month day year). A negative year is
1435 interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC
1436 return negative results."
1437 (let ((year (extract-calendar-year date
))
1440 (error "There was no year zero"))
1442 (setq offset-years
(1- year
))
1443 (+ (calendar-day-number date
) ; Days this year
1444 (* 365 offset-years
) ; + Days in prior years
1445 (/ offset-years
4) ; + Julian leap years
1446 (- (/ offset-years
100)) ; - century years
1447 (/ offset-years
400))) ; + Gregorian leap years
1449 ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc).
1450 (setq offset-years
(abs (1+ year
)))
1451 (- (calendar-day-number date
)
1452 (* 365 offset-years
)
1454 (- (/ offset-years
100))
1455 (/ offset-years
400)
1456 (calendar-day-number '(12 31 -
1))))))) ; days in year 1 BC
1458 (autoload 'calendar-goto-today
"cal-move"
1459 "Reposition the calendar window so the current date is visible."
1462 (autoload 'calendar-forward-month
"cal-move"
1463 "Move the cursor forward ARG months."
1466 (autoload 'calendar-forward-year
"cal-move"
1467 "Move the cursor forward by ARG years."
1470 (autoload 'calendar-backward-month
"cal-move"
1471 "Move the cursor backward by ARG months."
1474 (autoload 'calendar-backward-year
"cal-move"
1475 "Move the cursor backward ARG years."
1478 (autoload 'scroll-calendar-left
"cal-move"
1479 "Scroll the displayed calendar left by ARG months."
1482 (autoload 'scroll-calendar-right
"cal-move"
1483 "Scroll the displayed calendar window right by ARG months."
1486 (autoload 'scroll-calendar-left-three-months
"cal-move"
1487 "Scroll the displayed calendar window left by 3*ARG months."
1490 (autoload 'scroll-calendar-right-three-months
"cal-move"
1491 "Scroll the displayed calendar window right by 3*ARG months."
1494 (autoload 'calendar-cursor-to-nearest-date
"cal-move"
1495 "Move the cursor to the closest date."
1498 (autoload 'calendar-forward-day
"cal-move"
1499 "Move the cursor forward ARG days."
1502 (autoload 'calendar-backward-day
"cal-move"
1503 "Move the cursor back ARG days."
1506 (autoload 'calendar-forward-week
"cal-move"
1507 "Move the cursor forward ARG weeks."
1510 (autoload 'calendar-backward-week
"cal-move"
1511 "Move the cursor back ARG weeks."
1514 (autoload 'calendar-beginning-of-week
"cal-move"
1515 "Move the cursor back ARG calendar-week-start-day's."
1518 (autoload 'calendar-end-of-week
"cal-move"
1519 "Move the cursor forward ARG calendar-week-start-day+6's."
1522 (autoload 'calendar-beginning-of-month
"cal-move"
1523 "Move the cursor backward ARG month beginnings."
1526 (autoload 'calendar-end-of-month
"cal-move"
1527 "Move the cursor forward ARG month ends."
1530 (autoload 'calendar-beginning-of-year
"cal-move"
1531 "Move the cursor backward ARG year beginnings."
1534 (autoload 'calendar-end-of-year
"cal-move"
1535 "Move the cursor forward ARG year beginnings."
1538 (autoload 'calendar-cursor-to-visible-date
"cal-move"
1539 "Move the cursor to DATE that is on the screen."
1542 (autoload 'calendar-goto-date
"cal-move"
1543 "Move cursor to DATE."
1546 (autoload 'calendar-goto-day-of-year
"cal-move"
1547 "Move cursor to day of year."
1550 (autoload 'calendar-only-one-frame-setup
"cal-x"
1551 "Start calendar and display it in a dedicated frame.")
1553 (autoload 'calendar-one-frame-setup
"cal-x"
1554 "Start calendar and display it in a dedicated frame together with the diary.")
1556 (autoload 'calendar-two-frame-setup
"cal-x"
1557 "Start calendar and diary in separate, dedicated frames.")
1560 (defcustom calendar-setup nil
1561 "The frame setup of the calendar.
1562 The choices are: `one-frame' (calendar and diary together in one separate,
1563 dedicated frame); `two-frames' (calendar and diary in separate, dedicated
1564 frames); `calendar-only' (calendar in a separate, dedicated frame); with
1565 any other value the current frame is used. Using any of the first
1566 three options overrides the value of `view-diary-entries-initially'."
1568 (const :tag
"calendar and diary in separate frame" one-frame
)
1569 (const :tag
"calendar and diary each in own frame" two-frames
)
1570 (const :tag
"calendar in separate frame" calendar-only
)
1571 (const :tag
"use current frame" nil
))
1574 (defcustom calendar-minimum-window-height
8
1575 "Minimum height `generate-calendar-window' should use for calendar window."
1581 (defun calendar (&optional arg
)
1582 "Choose between the one frame, two frame, or basic calendar displays.
1583 If called with an optional prefix argument, prompts for month and year.
1585 The original function `calendar' has been renamed `calendar-basic-setup'.
1586 See the documentation of that function for more information."
1588 (cond ((equal calendar-setup
'one-frame
) (calendar-one-frame-setup arg
))
1589 ((equal calendar-setup
'two-frames
) (calendar-two-frame-setup arg
))
1590 ((equal calendar-setup
'calendar-only
)
1591 (calendar-only-one-frame-setup arg
))
1592 (t (calendar-basic-setup arg
))))
1594 (autoload 'diary-view-entries
"diary-lib"
1595 "Prepare and display a buffer with diary entries.
1596 Searches your diary file for entries that match ARG days starting with
1597 the date indicated by the cursor position in the displayed three-month
1601 (autoload 'list-calendar-holidays
"holidays"
1602 "Create a buffer containing the holidays for the current calendar window.
1603 The holidays are those in the list `calendar-notable-days'. Returns t if any
1604 holidays are found, nil if not."
1607 (defun calendar-basic-setup (&optional arg
)
1608 "Display a three-month calendar in another window.
1609 The three months appear side by side, with the current month in the middle
1610 surrounded by the previous and next months. The cursor is put on today's date.
1612 If called with an optional prefix argument, prompts for month and year.
1614 This function is suitable for execution in a .emacs file; appropriate setting
1615 of the variable `view-diary-entries-initially' will cause the diary entries for
1616 the current date to be displayed in another window. The value of the variable
1617 `number-of-diary-entries' controls the number of days of diary entries
1618 displayed upon initial display of the calendar.
1620 Once in the calendar window, future or past months can be moved into view.
1621 Arbitrary months can be displayed, or the calendar can be scrolled forward
1624 The cursor can be moved forward or backward by one day, one week, one month,
1625 or one year. All of these commands take prefix arguments which, when negative,
1626 cause movement in the opposite direction. For convenience, the digit keys
1627 and the minus sign are automatically prefixes. The window is replotted as
1628 necessary to display the desired date.
1630 Diary entries can be marked on the calendar or displayed in another window.
1632 Use \\[describe-mode] for details of the key bindings in the calendar window.
1634 The Gregorian calendar is assumed.
1636 After loading the calendar, the hooks given by the variable
1637 `calendar-load-hook' are run. This is the place to add key bindings to the
1640 After preparing the calendar window initially, the hooks given by the variable
1641 `initial-calendar-window-hook' are run.
1643 The hooks given by the variable `today-visible-calendar-hook' are run
1644 every time the calendar window gets scrolled, if the current date is visible
1645 in the window. If it is not visible, the hooks given by the variable
1646 `today-invisible-calendar-hook' are run. Thus, for example, setting
1647 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1648 to be replaced by asterisks to highlight it whenever it is in the window."
1650 (set-buffer (get-buffer-create calendar-buffer
))
1652 (let* ((pop-up-windows t
)
1653 (split-height-threshold 1000)
1655 (calendar-read-date t
)
1656 (calendar-current-date)))
1657 (month (extract-calendar-month date
))
1658 (year (extract-calendar-year date
)))
1659 ;; (calendar-read-date t) returns a date with day = nil, which is
1660 ;; not a legal date for the visible test in the diary section.
1661 (if arg
(setcar (cdr date
) 1))
1662 (pop-to-buffer calendar-buffer
)
1663 (increment-calendar-month month year
(- calendar-offset
))
1664 (generate-calendar-window month year
)
1665 (if (and view-diary-entries-initially
(calendar-date-is-visible-p date
))
1666 (diary-view-entries)))
1667 (let* ((diary-buffer (get-file-buffer diary-file
))
1668 (diary-window (if diary-buffer
(get-buffer-window diary-buffer
)))
1669 (split-height-threshold (if diary-window
2 1000)))
1670 (if view-calendar-holidays-initially
1671 (list-calendar-holidays)))
1672 (run-hooks 'initial-calendar-window-hook
))
1674 (autoload 'view-other-diary-entries
"diary-lib"
1675 "Prepare and display buffer of diary entries from an alternative diary file.
1676 Searches for entries that match ARG days, starting with the date indicated
1677 by the cursor position in the displayed three-month calendar.
1678 D-FILE specifies the file to use as the diary file."
1681 (autoload 'calendar-sunrise-sunset
"solar"
1682 "Local time of sunrise and sunset for date under cursor."
1685 (autoload 'calendar-phases-of-moon
"lunar"
1686 "Create a buffer of the phases of the moon for the current calendar window."
1689 (autoload 'calendar-print-french-date
"cal-french"
1690 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1693 (autoload 'calendar-goto-french-date
"cal-french"
1694 "Move cursor to French Revolutionary date."
1697 (autoload 'calendar-french-date-string
"cal-french"
1698 "String of French Revolutionary date of Gregorian date.")
1700 (autoload 'calendar-mayan-date-string
"cal-mayan"
1701 "String of Mayan date of Gregorian date.")
1703 (autoload 'calendar-print-mayan-date
"cal-mayan"
1704 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1707 (autoload 'calendar-goto-mayan-long-count-date
"cal-mayan"
1708 "Move cursor to Mayan long count date."
1711 (autoload 'calendar-next-haab-date
"cal-mayan"
1712 "Move cursor to next instance of Mayan Haab date."
1715 (autoload 'calendar-previous-haab-date
"cal-mayan"
1716 "Move cursor to previous instance of Mayan Haab date."
1719 (autoload 'calendar-next-tzolkin-date
"cal-mayan"
1720 "Move cursor to next instance of Mayan Tzolkin date."
1723 (autoload 'calendar-previous-tzolkin-date
"cal-mayan"
1724 "Move cursor to previous instance of Mayan Tzolkin date."
1727 (autoload 'calendar-next-calendar-round-date
"cal-mayan"
1728 "Move cursor to next instance of Mayan Haab/Tzolkin combination."
1731 (autoload 'calendar-previous-calendar-round-date
"cal-mayan"
1732 "Move cursor to previous instance of Mayan Haab/Tzolkin combination."
1735 (autoload 'calendar-goto-chinese-date
"cal-china"
1736 "Move cursor to Chinese date."
1739 (autoload 'calendar-print-chinese-date
"cal-china"
1740 "Show the Chinese date equivalents of date."
1743 (autoload 'calendar-chinese-date-string
"cal-china"
1744 "String of Chinese date of Gregorian date.")
1746 (autoload 'calendar-absolute-from-astro
"cal-julian"
1747 "Absolute date of astronomical (Julian) day number D."
1750 (autoload 'calendar-astro-from-absolute
"cal-julian"
1751 "Astronomical (Julian) day number of absolute date D.")
1753 (autoload 'calendar-astro-date-string
"cal-julian"
1754 "String of astronomical (Julian) day number of Gregorian date.")
1756 (autoload 'calendar-goto-astro-day-number
"cal-julian"
1757 "Move cursor to astronomical (Julian) day number."
1760 (autoload 'calendar-print-astro-day-number
"cal-julian"
1761 "Show the astro date equivalents of date."
1764 (autoload 'calendar-julian-from-absolute
"cal-julian"
1765 "Compute the Julian (month day year) corresponding to the absolute DATE.
1766 The absolute date is the number of days elapsed since the (imaginary)
1767 Gregorian date Sunday, December 31, 1 BC.")
1769 (autoload 'calendar-goto-julian-date
"cal-julian"
1770 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1773 (autoload 'calendar-print-julian-date
"cal-julian"
1774 "Show the Julian calendar equivalent of the date under the cursor."
1777 (autoload 'calendar-julian-date-string
"cal-julian"
1778 "String of Julian date of Gregorian DATE.
1779 Defaults to today's date if DATE is not given.
1780 Driven by the variable `calendar-date-display-form'.")
1782 (autoload 'calendar-goto-iso-date
"cal-iso"
1783 "Move cursor to ISO date."
1786 (autoload 'calendar-goto-iso-week
"cal-iso"
1787 "Move cursor to start of ISO week."
1790 (autoload 'calendar-print-iso-date
"cal-iso"
1791 "Show the ISO date equivalents of date."
1794 (autoload 'calendar-iso-date-string
"cal-iso"
1795 "String of ISO date of Gregorian date.")
1797 (autoload 'calendar-goto-islamic-date
"cal-islam"
1798 "Move cursor to Islamic date."
1801 (autoload 'calendar-print-islamic-date
"cal-islam"
1802 "Show the Islamic date equivalents of date."
1805 (autoload 'calendar-islamic-date-string
"cal-islam"
1806 "String of Islamic date of Gregorian date.")
1808 (autoload 'calendar-print-bahai-date
"cal-bahai"
1809 "Show the Baha'i date equivalents of date."
1812 (autoload 'calendar-bahai-date-string
"cal-bahai"
1813 "String of Baha'i date of Gregorian date.")
1815 (autoload 'calendar-goto-hebrew-date
"cal-hebrew"
1816 "Move cursor to Hebrew date."
1819 (autoload 'calendar-print-hebrew-date
"cal-hebrew"
1820 "Show the Hebrew date equivalents of date."
1823 (autoload 'calendar-hebrew-date-string
"cal-hebrew"
1824 "String of Hebrew date of Gregorian date.")
1826 (autoload 'calendar-goto-coptic-date
"cal-coptic"
1827 "Move cursor to Coptic date."
1830 (autoload 'calendar-print-coptic-date
"cal-coptic"
1831 "Show the Coptic date equivalents of date."
1834 (autoload 'calendar-coptic-date-string
"cal-coptic"
1835 "String of Coptic date of Gregorian date.")
1837 (autoload 'calendar-goto-ethiopic-date
"cal-coptic"
1838 "Move cursor to Ethiopic date."
1841 (autoload 'calendar-print-ethiopic-date
"cal-coptic"
1842 "Show the Ethiopic date equivalents of date."
1845 (autoload 'calendar-ethiopic-date-string
"cal-coptic"
1846 "String of Ethiopic date of Gregorian date.")
1848 (autoload 'calendar-goto-persian-date
"cal-persia"
1849 "Move cursor to Persian date."
1852 (autoload 'calendar-print-persian-date
"cal-persia"
1853 "Show the Persian date equivalents of date."
1856 (autoload 'calendar-persian-date-string
"cal-persia"
1857 "String of Persian date of Gregorian date.")
1859 (autoload 'diary-show-all-entries
"diary-lib"
1860 "Show all of the diary entries in the diary file.
1861 This function gets rid of the selective display of the diary file so that
1862 all entries, not just some, are visible. If there is no diary buffer, one
1866 (autoload 'mark-diary-entries
"diary-lib"
1867 "Mark days in the calendar window that have diary entries.
1868 Each entry in diary file visible in the calendar window is marked."
1871 (autoload 'make-diary-entry
"diary-lib"
1872 "Insert a diary entry STRING which may be NONMARKING in FILE.")
1874 (autoload 'insert-diary-entry
"diary-lib"
1875 "Insert a diary entry for the date indicated by point."
1878 (autoload 'insert-weekly-diary-entry
"diary-lib"
1879 "Insert a weekly diary entry for the day of the week indicated by point."
1883 (autoload 'insert-monthly-diary-entry
"diary-lib"
1884 "Insert a monthly diary entry for the day of the month indicated by point."
1887 (autoload 'insert-yearly-diary-entry
"diary-lib"
1888 "Insert an annual diary entry for the day of the year indicated by point."
1891 (autoload 'insert-anniversary-diary-entry
"diary-lib"
1892 "Insert an anniversary diary entry for the date indicated by point."
1895 (autoload 'insert-block-diary-entry
"diary-lib"
1896 "Insert a block diary entry for the dates indicated by point and mark."
1899 (autoload 'insert-cyclic-diary-entry
"diary-lib"
1900 "Insert a cyclic diary entry starting at the date indicated by point."
1903 (autoload 'insert-hebrew-diary-entry
"cal-hebrew"
1904 "Insert a diary entry for the Hebrew date corresponding to the date
1905 indicated by point."
1908 (autoload 'insert-monthly-hebrew-diary-entry
"cal-hebrew"
1909 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1910 to the date indicated by point."
1913 (autoload 'insert-yearly-hebrew-diary-entry
"cal-hebrew"
1914 "Insert an annual diary entry for the day of the Hebrew year corresponding
1915 to the date indicated by point."
1918 (autoload 'insert-islamic-diary-entry
"cal-islam"
1919 "Insert a diary entry for the Islamic date corresponding to the date
1920 indicated by point."
1923 (autoload 'insert-monthly-islamic-diary-entry
"cal-islam"
1924 "Insert a monthly diary entry for the day of the Islamic month corresponding
1925 to the date indicated by point."
1928 (autoload 'insert-yearly-islamic-diary-entry
"cal-islam"
1929 "Insert an annual diary entry for the day of the Islamic year corresponding
1930 to the date indicated by point."
1933 (autoload 'insert-bahai-diary-entry
"cal-bahai"
1934 "Insert a diary entry for the Baha'i date corresponding to the date
1935 indicated by point."
1938 (autoload 'insert-monthly-bahai-diary-entry
"cal-bahai"
1939 "Insert a monthly diary entry for the day of the Baha'i month corresponding
1940 to the date indicated by point."
1943 (autoload 'insert-yearly-bahai-diary-entry
"cal-bahai"
1944 "Insert an annual diary entry for the day of the Baha'i year corresponding
1945 to the date indicated by point."
1948 (autoload 'cal-tex-cursor-month
"cal-tex"
1949 "Make a buffer with LaTeX commands for the month cursor is on.
1950 Optional prefix argument specifies number of months to be produced.
1951 Calendar is condensed onto one page." t
)
1953 (autoload 'cal-tex-cursor-month-landscape
"cal-tex"
1954 "Make a buffer with LaTeX commands for the month cursor is on.
1955 Optional prefix argument specifies number of months to be produced." t
)
1957 (autoload 'cal-tex-cursor-day
"cal-tex"
1958 "Make a buffer with LaTeX commands for the day cursor is on." t
)
1960 (autoload 'cal-tex-cursor-week
"cal-tex"
1961 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1962 It applies to the week that point is in.
1963 Optional prefix argument specifies number of weeks.
1964 Holidays are included if `cal-tex-holidays' is t." t
)
1966 (autoload 'cal-tex-cursor-week2
"cal-tex"
1967 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1968 It applies to the week that point is in.
1969 Optional prefix argument specifies number of weeks.
1970 Holidays are included if `cal-tex-holidays' is t." t
)
1972 (autoload 'cal-tex-cursor-week-iso
"cal-tex"
1973 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
1974 Optional prefix argument specifies number of weeks.
1975 Diary entries are included if `cal-tex-diary' is t.
1976 Holidays are included if `cal-tex-holidays' is t." t
)
1978 (autoload 'cal-tex-cursor-week-monday
"cal-tex"
1979 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1980 It applies to the week that point is in, and starts on Monday.
1981 Optional prefix argument specifies number of weeks.
1982 Holidays are included if `cal-tex-holidays' is t." t
)
1984 (autoload 'cal-tex-cursor-filofax-2week
"cal-tex"
1985 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
1986 Optional prefix argument specifies number of weeks.
1987 Diary entries are included if cal-tex-diary is t.
1988 Holidays are included if `cal-tex-holidays' is t." t
)
1990 (autoload 'cal-tex-cursor-filofax-week
"cal-tex"
1991 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
1992 Optional prefix argument specifies number of weeks.
1993 Weeks start on Monday.
1994 Diary entries are included if cal-tex-diary is t.
1995 Holidays are included if `cal-tex-holidays' is t." t
)
1997 (autoload 'cal-tex-cursor-filofax-daily
"cal-tex"
1998 "Day-per-page Filofax style calendar for week indicated by cursor.
1999 Optional prefix argument specifies number of weeks. Weeks start on Monday.
2000 Diary entries are included if `cal-tex-diary' is t.
2001 Holidays are included if `cal-tex-holidays' is t." t
)
2003 (autoload 'cal-tex-cursor-year
"cal-tex"
2004 "Make a buffer with LaTeX commands for a year's calendar.
2005 Optional prefix argument specifies number of years." t
)
2007 (autoload 'cal-tex-cursor-year-landscape
"cal-tex"
2008 "Make a buffer with LaTeX commands for a year's calendar (landscape).
2009 Optional prefix argument specifies number of years." t
)
2011 (autoload 'cal-tex-cursor-filofax-year
"cal-tex"
2012 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
2013 Optional prefix argument specifies number of years." t
)
2015 (autoload 'cal-html-cursor-month
"cal-html"
2016 "Write an HTML calendar file for numeric MONTH of four-digit YEAR.
2017 The output directory DIR is created if necessary. Interactively,
2018 MONTH and YEAR are taken from the calendar cursor position. Note
2019 that any existing output files are overwritten." t
)
2021 (autoload 'cal-html-cursor-year
"cal-html"
2022 "Write HTML calendar files (index and monthly pages) for four-digit YEAR.
2023 The output directory DIR is created if necessary. Interactively,
2024 YEAR is taken from the calendar cursor position. Note that any
2025 existing output files are overwritten." t
)
2027 (autoload 'mark-calendar-holidays
"holidays"
2028 "Mark notable days in the calendar window."
2031 (autoload 'calendar-cursor-holidays
"holidays"
2032 "Find holidays for the date specified by the cursor in the calendar window."
2035 (defun generate-calendar-window (&optional mon yr
)
2036 "Generate the calendar window for the current date.
2037 Or, for optional MON, YR."
2038 (let* ((buffer-read-only nil
)
2039 (today (calendar-current-date))
2040 (month (extract-calendar-month today
))
2041 (day (extract-calendar-day today
))
2042 (year (extract-calendar-year today
))
2045 (let ((offset (calendar-interval mon yr month year
)))
2046 (and (<= offset
1) (>= offset -
1)))))
2047 (day-in-week (calendar-day-of-week today
))
2048 (in-calendar-window (eq (window-buffer (selected-window))
2049 (get-buffer calendar-buffer
))))
2050 (update-calendar-mode-line)
2052 (generate-calendar mon yr
)
2053 (generate-calendar month year
))
2054 (calendar-cursor-to-visible-date
2055 (if today-visible today
(list displayed-month
1 displayed-year
)))
2056 (set-buffer-modified-p nil
)
2057 ;; Don't do any window-related stuff if we weren't called from a
2058 ;; window displaying the calendar
2059 (when in-calendar-window
2060 (if (or (one-window-p t
) (/= (frame-width) (window-width)))
2061 ;; Don't mess with the window size, but ensure that the first
2062 ;; line is fully visible
2063 (set-window-vscroll nil
0)
2064 ;; Adjust the window to exactly fit the displayed calendar
2065 (fit-window-to-buffer nil nil calendar-minimum-window-height
))
2067 (if (and (boundp 'font-lock-mode
)
2069 (font-lock-fontify-buffer))
2070 (and mark-holidays-in-calendar
2071 ;;; (calendar-date-is-legal-p today) ; useful for BC dates
2072 (mark-calendar-holidays)
2073 (and in-calendar-window
(sit-for 0)))
2075 (if mark-diary-entries-in-calendar
(mark-diary-entries))
2077 (run-hooks 'today-visible-calendar-hook
)
2078 (run-hooks 'today-invisible-calendar-hook
)))))
2080 (defun generate-calendar (month year
)
2081 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
2082 ;;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on.
2083 ;;; Note that while calendars for years BC could be displayed as it
2084 ;;; stands, almost all other calendar functions (eg holidays) would
2085 ;;; at best have unpredictable results for such dates.
2086 (if (< (+ month
(* 12 (1- year
))) 2)
2087 (error "Months before January, 1 AD cannot be displayed"))
2088 (setq displayed-month month
2089 displayed-year year
)
2091 (increment-calendar-month month year -
1)
2092 (calendar-for-loop i from
0 to
2 do
2093 (generate-calendar-month month year
(+ 5 (* 25 i
)))
2094 (increment-calendar-month month year
1)))
2096 (defun generate-calendar-month (month year indent
)
2097 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
2098 The calendar is inserted at the top of the buffer in which point is currently
2099 located, but indented INDENT spaces. The indentation is done from the first
2100 character on the line and does not disturb the first INDENT characters on the
2102 (let* ((blank-days;; at start of month
2104 (- (calendar-day-of-week (list month
1 year
))
2105 calendar-week-start-day
)
2107 (last (calendar-last-day-of-month month year
)))
2108 (goto-char (point-min))
2109 (calendar-insert-indented
2110 (calendar-string-spread
2111 (list (format "%s %d" (calendar-month-name month
) year
)) ?
20)
2113 (calendar-insert-indented "" indent
);; Go to proper spot
2114 ;; Use the first two characters of each day to head the columns.
2115 (calendar-for-loop i from
0 to
6 do
2118 (calendar-day-name (mod (+ calendar-week-start-day i
) 7) nil t
)))
2119 (if enable-multibyte-characters
2120 (truncate-string-to-width string
2)
2121 (substring string
0 2)))
2123 (calendar-insert-indented "" 0 t
);; Force onto following line
2124 (calendar-insert-indented "" indent
);; Go to proper spot
2125 ;; Add blank days before the first of the month
2126 (calendar-for-loop i from
1 to blank-days do
(insert " "))
2127 ;; Put in the days of the month
2128 (calendar-for-loop i from
1 to last do
2129 (insert (format "%2d " i
))
2130 (add-text-properties
2131 (- (point) 3) (1- (point))
2132 '(mouse-face highlight
2133 help-echo
"mouse-2: menu of operations for this date"))
2134 (and (zerop (mod (+ i blank-days
) 7))
2136 (calendar-insert-indented "" 0 t
) ;; Force onto following line
2137 (calendar-insert-indented "" indent
)))));; Go to proper spot
2139 (defun calendar-insert-indented (string indent
&optional newline
)
2140 "Insert STRING at column INDENT.
2141 If the optional parameter NEWLINE is t, leave point at start of next line,
2142 inserting a newline if there was no next line; otherwise, leave point after
2143 the inserted text. Value is always t."
2144 ;; Try to move to that column.
2145 (move-to-column indent
)
2146 ;; If line is too short, indent out to that column.
2147 (if (< (current-column) indent
)
2150 ;; Advance to next line, if requested.
2159 (defun redraw-calendar ()
2160 "Redraw the calendar display, if `calendar-buffer' is live."
2162 (if (get-buffer calendar-buffer
)
2163 (with-current-buffer calendar-buffer
2164 (let ((cursor-date (calendar-cursor-to-nearest-date)))
2165 (generate-calendar-window displayed-month displayed-year
)
2166 (calendar-cursor-to-visible-date cursor-date
)))))
2169 (defcustom calendar-week-start-day
0
2170 "The day of the week on which a week in the calendar begins.
2171 0 means Sunday (default), 1 means Monday, and so on.
2173 If you change this variable directly (without using customize)
2174 after starting `calendar', you should call `redraw-calendar' to
2175 update the calendar display to reflect the change, otherwise
2176 movement commands will not work correctly."
2178 ;; Change the initialize so that if you reload calendar.el, it will not
2179 ;; cause a redraw (which may fail, e.g. with "invalid byte-code in
2180 ;; calendar.elc" because of the "byte-compile-dynamic").
2181 :initialize
'custom-initialize-default
2182 :set
(lambda (sym val
)
2187 (defcustom calendar-debug-sexp nil
2188 "Turn debugging on when evaluating a sexp in the diary or holiday list."
2192 (defvar calendar-mode-map nil
)
2193 (if calendar-mode-map
2195 (let ((map (make-keymap)))
2196 (suppress-keymap map
)
2197 (dolist (c '(narrow-to-region mark-word mark-sexp mark-paragraph
2198 mark-defun
mark-whole-buffer mark-page
2199 downcase-region upcase-region kill-region
2200 copy-region-as-kill capitalize-region write-region
))
2201 (define-key map
(vector 'remap c
) 'calendar-not-implemented
))
2202 (define-key map
"<" 'scroll-calendar-right
)
2203 (define-key map
"\C-x<" 'scroll-calendar-right
)
2204 (define-key map
[prior] 'scroll-calendar-right-three-months)
2205 (define-key map "\ev" 'scroll-calendar-right-three-months)
2206 (define-key map ">" 'scroll-calendar-left)
2207 (define-key map "\C-x>" 'scroll-calendar-left)
2208 (define-key map [next] 'scroll-calendar-left-three-months)
2209 (define-key map "\C-v" 'scroll-calendar-left-three-months)
2210 (define-key map "\C-b" 'calendar-backward-day)
2211 (define-key map "\C-p" 'calendar-backward-week)
2212 (define-key map "\e{" 'calendar-backward-month)
2213 (define-key map "\C-x[" 'calendar-backward-year)
2214 (define-key map "\C-f" 'calendar-forward-day)
2215 (define-key map "\C-n" 'calendar-forward-week)
2216 (define-key map [left] 'calendar-backward-day)
2217 (define-key map [up] 'calendar-backward-week)
2218 (define-key map [right] 'calendar-forward-day)
2219 (define-key map [down] 'calendar-forward-week)
2220 (define-key map "\e}" 'calendar-forward-month)
2221 (define-key map "\C-x]" 'calendar-forward-year)
2222 (define-key map "\C-a" 'calendar-beginning-of-week)
2223 (define-key map "\C-e" 'calendar-end-of-week)
2224 (define-key map "\ea" 'calendar-beginning-of-month)
2225 (define-key map "\ee" 'calendar-end-of-month)
2226 (define-key map "\e<" 'calendar-beginning-of-year)
2227 (define-key map "\e>" 'calendar-end-of-year)
2228 (define-key map "\C-@" 'calendar-set-mark)
2229 ;; Many people are used to typing C-SPC and getting C-@.
2230 (define-key map [?\C- ] 'calendar-set-mark)
2231 (define-key map "\C-x\C-x" 'calendar-exchange-point-and-mark)
2232 (define-key map "\e=" 'calendar-count-days-region)
2233 (define-key map "gd" 'calendar-goto-date)
2234 (define-key map "gD" 'calendar-goto-day-of-year)
2235 (define-key map "gj" 'calendar-goto-julian-date)
2236 (define-key map "ga" 'calendar-goto-astro-day-number)
2237 (define-key map "gh" 'calendar-goto-hebrew-date)
2238 (define-key map "gi" 'calendar-goto-islamic-date)
2239 (define-key map "gb" 'calendar-goto-bahai-date)
2240 (define-key map "gC" 'calendar-goto-chinese-date)
2241 (define-key map "gk" 'calendar-goto-coptic-date)
2242 (define-key map "ge" 'calendar-goto-ethiopic-date)
2243 (define-key map "gp" 'calendar-goto-persian-date)
2244 (define-key map "gc" 'calendar-goto-iso-date)
2245 (define-key map "gw" 'calendar-goto-iso-week)
2246 (define-key map "gf" 'calendar-goto-french-date)
2247 (define-key map "gml" 'calendar-goto-mayan-long-count-date)
2248 (define-key map "gmpc" 'calendar-previous-calendar-round-date)
2249 (define-key map "gmnc" 'calendar-next-calendar-round-date)
2250 (define-key map "gmph" 'calendar-previous-haab-date)
2251 (define-key map "gmnh" 'calendar-next-haab-date)
2252 (define-key map "gmpt" 'calendar-previous-tzolkin-date)
2253 (define-key map "gmnt" 'calendar-next-tzolkin-date)
2254 (define-key map "Aa" 'appt-add)
2255 (define-key map "Ad" 'appt-delete)
2256 (define-key map "S" 'calendar-sunrise-sunset)
2257 (define-key map "M" 'calendar-phases-of-moon)
2258 (define-key map " " 'scroll-other-window)
2259 (define-key map (kbd "DEL") 'scroll-other-window-down)
2260 (define-key map "\C-c\C-l" 'redraw-calendar)
2261 (define-key map "." 'calendar-goto-today)
2262 (define-key map "o" 'calendar-other-month)
2263 (define-key map "q" 'exit-calendar)
2264 (define-key map "a" 'list-calendar-holidays)
2265 (define-key map "h" 'calendar-cursor-holidays)
2266 (define-key map "x" 'mark-calendar-holidays)
2267 (define-key map "u" 'calendar-unmark)
2268 (define-key map "m" 'mark-diary-entries)
2269 (define-key map "d" 'diary-view-entries)
2270 (define-key map "D" 'view-other-diary-entries)
2271 (define-key map "s" 'diary-show-all-entries)
2272 (define-key map "pd" 'calendar-print-day-of-year)
2273 (define-key map "pC" 'calendar-print-chinese-date)
2274 (define-key map "pk" 'calendar-print-coptic-date)
2275 (define-key map "pe" 'calendar-print-ethiopic-date)
2276 (define-key map "pp" 'calendar-print-persian-date)
2277 (define-key map "pc" 'calendar-print-iso-date)
2278 (define-key map "pj" 'calendar-print-julian-date)
2279 (define-key map "pa" 'calendar-print-astro-day-number)
2280 (define-key map "ph" 'calendar-print-hebrew-date)
2281 (define-key map "pi" 'calendar-print-islamic-date)
2282 (define-key map "pb" 'calendar-print-bahai-date)
2283 (define-key map "pf" 'calendar-print-french-date)
2284 (define-key map "pm" 'calendar-print-mayan-date)
2285 (define-key map "po" 'calendar-print-other-dates)
2286 (define-key map "id" 'insert-diary-entry)
2287 (define-key map "iw" 'insert-weekly-diary-entry)
2288 (define-key map "im" 'insert-monthly-diary-entry)
2289 (define-key map "iy" 'insert-yearly-diary-entry)
2290 (define-key map "ia" 'insert-anniversary-diary-entry)
2291 (define-key map "ib" 'insert-block-diary-entry)
2292 (define-key map "ic" 'insert-cyclic-diary-entry)
2293 (define-key map "ihd" 'insert-hebrew-diary-entry)
2294 (define-key map "ihm" 'insert-monthly-hebrew-diary-entry)
2295 (define-key map "ihy" 'insert-yearly-hebrew-diary-entry)
2296 (define-key map "iid" 'insert-islamic-diary-entry)
2297 (define-key map "iim" 'insert-monthly-islamic-diary-entry)
2298 (define-key map "iiy" 'insert-yearly-islamic-diary-entry)
2299 (define-key map "iBd" 'insert-bahai-diary-entry)
2300 (define-key map "iBm" 'insert-monthly-bahai-diary-entry)
2301 (define-key map "iBy" 'insert-yearly-bahai-diary-entry)
2302 (define-key map "?" 'calendar-goto-info-node)
2303 (define-key map "Hm" 'cal-html-cursor-month)
2304 (define-key map "Hy" 'cal-html-cursor-year)
2305 (define-key map "tm" 'cal-tex-cursor-month)
2306 (define-key map "tM" 'cal-tex-cursor-month-landscape)
2307 (define-key map "td" 'cal-tex-cursor-day)
2308 (define-key map "tw1" 'cal-tex-cursor-week)
2309 (define-key map "tw2" 'cal-tex-cursor-week2)
2310 (define-key map "tw3" 'cal-tex-cursor-week-iso)
2311 (define-key map "tw4" 'cal-tex-cursor-week-monday)
2312 (define-key map "tfd" 'cal-tex-cursor-filofax-daily)
2313 (define-key map "tfw" 'cal-tex-cursor-filofax-2week)
2314 (define-key map "tfW" 'cal-tex-cursor-filofax-week)
2315 (define-key map "tfy" 'cal-tex-cursor-filofax-year)
2316 (define-key map "ty" 'cal-tex-cursor-year)
2317 (define-key map "tY" 'cal-tex-cursor-year-landscape)
2318 (setq calendar-mode-map map)
2319 ;; Require cal-menu after initializing calendar-mode-map because it uses it.
2320 (require 'cal-menu)))
2322 (defun describe-calendar-mode ()
2323 "Create a help buffer with a brief description of the `calendar-mode'."
2325 (help-setup-xref (list #'describe-calendar-mode) (interactive-p))
2326 (with-output-to-temp-buffer (help-buffer)
2329 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
2330 (substitute-command-keys
2331 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
2332 (substitute-command-keys "\\{calendar-mode-map}")))
2333 (print-help-return-message)))
2335 ;; Calendar mode is suitable only for specially formatted data.
2336 (put 'calendar-mode 'mode-class 'special)
2338 (defvar calendar-mode-line-format
2341 'help-echo "mouse-1: previous month"
2342 'mouse-face 'mode-line-highlight
2343 'keymap (make-mode-line-mouse-map 'mouse-1
2344 'mouse-scroll-calendar-right))
2348 (substitute-command-keys
2349 "\\<calendar-mode-map>\\[calendar-goto-info-node] info")
2350 'help-echo "mouse-1: read Info on Calendar"
2351 'mouse-face 'mode-line-highlight
2352 'keymap (make-mode-line-mouse-map 'mouse-1 'calendar-goto-info-node))
2355 (substitute-command-keys
2356 " \\<calendar-mode-map>\\[calendar-other-month] other")
2357 'help-echo "mouse-1: choose another month"
2358 'mouse-face 'mode-line-highlight
2359 'keymap (make-mode-line-mouse-map
2360 'mouse-1 'mouse-calendar-other-month))
2363 (substitute-command-keys
2364 "\\<calendar-mode-map>\\[calendar-goto-today] today")
2365 'help-echo "mouse-1: go to today's date"
2366 'mouse-face 'mode-line-highlight
2367 'keymap (make-mode-line-mouse-map 'mouse-1 #'calendar-goto-today)))
2368 '(calendar-date-string (calendar-current-date) t)
2370 'help-echo "mouse-1: next month"
2371 'mouse-face 'mode-line-highlight
2372 'keymap (make-mode-line-mouse-map
2373 'mouse-1 'mouse-scroll-calendar-left)))
2374 "The mode line of the calendar buffer.
2376 This must be a list of items that evaluate to strings--those strings are
2377 evaluated and concatenated together, evenly separated by blanks. The variable
2378 `date' is available for use as the date under (or near) the cursor; `date'
2379 defaults to the current date if it is otherwise undefined. Here is an example
2380 value that has the Hebrew date, the day number/days remaining in the year,
2381 and the ISO week/year numbers in the mode. When calendar-move-hook is set to
2382 'update-calendar-mode-line, these mode line shows these values for the date
2387 '(calendar-hebrew-date-string date)
2388 '(let* ((year (extract-calendar-year date))
2389 (d (calendar-day-number date))
2391 (- (calendar-day-number (list 12 31 year)) d)))
2392 (format \"%d/%d\" d days-remaining))
2393 '(let* ((d (calendar-absolute-from-gregorian date))
2394 (iso-date (calendar-iso-from-absolute d)))
2395 (format \"ISO week %d of %d\"
2396 (extract-calendar-month iso-date)
2397 (extract-calendar-year iso-date)))
2401 (defun mouse-scroll-calendar-left (event)
2402 "Scroll the displayed calendar left by one month.
2403 Maintains the relative position of the cursor
2404 with respect to the calendar as well as possible."
2406 (save-selected-window
2407 (select-window (posn-window (event-start event)))
2408 (scroll-calendar-left 1)))
2410 (defun mouse-scroll-calendar-right (event)
2411 "Scroll the displayed calendar right by one month.
2412 Maintains the relative position of the cursor
2413 with respect to the calendar as well as possible."
2415 (save-selected-window
2416 (select-window (posn-window (event-start event)))
2417 (scroll-calendar-right 1)))
2419 (defun mouse-calendar-other-month (event)
2420 "Display a three-month calendar centered around a specified month and year."
2422 (save-selected-window
2423 (select-window (posn-window (event-start event)))
2424 (call-interactively 'calendar-other-month)))
2426 (defun calendar-goto-info-node ()
2427 "Go to the info node for the calendar."
2430 (let ((where (save-window-excursion
2431 (Info-find-emacs-command-nodes 'calendar))))
2433 (error "Couldn't find documentation for the calendar")
2434 (let (same-window-buffer-names)
2436 (Info-find-node (car (car where)) (car (cdr (car where)))))))
2440 (defun calendar-mode ()
2441 "A major mode for the calendar window.
2443 For a complete description, type \
2444 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
2446 \\<calendar-mode-map>\\{calendar-mode-map}"
2447 (kill-all-local-variables)
2448 (setq major-mode 'calendar-mode)
2449 (setq mode-name "Calendar")
2450 (use-local-map calendar-mode-map)
2451 (setq buffer-read-only t)
2452 (setq indent-tabs-mode nil)
2453 (update-calendar-mode-line)
2454 (add-hook 'activate-menubar-hook 'cal-menu-update nil t)
2455 (make-local-variable 'calendar-mark-ring)
2456 (make-local-variable 'displayed-month);; Month in middle of window.
2457 (make-local-variable 'displayed-year) ;; Year in middle of window.
2458 (set (make-local-variable 'font-lock-defaults)
2459 '(calendar-font-lock-keywords t))
2460 (run-mode-hooks 'calendar-mode-hook))
2462 (defun calendar-string-spread (strings char length)
2463 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
2464 The effect is like mapconcat but the separating pieces are as balanced as
2465 possible. Each item of STRINGS is evaluated before concatenation so it can
2466 actually be an expression that evaluates to a string. If LENGTH is too short,
2467 the STRINGS are just concatenated and the result truncated."
2468 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
2469 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
2470 ;; Addison-Wesley, Reading, MA, 1989
2471 (let* ((strings (mapcar 'eval
2472 (if (< (length strings) 2)
2473 (append (list "") strings (list ""))
2475 (n (- length (length (apply 'concat strings))))
2476 (m (1- (length strings)))
2478 (strings (cdr strings))
2480 (dolist (string strings)
2482 (make-string (max 0 (/ (+ n i) m)) char)
2485 (substring s 0 length)))
2487 (defun update-calendar-mode-line ()
2488 "Update the calendar mode line with the current date and date style."
2489 (if (bufferp (get-buffer calendar-buffer))
2490 (with-current-buffer calendar-buffer
2491 (setq mode-line-format
2492 (calendar-string-spread
2493 (let ((date (condition-case nil
2494 (calendar-cursor-to-nearest-date)
2495 (error (calendar-current-date)))))
2496 (mapcar 'eval calendar-mode-line-format))
2498 (force-mode-line-update))))
2500 (defun calendar-window-list ()
2501 "List of all calendar-related windows."
2502 (let ((calendar-buffers (calendar-buffer-list))
2504 (walk-windows (lambda (w)
2505 (if (memq (window-buffer w) calendar-buffers)
2510 (defun calendar-buffer-list ()
2511 "List of all calendar-related buffers."
2512 (let* ((diary-buffer (get-file-buffer diary-file))
2513 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
2514 fancy-diary-buffer diary-buffer calendar-buffer
2515 other-calendars-buffer))
2518 (setq b (cond ((stringp b) (get-buffer b))
2521 (if b (push b buffer-list)))
2524 (defun exit-calendar ()
2525 "Get out of the calendar window and hide it and related buffers."
2527 (let* ((diary-buffer (get-file-buffer diary-file)))
2528 (if (or (not diary-buffer)
2529 (not (buffer-modified-p diary-buffer))
2531 "Diary modified; do you really want to exit the calendar? "))
2532 ;; Need to do this multiple times because one time can replace some
2533 ;; calendar-related buffers with other calendar-related buffers
2535 (mapcar 'calendar-hide-window (calendar-window-list)))
2536 (calendar-window-list)))))
2538 (defun calendar-hide-window (window)
2539 "Hide WINDOW if it is calendar-related."
2540 (let ((buffer (if (window-live-p window) (window-buffer window))))
2541 (if (memq buffer (calendar-buffer-list))
2543 ((and (display-multi-frame-p)
2544 (eq 'icon (cdr (assoc 'visibility
2546 (window-frame window))))))
2548 ((and (display-multi-frame-p) (window-dedicated-p window))
2549 (if calendar-remove-frame-by-deleting
2550 (delete-frame (window-frame window))
2551 (iconify-frame (window-frame window))))
2552 ((not (and (select-window window) (one-window-p window)))
2553 (delete-window window))
2554 (t (set-buffer buffer)
2557 (defun calendar-current-date ()
2558 "Return the current date in a list (month day year)."
2559 (let ((now (decode-time)))
2560 (list (nth 4 now) (nth 3 now) (nth 5 now))))
2562 (defun calendar-cursor-to-date (&optional error)
2563 "Return a list (month day year) of current cursor position.
2564 If cursor is not on a specific date, signals an error if optional parameter
2565 ERROR is t, otherwise just returns nil."
2566 (let* ((segment (/ (current-column) 25))
2567 (month (% (+ displayed-month segment -1) 12))
2568 (month (if (= 0 month) 12 month))
2571 ((and (= 12 month) (= segment 0)) (1- displayed-year))
2572 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
2573 (t displayed-year))))
2574 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
2575 (< 2 (count-lines (point-min) (point))))
2577 (if (not (looking-at " "))
2578 (re-search-backward "[^0-9]"))
2580 (string-to-number (buffer-substring (1+ (point)) (+ 4 (point))))
2582 (if (and (looking-at "\\*")
2584 (re-search-backward "[^*]")
2585 (looking-at ".\\*\\*")))
2586 (list month calendar-starred-day year)
2587 (if error (error "Not on a date!"))))))
2589 (add-to-list 'debug-ignored-errors "Not on a date!")
2591 ;; The following version of calendar-gregorian-from-absolute is preferred for
2592 ;; reasons of clarity, BUT it's much slower than the version that follows it.
2594 ;;(defun calendar-gregorian-from-absolute (date)
2595 ;; "Compute the list (month day year) corresponding to the absolute DATE.
2596 ;;The absolute date is the number of days elapsed since the (imaginary)
2597 ;;Gregorian date Sunday, December 31, 1 BC."
2598 ;; (let* ((approx (/ date 366));; Approximation from below.
2599 ;; (year ;; Search forward from the approximation.
2601 ;; (calendar-sum y approx
2602 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2604 ;; (month ;; Search forward from January.
2605 ;; (1+ (calendar-sum m 1
2607 ;; (calendar-absolute-from-gregorian
2608 ;; (list m (calendar-last-day-of-month m year) year)))
2610 ;; (day ;; Calculate the day by subtraction.
2612 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2613 ;; (list month day year)))
2615 (defun calendar-gregorian-from-absolute (date)
2616 "Compute the list (month day year) corresponding to the absolute DATE.
2617 The absolute date is the number of days elapsed since the (imaginary)
2618 Gregorian date Sunday, December 31, 1 BC. This function does not
2619 handle dates in years BC."
2620 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2621 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2622 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2623 ;; (April, 1993), pages 383-404 for an explanation.
2624 (let* ((d0 (1- date))
2625 (n400 (/ d0 146097))
2632 (day (1+ (% d3 365)))
2633 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2634 (if (or (= n100 4) (= n1 4))
2636 (let ((year (1+ year))
2638 (while (let ((mdays (calendar-last-day-of-month month year)))
2640 (setq day (- day mdays))))
2641 (setq month (1+ month)))
2642 (list month day year)))))
2644 (defun calendar-other-month (month year)
2645 "Display a three-month calendar centered around MONTH and YEAR."
2646 (interactive (calendar-read-date 'noday))
2647 (if (and (= month displayed-month)
2648 (= year displayed-year))
2650 (let ((old-date (calendar-cursor-to-date))
2651 (today (calendar-current-date)))
2652 (generate-calendar-window month year)
2653 (calendar-cursor-to-visible-date
2655 ((calendar-date-is-visible-p old-date) old-date)
2656 ((calendar-date-is-visible-p today) today)
2657 (t (list month 1 year)))))))
2659 (defun calendar-set-mark (arg)
2660 "Mark the date under the cursor, or jump to marked date.
2661 With no prefix argument, push current date onto marked date ring.
2662 With argument, jump to mark, pop it, and put point at end of ring."
2664 (let ((date (calendar-cursor-to-date t)))
2667 (push date calendar-mark-ring)
2668 ;; Since the top of the mark ring is the marked date in the
2669 ;; calendar, the mark ring in the calendar is one longer than
2670 ;; in other buffers to get the same effect.
2671 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2672 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2673 (message "Mark set"))
2674 (if (null calendar-mark-ring)
2675 (error "No mark set in this buffer")
2676 (calendar-goto-date (car calendar-mark-ring))
2677 (setq calendar-mark-ring
2678 (cdr (nconc calendar-mark-ring (list date))))))))
2680 (defun calendar-exchange-point-and-mark ()
2681 "Exchange the current cursor position with the marked date."
2683 (let ((mark (car calendar-mark-ring))
2684 (date (calendar-cursor-to-date t)))
2686 (error "No mark set in this buffer")
2687 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2688 (calendar-goto-date mark))))
2690 (defun calendar-count-days-region ()
2691 "Count the number of days (inclusive) between point and the mark."
2693 (let* ((days (- (calendar-absolute-from-gregorian
2694 (calendar-cursor-to-date t))
2695 (calendar-absolute-from-gregorian
2696 (or (car calendar-mark-ring)
2697 (error "No mark set in this buffer")))))
2698 (days (1+ (if (> days 0) days (- days)))))
2699 (message "Region has %d day%s (inclusive)"
2700 days (if (> days 1) "s" ""))))
2702 (defun calendar-not-implemented ()
2705 (error "%s not available in the calendar"
2706 (global-key-binding (this-command-keys))))
2708 (defun calendar-read (prompt acceptable &optional initial-contents)
2709 "Return an object read from the minibuffer.
2710 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2711 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2712 is a string to insert in the minibuffer before reading."
2713 (let ((value (read-minibuffer prompt initial-contents)))
2714 (while (not (funcall acceptable value))
2715 (setq value (read-minibuffer prompt initial-contents)))
2718 (defun calendar-read-date (&optional noday)
2719 "Prompt for Gregorian date. Return a list (month day year).
2720 If optional NODAY is t, does not ask for day, but just returns
2721 \(month nil year); if NODAY is any other non-nil value the value returned is
2723 (let* ((year (calendar-read
2725 (lambda (x) (> x 0))
2726 (int-to-string (extract-calendar-year
2727 (calendar-current-date)))))
2728 (month-array calendar-month-name-array)
2729 (completion-ignore-case t)
2730 (month (cdr (assoc-string
2733 (mapcar 'list (append month-array nil))
2735 (calendar-make-alist month-array 1) t)))
2736 (last (calendar-last-day-of-month month year)))
2739 (list month nil year)
2742 (calendar-read (format "Day (1-%d): " last)
2743 (lambda (x) (and (< 0 x) (<= x last))))
2746 (defun calendar-interval (mon1 yr1 mon2 yr2)
2747 "The number of months difference between MON1, YR1 and MON2, YR2.
2748 The result is positive if the second date is later than the first.
2749 Negative years are interpreted as years BC; -1 being 1 BC, and so on."
2750 (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc
2751 (if (< yr2 0) (setq yr2 (1+ yr2)))
2752 (+ (* 12 (- yr2 yr1))
2755 (defvar calendar-abbrev-length 3
2756 "*Length of abbreviations to be used for day and month names.
2757 See also `calendar-day-abbrev-array' and `calendar-month-abbrev-array'.")
2759 (defvar calendar-day-name-array
2760 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2761 "*Array of capitalized strings giving, in order, the day names.
2762 The first two characters of each string will be used to head the
2763 day columns in the calendar. See also the variable
2764 `calendar-day-abbrev-array'.")
2766 (defvar calendar-day-abbrev-array
2767 [nil nil nil nil nil nil nil]
2768 "*Array of capitalized strings giving the abbreviated day names.
2769 The order should be the same as that of the full names specified
2770 in `calendar-day-name-array'. These abbreviations may be used
2771 instead of the full names in the diary file. Do not include a
2772 trailing `.' in the strings specified in this variable, though
2773 you may use such in the diary file. If any element of this array
2774 is nil, then the abbreviation will be constructed as the first
2775 `calendar-abbrev-length' characters of the corresponding full name.")
2777 (defvar calendar-month-name-array
2778 ["January" "February" "March" "April" "May" "June"
2779 "July" "August" "September" "October" "November" "December"]
2780 "*Array of capitalized strings giving, in order, the month names.
2781 See also the variable `calendar-month-abbrev-array'.")
2783 (defvar calendar-month-abbrev-array
2784 [nil nil nil nil nil nil nil nil nil nil nil nil]
2785 "*Array of capitalized strings giving the abbreviated month names.
2786 The order should be the same as that of the full names specified
2787 in `calendar-month-name-array'. These abbreviations are used in
2788 the calendar menu entries, and can also be used in the diary
2789 file. Do not include a trailing `.' in the strings specified in
2790 this variable, though you may use such in the diary file. If any
2791 element of this array is nil, then the abbreviation will be
2792 constructed as the first `calendar-abbrev-length' characters of the
2793 corresponding full name.")
2795 (defun calendar-abbrev-construct (abbrev full &optional period)
2796 "Internal calendar function to return a complete abbreviation array.
2797 ABBREV is an array of abbreviations, FULL the corresponding array
2798 of full names. The return value is the ABBREV array, with any nil
2799 elements replaced by the first three characters taken from the
2800 corresponding element of FULL. If optional argument PERIOD is non-nil,
2801 each element returned has a final `.' character."
2802 (let (elem array name)
2803 (dotimes (i (length full))
2804 (setq name (aref full i)
2805 elem (or (aref abbrev i)
2807 (min calendar-abbrev-length (length name))))
2808 elem (format "%s%s" elem (if period "." ""))
2809 array (append array (list elem))))
2812 (defvar calendar-font-lock-keywords
2813 `((,(concat (regexp-opt (mapcar 'identity calendar-month-name-array) t)
2815 . font-lock-function-name-face) ; month and year
2817 (list (substring (aref calendar-day-name-array 6) 0 2)
2818 (substring (aref calendar-day-name-array 0) 0 2)))
2819 ;; Saturdays and Sundays are hilited differently.
2820 . font-lock-comment-face)
2821 ;; First two chars of each day are used in the calendar.
2822 (,(regexp-opt (mapcar (lambda (x) (substring x 0 2)) calendar-day-name-array))
2823 . font-lock-reference-face))
2824 "Default keywords to highlight in Calendar mode.")
2826 (defun calendar-day-name (date &optional abbrev absolute)
2827 "Return a string with the name of the day of the week of DATE.
2828 DATE should be a list in the format (MONTH DAY YEAR), unless the
2829 optional argument ABSOLUTE is non-nil, in which case DATE should
2830 be an integer in the range 0 to 6 corresponding to the day of the
2831 week. Day names are taken from the variable `calendar-day-name-array',
2832 unless the optional argument ABBREV is non-nil, in which case
2833 the variable `calendar-day-abbrev-array' is used."
2835 (calendar-abbrev-construct calendar-day-abbrev-array
2836 calendar-day-name-array)
2837 calendar-day-name-array)
2838 (if absolute date (calendar-day-of-week date))))
2840 (defun calendar-make-alist (sequence &optional start-index filter abbrevs)
2841 "Make an assoc list corresponding to SEQUENCE.
2842 Each element of sequence will be associated with an integer, starting
2843 from 1, or from START-INDEX if that is non-nil. If a sequence ABBREVS
2844 is supplied, the function `calendar-abbrev-construct' is used to
2845 construct abbreviations corresponding to the elements in SEQUENCE.
2846 Each abbreviation is entered into the alist with the same
2847 association index as the full name it represents.
2848 If FILTER is provided, apply it to each key in the alist."
2850 (offset (or start-index 1))
2851 (aseq (if abbrevs (calendar-abbrev-construct abbrevs sequence)))
2852 (aseqp (if abbrevs (calendar-abbrev-construct abbrevs sequence
2855 (dotimes (i (length sequence) (reverse alist))
2856 (setq index (+ i offset)
2857 elem (elt sequence i)
2859 (cons (cons (if filter (funcall filter elem) elem) index) alist))
2861 (setq elem (elt aseq i)
2862 alist (cons (cons (if filter (funcall filter elem) elem)
2865 (setq elem (elt aseqp i)
2866 alist (cons (cons (if filter (funcall filter elem) elem)
2869 (defun calendar-month-name (month &optional abbrev)
2870 "Return a string with the name of month number MONTH.
2871 Months are numbered from one. Month names are taken from the
2872 variable `calendar-month-name-array', unless the optional
2873 argument ABBREV is non-nil, in which case
2874 `calendar-month-abbrev-array' is used."
2876 (calendar-abbrev-construct calendar-month-abbrev-array
2877 calendar-month-name-array)
2878 calendar-month-name-array)
2881 (defun calendar-day-of-week (date)
2882 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc.
2883 DATE is a list of the form (month day year). A negative year is
2884 interpreted as BC; -1 being 1 BC, and so on."
2885 (mod (calendar-absolute-from-gregorian date) 7))
2887 (defun calendar-unmark ()
2888 "Delete all diary/holiday marks/highlighting from the calendar."
2890 (setq mark-holidays-in-calendar nil)
2891 (setq mark-diary-entries-in-calendar nil)
2894 (defun calendar-date-is-visible-p (date)
2895 "Return t if DATE is valid and is visible in the calendar window."
2896 (let ((gap (calendar-interval
2897 displayed-month displayed-year
2898 (extract-calendar-month date) (extract-calendar-year date))))
2899 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2901 (defun calendar-date-is-legal-p (date)
2902 "Return t if DATE is a valid date."
2903 (let ((month (extract-calendar-month date))
2904 (day (extract-calendar-day date))
2905 (year (extract-calendar-year date)))
2906 (and (<= 1 month) (<= month 12)
2907 ;; (calendar-read-date t) returns a date with day = nil.
2908 ;; Should not be valid (?), since many funcs prob assume integer.
2909 ;; (calendar-read-date 'noday) returns (month year), which
2910 ;; currently results in extract-calendar-year returning nil.
2911 day year (<= 1 day) (<= day (calendar-last-day-of-month month year))
2912 ;; BC dates left as non-valid, to suppress errors from
2913 ;; complex holiday algorithms not suitable for years BC.
2914 ;; Note there are side effects on calendar navigation.
2917 (defun calendar-date-equal (date1 date2)
2918 "Return t if the DATE1 and DATE2 are the same."
2920 (= (extract-calendar-month date1) (extract-calendar-month date2))
2921 (= (extract-calendar-day date1) (extract-calendar-day date2))
2922 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2924 (defun mark-visible-calendar-date (date &optional mark)
2925 "Mark DATE in the calendar window with MARK.
2926 MARK is a single-character string, a list of face attributes/values, or a face.
2927 MARK defaults to `diary-entry-marker'."
2928 (if (calendar-date-is-legal-p date)
2929 (with-current-buffer calendar-buffer
2931 (calendar-cursor-to-visible-date date)
2933 (or (and (stringp mark) (= (length mark) 1) mark) ; single-char
2934 (and (listp mark) (> (length mark) 0) mark) ; attr list
2935 (and (facep mark) mark) ; face-name
2936 diary-entry-marker))
2938 ;; face or an attr-list that contained a face
2941 (make-overlay (1- (point)) (1+ (point))) 'face mark))
2943 ((and (stringp mark) (= (length mark) 1))
2944 (let ((inhibit-read-only t))
2946 ;; Insert before delete so as to better preserve markers.
2953 (apply 'concat "temp-"
2954 (mapcar (lambda (sym)
2956 ((symbolp sym) (symbol-name sym))
2957 ((numberp sym) (number-to-string sym))
2961 (make-face temp-face)
2962 ;; Remove :face info from the mark, copy the face info into
2964 (while (setq faceinfo (memq :face faceinfo))
2965 (copy-face (read (nth 1 faceinfo)) temp-face)
2966 (setcar faceinfo nil)
2967 (setcar (cdr faceinfo) nil))
2968 (setq mark (delq nil mark))
2969 ;; Apply the font aspects
2970 (apply 'set-face-attribute temp-face nil mark)
2972 (make-overlay (1- (point)) (1+ (point))) 'face temp-face))))))))
2974 (defun calendar-star-date ()
2975 "Replace the date under the cursor in the calendar window with asterisks.
2976 This function can be used with the `today-visible-calendar-hook' run after the
2977 calendar window has been prepared."
2978 (let ((inhibit-read-only t)
2979 (modified (buffer-modified-p)))
2981 (set (make-local-variable 'calendar-starred-day)
2983 (buffer-substring (point) (- (point) 2))))
2984 ;; Insert before deleting, to better preserve markers.
2989 (restore-buffer-modified-p modified)))
2991 (defun calendar-mark-today ()
2992 "Mark the date under the cursor in the calendar window.
2993 The date is marked with `calendar-today-marker'. This function can be used with
2994 the `today-visible-calendar-hook' run after the calendar window has been
2996 (mark-visible-calendar-date
2997 (calendar-cursor-to-date)
2998 calendar-today-marker))
3000 (defun calendar-date-compare (date1 date2)
3001 "Return t if DATE1 is before DATE2, nil otherwise.
3002 The actual dates are in the car of DATE1 and DATE2."
3003 (< (calendar-absolute-from-gregorian (car date1))
3004 (calendar-absolute-from-gregorian (car date2))))
3006 (defun calendar-date-string (date &optional abbreviate nodayname)
3007 "A string form of DATE, driven by the variable `calendar-date-display-form'.
3008 An optional parameter ABBREVIATE, when non-nil, causes the month
3009 and day names to be abbreviated as specified by
3010 `calendar-month-abbrev-array' and `calendar-day-abbrev-array',
3011 respectively. An optional parameter NODAYNAME, when t, omits the
3012 name of the day of the week."
3015 (calendar-day-name date abbreviate)))
3016 (month (extract-calendar-month date))
3017 (monthname (calendar-month-name month abbreviate))
3018 (day (int-to-string (extract-calendar-day date)))
3019 (month (int-to-string month))
3020 (year (int-to-string (extract-calendar-year date))))
3021 (mapconcat 'eval calendar-date-display-form "")))
3023 (defun calendar-dayname-on-or-before (dayname date)
3024 "Return the absolute date of the DAYNAME on or before absolute DATE.
3025 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
3027 Note: Applying this function to d+6 gives us the DAYNAME on or after an
3028 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
3029 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
3030 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
3031 (- date (% (- date dayname) 7)))
3033 (defun calendar-nth-named-absday (n dayname month year &optional day)
3034 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3035 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3036 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3037 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3039 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3042 (calendar-dayname-on-or-before
3044 (+ 6 (calendar-absolute-from-gregorian
3045 (list month (or day 1) year)))))
3047 (calendar-dayname-on-or-before
3049 (calendar-absolute-from-gregorian
3051 (or day (calendar-last-day-of-month month year))
3054 (defun calendar-nth-named-day (n dayname month year &optional day)
3055 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3056 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3057 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3058 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3060 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3061 (calendar-gregorian-from-absolute
3062 (calendar-nth-named-absday n dayname month year day)))
3064 (defun calendar-day-of-year-string (&optional date)
3065 "String of day number of year of Gregorian DATE.
3066 Defaults to today's date if DATE is not given."
3067 (let* ((d (or date (calendar-current-date)))
3068 (year (extract-calendar-year d))
3069 (day (calendar-day-number d))
3070 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
3071 (format "Day %d of %d; %d day%s remaining in the year"
3072 day year days-remaining (if (= days-remaining 1) "" "s"))))
3074 (defun calendar-print-other-dates ()
3075 "Show dates on other calendars for date under the cursor."
3077 (let* ((date (calendar-cursor-to-date t)))
3078 (with-current-buffer (get-buffer-create other-calendars-buffer)
3079 (let ((inhibit-read-only t)
3080 (modified (buffer-modified-p)))
3081 (calendar-set-mode-line
3082 (concat (calendar-date-string date) " (Gregorian)"))
3088 (calendar-day-of-year-string date) "\n"
3089 (format "ISO date: %s\n" (calendar-iso-date-string date))
3090 (format "Julian date: %s\n"
3091 (calendar-julian-date-string date))
3092 (format "Astronomical (Julian) day number (at noon UTC): %s.0\n"
3093 (calendar-astro-date-string date))
3094 (format "Fixed (RD) date: %s\n"
3095 (calendar-absolute-from-gregorian date))
3096 (format "Hebrew date (before sunset): %s\n"
3097 (calendar-hebrew-date-string date))
3098 (format "Persian date: %s\n"
3099 (calendar-persian-date-string date))
3100 (let ((i (calendar-islamic-date-string date)))
3101 (if (not (string-equal i ""))
3102 (format "Islamic date (before sunset): %s\n" i)))
3103 (let ((b (calendar-bahai-date-string date)))
3104 (if (not (string-equal b ""))
3105 (format "Baha'i date (before sunset): %s\n" b)))
3106 (format "Chinese date: %s\n"
3107 (calendar-chinese-date-string date))
3108 (let ((c (calendar-coptic-date-string date)))
3109 (if (not (string-equal c ""))
3110 (format "Coptic date: %s\n" c)))
3111 (let ((e (calendar-ethiopic-date-string date)))
3112 (if (not (string-equal e ""))
3113 (format "Ethiopic date: %s\n" e)))
3114 (let ((f (calendar-french-date-string date)))
3115 (if (not (string-equal f ""))
3116 (format "French Revolutionary date: %s\n" f)))
3117 (format "Mayan date: %s\n"
3118 (calendar-mayan-date-string date)))))
3119 (goto-char (point-min))
3120 (restore-buffer-modified-p modified))
3121 (display-buffer other-calendars-buffer))))
3123 (defun calendar-print-day-of-year ()
3124 "Show day number in year/days remaining in year for date under the cursor."
3126 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
3128 (defun calendar-set-mode-line (str)
3129 "Set mode line to STR, centered, surrounded by dashes."
3130 (let* ((edges (window-edges))
3131 ;; As per doc of window-width, total visible mode-line length.
3132 (width (- (nth 2 edges) (nth 0 edges))))
3133 (setq mode-line-format
3134 (if buffer-file-name
3135 `("-" mode-line-modified
3136 ,(calendar-string-spread (list str) ?- (- width 6))
3138 (calendar-string-spread (list str) ?- width)))))
3140 (defun calendar-mod (m n)
3141 "Non-negative remainder of M/N with N instead of 0."
3142 (1+ (mod (1- m) n)))
3144 (run-hooks 'calendar-load-hook)
3149 ;; byte-compile-dynamic: t
3152 ;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8
3153 ;;; calendar.el ends here