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