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