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 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)))
589 (defcustom american-date-diary-pattern
590 '((month "/" day
"[^/0-9]")
591 (month "/" day
"/" year
"[^0-9]")
592 (monthname " *" day
"[^,0-9]")
593 (monthname " *" day
", *" year
"[^0-9]")
595 "List of pseudo-patterns describing the American patterns of date used.
596 See the documentation of `diary-date-forms' for an explanation."
597 :type
'(repeat (choice (cons :tag
"Backup"
598 :value
(backup . nil
)
600 (repeat (list :inline t
:format
"%v"
601 (symbol :tag
"Keyword")
602 (choice symbol regexp
))))
603 (repeat (list :inline t
:format
"%v"
604 (symbol :tag
"Keyword")
605 (choice symbol regexp
)))))
609 (defcustom european-date-diary-pattern
610 '((day "/" month
"[^/0-9]")
611 (day "/" month
"/" year
"[^0-9]")
612 (backup day
" *" monthname
"\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
613 (day " *" monthname
" *" year
"[^0-9]")
615 "List of pseudo-patterns describing the European patterns of date used.
616 See the documentation of `diary-date-forms' for an explanation."
617 :type
'(repeat (choice (cons :tag
"Backup"
618 :value
(backup . nil
)
620 (repeat (list :inline t
:format
"%v"
621 (symbol :tag
"Keyword")
622 (choice symbol regexp
))))
623 (repeat (list :inline t
:format
"%v"
624 (symbol :tag
"Keyword")
625 (choice symbol regexp
)))))
628 (defcustom diary-date-forms
629 (if european-calendar-style
630 european-date-diary-pattern
631 american-date-diary-pattern
)
632 "List of pseudo-patterns describing the forms of date used in the diary.
633 The patterns on the list must be MUTUALLY EXCLUSIVE and should not match
634 any portion of the diary entry itself, just the date component.
636 A pseudo-pattern is a list of regular expressions and the keywords `month',
637 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
638 match the name of the month (see `calendar-month-name-array'), capitalized
639 or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'),
640 followed by a period or not; it will also match `*'. Similarly, `dayname'
641 will match the name of the day (see `calendar-day-name-array'), capitalized or
642 not, or its user-specified abbreviation (see `calendar-day-abbrev-array'),
643 followed by a period or not. The keywords `month', `day', and `year' will
644 match those numerical values, preceded by arbitrarily many zeros; they will
647 The matching of the diary entries with the date forms is done with the
648 standard syntax table from Fundamental mode, but with the `*' changed so
649 that it is a word constituent.
651 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
652 diary entry itself, the first element of the pattern MUST be `backup'. This
653 directive causes the date recognizer to back up to the beginning of the
654 current word of the diary entry, so in no case can the pattern match more than
655 a portion of the first word of the diary entry."
656 :type
'(repeat (choice (cons :tag
"Backup"
657 :value
(backup . nil
)
659 (repeat (list :inline t
:format
"%v"
660 (symbol :tag
"Keyword")
661 (choice symbol regexp
))))
662 (repeat (list :inline t
:format
"%v"
663 (symbol :tag
"Keyword")
664 (choice symbol regexp
)))))
668 (defcustom european-calendar-display-form
669 '((if dayname
(concat dayname
", ")) day
" " monthname
" " year
)
670 "Pseudo-pattern governing the way a date appears in the European style.
671 See the documentation of `calendar-date-display-form' for an explanation."
676 (defcustom american-calendar-display-form
677 '((if dayname
(concat dayname
", ")) monthname
" " day
", " year
)
678 "Pseudo-pattern governing the way a date appears in the American style.
679 See the documentation of `calendar-date-display-form' for an explanation."
683 (defcustom calendar-date-display-form
684 (if european-calendar-style
685 european-calendar-display-form
686 american-calendar-display-form
)
687 "Pseudo-pattern governing the way a date appears.
689 Used by the function `calendar-date-string', a pseudo-pattern is a list of
690 expressions that can involve the keywords `month', `day', and `year', all
691 numbers in string form, and `monthname' and `dayname', both alphabetic
692 strings. For example, the ISO standard would use the pseudo- pattern
694 '(year \"-\" month \"-\" day)
696 while a typical American form would be
698 '(month \"/\" day \"/\" (substring year -2))
702 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
704 would give the usual American style in fixed-length fields.
706 See the documentation of the function `calendar-date-string'."
710 (defun european-calendar ()
711 "Set the interpretation and display of dates to the European style."
713 (setq european-calendar-style t
)
714 (setq calendar-date-display-form european-calendar-display-form
)
715 (setq diary-date-forms european-date-diary-pattern
)
716 (update-calendar-mode-line))
718 (defun american-calendar ()
719 "Set the interpretation and display of dates to the American style."
721 (setq european-calendar-style nil
)
722 (setq calendar-date-display-form american-calendar-display-form
)
723 (setq diary-date-forms american-date-diary-pattern
)
724 (update-calendar-mode-line))
727 (defcustom print-diary-entries-hook
'lpr-buffer
728 "List of functions called after a temporary diary buffer is prepared.
729 The buffer shows only the diary entries currently visible in the diary
730 buffer. The default just does the printing. Other uses might include, for
731 example, rearranging the lines into order by day and time, saving the buffer
732 instead of deleting it, or changing the function used to do the printing."
737 (defcustom list-diary-entries-hook nil
738 "List of functions called after diary file is culled for relevant entries.
739 It is to be used for diary entries that are not found in the diary file.
741 A function `include-other-diary-files' is provided for use as the value of
742 this hook. This function enables you to use shared diary files together
743 with your own. The files included are specified in the diary file by lines
746 #include \"filename\"
748 This is recursive; that is, #include directives in files thus included are
749 obeyed. You can change the \"#include\" to some other string by changing
750 the variable `diary-include-string'. When you use `include-other-diary-files'
751 as part of the list-diary-entries-hook, you will probably also want to use the
752 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
754 For example, you could use
756 (setq list-diary-entries-hook
757 '(include-other-diary-files sort-diary-entries))
758 (setq diary-display-hook 'fancy-diary-display)
760 in your `.emacs' file to cause the fancy diary buffer to be displayed with
761 diary entries from various included files, each day's entries sorted into
762 lexicographic order."
764 :options
'(include-other-diary-files sort-diary-entries
)
768 (defcustom diary-hook nil
769 "List of functions called after the display of the diary.
770 Can be used for appointment notification."
775 (defcustom diary-display-hook nil
776 "List of functions that handle the display of the diary.
777 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
780 Ordinarily, this just displays the diary buffer (with holidays indicated in
781 the mode line), if there are any relevant entries. At the time these
782 functions are called, the variable `diary-entries-list' is a list, in order
783 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
784 STRING), where string is the diary entry for the given date. This can be
785 used, for example, a different buffer for display (perhaps combined with
786 holidays), or produce hard copy output.
788 A function `fancy-diary-display' is provided as an alternative
789 choice for this hook; this function prepares a special noneditable diary
790 buffer with the relevant diary entries that has neat day-by-day arrangement
791 with headings. The fancy diary buffer will show the holidays unless the
792 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
793 diary buffer will not show days for which there are no diary entries, even
794 if that day is a holiday; if you want such days to be shown in the fancy
795 diary buffer, set the variable `diary-list-include-blanks' to t."
797 :options
'(fancy-diary-display)
801 (defcustom nongregorian-diary-listing-hook nil
802 "List of functions called for listing diary file and included files.
803 As the files are processed for diary entries, these functions are used
804 to cull relevant entries. You can use either or both of
805 `list-hebrew-diary-entries', `list-islamic-diary-entries' and
806 `list-bahai-diary-entries'. The documentation for these functions
807 describes the style of such diary entries."
809 :options
'(list-hebrew-diary-entries
810 list-islamic-diary-entries
811 list-bahai-diary-entries
)
815 (defcustom mark-diary-entries-hook nil
816 "List of functions called after marking diary entries in the calendar.
818 A function `mark-included-diary-files' is also provided for use as the
819 `mark-diary-entries-hook'; it enables you to use shared diary files together
820 with your own. The files included are specified in the diary file by lines
822 #include \"filename\"
823 This is recursive; that is, #include directives in files thus included are
824 obeyed. You can change the \"#include\" to some other string by changing the
825 variable `diary-include-string'. When you use `mark-included-diary-files' as
826 part of the mark-diary-entries-hook, you will probably also want to use the
827 function `include-other-diary-files' as part of `list-diary-entries-hook'."
829 :options
'(mark-included-diary-files)
833 (defcustom nongregorian-diary-marking-hook nil
834 "List of functions called for marking diary file and included files.
835 As the files are processed for diary entries, these functions are used
836 to cull relevant entries. You can use either or both of
837 `mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
838 `mark-bahai-diary-entries'. The documentation for these functions
839 describes the style of such diary entries."
841 :options
'(mark-hebrew-diary-entries
842 mark-islamic-diary-entries
843 mark-bahai-diary-entries
)
847 (defcustom diary-list-include-blanks nil
848 "If nil, do not include days with no diary entry in the list of diary entries.
849 Such days will then not be shown in the fancy diary buffer, even if they
855 (defcustom holidays-in-diary-buffer t
856 "Non-nil means include holidays in the diary display.
857 The holidays appear in the mode line of the diary buffer, or in the
858 fancy diary buffer next to the date. This slows down the diary functions
859 somewhat; setting it to nil makes the diary display faster."
863 (defvar calendar-mark-ring nil
)
866 (put 'general-holidays
'risky-local-variable t
)
868 (defcustom general-holidays
869 '((holiday-fixed 1 1 "New Year's Day")
870 (holiday-float 1 1 3 "Martin Luther King Day")
871 (holiday-fixed 2 2 "Groundhog Day")
872 (holiday-fixed 2 14 "Valentine's Day")
873 (holiday-float 2 1 3 "President's Day")
874 (holiday-fixed 3 17 "St. Patrick's Day")
875 (holiday-fixed 4 1 "April Fools' Day")
876 (holiday-float 5 0 2 "Mother's Day")
877 (holiday-float 5 1 -
1 "Memorial Day")
878 (holiday-fixed 6 14 "Flag Day")
879 (holiday-float 6 0 3 "Father's Day")
880 (holiday-fixed 7 4 "Independence Day")
881 (holiday-float 9 1 1 "Labor Day")
882 (holiday-float 10 1 2 "Columbus Day")
883 (holiday-fixed 10 31 "Halloween")
884 (holiday-fixed 11 11 "Veteran's Day")
885 (holiday-float 11 4 4 "Thanksgiving"))
886 "General holidays. Default value is for the United States.
887 See the documentation for `calendar-holidays' for details."
892 (put 'oriental-holidays
'risky-local-variable t
)
894 (defcustom oriental-holidays
895 '((if (fboundp 'atan
)
896 (holiday-chinese-new-year)))
898 See the documentation for `calendar-holidays' for details."
903 (put 'local-holidays
'risky-local-variable t
)
905 (defcustom local-holidays nil
907 See the documentation for `calendar-holidays' for details."
912 (put 'other-holidays
'risky-local-variable t
)
914 (defcustom other-holidays nil
915 "User defined holidays.
916 See the documentation for `calendar-holidays' for details."
921 (put 'hebrew-holidays-1
'risky-local-variable t
)
923 (defvar hebrew-holidays-1
924 '((holiday-rosh-hashanah-etc)
925 (if all-hebrew-calendar-holidays
928 (let* ((m displayed-month
)
931 (increment-calendar-month m y -
1)
932 (let ((year (extract-calendar-year
933 (calendar-julian-from-absolute
934 (calendar-absolute-from-gregorian
936 (if (zerop (%
(1+ year
) 4))
938 21))) "\"Tal Umatar\" (evening)"))))
941 (put 'hebrew-holidays-2
'risky-local-variable t
)
943 (defvar hebrew-holidays-2
944 '((if all-hebrew-calendar-holidays
946 (holiday-hebrew 9 25 "Hanukkah"))
947 (if all-hebrew-calendar-holidays
950 (let ((h-year (extract-calendar-year
951 (calendar-hebrew-from-absolute
952 (calendar-absolute-from-gregorian
953 (list displayed-month
28 displayed-year
))))))
954 (if (= (%
(calendar-absolute-from-hebrew (list 10 10 h-year
))
959 (if all-hebrew-calendar-holidays
960 (holiday-hebrew 11 15 "Tu B'Shevat"))))
963 (put 'hebrew-holidays-3
'risky-local-variable t
)
965 (defvar hebrew-holidays-3
966 '((if all-hebrew-calendar-holidays
969 (let ((m displayed-month
)
971 (increment-calendar-month m y
1)
972 (let* ((h-year (extract-calendar-year
973 (calendar-hebrew-from-absolute
974 (calendar-absolute-from-gregorian
976 (calendar-last-day-of-month m y
)
979 (calendar-hebrew-from-absolute
981 (%
(calendar-absolute-from-hebrew
985 (calendar-dayname-on-or-before
986 6 (calendar-absolute-from-hebrew
987 (list 11 17 h-year
)))
988 (calendar-dayname-on-or-before
989 6 (calendar-absolute-from-hebrew
990 (list 11 16 h-year
))))))
991 (day (extract-calendar-day s-s
)))
996 (put 'hebrew-holidays-4
'risky-local-variable t
)
998 (defvar hebrew-holidays-4
999 '((holiday-passover-etc)
1000 (if (and all-hebrew-calendar-holidays
1001 (let* ((m displayed-month
)
1004 (increment-calendar-month m y -
1)
1005 (let ((year (extract-calendar-year
1006 (calendar-julian-from-absolute
1007 (calendar-absolute-from-gregorian
1009 (= 21 (% year
28)))))
1010 (holiday-julian 3 26 "Kiddush HaHamah"))
1011 (if all-hebrew-calendar-holidays
1012 (holiday-tisha-b-av-etc))))
1015 (put 'hebrew-holidays
'risky-local-variable t
)
1017 (defcustom hebrew-holidays
(append hebrew-holidays-1 hebrew-holidays-2
1018 hebrew-holidays-3 hebrew-holidays-4
)
1020 See the documentation for `calendar-holidays' for details."
1025 (put 'christian-holidays
'risky-local-variable t
)
1027 (defcustom christian-holidays
1028 '((if all-christian-calendar-holidays
1029 (holiday-fixed 1 6 "Epiphany"))
1030 (holiday-easter-etc 0 "Easter Sunday")
1031 (holiday-easter-etc -
2 "Good Friday")
1032 (holiday-easter-etc -
46 "Ash Wednesday")
1033 (if all-christian-calendar-holidays
1034 (holiday-easter-etc -
63 "Septuagesima Sunday"))
1035 (if all-christian-calendar-holidays
1036 (holiday-easter-etc -
56 "Sexagesima Sunday"))
1037 (if all-christian-calendar-holidays
1038 (holiday-easter-etc -
49 "Shrove Sunday"))
1039 (if all-christian-calendar-holidays
1040 (holiday-easter-etc -
48 "Shrove Monday"))
1041 (if all-christian-calendar-holidays
1042 (holiday-easter-etc -
47 "Shrove Tuesday"))
1043 (if all-christian-calendar-holidays
1044 (holiday-easter-etc -
14 "Passion Sunday"))
1045 (if all-christian-calendar-holidays
1046 (holiday-easter-etc -
7 "Palm Sunday"))
1047 (if all-christian-calendar-holidays
1048 (holiday-easter-etc -
3 "Maundy Thursday"))
1049 (if all-christian-calendar-holidays
1050 (holiday-easter-etc 35 "Rogation Sunday"))
1051 (if all-christian-calendar-holidays
1052 (holiday-easter-etc 39 "Ascension Day"))
1053 (if all-christian-calendar-holidays
1054 (holiday-easter-etc 49 "Pentecost (Whitsunday)"))
1055 (if all-christian-calendar-holidays
1056 (holiday-easter-etc 50 "Whitmonday"))
1057 (if all-christian-calendar-holidays
1058 (holiday-easter-etc 56 "Trinity Sunday"))
1059 (if all-christian-calendar-holidays
1060 (holiday-easter-etc 60 "Corpus Christi"))
1061 (if all-christian-calendar-holidays
1062 (holiday-greek-orthodox-easter))
1063 (if all-christian-calendar-holidays
1064 (holiday-fixed 8 15 "Assumption"))
1065 (if all-christian-calendar-holidays
1066 (holiday-advent 0 "Advent"))
1067 (holiday-fixed 12 25 "Christmas")
1068 (if all-christian-calendar-holidays
1069 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
1070 "Christian holidays.
1071 See the documentation for `calendar-holidays' for details."
1076 (put 'islamic-holidays
'risky-local-variable t
)
1078 (defcustom islamic-holidays
1081 (format "Islamic New Year %d"
1082 (let ((m displayed-month
)
1084 (increment-calendar-month m y
1)
1085 (extract-calendar-year
1086 (calendar-islamic-from-absolute
1087 (calendar-absolute-from-gregorian
1089 m
(calendar-last-day-of-month m y
) y
)))))))
1090 (if all-islamic-calendar-holidays
1091 (holiday-islamic 1 10 "Ashura"))
1092 (if all-islamic-calendar-holidays
1093 (holiday-islamic 3 12 "Mulad-al-Nabi"))
1094 (if all-islamic-calendar-holidays
1095 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
1096 (if all-islamic-calendar-holidays
1097 (holiday-islamic 8 15 "Shab-e-Bara't"))
1098 (holiday-islamic 9 1 "Ramadan Begins")
1099 (if all-islamic-calendar-holidays
1100 (holiday-islamic 9 27 "Shab-e Qadr"))
1101 (if all-islamic-calendar-holidays
1102 (holiday-islamic 10 1 "Id-al-Fitr"))
1103 (if all-islamic-calendar-holidays
1104 (holiday-islamic 12 10 "Id-al-Adha")))
1106 See the documentation for `calendar-holidays' for details."
1111 (put 'bahai-holidays
'risky-local-variable t
)
1113 (defcustom bahai-holidays
1116 (format "Baha'i New Year (Naw-Ruz) %d" (- displayed-year
(1- 1844))))
1117 (holiday-fixed 4 21 "First Day of Ridvan")
1118 (if all-bahai-calendar-holidays
1119 (holiday-fixed 4 22 "Second Day of Ridvan"))
1120 (if all-bahai-calendar-holidays
1121 (holiday-fixed 4 23 "Third Day of Ridvan"))
1122 (if all-bahai-calendar-holidays
1123 (holiday-fixed 4 24 "Fourth Day of Ridvan"))
1124 (if all-bahai-calendar-holidays
1125 (holiday-fixed 4 25 "Fifth Day of Ridvan"))
1126 (if all-bahai-calendar-holidays
1127 (holiday-fixed 4 26 "Sixth Day of Ridvan"))
1128 (if all-bahai-calendar-holidays
1129 (holiday-fixed 4 27 "Seventh Day of Ridvan"))
1130 (if all-bahai-calendar-holidays
1131 (holiday-fixed 4 28 "Eighth Day of Ridvan"))
1132 (holiday-fixed 4 29 "Ninth Day of Ridvan")
1133 (if all-bahai-calendar-holidays
1134 (holiday-fixed 4 30 "Tenth Day of Ridvan"))
1135 (if all-bahai-calendar-holidays
1136 (holiday-fixed 5 1 "Eleventh Day of Ridvan"))
1137 (holiday-fixed 5 2 "Twelfth Day of Ridvan")
1138 (holiday-fixed 5 23 "Declaration of the Bab")
1139 (holiday-fixed 5 29 "Ascension of Baha'u'llah")
1140 (holiday-fixed 7 9 "Martyrdom of the Bab")
1141 (holiday-fixed 10 20 "Birth of the Bab")
1142 (holiday-fixed 11 12 "Birth of Baha'u'llah")
1143 (if all-bahai-calendar-holidays
1144 (holiday-fixed 11 26 "Day of the Covenant"))
1145 (if all-bahai-calendar-holidays
1146 (holiday-fixed 11 28 "Ascension of `Abdu'l-Baha")))
1148 See the documentation for `calendar-holidays' for details."
1153 (put 'solar-holidays
'risky-local-variable t
)
1155 (defcustom solar-holidays
1156 '((if (fboundp 'atan
)
1157 (solar-equinoxes-solstices))
1163 calendar-daylight-savings-starts
1164 '(format "Daylight Savings Time Begins %s"
1167 (/ calendar-daylight-savings-starts-time
(float 60))
1168 calendar-standard-time-zone-name
)
1172 calendar-daylight-savings-ends
1173 '(format "Daylight Savings Time Ends %s"
1176 (/ calendar-daylight-savings-ends-time
(float 60))
1177 calendar-daylight-time-zone-name
)
1179 "Sun-related holidays.
1180 See the documentation for `calendar-holidays' for details."
1185 (put 'calendar-holidays
'risky-local-variable t
)
1186 (defcustom calendar-holidays
1187 (append general-holidays local-holidays other-holidays
1188 christian-holidays hebrew-holidays islamic-holidays
1189 bahai-holidays oriental-holidays solar-holidays
)
1190 "List of notable days for the command \\[holidays].
1192 Additional holidays are easy to add to the list, just put them in the
1193 list `other-holidays' in your .emacs file. Similarly, by setting any
1194 of `general-holidays', `local-holidays' `christian-holidays',
1195 `hebrew-holidays', `islamic-holidays', `bahai-holidays',
1196 `oriental-holidays', or `solar-holidays' to nil in your .emacs file,
1197 you can eliminate unwanted categories of holidays.
1199 The aforementioned variables control the holiday choices offered
1200 by the function `list-holidays' when it is called interactively.
1202 They also initialize the default value of `calendar-holidays',
1203 which is the default list of holidays used by the function
1204 `list-holidays' in the non-interactive case. Note that these
1205 variables have no effect on `calendar-holidays' after it has been
1206 set (e.g. after the calendar is loaded). In that case, customize
1207 `calendar-holidays' directly.
1209 The intention is that (in the US) `local-holidays' be set in
1210 site-init.el and `other-holidays' be set by the user.
1212 Entries on the list are expressions that return (possibly empty) lists of
1213 items of the form ((month day year) string) of a holiday in the in the
1214 three-month period centered around `displayed-month' of `displayed-year'.
1215 Several basic functions are provided for this purpose:
1217 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1218 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1219 MONTH on the Gregorian calendar (0 for Sunday,
1220 etc.); K<0 means count back from the end of the
1221 month. An optional parameter DAY means the Kth
1222 DAYNAME after/before MONTH DAY.
1223 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1224 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1225 (holiday-bahai MONTH DAY STRING) a fixed date on the Baha'i calendar
1226 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1227 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
1228 in the variable `year'; if it evaluates to
1229 a visible date, that's the holiday; if it
1230 evaluates to nil, there's no holiday. STRING
1231 is an expression in the variable `date'.
1233 For example, to add Bastille Day, celebrated in France on July 14, add
1235 (holiday-fixed 7 14 \"Bastille Day\")
1237 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1238 Islands on the fourth Monday in August, add
1240 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
1242 to the list (the last Monday would be specified with `-1' instead of `4').
1243 To add the last day of Hanukkah to the list, use
1245 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
1247 since the Hebrew months are numbered with 1 starting from Nisan, while to
1248 add the Islamic feast celebrating Mohammed's birthday use
1250 (holiday-islamic 3 12 \"Mohammed's Birthday\")
1252 since the Islamic months are numbered from 1 starting with Muharram. To
1253 add an entry for the Baha'i festival of Ridvan, use
1255 (holiday-bahai 2 13 \"Festival of Ridvan\")
1257 since the Baha'i months are numbered from 1 starting with Baha. To
1258 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1260 (holiday-julian 4 2 \"Jefferson's Birthday\")
1262 To include a holiday conditionally, use the sexp form or a conditional. For
1263 example, to include American presidential elections, which occur on the first
1264 Tuesday after the first Monday in November of years divisible by 4, add
1267 '(if (zerop (% year 4))
1268 (calendar-gregorian-from-absolute
1269 (1+ (calendar-dayname-on-or-before
1270 1 (+ 6 (calendar-absolute-from-gregorian
1271 (list 11 1 year)))))))
1272 \"US Presidential Election\")
1276 (if (zerop (% displayed-year 4))
1278 (extract-calendar-day
1279 (calendar-gregorian-from-absolute
1280 (1+ (calendar-dayname-on-or-before
1281 1 (+ 6 (calendar-absolute-from-gregorian
1282 (list 11 1 displayed-year)))))))
1283 \"US Presidential Election\"))
1285 to the list. To include the phases of the moon, add
1289 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1290 you've written to return a (possibly empty) list of the relevant VISIBLE dates
1291 with descriptive strings such as
1293 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
1297 (defconst holiday-buffer
"*Holidays*"
1298 "Name of the buffer used for the displaying the holidays.")
1300 (defconst fancy-diary-buffer
"*Fancy Diary Entries*"
1301 "Name of the buffer used for the optional fancy display of the diary.")
1303 (defconst other-calendars-buffer
"*Other Calendars*"
1304 "Name of the buffer used for the display of date on other calendars.")
1306 (defconst lunar-phases-buffer
"*Phases of Moon*"
1307 "Name of the buffer used for the lunar phases.")
1309 (defmacro increment-calendar-month
(mon yr n
)
1310 "Increment the variables MON and YR by N months.
1311 Forward if N is positive or backward if N is negative.
1312 A negative YR is interpreted as BC; -1 being 1 BC, and so on."
1314 (if (< ,yr
0) (setq ,yr
(1+ ,yr
))) ; -1 BC -> 0 AD, etc
1315 (setq macro-y
(+ (* ,yr
12) ,mon -
1 ,n
)
1316 ,mon
(1+ (mod macro-y
12))
1318 (and (< macro-y
0) (> ,mon
1) (setq ,yr
(1- ,yr
)))
1319 (if (< ,yr
1) (setq ,yr
(1- ,yr
))))) ; 0 AD -> -1 BC, etc
1321 (defun calendar-increment-month (n &optional mon yr
)
1322 "Return the Nth month after MON/YR.
1323 The return value is a pair (MONTH . YEAR).
1324 MON defaults to `displayed-month'. YR defaults to `displayed-year'."
1325 (unless mon
(setq mon displayed-month
))
1326 (unless yr
(setq yr displayed-year
))
1327 (increment-calendar-month mon yr n
)
1330 (defmacro calendar-for-loop
(var from init to final do
&rest body
)
1331 "Execute a for loop."
1332 (declare (debug (symbolp "from" form
"to" form
"do" body
)))
1333 `(let ((,var
(1- ,init
)))
1334 (while (>= ,final
(setq ,var
(1+ ,var
)))
1337 (defmacro calendar-sum
(index initial condition expression
)
1338 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
1339 (declare (debug (symbolp form form form
)))
1340 `(let ((,index
,initial
)
1343 (setq sum
(+ sum
,expression
))
1344 (setq ,index
(1+ ,index
)))
1347 ;; The following are in-line for speed; they can be called thousands of times
1348 ;; when looking up holidays or processing the diary. Here, for example, are
1349 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1350 ;; fancy diary display, for a moderately complex diary file, with functions
1351 ;; used instead of macros. There were a total of 10000 such calls:
1353 ;; 1934 extract-calendar-month
1354 ;; 1852 extract-calendar-year
1355 ;; 1819 extract-calendar-day
1356 ;; 845 calendar-leap-year-p
1357 ;; 837 calendar-day-number
1358 ;; 775 calendar-absolute-from-gregorian
1359 ;; 346 calendar-last-day-of-month
1360 ;; 286 hebrew-calendar-last-day-of-month
1361 ;; 188 hebrew-calendar-leap-year-p
1362 ;; 180 hebrew-calendar-elapsed-days
1363 ;; 163 hebrew-calendar-last-month-of-year
1364 ;; 66 calendar-date-compare
1365 ;; 65 hebrew-calendar-days-in-year
1366 ;; 60 calendar-absolute-from-julian
1367 ;; 50 calendar-absolute-from-hebrew
1368 ;; 43 calendar-date-equal
1369 ;; 38 calendar-gregorian-from-absolute
1374 ;; The use of these seven macros eliminates the overhead of 92% of the function
1375 ;; calls; it's faster this way.
1377 (defsubst extract-calendar-month
(date)
1378 "Extract the month part of DATE which has the form (month day year)."
1381 ;; Note gives wrong answer for result of (calendar-read-date 'noday).
1382 (defsubst extract-calendar-day
(date)
1383 "Extract the day part of DATE which has the form (month day year)."
1386 (defsubst extract-calendar-year
(date)
1387 "Extract the year part of DATE which has the form (month day year)."
1388 (car (cdr (cdr date
))))
1390 (defsubst calendar-leap-year-p
(year)
1391 "Return t if YEAR is a Gregorian leap year.
1392 A negative year is interpreted as BC; -1 being 1 BC, and so on."
1393 ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc.
1394 (if (< year
0) (setq year
(1- (abs year
))))
1395 (and (zerop (% year
4))
1396 (or (not (zerop (% year
100)))
1397 (zerop (% year
400)))))
1399 ;; The foregoing is a bit faster, but not as clear as the following:
1401 ;;(defsubst calendar-leap-year-p (year)
1402 ;; "Returns t if YEAR is a Gregorian leap year."
1404 ;; (and (= (% year 4) 0)
1405 ;; (/= (% year 100) 0))
1406 ;; (= (% year 400) 0)))
1408 (defsubst calendar-last-day-of-month
(month year
)
1409 "The last day in MONTH during YEAR."
1410 (if (and (= month
2) (calendar-leap-year-p year
))
1412 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month
))))
1414 ;; An explanation of the calculation can be found in PascAlgorithms by
1415 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1417 (defsubst calendar-day-number
(date)
1418 "Return the day number within the year of the date DATE.
1419 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1420 while (calendar-day-number '(12 31 1980)) returns 366."
1421 (let* ((month (extract-calendar-month date
))
1422 (day (extract-calendar-day date
))
1423 (year (extract-calendar-year date
))
1424 (day-of-year (+ day
(* 31 (1- month
)))))
1427 (setq day-of-year
(- day-of-year
(/ (+ 23 (* 4 month
)) 10)))
1428 (if (calendar-leap-year-p year
)
1429 (setq day-of-year
(1+ day-of-year
)))))
1432 (defsubst calendar-absolute-from-gregorian
(date)
1433 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1434 The Gregorian date Sunday, December 31, 1 BC is imaginary.
1435 DATE is a list of the form (month day year). A negative year is
1436 interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC
1437 return negative results."
1438 (let ((year (extract-calendar-year date
))
1441 (error "There was no year zero"))
1443 (setq offset-years
(1- year
))
1444 (+ (calendar-day-number date
) ; Days this year
1445 (* 365 offset-years
) ; + Days in prior years
1446 (/ offset-years
4) ; + Julian leap years
1447 (- (/ offset-years
100)) ; - century years
1448 (/ offset-years
400))) ; + Gregorian leap years
1450 ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc).
1451 (setq offset-years
(abs (1+ year
)))
1452 (- (calendar-day-number date
)
1453 (* 365 offset-years
)
1455 (- (/ offset-years
100))
1456 (/ offset-years
400)
1457 (calendar-day-number '(12 31 -
1))))))) ; days in year 1 BC
1459 (autoload 'calendar-goto-today
"cal-move"
1460 "Reposition the calendar window so the current date is visible."
1463 (autoload 'calendar-forward-month
"cal-move"
1464 "Move the cursor forward ARG months."
1467 (autoload 'calendar-forward-year
"cal-move"
1468 "Move the cursor forward by ARG years."
1471 (autoload 'calendar-backward-month
"cal-move"
1472 "Move the cursor backward by ARG months."
1475 (autoload 'calendar-backward-year
"cal-move"
1476 "Move the cursor backward ARG years."
1479 (autoload 'scroll-calendar-left
"cal-move"
1480 "Scroll the displayed calendar left by ARG months."
1483 (autoload 'scroll-calendar-right
"cal-move"
1484 "Scroll the displayed calendar window right by ARG months."
1487 (autoload 'scroll-calendar-left-three-months
"cal-move"
1488 "Scroll the displayed calendar window left by 3*ARG months."
1491 (autoload 'scroll-calendar-right-three-months
"cal-move"
1492 "Scroll the displayed calendar window right by 3*ARG months."
1495 (autoload 'calendar-cursor-to-nearest-date
"cal-move"
1496 "Move the cursor to the closest date."
1499 (autoload 'calendar-forward-day
"cal-move"
1500 "Move the cursor forward ARG days."
1503 (autoload 'calendar-backward-day
"cal-move"
1504 "Move the cursor back ARG days."
1507 (autoload 'calendar-forward-week
"cal-move"
1508 "Move the cursor forward ARG weeks."
1511 (autoload 'calendar-backward-week
"cal-move"
1512 "Move the cursor back ARG weeks."
1515 (autoload 'calendar-beginning-of-week
"cal-move"
1516 "Move the cursor back ARG calendar-week-start-day's."
1519 (autoload 'calendar-end-of-week
"cal-move"
1520 "Move the cursor forward ARG calendar-week-start-day+6's."
1523 (autoload 'calendar-beginning-of-month
"cal-move"
1524 "Move the cursor backward ARG month beginnings."
1527 (autoload 'calendar-end-of-month
"cal-move"
1528 "Move the cursor forward ARG month ends."
1531 (autoload 'calendar-beginning-of-year
"cal-move"
1532 "Move the cursor backward ARG year beginnings."
1535 (autoload 'calendar-end-of-year
"cal-move"
1536 "Move the cursor forward ARG year beginnings."
1539 (autoload 'calendar-cursor-to-visible-date
"cal-move"
1540 "Move the cursor to DATE that is on the screen."
1543 (autoload 'calendar-goto-date
"cal-move"
1544 "Move cursor to DATE."
1547 (autoload 'calendar-goto-day-of-year
"cal-move"
1548 "Move cursor to day of year."
1551 (autoload 'calendar-only-one-frame-setup
"cal-x"
1552 "Start calendar and display it in a dedicated frame.")
1554 (autoload 'calendar-one-frame-setup
"cal-x"
1555 "Start calendar and display it in a dedicated frame together with the diary.")
1557 (autoload 'calendar-two-frame-setup
"cal-x"
1558 "Start calendar and diary in separate, dedicated frames.")
1561 (defcustom calendar-setup nil
1562 "The frame setup of the calendar.
1563 The choices are: `one-frame' (calendar and diary together in one separate,
1564 dedicated frame); `two-frames' (calendar and diary in separate, dedicated
1565 frames); `calendar-only' (calendar in a separate, dedicated frame); with
1566 any other value the current frame is used. Using any of the first
1567 three options overrides the value of `view-diary-entries-initially'."
1569 (const :tag
"calendar and diary in separate frame" one-frame
)
1570 (const :tag
"calendar and diary each in own frame" two-frames
)
1571 (const :tag
"calendar in separate frame" calendar-only
)
1572 (const :tag
"use current frame" nil
))
1575 (defcustom calendar-minimum-window-height
8
1576 "Minimum height `generate-calendar-window' should use for calendar window."
1582 (defun calendar (&optional arg
)
1583 "Choose between the one frame, two frame, or basic calendar displays.
1584 If called with an optional prefix argument, prompts for month and year.
1586 The original function `calendar' has been renamed `calendar-basic-setup'.
1587 See the documentation of that function for more information."
1589 (cond ((equal calendar-setup
'one-frame
) (calendar-one-frame-setup arg
))
1590 ((equal calendar-setup
'two-frames
) (calendar-two-frame-setup arg
))
1591 ((equal calendar-setup
'calendar-only
)
1592 (calendar-only-one-frame-setup arg
))
1593 (t (calendar-basic-setup arg
))))
1595 (autoload 'diary-view-entries
"diary-lib"
1596 "Prepare and display a buffer with diary entries.
1597 Searches your diary file for entries that match ARG days starting with
1598 the date indicated by the cursor position in the displayed three-month
1602 (autoload 'list-calendar-holidays
"holidays"
1603 "Create a buffer containing the holidays for the current calendar window.
1604 The holidays are those in the list `calendar-notable-days'. Returns t if any
1605 holidays are found, nil if not."
1608 (defun calendar-basic-setup (&optional arg
)
1609 "Display a three-month calendar in another window.
1610 The three months appear side by side, with the current month in the middle
1611 surrounded by the previous and next months. The cursor is put on today's date.
1613 If called with an optional prefix argument, prompts for month and year.
1615 This function is suitable for execution in a .emacs file; appropriate setting
1616 of the variable `view-diary-entries-initially' will cause the diary entries for
1617 the current date to be displayed in another window. The value of the variable
1618 `number-of-diary-entries' controls the number of days of diary entries
1619 displayed upon initial display of the calendar.
1621 Once in the calendar window, future or past months can be moved into view.
1622 Arbitrary months can be displayed, or the calendar can be scrolled forward
1625 The cursor can be moved forward or backward by one day, one week, one month,
1626 or one year. All of these commands take prefix arguments which, when negative,
1627 cause movement in the opposite direction. For convenience, the digit keys
1628 and the minus sign are automatically prefixes. The window is replotted as
1629 necessary to display the desired date.
1631 Diary entries can be marked on the calendar or displayed in another window.
1633 Use \\[describe-mode] for details of the key bindings in the calendar window.
1635 The Gregorian calendar is assumed.
1637 After loading the calendar, the hooks given by the variable
1638 `calendar-load-hook' are run. This is the place to add key bindings to the
1641 After preparing the calendar window initially, the hooks given by the variable
1642 `initial-calendar-window-hook' are run.
1644 The hooks given by the variable `today-visible-calendar-hook' are run
1645 every time the calendar window gets scrolled, if the current date is visible
1646 in the window. If it is not visible, the hooks given by the variable
1647 `today-invisible-calendar-hook' are run. Thus, for example, setting
1648 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1649 to be replaced by asterisks to highlight it whenever it is in the window."
1651 (set-buffer (get-buffer-create calendar-buffer
))
1653 (let* ((pop-up-windows t
)
1654 (split-height-threshold 1000)
1656 (calendar-read-date t
)
1657 (calendar-current-date)))
1658 (month (extract-calendar-month date
))
1659 (year (extract-calendar-year date
)))
1660 ;; (calendar-read-date t) returns a date with day = nil, which is
1661 ;; not a legal date for the visible test in the diary section.
1662 (if arg
(setcar (cdr date
) 1))
1663 (pop-to-buffer calendar-buffer
)
1664 (increment-calendar-month month year
(- calendar-offset
))
1665 (generate-calendar-window month year
)
1666 (if (and view-diary-entries-initially
(calendar-date-is-visible-p date
))
1667 (diary-view-entries)))
1668 (let* ((diary-buffer (get-file-buffer diary-file
))
1669 (diary-window (if diary-buffer
(get-buffer-window diary-buffer
)))
1670 (split-height-threshold (if diary-window
2 1000)))
1671 (if view-calendar-holidays-initially
1672 (list-calendar-holidays)))
1673 (run-hooks 'initial-calendar-window-hook
))
1675 (autoload 'view-other-diary-entries
"diary-lib"
1676 "Prepare and display buffer of diary entries from an alternative diary file.
1677 Searches for entries that match ARG days, starting with the date indicated
1678 by the cursor position in the displayed three-month calendar.
1679 D-FILE specifies the file to use as the diary file."
1682 (autoload 'calendar-sunrise-sunset
"solar"
1683 "Local time of sunrise and sunset for date under cursor."
1686 (autoload 'calendar-phases-of-moon
"lunar"
1687 "Create a buffer of the phases of the moon for the current calendar window."
1690 (autoload 'calendar-print-french-date
"cal-french"
1691 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1694 (autoload 'calendar-goto-french-date
"cal-french"
1695 "Move cursor to French Revolutionary date."
1698 (autoload 'calendar-french-date-string
"cal-french"
1699 "String of French Revolutionary date of Gregorian date.")
1701 (autoload 'calendar-mayan-date-string
"cal-mayan"
1702 "String of Mayan date of Gregorian date.")
1704 (autoload 'calendar-print-mayan-date
"cal-mayan"
1705 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1708 (autoload 'calendar-goto-mayan-long-count-date
"cal-mayan"
1709 "Move cursor to Mayan long count date."
1712 (autoload 'calendar-next-haab-date
"cal-mayan"
1713 "Move cursor to next instance of Mayan Haab date."
1716 (autoload 'calendar-previous-haab-date
"cal-mayan"
1717 "Move cursor to previous instance of Mayan Haab date."
1720 (autoload 'calendar-next-tzolkin-date
"cal-mayan"
1721 "Move cursor to next instance of Mayan Tzolkin date."
1724 (autoload 'calendar-previous-tzolkin-date
"cal-mayan"
1725 "Move cursor to previous instance of Mayan Tzolkin date."
1728 (autoload 'calendar-next-calendar-round-date
"cal-mayan"
1729 "Move cursor to next instance of Mayan Haab/Tzolkin combination."
1732 (autoload 'calendar-previous-calendar-round-date
"cal-mayan"
1733 "Move cursor to previous instance of Mayan Haab/Tzolkin combination."
1736 (autoload 'calendar-goto-chinese-date
"cal-china"
1737 "Move cursor to Chinese date."
1740 (autoload 'calendar-print-chinese-date
"cal-china"
1741 "Show the Chinese date equivalents of date."
1744 (autoload 'calendar-chinese-date-string
"cal-china"
1745 "String of Chinese date of Gregorian date.")
1747 (autoload 'calendar-absolute-from-astro
"cal-julian"
1748 "Absolute date of astronomical (Julian) day number D."
1751 (autoload 'calendar-astro-from-absolute
"cal-julian"
1752 "Astronomical (Julian) day number of absolute date D.")
1754 (autoload 'calendar-astro-date-string
"cal-julian"
1755 "String of astronomical (Julian) day number of Gregorian date.")
1757 (autoload 'calendar-goto-astro-day-number
"cal-julian"
1758 "Move cursor to astronomical (Julian) day number."
1761 (autoload 'calendar-print-astro-day-number
"cal-julian"
1762 "Show the astro date equivalents of date."
1765 (autoload 'calendar-julian-from-absolute
"cal-julian"
1766 "Compute the Julian (month day year) corresponding to the absolute DATE.
1767 The absolute date is the number of days elapsed since the (imaginary)
1768 Gregorian date Sunday, December 31, 1 BC.")
1770 (autoload 'calendar-goto-julian-date
"cal-julian"
1771 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1774 (autoload 'calendar-print-julian-date
"cal-julian"
1775 "Show the Julian calendar equivalent of the date under the cursor."
1778 (autoload 'calendar-julian-date-string
"cal-julian"
1779 "String of Julian date of Gregorian DATE.
1780 Defaults to today's date if DATE is not given.
1781 Driven by the variable `calendar-date-display-form'.")
1783 (autoload 'calendar-goto-iso-date
"cal-iso"
1784 "Move cursor to ISO date."
1787 (autoload 'calendar-goto-iso-week
"cal-iso"
1788 "Move cursor to start of ISO week."
1791 (autoload 'calendar-print-iso-date
"cal-iso"
1792 "Show the ISO date equivalents of date."
1795 (autoload 'calendar-iso-date-string
"cal-iso"
1796 "String of ISO date of Gregorian date.")
1798 (autoload 'calendar-goto-islamic-date
"cal-islam"
1799 "Move cursor to Islamic date."
1802 (autoload 'calendar-print-islamic-date
"cal-islam"
1803 "Show the Islamic date equivalents of date."
1806 (autoload 'calendar-islamic-date-string
"cal-islam"
1807 "String of Islamic date of Gregorian date.")
1809 (autoload 'calendar-print-bahai-date
"cal-bahai"
1810 "Show the Baha'i date equivalents of date."
1813 (autoload 'calendar-bahai-date-string
"cal-bahai"
1814 "String of Baha'i date of Gregorian date.")
1816 (autoload 'calendar-goto-hebrew-date
"cal-hebrew"
1817 "Move cursor to Hebrew date."
1820 (autoload 'calendar-print-hebrew-date
"cal-hebrew"
1821 "Show the Hebrew date equivalents of date."
1824 (autoload 'calendar-hebrew-date-string
"cal-hebrew"
1825 "String of Hebrew date of Gregorian date.")
1827 (autoload 'calendar-goto-coptic-date
"cal-coptic"
1828 "Move cursor to Coptic date."
1831 (autoload 'calendar-print-coptic-date
"cal-coptic"
1832 "Show the Coptic date equivalents of date."
1835 (autoload 'calendar-coptic-date-string
"cal-coptic"
1836 "String of Coptic date of Gregorian date.")
1838 (autoload 'calendar-goto-ethiopic-date
"cal-coptic"
1839 "Move cursor to Ethiopic date."
1842 (autoload 'calendar-print-ethiopic-date
"cal-coptic"
1843 "Show the Ethiopic date equivalents of date."
1846 (autoload 'calendar-ethiopic-date-string
"cal-coptic"
1847 "String of Ethiopic date of Gregorian date.")
1849 (autoload 'calendar-goto-persian-date
"cal-persia"
1850 "Move cursor to Persian date."
1853 (autoload 'calendar-print-persian-date
"cal-persia"
1854 "Show the Persian date equivalents of date."
1857 (autoload 'calendar-persian-date-string
"cal-persia"
1858 "String of Persian date of Gregorian date.")
1860 (autoload 'diary-show-all-entries
"diary-lib"
1861 "Show all of the diary entries in the diary file.
1862 This function gets rid of the selective display of the diary file so that
1863 all entries, not just some, are visible. If there is no diary buffer, one
1867 (autoload 'mark-diary-entries
"diary-lib"
1868 "Mark days in the calendar window that have diary entries.
1869 Each entry in diary file visible in the calendar window is marked."
1872 (autoload 'make-diary-entry
"diary-lib"
1873 "Insert a diary entry STRING which may be NONMARKING in FILE.")
1875 (autoload 'insert-diary-entry
"diary-lib"
1876 "Insert a diary entry for the date indicated by point."
1879 (autoload 'insert-weekly-diary-entry
"diary-lib"
1880 "Insert a weekly diary entry for the day of the week indicated by point."
1884 (autoload 'insert-monthly-diary-entry
"diary-lib"
1885 "Insert a monthly diary entry for the day of the month indicated by point."
1888 (autoload 'insert-yearly-diary-entry
"diary-lib"
1889 "Insert an annual diary entry for the day of the year indicated by point."
1892 (autoload 'insert-anniversary-diary-entry
"diary-lib"
1893 "Insert an anniversary diary entry for the date indicated by point."
1896 (autoload 'insert-block-diary-entry
"diary-lib"
1897 "Insert a block diary entry for the dates indicated by point and mark."
1900 (autoload 'insert-cyclic-diary-entry
"diary-lib"
1901 "Insert a cyclic diary entry starting at the date indicated by point."
1904 (autoload 'insert-hebrew-diary-entry
"cal-hebrew"
1905 "Insert a diary entry for the Hebrew date corresponding to the date
1906 indicated by point."
1909 (autoload 'insert-monthly-hebrew-diary-entry
"cal-hebrew"
1910 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1911 to the date indicated by point."
1914 (autoload 'insert-yearly-hebrew-diary-entry
"cal-hebrew"
1915 "Insert an annual diary entry for the day of the Hebrew year corresponding
1916 to the date indicated by point."
1919 (autoload 'insert-islamic-diary-entry
"cal-islam"
1920 "Insert a diary entry for the Islamic date corresponding to the date
1921 indicated by point."
1924 (autoload 'insert-monthly-islamic-diary-entry
"cal-islam"
1925 "Insert a monthly diary entry for the day of the Islamic month corresponding
1926 to the date indicated by point."
1929 (autoload 'insert-yearly-islamic-diary-entry
"cal-islam"
1930 "Insert an annual diary entry for the day of the Islamic year corresponding
1931 to the date indicated by point."
1934 (autoload 'insert-bahai-diary-entry
"cal-bahai"
1935 "Insert a diary entry for the Baha'i date corresponding to the date
1936 indicated by point."
1939 (autoload 'insert-monthly-bahai-diary-entry
"cal-bahai"
1940 "Insert a monthly diary entry for the day of the Baha'i month corresponding
1941 to the date indicated by point."
1944 (autoload 'insert-yearly-bahai-diary-entry
"cal-bahai"
1945 "Insert an annual diary entry for the day of the Baha'i year corresponding
1946 to the date indicated by point."
1949 (autoload 'cal-tex-cursor-month
"cal-tex"
1950 "Make a buffer with LaTeX commands for the month cursor is on.
1951 Optional prefix argument specifies number of months to be produced.
1952 Calendar is condensed onto one page." t
)
1954 (autoload 'cal-tex-cursor-month-landscape
"cal-tex"
1955 "Make a buffer with LaTeX commands for the month cursor is on.
1956 Optional prefix argument specifies number of months to be produced." t
)
1958 (autoload 'cal-tex-cursor-day
"cal-tex"
1959 "Make a buffer with LaTeX commands for the day cursor is on." t
)
1961 (autoload 'cal-tex-cursor-week
"cal-tex"
1962 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1963 It applies to the week that point is in.
1964 Optional prefix argument specifies number of weeks.
1965 Holidays are included if `cal-tex-holidays' is t." t
)
1967 (autoload 'cal-tex-cursor-week2
"cal-tex"
1968 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1969 It applies to the week that point is in.
1970 Optional prefix argument specifies number of weeks.
1971 Holidays are included if `cal-tex-holidays' is t." t
)
1973 (autoload 'cal-tex-cursor-week-iso
"cal-tex"
1974 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
1975 Optional prefix argument specifies number of weeks.
1976 Diary entries are included if `cal-tex-diary' is t.
1977 Holidays are included if `cal-tex-holidays' is t." t
)
1979 (autoload 'cal-tex-cursor-week-monday
"cal-tex"
1980 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1981 It applies to the week that point is in, and starts on Monday.
1982 Optional prefix argument specifies number of weeks.
1983 Holidays are included if `cal-tex-holidays' is t." t
)
1985 (autoload 'cal-tex-cursor-filofax-2week
"cal-tex"
1986 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
1987 Optional prefix argument specifies number of weeks.
1988 Diary entries are included if cal-tex-diary is t.
1989 Holidays are included if `cal-tex-holidays' is t." t
)
1991 (autoload 'cal-tex-cursor-filofax-week
"cal-tex"
1992 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
1993 Optional prefix argument specifies number of weeks.
1994 Weeks start on Monday.
1995 Diary entries are included if cal-tex-diary is t.
1996 Holidays are included if `cal-tex-holidays' is t." t
)
1998 (autoload 'cal-tex-cursor-filofax-daily
"cal-tex"
1999 "Day-per-page Filofax style calendar for week indicated by cursor.
2000 Optional prefix argument specifies number of weeks. Weeks start on Monday.
2001 Diary entries are included if `cal-tex-diary' is t.
2002 Holidays are included if `cal-tex-holidays' is t." t
)
2004 (autoload 'cal-tex-cursor-year
"cal-tex"
2005 "Make a buffer with LaTeX commands for a year's calendar.
2006 Optional prefix argument specifies number of years." t
)
2008 (autoload 'cal-tex-cursor-year-landscape
"cal-tex"
2009 "Make a buffer with LaTeX commands for a year's calendar (landscape).
2010 Optional prefix argument specifies number of years." t
)
2012 (autoload 'cal-tex-cursor-filofax-year
"cal-tex"
2013 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
2014 Optional prefix argument specifies number of years." t
)
2016 (autoload 'mark-calendar-holidays
"holidays"
2017 "Mark notable days in the calendar window."
2020 (autoload 'calendar-cursor-holidays
"holidays"
2021 "Find holidays for the date specified by the cursor in the calendar window."
2024 (defun generate-calendar-window (&optional mon yr
)
2025 "Generate the calendar window for the current date.
2026 Or, for optional MON, YR."
2027 (let* ((buffer-read-only nil
)
2028 (today (calendar-current-date))
2029 (month (extract-calendar-month today
))
2030 (day (extract-calendar-day today
))
2031 (year (extract-calendar-year today
))
2034 (let ((offset (calendar-interval mon yr month year
)))
2035 (and (<= offset
1) (>= offset -
1)))))
2036 (day-in-week (calendar-day-of-week today
))
2037 (in-calendar-window (eq (window-buffer (selected-window))
2038 (get-buffer calendar-buffer
))))
2039 (update-calendar-mode-line)
2041 (generate-calendar mon yr
)
2042 (generate-calendar month year
))
2043 (calendar-cursor-to-visible-date
2044 (if today-visible today
(list displayed-month
1 displayed-year
)))
2045 (set-buffer-modified-p nil
)
2046 ;; Don't do any window-related stuff if we weren't called from a
2047 ;; window displaying the calendar
2048 (when in-calendar-window
2049 (if (or (one-window-p t
) (/= (frame-width) (window-width)))
2050 ;; Don't mess with the window size, but ensure that the first
2051 ;; line is fully visible
2052 (set-window-vscroll nil
0)
2053 ;; Adjust the window to exactly fit the displayed calendar
2054 (fit-window-to-buffer nil nil calendar-minimum-window-height
))
2056 (if (and (boundp 'font-lock-mode
)
2058 (font-lock-fontify-buffer))
2059 (and mark-holidays-in-calendar
2060 ;;; (calendar-date-is-legal-p today) ; useful for BC dates
2061 (mark-calendar-holidays)
2062 (and in-calendar-window
(sit-for 0)))
2064 (if mark-diary-entries-in-calendar
(mark-diary-entries))
2066 (run-hooks 'today-visible-calendar-hook
)
2067 (run-hooks 'today-invisible-calendar-hook
)))))
2069 (defun generate-calendar (month year
)
2070 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
2071 ;;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on.
2072 ;;; Note that while calendars for years BC could be displayed as it
2073 ;;; stands, almost all other calendar functions (eg holidays) would
2074 ;;; at best have unpredictable results for such dates.
2075 (if (< (+ month
(* 12 (1- year
))) 2)
2076 (error "Months before January, 1 AD cannot be displayed"))
2077 (setq displayed-month month
2078 displayed-year year
)
2080 (increment-calendar-month month year -
1)
2081 (calendar-for-loop i from
0 to
2 do
2082 (generate-calendar-month month year
(+ 5 (* 25 i
)))
2083 (increment-calendar-month month year
1)))
2085 (defun generate-calendar-month (month year indent
)
2086 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
2087 The calendar is inserted at the top of the buffer in which point is currently
2088 located, but indented INDENT spaces. The indentation is done from the first
2089 character on the line and does not disturb the first INDENT characters on the
2091 (let* ((blank-days;; at start of month
2093 (- (calendar-day-of-week (list month
1 year
))
2094 calendar-week-start-day
)
2096 (last (calendar-last-day-of-month month year
)))
2097 (goto-char (point-min))
2098 (calendar-insert-indented
2099 (calendar-string-spread
2100 (list (format "%s %d" (calendar-month-name month
) year
)) ?
20)
2102 (calendar-insert-indented "" indent
);; Go to proper spot
2103 ;; Use the first two characters of each day to head the columns.
2104 (calendar-for-loop i from
0 to
6 do
2107 (calendar-day-name (mod (+ calendar-week-start-day i
) 7) nil t
)))
2108 (if enable-multibyte-characters
2109 (truncate-string-to-width string
2)
2110 (substring string
0 2)))
2112 (calendar-insert-indented "" 0 t
);; Force onto following line
2113 (calendar-insert-indented "" indent
);; Go to proper spot
2114 ;; Add blank days before the first of the month
2115 (calendar-for-loop i from
1 to blank-days do
(insert " "))
2116 ;; Put in the days of the month
2117 (calendar-for-loop i from
1 to last do
2118 (insert (format "%2d " i
))
2119 (add-text-properties
2120 (- (point) 3) (1- (point))
2121 '(mouse-face highlight
2122 help-echo
"mouse-2: menu of operations for this date"))
2123 (and (zerop (mod (+ i blank-days
) 7))
2125 (calendar-insert-indented "" 0 t
) ;; Force onto following line
2126 (calendar-insert-indented "" indent
)))));; Go to proper spot
2128 (defun calendar-insert-indented (string indent
&optional newline
)
2129 "Insert STRING at column INDENT.
2130 If the optional parameter NEWLINE is t, leave point at start of next line,
2131 inserting a newline if there was no next line; otherwise, leave point after
2132 the inserted text. Value is always t."
2133 ;; Try to move to that column.
2134 (move-to-column indent
)
2135 ;; If line is too short, indent out to that column.
2136 (if (< (current-column) indent
)
2139 ;; Advance to next line, if requested.
2148 (defun redraw-calendar ()
2149 "Redraw the calendar display, if `calendar-buffer' is live."
2151 (if (get-buffer calendar-buffer
)
2152 (with-current-buffer calendar-buffer
2153 (let ((cursor-date (calendar-cursor-to-nearest-date)))
2154 (generate-calendar-window displayed-month displayed-year
)
2155 (calendar-cursor-to-visible-date cursor-date
)))))
2158 (defcustom calendar-week-start-day
0
2159 "The day of the week on which a week in the calendar begins.
2160 0 means Sunday (default), 1 means Monday, and so on.
2162 If you change this variable directly (without using customize)
2163 after starting `calendar', you should call `redraw-calendar' to
2164 update the calendar display to reflect the change, otherwise
2165 movement commands will not work correctly."
2167 ;; Change the initialize so that if you reload calendar.el, it will not
2168 ;; cause a redraw (which may fail, e.g. with "invalid byte-code in
2169 ;; calendar.elc" because of the "byte-compile-dynamic").
2170 :initialize
'custom-initialize-default
2171 :set
(lambda (sym val
)
2176 (defcustom calendar-debug-sexp nil
2177 "Turn debugging on when evaluating a sexp in the diary or holiday list."
2181 (defvar calendar-mode-map nil
)
2182 (if calendar-mode-map
2184 (let ((map (make-keymap)))
2185 (suppress-keymap map
)
2186 (dolist (c '(narrow-to-region mark-word mark-sexp mark-paragraph
2187 mark-defun
mark-whole-buffer mark-page
2188 downcase-region upcase-region kill-region
2189 copy-region-as-kill capitalize-region write-region
))
2190 (define-key map
(vector 'remap c
) 'calendar-not-implemented
))
2191 (define-key map
">" 'scroll-calendar-right
)
2192 (define-key map
"\C-x>" 'scroll-calendar-right
)
2193 (define-key map
[prior] 'scroll-calendar-right-three-months)
2194 (define-key map "\ev" 'scroll-calendar-right-three-months)
2195 (define-key map "<" 'scroll-calendar-left)
2196 (define-key map "\C-x<" 'scroll-calendar-left)
2197 (define-key map [next] 'scroll-calendar-left-three-months)
2198 (define-key map "\C-v" 'scroll-calendar-left-three-months)
2199 (define-key map "\C-b" 'calendar-backward-day)
2200 (define-key map "\C-p" 'calendar-backward-week)
2201 (define-key map "\e{" 'calendar-backward-month)
2202 (define-key map "\C-x[" 'calendar-backward-year)
2203 (define-key map "\C-f" 'calendar-forward-day)
2204 (define-key map "\C-n" 'calendar-forward-week)
2205 (define-key map [left] 'calendar-backward-day)
2206 (define-key map [up] 'calendar-backward-week)
2207 (define-key map [right] 'calendar-forward-day)
2208 (define-key map [down] 'calendar-forward-week)
2209 (define-key map "\e}" 'calendar-forward-month)
2210 (define-key map "\C-x]" 'calendar-forward-year)
2211 (define-key map "\C-a" 'calendar-beginning-of-week)
2212 (define-key map "\C-e" 'calendar-end-of-week)
2213 (define-key map "\ea" 'calendar-beginning-of-month)
2214 (define-key map "\ee" 'calendar-end-of-month)
2215 (define-key map "\e<" 'calendar-beginning-of-year)
2216 (define-key map "\e>" 'calendar-end-of-year)
2217 (define-key map "\C-@" 'calendar-set-mark)
2218 ;; Many people are used to typing C-SPC and getting C-@.
2219 (define-key map [?\C- ] 'calendar-set-mark)
2220 (define-key map "\C-x\C-x" 'calendar-exchange-point-and-mark)
2221 (define-key map "\e=" 'calendar-count-days-region)
2222 (define-key map "gd" 'calendar-goto-date)
2223 (define-key map "gD" 'calendar-goto-day-of-year)
2224 (define-key map "gj" 'calendar-goto-julian-date)
2225 (define-key map "ga" 'calendar-goto-astro-day-number)
2226 (define-key map "gh" 'calendar-goto-hebrew-date)
2227 (define-key map "gi" 'calendar-goto-islamic-date)
2228 (define-key map "gb" 'calendar-goto-bahai-date)
2229 (define-key map "gC" 'calendar-goto-chinese-date)
2230 (define-key map "gk" 'calendar-goto-coptic-date)
2231 (define-key map "ge" 'calendar-goto-ethiopic-date)
2232 (define-key map "gp" 'calendar-goto-persian-date)
2233 (define-key map "gc" 'calendar-goto-iso-date)
2234 (define-key map "gw" 'calendar-goto-iso-week)
2235 (define-key map "gf" 'calendar-goto-french-date)
2236 (define-key map "gml" 'calendar-goto-mayan-long-count-date)
2237 (define-key map "gmpc" 'calendar-previous-calendar-round-date)
2238 (define-key map "gmnc" 'calendar-next-calendar-round-date)
2239 (define-key map "gmph" 'calendar-previous-haab-date)
2240 (define-key map "gmnh" 'calendar-next-haab-date)
2241 (define-key map "gmpt" 'calendar-previous-tzolkin-date)
2242 (define-key map "gmnt" 'calendar-next-tzolkin-date)
2243 (define-key map "Aa" 'appt-add)
2244 (define-key map "Ad" 'appt-delete)
2245 (define-key map "S" 'calendar-sunrise-sunset)
2246 (define-key map "M" 'calendar-phases-of-moon)
2247 (define-key map " " 'scroll-other-window)
2248 (define-key map (kbd "DEL") 'scroll-other-window-down)
2249 (define-key map "\C-c\C-l" 'redraw-calendar)
2250 (define-key map "." 'calendar-goto-today)
2251 (define-key map "o" 'calendar-other-month)
2252 (define-key map "q" 'exit-calendar)
2253 (define-key map "a" 'list-calendar-holidays)
2254 (define-key map "h" 'calendar-cursor-holidays)
2255 (define-key map "x" 'mark-calendar-holidays)
2256 (define-key map "u" 'calendar-unmark)
2257 (define-key map "m" 'mark-diary-entries)
2258 (define-key map "d" 'diary-view-entries)
2259 (define-key map "D" 'view-other-diary-entries)
2260 (define-key map "s" 'diary-show-all-entries)
2261 (define-key map "pd" 'calendar-print-day-of-year)
2262 (define-key map "pC" 'calendar-print-chinese-date)
2263 (define-key map "pk" 'calendar-print-coptic-date)
2264 (define-key map "pe" 'calendar-print-ethiopic-date)
2265 (define-key map "pp" 'calendar-print-persian-date)
2266 (define-key map "pc" 'calendar-print-iso-date)
2267 (define-key map "pj" 'calendar-print-julian-date)
2268 (define-key map "pa" 'calendar-print-astro-day-number)
2269 (define-key map "ph" 'calendar-print-hebrew-date)
2270 (define-key map "pi" 'calendar-print-islamic-date)
2271 (define-key map "pb" 'calendar-print-bahai-date)
2272 (define-key map "pf" 'calendar-print-french-date)
2273 (define-key map "pm" 'calendar-print-mayan-date)
2274 (define-key map "po" 'calendar-print-other-dates)
2275 (define-key map "id" 'insert-diary-entry)
2276 (define-key map "iw" 'insert-weekly-diary-entry)
2277 (define-key map "im" 'insert-monthly-diary-entry)
2278 (define-key map "iy" 'insert-yearly-diary-entry)
2279 (define-key map "ia" 'insert-anniversary-diary-entry)
2280 (define-key map "ib" 'insert-block-diary-entry)
2281 (define-key map "ic" 'insert-cyclic-diary-entry)
2282 (define-key map "ihd" 'insert-hebrew-diary-entry)
2283 (define-key map "ihm" 'insert-monthly-hebrew-diary-entry)
2284 (define-key map "ihy" 'insert-yearly-hebrew-diary-entry)
2285 (define-key map "iid" 'insert-islamic-diary-entry)
2286 (define-key map "iim" 'insert-monthly-islamic-diary-entry)
2287 (define-key map "iiy" 'insert-yearly-islamic-diary-entry)
2288 (define-key map "iBd" 'insert-bahai-diary-entry)
2289 (define-key map "iBm" 'insert-monthly-bahai-diary-entry)
2290 (define-key map "iBy" 'insert-yearly-bahai-diary-entry)
2291 (define-key map "?" 'calendar-goto-info-node)
2292 (define-key map "tm" 'cal-tex-cursor-month)
2293 (define-key map "tM" 'cal-tex-cursor-month-landscape)
2294 (define-key map "td" 'cal-tex-cursor-day)
2295 (define-key map "tw1" 'cal-tex-cursor-week)
2296 (define-key map "tw2" 'cal-tex-cursor-week2)
2297 (define-key map "tw3" 'cal-tex-cursor-week-iso)
2298 (define-key map "tw4" 'cal-tex-cursor-week-monday)
2299 (define-key map "tfd" 'cal-tex-cursor-filofax-daily)
2300 (define-key map "tfw" 'cal-tex-cursor-filofax-2week)
2301 (define-key map "tfW" 'cal-tex-cursor-filofax-week)
2302 (define-key map "tfy" 'cal-tex-cursor-filofax-year)
2303 (define-key map "ty" 'cal-tex-cursor-year)
2304 (define-key map "tY" 'cal-tex-cursor-year-landscape)
2305 (setq calendar-mode-map map)
2306 ;; Require cal-menu after initializing calendar-mode-map because it uses it.
2307 (require 'cal-menu)))
2309 (defun describe-calendar-mode ()
2310 "Create a help buffer with a brief description of the `calendar-mode'."
2312 (help-setup-xref (list #'describe-calendar-mode) (interactive-p))
2313 (with-output-to-temp-buffer (help-buffer)
2316 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
2317 (substitute-command-keys
2318 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
2319 (substitute-command-keys "\\{calendar-mode-map}")))
2320 (print-help-return-message)))
2322 ;; Calendar mode is suitable only for specially formatted data.
2323 (put 'calendar-mode 'mode-class 'special)
2325 (defvar calendar-mode-line-format
2327 (propertize (substitute-command-keys
2328 "\\<calendar-mode-map>\\[scroll-calendar-left]")
2329 'help-echo "mouse-2: scroll left"
2330 'mouse-face 'mode-line-highlight
2331 'keymap (make-mode-line-mouse-map 'mouse-2
2332 'mouse-scroll-calendar-left))
2336 (substitute-command-keys
2337 "\\<calendar-mode-map>\\[calendar-goto-info-node] info")
2338 'help-echo "mouse-2: read Info on Calendar"
2339 'mouse-face 'mode-line-highlight
2340 'keymap (make-mode-line-mouse-map 'mouse-2 'calendar-goto-info-node))
2343 (substitute-command-keys
2344 "\\<calendar-mode-map>\\[calendar-other-month] other")
2345 'help-echo "mouse-2: choose another month"
2346 'mouse-face 'mode-line-highlight
2347 'keymap (make-mode-line-mouse-map
2348 'mouse-2 'mouse-calendar-other-month))
2351 (substitute-command-keys
2352 "\\<calendar-mode-map>\\[calendar-goto-today] today")
2353 'help-echo "mouse-2: go to today's date"
2354 'mouse-face 'mode-line-highlight
2355 'keymap (make-mode-line-mouse-map 'mouse-2 #'calendar-goto-today)))
2356 '(calendar-date-string (calendar-current-date) t)
2357 (propertize (substitute-command-keys
2358 "\\<calendar-mode-map>\\[scroll-calendar-right]")
2359 'help-echo "mouse-2: scroll right"
2360 'mouse-face 'mode-line-highlight
2361 'keymap (make-mode-line-mouse-map
2362 'mouse-2 'mouse-scroll-calendar-right)))
2363 "The mode line of the calendar buffer.
2365 This must be a list of items that evaluate to strings--those strings are
2366 evaluated and concatenated together, evenly separated by blanks. The variable
2367 `date' is available for use as the date under (or near) the cursor; `date'
2368 defaults to the current date if it is otherwise undefined. Here is an example
2369 value that has the Hebrew date, the day number/days remaining in the year,
2370 and the ISO week/year numbers in the mode. When calendar-move-hook is set to
2371 'update-calendar-mode-line, these mode line shows these values for the date
2376 '(calendar-hebrew-date-string date)
2377 '(let* ((year (extract-calendar-year date))
2378 (d (calendar-day-number date))
2380 (- (calendar-day-number (list 12 31 year)) d)))
2381 (format \"%d/%d\" d days-remaining))
2382 '(let* ((d (calendar-absolute-from-gregorian date))
2383 (iso-date (calendar-iso-from-absolute d)))
2384 (format \"ISO week %d of %d\"
2385 (extract-calendar-month iso-date)
2386 (extract-calendar-year iso-date)))
2390 (defun mouse-scroll-calendar-left (event)
2391 "Scroll the displayed calendar left by one month.
2392 Maintains the relative position of the cursor
2393 with respect to the calendar as well as possible."
2395 (save-selected-window
2396 (select-window (posn-window (event-start event)))
2397 (scroll-calendar-left 1)))
2399 (defun mouse-scroll-calendar-right (event)
2400 "Scroll the displayed calendar right by one month.
2401 Maintains the relative position of the cursor
2402 with respect to the calendar as well as possible."
2404 (save-selected-window
2405 (select-window (posn-window (event-start event)))
2406 (scroll-calendar-right 1)))
2408 (defun mouse-calendar-other-month (event)
2409 "Display a three-month calendar centered around a specified month and year."
2411 (save-selected-window
2412 (select-window (posn-window (event-start event)))
2413 (call-interactively 'calendar-other-month)))
2415 (defun calendar-goto-info-node ()
2416 "Go to the info node for the calendar."
2419 (let ((where (save-window-excursion
2420 (Info-find-emacs-command-nodes 'calendar))))
2422 (error "Couldn't find documentation for the calendar")
2423 (let (same-window-buffer-names)
2425 (Info-find-node (car (car where)) (car (cdr (car where)))))))
2429 (defun calendar-mode ()
2430 "A major mode for the calendar window.
2432 For a complete description, type \
2433 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
2435 \\<calendar-mode-map>\\{calendar-mode-map}"
2436 (kill-all-local-variables)
2437 (setq major-mode 'calendar-mode)
2438 (setq mode-name "Calendar")
2439 (use-local-map calendar-mode-map)
2440 (setq buffer-read-only t)
2441 (setq indent-tabs-mode nil)
2442 (update-calendar-mode-line)
2443 (add-hook 'activate-menubar-hook 'cal-menu-update nil t)
2444 (make-local-variable 'calendar-mark-ring)
2445 (make-local-variable 'displayed-month);; Month in middle of window.
2446 (make-local-variable 'displayed-year) ;; Year in middle of window.
2447 (set (make-local-variable 'font-lock-defaults)
2448 '(calendar-font-lock-keywords t))
2449 (run-mode-hooks 'calendar-mode-hook))
2451 (defun calendar-string-spread (strings char length)
2452 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
2453 The effect is like mapconcat but the separating pieces are as balanced as
2454 possible. Each item of STRINGS is evaluated before concatenation so it can
2455 actually be an expression that evaluates to a string. If LENGTH is too short,
2456 the STRINGS are just concatenated and the result truncated."
2457 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
2458 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
2459 ;; Addison-Wesley, Reading, MA, 1989
2460 (let* ((strings (mapcar 'eval
2461 (if (< (length strings) 2)
2462 (append (list "") strings (list ""))
2464 (n (- length (length (apply 'concat strings))))
2465 (m (1- (length strings)))
2467 (strings (cdr strings))
2469 (dolist (string strings)
2471 (make-string (max 0 (/ (+ n i) m)) char)
2474 (substring s 0 length)))
2476 (defun update-calendar-mode-line ()
2477 "Update the calendar mode line with the current date and date style."
2478 (if (bufferp (get-buffer calendar-buffer))
2479 (with-current-buffer calendar-buffer
2480 (setq mode-line-format
2481 (calendar-string-spread
2482 (let ((date (condition-case nil
2483 (calendar-cursor-to-nearest-date)
2484 (error (calendar-current-date)))))
2485 (mapcar 'eval calendar-mode-line-format))
2487 (force-mode-line-update))))
2489 (defun calendar-window-list ()
2490 "List of all calendar-related windows."
2491 (let ((calendar-buffers (calendar-buffer-list))
2493 (walk-windows (lambda (w)
2494 (if (memq (window-buffer w) calendar-buffers)
2499 (defun calendar-buffer-list ()
2500 "List of all calendar-related buffers."
2501 (let* ((diary-buffer (get-file-buffer diary-file))
2502 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
2503 fancy-diary-buffer diary-buffer calendar-buffer
2504 other-calendars-buffer))
2507 (setq b (cond ((stringp b) (get-buffer b))
2510 (if b (push b buffer-list)))
2513 (defun exit-calendar ()
2514 "Get out of the calendar window and hide it and related buffers."
2516 (let* ((diary-buffer (get-file-buffer diary-file)))
2517 (if (or (not diary-buffer)
2518 (not (buffer-modified-p diary-buffer))
2520 "Diary modified; do you really want to exit the calendar? "))
2521 ;; Need to do this multiple times because one time can replace some
2522 ;; calendar-related buffers with other calendar-related buffers
2524 (mapcar 'calendar-hide-window (calendar-window-list)))
2525 (calendar-window-list)))))
2527 (defun calendar-hide-window (window)
2528 "Hide WINDOW if it is calendar-related."
2529 (let ((buffer (if (window-live-p window) (window-buffer window))))
2530 (if (memq buffer (calendar-buffer-list))
2532 ((and (display-multi-frame-p)
2533 (eq 'icon (cdr (assoc 'visibility
2535 (window-frame window))))))
2537 ((and (display-multi-frame-p) (window-dedicated-p window))
2538 (if calendar-remove-frame-by-deleting
2539 (delete-frame (window-frame window))
2540 (iconify-frame (window-frame window))))
2541 ((not (and (select-window window) (one-window-p window)))
2542 (delete-window window))
2543 (t (set-buffer buffer)
2546 (defun calendar-current-date ()
2547 "Return the current date in a list (month day year)."
2548 (let ((now (decode-time)))
2549 (list (nth 4 now) (nth 3 now) (nth 5 now))))
2551 (defun calendar-cursor-to-date (&optional error)
2552 "Return a list (month day year) of current cursor position.
2553 If cursor is not on a specific date, signals an error if optional parameter
2554 ERROR is t, otherwise just returns nil."
2555 (let* ((segment (/ (current-column) 25))
2556 (month (% (+ displayed-month segment -1) 12))
2557 (month (if (= 0 month) 12 month))
2560 ((and (= 12 month) (= segment 0)) (1- displayed-year))
2561 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
2562 (t displayed-year))))
2563 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
2564 (< 2 (count-lines (point-min) (point))))
2566 (if (not (looking-at " "))
2567 (re-search-backward "[^0-9]"))
2569 (string-to-number (buffer-substring (1+ (point)) (+ 4 (point))))
2571 (if (and (looking-at "\\*")
2573 (re-search-backward "[^*]")
2574 (looking-at ".\\*\\*")))
2575 (list month calendar-starred-day year)
2576 (if error (error "Not on a date!"))))))
2578 (add-to-list 'debug-ignored-errors "Not on a date!")
2580 ;; The following version of calendar-gregorian-from-absolute is preferred for
2581 ;; reasons of clarity, BUT it's much slower than the version that follows it.
2583 ;;(defun calendar-gregorian-from-absolute (date)
2584 ;; "Compute the list (month day year) corresponding to the absolute DATE.
2585 ;;The absolute date is the number of days elapsed since the (imaginary)
2586 ;;Gregorian date Sunday, December 31, 1 BC."
2587 ;; (let* ((approx (/ date 366));; Approximation from below.
2588 ;; (year ;; Search forward from the approximation.
2590 ;; (calendar-sum y approx
2591 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2593 ;; (month ;; Search forward from January.
2594 ;; (1+ (calendar-sum m 1
2596 ;; (calendar-absolute-from-gregorian
2597 ;; (list m (calendar-last-day-of-month m year) year)))
2599 ;; (day ;; Calculate the day by subtraction.
2601 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2602 ;; (list month day year)))
2604 (defun calendar-gregorian-from-absolute (date)
2605 "Compute the list (month day year) corresponding to the absolute DATE.
2606 The absolute date is the number of days elapsed since the (imaginary)
2607 Gregorian date Sunday, December 31, 1 BC. This function does not
2608 handle dates in years BC."
2609 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2610 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2611 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2612 ;; (April, 1993), pages 383-404 for an explanation.
2613 (let* ((d0 (1- date))
2614 (n400 (/ d0 146097))
2621 (day (1+ (% d3 365)))
2622 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2623 (if (or (= n100 4) (= n1 4))
2625 (let ((year (1+ year))
2627 (while (let ((mdays (calendar-last-day-of-month month year)))
2629 (setq day (- day mdays))))
2630 (setq month (1+ month)))
2631 (list month day year)))))
2633 (defun calendar-other-month (month year)
2634 "Display a three-month calendar centered around MONTH and YEAR."
2635 (interactive (calendar-read-date 'noday))
2636 (if (and (= month displayed-month)
2637 (= year displayed-year))
2639 (let ((old-date (calendar-cursor-to-date))
2640 (today (calendar-current-date)))
2641 (generate-calendar-window month year)
2642 (calendar-cursor-to-visible-date
2644 ((calendar-date-is-visible-p old-date) old-date)
2645 ((calendar-date-is-visible-p today) today)
2646 (t (list month 1 year)))))))
2648 (defun calendar-set-mark (arg)
2649 "Mark the date under the cursor, or jump to marked date.
2650 With no prefix argument, push current date onto marked date ring.
2651 With argument, jump to mark, pop it, and put point at end of ring."
2653 (let ((date (calendar-cursor-to-date t)))
2656 (push date calendar-mark-ring)
2657 ;; Since the top of the mark ring is the marked date in the
2658 ;; calendar, the mark ring in the calendar is one longer than
2659 ;; in other buffers to get the same effect.
2660 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2661 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2662 (message "Mark set"))
2663 (if (null calendar-mark-ring)
2664 (error "No mark set in this buffer")
2665 (calendar-goto-date (car calendar-mark-ring))
2666 (setq calendar-mark-ring
2667 (cdr (nconc calendar-mark-ring (list date))))))))
2669 (defun calendar-exchange-point-and-mark ()
2670 "Exchange the current cursor position with the marked date."
2672 (let ((mark (car calendar-mark-ring))
2673 (date (calendar-cursor-to-date t)))
2675 (error "No mark set in this buffer")
2676 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2677 (calendar-goto-date mark))))
2679 (defun calendar-count-days-region ()
2680 "Count the number of days (inclusive) between point and the mark."
2682 (let* ((days (- (calendar-absolute-from-gregorian
2683 (calendar-cursor-to-date t))
2684 (calendar-absolute-from-gregorian
2685 (or (car calendar-mark-ring)
2686 (error "No mark set in this buffer")))))
2687 (days (1+ (if (> days 0) days (- days)))))
2688 (message "Region has %d day%s (inclusive)"
2689 days (if (> days 1) "s" ""))))
2691 (defun calendar-not-implemented ()
2694 (error "%s not available in the calendar"
2695 (global-key-binding (this-command-keys))))
2697 (defun calendar-read (prompt acceptable &optional initial-contents)
2698 "Return an object read from the minibuffer.
2699 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2700 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2701 is a string to insert in the minibuffer before reading."
2702 (let ((value (read-minibuffer prompt initial-contents)))
2703 (while (not (funcall acceptable value))
2704 (setq value (read-minibuffer prompt initial-contents)))
2707 (defun calendar-read-date (&optional noday)
2708 "Prompt for Gregorian date. Return a list (month day year).
2709 If optional NODAY is t, does not ask for day, but just returns
2710 \(month nil year); if NODAY is any other non-nil value the value returned is
2712 (let* ((year (calendar-read
2714 (lambda (x) (> x 0))
2715 (int-to-string (extract-calendar-year
2716 (calendar-current-date)))))
2717 (month-array calendar-month-name-array)
2718 (completion-ignore-case t)
2719 (month (cdr (assoc-string
2722 (mapcar 'list (append month-array nil))
2724 (calendar-make-alist month-array 1) t)))
2725 (last (calendar-last-day-of-month month year)))
2728 (list month nil year)
2731 (calendar-read (format "Day (1-%d): " last)
2732 (lambda (x) (and (< 0 x) (<= x last))))
2735 (defun calendar-interval (mon1 yr1 mon2 yr2)
2736 "The number of months difference between MON1, YR1 and MON2, YR2.
2737 The result is positive if the second date is later than the first.
2738 Negative years are interpreted as years BC; -1 being 1 BC, and so on."
2739 (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc
2740 (if (< yr2 0) (setq yr2 (1+ yr2)))
2741 (+ (* 12 (- yr2 yr1))
2744 (defvar calendar-abbrev-length 3
2745 "*Length of abbreviations to be used for day and month names.
2746 See also `calendar-day-abbrev-array' and `calendar-month-abbrev-array'.")
2748 (defvar calendar-day-name-array
2749 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2750 "*Array of capitalized strings giving, in order, the day names.
2751 The first two characters of each string will be used to head the
2752 day columns in the calendar. See also the variable
2753 `calendar-day-abbrev-array'.")
2755 (defvar calendar-day-abbrev-array
2756 [nil nil nil nil nil nil nil]
2757 "*Array of capitalized strings giving the abbreviated day names.
2758 The order should be the same as that of the full names specified
2759 in `calendar-day-name-array'. These abbreviations may be used
2760 instead of the full names in the diary file. Do not include a
2761 trailing `.' in the strings specified in this variable, though
2762 you may use such in the diary file. If any element of this array
2763 is nil, then the abbreviation will be constructed as the first
2764 `calendar-abbrev-length' characters of the corresponding full name.")
2766 (defvar calendar-month-name-array
2767 ["January" "February" "March" "April" "May" "June"
2768 "July" "August" "September" "October" "November" "December"]
2769 "*Array of capitalized strings giving, in order, the month names.
2770 See also the variable `calendar-month-abbrev-array'.")
2772 (defvar calendar-month-abbrev-array
2773 [nil nil nil nil nil nil nil nil nil nil nil nil]
2774 "*Array of capitalized strings giving the abbreviated month names.
2775 The order should be the same as that of the full names specified
2776 in `calendar-month-name-array'. These abbreviations are used in
2777 the calendar menu entries, and can also be used in the diary
2778 file. Do not include a trailing `.' in the strings specified in
2779 this variable, though you may use such in the diary file. If any
2780 element of this array is nil, then the abbreviation will be
2781 constructed as the first `calendar-abbrev-length' characters of the
2782 corresponding full name.")
2784 (defun calendar-abbrev-construct (abbrev full &optional period)
2785 "Internal calendar function to return a complete abbreviation array.
2786 ABBREV is an array of abbreviations, FULL the corresponding array
2787 of full names. The return value is the ABBREV array, with any nil
2788 elements replaced by the first three characters taken from the
2789 corresponding element of FULL. If optional argument PERIOD is non-nil,
2790 each element returned has a final `.' character."
2791 (let (elem array name)
2792 (dotimes (i (length full))
2793 (setq name (aref full i)
2794 elem (or (aref abbrev i)
2796 (min calendar-abbrev-length (length name))))
2797 elem (format "%s%s" elem (if period "." ""))
2798 array (append array (list elem))))
2801 (defvar calendar-font-lock-keywords
2802 `((,(concat (regexp-opt (mapcar 'identity calendar-month-name-array) t)
2804 . font-lock-function-name-face) ; month and year
2806 (list (substring (aref calendar-day-name-array 6) 0 2)
2807 (substring (aref calendar-day-name-array 0) 0 2)))
2808 ;; Saturdays and Sundays are hilited differently.
2809 . font-lock-comment-face)
2810 ;; First two chars of each day are used in the calendar.
2811 (,(regexp-opt (mapcar (lambda (x) (substring x 0 2)) calendar-day-name-array))
2812 . font-lock-reference-face))
2813 "Default keywords to highlight in Calendar mode.")
2815 (defun calendar-day-name (date &optional abbrev absolute)
2816 "Return a string with the name of the day of the week of DATE.
2817 DATE should be a list in the format (MONTH DAY YEAR), unless the
2818 optional argument ABSOLUTE is non-nil, in which case DATE should
2819 be an integer in the range 0 to 6 corresponding to the day of the
2820 week. Day names are taken from the variable `calendar-day-name-array',
2821 unless the optional argument ABBREV is non-nil, in which case
2822 the variable `calendar-day-abbrev-array' is used."
2824 (calendar-abbrev-construct calendar-day-abbrev-array
2825 calendar-day-name-array)
2826 calendar-day-name-array)
2827 (if absolute date (calendar-day-of-week date))))
2829 (defun calendar-make-alist (sequence &optional start-index filter abbrevs)
2830 "Make an assoc list corresponding to SEQUENCE.
2831 Each element of sequence will be associated with an integer, starting
2832 from 1, or from START-INDEX if that is non-nil. If a sequence ABBREVS
2833 is supplied, the function `calendar-abbrev-construct' is used to
2834 construct abbreviations corresponding to the elements in SEQUENCE.
2835 Each abbreviation is entered into the alist with the same
2836 association index as the full name it represents.
2837 If FILTER is provided, apply it to each key in the alist."
2839 (offset (or start-index 1))
2840 (aseq (if abbrevs (calendar-abbrev-construct abbrevs sequence)))
2841 (aseqp (if abbrevs (calendar-abbrev-construct abbrevs sequence
2844 (dotimes (i (length sequence) (reverse alist))
2845 (setq index (+ i offset)
2846 elem (elt sequence i)
2848 (cons (cons (if filter (funcall filter elem) elem) index) alist))
2850 (setq elem (elt aseq i)
2851 alist (cons (cons (if filter (funcall filter elem) elem)
2854 (setq elem (elt aseqp i)
2855 alist (cons (cons (if filter (funcall filter elem) elem)
2858 (defun calendar-month-name (month &optional abbrev)
2859 "Return a string with the name of month number MONTH.
2860 Months are numbered from one. Month names are taken from the
2861 variable `calendar-month-name-array', unless the optional
2862 argument ABBREV is non-nil, in which case
2863 `calendar-month-abbrev-array' is used."
2865 (calendar-abbrev-construct calendar-month-abbrev-array
2866 calendar-month-name-array)
2867 calendar-month-name-array)
2870 (defun calendar-day-of-week (date)
2871 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc.
2872 DATE is a list of the form (month day year). A negative year is
2873 interpreted as BC; -1 being 1 BC, and so on."
2874 (mod (calendar-absolute-from-gregorian date) 7))
2876 (defun calendar-unmark ()
2877 "Delete all diary/holiday marks/highlighting from the calendar."
2879 (setq mark-holidays-in-calendar nil)
2880 (setq mark-diary-entries-in-calendar nil)
2883 (defun calendar-date-is-visible-p (date)
2884 "Return t if DATE is valid and is visible in the calendar window."
2885 (let ((gap (calendar-interval
2886 displayed-month displayed-year
2887 (extract-calendar-month date) (extract-calendar-year date))))
2888 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2890 (defun calendar-date-is-legal-p (date)
2891 "Return t if DATE is a valid date."
2892 (let ((month (extract-calendar-month date))
2893 (day (extract-calendar-day date))
2894 (year (extract-calendar-year date)))
2895 (and (<= 1 month) (<= month 12)
2896 ;; (calendar-read-date t) returns a date with day = nil.
2897 ;; Should not be valid (?), since many funcs prob assume integer.
2898 ;; (calendar-read-date 'noday) returns (month year), which
2899 ;; currently results in extract-calendar-year returning nil.
2900 day year (<= 1 day) (<= day (calendar-last-day-of-month month year))
2901 ;; BC dates left as non-valid, to suppress errors from
2902 ;; complex holiday algorithms not suitable for years BC.
2903 ;; Note there are side effects on calendar navigation.
2906 (defun calendar-date-equal (date1 date2)
2907 "Return t if the DATE1 and DATE2 are the same."
2909 (= (extract-calendar-month date1) (extract-calendar-month date2))
2910 (= (extract-calendar-day date1) (extract-calendar-day date2))
2911 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2913 (defun mark-visible-calendar-date (date &optional mark)
2914 "Mark DATE in the calendar window with MARK.
2915 MARK is a single-character string, a list of face attributes/values, or a face.
2916 MARK defaults to `diary-entry-marker'."
2917 (if (calendar-date-is-legal-p date)
2918 (with-current-buffer calendar-buffer
2920 (calendar-cursor-to-visible-date date)
2922 (or (and (stringp mark) (= (length mark) 1) mark) ; single-char
2923 (and (listp mark) (> (length mark) 0) mark) ; attr list
2924 (and (facep mark) mark) ; face-name
2925 diary-entry-marker))
2927 ;; face or an attr-list that contained a face
2930 (make-overlay (1- (point)) (1+ (point))) 'face mark))
2932 ((and (stringp mark) (= (length mark) 1))
2933 (let ((inhibit-read-only t))
2935 ;; Insert before delete so as to better preserve markers.
2942 (apply 'concat "temp-"
2943 (mapcar (lambda (sym)
2945 ((symbolp sym) (symbol-name sym))
2946 ((numberp sym) (number-to-string sym))
2950 (make-face temp-face)
2951 ;; Remove :face info from the mark, copy the face info into
2953 (while (setq faceinfo (memq :face faceinfo))
2954 (copy-face (read (nth 1 faceinfo)) temp-face)
2955 (setcar faceinfo nil)
2956 (setcar (cdr faceinfo) nil))
2957 (setq mark (delq nil mark))
2958 ;; Apply the font aspects
2959 (apply 'set-face-attribute temp-face nil mark)
2961 (make-overlay (1- (point)) (1+ (point))) 'face temp-face))))))))
2963 (defun calendar-star-date ()
2964 "Replace the date under the cursor in the calendar window with asterisks.
2965 This function can be used with the `today-visible-calendar-hook' run after the
2966 calendar window has been prepared."
2967 (let ((inhibit-read-only t)
2968 (modified (buffer-modified-p)))
2970 (set (make-local-variable 'calendar-starred-day)
2972 (buffer-substring (point) (- (point) 2))))
2973 ;; Insert before deleting, to better preserve markers.
2978 (restore-buffer-modified-p modified)))
2980 (defun calendar-mark-today ()
2981 "Mark the date under the cursor in the calendar window.
2982 The date is marked with `calendar-today-marker'. This function can be used with
2983 the `today-visible-calendar-hook' run after the calendar window has been
2985 (mark-visible-calendar-date
2986 (calendar-cursor-to-date)
2987 calendar-today-marker))
2989 (defun calendar-date-compare (date1 date2)
2990 "Return t if DATE1 is before DATE2, nil otherwise.
2991 The actual dates are in the car of DATE1 and DATE2."
2992 (< (calendar-absolute-from-gregorian (car date1))
2993 (calendar-absolute-from-gregorian (car date2))))
2995 (defun calendar-date-string (date &optional abbreviate nodayname)
2996 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2997 An optional parameter ABBREVIATE, when non-nil, causes the month
2998 and day names to be abbreviated as specified by
2999 `calendar-month-abbrev-array' and `calendar-day-abbrev-array',
3000 respectively. An optional parameter NODAYNAME, when t, omits the
3001 name of the day of the week."
3004 (calendar-day-name date abbreviate)))
3005 (month (extract-calendar-month date))
3006 (monthname (calendar-month-name month abbreviate))
3007 (day (int-to-string (extract-calendar-day date)))
3008 (month (int-to-string month))
3009 (year (int-to-string (extract-calendar-year date))))
3010 (mapconcat 'eval calendar-date-display-form "")))
3012 (defun calendar-dayname-on-or-before (dayname date)
3013 "Return the absolute date of the DAYNAME on or before absolute DATE.
3014 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
3016 Note: Applying this function to d+6 gives us the DAYNAME on or after an
3017 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
3018 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
3019 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
3020 (- date (% (- date dayname) 7)))
3022 (defun calendar-nth-named-absday (n dayname month year &optional day)
3023 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3024 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3025 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3026 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3028 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3031 (calendar-dayname-on-or-before
3033 (+ 6 (calendar-absolute-from-gregorian
3034 (list month (or day 1) year)))))
3036 (calendar-dayname-on-or-before
3038 (calendar-absolute-from-gregorian
3040 (or day (calendar-last-day-of-month month year))
3043 (defun calendar-nth-named-day (n dayname month year &optional day)
3044 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3045 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3046 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3047 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3049 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3050 (calendar-gregorian-from-absolute
3051 (calendar-nth-named-absday n dayname month year day)))
3053 (defun calendar-day-of-year-string (&optional date)
3054 "String of day number of year of Gregorian DATE.
3055 Defaults to today's date if DATE is not given."
3056 (let* ((d (or date (calendar-current-date)))
3057 (year (extract-calendar-year d))
3058 (day (calendar-day-number d))
3059 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
3060 (format "Day %d of %d; %d day%s remaining in the year"
3061 day year days-remaining (if (= days-remaining 1) "" "s"))))
3063 (defun calendar-print-other-dates ()
3064 "Show dates on other calendars for date under the cursor."
3066 (let* ((date (calendar-cursor-to-date t)))
3067 (with-current-buffer (get-buffer-create other-calendars-buffer)
3068 (let ((inhibit-read-only t)
3069 (modified (buffer-modified-p)))
3070 (calendar-set-mode-line
3071 (concat (calendar-date-string date) " (Gregorian)"))
3077 (calendar-day-of-year-string date) "\n"
3078 (format "ISO date: %s\n" (calendar-iso-date-string date))
3079 (format "Julian date: %s\n"
3080 (calendar-julian-date-string date))
3081 (format "Astronomical (Julian) day number (at noon UTC): %s.0\n"
3082 (calendar-astro-date-string date))
3083 (format "Fixed (RD) date: %s\n"
3084 (calendar-absolute-from-gregorian date))
3085 (format "Hebrew date (before sunset): %s\n"
3086 (calendar-hebrew-date-string date))
3087 (format "Persian date: %s\n"
3088 (calendar-persian-date-string date))
3089 (let ((i (calendar-islamic-date-string date)))
3090 (if (not (string-equal i ""))
3091 (format "Islamic date (before sunset): %s\n" i)))
3092 (let ((b (calendar-bahai-date-string date)))
3093 (if (not (string-equal b ""))
3094 (format "Baha'i date (before sunset): %s\n" b)))
3095 (format "Chinese date: %s\n"
3096 (calendar-chinese-date-string date))
3097 (let ((c (calendar-coptic-date-string date)))
3098 (if (not (string-equal c ""))
3099 (format "Coptic date: %s\n" c)))
3100 (let ((e (calendar-ethiopic-date-string date)))
3101 (if (not (string-equal e ""))
3102 (format "Ethiopic date: %s\n" e)))
3103 (let ((f (calendar-french-date-string date)))
3104 (if (not (string-equal f ""))
3105 (format "French Revolutionary date: %s\n" f)))
3106 (format "Mayan date: %s\n"
3107 (calendar-mayan-date-string date)))))
3108 (goto-char (point-min))
3109 (restore-buffer-modified-p modified))
3110 (display-buffer other-calendars-buffer))))
3112 (defun calendar-print-day-of-year ()
3113 "Show day number in year/days remaining in year for date under the cursor."
3115 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
3117 (defun calendar-set-mode-line (str)
3118 "Set mode line to STR, centered, surrounded by dashes."
3119 (let* ((edges (window-edges))
3120 ;; As per doc of window-width, total visible mode-line length.
3121 (width (- (nth 2 edges) (nth 0 edges))))
3122 (setq mode-line-format
3123 (if buffer-file-name
3124 `("-" mode-line-modified
3125 ,(calendar-string-spread (list str) ?- (- width 6))
3127 (calendar-string-spread (list str) ?- width)))))
3129 (defun calendar-mod (m n)
3130 "Non-negative remainder of M/N with N instead of 0."
3131 (1+ (mod (1- m) n)))
3133 (run-hooks 'calendar-load-hook)
3138 ;; byte-compile-dynamic: t
3141 ;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8
3142 ;;; calendar.el ends here
HCoop / bpt / emacs.git / blob