Restore previous use of browse-url-maybe-new-window.
[emacs.git] / lisp / calendar / calendar.el
blobafeece0432823da954d51fd802ec4e9a60a7475b
1 ;;; calendar.el --- Calendar functions.
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997
4 ;; Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Keywords: calendar
8 ;; Human-Keywords: calendar, Gregorian calendar, diary, holidays
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
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
49 ;; available. Calendar printing via LaTeX is available.
51 ;; The following files are part of the calendar/diary code:
53 ;; appt.el Appointment notification
54 ;; cal-china.el Chinese calendar
55 ;; cal-coptic.el Coptic/Ethiopic calendars
56 ;; cal-dst.el Daylight savings time rules
57 ;; cal-hebrew.el Hebrew calendar
58 ;; cal-islam.el Islamic calendar
59 ;; cal-iso.el ISO calendar
60 ;; cal-julian.el Julian/astronomical calendars
61 ;; cal-mayan.el Mayan calendars
62 ;; cal-menu.el Menu support
63 ;; cal-move.el Movement in the calendar
64 ;; cal-persia.el Persian calendar
65 ;; cal-tex.el Calendars in LaTeX
66 ;; cal-x.el X-windows dedicated frame functions
67 ;; diary-lib.el Diary functions
68 ;; holidays.el Holiday functions
69 ;; lunar.el Phases of the moon
70 ;; solar.el Sunrise/sunset, equinoxes/solstices
72 ;; Technical details of all the calendrical calculations can be found in
73 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
74 ;; Cambridge University Press (1997).
76 ;; An earlier version of the technical details appeared 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),
82 ;; pages 383-404.
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).
88 ;; Comments, corrections, and improvements should be sent to
89 ;; Edward M. Reingold Department of Computer Science
90 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
91 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
92 ;; Urbana, Illinois 61801
94 ;;; Code:
96 (defun calendar-version ()
97 (interactive)
98 (message "Version 6, October 12, 1995"))
100 (defgroup calendar nil
101 "Calendar and time management support."
102 :group 'applications)
104 (defgroup diary nil
105 "Emacs diary."
106 :group 'calendar)
108 (defgroup appt nil
109 "Appointment notification."
110 :group 'calendar)
112 (defgroup holidays nil
113 "Holidays support in calendar."
114 :group 'calendar
115 :prefix "calendar-"
116 :group 'local)
118 (defgroup chinese-calendar nil
119 "Chinese calendar support."
120 :group 'calendar)
122 (defgroup calendar-tex nil
123 "Options for printing calendar with LaTeX."
124 :prefix "cal-tex-"
125 :group 'calendar)
127 (defgroup calendar-hooks nil
128 "Calendar hooks."
129 :prefix "calendar-"
130 :group 'calendar)
133 ;;;###autoload
134 (defcustom calendar-week-start-day 0
135 "*The day of the week on which a week in the calendar begins.
136 0 means Sunday (default), 1 means Monday, and so on."
137 :type 'integer
138 :group 'calendar)
140 ;;;###autoload
141 (defcustom calendar-offset 0
142 "*The offset of the principal month from the center of the calendar window.
143 0 means the principal month is in the center (default), -1 means on the left,
144 +1 means on the right. Larger (or smaller) values push the principal month off
145 the screen."
146 :type 'integer
147 :group 'calendar)
149 ;;;###autoload
150 (defcustom view-diary-entries-initially nil
151 "*Non-nil means display current date's diary entries on entry.
152 The diary is displayed in another window when the calendar is first displayed,
153 if the current date is visible. The number of days of diary entries displayed
154 is governed by the variable `number-of-diary-entries'."
155 :type 'boolean
156 :group 'diary)
158 ;;;###autoload
159 (defcustom number-of-diary-entries 1
160 "*Specifies how many days of diary entries are to be displayed initially.
161 This variable affects the diary display when the command M-x diary is used,
162 or if the value of the variable `view-diary-entries-initially' is t. For
163 example, if the default value 1 is used, then only the current day's diary
164 entries will be displayed. If the value 2 is used, then both the current
165 day's and the next day's entries will be displayed.
167 The value can also be a vector such as [0 2 2 2 2 4 1]; this value
168 says to display no diary entries on Sunday, the display the entries
169 for the current date and the day after on Monday through Thursday,
170 display Friday through Monday's entries on Friday, and display only
171 Saturday's entries on Saturday.
173 This variable does not affect the diary display with the `d' command
174 from the calendar; in that case, the prefix argument controls the
175 number of days of diary entries displayed."
176 :type '(choice (integer :tag "Entries")
177 (vector :value [0 0 0 0 0 0 0]
178 (integer :tag "Sunday")
179 (integer :tag "Monday")
180 (integer :tag "Tuesday")
181 (integer :tag "Wednesday")
182 (integer :tag "Thursday")
183 (integer :tag "Friday")
184 (integer :tag "Saturday")))
185 :group 'diary)
187 ;;;###autoload
188 (defcustom mark-diary-entries-in-calendar nil
189 "*Non-nil means mark dates with diary entries, in the calendar window.
190 The marking symbol is specified by the variable `diary-entry-marker'."
191 :type 'boolean
192 :group 'diary)
194 ;;;###autoload
195 (defcustom calendar-remove-frame-by-deleting nil
196 "*Determine how the calendar mode removes a frame no longer needed.
197 If nil, make an icon of the frame. If non-nil, delete the frame."
198 :type 'boolean
199 :group 'view)
201 (when window-system
202 (add-to-list 'facemenu-unlisted-faces 'diary-face)
203 (defface diary-face
204 '((((class color))
205 (:foreground "red"))
206 (t (:bold t)))
207 "Face for highlighting diary entries."
208 :group 'diary)
210 (add-to-list 'facemenu-unlisted-faces 'calendar-today-face)
211 (defface calendar-today-face
212 '((t (:underline t)))
213 "Face for indicating today's date."
214 :group 'diary)
216 (add-to-list 'facemenu-unlisted-faces 'holiday-face)
217 (defface holiday-face
218 '((((class color))
219 (:background "pink"))
220 (t (:inverse-video t)))
221 "Face for indicating dates that have holidays."
222 :group 'diary))
224 (defcustom diary-entry-marker
225 (if (not window-system)
227 'diary-face)
228 "*How to mark dates that have diary entries.
229 The value can be either a single-character string or a face."
230 :type '(choice string face)
231 :group 'diary)
233 (defcustom calendar-today-marker
234 (if (not window-system)
236 'calendar-today-face)
237 "*How to mark today's date in the calendar.
238 The value can be either a single-character string or a face.
239 Marking today's date is done only if you set up `today-visible-calendar-hook'
240 to request that."
241 :type '(choice string face)
242 :group 'calendar)
244 (defcustom calendar-holiday-marker
245 (if (not window-system)
247 'holiday-face)
248 "*How to mark notable dates in the calendar.
249 The value can be either a single-character string or a face."
250 :type '(choice string face)
251 :group 'calendar)
253 ;;;###autoload
254 (defcustom view-calendar-holidays-initially nil
255 "*Non-nil means display holidays for current three month period on entry.
256 The holidays are displayed in another window when the calendar is first
257 displayed."
258 :type 'boolean
259 :group 'holidays)
261 ;;;###autoload
262 (defcustom mark-holidays-in-calendar nil
263 "*Non-nil means mark dates of holidays in the calendar window.
264 The marking symbol is specified by the variable `calendar-holiday-marker'."
265 :type 'boolean
266 :group 'holidays)
268 ;;;###autoload
269 (defcustom all-hebrew-calendar-holidays nil
270 "*If nil, show only major holidays from the Hebrew calendar.
271 This means only those Jewish holidays that appear on secular calendars.
273 If t, show all the holidays that would appear in a complete Hebrew calendar."
274 :type 'boolean
275 :group 'holidays)
277 ;;;###autoload
278 (defcustom all-christian-calendar-holidays nil
279 "*If nil, show only major holidays from the Christian calendar.
280 This means only those Christian holidays that appear on secular calendars.
282 If t, show all the holidays that would appear in a complete Christian
283 calendar."
284 :type 'boolean
285 :group 'holidays)
287 ;;;###autoload
288 (defcustom all-islamic-calendar-holidays nil
289 "*If nil, show only major holidays from the Islamic calendar.
290 This means only those Islamic holidays that appear on secular calendars.
292 If t, show all the holidays that would appear in a complete Islamic
293 calendar."
294 :type 'boolean
295 :group 'holidays)
297 ;;;###autoload
298 (defcustom calendar-load-hook nil
299 "*List of functions to be called after the calendar is first loaded.
300 This is the place to add key bindings to `calendar-mode-map'."
301 :type 'hook
302 :group 'calendar-hooks)
304 ;;;###autoload
305 (defcustom initial-calendar-window-hook nil
306 "*List of functions to be called when the calendar window is first opened.
307 The functions invoked are called after the calendar window is opened, but
308 once opened is never called again. Leaving the calendar with the `q' command
309 and reentering it will cause these functions to be called again."
310 :type 'hook
311 :group 'calendar-hooks)
313 ;;;###autoload
314 (defcustom today-visible-calendar-hook nil
315 "*List of functions called whenever the current date is visible.
316 This can be used, for example, to replace today's date with asterisks; a
317 function `calendar-star-date' is included for this purpose:
318 (setq today-visible-calendar-hook 'calendar-star-date)
319 It can also be used to mark the current date with `calendar-today-marker';
320 a function is also provided for this:
321 (setq today-visible-calendar-hook 'calendar-mark-today)
323 The corresponding variable `today-invisible-calendar-hook' is the list of
324 functions called when the calendar function was called when the current
325 date is not visible in the window.
327 Other than the use of the provided functions, the changing of any
328 characters in the calendar buffer by the hooks may cause the failure of the
329 functions that move by days and weeks."
330 :type 'hook
331 :group 'calendar-hooks)
333 ;;;###autoload
334 (defcustom today-invisible-calendar-hook nil
335 "*List of functions called whenever the current date is not visible.
337 The corresponding variable `today-visible-calendar-hook' is the list of
338 functions called when the calendar function was called when the current
339 date is visible in the window.
341 Other than the use of the provided functions, the changing of any
342 characters in the calendar buffer by the hooks may cause the failure of the
343 functions that move by days and weeks."
344 :type 'hook
345 :group 'calendar-hooks)
347 ;;;###autoload
348 (defcustom calendar-move-hook nil
349 "*List of functions called whenever the cursor moves in the calendar.
351 For example,
353 (add-hook 'calendar-move-hook (lambda () (view-diary-entries 1)))
355 redisplays the diary for whatever date the cursor is moved to."
356 :type 'hook
357 :group 'calendar-hooks)
359 ;;;###autoload
360 (defcustom diary-file "~/diary"
361 "*Name of the file in which one's personal diary of dates is kept.
363 The file's entries are lines in any of the forms
365 MONTH/DAY
366 MONTH/DAY/YEAR
367 MONTHNAME DAY
368 MONTHNAME DAY, YEAR
369 DAYNAME
371 at the beginning of the line; the remainder of the line is the diary entry
372 string for that date. MONTH and DAY are one or two digit numbers, YEAR is
373 a number and may be written in full or abbreviated to the final two digits.
374 If the date does not contain a year, it is generic and applies to any year.
375 DAYNAME entries apply to any date on which is on that day of the week.
376 MONTHNAME and DAYNAME can be spelled in full, abbreviated to three
377 characters (with or without a period), capitalized or not. Any of DAY,
378 MONTH, or MONTHNAME, YEAR can be `*' which matches any day, month, or year,
379 respectively.
381 The European style (in which the day precedes the month) can be used
382 instead, if you execute `european-calendar' when in the calendar, or set
383 `european-calendar-style' to t in your .emacs file. The European forms are
385 DAY/MONTH
386 DAY/MONTH/YEAR
387 DAY MONTHNAME
388 DAY MONTHNAME YEAR
389 DAYNAME
391 To revert to the default American style from the European style, execute
392 `american-calendar' in the calendar.
394 A diary entry can be preceded by the character
395 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
396 nonmarking--that is, it will not be marked on dates in the calendar
397 window but will appear in a diary window.
399 Multiline diary entries are made by indenting lines after the first with
400 either a TAB or one or more spaces.
402 Lines not in one the above formats are ignored. Here are some sample diary
403 entries (in the default American style):
405 12/22/1988 Twentieth wedding anniversary!!
406 &1/1. Happy New Year!
407 10/22 Ruth's birthday.
408 21: Payday
409 Tuesday--weekly meeting with grad students at 10am
410 Supowit, Shen, Bitner, and Kapoor to attend.
411 1/13/89 Friday the thirteenth!!
412 &thu 4pm squash game with Lloyd.
413 mar 16 Dad's birthday
414 April 15, 1989 Income tax due.
415 &* 15 time cards due.
417 If the first line of a diary entry consists only of the date or day name with
418 no trailing blanks or punctuation, then that line is not displayed in the
419 diary window; only the continuation lines is shown. For example, the
420 single diary entry
422 02/11/1989
423 Bill Blattner visits Princeton today
424 2pm Cognitive Studies Committee meeting
425 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
426 4:00pm Jamie Tappenden
427 7:30pm Dinner at George and Ed's for Alan Ryan
428 7:30-10:00pm dance at Stewart Country Day School
430 will appear in the diary window without the date line at the beginning. This
431 facility allows the diary window to look neater, but can cause confusion if
432 used with more than one day's entries displayed.
434 Diary entries can be based on Lisp sexps. For example, the diary entry
436 %%(diary-block 11 1 1990 11 10 1990) Vacation
438 causes the diary entry \"Vacation\" to appear from November 1 through November
439 10, 1990. Other functions available are `diary-float', `diary-anniversary',
440 `diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date',
441 `diary-hebrew-date', `diary-islamic-date', `diary-mayan-date',
442 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
443 `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset',
444 `diary-phases-of-moon', `diary-parasha', `diary-omer', `diary-rosh-hodesh',
445 and `diary-sabbath-candles'. See the documentation for the function
446 `list-sexp-diary-entries' for more details.
448 Diary entries based on the Hebrew and/or the Islamic calendar are also
449 possible, but because these are somewhat slow, they are ignored
450 unless you set the `nongregorian-diary-listing-hook' and the
451 `nongregorian-diary-marking-hook' appropriately. See the documentation
452 for these functions for details.
454 Diary files can contain directives to include the contents of other files; for
455 details, see the documentation for the variable `list-diary-entries-hook'."
456 :type 'file
457 :group 'diary)
459 ;;;###autoload
460 (defcustom diary-nonmarking-symbol "&"
461 "*Symbol indicating that a diary entry is not to be marked in the calendar."
462 :type 'string
463 :group 'diary)
465 ;;;###autoload
466 (defcustom hebrew-diary-entry-symbol "H"
467 "*Symbol indicating a diary entry according to the Hebrew calendar."
468 :type 'string
469 :group 'diary)
471 ;;;###autoload
472 (defcustom islamic-diary-entry-symbol "I"
473 "*Symbol indicating a diary entry according to the Islamic calendar."
474 :type 'string
475 :group 'diary)
477 ;;;###autoload
478 (defcustom diary-include-string "#include"
479 "*The string indicating inclusion of another file of diary entries.
480 See the documentation for the function `include-other-diary-files'."
481 :type 'string
482 :group 'diary)
484 ;;;###autoload
485 (defcustom sexp-diary-entry-symbol "%%"
486 "*The string used to indicate a sexp diary entry in diary-file.
487 See the documentation for the function `list-sexp-diary-entries'."
488 :type 'string
489 :group 'diary)
491 ;;;###autoload
492 (defcustom abbreviated-calendar-year t
493 "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
494 For the Gregorian calendar; similarly for the Hebrew and Islamic calendars.
495 If this variable is nil, years must be written in full."
496 :type 'boolean
497 :group 'diary)
499 ;;;###autoload
500 (defcustom european-calendar-style nil
501 "*Use the European style of dates in the diary and in any displays.
502 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
503 1990. The accepted European date styles are
505 DAY/MONTH
506 DAY/MONTH/YEAR
507 DAY MONTHNAME
508 DAY MONTHNAME YEAR
509 DAYNAME
511 Names can be capitalized or not, written in full, or abbreviated to three
512 characters with or without a period."
513 :type 'boolean
514 :group 'diary)
516 ;;;###autoload
517 (defcustom american-date-diary-pattern
518 '((month "/" day "[^/0-9]")
519 (month "/" day "/" year "[^0-9]")
520 (monthname " *" day "[^,0-9]")
521 (monthname " *" day ", *" year "[^0-9]")
522 (dayname "\\W"))
523 "*List of pseudo-patterns describing the American patterns of date used.
524 See the documentation of `diary-date-forms' for an explanation."
525 :type '(repeat (choice (cons :tag "Backup"
526 :value (backup . nil)
527 (const backup)
528 (repeat (list :inline t :format "%v"
529 (symbol :tag "Keyword")
530 (choice symbol regexp))))
531 (repeat (list :inline t :format "%v"
532 (symbol :tag "Keyword")
533 (choice symbol regexp)))))
534 :group 'diary)
536 ;;;###autoload
537 (defcustom european-date-diary-pattern
538 '((day "/" month "[^/0-9]")
539 (day "/" month "/" year "[^0-9]")
540 (backup day " *" monthname "\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
541 (day " *" monthname " *" year "[^0-9]")
542 (dayname "\\W"))
543 "*List of pseudo-patterns describing the European patterns of date used.
544 See the documentation of `diary-date-forms' for an explanation."
545 :type '(repeat (choice (cons :tag "Backup"
546 :value (backup . nil)
547 (const backup)
548 (repeat (list :inline t :format "%v"
549 (symbol :tag "Keyword")
550 (choice symbol regexp))))
551 (repeat (list :inline t :format "%v"
552 (symbol :tag "Keyword")
553 (choice symbol regexp)))))
554 :group 'diary)
556 (defcustom diary-date-forms
557 (if european-calendar-style
558 european-date-diary-pattern
559 american-date-diary-pattern)
560 "*List of pseudo-patterns describing the forms of date used in the diary.
561 The patterns on the list must be MUTUALLY EXCLUSIVE and must should not match
562 any portion of the diary entry itself, just the date component.
564 A pseudo-pattern is a list of regular expressions and the keywords `month',
565 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
566 match the name of the month, capitalized or not, or its three-letter
567 abbreviation, followed by a period or not; it will also match `*'.
568 Similarly, `dayname' will match the name of the day, capitalized or not, or
569 its three-letter abbreviation, followed by a period or not. The keywords
570 `month', `day', and `year' will match those numerical values, preceded by
571 arbitrarily many zeros; they will also match `*'.
573 The matching of the diary entries with the date forms is done with the
574 standard syntax table from Fundamental mode, but with the `*' changed so
575 that it is a word constituent.
577 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
578 diary entry itself, the first element of the pattern MUST be `backup'. This
579 directive causes the date recognizer to back up to the beginning of the
580 current word of the diary entry, so in no case can the pattern match more than
581 a portion of the first word of the diary entry."
582 :type '(repeat (choice (cons :tag "Backup"
583 :value (backup . nil)
584 (const backup)
585 (repeat (list :inline t :format "%v"
586 (symbol :tag "Keyword")
587 (choice symbol regexp))))
588 (repeat (list :inline t :format "%v"
589 (symbol :tag "Keyword")
590 (choice symbol regexp)))))
591 :group 'diary)
593 ;;;###autoload
594 (defcustom european-calendar-display-form
595 '((if dayname (concat dayname ", ")) day " " monthname " " year)
596 "*Pseudo-pattern governing the way a date appears in the European style.
597 See the documentation of calendar-date-display-form for an explanation."
598 :type 'sexp
599 :group 'calendar)
601 ;;;###autoload
602 (defcustom american-calendar-display-form
603 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
604 "*Pseudo-pattern governing the way a date appears in the American style.
605 See the documentation of `calendar-date-display-form' for an explanation."
606 :type 'sexp
607 :group 'calendar)
609 (defcustom calendar-date-display-form
610 (if european-calendar-style
611 european-calendar-display-form
612 american-calendar-display-form)
613 "*Pseudo-pattern governing the way a date appears.
615 Used by the function `calendar-date-string', a pseudo-pattern is a list of
616 expressions that can involve the keywords `month', `day', and `year', all
617 numbers in string form, and `monthname' and `dayname', both alphabetic
618 strings. For example, the ISO standard would use the pseudo- pattern
620 '(year \"-\" month \"-\" day)
622 while a typical American form would be
624 '(month \"/\" day \"/\" (substring year -2))
628 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
630 would give the usual American style in fixed-length fields.
632 See the documentation of the function `calendar-date-string'."
633 :type 'sexp
634 :group 'calendar)
636 (defun european-calendar ()
637 "Set the interpretation and display of dates to the European style."
638 (interactive)
639 (setq european-calendar-style t)
640 (setq calendar-date-display-form european-calendar-display-form)
641 (setq diary-date-forms european-date-diary-pattern)
642 (update-calendar-mode-line))
644 (defun american-calendar ()
645 "Set the interpretation and display of dates to the American style."
646 (interactive)
647 (setq european-calendar-style nil)
648 (setq calendar-date-display-form american-calendar-display-form)
649 (setq diary-date-forms american-date-diary-pattern)
650 (update-calendar-mode-line))
652 ;;;###autoload
653 (defcustom print-diary-entries-hook 'lpr-buffer
654 "*List of functions called after a temporary diary buffer is prepared.
655 The buffer shows only the diary entries currently visible in the diary
656 buffer. The default just does the printing. Other uses might include, for
657 example, rearranging the lines into order by day and time, saving the buffer
658 instead of deleting it, or changing the function used to do the printing."
659 :type 'hook
660 :group 'diary)
662 ;;;###autoload
663 (defcustom list-diary-entries-hook nil
664 "*List of functions called after diary file is culled for relevant entries.
665 It is to be used for diary entries that are not found in the diary file.
667 A function `include-other-diary-files' is provided for use as the value of
668 this hook. This function enables you to use shared diary files together
669 with your own. The files included are specified in the diary file by lines
670 of the form
672 #include \"filename\"
674 This is recursive; that is, #include directives in files thus included are
675 obeyed. You can change the \"#include\" to some other string by changing
676 the variable `diary-include-string'. When you use `include-other-diary-files'
677 as part of the list-diary-entries-hook, you will probably also want to use the
678 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
680 For example, you could use
682 (setq list-diary-entries-hook
683 '(include-other-diary-files sort-diary-entries))
684 (setq diary-display-hook 'fancy-diary-display)
686 in your `.emacs' file to cause the fancy diary buffer to be displayed with
687 diary entries from various included files, each day's entries sorted into
688 lexicographic order."
689 :type 'hook
690 :group 'diary)
692 ;;;###autoload
693 (defcustom diary-hook nil
694 "*List of functions called after the display of the diary.
695 Can be used for appointment notification."
696 :type 'hook
697 :group 'diary)
699 ;;;###autoload
700 (defcustom diary-display-hook nil
701 "*List of functions that handle the display of the diary.
702 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
703 diary display.
705 Ordinarily, this just displays the diary buffer (with holidays indicated in
706 the mode line), if there are any relevant entries. At the time these
707 functions are called, the variable `diary-entries-list' is a list, in order
708 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
709 STRING), where string is the diary entry for the given date. This can be
710 used, for example, a different buffer for display (perhaps combined with
711 holidays), or produce hard copy output.
713 A function `fancy-diary-display' is provided as an alternative
714 choice for this hook; this function prepares a special noneditable diary
715 buffer with the relevant diary entries that has neat day-by-day arrangement
716 with headings. The fancy diary buffer will show the holidays unless the
717 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
718 diary buffer will not show days for which there are no diary entries, even
719 if that day is a holiday; if you want such days to be shown in the fancy
720 diary buffer, set the variable `diary-list-include-blanks' to t."
721 :type 'hook
722 :group 'diary)
724 ;;;###autoload
725 (defcustom nongregorian-diary-listing-hook nil
726 "*List of functions called for listing diary file and included files.
727 As the files are processed for diary entries, these functions are used to cull
728 relevant entries. You can use either or both of `list-hebrew-diary-entries'
729 and `list-islamic-diary-entries'. The documentation for these functions
730 describes the style of such diary entries."
731 :type 'hook
732 :group 'diary)
734 ;;;###autoload
735 (defcustom mark-diary-entries-hook nil
736 "*List of functions called after marking diary entries in the calendar.
738 A function `mark-included-diary-files' is also provided for use as the
739 mark-diary-entries-hook; it enables you to use shared diary files together
740 with your own. The files included are specified in the diary file by lines
741 of the form
742 #include \"filename\"
743 This is recursive; that is, #include directives in files thus included are
744 obeyed. You can change the \"#include\" to some other string by changing the
745 variable `diary-include-string'. When you use `mark-included-diary-files' as
746 part of the mark-diary-entries-hook, you will probably also want to use the
747 function `include-other-diary-files' as part of `list-diary-entries-hook'."
748 :type 'hook
749 :group 'diary)
751 ;;;###autoload
752 (defcustom nongregorian-diary-marking-hook nil
753 "*List of functions called for marking diary file and included files.
754 As the files are processed for diary entries, these functions are used to cull
755 relevant entries. You can use either or both of `mark-hebrew-diary-entries'
756 and `mark-islamic-diary-entries'. The documentation for these functions
757 describes the style of such diary entries."
758 :type 'hook
759 :group 'diary)
761 ;;;###autoload
762 (defcustom diary-list-include-blanks nil
763 "*If nil, do not include days with no diary entry in the list of diary entries.
764 Such days will then not be shown in the fancy diary buffer, even if they
765 are holidays."
766 :type 'boolean
767 :group 'diary)
769 ;;;###autoload
770 (defcustom holidays-in-diary-buffer t
771 "*Non-nil means include holidays in the diary display.
772 The holidays appear in the mode line of the diary buffer, or in the
773 fancy diary buffer next to the date. This slows down the diary functions
774 somewhat; setting it to nil makes the diary display faster."
775 :type 'boolean
776 :group 'holidays)
778 (defvar calendar-mark-ring nil)
780 ;;;###autoload
781 (put 'general-holidays 'risky-local-variable t)
782 ;;;###autoload
783 (defcustom general-holidays
784 '((holiday-fixed 1 1 "New Year's Day")
785 (holiday-float 1 1 3 "Martin Luther King Day")
786 (holiday-fixed 2 2 "Groundhog Day")
787 (holiday-fixed 2 14 "Valentine's Day")
788 (holiday-float 2 1 3 "President's Day")
789 (holiday-fixed 3 17 "St. Patrick's Day")
790 (holiday-fixed 4 1 "April Fools' Day")
791 (holiday-float 5 0 2 "Mother's Day")
792 (holiday-float 5 1 -1 "Memorial Day")
793 (holiday-fixed 6 14 "Flag Day")
794 (holiday-float 6 0 3 "Father's Day")
795 (holiday-fixed 7 4 "Independence Day")
796 (holiday-float 9 1 1 "Labor Day")
797 (holiday-float 10 1 2 "Columbus Day")
798 (holiday-fixed 10 31 "Halloween")
799 (holiday-fixed 11 11 "Veteran's Day")
800 (holiday-float 11 4 4 "Thanksgiving"))
801 "*General holidays. Default value is for the United States.
802 See the documentation for `calendar-holidays' for details."
803 :type 'sexp
804 :group 'holidays)
806 ;;;###autoload
807 (put 'oriental-holidays 'risky-local-variable t)
808 ;;;###autoload
809 (defcustom oriental-holidays
810 '((if (fboundp 'atan)
811 (holiday-chinese-new-year)))
812 "*Oriental holidays.
813 See the documentation for `calendar-holidays' for details."
814 :type 'sexp
815 :group 'holidays)
817 ;;;###autoload
818 (put 'local-holidays 'risky-local-variable t)
819 ;;;###autoload
820 (defcustom local-holidays nil
821 "*Local holidays.
822 See the documentation for `calendar-holidays' for details."
823 :type 'sexp
824 :group 'holidays)
826 ;;;###autoload
827 (put 'other-holidays 'risky-local-variable t)
828 ;;;###autoload
829 (defcustom other-holidays nil
830 "*User defined holidays.
831 See the documentation for `calendar-holidays' for details."
832 :type 'sexp
833 :group 'holidays)
835 ;;;###autoload
836 (put 'hebrew-holidays-1 'risky-local-variable t)
837 ;;;###autoload
838 (defvar hebrew-holidays-1
839 '((holiday-rosh-hashanah-etc)
840 (if all-hebrew-calendar-holidays
841 (holiday-julian
843 (let* ((m displayed-month)
844 (y displayed-year)
845 (year))
846 (increment-calendar-month m y -1)
847 (let ((year (extract-calendar-year
848 (calendar-julian-from-absolute
849 (calendar-absolute-from-gregorian
850 (list m 1 y))))))
851 (if (zerop (% (1+ year) 4))
853 21))) "\"Tal Umatar\" (evening)"))))
855 ;;;###autoload
856 (put 'hebrew-holidays-2 'risky-local-variable t)
857 ;;;###autoload
858 (defvar hebrew-holidays-2
859 '((if all-hebrew-calendar-holidays
860 (holiday-hanukkah)
861 (holiday-hebrew 9 25 "Hanukkah"))
862 (if all-hebrew-calendar-holidays
863 (holiday-hebrew
865 (let ((h-year (extract-calendar-year
866 (calendar-hebrew-from-absolute
867 (calendar-absolute-from-gregorian
868 (list displayed-month 28 displayed-year))))))
869 (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
872 11 10))
873 "Tzom Teveth"))
874 (if all-hebrew-calendar-holidays
875 (holiday-hebrew 11 15 "Tu B'Shevat"))))
877 ;;;###autoload
878 (put 'hebrew-holidays-3 'risky-local-variable t)
879 ;;;###autoload
880 (defvar hebrew-holidays-3
881 '((if all-hebrew-calendar-holidays
882 (holiday-hebrew
884 (let ((m displayed-month)
885 (y displayed-year))
886 (increment-calendar-month m y 1)
887 (let* ((h-year (extract-calendar-year
888 (calendar-hebrew-from-absolute
889 (calendar-absolute-from-gregorian
890 (list m
891 (calendar-last-day-of-month m y)
892 y)))))
893 (s-s
894 (calendar-hebrew-from-absolute
895 (if (=
896 (% (calendar-absolute-from-hebrew
897 (list 7 1 h-year))
900 (calendar-dayname-on-or-before
901 6 (calendar-absolute-from-hebrew
902 (list 11 17 h-year)))
903 (calendar-dayname-on-or-before
904 6 (calendar-absolute-from-hebrew
905 (list 11 16 h-year))))))
906 (day (extract-calendar-day s-s)))
907 day))
908 "Shabbat Shirah"))))
910 ;;;###autoload
911 (put 'hebrew-holidays-4 'risky-local-variable t)
912 ;;;###autoload
913 (defvar hebrew-holidays-4
914 '((holiday-passover-etc)
915 (if (and all-hebrew-calendar-holidays
916 (let* ((m displayed-month)
917 (y displayed-year)
918 (year))
919 (increment-calendar-month m y -1)
920 (let ((year (extract-calendar-year
921 (calendar-julian-from-absolute
922 (calendar-absolute-from-gregorian
923 (list m 1 y))))))
924 (= 21 (% year 28)))))
925 (holiday-julian 3 26 "Kiddush HaHamah"))
926 (if all-hebrew-calendar-holidays
927 (holiday-tisha-b-av-etc))))
929 ;;;###autoload
930 (put 'hebrew-holidays 'risky-local-variable t)
931 ;;;###autoload
932 (defcustom hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
933 hebrew-holidays-3 hebrew-holidays-4)
934 "*Jewish holidays.
935 See the documentation for `calendar-holidays' for details."
936 :type 'sexp
937 :group 'holidays)
939 ;;;###autoload
940 (put 'christian-holidays 'risky-local-variable t)
941 ;;;###autoload
942 (defcustom christian-holidays
943 '((if all-christian-calendar-holidays
944 (holiday-fixed 1 6 "Epiphany"))
945 (holiday-easter-etc)
946 (if all-christian-calendar-holidays
947 (holiday-greek-orthodox-easter))
948 (if all-christian-calendar-holidays
949 (holiday-fixed 8 15 "Assumption"))
950 (if all-christian-calendar-holidays
951 (holiday-advent))
952 (holiday-fixed 12 25 "Christmas")
953 (if all-christian-calendar-holidays
954 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
955 "*Christian holidays.
956 See the documentation for `calendar-holidays' for details."
957 :type 'sexp
958 :group 'holidays)
960 ;;;###autoload
961 (put 'islamic-holidays 'risky-local-variable t)
962 ;;;###autoload
963 (defcustom islamic-holidays
964 '((holiday-islamic
966 (format "Islamic New Year %d"
967 (let ((m displayed-month)
968 (y displayed-year))
969 (increment-calendar-month m y 1)
970 (extract-calendar-year
971 (calendar-islamic-from-absolute
972 (calendar-absolute-from-gregorian
973 (list
974 m (calendar-last-day-of-month m y) y)))))))
975 (if all-islamic-calendar-holidays
976 (holiday-islamic 1 10 "Ashura"))
977 (if all-islamic-calendar-holidays
978 (holiday-islamic 3 12 "Mulad-al-Nabi"))
979 (if all-islamic-calendar-holidays
980 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
981 (if all-islamic-calendar-holidays
982 (holiday-islamic 8 15 "Shab-e-Bara't"))
983 (holiday-islamic 9 1 "Ramadan Begins")
984 (if all-islamic-calendar-holidays
985 (holiday-islamic 9 27 "Shab-e Qadr"))
986 (if all-islamic-calendar-holidays
987 (holiday-islamic 10 1 "Id-al-Fitr"))
988 (if all-islamic-calendar-holidays
989 (holiday-islamic 12 10 "Id-al-Adha")))
990 "*Islamic holidays.
991 See the documentation for `calendar-holidays' for details."
992 :type 'sexp
993 :group 'holidays)
995 ;;;###autoload
996 (put 'solar-holidays 'risky-local-variable t)
997 ;;;###autoload
998 (defcustom solar-holidays
999 '((if (fboundp 'atan)
1000 (solar-equinoxes-solstices))
1001 (if (progn
1002 (require 'cal-dst)
1004 (funcall
1005 'holiday-sexp
1006 calendar-daylight-savings-starts
1007 '(format "Daylight Savings Time Begins %s"
1008 (if (fboundp 'atan)
1009 (solar-time-string
1010 (/ calendar-daylight-savings-starts-time (float 60))
1011 calendar-standard-time-zone-name)
1012 ""))))
1013 (funcall
1014 'holiday-sexp
1015 calendar-daylight-savings-ends
1016 '(format "Daylight Savings Time Ends %s"
1017 (if (fboundp 'atan)
1018 (solar-time-string
1019 (/ calendar-daylight-savings-ends-time (float 60))
1020 calendar-daylight-time-zone-name)
1021 ""))))
1022 "*Sun-related holidays.
1023 See the documentation for `calendar-holidays' for details."
1024 :type 'sexp
1025 :group 'holidays)
1027 ;;;###autoload
1028 (put 'calendar-holidays 'risky-local-variable t)
1029 (defcustom calendar-holidays
1030 (append general-holidays local-holidays other-holidays
1031 christian-holidays hebrew-holidays islamic-holidays
1032 oriental-holidays solar-holidays)
1033 "*List of notable days for the command M-x holidays.
1035 Additional holidays are easy to add to the list, just put them in the list
1036 `other-holidays' in your .emacs file. Similarly, by setting any of
1037 `general-holidays', `local-holidays' `christian-holidays', `hebrew-holidays',
1038 `islamic-holidays', `oriental-holidays', or `solar-holidays' to nil in your
1039 .emacs file, you can eliminate unwanted categories of holidays. The intention
1040 is that (in the US) `local-holidays' be set in site-init.el and
1041 `other-holidays' be set by the user.
1043 Entries on the list are expressions that return (possibly empty) lists of
1044 items of the form ((month day year) string) of a holiday in the in the
1045 three-month period centered around `displayed-month' of `displayed-year'.
1046 Several basic functions are provided for this purpose:
1048 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1049 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1050 MONTH on the Gregorian calendar (0 for Sunday,
1051 etc.); K<0 means count back from the end of the
1052 month. An optional parameter DAY means the Kth
1053 DAYNAME after/before MONTH DAY.
1054 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1055 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1056 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1057 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
1058 in the variable `year'; if it evaluates to
1059 a visible date, that's the holiday; if it
1060 evaluates to nil, there's no holiday. STRING
1061 is an expression in the variable `date'.
1063 For example, to add Bastille Day, celebrated in France on July 14, add
1065 (holiday-fixed 7 14 \"Bastille Day\")
1067 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1068 Islands on the fourth Monday in August, add
1070 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
1072 to the list (the last Monday would be specified with `-1' instead of `4').
1073 To add the last day of Hanukkah to the list, use
1075 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
1077 since the Hebrew months are numbered with 1 starting from Nisan, while to
1078 add the Islamic feast celebrating Mohammed's birthday use
1080 (holiday-islamic 3 12 \"Mohammed's Birthday\")
1082 since the Islamic months are numbered from 1 starting with Muharram. To
1083 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1085 (holiday-julian 4 2 \"Jefferson's Birthday\")
1087 To include a holiday conditionally, use the sexp form or a conditional. For
1088 example, to include American presidential elections, which occur on the first
1089 Tuesday after the first Monday in November of years divisible by 4, add
1091 (holiday-sexp
1092 (if (zerop (% year 4))
1093 (calendar-gregorian-from-absolute
1094 (1+ (calendar-dayname-on-or-before
1095 1 (+ 6 (calendar-absolute-from-gregorian
1096 (list 11 1 year)))))))
1097 \"US Presidential Election\")
1101 (if (zerop (% displayed-year 4))
1102 (holiday-fixed 11
1103 (extract-calendar-day
1104 (calendar-gregorian-from-absolute
1105 (1+ (calendar-dayname-on-or-before
1106 1 (+ 6 (calendar-absolute-from-gregorian
1107 (list 11 1 displayed-year)))))))
1108 \"US Presidential Election\"))
1110 to the list. To include the phases of the moon, add
1112 (lunar-phases)
1114 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1115 you've written to return a (possibly empty) list of the relevant VISIBLE dates
1116 with descriptive strings such as
1118 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
1119 :type 'sexp
1120 :group 'holidays)
1122 (defconst calendar-buffer "*Calendar*"
1123 "Name of the buffer used for the calendar.")
1125 (defconst holiday-buffer "*Holidays*"
1126 "Name of the buffer used for the displaying the holidays.")
1128 (defconst fancy-diary-buffer "*Fancy Diary Entries*"
1129 "Name of the buffer used for the optional fancy display of the diary.")
1131 (defconst other-calendars-buffer "*Other Calendars*"
1132 "Name of the buffer used for the display of date on other calendars.")
1134 (defconst lunar-phases-buffer "*Phases of Moon*"
1135 "Name of the buffer used for the lunar phases.")
1137 (defmacro increment-calendar-month (mon yr n)
1138 "Move the variables MON and YR to the month and year by N months.
1139 Forward if N is positive or backward if N is negative."
1140 `(let ((macro-y (+ (* ,yr 12) ,mon -1 ,n)))
1141 (setq ,mon (1+ (% macro-y 12)))
1142 (setq ,yr (/ macro-y 12))))
1144 (defmacro calendar-for-loop (var from init to final do &rest body)
1145 "Execute a for loop."
1146 `(let ((,var (1- ,init)))
1147 (while (>= ,final (setq ,var (1+ ,var)))
1148 ,@body)))
1150 (defmacro calendar-sum (index initial condition expression)
1151 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
1152 `(let ((,index ,initial)
1153 (sum 0))
1154 (while ,condition
1155 (setq sum (+ sum ,expression))
1156 (setq ,index (1+ ,index)))
1157 sum))
1159 ;; The following are in-line for speed; they can be called thousands of times
1160 ;; when looking up holidays or processing the diary. Here, for example, are
1161 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1162 ;; fancy diary display, for a moderately complex diary file, with functions
1163 ;; used instead of macros. There were a total of 10000 such calls:
1165 ;; 1934 extract-calendar-month
1166 ;; 1852 extract-calendar-year
1167 ;; 1819 extract-calendar-day
1168 ;; 845 calendar-leap-year-p
1169 ;; 837 calendar-day-number
1170 ;; 775 calendar-absolute-from-gregorian
1171 ;; 346 calendar-last-day-of-month
1172 ;; 286 hebrew-calendar-last-day-of-month
1173 ;; 188 hebrew-calendar-leap-year-p
1174 ;; 180 hebrew-calendar-elapsed-days
1175 ;; 163 hebrew-calendar-last-month-of-year
1176 ;; 66 calendar-date-compare
1177 ;; 65 hebrew-calendar-days-in-year
1178 ;; 60 calendar-absolute-from-julian
1179 ;; 50 calendar-absolute-from-hebrew
1180 ;; 43 calendar-date-equal
1181 ;; 38 calendar-gregorian-from-absolute
1182 ;; .
1183 ;; .
1184 ;; .
1186 ;; The use of these seven macros eliminates the overhead of 92% of the function
1187 ;; calls; it's faster this way.
1189 (defsubst extract-calendar-month (date)
1190 "Extract the month part of DATE which has the form (month day year)."
1191 (car date))
1193 (defsubst extract-calendar-day (date)
1194 "Extract the day part of DATE which has the form (month day year)."
1195 (car (cdr date)))
1197 (defsubst extract-calendar-year (date)
1198 "Extract the year part of DATE which has the form (month day year)."
1199 (car (cdr (cdr date))))
1201 (defsubst calendar-leap-year-p (year)
1202 "Returns t if YEAR is a Gregorian leap year."
1203 (and (zerop (% year 4))
1204 (or (not (zerop (% year 100)))
1205 (zerop (% year 400)))))
1207 ;; The foregoing is a bit faster, but not as clear as the following:
1209 ;;(defsubst calendar-leap-year-p (year)
1210 ;; "Returns t if YEAR is a Gregorian leap year."
1211 ;; (or
1212 ;; (and (= (% year 4) 0)
1213 ;; (/= (% year 100) 0))
1214 ;; (= (% year 400) 0)))
1216 (defsubst calendar-last-day-of-month (month year)
1217 "The last day in MONTH during YEAR."
1218 (if (and (= month 2) (calendar-leap-year-p year))
1220 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1222 ;; An explanation of the calculation can be found in PascAlgorithms by
1223 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1225 (defsubst calendar-day-number (date)
1226 "Return the day number within the year of the date DATE.
1227 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1228 while (calendar-day-number '(12 31 1980)) returns 366."
1229 (let* ((month (extract-calendar-month date))
1230 (day (extract-calendar-day date))
1231 (year (extract-calendar-year date))
1232 (day-of-year (+ day (* 31 (1- month)))))
1233 (if (> month 2)
1234 (progn
1235 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1236 (if (calendar-leap-year-p year)
1237 (setq day-of-year (1+ day-of-year)))))
1238 day-of-year))
1240 (defsubst calendar-absolute-from-gregorian (date)
1241 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1242 The Gregorian date Sunday, December 31, 1 BC is imaginary."
1243 (let ((prior-years (1- (extract-calendar-year date))))
1244 (+ (calendar-day-number date);; Days this year
1245 (* 365 prior-years);; + Days in prior years
1246 (/ prior-years 4);; + Julian leap years
1247 (- (/ prior-years 100));; - century years
1248 (/ prior-years 400))));; + Gregorian leap years
1250 (autoload 'calendar-goto-today "cal-move"
1251 "Reposition the calendar window so the current date is visible."
1254 (autoload 'calendar-forward-month "cal-move"
1255 "Move the cursor forward ARG months."
1258 (autoload 'calendar-forward-year "cal-move"
1259 "Move the cursor forward by ARG years."
1262 (autoload 'calendar-backward-month "cal-move"
1263 "Move the cursor backward by ARG months."
1266 (autoload 'calendar-backward-year "cal-move"
1267 "Move the cursor backward ARG years."
1270 (autoload 'scroll-calendar-left "cal-move"
1271 "Scroll the displayed calendar left by ARG months."
1274 (autoload 'scroll-calendar-right "cal-move"
1275 "Scroll the displayed calendar window right by ARG months."
1278 (autoload 'scroll-calendar-left-three-months "cal-move"
1279 "Scroll the displayed calendar window left by 3*ARG months."
1282 (autoload 'scroll-calendar-right-three-months "cal-move"
1283 "Scroll the displayed calendar window right by 3*ARG months."
1286 (autoload 'calendar-cursor-to-nearest-date "cal-move"
1287 "Move the cursor to the closest date."
1290 (autoload 'calendar-forward-day "cal-move"
1291 "Move the cursor forward ARG days."
1294 (autoload 'calendar-backward-day "cal-move"
1295 "Move the cursor back ARG days."
1298 (autoload 'calendar-forward-week "cal-move"
1299 "Move the cursor forward ARG weeks."
1302 (autoload 'calendar-backward-week "cal-move"
1303 "Move the cursor back ARG weeks."
1306 (autoload 'calendar-beginning-of-week "cal-move"
1307 "Move the cursor back ARG calendar-week-start-day's."
1310 (autoload 'calendar-end-of-week "cal-move"
1311 "Move the cursor forward ARG calendar-week-start-day+6's."
1314 (autoload 'calendar-beginning-of-month "cal-move"
1315 "Move the cursor backward ARG month beginnings."
1318 (autoload 'calendar-end-of-month "cal-move"
1319 "Move the cursor forward ARG month ends."
1322 (autoload 'calendar-beginning-of-year "cal-move"
1323 "Move the cursor backward ARG year beginnings."
1326 (autoload 'calendar-end-of-year "cal-move"
1327 "Move the cursor forward ARG year beginnings."
1330 (autoload 'calendar-cursor-to-visible-date "cal-move"
1331 "Move the cursor to DATE that is on the screen."
1334 (autoload 'calendar-goto-date "cal-move"
1335 "Move cursor to DATE."
1338 (autoload 'calendar-one-frame-setup "cal-x"
1339 "Start calendar and display it in a dedicated frame together with the diary.")
1341 (autoload 'calendar-two-frame-setup "cal-x"
1342 "Start calendar and diary in separate, dedicated frames.")
1344 ;;;###autoload
1345 (defvar calendar-setup nil
1346 "The frame set up of the calendar.
1347 The choices are `one-frame' (calendar and diary together in one separate,
1348 dedicated frame), `two-frames' (calendar and diary in separate, dedicated
1349 frames), `calendar-only' (calendar in a separate, dedicated frame); with
1350 any other value the current frame is used.")
1352 ;;;###autoload
1353 (defun calendar (&optional arg)
1354 "Choose between the one frame, two frame, or basic calendar displays.
1355 The original function `calendar' has been renamed `calendar-basic-setup'."
1356 (interactive "P")
1357 (cond ((equal calendar-setup 'one-frame) (calendar-one-frame-setup arg))
1358 ((equal calendar-setup 'two-frames) (calendar-two-frame-setup arg))
1359 ((equal calendar-setup 'calendar-only)
1360 (calendar-only-one-frame-setup arg))
1361 (t (calendar-basic-setup arg))))
1363 (defun calendar-basic-setup (&optional arg)
1364 "Display a three-month calendar in another window.
1365 The three months appear side by side, with the current month in the middle
1366 surrounded by the previous and next months. The cursor is put on today's date.
1368 If called with an optional prefix argument, prompts for month and year.
1370 This function is suitable for execution in a .emacs file; appropriate setting
1371 of the variable `view-diary-entries-initially' will cause the diary entries for
1372 the current date to be displayed in another window. The value of the variable
1373 `number-of-diary-entries' controls the number of days of diary entries
1374 displayed upon initial display of the calendar.
1376 An optional prefix argument ARG causes the calendar displayed to be ARG
1377 months in the future if ARG is positive or in the past if ARG is negative;
1378 in this case the cursor goes on the first day of the month.
1380 Once in the calendar window, future or past months can be moved into view.
1381 Arbitrary months can be displayed, or the calendar can be scrolled forward
1382 or backward.
1384 The cursor can be moved forward or backward by one day, one week, one month,
1385 or one year. All of these commands take prefix arguments which, when negative,
1386 cause movement in the opposite direction. For convenience, the digit keys
1387 and the minus sign are automatically prefixes. The window is replotted as
1388 necessary to display the desired date.
1390 Diary entries can be marked on the calendar or displayed in another window.
1392 Use M-x describe-mode for details of the key bindings in the calendar window.
1394 The Gregorian calendar is assumed.
1396 After loading the calendar, the hooks given by the variable
1397 `calendar-load-hook' are run. This is the place to add key bindings to the
1398 calendar-mode-map.
1400 After preparing the calendar window initially, the hooks given by the variable
1401 `initial-calendar-window-hook' are run.
1403 The hooks given by the variable `today-visible-calendar-hook' are run
1404 every time the calendar window gets scrolled, if the current date is visible
1405 in the window. If it is not visible, the hooks given by the variable
1406 `today-invisible-calendar-hook' are run. Thus, for example, setting
1407 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1408 to be replaced by asterisks to highlight it whenever it is in the window."
1409 (interactive "P")
1410 (set-buffer (get-buffer-create calendar-buffer))
1411 (calendar-mode)
1412 (let* ((pop-up-windows t)
1413 (split-height-threshold 1000)
1414 (date (if arg
1415 (calendar-read-date t)
1416 (calendar-current-date)))
1417 (month (extract-calendar-month date))
1418 (year (extract-calendar-year date)))
1419 (pop-to-buffer calendar-buffer)
1420 (increment-calendar-month month year (- calendar-offset))
1421 (generate-calendar-window month year)
1422 (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
1423 (view-diary-entries
1424 (if (vectorp number-of-diary-entries)
1425 (aref number-of-diary-entries (calendar-day-of-week date))
1426 number-of-diary-entries))))
1427 (let* ((diary-buffer (get-file-buffer diary-file))
1428 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1429 (split-height-threshold (if diary-window 2 1000)))
1430 (if view-calendar-holidays-initially
1431 (list-calendar-holidays)))
1432 (run-hooks 'initial-calendar-window-hook))
1434 (autoload 'view-diary-entries "diary-lib"
1435 "Prepare and display a buffer with diary entries.
1436 Searches your diary file for entries that match ARG days starting with
1437 the date indicated by the cursor position in the displayed three-month
1438 calendar."
1441 (autoload 'calendar-sunrise-sunset "solar"
1442 "Local time of sunrise and sunset for date under cursor."
1445 (autoload 'calendar-phases-of-moon "lunar"
1446 "Create a buffer of the phases of the moon for the current calendar window."
1449 (autoload 'calendar-print-french-date "cal-french"
1450 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1453 (autoload 'calendar-goto-french-date "cal-french"
1454 "Move cursor to French Revolutionary date."
1457 (autoload 'calendar-french-date-string "cal-french"
1458 "String of French Revolutionary date of Gregorian date."
1461 (autoload 'calendar-mayan-date-string "cal-mayan"
1462 "String of Mayan date of Gregorian date."
1465 (autoload 'calendar-print-mayan-date "cal-mayan"
1466 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1469 (autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
1470 "Move cursor to Mayan long count date."
1473 (autoload 'calendar-next-haab-date "cal-mayan"
1474 "Move cursor to next instance of Mayan Haab date."
1477 (autoload 'calendar-previous-haab-date "cal-mayan"
1478 "Move cursor to previous instance of Mayan Haab date."
1481 (autoload 'calendar-next-tzolkin-date "cal-mayan"
1482 "Move cursor to next instance of Mayan Tzolkin date."
1485 (autoload 'calendar-previous-tzolkin-date "cal-mayan"
1486 "Move cursor to previous instance of Mayan Tzolkin date."
1489 (autoload 'calendar-next-calendar-round-date "cal-mayan"
1490 "Move cursor to next instance of Mayan Haab/Tzolkin combination."
1493 (autoload 'calendar-previous-calendar-round-date "cal-mayan"
1494 "Move cursor to previous instance of Mayan Haab/Tzolkin combination."
1497 (autoload 'calendar-goto-chinese-date "cal-china"
1498 "Move cursor to Chinese date."
1501 (autoload 'calendar-print-chinese-date "cal-china"
1502 "Show the Chinese date equivalents of date."
1505 (autoload 'calendar-chinese-date-string "cal-china"
1506 "String of Chinese date of Gregorian date."
1509 (autoload 'calendar-absolute-from-astro "cal-julian"
1510 "Absolute date of astronomical (Julian) day number D."
1513 (autoload 'calendar-astro-from-absolute "cal-julian"
1514 "Astronomical (Julian) day number of absolute date D.")
1516 (autoload 'calendar-astro-date-string "cal-julian"
1517 "String of astronomical (Julian) day number of Gregorian date."
1520 (autoload 'calendar-goto-astro-day-number "cal-julian"
1521 "Move cursor to astronomical (Julian) day number."
1524 (autoload 'calendar-print-astro-day-number "cal-julian"
1525 "Show the astro date equivalents of date."
1528 (autoload 'calendar-julian-from-absolute "cal-julian"
1529 "Compute the Julian (month day year) corresponding to the absolute DATE.
1530 The absolute date is the number of days elapsed since the (imaginary)
1531 Gregorian date Sunday, December 31, 1 BC.")
1533 (autoload 'calendar-goto-julian-date "cal-julian"
1534 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1537 (autoload 'calendar-print-julian-date "cal-julian"
1538 "Show the Julian calendar equivalent of the date under the cursor."
1541 (autoload 'calendar-julian-date-string "cal-julian"
1542 "String of Julian date of Gregorian DATE.
1543 Defaults to today's date if DATE is not given.
1544 Driven by the variable `calendar-date-display-form'.")
1546 (autoload 'calendar-goto-iso-date "cal-iso"
1547 "Move cursor to ISO date."
1550 (autoload 'calendar-print-iso-date "cal-iso"
1551 "Show the ISO date equivalents of date."
1554 (autoload 'calendar-iso-date-string "cal-iso"
1555 "String of ISO date of Gregorian date."
1558 (autoload 'calendar-print-islamic-date "cal-islam"
1559 "Show the Islamic date equivalents of date."
1562 (autoload 'calendar-islamic-date-string "cal-islam"
1563 "String of Islamic date of Gregorian date."
1566 (autoload 'calendar-goto-hebrew-date "cal-hebrew"
1567 "Move cursor to Hebrew date date."
1570 (autoload 'calendar-print-hebrew-date "cal-hebrew"
1571 "Show the Hebrew date equivalents of date."
1574 (autoload 'calendar-hebrew-date-string "cal-hebrew"
1575 "String of Hebrew date of Gregorian date."
1578 (autoload 'calendar-goto-coptic-date "cal-coptic"
1579 "Move cursor to Coptic date date."
1582 (autoload 'calendar-print-coptic-date "cal-coptic"
1583 "Show the Coptic date equivalents of date."
1586 (autoload 'calendar-coptic-date-string "cal-coptic"
1587 "String of Coptic date of Gregorian date."
1590 (autoload 'calendar-goto-ethiopic-date "cal-coptic"
1591 "Move cursor to Ethiopic date date."
1594 (autoload 'calendar-print-ethiopic-date "cal-coptic"
1595 "Show the Ethiopic date equivalents of date."
1598 (autoload 'calendar-ethiopic-date-string "cal-coptic"
1599 "String of Ethiopic date of Gregorian date."
1602 (autoload 'calendar-goto-persian-date "cal-persia"
1603 "Move cursor to Persian date date."
1606 (autoload 'calendar-print-persian-date "cal-persia"
1607 "Show the Persian date equivalents of date."
1610 (autoload 'calendar-persian-date-string "cal-persia"
1611 "String of Persian date of Gregorian date."
1614 (autoload 'show-all-diary-entries "diary-lib"
1615 "Show all of the diary entries in the diary file.
1616 This function gets rid of the selective display of the diary file so that
1617 all entries, not just some, are visible. If there is no diary buffer, one
1618 is created."
1621 (autoload 'mark-diary-entries "diary-lib"
1622 "Mark days in the calendar window that have diary entries.
1623 Each entry in diary file visible in the calendar window is marked."
1626 (autoload 'make-diary-entry "diary-lib"
1627 "Insert a diary entry STRING which may be NONMARKING in FILE."
1630 (autoload 'insert-diary-entry "diary-lib"
1631 "Insert a diary entry for the date indicated by point."
1634 (autoload 'insert-weekly-diary-entry "diary-lib"
1635 "Insert a weekly diary entry for the day of the week indicated by point."
1639 (autoload 'insert-monthly-diary-entry "diary-lib"
1640 "Insert a monthly diary entry for the day of the month indicated by point."
1643 (autoload 'insert-yearly-diary-entry "diary-lib"
1644 "Insert an annual diary entry for the day of the year indicated by point."
1647 (autoload 'insert-anniversary-diary-entry "diary-lib"
1648 "Insert an anniversary diary entry for the date indicated by point."
1651 (autoload 'insert-block-diary-entry "diary-lib"
1652 "Insert a block diary entry for the dates indicated by point and mark."
1655 (autoload 'insert-cyclic-diary-entry "diary-lib"
1656 "Insert a cyclic diary entry starting at the date indicated by point."
1659 (autoload 'insert-hebrew-diary-entry "cal-hebrew"
1660 "Insert a diary entry for the Hebrew date corresponding to the date
1661 indicated by point."
1664 (autoload 'insert-monthly-hebrew-diary-entry "cal-hebrew"
1665 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1666 to the date indicated by point."
1669 (autoload 'insert-yearly-hebrew-diary-entry "cal-hebrew"
1670 "Insert an annual diary entry for the day of the Hebrew year corresponding
1671 to the date indicated by point."
1674 (autoload 'insert-islamic-diary-entry "cal-islam"
1675 "Insert a diary entry for the Islamic date corresponding to the date
1676 indicated by point."
1679 (autoload 'insert-monthly-islamic-diary-entry "cal-islam"
1680 "Insert a monthly diary entry for the day of the Islamic month corresponding
1681 to the date indicated by point."
1684 (autoload 'insert-yearly-islamic-diary-entry "cal-islam"
1685 "Insert an annual diary entry for the day of the Islamic year corresponding
1686 to the date indicated by point."
1689 (autoload 'list-calendar-holidays "holidays"
1690 "Create a buffer containing the holidays for the current calendar window.
1691 The holidays are those in the list `calendar-notable-days'. Returns t if any
1692 holidays are found, nil if not."
1695 (autoload 'cal-tex-cursor-month "cal-tex"
1696 "Make a buffer with LaTeX commands for the month cursor is on.
1697 Optional prefix argument specifies number of months to be produced.
1698 Calendar is condensed onto one page.")
1700 (autoload 'cal-tex-cursor-month-landscape "cal-tex"
1701 "Make a buffer with LaTeX commands for the month cursor is on.
1702 Optional prefix argument specifies number of months to be produced.")
1704 (autoload 'cal-tex-cursor-day "cal-tex"
1705 "Make a buffer with LaTeX commands for the day cursor is on.")
1707 (autoload 'cal-tex-cursor-week "cal-tex"
1708 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1709 It applies to the week that point is in.
1710 Optional prefix argument specifies number of weeks.
1711 Holidays are included if `cal-tex-holidays' is t.")
1713 (autoload 'cal-tex-cursor-week2 "cal-tex"
1714 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1715 It applies to the week that point is in.
1716 Optional prefix argument specifies number of weeks.
1717 Holidays are included if `cal-tex-holidays' is t.")
1719 (autoload 'cal-tex-cursor-week-iso "cal-tex"
1720 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
1721 Optional prefix argument specifies number of weeks.
1722 Diary entries are included if `cal-tex-diary' is t.
1723 Holidays are included if `cal-tex-holidays' is t.")
1725 (autoload 'cal-tex-cursor-week-monday "cal-tex"
1726 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1727 It applies to the week that point is in, and starts on Monday.
1728 Optional prefix argument specifies number of weeks.
1729 Holidays are included if `cal-tex-holidays' is t.")
1731 (autoload 'cal-tex-cursor-filofax-2week "cal-tex"
1732 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
1733 Optional prefix argument specifies number of weeks.
1734 Diary entries are included if cal-tex-diary is t.
1735 Holidays are included if `cal-tex-holidays' is t.")
1737 (autoload 'cal-tex-cursor-filofax-week "cal-tex"
1738 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
1739 Optional prefix argument specifies number of weeks.
1740 Weeks start on Monday.
1741 Diary entries are included if cal-tex-diary is t.
1742 Holidays are included if `cal-tex-holidays' is t.")
1744 (autoload 'cal-tex-cursor-filofax-daily "cal-tex"
1745 "Day-per-page Filofax style calendar for week indicated by cursor.
1746 Optional prefix argument specifies number of weeks. Weeks start on Monday.
1747 Diary entries are included if `cal-tex-diary' is t.
1748 Holidays are included if `cal-tex-holidays' is t.")
1750 (autoload 'cal-tex-cursor-year "cal-tex"
1751 "Make a buffer with LaTeX commands for a year's calendar.
1752 Optional prefix argument specifies number of years.")
1754 (autoload 'cal-tex-cursor-year-landscape "cal-tex"
1755 "Make a buffer with LaTeX commands for a year's calendar (landscape).
1756 Optional prefix argument specifies number of years.")
1758 (autoload 'cal-tex-cursor-filofax-year "cal-tex"
1759 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
1760 Optional prefix argument specifies number of years.")
1762 (autoload 'mark-calendar-holidays "holidays"
1763 "Mark notable days in the calendar window."
1766 (autoload 'calendar-cursor-holidays "holidays"
1767 "Find holidays for the date specified by the cursor in the calendar window."
1770 (defun generate-calendar-window (&optional mon yr)
1771 "Generate the calendar window for the current date.
1772 Or, for optional MON, YR."
1773 (let* ((buffer-read-only nil)
1774 (today (calendar-current-date))
1775 (month (extract-calendar-month today))
1776 (day (extract-calendar-day today))
1777 (year (extract-calendar-year today))
1778 (today-visible
1779 (or (not mon)
1780 (let ((offset (calendar-interval mon yr month year)))
1781 (and (<= offset 1) (>= offset -1)))))
1782 (day-in-week (calendar-day-of-week today)))
1783 (update-calendar-mode-line)
1784 (if mon
1785 (generate-calendar mon yr)
1786 (generate-calendar month year))
1787 (calendar-cursor-to-visible-date
1788 (if today-visible today (list displayed-month 1 displayed-year)))
1789 (set-buffer-modified-p nil)
1790 (or (one-window-p t)
1791 (/= (frame-width) (window-width))
1792 (shrink-window (- (window-height) 9)))
1793 (sit-for 0)
1794 (and mark-holidays-in-calendar
1795 (mark-calendar-holidays)
1796 (sit-for 0))
1797 (unwind-protect
1798 (if mark-diary-entries-in-calendar (mark-diary-entries))
1799 (if today-visible
1800 (run-hooks 'today-visible-calendar-hook)
1801 (run-hooks 'today-invisible-calendar-hook)))))
1803 (defun generate-calendar (month year)
1804 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
1805 (if (< (+ month (* 12 (1- year))) 2)
1806 (error "Months before February, 1 AD are not available."))
1807 (setq displayed-month month)
1808 (setq displayed-year year)
1809 (erase-buffer)
1810 (increment-calendar-month month year -1)
1811 (calendar-for-loop i from 0 to 2 do
1812 (generate-calendar-month month year (+ 5 (* 25 i)))
1813 (increment-calendar-month month year 1)))
1815 (defun generate-calendar-month (month year indent)
1816 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
1817 The calendar is inserted in the buffer starting at the line on which point
1818 is currently located, but indented INDENT spaces. The indentation is done
1819 from the first character on the line and does not disturb the first INDENT
1820 characters on the line."
1821 (let* ((blank-days;; at start of month
1822 (mod
1823 (- (calendar-day-of-week (list month 1 year))
1824 calendar-week-start-day)
1826 (last (calendar-last-day-of-month month year)))
1827 (goto-char (point-min))
1828 (calendar-insert-indented
1829 (calendar-string-spread
1830 (list (format "%s %d" (calendar-month-name month) year)) ? 20)
1831 indent t)
1832 (calendar-insert-indented "" indent);; Go to proper spot
1833 (calendar-for-loop i from 0 to 6 do
1834 (insert (calendar-day-name (mod (+ calendar-week-start-day i) 7)
1835 2 t))
1836 (insert " "))
1837 (calendar-insert-indented "" 0 t);; Force onto following line
1838 (calendar-insert-indented "" indent);; Go to proper spot
1839 ;; Add blank days before the first of the month
1840 (calendar-for-loop i from 1 to blank-days do (insert " "))
1841 ;; Put in the days of the month
1842 (calendar-for-loop i from 1 to last do
1843 (insert (format "%2d " i))
1844 (put-text-property (- (point) 3) (1- (point))
1845 'mouse-face 'highlight)
1846 (and (zerop (mod (+ i blank-days) 7))
1847 (/= i last)
1848 (calendar-insert-indented "" 0 t) ;; Force onto following line
1849 (calendar-insert-indented "" indent)))));; Go to proper spot
1851 (defun calendar-insert-indented (string indent &optional newline)
1852 "Insert STRING at column INDENT.
1853 If the optional parameter NEWLINE is t, leave point at start of next line,
1854 inserting a newline if there was no next line; otherwise, leave point after
1855 the inserted text. Value is always t."
1856 ;; Try to move to that column.
1857 (move-to-column indent)
1858 ;; If line is too short, indent out to that column.
1859 (if (< (current-column) indent)
1860 (indent-to indent))
1861 (insert string)
1862 ;; Advance to next line, if requested.
1863 (if newline
1864 (progn
1865 (end-of-line)
1866 (if (eobp)
1867 (newline)
1868 (forward-line 1))))
1871 (defun redraw-calendar ()
1872 "Redraw the calendar display."
1873 (interactive)
1874 (let ((cursor-date (calendar-cursor-to-nearest-date)))
1875 (generate-calendar-window displayed-month displayed-year)
1876 (calendar-cursor-to-visible-date cursor-date)))
1878 (defcustom calendar-debug-sexp nil
1879 "*Turn debugging on when evaluating a sexp in the diary or holiday list."
1880 :type 'boolean
1881 :group 'calendar)
1883 (defvar calendar-mode-map nil)
1884 (if calendar-mode-map
1886 (setq calendar-mode-map (make-sparse-keymap))
1887 (if window-system (require 'cal-menu))
1888 (calendar-for-loop i from 0 to 9 do
1889 (define-key calendar-mode-map (int-to-string i) 'digit-argument))
1890 (let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph
1891 'mark-defun 'mark-whole-buffer 'mark-page
1892 'downcase-region 'upcase-region 'kill-region
1893 'copy-region-as-kill 'capitalize-region 'write-region)))
1894 (while l
1895 (substitute-key-definition (car l) 'calendar-not-implemented
1896 calendar-mode-map global-map)
1897 (setq l (cdr l))))
1898 (define-key calendar-mode-map "-" 'negative-argument)
1899 (define-key calendar-mode-map "\C-x>" 'scroll-calendar-right)
1900 (define-key calendar-mode-map [prior] 'scroll-calendar-right-three-months)
1901 (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
1902 (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
1903 (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
1904 (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
1905 (define-key calendar-mode-map "\C-b" 'calendar-backward-day)
1906 (define-key calendar-mode-map "\C-p" 'calendar-backward-week)
1907 (define-key calendar-mode-map "\e{" 'calendar-backward-month)
1908 (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
1909 (define-key calendar-mode-map "\C-f" 'calendar-forward-day)
1910 (define-key calendar-mode-map "\C-n" 'calendar-forward-week)
1911 (define-key calendar-mode-map [left] 'calendar-backward-day)
1912 (define-key calendar-mode-map [up] 'calendar-backward-week)
1913 (define-key calendar-mode-map [right] 'calendar-forward-day)
1914 (define-key calendar-mode-map [down] 'calendar-forward-week)
1915 (define-key calendar-mode-map "\e}" 'calendar-forward-month)
1916 (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
1917 (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
1918 (define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
1919 (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month)
1920 (define-key calendar-mode-map "\ee" 'calendar-end-of-month)
1921 (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
1922 (define-key calendar-mode-map "\e>" 'calendar-end-of-year)
1923 (define-key calendar-mode-map "\C-@" 'calendar-set-mark)
1924 ;; Many people are used to typing C-SPC and getting C-@.
1925 (define-key calendar-mode-map [?\C- ] 'calendar-set-mark)
1926 (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
1927 (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
1928 (define-key calendar-mode-map "gd" 'calendar-goto-date)
1929 (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
1930 (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
1931 (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
1932 (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
1933 (define-key calendar-mode-map "gC" 'calendar-goto-chinese-date)
1934 (define-key calendar-mode-map "gk" 'calendar-goto-coptic-date)
1935 (define-key calendar-mode-map "ge" 'calendar-goto-ethiopic-date)
1936 (define-key calendar-mode-map "gp" 'calendar-goto-persian-date)
1937 (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
1938 (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
1939 (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
1940 (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
1941 (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
1942 (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
1943 (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
1944 (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
1945 (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
1946 (define-key calendar-mode-map "Aa" 'appt-add)
1947 (define-key calendar-mode-map "Ad" 'appt-delete)
1948 (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
1949 (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
1950 (define-key calendar-mode-map " " 'scroll-other-window)
1951 (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
1952 (define-key calendar-mode-map "." 'calendar-goto-today)
1953 (define-key calendar-mode-map "o" 'calendar-other-month)
1954 (define-key calendar-mode-map "q" 'exit-calendar)
1955 (define-key calendar-mode-map "a" 'list-calendar-holidays)
1956 (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
1957 (define-key calendar-mode-map "x" 'mark-calendar-holidays)
1958 (define-key calendar-mode-map "u" 'calendar-unmark)
1959 (define-key calendar-mode-map "m" 'mark-diary-entries)
1960 (define-key calendar-mode-map "d" 'view-diary-entries)
1961 (define-key calendar-mode-map "D" 'view-other-diary-entries)
1962 (define-key calendar-mode-map "s" 'show-all-diary-entries)
1963 (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
1964 (define-key calendar-mode-map "pC" 'calendar-print-chinese-date)
1965 (define-key calendar-mode-map "pk" 'calendar-print-coptic-date)
1966 (define-key calendar-mode-map "pe" 'calendar-print-ethiopic-date)
1967 (define-key calendar-mode-map "pp" 'calendar-print-persian-date)
1968 (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
1969 (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
1970 (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
1971 (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
1972 (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
1973 (define-key calendar-mode-map "pf" 'calendar-print-french-date)
1974 (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
1975 (define-key calendar-mode-map "po" 'calendar-print-other-dates)
1976 (define-key calendar-mode-map "id" 'insert-diary-entry)
1977 (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
1978 (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
1979 (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
1980 (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
1981 (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
1982 (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
1983 (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
1984 (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
1985 (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
1986 (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
1987 (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
1988 (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
1989 (define-key calendar-mode-map "?" 'calendar-goto-info-node)
1990 (define-key calendar-mode-map "tm" 'cal-tex-cursor-month)
1991 (define-key calendar-mode-map "tM" 'cal-tex-cursor-month-landscape)
1992 (define-key calendar-mode-map "td" 'cal-tex-cursor-day)
1993 (define-key calendar-mode-map "tw1" 'cal-tex-cursor-week)
1994 (define-key calendar-mode-map "tw2" 'cal-tex-cursor-week2)
1995 (define-key calendar-mode-map "tw3" 'cal-tex-cursor-week-iso)
1996 (define-key calendar-mode-map "tw4" 'cal-tex-cursor-week-monday)
1997 (define-key calendar-mode-map "tfd" 'cal-tex-cursor-filofax-daily)
1998 (define-key calendar-mode-map "tfw" 'cal-tex-cursor-filofax-2week)
1999 (define-key calendar-mode-map "tfW" 'cal-tex-cursor-filofax-week)
2000 (define-key calendar-mode-map "tfy" 'cal-tex-cursor-filofax-year)
2001 (define-key calendar-mode-map "ty" 'cal-tex-cursor-year)
2002 (define-key calendar-mode-map "tY" 'cal-tex-cursor-year-landscape))
2004 (defun describe-calendar-mode ()
2005 "Create a help buffer with a brief description of the calendar-mode."
2006 (interactive)
2007 (with-output-to-temp-buffer "*Help*"
2008 (princ
2009 (format
2010 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
2011 (substitute-command-keys
2012 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
2013 (substitute-command-keys "\\{calendar-mode-map}")))
2014 (save-excursion
2015 (set-buffer standard-output)
2016 (help-mode))
2017 (print-help-return-message)))
2019 ;; Calendar mode is suitable only for specially formatted data.
2020 (put 'calendar-mode 'mode-class 'special)
2022 (defvar calendar-mode-line-format
2023 (list
2024 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-left]")
2025 "Calendar"
2026 (substitute-command-keys "\\<calendar-mode-map>\\[calendar-goto-info-node] info/\\[calendar-other-month] other/\\[calendar-goto-today] today")
2027 '(calendar-date-string (calendar-current-date) t)
2028 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-right]"))
2029 "The mode line of the calendar buffer.")
2031 (defun calendar-goto-info-node ()
2032 "Go to the info node for the calendar."
2033 (interactive)
2034 (require 'info)
2035 (let ((where (save-window-excursion
2036 (Info-find-emacs-command-nodes 'calendar))))
2037 (if (not where)
2038 (error "Couldn't find documentation for the calendar.")
2039 (let (same-window-buffer-names)
2040 (info))
2041 (Info-find-node (car (car where)) (car (cdr (car where)))))))
2043 (defun calendar-mode ()
2044 "A major mode for the calendar window.
2046 For a complete description, type \
2047 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
2049 \\<calendar-mode-map>\\{calendar-mode-map}"
2051 (kill-all-local-variables)
2052 (setq major-mode 'calendar-mode)
2053 (setq mode-name "Calendar")
2054 (use-local-map calendar-mode-map)
2055 (setq buffer-read-only t)
2056 (setq indent-tabs-mode nil)
2057 (update-calendar-mode-line)
2058 (if window-system
2059 (progn
2060 (make-local-hook 'activate-menubar-hook)
2061 (add-hook 'activate-menubar-hook 'cal-menu-update nil t)))
2062 (make-local-variable 'calendar-mark-ring)
2063 (make-local-variable 'displayed-month);; Month in middle of window.
2064 (make-local-variable 'displayed-year));; Year in middle of window.
2066 (defun calendar-string-spread (strings char length)
2067 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
2068 The effect is like mapconcat but the separating pieces are as balanced as
2069 possible. Each item of STRINGS is evaluated before concatenation so it can
2070 actually be an expression that evaluates to a string. If LENGTH is too short,
2071 the STRINGS are just concatenated and the result truncated."
2072 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
2073 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
2074 ;; Addison-Wesley, Reading, MA, 1989
2075 (let* ((strings (mapcar 'eval
2076 (if (< (length strings) 2)
2077 (append (list "") strings (list ""))
2078 strings)))
2079 (n (- length (length (apply 'concat strings))))
2080 (m (1- (length strings)))
2081 (s (car strings))
2082 (strings (cdr strings))
2083 (i 0))
2084 (while strings
2085 (setq s (concat s
2086 (make-string (max 0 (/ (+ n i) m)) char)
2087 (car strings)))
2088 (setq i (1+ i))
2089 (setq strings (cdr strings)))
2090 (substring s 0 length)))
2092 (defun update-calendar-mode-line ()
2093 "Update the calendar mode line with the current date and date style."
2094 (if (bufferp (get-buffer calendar-buffer))
2095 (save-excursion
2096 (set-buffer calendar-buffer)
2097 (setq mode-line-format
2098 (calendar-string-spread
2099 calendar-mode-line-format ? (frame-width))))))
2101 (defun calendar-window-list ()
2102 "List of all calendar-related windows."
2103 (let ((calendar-buffers (calendar-buffer-list))
2104 list)
2105 (walk-windows '(lambda (w)
2106 (if (memq (window-buffer w) calendar-buffers)
2107 (setq list (cons w list))))
2108 nil t)
2109 list))
2111 (defun calendar-buffer-list ()
2112 "List of all calendar-related buffers."
2113 (let* ((diary-buffer (get-file-buffer diary-file))
2114 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
2115 fancy-diary-buffer diary-buffer calendar-buffer
2116 other-calendars-buffer))
2117 (buffer-list nil)
2119 (while buffers
2120 (setq b (car buffers))
2121 (setq b (cond ((stringp b) (get-buffer b))
2122 ((bufferp b) b)
2123 (t nil)))
2124 (if b (setq buffer-list (cons b buffer-list)))
2125 (setq buffers (cdr buffers)))
2126 buffer-list))
2128 (defun exit-calendar ()
2129 "Get out of the calendar window and hide it and related buffers."
2130 (interactive)
2131 (let* ((diary-buffer (get-file-buffer diary-file)))
2132 (if (or (not diary-buffer)
2133 (not (buffer-modified-p diary-buffer))
2134 (yes-or-no-p
2135 "Diary modified; do you really want to exit the calendar? "))
2136 ;; Need to do this multiple times because one time can replace some
2137 ;; calendar-related buffers with other calendar-related buffers
2138 (mapcar (lambda (x)
2139 (mapcar 'calendar-hide-window (calendar-window-list)))
2140 (calendar-window-list)))))
2142 (defun calendar-hide-window (window)
2143 "Hide WINDOW if it is calendar-related."
2144 (let ((buffer (if (window-live-p window) (window-buffer window))))
2145 (if (memq buffer (calendar-buffer-list))
2146 (cond
2147 ((and window-system
2148 (eq 'icon (cdr (assoc 'visibility
2149 (frame-parameters
2150 (window-frame window))))))
2151 nil)
2152 ((and window-system (window-dedicated-p window))
2153 (if calendar-remove-frame-by-deleting
2154 (delete-frame (window-frame window))
2155 (iconify-frame (window-frame window))))
2156 ((not (and (select-window window) (one-window-p window)))
2157 (delete-window window))
2158 (t (set-buffer buffer)
2159 (bury-buffer))))))
2161 (defun calendar-current-date ()
2162 "Returns the current date in a list (month day year)."
2163 (let ((now (decode-time)))
2164 (list (nth 4 now) (nth 3 now) (nth 5 now))))
2166 (defun calendar-cursor-to-date (&optional error)
2167 "Returns a list (month day year) of current cursor position.
2168 If cursor is not on a specific date, signals an error if optional parameter
2169 ERROR is t, otherwise just returns nil."
2170 (let* ((segment (/ (current-column) 25))
2171 (month (% (+ displayed-month segment -1) 12))
2172 (month (if (= 0 month) 12 month))
2173 (year
2174 (cond
2175 ((and (= 12 month) (= segment 0)) (1- displayed-year))
2176 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
2177 (t displayed-year))))
2178 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
2179 (< 2 (count-lines (point-min) (point))))
2180 (save-excursion
2181 (if (not (looking-at " "))
2182 (re-search-backward "[^0-9]"))
2183 (list month
2184 (string-to-int (buffer-substring (1+ (point)) (+ 4 (point))))
2185 year))
2186 (if (looking-at "\\*")
2187 (save-excursion
2188 (re-search-backward "[^*]")
2189 (if (looking-at ".\\*\\*")
2190 (list month calendar-starred-day year)
2191 (if error (error "Not on a date!"))))
2192 (if error (error "Not on a date!"))))))
2194 ;; The following version of calendar-gregorian-from-absolute is preferred for
2195 ;; reasons of clarity, BUT it's much slower than the version that follows it.
2197 ;;(defun calendar-gregorian-from-absolute (date)
2198 ;; "Compute the list (month day year) corresponding to the absolute DATE.
2199 ;;The absolute date is the number of days elapsed since the (imaginary)
2200 ;;Gregorian date Sunday, December 31, 1 BC."
2201 ;; (let* ((approx (/ date 366));; Approximation from below.
2202 ;; (year ;; Search forward from the approximation.
2203 ;; (+ approx
2204 ;; (calendar-sum y approx
2205 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2206 ;; 1)))
2207 ;; (month ;; Search forward from January.
2208 ;; (1+ (calendar-sum m 1
2209 ;; (> date
2210 ;; (calendar-absolute-from-gregorian
2211 ;; (list m (calendar-last-day-of-month m year) year)))
2212 ;; 1)))
2213 ;; (day ;; Calculate the day by subtraction.
2214 ;; (- date
2215 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2216 ;; (list month day year)))
2218 (defun calendar-gregorian-from-absolute (date)
2219 "Compute the list (month day year) corresponding to the absolute DATE.
2220 The absolute date is the number of days elapsed since the (imaginary)
2221 Gregorian date Sunday, December 31, 1 BC."
2222 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2223 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2224 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2225 ;; (April, 1993), pages 383-404 for an explanation.
2226 (let* ((d0 (1- date))
2227 (n400 (/ d0 146097))
2228 (d1 (% d0 146097))
2229 (n100 (/ d1 36524))
2230 (d2 (% d1 36524))
2231 (n4 (/ d2 1461))
2232 (d3 (% d2 1461))
2233 (n1 (/ d3 365))
2234 (day (1+ (% d3 365)))
2235 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2236 (if (or (= n100 4) (= n1 4))
2237 (list 12 31 year)
2238 (let ((year (1+ year))
2239 (month 1))
2240 (while (let ((mdays (calendar-last-day-of-month month year)))
2241 (and (< mdays day)
2242 (setq day (- day mdays))))
2243 (setq month (1+ month)))
2244 (list month day year)))))
2246 (defun calendar-other-month (month year)
2247 "Display a three-month calendar centered around MONTH and YEAR."
2248 (interactive (calendar-read-date 'noday))
2249 (if (and (= month displayed-month)
2250 (= year displayed-year))
2252 (let ((old-date (calendar-cursor-to-date))
2253 (today (calendar-current-date)))
2254 (generate-calendar-window month year)
2255 (calendar-cursor-to-visible-date
2256 (cond
2257 ((calendar-date-is-visible-p old-date) old-date)
2258 ((calendar-date-is-visible-p today) today)
2259 (t (list month 1 year)))))))
2261 (defun calendar-set-mark (arg)
2262 "Mark the date under the cursor, or jump to marked date.
2263 With no prefix argument, push current date onto marked date ring.
2264 With argument, jump to mark, pop it, and put point at end of ring."
2265 (interactive "P")
2266 (let ((date (calendar-cursor-to-date t)))
2267 (if (null arg)
2268 (progn
2269 (setq calendar-mark-ring (cons date calendar-mark-ring))
2270 ;; Since the top of the mark ring is the marked date in the
2271 ;; calendar, the mark ring in the calendar is one longer than
2272 ;; in other buffers to get the same effect.
2273 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2274 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2275 (message "Mark set"))
2276 (if (null calendar-mark-ring)
2277 (error "No mark set in this buffer")
2278 (calendar-goto-date (car calendar-mark-ring))
2279 (setq calendar-mark-ring
2280 (cdr (nconc calendar-mark-ring (list date))))))))
2282 (defun calendar-exchange-point-and-mark ()
2283 "Exchange the current cursor position with the marked date."
2284 (interactive)
2285 (let ((mark (car calendar-mark-ring))
2286 (date (calendar-cursor-to-date t)))
2287 (if (null mark)
2288 (error "No mark set in this buffer")
2289 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2290 (calendar-goto-date mark))))
2292 (defun calendar-count-days-region ()
2293 "Count the number of days (inclusive) between point and the mark."
2294 (interactive)
2295 (let* ((days (- (calendar-absolute-from-gregorian
2296 (calendar-cursor-to-date t))
2297 (calendar-absolute-from-gregorian
2298 (or (car calendar-mark-ring)
2299 (error "No mark set in this buffer")))))
2300 (days (1+ (if (> days 0) days (- days)))))
2301 (message "Region has %d day%s (inclusive)"
2302 days (if (> days 1) "s" ""))))
2304 (defun calendar-not-implemented ()
2305 "Not implemented."
2306 (interactive)
2307 (error "%s not available in the calendar"
2308 (global-key-binding (this-command-keys))))
2310 (defun calendar-read (prompt acceptable &optional initial-contents)
2311 "Return an object read from the minibuffer.
2312 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2313 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2314 is a string to insert in the minibuffer before reading."
2315 (let ((value (read-minibuffer prompt initial-contents)))
2316 (while (not (funcall acceptable value))
2317 (setq value (read-minibuffer prompt initial-contents)))
2318 value))
2320 (defun calendar-read-date (&optional noday)
2321 "Prompt for Gregorian date. Returns a list (month day year).
2322 If optional NODAY is t, does not ask for day, but just returns
2323 \(month nil year); if NODAY is any other non-nil value the value returned is
2324 \(month year) "
2325 (let* ((year (calendar-read
2326 "Year (>0): "
2327 '(lambda (x) (> x 0))
2328 (int-to-string (extract-calendar-year
2329 (calendar-current-date)))))
2330 (month-array calendar-month-name-array)
2331 (completion-ignore-case t)
2332 (month (cdr (assoc-ignore-case
2333 (completing-read
2334 "Month name: "
2335 (mapcar 'list (append month-array nil))
2336 nil t)
2337 (calendar-make-alist month-array 1))))
2338 (last (calendar-last-day-of-month month year)))
2339 (if noday
2340 (if (eq noday t)
2341 (list month nil year)
2342 (list month year))
2343 (list month
2344 (calendar-read (format "Day (1-%d): " last)
2345 '(lambda (x) (and (< 0 x) (<= x last))))
2346 year))))
2348 (defun calendar-interval (mon1 yr1 mon2 yr2)
2349 "The number of months difference between MON1, YR1 and MON2, YR2."
2350 (+ (* 12 (- yr2 yr1))
2351 (- mon2 mon1)))
2353 (defun calendar-day-name (date &optional width absolute)
2354 "Returns a string with the name of the day of the week of DATE.
2355 If WIDTH is non-nil, return just the first WIDTH characters of the name.
2356 If ABSOLUTE is non-nil, then DATE is actually the day-of-the-week
2357 rather than a date."
2358 (let ((string (aref calendar-day-name-array
2359 (if absolute date (calendar-day-of-week date)))))
2360 (cond ((null width) string)
2361 (enable-multibyte-characters (truncate-string-to-width string width))
2362 (t (substring string 0 width)))))
2364 (defvar calendar-day-name-array
2365 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2366 "Array of capitalized strings giving, in order, the day names.")
2368 (defvar calendar-month-name-array
2369 ["January" "February" "March" "April" "May" "June"
2370 "July" "August" "September" "October" "November" "December"]
2371 "Array of capitalized strings giving, in order, the month names.")
2373 (defun calendar-make-alist (sequence &optional start-index filter)
2374 "Make an assoc list corresponding to SEQUENCE.
2375 Start at index 1, unless optional START-INDEX is provided.
2376 If FILTER is provided, apply it to each item in the list."
2377 (let ((index (if start-index (1- start-index) 0)))
2378 (mapcar
2379 '(lambda (x)
2380 (setq index (1+ index))
2381 (cons (if filter (funcall filter x) x)
2382 index))
2383 (append sequence nil))))
2385 (defun calendar-month-name (month &optional width)
2386 "The name of MONTH.
2387 If WIDTH is non-nil, return just the first WIDTH characters of the name."
2388 (let ((string (aref calendar-month-name-array (1- month))))
2389 (if width
2390 (let ((i 0) (result "") (pos 0))
2391 (while (< i width)
2392 (let ((chartext (char-to-string (sref string pos))))
2393 (setq pos (+ pos (length chartext)))
2394 (setq result (concat result chartext)))
2395 (setq i (1+ i)))
2396 result)
2397 string)))
2399 (defun calendar-day-of-week (date)
2400 "Returns the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc."
2401 (% (calendar-absolute-from-gregorian date) 7))
2403 (defun calendar-unmark ()
2404 "Delete all diary/holiday marks/highlighting from the calendar."
2405 (interactive)
2406 (setq mark-holidays-in-calendar nil)
2407 (setq mark-diary-entries-in-calendar nil)
2408 (redraw-calendar))
2410 (defun calendar-date-is-visible-p (date)
2411 "Returns t if DATE is legal and is visible in the calendar window."
2412 (let ((gap (calendar-interval
2413 displayed-month displayed-year
2414 (extract-calendar-month date) (extract-calendar-year date))))
2415 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2417 (defun calendar-date-is-legal-p (date)
2418 "Returns t if DATE is a legal date."
2419 (let ((month (extract-calendar-month date))
2420 (day (extract-calendar-day date))
2421 (year (extract-calendar-year date)))
2422 (and (<= 1 month) (<= month 12)
2423 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2424 (<= 1 year))))
2426 (defun calendar-date-equal (date1 date2)
2427 "Returns t if the DATE1 and DATE2 are the same."
2428 (and
2429 (= (extract-calendar-month date1) (extract-calendar-month date2))
2430 (= (extract-calendar-day date1) (extract-calendar-day date2))
2431 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2433 (defun mark-visible-calendar-date (date &optional mark)
2434 "Mark DATE in the calendar window with MARK.
2435 MARK is either a single-character string or a face.
2436 MARK defaults to diary-entry-marker."
2437 (if (calendar-date-is-legal-p date)
2438 (save-excursion
2439 (set-buffer calendar-buffer)
2440 (calendar-cursor-to-visible-date date)
2441 (let ((mark (or mark diary-entry-marker)))
2442 (if (stringp mark)
2443 (let ((buffer-read-only nil))
2444 (forward-char 1)
2445 (delete-char 1)
2446 (insert mark)
2447 (forward-char -2))
2448 (overlay-put
2449 (make-overlay (1- (point)) (1+ (point))) 'face mark))))))
2451 (defun calendar-star-date ()
2452 "Replace the date under the cursor in the calendar window with asterisks.
2453 This function can be used with the today-visible-calendar-hook run after the
2454 calendar window has been prepared."
2455 (let ((buffer-read-only nil))
2456 (make-variable-buffer-local 'calendar-starred-day)
2457 (forward-char 1)
2458 (setq calendar-starred-day
2459 (string-to-int
2460 (buffer-substring (point) (- (point) 2))))
2461 (delete-char -2)
2462 (insert "**")
2463 (backward-char 1)
2464 (set-buffer-modified-p nil)))
2466 (defun calendar-mark-today ()
2467 "Mark the date under the cursor in the calendar window.
2468 The date is marked with calendar-today-marker. This function can be used with
2469 the today-visible-calendar-hook run after the calendar window has been
2470 prepared."
2471 (mark-visible-calendar-date
2472 (calendar-cursor-to-date)
2473 calendar-today-marker))
2475 (defun calendar-date-compare (date1 date2)
2476 "Returns t if DATE1 is before DATE2, nil otherwise.
2477 The actual dates are in the car of DATE1 and DATE2."
2478 (< (calendar-absolute-from-gregorian (car date1))
2479 (calendar-absolute-from-gregorian (car date2))))
2481 (defun calendar-date-string (date &optional abbreviate nodayname)
2482 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2483 An optional parameter ABBREVIATE, when t, causes the month and day names to be
2484 abbreviated to three characters. An optional parameter NODAYNAME, when t,
2485 omits the name of the day of the week."
2486 (let* ((dayname
2487 (if nodayname
2489 (if abbreviate
2490 (calendar-day-name date 3)
2491 (calendar-day-name date))))
2492 (month (extract-calendar-month date))
2493 (monthname
2494 (if abbreviate
2495 (calendar-month-name month 3)
2496 (calendar-month-name month)))
2497 (day (int-to-string (extract-calendar-day date)))
2498 (month (int-to-string month))
2499 (year (int-to-string (extract-calendar-year date))))
2500 (mapconcat 'eval calendar-date-display-form "")))
2502 (defun calendar-dayname-on-or-before (dayname date)
2503 "Returns the absolute date of the DAYNAME on or before absolute DATE.
2504 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
2506 Note: Applying this function to d+6 gives us the DAYNAME on or after an
2507 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
2508 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
2509 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
2510 (- date (% (- date dayname) 7)))
2512 (defun calendar-nth-named-absday (n dayname month year &optional day)
2513 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2514 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2515 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2516 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2518 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2519 (if (> n 0)
2520 (+ (* 7 (1- n))
2521 (calendar-dayname-on-or-before
2522 dayname
2523 (+ 6 (calendar-absolute-from-gregorian
2524 (list month (or day 1) year)))))
2525 (+ (* 7 (1+ n))
2526 (calendar-dayname-on-or-before
2527 dayname
2528 (calendar-absolute-from-gregorian
2529 (list month
2530 (or day (calendar-last-day-of-month month year))
2531 year))))))
2533 (defun calendar-nth-named-day (n dayname month year &optional day)
2534 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2535 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2536 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2537 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2539 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2540 (calendar-gregorian-from-absolute
2541 (calendar-nth-named-absday n dayname month year day)))
2543 (defun calendar-day-of-year-string (&optional date)
2544 "String of day number of year of Gregorian DATE.
2545 Defaults to today's date if DATE is not given."
2546 (let* ((d (or date (calendar-current-date)))
2547 (year (extract-calendar-year d))
2548 (day (calendar-day-number d))
2549 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
2550 (format "Day %d of %d; %d day%s remaining in the year"
2551 day year days-remaining (if (= days-remaining 1) "" "s"))))
2553 (defun calendar-print-other-dates ()
2554 "Show dates on other calendars for date under the cursor."
2555 (interactive)
2556 (let* ((date (calendar-cursor-to-date t)))
2557 (save-excursion
2558 (set-buffer (get-buffer-create other-calendars-buffer))
2559 (setq buffer-read-only nil)
2560 (calendar-set-mode-line
2561 (concat (calendar-date-string date) " (Gregorian)"))
2562 (erase-buffer)
2563 (insert
2564 (mapconcat 'identity
2565 (list (calendar-day-of-year-string date)
2566 (format "ISO date: %s" (calendar-iso-date-string date))
2567 (format "Julian date: %s"
2568 (calendar-julian-date-string date))
2569 (format
2570 "Astronomical (Julian) day number (at noon UTC): %s.0"
2571 (calendar-astro-date-string date))
2572 (format "Fixed (RD) date: %s"
2573 (calendar-absolute-from-gregorian date))
2574 (format "Hebrew date (before sunset): %s"
2575 (calendar-hebrew-date-string date))
2576 (format "Persian date: %s"
2577 (calendar-persian-date-string date))
2578 (let ((i (calendar-islamic-date-string date)))
2579 (if (not (string-equal i ""))
2580 (format "Islamic date (before sunset): %s" i)))
2581 (format "Chinese date: %s"
2582 (calendar-chinese-date-string date))
2583 (let ((c (calendar-coptic-date-string date)))
2584 (if (not (string-equal c ""))
2585 (format "Coptic date: %s" c)))
2586 (let ((e (calendar-ethiopic-date-string date)))
2587 (if (not (string-equal e ""))
2588 (format "Ethiopic date: %s" e)))
2589 (let ((f (calendar-french-date-string date)))
2590 (if (not (string-equal f ""))
2591 (format "French Revolutionary date: %s" f)))
2592 (format "Mayan date: %s"
2593 (calendar-mayan-date-string date)))
2594 "\n"))
2595 (goto-char (point-min))
2596 (set-buffer-modified-p nil)
2597 (setq buffer-read-only t)
2598 (display-buffer other-calendars-buffer))))
2600 (defun calendar-print-day-of-year ()
2601 "Show day number in year/days remaining in year for date under the cursor."
2602 (interactive)
2603 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
2605 (defun calendar-set-mode-line (str)
2606 "Set mode line to STR, centered, surrounded by dashes."
2607 (setq mode-line-format
2608 (calendar-string-spread (list str) ?- (frame-width))))
2610 (defun calendar-mod (m n)
2611 "Non-negative remainder of M/N with N instead of 0."
2612 (1+ (mod (1- m) n)))
2614 (run-hooks 'calendar-load-hook)
2616 (provide 'calendar)
2618 ;;; Local variables:
2619 ;;; byte-compile-dynamic: t
2620 ;;; End:
2622 ;;; calendar.el ends here