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