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