]> code.delx.au - gnu-emacs/blob - lisp/calendar/calendar.el
(solar-longitude): Doc fix.
[gnu-emacs] / lisp / calendar / calendar.el
1 ;;; calendar.el --- Calendar functions. -*-byte-compile-dynamic: t;-*-
2
3 ;;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995 Free Software
4 ;;; Foundation, Inc.
5
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Keywords: calendar
8 ;; Human-Keywords: calendar, Gregorian calendar, diary, holidays
9
10 ;; This file is part of GNU Emacs.
11
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.
16
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.
21
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
24 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25
26 ;;; Commentary:
27
28 ;; This collection of functions implements a calendar window. It generates a
29 ;; calendar for the current month, together with the previous and coming
30 ;; months, or for any other three-month period. The calendar can be scrolled
31 ;; forward and backward in the window to show months in the past or future;
32 ;; the cursor can move forward and backward by days, weeks, or months, making
33 ;; it possible, for instance, to jump to the date a specified number of days,
34 ;; weeks, or months from the date under the cursor. The user can display a
35 ;; list of holidays and other notable days for the period shown; the notable
36 ;; days can be marked on the calendar, if desired. The user can also specify
37 ;; that dates having corresponding diary entries (in a file that the user
38 ;; specifies) be marked; the diary entries for any date can be viewed in a
39 ;; separate window. The diary and the notable days can be viewed
40 ;; independently of the calendar. Dates can be translated from the (usual)
41 ;; Gregorian calendar to the day of the year/days remaining in year, to the
42 ;; ISO commercial calendar, to the Julian (old style) calendar, to the Hebrew
43 ;; calendar, to the Islamic calendar, to the French Revolutionary calendar, to
44 ;; the Mayan calendar, to the Chinese calendar, to the Coptic calendar, to the
45 ;; Ethiopic calendar, and to the astronomical (Julian) day number. When
46 ;; floating point is available, times of sunrise/sunset can be displayed, as
47 ;; can the phases of the moon. Appointment notification for diary entries is
48 ;; available. Calendar printing via LaTeX is available.
49
50 ;; The following files are part of the calendar/diary code:
51
52 ;; appt.el Appointment notification
53 ;; cal-chinese.el Chinese calendar
54 ;; cal-coptic.el Coptic/Ethiopic calendars
55 ;; cal-dst.el Daylight savings time rules
56 ;; cal-hebrew.el Hebrew calendar
57 ;; cal-islamic.el Islamic calendar
58 ;; cal-iso.el ISO calendar
59 ;; cal-julian.el Julian/astronomical calendars
60 ;; cal-mayan.el Mayan calendars
61 ;; cal-menu.el Menu support
62 ;; cal-move.el Movement in the calendar
63 ;; cal-tex.el Calendars in LaTeX
64 ;; cal-x.el X-windows dedicated frame functions
65 ;; diary.el Diary functions
66 ;; holidays.el Holiday functions
67 ;; lunar.el Phases of the moon
68 ;; solar.el Sunrise/sunset, equinoxes/solstices
69
70 ;; Comments, corrections, and improvements should be sent to
71 ;; Edward M. Reingold Department of Computer Science
72 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
73 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
74 ;; Urbana, Illinois 61801
75
76 ;; Technical details of all the calendrical calculations can be found in
77
78 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
79 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
80 ;; pages 899-928. ``Calendrical Calculations, Part II: Three Historical
81 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
82 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
83 ;; pages 383-404.
84
85 ;; Hard copies of these two papers can be obtained by sending email to
86 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
87 ;; the message BODY containing your mailing address (snail).
88
89 ;;; Code:
90
91 (defun calendar-version ()
92 (interactive)
93 (message "Version 6, October 12, 1995"))
94
95 ;;;###autoload
96 (defvar calendar-week-start-day 0
97 "*The day of the week on which a week in the calendar begins.
98 0 means Sunday (default), 1 means Monday, and so on.")
99
100 ;;;###autoload
101 (defvar calendar-offset 0
102 "*The offset of the principal month from the center of the calendar window.
103 0 means the principal month is in the center (default), -1 means on the left,
104 +1 means on the right. Larger (or smaller) values push the principal month off
105 the screen.")
106
107 ;;;###autoload
108 (defvar view-diary-entries-initially nil
109 "*Non-nil means display current date's diary entries on entry.
110 The diary is displayed in another window when the calendar is first displayed,
111 if the current date is visible. The number of days of diary entries displayed
112 is governed by the variable `number-of-diary-entries'.")
113
114 ;;;###autoload
115 (defvar number-of-diary-entries 1
116 "*Specifies how many days of diary entries are to be displayed initially.
117 This variable affects the diary display when the command M-x diary is used,
118 or if the value of the variable `view-diary-entries-initially' is t. For
119 example, if the default value 1 is used, then only the current day's diary
120 entries will be displayed. If the value 2 is used, then both the current
121 day's and the next day's entries will be displayed.
122
123 The value can also be a vector such as [0 2 2 2 2 4 1]; this value
124 says to display no diary entries on Sunday, the display the entries
125 for the current date and the day after on Monday through Thursday,
126 display Friday through Monday's entries on Friday, and display only
127 Saturday's entries on Saturday.
128
129 This variable does not affect the diary display with the `d' command
130 from the calendar; in that case, the prefix argument controls the
131 number of days of diary entries displayed.")
132
133 ;;;###autoload
134 (defvar mark-diary-entries-in-calendar nil
135 "*Non-nil means mark dates with diary entries, in the calendar window.
136 The marking symbol is specified by the variable `diary-entry-marker'.")
137
138 (defvar diary-entry-marker
139 (if (not window-system)
140 "+"
141 (require 'faces)
142 (add-to-list 'facemenu-unlisted-faces 'diary-face)
143 (make-face 'diary-face)
144 (cond ((face-differs-from-default-p 'diary-face))
145 ((x-display-color-p) (set-face-foreground 'diary-face "red"))
146 (t (copy-face 'bold 'diary-face)))
147 'diary-face)
148 "*Used to mark dates that have diary entries.
149 Can be either a single-character string or a face.")
150
151 (defvar calendar-today-marker
152 (if (not window-system)
153 "="
154 (require 'faces)
155 (add-to-list 'facemenu-unlisted-faces 'calendar-today-face)
156 (make-face 'calendar-today-face)
157 (if (not (face-differs-from-default-p 'calendar-today-face))
158 (set-face-underline-p 'calendar-today-face t))
159 'calendar-today-face)
160 "*Used to mark today's date.
161 Can be either a single-character string or a face.")
162
163 (defvar calendar-holiday-marker
164 (if (not window-system)
165 "*"
166 (require 'faces)
167 (add-to-list 'facemenu-unlisted-faces 'holiday-face)
168 (make-face 'holiday-face)
169 (cond ((face-differs-from-default-p 'holiday-face))
170 ((x-display-color-p) (set-face-background 'holiday-face "pink"))
171 (t (set-face-background 'holiday-face "black")
172 (set-face-foreground 'holiday-face "white")))
173 'holiday-face)
174 "*Used to mark notable dates in the calendar.
175 Can be either a single-character string or a face.")
176
177 ;;;###autoload
178 (defvar view-calendar-holidays-initially nil
179 "*Non-nil means display holidays for current three month period on entry.
180 The holidays are displayed in another window when the calendar is first
181 displayed.")
182
183 ;;;###autoload
184 (defvar mark-holidays-in-calendar nil
185 "*Non-nil means mark dates of holidays in the calendar window.
186 The marking symbol is specified by the variable `calendar-holiday-marker'.")
187
188 ;;;###autoload
189 (defvar all-hebrew-calendar-holidays nil
190 "*If nil, show only major holidays from the Hebrew calendar.
191 This means only those Jewish holidays that appear on secular calendars.
192
193 If t, show all the holidays that would appear in a complete Hebrew calendar.")
194
195 ;;;###autoload
196 (defvar all-christian-calendar-holidays nil
197 "*If nil, show only major holidays from the Christian calendar.
198 This means only those Christian holidays that appear on secular calendars.
199
200 If t, show all the holidays that would appear in a complete Christian
201 calendar.")
202
203 ;;;###autoload
204 (defvar all-islamic-calendar-holidays nil
205 "*If nil, show only major holidays from the Islamic calendar.
206 This means only those Islamic holidays that appear on secular calendars.
207
208 If t, show all the holidays that would appear in a complete Islamic
209 calendar.")
210
211 ;;;###autoload
212 (defvar calendar-load-hook nil
213 "*List of functions to be called after the calendar is first loaded.
214 This is the place to add key bindings to `calendar-mode-map'.")
215
216 ;;;###autoload
217 (defvar initial-calendar-window-hook nil
218 "*List of functions to be called when the calendar window is first opened.
219 The functions invoked are called after the calendar window is opened, but
220 once opened is never called again. Leaving the calendar with the `q' command
221 and reentering it will cause these functions to be called again.")
222
223 ;;;###autoload
224 (defvar today-visible-calendar-hook nil
225 "*List of functions called whenever the current date is visible.
226 This can be used, for example, to replace today's date with asterisks; a
227 function `calendar-star-date' is included for this purpose:
228 (setq today-visible-calendar-hook 'calendar-star-date)
229 It can also be used to mark the current date with `calendar-today-marker';
230 a function is also provided for this:
231 (setq today-visible-calendar-hook 'calendar-mark-today)
232
233 The corresponding variable `today-invisible-calendar-hook' is the list of
234 functions called when the calendar function was called when the current
235 date is not visible in the window.
236
237 Other than the use of the provided functions, the changing of any
238 characters in the calendar buffer by the hooks may cause the failure of the
239 functions that move by days and weeks.")
240
241 ;;;###autoload
242 (defvar today-invisible-calendar-hook nil
243 "*List of functions called whenever the current date is not visible.
244
245 The corresponding variable `today-visible-calendar-hook' is the list of
246 functions called when the calendar function was called when the current
247 date is visible in the window.
248
249 Other than the use of the provided functions, the changing of any
250 characters in the calendar buffer by the hooks may cause the failure of the
251 functions that move by days and weeks.")
252
253 ;;;###autoload
254 (defvar diary-file "~/diary"
255 "*Name of the file in which one's personal diary of dates is kept.
256
257 The file's entries are lines in any of the forms
258
259 MONTH/DAY
260 MONTH/DAY/YEAR
261 MONTHNAME DAY
262 MONTHNAME DAY, YEAR
263 DAYNAME
264
265 at the beginning of the line; the remainder of the line is the diary entry
266 string for that date. MONTH and DAY are one or two digit numbers, YEAR is
267 a number and may be written in full or abbreviated to the final two digits.
268 If the date does not contain a year, it is generic and applies to any year.
269 DAYNAME entries apply to any date on which is on that day of the week.
270 MONTHNAME and DAYNAME can be spelled in full, abbreviated to three
271 characters (with or without a period), capitalized or not. Any of DAY,
272 MONTH, or MONTHNAME, YEAR can be `*' which matches any day, month, or year,
273 respectively.
274
275 The European style (in which the day precedes the month) can be used
276 instead, if you execute `european-calendar' when in the calendar, or set
277 `european-calendar-style' to t in your .emacs file. The European forms are
278
279 DAY/MONTH
280 DAY/MONTH/YEAR
281 DAY MONTHNAME
282 DAY MONTHNAME YEAR
283 DAYNAME
284
285 To revert to the default American style from the European style, execute
286 `american-calendar' in the calendar.
287
288 A diary entry can be preceded by the character
289 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
290 nonmarking--that is, it will not be marked on dates in the calendar
291 window but will appear in a diary window.
292
293 Multiline diary entries are made by indenting lines after the first with
294 either a TAB or one or more spaces.
295
296 Lines not in one the above formats are ignored. Here are some sample diary
297 entries (in the default American style):
298
299 12/22/1988 Twentieth wedding anniversary!!
300 &1/1. Happy New Year!
301 10/22 Ruth's birthday.
302 21: Payday
303 Tuesday--weekly meeting with grad students at 10am
304 Supowit, Shen, Bitner, and Kapoor to attend.
305 1/13/89 Friday the thirteenth!!
306 &thu 4pm squash game with Lloyd.
307 mar 16 Dad's birthday
308 April 15, 1989 Income tax due.
309 &* 15 time cards due.
310
311 If the first line of a diary entry consists only of the date or day name with
312 no trailing blanks or punctuation, then that line is not displayed in the
313 diary window; only the continuation lines is shown. For example, the
314 single diary entry
315
316 02/11/1989
317 Bill Blattner visits Princeton today
318 2pm Cognitive Studies Committee meeting
319 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
320 4:00pm Jamie Tappenden
321 7:30pm Dinner at George and Ed's for Alan Ryan
322 7:30-10:00pm dance at Stewart Country Day School
323
324 will appear in the diary window without the date line at the beginning. This
325 facility allows the diary window to look neater, but can cause confusion if
326 used with more than one day's entries displayed.
327
328 Diary entries can be based on Lisp sexps. For example, the diary entry
329
330 %%(diary-block 11 1 1990 11 10 1990) Vacation
331
332 causes the diary entry \"Vacation\" to appear from November 1 through November
333 10, 1990. Other functions available are `diary-float', `diary-anniversary',
334 `diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date',
335 `diary-hebrew-date', `diary-islamic-date', `diary-mayan-date',
336 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
337 `diary-yahrzeit', `diary-sunrise-sunset', `diary-phases-of-moon',
338 `diary-parasha', `diary-omer', `diary-rosh-hodesh', and
339 `diary-sabbath-candles'. See the documentation for the function
340 `list-sexp-diary-entries' for more details.
341
342 Diary entries based on the Hebrew and/or the Islamic calendar are also
343 possible, but because these are somewhat slow, they are ignored
344 unless you set the `nongregorian-diary-listing-hook' and the
345 `nongregorian-diary-marking-hook' appropriately. See the documentation
346 for these functions for details.
347
348 Diary files can contain directives to include the contents of other files; for
349 details, see the documentation for the variable `list-diary-entries-hook'.")
350
351 ;;;###autoload
352 (defvar diary-nonmarking-symbol "&"
353 "*Symbol indicating that a diary entry is not to be marked in the calendar.")
354
355 ;;;###autoload
356 (defvar hebrew-diary-entry-symbol "H"
357 "*Symbol indicating a diary entry according to the Hebrew calendar.")
358
359 ;;;###autoload
360 (defvar islamic-diary-entry-symbol "I"
361 "*Symbol indicating a diary entry according to the Islamic calendar.")
362
363 ;;;###autoload
364 (defvar diary-include-string "#include"
365 "*The string indicating inclusion of another file of diary entries.
366 See the documentation for the function `include-other-diary-files'.")
367
368 ;;;###autoload
369 (defvar sexp-diary-entry-symbol "%%"
370 "*The string used to indicate a sexp diary entry in diary-file.
371 See the documentation for the function `list-sexp-diary-entries'.")
372
373 ;;;###autoload
374 (defvar abbreviated-calendar-year t
375 "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
376 For the Gregorian calendar; similarly for the Hebrew and Islamic calendars.
377 If this variable is nil, years must be written in full.")
378
379 ;;;###autoload
380 (defvar european-calendar-style nil
381 "*Use the European style of dates in the diary and in any displays.
382 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
383 1990. The accepted European date styles are
384
385 DAY/MONTH
386 DAY/MONTH/YEAR
387 DAY MONTHNAME
388 DAY MONTHNAME YEAR
389 DAYNAME
390
391 Names can be capitalized or not, written in full, or abbreviated to three
392 characters with or without a period.")
393
394 ;;;###autoload
395 (defvar american-date-diary-pattern
396 '((month "/" day "[^/0-9]")
397 (month "/" day "/" year "[^0-9]")
398 (monthname " *" day "[^,0-9]")
399 (monthname " *" day ", *" year "[^0-9]")
400 (dayname "\\W"))
401 "*List of pseudo-patterns describing the American patterns of date used.
402 See the documentation of `diary-date-forms' for an explanation.")
403
404 ;;;###autoload
405 (defvar european-date-diary-pattern
406 '((day "/" month "[^/0-9]")
407 (day "/" month "/" year "[^0-9]")
408 (backup day " *" monthname "\\W+\\<[^*0-9]")
409 (day " *" monthname " *" year "[^0-9]")
410 (dayname "\\W"))
411 "*List of pseudo-patterns describing the European patterns of date used.
412 See the documentation of `diary-date-forms' for an explanation.")
413
414 (defvar diary-date-forms
415 (if european-calendar-style
416 european-date-diary-pattern
417 american-date-diary-pattern)
418 "*List of pseudo-patterns describing the forms of date used in the diary.
419 The patterns on the list must be MUTUALLY EXCLUSIVE and must should not match
420 any portion of the diary entry itself, just the date component.
421
422 A pseudo-pattern is a list of regular expressions and the keywords `month',
423 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
424 match the name of the month, capitalized or not, or its three-letter
425 abbreviation, followed by a period or not; it will also match `*'.
426 Similarly, `dayname' will match the name of the day, capitalized or not, or
427 its three-letter abbreviation, followed by a period or not. The keywords
428 `month', `day', and `year' will match those numerical values, preceded by
429 arbitrarily many zeros; they will also match `*'.
430
431 The matching of the diary entries with the date forms is done with the
432 standard syntax table from Fundamental mode, but with the `*' changed so
433 that it is a word constituent.
434
435 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
436 diary entry itself, the first element of the pattern MUST be `backup'. This
437 directive causes the date recognizer to back up to the beginning of the
438 current word of the diary entry, so in no case can the pattern match more than
439 a portion of the first word of the diary entry.")
440
441 ;;;###autoload
442 (defvar european-calendar-display-form
443 '((if dayname (concat dayname ", ")) day " " monthname " " year)
444 "*Pseudo-pattern governing the way a date appears in the European style.
445 See the documentation of calendar-date-display-form for an explanation.")
446
447 ;;;###autoload
448 (defvar american-calendar-display-form
449 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
450 "*Pseudo-pattern governing the way a date appears in the American style.
451 See the documentation of `calendar-date-display-form' for an explanation.")
452
453 (defvar calendar-date-display-form
454 (if european-calendar-style
455 european-calendar-display-form
456 american-calendar-display-form)
457 "*Pseudo-pattern governing the way a date appears.
458
459 Used by the function `calendar-date-string', a pseudo-pattern is a list of
460 expressions that can involve the keywords `month', `day', and `year', all
461 numbers in string form, and `monthname' and `dayname', both alphabetic
462 strings. For example, the ISO standard would use the pseudo- pattern
463
464 '(year \"-\" month \"-\" day)
465
466 while a typical American form would be
467
468 '(month \"/\" day \"/\" (substring year -2))
469
470 and
471
472 '((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
473
474 would give the usual American style in fixed-length fields.
475
476 See the documentation of the function `calendar-date-string'.")
477
478 (defun european-calendar ()
479 "Set the interpretation and display of dates to the European style."
480 (interactive)
481 (setq european-calendar-style t)
482 (setq calendar-date-display-form european-calendar-display-form)
483 (setq diary-date-forms european-date-diary-pattern)
484 (update-calendar-mode-line))
485
486 (defun american-calendar ()
487 "Set the interpretation and display of dates to the American style."
488 (interactive)
489 (setq european-calendar-style nil)
490 (setq calendar-date-display-form american-calendar-display-form)
491 (setq diary-date-forms american-date-diary-pattern)
492 (update-calendar-mode-line))
493
494 ;;;###autoload
495 (defvar print-diary-entries-hook 'lpr-buffer
496 "*List of functions called after a temporary diary buffer is prepared.
497 The buffer shows only the diary entries currently visible in the diary
498 buffer. The default just does the printing. Other uses might include, for
499 example, rearranging the lines into order by day and time, saving the buffer
500 instead of deleting it, or changing the function used to do the printing.")
501
502 ;;;###autoload
503 (defvar list-diary-entries-hook nil
504 "*List of functions called after diary file is culled for relevant entries.
505 It is to be used for diary entries that are not found in the diary file.
506
507 A function `include-other-diary-files' is provided for use as the value of
508 this hook. This function enables you to use shared diary files together
509 with your own. The files included are specified in the diary file by lines
510 of the form
511
512 #include \"filename\"
513
514 This is recursive; that is, #include directives in files thus included are
515 obeyed. You can change the \"#include\" to some other string by changing
516 the variable `diary-include-string'. When you use `include-other-diary-files'
517 as part of the list-diary-entries-hook, you will probably also want to use the
518 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
519
520 For example, you could use
521
522 (setq list-diary-entries-hook
523 '(include-other-diary-files sort-diary-entries))
524 (setq diary-display-hook 'fancy-diary-display)
525
526 in your `.emacs' file to cause the fancy diary buffer to be displayed with
527 diary entries from various included files, each day's entries sorted into
528 lexicographic order.")
529
530 ;;;###autoload
531 (defvar diary-hook nil
532 "*List of functions called after the display of the diary.
533 Can be used for appointment notification.")
534
535 ;;;###autoload
536 (defvar diary-display-hook nil
537 "*List of functions that handle the display of the diary.
538 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
539 diary display.
540
541 Ordinarily, this just displays the diary buffer (with holidays indicated in
542 the mode line), if there are any relevant entries. At the time these
543 functions are called, the variable `diary-entries-list' is a list, in order
544 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
545 STRING), where string is the diary entry for the given date. This can be
546 used, for example, a different buffer for display (perhaps combined with
547 holidays), or produce hard copy output.
548
549 A function `fancy-diary-display' is provided as an alternative
550 choice for this hook; this function prepares a special noneditable diary
551 buffer with the relevant diary entries that has neat day-by-day arrangement
552 with headings. The fancy diary buffer will show the holidays unless the
553 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
554 diary buffer will not show days for which there are no diary entries, even
555 if that day is a holiday; if you want such days to be shown in the fancy
556 diary buffer, set the variable `diary-list-include-blanks' to t.")
557
558 ;;;###autoload
559 (defvar nongregorian-diary-listing-hook nil
560 "*List of functions called for listing diary file and included files.
561 As the files are processed for diary entries, these functions are used to cull
562 relevant entries. You can use either or both of `list-hebrew-diary-entries'
563 and `list-islamic-diary-entries'. The documentation for these functions
564 describes the style of such diary entries.")
565
566 ;;;###autoload
567 (defvar mark-diary-entries-hook nil
568 "*List of functions called after marking diary entries in the calendar.
569
570 A function `mark-included-diary-files' is also provided for use as the
571 mark-diary-entries-hook; it enables you to use shared diary files together
572 with your own. The files included are specified in the diary file by lines
573 of the form
574 #include \"filename\"
575 This is recursive; that is, #include directives in files thus included are
576 obeyed. You can change the \"#include\" to some other string by changing the
577 variable `diary-include-string'. When you use `mark-included-diary-files' as
578 part of the mark-diary-entries-hook, you will probably also want to use the
579 function `include-other-diary-files' as part of `list-diary-entries-hook'.")
580
581 ;;;###autoload
582 (defvar nongregorian-diary-marking-hook nil
583 "*List of functions called for marking diary file and included files.
584 As the files are processed for diary entries, these functions are used to cull
585 relevant entries. You can use either or both of `mark-hebrew-diary-entries'
586 and `mark-islamic-diary-entries'. The documentation for these functions
587 describes the style of such diary entries.")
588
589 ;;;###autoload
590 (defvar diary-list-include-blanks nil
591 "*If nil, do not include days with no diary entry in the list of diary entries.
592 Such days will then not be shown in the the fancy diary buffer, even if they
593 are holidays.")
594
595 ;;;###autoload
596 (defvar holidays-in-diary-buffer t
597 "*Non-nil means include holidays in the diary display.
598 The holidays appear in the mode line of the diary buffer, or in the
599 fancy diary buffer next to the date. This slows down the diary functions
600 somewhat; setting it to nil makes the diary display faster.")
601
602 (defvar calendar-mark-ring nil)
603
604 ;;;###autoload
605 (put 'general-holidays 'risky-local-variable t)
606 ;;;###autoload
607 (defvar general-holidays
608 '((holiday-fixed 1 1 "New Year's Day")
609 (holiday-float 1 1 3 "Martin Luther King Day")
610 (holiday-fixed 2 2 "Ground Hog Day")
611 (holiday-fixed 2 14 "Valentine's Day")
612 (holiday-float 2 1 3 "President's Day")
613 (holiday-fixed 3 17 "St. Patrick's Day")
614 (holiday-fixed 4 1 "April Fool's Day")
615 (holiday-float 5 0 2 "Mother's Day")
616 (holiday-float 5 1 -1 "Memorial Day")
617 (holiday-fixed 6 14 "Flag Day")
618 (holiday-float 6 0 3 "Father's Day")
619 (holiday-fixed 7 4 "Independence Day")
620 (holiday-float 9 1 1 "Labor Day")
621 (holiday-float 10 1 2 "Columbus Day")
622 (holiday-fixed 10 31 "Halloween")
623 (holiday-fixed 11 11 "Veteran's Day")
624 (holiday-float 11 4 4 "Thanksgiving"))
625 "*General holidays. Default value is for the United States.
626 See the documentation for `calendar-holidays' for details.")
627
628 ;;;###autoload
629 (put 'oriental-holidays 'risky-local-variable t)
630 ;;;###autoload
631 (defvar oriental-holidays
632 '((if (fboundp 'atan)
633 (holiday-chinese-new-year)))
634 "*Oriental holidays.
635 See the documentation for `calendar-holidays' for details.")
636
637 ;;;###autoload
638 (put 'local-holidays 'risky-local-variable t)
639 ;;;###autoload
640 (defvar local-holidays nil
641 "*Local holidays.
642 See the documentation for `calendar-holidays' for details.")
643
644 ;;;###autoload
645 (put 'other-holidays 'risky-local-variable t)
646 ;;;###autoload
647 (defvar other-holidays nil
648 "*User defined holidays.
649 See the documentation for `calendar-holidays' for details.")
650
651 ;;;###autoload
652 (put 'hebrew-holidays-1 'risky-local-variable t)
653 ;;;###autoload
654 (defvar hebrew-holidays-1
655 '((holiday-rosh-hashanah-etc)
656 (if all-hebrew-calendar-holidays
657 (holiday-julian
658 11
659 (let* ((m displayed-month)
660 (y displayed-year)
661 (year))
662 (increment-calendar-month m y -1)
663 (let ((year (extract-calendar-year
664 (calendar-julian-from-absolute
665 (calendar-absolute-from-gregorian
666 (list m 1 y))))))
667 (if (zerop (% (1+ year) 4))
668 22
669 21))) "\"Tal Umatar\" (evening)"))))
670
671 ;;;###autoload
672 (put 'hebrew-holidays-2 'risky-local-variable t)
673 ;;;###autoload
674 (defvar hebrew-holidays-2
675 '((if all-hebrew-calendar-holidays
676 (holiday-hanukkah)
677 (holiday-hebrew 9 25 "Hanukkah"))
678 (if all-hebrew-calendar-holidays
679 (holiday-hebrew
680 10
681 (let ((h-year (extract-calendar-year
682 (calendar-hebrew-from-absolute
683 (calendar-absolute-from-gregorian
684 (list displayed-month 28 displayed-year))))))
685 (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year))
686 7)
687 6)
688 11 10))
689 "Tzom Teveth"))
690 (if all-hebrew-calendar-holidays
691 (holiday-hebrew 11 15 "Tu B'Shevat"))))
692
693 ;;;###autoload
694 (put 'hebrew-holidays-3 'risky-local-variable t)
695 ;;;###autoload
696 (defvar hebrew-holidays-3
697 '((if all-hebrew-calendar-holidays
698 (holiday-hebrew
699 11
700 (let ((m displayed-month)
701 (y displayed-year))
702 (increment-calendar-month m y 1)
703 (let* ((h-year (extract-calendar-year
704 (calendar-hebrew-from-absolute
705 (calendar-absolute-from-gregorian
706 (list m
707 (calendar-last-day-of-month m y)
708 y)))))
709 (s-s
710 (calendar-hebrew-from-absolute
711 (if (=
712 (% (calendar-absolute-from-hebrew
713 (list 7 1 h-year))
714 7)
715 6)
716 (calendar-dayname-on-or-before
717 6 (calendar-absolute-from-hebrew
718 (list 11 17 h-year)))
719 (calendar-dayname-on-or-before
720 6 (calendar-absolute-from-hebrew
721 (list 11 16 h-year))))))
722 (day (extract-calendar-day s-s)))
723 day))
724 "Shabbat Shirah"))))
725
726 ;;;###autoload
727 (put 'hebrew-holidays-4 'risky-local-variable t)
728 ;;;###autoload
729 (defvar hebrew-holidays-4
730 '((holiday-passover-etc)
731 (if (and all-hebrew-calendar-holidays
732 (let* ((m displayed-month)
733 (y displayed-year)
734 (year))
735 (increment-calendar-month m y -1)
736 (let ((year (extract-calendar-year
737 (calendar-julian-from-absolute
738 (calendar-absolute-from-gregorian
739 (list m 1 y))))))
740 (= 21 (% year 28)))))
741 (holiday-julian 3 26 "Kiddush HaHamah"))
742 (if all-hebrew-calendar-holidays
743 (holiday-tisha-b-av-etc))))
744
745 ;;;###autoload
746 (put 'hebrew-holidays 'risky-local-variable t)
747 ;;;###autoload
748 (defvar hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2
749 hebrew-holidays-3 hebrew-holidays-4)
750 "*Jewish holidays.
751 See the documentation for `calendar-holidays' for details.")
752
753 ;;;###autoload
754 (put 'christian-holidays 'risky-local-variable t)
755 ;;;###autoload
756 (defvar christian-holidays
757 '((if all-christian-calendar-holidays
758 (holiday-fixed 1 6 "Epiphany"))
759 (holiday-easter-etc)
760 (if all-christian-calendar-holidays
761 (holiday-greek-orthodox-easter))
762 (if all-christian-calendar-holidays
763 (holiday-fixed 8 15 "Assumption"))
764 (if all-christian-calendar-holidays
765 (holiday-advent))
766 (holiday-fixed 12 25 "Christmas")
767 (if all-christian-calendar-holidays
768 (holiday-julian 12 25 "Eastern Orthodox Christmas")))
769 "*Christian holidays.
770 See the documentation for `calendar-holidays' for details.")
771
772 ;;;###autoload
773 (put 'islamic-holidays 'risky-local-variable t)
774 ;;;###autoload
775 (defvar islamic-holidays
776 '((holiday-islamic
777 1 1
778 (format "Islamic New Year %d"
779 (let ((m displayed-month)
780 (y displayed-year))
781 (increment-calendar-month m y 1)
782 (extract-calendar-year
783 (calendar-islamic-from-absolute
784 (calendar-absolute-from-gregorian
785 (list
786 m (calendar-last-day-of-month m y) y)))))))
787 (if all-islamic-calendar-holidays
788 (holiday-islamic 1 10 "Ashura"))
789 (if all-islamic-calendar-holidays
790 (holiday-islamic 3 12 "Mulad-al-Nabi"))
791 (if all-islamic-calendar-holidays
792 (holiday-islamic 7 26 "Shab-e-Mi'raj"))
793 (if all-islamic-calendar-holidays
794 (holiday-islamic 8 15 "Shab-e-Bara't"))
795 (holiday-islamic 9 1 "Ramadan Begins")
796 (if all-islamic-calendar-holidays
797 (holiday-islamic 9 27 "Shab-e Qadr"))
798 (if all-islamic-calendar-holidays
799 (holiday-islamic 10 1 "Id-al-Fitr"))
800 (if all-islamic-calendar-holidays
801 (holiday-islamic 12 10 "Id-al-Adha")))
802 "*Islamic holidays.
803 See the documentation for `calendar-holidays' for details.")
804
805 ;;;###autoload
806 (put 'solar-holidays 'risky-local-variable t)
807 ;;;###autoload
808 (defvar solar-holidays
809 '((if (fboundp 'atan)
810 (solar-equinoxes-solstices))
811 (if (progn
812 (require 'cal-dst)
813 t)
814 (funcall
815 'holiday-sexp
816 calendar-daylight-savings-starts
817 '(format "Daylight Savings Time Begins %s"
818 (if (fboundp 'atan)
819 (solar-time-string
820 (/ calendar-daylight-savings-starts-time (float 60))
821 calendar-standard-time-zone-name)
822 ""))))
823 (funcall
824 'holiday-sexp
825 calendar-daylight-savings-ends
826 '(format "Daylight Savings Time Ends %s"
827 (if (fboundp 'atan)
828 (solar-time-string
829 (/ calendar-daylight-savings-ends-time (float 60))
830 calendar-daylight-time-zone-name)
831 ""))))
832 "*Sun-related holidays.
833 See the documentation for `calendar-holidays' for details.")
834
835 ;;;###autoload
836 (put 'calendar-holidays 'risky-local-variable t)
837 (defvar calendar-holidays
838 (append general-holidays local-holidays other-holidays
839 christian-holidays hebrew-holidays islamic-holidays
840 oriental-holidays solar-holidays)
841 "*List of notable days for the command M-x holidays.
842
843 Additional holidays are easy to add to the list, just put them in the list
844 `other-holidays' in your .emacs file. Similarly, by setting any of
845 `general-holidays', `local-holidays' `christian-holidays', `hebrew-holidays',
846 `islamic-holidays', `oriental-holidays', or `solar-holidays' to nil in your
847 .emacs file, you can eliminate unwanted categories of holidays. The intention
848 is that (in the US) `local-holidays' be set in site-init.el and
849 `other-holidays' be set by the user.
850
851 Entries on the list are expressions that return (possibly empty) lists of
852 items of the form ((month day year) string) of a holiday in the in the
853 three-month period centered around `displayed-month' of `displayed-year'.
854 Several basic functions are provided for this purpose:
855
856 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
857 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
858 MONTH on the Gregorian calendar (0 for Sunday,
859 etc.); K<0 means count back from the end of the
860 month. An optional parameter DAY means the Kth
861 DAYNAME after/before MONTH DAY.
862 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
863 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
864 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
865 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
866 in the variable `year'; if it evaluates to
867 a visible date, that's the holiday; if it
868 evaluates to nil, there's no holiday. STRING
869 is an expression in the variable `date'.
870
871 For example, to add Bastille Day, celebrated in France on July 14, add
872
873 (holiday-fixed 7 14 \"Bastille Day\")
874
875 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
876 Islands on the fourth Monday in August, add
877
878 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
879
880 to the list (the last Monday would be specified with `-1' instead of `4').
881 To add the last day of Hanukkah to the list, use
882
883 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
884
885 since the Hebrew months are numbered with 1 starting from Nisan, while to
886 add the Islamic feast celebrating Mohammed's birthday use
887
888 (holiday-islamic 3 12 \"Mohammed's Birthday\")
889
890 since the Islamic months are numbered from 1 starting with Muharram. To
891 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
892
893 (holiday-julian 4 2 \"Jefferson's Birthday\")
894
895 To include a holiday conditionally, use the sexp form or a conditional. For
896 example, to include American presidential elections, which occur on the first
897 Tuesday after the first Monday in November of years divisible by 4, add
898
899 (holiday-sexp
900 (if (zerop (% year 4))
901 (calendar-gregorian-from-absolute
902 (1+ (calendar-dayname-on-or-before
903 1 (+ 6 (calendar-absolute-from-gregorian
904 (list 11 1 year)))))))
905 \"US Presidential Election\")
906
907 or
908
909 (if (zerop (% displayed-year 4))
910 (holiday-fixed 11
911 (extract-calendar-day
912 (calendar-gregorian-from-absolute
913 (1+ (calendar-dayname-on-or-before
914 1 (+ 6 (calendar-absolute-from-gregorian
915 (list 11 1 displayed-year)))))))
916 \"US Presidential Election\"))
917
918 to the list. To include the phases of the moon, add
919
920 (lunar-phases)
921
922 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
923 you've written to return a (possibly empty) list of the relevant VISIBLE dates
924 with descriptive strings such as
925
926 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... ).")
927
928 (defconst calendar-buffer "*Calendar*"
929 "Name of the buffer used for the calendar.")
930
931 (defconst holiday-buffer "*Holidays*"
932 "Name of the buffer used for the displaying the holidays.")
933
934 (defconst fancy-diary-buffer "*Fancy Diary Entries*"
935 "Name of the buffer used for the optional fancy display of the diary.")
936
937 (defconst lunar-phases-buffer "*Phases of Moon*"
938 "Name of the buffer used for the lunar phases.")
939
940 (defmacro increment-calendar-month (mon yr n)
941 "Move the variables MON and YR to the month and year by N months.
942 Forward if N is positive or backward if N is negative."
943 (` (let (( macro-y (+ (* (, yr) 12) (, mon) -1 (, n) )))
944 (setq (, mon) (1+ (% macro-y 12) ))
945 (setq (, yr) (/ macro-y 12)))))
946
947 (defmacro calendar-for-loop (var from init to final do &rest body)
948 "Execute a for loop."
949 (` (let (( (, var) (1- (, init)) ))
950 (while (>= (, final) (setq (, var) (1+ (, var))))
951 (,@ body)))))
952
953 (defmacro calendar-sum (index initial condition expression)
954 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
955 (` (let (( (, index) (, initial))
956 (sum 0))
957 (while (, condition)
958 (setq sum (+ sum (, expression) ))
959 (setq (, index) (1+ (, index))))
960 sum)))
961
962 ;; The following are in-line for speed; they can be called thousands of times
963 ;; when looking up holidays or processing the diary. Here, for example, are
964 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
965 ;; fancy diary display, for a moderately complex diary file, with functions
966 ;; used instead of macros. There were a total of 10000 such calls:
967 ;;
968 ;; 1934 extract-calendar-month
969 ;; 1852 extract-calendar-year
970 ;; 1819 extract-calendar-day
971 ;; 845 calendar-leap-year-p
972 ;; 837 calendar-day-number
973 ;; 775 calendar-absolute-from-gregorian
974 ;; 346 calendar-last-day-of-month
975 ;; 286 hebrew-calendar-last-day-of-month
976 ;; 188 hebrew-calendar-leap-year-p
977 ;; 180 hebrew-calendar-elapsed-days
978 ;; 163 hebrew-calendar-last-month-of-year
979 ;; 66 calendar-date-compare
980 ;; 65 hebrew-calendar-days-in-year
981 ;; 60 calendar-absolute-from-julian
982 ;; 50 calendar-absolute-from-hebrew
983 ;; 43 calendar-date-equal
984 ;; 38 calendar-gregorian-from-absolute
985 ;; .
986 ;; .
987 ;; .
988 ;;
989 ;; The use of these seven macros eliminates the overhead of 92% of the function
990 ;; calls; it's faster this way.
991
992 (defsubst extract-calendar-month (date)
993 "Extract the month part of DATE which has the form (month day year)."
994 (car date))
995
996 (defsubst extract-calendar-day (date)
997 "Extract the day part of DATE which has the form (month day year)."
998 (car (cdr date)))
999
1000 (defsubst extract-calendar-year (date)
1001 "Extract the year part of DATE which has the form (month day year)."
1002 (car (cdr (cdr date))))
1003
1004 (defsubst calendar-leap-year-p (year)
1005 "Returns t if YEAR is a Gregorian leap year."
1006 (and (zerop (% year 4))
1007 (or (not (zerop (% year 100)))
1008 (zerop (% year 400)))))
1009
1010 ;; The foregoing is a bit faster, but not as clear as the following:
1011 ;;
1012 ;;(defsubst calendar-leap-year-p (year)
1013 ;; "Returns t if YEAR is a Gregorian leap year."
1014 ;; (or
1015 ;; (and (= (% year 4) 0)
1016 ;; (/= (% year 100) 0))
1017 ;; (= (% year 400) 0)))
1018
1019 (defsubst calendar-last-day-of-month (month year)
1020 "The last day in MONTH during YEAR."
1021 (if (and (= month 2) (calendar-leap-year-p year))
1022 29
1023 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1024
1025 ;; An explanation of the calculation can be found in PascAlgorithms by
1026 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1027
1028 (defsubst calendar-day-number (date)
1029 "Return the day number within the year of the date DATE.
1030 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1031 while (calendar-day-number '(12 31 1980)) returns 366."
1032 (let* ((month (extract-calendar-month date))
1033 (day (extract-calendar-day date))
1034 (year (extract-calendar-year date))
1035 (day-of-year (+ day (* 31 (1- month)))))
1036 (if (> month 2)
1037 (progn
1038 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1039 (if (calendar-leap-year-p year)
1040 (setq day-of-year (1+ day-of-year)))))
1041 day-of-year))
1042
1043 (defsubst calendar-absolute-from-gregorian (date)
1044 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1045 The Gregorian date Sunday, December 31, 1 BC is imaginary."
1046 (let ((prior-years (1- (extract-calendar-year date))))
1047 (+ (calendar-day-number date);; Days this year
1048 (* 365 prior-years);; + Days in prior years
1049 (/ prior-years 4);; + Julian leap years
1050 (- (/ prior-years 100));; - century years
1051 (/ prior-years 400))));; + Gregorian leap years
1052
1053 (autoload 'calendar-goto-today "cal-move"
1054 "Reposition the calendar window so the current date is visible."
1055 t)
1056
1057 (autoload 'calendar-forward-month "cal-move"
1058 "Move the cursor forward ARG months."
1059 t)
1060
1061 (autoload 'calendar-forward-year "cal-move"
1062 "Move the cursor forward by ARG years."
1063 t)
1064
1065 (autoload 'calendar-backward-month "cal-move"
1066 "Move the cursor backward by ARG months."
1067 t)
1068
1069 (autoload 'calendar-backward-year "cal-move"
1070 "Move the cursor backward ARG years."
1071 t)
1072
1073 (autoload 'scroll-calendar-left "cal-move"
1074 "Scroll the displayed calendar left by ARG months."
1075 t)
1076
1077 (autoload 'scroll-calendar-right "cal-move"
1078 "Scroll the displayed calendar window right by ARG months."
1079 t)
1080
1081 (autoload 'scroll-calendar-left-three-months "cal-move"
1082 "Scroll the displayed calendar window left by 3*ARG months."
1083 t)
1084
1085 (autoload 'scroll-calendar-right-three-months "cal-move"
1086 "Scroll the displayed calendar window right by 3*ARG months."
1087 t)
1088
1089 (autoload 'calendar-cursor-to-nearest-date "cal-move"
1090 "Move the cursor to the closest date."
1091 t)
1092
1093 (autoload 'calendar-forward-day "cal-move"
1094 "Move the cursor forward ARG days."
1095 t)
1096
1097 (autoload 'calendar-backward-day "cal-move"
1098 "Move the cursor back ARG days."
1099 t)
1100
1101 (autoload 'calendar-forward-week "cal-move"
1102 "Move the cursor forward ARG weeks."
1103 t)
1104
1105 (autoload 'calendar-backward-week "cal-move"
1106 "Move the cursor back ARG weeks."
1107 t)
1108
1109 (autoload 'calendar-beginning-of-week "cal-move"
1110 "Move the cursor back ARG calendar-week-start-day's."
1111 t)
1112
1113 (autoload 'calendar-end-of-week "cal-move"
1114 "Move the cursor forward ARG calendar-week-start-day+6's."
1115 t)
1116
1117 (autoload 'calendar-beginning-of-month "cal-move"
1118 "Move the cursor backward ARG month beginnings."
1119 t)
1120
1121 (autoload 'calendar-end-of-month "cal-move"
1122 "Move the cursor forward ARG month ends."
1123 t)
1124
1125 (autoload 'calendar-beginning-of-year "cal-move"
1126 "Move the cursor backward ARG year beginnings."
1127 t)
1128
1129 (autoload 'calendar-end-of-year "cal-move"
1130 "Move the cursor forward ARG year beginnings."
1131 t)
1132
1133 (autoload 'calendar-cursor-to-visible-date "cal-move"
1134 "Move the cursor to DATE that is on the screen."
1135 t)
1136
1137 (autoload 'calendar-goto-date "cal-move"
1138 "Move cursor to DATE."
1139 t)
1140
1141 (autoload 'calendar-one-frame-setup "cal-x"
1142 "Start calendar and display it in a dedicated frame together with the diary.")
1143
1144 (autoload 'calendar-two-frame-setup "cal-x"
1145 "Start calendar and diary in separate, dedicated frames.")
1146
1147 ;;;###autoload
1148 (defvar calendar-setup nil
1149 "The frame set up of the calendar.
1150 The choices are `one-frame' (calendar and diary together in one separate,
1151 dediciated frame) or `two-frames' (calendar and diary in separate, dedicated
1152 frames); with any other value the current frame is used.")
1153
1154 ;;;###autoload
1155 (defun calendar (&optional arg)
1156 "Choose between the one frame, two frame, or basic calendar displays.
1157 The original function `calendar' has been renamed `calendar-basic-setup'."
1158 (interactive "P")
1159 (cond ((equal calendar-setup 'one-frame) (calendar-one-frame-setup arg))
1160 ((equal calendar-setup 'two-frames) (calendar-two-frame-setup arg))
1161 (t (calendar-basic-setup arg))))
1162
1163 (defun calendar-basic-setup (&optional arg)
1164 "Display a three-month calendar in another window.
1165 The three months appear side by side, with the current month in the middle
1166 surrounded by the previous and next months. The cursor is put on today's date.
1167
1168 If called with an optional prefix argument, prompts for month and year.
1169
1170 This function is suitable for execution in a .emacs file; appropriate setting
1171 of the variable `view-diary-entries-initially' will cause the diary entries for
1172 the current date to be displayed in another window. The value of the variable
1173 `number-of-diary-entries' controls the number of days of diary entries
1174 displayed upon initial display of the calendar.
1175
1176 An optional prefix argument ARG causes the calendar displayed to be ARG
1177 months in the future if ARG is positive or in the past if ARG is negative;
1178 in this case the cursor goes on the first day of the month.
1179
1180 Once in the calendar window, future or past months can be moved into view.
1181 Arbitrary months can be displayed, or the calendar can be scrolled forward
1182 or backward.
1183
1184 The cursor can be moved forward or backward by one day, one week, one month,
1185 or one year. All of these commands take prefix arguments which, when negative,
1186 cause movement in the opposite direction. For convenience, the digit keys
1187 and the minus sign are automatically prefixes. The window is replotted as
1188 necessary to display the desired date.
1189
1190 Diary entries can be marked on the calendar or displayed in another window.
1191
1192 Use M-x describe-mode for details of the key bindings in the calendar window.
1193
1194 The Gregorian calendar is assumed.
1195
1196 After loading the calendar, the hooks given by the variable
1197 `calendar-load-hook' are run. This is the place to add key bindings to the
1198 calendar-mode-map.
1199
1200 After preparing the calendar window initially, the hooks given by the variable
1201 `initial-calendar-window-hook' are run.
1202
1203 The hooks given by the variable `today-visible-calendar-hook' are run
1204 everytime the calendar window gets scrolled, if the current date is visible
1205 in the window. If it is not visible, the hooks given by the variable
1206 `today-invisible-calendar-hook' are run. Thus, for example, setting
1207 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1208 to be replaced by asterisks to highlight it whenever it is in the window."
1209 (interactive "P")
1210 (set-buffer (get-buffer-create calendar-buffer))
1211 (calendar-mode)
1212 (let* ((pop-up-windows t)
1213 (split-height-threshold 1000)
1214 (date (if arg
1215 (calendar-read-date t)
1216 (calendar-current-date)))
1217 (month (extract-calendar-month date))
1218 (year (extract-calendar-year date)))
1219 (pop-to-buffer calendar-buffer)
1220 (increment-calendar-month month year (- calendar-offset))
1221 (generate-calendar-window month year)
1222 (if (and view-diary-entries-initially (calendar-date-is-visible-p date))
1223 (view-diary-entries
1224 (if (vectorp number-of-diary-entries)
1225 (aref number-of-diary-entries (calendar-day-of-week date))
1226 number-of-diary-entries))))
1227 (let* ((diary-buffer (get-file-buffer diary-file))
1228 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1229 (split-height-threshold (if diary-window 2 1000)))
1230 (if view-calendar-holidays-initially
1231 (list-calendar-holidays)))
1232 (run-hooks 'initial-calendar-window-hook))
1233
1234 (autoload 'view-diary-entries "diary-lib"
1235 "Prepare and display a buffer with diary entries.
1236 Searches your diary file for entries that match ARG days starting with
1237 the date indicated by the cursor position in the displayed three-month
1238 calendar."
1239 t)
1240
1241 (autoload 'calendar-sunrise-sunset "solar"
1242 "Local time of sunrise and sunset for date under cursor."
1243 t)
1244
1245 (autoload 'calendar-phases-of-moon "lunar"
1246 "Create a buffer of the phases of the moon for the current calendar window."
1247 t)
1248
1249 (autoload 'calendar-print-french-date "cal-french"
1250 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1251 t)
1252
1253 (autoload 'calendar-goto-french-date "cal-french"
1254 "Move cursor to French Revolutionary date."
1255 t)
1256
1257 (autoload 'calendar-french-date-string "cal-french"
1258 "String of French Revolutionary date of Gregorian date."
1259 t)
1260
1261 (autoload 'calendar-mayan-date-string "cal-mayan"
1262 "String of Mayan date of Gregorian date."
1263 t)
1264
1265 (autoload 'calendar-print-mayan-date "cal-mayan"
1266 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1267 t)
1268
1269 (autoload 'calendar-goto-mayan-long-count-date "cal-mayan"
1270 "Move cursor to Mayan long count date."
1271 t)
1272
1273 (autoload 'calendar-next-haab-date "cal-mayan"
1274 "Move cursor to next instance of Mayan Haab date."
1275 t)
1276
1277 (autoload 'calendar-previous-haab-date "cal-mayan"
1278 "Move cursor to previous instance of Mayan Haab date."
1279 t)
1280
1281 (autoload 'calendar-next-tzolkin-date "cal-mayan"
1282 "Move cursor to next instance of Mayan Tzolkin date."
1283 t)
1284
1285 (autoload 'calendar-previous-tzolkin-date "cal-mayan"
1286 "Move cursor to previous instance of Mayan Tzolkin date."
1287 t)
1288
1289 (autoload 'calendar-next-calendar-round-date "cal-mayan"
1290 "Move cursor to next instance of Mayan Haab/Tzoklin combination."
1291 t)
1292
1293 (autoload 'calendar-previous-calendar-round-date "cal-mayan"
1294 "Move cursor to previous instance of Mayan Haab/Tzoklin combination."
1295 t)
1296
1297 (autoload 'calendar-goto-chinese-date "cal-chinese"
1298 "Move cursor to Chinese date date."
1299 t)
1300
1301 (autoload 'calendar-print-chinese-date "cal-chinese"
1302 "Show the Chinese date equivalents of date."
1303 t)
1304
1305 (autoload 'calendar-chinese-date-string "cal-chinese"
1306 "String of Chinese date of Gregorian date."
1307 t)
1308
1309 (autoload 'calendar-julian-from-absolute "cal-julian"
1310 "Compute the Julian (month day year) corresponding to the absolute DATE.
1311 The absolute date is the number of days elapsed since the (imaginary)
1312 Gregorian date Sunday, December 31, 1 BC.")
1313
1314 (autoload 'calendar-goto-julian-date "cal-julian"
1315 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1316 t)
1317
1318 (autoload 'calendar-julian-date-string "cal-julian"
1319 "String of Julian date of Gregorian DATE.
1320 Defaults to today's date if DATE is not given.
1321 Driven by the variable `calendar-date-display-form'."
1322 t)
1323
1324 (autoload 'calendar-goto-iso-date "cal-iso"
1325 "Move cursor to ISO date."
1326 t)
1327
1328 (autoload 'calendar-print-iso-date "cal-iso"
1329 "Show the ISO date equivalents of date."
1330 t)
1331
1332 (autoload 'calendar-iso-date-string "cal-iso"
1333 "String of ISO date of Gregorian date."
1334 t)
1335
1336 (autoload 'calendar-print-islamic-date "cal-islamic"
1337 "Show the Islamic date equivalents of date."
1338 t)
1339
1340 (autoload 'calendar-islamic-date-string "cal-islamic"
1341 "String of Islamic date of Gregorian date."
1342 t)
1343
1344 (autoload 'calendar-goto-hebrew-date "cal-hebrew"
1345 "Move cursor to Hebrew date date."
1346 t)
1347
1348 (autoload 'calendar-print-hebrew-date "cal-hebrew"
1349 "Show the Hebrew date equivalents of date."
1350 t)
1351
1352 (autoload 'calendar-hebrew-date-string "cal-hebrew"
1353 "String of Hebrew date of Gregorian date."
1354 t)
1355
1356 (autoload 'calendar-goto-coptic-date "cal-coptic"
1357 "Move cursor to Coptic date date."
1358 t)
1359
1360 (autoload 'calendar-print-coptic-date "cal-coptic"
1361 "Show the Coptic date equivalents of date."
1362 t)
1363
1364 (autoload 'calendar-coptic-date-string "cal-coptic"
1365 "String of Coptic date of Gregorian date."
1366 t)
1367
1368 (autoload 'calendar-goto-ethiopic-date "cal-coptic"
1369 "Move cursor to Ethiopic date date."
1370 t)
1371
1372 (autoload 'calendar-print-ethiopic-date "cal-coptic"
1373 "Show the Ethiopic date equivalents of date."
1374 t)
1375
1376 (autoload 'calendar-ethiopic-date-string "cal-coptic"
1377 "String of Ethiopic date of Gregorian date."
1378 t)
1379
1380 (autoload 'show-all-diary-entries "diary-lib"
1381 "Show all of the diary entries in the diary file.
1382 This function gets rid of the selective display of the diary file so that
1383 all entries, not just some, are visible. If there is no diary buffer, one
1384 is created."
1385 t)
1386
1387 (autoload 'mark-diary-entries "diary-lib"
1388 "Mark days in the calendar window that have diary entries.
1389 Each entry in diary file visible in the calendar window is marked."
1390 t)
1391
1392 (autoload 'make-diary-entry "diary-lib"
1393 "Insert a diary entry STRING which may be NONMARKING in FILE."
1394 t)
1395
1396 (autoload 'insert-diary-entry "diary-lib"
1397 "Insert a diary entry for the date indicated by point."
1398 t)
1399
1400 (autoload 'insert-weekly-diary-entry "diary-lib"
1401 "Insert a weekly diary entry for the day of the week indicated by point."
1402 t)
1403
1404
1405 (autoload 'insert-monthly-diary-entry "diary-lib"
1406 "Insert a monthly diary entry for the day of the month indicated by point."
1407 t)
1408
1409 (autoload 'insert-yearly-diary-entry "diary-lib"
1410 "Insert an annual diary entry for the day of the year indicated by point."
1411 t)
1412
1413 (autoload 'insert-anniversary-diary-entry "diary-lib"
1414 "Insert an anniversary diary entry for the date indicated by point."
1415 t)
1416
1417 (autoload 'insert-block-diary-entry "diary-lib"
1418 "Insert a block diary entry for the dates indicated by point and mark."
1419 t)
1420
1421 (autoload 'insert-cyclic-diary-entry "diary-lib"
1422 "Insert a cyclic diary entry starting at the date indicated by point."
1423 t)
1424
1425 (autoload 'insert-hebrew-diary-entry "cal-hebrew"
1426 "Insert a diary entry for the Hebrew date corresponding to the date
1427 indicated by point."
1428 t)
1429
1430 (autoload 'insert-monthly-hebrew-diary-entry "cal-hebrew"
1431 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1432 to the date indicated by point."
1433 t)
1434
1435 (autoload 'insert-yearly-hebrew-diary-entry "cal-hebrew"
1436 "Insert an annual diary entry for the day of the Hebrew year corresponding
1437 to the date indicated by point."
1438 t)
1439
1440 (autoload 'insert-islamic-diary-entry "cal-islamic"
1441 "Insert a diary entry for the Islamic date corresponding to the date
1442 indicated by point."
1443 t)
1444
1445 (autoload 'insert-monthly-islamic-diary-entry "cal-islamic"
1446 "Insert a monthly diary entry for the day of the Islamic month corresponding
1447 to the date indicated by point."
1448 t)
1449
1450 (autoload 'insert-yearly-islamic-diary-entry "cal-islamic"
1451 "Insert an annual diary entry for the day of the Islamic year corresponding
1452 to the date indicated by point."
1453 t)
1454
1455 (autoload 'list-calendar-holidays "holidays"
1456 "Create a buffer containing the holidays for the current calendar window.
1457 The holidays are those in the list `calendar-notable-days'. Returns t if any
1458 holidays are found, nil if not."
1459 t)
1460
1461 (autoload 'cal-tex-cursor-month "cal-tex"
1462 "Make a buffer with LaTeX commands for the month cursor is on.
1463 Optional prefix argument specifies number of months to be produced.
1464 Calendar is condensed onto one page.")
1465
1466 (autoload 'cal-tex-cursor-month-landscape "cal-tex"
1467 "Make a buffer with LaTeX commands for the month cursor is on.
1468 Optional prefix argument specifies number of months to be produced.")
1469
1470 (autoload 'cal-tex-cursor-day "cal-tex"
1471 "Make a buffer with LaTeX commands for the day cursor is on.")
1472
1473 (autoload 'cal-tex-cursor-week "cal-tex"
1474 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1475 It applies to the week that point is in.
1476 Optional prefix argument specifies number of weeks.
1477 Holidays are included if `cal-tex-holidays' is t.")
1478
1479 (autoload 'cal-tex-cursor-week2 "cal-tex"
1480 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1481 It applies to the week that point is in.
1482 Optional prefix argument specifies number of weeks.
1483 Holidays are included if `cal-tex-holidays' is t.")
1484
1485 (autoload 'cal-tex-cursor-week-iso "cal-tex"
1486 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
1487 Optional prefix argument specifies number of weeks.
1488 Diary entries are included if `cal-tex-diary' is t.
1489 Holidays are included if `cal-tex-holidays' is t.")
1490
1491 (autoload 'cal-tex-cursor-week-monday "cal-tex"
1492 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1493 It applies to the week that point is in, and starts on Monday.
1494 Optional prefix argument specifies number of weeks.
1495 Holidays are included if `cal-tex-holidays' is t.")
1496
1497 (autoload 'cal-tex-cursor-filofax-2week "cal-tex"
1498 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
1499 Optional prefix argument specifies number of weeks.
1500 Diary entries are included if cal-tex-diary is t.
1501 Holidays are included if `cal-tex-holidays' is t.")
1502
1503 (autoload 'cal-tex-cursor-filofax-week "cal-tex"
1504 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
1505 Optional prefix argument specifies number of weeks.
1506 Weeks start on Monday.
1507 Diary entries are included if cal-tex-diary is t.
1508 Holidays are included if `cal-tex-holidays' is t.")
1509
1510 (autoload 'cal-tex-cursor-year "cal-tex"
1511 "Make a buffer with LaTeX commands for a year's calendar.
1512 Optional prefix argument specifies numeber of years.")
1513
1514 (autoload 'cal-tex-cursor-year-landscape "cal-tex"
1515 "Make a buffer with LaTeX commands for a year's calendar (landscape).
1516 Optional prefix argument specifies number of years.")
1517
1518 (autoload 'cal-tex-cursor-filofax-year "cal-tex"
1519 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
1520 Optional prefix argument specifies number of years.")
1521
1522 (autoload 'mark-calendar-holidays "holidays"
1523 "Mark notable days in the calendar window."
1524 t)
1525
1526 (autoload 'calendar-cursor-holidays "holidays"
1527 "Find holidays for the date specified by the cursor in the calendar window."
1528 t)
1529
1530 (defun generate-calendar-window (&optional mon yr)
1531 "Generate the calendar window for the current date.
1532 Or, for optional MON, YR."
1533 (let* ((buffer-read-only nil)
1534 (today (calendar-current-date))
1535 (month (extract-calendar-month today))
1536 (day (extract-calendar-day today))
1537 (year (extract-calendar-year today))
1538 (today-visible
1539 (or (not mon)
1540 (let ((offset (calendar-interval mon yr month year)))
1541 (and (<= offset 1) (>= offset -1)))))
1542 (day-in-week (calendar-day-of-week today)))
1543 (update-calendar-mode-line)
1544 (if mon
1545 (generate-calendar mon yr)
1546 (generate-calendar month year))
1547 (calendar-cursor-to-visible-date
1548 (if today-visible today (list displayed-month 1 displayed-year)))
1549 (set-buffer-modified-p nil)
1550 (or (one-window-p t)
1551 (/= (frame-width) (window-width))
1552 (shrink-window (- (window-height) 9)))
1553 (sit-for 0)
1554 (and mark-holidays-in-calendar
1555 (mark-calendar-holidays)
1556 (sit-for 0))
1557 (unwind-protect
1558 (if mark-diary-entries-in-calendar (mark-diary-entries))
1559 (if today-visible
1560 (run-hooks 'today-visible-calendar-hook)
1561 (run-hooks 'today-invisible-calendar-hook)))))
1562
1563 (defun generate-calendar (month year)
1564 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
1565 (if (< (+ month (* 12 (1- year))) 2)
1566 (error "Months before February, 1 AD are not available."))
1567 (setq displayed-month month)
1568 (setq displayed-year year)
1569 (erase-buffer)
1570 (increment-calendar-month month year -1)
1571 (calendar-for-loop i from 0 to 2 do
1572 (generate-calendar-month month year (+ 5 (* 25 i)))
1573 (increment-calendar-month month year 1)))
1574
1575 (defun generate-calendar-month (month year indent)
1576 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
1577 The calendar is inserted in the buffer starting at the line on which point
1578 is currently located, but indented INDENT spaces. The indentation is done
1579 from the first character on the line and does not disturb the first INDENT
1580 characters on the line."
1581 (let* ((blank-days;; at start of month
1582 (mod
1583 (- (calendar-day-of-week (list month 1 year))
1584 calendar-week-start-day)
1585 7))
1586 (last (calendar-last-day-of-month month year)))
1587 (goto-char (point-min))
1588 (calendar-insert-indented
1589 (calendar-string-spread
1590 (list (format "%s %d" (calendar-month-name month) year)) ? 20)
1591 indent t)
1592 (calendar-insert-indented "" indent);; Go to proper spot
1593 (calendar-for-loop i from 0 to 6 do
1594 (insert (substring (aref calendar-day-name-array
1595 (mod (+ calendar-week-start-day i) 7))
1596 0 2))
1597 (insert " "))
1598 (calendar-insert-indented "" 0 t);; Force onto following line
1599 (calendar-insert-indented "" indent);; Go to proper spot
1600 ;; Add blank days before the first of the month
1601 (calendar-for-loop i from 1 to blank-days do (insert " "))
1602 ;; Put in the days of the month
1603 (calendar-for-loop i from 1 to last do
1604 (insert (format "%2d " i))
1605 (put-text-property (- (point) 3) (1- (point))
1606 'mouse-face 'highlight)
1607 (and (zerop (mod (+ i blank-days) 7))
1608 (/= i last)
1609 (calendar-insert-indented "" 0 t) ;; Force onto following line
1610 (calendar-insert-indented "" indent)))));; Go to proper spot
1611
1612 (defun calendar-insert-indented (string indent &optional newline)
1613 "Insert STRING at column INDENT.
1614 If the optional parameter NEWLINE is t, leave point at start of next line,
1615 inserting a newline if there was no next line; otherwise, leave point after
1616 the inserted text. Value is always t."
1617 ;; Try to move to that column.
1618 (move-to-column indent)
1619 ;; If line is too short, indent out to that column.
1620 (if (< (current-column) indent)
1621 (indent-to indent))
1622 (insert string)
1623 ;; Advance to next line, if requested.
1624 (if newline
1625 (progn
1626 (end-of-line)
1627 (if (eobp)
1628 (newline)
1629 (forward-line 1))))
1630 t)
1631
1632 (defun redraw-calendar ()
1633 "Redraw the calendar display."
1634 (interactive)
1635 (let ((cursor-date (calendar-cursor-to-date)))
1636 (generate-calendar-window displayed-month displayed-year)
1637 (calendar-cursor-to-visible-date cursor-date)))
1638
1639 (defvar calendar-debug-sexp nil
1640 "*Turn debugging on when evaluating a sexp in the diary or holiday list.")
1641
1642 (defvar calendar-mode-map nil)
1643 (if calendar-mode-map
1644 nil
1645 (setq calendar-mode-map (make-sparse-keymap))
1646 (if window-system (require 'cal-menu))
1647 (calendar-for-loop i from 0 to 9 do
1648 (define-key calendar-mode-map (int-to-string i) 'digit-argument))
1649 (let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph
1650 'mark-defun 'mark-whole-buffer 'mark-page
1651 'downcase-region 'upcase-region 'kill-region
1652 'copy-region-as-kill 'capitalize-region 'write-region)))
1653 (while l
1654 (substitute-key-definition (car l) 'calendar-not-implemented
1655 calendar-mode-map global-map)
1656 (setq l (cdr l))))
1657 (define-key calendar-mode-map "-" 'negative-argument)
1658 (define-key calendar-mode-map "\C-x>" 'scroll-calendar-right)
1659 (define-key calendar-mode-map [prior] 'scroll-calendar-right-three-months)
1660 (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months)
1661 (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left)
1662 (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months)
1663 (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months)
1664 (define-key calendar-mode-map "\C-b" 'calendar-backward-day)
1665 (define-key calendar-mode-map "\C-p" 'calendar-backward-week)
1666 (define-key calendar-mode-map "\e{" 'calendar-backward-month)
1667 (define-key calendar-mode-map "\C-x[" 'calendar-backward-year)
1668 (define-key calendar-mode-map "\C-f" 'calendar-forward-day)
1669 (define-key calendar-mode-map "\C-n" 'calendar-forward-week)
1670 (define-key calendar-mode-map [left] 'calendar-backward-day)
1671 (define-key calendar-mode-map [up] 'calendar-backward-week)
1672 (define-key calendar-mode-map [right] 'calendar-forward-day)
1673 (define-key calendar-mode-map [down] 'calendar-forward-week)
1674 (define-key calendar-mode-map "\e}" 'calendar-forward-month)
1675 (define-key calendar-mode-map "\C-x]" 'calendar-forward-year)
1676 (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week)
1677 (define-key calendar-mode-map "\C-e" 'calendar-end-of-week)
1678 (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month)
1679 (define-key calendar-mode-map "\ee" 'calendar-end-of-month)
1680 (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year)
1681 (define-key calendar-mode-map "\e>" 'calendar-end-of-year)
1682 (define-key calendar-mode-map "\C-@" 'calendar-set-mark)
1683 ;; Many people are used to typing C-SPC and getting C-@.
1684 (define-key calendar-mode-map [?\C-\ ] 'calendar-set-mark)
1685 (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark)
1686 (define-key calendar-mode-map "\e=" 'calendar-count-days-region)
1687 (define-key calendar-mode-map "gd" 'calendar-goto-date)
1688 (define-key calendar-mode-map "gj" 'calendar-goto-julian-date)
1689 (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number)
1690 (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date)
1691 (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date)
1692 (define-key calendar-mode-map "gC" 'calendar-goto-chinese-date)
1693 (define-key calendar-mode-map "gk" 'calendar-goto-coptic-date)
1694 (define-key calendar-mode-map "ge" 'calendar-goto-ethiopic-date)
1695 (define-key calendar-mode-map "gc" 'calendar-goto-iso-date)
1696 (define-key calendar-mode-map "gf" 'calendar-goto-french-date)
1697 (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date)
1698 (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date)
1699 (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date)
1700 (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date)
1701 (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date)
1702 (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date)
1703 (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date)
1704 (define-key calendar-mode-map "S" 'calendar-sunrise-sunset)
1705 (define-key calendar-mode-map "M" 'calendar-phases-of-moon)
1706 (define-key calendar-mode-map " " 'scroll-other-window)
1707 (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar)
1708 (define-key calendar-mode-map "." 'calendar-goto-today)
1709 (define-key calendar-mode-map "o" 'calendar-other-month)
1710 (define-key calendar-mode-map "q" 'exit-calendar)
1711 (define-key calendar-mode-map "a" 'list-calendar-holidays)
1712 (define-key calendar-mode-map "h" 'calendar-cursor-holidays)
1713 (define-key calendar-mode-map "x" 'mark-calendar-holidays)
1714 (define-key calendar-mode-map "u" 'calendar-unmark)
1715 (define-key calendar-mode-map "m" 'mark-diary-entries)
1716 (define-key calendar-mode-map "d" 'view-diary-entries)
1717 (define-key calendar-mode-map "D" 'view-other-diary-entries)
1718 (define-key calendar-mode-map "s" 'show-all-diary-entries)
1719 (define-key calendar-mode-map "pd" 'calendar-print-day-of-year)
1720 (define-key calendar-mode-map "pC" 'calendar-print-chinese-date)
1721 (define-key calendar-mode-map "pk" 'calendar-print-coptic-date)
1722 (define-key calendar-mode-map "pe" 'calendar-print-ethiopic-date)
1723 (define-key calendar-mode-map "pc" 'calendar-print-iso-date)
1724 (define-key calendar-mode-map "pj" 'calendar-print-julian-date)
1725 (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number)
1726 (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date)
1727 (define-key calendar-mode-map "pi" 'calendar-print-islamic-date)
1728 (define-key calendar-mode-map "pf" 'calendar-print-french-date)
1729 (define-key calendar-mode-map "pm" 'calendar-print-mayan-date)
1730 (define-key calendar-mode-map "id" 'insert-diary-entry)
1731 (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry)
1732 (define-key calendar-mode-map "im" 'insert-monthly-diary-entry)
1733 (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry)
1734 (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry)
1735 (define-key calendar-mode-map "ib" 'insert-block-diary-entry)
1736 (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry)
1737 (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry)
1738 (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry)
1739 (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry)
1740 (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry)
1741 (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry)
1742 (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry)
1743 (define-key calendar-mode-map "?" 'calendar-goto-info-node)
1744 (define-key calendar-mode-map "tm" 'cal-tex-cursor-month)
1745 (define-key calendar-mode-map "tM" 'cal-tex-cursor-month-landscape)
1746 (define-key calendar-mode-map "td" 'cal-tex-cursor-day)
1747 (define-key calendar-mode-map "tw1" 'cal-tex-cursor-week)
1748 (define-key calendar-mode-map "tw2" 'cal-tex-cursor-week2)
1749 (define-key calendar-mode-map "tw3" 'cal-tex-cursor-week-iso)
1750 (define-key calendar-mode-map "tw4" 'cal-tex-cursor-week-monday)
1751 (define-key calendar-mode-map "tfw" 'cal-tex-cursor-filofax-2week)
1752 (define-key calendar-mode-map "tfW" 'cal-tex-cursor-filofax-week)
1753 (define-key calendar-mode-map "tfy" 'cal-tex-cursor-filofax-year)
1754 (define-key calendar-mode-map "ty" 'cal-tex-cursor-year)
1755 (define-key calendar-mode-map "tY" 'cal-tex-cursor-year-landscape))
1756
1757 (defun describe-calendar-mode ()
1758 "Create a help buffer with a brief description of the calendar-mode."
1759 (interactive)
1760 (with-output-to-temp-buffer "*Help*"
1761 (princ
1762 (format
1763 "Calendar Mode:\nFor a complete description, type %s\n%s\n"
1764 (substitute-command-keys
1765 "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
1766 (substitute-command-keys "\\{calendar-mode-map}")))
1767 (save-excursion
1768 (set-buffer standard-output)
1769 (help-mode))
1770 (print-help-return-message)))
1771
1772 ;; Calendar mode is suitable only for specially formatted data.
1773 (put 'calendar-mode 'mode-class 'special)
1774
1775 (defvar calendar-mode-line-format
1776 (list
1777 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-left]")
1778 "Calendar"
1779 (substitute-command-keys "\\<calendar-mode-map>\\[calendar-goto-info-node] info/\\[calendar-other-month] other/\\[calendar-goto-today] today")
1780 '(calendar-date-string (calendar-current-date) t)
1781 (substitute-command-keys "\\<calendar-mode-map>\\[scroll-calendar-right]"))
1782 "The mode line of the calendar buffer.")
1783
1784 (defun calendar-goto-info-node ()
1785 "Go to the info node for the calendar."
1786 (interactive)
1787 (require 'info)
1788 (let ((where (save-window-excursion
1789 (Info-find-emacs-command-nodes 'calendar))))
1790 (if (not where)
1791 (error "Couldn't find documentation for the calendar.")
1792 (let (same-window-buffer-names)
1793 (info))
1794 (Info-find-node (car (car where)) (car (cdr (car where)))))))
1795
1796 (defun calendar-mode ()
1797 "A major mode for the calendar window.
1798
1799 For a complete description, type \
1800 \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
1801
1802 \\<calendar-mode-map>\\{calendar-mode-map}"
1803
1804 (kill-all-local-variables)
1805 (setq major-mode 'calendar-mode)
1806 (setq mode-name "Calendar")
1807 (use-local-map calendar-mode-map)
1808 (setq buffer-read-only t)
1809 (setq indent-tabs-mode nil)
1810 (update-calendar-mode-line)
1811 (make-local-variable 'calendar-mark-ring)
1812 (make-local-variable 'displayed-month);; Month in middle of window.
1813 (make-local-variable 'displayed-year));; Year in middle of window.
1814
1815 (defun calendar-string-spread (strings char length)
1816 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
1817 The effect is like mapconcat but the separating pieces are as balanced as
1818 possible. Each item of STRINGS is evaluated before concatenation so it can
1819 actually be an expression that evaluates to a string. If LENGTH is too short,
1820 the STRINGS are just concatenated and the result truncated."
1821 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
1822 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
1823 ;; Addison-Wesley, Reading, MA, 1989
1824 (let* ((strings (mapcar 'eval
1825 (if (< (length strings) 2)
1826 (append (list "") strings (list ""))
1827 strings)))
1828 (n (- length (length (apply 'concat strings))))
1829 (m (1- (length strings)))
1830 (s (car strings))
1831 (strings (cdr strings))
1832 (i 0))
1833 (while strings
1834 (setq s (concat s
1835 (make-string (max 0 (/ (+ n i) m)) char)
1836 (car strings)))
1837 (setq i (1+ i))
1838 (setq strings (cdr strings)))
1839 (substring s 0 length)))
1840
1841 (defun update-calendar-mode-line ()
1842 "Update the calendar mode line with the current date and date style."
1843 (if (bufferp (get-buffer calendar-buffer))
1844 (save-excursion
1845 (set-buffer calendar-buffer)
1846 (setq mode-line-format
1847 (calendar-string-spread
1848 calendar-mode-line-format ? (frame-width))))))
1849
1850 (defun calendar-window-list ()
1851 "List of all calendar-related windows."
1852 (let ((calendar-buffers (calendar-buffer-list))
1853 list)
1854 (walk-windows '(lambda (w)
1855 (if (memq (window-buffer w) calendar-buffers)
1856 (setq list (cons w list))))
1857 nil t)
1858 list))
1859
1860 (defun calendar-buffer-list ()
1861 "List of all calendar-related buffers."
1862 (let* ((diary-buffer (get-file-buffer diary-file))
1863 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
1864 fancy-diary-buffer diary-buffer calendar-buffer))
1865 (buffer-list nil)
1866 b)
1867 (while buffers
1868 (setq b (car buffers))
1869 (setq b (cond ((stringp b) (get-buffer b))
1870 ((bufferp b) b)
1871 (t nil)))
1872 (if b (setq buffer-list (cons b buffer-list)))
1873 (setq buffers (cdr buffers)))
1874 buffer-list))
1875
1876 (defun exit-calendar ()
1877 "Get out of the calendar window and hide it and related buffers."
1878 (interactive)
1879 (let* ((diary-buffer (get-file-buffer diary-file)))
1880 (if (and diary-buffer (buffer-modified-p diary-buffer)
1881 (not
1882 (yes-or-no-p
1883 "Diary modified; do you really want to exit the calendar? ")))
1884 (error)
1885 ;; Need to do this multiple times because one time can replace some
1886 ;; calendar-related buffers with other calendar-related buffers
1887 (mapcar (lambda (x)
1888 (mapcar 'calendar-hide-window (calendar-window-list)))
1889 (calendar-window-list)))))
1890
1891 (defun calendar-hide-window (window)
1892 "Hide WINDOW if it is calendar-related."
1893 (let ((buffer (if (window-live-p window) (window-buffer window))))
1894 (if (memq buffer (calendar-buffer-list))
1895 (cond
1896 ((and window-system
1897 (eq 'icon (cdr (assoc 'visibility
1898 (frame-parameters
1899 (window-frame window))))))
1900 nil)
1901 ((and window-system (window-dedicated-p window))
1902 (iconify-frame (window-frame window)))
1903 ((not (and (select-window window) (one-window-p window)))
1904 (delete-window window))
1905 (t (set-buffer buffer)
1906 (bury-buffer))))))
1907
1908 (defun calendar-current-date ()
1909 "Returns the current date in a list (month day year)."
1910 (let ((s (current-time-string)))
1911 (list (length (member (substring s 4 7)
1912 '("Dec" "Nov" "Oct" "Sep" "Aug" "Jul"
1913 "Jun" "May" "Apr" "Mar" "Feb" "Jan")))
1914 (string-to-number (substring s 8 10))
1915 (string-to-number (substring s 20 24)))))
1916
1917 (defun calendar-cursor-to-date (&optional error)
1918 "Returns a list (month day year) of current cursor position.
1919 If cursor is not on a specific date, signals an error if optional parameter
1920 ERROR is t, otherwise just returns nil."
1921 (let* ((segment (/ (current-column) 25))
1922 (month (% (+ displayed-month segment -1) 12))
1923 (month (if (= 0 month) 12 month))
1924 (year
1925 (cond
1926 ((and (= 12 month) (= segment 0)) (1- displayed-year))
1927 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
1928 (t displayed-year))))
1929 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
1930 (< 2 (count-lines (point-min) (point))))
1931 (save-excursion
1932 (if (not (looking-at " "))
1933 (re-search-backward "[^0-9]"))
1934 (list month
1935 (string-to-int (buffer-substring (1+ (point)) (+ 4 (point))))
1936 year))
1937 (if (looking-at "\\*")
1938 (save-excursion
1939 (re-search-backward "[^*]")
1940 (if (looking-at ".\\*\\*")
1941 (list month calendar-starred-day year)
1942 (if error (error "Not on a date!"))))
1943 (if error (error "Not on a date!"))))))
1944
1945 ;; The following version of calendar-gregorian-from-absolute is preferred for
1946 ;; reasons of clarity, BUT it's much slower than the version that follows it.
1947
1948 ;;(defun calendar-gregorian-from-absolute (date)
1949 ;; "Compute the list (month day year) corresponding to the absolute DATE.
1950 ;;The absolute date is the number of days elapsed since the (imaginary)
1951 ;;Gregorian date Sunday, December 31, 1 BC."
1952 ;; (let* ((approx (/ date 366));; Approximation from below.
1953 ;; (year ;; Search forward from the approximation.
1954 ;; (+ approx
1955 ;; (calendar-sum y approx
1956 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
1957 ;; 1)))
1958 ;; (month ;; Search forward from January.
1959 ;; (1+ (calendar-sum m 1
1960 ;; (> date
1961 ;; (calendar-absolute-from-gregorian
1962 ;; (list m (calendar-last-day-of-month m year) year)))
1963 ;; 1)))
1964 ;; (day ;; Calculate the day by subtraction.
1965 ;; (- date
1966 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
1967 ;; (list month day year)))
1968
1969 (defun calendar-gregorian-from-absolute (date)
1970 "Compute the list (month day year) corresponding to the absolute DATE.
1971 The absolute date is the number of days elapsed since the (imaginary)
1972 Gregorian date Sunday, December 31, 1 BC."
1973 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
1974 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
1975 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
1976 ;; (April, 1993), pages 383-404 for an explanation.
1977 (let* ((d0 (1- date))
1978 (n400 (/ d0 146097))
1979 (d1 (% d0 146097))
1980 (n100 (/ d1 36524))
1981 (d2 (% d1 36524))
1982 (n4 (/ d2 1461))
1983 (d3 (% d2 1461))
1984 (n1 (/ d3 365))
1985 (day (1+ (% d3 365)))
1986 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
1987 (if (or (= n100 4) (= n1 4))
1988 (list 12 31 year)
1989 (let ((year (1+ year))
1990 (month 1))
1991 (while (let ((mdays (calendar-last-day-of-month month year)))
1992 (and (< mdays day)
1993 (setq day (- day mdays))))
1994 (setq month (1+ month)))
1995 (list month day year)))))
1996
1997 (defun calendar-other-month (month year)
1998 "Display a three-month calendar centered around MONTH and YEAR."
1999 (interactive (calendar-read-date 'noday))
2000 (if (and (= month displayed-month)
2001 (= year displayed-year))
2002 nil
2003 (let ((old-date (calendar-cursor-to-date))
2004 (today (calendar-current-date)))
2005 (generate-calendar-window month year)
2006 (calendar-cursor-to-visible-date
2007 (cond
2008 ((calendar-date-is-visible-p old-date) old-date)
2009 ((calendar-date-is-visible-p today) today)
2010 (t (list month 1 year)))))))
2011
2012 (defun calendar-set-mark (arg)
2013 "Mark the date under the cursor, or jump to marked date.
2014 With no prefix argument, push current date onto marked date ring.
2015 With argument, jump to mark, pop it, and put point at end of ring."
2016 (interactive "P")
2017 (let ((date (calendar-cursor-to-date t)))
2018 (if (null arg)
2019 (progn
2020 (setq calendar-mark-ring (cons date calendar-mark-ring))
2021 ;; Since the top of the mark ring is the marked date in the
2022 ;; calendar, the mark ring in the calendar is one longer than
2023 ;; in other buffers to get the same effect.
2024 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2025 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2026 (message "Mark set"))
2027 (if (null calendar-mark-ring)
2028 (error "No mark set in this buffer")
2029 (calendar-goto-date (car calendar-mark-ring))
2030 (setq calendar-mark-ring
2031 (cdr (nconc calendar-mark-ring (list date))))))))
2032
2033 (defun calendar-exchange-point-and-mark ()
2034 "Exchange the current cursor position with the marked date."
2035 (interactive)
2036 (let ((mark (car calendar-mark-ring))
2037 (date (calendar-cursor-to-date t)))
2038 (if (null mark)
2039 (error "No mark set in this buffer")
2040 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2041 (calendar-goto-date mark))))
2042
2043 (defun calendar-count-days-region ()
2044 "Count the number of days (inclusive) between point and the mark."
2045 (interactive)
2046 (let* ((days (- (calendar-absolute-from-gregorian
2047 (calendar-cursor-to-date t))
2048 (calendar-absolute-from-gregorian
2049 (or (car calendar-mark-ring)
2050 (error "No mark set in this buffer")))))
2051 (days (1+ (if (> days 0) days (- days)))))
2052 (message "Region has %d day%s (inclusive)"
2053 days (if (> days 1) "s" ""))))
2054
2055 (defun calendar-not-implemented ()
2056 "Not implemented."
2057 (interactive)
2058 (error "%s not available in the calendar"
2059 (global-key-binding (this-command-keys))))
2060
2061 (defun calendar-read (prompt acceptable &optional initial-contents)
2062 "Return an object read from the minibuffer.
2063 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2064 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2065 is a string to insert in the minibuffer before reading."
2066 (let ((value (read-minibuffer prompt initial-contents)))
2067 (while (not (funcall acceptable value))
2068 (setq value (read-minibuffer prompt initial-contents)))
2069 value))
2070
2071 (defun calendar-read-date (&optional noday)
2072 "Prompt for Gregorian date. Returns a list (month day year).
2073 If optional NODAY is t, does not ask for day, but just returns
2074 (month nil year); if NODAY is any other non-nil value the value returned is
2075 (month year) "
2076 (let* ((year (calendar-read
2077 "Year (>0): "
2078 '(lambda (x) (> x 0))
2079 (int-to-string (extract-calendar-year
2080 (calendar-current-date)))))
2081 (month-array calendar-month-name-array)
2082 (completion-ignore-case t)
2083 (month (cdr (assoc
2084 (capitalize
2085 (completing-read
2086 "Month name: "
2087 (mapcar 'list (append month-array nil))
2088 nil t))
2089 (calendar-make-alist month-array 1 'capitalize))))
2090 (last (calendar-last-day-of-month month year)))
2091 (if noday
2092 (if (eq noday t)
2093 (list month nil year)
2094 (list month year))
2095 (list month
2096 (calendar-read (format "Day (1-%d): " last)
2097 '(lambda (x) (and (< 0 x) (<= x last))))
2098 year))))
2099
2100 (defun calendar-interval (mon1 yr1 mon2 yr2)
2101 "The number of months difference between MON1, YR1 and MON2, YR2."
2102 (+ (* 12 (- yr2 yr1))
2103 (- mon2 mon1)))
2104
2105 (defun calendar-day-name (date)
2106 "Returns a string with the name of the day of the week of DATE."
2107 (aref calendar-day-name-array (calendar-day-of-week date)))
2108
2109 (defvar calendar-day-name-array
2110 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"])
2111
2112 (defvar calendar-month-name-array
2113 ["January" "February" "March" "April" "May" "June"
2114 "July" "August" "September" "October" "November" "December"])
2115
2116 (defun calendar-make-alist (sequence &optional start-index filter)
2117 "Make an assoc list corresponding to SEQUENCE.
2118 Start at index 1, unless optional START-INDEX is provided.
2119 If FILTER is provided, apply it to each item in the list."
2120 (let ((index (if start-index (1- start-index) 0)))
2121 (mapcar
2122 '(lambda (x)
2123 (setq index (1+ index))
2124 (cons (if filter (funcall filter x) x)
2125 index))
2126 (append sequence nil))))
2127
2128 (defun calendar-month-name (month)
2129 "The name of MONTH."
2130 (aref calendar-month-name-array (1- month)))
2131
2132 (defun calendar-day-of-week (date)
2133 "Returns the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc."
2134 (% (calendar-absolute-from-gregorian date) 7))
2135
2136 (defun calendar-unmark ()
2137 "Delete all diary/holiday marks/highlighting from the calendar."
2138 (interactive)
2139 (setq mark-holidays-in-calendar nil)
2140 (setq mark-diary-entries-in-calendar nil)
2141 (redraw-calendar))
2142
2143 (defun calendar-date-is-visible-p (date)
2144 "Returns t if DATE is legal and is visible in the calendar window."
2145 (let ((gap (calendar-interval
2146 displayed-month displayed-year
2147 (extract-calendar-month date) (extract-calendar-year date))))
2148 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2149
2150 (defun calendar-date-is-legal-p (date)
2151 "Returns t if DATE is a legal date."
2152 (let ((month (extract-calendar-month date))
2153 (day (extract-calendar-day date))
2154 (year (extract-calendar-year date)))
2155 (and (<= 1 month) (<= month 12)
2156 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2157 (<= 1 year))))
2158
2159 (defun calendar-date-equal (date1 date2)
2160 "Returns t if the DATE1 and DATE2 are the same."
2161 (and
2162 (= (extract-calendar-month date1) (extract-calendar-month date2))
2163 (= (extract-calendar-day date1) (extract-calendar-day date2))
2164 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2165
2166 (defun mark-visible-calendar-date (date &optional mark)
2167 "Mark DATE in the calendar window with MARK.
2168 MARK is either a single-character string or a face.
2169 MARK defaults to diary-entry-marker."
2170 (if (calendar-date-is-legal-p date)
2171 (save-excursion
2172 (set-buffer calendar-buffer)
2173 (calendar-cursor-to-visible-date date)
2174 (let ((mark (or mark diary-entry-marker)))
2175 (if (stringp mark)
2176 (let ((buffer-read-only nil))
2177 (forward-char 1)
2178 (delete-char 1)
2179 (insert mark)
2180 (forward-char -2))
2181 (overlay-put
2182 (make-overlay (1- (point)) (1+ (point))) 'face mark))))))
2183
2184 (defun calendar-star-date ()
2185 "Replace the date under the cursor in the calendar window with asterisks.
2186 This function can be used with the today-visible-calendar-hook run after the
2187 calendar window has been prepared."
2188 (let ((buffer-read-only nil))
2189 (make-variable-buffer-local 'calendar-starred-day)
2190 (forward-char 1)
2191 (setq calendar-starred-day
2192 (string-to-int
2193 (buffer-substring (point) (- (point) 2))))
2194 (delete-char -2)
2195 (insert "**")
2196 (backward-char 1)
2197 (set-buffer-modified-p nil)))
2198
2199 (defun calendar-mark-today ()
2200 "Mark the date under the cursor in the calendar window.
2201 The date is marked with calendar-today-marker. This function can be used with
2202 the today-visible-calendar-hook run after the calendar window has been
2203 prepared."
2204 (mark-visible-calendar-date
2205 (calendar-cursor-to-date)
2206 calendar-today-marker))
2207
2208 (defun calendar-date-compare (date1 date2)
2209 "Returns t if DATE1 is before DATE2, nil otherwise.
2210 The actual dates are in the car of DATE1 and DATE2."
2211 (< (calendar-absolute-from-gregorian (car date1))
2212 (calendar-absolute-from-gregorian (car date2))))
2213
2214 (defun calendar-date-string (date &optional abbreviate nodayname)
2215 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2216 An optional parameter ABBREVIATE, when t, causes the month and day names to be
2217 abbreviated to three characters. An optional parameter NODAYNAME, when t,
2218 omits the name of the day of the week."
2219 (let* ((dayname
2220 (if nodayname
2221 nil
2222 (if abbreviate
2223 (substring (calendar-day-name date) 0 3)
2224 (calendar-day-name date))))
2225 (month (extract-calendar-month date))
2226 (monthname
2227 (if abbreviate
2228 (substring
2229 (calendar-month-name month) 0 3)
2230 (calendar-month-name month)))
2231 (day (int-to-string (extract-calendar-day date)))
2232 (month (int-to-string month))
2233 (year (int-to-string (extract-calendar-year date))))
2234 (mapconcat 'eval calendar-date-display-form "")))
2235
2236 (defun calendar-dayname-on-or-before (dayname date)
2237 "Returns the absolute date of the DAYNAME on or before absolute DATE.
2238 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
2239
2240 Note: Applying this function to d+6 gives us the DAYNAME on or after an
2241 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
2242 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
2243 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
2244 (- date (% (- date dayname) 7)))
2245
2246 (defun calendar-nth-named-absday (n dayname month year &optional day)
2247 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2248 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2249 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2250 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2251
2252 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2253 (if (> n 0)
2254 (+ (* 7 (1- n))
2255 (calendar-dayname-on-or-before
2256 dayname
2257 (+ 6 (calendar-absolute-from-gregorian
2258 (list month (or day 1) year)))))
2259 (+ (* 7 (1+ n))
2260 (calendar-dayname-on-or-before
2261 dayname
2262 (calendar-absolute-from-gregorian
2263 (list month
2264 (or day (calendar-last-day-of-month month year))
2265 year))))))
2266
2267 (defun calendar-nth-named-day (n dayname month year &optional day)
2268 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
2269 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
2270 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2271 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2272
2273 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
2274 (calendar-gregorian-from-absolute
2275 (calendar-nth-named-absday n dayname month year day)))
2276
2277 (defun calendar-day-of-year-string (&optional date)
2278 "String of day number of year of Gregorian DATE.
2279 Defaults to today's date if DATE is not given."
2280 (let* ((d (or date (calendar-current-date)))
2281 (year (extract-calendar-year d))
2282 (day (calendar-day-number d))
2283 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
2284 (format "Day %d of %d; %d day%s remaining in the year"
2285 day year days-remaining (if (= days-remaining 1) "" "s"))))
2286
2287 (defun calendar-print-day-of-year ()
2288 "Show day number in year/days remaining in year for date under the cursor."
2289 (interactive)
2290 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
2291
2292 (defun calendar-set-mode-line (str)
2293 "Set mode line to STR, centered, surrounded by dashes."
2294 (setq mode-line-format
2295 (calendar-string-spread (list str) ?- (frame-width))))
2296
2297 (defun calendar-mod (m n)
2298 "Non-negative remainder of M/N with N instead of 0."
2299 (1+ (mod (1- m) n)))
2300
2301 (run-hooks 'calendar-load-hook)
2302
2303 (provide 'calendar)
2304
2305 ;;; calendar.el ends here