Many doc fixes.
[emacs.git] / lisp / calendar / calendar.el
blob733c37c8b6d454ca7ada34d7567c8dc92c03dfb2
1 ;;; calendar.el --- Calendar functions.
3 ;;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994 Free Software
4 ;;; Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Keywords: calendar
8 ;; Human-Keywords: calendar, Gregorian calendar, Julian calendar,
9 ;; Hebrew calendar, Islamic calendar, ISO calendar, Julian day number,
10 ;; diary, holidays
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)
17 ;; any later version.
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.
28 ;;; Commentary:
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
50 ;; is available.
52 ;; The following files are part of the calendar/diary code:
54 ;; cal-menu.el Menu support
55 ;; diary.el, diary-ins.el Diary functions
56 ;; holidays.el Holiday functions
57 ;; cal-french.el French Revolutionary calendar
58 ;; cal-mayan.el Mayan calendars
59 ;; cal-dst.el Daylight savings time rules
60 ;; solar.el Sunrise/sunset, equinoxes/solstices
61 ;; lunar.el Phases of the moon
62 ;; appt.el Appointment notification
64 ;; Comments, corrections, and improvements should be sent to
65 ;; Edward M. Reingold Department of Computer Science
66 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
67 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
68 ;; Urbana, Illinois 61801
70 ;; GNU Emacs users too numerous to list pointed out a variety of problems
71 ;; with earlier forms of the `infinite' sliding calendar and suggested some
72 ;; of the features included in this package. Especially significant in this
73 ;; regard was the suggestion of mark-diary-entries and view-diary-entries,
74 ;; together ideas for their implementation, by
75 ;; Michael S. Littman Cognitive Science Research Group
76 ;; (201) 829-5155 Bell Communications Research
77 ;; mlittman@wind.bellcore.com 445 South St. Box 1961 (2L-331)
78 ;; Morristown, NJ 07960
80 ;; The algorithms for the Hebrew calendar are those of the Rambam (Rabbi Moses
81 ;; Maimonides), from his Mishneh Torah, as implemented by
82 ;; Nachum Dershowitz Department of Computer Science
83 ;; (217) 333-4219 University of Illinois at Urbana-Champaign
84 ;; nachum@cs.uiuc.edu 1304 West Springfield Avenue
85 ;; Urbana, Illinois 61801
87 ;; Technical details of all the calendrical calculations can be found in
89 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
90 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
91 ;; pages 899-928. ``Calendrical Calculations, Part II: Three Historical
92 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
93 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
94 ;; pages 383-404.
96 ;; Hard copies of these two papers can be obtained by sending email to
97 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
98 ;; the message BODY containing your mailing address (snail).
100 ;;; Code:
102 (defun calendar-version ()
103 (interactive)
104 (message "Version 5.3, January 25, 1994"))
106 ;;;###autoload
107 (defvar calendar-week-start-day 0
108 "*The day of the week on which a week in the calendar begins.
109 0 means Sunday (default), 1 means Monday, and so on.")
111 ;;;###autoload
112 (defvar view-diary-entries-initially nil
113 "*Non-nil means display current date's diary entries on entry.
114 The diary is displayed in another window when the calendar is first displayed,
115 if the current date is visible. The number of days of diary entries displayed
116 is governed by the variable `number-of-diary-entries'.")
118 ;;;###autoload
119 (defvar number-of-diary-entries 1
120 "*Specifies how many days of diary entries are to be displayed initially.
121 This variable affects the diary display when the command M-x diary is used,
122 or if the value of the variable `view-diary-entries-initially' is t. For
123 example, if the default value 1 is used, then only the current day's diary
124 entries will be displayed. If the value 2 is used, then both the current
125 day's and the next day's entries will be displayed.
127 The value can also be a vector such as [0 2 2 2 2 4 1]; this value
128 says to display no diary entries on Sunday, the display the entries
129 for the current date and the day after on Monday through Thursday,
130 display Friday through Monday's entries on Friday, and display only
131 Saturday's entries on Saturday.
133 This variable does not affect the diary display with the `d' command
134 from the calendar; in that case, the prefix argument controls the
135 number of days of diary entries displayed.")
137 ;;;###autoload
138 (defvar mark-diary-entries-in-calendar nil
139 "*Non-nil means mark dates with diary entries, in the calendar window.
140 The marking symbol is specified by the variable `diary-entry-marker'.")
142 (defvar diary-entry-marker
143 (if (not window-system)
145 (require 'faces)
146 (make-face 'diary-face)
147 (if (x-display-color-p)
148 (set-face-foreground 'diary-face "red")
149 (copy-face 'bold 'diary-face))
150 'diary-face)
151 "*Used to mark dates that have diary entries.
152 Can be either a single-character string or a face.")
154 (defvar calendar-today-marker
155 (if (not window-system)
157 (require 'faces)
158 (make-face 'calendar-today-face)
159 (set-face-underline-p 'calendar-today-face t)
160 'calendar-today-face)
161 "*Used to mark today's date.
162 Can be either a single-character string or a face.")
164 (defvar calendar-holiday-marker
165 (if (not window-system)
167 (require 'faces)
168 (make-face 'holiday-face)
169 (if (x-display-color-p)
170 (set-face-background 'holiday-face "pink")
171 (set-face-background 'holiday-face "black")
172 (set-face-foreground 'holiday-face "white"))
173 'holiday-face)
174 "*Used to mark notable dates in the calendar.
175 Can be either a single-character string or a face.")
177 ;;;###autoload
178 (defvar view-calendar-holidays-initially nil
179 "*Non-nil means display holidays for current three month period on entry.
180 The holidays are displayed in another window when the calendar is first
181 displayed.")
183 ;;;###autoload
184 (defvar mark-holidays-in-calendar nil
185 "*Non-nil means mark dates of holidays in the calendar window.
186 The marking symbol is specified by the variable `calendar-holiday-marker'.")
188 ;;;###autoload
189 (defvar all-hebrew-calendar-holidays nil
190 "*If nil, show only major holidays from the Hebrew calendar.
191 This means only those Jewish holidays that appear on secular calendars.
193 If t, show all the holidays that would appear in a complete Hebrew calendar.")
195 ;;;###autoload
196 (defvar all-christian-calendar-holidays nil
197 "*If nil, show only major holidays from the Christian calendar.
198 This means only those Christian holidays that appear on secular calendars.
200 If t, show all the holidays that would appear in a complete Christian
201 calendar.")
203 ;;;###autoload
204 (defvar all-islamic-calendar-holidays nil
205 "*If nil, show only major holidays from the Islamic calendar.
206 This means only those Islamic holidays that appear on secular calendars.
208 If t, show all the holidays that would appear in a complete Islamic
209 calendar.")
211 ;;;###autoload
212 (defvar calendar-load-hook nil
213 "*List of functions to be called after the calendar is first loaded.
214 This is the place to add key bindings to `calendar-mode-map'.")
216 ;;;###autoload
217 (defvar initial-calendar-window-hook nil
218 "*List of functions to be called when the calendar window is first opened.
219 The functions invoked are called after the calendar window is opened, but
220 once opened is never called again. Leaving the calendar with the `q' command
221 and reentering it will cause these functions to be called again.")
223 ;;;###autoload
224 (defvar today-visible-calendar-hook nil
225 "*List of functions called whenever the current date is visible.
226 This can be used, for example, to replace today's date with asterisks; a
227 function `calendar-star-date' is included for this purpose:
228 (setq today-visible-calendar-hook 'calendar-star-date)
229 It can also be used to mark the current date with calendar-today-marker;
230 a function is also provided for this:
231 (setq today-visible-calendar-hook 'calendar-mark-today)
233 The corresponding variable `today-invisible-calendar-hook' is the list of
234 functions called when the calendar function was called when the current
235 date is not visible in the window.
237 Other than the use of the provided functions, the changing of any
238 characters in the calendar buffer by the hooks may cause the failure of the
239 functions that move by days and weeks.")
241 ;;;###autoload
242 (defvar today-invisible-calendar-hook nil
243 "*List of functions called whenever the current date is not visible.
245 The corresponding variable `today-visible-calendar-hook' is the list of
246 functions called when the calendar function was called when the current
247 date is visible in the window.
249 Other than the use of the provided functions, the changing of any
250 characters in the calendar buffer by the hooks may cause the failure of the
251 functions that move by days and weeks.")
253 ;;;###autoload
254 (defvar diary-file "~/diary"
255 "*Name of the file in which one's personal diary of dates is kept.
257 The file's entries are lines in any of the forms
259 MONTH/DAY
260 MONTH/DAY/YEAR
261 MONTHNAME DAY
262 MONTHNAME DAY, YEAR
263 DAYNAME
265 at the beginning of the line; the remainder of the line is the diary entry
266 string for that date. MONTH and DAY are one or two digit numbers, YEAR is
267 a number and may be written in full or abbreviated to the final two digits.
268 If the date does not contain a year, it is generic and applies to any year.
269 DAYNAME entries apply to any date on which is on that day of the week.
270 MONTHNAME and DAYNAME can be spelled in full, abbreviated to three
271 characters (with or without a period), capitalized or not. Any of DAY,
272 MONTH, or MONTHNAME, YEAR can be `*' which matches any day, month, or year,
273 respectively.
275 The European style (in which the day precedes the month) can be used
276 instead, if you execute `european-calendar' when in the calendar, or set
277 `european-calendar-style' to t in your .emacs file. The European forms are
279 DAY/MONTH
280 DAY/MONTH/YEAR
281 DAY MONTHNAME
282 DAY MONTHNAME YEAR
283 DAYNAME
285 To revert to the default American style from the European style, execute
286 `american-calendar' in the calendar.
288 A diary entry can be preceded by a diary-nonmarking-symbol (ordinarily `&')
289 to make that entry nonmarking--that is, it will not be marked on dates in
290 the calendar window but will appear in a diary window.
292 Multiline diary entries are made by indenting lines after the first with
293 either a TAB or one or more spaces.
295 Lines not in one the above formats are ignored. Here are some sample diary
296 entries (in the default American style):
298 12/22/1988 Twentieth wedding anniversary!!
299 &1/1. Happy New Year!
300 10/22 Ruth's birthday.
301 21: Payday
302 Tuesday--weekly meeting with grad students at 10am
303 Supowit, Shen, Bitner, and Kapoor to attend.
304 1/13/89 Friday the thirteenth!!
305 &thu 4pm squash game with Lloyd.
306 mar 16 Dad's birthday
307 April 15, 1989 Income tax due.
308 &* 15 time cards due.
310 If the first line of a diary entry consists only of the date or day name with
311 no trailing blanks or punctuation, then that line is not displayed in the
312 diary window; only the continuation lines is shown. For example, the
313 single diary entry
315 02/11/1989
316 Bill Blattner visits Princeton today
317 2pm Cognitive Studies Committee meeting
318 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
319 4:00pm Jamie Tappenden
320 7:30pm Dinner at George and Ed's for Alan Ryan
321 7:30-10:00pm dance at Stewart Country Day School
323 will appear in the diary window without the date line at the beginning. This
324 facility allows the diary window to look neater, but can cause confusion if
325 used with more than one day's entries displayed.
327 Diary entries can be based on Lisp sexps. For example, the diary entry
329 %%(diary-block 11 1 1990 11 10 1990) Vacation
331 causes the diary entry \"Vacation\" to appear from November 1 through November
332 10, 1990. Other functions available are `diary-float', `diary-anniversary',
333 `diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date',
334 `diary-hebrew-date', `diary-islamic-date', `diary-mayan-date',
335 `diary-yahrzeit', `diary-sunrise-sunset', `diary-phases-of-moon',
336 `diary-parasha', `diary-omer', `diary-rosh-hodesh', and
337 `diary-sabbath-candles'. See the documentation for the function
338 `list-sexp-diary-entries' for more details.
340 Diary entries based on the Hebrew and/or the Islamic calendar are also
341 possible, but because these are somewhat slow, they are ignored
342 unless you set the `nongregorian-diary-listing-hook' and the
343 `nongregorian-diary-marking-hook' appropriately. See the documentation
344 for these functions for details.
346 Diary files can contain directives to include the contents of other files; for
347 details, see the documentation for the variable `list-diary-entries-hook'.")
349 ;;;###autoload
350 (defvar diary-nonmarking-symbol "&"
351 "*Symbol indicating that a diary entry is not to be marked in the calendar.")
353 ;;;###autoload
354 (defvar hebrew-diary-entry-symbol "H"
355 "*Symbol indicating a diary entry according to the Hebrew calendar.")
357 ;;;###autoload
358 (defvar islamic-diary-entry-symbol "I"
359 "*Symbol indicating a diary entry according to the Islamic calendar.")
361 ;;;###autoload
362 (defvar diary-include-string "#include"
363 "*The string indicating inclusion of another file of diary entries.
364 See the documentation for the function `include-other-diary-files'.")
366 ;;;###autoload
367 (defvar sexp-diary-entry-symbol "%%"
368 "*The string used to indicate a sexp diary entry in diary-file.
369 See the documentation for the function `list-sexp-diary-entries'.")
371 ;;;###autoload
372 (defvar abbreviated-calendar-year t
373 "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
374 For the Gregorian calendar; similarly for the Hebrew and Islamic calendars.
375 If this variable is nil, years must be written in full.")
377 ;;;###autoload
378 (defvar european-calendar-style nil
379 "*Use the European style of dates in the diary and in any displays.
380 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
381 1990. The accepted European date styles are
383 DAY/MONTH
384 DAY/MONTH/YEAR
385 DAY MONTHNAME
386 DAY MONTHNAME YEAR
387 DAYNAME
389 Names can be capitalized or not, written in full, or abbreviated to three
390 characters with or without a period.")
392 ;;;###autoload
393 (defvar american-date-diary-pattern
394 '((month "/" day "[^/0-9]")
395 (month "/" day "/" year "[^0-9]")
396 (monthname " *" day "[^,0-9]")
397 (monthname " *" day ", *" year "[^0-9]")
398 (dayname "\\W"))
399 "*List of pseudo-patterns describing the American patterns of date used.
400 See the documentation of diary-date-forms for an explanation.")
402 ;;;###autoload
403 (defvar european-date-diary-pattern
404 '((day "/" month "[^/0-9]")
405 (day "/" month "/" year "[^0-9]")
406 (backup day " *" monthname "\\W+\\<[^*0-9]")
407 (day " *" monthname " *" year "[^0-9]")
408 (dayname "\\W"))
409 "*List of pseudo-patterns describing the European patterns of date used.
410 See the documentation of diary-date-forms for an explanation.")
412 (defvar diary-date-forms
413 (if european-calendar-style
414 european-date-diary-pattern
415 american-date-diary-pattern)
416 "*List of pseudo-patterns describing the forms of date used in the diary.
417 The patterns on the list must be MUTUALLY EXCLUSIVE and must should not match
418 any portion of the diary entry itself, just the date component.
420 A pseudo-pattern is a list of regular expressions and the keywords `month',
421 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
422 match the name of the month, capitalized or not, or its three-letter
423 abbreviation, followed by a period or not; it will also match `*'.
424 Similarly, `dayname' will match the name of the day, capitalized or not, or
425 its three-letter abbreviation, followed by a period or not. The keywords
426 `month', `day', and `year' will match those numerical values, preceded by
427 arbitrarily many zeros; they will also match `*'.
429 The matching of the diary entries with the date forms is done with the
430 standard syntax table from Fundamental mode, but with the `*' changed so
431 that it is a word constituent.
433 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
434 diary entry itself, the first element of the pattern MUST be `backup'. This
435 directive causes the date recognizer to back up to the beginning of the
436 current word of the diary entry, so in no case can the pattern match more than
437 a portion of the first word of the diary entry.")
439 ;;;###autoload
440 (defvar european-calendar-display-form
441 '((if dayname (concat dayname ", ")) day " " monthname " " year)
442 "*Pseudo-pattern governing the way a date appears in the European style.
443 See the documentation of calendar-date-display-form for an explanation.")
445 ;;;###autoload
446 (defvar american-calendar-display-form
447 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
448 "*Pseudo-pattern governing the way a date appears in the American style.
449 See the documentation of calendar-date-display-form for an explanation.")
451 (defvar calendar-date-display-form
452 (if european-calendar-style
453 european-calendar-display-form
454 american-calendar-display-form)
455 "*Pseudo-pattern governing the way a date appears.
457 Used by the function `calendar-date-string', a pseudo-pattern is a list of
458 expressions that can involve the keywords `month', `day', and `year', all
459 numbers in string form, and `monthname' and `dayname', both alphabetic
460 strings. For example, the ISO standard would use the pseudo- pattern
462 '(year \"-\" month \"-\" day)
464 while a typical American form would be
466 '(month \"/\" day \"/\" (substring year -2))
470 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
472 would give the usual American style in fixed-length fields.
474 See the documentation of the function `calendar-date-string'.")
476 (defun european-calendar ()
477 "Set the interpretation and display of dates to the European style."
478 (interactive)
479 (setq european-calendar-style t)
480 (setq calendar-date-display-form european-calendar-display-form)
481 (setq diary-date-forms european-date-diary-pattern)
482 (update-calendar-mode-line))
484 (defun american-calendar ()
485 "Set the interpretation and display of dates to the American style."
486 (interactive)
487 (setq european-calendar-style nil)
488 (setq calendar-date-display-form american-calendar-display-form)
489 (setq diary-date-forms american-date-diary-pattern)
490 (update-calendar-mode-line))
492 ;;;###autoload
493 (defvar print-diary-entries-hook 'lpr-buffer
494 "*List of functions called after a temporary diary buffer is prepared.
495 The buffer shows only the diary entries currently visible in the diary
496 buffer. The default just does the printing. Other uses might include, for
497 example, rearranging the lines into order by day and time, saving the buffer
498 instead of deleting it, or changing the function used to do the printing.")
500 ;;;###autoload
501 (defvar list-diary-entries-hook nil
502 "*List of functions called after diary file is culled for relevant entries.
503 It is to be used for diary entries that are not found in the diary file.
505 A function `include-other-diary-files' is provided for use as the value of
506 this hook. This function enables you to use shared diary files together
507 with your own. The files included are specified in the diary-file by lines
508 of the form
510 #include \"filename\"
512 This is recursive; that is, #include directives in files thus included are
513 obeyed. You can change the \"#include\" to some other string by changing
514 the variable `diary-include-string'. When you use `include-other-diary-files'
515 as part of the list-diary-entries-hook, you will probably also want to use the
516 function `mark-included-diary-files' as part of the mark-diary-entries-hook.
518 For example, you could use
520 (setq list-diary-entries-hook
521 '(include-other-diary-files sort-diary-entries))
522 (setq diary-display-hook 'fancy-diary-display)
524 in your .emacs file to cause the fancy diary buffer to be displayed with
525 diary entries from various included files, each day's entries sorted into
526 lexicographic order.")
528 ;;;###autoload
529 (defvar diary-hook nil
530 "*List of functions called after the display of the diary.
531 Can be used for appointment notification.")
533 ;;;###autoload
534 (defvar diary-display-hook nil
535 "*List of functions that handle the display of the diary.
536 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
537 diary display.
539 Ordinarily, this just displays the diary buffer (with holidays indicated in
540 the mode line), if there are any relevant entries. At the time these
541 functions are called, the variable `diary-entries-list' is a list, in order
542 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
543 STRING), where string is the diary entry for the given date. This can be
544 used, for example, a different buffer for display (perhaps combined with
545 holidays), or produce hard copy output.
547 A function `fancy-diary-display' is provided as an alternative
548 choice for this hook; this function prepares a special noneditable diary
549 buffer with the relevant diary entries that has neat day-by-day arrangement
550 with headings. The fancy diary buffer will show the holidays unless the
551 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
552 diary buffer will not show days for which there are no diary entries, even
553 if that day is a holiday; if you want such days to be shown in the fancy
554 diary buffer, set the variable `diary-list-include-blanks' to t.")
556 ;;;###autoload
557 (defvar nongregorian-diary-listing-hook nil
558 "*List of functions called for listing diary file and included files.
559 As the files are processed for diary entries, these functions are used to cull
560 relevant entries. You can use either or both of `list-hebrew-diary-entries'
561 and `list-islamic-diary-entries'. The documentation for these functions
562 describes the style of such diary entries.")
564 ;;;###autoload
565 (defvar mark-diary-entries-hook nil
566 "*List of functions called after marking diary entries in the calendar.
568 A function `mark-included-diary-files' is also provided for use as the
569 mark-diary-entries-hook; it enables you to use shared diary files together
570 with your own. The files included are specified in the diary-file by lines
571 of the form
572 #include \"filename\"
573 This is recursive; that is, #include directives in files thus included are
574 obeyed. You can change the \"#include\" to some other string by changing the
575 variable `diary-include-string'. When you use `mark-included-diary-files' as
576 part of the mark-diary-entries-hook, you will probably also want to use the
577 function `include-other-diary-files' as part of the list-diary-entries-hook.")
579 ;;;###autoload
580 (defvar nongregorian-diary-marking-hook nil
581 "*List of functions called for marking diary file and included files.
582 As the files are processed for diary entries, these functions are used to cull
583 relevant entries. You can use either or both of `mark-hebrew-diary-entries'
584 and `mark-islamic-diary-entries'. The documentation for these functions
585 describes the style of such diary entries.")
587 ;;;###autoload
588 (defvar diary-list-include-blanks nil
589 "*If nil, do not include days with no diary entry in the list of diary entries.
590 Such days will then not be shown in the the fancy diary buffer, even if they
591 are holidays.")
593 ;;;###autoload
594 (defvar holidays-in-diary-buffer t
595 "*Non-nil means include holidays in the diary display.
596 The holidays appear in the mode line of the diary buffer, or in the
597 fancy diary buffer next to the date. This slows down the diary functions
598 somewhat; setting it to nil makes the diary display faster.")
600 (defvar calendar-mark-ring nil)
602 ;;;###autoload
603 (put 'general-holidays 'risky-local-variable t)
604 ;;;###autoload
605 (defvar general-holidays
606 '((holiday-fixed 1 1 "New Year's Day")
607 (holiday-float 1 1 3 "Martin Luther King Day")
608 (holiday-fixed 2 2 "Ground Hog Day")
609 (holiday-fixed 2 14 "Valentine's Day")
610 (holiday-float 2 1 3 "President's Day")
611 (holiday-fixed 3 17 "St. Patrick's Day")
612 (holiday-fixed 4 1 "April Fool's Day")
613 (holiday-float 5 0 2 "Mother's Day")
614 (holiday-float 5 1 -1 "Memorial Day")
615 (holiday-fixed 6 14 "Flag Day")
616 (holiday-float 6 0 3 "Father's Day")
617 (holiday-fixed 7 4 "Independence Day")
618 (holiday-float 9 1 1 "Labor Day")
619 (holiday-float 10 1 2 "Columbus Day")
620 (holiday-fixed 10 31 "Halloween")
621 (holiday-fixed 11 11 "Veteran's Day")
622 (holiday-float 11 4 4 "Thanksgiving"))
623 "*General holidays. Default value is for the United States.
624 See the documentation for `calendar-holidays' for details.")
626 ;;;###autoload
627 (put 'local-holidays 'risky-local-variable t)
628 ;;;###autoload
629 (defvar local-holidays nil
630 "*Local holidays.
631 See the documentation for `calendar-holidays' for details.")
633 ;;;###autoload
634 (put 'other-holidays 'risky-local-variable t)
635 ;;;###autoload
636 (defvar other-holidays nil
637 "*User defined holidays.
638 See the documentation for `calendar-holidays' for details.")
640 ;;;###autoload
641 (put 'hebrew-holidays-1 'risky-local-variable t)
642 ;;;###autoload
643 (defvar hebrew-holidays-1
644 '((holiday-rosh-hashanah-etc)
645 (if all-hebrew-calendar-holidays
646 (holiday-julian
648 (let* ((m displayed-month)
649 (y displayed-year)
650 (year))
651 (increment-calendar-month m y -1)
652 (let ((year (extract-calendar-year
653 (calendar-julian-from-absolute
654 (calendar-absolute-from-gregorian
655 (list m 1 y))))))
656 (if (zerop (% (1+ year) 4))
658 21))) "\"Tal Umatar\" (evening)"))))
660 ;;;###autoload
661 (put 'hebrew-holidays-2 'risky-local-variable t)
662 ;;;###autoload
663 (defvar hebrew-holidays-2
664 '((if all-hebrew-calendar-holidays
665 (holiday-hanukkah)
666 (holiday-hebrew 9 25 "Hanukkah"))
667 (if all-hebrew-calendar-holidays
668 (holiday-hebrew
670 (let ((h-year (extract-calendar-year
671 (calendar-hebrew-from-absolute
672 (calendar-absolute-from-gregorian
673 (list displayed-month 28 displayed-year))))))
674 (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
677 11 10))
678 "Tzom Teveth"))
679 (if all-hebrew-calendar-holidays
680 (holiday-hebrew 11 15 "Tu B'Shevat"))))
682 ;;;###autoload
683 (put 'hebrew-holidays-3 'risky-local-variable t)
684 ;;;###autoload
685 (defvar hebrew-holidays-3
686 '((if all-hebrew-calendar-holidays
687 (holiday-hebrew
689 (let ((m displayed-month)
690 (y displayed-year))
691 (increment-calendar-month m y 1)
692 (let* ((h-year (extract-calendar-year
693 (calendar-hebrew-from-absolute
694 (calendar-absolute-from-gregorian
695 (list m
696 (calendar-last-day-of-month m y)
697 y)))))
698 (s-s
699 (calendar-hebrew-from-absolute
700 (if (=
701 (% (calendar-absolute-from-hebrew
702 (list 7 1 h-year))
705 (calendar-dayname-on-or-before
706 6 (calendar-absolute-from-hebrew
707 (list 11 17 h-year)))
708 (calendar-dayname-on-or-before
709 6 (calendar-absolute-from-hebrew
710 (list 11 16 h-year))))))
711 (day (extract-calendar-day s-s)))
712 day))
713 "Shabbat Shirah"))))
715 ;;;###autoload
716 (put 'hebrew-holidays-4 'risky-local-variable t)
717 ;;;###autoload
718 (defvar hebrew-holidays-4
719 '((holiday-passover-etc)
720 (if (and all-hebrew-calendar-holidays
721 (let* ((m displayed-month)
722 (y displayed-year)
723 (year))
724 (increment-calendar-month m y -1)
725 (let ((year (extract-calendar-year
726 (calendar-julian-from-absolute
727 (calendar-absolute-from-gregorian
728 (list m 1 y))))))
729 (= 21 (% year 28)))))
730 (holiday-julian 3 26 "Kiddush HaHamah"))
731 (if all-hebrew-calendar-holidays
732 (holiday-tisha-b-av-etc))))
734 ;;;###autoload
735 (put 'hebrew-holidays 'risky-local-variable t)
736 ;;;###autoload
737 (defvar hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
738 hebrew-holidays-3 hebrew-holidays-4)
739 "*Jewish holidays.
740 See the documentation for `calendar-holidays' for details.")
742 ;;;###autoload
743 (put 'christian-holidays 'risky-local-variable t)
744 ;;;###autoload
745 (defvar christian-holidays
746 '((if all-christian-calendar-holidays
747 (holiday-fixed 1 6 "Epiphany"))
748 (holiday-easter-etc)
749 (if all-christian-calendar-holidays
750 (holiday-greek-orthodox-easter))
751 (if all-christian-calendar-holidays
752 (holiday-fixed 8 15 "Assumption"))
753 (if all-christian-calendar-holidays
754 (holiday-advent))
755 (holiday-fixed 12 25 "Christmas")
756 (if all-christian-calendar-holidays
757 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
758 "*Christian holidays.
759 See the documentation for `calendar-holidays' for details.")
761 ;;;###autoload
762 (put 'islamic-holidays 'risky-local-variable t)
763 ;;;###autoload
764 (defvar islamic-holidays
765 '((holiday-islamic
767 (format "Islamic New Year %d"
768 (let ((m displayed-month)
769 (y displayed-year))
770 (increment-calendar-month m y 1)
771 (extract-calendar-year
772 (calendar-islamic-from-absolute
773 (calendar-absolute-from-gregorian
774 (list
775 m (calendar-last-day-of-month m y) y)))))))
776 (if all-islamic-calendar-holidays
777 (holiday-islamic 1 10 "Ashura"))
778 (if all-islamic-calendar-holidays
779 (holiday-islamic 3 12 "Mulad-al-Nabi"))
780 (if all-islamic-calendar-holidays
781 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
782 (if all-islamic-calendar-holidays
783 (holiday-islamic 8 15 "Shab-e-Bara't"))
784 (holiday-islamic 9 1 "Ramadan Begins")
785 (if all-islamic-calendar-holidays
786 (holiday-islamic 9 27 "Shab-e Qadr"))
787 (if all-islamic-calendar-holidays
788 (holiday-islamic 10 1 "Id-al-Fitr"))
789 (if all-islamic-calendar-holidays
790 (holiday-islamic 12 10 "Id-al-Adha")))
791 "*Islamic holidays.
792 See the documentation for `calendar-holidays' for details.")
794 ;;;###autoload
795 (put 'solar-holidays 'risky-local-variable t)
796 ;;;###autoload
797 (defvar solar-holidays
798 '((if (fboundp 'atan)
799 (solar-equinoxes-solstices))
800 (if (progn
801 (require 'cal-dst)
803 (funcall
804 'holiday-sexp
805 calendar-daylight-savings-starts
806 '(format "Daylight Savings Time Begins %s"
807 (if (fboundp 'atan)
808 (solar-time-string
809 (/ calendar-daylight-savings-starts-time
810 (float 60))
811 date
812 'standard)
813 ""))))
814 (funcall
815 'holiday-sexp
816 calendar-daylight-savings-ends
817 '(format "Daylight Savings Time Ends %s"
818 (if (fboundp 'atan)
819 (solar-time-string
820 (/ (- calendar-daylight-savings-ends-time
821 calendar-daylight-time-offset)
822 (float 60))
823 date
824 'daylight)
825 ""))))
826 "*Sun-related holidays.
827 See the documentation for `calendar-holidays' for details.")
829 ;;;###autoload
830 (put 'calendar-holidays 'risky-local-variable t)
831 (defvar calendar-holidays
832 (append general-holidays local-holidays other-holidays
833 christian-holidays hebrew-holidays islamic-holidays
834 solar-holidays)
835 "*List of notable days for the command M-x holidays.
837 Additional holidays are easy to add to the list, just put them in the list
838 `other-holidays' in your .emacs file. Similarly, by setting any of
839 `general-holidays', `local-holidays' `christian-holidays', `hebrew-holidays',
840 `islamic-holidays', or `solar-holidays' to nil in your .emacs file, you can
841 eliminate unwanted categories of holidays. The intention is that (in the US)
842 `local-holidays' be set in site-init.el and `other-holidays' be set by the
843 user.
845 Entries on the list are expressions that return (possibly empty) lists of
846 items of the form ((month day year) string) of a holiday in the in the
847 three-month period centered around `displayed-month' of `displayed-year'.
848 Several basic functions are provided for this purpose:
850 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
851 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
852 MONTH on the Gregorian calendar (0 for Sunday,
853 etc.); K<0 means count back from the end of the
854 month. An optional parameter DAY means the Kth
855 DAYNAME after/before MONTH DAY.
856 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
857 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
858 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
859 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
860 in the variable `year'; if it evaluates to
861 a visible date, that's the holiday; if it
862 evaluates to nil, there's no holiday. STRING
863 is an expression in the variable `date'.
865 For example, to add Bastille Day, celebrated in France on July 14, add
867 (holiday-fixed 7 14 \"Bastille Day\")
869 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
870 Islands on the fourth Monday in August, add
872 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
874 to the list (the last Monday would be specified with `-1' instead of `4').
875 To add the last day of Hanukkah to the list, use
877 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
879 since the Hebrew months are numbered with 1 starting from Nisan, while to
880 add the Islamic feast celebrating Mohammed's birthday use
882 (holiday-islamic 3 12 \"Mohammed's Birthday\")
884 since the Islamic months are numbered from 1 starting with Muharram. To
885 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
887 (holiday-julian 4 2 \"Jefferson's Birthday\")
889 To include a holiday conditionally, use the sexp form or a conditional. For
890 example, to include American presidential elections, which occur on the first
891 Tuesday after the first Monday in November of years divisible by 4, add
893 (holiday-sexp
894 (if (zerop (% year 4))
895 (calendar-gregorian-from-absolute
896 (1+ (calendar-dayname-on-or-before
897 1 (+ 6 (calendar-absolute-from-gregorian
898 (list 11 1 year)))))))
899 \"US Presidential Election\")
903 (if (zerop (% displayed-year 4))
904 (holiday-fixed 11
905 (extract-calendar-day
906 (calendar-gregorian-from-absolute
907 (1+ (calendar-dayname-on-or-before
908 1 (+ 6 (calendar-absolute-from-gregorian
909 (list 11 1 displayed-year)))))))
910 \"US Presidential Election\"))
912 to the list. To include the phases of the moon, add
914 (lunar-phases)
916 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
917 you've written to return a (possibly empty) list of the relevant VISIBLE dates
918 with descriptive strings such as
920 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... ).")
922 (defconst calendar-buffer "*Calendar*"
923 "Name of the buffer used for the calendar.")
925 (defconst holiday-buffer "*Holidays*"
926 "Name of the buffer used for the displaying the holidays.")
928 (defconst fancy-diary-buffer "*Fancy Diary Entries*"
929 "Name of the buffer used for the optional fancy display of the diary.")
931 (defmacro increment-calendar-month (mon yr n)
932 "Move the variables MON and YR to the month and year by N months.
933 Forward if N is positive or backward if N is negative."
934 (` (let (( macro-y (+ (* (, yr) 12) (, mon) -1 (, n) )))
935 (setq (, mon) (1+ (% macro-y 12) ))
936 (setq (, yr) (/ macro-y 12)))))
938 (defmacro calendar-for-loop (var from init to final do &rest body)
939 "Execute a for loop."
940 (` (let (( (, var) (1- (, init)) ))
941 (while (>= (, final) (setq (, var) (1+ (, var))))
942 (,@ body)))))
944 (defmacro calendar-sum (index initial condition expression)
945 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
946 (` (let (( (, index) (, initial))
947 (sum 0))
948 (while (, condition)
949 (setq sum (+ sum (, expression) ))
950 (setq (, index) (1+ (, index))))
951 sum)))
953 ;; The following macros are for speed; the code would be clearer if they
954 ;; were functions, but they can be called thousands of times when
955 ;; looking up holidays or processing the diary. Here, for example, are the
956 ;; numbers of calls to calendar/diary/holiday functions in preparing the
957 ;; fancy diary display, for a moderately complex diary file, with functions
958 ;; used instead of macros. There were a total of 10000 such calls:
960 ;; 1934 extract-calendar-month
961 ;; 1852 extract-calendar-year
962 ;; 1819 extract-calendar-day
963 ;; 845 calendar-leap-year-p
964 ;; 837 calendar-day-number
965 ;; 775 calendar-absolute-from-gregorian
966 ;; 346 calendar-last-day-of-month
967 ;; 286 hebrew-calendar-last-day-of-month
968 ;; 188 hebrew-calendar-leap-year-p
969 ;; 180 hebrew-calendar-elapsed-days
970 ;; 163 hebrew-calendar-last-month-of-year
971 ;; 66 calendar-date-compare
972 ;; 65 hebrew-calendar-days-in-year
973 ;; 60 calendar-absolute-from-julian
974 ;; 50 calendar-absolute-from-hebrew
975 ;; 43 calendar-date-equal
976 ;; 38 calendar-gregorian-from-absolute
977 ;; .
978 ;; .
979 ;; .
981 ;; The use of these seven macros eliminates the overhead of 92% of the function
982 ;; calls; it's faster this way. For clarity, the defun form of each is given
983 ;; in comments after the defmacro form.
985 (defmacro extract-calendar-month (date)
986 "Extract the month part of DATE which has the form (month day year)."
987 (` (car (, date))))
988 ;;(defun extract-calendar-month (date)
989 ;; "Extract the month part of DATE which has the form (month day year)."
990 ;; (car date))
992 (defmacro extract-calendar-day (date)
993 "Extract the day part of DATE which has the form (month day year)."
994 (` (car (cdr (, date)))))
995 ;;(defun extract-calendar-day (date)
996 ;; "Extract the day part of DATE which has the form (month day year)."
997 ;; (car (cdr date)))
999 (defmacro extract-calendar-year (date)
1000 "Extract the year part of DATE which has the form (month day year)."
1001 (` (car (cdr (cdr (, date))))))
1002 ;;(defun extract-calendar-year (date)
1003 ;; "Extract the year part of DATE which has the form (month day year)."
1004 ;; (car (cdr (cdr date))))
1006 (defmacro calendar-leap-year-p (year)
1007 "Returns t if YEAR is a Gregorian leap year."
1008 (` (and
1009 (zerop (% (, year) 4))
1010 (or (not (zerop (% (, year) 100)))
1011 (zerop (% (, year) 400))))))
1012 ;;(defun calendar-leap-year-p (year)
1013 ;; "Returns t if YEAR is a Gregorian leap year."
1014 ;; (and
1015 ;; (zerop (% year 4))
1016 ;; (or ((not (zerop (% year 100))))
1017 ;; (zerop (% year 400)))))
1019 ;; The foregoing is a bit faster, but not as clear as the following:
1021 ;;(defmacro calendar-leap-year-p (year)
1022 ;; "Returns t if YEAR is a Gregorian leap year."
1023 ;; (` (or
1024 ;; (and (= (% (, year) 4) 0)
1025 ;; (/= (% (, year) 100) 0))
1026 ;; (= (% (, year) 400) 0))))
1027 ;;(defun calendar-leap-year-p (year)
1028 ;; "Returns t if YEAR is a Gregorian leap year."
1029 ;; (or
1030 ;; (and (= (% year 4) 0)
1031 ;; (/= (% year 100) 0))
1032 ;; (= (% year 400) 0)))
1034 (defmacro calendar-last-day-of-month (month year)
1035 "The last day in MONTH during YEAR."
1036 (` (if (and
1037 (= (, month) 2)
1038 (, (macroexpand (` (calendar-leap-year-p (, year))))))
1040 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- (, month))))))
1041 ;;(defun calendar-last-day-of-month (month year)
1042 ;; "The last day in MONTH during YEAR."
1043 ;; (if (and (= month 2) (calendar-leap-year-p year))
1044 ;; 29
1045 ;; (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1047 (defmacro calendar-day-number (date)
1048 "Return the day number within the year of the date DATE.
1049 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1050 while (calendar-day-number '(12 31 1980)) returns 366."
1052 ;; An explanation of the calculation can be found in PascAlgorithms by
1053 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1055 (` (let* ((month (, (macroexpand (` (extract-calendar-month (, date))))))
1056 (day (, (macroexpand (` (extract-calendar-day (, date))))))
1057 (year (, (macroexpand (` (extract-calendar-year (, date))))))
1058 (day-of-year (+ day (* 31 (1- month)))))
1059 (if (> month 2)
1060 (progn
1061 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1062 (if (, (macroexpand (` (calendar-leap-year-p year))))
1063 (setq day-of-year (1+ day-of-year)))))
1064 day-of-year)))
1065 ;;(defun calendar-day-number (date)
1066 ;; "Return the day number within the year of the date DATE.
1067 ;;For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1068 ;;while (calendar-day-number '(12 31 1980)) returns 366."
1069 ;; (let* ((month (extract-calendar-month date))
1070 ;; (day (extract-calendar-day date))
1071 ;; (year (extract-calendar-year date))
1072 ;; (day-of-year (+ day (* 31 (1- month)))))
1073 ;; (if (> month 2)
1074 ;; (progn
1075 ;; (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1076 ;; (if (calendar-leap-year-p year)
1077 ;; (setq day-of-year (1+ day-of-year)))))
1078 ;; day-of-year))
1080 (defmacro calendar-absolute-from-gregorian (date)
1081 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1082 The Gregorian date Sunday, December 31, 1 BC is imaginary."
1083 (` (let ((prior-years
1084 (1- (, (macroexpand (` (extract-calendar-year (, date))))))))
1085 (+ (, (macroexpand (` (calendar-day-number (, date)))));; Days this year
1086 (* 365 prior-years);; + Days in prior years
1087 (/ prior-years 4);; + Julian leap years
1088 (- (/ prior-years 100));; - century years
1089 (/ prior-years 400)))));; + Gregorian leap years
1090 ;;(defun calendar-absolute-from-gregorian (date)
1091 ;; "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1092 ;;The Gregorian date Sunday, December 31, 1 BC is imaginary."
1093 ;; (let ((prior-years (1- (extract-calendar-year date))))
1094 ;; (+ (calendar-day-number date);; Days this year
1095 ;; (* 365 prior-years);; + Days in prior years
1096 ;; (/ prior-years 4);; + Julian leap years
1097 ;; (- (/ prior-years 100));; - century years
1098 ;; (/ prior-years 400))));; + Gregorian leap years
1100 ;;;###autoload
1101 (defun calendar (&optional arg)
1102 "Display a three-month calendar in another window.
1103 The three months appear side by side, with the current month in the middle
1104 surrounded by the previous and next months. The cursor is put on today's date.
1106 If called with an optional prefix argument, prompts for month and year.
1108 This function is suitable for execution in a .emacs file; appropriate setting
1109 of the variable `view-diary-entries-initially' will cause the diary entries for
1110 the current date to be displayed in another window. The value of the variable
1111 `number-of-diary-entries' controls the number of days of diary entries
1112 displayed upon initial display of the calendar.
1114 An optional prefix argument ARG causes the calendar displayed to be ARG
1115 months in the future if ARG is positive or in the past if ARG is negative;
1116 in this case the cursor goes on the first day of the month.
1118 Once in the calendar window, future or past months can be moved into view.
1119 Arbitrary months can be displayed, or the calendar can be scrolled forward
1120 or backward.
1122 The cursor can be moved forward or backward by one day, one week, one month,
1123 or one year. All of these commands take prefix arguments which, when negative,
1124 cause movement in the opposite direction. For convenience, the digit keys
1125 and the minus sign are automatically prefixes. The window is replotted as
1126 necessary to display the desired date.
1128 Diary entries can be marked on the calendar or displayed in another window.
1130 Use M-x describe-mode for details of the key bindings in the calendar window.
1132 The Gregorian calendar is assumed.
1134 After loading the calendar, the hooks given by the variable
1135 `calendar-load-hook' are run. This the place to add key bindings to the
1136 calendar-mode-map.
1138 After preparing the calendar window initially, the hooks given by the variable
1139 `initial-calendar-window-hook' are run.
1141 The hooks given by the variable `today-visible-calendar-hook' are run
1142 everytime the calendar window gets scrolled, if the current date is visible
1143 in the window. If it is not visible, the hooks given by the variable
1144 `today-invisible-calendar-hook' are run. Thus, for example, setting
1145 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1146 to be replaced by asterisks to highlight it whenever it is in the window."
1147 (interactive "P")
1148 (set-buffer (get-buffer-create calendar-buffer))
1149 (calendar-mode)
1150 (setq calendar-window-configuration (current-window-configuration))
1151 (let* ((completion-ignore-case t)
1152 (pop-up-windows t)
1153 (split-height-threshold 1000)
1154 (date (calendar-current-date))
1155 (month
1156 (if arg
1157 (cdr (assoc
1158 (capitalize
1159 (completing-read
1160 "Month name: "
1161 (mapcar 'list (append calendar-month-name-array nil))
1162 nil t))
1163 (calendar-make-alist calendar-month-name-array)))
1164 (extract-calendar-month date)))
1165 (year
1166 (if arg
1167 (calendar-read
1168 "Year (>0): "
1169 '(lambda (x) (> x 0))
1170 (int-to-string (extract-calendar-year date)))
1171 (extract-calendar-year date))))
1172 (pop-to-buffer calendar-buffer)
1173 (generate-calendar-window month year)
1174 (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
1175 (view-diary-entries
1176 (if (vectorp number-of-diary-entries)
1177 (aref number-of-diary-entries (calendar-day-of-week date))
1178 number-of-diary-entries))))
1179 (let* ((diary-buffer (get-file-buffer diary-file))
1180 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1181 (split-height-threshold (if diary-window 2 1000)))
1182 (if view-calendar-holidays-initially
1183 (list-calendar-holidays)))
1184 (run-hooks 'initial-calendar-window-hook))
1186 (autoload 'view-diary-entries "diary"
1187 "Prepare and display a buffer with diary entries.
1188 Searches the file diary-file for entries that match ARG days starting with
1189 the date indicated by the cursor position in the displayed three-month
1190 calendar."
1193 (autoload 'calendar-sunrise-sunset "solar"
1194 "Local time of sunrise and sunset for date under cursor."
1197 (autoload 'calendar-phases-of-moon "lunar"
1198 "Create a buffer of the phases of the moon for the current calendar window."
1201 (autoload 'calendar-print-french-date "cal-french"
1202 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1205 (autoload 'calendar-goto-french-date "cal-french"
1206 "Move cursor to French Revolutionary date."
1209 (autoload 'calendar-french-date-string "cal-french"
1210 "String of French Revolutionary date of Gregorian DATE."
1213 (autoload 'calendar-mayan-date-string "cal-mayan"
1214 "String of Mayan date of Gregorian DATE."
1217 (autoload 'calendar-print-mayan-date "cal-mayan"
1218 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1221 (autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
1222 "Move cursor to Mayan long count date."
1225 (autoload 'calendar-next-haab-date "cal-mayan"
1226 "Move cursor to next instance of Mayan Haab date."
1229 (autoload 'calendar-previous-haab-date "cal-mayan"
1230 "Move cursor to previous instance of Mayan Haab date."
1233 (autoload 'calendar-next-tzolkin-date "cal-mayan"
1234 "Move cursor to next instance of Mayan Tzolkin date."
1237 (autoload 'calendar-previous-tzolkin-date "cal-mayan"
1238 "Move cursor to previous instance of Mayan Tzolkin date."
1241 (autoload 'calendar-next-calendar-round-date "cal-mayan"
1242 "Move cursor to next instance of Mayan Haab/Tzoklin combination."
1245 (autoload 'calendar-previous-calendar-round-date "cal-mayan"
1246 "Move cursor to previous instance of Mayan Haab/Tzoklin combination."
1249 (autoload 'show-all-diary-entries "diary"
1250 "Show all of the diary entries in the diary-file.
1251 This function gets rid of the selective display of the diary-file so that
1252 all entries, not just some, are visible. If there is no diary buffer, one
1253 is created."
1256 (autoload 'mark-diary-entries "diary"
1257 "Mark days in the calendar window that have diary entries.
1258 Each entry in diary-file visible in the calendar window is marked."
1261 (autoload 'insert-diary-entry "diary-ins"
1262 "Insert a diary entry for the date indicated by point."
1265 (autoload 'insert-weekly-diary-entry "diary-ins"
1266 "Insert a weekly diary entry for the day of the week indicated by point."
1270 (autoload 'insert-monthly-diary-entry "diary-ins"
1271 "Insert a monthly diary entry for the day of the month indicated by point."
1274 (autoload 'insert-yearly-diary-entry "diary-ins"
1275 "Insert an annual diary entry for the day of the year indicated by point."
1278 (autoload 'insert-anniversary-diary-entry "diary-ins"
1279 "Insert an anniversary diary entry for the date indicated by point."
1282 (autoload 'insert-block-diary-entry "diary-ins"
1283 "Insert a block diary entry for the dates indicated by point and mark."
1286 (autoload 'insert-cyclic-diary-entry "diary-ins"
1287 "Insert a cyclic diary entry starting at the date indicated by point."
1290 (autoload 'insert-hebrew-diary-entry "diary-ins"
1291 "Insert a diary entry for the Hebrew date corresponding to the date
1292 indicated by point."
1295 (autoload 'insert-monthly-hebrew-diary-entry "diary-ins"
1296 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1297 to the date indicated by point."
1300 (autoload 'insert-yearly-hebrew-diary-entry "diary-ins"
1301 "Insert an annual diary entry for the day of the Hebrew year corresponding
1302 to the date indicated by point."
1305 (autoload 'insert-islamic-diary-entry "diary-ins"
1306 "Insert a diary entry for the Islamic date corresponding to the date
1307 indicated by point."
1310 (autoload 'insert-monthly-islamic-diary-entry "diary-ins"
1311 "Insert a monthly diary entry for the day of the Islamic month corresponding
1312 to the date indicated by point."
1315 (autoload 'insert-yearly-islamic-diary-entry "diary-ins"
1316 "Insert an annual diary entry for the day of the Islamic year corresponding
1317 to the date indicated by point."
1320 (autoload 'list-calendar-holidays "holidays"
1321 "Create a buffer containing the holidays for the current calendar window.
1322 The holidays are those in the list `calendar-notable-days'. Returns t if any
1323 holidays are found, nil if not."
1326 (autoload 'mark-calendar-holidays "holidays"
1327 "Mark notable days in the calendar window."
1330 (autoload 'calendar-cursor-holidays "holidays"
1331 "Find holidays for the date specified by the cursor in the calendar window."
1334 (defun generate-calendar-window (&optional mon yr)
1335 "Generate the calendar window for the current date.
1336 Or, for optional MON, YR."
1337 (let* ((buffer-read-only nil)
1338 (today (calendar-current-date))
1339 (month (extract-calendar-month today))
1340 (day (extract-calendar-day today))
1341 (year (extract-calendar-year today))
1342 (today-visible
1343 (or (not mon)
1344 (let ((offset (calendar-interval mon yr month year)))
1345 (and (<= offset 1) (>= offset -1)))))
1346 (day-in-week (calendar-day-of-week today)))
1347 (update-calendar-mode-line)
1348 (if mon
1349 (generate-calendar mon yr)
1350 (generate-calendar month year))
1351 (calendar-cursor-to-visible-date
1352 (if today-visible today (list displayed-month 1 displayed-year)))
1353 (set-buffer-modified-p nil)
1354 (or (one-window-p t)
1355 (/= (frame-width) (window-width))
1356 (shrink-window (- (window-height) 9)))
1357 (sit-for 0)
1358 (and mark-holidays-in-calendar
1359 (mark-calendar-holidays)
1360 (sit-for 0))
1361 (unwind-protect
1362 (if mark-diary-entries-in-calendar (mark-diary-entries))
1363 (if today-visible
1364 (run-hooks 'today-visible-calendar-hook)
1365 (run-hooks 'today-invisible-calendar-hook)))))
1367 (defun generate-calendar (month year)
1368 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
1369 (if (< (+ month (* 12 (1- year))) 2)
1370 (error "Months before February, 1 AD are not available."))
1371 (setq displayed-month month)
1372 (setq displayed-year year)
1373 (erase-buffer)
1374 (increment-calendar-month month year -1)
1375 (calendar-for-loop i from 0 to 2 do
1376 (generate-calendar-month month year (+ 5 (* 25 i)))
1377 (increment-calendar-month month year 1)))
1379 (defun generate-calendar-month (month year indent)
1380 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
1381 The calendar is inserted in the buffer starting at the line on which point
1382 is currently located, but indented INDENT spaces. The indentation is done
1383 from the first character on the line and does not disturb the first INDENT
1384 characters on the line."
1385 (let* ((blank-days;; at start of month
1386 (calendar-mod
1387 (- (calendar-day-of-week (list month 1 year))
1388 calendar-week-start-day)
1390 (last (calendar-last-day-of-month month year)))
1391 (goto-char (point-min))
1392 (calendar-insert-indented
1393 (calendar-string-spread
1394 (list "" (format "%s %d" (calendar-month-name month) year) "") ? 20)
1395 indent t)
1396 (calendar-insert-indented "" indent);; Go to proper spot
1397 (calendar-for-loop i from 0 to 6 do
1398 (insert (substring (aref calendar-day-name-array
1399 (calendar-mod (+ calendar-week-start-day i) 7))
1400 0 2))
1401 (insert " "))
1402 (calendar-insert-indented "" 0 t);; Force onto following line
1403 (calendar-insert-indented "" indent);; Go to proper spot
1404 ;; Add blank days before the first of the month
1405 (calendar-for-loop i from 1 to blank-days do (insert " "))
1406 ;; Put in the days of the month
1407 (calendar-for-loop i from 1 to last do
1408 (insert (format "%2d " i))
1409 (put-text-property (- (point) (if (< i 10) 2 3)) (1- (point))
1410 'mouse-face 'highlight)
1411 (and (zerop (calendar-mod (+ i blank-days) 7))
1412 (/= i last)
1413 (calendar-insert-indented "" 0 t) ;; Force onto following line
1414 (calendar-insert-indented "" indent)))));; Go to proper spot
1416 (defun calendar-insert-indented (string indent &optional newline)
1417 "Insert STRING at column INDENT.
1418 If the optional parameter NEWLINE is t, leave point at start of next line,
1419 inserting a newline if there was no next line; otherwise, leave point after
1420 the inserted text. Value is always t."
1421 ;; Try to move to that column.
1422 (move-to-column indent)
1423 ;; If line is too short, indent out to that column.
1424 (if (< (current-column) indent)
1425 (indent-to indent))
1426 (insert string)
1427 ;; Advance to next line, if requested.
1428 (if newline
1429 (progn
1430 (end-of-line)
1431 (if (eobp)
1432 (newline)
1433 (forward-line 1))))
1436 (defun redraw-calendar ()
1437 "Redraw the calendar display."
1438 (interactive)
1439 (let ((cursor-date (calendar-cursor-to-date)))
1440 (generate-calendar-window displayed-month displayed-year)
1441 (calendar-cursor-to-visible-date cursor-date)))
1443 (defvar calendar-debug-sexp nil
1444 "*Turn debugging on when evaluating a sexp in the diary or holiday list.")
1446 (defvar calendar-mode-map nil)
1447 (if calendar-mode-map
1449 (setq calendar-mode-map (make-sparse-keymap))
1450 (if window-system (require 'cal-menu))
1451 (calendar-for-loop i from 0 to 9 do
1452 (define-key calendar-mode-map (int-to-string i) 'digit-argument))
1453 (let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph
1454 'mark-defun 'mark-whole-buffer 'mark-page 'kill-region
1455 'copy-region-as-kill 'downcase-region 'upcase-region
1456 'capitalize-region 'write-region)))
1457 (while (car l)
1458 (let ((k (where-is-internal (car l) '(keymap))))
1459 (while (car k)
1460 (define-key calendar-mode-map (car k) 'calendar-not-implemented)
1461 (setq k (cdr k)))
1462 (setq l (cdr l)))))
1463 (define-key calendar-mode-map "-" 'negative-argument)
1464 (define-key calendar-mode-map "\C-x>" 'scroll-calendar-right)
1465 (define-key calendar-mode-map [prior] 'scroll-calendar-right-three-months)
1466 (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
1467 (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
1468 (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
1469 (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
1470 (define-key calendar-mode-map "\C-b" 'calendar-backward-day)
1471 (define-key calendar-mode-map "\C-p" 'calendar-backward-week)
1472 (define-key calendar-mode-map "\e{" 'calendar-backward-month)
1473 (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
1474 (define-key calendar-mode-map "\C-f" 'calendar-forward-day)
1475 (define-key calendar-mode-map "\C-n" 'calendar-forward-week)
1476 (define-key calendar-mode-map [left] 'calendar-backward-day)
1477 (define-key calendar-mode-map [up] 'calendar-backward-week)
1478 (define-key calendar-mode-map [right] 'calendar-forward-day)
1479 (define-key calendar-mode-map [down] 'calendar-forward-week)
1480 (define-key calendar-mode-map "\e}" 'calendar-forward-month)
1481 (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
1482 (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
1483 (define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
1484 (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month)
1485 (define-key calendar-mode-map "\ee" 'calendar-end-of-month)
1486 (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
1487 (define-key calendar-mode-map "\e>" 'calendar-end-of-year)
1488 (define-key calendar-mode-map "\C-@" 'calendar-set-mark)
1489 ;; Many people are used to typing C-SPC and getting C-@.
1490 (define-key calendar-mode-map [?\C-\ ] 'calendar-set-mark)
1491 (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
1492 (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
1493 (define-key calendar-mode-map "gd" 'calendar-goto-date)
1494 (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
1495 (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
1496 (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
1497 (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
1498 (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
1499 (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
1500 (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
1501 (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
1502 (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
1503 (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
1504 (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
1505 (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
1506 (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
1507 (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
1508 (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
1509 (define-key calendar-mode-map " " 'scroll-other-window)
1510 (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
1511 (define-key calendar-mode-map "." 'calendar-current-month)
1512 (define-key calendar-mode-map "o" 'calendar-other-month)
1513 (define-key calendar-mode-map "q" 'exit-calendar)
1514 (define-key calendar-mode-map "a" 'list-calendar-holidays)
1515 (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
1516 (define-key calendar-mode-map "x" 'mark-calendar-holidays)
1517 (define-key calendar-mode-map "u" 'calendar-unmark)
1518 (define-key calendar-mode-map "m" 'mark-diary-entries)
1519 (define-key calendar-mode-map "d" 'view-diary-entries)
1520 (define-key calendar-mode-map "s" 'show-all-diary-entries)
1521 (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
1522 (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
1523 (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
1524 (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
1525 (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
1526 (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
1527 (define-key calendar-mode-map "pf" 'calendar-print-french-date)
1528 (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
1529 (define-key calendar-mode-map "id" 'insert-diary-entry)
1530 (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
1531 (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
1532 (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
1533 (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
1534 (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
1535 (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
1536 (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
1537 (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
1538 (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
1539 (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
1540 (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
1541 (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
1542 (define-key calendar-mode-map "?" 'describe-calendar-mode))
1544 (defun describe-calendar-mode ()
1545 "Create a help buffer with a brief description of the calendar-mode."
1546 (interactive)
1547 (with-output-to-temp-buffer "*Help*"
1548 (princ
1549 (format
1550 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
1551 (substitute-command-keys
1552 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
1553 (substitute-command-keys "\\{calendar-mode-map}")))
1554 (print-help-return-message)))
1556 ;; Calendar mode is suitable only for specially formatted data.
1557 (put 'calendar-mode 'mode-class 'special)
1559 (defvar calendar-mode-line-format
1560 (list
1561 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-left]")
1562 "Calendar"
1563 (substitute-command-keys "\\<calendar-mode-map>\\[describe-calendar-mode] help/\\[calendar-other-month] other/\\[calendar-current-month] today")
1564 '(calendar-date-string (calendar-current-date) t)
1565 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-right]"))
1566 "The mode line of the calendar buffer.")
1568 (defun calendar-mode ()
1569 "A major mode for the calendar window.
1571 The commands for cursor movement are:\\<calendar-mode-map>
1573 \\[calendar-forward-day] one day forward \\[calendar-backward-day] one day backward
1574 \\[calendar-forward-week] one week forward \\[calendar-backward-week] one week backward
1575 \\[calendar-forward-month] one month forward \\[calendar-backward-month] one month backward
1576 \\[calendar-forward-year] one year forward \\[calendar-backward-year] one year backward
1577 \\[calendar-beginning-of-week] beginning of week \\[calendar-end-of-week] end of week
1578 \\[calendar-beginning-of-month] beginning of month \\[calendar-end-of-month] end of month
1579 \\[calendar-beginning-of-year] beginning of year \\[calendar-end-of-year] end of year
1581 \\[calendar-goto-date] go to date
1583 \\[calendar-goto-julian-date] go to Julian date \\[calendar-goto-astro-day-number] go to astronomical (Julian) day number
1584 \\[calendar-goto-hebrew-date] go to Hebrew date \\[calendar-goto-islamic-date] go to Islamic date
1585 \\[calendar-goto-iso-date] go to ISO date \\[calendar-goto-french-date] go to French Revolutionary date
1587 \\[calendar-goto-mayan-long-count-date] go to Mayan Long Count date
1588 \\[calendar-next-haab-date] go to next occurrence of Mayan Haab date
1589 \\[calendar-previous-haab-date] go to previous occurrence of Mayan Haab date
1590 \\[calendar-next-tzolkin-date] go to next occurrence of Mayan Tzolkin date
1591 \\[calendar-previous-tzolkin-date] go to previous occurrence of Mayan Tzolkin date
1592 \\[calendar-next-calendar-round-date] go to next occurrence of Mayan Calendar Round date
1593 \\[calendar-previous-calendar-round-date] go to previous occurrence of Mayan Calendar Round date
1595 You can mark a date in the calendar and switch the point and mark:
1597 \\[calendar-set-mark] mark date \\[calendar-exchange-point-and-mark] exchange point and mark
1599 You can determine the number of days (inclusive) between the point and mark by
1601 \\[calendar-count-days-region] count days in the region
1603 The commands for calendar movement are:
1605 \\[scroll-calendar-right] scroll one month right \\[scroll-calendar-left] scroll one month left
1606 \\[scroll-calendar-right-three-months] scroll 3 months right \\[scroll-calendar-left-three-months] scroll 3 months left
1607 \\[calendar-current-month] display current month \\[calendar-other-month] display another month
1609 Whenever it makes sense, the above commands take prefix arguments that
1610 multiply their affect. For convenience, the digit keys and the minus sign
1611 are bound to digit-argument, so they need not be prefixed with ESC.
1613 If the calendar window somehow becomes corrupted, it can be regenerated with
1615 \\[redraw-calendar] redraw the calendar
1617 The following commands deal with holidays and other notable days:
1619 \\[calendar-cursor-holidays] give holidays for the date specified by the cursor
1620 \\[mark-calendar-holidays] mark notable days
1621 \\[calendar-unmark] unmark dates
1622 \\[list-calendar-holidays] display notable days
1624 The command M-x holidays causes the notable dates for the current month, and
1625 the preceding and succeeding months, to be displayed, independently of the
1626 calendar.
1628 The following commands control the diary:
1630 \\[mark-diary-entries] mark diary entries \\[calendar-unmark] unmark dates
1631 \\[view-diary-entries] display diary entries \\[show-all-diary-entries] show all diary entries
1632 \\[print-diary-entries] print diary entries
1634 Displaying the diary entries causes the diary entries from the diary-file
1635 \(for the date indicated by the cursor in the calendar window) to be
1636 displayed in another window. This function takes an integer argument that
1637 specifies the number of days of calendar entries to be displayed, starting
1638 with the date indicated by the cursor.
1640 The command \\[print-diary-entries] prints the diary buffer (as it appears)
1641 on the line printer.
1643 The command M-x diary causes the diary entries for the current date to be
1644 displayed, independently of the calendar. The number of days of entries is
1645 governed by number-of-diary-entries.
1647 The format of the entries in the diary file is described in the
1648 documentation string for the variable diary-file.
1650 When diary entries are in view in the window, they can be edited. It is
1651 important to keep in mind that the buffer displayed contains the entire
1652 diary file, but with portions of it concealed from view. This means, for
1653 instance, that the forward-char command can put the cursor at what appears
1654 to be the end of the line, but what is in reality the middle of some
1655 concealed line. BE CAREFUL WHEN EDITING THE DIARY ENTRIES! (Inserting
1656 additional lines or adding/deleting characters in the middle of a visible
1657 line will not cause problems; watch out for end-of-line, however--it may
1658 put you at the end of a concealed line far from where the cursor appears to
1659 be!) BEFORE EDITING THE DIARY IT IS BEST TO DISPLAY THE ENTIRE FILE WITH
1660 show-all-diary-entries. BE SURE TO WRITE THE FILE BEFORE EXITING FROM THE
1661 CALENDAR.
1663 The following commands assist in making diary entries:
1665 \\[insert-diary-entry] insert a diary entry for the selected date
1666 \\[insert-weekly-diary-entry] insert a diary entry for the selected day of the week
1667 \\[insert-monthly-diary-entry] insert a diary entry for the selected day of the month
1668 \\[insert-yearly-diary-entry] insert a diary entry for the selected day of the year
1669 \\[insert-block-diary-entry] insert a diary entry for the block days between point and mark
1670 \\[insert-anniversary-diary-entry] insert an anniversary diary entry for the selected date
1671 \\[insert-cyclic-diary-entry] insert a cyclic diary entry
1673 There are corresponding commands to assist in making Hebrew- or Islamic-date
1674 diary entries:
1676 \\[insert-hebrew-diary-entry] insert a diary entry for the Hebrew date corresponding
1677 to the selected date
1678 \\[insert-monthly-hebrew-diary-entry] insert a diary entry for the day of the Hebrew month
1679 corresponding to the selected day
1680 \\[insert-yearly-hebrew-diary-entry] insert a diary entry for the day of the Hebrew year
1681 corresponding to the selected day
1682 \\[insert-islamic-diary-entry] insert a diary entry for the Islamic date corresponding
1683 to the selected date
1684 \\[insert-monthly-islamic-diary-entry] insert a diary entry for the day of the Islamic month
1685 corresponding to the selected day
1686 \\[insert-yearly-islamic-diary-entry] insert a diary entry for the day of the Islamic year
1687 corresponding to the selected day
1689 All of the diary entry commands make nonmarking entries when given a prefix
1690 argument; with no prefix argument, the diary entries are marking.
1692 The day number in the year and the number of days remaining in the year can be
1693 determined by
1695 \\[calendar-print-day-of-year] show day number and the number of days remaining in the year
1697 Equivalent dates on the ISO commercial, Julian, Hebrew, Islamic, French
1698 Revolutionary, and Mayan calendars can be determined by
1700 \\[calendar-print-iso-date] show equivalent date on the ISO commercial calendar
1701 \\[calendar-print-julian-date] show equivalent date on the Julian calendar
1702 \\[calendar-print-hebrew-date] show equivalent date on the Hebrew calendar
1703 \\[calendar-print-islamic-date] show equivalent date on the Islamic calendar
1704 \\[calendar-print-french-date] show equivalent date on the French Revolutionary calendar
1705 \\[calendar-print-mayan-date] show equivalent date on the Mayan calendar
1707 The astronomical (Julian) day number of a date is found with
1709 \\[calendar-print-astro-day-number] show equivalent astronomical (Julian) day number
1711 To find the times of sunrise and sunset and lunar phases use
1713 \\[calendar-sunrise-sunset] show times of sunrise and sunset
1714 \\[calendar-phases-of-moon] show times of quarters of the moon
1716 The times given apply to location `calendar-location-name' at latitude
1717 `calendar-latitude', longitude `calendar-longitude'; set these variables for
1718 your location. The following variables are also consulted, and you must set
1719 them if your system does not initialize them properly: `calendar-time-zone',
1720 `calendar-daylight-time-offset', `calendar-standard-time-zone-name',
1721 `calendar-daylight-time-zone-name', `calendar-daylight-savings-starts',
1722 `calendar-daylight-savings-ends', `calendar-daylight-savings-starts-time',
1723 `calendar-daylight-savings-ends-time'.
1725 To exit from the calendar use
1727 \\[exit-calendar] exit from calendar
1729 Set `view-diary-entries-initially' to a non-nil value to display
1730 diary entries for the current date in
1731 another window when the calendar is first displayed, if the current date is
1732 visible. The variable `number-of-diary-entries' controls number of days of
1733 diary entries that to display initially or with the command M-x
1734 diary. For example, the default value 1 says to display only the current
1735 day's diary entries. The value 2 says to display both the
1736 current day's and the next day's entries.
1738 The value can also be a vector such as [0 2 2 2 2 4 1]; this value
1739 says to display no diary entries on Sunday, the display the entries
1740 for the current date and the day after on Monday through Thursday,
1741 display Friday through Monday's entries on Friday, and display only
1742 Saturday's entries on Saturday.
1744 Set `view-calendar-holidays-initially' to a non-nil value to display
1745 holidays for the current three month period on entry to the calendar.
1747 Set `mark-diary-entries-in-calendar' to a non-nil value to mark in the
1748 calendar all the dates that have diary entries. The variable
1749 `diary-entry-marker' controls how to mark them.
1751 The variable `calendar-load-hook', whose default value is nil, is list of
1752 functions to be called when the calendar is first loaded.
1754 The variable `initial-calendar-window-hook', whose default value is nil, is
1755 list of functions to be called when the calendar window is first opened. The
1756 functions invoked are called after the calendar window is opened, but once
1757 opened is never called again. Leaving the calendar with the `q' command and
1758 reentering it will cause these functions to be called again.
1760 The variable `today-visible-calendar-hook', whose default value is nil, is the
1761 list of functions called after the calendar buffer has been prepared with the
1762 calendar when the current date is visible in the window. This can be used,
1763 for example, to replace today's date with asterisks; a function
1764 calendar-star-date is included for this purpose:
1765 (setq today-visible-calendar-hook 'calendar-star-date)
1766 It could also be used to mark the current date; a function is also provided
1767 for this:
1768 (setq today-visible-calendar-hook 'calendar-mark-today)
1770 The variable `today-invisible-calendar-hook', whose default value is nil, is
1771 the list of functions called after the calendar buffer has been prepared with
1772 the calendar when the current date is not visible in the window.
1774 The variable `diary-display-hook' is the list of functions called after the
1775 diary buffer is prepared. The default value simply displays the diary file
1776 using selective-display to conceal irrelevant diary entries. An alternative
1777 function `fancy-diary-display' is provided that, when used as the
1778 `diary-display-hook', causes a noneditable buffer to be prepared with a neatly
1779 organized day-by-day listing of relevant diary entries, together with any
1780 known holidays. The inclusion of the holidays slows this fancy display of the
1781 diary; to speed it up, set the variable `holidays-in-diary-buffer' to nil.
1783 The variable `print-diary-entries-hook' is the list of functions called after
1784 a temporary buffer is prepared with the diary entries currently visible in the
1785 diary buffer. The default value of this hook adds a heading (composed from
1786 the diary buffer's mode line), does the printing with the command lpr-buffer,
1787 and kills the temporary buffer. Other uses might include, for example,
1788 rearranging the lines into order by day and time.
1790 The Gregorian calendar is assumed."
1792 (kill-all-local-variables)
1793 (setq major-mode 'calendar-mode)
1794 (setq mode-name "Calendar")
1795 (use-local-map calendar-mode-map)
1796 (setq buffer-read-only t)
1797 (setq indent-tabs-mode nil)
1798 (update-calendar-mode-line)
1799 (make-local-variable 'calendar-window-configuration);; Windows on entry.
1800 (make-local-variable 'calendar-mark-ring)
1801 (make-local-variable 'displayed-month);; Month in middle of window.
1802 (make-local-variable 'displayed-year));; Year in middle of window.
1804 (defun calendar-string-spread (strings char length)
1805 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH
1806 There must be at least 2 strings. The effect is like mapconcat but the
1807 separating pieces are as balanced as possible. Each item of STRINGS is
1808 evaluated before concatenation so it can actually be an expression that
1809 evaluates to a string. If LENGTH is too short, the STRINGS are just
1810 concatenated and the result truncated."
1811 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
1812 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
1813 ;; Addison-Wesley, Reading, MA, 1989
1814 (let* ((strings (mapcar 'eval strings))
1815 (n (- length (length (apply 'concat strings))))
1816 (m (1- (length strings)))
1817 (s (car strings))
1818 (strings (cdr strings))
1819 (i 0))
1820 (while strings
1821 (setq s (concat s
1822 (make-string (max 0 (/ (+ n i) m)) char)
1823 (car strings)))
1824 (setq i (1+ i))
1825 (setq strings (cdr strings)))
1826 (substring s 0 length)))
1828 (defun update-calendar-mode-line ()
1829 "Update the calendar mode line with the current date and date style."
1830 (if (bufferp (get-buffer calendar-buffer))
1831 (save-excursion
1832 (set-buffer calendar-buffer)
1833 (setq mode-line-format
1834 (calendar-string-spread
1835 calendar-mode-line-format ? (frame-width))))))
1837 (defun exit-calendar ()
1838 "Get out of the calendar window and bury it and related buffers."
1839 (interactive)
1840 (let ((diary-buffer (get-file-buffer diary-file))
1841 (d-buffer (get-buffer fancy-diary-buffer))
1842 (h-buffer (get-buffer holiday-buffer)))
1843 (if (not diary-buffer)
1844 (progn
1845 (set-window-configuration calendar-window-configuration)
1846 (bury-buffer calendar-buffer)
1847 (if d-buffer (bury-buffer d-buffer))
1848 (if h-buffer (bury-buffer h-buffer)))
1849 (if (or (not (buffer-modified-p diary-buffer))
1850 (yes-or-no-p "Diary modified; do you really want to exit the calendar? "))
1851 (progn
1852 (set-window-configuration calendar-window-configuration)
1853 (bury-buffer calendar-buffer)
1854 (if d-buffer (bury-buffer d-buffer))
1855 (if h-buffer (bury-buffer h-buffer))
1856 (set-buffer diary-buffer)
1857 (set-buffer-modified-p nil)
1858 (bury-buffer diary-buffer))))))
1860 (defun calendar-current-month ()
1861 "Reposition the calendar window so the current date is visible."
1862 (interactive)
1863 (let ((today (calendar-current-date)));; The date might have changed.
1864 (if (not (calendar-date-is-visible-p today))
1865 (generate-calendar-window)
1866 (update-calendar-mode-line)
1867 (calendar-cursor-to-visible-date today))))
1869 (defun calendar-forward-month (arg)
1870 "Move the cursor forward ARG months.
1871 Movement is backward if ARG is negative."
1872 (interactive "p")
1873 (calendar-cursor-to-nearest-date)
1874 (let* ((cursor-date (calendar-cursor-to-date t))
1875 (month (extract-calendar-month cursor-date))
1876 (day (extract-calendar-day cursor-date))
1877 (year (extract-calendar-year cursor-date)))
1878 (increment-calendar-month month year arg)
1879 (let ((last (calendar-last-day-of-month month year)))
1880 (if (< last day)
1881 (setq day last)))
1882 ;; Put the new month on the screen, if needed, and go to the new date.
1883 (let ((new-cursor-date (list month day year)))
1884 (if (not (calendar-date-is-visible-p new-cursor-date))
1885 (calendar-other-month month year))
1886 (calendar-cursor-to-visible-date new-cursor-date))))
1888 (defun calendar-forward-year (arg)
1889 "Move the cursor forward by ARG years.
1890 Movement is backward if ARG is negative."
1891 (interactive "p")
1892 (calendar-forward-month (* 12 arg)))
1894 (defun calendar-backward-month (arg)
1895 "Move the cursor backward by ARG months.
1896 Movement is forward if ARG is negative."
1897 (interactive "p")
1898 (calendar-forward-month (- arg)))
1900 (defun calendar-backward-year (arg)
1901 "Move the cursor backward ARG years.
1902 Movement is forward is ARG is negative."
1903 (interactive "p")
1904 (calendar-forward-month (* -12 arg)))
1906 (defun scroll-calendar-left (arg)
1907 "Scroll the displayed calendar left by ARG months.
1908 If ARG is negative the calendar is scrolled right. Maintains the relative
1909 position of the cursor with respect to the calendar as well as possible."
1910 (interactive "p")
1911 (calendar-cursor-to-nearest-date)
1912 (let ((old-date (calendar-cursor-to-date))
1913 (today (calendar-current-date)))
1914 (if (/= arg 0)
1915 (progn
1916 (increment-calendar-month displayed-month displayed-year arg)
1917 (generate-calendar-window displayed-month displayed-year)
1918 (calendar-cursor-to-visible-date
1919 (cond
1920 ((calendar-date-is-visible-p old-date) old-date)
1921 ((calendar-date-is-visible-p today) today)
1922 (t (list displayed-month 1 displayed-year))))))))
1924 (defun scroll-calendar-right (arg)
1925 "Scroll the displayed calendar window right by ARG months.
1926 If ARG is negative the calendar is scrolled left. Maintains the relative
1927 position of the cursor with respect to the calendar as well as possible."
1928 (interactive "p")
1929 (scroll-calendar-left (- arg)))
1931 (defun scroll-calendar-left-three-months (arg)
1932 "Scroll the displayed calendar window left by 3*ARG months.
1933 If ARG is negative the calendar is scrolled right. Maintains the relative
1934 position of the cursor with respect to the calendar as well as possible."
1935 (interactive "p")
1936 (scroll-calendar-left (* 3 arg)))
1938 (defun scroll-calendar-right-three-months (arg)
1939 "Scroll the displayed calendar window right by 3*ARG months.
1940 If ARG is negative the calendar is scrolled left. Maintains the relative
1941 position of the cursor with respect to the calendar as well as possible."
1942 (interactive "p")
1943 (scroll-calendar-left (* -3 arg)))
1945 (defun calendar-current-date ()
1946 "Returns the current date in a list (month day year).
1947 If in the calendar buffer, also sets the current date local variables."
1948 (let* ((date (current-time-string))
1949 (garbage
1950 (string-match
1951 "^\\([A-Z][a-z]*\\) *\\([A-Z][a-z]*\\) *\\([0-9]*\\) .* \\([0-9]*\\)$"
1952 date))
1953 (month
1954 (cdr (assoc
1955 (substring date (match-beginning 2) (match-end 2))
1956 '(("Jan" . 1) ("Feb" . 2) ("Mar" . 3) ("Apr" . 4)
1957 ("May" . 5) ("Jun" . 6) ("Jul" . 7) ("Aug" . 8)
1958 ("Sep" . 9) ("Oct" . 10) ("Nov" . 11) ("Dec" . 12)))))
1959 (day
1960 (string-to-int (substring date (match-beginning 3) (match-end 3))))
1961 (year
1962 (string-to-int (substring date (match-beginning 4) (match-end 4)))))
1963 (list month day year)))
1965 (defun calendar-cursor-to-date (&optional error)
1966 "Returns a list of the month, day, and year of current cursor position.
1967 If cursor is not on a specific date, signals an error if optional parameter
1968 ERROR is t, otherwise just returns nil."
1969 (let* ((segment (/ (current-column) 25))
1970 (month (% (+ displayed-month segment -1) 12))
1971 (month (if (= 0 month) 12 month))
1972 (year
1973 (cond
1974 ((and (= 12 month) (= segment 0)) (1- displayed-year))
1975 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
1976 (t displayed-year))))
1977 (if (and (looking-at "[0-9]")
1978 (< 2 (count-lines (point-min) (point))))
1979 (save-excursion
1980 (re-search-backward "[^0-9]")
1981 (list month
1982 (string-to-int (buffer-substring (1+ (point)) (+ 4 (point))))
1983 year))
1984 (if (and (looking-at "\\*")
1985 (save-excursion
1986 (re-search-backward "[^*]")
1987 (looking-at ".\\*\\*")))
1988 (list month starred-day year)
1989 (if error (error "Cursor is not on a date!"))))))
1991 (defun calendar-cursor-to-nearest-date ()
1992 "Move the cursor to the closest date.
1993 The position of the cursor is unchanged if it is already on a date.
1994 Returns the list (month day year) giving the cursor position."
1995 (let ((date (calendar-cursor-to-date))
1996 (column (current-column)))
1997 (if date
1998 date
1999 (if (> 3 (count-lines (point-min) (point)))
2000 (progn
2001 (goto-line 3)
2002 (move-to-column column)))
2003 (if (not (looking-at "[0-9]"))
2004 (if (and (not (looking-at " *$"))
2005 (or (< column 25)
2006 (and (> column 27)
2007 (< column 50))
2008 (and (> column 52)
2009 (< column 75))))
2010 (progn
2011 (re-search-forward "[0-9]" nil t)
2012 (backward-char 1))
2013 (re-search-backward "[0-9]" nil t)))
2014 (calendar-cursor-to-date))))
2016 (defun calendar-forward-day (arg)
2017 "Move the cursor forward ARG days.
2018 Moves backward if ARG is negative."
2019 (interactive "p")
2020 (if (/= 0 arg)
2021 (let*
2022 ((cursor-date (calendar-cursor-to-date))
2023 (cursor-date (if cursor-date
2024 cursor-date
2025 (if (> arg 0) (setq arg (1- arg)))
2026 (calendar-cursor-to-nearest-date)))
2027 (new-cursor-date
2028 (calendar-gregorian-from-absolute
2029 (+ (calendar-absolute-from-gregorian cursor-date) arg)))
2030 (new-display-month (extract-calendar-month new-cursor-date))
2031 (new-display-year (extract-calendar-year new-cursor-date)))
2032 ;; Put the new month on the screen, if needed, and go to the new date.
2033 (if (not (calendar-date-is-visible-p new-cursor-date))
2034 (calendar-other-month new-display-month new-display-year))
2035 (calendar-cursor-to-visible-date new-cursor-date))))
2037 (defun calendar-backward-day (arg)
2038 "Move the cursor back ARG days.
2039 Moves forward if ARG is negative."
2040 (interactive "p")
2041 (calendar-forward-day (- arg)))
2043 (defun calendar-forward-week (arg)
2044 "Move the cursor forward ARG weeks.
2045 Moves backward if ARG is negative."
2046 (interactive "p")
2047 (calendar-forward-day (* arg 7)))
2049 (defun calendar-backward-week (arg)
2050 "Move the cursor back ARG weeks.
2051 Moves forward if ARG is negative."
2052 (interactive "p")
2053 (calendar-forward-day (* arg -7)))
2055 (defun calendar-beginning-of-week (arg)
2056 "Move the cursor back ARG calendar-week-start-day's."
2057 (interactive "p")
2058 (calendar-cursor-to-nearest-date)
2059 (let ((day (calendar-day-of-week (calendar-cursor-to-date))))
2060 (calendar-backward-day
2061 (if (= day calendar-week-start-day)
2062 (* 7 arg)
2063 (+ (calendar-mod (- day calendar-week-start-day) 7)
2064 (* 7 (1- arg)))))))
2066 (defun calendar-end-of-week (arg)
2067 "Move the cursor forward ARG calendar-week-start-day+6's."
2068 (interactive "p")
2069 (calendar-cursor-to-nearest-date)
2070 (let ((day (calendar-day-of-week (calendar-cursor-to-date))))
2071 (calendar-forward-day
2072 (if (= day (calendar-mod (1- calendar-week-start-day) 7))
2073 (* 7 arg)
2074 (+ (- 6 (calendar-mod (- day calendar-week-start-day) 7))
2075 (* 7 (1- arg)))))))
2077 (defun calendar-beginning-of-month (arg)
2078 "Move the cursor backward ARG month beginnings."
2079 (interactive "p")
2080 (calendar-cursor-to-nearest-date)
2081 (let* ((date (calendar-cursor-to-date))
2082 (month (extract-calendar-month date))
2083 (day (extract-calendar-day date))
2084 (year (extract-calendar-year date)))
2085 (if (= day 1)
2086 (calendar-backward-month arg)
2087 (calendar-cursor-to-visible-date (list month 1 year))
2088 (calendar-backward-month (1- arg)))))
2090 (defun calendar-end-of-month (arg)
2091 "Move the cursor forward ARG month ends."
2092 (interactive "p")
2093 (calendar-cursor-to-nearest-date)
2094 (let* ((date (calendar-cursor-to-date))
2095 (month (extract-calendar-month date))
2096 (day (extract-calendar-day date))
2097 (year (extract-calendar-year date))
2098 (last-day (calendar-last-day-of-month month year)))
2099 (if (/= day last-day)
2100 (progn
2101 (calendar-cursor-to-visible-date (list month last-day year))
2102 (setq arg (1- arg))))
2103 (increment-calendar-month month year arg)
2104 (let ((last-day (list
2105 month
2106 (calendar-last-day-of-month month year)
2107 year)))
2108 (if (not (calendar-date-is-visible-p last-day))
2109 (calendar-other-month month year)
2110 (calendar-cursor-to-visible-date last-day)))))
2112 (defun calendar-beginning-of-year (arg)
2113 "Move the cursor backward ARG year beginnings."
2114 (interactive "p")
2115 (calendar-cursor-to-nearest-date)
2116 (let* ((date (calendar-cursor-to-date))
2117 (month (extract-calendar-month date))
2118 (day (extract-calendar-day date))
2119 (year (extract-calendar-year date))
2120 (jan-first (list 1 1 year)))
2121 (if (and (= day 1) (= 1 month))
2122 (calendar-backward-month (* 12 arg))
2123 (if (and (= arg 1)
2124 (calendar-date-is-visible-p jan-first))
2125 (calendar-cursor-to-visible-date jan-first)
2126 (calendar-other-month 1 (- year (1- arg)))))))
2128 (defun calendar-end-of-year (arg)
2129 "Move the cursor forward ARG year beginnings."
2130 (interactive "p")
2131 (calendar-cursor-to-nearest-date)
2132 (let* ((date (calendar-cursor-to-date))
2133 (month (extract-calendar-month date))
2134 (day (extract-calendar-day date))
2135 (year (extract-calendar-year date))
2136 (dec-31 (list 12 31 year)))
2137 (if (and (= day 31) (= 12 month))
2138 (calendar-forward-month (* 12 arg))
2139 (if (and (= arg 1)
2140 (calendar-date-is-visible-p dec-31))
2141 (calendar-cursor-to-visible-date dec-31)
2142 (calendar-other-month 12 (- year (1- arg)))
2143 (calendar-cursor-to-visible-date (list 12 31 displayed-year))))))
2145 ;; The following version of calendar-gregorian-from-absolute is preferred for
2146 ;; reasons of clarity, BUT it's much slower than the version that follows it.
2148 ;;(defun calendar-gregorian-from-absolute (date)
2149 ;; "Compute the list (month day year) corresponding to the absolute DATE.
2150 ;;The absolute date is the number of days elapsed since the (imaginary)
2151 ;;Gregorian date Sunday, December 31, 1 BC."
2152 ;; (let* ((approx (/ date 366));; Approximation from below.
2153 ;; (year ;; Search forward from the approximation.
2154 ;; (+ approx
2155 ;; (calendar-sum y approx
2156 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2157 ;; 1)))
2158 ;; (month ;; Search forward from January.
2159 ;; (1+ (calendar-sum m 1
2160 ;; (> date
2161 ;; (calendar-absolute-from-gregorian
2162 ;; (list m (calendar-last-day-of-month m year) year)))
2163 ;; 1)))
2164 ;; (day ;; Calculate the day by subtraction.
2165 ;; (- date
2166 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2167 ;; (list month day year)))
2169 (defun calendar-gregorian-from-absolute (date)
2170 "Compute the list (month day year) corresponding to the absolute DATE.
2171 The absolute date is the number of days elapsed since the (imaginary)
2172 Gregorian date Sunday, December 31, 1 BC."
2173 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2174 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2175 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2176 ;; (April, 1993), pages 383-404 for an explanation.
2177 (let* ((d0 (1- date))
2178 (n400 (/ d0 146097))
2179 (d1 (% d0 146097))
2180 (n100 (/ d1 36524))
2181 (d2 (% d1 36524))
2182 (n4 (/ d2 1461))
2183 (d3 (% d2 1461))
2184 (n1 (/ d3 365))
2185 (day (1+ (% d3 365)))
2186 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2187 (if (or (= n100 4) (= n1 4))
2188 (list 12 31 year)
2189 (let ((year (1+ year))
2190 (month 1))
2191 (while (let ((mdays (calendar-last-day-of-month month year)))
2192 (and (< mdays day)
2193 (setq day (- day mdays))))
2194 (setq month (1+ month)))
2195 (list month day year)))))
2197 (defun calendar-mod (x y)
2198 "Returns X % Y; value is *always* non-negative."
2199 (let ((v (mod x y)))
2200 (if (> 0 v)
2201 (+ v y)
2202 v)))
2204 (defun calendar-cursor-to-visible-date (date)
2205 "Move the cursor to DATE that is on the screen."
2206 (let* ((month (extract-calendar-month date))
2207 (day (extract-calendar-day date))
2208 (year (extract-calendar-year date))
2209 (first-of-month-weekday (calendar-day-of-week (list month 1 year))))
2210 (goto-line (+ 3
2211 (/ (+ day -1
2212 (calendar-mod
2213 (- (calendar-day-of-week (list month 1 year))
2214 calendar-week-start-day)
2216 7)))
2217 (move-to-column (+ 6
2218 (* 25
2219 (1+ (calendar-interval
2220 displayed-month displayed-year month year)))
2221 (* 3 (calendar-mod
2222 (- (calendar-day-of-week date)
2223 calendar-week-start-day)
2224 7))))))
2226 (defun calendar-other-month (month year)
2227 "Display a three-month calendar centered around MONTH and YEAR."
2228 (interactive
2229 (let* ((completion-ignore-case t)
2230 (month (cdr (assoc
2231 (capitalize
2232 (completing-read
2233 "Month name: "
2234 (mapcar 'list (append calendar-month-name-array nil))
2235 nil t))
2236 (calendar-make-alist calendar-month-name-array))))
2237 (year (calendar-read
2238 "Year (>0): "
2239 '(lambda (x) (> x 0))
2240 (int-to-string
2241 (extract-calendar-year (calendar-current-date))))))
2242 (list month year)))
2243 (if (and (= month displayed-month)
2244 (= year displayed-year))
2246 (let ((old-date (calendar-cursor-to-date))
2247 (today (calendar-current-date)))
2248 (generate-calendar-window month year)
2249 (calendar-cursor-to-visible-date
2250 (cond
2251 ((calendar-date-is-visible-p old-date) old-date)
2252 ((calendar-date-is-visible-p today) today)
2253 (t (list month 1 year)))))))
2255 (defun calendar-set-mark (arg)
2256 "Mark the date under the cursor, or jump to marked date.
2257 With no prefix argument, push current date onto marked date ring.
2258 With argument, jump to mark, pop it, and put point at end of ring."
2259 (interactive "P")
2260 (let ((date (calendar-cursor-to-date t)))
2261 (if (null arg)
2262 (progn
2263 (setq calendar-mark-ring (cons date calendar-mark-ring))
2264 ;; Since the top of the mark ring is the marked date in the
2265 ;; calendar, the mark ring in the calendar is one longer than
2266 ;; in other buffers to get the same effect.
2267 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2268 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2269 (message "Mark set"))
2270 (if (null calendar-mark-ring)
2271 (error "No mark set in this buffer")
2272 (calendar-goto-date (car calendar-mark-ring))
2273 (setq calendar-mark-ring
2274 (cdr (nconc calendar-mark-ring (list date))))))))
2276 (defun calendar-exchange-point-and-mark ()
2277 "Exchange the current cursor position with the marked date."
2278 (interactive)
2279 (let ((mark (car calendar-mark-ring))
2280 (date (calendar-cursor-to-date t)))
2281 (if (null mark)
2282 (error "No mark set in this buffer")
2283 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2284 (calendar-goto-date mark))))
2286 (defun calendar-count-days-region ()
2287 "Count the number of days (inclusive) between point and the mark."
2288 (interactive)
2289 (let* ((days (- (calendar-absolute-from-gregorian
2290 (calendar-cursor-to-date t))
2291 (calendar-absolute-from-gregorian
2292 (or (car calendar-mark-ring)
2293 (error "No mark set in this buffer")))))
2294 (days (1+ (if (> days 0) days (- days)))))
2295 (message "Region has %d day%s (inclusive)"
2296 days (if (> days 1) "s" ""))))
2298 (defun calendar-not-implemented ()
2299 "Not implemented."
2300 (interactive)
2301 (error "%s not available in the calendar"
2302 (global-key-binding (this-command-keys))))
2304 (defun calendar-read (prompt acceptable &optional initial-contents)
2305 "Return an object read from the minibuffer.
2306 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2307 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2308 is a string to insert in the minibuffer before reading."
2309 (let ((value (read-minibuffer prompt initial-contents)))
2310 (while (not (funcall acceptable value))
2311 (setq value (read-minibuffer prompt initial-contents)))
2312 value))
2314 (defun calendar-read-date ()
2315 "Prompt for Gregorian date. Returns a list (month day year)."
2316 (let* ((year (calendar-read
2317 "Year (>0): "
2318 '(lambda (x) (> x 0))
2319 (int-to-string (extract-calendar-year
2320 (calendar-current-date)))))
2321 (month-array calendar-month-name-array)
2322 (completion-ignore-case t)
2323 (month (cdr (assoc
2324 (capitalize
2325 (completing-read
2326 "Month name: "
2327 (mapcar 'list (append month-array nil))
2328 nil t))
2329 (calendar-make-alist month-array 1 'capitalize))))
2330 (last (calendar-last-day-of-month month year))
2331 (day (calendar-read
2332 (format "Day (1-%d): " last)
2333 '(lambda (x) (and (< 0 x) (<= x last))))))
2334 (list month day year)))
2336 (defun calendar-goto-date (date)
2337 "Move cursor to DATE."
2338 (interactive (list (calendar-read-date)))
2339 (let ((month (extract-calendar-month date))
2340 (year (extract-calendar-year date)))
2341 (if (not (calendar-date-is-visible-p date))
2342 (calendar-other-month
2343 (if (and (= month 1) (= year 1))
2345 month)
2346 year)))
2347 (calendar-cursor-to-visible-date date))
2349 (defun calendar-goto-julian-date (date &optional noecho)
2350 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
2351 (interactive
2352 (let* ((today (calendar-current-date))
2353 (year (calendar-read
2354 "Julian calendar year (>0): "
2355 '(lambda (x) (> x 0))
2356 (int-to-string
2357 (extract-calendar-year
2358 (calendar-julian-from-absolute
2359 (calendar-absolute-from-gregorian
2360 today))))))
2361 (month-array calendar-month-name-array)
2362 (completion-ignore-case t)
2363 (month (cdr (assoc
2364 (capitalize
2365 (completing-read
2366 "Julian calendar month name: "
2367 (mapcar 'list (append month-array nil))
2368 nil t))
2369 (calendar-make-alist month-array 1 'capitalize))))
2370 (last
2371 (if (and (zerop (% year 4)) (= month 2))
2373 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
2374 (day (calendar-read
2375 (format "Julian calendar day (%d-%d): "
2376 (if (and (= year 1) (= month 1)) 3 1) last)
2377 '(lambda (x)
2378 (and (< (if (and (= year 1) (= month 1)) 2 0) x)
2379 (<= x last))))))
2380 (list (list month day year))))
2381 (calendar-goto-date (calendar-gregorian-from-absolute
2382 (calendar-absolute-from-julian date)))
2383 (or noecho (calendar-print-julian-date)))
2385 (defun calendar-goto-hebrew-date (date &optional noecho)
2386 "Move cursor to Hebrew DATE; echo Hebrew date unless NOECHO is t."
2387 (interactive
2388 (let* ((today (calendar-current-date))
2389 (year (calendar-read
2390 "Hebrew calendar year (>3760): "
2391 '(lambda (x) (> x 3760))
2392 (int-to-string
2393 (extract-calendar-year
2394 (calendar-hebrew-from-absolute
2395 (calendar-absolute-from-gregorian today))))))
2396 (month-array (if (hebrew-calendar-leap-year-p year)
2397 calendar-hebrew-month-name-array-leap-year
2398 calendar-hebrew-month-name-array-common-year))
2399 (completion-ignore-case t)
2400 (month (cdr (assoc
2401 (capitalize
2402 (completing-read
2403 "Hebrew calendar month name: "
2404 (mapcar 'list (append month-array nil))
2405 (if (= year 3761)
2406 '(lambda (x)
2407 (let ((m (cdr
2408 (assoc
2409 (car x)
2410 (calendar-make-alist
2411 month-array)))))
2412 (< 0
2413 (calendar-absolute-from-hebrew
2414 (list m
2415 (hebrew-calendar-last-day-of-month
2416 m year)
2417 year))))))
2420 (calendar-make-alist month-array 1 'capitalize))))
2421 (last (hebrew-calendar-last-day-of-month month year))
2422 (first (if (and (= year 3761) (= month 10))
2423 18 1))
2424 (day (calendar-read
2425 (format "Hebrew calendar day (%d-%d): "
2426 first last)
2427 '(lambda (x) (and (<= first x) (<= x last))))))
2428 (list (list month day year))))
2429 (calendar-goto-date (calendar-gregorian-from-absolute
2430 (calendar-absolute-from-hebrew date)))
2431 (or noecho (calendar-print-hebrew-date)))
2433 (defun calendar-goto-islamic-date (date &optional noecho)
2434 "Move cursor to Islamic DATE; echo Islamic date unless NOECHO is t."
2435 (interactive
2436 (let* ((today (calendar-current-date))
2437 (year (calendar-read
2438 "Islamic calendar year (>0): "
2439 '(lambda (x) (> x 0))
2440 (int-to-string
2441 (extract-calendar-year
2442 (calendar-islamic-from-absolute
2443 (calendar-absolute-from-gregorian today))))))
2444 (month-array calendar-islamic-month-name-array)
2445 (completion-ignore-case t)
2446 (month (cdr (assoc
2447 (capitalize
2448 (completing-read
2449 "Islamic calendar month name: "
2450 (mapcar 'list (append month-array nil))
2451 nil t))
2452 (calendar-make-alist month-array 1 'capitalize))))
2453 (last (islamic-calendar-last-day-of-month month year))
2454 (day (calendar-read
2455 (format "Islamic calendar day (1-%d): " last)
2456 '(lambda (x) (and (< 0 x) (<= x last))))))
2457 (list (list month day year))))
2458 (calendar-goto-date (calendar-gregorian-from-absolute
2459 (calendar-absolute-from-islamic date)))
2460 (or noecho (calendar-print-islamic-date)))
2462 (defun calendar-goto-iso-date (date &optional noecho)
2463 "Move cursor to ISO DATE; echo ISO date unless NOECHO is t."
2464 (interactive
2465 (let* ((today (calendar-current-date))
2466 (year (calendar-read
2467 "ISO calendar year (>0): "
2468 '(lambda (x) (> x 0))
2469 (int-to-string (extract-calendar-year today))))
2470 (no-weeks (extract-calendar-month
2471 (calendar-iso-from-absolute
2473 (calendar-dayname-on-or-before
2474 1 (calendar-absolute-from-gregorian
2475 (list 1 4 (1+ year))))))))
2476 (week (calendar-read
2477 (format "ISO calendar week (1-%d): " no-weeks)
2478 '(lambda (x) (and (> x 0) (<= x no-weeks)))))
2479 (day (calendar-read
2480 "ISO day (1-7): "
2481 '(lambda (x) (and (<= 1 x) (<= x 7))))))
2482 (list (list week day year))))
2483 (calendar-goto-date (calendar-gregorian-from-absolute
2484 (calendar-absolute-from-iso date)))
2485 (or noecho (calendar-print-iso-date)))
2487 (defun calendar-interval (mon1 yr1 mon2 yr2)
2488 "The number of months difference between MON1, YR1 and MON2, YR2."
2489 (+ (* 12 (- yr2 yr1))
2490 (- mon2 mon1)))
2492 (defun calendar-day-name (date)
2493 "Returns a string with the name of the day of the week of DATE."
2494 (aref calendar-day-name-array (calendar-day-of-week date)))
2496 (defvar calendar-day-name-array
2497 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"])
2499 (defvar calendar-month-name-array
2500 ["January" "February" "March" "April" "May" "June"
2501 "July" "August" "September" "October" "November" "December"])
2503 (defun calendar-make-alist (sequence &optional start-index filter)
2504 "Make an assoc list corresponding to SEQUENCE.
2505 Start at index 1, unless optional START-INDEX is provided.
2506 If FILTER is provided, apply it to each item in the list."
2507 (let ((index (if start-index (1- start-index) 0)))
2508 (mapcar
2509 '(lambda (x)
2510 (setq index (1+ index))
2511 (cons (if filter (funcall filter x) x)
2512 index))
2513 (append sequence nil))))
2515 (defun calendar-month-name (month)
2516 "The name of MONTH."
2517 (aref calendar-month-name-array (1- month)))
2519 (defun calendar-day-of-week (date)
2520 "Returns the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc."
2521 (% (calendar-absolute-from-gregorian date) 7))
2523 (defun calendar-unmark ()
2524 "Delete all diary/holiday marks/highlighting from the calendar."
2525 (interactive)
2526 (setq mark-holidays-in-calendar nil)
2527 (setq mark-diary-entries-in-calendar nil)
2528 (redraw-calendar))
2530 (defun calendar-date-is-visible-p (date)
2531 "Returns t if DATE is legal and is visible in the calendar window."
2532 (let ((gap (calendar-interval
2533 displayed-month displayed-year
2534 (extract-calendar-month date) (extract-calendar-year date))))
2535 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2537 (defun calendar-date-is-legal-p (date)
2538 "Returns t if DATE is a legal date."
2539 (let ((month (extract-calendar-month date))
2540 (day (extract-calendar-day date))
2541 (year (extract-calendar-year date)))
2542 (and (<= 1 month) (<= month 12)
2543 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2544 (<= 1 year))))
2546 (defun calendar-date-equal (date1 date2)
2547 "Returns t if the DATE1 and DATE2 are the same."
2548 (and
2549 (= (extract-calendar-month date1) (extract-calendar-month date2))
2550 (= (extract-calendar-day date1) (extract-calendar-day date2))
2551 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2553 (defun mark-visible-calendar-date (date &optional mark)
2554 "Mark DATE in the calendar window with MARK.
2555 MARK is either a single-character string or a face.
2556 MARK defaults to diary-entry-marker."
2557 (if (calendar-date-is-legal-p date)
2558 (save-excursion
2559 (set-buffer calendar-buffer)
2560 (calendar-cursor-to-visible-date date)
2561 (let ((mark (or mark diary-entry-marker)))
2562 (if (stringp mark)
2563 (let ((buffer-read-only nil))
2564 (forward-char 1)
2565 (delete-char 1)
2566 (insert mark)
2567 (forward-char -2))
2568 (overlay-put
2569 (make-overlay (1-(point)) (1+ (point))) 'face mark))))))
2571 (defun calendar-star-date ()
2572 "Replace the date under the cursor in the calendar window with asterisks.
2573 This function can be used with the today-visible-calendar-hook run after the
2574 calendar window has been prepared."
2575 (let ((buffer-read-only nil))
2576 (make-variable-buffer-local 'starred-day)
2577 (forward-char 1)
2578 (setq starred-day
2579 (string-to-int
2580 (buffer-substring (point) (- (point) 2))))
2581 (delete-char -2)
2582 (insert "**")
2583 (backward-char 1)
2584 (set-buffer-modified-p nil)))
2586 (defun calendar-mark-today ()
2587 "Mark the date under the cursor in the calendar window.
2588 The date is marked with calendar-today-marker. This function can be used with
2589 the today-visible-calendar-hook run after the calendar window has been
2590 prepared."
2591 (mark-visible-calendar-date
2592 (calendar-cursor-to-date)
2593 calendar-today-marker))
2595 (defun calendar-date-compare (date1 date2)
2596 "Returns t if DATE1 is before DATE2, nil otherwise.
2597 The actual dates are in the car of DATE1 and DATE2."
2598 (< (calendar-absolute-from-gregorian (car date1))
2599 (calendar-absolute-from-gregorian (car date2))))
2601 (defun calendar-date-string (date &optional abbreviate nodayname)
2602 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2603 An optional parameter ABBREVIATE, when t, causes the month and day names to be
2604 abbreviated to three characters. An optional parameter NODAYNAME, when t,
2605 omits the name of the day of the week."
2606 (let* ((dayname
2607 (if nodayname
2609 (if abbreviate
2610 (substring (calendar-day-name date) 0 3)
2611 (calendar-day-name date))))
2612 (month (extract-calendar-month date))
2613 (monthname
2614 (if abbreviate
2615 (substring
2616 (calendar-month-name month) 0 3)
2617 (calendar-month-name month)))
2618 (day (int-to-string (extract-calendar-day date)))
2619 (month (int-to-string month))
2620 (year (int-to-string (extract-calendar-year date))))
2621 (mapconcat 'eval calendar-date-display-form "")))
2623 (defun calendar-dayname-on-or-before (dayname date)
2624 "Returns the absolute date of the DAYNAME on or before absolute DATE.
2625 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
2627 Note: Applying this function to d+6 gives us the DAYNAME on or after an
2628 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
2629 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
2630 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
2631 (- date (% (- date dayname) 7)))
2633 (defun calendar-nth-named-absday (n dayname month year &optional day)
2634 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2635 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2636 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2637 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2639 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2640 (if (> n 0)
2641 (+ (* 7 (1- n))
2642 (calendar-dayname-on-or-before
2643 dayname
2644 (+ 6 (calendar-absolute-from-gregorian
2645 (list month (or day 1) year)))))
2646 (+ (* 7 (1+ n))
2647 (calendar-dayname-on-or-before
2648 dayname
2649 (calendar-absolute-from-gregorian
2650 (list month
2651 (or day (calendar-last-day-of-month month year))
2652 year))))))
2654 (defun calendar-nth-named-day (n dayname month year &optional day)
2655 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2656 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2657 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2658 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2660 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2661 (calendar-gregorian-from-absolute
2662 (calendar-nth-named-absday n dayname month year day)))
2664 (defun calendar-day-of-year-string (&optional date)
2665 "String of day number of year of Gregorian DATE.
2666 Defaults to today's date if DATE is not given."
2667 (let* ((d (or date (calendar-current-date)))
2668 (year (extract-calendar-year d))
2669 (day (calendar-day-number d))
2670 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
2671 (format "Day %d of %d; %d day%s remaining in the year"
2672 day year days-remaining (if (= days-remaining 1) "" "s"))))
2674 (defun calendar-print-day-of-year ()
2675 "Show day number in year/days remaining in year for date under the cursor."
2676 (interactive)
2677 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
2679 (defun calendar-absolute-from-iso (date)
2680 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
2681 The `ISO year' corresponds approximately to the Gregorian year, but
2682 weeks start on Monday and end on Sunday. The first week of the ISO year is
2683 the first such week in which at least 4 days are in a year. The ISO
2684 commercial DATE has the form (week day year) in which week is in the range
2685 1..52 and day is in the range 0..6 (1 = Monday, 2 = Tuesday, ..., 0 =
2686 Sunday). The Gregorian date Sunday, December 31, 1 BC is imaginary."
2687 (let* ((week (extract-calendar-month date))
2688 (day (extract-calendar-day date))
2689 (year (extract-calendar-year date)))
2690 (+ (calendar-dayname-on-or-before
2691 1 (+ 3 (calendar-absolute-from-gregorian (list 1 1 year))))
2692 (* 7 (1- week))
2693 (if (= day 0) 6 (1- day)))))
2695 (defun calendar-iso-from-absolute (date)
2696 "Compute the `ISO commercial date' corresponding to the absolute DATE.
2697 The ISO year corresponds approximately to the Gregorian year, but weeks
2698 start on Monday and end on Sunday. The first week of the ISO year is the
2699 first such week in which at least 4 days are in a year. The ISO commercial
2700 date has the form (week day year) in which week is in the range 1..52 and
2701 day is in the range 0..6 (1 = Monday, 2 = Tuesday, ..., 0 = Sunday). The
2702 absolute date is the number of days elapsed since the (imaginary) Gregorian
2703 date Sunday, December 31, 1 BC."
2704 (let* ((approx (extract-calendar-year
2705 (calendar-gregorian-from-absolute (- date 3))))
2706 (year (+ approx
2707 (calendar-sum y approx
2708 (>= date (calendar-absolute-from-iso (list 1 1 (1+ y))))
2709 1))))
2710 (list
2711 (1+ (/ (- date (calendar-absolute-from-iso (list 1 1 year))) 7))
2712 (% date 7)
2713 year)))
2715 (defun calendar-iso-date-string (&optional date)
2716 "String of ISO date of Gregorian DATE.
2717 Defaults to today's date if DATE is not given."
2718 (let* ((d (calendar-absolute-from-gregorian
2719 (or date (calendar-current-date))))
2720 (day (% d 7))
2721 (iso-date (calendar-iso-from-absolute d)))
2722 (format "Day %s of week %d of %d."
2723 (if (zerop day) 7 day)
2724 (extract-calendar-month iso-date)
2725 (extract-calendar-year iso-date))))
2727 (defun calendar-print-iso-date ()
2728 "Show equivalent ISO date for the date under the cursor."
2729 (interactive)
2730 (message "ISO date: %s"
2731 (calendar-iso-date-string (calendar-cursor-to-date t))))
2733 (defun calendar-julian-from-absolute (date)
2734 "Compute the Julian (month day year) corresponding to the absolute DATE.
2735 The absolute date is the number of days elapsed since the (imaginary)
2736 Gregorian date Sunday, December 31, 1 BC."
2737 (let* ((approx (/ (+ date 2) 366));; Approximation from below.
2738 (year ;; Search forward from the approximation.
2739 (+ approx
2740 (calendar-sum y approx
2741 (>= date (calendar-absolute-from-julian (list 1 1 (1+ y))))
2742 1)))
2743 (month ;; Search forward from January.
2744 (1+ (calendar-sum m 1
2745 (> date
2746 (calendar-absolute-from-julian
2747 (list m
2748 (if (and (= m 2) (= (% year 4) 0))
2750 (aref [31 28 31 30 31 30 31 31 30 31 30 31]
2751 (1- m)))
2752 year)))
2753 1)))
2754 (day ;; Calculate the day by subtraction.
2755 (- date (1- (calendar-absolute-from-julian (list month 1 year))))))
2756 (list month day year)))
2758 (defun calendar-absolute-from-julian (date)
2759 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
2760 The Gregorian date Sunday, December 31, 1 BC is imaginary."
2761 (let ((month (extract-calendar-month date))
2762 (day (extract-calendar-day date))
2763 (year (extract-calendar-year date)))
2764 (+ (calendar-day-number date)
2765 (if (and (= (% year 100) 0)
2766 (/= (% year 400) 0)
2767 (> month 2))
2768 1 0);; Correct for Julian but not Gregorian leap year.
2769 (* 365 (1- year))
2770 (/ (1- year) 4)
2771 -2)))
2773 (defun calendar-julian-date-string (&optional date)
2774 "String of Julian date of Gregorian DATE.
2775 Defaults to today's date if DATE is not given.
2776 Driven by the variable `calendar-date-display-form'."
2777 (calendar-date-string
2778 (calendar-julian-from-absolute
2779 (calendar-absolute-from-gregorian
2780 (or date (calendar-current-date))))
2781 nil t))
2783 (defun calendar-print-julian-date ()
2784 "Show the Julian calendar equivalent of the date under the cursor."
2785 (interactive)
2786 (message "Julian date: %s"
2787 (calendar-julian-date-string (calendar-cursor-to-date t))))
2789 (defun islamic-calendar-leap-year-p (year)
2790 "Returns t if YEAR is a leap year on the Islamic calendar."
2791 (memq (% year 30)
2792 (list 2 5 7 10 13 16 18 21 24 26 29)))
2794 (defun islamic-calendar-last-day-of-month (month year)
2795 "The last day in MONTH during YEAR on the Islamic calendar."
2796 (cond
2797 ((memq month (list 1 3 5 7 9 11)) 30)
2798 ((memq month (list 2 4 6 8 10)) 29)
2799 (t (if (islamic-calendar-leap-year-p year) 30 29))))
2801 (defun islamic-calendar-day-number (date)
2802 "Return the day number within the year of the Islamic date DATE."
2803 (let* ((month (extract-calendar-month date))
2804 (day (extract-calendar-day date)))
2805 (+ (* 30 (/ month 2))
2806 (* 29 (/ (1- month) 2))
2807 day)))
2809 (defun calendar-absolute-from-islamic (date)
2810 "Absolute date of Islamic DATE.
2811 The absolute date is the number of days elapsed since the (imaginary)
2812 Gregorian date Sunday, December 31, 1 BC."
2813 (let* ((month (extract-calendar-month date))
2814 (day (extract-calendar-day date))
2815 (year (extract-calendar-year date))
2816 (y (% year 30))
2817 (leap-years-in-cycle
2818 (cond
2819 ((< y 3) 0) ((< y 6) 1) ((< y 8) 2) ((< y 11) 3) ((< y 14) 4)
2820 ((< y 17) 5) ((< y 19) 6) ((< y 22) 7) ((< y 25) 8) ((< y 27) 9)
2821 (t 10))))
2822 (+ (islamic-calendar-day-number date);; days so far this year
2823 (* (1- year) 354) ;; days in all non-leap years
2824 (* 11 (/ year 30)) ;; leap days in complete cycles
2825 leap-years-in-cycle ;; leap days this cycle
2826 227014))) ;; days before start of calendar
2828 (defun calendar-islamic-from-absolute (date)
2829 "Compute the Islamic date (month day year) corresponding to absolute DATE.
2830 The absolute date is the number of days elapsed since the (imaginary)
2831 Gregorian date Sunday, December 31, 1 BC."
2832 (if (< date 227015)
2833 (list 0 0 0);; pre-Islamic date
2834 (let* ((approx (/ (- date 227014) 355));; Approximation from below.
2835 (year ;; Search forward from the approximation.
2836 (+ approx
2837 (calendar-sum y approx
2838 (>= date (calendar-absolute-from-islamic
2839 (list 1 1 (1+ y))))
2840 1)))
2841 (month ;; Search forward from Muharram.
2842 (1+ (calendar-sum m 1
2843 (> date
2844 (calendar-absolute-from-islamic
2845 (list m
2846 (islamic-calendar-last-day-of-month
2847 m year)
2848 year)))
2849 1)))
2850 (day ;; Calculate the day by subtraction.
2851 (- date
2852 (1- (calendar-absolute-from-islamic (list month 1 year))))))
2853 (list month day year))))
2855 (defvar calendar-islamic-month-name-array
2856 ["Muharram" "Safar" "Rabi I" "Rabi II" "Jumada I" "Jumada II"
2857 "Rajab" "Sha'ban" "Ramadan" "Shawwal" "Dhu al-Qada" "Dhu al-Hijjah"])
2859 (defun calendar-islamic-date-string (&optional date)
2860 "String of Islamic date before sunset of Gregorian DATE.
2861 Returns the empty string if DATE is pre-Islamic.
2862 Defaults to today's date if DATE is not given.
2863 Driven by the variable `calendar-date-display-form'."
2864 (let ((calendar-month-name-array calendar-islamic-month-name-array)
2865 (islamic-date (calendar-islamic-from-absolute
2866 (calendar-absolute-from-gregorian
2867 (or date (calendar-current-date))))))
2868 (if (< (extract-calendar-year islamic-date) 1)
2870 (calendar-date-string islamic-date nil t))))
2872 (defun calendar-print-islamic-date ()
2873 "Show the Islamic calendar equivalent of the date under the cursor."
2874 (interactive)
2875 (let ((i (calendar-islamic-date-string (calendar-cursor-to-date t))))
2876 (if (string-equal i "")
2877 (message "Date is pre-Islamic")
2878 (message "Islamic date (until sunset): %s" i))))
2880 (defun calendar-hebrew-from-absolute (date)
2881 "Compute the Hebrew date (month day year) corresponding to absolute DATE.
2882 The absolute date is the number of days elapsed since the (imaginary)
2883 Gregorian date Sunday, December 31, 1 BC."
2884 (let* ((greg-date (calendar-gregorian-from-absolute date))
2885 (month (aref [9 10 11 12 1 2 3 4 7 7 7 8]
2886 (1- (extract-calendar-month greg-date))))
2887 (day)
2888 (year (+ 3760 (extract-calendar-year greg-date))))
2889 (while (>= date (calendar-absolute-from-hebrew (list 7 1 (1+ year))))
2890 (setq year (1+ year)))
2891 (let ((length (hebrew-calendar-last-month-of-year year)))
2892 (while (> date
2893 (calendar-absolute-from-hebrew
2894 (list month
2895 (hebrew-calendar-last-day-of-month month year)
2896 year)))
2897 (setq month (1+ (% month length)))))
2898 (setq day (1+
2899 (- date (calendar-absolute-from-hebrew (list month 1 year)))))
2900 (list month day year)))
2902 (defun hebrew-calendar-leap-year-p (year)
2903 "t if YEAR is a Hebrew calendar leap year."
2904 (< (% (1+ (* 7 year)) 19) 7))
2906 (defun hebrew-calendar-last-month-of-year (year)
2907 "The last month of the Hebrew calendar YEAR."
2908 (if (hebrew-calendar-leap-year-p year)
2910 12))
2912 (defun hebrew-calendar-last-day-of-month (month year)
2913 "The last day of MONTH in YEAR."
2914 (if (or (memq month (list 2 4 6 10 13))
2915 (and (= month 12) (not (hebrew-calendar-leap-year-p year)))
2916 (and (= month 8) (not (hebrew-calendar-long-heshvan-p year)))
2917 (and (= month 9) (hebrew-calendar-short-kislev-p year)))
2919 30))
2921 (defun hebrew-calendar-elapsed-days (year)
2922 "Days from Sun. prior to start of Hebrew calendar to mean conjunction of Tishri of Hebrew YEAR."
2923 (let* ((months-elapsed
2924 (+ (* 235 (/ (1- year) 19));; Months in complete cycles so far.
2925 (* 12 (% (1- year) 19)) ;; Regular months in this cycle
2926 (/ (1+ (* 7 (% (1- year) 19))) 19)));; Leap months this cycle
2927 (parts-elapsed (+ 204 (* 793 (% months-elapsed 1080))))
2928 (hours-elapsed (+ 5
2929 (* 12 months-elapsed)
2930 (* 793 (/ months-elapsed 1080))
2931 (/ parts-elapsed 1080)))
2932 (parts ;; Conjunction parts
2933 (+ (* 1080 (% hours-elapsed 24)) (% parts-elapsed 1080)))
2934 (day ;; Conjunction day
2935 (+ 1 (* 29 months-elapsed) (/ hours-elapsed 24)))
2936 (alternative-day
2937 (if (or (>= parts 19440) ;; If the new moon is at or after midday,
2938 (and (= (% day 7) 2);; ...or is on a Tuesday...
2939 (>= parts 9924) ;; at 9 hours, 204 parts or later...
2940 (not (hebrew-calendar-leap-year-p year)));; of a
2941 ;; common year,
2942 (and (= (% day 7) 1);; ...or is on a Monday...
2943 (>= parts 16789) ;; at 15 hours, 589 parts or later...
2944 (hebrew-calendar-leap-year-p (1- year))));; at the end
2945 ;; of a leap year
2946 ;; Then postpone Rosh HaShanah one day
2947 (1+ day)
2948 ;; Else
2949 day)))
2950 (if ;; If Rosh HaShanah would occur on Sunday, Wednesday, or Friday
2951 (memq (% alternative-day 7) (list 0 3 5))
2952 ;; Then postpone it one (more) day and return
2953 (1+ alternative-day)
2954 ;; Else return
2955 alternative-day)))
2957 (defun hebrew-calendar-days-in-year (year)
2958 "Number of days in Hebrew YEAR."
2959 (- (hebrew-calendar-elapsed-days (1+ year))
2960 (hebrew-calendar-elapsed-days year)))
2962 (defun hebrew-calendar-long-heshvan-p (year)
2963 "t if Heshvan is long in Hebrew YEAR."
2964 (= (% (hebrew-calendar-days-in-year year) 10) 5))
2966 (defun hebrew-calendar-short-kislev-p (year)
2967 "t if Kislev is short in Hebrew YEAR."
2968 (= (% (hebrew-calendar-days-in-year year) 10) 3))
2970 (defun calendar-absolute-from-hebrew (date)
2971 "Absolute date of Hebrew DATE.
2972 The absolute date is the number of days elapsed since the (imaginary)
2973 Gregorian date Sunday, December 31, 1 BC."
2974 (let* ((month (extract-calendar-month date))
2975 (day (extract-calendar-day date))
2976 (year (extract-calendar-year date)))
2977 (+ day ;; Days so far this month.
2978 (if (< month 7);; before Tishri
2979 ;; Then add days in prior months this year before and after Nisan
2980 (+ (calendar-sum
2981 m 7 (<= m (hebrew-calendar-last-month-of-year year))
2982 (hebrew-calendar-last-day-of-month m year))
2983 (calendar-sum
2984 m 1 (< m month)
2985 (hebrew-calendar-last-day-of-month m year)))
2986 ;; Else add days in prior months this year
2987 (calendar-sum
2988 m 7 (< m month)
2989 (hebrew-calendar-last-day-of-month m year)))
2990 (hebrew-calendar-elapsed-days year);; Days in prior years.
2991 -1373429))) ;; Days elapsed before absolute date 1.
2993 (defvar calendar-hebrew-month-name-array-common-year
2994 ["Nisan" "Iyar" "Sivan" "Tammuz" "Av" "Elul" "Tishri"
2995 "Heshvan" "Kislev" "Teveth" "Shevat" "Adar"])
2997 (defvar calendar-hebrew-month-name-array-leap-year
2998 ["Nisan" "Iyar" "Sivan" "Tammuz" "Av" "Elul" "Tishri"
2999 "Heshvan" "Kislev" "Teveth" "Shevat" "Adar I" "Adar II"])
3001 (defun calendar-hebrew-date-string (&optional date)
3002 "String of Hebrew date before sunset of Gregorian DATE.
3003 Defaults to today's date if DATE is not given.
3004 Driven by the variable `calendar-date-display-form'."
3005 (let* ((hebrew-date (calendar-hebrew-from-absolute
3006 (calendar-absolute-from-gregorian
3007 (or date (calendar-current-date)))))
3008 (calendar-month-name-array
3009 (if (hebrew-calendar-leap-year-p (extract-calendar-year hebrew-date))
3010 calendar-hebrew-month-name-array-leap-year
3011 calendar-hebrew-month-name-array-common-year)))
3012 (calendar-date-string hebrew-date nil t)))
3014 (defun calendar-print-hebrew-date ()
3015 "Show the Hebrew calendar equivalent of the date under the cursor."
3016 (interactive)
3017 (message "Hebrew date (until sunset): %s"
3018 (calendar-hebrew-date-string (calendar-cursor-to-date t))))
3020 (defun hebrew-calendar-yahrzeit (death-date year)
3021 "Absolute date of the anniversary of Hebrew DEATH-DATE in Hebrew YEAR."
3022 (let* ((death-day (extract-calendar-day death-date))
3023 (death-month (extract-calendar-month death-date))
3024 (death-year (extract-calendar-year death-date)))
3025 (cond
3026 ;; If it's Heshvan 30 it depends on the first anniversary; if
3027 ;; that was not Heshvan 30, use the day before Kislev 1.
3028 ((and (= death-month 8)
3029 (= death-day 30)
3030 (not (hebrew-calendar-long-heshvan-p (1+ death-year))))
3031 (1- (calendar-absolute-from-hebrew (list 9 1 year))))
3032 ;; If it's Kislev 30 it depends on the first anniversary; if
3033 ;; that was not Kislev 30, use the day before Teveth 1.
3034 ((and (= death-month 9)
3035 (= death-day 30)
3036 (hebrew-calendar-short-kislev-p (1+ death-year)))
3037 (1- (calendar-absolute-from-hebrew (list 10 1 year))))
3038 ;; If it's Adar II, use the same day in last month of
3039 ;; year (Adar or Adar II).
3040 ((= death-month 13)
3041 (calendar-absolute-from-hebrew
3042 (list (hebrew-calendar-last-month-of-year year) death-day year)))
3043 ;; If it's the 30th in Adar I and year is not a leap year
3044 ;; (so Adar has only 29 days), use the last day in Shevat.
3045 ((and (= death-day 30)
3046 (= death-month 12)
3047 (not (hebrew-calendar-leap-year-p year)))
3048 (calendar-absolute-from-hebrew (list 11 30 year)))
3049 ;; In all other cases, use the normal anniversary of the date of death.
3050 (t (calendar-absolute-from-hebrew
3051 (list death-month death-day year))))))
3053 (defun calendar-set-mode-line (str)
3054 "Set mode line to STR, centered, surrounded by dashes."
3055 (setq mode-line-format
3056 (calendar-string-spread (list "" str "") ?- (frame-width))))
3058 ;;;###autoload
3059 (defun list-yahrzeit-dates (death-date start-year end-year)
3060 "List Yahrzeit dates for *Gregorian* DEATH-DATE from START-YEAR to END-YEAR.
3061 When called interactively from the calendar window, the date of death is taken
3062 from the cursor position."
3063 (interactive
3064 (let* ((death-date
3065 (if (equal (current-buffer) (get-buffer calendar-buffer))
3066 (calendar-cursor-to-date)
3067 (let* ((today (calendar-current-date))
3068 (year (calendar-read
3069 "Year of death (>0): "
3070 '(lambda (x) (> x 0))
3071 (int-to-string (extract-calendar-year today))))
3072 (month-array calendar-month-name-array)
3073 (completion-ignore-case t)
3074 (month (cdr (assoc
3075 (capitalize
3076 (completing-read
3077 "Month of death (name): "
3078 (mapcar 'list (append month-array nil))
3079 nil t))
3080 (calendar-make-alist
3081 month-array 1 'capitalize))))
3082 (last (calendar-last-day-of-month month year))
3083 (day (calendar-read
3084 (format "Day of death (1-%d): " last)
3085 '(lambda (x) (and (< 0 x) (<= x last))))))
3086 (list month day year))))
3087 (death-year (extract-calendar-year death-date))
3088 (start-year (calendar-read
3089 (format "Starting year of Yahrzeit table (>%d): "
3090 death-year)
3091 '(lambda (x) (> x death-year))
3092 (int-to-string (1+ death-year))))
3093 (end-year (calendar-read
3094 (format "Ending year of Yahrzeit table (>=%d): "
3095 start-year)
3096 '(lambda (x) (>= x start-year)))))
3097 (list death-date start-year end-year)))
3098 (message "Computing yahrzeits...")
3099 (let* ((yahrzeit-buffer "*Yahrzeits*")
3100 (h-date (calendar-hebrew-from-absolute
3101 (calendar-absolute-from-gregorian death-date)))
3102 (h-month (extract-calendar-month h-date))
3103 (h-day (extract-calendar-day h-date))
3104 (h-year (extract-calendar-year h-date)))
3105 (set-buffer (get-buffer-create yahrzeit-buffer))
3106 (setq buffer-read-only nil)
3107 (calendar-set-mode-line
3108 (format "Yahrzeit dates for %s = %s"
3109 (calendar-date-string death-date)
3110 (let ((calendar-month-name-array
3111 (if (hebrew-calendar-leap-year-p h-year)
3112 calendar-hebrew-month-name-array-leap-year
3113 calendar-hebrew-month-name-array-common-year)))
3114 (calendar-date-string h-date nil t))))
3115 (erase-buffer)
3116 (goto-char (point-min))
3117 (calendar-for-loop i from start-year to end-year do
3118 (insert
3119 (calendar-date-string
3120 (calendar-gregorian-from-absolute
3121 (hebrew-calendar-yahrzeit
3122 h-date
3123 (extract-calendar-year
3124 (calendar-hebrew-from-absolute
3125 (calendar-absolute-from-gregorian (list 1 1 i))))))) "\n"))
3126 (goto-char (point-min))
3127 (set-buffer-modified-p nil)
3128 (setq buffer-read-only t)
3129 (display-buffer yahrzeit-buffer)
3130 (message "Computing yahrzeits...done")))
3132 (defun calendar-astro-date-string (&optional date)
3133 "String of astronomical (Julian) day number of afternoon of Gregorian DATE.
3134 Defaults to today's date if DATE is not given."
3135 (int-to-string
3136 (+ 1721425 (calendar-absolute-from-gregorian
3137 (or date (calendar-current-date))))))
3139 (defun calendar-print-astro-day-number ()
3140 "Show astronomical (Julian) day number of afternoon on date shown by cursor."
3141 (interactive)
3142 (message
3143 "Astronomical (Julian) day number after noon UTC: %s"
3144 (calendar-astro-date-string (calendar-cursor-to-date t))))
3146 (defun calendar-goto-astro-day-number (daynumber &optional noecho)
3147 "Move cursor to astronomical (Julian) DAYNUMBER.
3148 Echo astronomical (Julian) day number unless NOECHO is t."
3149 (interactive (list (calendar-read
3150 "Astronomical (Julian) day number (>1721425): "
3151 '(lambda (x) (> x 1721425)))))
3152 (calendar-goto-date (calendar-gregorian-from-absolute (- daynumber 1721425)))
3153 (or noecho (calendar-print-astro-day-number)))
3155 (run-hooks 'calendar-load-hook)
3157 (provide 'calendar)
3159 ;;; calendar.el ends here