1 ;;; calendar.el --- Calendar functions. -*-byte-compile-dynamic: t;-*-
3 ;;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995 Free Software
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
8 ;; Human-Keywords: calendar, Gregorian calendar, Julian calendar,
9 ;; Julian day number, diary, holidays
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to
25 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
29 ;; This collection of functions implements a calendar window. It generates a
30 ;; calendar for the current month, together with the previous and coming
31 ;; months, or for any other three-month period. The calendar can be scrolled
32 ;; forward and backward in the window to show months in the past or future;
33 ;; the cursor can move forward and backward by days, weeks, or months, making
34 ;; it possible, for instance, to jump to the date a specified number of days,
35 ;; weeks, or months from the date under the cursor. The user can display a
36 ;; list of holidays and other notable days for the period shown; the notable
37 ;; days can be marked on the calendar, if desired. The user can also specify
38 ;; that dates having corresponding diary entries (in a file that the user
39 ;; specifies) be marked; the diary entries for any date can be viewed in a
40 ;; separate window. The diary and the notable days can be viewed
41 ;; independently of the calendar. Dates can be translated from the (usual)
42 ;; Gregorian calendar to the day of the year/days remaining in year, to the
43 ;; ISO commercial calendar, to the Julian (old style) calendar, to the Hebrew
44 ;; calendar, to the Islamic calendar, to the French Revolutionary calendar, to
45 ;; the Mayan calendar, to the Chinese calendar, to the Coptic calendar, to the
46 ;; Ethiopic calendar, and to the astronomical (Julian) day number. When
47 ;; floating point is available, times of sunrise/sunset can be displayed, as
48 ;; can the phases of the moon. Appointment notification for diary entries is
51 ;; The following files are part of the calendar/diary code:
53 ;; cal-menu.el Menu support
54 ;; cal-move.el Movement in the calendar
55 ;; cal-x.el X-windows dedicated frame functions
56 ;; diary.el Diary functions
57 ;; holidays.el Holiday functions
58 ;; cal-julian.el Julian/astronomical calendars
59 ;; cal-hebrew.el Hebrew calendar
60 ;; cal-islamic.el Islamic calendar
61 ;; cal-mayan.el Mayan calendars
62 ;; cal-chinese.el Chinese calendar
63 ;; cal-coptic.el Coptic/Ethiopic calendars
64 ;; cal-dst.el Daylight savings time rules
65 ;; solar.el Sunrise/sunset, equinoxes/solstices
66 ;; lunar.el Phases of the moon
67 ;; appt.el Appointment notification
69 ;; Comments, corrections, and improvements should be sent to
70 ;; Edward M. Reingold Department of Computer Science
71 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
72 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
73 ;; Urbana, Illinois 61801
75 ;; Technical details of all the calendrical calculations can be found in
77 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
78 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
79 ;; pages 899-928. ``Calendrical Calculations, Part II: Three Historical
80 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
81 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
84 ;; Hard copies of these two papers can be obtained by sending email to
85 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
86 ;; the message BODY containing your mailing address (snail).
90 (defun calendar-version ()
92 (message "Version 6, September 17, 1995"))
95 (defvar calendar-week-start-day 0
96 "*The day of the week on which a week in the calendar begins.
97 0 means Sunday (default), 1 means Monday, and so on.")
100 (defvar calendar-offset 0
101 "*The offset of the principal month from the center of the calendar window.
102 0 means the principal month is in the center (default), -1 means on the left,
103 +1 means on the right. Larger (or smaller) values push the principal month off
107 (defvar view-diary-entries-initially nil
108 "*Non-nil means display current date's diary entries on entry.
109 The diary is displayed in another window when the calendar is first displayed,
110 if the current date is visible. The number of days of diary entries displayed
111 is governed by the variable `number-of-diary-entries'.")
114 (defvar number-of-diary-entries 1
115 "*Specifies how many days of diary entries are to be displayed initially.
116 This variable affects the diary display when the command M-x diary is used,
117 or if the value of the variable `view-diary-entries-initially' is t. For
118 example, if the default value 1 is used, then only the current day's diary
119 entries will be displayed. If the value 2 is used, then both the current
120 day's and the next day's entries will be displayed.
122 The value can also be a vector such as [0 2 2 2 2 4 1]; this value
123 says to display no diary entries on Sunday, the display the entries
124 for the current date and the day after on Monday through Thursday,
125 display Friday through Monday's entries on Friday, and display only
126 Saturday's entries on Saturday.
128 This variable does not affect the diary display with the `d' command
129 from the calendar; in that case, the prefix argument controls the
130 number of days of diary entries displayed.")
133 (defvar mark-diary-entries-in-calendar nil
134 "*Non-nil means mark dates with diary entries, in the calendar window.
135 The marking symbol is specified by the variable `diary-entry-marker'.")
137 (defvar diary-entry-marker
138 (if (not window-system)
141 (make-face 'diary-face)
142 (cond ((face-differs-from-default-p 'diary-face))
143 ((x-display-color-p) (set-face-foreground 'diary-face "red"))
144 (t (copy-face 'bold 'diary-face)))
146 "*Used to mark dates that have diary entries.
147 Can be either a single-character string or a face.")
149 (defvar calendar-today-marker
150 (if (not window-system)
153 (make-face 'calendar-today-face)
154 (if (not (face-differs-from-default-p 'calendar-today-face))
155 (set-face-underline-p 'calendar-today-face t))
156 'calendar-today-face)
157 "*Used to mark today's date.
158 Can be either a single-character string or a face.")
160 (defvar calendar-holiday-marker
161 (if (not window-system)
164 (make-face 'holiday-face)
165 (cond ((face-differs-from-default-p 'holiday-face))
166 ((x-display-color-p) (set-face-background 'holiday-face "pink"))
167 (t (set-face-background 'holiday-face "black")
168 (set-face-foreground 'holiday-face "white")))
170 "*Used to mark notable dates in the calendar.
171 Can be either a single-character string or a face.")
174 (defvar view-calendar-holidays-initially nil
175 "*Non-nil means display holidays for current three month period on entry.
176 The holidays are displayed in another window when the calendar is first
180 (defvar mark-holidays-in-calendar nil
181 "*Non-nil means mark dates of holidays in the calendar window.
182 The marking symbol is specified by the variable `calendar-holiday-marker'.")
185 (defvar all-hebrew-calendar-holidays nil
186 "*If nil, show only major holidays from the Hebrew calendar.
187 This means only those Jewish holidays that appear on secular calendars.
189 If t, show all the holidays that would appear in a complete Hebrew calendar.")
192 (defvar all-christian-calendar-holidays nil
193 "*If nil, show only major holidays from the Christian calendar.
194 This means only those Christian holidays that appear on secular calendars.
196 If t, show all the holidays that would appear in a complete Christian
200 (defvar all-islamic-calendar-holidays nil
201 "*If nil, show only major holidays from the Islamic calendar.
202 This means only those Islamic holidays that appear on secular calendars.
204 If t, show all the holidays that would appear in a complete Islamic
208 (defvar calendar-load-hook nil
209 "*List of functions to be called after the calendar is first loaded.
210 This is the place to add key bindings to `calendar-mode-map'.")
213 (defvar initial-calendar-window-hook nil
214 "*List of functions to be called when the calendar window is first opened.
215 The functions invoked are called after the calendar window is opened, but
216 once opened is never called again. Leaving the calendar with the `q' command
217 and reentering it will cause these functions to be called again.")
220 (defvar today-visible-calendar-hook nil
221 "*List of functions called whenever the current date is visible.
222 This can be used, for example, to replace today's date with asterisks; a
223 function `calendar-star-date' is included for this purpose:
224 (setq today-visible-calendar-hook 'calendar-star-date)
225 It can also be used to mark the current date with `calendar-today-marker';
226 a function is also provided for this:
227 (setq today-visible-calendar-hook 'calendar-mark-today)
229 The corresponding variable `today-invisible-calendar-hook' is the list of
230 functions called when the calendar function was called when the current
231 date is not visible in the window.
233 Other than the use of the provided functions, the changing of any
234 characters in the calendar buffer by the hooks may cause the failure of the
235 functions that move by days and weeks.")
238 (defvar today-invisible-calendar-hook nil
239 "*List of functions called whenever the current date is not visible.
241 The corresponding variable `today-visible-calendar-hook' is the list of
242 functions called when the calendar function was called when the current
243 date is visible in the window.
245 Other than the use of the provided functions, the changing of any
246 characters in the calendar buffer by the hooks may cause the failure of the
247 functions that move by days and weeks.")
250 (defvar diary-file "~/diary"
251 "*Name of the file in which one's personal diary of dates is kept.
253 The file's entries are lines in any of the forms
261 at the beginning of the line; the remainder of the line is the diary entry
262 string for that date. MONTH and DAY are one or two digit numbers, YEAR is
263 a number and may be written in full or abbreviated to the final two digits.
264 If the date does not contain a year, it is generic and applies to any year.
265 DAYNAME entries apply to any date on which is on that day of the week.
266 MONTHNAME and DAYNAME can be spelled in full, abbreviated to three
267 characters (with or without a period), capitalized or not. Any of DAY,
268 MONTH, or MONTHNAME, YEAR can be `*' which matches any day, month, or year,
271 The European style (in which the day precedes the month) can be used
272 instead, if you execute `european-calendar' when in the calendar, or set
273 `european-calendar-style' to t in your .emacs file. The European forms are
281 To revert to the default American style from the European style, execute
282 `american-calendar' in the calendar.
284 A diary entry can be preceded by the character
285 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
286 nonmarking--that is, it will not be marked on dates in the calendar
287 window but will appear in a diary window.
289 Multiline diary entries are made by indenting lines after the first with
290 either a TAB or one or more spaces.
292 Lines not in one the above formats are ignored. Here are some sample diary
293 entries (in the default American style):
295 12/22/1988 Twentieth wedding anniversary!!
296 &1/1. Happy New Year!
297 10/22 Ruth's birthday.
299 Tuesday--weekly meeting with grad students at 10am
300 Supowit, Shen, Bitner, and Kapoor to attend.
301 1/13/89 Friday the thirteenth!!
302 &thu 4pm squash game with Lloyd.
303 mar 16 Dad's birthday
304 April 15, 1989 Income tax due.
305 &* 15 time cards due.
307 If the first line of a diary entry consists only of the date or day name with
308 no trailing blanks or punctuation, then that line is not displayed in the
309 diary window; only the continuation lines is shown. For example, the
313 Bill Blattner visits Princeton today
314 2pm Cognitive Studies Committee meeting
315 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
316 4:00pm Jamie Tappenden
317 7:30pm Dinner at George and Ed's for Alan Ryan
318 7:30-10:00pm dance at Stewart Country Day School
320 will appear in the diary window without the date line at the beginning. This
321 facility allows the diary window to look neater, but can cause confusion if
322 used with more than one day's entries displayed.
324 Diary entries can be based on Lisp sexps. For example, the diary entry
326 %%(diary-block 11 1 1990 11 10 1990) Vacation
328 causes the diary entry \"Vacation\" to appear from November 1 through November
329 10, 1990. Other functions available are `diary-float', `diary-anniversary',
330 `diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date',
331 `diary-hebrew-date', `diary-islamic-date', `diary-mayan-date',
332 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
333 `diary-yahrzeit', `diary-sunrise-sunset', `diary-phases-of-moon',
334 `diary-parasha', `diary-omer', `diary-rosh-hodesh', and
335 `diary-sabbath-candles'. See the documentation for the function
336 `list-sexp-diary-entries' for more details.
338 Diary entries based on the Hebrew and/or the Islamic calendar are also
339 possible, but because these are somewhat slow, they are ignored
340 unless you set the `nongregorian-diary-listing-hook' and the
341 `nongregorian-diary-marking-hook' appropriately. See the documentation
342 for these functions for details.
344 Diary files can contain directives to include the contents of other files; for
345 details, see the documentation for the variable `list-diary-entries-hook'.")
348 (defvar diary-nonmarking-symbol "&"
349 "*Symbol indicating that a diary entry is not to be marked in the calendar.")
352 (defvar hebrew-diary-entry-symbol "H"
353 "*Symbol indicating a diary entry according to the Hebrew calendar.")
356 (defvar islamic-diary-entry-symbol "I"
357 "*Symbol indicating a diary entry according to the Islamic calendar.")
360 (defvar diary-include-string "#include"
361 "*The string indicating inclusion of another file of diary entries.
362 See the documentation for the function `include-other-diary-files'.")
365 (defvar sexp-diary-entry-symbol "%%"
366 "*The string used to indicate a sexp diary entry in diary-file.
367 See the documentation for the function `list-sexp-diary-entries'.")
370 (defvar abbreviated-calendar-year t
371 "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
372 For the Gregorian calendar; similarly for the Hebrew and Islamic calendars.
373 If this variable is nil, years must be written in full.")
376 (defvar european-calendar-style nil
377 "*Use the European style of dates in the diary and in any displays.
378 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
379 1990. The accepted European date styles are
387 Names can be capitalized or not, written in full, or abbreviated to three
388 characters with or without a period.")
391 (defvar american-date-diary-pattern
392 '((month "/" day "[^/0-9]")
393 (month "/" day "/" year "[^0-9]")
394 (monthname " *" day "[^,0-9]")
395 (monthname " *" day ", *" year "[^0-9]")
397 "*List of pseudo-patterns describing the American patterns of date used.
398 See the documentation of `diary-date-forms' for an explanation.")
401 (defvar european-date-diary-pattern
402 '((day "/" month "[^/0-9]")
403 (day "/" month "/" year "[^0-9]")
404 (backup day " *" monthname "\\W+\\<[^*0-9]")
405 (day " *" monthname " *" year "[^0-9]")
407 "*List of pseudo-patterns describing the European patterns of date used.
408 See the documentation of `diary-date-forms' for an explanation.")
410 (defvar diary-date-forms
411 (if european-calendar-style
412 european-date-diary-pattern
413 american-date-diary-pattern)
414 "*List of pseudo-patterns describing the forms of date used in the diary.
415 The patterns on the list must be MUTUALLY EXCLUSIVE and must should not match
416 any portion of the diary entry itself, just the date component.
418 A pseudo-pattern is a list of regular expressions and the keywords `month',
419 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
420 match the name of the month, capitalized or not, or its three-letter
421 abbreviation, followed by a period or not; it will also match `*'.
422 Similarly, `dayname' will match the name of the day, capitalized or not, or
423 its three-letter abbreviation, followed by a period or not. The keywords
424 `month', `day', and `year' will match those numerical values, preceded by
425 arbitrarily many zeros; they will also match `*'.
427 The matching of the diary entries with the date forms is done with the
428 standard syntax table from Fundamental mode, but with the `*' changed so
429 that it is a word constituent.
431 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
432 diary entry itself, the first element of the pattern MUST be `backup'. This
433 directive causes the date recognizer to back up to the beginning of the
434 current word of the diary entry, so in no case can the pattern match more than
435 a portion of the first word of the diary entry.")
438 (defvar european-calendar-display-form
439 '((if dayname (concat dayname ", ")) day " " monthname " " year)
440 "*Pseudo-pattern governing the way a date appears in the European style.
441 See the documentation of calendar-date-display-form for an explanation.")
444 (defvar american-calendar-display-form
445 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
446 "*Pseudo-pattern governing the way a date appears in the American style.
447 See the documentation of `calendar-date-display-form' for an explanation.")
449 (defvar calendar-date-display-form
450 (if european-calendar-style
451 european-calendar-display-form
452 american-calendar-display-form)
453 "*Pseudo-pattern governing the way a date appears.
455 Used by the function `calendar-date-string', a pseudo-pattern is a list of
456 expressions that can involve the keywords `month', `day', and `year', all
457 numbers in string form, and `monthname' and `dayname', both alphabetic
458 strings. For example, the ISO standard would use the pseudo- pattern
460 '(year \"-\" month \"-\" day)
462 while a typical American form would be
464 '(month \"/\" day \"/\" (substring year -2))
468 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
470 would give the usual American style in fixed-length fields.
472 See the documentation of the function `calendar-date-string'.")
474 (defun european-calendar ()
475 "Set the interpretation and display of dates to the European style."
477 (setq european-calendar-style t)
478 (setq calendar-date-display-form european-calendar-display-form)
479 (setq diary-date-forms european-date-diary-pattern)
480 (update-calendar-mode-line))
482 (defun american-calendar ()
483 "Set the interpretation and display of dates to the American style."
485 (setq european-calendar-style nil)
486 (setq calendar-date-display-form american-calendar-display-form)
487 (setq diary-date-forms american-date-diary-pattern)
488 (update-calendar-mode-line))
491 (defvar print-diary-entries-hook 'lpr-buffer
492 "*List of functions called after a temporary diary buffer is prepared.
493 The buffer shows only the diary entries currently visible in the diary
494 buffer. The default just does the printing. Other uses might include, for
495 example, rearranging the lines into order by day and time, saving the buffer
496 instead of deleting it, or changing the function used to do the printing.")
499 (defvar list-diary-entries-hook nil
500 "*List of functions called after diary file is culled for relevant entries.
501 It is to be used for diary entries that are not found in the diary file.
503 A function `include-other-diary-files' is provided for use as the value of
504 this hook. This function enables you to use shared diary files together
505 with your own. The files included are specified in the diary file by lines
508 #include \"filename\"
510 This is recursive; that is, #include directives in files thus included are
511 obeyed. You can change the \"#include\" to some other string by changing
512 the variable `diary-include-string'. When you use `include-other-diary-files'
513 as part of the list-diary-entries-hook, you will probably also want to use the
514 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
516 For example, you could use
518 (setq list-diary-entries-hook
519 '(include-other-diary-files sort-diary-entries))
520 (setq diary-display-hook 'fancy-diary-display)
522 in your `.emacs' file to cause the fancy diary buffer to be displayed with
523 diary entries from various included files, each day's entries sorted into
524 lexicographic order.")
527 (defvar diary-hook nil
528 "*List of functions called after the display of the diary.
529 Can be used for appointment notification.")
532 (defvar diary-display-hook nil
533 "*List of functions that handle the display of the diary.
534 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
537 Ordinarily, this just displays the diary buffer (with holidays indicated in
538 the mode line), if there are any relevant entries. At the time these
539 functions are called, the variable `diary-entries-list' is a list, in order
540 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
541 STRING), where string is the diary entry for the given date. This can be
542 used, for example, a different buffer for display (perhaps combined with
543 holidays), or produce hard copy output.
545 A function `fancy-diary-display' is provided as an alternative
546 choice for this hook; this function prepares a special noneditable diary
547 buffer with the relevant diary entries that has neat day-by-day arrangement
548 with headings. The fancy diary buffer will show the holidays unless the
549 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
550 diary buffer will not show days for which there are no diary entries, even
551 if that day is a holiday; if you want such days to be shown in the fancy
552 diary buffer, set the variable `diary-list-include-blanks' to t.")
555 (defvar nongregorian-diary-listing-hook nil
556 "*List of functions called for listing diary file and included files.
557 As the files are processed for diary entries, these functions are used to cull
558 relevant entries. You can use either or both of `list-hebrew-diary-entries'
559 and `list-islamic-diary-entries'. The documentation for these functions
560 describes the style of such diary entries.")
563 (defvar mark-diary-entries-hook nil
564 "*List of functions called after marking diary entries in the calendar.
566 A function `mark-included-diary-files' is also provided for use as the
567 mark-diary-entries-hook; it enables you to use shared diary files together
568 with your own. The files included are specified in the diary file by lines
570 #include \"filename\"
571 This is recursive; that is, #include directives in files thus included are
572 obeyed. You can change the \"#include\" to some other string by changing the
573 variable `diary-include-string'. When you use `mark-included-diary-files' as
574 part of the mark-diary-entries-hook, you will probably also want to use the
575 function `include-other-diary-files' as part of `list-diary-entries-hook'.")
578 (defvar nongregorian-diary-marking-hook nil
579 "*List of functions called for marking diary file and included files.
580 As the files are processed for diary entries, these functions are used to cull
581 relevant entries. You can use either or both of `mark-hebrew-diary-entries'
582 and `mark-islamic-diary-entries'. The documentation for these functions
583 describes the style of such diary entries.")
586 (defvar diary-list-include-blanks nil
587 "*If nil, do not include days with no diary entry in the list of diary entries.
588 Such days will then not be shown in the the fancy diary buffer, even if they
592 (defvar holidays-in-diary-buffer t
593 "*Non-nil means include holidays in the diary display.
594 The holidays appear in the mode line of the diary buffer, or in the
595 fancy diary buffer next to the date. This slows down the diary functions
596 somewhat; setting it to nil makes the diary display faster.")
598 (defvar calendar-mark-ring nil)
601 (put 'general-holidays 'risky-local-variable t)
603 (defvar general-holidays
604 '((holiday-fixed 1 1 "New Year's Day")
605 (holiday-float 1 1 3 "Martin Luther King Day")
606 (holiday-fixed 2 2 "Ground Hog Day")
607 (holiday-fixed 2 14 "Valentine's Day")
608 (holiday-float 2 1 3 "President's Day")
609 (holiday-fixed 3 17 "St. Patrick's Day")
610 (holiday-fixed 4 1 "April Fool's Day")
611 (holiday-float 5 0 2 "Mother's Day")
612 (holiday-float 5 1 -1 "Memorial Day")
613 (holiday-fixed 6 14 "Flag Day")
614 (holiday-float 6 0 3 "Father's Day")
615 (holiday-fixed 7 4 "Independence Day")
616 (holiday-float 9 1 1 "Labor Day")
617 (holiday-float 10 1 2 "Columbus Day")
618 (holiday-fixed 10 31 "Halloween")
619 (holiday-fixed 11 11 "Veteran's Day")
620 (holiday-float 11 4 4 "Thanksgiving"))
621 "*General holidays. Default value is for the United States.
622 See the documentation for `calendar-holidays' for details.")
625 (put 'oriental-holidays 'risky-local-variable t)
627 (defvar oriental-holidays
628 '((if (fboundp 'atan)
629 (holiday-chinese-new-year)))
631 See the documentation for `calendar-holidays' for details.")
634 (put 'local-holidays 'risky-local-variable t)
636 (defvar local-holidays nil
638 See the documentation for `calendar-holidays' for details.")
641 (put 'other-holidays 'risky-local-variable t)
643 (defvar other-holidays nil
644 "*User defined holidays.
645 See the documentation for `calendar-holidays' for details.")
648 (put 'hebrew-holidays-1 'risky-local-variable t)
650 (defvar hebrew-holidays-1
651 '((holiday-rosh-hashanah-etc)
652 (if all-hebrew-calendar-holidays
655 (let* ((m displayed-month)
658 (increment-calendar-month m y -1)
659 (let ((year (extract-calendar-year
660 (calendar-julian-from-absolute
661 (calendar-absolute-from-gregorian
663 (if (zerop (% (1+ year) 4))
665 21))) "\"Tal Umatar\" (evening)"))))
668 (put 'hebrew-holidays-2 'risky-local-variable t)
670 (defvar hebrew-holidays-2
671 '((if all-hebrew-calendar-holidays
673 (holiday-hebrew 9 25 "Hanukkah"))
674 (if all-hebrew-calendar-holidays
677 (let ((h-year (extract-calendar-year
678 (calendar-hebrew-from-absolute
679 (calendar-absolute-from-gregorian
680 (list displayed-month 28 displayed-year))))))
681 (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
686 (if all-hebrew-calendar-holidays
687 (holiday-hebrew 11 15 "Tu B'Shevat"))))
690 (put 'hebrew-holidays-3 'risky-local-variable t)
692 (defvar hebrew-holidays-3
693 '((if all-hebrew-calendar-holidays
696 (let ((m displayed-month)
698 (increment-calendar-month m y 1)
699 (let* ((h-year (extract-calendar-year
700 (calendar-hebrew-from-absolute
701 (calendar-absolute-from-gregorian
703 (calendar-last-day-of-month m y)
706 (calendar-hebrew-from-absolute
708 (% (calendar-absolute-from-hebrew
712 (calendar-dayname-on-or-before
713 6 (calendar-absolute-from-hebrew
714 (list 11 17 h-year)))
715 (calendar-dayname-on-or-before
716 6 (calendar-absolute-from-hebrew
717 (list 11 16 h-year))))))
718 (day (extract-calendar-day s-s)))
723 (put 'hebrew-holidays-4 'risky-local-variable t)
725 (defvar hebrew-holidays-4
726 '((holiday-passover-etc)
727 (if (and all-hebrew-calendar-holidays
728 (let* ((m displayed-month)
731 (increment-calendar-month m y -1)
732 (let ((year (extract-calendar-year
733 (calendar-julian-from-absolute
734 (calendar-absolute-from-gregorian
736 (= 21 (% year 28)))))
737 (holiday-julian 3 26 "Kiddush HaHamah"))
738 (if all-hebrew-calendar-holidays
739 (holiday-tisha-b-av-etc))))
742 (put 'hebrew-holidays 'risky-local-variable t)
744 (defvar hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
745 hebrew-holidays-3 hebrew-holidays-4)
747 See the documentation for `calendar-holidays' for details.")
750 (put 'christian-holidays 'risky-local-variable t)
752 (defvar christian-holidays
753 '((if all-christian-calendar-holidays
754 (holiday-fixed 1 6 "Epiphany"))
756 (if all-christian-calendar-holidays
757 (holiday-greek-orthodox-easter))
758 (if all-christian-calendar-holidays
759 (holiday-fixed 8 15 "Assumption"))
760 (if all-christian-calendar-holidays
762 (holiday-fixed 12 25 "Christmas")
763 (if all-christian-calendar-holidays
764 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
765 "*Christian holidays.
766 See the documentation for `calendar-holidays' for details.")
769 (put 'islamic-holidays 'risky-local-variable t)
771 (defvar islamic-holidays
774 (format "Islamic New Year %d"
775 (let ((m displayed-month)
777 (increment-calendar-month m y 1)
778 (extract-calendar-year
779 (calendar-islamic-from-absolute
780 (calendar-absolute-from-gregorian
782 m (calendar-last-day-of-month m y) y)))))))
783 (if all-islamic-calendar-holidays
784 (holiday-islamic 1 10 "Ashura"))
785 (if all-islamic-calendar-holidays
786 (holiday-islamic 3 12 "Mulad-al-Nabi"))
787 (if all-islamic-calendar-holidays
788 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
789 (if all-islamic-calendar-holidays
790 (holiday-islamic 8 15 "Shab-e-Bara't"))
791 (holiday-islamic 9 1 "Ramadan Begins")
792 (if all-islamic-calendar-holidays
793 (holiday-islamic 9 27 "Shab-e Qadr"))
794 (if all-islamic-calendar-holidays
795 (holiday-islamic 10 1 "Id-al-Fitr"))
796 (if all-islamic-calendar-holidays
797 (holiday-islamic 12 10 "Id-al-Adha")))
799 See the documentation for `calendar-holidays' for details.")
802 (put 'solar-holidays 'risky-local-variable t)
804 (defvar solar-holidays
805 '((if (fboundp 'atan)
806 (solar-equinoxes-solstices))
812 calendar-daylight-savings-starts
813 '(format "Daylight Savings Time Begins %s"
816 (/ calendar-daylight-savings-starts-time (float 60))
817 calendar-standard-time-zone-name)
821 calendar-daylight-savings-ends
822 '(format "Daylight Savings Time Ends %s"
825 (/ calendar-daylight-savings-ends-time (float 60))
826 calendar-daylight-time-zone-name)
828 "*Sun-related holidays.
829 See the documentation for `calendar-holidays' for details.")
832 (put 'calendar-holidays 'risky-local-variable t)
833 (defvar calendar-holidays
834 (append general-holidays local-holidays other-holidays
835 christian-holidays hebrew-holidays islamic-holidays
836 oriental-holidays solar-holidays)
837 "*List of notable days for the command M-x holidays.
839 Additional holidays are easy to add to the list, just put them in the list
840 `other-holidays' in your .emacs file. Similarly, by setting any of
841 `general-holidays', `local-holidays' `christian-holidays', `hebrew-holidays',
842 `islamic-holidays', `oriental-holidays', or `solar-holidays' to nil in your
843 .emacs file, you can eliminate unwanted categories of holidays. The intention
844 is that (in the US) `local-holidays' be set in site-init.el and
845 `other-holidays' be set by the user.
847 Entries on the list are expressions that return (possibly empty) lists of
848 items of the form ((month day year) string) of a holiday in the in the
849 three-month period centered around `displayed-month' of `displayed-year'.
850 Several basic functions are provided for this purpose:
852 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
853 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
854 MONTH on the Gregorian calendar (0 for Sunday,
855 etc.); K<0 means count back from the end of the
856 month. An optional parameter DAY means the Kth
857 DAYNAME after/before MONTH DAY.
858 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
859 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
860 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
861 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
862 in the variable `year'; if it evaluates to
863 a visible date, that's the holiday; if it
864 evaluates to nil, there's no holiday. STRING
865 is an expression in the variable `date'.
867 For example, to add Bastille Day, celebrated in France on July 14, add
869 (holiday-fixed 7 14 \"Bastille Day\")
871 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
872 Islands on the fourth Monday in August, add
874 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
876 to the list (the last Monday would be specified with `-1' instead of `4').
877 To add the last day of Hanukkah to the list, use
879 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
881 since the Hebrew months are numbered with 1 starting from Nisan, while to
882 add the Islamic feast celebrating Mohammed's birthday use
884 (holiday-islamic 3 12 \"Mohammed's Birthday\")
886 since the Islamic months are numbered from 1 starting with Muharram. To
887 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
889 (holiday-julian 4 2 \"Jefferson's Birthday\")
891 To include a holiday conditionally, use the sexp form or a conditional. For
892 example, to include American presidential elections, which occur on the first
893 Tuesday after the first Monday in November of years divisible by 4, add
896 (if (zerop (% year 4))
897 (calendar-gregorian-from-absolute
898 (1+ (calendar-dayname-on-or-before
899 1 (+ 6 (calendar-absolute-from-gregorian
900 (list 11 1 year)))))))
901 \"US Presidential Election\")
905 (if (zerop (% displayed-year 4))
907 (extract-calendar-day
908 (calendar-gregorian-from-absolute
909 (1+ (calendar-dayname-on-or-before
910 1 (+ 6 (calendar-absolute-from-gregorian
911 (list 11 1 displayed-year)))))))
912 \"US Presidential Election\"))
914 to the list. To include the phases of the moon, add
918 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
919 you've written to return a (possibly empty) list of the relevant VISIBLE dates
920 with descriptive strings such as
922 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... ).")
924 (defconst calendar-buffer "*Calendar*"
925 "Name of the buffer used for the calendar.")
927 (defconst holiday-buffer "*Holidays*"
928 "Name of the buffer used for the displaying the holidays.")
930 (defconst fancy-diary-buffer "*Fancy Diary Entries*"
931 "Name of the buffer used for the optional fancy display of the diary.")
933 (defconst lunar-phases-buffer "*Phases of Moon*"
934 "Name of the buffer used for the lunar phases.")
936 (defmacro increment-calendar-month (mon yr n)
937 "Move the variables MON and YR to the month and year by N months.
938 Forward if N is positive or backward if N is negative."
939 (` (let (( macro-y (+ (* (, yr) 12) (, mon) -1 (, n) )))
940 (setq (, mon) (1+ (% macro-y 12) ))
941 (setq (, yr) (/ macro-y 12)))))
943 (defmacro calendar-for-loop (var from init to final do &rest body)
944 "Execute a for loop."
945 (` (let (( (, var) (1- (, init)) ))
946 (while (>= (, final) (setq (, var) (1+ (, var))))
949 (defmacro calendar-sum (index initial condition expression)
950 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
951 (` (let (( (, index) (, initial))
954 (setq sum (+ sum (, expression) ))
955 (setq (, index) (1+ (, index))))
958 ;; The following are in-line for speed; they can be called thousands of times
959 ;; when looking up holidays or processing the diary. Here, for example, are
960 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
961 ;; fancy diary display, for a moderately complex diary file, with functions
962 ;; used instead of macros. There were a total of 10000 such calls:
964 ;; 1934 extract-calendar-month
965 ;; 1852 extract-calendar-year
966 ;; 1819 extract-calendar-day
967 ;; 845 calendar-leap-year-p
968 ;; 837 calendar-day-number
969 ;; 775 calendar-absolute-from-gregorian
970 ;; 346 calendar-last-day-of-month
971 ;; 286 hebrew-calendar-last-day-of-month
972 ;; 188 hebrew-calendar-leap-year-p
973 ;; 180 hebrew-calendar-elapsed-days
974 ;; 163 hebrew-calendar-last-month-of-year
975 ;; 66 calendar-date-compare
976 ;; 65 hebrew-calendar-days-in-year
977 ;; 60 calendar-absolute-from-julian
978 ;; 50 calendar-absolute-from-hebrew
979 ;; 43 calendar-date-equal
980 ;; 38 calendar-gregorian-from-absolute
985 ;; The use of these seven macros eliminates the overhead of 92% of the function
986 ;; calls; it's faster this way.
988 (defsubst extract-calendar-month (date)
989 "Extract the month part of DATE which has the form (month day year)."
992 (defsubst extract-calendar-day (date)
993 "Extract the day part of DATE which has the form (month day year)."
996 (defsubst extract-calendar-year (date)
997 "Extract the year part of DATE which has the form (month day year)."
998 (car (cdr (cdr date))))
1000 (defsubst calendar-leap-year-p (year)
1001 "Returns t if YEAR is a Gregorian leap year."
1002 (and (zerop (% year 4))
1003 (or (not (zerop (% year 100)))
1004 (zerop (% year 400)))))
1006 ;; The foregoing is a bit faster, but not as clear as the following:
1008 ;;(defsubst calendar-leap-year-p (year)
1009 ;; "Returns t if YEAR is a Gregorian leap year."
1011 ;; (and (= (% year 4) 0)
1012 ;; (/= (% year 100) 0))
1013 ;; (= (% year 400) 0)))
1015 (defsubst calendar-last-day-of-month (month year)
1016 "The last day in MONTH during YEAR."
1017 (if (and (= month 2) (calendar-leap-year-p year))
1019 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1021 ;; An explanation of the calculation can be found in PascAlgorithms by
1022 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1024 (defsubst calendar-day-number (date)
1025 "Return the day number within the year of the date DATE.
1026 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1027 while (calendar-day-number '(12 31 1980)) returns 366."
1028 (let* ((month (extract-calendar-month date))
1029 (day (extract-calendar-day date))
1030 (year (extract-calendar-year date))
1031 (day-of-year (+ day (* 31 (1- month)))))
1034 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1035 (if (calendar-leap-year-p year)
1036 (setq day-of-year (1+ day-of-year)))))
1039 (defsubst calendar-absolute-from-gregorian (date)
1040 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1041 The Gregorian date Sunday, December 31, 1 BC is imaginary."
1042 (let ((prior-years (1- (extract-calendar-year date))))
1043 (+ (calendar-day-number date);; Days this year
1044 (* 365 prior-years);; + Days in prior years
1045 (/ prior-years 4);; + Julian leap years
1046 (- (/ prior-years 100));; - century years
1047 (/ prior-years 400))));; + Gregorian leap years
1049 (autoload 'calendar-goto-today "cal-move"
1050 "Reposition the calendar window so the current date is visible."
1053 (autoload 'calendar-forward-month "cal-move"
1054 "Move the cursor forward ARG months."
1057 (autoload 'calendar-forward-year "cal-move"
1058 "Move the cursor forward by ARG years."
1061 (autoload 'calendar-backward-month "cal-move"
1062 "Move the cursor backward by ARG months."
1065 (autoload 'calendar-backward-year "cal-move"
1066 "Move the cursor backward ARG years."
1069 (autoload 'scroll-calendar-left "cal-move"
1070 "Scroll the displayed calendar left by ARG months."
1073 (autoload 'scroll-calendar-right "cal-move"
1074 "Scroll the displayed calendar window right by ARG months."
1077 (autoload 'scroll-calendar-left-three-months "cal-move"
1078 "Scroll the displayed calendar window left by 3*ARG months."
1081 (autoload 'scroll-calendar-right-three-months "cal-move"
1082 "Scroll the displayed calendar window right by 3*ARG months."
1085 (autoload 'calendar-cursor-to-nearest-date "cal-move"
1086 "Move the cursor to the closest date."
1089 (autoload 'calendar-forward-day "cal-move"
1090 "Move the cursor forward ARG days."
1093 (autoload 'calendar-backward-day "cal-move"
1094 "Move the cursor back ARG days."
1097 (autoload 'calendar-forward-week "cal-move"
1098 "Move the cursor forward ARG weeks."
1101 (autoload 'calendar-backward-week "cal-move"
1102 "Move the cursor back ARG weeks."
1105 (autoload 'calendar-beginning-of-week "cal-move"
1106 "Move the cursor back ARG calendar-week-start-day's."
1109 (autoload 'calendar-end-of-week "cal-move"
1110 "Move the cursor forward ARG calendar-week-start-day+6's."
1113 (autoload 'calendar-beginning-of-month "cal-move"
1114 "Move the cursor backward ARG month beginnings."
1117 (autoload 'calendar-end-of-month "cal-move"
1118 "Move the cursor forward ARG month ends."
1121 (autoload 'calendar-beginning-of-year "cal-move"
1122 "Move the cursor backward ARG year beginnings."
1125 (autoload 'calendar-end-of-year "cal-move"
1126 "Move the cursor forward ARG year beginnings."
1129 (autoload 'calendar-cursor-to-visible-date "cal-move"
1130 "Move the cursor to DATE that is on the screen."
1133 (autoload 'calendar-goto-date "cal-move"
1134 "Move cursor to DATE."
1137 (autoload 'calendar-one-frame-setup "cal-x"
1138 "Start calendar and display it in a dedicated frame together with the diary.")
1140 (autoload 'calendar-two-frame-setup "cal-x"
1141 "Start calendar and diary in separate, dedicated frames.")
1144 (defvar calendar-setup nil
1145 "The frame set up of the calendar.
1146 The choices are `one-frame' (calendar and diary together in one separate,
1147 dediciated frame) or `two-frames' (calendar and diary in separate, dedicated
1148 frames); with any other value the current frame is used.")
1151 (defun calendar (&optional arg)
1152 "Choose between the one frame, two frame, or basic calendar displays.
1153 The original function `calendar' has been renamed `calendar-basic-setup'."
1155 (cond ((equal calendar-setup 'one-frame) (calendar-one-frame-setup arg))
1156 ((equal calendar-setup 'two-frames) (calendar-two-frame-setup arg))
1157 (t (calendar-basic-setup arg))))
1159 (defun calendar-basic-setup (&optional arg)
1160 "Display a three-month calendar in another window.
1161 The three months appear side by side, with the current month in the middle
1162 surrounded by the previous and next months. The cursor is put on today's date.
1164 If called with an optional prefix argument, prompts for month and year.
1166 This function is suitable for execution in a .emacs file; appropriate setting
1167 of the variable `view-diary-entries-initially' will cause the diary entries for
1168 the current date to be displayed in another window. The value of the variable
1169 `number-of-diary-entries' controls the number of days of diary entries
1170 displayed upon initial display of the calendar.
1172 An optional prefix argument ARG causes the calendar displayed to be ARG
1173 months in the future if ARG is positive or in the past if ARG is negative;
1174 in this case the cursor goes on the first day of the month.
1176 Once in the calendar window, future or past months can be moved into view.
1177 Arbitrary months can be displayed, or the calendar can be scrolled forward
1180 The cursor can be moved forward or backward by one day, one week, one month,
1181 or one year. All of these commands take prefix arguments which, when negative,
1182 cause movement in the opposite direction. For convenience, the digit keys
1183 and the minus sign are automatically prefixes. The window is replotted as
1184 necessary to display the desired date.
1186 Diary entries can be marked on the calendar or displayed in another window.
1188 Use M-x describe-mode for details of the key bindings in the calendar window.
1190 The Gregorian calendar is assumed.
1192 After loading the calendar, the hooks given by the variable
1193 `calendar-load-hook' are run. This is the place to add key bindings to the
1196 After preparing the calendar window initially, the hooks given by the variable
1197 `initial-calendar-window-hook' are run.
1199 The hooks given by the variable `today-visible-calendar-hook' are run
1200 everytime the calendar window gets scrolled, if the current date is visible
1201 in the window. If it is not visible, the hooks given by the variable
1202 `today-invisible-calendar-hook' are run. Thus, for example, setting
1203 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1204 to be replaced by asterisks to highlight it whenever it is in the window."
1206 (set-buffer (get-buffer-create calendar-buffer))
1208 (let* ((pop-up-windows t)
1209 (split-height-threshold 1000)
1211 (calendar-read-date t)
1212 (calendar-current-date)))
1213 (month (extract-calendar-month date))
1214 (year (extract-calendar-year date)))
1215 (pop-to-buffer calendar-buffer)
1216 (increment-calendar-month month year (- calendar-offset))
1217 (generate-calendar-window month year)
1218 (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
1220 (if (vectorp number-of-diary-entries)
1221 (aref number-of-diary-entries (calendar-day-of-week date))
1222 number-of-diary-entries))))
1223 (let* ((diary-buffer (get-file-buffer diary-file))
1224 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1225 (split-height-threshold (if diary-window 2 1000)))
1226 (if view-calendar-holidays-initially
1227 (list-calendar-holidays)))
1228 (run-hooks 'initial-calendar-window-hook))
1230 (autoload 'view-diary-entries "diary"
1231 "Prepare and display a buffer with diary entries.
1232 Searches your diary file for entries that match ARG days starting with
1233 the date indicated by the cursor position in the displayed three-month
1237 (autoload 'calendar-sunrise-sunset "solar"
1238 "Local time of sunrise and sunset for date under cursor."
1241 (autoload 'calendar-phases-of-moon "lunar"
1242 "Create a buffer of the phases of the moon for the current calendar window."
1245 (autoload 'calendar-print-french-date "cal-french"
1246 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1249 (autoload 'calendar-goto-french-date "cal-french"
1250 "Move cursor to French Revolutionary date."
1253 (autoload 'calendar-french-date-string "cal-french"
1254 "String of French Revolutionary date of Gregorian date."
1257 (autoload 'calendar-mayan-date-string "cal-mayan"
1258 "String of Mayan date of Gregorian date."
1261 (autoload 'calendar-print-mayan-date "cal-mayan"
1262 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1265 (autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
1266 "Move cursor to Mayan long count date."
1269 (autoload 'calendar-next-haab-date "cal-mayan"
1270 "Move cursor to next instance of Mayan Haab date."
1273 (autoload 'calendar-previous-haab-date "cal-mayan"
1274 "Move cursor to previous instance of Mayan Haab date."
1277 (autoload 'calendar-next-tzolkin-date "cal-mayan"
1278 "Move cursor to next instance of Mayan Tzolkin date."
1281 (autoload 'calendar-previous-tzolkin-date "cal-mayan"
1282 "Move cursor to previous instance of Mayan Tzolkin date."
1285 (autoload 'calendar-next-calendar-round-date "cal-mayan"
1286 "Move cursor to next instance of Mayan Haab/Tzoklin combination."
1289 (autoload 'calendar-previous-calendar-round-date "cal-mayan"
1290 "Move cursor to previous instance of Mayan Haab/Tzoklin combination."
1293 (autoload 'calendar-goto-chinese-date "cal-chinese"
1294 "Move cursor to Chinese date date."
1297 (autoload 'calendar-print-chinese-date "cal-chinese"
1298 "Show the Chinese date equivalents of date."
1301 (autoload 'calendar-chinese-date-string "cal-chinese"
1302 "String of Chinese date of Gregorian date."
1305 (autoload 'calendar-goto-julian-date "cal-julian"
1306 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1309 (autoload 'calendar-goto-iso-date "cal-iso"
1310 "Move cursor to ISO date."
1313 (autoload 'calendar-print-iso-date "cal-iso"
1314 "Show the ISO date equivalents of date."
1317 (autoload 'calendar-iso-date-string "cal-iso"
1318 "String of ISO date of Gregorian date."
1321 (autoload 'calendar-print-islamic-date "cal-islamic"
1322 "Show the Islamic date equivalents of date."
1325 (autoload 'calendar-islamic-date-string "cal-islamic"
1326 "String of Islamic date of Gregorian date."
1329 (autoload 'calendar-goto-hebrew-date "cal-hebrew"
1330 "Move cursor to Hebrew date date."
1333 (autoload 'calendar-print-hebrew-date "cal-hebrew"
1334 "Show the Hebrew date equivalents of date."
1337 (autoload 'calendar-hebrew-date-string "cal-hebrew"
1338 "String of Hebrew date of Gregorian date."
1341 (autoload 'calendar-goto-coptic-date "cal-coptic"
1342 "Move cursor to Coptic date date."
1345 (autoload 'calendar-print-coptic-date "cal-coptic"
1346 "Show the Coptic date equivalents of date."
1349 (autoload 'calendar-coptic-date-string "cal-coptic"
1350 "String of Coptic date of Gregorian date."
1353 (autoload 'calendar-goto-ethiopic-date "cal-coptic"
1354 "Move cursor to Ethiopic date date."
1357 (autoload 'calendar-print-ethiopic-date "cal-coptic"
1358 "Show the Ethiopic date equivalents of date."
1361 (autoload 'calendar-ethiopic-date-string "cal-coptic"
1362 "String of Ethiopic date of Gregorian date."
1365 (autoload 'show-all-diary-entries "diary"
1366 "Show all of the diary entries in the diary file.
1367 This function gets rid of the selective display of the diary file so that
1368 all entries, not just some, are visible. If there is no diary buffer, one
1372 (autoload 'mark-diary-entries "diary"
1373 "Mark days in the calendar window that have diary entries.
1374 Each entry in diary file visible in the calendar window is marked."
1377 (autoload 'make-diary-entry "diary"
1378 "Insert a diary entry STRING which may be NONMARKING in FILE."
1381 (autoload 'insert-diary-entry "diary"
1382 "Insert a diary entry for the date indicated by point."
1385 (autoload 'insert-weekly-diary-entry "diary"
1386 "Insert a weekly diary entry for the day of the week indicated by point."
1390 (autoload 'insert-monthly-diary-entry "diary"
1391 "Insert a monthly diary entry for the day of the month indicated by point."
1394 (autoload 'insert-yearly-diary-entry "diary"
1395 "Insert an annual diary entry for the day of the year indicated by point."
1398 (autoload 'insert-anniversary-diary-entry "diary"
1399 "Insert an anniversary diary entry for the date indicated by point."
1402 (autoload 'insert-block-diary-entry "diary"
1403 "Insert a block diary entry for the dates indicated by point and mark."
1406 (autoload 'insert-cyclic-diary-entry "diary"
1407 "Insert a cyclic diary entry starting at the date indicated by point."
1410 (autoload 'insert-hebrew-diary-entry "cal-hebrew"
1411 "Insert a diary entry for the Hebrew date corresponding to the date
1412 indicated by point."
1415 (autoload 'insert-monthly-hebrew-diary-entry "cal-hebrew"
1416 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1417 to the date indicated by point."
1420 (autoload 'insert-yearly-hebrew-diary-entry "cal-hebrew"
1421 "Insert an annual diary entry for the day of the Hebrew year corresponding
1422 to the date indicated by point."
1425 (autoload 'insert-islamic-diary-entry "cal-islamic"
1426 "Insert a diary entry for the Islamic date corresponding to the date
1427 indicated by point."
1430 (autoload 'insert-monthly-islamic-diary-entry "cal-islamic"
1431 "Insert a monthly diary entry for the day of the Islamic month corresponding
1432 to the date indicated by point."
1435 (autoload 'insert-yearly-islamic-diary-entry "cal-islamic"
1436 "Insert an annual diary entry for the day of the Islamic year corresponding
1437 to the date indicated by point."
1440 (autoload 'list-calendar-holidays "holidays"
1441 "Create a buffer containing the holidays for the current calendar window.
1442 The holidays are those in the list `calendar-notable-days'. Returns t if any
1443 holidays are found, nil if not."
1446 (autoload 'mark-calendar-holidays "holidays"
1447 "Mark notable days in the calendar window."
1450 (autoload 'calendar-cursor-holidays "holidays"
1451 "Find holidays for the date specified by the cursor in the calendar window."
1454 (defun generate-calendar-window (&optional mon yr)
1455 "Generate the calendar window for the current date.
1456 Or, for optional MON, YR."
1457 (let* ((buffer-read-only nil)
1458 (today (calendar-current-date))
1459 (month (extract-calendar-month today))
1460 (day (extract-calendar-day today))
1461 (year (extract-calendar-year today))
1464 (let ((offset (calendar-interval mon yr month year)))
1465 (and (<= offset 1) (>= offset -1)))))
1466 (day-in-week (calendar-day-of-week today)))
1467 (update-calendar-mode-line)
1469 (generate-calendar mon yr)
1470 (generate-calendar month year))
1471 (calendar-cursor-to-visible-date
1472 (if today-visible today (list displayed-month 1 displayed-year)))
1473 (set-buffer-modified-p nil)
1474 (or (one-window-p t)
1475 (/= (frame-width) (window-width))
1476 (shrink-window (- (window-height) 9)))
1478 (and mark-holidays-in-calendar
1479 (mark-calendar-holidays)
1482 (if mark-diary-entries-in-calendar (mark-diary-entries))
1484 (run-hooks 'today-visible-calendar-hook)
1485 (run-hooks 'today-invisible-calendar-hook)))))
1487 (defun generate-calendar (month year)
1488 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
1489 (if (< (+ month (* 12 (1- year))) 2)
1490 (error "Months before February, 1 AD are not available."))
1491 (setq displayed-month month)
1492 (setq displayed-year year)
1494 (increment-calendar-month month year -1)
1495 (calendar-for-loop i from 0 to 2 do
1496 (generate-calendar-month month year (+ 5 (* 25 i)))
1497 (increment-calendar-month month year 1)))
1499 (defun generate-calendar-month (month year indent)
1500 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
1501 The calendar is inserted in the buffer starting at the line on which point
1502 is currently located, but indented INDENT spaces. The indentation is done
1503 from the first character on the line and does not disturb the first INDENT
1504 characters on the line."
1505 (let* ((blank-days;; at start of month
1507 (- (calendar-day-of-week (list month 1 year))
1508 calendar-week-start-day)
1510 (last (calendar-last-day-of-month month year)))
1511 (goto-char (point-min))
1512 (calendar-insert-indented
1513 (calendar-string-spread
1514 (list (format "%s %d" (calendar-month-name month) year)) ? 20)
1516 (calendar-insert-indented "" indent);; Go to proper spot
1517 (calendar-for-loop i from 0 to 6 do
1518 (insert (substring (aref calendar-day-name-array
1519 (mod (+ calendar-week-start-day i) 7))
1522 (calendar-insert-indented "" 0 t);; Force onto following line
1523 (calendar-insert-indented "" indent);; Go to proper spot
1524 ;; Add blank days before the first of the month
1525 (calendar-for-loop i from 1 to blank-days do (insert " "))
1526 ;; Put in the days of the month
1527 (calendar-for-loop i from 1 to last do
1528 (insert (format "%2d " i))
1529 (put-text-property (- (point) 3) (1- (point))
1530 'mouse-face 'highlight)
1531 (and (zerop (mod (+ i blank-days) 7))
1533 (calendar-insert-indented "" 0 t) ;; Force onto following line
1534 (calendar-insert-indented "" indent)))));; Go to proper spot
1536 (defun calendar-insert-indented (string indent &optional newline)
1537 "Insert STRING at column INDENT.
1538 If the optional parameter NEWLINE is t, leave point at start of next line,
1539 inserting a newline if there was no next line; otherwise, leave point after
1540 the inserted text. Value is always t."
1541 ;; Try to move to that column.
1542 (move-to-column indent)
1543 ;; If line is too short, indent out to that column.
1544 (if (< (current-column) indent)
1547 ;; Advance to next line, if requested.
1556 (defun redraw-calendar ()
1557 "Redraw the calendar display."
1559 (let ((cursor-date (calendar-cursor-to-date)))
1560 (generate-calendar-window displayed-month displayed-year)
1561 (calendar-cursor-to-visible-date cursor-date)))
1563 (defvar calendar-debug-sexp nil
1564 "*Turn debugging on when evaluating a sexp in the diary or holiday list.")
1566 (defvar calendar-mode-map nil)
1567 (if calendar-mode-map
1569 (setq calendar-mode-map (make-sparse-keymap))
1570 (if window-system (require 'cal-menu))
1571 (calendar-for-loop i from 0 to 9 do
1572 (define-key calendar-mode-map (int-to-string i) 'digit-argument))
1573 (let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph
1574 'mark-defun 'mark-whole-buffer 'mark-page
1575 'downcase-region 'upcase-region 'kill-region
1576 'copy-region-as-kill 'capitalize-region 'write-region)))
1578 (substitute-key-definition (car l) 'calendar-not-implemented
1579 calendar-mode-map global-map)
1581 (define-key calendar-mode-map "-" 'negative-argument)
1582 (define-key calendar-mode-map "\C-x>" 'scroll-calendar-right)
1583 (define-key calendar-mode-map [prior] 'scroll-calendar-right-three-months)
1584 (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
1585 (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
1586 (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
1587 (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
1588 (define-key calendar-mode-map "\C-b" 'calendar-backward-day)
1589 (define-key calendar-mode-map "\C-p" 'calendar-backward-week)
1590 (define-key calendar-mode-map "\e{" 'calendar-backward-month)
1591 (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
1592 (define-key calendar-mode-map "\C-f" 'calendar-forward-day)
1593 (define-key calendar-mode-map "\C-n" 'calendar-forward-week)
1594 (define-key calendar-mode-map [left] 'calendar-backward-day)
1595 (define-key calendar-mode-map [up] 'calendar-backward-week)
1596 (define-key calendar-mode-map [right] 'calendar-forward-day)
1597 (define-key calendar-mode-map [down] 'calendar-forward-week)
1598 (define-key calendar-mode-map "\e}" 'calendar-forward-month)
1599 (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
1600 (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
1601 (define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
1602 (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month)
1603 (define-key calendar-mode-map "\ee" 'calendar-end-of-month)
1604 (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
1605 (define-key calendar-mode-map "\e>" 'calendar-end-of-year)
1606 (define-key calendar-mode-map "\C-@" 'calendar-set-mark)
1607 ;; Many people are used to typing C-SPC and getting C-@.
1608 (define-key calendar-mode-map [?\C-\ ] 'calendar-set-mark)
1609 (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
1610 (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
1611 (define-key calendar-mode-map "gd" 'calendar-goto-date)
1612 (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
1613 (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
1614 (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
1615 (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
1616 (define-key calendar-mode-map "gC" 'calendar-goto-chinese-date)
1617 (define-key calendar-mode-map "gk" 'calendar-goto-coptic-date)
1618 (define-key calendar-mode-map "ge" 'calendar-goto-ethiopic-date)
1619 (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
1620 (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
1621 (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
1622 (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
1623 (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
1624 (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
1625 (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
1626 (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
1627 (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
1628 (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
1629 (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
1630 (define-key calendar-mode-map " " 'scroll-other-window)
1631 (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
1632 (define-key calendar-mode-map "." 'calendar-goto-today)
1633 (define-key calendar-mode-map "o" 'calendar-other-month)
1634 (define-key calendar-mode-map "q" 'exit-calendar)
1635 (define-key calendar-mode-map "a" 'list-calendar-holidays)
1636 (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
1637 (define-key calendar-mode-map "x" 'mark-calendar-holidays)
1638 (define-key calendar-mode-map "u" 'calendar-unmark)
1639 (define-key calendar-mode-map "m" 'mark-diary-entries)
1640 (define-key calendar-mode-map "d" 'view-diary-entries)
1641 (define-key calendar-mode-map "D" 'view-other-diary-entries)
1642 (define-key calendar-mode-map "s" 'show-all-diary-entries)
1643 (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
1644 (define-key calendar-mode-map "pC" 'calendar-print-chinese-date)
1645 (define-key calendar-mode-map "pk" 'calendar-print-coptic-date)
1646 (define-key calendar-mode-map "pe" 'calendar-print-ethiopic-date)
1647 (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
1648 (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
1649 (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
1650 (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
1651 (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
1652 (define-key calendar-mode-map "pf" 'calendar-print-french-date)
1653 (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
1654 (define-key calendar-mode-map "id" 'insert-diary-entry)
1655 (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
1656 (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
1657 (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
1658 (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
1659 (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
1660 (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
1661 (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
1662 (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
1663 (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
1664 (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
1665 (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
1666 (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
1667 (define-key calendar-mode-map "?" 'calendar-goto-info-node))
1669 (defun describe-calendar-mode ()
1670 "Create a help buffer with a brief description of the calendar-mode."
1672 (with-output-to-temp-buffer "*Help*"
1675 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
1676 (substitute-command-keys
1677 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
1678 (substitute-command-keys "\\{calendar-mode-map}")))
1680 (set-buffer standard-output)
1682 (print-help-return-message)))
1684 ;; Calendar mode is suitable only for specially formatted data.
1685 (put 'calendar-mode 'mode-class 'special)
1687 (defvar calendar-mode-line-format
1689 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-left]")
1691 (substitute-command-keys "\\<calendar-mode-map>\\[calendar-goto-info-node] info/\\[calendar-other-month] other/\\[calendar-goto-today] today")
1692 '(calendar-date-string (calendar-current-date) t)
1693 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-right]"))
1694 "The mode line of the calendar buffer.")
1696 (defun calendar-goto-info-node ()
1697 "Go to the info node for the calendar."
1700 (let ((where (Info-find-emacs-command-nodes 'calendar)))
1702 (error "Couldn't find documentation for the calendar.")
1703 (save-window-excursion (info))
1704 (pop-to-buffer "*info*")
1705 (Info-find-node (car (car where)) (car (cdr (car where)))))))
1707 (defun calendar-mode ()
1708 "A major mode for the calendar window.
1710 For a complete description, type \
1711 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
1713 \\<calendar-mode-map>\\{calendar-mode-map}"
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-mark-ring)
1723 (make-local-variable 'displayed-month);; Month in middle of window.
1724 (make-local-variable 'displayed-year));; Year in middle of window.
1726 (defun calendar-string-spread (strings char length)
1727 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
1728 The effect is like mapconcat but the separating pieces are as balanced as
1729 possible. Each item of STRINGS is evaluated before concatenation so it can
1730 actually be an expression that evaluates to a string. If LENGTH is too short,
1731 the STRINGS are just concatenated and the result truncated."
1732 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
1733 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
1734 ;; Addison-Wesley, Reading, MA, 1989
1735 (let* ((strings (mapcar 'eval
1736 (if (< (length strings) 2)
1737 (append (list "") strings (list ""))
1739 (n (- length (length (apply 'concat strings))))
1740 (m (1- (length strings)))
1742 (strings (cdr strings))
1746 (make-string (max 0 (/ (+ n i) m)) char)
1749 (setq strings (cdr strings)))
1750 (substring s 0 length)))
1752 (defun update-calendar-mode-line ()
1753 "Update the calendar mode line with the current date and date style."
1754 (if (bufferp (get-buffer calendar-buffer))
1756 (set-buffer calendar-buffer)
1757 (setq mode-line-format
1758 (calendar-string-spread
1759 calendar-mode-line-format ? (frame-width))))))
1761 (defun calendar-window-list ()
1762 "List of all calendar-related windows."
1763 (let ((calendar-buffers (calendar-buffer-list))
1765 (walk-windows '(lambda (w)
1766 (if (memq (window-buffer w) calendar-buffers)
1767 (setq list (cons w list))))
1771 (defun calendar-buffer-list ()
1772 "List of all calendar-related buffers."
1773 (let* ((diary-buffer (get-file-buffer diary-file))
1774 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
1775 fancy-diary-buffer diary-buffer calendar-buffer))
1779 (setq b (car buffers))
1780 (setq b (cond ((stringp b) (get-buffer b))
1783 (if b (setq buffer-list (cons b buffer-list)))
1784 (setq buffers (cdr buffers)))
1787 (defun exit-calendar ()
1788 "Get out of the calendar window and hide it and related buffers."
1790 (let* ((diary-buffer (get-file-buffer diary-file)))
1791 (if (and diary-buffer (buffer-modified-p diary-buffer)
1794 "Diary modified; do you really want to exit the calendar? ")))
1796 ;; Need to do this multiple times because one time can replace some
1797 ;; calendar-related buffers with other calendar-related buffers
1799 (mapcar 'calendar-hide-window (calendar-window-list)))
1800 (calendar-window-list)))))
1802 (defun calendar-hide-window (window)
1803 "Hide WINDOW if it is calendar-related."
1804 (let ((buffer (if (window-live-p window) (window-buffer window))))
1805 (if (memq buffer (calendar-buffer-list))
1808 (eq 'icon (cdr (assoc 'visibility
1810 (window-frame window))))))
1812 ((and window-system (window-dedicated-p window))
1813 (iconify-frame (window-frame window)))
1814 ((not (and (select-window window) (one-window-p window)))
1815 (delete-window window))
1816 (t (set-buffer buffer)
1819 (defun calendar-current-date ()
1820 "Returns the current date in a list (month day year)."
1821 (let ((s (current-time-string)))
1822 (list (length (member (substring s 4 7)
1823 '("Dec" "Nov" "Oct" "Sep" "Aug" "Jul"
1824 "Jun" "May" "Apr" "Mar" "Feb" "Jan")))
1825 (string-to-number (substring s 8 10))
1826 (string-to-number (substring s 20 24)))))
1828 (defun calendar-cursor-to-date (&optional error)
1829 "Returns a list (month day year) of current cursor position.
1830 If cursor is not on a specific date, signals an error if optional parameter
1831 ERROR is t, otherwise just returns nil."
1832 (let* ((segment (/ (current-column) 25))
1833 (month (% (+ displayed-month segment -1) 12))
1834 (month (if (= 0 month) 12 month))
1837 ((and (= 12 month) (= segment 0)) (1- displayed-year))
1838 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
1839 (t displayed-year))))
1840 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
1841 (< 2 (count-lines (point-min) (point))))
1843 (if (not (looking-at " "))
1844 (re-search-backward "[^0-9]"))
1846 (string-to-int (buffer-substring (1+ (point)) (+ 4 (point))))
1848 (if (looking-at "\\*")
1850 (re-search-backward "[^*]")
1851 (if (looking-at ".\\*\\*")
1852 (list month calendar-starred-day year)
1853 (if error (error "Not on a date!"))))
1854 (if error (error "Not on a date!"))))))
1856 ;; The following version of calendar-gregorian-from-absolute is preferred for
1857 ;; reasons of clarity, BUT it's much slower than the version that follows it.
1859 ;;(defun calendar-gregorian-from-absolute (date)
1860 ;; "Compute the list (month day year) corresponding to the absolute DATE.
1861 ;;The absolute date is the number of days elapsed since the (imaginary)
1862 ;;Gregorian date Sunday, December 31, 1 BC."
1863 ;; (let* ((approx (/ date 366));; Approximation from below.
1864 ;; (year ;; Search forward from the approximation.
1866 ;; (calendar-sum y approx
1867 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
1869 ;; (month ;; Search forward from January.
1870 ;; (1+ (calendar-sum m 1
1872 ;; (calendar-absolute-from-gregorian
1873 ;; (list m (calendar-last-day-of-month m year) year)))
1875 ;; (day ;; Calculate the day by subtraction.
1877 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
1878 ;; (list month day year)))
1880 (defun calendar-gregorian-from-absolute (date)
1881 "Compute the list (month day year) corresponding to the absolute DATE.
1882 The absolute date is the number of days elapsed since the (imaginary)
1883 Gregorian date Sunday, December 31, 1 BC."
1884 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
1885 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
1886 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
1887 ;; (April, 1993), pages 383-404 for an explanation.
1888 (let* ((d0 (1- date))
1889 (n400 (/ d0 146097))
1896 (day (1+ (% d3 365)))
1897 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
1898 (if (or (= n100 4) (= n1 4))
1900 (let ((year (1+ year))
1902 (while (let ((mdays (calendar-last-day-of-month month year)))
1904 (setq day (- day mdays))))
1905 (setq month (1+ month)))
1906 (list month day year)))))
1908 (defun calendar-other-month (month year)
1909 "Display a three-month calendar centered around MONTH and YEAR."
1910 (interactive (calendar-read-date 'noday))
1911 (if (and (= month displayed-month)
1912 (= year displayed-year))
1914 (let ((old-date (calendar-cursor-to-date))
1915 (today (calendar-current-date)))
1916 (generate-calendar-window month year)
1917 (calendar-cursor-to-visible-date
1919 ((calendar-date-is-visible-p old-date) old-date)
1920 ((calendar-date-is-visible-p today) today)
1921 (t (list month 1 year)))))))
1923 (defun calendar-set-mark (arg)
1924 "Mark the date under the cursor, or jump to marked date.
1925 With no prefix argument, push current date onto marked date ring.
1926 With argument, jump to mark, pop it, and put point at end of ring."
1928 (let ((date (calendar-cursor-to-date t)))
1931 (setq calendar-mark-ring (cons date calendar-mark-ring))
1932 ;; Since the top of the mark ring is the marked date in the
1933 ;; calendar, the mark ring in the calendar is one longer than
1934 ;; in other buffers to get the same effect.
1935 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
1936 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
1937 (message "Mark set"))
1938 (if (null calendar-mark-ring)
1939 (error "No mark set in this buffer")
1940 (calendar-goto-date (car calendar-mark-ring))
1941 (setq calendar-mark-ring
1942 (cdr (nconc calendar-mark-ring (list date))))))))
1944 (defun calendar-exchange-point-and-mark ()
1945 "Exchange the current cursor position with the marked date."
1947 (let ((mark (car calendar-mark-ring))
1948 (date (calendar-cursor-to-date t)))
1950 (error "No mark set in this buffer")
1951 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
1952 (calendar-goto-date mark))))
1954 (defun calendar-count-days-region ()
1955 "Count the number of days (inclusive) between point and the mark."
1957 (let* ((days (- (calendar-absolute-from-gregorian
1958 (calendar-cursor-to-date t))
1959 (calendar-absolute-from-gregorian
1960 (or (car calendar-mark-ring)
1961 (error "No mark set in this buffer")))))
1962 (days (1+ (if (> days 0) days (- days)))))
1963 (message "Region has %d day%s (inclusive)"
1964 days (if (> days 1) "s" ""))))
1966 (defun calendar-not-implemented ()
1969 (error "%s not available in the calendar"
1970 (global-key-binding (this-command-keys))))
1972 (defun calendar-read (prompt acceptable &optional initial-contents)
1973 "Return an object read from the minibuffer.
1974 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
1975 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
1976 is a string to insert in the minibuffer before reading."
1977 (let ((value (read-minibuffer prompt initial-contents)))
1978 (while (not (funcall acceptable value))
1979 (setq value (read-minibuffer prompt initial-contents)))
1982 (defun calendar-read-date (&optional noday)
1983 "Prompt for Gregorian date. Returns a list (month day year).
1984 If optional NODAY is t, does not ask for day, but just returns
1985 (month nil year); if NODAY is any other non-nil value the value returned is
1987 (let* ((year (calendar-read
1989 '(lambda (x) (> x 0))
1990 (int-to-string (extract-calendar-year
1991 (calendar-current-date)))))
1992 (month-array calendar-month-name-array)
1993 (completion-ignore-case t)
1998 (mapcar 'list (append month-array nil))
2000 (calendar-make-alist month-array 1 'capitalize))))
2001 (last (calendar-last-day-of-month month year)))
2004 (list month nil year)
2007 (calendar-read (format "Day (1-%d): " last)
2008 '(lambda (x) (and (< 0 x) (<= x last))))
2011 (defun calendar-interval (mon1 yr1 mon2 yr2)
2012 "The number of months difference between MON1, YR1 and MON2, YR2."
2013 (+ (* 12 (- yr2 yr1))
2016 (defun calendar-day-name (date)
2017 "Returns a string with the name of the day of the week of DATE."
2018 (aref calendar-day-name-array (calendar-day-of-week date)))
2020 (defvar calendar-day-name-array
2021 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"])
2023 (defvar calendar-month-name-array
2024 ["January" "February" "March" "April" "May" "June"
2025 "July" "August" "September" "October" "November" "December"])
2027 (defun calendar-make-alist (sequence &optional start-index filter)
2028 "Make an assoc list corresponding to SEQUENCE.
2029 Start at index 1, unless optional START-INDEX is provided.
2030 If FILTER is provided, apply it to each item in the list."
2031 (let ((index (if start-index (1- start-index) 0)))
2034 (setq index (1+ index))
2035 (cons (if filter (funcall filter x) x)
2037 (append sequence nil))))
2039 (defun calendar-month-name (month)
2040 "The name of MONTH."
2041 (aref calendar-month-name-array (1- month)))
2043 (defun calendar-day-of-week (date)
2044 "Returns the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc."
2045 (% (calendar-absolute-from-gregorian date) 7))
2047 (defun calendar-unmark ()
2048 "Delete all diary/holiday marks/highlighting from the calendar."
2050 (setq mark-holidays-in-calendar nil)
2051 (setq mark-diary-entries-in-calendar nil)
2054 (defun calendar-date-is-visible-p (date)
2055 "Returns t if DATE is legal and is visible in the calendar window."
2056 (let ((gap (calendar-interval
2057 displayed-month displayed-year
2058 (extract-calendar-month date) (extract-calendar-year date))))
2059 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2061 (defun calendar-date-is-legal-p (date)
2062 "Returns t if DATE is a legal date."
2063 (let ((month (extract-calendar-month date))
2064 (day (extract-calendar-day date))
2065 (year (extract-calendar-year date)))
2066 (and (<= 1 month) (<= month 12)
2067 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2070 (defun calendar-date-equal (date1 date2)
2071 "Returns t if the DATE1 and DATE2 are the same."
2073 (= (extract-calendar-month date1) (extract-calendar-month date2))
2074 (= (extract-calendar-day date1) (extract-calendar-day date2))
2075 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2077 (defun mark-visible-calendar-date (date &optional mark)
2078 "Mark DATE in the calendar window with MARK.
2079 MARK is either a single-character string or a face.
2080 MARK defaults to diary-entry-marker."
2081 (if (calendar-date-is-legal-p date)
2083 (set-buffer calendar-buffer)
2084 (calendar-cursor-to-visible-date date)
2085 (let ((mark (or mark diary-entry-marker)))
2087 (let ((buffer-read-only nil))
2093 (make-overlay (1- (point)) (1+ (point))) 'face mark))))))
2095 (defun calendar-star-date ()
2096 "Replace the date under the cursor in the calendar window with asterisks.
2097 This function can be used with the today-visible-calendar-hook run after the
2098 calendar window has been prepared."
2099 (let ((buffer-read-only nil))
2100 (make-variable-buffer-local 'calendar-starred-day)
2102 (setq calendar-starred-day
2104 (buffer-substring (point) (- (point) 2))))
2108 (set-buffer-modified-p nil)))
2110 (defun calendar-mark-today ()
2111 "Mark the date under the cursor in the calendar window.
2112 The date is marked with calendar-today-marker. This function can be used with
2113 the today-visible-calendar-hook run after the calendar window has been
2115 (mark-visible-calendar-date
2116 (calendar-cursor-to-date)
2117 calendar-today-marker))
2119 (defun calendar-date-compare (date1 date2)
2120 "Returns t if DATE1 is before DATE2, nil otherwise.
2121 The actual dates are in the car of DATE1 and DATE2."
2122 (< (calendar-absolute-from-gregorian (car date1))
2123 (calendar-absolute-from-gregorian (car date2))))
2125 (defun calendar-date-string (date &optional abbreviate nodayname)
2126 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2127 An optional parameter ABBREVIATE, when t, causes the month and day names to be
2128 abbreviated to three characters. An optional parameter NODAYNAME, when t,
2129 omits the name of the day of the week."
2134 (substring (calendar-day-name date) 0 3)
2135 (calendar-day-name date))))
2136 (month (extract-calendar-month date))
2140 (calendar-month-name month) 0 3)
2141 (calendar-month-name month)))
2142 (day (int-to-string (extract-calendar-day date)))
2143 (month (int-to-string month))
2144 (year (int-to-string (extract-calendar-year date))))
2145 (mapconcat 'eval calendar-date-display-form "")))
2147 (defun calendar-dayname-on-or-before (dayname date)
2148 "Returns the absolute date of the DAYNAME on or before absolute DATE.
2149 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
2151 Note: Applying this function to d+6 gives us the DAYNAME on or after an
2152 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
2153 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
2154 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
2155 (- date (% (- date dayname) 7)))
2157 (defun calendar-nth-named-absday (n dayname month year &optional day)
2158 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2159 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2160 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2161 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2163 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2166 (calendar-dayname-on-or-before
2168 (+ 6 (calendar-absolute-from-gregorian
2169 (list month (or day 1) year)))))
2171 (calendar-dayname-on-or-before
2173 (calendar-absolute-from-gregorian
2175 (or day (calendar-last-day-of-month month year))
2178 (defun calendar-nth-named-day (n dayname month year &optional day)
2179 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2180 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2181 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2182 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2184 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2185 (calendar-gregorian-from-absolute
2186 (calendar-nth-named-absday n dayname month year day)))
2188 (defun calendar-day-of-year-string (&optional date)
2189 "String of day number of year of Gregorian DATE.
2190 Defaults to today's date if DATE is not given."
2191 (let* ((d (or date (calendar-current-date)))
2192 (year (extract-calendar-year d))
2193 (day (calendar-day-number d))
2194 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
2195 (format "Day %d of %d; %d day%s remaining in the year"
2196 day year days-remaining (if (= days-remaining 1) "" "s"))))
2198 (defun calendar-print-day-of-year ()
2199 "Show day number in year/days remaining in year for date under the cursor."
2201 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
2203 (defun calendar-set-mode-line (str)
2204 "Set mode line to STR, centered, surrounded by dashes."
2205 (setq mode-line-format
2206 (calendar-string-spread (list str) ?- (frame-width))))
2208 (defun calendar-mod (m n)
2209 "Non-negative remainder of M/N with N instead of 0."
2210 (1+ (mod (1- m) n)))
2212 (run-hooks 'calendar-load-hook)
2216 ;;; calendar.el ends here