1 ;;; calendar.el --- Calendar functions. -*-byte-compile-dynamic: t;-*-
3 ;;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994 Free Software
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
8 ;; Human-Keywords: calendar, Gregorian calendar, Julian calendar,
9 ;; Hebrew calendar, Islamic calendar, ISO calendar, Julian day number,
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to
26 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
30 ;; This collection of functions implements a calendar window. It
31 ;; generates a calendar for the current month, together with the previous
32 ;; and coming months, or for any other three-month period. The calendar
33 ;; can be scrolled forward and backward in the window to show months in
34 ;; the past or future; the cursor can move forward and backward by days,
35 ;; weeks, or months, making it possible, for instance, to jump to the
36 ;; date a specified number of days, weeks, or months from the date under
37 ;; the cursor. The user can display a list of holidays and other notable
38 ;; days for the period shown; the notable days can be marked on the
39 ;; calendar, if desired. The user can also specify that dates having
40 ;; corresponding diary entries (in a file that the user specifies) be
41 ;; marked; the diary entries for any date can be viewed in a separate
42 ;; window. The diary and the notable days can be viewed independently of
43 ;; the calendar. Dates can be translated from the (usual) Gregorian
44 ;; calendar to the day of the year/days remaining in year, to the ISO
45 ;; commercial calendar, to the Julian (old style) calendar, to the Hebrew
46 ;; calendar, to the Islamic calendar, to the French Revolutionary calendar,
47 ;; to the Mayan calendar, and to the astronomical (Julian) day number.
48 ;; When floating point is available, times of sunrise/sunset can be displayed,
49 ;; as can the phases of the moon. Appointment notification for diary entries
52 ;; The following files are part of the calendar/diary code:
54 ;; cal-menu.el Menu support
55 ;; cal-x.el X-windows dedicated frame functions
56 ;; diary-lib.el, diary-ins.el Diary functions
57 ;; holidays.el Holiday functions
58 ;; cal-french.el French Revolutionary calendar
59 ;; cal-mayan.el Mayan calendars
60 ;; cal-dst.el Daylight savings time rules
61 ;; solar.el Sunrise/sunset, equinoxes/solstices
62 ;; lunar.el Phases of the moon
63 ;; appt.el Appointment notification
65 ;; Comments, corrections, and improvements should be sent to
66 ;; Edward M. Reingold Department of Computer Science
67 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
68 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
69 ;; Urbana, Illinois 61801
71 ;; GNU Emacs users too numerous to list pointed out a variety of problems
72 ;; with earlier forms of the `infinite' sliding calendar and suggested some
73 ;; of the features included in this package. Especially significant in this
74 ;; regard was the suggestion of mark-diary-entries and view-diary-entries,
75 ;; together ideas for their implementation, by
76 ;; Michael S. Littman Cognitive Science Research Group
77 ;; (201) 829-5155 Bell Communications Research
78 ;; mlittman@wind.bellcore.com 445 South St. Box 1961 (2L-331)
79 ;; Morristown, NJ 07960
81 ;; The algorithms for the Hebrew calendar are those of the Rambam (Rabbi Moses
82 ;; Maimonides), from his Mishneh Torah, as implemented by
83 ;; Nachum Dershowitz Department of Computer Science
84 ;; (217) 333-4219 University of Illinois at Urbana-Champaign
85 ;; nachum@cs.uiuc.edu 1304 West Springfield Avenue
86 ;; Urbana, Illinois 61801
88 ;; Technical details of all the calendrical calculations can be found in
90 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
91 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
92 ;; pages 899-928. ``Calendrical Calculations, Part II: Three Historical
93 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
94 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
97 ;; Hard copies of these two papers can be obtained by sending email to
98 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
99 ;; the message BODY containing your mailing address (snail).
103 (defun calendar-version ()
105 (message "Version 5.3, January 25, 1994"))
108 (defvar calendar-week-start-day
0
109 "*The day of the week on which a week in the calendar begins.
110 0 means Sunday (default), 1 means Monday, and so on.")
113 (defvar calendar-offset
0
114 "*The offset of the principal month from the center of the calendar window.
115 0 means the principal month is in the center (default), -1 means on the left,
116 +1 means on the right. Larger (or smaller) values push the principal month off
120 (defvar view-diary-entries-initially nil
121 "*Non-nil means display current date's diary entries on entry.
122 The diary is displayed in another window when the calendar is first displayed,
123 if the current date is visible. The number of days of diary entries displayed
124 is governed by the variable `number-of-diary-entries'.")
127 (defvar number-of-diary-entries
1
128 "*Specifies how many days of diary entries are to be displayed initially.
129 This variable affects the diary display when the command M-x diary is used,
130 or if the value of the variable `view-diary-entries-initially' is t. For
131 example, if the default value 1 is used, then only the current day's diary
132 entries will be displayed. If the value 2 is used, then both the current
133 day's and the next day's entries will be displayed.
135 The value can also be a vector such as [0 2 2 2 2 4 1]; this value
136 says to display no diary entries on Sunday, the display the entries
137 for the current date and the day after on Monday through Thursday,
138 display Friday through Monday's entries on Friday, and display only
139 Saturday's entries on Saturday.
141 This variable does not affect the diary display with the `d' command
142 from the calendar; in that case, the prefix argument controls the
143 number of days of diary entries displayed.")
146 (defvar mark-diary-entries-in-calendar nil
147 "*Non-nil means mark dates with diary entries, in the calendar window.
148 The marking symbol is specified by the variable `diary-entry-marker'.")
150 (defvar diary-entry-marker
151 (if (not window-system
)
154 (make-face 'diary-face
)
155 (cond ((face-differs-from-default-p 'diary-face
))
156 ((x-display-color-p) (set-face-foreground 'diary-face
"red"))
157 (t (copy-face 'bold
'diary-face
)))
159 "*Used to mark dates that have diary entries.
160 Can be either a single-character string or a face.")
162 (defvar calendar-today-marker
163 (if (not window-system
)
166 (make-face 'calendar-today-face
)
167 (if (not (face-differs-from-default-p 'calendar-today-face
))
168 (set-face-underline-p 'calendar-today-face t
))
169 'calendar-today-face
)
170 "*Used to mark today's date.
171 Can be either a single-character string or a face.")
173 (defvar calendar-holiday-marker
174 (if (not window-system
)
177 (make-face 'holiday-face
)
178 (cond ((face-differs-from-default-p 'holiday-face
))
179 ((x-display-color-p) (set-face-background 'holiday-face
"pink"))
180 (t (set-face-background 'holiday-face
"black")
181 (set-face-foreground 'holiday-face
"white")))
183 "*Used to mark notable dates in the calendar.
184 Can be either a single-character string or a face.")
187 (defvar view-calendar-holidays-initially nil
188 "*Non-nil means display holidays for current three month period on entry.
189 The holidays are displayed in another window when the calendar is first
193 (defvar mark-holidays-in-calendar nil
194 "*Non-nil means mark dates of holidays in the calendar window.
195 The marking symbol is specified by the variable `calendar-holiday-marker'.")
198 (defvar all-hebrew-calendar-holidays nil
199 "*If nil, show only major holidays from the Hebrew calendar.
200 This means only those Jewish holidays that appear on secular calendars.
202 If t, show all the holidays that would appear in a complete Hebrew calendar.")
205 (defvar all-christian-calendar-holidays nil
206 "*If nil, show only major holidays from the Christian calendar.
207 This means only those Christian holidays that appear on secular calendars.
209 If t, show all the holidays that would appear in a complete Christian
213 (defvar all-islamic-calendar-holidays nil
214 "*If nil, show only major holidays from the Islamic calendar.
215 This means only those Islamic holidays that appear on secular calendars.
217 If t, show all the holidays that would appear in a complete Islamic
221 (defvar calendar-load-hook nil
222 "*List of functions to be called after the calendar is first loaded.
223 This is the place to add key bindings to `calendar-mode-map'.")
226 (defvar initial-calendar-window-hook nil
227 "*List of functions to be called when the calendar window is first opened.
228 The functions invoked are called after the calendar window is opened, but
229 once opened is never called again. Leaving the calendar with the `q' command
230 and reentering it will cause these functions to be called again.")
233 (defvar today-visible-calendar-hook nil
234 "*List of functions called whenever the current date is visible.
235 This can be used, for example, to replace today's date with asterisks; a
236 function `calendar-star-date' is included for this purpose:
237 (setq today-visible-calendar-hook 'calendar-star-date)
238 It can also be used to mark the current date with `calendar-today-marker';
239 a function is also provided for this:
240 (setq today-visible-calendar-hook 'calendar-mark-today)
242 The corresponding variable `today-invisible-calendar-hook' is the list of
243 functions called when the calendar function was called when the current
244 date is not visible in the window.
246 Other than the use of the provided functions, the changing of any
247 characters in the calendar buffer by the hooks may cause the failure of the
248 functions that move by days and weeks.")
251 (defvar today-invisible-calendar-hook nil
252 "*List of functions called whenever the current date is not visible.
254 The corresponding variable `today-visible-calendar-hook' is the list of
255 functions called when the calendar function was called when the current
256 date is visible in the window.
258 Other than the use of the provided functions, the changing of any
259 characters in the calendar buffer by the hooks may cause the failure of the
260 functions that move by days and weeks.")
263 (defvar diary-file
"~/diary"
264 "*Name of the file in which one's personal diary of dates is kept.
266 The file's entries are lines in any of the forms
274 at the beginning of the line; the remainder of the line is the diary entry
275 string for that date. MONTH and DAY are one or two digit numbers, YEAR is
276 a number and may be written in full or abbreviated to the final two digits.
277 If the date does not contain a year, it is generic and applies to any year.
278 DAYNAME entries apply to any date on which is on that day of the week.
279 MONTHNAME and DAYNAME can be spelled in full, abbreviated to three
280 characters (with or without a period), capitalized or not. Any of DAY,
281 MONTH, or MONTHNAME, YEAR can be `*' which matches any day, month, or year,
284 The European style (in which the day precedes the month) can be used
285 instead, if you execute `european-calendar' when in the calendar, or set
286 `european-calendar-style' to t in your .emacs file. The European forms are
294 To revert to the default American style from the European style, execute
295 `american-calendar' in the calendar.
297 A diary entry can be preceded by the character
298 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
299 nonmarking--that is, it will not be marked on dates in the calendar
300 window but will appear in a diary window.
302 Multiline diary entries are made by indenting lines after the first with
303 either a TAB or one or more spaces.
305 Lines not in one the above formats are ignored. Here are some sample diary
306 entries (in the default American style):
308 12/22/1988 Twentieth wedding anniversary!!
309 &1/1. Happy New Year!
310 10/22 Ruth's birthday.
312 Tuesday--weekly meeting with grad students at 10am
313 Supowit, Shen, Bitner, and Kapoor to attend.
314 1/13/89 Friday the thirteenth!!
315 &thu 4pm squash game with Lloyd.
316 mar 16 Dad's birthday
317 April 15, 1989 Income tax due.
318 &* 15 time cards due.
320 If the first line of a diary entry consists only of the date or day name with
321 no trailing blanks or punctuation, then that line is not displayed in the
322 diary window; only the continuation lines is shown. For example, the
326 Bill Blattner visits Princeton today
327 2pm Cognitive Studies Committee meeting
328 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
329 4:00pm Jamie Tappenden
330 7:30pm Dinner at George and Ed's for Alan Ryan
331 7:30-10:00pm dance at Stewart Country Day School
333 will appear in the diary window without the date line at the beginning. This
334 facility allows the diary window to look neater, but can cause confusion if
335 used with more than one day's entries displayed.
337 Diary entries can be based on Lisp sexps. For example, the diary entry
339 %%(diary-block 11 1 1990 11 10 1990) Vacation
341 causes the diary entry \"Vacation\" to appear from November 1 through November
342 10, 1990. Other functions available are `diary-float', `diary-anniversary',
343 `diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date',
344 `diary-hebrew-date', `diary-islamic-date', `diary-mayan-date',
345 `diary-yahrzeit', `diary-sunrise-sunset', `diary-phases-of-moon',
346 `diary-parasha', `diary-omer', `diary-rosh-hodesh', and
347 `diary-sabbath-candles'. See the documentation for the function
348 `list-sexp-diary-entries' for more details.
350 Diary entries based on the Hebrew and/or the Islamic calendar are also
351 possible, but because these are somewhat slow, they are ignored
352 unless you set the `nongregorian-diary-listing-hook' and the
353 `nongregorian-diary-marking-hook' appropriately. See the documentation
354 for these functions for details.
356 Diary files can contain directives to include the contents of other files; for
357 details, see the documentation for the variable `list-diary-entries-hook'.")
360 (defvar diary-nonmarking-symbol
"&"
361 "*Symbol indicating that a diary entry is not to be marked in the calendar.")
364 (defvar hebrew-diary-entry-symbol
"H"
365 "*Symbol indicating a diary entry according to the Hebrew calendar.")
368 (defvar islamic-diary-entry-symbol
"I"
369 "*Symbol indicating a diary entry according to the Islamic calendar.")
372 (defvar diary-include-string
"#include"
373 "*The string indicating inclusion of another file of diary entries.
374 See the documentation for the function `include-other-diary-files'.")
377 (defvar sexp-diary-entry-symbol
"%%"
378 "*The string used to indicate a sexp diary entry in diary-file.
379 See the documentation for the function `list-sexp-diary-entries'.")
382 (defvar abbreviated-calendar-year t
383 "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
384 For the Gregorian calendar; similarly for the Hebrew and Islamic calendars.
385 If this variable is nil, years must be written in full.")
388 (defvar european-calendar-style nil
389 "*Use the European style of dates in the diary and in any displays.
390 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
391 1990. The accepted European date styles are
399 Names can be capitalized or not, written in full, or abbreviated to three
400 characters with or without a period.")
403 (defvar american-date-diary-pattern
404 '((month "/" day
"[^/0-9]")
405 (month "/" day
"/" year
"[^0-9]")
406 (monthname " *" day
"[^,0-9]")
407 (monthname " *" day
", *" year
"[^0-9]")
409 "*List of pseudo-patterns describing the American patterns of date used.
410 See the documentation of `diary-date-forms' for an explanation.")
413 (defvar european-date-diary-pattern
414 '((day "/" month
"[^/0-9]")
415 (day "/" month
"/" year
"[^0-9]")
416 (backup day
" *" monthname
"\\W+\\<[^*0-9]")
417 (day " *" monthname
" *" year
"[^0-9]")
419 "*List of pseudo-patterns describing the European patterns of date used.
420 See the documentation of `diary-date-forms' for an explanation.")
422 (defvar diary-date-forms
423 (if european-calendar-style
424 european-date-diary-pattern
425 american-date-diary-pattern
)
426 "*List of pseudo-patterns describing the forms of date used in the diary.
427 The patterns on the list must be MUTUALLY EXCLUSIVE and must should not match
428 any portion of the diary entry itself, just the date component.
430 A pseudo-pattern is a list of regular expressions and the keywords `month',
431 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
432 match the name of the month, capitalized or not, or its three-letter
433 abbreviation, followed by a period or not; it will also match `*'.
434 Similarly, `dayname' will match the name of the day, capitalized or not, or
435 its three-letter abbreviation, followed by a period or not. The keywords
436 `month', `day', and `year' will match those numerical values, preceded by
437 arbitrarily many zeros; they will also match `*'.
439 The matching of the diary entries with the date forms is done with the
440 standard syntax table from Fundamental mode, but with the `*' changed so
441 that it is a word constituent.
443 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
444 diary entry itself, the first element of the pattern MUST be `backup'. This
445 directive causes the date recognizer to back up to the beginning of the
446 current word of the diary entry, so in no case can the pattern match more than
447 a portion of the first word of the diary entry.")
450 (defvar european-calendar-display-form
451 '((if dayname
(concat dayname
", ")) day
" " monthname
" " year
)
452 "*Pseudo-pattern governing the way a date appears in the European style.
453 See the documentation of calendar-date-display-form for an explanation.")
456 (defvar american-calendar-display-form
457 '((if dayname
(concat dayname
", ")) monthname
" " day
", " year
)
458 "*Pseudo-pattern governing the way a date appears in the American style.
459 See the documentation of `calendar-date-display-form' for an explanation.")
461 (defvar calendar-date-display-form
462 (if european-calendar-style
463 european-calendar-display-form
464 american-calendar-display-form
)
465 "*Pseudo-pattern governing the way a date appears.
467 Used by the function `calendar-date-string', a pseudo-pattern is a list of
468 expressions that can involve the keywords `month', `day', and `year', all
469 numbers in string form, and `monthname' and `dayname', both alphabetic
470 strings. For example, the ISO standard would use the pseudo- pattern
472 '(year \"-\" month \"-\" day)
474 while a typical American form would be
476 '(month \"/\" day \"/\" (substring year -2))
480 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
482 would give the usual American style in fixed-length fields.
484 See the documentation of the function `calendar-date-string'.")
486 (defun european-calendar ()
487 "Set the interpretation and display of dates to the European style."
489 (setq european-calendar-style t
)
490 (setq calendar-date-display-form european-calendar-display-form
)
491 (setq diary-date-forms european-date-diary-pattern
)
492 (update-calendar-mode-line))
494 (defun american-calendar ()
495 "Set the interpretation and display of dates to the American style."
497 (setq european-calendar-style nil
)
498 (setq calendar-date-display-form american-calendar-display-form
)
499 (setq diary-date-forms american-date-diary-pattern
)
500 (update-calendar-mode-line))
503 (defvar print-diary-entries-hook
'lpr-buffer
504 "*List of functions called after a temporary diary buffer is prepared.
505 The buffer shows only the diary entries currently visible in the diary
506 buffer. The default just does the printing. Other uses might include, for
507 example, rearranging the lines into order by day and time, saving the buffer
508 instead of deleting it, or changing the function used to do the printing.")
511 (defvar list-diary-entries-hook nil
512 "*List of functions called after diary file is culled for relevant entries.
513 It is to be used for diary entries that are not found in the diary file.
515 A function `include-other-diary-files' is provided for use as the value of
516 this hook. This function enables you to use shared diary files together
517 with your own. The files included are specified in the diary file by lines
520 #include \"filename\"
522 This is recursive; that is, #include directives in files thus included are
523 obeyed. You can change the \"#include\" to some other string by changing
524 the variable `diary-include-string'. When you use `include-other-diary-files'
525 as part of the list-diary-entries-hook, you will probably also want to use the
526 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
528 For example, you could use
530 (setq list-diary-entries-hook
531 '(include-other-diary-files sort-diary-entries))
532 (setq diary-display-hook 'fancy-diary-display)
534 in your `.emacs' file to cause the fancy diary buffer to be displayed with
535 diary entries from various included files, each day's entries sorted into
536 lexicographic order.")
539 (defvar diary-hook nil
540 "*List of functions called after the display of the diary.
541 Can be used for appointment notification.")
544 (defvar diary-display-hook nil
545 "*List of functions that handle the display of the diary.
546 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
549 Ordinarily, this just displays the diary buffer (with holidays indicated in
550 the mode line), if there are any relevant entries. At the time these
551 functions are called, the variable `diary-entries-list' is a list, in order
552 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
553 STRING), where string is the diary entry for the given date. This can be
554 used, for example, a different buffer for display (perhaps combined with
555 holidays), or produce hard copy output.
557 A function `fancy-diary-display' is provided as an alternative
558 choice for this hook; this function prepares a special noneditable diary
559 buffer with the relevant diary entries that has neat day-by-day arrangement
560 with headings. The fancy diary buffer will show the holidays unless the
561 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
562 diary buffer will not show days for which there are no diary entries, even
563 if that day is a holiday; if you want such days to be shown in the fancy
564 diary buffer, set the variable `diary-list-include-blanks' to t.")
567 (defvar nongregorian-diary-listing-hook nil
568 "*List of functions called for listing diary file and included files.
569 As the files are processed for diary entries, these functions are used to cull
570 relevant entries. You can use either or both of `list-hebrew-diary-entries'
571 and `list-islamic-diary-entries'. The documentation for these functions
572 describes the style of such diary entries.")
575 (defvar mark-diary-entries-hook nil
576 "*List of functions called after marking diary entries in the calendar.
578 A function `mark-included-diary-files' is also provided for use as the
579 mark-diary-entries-hook; it enables you to use shared diary files together
580 with your own. The files included are specified in the diary file by lines
582 #include \"filename\"
583 This is recursive; that is, #include directives in files thus included are
584 obeyed. You can change the \"#include\" to some other string by changing the
585 variable `diary-include-string'. When you use `mark-included-diary-files' as
586 part of the mark-diary-entries-hook, you will probably also want to use the
587 function `include-other-diary-files' as part of `list-diary-entries-hook'.")
590 (defvar nongregorian-diary-marking-hook nil
591 "*List of functions called for marking diary file and included files.
592 As the files are processed for diary entries, these functions are used to cull
593 relevant entries. You can use either or both of `mark-hebrew-diary-entries'
594 and `mark-islamic-diary-entries'. The documentation for these functions
595 describes the style of such diary entries.")
598 (defvar diary-list-include-blanks nil
599 "*If nil, do not include days with no diary entry in the list of diary entries.
600 Such days will then not be shown in the the fancy diary buffer, even if they
604 (defvar holidays-in-diary-buffer t
605 "*Non-nil means include holidays in the diary display.
606 The holidays appear in the mode line of the diary buffer, or in the
607 fancy diary buffer next to the date. This slows down the diary functions
608 somewhat; setting it to nil makes the diary display faster.")
610 (defvar calendar-mark-ring nil
)
613 (put 'general-holidays
'risky-local-variable t
)
615 (defvar general-holidays
616 '((holiday-fixed 1 1 "New Year's Day")
617 (holiday-float 1 1 3 "Martin Luther King Day")
618 (holiday-fixed 2 2 "Ground Hog Day")
619 (holiday-fixed 2 14 "Valentine's Day")
620 (holiday-float 2 1 3 "President's Day")
621 (holiday-fixed 3 17 "St. Patrick's Day")
622 (holiday-fixed 4 1 "April Fool's Day")
623 (holiday-float 5 0 2 "Mother's Day")
624 (holiday-float 5 1 -
1 "Memorial Day")
625 (holiday-fixed 6 14 "Flag Day")
626 (holiday-float 6 0 3 "Father's Day")
627 (holiday-fixed 7 4 "Independence Day")
628 (holiday-float 9 1 1 "Labor Day")
629 (holiday-float 10 1 2 "Columbus Day")
630 (holiday-fixed 10 31 "Halloween")
631 (holiday-fixed 11 11 "Veteran's Day")
632 (holiday-float 11 4 4 "Thanksgiving"))
633 "*General holidays. Default value is for the United States.
634 See the documentation for `calendar-holidays' for details.")
637 (put 'local-holidays
'risky-local-variable t
)
639 (defvar local-holidays nil
641 See the documentation for `calendar-holidays' for details.")
644 (put 'other-holidays
'risky-local-variable t
)
646 (defvar other-holidays nil
647 "*User defined holidays.
648 See the documentation for `calendar-holidays' for details.")
651 (put 'hebrew-holidays-1
'risky-local-variable t
)
653 (defvar hebrew-holidays-1
654 '((holiday-rosh-hashanah-etc)
655 (if all-hebrew-calendar-holidays
658 (let* ((m displayed-month
)
661 (increment-calendar-month m y -
1)
662 (let ((year (extract-calendar-year
663 (calendar-julian-from-absolute
664 (calendar-absolute-from-gregorian
666 (if (zerop (%
(1+ year
) 4))
668 21))) "\"Tal Umatar\" (evening)"))))
671 (put 'hebrew-holidays-2
'risky-local-variable t
)
673 (defvar hebrew-holidays-2
674 '((if all-hebrew-calendar-holidays
676 (holiday-hebrew 9 25 "Hanukkah"))
677 (if all-hebrew-calendar-holidays
680 (let ((h-year (extract-calendar-year
681 (calendar-hebrew-from-absolute
682 (calendar-absolute-from-gregorian
683 (list displayed-month
28 displayed-year
))))))
684 (if (= (%
(calendar-absolute-from-hebrew (list 10 10 h-year
))
689 (if all-hebrew-calendar-holidays
690 (holiday-hebrew 11 15 "Tu B'Shevat"))))
693 (put 'hebrew-holidays-3
'risky-local-variable t
)
695 (defvar hebrew-holidays-3
696 '((if all-hebrew-calendar-holidays
699 (let ((m displayed-month
)
701 (increment-calendar-month m y
1)
702 (let* ((h-year (extract-calendar-year
703 (calendar-hebrew-from-absolute
704 (calendar-absolute-from-gregorian
706 (calendar-last-day-of-month m y
)
709 (calendar-hebrew-from-absolute
711 (%
(calendar-absolute-from-hebrew
715 (calendar-dayname-on-or-before
716 6 (calendar-absolute-from-hebrew
717 (list 11 17 h-year
)))
718 (calendar-dayname-on-or-before
719 6 (calendar-absolute-from-hebrew
720 (list 11 16 h-year
))))))
721 (day (extract-calendar-day s-s
)))
726 (put 'hebrew-holidays-4
'risky-local-variable t
)
728 (defvar hebrew-holidays-4
729 '((holiday-passover-etc)
730 (if (and all-hebrew-calendar-holidays
731 (let* ((m displayed-month
)
734 (increment-calendar-month m y -
1)
735 (let ((year (extract-calendar-year
736 (calendar-julian-from-absolute
737 (calendar-absolute-from-gregorian
739 (= 21 (% year
28)))))
740 (holiday-julian 3 26 "Kiddush HaHamah"))
741 (if all-hebrew-calendar-holidays
742 (holiday-tisha-b-av-etc))))
745 (put 'hebrew-holidays
'risky-local-variable t
)
747 (defvar hebrew-holidays
(append hebrew-holidays-1 hebrew-holidays-2
748 hebrew-holidays-3 hebrew-holidays-4
)
750 See the documentation for `calendar-holidays' for details.")
753 (put 'christian-holidays
'risky-local-variable t
)
755 (defvar christian-holidays
756 '((if all-christian-calendar-holidays
757 (holiday-fixed 1 6 "Epiphany"))
759 (if all-christian-calendar-holidays
760 (holiday-greek-orthodox-easter))
761 (if all-christian-calendar-holidays
762 (holiday-fixed 8 15 "Assumption"))
763 (if all-christian-calendar-holidays
765 (holiday-fixed 12 25 "Christmas")
766 (if all-christian-calendar-holidays
767 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
768 "*Christian holidays.
769 See the documentation for `calendar-holidays' for details.")
772 (put 'islamic-holidays
'risky-local-variable t
)
774 (defvar islamic-holidays
777 (format "Islamic New Year %d"
778 (let ((m displayed-month
)
780 (increment-calendar-month m y
1)
781 (extract-calendar-year
782 (calendar-islamic-from-absolute
783 (calendar-absolute-from-gregorian
785 m
(calendar-last-day-of-month m y
) y
)))))))
786 (if all-islamic-calendar-holidays
787 (holiday-islamic 1 10 "Ashura"))
788 (if all-islamic-calendar-holidays
789 (holiday-islamic 3 12 "Mulad-al-Nabi"))
790 (if all-islamic-calendar-holidays
791 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
792 (if all-islamic-calendar-holidays
793 (holiday-islamic 8 15 "Shab-e-Bara't"))
794 (holiday-islamic 9 1 "Ramadan Begins")
795 (if all-islamic-calendar-holidays
796 (holiday-islamic 9 27 "Shab-e Qadr"))
797 (if all-islamic-calendar-holidays
798 (holiday-islamic 10 1 "Id-al-Fitr"))
799 (if all-islamic-calendar-holidays
800 (holiday-islamic 12 10 "Id-al-Adha")))
802 See the documentation for `calendar-holidays' for details.")
805 (put 'solar-holidays
'risky-local-variable t
)
807 (defvar solar-holidays
808 '((if (fboundp 'atan
)
809 (solar-equinoxes-solstices))
815 calendar-daylight-savings-starts
816 '(format "Daylight Savings Time Begins %s"
819 (/ calendar-daylight-savings-starts-time
(float 60))
820 calendar-standard-time-zone-name
)
824 calendar-daylight-savings-ends
825 '(format "Daylight Savings Time Ends %s"
828 (/ calendar-daylight-savings-ends-time
(float 60))
829 calendar-daylight-time-zone-name
)
831 "*Sun-related holidays.
832 See the documentation for `calendar-holidays' for details.")
835 (put 'calendar-holidays
'risky-local-variable t
)
836 (defvar calendar-holidays
837 (append general-holidays local-holidays other-holidays
838 christian-holidays hebrew-holidays islamic-holidays
840 "*List of notable days for the command M-x holidays.
842 Additional holidays are easy to add to the list, just put them in the list
843 `other-holidays' in your .emacs file. Similarly, by setting any of
844 `general-holidays', `local-holidays' `christian-holidays', `hebrew-holidays',
845 `islamic-holidays', or `solar-holidays' to nil in your .emacs file, you can
846 eliminate unwanted categories of holidays. The intention is that (in the US)
847 `local-holidays' be set in site-init.el and `other-holidays' be set by the
850 Entries on the list are expressions that return (possibly empty) lists of
851 items of the form ((month day year) string) of a holiday in the in the
852 three-month period centered around `displayed-month' of `displayed-year'.
853 Several basic functions are provided for this purpose:
855 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
856 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
857 MONTH on the Gregorian calendar (0 for Sunday,
858 etc.); K<0 means count back from the end of the
859 month. An optional parameter DAY means the Kth
860 DAYNAME after/before MONTH DAY.
861 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
862 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
863 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
864 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
865 in the variable `year'; if it evaluates to
866 a visible date, that's the holiday; if it
867 evaluates to nil, there's no holiday. STRING
868 is an expression in the variable `date'.
870 For example, to add Bastille Day, celebrated in France on July 14, add
872 (holiday-fixed 7 14 \"Bastille Day\")
874 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
875 Islands on the fourth Monday in August, add
877 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
879 to the list (the last Monday would be specified with `-1' instead of `4').
880 To add the last day of Hanukkah to the list, use
882 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
884 since the Hebrew months are numbered with 1 starting from Nisan, while to
885 add the Islamic feast celebrating Mohammed's birthday use
887 (holiday-islamic 3 12 \"Mohammed's Birthday\")
889 since the Islamic months are numbered from 1 starting with Muharram. To
890 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
892 (holiday-julian 4 2 \"Jefferson's Birthday\")
894 To include a holiday conditionally, use the sexp form or a conditional. For
895 example, to include American presidential elections, which occur on the first
896 Tuesday after the first Monday in November of years divisible by 4, add
899 (if (zerop (% year 4))
900 (calendar-gregorian-from-absolute
901 (1+ (calendar-dayname-on-or-before
902 1 (+ 6 (calendar-absolute-from-gregorian
903 (list 11 1 year)))))))
904 \"US Presidential Election\")
908 (if (zerop (% displayed-year 4))
910 (extract-calendar-day
911 (calendar-gregorian-from-absolute
912 (1+ (calendar-dayname-on-or-before
913 1 (+ 6 (calendar-absolute-from-gregorian
914 (list 11 1 displayed-year)))))))
915 \"US Presidential Election\"))
917 to the list. To include the phases of the moon, add
921 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
922 you've written to return a (possibly empty) list of the relevant VISIBLE dates
923 with descriptive strings such as
925 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... ).")
927 (defconst calendar-buffer
"*Calendar*"
928 "Name of the buffer used for the calendar.")
930 (defconst holiday-buffer
"*Holidays*"
931 "Name of the buffer used for the displaying the holidays.")
933 (defconst fancy-diary-buffer
"*Fancy Diary Entries*"
934 "Name of the buffer used for the optional fancy display of the diary.")
936 (defconst lunar-phases-buffer
"*Phases of Moon*"
937 "Name of the buffer used for the lunar phases.")
939 (defmacro increment-calendar-month
(mon yr n
)
940 "Move the variables MON and YR to the month and year by N months.
941 Forward if N is positive or backward if N is negative."
942 (` (let (( macro-y
(+ (* (, yr
) 12) (, mon
) -
1 (, n
) )))
943 (setq (, mon
) (1+ (% macro-y
12) ))
944 (setq (, yr
) (/ macro-y
12)))))
946 (defmacro calendar-for-loop
(var from init to final do
&rest body
)
947 "Execute a for loop."
948 (` (let (( (, var
) (1- (, init
)) ))
949 (while (>= (, final
) (setq (, var
) (1+ (, var
))))
952 (defmacro calendar-sum
(index initial condition expression
)
953 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
954 (` (let (( (, index
) (, initial
))
957 (setq sum
(+ sum
(, expression
) ))
958 (setq (, index
) (1+ (, index
))))
961 ;; The following are in-line for speed; they can be called thousands of times
962 ;; when looking up holidays or processing the diary. Here, for example, are
963 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
964 ;; fancy diary display, for a moderately complex diary file, with functions
965 ;; used instead of macros. There were a total of 10000 such calls:
967 ;; 1934 extract-calendar-month
968 ;; 1852 extract-calendar-year
969 ;; 1819 extract-calendar-day
970 ;; 845 calendar-leap-year-p
971 ;; 837 calendar-day-number
972 ;; 775 calendar-absolute-from-gregorian
973 ;; 346 calendar-last-day-of-month
974 ;; 286 hebrew-calendar-last-day-of-month
975 ;; 188 hebrew-calendar-leap-year-p
976 ;; 180 hebrew-calendar-elapsed-days
977 ;; 163 hebrew-calendar-last-month-of-year
978 ;; 66 calendar-date-compare
979 ;; 65 hebrew-calendar-days-in-year
980 ;; 60 calendar-absolute-from-julian
981 ;; 50 calendar-absolute-from-hebrew
982 ;; 43 calendar-date-equal
983 ;; 38 calendar-gregorian-from-absolute
988 ;; The use of these seven macros eliminates the overhead of 92% of the function
989 ;; calls; it's faster this way.
991 (defsubst extract-calendar-month
(date)
992 "Extract the month part of DATE which has the form (month day year)."
995 (defsubst extract-calendar-day
(date)
996 "Extract the day part of DATE which has the form (month day year)."
999 (defsubst extract-calendar-year
(date)
1000 "Extract the year part of DATE which has the form (month day year)."
1001 (car (cdr (cdr date
))))
1003 (defsubst calendar-leap-year-p
(year)
1004 "Returns t if YEAR is a Gregorian leap year."
1005 (and (zerop (% year
4))
1006 (or (not (zerop (% year
100)))
1007 (zerop (% year
400)))))
1009 ;; The foregoing is a bit faster, but not as clear as the following:
1011 ;;(defsubst calendar-leap-year-p (year)
1012 ;; "Returns t if YEAR is a Gregorian leap year."
1014 ;; (and (= (% year 4) 0)
1015 ;; (/= (% year 100) 0))
1016 ;; (= (% year 400) 0)))
1018 (defsubst calendar-last-day-of-month
(month year
)
1019 "The last day in MONTH during YEAR."
1020 (if (and (= month
2) (calendar-leap-year-p year
))
1022 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month
))))
1024 ;; An explanation of the calculation can be found in PascAlgorithms by
1025 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1027 (defsubst calendar-day-number
(date)
1028 "Return the day number within the year of the date DATE.
1029 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1030 while (calendar-day-number '(12 31 1980)) returns 366."
1031 (let* ((month (extract-calendar-month date
))
1032 (day (extract-calendar-day date
))
1033 (year (extract-calendar-year date
))
1034 (day-of-year (+ day
(* 31 (1- month
)))))
1037 (setq day-of-year
(- day-of-year
(/ (+ 23 (* 4 month
)) 10)))
1038 (if (calendar-leap-year-p year
)
1039 (setq day-of-year
(1+ day-of-year
)))))
1042 (defsubst calendar-absolute-from-gregorian
(date)
1043 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1044 The Gregorian date Sunday, December 31, 1 BC is imaginary."
1045 (let ((prior-years (1- (extract-calendar-year date
))))
1046 (+ (calendar-day-number date
);; Days this year
1047 (* 365 prior-years
);; + Days in prior years
1048 (/ prior-years
4);; + Julian leap years
1049 (- (/ prior-years
100));; - century years
1050 (/ prior-years
400))));; + Gregorian leap years
1053 (defun calendar (&optional arg
)
1054 "Display a three-month calendar in another window.
1055 The three months appear side by side, with the current month in the middle
1056 surrounded by the previous and next months. The cursor is put on today's date.
1058 If called with an optional prefix argument, prompts for month and year.
1060 This function is suitable for execution in a .emacs file; appropriate setting
1061 of the variable `view-diary-entries-initially' will cause the diary entries for
1062 the current date to be displayed in another window. The value of the variable
1063 `number-of-diary-entries' controls the number of days of diary entries
1064 displayed upon initial display of the calendar.
1066 An optional prefix argument ARG causes the calendar displayed to be ARG
1067 months in the future if ARG is positive or in the past if ARG is negative;
1068 in this case the cursor goes on the first day of the month.
1070 Once in the calendar window, future or past months can be moved into view.
1071 Arbitrary months can be displayed, or the calendar can be scrolled forward
1074 The cursor can be moved forward or backward by one day, one week, one month,
1075 or one year. All of these commands take prefix arguments which, when negative,
1076 cause movement in the opposite direction. For convenience, the digit keys
1077 and the minus sign are automatically prefixes. The window is replotted as
1078 necessary to display the desired date.
1080 Diary entries can be marked on the calendar or displayed in another window.
1082 Use M-x describe-mode for details of the key bindings in the calendar window.
1084 The Gregorian calendar is assumed.
1086 After loading the calendar, the hooks given by the variable
1087 `calendar-load-hook' are run. This is the place to add key bindings to the
1090 After preparing the calendar window initially, the hooks given by the variable
1091 `initial-calendar-window-hook' are run.
1093 The hooks given by the variable `today-visible-calendar-hook' are run
1094 everytime the calendar window gets scrolled, if the current date is visible
1095 in the window. If it is not visible, the hooks given by the variable
1096 `today-invisible-calendar-hook' are run. Thus, for example, setting
1097 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1098 to be replaced by asterisks to highlight it whenever it is in the window."
1100 (set-buffer (get-buffer-create calendar-buffer
))
1102 (let* ((pop-up-windows t
)
1103 (split-height-threshold 1000)
1105 (calendar-read-date t
)
1106 (calendar-current-date)))
1107 (month (extract-calendar-month date
))
1108 (year (extract-calendar-year date
)))
1109 (pop-to-buffer calendar-buffer
)
1110 (increment-calendar-month month year
(- calendar-offset
))
1111 (generate-calendar-window month year
)
1112 (if (and view-diary-entries-initially
(calendar-date-is-visible-p date
))
1114 (if (vectorp number-of-diary-entries
)
1115 (aref number-of-diary-entries
(calendar-day-of-week date
))
1116 number-of-diary-entries
))))
1117 (let* ((diary-buffer (get-file-buffer diary-file
))
1118 (diary-window (if diary-buffer
(get-buffer-window diary-buffer
)))
1119 (split-height-threshold (if diary-window
2 1000)))
1120 (if view-calendar-holidays-initially
1121 (list-calendar-holidays)))
1122 (run-hooks 'initial-calendar-window-hook
))
1124 (autoload 'view-diary-entries
"diary-lib"
1125 "Prepare and display a buffer with diary entries.
1126 Searches your diary file for entries that match ARG days starting with
1127 the date indicated by the cursor position in the displayed three-month
1131 (autoload 'calendar-sunrise-sunset
"solar"
1132 "Local time of sunrise and sunset for date under cursor."
1135 (autoload 'calendar-phases-of-moon
"lunar"
1136 "Create a buffer of the phases of the moon for the current calendar window."
1139 (autoload 'calendar-print-french-date
"cal-french"
1140 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1143 (autoload 'calendar-goto-french-date
"cal-french"
1144 "Move cursor to French Revolutionary date."
1147 (autoload 'calendar-french-date-string
"cal-french"
1148 "String of French Revolutionary date of Gregorian DATE."
1151 (autoload 'calendar-mayan-date-string
"cal-mayan"
1152 "String of Mayan date of Gregorian DATE."
1155 (autoload 'calendar-print-mayan-date
"cal-mayan"
1156 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1159 (autoload 'calendar-goto-mayan-long-count-date
"cal-mayan"
1160 "Move cursor to Mayan long count date."
1163 (autoload 'calendar-next-haab-date
"cal-mayan"
1164 "Move cursor to next instance of Mayan Haab date."
1167 (autoload 'calendar-previous-haab-date
"cal-mayan"
1168 "Move cursor to previous instance of Mayan Haab date."
1171 (autoload 'calendar-next-tzolkin-date
"cal-mayan"
1172 "Move cursor to next instance of Mayan Tzolkin date."
1175 (autoload 'calendar-previous-tzolkin-date
"cal-mayan"
1176 "Move cursor to previous instance of Mayan Tzolkin date."
1179 (autoload 'calendar-next-calendar-round-date
"cal-mayan"
1180 "Move cursor to next instance of Mayan Haab/Tzoklin combination."
1183 (autoload 'calendar-previous-calendar-round-date
"cal-mayan"
1184 "Move cursor to previous instance of Mayan Haab/Tzoklin combination."
1187 (autoload 'show-all-diary-entries
"diary-lib"
1188 "Show all of the diary entries in the diary file.
1189 This function gets rid of the selective display of the diary file so that
1190 all entries, not just some, are visible. If there is no diary buffer, one
1194 (autoload 'mark-diary-entries
"diary-lib"
1195 "Mark days in the calendar window that have diary entries.
1196 Each entry in diary file visible in the calendar window is marked."
1199 (autoload 'insert-diary-entry
"diary-ins"
1200 "Insert a diary entry for the date indicated by point."
1203 (autoload 'insert-weekly-diary-entry
"diary-ins"
1204 "Insert a weekly diary entry for the day of the week indicated by point."
1208 (autoload 'insert-monthly-diary-entry
"diary-ins"
1209 "Insert a monthly diary entry for the day of the month indicated by point."
1212 (autoload 'insert-yearly-diary-entry
"diary-ins"
1213 "Insert an annual diary entry for the day of the year indicated by point."
1216 (autoload 'insert-anniversary-diary-entry
"diary-ins"
1217 "Insert an anniversary diary entry for the date indicated by point."
1220 (autoload 'insert-block-diary-entry
"diary-ins"
1221 "Insert a block diary entry for the dates indicated by point and mark."
1224 (autoload 'insert-cyclic-diary-entry
"diary-ins"
1225 "Insert a cyclic diary entry starting at the date indicated by point."
1228 (autoload 'insert-hebrew-diary-entry
"diary-ins"
1229 "Insert a diary entry for the Hebrew date corresponding to the date
1230 indicated by point."
1233 (autoload 'insert-monthly-hebrew-diary-entry
"diary-ins"
1234 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1235 to the date indicated by point."
1238 (autoload 'insert-yearly-hebrew-diary-entry
"diary-ins"
1239 "Insert an annual diary entry for the day of the Hebrew year corresponding
1240 to the date indicated by point."
1243 (autoload 'insert-islamic-diary-entry
"diary-ins"
1244 "Insert a diary entry for the Islamic date corresponding to the date
1245 indicated by point."
1248 (autoload 'insert-monthly-islamic-diary-entry
"diary-ins"
1249 "Insert a monthly diary entry for the day of the Islamic month corresponding
1250 to the date indicated by point."
1253 (autoload 'insert-yearly-islamic-diary-entry
"diary-ins"
1254 "Insert an annual diary entry for the day of the Islamic year corresponding
1255 to the date indicated by point."
1258 (autoload 'list-calendar-holidays
"holidays"
1259 "Create a buffer containing the holidays for the current calendar window.
1260 The holidays are those in the list `calendar-notable-days'. Returns t if any
1261 holidays are found, nil if not."
1264 (autoload 'mark-calendar-holidays
"holidays"
1265 "Mark notable days in the calendar window."
1268 (autoload 'calendar-cursor-holidays
"holidays"
1269 "Find holidays for the date specified by the cursor in the calendar window."
1272 (defun generate-calendar-window (&optional mon yr
)
1273 "Generate the calendar window for the current date.
1274 Or, for optional MON, YR."
1275 (let* ((buffer-read-only nil
)
1276 (today (calendar-current-date))
1277 (month (extract-calendar-month today
))
1278 (day (extract-calendar-day today
))
1279 (year (extract-calendar-year today
))
1282 (let ((offset (calendar-interval mon yr month year
)))
1283 (and (<= offset
1) (>= offset -
1)))))
1284 (day-in-week (calendar-day-of-week today
)))
1285 (update-calendar-mode-line)
1287 (generate-calendar mon yr
)
1288 (generate-calendar month year
))
1289 (calendar-cursor-to-visible-date
1290 (if today-visible today
(list displayed-month
1 displayed-year
)))
1291 (set-buffer-modified-p nil
)
1292 (or (one-window-p t
)
1293 (/= (frame-width) (window-width))
1294 (shrink-window (- (window-height) 9)))
1296 (and mark-holidays-in-calendar
1297 (mark-calendar-holidays)
1300 (if mark-diary-entries-in-calendar
(mark-diary-entries))
1302 (run-hooks 'today-visible-calendar-hook
)
1303 (run-hooks 'today-invisible-calendar-hook
)))))
1305 (defun generate-calendar (month year
)
1306 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
1307 (if (< (+ month
(* 12 (1- year
))) 2)
1308 (error "Months before February, 1 AD are not available."))
1309 (setq displayed-month month
)
1310 (setq displayed-year year
)
1312 (increment-calendar-month month year -
1)
1313 (calendar-for-loop i from
0 to
2 do
1314 (generate-calendar-month month year
(+ 5 (* 25 i
)))
1315 (increment-calendar-month month year
1)))
1317 (defun generate-calendar-month (month year indent
)
1318 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
1319 The calendar is inserted in the buffer starting at the line on which point
1320 is currently located, but indented INDENT spaces. The indentation is done
1321 from the first character on the line and does not disturb the first INDENT
1322 characters on the line."
1323 (let* ((blank-days;; at start of month
1325 (- (calendar-day-of-week (list month
1 year
))
1326 calendar-week-start-day
)
1328 (last (calendar-last-day-of-month month year
)))
1329 (goto-char (point-min))
1330 (calendar-insert-indented
1331 (calendar-string-spread
1332 (list "" (format "%s %d" (calendar-month-name month
) year
) "") ?
20)
1334 (calendar-insert-indented "" indent
);; Go to proper spot
1335 (calendar-for-loop i from
0 to
6 do
1336 (insert (substring (aref calendar-day-name-array
1337 (mod (+ calendar-week-start-day i
) 7))
1340 (calendar-insert-indented "" 0 t
);; Force onto following line
1341 (calendar-insert-indented "" indent
);; Go to proper spot
1342 ;; Add blank days before the first of the month
1343 (calendar-for-loop i from
1 to blank-days do
(insert " "))
1344 ;; Put in the days of the month
1345 (calendar-for-loop i from
1 to last do
1346 (insert (format "%2d " i
))
1347 (put-text-property (- (point) (if (< i
10) 2 3)) (1- (point))
1348 'mouse-face
'highlight
)
1349 (and (zerop (mod (+ i blank-days
) 7))
1351 (calendar-insert-indented "" 0 t
) ;; Force onto following line
1352 (calendar-insert-indented "" indent
)))));; Go to proper spot
1354 (defun calendar-insert-indented (string indent
&optional newline
)
1355 "Insert STRING at column INDENT.
1356 If the optional parameter NEWLINE is t, leave point at start of next line,
1357 inserting a newline if there was no next line; otherwise, leave point after
1358 the inserted text. Value is always t."
1359 ;; Try to move to that column.
1360 (move-to-column indent
)
1361 ;; If line is too short, indent out to that column.
1362 (if (< (current-column) indent
)
1365 ;; Advance to next line, if requested.
1374 (defun redraw-calendar ()
1375 "Redraw the calendar display."
1377 (let ((cursor-date (calendar-cursor-to-date)))
1378 (generate-calendar-window displayed-month displayed-year
)
1379 (calendar-cursor-to-visible-date cursor-date
)))
1381 (defvar calendar-debug-sexp nil
1382 "*Turn debugging on when evaluating a sexp in the diary or holiday list.")
1384 (defvar calendar-mode-map nil
)
1385 (if calendar-mode-map
1387 (setq calendar-mode-map
(make-sparse-keymap))
1388 (if window-system
(require 'cal-menu
))
1389 (calendar-for-loop i from
0 to
9 do
1390 (define-key calendar-mode-map
(int-to-string i
) 'digit-argument
))
1391 (let ((l (list 'narrow-to-region
'mark-word
'mark-sexp
'mark-paragraph
1392 'mark-defun
'mark-whole-buffer
'mark-page
1393 'downcase-region
'upcase-region
'kill-region
1394 'copy-region-as-kill
'capitalize-region
'write-region
)))
1396 (substitute-key-definition (car l
) 'calendar-not-implemented
1397 calendar-mode-map global-map
)
1399 (define-key calendar-mode-map
"-" 'negative-argument
)
1400 (define-key calendar-mode-map
"\C-x>" 'scroll-calendar-right
)
1401 (define-key calendar-mode-map
[prior] 'scroll-calendar-right-three-months)
1402 (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
1403 (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
1404 (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
1405 (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
1406 (define-key calendar-mode-map "\C-b" 'calendar-backward-day)
1407 (define-key calendar-mode-map "\C-p" 'calendar-backward-week)
1408 (define-key calendar-mode-map "\e{" 'calendar-backward-month)
1409 (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
1410 (define-key calendar-mode-map "\C-f" 'calendar-forward-day)
1411 (define-key calendar-mode-map "\C-n" 'calendar-forward-week)
1412 (define-key calendar-mode-map [left] 'calendar-backward-day)
1413 (define-key calendar-mode-map [up] 'calendar-backward-week)
1414 (define-key calendar-mode-map [right] 'calendar-forward-day)
1415 (define-key calendar-mode-map [down] 'calendar-forward-week)
1416 (define-key calendar-mode-map "\e}" 'calendar-forward-month)
1417 (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
1418 (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
1419 (define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
1420 (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month)
1421 (define-key calendar-mode-map "\ee" 'calendar-end-of-month)
1422 (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
1423 (define-key calendar-mode-map "\e>" 'calendar-end-of-year)
1424 (define-key calendar-mode-map "\C-@" 'calendar-set-mark)
1425 ;; Many people are used to typing C-SPC and getting C-@.
1426 (define-key calendar-mode-map [?\C-\ ] 'calendar-set-mark)
1427 (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
1428 (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
1429 (define-key calendar-mode-map "gd" 'calendar-goto-date)
1430 (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
1431 (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
1432 (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
1433 (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
1434 (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
1435 (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
1436 (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
1437 (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
1438 (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
1439 (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
1440 (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
1441 (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
1442 (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
1443 (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
1444 (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
1445 (define-key calendar-mode-map " " 'scroll-other-window)
1446 (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
1447 (define-key calendar-mode-map "." 'calendar-goto-today)
1448 (define-key calendar-mode-map "o" 'calendar-other-month)
1449 (define-key calendar-mode-map "q" 'exit-calendar)
1450 (define-key calendar-mode-map "a" 'list-calendar-holidays)
1451 (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
1452 (define-key calendar-mode-map "x" 'mark-calendar-holidays)
1453 (define-key calendar-mode-map "u" 'calendar-unmark)
1454 (define-key calendar-mode-map "m" 'mark-diary-entries)
1455 (define-key calendar-mode-map "d" 'view-diary-entries)
1456 (define-key calendar-mode-map "D" 'view-other-diary-entries)
1457 (define-key calendar-mode-map "s" 'show-all-diary-entries)
1458 (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
1459 (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
1460 (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
1461 (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
1462 (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
1463 (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
1464 (define-key calendar-mode-map "pf" 'calendar-print-french-date)
1465 (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
1466 (define-key calendar-mode-map "id" 'insert-diary-entry)
1467 (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
1468 (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
1469 (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
1470 (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
1471 (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
1472 (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
1473 (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
1474 (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
1475 (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
1476 (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
1477 (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
1478 (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
1479 (define-key calendar-mode-map "?" 'calendar-goto-info-node))
1481 (defun describe-calendar-mode ()
1482 "Create a help buffer with a brief description of the calendar-mode."
1484 (with-output-to-temp-buffer "*Help*"
1487 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
1488 (substitute-command-keys
1489 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
1490 (substitute-command-keys "\\{calendar-mode-map}")))
1492 (set-buffer standard-output)
1494 (print-help-return-message)))
1496 ;; Calendar mode is suitable only for specially formatted data.
1497 (put 'calendar-mode 'mode-class 'special)
1499 (defvar calendar-mode-line-format
1501 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-left]")
1503 (substitute-command-keys "\\<calendar-mode-map>\\[calendar-goto-info-node] info/\\[calendar-other-month] other/\\[calendar-goto-today] today")
1504 '(calendar-date-string (calendar-current-date) t)
1505 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-right]"))
1506 "The mode line of the calendar buffer.")
1508 (defun calendar-goto-info-node ()
1509 "Go to the info node for the calendar."
1512 (let ((where (Info-find-emacs-command-nodes 'calendar)))
1514 (error "Couldn't find documentation for the calendar.")
1515 (save-window-excursion (info))
1516 (pop-to-buffer "*info*")
1517 (Info-find-node (car (car where)) (car (cdr (car where)))))))
1519 (defun calendar-mode ()
1520 "A major mode for the calendar window.
1522 For a complete description, type \
1523 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
1525 \\<calendar-mode-map>\\{calendar-mode-map}"
1527 (kill-all-local-variables)
1528 (setq major-mode 'calendar-mode)
1529 (setq mode-name "Calendar")
1530 (use-local-map calendar-mode-map)
1531 (setq buffer-read-only t)
1532 (setq indent-tabs-mode nil)
1533 (update-calendar-mode-line)
1534 (make-local-variable 'calendar-mark-ring)
1535 (make-local-variable 'displayed-month);; Month in middle of window.
1536 (make-local-variable 'displayed-year));; Year in middle of window.
1538 (defun calendar-string-spread (strings char length)
1539 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH
1540 There must be at least 2 strings. The effect is like mapconcat but the
1541 separating pieces are as balanced as possible. Each item of STRINGS is
1542 evaluated before concatenation so it can actually be an expression that
1543 evaluates to a string. If LENGTH is too short, the STRINGS are just
1544 concatenated and the result truncated."
1545 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
1546 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
1547 ;; Addison-Wesley, Reading, MA, 1989
1548 (let* ((strings (mapcar 'eval strings))
1549 (n (- length (length (apply 'concat strings))))
1550 (m (1- (length strings)))
1552 (strings (cdr strings))
1556 (make-string (max 0 (/ (+ n i) m)) char)
1559 (setq strings (cdr strings)))
1560 (substring s 0 length)))
1562 (defun update-calendar-mode-line ()
1563 "Update the calendar mode line with the current date and date style."
1564 (if (bufferp (get-buffer calendar-buffer))
1566 (set-buffer calendar-buffer)
1567 (setq mode-line-format
1568 (calendar-string-spread
1569 calendar-mode-line-format ? (frame-width))))))
1571 (defun calendar-window-list ()
1572 "List of all calendar-related windows."
1573 (let ((calendar-buffers (calendar-buffer-list))
1575 (walk-windows '(lambda (w)
1576 (if (memq (window-buffer w) calendar-buffers)
1577 (setq list (cons w list))))
1581 (defun calendar-buffer-list ()
1582 "List of all calendar-related buffers."
1583 (let* ((diary-buffer (get-file-buffer diary-file))
1584 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
1585 fancy-diary-buffer diary-buffer calendar-buffer))
1589 (setq b (car buffers))
1590 (setq b (cond ((stringp b) (get-buffer b))
1593 (if b (setq buffer-list (cons b buffer-list)))
1594 (setq buffers (cdr buffers)))
1597 (defun exit-calendar ()
1598 "Get out of the calendar window and hide it and related buffers."
1600 (let* ((diary-buffer (get-file-buffer diary-file)))
1601 (if (and diary-buffer (buffer-modified-p diary-buffer)
1604 "Diary modified; do you really want to exit the calendar? ")))
1606 ;; Need to do this multiple times because one time can replace some
1607 ;; calendar-related buffers with other calendar-related buffers
1609 (mapcar 'calendar-hide-window (calendar-window-list)))
1610 (calendar-window-list)))))
1612 (defun calendar-hide-window (window)
1613 "Hide WINDOW if it is calendar-related."
1614 (let ((buffer (if (window-live-p window) (window-buffer window))))
1615 (if (memq buffer (calendar-buffer-list))
1618 (eq 'icon (cdr (assoc 'visibility
1620 (window-frame window))))))
1622 ((and window-system (window-dedicated-p window))
1623 (iconify-frame (window-frame window)))
1624 ((not (and (select-window window) (one-window-p window)))
1625 (delete-window window))
1626 (t (set-buffer buffer)
1629 (defun calendar-goto-today ()
1630 "Reposition the calendar window so the current date is visible."
1632 (let ((today (calendar-current-date)));; The date might have changed.
1633 (if (not (calendar-date-is-visible-p today))
1634 (generate-calendar-window)
1635 (update-calendar-mode-line)
1636 (calendar-cursor-to-visible-date today))))
1638 (defun calendar-forward-month (arg)
1639 "Move the cursor forward ARG months.
1640 Movement is backward if ARG is negative."
1642 (calendar-cursor-to-nearest-date)
1643 (let* ((cursor-date (calendar-cursor-to-date t))
1644 (month (extract-calendar-month cursor-date))
1645 (day (extract-calendar-day cursor-date))
1646 (year (extract-calendar-year cursor-date)))
1647 (increment-calendar-month month year arg)
1648 (let ((last (calendar-last-day-of-month month year)))
1651 ;; Put the new month on the screen, if needed, and go to the new date.
1652 (let ((new-cursor-date (list month day year)))
1653 (if (not (calendar-date-is-visible-p new-cursor-date))
1654 (calendar-other-month month year))
1655 (calendar-cursor-to-visible-date new-cursor-date))))
1657 (defun calendar-forward-year (arg)
1658 "Move the cursor forward by ARG years.
1659 Movement is backward if ARG is negative."
1661 (calendar-forward-month (* 12 arg)))
1663 (defun calendar-backward-month (arg)
1664 "Move the cursor backward by ARG months.
1665 Movement is forward if ARG is negative."
1667 (calendar-forward-month (- arg)))
1669 (defun calendar-backward-year (arg)
1670 "Move the cursor backward ARG years.
1671 Movement is forward is ARG is negative."
1673 (calendar-forward-month (* -12 arg)))
1675 (defun scroll-calendar-left (arg)
1676 "Scroll the displayed calendar left by ARG months.
1677 If ARG is negative the calendar is scrolled right. Maintains the relative
1678 position of the cursor with respect to the calendar as well as possible."
1680 (calendar-cursor-to-nearest-date)
1681 (let ((old-date (calendar-cursor-to-date))
1682 (today (calendar-current-date)))
1685 (increment-calendar-month displayed-month displayed-year arg)
1686 (generate-calendar-window displayed-month displayed-year)
1687 (calendar-cursor-to-visible-date
1689 ((calendar-date-is-visible-p old-date) old-date)
1690 ((calendar-date-is-visible-p today) today)
1691 (t (list displayed-month 1 displayed-year))))))))
1693 (defun scroll-calendar-right (arg)
1694 "Scroll the displayed calendar window right by ARG months.
1695 If ARG is negative the calendar is scrolled left. Maintains the relative
1696 position of the cursor with respect to the calendar as well as possible."
1698 (scroll-calendar-left (- arg)))
1700 (defun scroll-calendar-left-three-months (arg)
1701 "Scroll the displayed calendar window left by 3*ARG months.
1702 If ARG is negative the calendar is scrolled right. Maintains the relative
1703 position of the cursor with respect to the calendar as well as possible."
1705 (scroll-calendar-left (* 3 arg)))
1707 (defun scroll-calendar-right-three-months (arg)
1708 "Scroll the displayed calendar window right by 3*ARG months.
1709 If ARG is negative the calendar is scrolled left. Maintains the relative
1710 position of the cursor with respect to the calendar as well as possible."
1712 (scroll-calendar-left (* -3 arg)))
1714 (defun calendar-current-date ()
1715 "Returns the current date in a list (month day year)."
1716 (let ((s (current-time-string)))
1717 (list (length (member (substring s 4 7)
1718 '("Dec" "Nov" "Oct" "Sep" "Aug" "Jul"
1719 "Jun" "May" "Apr" "Mar" "Feb" "Jan")))
1720 (string-to-number (substring s 8 10))
1721 (string-to-number (substring s 20 24)))))
1723 (defun calendar-cursor-to-date (&optional error)
1724 "Returns a list (month day year) of current cursor position.
1725 If cursor is not on a specific date, signals an error if optional parameter
1726 ERROR is t, otherwise just returns nil."
1727 (let* ((segment (/ (current-column) 25))
1728 (month (% (+ displayed-month segment -1) 12))
1729 (month (if (= 0 month) 12 month))
1732 ((and (= 12 month) (= segment 0)) (1- displayed-year))
1733 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
1734 (t displayed-year))))
1735 (if (and (looking-at "[0-9]")
1736 (< 2 (count-lines (point-min) (point))))
1738 (re-search-backward "[^0-9]")
1740 (string-to-int (buffer-substring (1+ (point)) (+ 4 (point))))
1742 (if (looking-at "\\*")
1744 (re-search-backward "[^*]")
1745 (if (looking-at ".\\*\\*")
1746 (list month calendar-starred-day year)
1747 (if error (error "Not on a date!"))))
1748 (if error (error "Not on a date!"))))))
1750 (defun calendar-cursor-to-nearest-date ()
1751 "Move the cursor to the closest date.
1752 The position of the cursor is unchanged if it is already on a date.
1753 Returns the list (month day year) giving the cursor position."
1754 (let ((date (calendar-cursor-to-date))
1755 (column (current-column)))
1758 (if (> 3 (count-lines (point-min) (point)))
1761 (move-to-column column)))
1762 (if (not (looking-at "[0-9]"))
1763 (if (and (not (looking-at " *$"))
1770 (re-search-forward "[0-9]" nil t)
1772 (re-search-backward "[0-9]" nil t)))
1773 (calendar-cursor-to-date))))
1775 (defun calendar-forward-day (arg)
1776 "Move the cursor forward ARG days.
1777 Moves backward if ARG is negative."
1781 ((cursor-date (calendar-cursor-to-date))
1782 (cursor-date (if cursor-date
1784 (if (> arg 0) (setq arg (1- arg)))
1785 (calendar-cursor-to-nearest-date)))
1787 (calendar-gregorian-from-absolute
1788 (+ (calendar-absolute-from-gregorian cursor-date) arg)))
1789 (new-display-month (extract-calendar-month new-cursor-date))
1790 (new-display-year (extract-calendar-year new-cursor-date)))
1791 ;; Put the new month on the screen, if needed, and go to the new date.
1792 (if (not (calendar-date-is-visible-p new-cursor-date))
1793 (calendar-other-month new-display-month new-display-year))
1794 (calendar-cursor-to-visible-date new-cursor-date))))
1796 (defun calendar-backward-day (arg)
1797 "Move the cursor back ARG days.
1798 Moves forward if ARG is negative."
1800 (calendar-forward-day (- arg)))
1802 (defun calendar-forward-week (arg)
1803 "Move the cursor forward ARG weeks.
1804 Moves backward if ARG is negative."
1806 (calendar-forward-day (* arg 7)))
1808 (defun calendar-backward-week (arg)
1809 "Move the cursor back ARG weeks.
1810 Moves forward if ARG is negative."
1812 (calendar-forward-day (* arg -7)))
1814 (defun calendar-beginning-of-week (arg)
1815 "Move the cursor back ARG calendar-week-start-day's."
1817 (calendar-cursor-to-nearest-date)
1818 (let ((day (calendar-day-of-week (calendar-cursor-to-date))))
1819 (calendar-backward-day
1820 (if (= day calendar-week-start-day)
1822 (+ (mod (- day calendar-week-start-day) 7)
1825 (defun calendar-end-of-week (arg)
1826 "Move the cursor forward ARG calendar-week-start-day+6's."
1828 (calendar-cursor-to-nearest-date)
1829 (let ((day (calendar-day-of-week (calendar-cursor-to-date))))
1830 (calendar-forward-day
1831 (if (= day (mod (1- calendar-week-start-day) 7))
1833 (+ (- 6 (mod (- day calendar-week-start-day) 7))
1836 (defun calendar-beginning-of-month (arg)
1837 "Move the cursor backward ARG month beginnings."
1839 (calendar-cursor-to-nearest-date)
1840 (let* ((date (calendar-cursor-to-date))
1841 (month (extract-calendar-month date))
1842 (day (extract-calendar-day date))
1843 (year (extract-calendar-year date)))
1845 (calendar-backward-month arg)
1846 (calendar-cursor-to-visible-date (list month 1 year))
1847 (calendar-backward-month (1- arg)))))
1849 (defun calendar-end-of-month (arg)
1850 "Move the cursor forward ARG month ends."
1852 (calendar-cursor-to-nearest-date)
1853 (let* ((date (calendar-cursor-to-date))
1854 (month (extract-calendar-month date))
1855 (day (extract-calendar-day date))
1856 (year (extract-calendar-year date))
1857 (last-day (calendar-last-day-of-month month year)))
1858 (if (/= day last-day)
1860 (calendar-cursor-to-visible-date (list month last-day year))
1861 (setq arg (1- arg))))
1862 (increment-calendar-month month year arg)
1863 (let ((last-day (list
1865 (calendar-last-day-of-month month year)
1867 (if (not (calendar-date-is-visible-p last-day))
1868 (calendar-other-month month year)
1869 (calendar-cursor-to-visible-date last-day)))))
1871 (defun calendar-beginning-of-year (arg)
1872 "Move the cursor backward ARG year beginnings."
1874 (calendar-cursor-to-nearest-date)
1875 (let* ((date (calendar-cursor-to-date))
1876 (month (extract-calendar-month date))
1877 (day (extract-calendar-day date))
1878 (year (extract-calendar-year date))
1879 (jan-first (list 1 1 year)))
1880 (if (and (= day 1) (= 1 month))
1881 (calendar-backward-month (* 12 arg))
1883 (calendar-date-is-visible-p jan-first))
1884 (calendar-cursor-to-visible-date jan-first)
1885 (calendar-other-month 1 (- year (1- arg)))))))
1887 (defun calendar-end-of-year (arg)
1888 "Move the cursor forward ARG year beginnings."
1890 (calendar-cursor-to-nearest-date)
1891 (let* ((date (calendar-cursor-to-date))
1892 (month (extract-calendar-month date))
1893 (day (extract-calendar-day date))
1894 (year (extract-calendar-year date))
1895 (dec-31 (list 12 31 year)))
1896 (if (and (= day 31) (= 12 month))
1897 (calendar-forward-month (* 12 arg))
1899 (calendar-date-is-visible-p dec-31))
1900 (calendar-cursor-to-visible-date dec-31)
1901 (calendar-other-month 12 (- year (1- arg)))
1902 (calendar-cursor-to-visible-date (list 12 31 displayed-year))))))
1904 ;; The following version of calendar-gregorian-from-absolute is preferred for
1905 ;; reasons of clarity, BUT it's much slower than the version that follows it.
1907 ;;(defun calendar-gregorian-from-absolute (date)
1908 ;; "Compute the list (month day year) corresponding to the absolute DATE.
1909 ;;The absolute date is the number of days elapsed since the (imaginary)
1910 ;;Gregorian date Sunday, December 31, 1 BC."
1911 ;; (let* ((approx (/ date 366));; Approximation from below.
1912 ;; (year ;; Search forward from the approximation.
1914 ;; (calendar-sum y approx
1915 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
1917 ;; (month ;; Search forward from January.
1918 ;; (1+ (calendar-sum m 1
1920 ;; (calendar-absolute-from-gregorian
1921 ;; (list m (calendar-last-day-of-month m year) year)))
1923 ;; (day ;; Calculate the day by subtraction.
1925 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
1926 ;; (list month day year)))
1928 (defun calendar-gregorian-from-absolute (date)
1929 "Compute the list (month day year) corresponding to the absolute DATE.
1930 The absolute date is the number of days elapsed since the (imaginary)
1931 Gregorian date Sunday, December 31, 1 BC."
1932 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
1933 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
1934 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
1935 ;; (April, 1993), pages 383-404 for an explanation.
1936 (let* ((d0 (1- date))
1937 (n400 (/ d0 146097))
1944 (day (1+ (% d3 365)))
1945 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
1946 (if (or (= n100 4) (= n1 4))
1948 (let ((year (1+ year))
1950 (while (let ((mdays (calendar-last-day-of-month month year)))
1952 (setq day (- day mdays))))
1953 (setq month (1+ month)))
1954 (list month day year)))))
1956 (defun calendar-cursor-to-visible-date (date)
1957 "Move the cursor to DATE that is on the screen."
1958 (let* ((month (extract-calendar-month date))
1959 (day (extract-calendar-day date))
1960 (year (extract-calendar-year date))
1961 (first-of-month-weekday (calendar-day-of-week (list month 1 year))))
1965 (- (calendar-day-of-week (list month 1 year))
1966 calendar-week-start-day)
1969 (move-to-column (+ 6
1971 (1+ (calendar-interval
1972 displayed-month displayed-year month year)))
1974 (- (calendar-day-of-week date)
1975 calendar-week-start-day)
1978 (defun calendar-other-month (month year)
1979 "Display a three-month calendar centered around MONTH and YEAR."
1980 (interactive (calendar-read-date 'noday))
1981 (if (and (= month displayed-month)
1982 (= year displayed-year))
1984 (let ((old-date (calendar-cursor-to-date))
1985 (today (calendar-current-date)))
1986 (generate-calendar-window month year)
1987 (calendar-cursor-to-visible-date
1989 ((calendar-date-is-visible-p old-date) old-date)
1990 ((calendar-date-is-visible-p today) today)
1991 (t (list month 1 year)))))))
1993 (defun calendar-set-mark (arg)
1994 "Mark the date under the cursor, or jump to marked date.
1995 With no prefix argument, push current date onto marked date ring.
1996 With argument, jump to mark, pop it, and put point at end of ring."
1998 (let ((date (calendar-cursor-to-date t)))
2001 (setq calendar-mark-ring (cons date calendar-mark-ring))
2002 ;; Since the top of the mark ring is the marked date in the
2003 ;; calendar, the mark ring in the calendar is one longer than
2004 ;; in other buffers to get the same effect.
2005 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2006 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2007 (message "Mark set"))
2008 (if (null calendar-mark-ring)
2009 (error "No mark set in this buffer")
2010 (calendar-goto-date (car calendar-mark-ring))
2011 (setq calendar-mark-ring
2012 (cdr (nconc calendar-mark-ring (list date))))))))
2014 (defun calendar-exchange-point-and-mark ()
2015 "Exchange the current cursor position with the marked date."
2017 (let ((mark (car calendar-mark-ring))
2018 (date (calendar-cursor-to-date t)))
2020 (error "No mark set in this buffer")
2021 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2022 (calendar-goto-date mark))))
2024 (defun calendar-count-days-region ()
2025 "Count the number of days (inclusive) between point and the mark."
2027 (let* ((days (- (calendar-absolute-from-gregorian
2028 (calendar-cursor-to-date t))
2029 (calendar-absolute-from-gregorian
2030 (or (car calendar-mark-ring)
2031 (error "No mark set in this buffer")))))
2032 (days (1+ (if (> days 0) days (- days)))))
2033 (message "Region has %d day%s (inclusive)"
2034 days (if (> days 1) "s" ""))))
2036 (defun calendar-not-implemented ()
2039 (error "%s not available in the calendar"
2040 (global-key-binding (this-command-keys))))
2042 (defun calendar-read (prompt acceptable &optional initial-contents)
2043 "Return an object read from the minibuffer.
2044 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2045 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2046 is a string to insert in the minibuffer before reading."
2047 (let ((value (read-minibuffer prompt initial-contents)))
2048 (while (not (funcall acceptable value))
2049 (setq value (read-minibuffer prompt initial-contents)))
2052 (defun calendar-read-date (&optional noday)
2053 "Prompt for Gregorian date. Returns a list (month day year).
2054 If optional NODAY is t, does not ask for day, but just returns
2055 (month nil year); if NODAY is any other non-nil value the value returned is
2057 (let* ((year (calendar-read
2059 '(lambda (x) (> x 0))
2060 (int-to-string (extract-calendar-year
2061 (calendar-current-date)))))
2062 (month-array calendar-month-name-array)
2063 (completion-ignore-case t)
2068 (mapcar 'list (append month-array nil))
2070 (calendar-make-alist month-array 1 'capitalize))))
2071 (last (calendar-last-day-of-month month year)))
2074 (list month nil year)
2077 (calendar-read (format "Day (1-%d): " last)
2078 '(lambda (x) (and (< 0 x) (<= x last))))
2081 (defun calendar-goto-date (date)
2082 "Move cursor to DATE."
2083 (interactive (list (calendar-read-date)))
2084 (let ((month (extract-calendar-month date))
2085 (year (extract-calendar-year date)))
2086 (if (not (calendar-date-is-visible-p date))
2087 (calendar-other-month
2088 (if (and (= month 1) (= year 1))
2092 (calendar-cursor-to-visible-date date))
2094 (defun calendar-goto-julian-date (date &optional noecho)
2095 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
2097 (let* ((today (calendar-current-date))
2098 (year (calendar-read
2099 "Julian calendar year (>0): "
2100 '(lambda (x) (> x 0))
2102 (extract-calendar-year
2103 (calendar-julian-from-absolute
2104 (calendar-absolute-from-gregorian
2106 (month-array calendar-month-name-array)
2107 (completion-ignore-case t)
2111 "Julian calendar month name: "
2112 (mapcar 'list (append month-array nil))
2114 (calendar-make-alist month-array 1 'capitalize))))
2116 (if (and (zerop (% year 4)) (= month 2))
2118 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
2120 (format "Julian calendar day (%d-%d): "
2121 (if (and (= year 1) (= month 1)) 3 1) last)
2123 (and (< (if (and (= year 1) (= month 1)) 2 0) x)
2125 (list (list month day year))))
2126 (calendar-goto-date (calendar-gregorian-from-absolute
2127 (calendar-absolute-from-julian date)))
2128 (or noecho (calendar-print-julian-date)))
2130 (defun calendar-goto-hebrew-date (date &optional noecho)
2131 "Move cursor to Hebrew DATE; echo Hebrew date unless NOECHO is t."
2133 (let* ((today (calendar-current-date))
2134 (year (calendar-read
2135 "Hebrew calendar year (>3760): "
2136 '(lambda (x) (> x 3760))
2138 (extract-calendar-year
2139 (calendar-hebrew-from-absolute
2140 (calendar-absolute-from-gregorian today))))))
2141 (month-array (if (hebrew-calendar-leap-year-p year)
2142 calendar-hebrew-month-name-array-leap-year
2143 calendar-hebrew-month-name-array-common-year))
2144 (completion-ignore-case t)
2148 "Hebrew calendar month name: "
2149 (mapcar 'list (append month-array nil))
2155 (calendar-make-alist
2158 (calendar-absolute-from-hebrew
2160 (hebrew-calendar-last-day-of-month
2165 (calendar-make-alist month-array 1 'capitalize))))
2166 (last (hebrew-calendar-last-day-of-month month year))
2167 (first (if (and (= year 3761) (= month 10))
2170 (format "Hebrew calendar day (%d-%d): "
2172 '(lambda (x) (and (<= first x) (<= x last))))))
2173 (list (list month day year))))
2174 (calendar-goto-date (calendar-gregorian-from-absolute
2175 (calendar-absolute-from-hebrew date)))
2176 (or noecho (calendar-print-hebrew-date)))
2178 (defun calendar-goto-islamic-date (date &optional noecho)
2179 "Move cursor to Islamic DATE; echo Islamic date unless NOECHO is t."
2181 (let* ((today (calendar-current-date))
2182 (year (calendar-read
2183 "Islamic calendar year (>0): "
2184 '(lambda (x) (> x 0))
2186 (extract-calendar-year
2187 (calendar-islamic-from-absolute
2188 (calendar-absolute-from-gregorian today))))))
2189 (month-array calendar-islamic-month-name-array)
2190 (completion-ignore-case t)
2194 "Islamic calendar month name: "
2195 (mapcar 'list (append month-array nil))
2197 (calendar-make-alist month-array 1 'capitalize))))
2198 (last (islamic-calendar-last-day-of-month month year))
2200 (format "Islamic calendar day (1-%d): " last)
2201 '(lambda (x) (and (< 0 x) (<= x last))))))
2202 (list (list month day year))))
2203 (calendar-goto-date (calendar-gregorian-from-absolute
2204 (calendar-absolute-from-islamic date)))
2205 (or noecho (calendar-print-islamic-date)))
2207 (defun calendar-goto-iso-date (date &optional noecho)
2208 "Move cursor to ISO DATE; echo ISO date unless NOECHO is t."
2210 (let* ((today (calendar-current-date))
2211 (year (calendar-read
2212 "ISO calendar year (>0): "
2213 '(lambda (x) (> x 0))
2214 (int-to-string (extract-calendar-year today))))
2215 (no-weeks (extract-calendar-month
2216 (calendar-iso-from-absolute
2218 (calendar-dayname-on-or-before
2219 1 (calendar-absolute-from-gregorian
2220 (list 1 4 (1+ year))))))))
2221 (week (calendar-read
2222 (format "ISO calendar week (1-%d): " no-weeks)
2223 '(lambda (x) (and (> x 0) (<= x no-weeks)))))
2226 '(lambda (x) (and (<= 1 x) (<= x 7))))))
2227 (list (list week day year))))
2228 (calendar-goto-date (calendar-gregorian-from-absolute
2229 (calendar-absolute-from-iso date)))
2230 (or noecho (calendar-print-iso-date)))
2232 (defun calendar-interval (mon1 yr1 mon2 yr2)
2233 "The number of months difference between MON1, YR1 and MON2, YR2."
2234 (+ (* 12 (- yr2 yr1))
2237 (defun calendar-day-name (date)
2238 "Returns a string with the name of the day of the week of DATE."
2239 (aref calendar-day-name-array (calendar-day-of-week date)))
2241 (defvar calendar-day-name-array
2242 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"])
2244 (defvar calendar-month-name-array
2245 ["January" "February" "March" "April" "May" "June"
2246 "July" "August" "September" "October" "November" "December"])
2248 (defun calendar-make-alist (sequence &optional start-index filter)
2249 "Make an assoc list corresponding to SEQUENCE.
2250 Start at index 1, unless optional START-INDEX is provided.
2251 If FILTER is provided, apply it to each item in the list."
2252 (let ((index (if start-index (1- start-index) 0)))
2255 (setq index (1+ index))
2256 (cons (if filter (funcall filter x) x)
2258 (append sequence nil))))
2260 (defun calendar-month-name (month)
2261 "The name of MONTH."
2262 (aref calendar-month-name-array (1- month)))
2264 (defun calendar-day-of-week (date)
2265 "Returns the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc."
2266 (% (calendar-absolute-from-gregorian date) 7))
2268 (defun calendar-unmark ()
2269 "Delete all diary/holiday marks/highlighting from the calendar."
2271 (setq mark-holidays-in-calendar nil)
2272 (setq mark-diary-entries-in-calendar nil)
2275 (defun calendar-date-is-visible-p (date)
2276 "Returns t if DATE is legal and is visible in the calendar window."
2277 (let ((gap (calendar-interval
2278 displayed-month displayed-year
2279 (extract-calendar-month date) (extract-calendar-year date))))
2280 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2282 (defun calendar-date-is-legal-p (date)
2283 "Returns t if DATE is a legal date."
2284 (let ((month (extract-calendar-month date))
2285 (day (extract-calendar-day date))
2286 (year (extract-calendar-year date)))
2287 (and (<= 1 month) (<= month 12)
2288 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2291 (defun calendar-date-equal (date1 date2)
2292 "Returns t if the DATE1 and DATE2 are the same."
2294 (= (extract-calendar-month date1) (extract-calendar-month date2))
2295 (= (extract-calendar-day date1) (extract-calendar-day date2))
2296 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2298 (defun mark-visible-calendar-date (date &optional mark)
2299 "Mark DATE in the calendar window with MARK.
2300 MARK is either a single-character string or a face.
2301 MARK defaults to diary-entry-marker."
2302 (if (calendar-date-is-legal-p date)
2304 (set-buffer calendar-buffer)
2305 (calendar-cursor-to-visible-date date)
2306 (let ((mark (or mark diary-entry-marker)))
2308 (let ((buffer-read-only nil))
2314 (make-overlay (1-(point)) (1+ (point))) 'face mark))))))
2316 (defun calendar-star-date ()
2317 "Replace the date under the cursor in the calendar window with asterisks.
2318 This function can be used with the today-visible-calendar-hook run after the
2319 calendar window has been prepared."
2320 (let ((buffer-read-only nil))
2321 (make-variable-buffer-local 'calendar-starred-day)
2323 (setq calendar-starred-day
2325 (buffer-substring (point) (- (point) 2))))
2329 (set-buffer-modified-p nil)))
2331 (defun calendar-mark-today ()
2332 "Mark the date under the cursor in the calendar window.
2333 The date is marked with calendar-today-marker. This function can be used with
2334 the today-visible-calendar-hook run after the calendar window has been
2336 (mark-visible-calendar-date
2337 (calendar-cursor-to-date)
2338 calendar-today-marker))
2340 (defun calendar-date-compare (date1 date2)
2341 "Returns t if DATE1 is before DATE2, nil otherwise.
2342 The actual dates are in the car of DATE1 and DATE2."
2343 (< (calendar-absolute-from-gregorian (car date1))
2344 (calendar-absolute-from-gregorian (car date2))))
2346 (defun calendar-date-string (date &optional abbreviate nodayname)
2347 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2348 An optional parameter ABBREVIATE, when t, causes the month and day names to be
2349 abbreviated to three characters. An optional parameter NODAYNAME, when t,
2350 omits the name of the day of the week."
2355 (substring (calendar-day-name date) 0 3)
2356 (calendar-day-name date))))
2357 (month (extract-calendar-month date))
2361 (calendar-month-name month) 0 3)
2362 (calendar-month-name month)))
2363 (day (int-to-string (extract-calendar-day date)))
2364 (month (int-to-string month))
2365 (year (int-to-string (extract-calendar-year date))))
2366 (mapconcat 'eval calendar-date-display-form "")))
2368 (defun calendar-dayname-on-or-before (dayname date)
2369 "Returns the absolute date of the DAYNAME on or before absolute DATE.
2370 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
2372 Note: Applying this function to d+6 gives us the DAYNAME on or after an
2373 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
2374 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
2375 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
2376 (- date (% (- date dayname) 7)))
2378 (defun calendar-nth-named-absday (n dayname month year &optional day)
2379 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2380 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2381 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2382 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2384 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2387 (calendar-dayname-on-or-before
2389 (+ 6 (calendar-absolute-from-gregorian
2390 (list month (or day 1) year)))))
2392 (calendar-dayname-on-or-before
2394 (calendar-absolute-from-gregorian
2396 (or day (calendar-last-day-of-month month year))
2399 (defun calendar-nth-named-day (n dayname month year &optional day)
2400 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2401 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2402 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2403 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2405 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2406 (calendar-gregorian-from-absolute
2407 (calendar-nth-named-absday n dayname month year day)))
2409 (defun calendar-day-of-year-string (&optional date)
2410 "String of day number of year of Gregorian DATE.
2411 Defaults to today's date if DATE is not given."
2412 (let* ((d (or date (calendar-current-date)))
2413 (year (extract-calendar-year d))
2414 (day (calendar-day-number d))
2415 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
2416 (format "Day %d of %d; %d day%s remaining in the year"
2417 day year days-remaining (if (= days-remaining 1) "" "s"))))
2419 (defun calendar-print-day-of-year ()
2420 "Show day number in year/days remaining in year for date under the cursor."
2422 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
2424 (defun calendar-absolute-from-iso (date)
2425 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
2426 The `ISO year' corresponds approximately to the Gregorian year, but
2427 weeks start on Monday and end on Sunday. The first week of the ISO year is
2428 the first such week in which at least 4 days are in a year. The ISO
2429 commercial DATE has the form (week day year) in which week is in the range
2430 1..52 and day is in the range 0..6 (1 = Monday, 2 = Tuesday, ..., 0 =
2431 Sunday). The Gregorian date Sunday, December 31, 1 BC is imaginary."
2432 (let* ((week (extract-calendar-month date))
2433 (day (extract-calendar-day date))
2434 (year (extract-calendar-year date)))
2435 (+ (calendar-dayname-on-or-before
2436 1 (+ 3 (calendar-absolute-from-gregorian (list 1 1 year))))
2438 (if (= day 0) 6 (1- day)))))
2440 (defun calendar-iso-from-absolute (date)
2441 "Compute the `ISO commercial date' corresponding to the absolute DATE.
2442 The ISO year corresponds approximately to the Gregorian year, but weeks
2443 start on Monday and end on Sunday. The first week of the ISO year is the
2444 first such week in which at least 4 days are in a year. The ISO commercial
2445 date has the form (week day year) in which week is in the range 1..52 and
2446 day is in the range 0..6 (1 = Monday, 2 = Tuesday, ..., 0 = Sunday). The
2447 absolute date is the number of days elapsed since the (imaginary) Gregorian
2448 date Sunday, December 31, 1 BC."
2449 (let* ((approx (extract-calendar-year
2450 (calendar-gregorian-from-absolute (- date 3))))
2452 (calendar-sum y approx
2453 (>= date (calendar-absolute-from-iso (list 1 1 (1+ y))))
2456 (1+ (/ (- date (calendar-absolute-from-iso (list 1 1 year))) 7))
2460 (defun calendar-iso-date-string (&optional date)
2461 "String of ISO date of Gregorian DATE.
2462 Defaults to today's date if DATE is not given."
2463 (let* ((d (calendar-absolute-from-gregorian
2464 (or date (calendar-current-date))))
2466 (iso-date (calendar-iso-from-absolute d)))
2467 (format "Day %s of week %d of %d"
2468 (if (zerop day) 7 day)
2469 (extract-calendar-month iso-date)
2470 (extract-calendar-year iso-date))))
2472 (defun calendar-print-iso-date ()
2473 "Show equivalent ISO date for the date under the cursor."
2475 (message "ISO date: %s"
2476 (calendar-iso-date-string (calendar-cursor-to-date t))))
2478 (defun calendar-julian-from-absolute (date)
2479 "Compute the Julian (month day year) corresponding to the absolute DATE.
2480 The absolute date is the number of days elapsed since the (imaginary)
2481 Gregorian date Sunday, December 31, 1 BC."
2482 (let* ((approx (/ (+ date 2) 366));; Approximation from below.
2483 (year ;; Search forward from the approximation.
2485 (calendar-sum y approx
2486 (>= date (calendar-absolute-from-julian (list 1 1 (1+ y))))
2488 (month ;; Search forward from January.
2489 (1+ (calendar-sum m 1
2491 (calendar-absolute-from-julian
2493 (if (and (= m 2) (= (% year 4) 0))
2495 (aref [31 28 31 30 31 30 31 31 30 31 30 31]
2499 (day ;; Calculate the day by subtraction.
2500 (- date (1- (calendar-absolute-from-julian (list month 1 year))))))
2501 (list month day year)))
2503 (defun calendar-absolute-from-julian (date)
2504 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
2505 The Gregorian date Sunday, December 31, 1 BC is imaginary."
2506 (let ((month (extract-calendar-month date))
2507 (day (extract-calendar-day date))
2508 (year (extract-calendar-year date)))
2509 (+ (calendar-day-number date)
2510 (if (and (= (% year 100) 0)
2513 1 0);; Correct for Julian but not Gregorian leap year.
2518 (defun calendar-julian-date-string (&optional date)
2519 "String of Julian date of Gregorian DATE.
2520 Defaults to today's date if DATE is not given.
2521 Driven by the variable `calendar-date-display-form'."
2522 (calendar-date-string
2523 (calendar-julian-from-absolute
2524 (calendar-absolute-from-gregorian
2525 (or date (calendar-current-date))))
2528 (defun calendar-print-julian-date ()
2529 "Show the Julian calendar equivalent of the date under the cursor."
2531 (message "Julian date: %s"
2532 (calendar-julian-date-string (calendar-cursor-to-date t))))
2534 (defun islamic-calendar-leap-year-p (year)
2535 "Returns t if YEAR is a leap year on the Islamic calendar."
2537 (list 2 5 7 10 13 16 18 21 24 26 29)))
2539 (defun islamic-calendar-last-day-of-month (month year)
2540 "The last day in MONTH during YEAR on the Islamic calendar."
2542 ((memq month (list 1 3 5 7 9 11)) 30)
2543 ((memq month (list 2 4 6 8 10)) 29)
2544 (t (if (islamic-calendar-leap-year-p year) 30 29))))
2546 (defun islamic-calendar-day-number (date)
2547 "Return the day number within the year of the Islamic date DATE."
2548 (let* ((month (extract-calendar-month date))
2549 (day (extract-calendar-day date)))
2550 (+ (* 30 (/ month 2))
2551 (* 29 (/ (1- month) 2))
2554 (defun calendar-absolute-from-islamic (date)
2555 "Absolute date of Islamic DATE.
2556 The absolute date is the number of days elapsed since the (imaginary)
2557 Gregorian date Sunday, December 31, 1 BC."
2558 (let* ((month (extract-calendar-month date))
2559 (day (extract-calendar-day date))
2560 (year (extract-calendar-year date))
2562 (leap-years-in-cycle
2564 ((< y 3) 0) ((< y 6) 1) ((< y 8) 2) ((< y 11) 3) ((< y 14) 4)
2565 ((< y 17) 5) ((< y 19) 6) ((< y 22) 7) ((< y 25) 8) ((< y 27) 9)
2567 (+ (islamic-calendar-day-number date);; days so far this year
2568 (* (1- year) 354) ;; days in all non-leap years
2569 (* 11 (/ year 30)) ;; leap days in complete cycles
2570 leap-years-in-cycle ;; leap days this cycle
2571 227014))) ;; days before start of calendar
2573 (defun calendar-islamic-from-absolute (date)
2574 "Compute the Islamic date (month day year) corresponding to absolute DATE.
2575 The absolute date is the number of days elapsed since the (imaginary)
2576 Gregorian date Sunday, December 31, 1 BC."
2578 (list 0 0 0);; pre-Islamic date
2579 (let* ((approx (/ (- date 227014) 355));; Approximation from below.
2580 (year ;; Search forward from the approximation.
2582 (calendar-sum y approx
2583 (>= date (calendar-absolute-from-islamic
2586 (month ;; Search forward from Muharram.
2587 (1+ (calendar-sum m 1
2589 (calendar-absolute-from-islamic
2591 (islamic-calendar-last-day-of-month
2595 (day ;; Calculate the day by subtraction.
2597 (1- (calendar-absolute-from-islamic (list month 1 year))))))
2598 (list month day year))))
2600 (defvar calendar-islamic-month-name-array
2601 ["Muharram" "Safar" "Rabi I" "Rabi II" "Jumada I" "Jumada II"
2602 "Rajab" "Sha'ban" "Ramadan" "Shawwal" "Dhu al-Qada" "Dhu al-Hijjah"])
2604 (defun calendar-islamic-date-string (&optional date)
2605 "String of Islamic date before sunset of Gregorian DATE.
2606 Returns the empty string if DATE is pre-Islamic.
2607 Defaults to today's date if DATE is not given.
2608 Driven by the variable `calendar-date-display-form'."
2609 (let ((calendar-month-name-array calendar-islamic-month-name-array)
2610 (islamic-date (calendar-islamic-from-absolute
2611 (calendar-absolute-from-gregorian
2612 (or date (calendar-current-date))))))
2613 (if (< (extract-calendar-year islamic-date) 1)
2615 (calendar-date-string islamic-date nil t))))
2617 (defun calendar-print-islamic-date ()
2618 "Show the Islamic calendar equivalent of the date under the cursor."
2620 (let ((i (calendar-islamic-date-string (calendar-cursor-to-date t))))
2621 (if (string-equal i "")
2622 (message "Date is pre-Islamic")
2623 (message "Islamic date (until sunset): %s" i))))
2625 (defun calendar-hebrew-from-absolute (date)
2626 "Compute the Hebrew date (month day year) corresponding to absolute DATE.
2627 The absolute date is the number of days elapsed since the (imaginary)
2628 Gregorian date Sunday, December 31, 1 BC."
2629 (let* ((greg-date (calendar-gregorian-from-absolute date))
2630 (month (aref [9 10 11 12 1 2 3 4 7 7 7 8]
2631 (1- (extract-calendar-month greg-date))))
2633 (year (+ 3760 (extract-calendar-year greg-date))))
2634 (while (>= date (calendar-absolute-from-hebrew (list 7 1 (1+ year))))
2635 (setq year (1+ year)))
2636 (let ((length (hebrew-calendar-last-month-of-year year)))
2638 (calendar-absolute-from-hebrew
2640 (hebrew-calendar-last-day-of-month month year)
2642 (setq month (1+ (% month length)))))
2644 (- date (calendar-absolute-from-hebrew (list month 1 year)))))
2645 (list month day year)))
2647 (defun hebrew-calendar-leap-year-p (year)
2648 "t if YEAR is a Hebrew calendar leap year."
2649 (< (% (1+ (* 7 year)) 19) 7))
2651 (defun hebrew-calendar-last-month-of-year (year)
2652 "The last month of the Hebrew calendar YEAR."
2653 (if (hebrew-calendar-leap-year-p year)
2657 (defun hebrew-calendar-last-day-of-month (month year)
2658 "The last day of MONTH in YEAR."
2659 (if (or (memq month (list 2 4 6 10 13))
2660 (and (= month 12) (not (hebrew-calendar-leap-year-p year)))
2661 (and (= month 8) (not (hebrew-calendar-long-heshvan-p year)))
2662 (and (= month 9) (hebrew-calendar-short-kislev-p year)))
2666 (defun hebrew-calendar-elapsed-days (year)
2667 "Days from Sun. prior to start of Hebrew calendar to mean conjunction of Tishri of Hebrew YEAR."
2668 (let* ((months-elapsed
2669 (+ (* 235 (/ (1- year) 19));; Months in complete cycles so far.
2670 (* 12 (% (1- year) 19)) ;; Regular months in this cycle
2671 (/ (1+ (* 7 (% (1- year) 19))) 19)));; Leap months this cycle
2672 (parts-elapsed (+ 204 (* 793 (% months-elapsed 1080))))
2674 (* 12 months-elapsed)
2675 (* 793 (/ months-elapsed 1080))
2676 (/ parts-elapsed 1080)))
2677 (parts ;; Conjunction parts
2678 (+ (* 1080 (% hours-elapsed 24)) (% parts-elapsed 1080)))
2679 (day ;; Conjunction day
2680 (+ 1 (* 29 months-elapsed) (/ hours-elapsed 24)))
2682 (if (or (>= parts 19440) ;; If the new moon is at or after midday,
2683 (and (= (% day 7) 2);; ...or is on a Tuesday...
2684 (>= parts 9924) ;; at 9 hours, 204 parts or later...
2685 (not (hebrew-calendar-leap-year-p year)));; of a
2687 (and (= (% day 7) 1);; ...or is on a Monday...
2688 (>= parts 16789) ;; at 15 hours, 589 parts or later...
2689 (hebrew-calendar-leap-year-p (1- year))));; at the end
2691 ;; Then postpone Rosh HaShanah one day
2695 (if ;; If Rosh HaShanah would occur on Sunday, Wednesday, or Friday
2696 (memq (% alternative-day 7) (list 0 3 5))
2697 ;; Then postpone it one (more) day and return
2698 (1+ alternative-day)
2702 (defun hebrew-calendar-days-in-year (year)
2703 "Number of days in Hebrew YEAR."
2704 (- (hebrew-calendar-elapsed-days (1+ year))
2705 (hebrew-calendar-elapsed-days year)))
2707 (defun hebrew-calendar-long-heshvan-p (year)
2708 "t if Heshvan is long in Hebrew YEAR."
2709 (= (% (hebrew-calendar-days-in-year year) 10) 5))
2711 (defun hebrew-calendar-short-kislev-p (year)
2712 "t if Kislev is short in Hebrew YEAR."
2713 (= (% (hebrew-calendar-days-in-year year) 10) 3))
2715 (defun calendar-absolute-from-hebrew (date)
2716 "Absolute date of Hebrew DATE.
2717 The absolute date is the number of days elapsed since the (imaginary)
2718 Gregorian date Sunday, December 31, 1 BC."
2719 (let* ((month (extract-calendar-month date))
2720 (day (extract-calendar-day date))
2721 (year (extract-calendar-year date)))
2722 (+ day ;; Days so far this month.
2723 (if (< month 7);; before Tishri
2724 ;; Then add days in prior months this year before and after Nisan
2726 m 7 (<= m (hebrew-calendar-last-month-of-year year))
2727 (hebrew-calendar-last-day-of-month m year))
2730 (hebrew-calendar-last-day-of-month m year)))
2731 ;; Else add days in prior months this year
2734 (hebrew-calendar-last-day-of-month m year)))
2735 (hebrew-calendar-elapsed-days year);; Days in prior years.
2736 -1373429))) ;; Days elapsed before absolute date 1.
2738 (defvar calendar-hebrew-month-name-array-common-year
2739 ["Nisan" "Iyar" "Sivan" "Tammuz" "Av" "Elul" "Tishri"
2740 "Heshvan" "Kislev" "Teveth" "Shevat" "Adar"])
2742 (defvar calendar-hebrew-month-name-array-leap-year
2743 ["Nisan" "Iyar" "Sivan" "Tammuz" "Av" "Elul" "Tishri"
2744 "Heshvan" "Kislev" "Teveth" "Shevat" "Adar I" "Adar II"])
2746 (defun calendar-hebrew-date-string (&optional date)
2747 "String of Hebrew date before sunset of Gregorian DATE.
2748 Defaults to today's date if DATE is not given.
2749 Driven by the variable `calendar-date-display-form'."
2750 (let* ((hebrew-date (calendar-hebrew-from-absolute
2751 (calendar-absolute-from-gregorian
2752 (or date (calendar-current-date)))))
2753 (calendar-month-name-array
2754 (if (hebrew-calendar-leap-year-p (extract-calendar-year hebrew-date))
2755 calendar-hebrew-month-name-array-leap-year
2756 calendar-hebrew-month-name-array-common-year)))
2757 (calendar-date-string hebrew-date nil t)))
2759 (defun calendar-print-hebrew-date ()
2760 "Show the Hebrew calendar equivalent of the date under the cursor."
2762 (message "Hebrew date (until sunset): %s"
2763 (calendar-hebrew-date-string (calendar-cursor-to-date t))))
2765 (defun hebrew-calendar-yahrzeit (death-date year)
2766 "Absolute date of the anniversary of Hebrew DEATH-DATE in Hebrew YEAR."
2767 (let* ((death-day (extract-calendar-day death-date))
2768 (death-month (extract-calendar-month death-date))
2769 (death-year (extract-calendar-year death-date)))
2771 ;; If it's Heshvan 30 it depends on the first anniversary; if
2772 ;; that was not Heshvan 30, use the day before Kislev 1.
2773 ((and (= death-month 8)
2775 (not (hebrew-calendar-long-heshvan-p (1+ death-year))))
2776 (1- (calendar-absolute-from-hebrew (list 9 1 year))))
2777 ;; If it's Kislev 30 it depends on the first anniversary; if
2778 ;; that was not Kislev 30, use the day before Teveth 1.
2779 ((and (= death-month 9)
2781 (hebrew-calendar-short-kislev-p (1+ death-year)))
2782 (1- (calendar-absolute-from-hebrew (list 10 1 year))))
2783 ;; If it's Adar II, use the same day in last month of
2784 ;; year (Adar or Adar II).
2786 (calendar-absolute-from-hebrew
2787 (list (hebrew-calendar-last-month-of-year year) death-day year)))
2788 ;; If it's the 30th in Adar I and year is not a leap year
2789 ;; (so Adar has only 29 days), use the last day in Shevat.
2790 ((and (= death-day 30)
2792 (not (hebrew-calendar-leap-year-p year)))
2793 (calendar-absolute-from-hebrew (list 11 30 year)))
2794 ;; In all other cases, use the normal anniversary of the date of death.
2795 (t (calendar-absolute-from-hebrew
2796 (list death-month death-day year))))))
2798 (defun calendar-set-mode-line (str)
2799 "Set mode line to STR, centered, surrounded by dashes."
2800 (setq mode-line-format
2801 (calendar-string-spread (list "" str "") ?- (frame-width))))
2804 (defun list-yahrzeit-dates (death-date start-year end-year)
2805 "List Yahrzeit dates for *Gregorian* DEATH-DATE from START-YEAR to END-YEAR.
2806 When called interactively from the calendar window, the date of death is taken
2807 from the cursor position."
2810 (if (equal (current-buffer) (get-buffer calendar-buffer))
2811 (calendar-cursor-to-date)
2812 (let* ((today (calendar-current-date))
2813 (year (calendar-read
2814 "Year of death (>0): "
2815 '(lambda (x) (> x 0))
2816 (int-to-string (extract-calendar-year today))))
2817 (month-array calendar-month-name-array)
2818 (completion-ignore-case t)
2822 "Month of death (name): "
2823 (mapcar 'list (append month-array nil))
2825 (calendar-make-alist
2826 month-array 1 'capitalize))))
2827 (last (calendar-last-day-of-month month year))
2829 (format "Day of death (1-%d): " last)
2830 '(lambda (x) (and (< 0 x) (<= x last))))))
2831 (list month day year))))
2832 (death-year (extract-calendar-year death-date))
2833 (start-year (calendar-read
2834 (format "Starting year of Yahrzeit table (>%d): "
2836 '(lambda (x) (> x death-year))
2837 (int-to-string (1+ death-year))))
2838 (end-year (calendar-read
2839 (format "Ending year of Yahrzeit table (>=%d): "
2841 '(lambda (x) (>= x start-year)))))
2842 (list death-date start-year end-year)))
2843 (message "Computing yahrzeits...")
2844 (let* ((yahrzeit-buffer "*Yahrzeits*")
2845 (h-date (calendar-hebrew-from-absolute
2846 (calendar-absolute-from-gregorian death-date)))
2847 (h-month (extract-calendar-month h-date))
2848 (h-day (extract-calendar-day h-date))
2849 (h-year (extract-calendar-year h-date)))
2850 (set-buffer (get-buffer-create yahrzeit-buffer))
2851 (setq buffer-read-only nil)
2852 (calendar-set-mode-line
2853 (format "Yahrzeit dates for %s = %s"
2854 (calendar-date-string death-date)
2855 (let ((calendar-month-name-array
2856 (if (hebrew-calendar-leap-year-p h-year)
2857 calendar-hebrew-month-name-array-leap-year
2858 calendar-hebrew-month-name-array-common-year)))
2859 (calendar-date-string h-date nil t))))
2861 (goto-char (point-min))
2862 (calendar-for-loop i from start-year to end-year do
2864 (calendar-date-string
2865 (calendar-gregorian-from-absolute
2866 (hebrew-calendar-yahrzeit
2868 (extract-calendar-year
2869 (calendar-hebrew-from-absolute
2870 (calendar-absolute-from-gregorian (list 1 1 i))))))) "\n"))
2871 (goto-char (point-min))
2872 (set-buffer-modified-p nil)
2873 (setq buffer-read-only t)
2874 (display-buffer yahrzeit-buffer)
2875 (message "Computing yahrzeits...done")))
2877 (defun calendar-astro-date-string (&optional date)
2878 "String of astronomical (Julian) day number of afternoon of Gregorian DATE.
2879 Defaults to today's date if DATE is not given."
2881 (+ 1721425 (calendar-absolute-from-gregorian
2882 (or date (calendar-current-date))))))
2884 (defun calendar-print-astro-day-number ()
2885 "Show astronomical (Julian) day number of afternoon on date shown by cursor."
2888 "Astronomical (Julian) day number after noon UTC: %s"
2889 (calendar-astro-date-string (calendar-cursor-to-date t))))
2891 (defun calendar-goto-astro-day-number (daynumber &optional noecho)
2892 "Move cursor to astronomical (Julian) DAYNUMBER.
2893 Echo astronomical (Julian) day number unless NOECHO is t."
2894 (interactive (list (calendar-read
2895 "Astronomical (Julian) day number (>1721425): "
2896 '(lambda (x) (> x 1721425)))))
2897 (calendar-goto-date (calendar-gregorian-from-absolute (- daynumber 1721425)))
2898 (or noecho (calendar-print-astro-day-number)))
2900 (run-hooks 'calendar-load-hook)
2904 ;;; calendar.el ends here