| blob | 734a9b27e1f7c9051d999416f2ce81eb19805976 |
1 ;;; calendar.el --- calendar functions
3 ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
8 ;; Keywords: calendar
9 ;; Human-Keywords: calendar, Gregorian calendar, diary, holidays
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; This collection of functions implements a calendar window. It
31 ;; generates a calendar for the current month, together with the
32 ;; previous and coming months, or for any other three-month period.
33 ;; The calendar can be scrolled forward and backward in the window to
34 ;; show months in the past or future; the cursor can move forward and
35 ;; backward by days, weeks, or months, making it possible, for
36 ;; instance, to jump to the date a specified number of days, weeks, or
37 ;; months from the date under the cursor. The user can display a list
38 ;; of holidays and other notable days for the period shown; the
39 ;; notable days can be marked on the calendar, if desired. The user
40 ;; can also specify that dates having corresponding diary entries (in
41 ;; a file that the user specifies) be marked; the diary entries for
42 ;; any date can be viewed in a separate window. The diary and the
43 ;; notable days can be viewed independently of the calendar. Dates
44 ;; can be translated from the (usual) Gregorian calendar to the day of
45 ;; the year/days remaining in year, to the ISO commercial calendar, to
46 ;; the Julian (old style) calendar, to the Hebrew calendar, to the
47 ;; Islamic calendar, to the Baha'i calendar, to the French
48 ;; Revolutionary calendar, to the Mayan calendar, to the Chinese
49 ;; calendar, to the Coptic calendar, to the Ethiopic calendar, and to
50 ;; the astronomical (Julian) day number. When floating point is
51 ;; available, times of sunrise/sunset can be displayed, as can the
52 ;; phases of the moon. Appointment notification for diary entries is
53 ;; available. Calendar printing via LaTeX is available.
55 ;; The following files are part of the calendar/diary code:
57 ;; appt.el Appointment notification
58 ;; cal-china.el Chinese calendar
59 ;; cal-coptic.el Coptic/Ethiopic calendars
60 ;; cal-dst.el Daylight savings time rules
61 ;; cal-hebrew.el Hebrew calendar
62 ;; cal-islam.el Islamic calendar
63 ;; cal-bahai.el Baha'i calendar
64 ;; cal-iso.el ISO calendar
65 ;; cal-julian.el Julian/astronomical calendars
66 ;; cal-mayan.el Mayan calendars
67 ;; cal-menu.el Menu support
68 ;; cal-move.el Movement in the calendar
69 ;; cal-persia.el Persian calendar
70 ;; cal-tex.el Calendars in LaTeX
71 ;; cal-x.el X-windows dedicated frame functions
72 ;; diary-lib.el Diary functions
73 ;; holidays.el Holiday functions
74 ;; lunar.el Phases of the moon
75 ;; solar.el Sunrise/sunset, equinoxes/solstices
77 ;; Technical details of all the calendrical calculations can be found in
78 ;; ``Calendrical Calculations: The Millennium Edition'' by Edward M. Reingold
79 ;; and Nachum Dershowitz, Cambridge University Press (2001).
81 ;; An earlier version of the technical details appeared in
82 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
83 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
84 ;; pages 899-928, and in ``Calendrical Calculations, Part II: Three Historical
85 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
86 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
87 ;; pages 383-404.
89 ;; Hard copies of these two papers can be obtained by sending email to
90 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
91 ;; the message BODY containing your mailing address (snail).
93 ;; Comments, corrections, and improvements should be sent to
94 ;; Edward M. Reingold Department of Computer Science
95 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
96 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
97 ;; Urbana, Illinois 61801
99 ;;; Code:
111 "Calendar and time management support."
115 "Emacs diary."
119 "Appointment notification."
123 "Holidays support in calendar."
129 "Chinese calendar support."
133 "Options for printing calendar with LaTeX."
138 "Calendar hooks."
146 ;;;###autoload
148 "The offset of the principal month from the center of the calendar window.
149 0 means the principal month is in the center (default), -1 means on the left,
150 +1 means on the right. Larger (or smaller) values push the principal month off
151 the screen."
155 ;;;###autoload
157 "Non-nil means display current date's diary entries on entry to calendar.
158 The diary is displayed in another window when the calendar is first displayed,
159 if the current date is visible. The number of days of diary entries displayed
160 is governed by the variable `number-of-diary-entries'. This variable can
161 be overridden by the value of `calendar-setup'."
165 ;;;###autoload
167 "Non-nil means mark dates with diary entries, in the calendar window.
168 The marking symbol is specified by the variable `diary-entry-marker'."
172 ;;;###autoload
174 "Determine how the calendar mode removes a frame no longer needed.
175 If nil, make an icon of the frame. If non-nil, delete the frame."
192 "Face for highlighting diary entries."
194 ;; backward-compatibility alias
199 "Face for indicating today's date."
201 ;; backward-compatibility alias
211 "Face for indicating dates that have holidays."
213 ;; backward-compatibility alias
224 "+"
226 "How to mark dates that have diary entries.
227 The value can be either a single-character string or a face."
233 "="
235 "How to mark today's date in the calendar.
236 The value can be either a single-character string or a face.
237 Marking today's date is done only if you set up `today-visible-calendar-hook'
238 to request that."
244 "*"
246 "How to mark notable dates in the calendar.
247 The value can be either a single-character string or a face."
251 ;;;###autoload
253 "Non-nil means display holidays for current three month period on entry.
254 The holidays are displayed in another window when the calendar is first
255 displayed."
259 ;;;###autoload
261 "Non-nil means mark dates of holidays in the calendar window.
262 The marking symbol is specified by the variable `calendar-holiday-marker'."
266 ;;;###autoload
268 "If nil, show only major holidays from the Hebrew calendar.
269 This means only those Jewish holidays that appear on secular calendars.
271 If t, show all the holidays that would appear in a complete Hebrew calendar."
275 ;;;###autoload
277 "If nil, show only major holidays from the Christian calendar.
278 This means only those Christian holidays that appear on secular calendars.
280 If t, show all the holidays that would appear in a complete Christian
281 calendar."
285 ;;;###autoload
287 "If nil, show only major holidays from the Islamic calendar.
288 This means only those Islamic holidays that appear on secular calendars.
290 If t, show all the holidays that would appear in a complete Islamic
291 calendar."
296 "The function that will take a diary file name and return the desired prefix."
300 ;;;###autoload
302 "If nil, show only major holidays from the Baha'i calendar.
303 These are the days on which work and school must be suspended.
305 If t, show all the holidays that would appear in a complete Baha'i
306 calendar."
310 ;;;###autoload
312 "List of functions to be called after the calendar is first loaded.
313 This is the place to add key bindings to `calendar-mode-map'."
317 ;;;###autoload
319 "List of functions to be called when the calendar window is first opened.
320 The functions invoked are called after the calendar window is opened, but
321 once opened is never called again. Leaving the calendar with the `q' command
322 and reentering it will cause these functions to be called again."
326 ;;;###autoload
328 "List of functions called whenever the current date is visible.
329 This can be used, for example, to replace today's date with asterisks; a
330 function `calendar-star-date' is included for this purpose:
331 (setq today-visible-calendar-hook 'calendar-star-date)
332 It can also be used to mark the current date with `calendar-today-marker';
333 a function is also provided for this:
334 (setq today-visible-calendar-hook 'calendar-mark-today)
336 The corresponding variable `today-invisible-calendar-hook' is the list of
337 functions called when the calendar function was called when the current
338 date is not visible in the window.
340 Other than the use of the provided functions, the changing of any
341 characters in the calendar buffer by the hooks may cause the failure of the
342 functions that move by days and weeks."
346 ;;;###autoload
348 "List of functions called whenever the current date is not visible.
350 The corresponding variable `today-visible-calendar-hook' is the list of
351 functions called when the calendar function was called when the current
352 date is visible in the window.
354 Other than the use of the provided functions, the changing of any
355 characters in the calendar buffer by the hooks may cause the failure of the
356 functions that move by days and weeks."
360 ;;;###autoload
362 "List of functions called whenever the cursor moves in the calendar.
364 For example,
366 (add-hook 'calendar-move-hook (lambda () (diary-view-entries 1)))
368 redisplays the diary for whatever date the cursor is moved to."
372 ;;;###autoload
374 "Name of the file in which one's personal diary of dates is kept.
376 The file's entries are lines beginning with any of the forms
377 specified by the variable `american-date-diary-pattern', by default:
379 MONTH/DAY
380 MONTH/DAY/YEAR
381 MONTHNAME DAY
382 MONTHNAME DAY, YEAR
383 DAYNAME
385 with the remainder of the line being the diary entry string for
386 that date. MONTH and DAY are one or two digit numbers, YEAR is a
387 number and may be written in full or abbreviated to the final two
388 digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME
389 and DAYNAME can be spelled in full (as specified by the variables
390 `calendar-month-name-array' and `calendar-day-name-array'),
391 abbreviated (as specified by `calendar-month-abbrev-array' and
392 `calendar-day-abbrev-array') with or without a period,
393 capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be
394 `*' which matches any day, month, or year, respectively. If the
395 date does not contain a year, it is generic and applies to any
396 year. A DAYNAME entry applies to the appropriate day of the week
397 in every week.
399 The European style (in which the day precedes the month) can be
400 used instead, if you execute `european-calendar' when in the
401 calendar, or set `european-calendar-style' to t in your .emacs
402 file. The European forms (see `european-date-diary-pattern') are
404 DAY/MONTH
405 DAY/MONTH/YEAR
406 DAY MONTHNAME
407 DAY MONTHNAME YEAR
408 DAYNAME
410 To revert to the default American style from the European style, execute
411 `american-calendar' in the calendar.
413 A diary entry can be preceded by the character
414 `diary-nonmarking-symbol' (ordinarily `&') to make that entry
415 nonmarking--that is, it will not be marked on dates in the calendar
416 window but will appear in a diary window.
418 Multiline diary entries are made by indenting lines after the first with
419 either a TAB or one or more spaces.
421 Lines not in one the above formats are ignored. Here are some sample diary
422 entries (in the default American style):
424 12/22/1988 Twentieth wedding anniversary!!
425 &1/1. Happy New Year!
426 10/22 Ruth's birthday.
427 21: Payday
428 Tuesday--weekly meeting with grad students at 10am
429 Supowit, Shen, Bitner, and Kapoor to attend.
430 1/13/89 Friday the thirteenth!!
431 &thu 4pm squash game with Lloyd.
432 mar 16 Dad's birthday
433 April 15, 1989 Income tax due.
434 &* 15 time cards due.
436 If the first line of a diary entry consists only of the date or day name with
437 no trailing blanks or punctuation, then that line is not displayed in the
438 diary window; only the continuation lines is shown. For example, the
439 single diary entry
441 02/11/1989
442 Bill Blattner visits Princeton today
443 2pm Cognitive Studies Committee meeting
444 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
445 4:00pm Jamie Tappenden
446 7:30pm Dinner at George and Ed's for Alan Ryan
447 7:30-10:00pm dance at Stewart Country Day School
449 will appear in the diary window without the date line at the beginning. This
450 facility allows the diary window to look neater, but can cause confusion if
451 used with more than one day's entries displayed.
453 Diary entries can be based on Lisp sexps. For example, the diary entry
455 %%(diary-block 11 1 1990 11 10 1990) Vacation
458 November 10, 1990. Other functions available are `diary-float',
459 `diary-anniversary', `diary-cyclic', `diary-day-of-year',
460 `diary-iso-date', `diary-french-date', `diary-hebrew-date',
461 `diary-islamic-date', `diary-bahai-date', `diary-mayan-date',
462 `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date',
463 `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset',
464 `diary-phases-of-moon', `diary-parasha', `diary-omer',
465 `diary-rosh-hodesh', and `diary-sabbath-candles'. See the
466 documentation for the function `list-sexp-diary-entries' for more
467 details.
469 Diary entries based on the Hebrew, the Islamic and/or the Baha'i
470 calendar are also possible, but because these are somewhat slow, they
471 are ignored unless you set the `nongregorian-diary-listing-hook' and
472 the `nongregorian-diary-marking-hook' appropriately. See the
473 documentation for these functions for details.
475 Diary files can contain directives to include the contents of other files; for
476 details, see the documentation for the variable `list-diary-entries-hook'."
480 ;;;###autoload
482 "Symbol indicating that a diary entry is not to be marked in the calendar."
486 ;;;###autoload
488 "Symbol indicating a diary entry according to the Hebrew calendar."
492 ;;;###autoload
494 "Symbol indicating a diary entry according to the Islamic calendar."
498 ;;;###autoload
500 "Symbol indicating a diary entry according to the Baha'i calendar."
504 ;;;###autoload
506 "The string indicating inclusion of another file of diary entries.
507 See the documentation for the function `include-other-diary-files'."
512 "The regular expression that gets pre-pended to each of the attribute-regexp's for file-wide specifiers."
529 ;; Unsupported.
530 ;;; (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box)
531 ;;; (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple)
532 )
533 "A list of (regexp regnum attr attrtype) lists where the
534 regexp says how to find the tag, the regnum says which
535 parenthetical sub-regexp this regexp looks for, and the attr says
536 which attribute of the face (or that this _is_ a face) is being
537 modified."
542 "If non-nil each diary entry is prefixed with the name of the file where it is defined."
546 ;;;###autoload
548 "The string used to indicate a sexp diary entry in `diary-file'.
549 See the documentation for the function `list-sexp-diary-entries'."
553 ;;;###autoload
555 "Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
556 For the Gregorian calendar; similarly for the Hebrew, Islamic and
557 Baha'i calendars. If this variable is nil, years must be written in
558 full."
562 ;;;###autoload
564 "Use the European style of dates in the diary and in any displays.
565 If this variable is t, a date 1/2/1990 would be interpreted as February 1,
566 1990. The default European date styles (see `european-date-diary-pattern')
567 are
569 DAY/MONTH
570 DAY/MONTH/YEAR
571 DAY MONTHNAME
572 DAY MONTHNAME YEAR
573 DAYNAME
575 Names can be capitalized or not, written in full (as specified by the
576 variable `calendar-day-name-array'), or abbreviated (as specified by
577 `calendar-day-abbrev-array') with or without a period. To take effect,
578 this variable should be set before the calendar package and its associates
579 are loaded. Otherwise, use one of the functions `european-calendar' or
580 `american-calendar' to force the appropriate update."
584 ;;;###autoload
591 "List of pseudo-patterns describing the American patterns of date used.
592 See the documentation of `diary-date-forms' for an explanation."
604 ;;;###autoload
611 "List of pseudo-patterns describing the European patterns of date used.
612 See the documentation of `diary-date-forms' for an explanation."
626 european-date-diary-pattern
627 american-date-diary-pattern)
628 "List of pseudo-patterns describing the forms of date used in the diary.
629 The patterns on the list must be MUTUALLY EXCLUSIVE and should not match
630 any portion of the diary entry itself, just the date component.
632 A pseudo-pattern is a list of regular expressions and the keywords `month',
633 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
634 match the name of the month (see `calendar-month-name-array'), capitalized
635 or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'),
636 followed by a period or not; it will also match `*'. Similarly, `dayname'
637 will match the name of the day (see `calendar-day-name-array'), capitalized or
638 not, or its user-specified abbreviation (see `calendar-day-abbrev-array'),
639 followed by a period or not. The keywords `month', `day', and `year' will
640 match those numerical values, preceded by arbitrarily many zeros; they will
641 also match `*'.
643 The matching of the diary entries with the date forms is done with the
644 standard syntax table from Fundamental mode, but with the `*' changed so
645 that it is a word constituent.
647 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
648 diary entry itself, the first element of the pattern MUST be `backup'. This
649 directive causes the date recognizer to back up to the beginning of the
650 current word of the diary entry, so in no case can the pattern match more than
651 a portion of the first word of the diary entry."
663 ;;;###autoload
666 "Pseudo-pattern governing the way a date appears in the European style.
667 See the documentation of `calendar-date-display-form' for an explanation."
671 ;;;###autoload
674 "Pseudo-pattern governing the way a date appears in the American style.
675 See the documentation of `calendar-date-display-form' for an explanation."
681 european-calendar-display-form
682 american-calendar-display-form)
683 "Pseudo-pattern governing the way a date appears.
685 Used by the function `calendar-date-string', a pseudo-pattern is a list of
686 expressions that can involve the keywords `month', `day', and `year', all
687 numbers in string form, and `monthname' and `dayname', both alphabetic
688 strings. For example, the ISO standard would use the pseudo- pattern
692 while a typical American form would be
696 and
700 would give the usual American style in fixed-length fields.
702 See the documentation of the function `calendar-date-string'."
707 "Set the interpretation and display of dates to the European style."
715 "Set the interpretation and display of dates to the American style."
722 ;;;###autoload
724 "List of functions called after a temporary diary buffer is prepared.
725 The buffer shows only the diary entries currently visible in the diary
726 buffer. The default just does the printing. Other uses might include, for
727 example, rearranging the lines into order by day and time, saving the buffer
728 instead of deleting it, or changing the function used to do the printing."
732 ;;;###autoload
734 "List of functions called after diary file is culled for relevant entries.
735 It is to be used for diary entries that are not found in the diary file.
737 A function `include-other-diary-files' is provided for use as the value of
738 this hook. This function enables you to use shared diary files together
739 with your own. The files included are specified in the diary file by lines
740 of the form
744 This is recursive; that is, #include directives in files thus included are
746 the variable `diary-include-string'. When you use `include-other-diary-files'
747 as part of the list-diary-entries-hook, you will probably also want to use the
748 function `mark-included-diary-files' as part of `mark-diary-entries-hook'.
750 For example, you could use
752 (setq list-diary-entries-hook
753 '(include-other-diary-files sort-diary-entries))
754 (setq diary-display-hook 'fancy-diary-display)
756 in your `.emacs' file to cause the fancy diary buffer to be displayed with
757 diary entries from various included files, each day's entries sorted into
758 lexicographic order."
763 ;;;###autoload
765 "List of functions called after the display of the diary.
766 Can be used for appointment notification."
770 ;;;###autoload
772 "List of functions that handle the display of the diary.
773 If nil (the default), `simple-diary-display' is used. Use `ignore' for no
774 diary display.
776 Ordinarily, this just displays the diary buffer (with holidays indicated in
777 the mode line), if there are any relevant entries. At the time these
778 functions are called, the variable `diary-entries-list' is a list, in order
779 by date, of all relevant diary entries in the form of ((MONTH DAY YEAR)
780 STRING), where string is the diary entry for the given date. This can be
781 used, for example, a different buffer for display (perhaps combined with
782 holidays), or produce hard copy output.
784 A function `fancy-diary-display' is provided as an alternative
785 choice for this hook; this function prepares a special noneditable diary
786 buffer with the relevant diary entries that has neat day-by-day arrangement
787 with headings. The fancy diary buffer will show the holidays unless the
788 variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy
789 diary buffer will not show days for which there are no diary entries, even
790 if that day is a holiday; if you want such days to be shown in the fancy
791 diary buffer, set the variable `diary-list-include-blanks' to t."
796 ;;;###autoload
798 "List of functions called for listing diary file and included files.
799 As the files are processed for diary entries, these functions are used
800 to cull relevant entries. You can use either or both of
801 `list-hebrew-diary-entries', `list-islamic-diary-entries' and
802 `list-bahai-diary-entries'. The documentation for these functions
803 describes the style of such diary entries."
806 list-islamic-diary-entries
807 list-bahai-diary-entries)
810 ;;;###autoload
812 "List of functions called after marking diary entries in the calendar.
814 A function `mark-included-diary-files' is also provided for use as the
815 `mark-diary-entries-hook'; it enables you to use shared diary files together
816 with your own. The files included are specified in the diary file by lines
817 of the form
819 This is recursive; that is, #include directives in files thus included are
821 variable `diary-include-string'. When you use `mark-included-diary-files' as
822 part of the mark-diary-entries-hook, you will probably also want to use the
823 function `include-other-diary-files' as part of `list-diary-entries-hook'."
828 ;;;###autoload
830 "List of functions called for marking diary file and included files.
831 As the files are processed for diary entries, these functions are used
832 to cull relevant entries. You can use either or both of
833 `mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
834 `mark-bahai-diary-entries'. The documentation for these functions
835 describes the style of such diary entries."
838 mark-islamic-diary-entries
839 mark-bahai-diary-entries)
842 ;;;###autoload
844 "If nil, do not include days with no diary entry in the list of diary entries.
845 Such days will then not be shown in the fancy diary buffer, even if they
846 are holidays."
850 ;;;###autoload
852 "Non-nil means include holidays in the diary display.
853 The holidays appear in the mode line of the diary buffer, or in the
854 fancy diary buffer next to the date. This slows down the diary functions
855 somewhat; setting it to nil makes the diary display faster."
861 ;;;###autoload
863 ;;;###autoload
882 "General holidays. Default value is for the United States.
883 See the documentation for `calendar-holidays' for details."
887 ;;;###autoload
889 ;;;###autoload
893 "Oriental holidays.
894 See the documentation for `calendar-holidays' for details."
898 ;;;###autoload
900 ;;;###autoload
902 "Local holidays.
903 See the documentation for `calendar-holidays' for details."
907 ;;;###autoload
909 ;;;###autoload
911 "User defined holidays.
912 See the documentation for `calendar-holidays' for details."
916 ;;;###autoload
918 ;;;###autoload
923 11
933 22
936 ;;;###autoload
938 ;;;###autoload
945 10
958 ;;;###autoload
960 ;;;###autoload
964 11
973 y)))))
988 day))
991 ;;;###autoload
993 ;;;###autoload
1010 ;;;###autoload
1012 ;;;###autoload
1014 hebrew-holidays-3 hebrew-holidays-4)
1015 "Jewish holidays.
1016 See the documentation for `calendar-holidays' for details."
1020 ;;;###autoload
1022 ;;;###autoload
1066 "Christian holidays.
1067 See the documentation for `calendar-holidays' for details."
1071 ;;;###autoload
1073 ;;;###autoload
1076 1 1
1101 "Islamic holidays.
1102 See the documentation for `calendar-holidays' for details."
1106 ;;;###autoload
1108 ;;;###autoload
1111 3 21
1143 "Baha'i holidays.
1144 See the documentation for `calendar-holidays' for details."
1148 ;;;###autoload
1150 ;;;###autoload
1156 t)
1158 'holiday-sexp
1159 calendar-daylight-savings-starts
1164 calendar-standard-time-zone-name)
1167 'holiday-sexp
1168 calendar-daylight-savings-ends
1173 calendar-daylight-time-zone-name)
1175 "Sun-related holidays.
1176 See the documentation for `calendar-holidays' for details."
1180 ;;;###autoload
1184 christian-holidays hebrew-holidays islamic-holidays
1185 bahai-holidays oriental-holidays solar-holidays)
1188 Additional holidays are easy to add to the list, just put them in the
1189 list `other-holidays' in your .emacs file. Similarly, by setting any
1190 of `general-holidays', `local-holidays' `christian-holidays',
1191 `hebrew-holidays', `islamic-holidays', `bahai-holidays',
1192 `oriental-holidays', or `solar-holidays' to nil in your .emacs file,
1193 you can eliminate unwanted categories of holidays.
1195 The aforementioned variables control the holiday choices offered
1196 by the function `list-holidays' when it is called interactively.
1198 They are also used to initialize the default value of
1199 `calendar-holidays', which is the default list of holidays used
1200 by the function `list-holidays' in the non-interactive case.
1201 Note that these variables have no effect on `calendar-holidays'
1202 after it has been set (e.g. after the calendar is loaded). In
1203 that case, customize `calendar-holidays' directly.
1205 The intention is that (in the US) `local-holidays' be set in
1206 site-init.el and `other-holidays' be set by the user.
1208 Entries on the list are expressions that return (possibly empty) lists of
1209 items of the form ((month day year) string) of a holiday in the in the
1210 three-month period centered around `displayed-month' of `displayed-year'.
1211 Several basic functions are provided for this purpose:
1213 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
1214 (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in
1215 MONTH on the Gregorian calendar (0 for Sunday,
1216 etc.); K<0 means count back from the end of the
1217 month. An optional parameter DAY means the Kth
1218 DAYNAME after/before MONTH DAY.
1219 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
1220 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
1221 (holiday-bahai MONTH DAY STRING) a fixed date on the Baha'i calendar
1222 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
1223 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
1224 in the variable `year'; if it evaluates to
1225 a visible date, that's the holiday; if it
1226 evaluates to nil, there's no holiday. STRING
1227 is an expression in the variable `date'.
1229 For example, to add Bastille Day, celebrated in France on July 14, add
1233 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
1234 Islands on the fourth Monday in August, add
1238 to the list (the last Monday would be specified with `-1' instead of `4').
1239 To add the last day of Hanukkah to the list, use
1243 since the Hebrew months are numbered with 1 starting from Nisan, while to
1244 add the Islamic feast celebrating Mohammed's birthday use
1248 since the Islamic months are numbered from 1 starting with Muharram. To
1249 add an entry for the Baha'i festival of Ridvan, use
1253 since the Baha'i months are numbered from 1 starting with Baha. To
1254 add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
1258 To include a holiday conditionally, use the sexp form or a conditional. For
1259 example, to include American presidential elections, which occur on the first
1260 Tuesday after the first Monday in November of years divisible by 4, add
1262 (holiday-sexp
1263 '(if (zerop (% year 4))
1264 (calendar-gregorian-from-absolute
1265 (1+ (calendar-dayname-on-or-before
1266 1 (+ 6 (calendar-absolute-from-gregorian
1267 (list 11 1 year)))))))
1270 or
1272 (if (zerop (% displayed-year 4))
1273 (holiday-fixed 11
1274 (extract-calendar-day
1275 (calendar-gregorian-from-absolute
1276 (1+ (calendar-dayname-on-or-before
1277 1 (+ 6 (calendar-absolute-from-gregorian
1278 (list 11 1 displayed-year)))))))
1281 to the list. To include the phases of the moon, add
1283 (lunar-phases)
1285 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
1286 you've written to return a (possibly empty) list of the relevant VISIBLE dates
1287 with descriptive strings such as
1306 "Increment the variables MON and YR by N months.
1307 Forward if N is positive or backward if N is negative.
1308 A negative YR is interpreted as BC; -1 being 1 BC, and so on."
1318 "Return the Nth month after MON/YR.
1319 The return value is a pair (MONTH . YEAR).
1320 MON defaults to `displayed-month'. YR defaults to `displayed-year'."
1327 "Execute a for loop."
1334 "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION."
1341 sum))
1343 ;; The following are in-line for speed; they can be called thousands of times
1344 ;; when looking up holidays or processing the diary. Here, for example, are
1345 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1346 ;; fancy diary display, for a moderately complex diary file, with functions
1347 ;; used instead of macros. There were a total of 10000 such calls:
1348 ;;
1349 ;; 1934 extract-calendar-month
1350 ;; 1852 extract-calendar-year
1351 ;; 1819 extract-calendar-day
1352 ;; 845 calendar-leap-year-p
1353 ;; 837 calendar-day-number
1354 ;; 775 calendar-absolute-from-gregorian
1355 ;; 346 calendar-last-day-of-month
1356 ;; 286 hebrew-calendar-last-day-of-month
1357 ;; 188 hebrew-calendar-leap-year-p
1358 ;; 180 hebrew-calendar-elapsed-days
1359 ;; 163 hebrew-calendar-last-month-of-year
1360 ;; 66 calendar-date-compare
1361 ;; 65 hebrew-calendar-days-in-year
1362 ;; 60 calendar-absolute-from-julian
1363 ;; 50 calendar-absolute-from-hebrew
1364 ;; 43 calendar-date-equal
1365 ;; 38 calendar-gregorian-from-absolute
1366 ;; .
1367 ;; .
1368 ;; .
1369 ;;
1370 ;; The use of these seven macros eliminates the overhead of 92% of the function
1371 ;; calls; it's faster this way.
1374 "Extract the month part of DATE which has the form (month day year)."
1378 "Extract the day part of DATE which has the form (month day year)."
1382 "Extract the year part of DATE which has the form (month day year)."
1386 "Return t if YEAR is a Gregorian leap year.
1387 A negative year is interpreted as BC; -1 being 1 BC, and so on."
1388 ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc.
1394 ;; The foregoing is a bit faster, but not as clear as the following:
1395 ;;
1396 ;;(defsubst calendar-leap-year-p (year)
1397 ;; "Returns t if YEAR is a Gregorian leap year."
1398 ;; (or
1399 ;; (and (= (% year 4) 0)
1400 ;; (/= (% year 100) 0))
1401 ;; (= (% year 400) 0)))
1404 "The last day in MONTH during YEAR."
1406 29
1409 ;; An explanation of the calculation can be found in PascAlgorithms by
1410 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1413 "Return the day number within the year of the date DATE.
1414 For example, (calendar-day-number '(1 1 1987)) returns the value 1,
1415 while (calendar-day-number '(12 31 1980)) returns 366."
1425 day-of-year))
1428 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1429 The Gregorian date Sunday, December 31, 1 BC is imaginary.
1430 DATE is a list of the form (month day year). A negative year is
1431 interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC
1432 return negative results."
1434 offset-years)
1445 ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc).
1455 "Reposition the calendar window so the current date is visible."
1456 t)
1459 "Move the cursor forward ARG months."
1460 t)
1463 "Move the cursor forward by ARG years."
1464 t)
1467 "Move the cursor backward by ARG months."
1468 t)
1471 "Move the cursor backward ARG years."
1472 t)
1475 "Scroll the displayed calendar left by ARG months."
1476 t)
1479 "Scroll the displayed calendar window right by ARG months."
1480 t)
1483 "Scroll the displayed calendar window left by 3*ARG months."
1484 t)
1487 "Scroll the displayed calendar window right by 3*ARG months."
1488 t)
1491 "Move the cursor to the closest date."
1492 t)
1495 "Move the cursor forward ARG days."
1496 t)
1499 "Move the cursor back ARG days."
1500 t)
1503 "Move the cursor forward ARG weeks."
1504 t)
1507 "Move the cursor back ARG weeks."
1508 t)
1511 "Move the cursor back ARG calendar-week-start-day's."
1512 t)
1515 "Move the cursor forward ARG calendar-week-start-day+6's."
1516 t)
1519 "Move the cursor backward ARG month beginnings."
1520 t)
1523 "Move the cursor forward ARG month ends."
1524 t)
1527 "Move the cursor backward ARG year beginnings."
1528 t)
1531 "Move the cursor forward ARG year beginnings."
1532 t)
1535 "Move the cursor to DATE that is on the screen."
1536 t)
1539 "Move cursor to DATE."
1540 t)
1543 "Move cursor to day of year."
1544 t)
1555 ;;;###autoload
1557 "The frame setup of the calendar.
1558 The choices are: `one-frame' (calendar and diary together in one separate,
1559 dedicated frame); `two-frames' (calendar and diary in separate, dedicated
1560 frames); `calendar-only' (calendar in a separate, dedicated frame); with
1561 any other value the current frame is used. Using any of the first
1562 three options overrides the value of `view-diary-entries-initially'."
1571 "Minimum height `generate-calendar-window' should use for calendar window."
1576 ;;;###autoload
1578 "Choose between the one frame, two frame, or basic calendar displays.
1579 If called with an optional prefix argument, prompts for month and year.
1581 The original function `calendar' has been renamed `calendar-basic-setup'.
1582 See the documentation of that function for more information."
1591 "Display a three-month calendar in another window.
1592 The three months appear side by side, with the current month in the middle
1593 surrounded by the previous and next months. The cursor is put on today's date.
1595 If called with an optional prefix argument, prompts for month and year.
1597 This function is suitable for execution in a .emacs file; appropriate setting
1598 of the variable `view-diary-entries-initially' will cause the diary entries for
1599 the current date to be displayed in another window. The value of the variable
1600 `number-of-diary-entries' controls the number of days of diary entries
1601 displayed upon initial display of the calendar.
1603 Once in the calendar window, future or past months can be moved into view.
1604 Arbitrary months can be displayed, or the calendar can be scrolled forward
1605 or backward.
1607 The cursor can be moved forward or backward by one day, one week, one month,
1608 or one year. All of these commands take prefix arguments which, when negative,
1609 cause movement in the opposite direction. For convenience, the digit keys
1610 and the minus sign are automatically prefixes. The window is replotted as
1611 necessary to display the desired date.
1613 Diary entries can be marked on the calendar or displayed in another window.
1617 The Gregorian calendar is assumed.
1619 After loading the calendar, the hooks given by the variable
1620 `calendar-load-hook' are run. This is the place to add key bindings to the
1621 calendar-mode-map.
1623 After preparing the calendar window initially, the hooks given by the variable
1624 `initial-calendar-window-hook' are run.
1626 The hooks given by the variable `today-visible-calendar-hook' are run
1627 every time the calendar window gets scrolled, if the current date is visible
1628 in the window. If it is not visible, the hooks given by the variable
1629 `today-invisible-calendar-hook' are run. Thus, for example, setting
1630 `today-visible-calendar-hook' to 'calendar-star-date will cause today's date
1631 to be replaced by asterisks to highlight it whenever it is in the window."
1655 "Prepare and display a buffer with diary entries.
1656 Searches your diary file for entries that match ARG days starting with
1657 the date indicated by the cursor position in the displayed three-month
1658 calendar."
1659 t)
1662 "Prepare and display buffer of diary entries from an alternative diary file.
1663 Searches for entries that match ARG days, starting with the date indicated
1664 by the cursor position in the displayed three-month calendar.
1665 D-FILE specifies the file to use as the diary file."
1666 t)
1669 "Local time of sunrise and sunset for date under cursor."
1670 t)
1673 "Create a buffer of the phases of the moon for the current calendar window."
1674 t)
1677 "Show the French Revolutionary calendar equivalent of the date under the cursor."
1678 t)
1681 "Move cursor to French Revolutionary date."
1682 t)
1685 "String of French Revolutionary date of Gregorian date."
1686 t)
1689 "String of Mayan date of Gregorian date."
1690 t)
1693 "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor."
1694 t)
1697 "Move cursor to Mayan long count date."
1698 t)
1701 "Move cursor to next instance of Mayan Haab date."
1702 t)
1705 "Move cursor to previous instance of Mayan Haab date."
1706 t)
1709 "Move cursor to next instance of Mayan Tzolkin date."
1710 t)
1713 "Move cursor to previous instance of Mayan Tzolkin date."
1714 t)
1717 "Move cursor to next instance of Mayan Haab/Tzolkin combination."
1718 t)
1721 "Move cursor to previous instance of Mayan Haab/Tzolkin combination."
1722 t)
1725 "Move cursor to Chinese date."
1726 t)
1729 "Show the Chinese date equivalents of date."
1730 t)
1733 "String of Chinese date of Gregorian date."
1734 t)
1737 "Absolute date of astronomical (Julian) day number D."
1738 t )
1744 "String of astronomical (Julian) day number of Gregorian date."
1745 t)
1748 "Move cursor to astronomical (Julian) day number."
1749 t)
1752 "Show the astro date equivalents of date."
1753 t)
1756 "Compute the Julian (month day year) corresponding to the absolute DATE.
1757 The absolute date is the number of days elapsed since the (imaginary)
1761 "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
1762 t)
1765 "Show the Julian calendar equivalent of the date under the cursor."
1766 t)
1769 "String of Julian date of Gregorian DATE.
1770 Defaults to today's date if DATE is not given.
1774 "Move cursor to ISO date."
1775 t)
1778 "Move cursor to start of ISO week."
1779 t)
1782 "Show the ISO date equivalents of date."
1783 t)
1786 "String of ISO date of Gregorian date."
1787 t)
1790 "Move cursor to Islamic date."
1791 t)
1794 "Show the Islamic date equivalents of date."
1795 t)
1798 "String of Islamic date of Gregorian date."
1799 t)
1802 "Show the Baha'i date equivalents of date."
1803 t)
1806 "String of Baha'i date of Gregorian date."
1807 t)
1810 "Move cursor to Hebrew date."
1811 t)
1814 "Show the Hebrew date equivalents of date."
1815 t)
1818 "String of Hebrew date of Gregorian date."
1819 t)
1822 "Move cursor to Coptic date."
1823 t)
1826 "Show the Coptic date equivalents of date."
1827 t)
1830 "String of Coptic date of Gregorian date."
1831 t)
1834 "Move cursor to Ethiopic date."
1835 t)
1838 "Show the Ethiopic date equivalents of date."
1839 t)
1842 "String of Ethiopic date of Gregorian date."
1843 t)
1846 "Move cursor to Persian date."
1847 t)
1850 "Show the Persian date equivalents of date."
1851 t)
1854 "String of Persian date of Gregorian date."
1855 t)
1858 "Show all of the diary entries in the diary file.
1859 This function gets rid of the selective display of the diary file so that
1860 all entries, not just some, are visible. If there is no diary buffer, one
1861 is created."
1862 t)
1865 "Mark days in the calendar window that have diary entries.
1866 Each entry in diary file visible in the calendar window is marked."
1867 t)
1870 "Insert a diary entry STRING which may be NONMARKING in FILE."
1871 t)
1874 "Insert a diary entry for the date indicated by point."
1875 t)
1878 "Insert a weekly diary entry for the day of the week indicated by point."
1879 t)
1883 "Insert a monthly diary entry for the day of the month indicated by point."
1884 t)
1887 "Insert an annual diary entry for the day of the year indicated by point."
1888 t)
1891 "Insert an anniversary diary entry for the date indicated by point."
1892 t)
1895 "Insert a block diary entry for the dates indicated by point and mark."
1896 t)
1899 "Insert a cyclic diary entry starting at the date indicated by point."
1900 t)
1903 "Insert a diary entry for the Hebrew date corresponding to the date
1904 indicated by point."
1905 t)
1908 "Insert a monthly diary entry for the day of the Hebrew month corresponding
1909 to the date indicated by point."
1910 t)
1913 "Insert an annual diary entry for the day of the Hebrew year corresponding
1914 to the date indicated by point."
1915 t)
1918 "Insert a diary entry for the Islamic date corresponding to the date
1919 indicated by point."
1920 t)
1923 "Insert a monthly diary entry for the day of the Islamic month corresponding
1924 to the date indicated by point."
1925 t)
1928 "Insert an annual diary entry for the day of the Islamic year corresponding
1929 to the date indicated by point."
1930 t)
1933 "Insert a diary entry for the Baha'i date corresponding to the date
1934 indicated by point."
1935 t)
1938 "Insert a monthly diary entry for the day of the Baha'i month corresponding
1939 to the date indicated by point."
1940 t)
1943 "Insert an annual diary entry for the day of the Baha'i year corresponding
1944 to the date indicated by point."
1945 t)
1948 "Create a buffer containing the holidays for the current calendar window.
1949 The holidays are those in the list `calendar-notable-days'. Returns t if any
1950 holidays are found, nil if not."
1951 t)
1954 "Make a buffer with LaTeX commands for the month cursor is on.
1955 Optional prefix argument specifies number of months to be produced.
1959 "Make a buffer with LaTeX commands for the month cursor is on.
1966 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1967 It applies to the week that point is in.
1968 Optional prefix argument specifies number of weeks.
1972 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1973 It applies to the week that point is in.
1974 Optional prefix argument specifies number of weeks.
1978 "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar.
1979 Optional prefix argument specifies number of weeks.
1980 Diary entries are included if `cal-tex-diary' is t.
1984 "Make a buffer with LaTeX commands for a two-page one-week calendar.
1985 It applies to the week that point is in, and starts on Monday.
1986 Optional prefix argument specifies number of weeks.
1990 "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor.
1991 Optional prefix argument specifies number of weeks.
1992 Diary entries are included if cal-tex-diary is t.
1996 "One-week-at-a-glance Filofax style calendar for week indicated by cursor.
1997 Optional prefix argument specifies number of weeks.
1998 Weeks start on Monday.
1999 Diary entries are included if cal-tex-diary is t.
2003 "Day-per-page Filofax style calendar for week indicated by cursor.
2004 Optional prefix argument specifies number of weeks. Weeks start on Monday.
2005 Diary entries are included if `cal-tex-diary' is t.
2009 "Make a buffer with LaTeX commands for a year's calendar.
2013 "Make a buffer with LaTeX commands for a year's calendar (landscape).
2017 "Make a buffer with LaTeX commands for a year's calendar (Filofax).
2021 "Mark notable days in the calendar window."
2022 t)
2025 "Find holidays for the date specified by the cursor in the calendar window."
2026 t)
2029 "Generate the calendar window for the current date.
2030 Or, for optional MON, YR."
2050 ;; Don't do any window-related stuff if we weren't called from a
2051 ;; window displaying the calendar
2054 ;; Don't mess with the window size, but ensure that the first
2055 ;; line is fully visible
2057 ;; Adjust the window to exactly fit the displayed calendar
2061 font-lock-mode)
2064 ;;; (calendar-date-is-legal-p today) ; useful for BC dates
2074 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
2075 ;;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on.
2076 ;;; Note that while calendars for years BC could be displayed as it
2077 ;;; stands, almost all other calendar functions (eg holidays) would
2078 ;;; at best have unpredictable results for such dates.
2082 displayed-year year)
2090 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
2091 The calendar is inserted at the top of the buffer in which point is currently
2092 located, but indented INDENT spaces. The indentation is done from the first
2093 character on the line and does not disturb the first INDENT characters on the
2094 line."
2098 calendar-week-start-day)
2105 indent t)
2107 ;; Use the first two characters of each day to head the columns.
2118 ;; Add blank days before the first of the month
2120 ;; Put in the days of the month
2133 "Insert STRING at column INDENT.
2134 If the optional parameter NEWLINE is t, leave point at start of next line,
2135 inserting a newline if there was no next line; otherwise, leave point after
2136 the inserted text. Value is always t."
2137 ;; Try to move to that column.
2139 ;; If line is too short, indent out to that column.
2143 ;; Advance to next line, if requested.
2150 t)
2153 "Redraw the calendar display, if `calendar-buffer' is live."
2161 ;;;###autoload
2163 "The day of the week on which a week in the calendar begins.
2164 0 means Sunday (default), 1 means Monday, and so on.
2166 If you change this variable directly (without using customize)
2167 after starting `calendar', you should call `redraw-calendar' to
2168 update the calendar display to reflect the change, otherwise
2169 movement commands will not work correctly."
2171 ;; Change the initialize so that if you reload calendar.el, it will not
2172 ;; cause a redraw (which may fail, e.g. with "invalid byte-code in
2173 ;; calendar.elc" because of the "byte-compile-dynamic").
2181 "Turn debugging on when evaluating a sexp in the diary or holiday list."
2187 nil
2191 mark-defun mark-whole-buffer mark-page
2192 downcase-region upcase-region kill-region
2193 copy-region-as-kill capitalize-region write-region))
2198 (define-key map "\ev" 'scroll-calendar-right-three-months)
2199 (define-key map "<" 'scroll-calendar-left)
2200 (define-key map "\C-x<" 'scroll-calendar-left)
2201 (define-key map [next] 'scroll-calendar-left-three-months)
2202 (define-key map "\C-v" 'scroll-calendar-left-three-months)
2203 (define-key map "\C-b" 'calendar-backward-day)
2204 (define-key map "\C-p" 'calendar-backward-week)
2205 (define-key map "\e{" 'calendar-backward-month)
2206 (define-key map "\C-x[" 'calendar-backward-year)
2207 (define-key map "\C-f" 'calendar-forward-day)
2208 (define-key map "\C-n" 'calendar-forward-week)
2209 (define-key map [left] 'calendar-backward-day)
2210 (define-key map [up] 'calendar-backward-week)
2211 (define-key map [right] 'calendar-forward-day)
2212 (define-key map [down] 'calendar-forward-week)
2213 (define-key map "\e}" 'calendar-forward-month)
2214 (define-key map "\C-x]" 'calendar-forward-year)
2215 (define-key map "\C-a" 'calendar-beginning-of-week)
2216 (define-key map "\C-e" 'calendar-end-of-week)
2217 (define-key map "\ea" 'calendar-beginning-of-month)
2218 (define-key map "\ee" 'calendar-end-of-month)
2219 (define-key map "\e<" 'calendar-beginning-of-year)
2220 (define-key map "\e>" 'calendar-end-of-year)
2221 (define-key map "\C-@" 'calendar-set-mark)
2222 ;; Many people are used to typing C-SPC and getting C-@.
2223 (define-key map [?\C- ] 'calendar-set-mark)
2224 (define-key map "\C-x\C-x" 'calendar-exchange-point-and-mark)
2225 (define-key map "\e=" 'calendar-count-days-region)
2226 (define-key map "gd" 'calendar-goto-date)
2227 (define-key map "gD" 'calendar-goto-day-of-year)
2228 (define-key map "gj" 'calendar-goto-julian-date)
2229 (define-key map "ga" 'calendar-goto-astro-day-number)
2230 (define-key map "gh" 'calendar-goto-hebrew-date)
2231 (define-key map "gi" 'calendar-goto-islamic-date)
2232 (define-key map "gb" 'calendar-goto-bahai-date)
2233 (define-key map "gC" 'calendar-goto-chinese-date)
2234 (define-key map "gk" 'calendar-goto-coptic-date)
2235 (define-key map "ge" 'calendar-goto-ethiopic-date)
2236 (define-key map "gp" 'calendar-goto-persian-date)
2237 (define-key map "gc" 'calendar-goto-iso-date)
2238 (define-key map "gw" 'calendar-goto-iso-week)
2239 (define-key map "gf" 'calendar-goto-french-date)
2240 (define-key map "gml" 'calendar-goto-mayan-long-count-date)
2241 (define-key map "gmpc" 'calendar-previous-calendar-round-date)
2242 (define-key map "gmnc" 'calendar-next-calendar-round-date)
2243 (define-key map "gmph" 'calendar-previous-haab-date)
2244 (define-key map "gmnh" 'calendar-next-haab-date)
2245 (define-key map "gmpt" 'calendar-previous-tzolkin-date)
2246 (define-key map "gmnt" 'calendar-next-tzolkin-date)
2247 (define-key map "Aa" 'appt-add)
2248 (define-key map "Ad" 'appt-delete)
2249 (define-key map "S" 'calendar-sunrise-sunset)
2250 (define-key map "M" 'calendar-phases-of-moon)
2251 (define-key map " " 'scroll-other-window)
2252 (define-key map (kbd "DEL") 'scroll-other-window-down)
2253 (define-key map "\C-c\C-l" 'redraw-calendar)
2254 (define-key map "." 'calendar-goto-today)
2255 (define-key map "o" 'calendar-other-month)
2256 (define-key map "q" 'exit-calendar)
2257 (define-key map "a" 'list-calendar-holidays)
2258 (define-key map "h" 'calendar-cursor-holidays)
2259 (define-key map "x" 'mark-calendar-holidays)
2260 (define-key map "u" 'calendar-unmark)
2261 (define-key map "m" 'mark-diary-entries)
2262 (define-key map "d" 'diary-view-entries)
2263 (define-key map "D" 'view-other-diary-entries)
2264 (define-key map "s" 'show-all-diary-entries)
2265 (define-key map "pd" 'calendar-print-day-of-year)
2266 (define-key map "pC" 'calendar-print-chinese-date)
2267 (define-key map "pk" 'calendar-print-coptic-date)
2268 (define-key map "pe" 'calendar-print-ethiopic-date)
2269 (define-key map "pp" 'calendar-print-persian-date)
2270 (define-key map "pc" 'calendar-print-iso-date)
2271 (define-key map "pj" 'calendar-print-julian-date)
2272 (define-key map "pa" 'calendar-print-astro-day-number)
2273 (define-key map "ph" 'calendar-print-hebrew-date)
2274 (define-key map "pi" 'calendar-print-islamic-date)
2275 (define-key map "pb" 'calendar-print-bahai-date)
2276 (define-key map "pf" 'calendar-print-french-date)
2277 (define-key map "pm" 'calendar-print-mayan-date)
2278 (define-key map "po" 'calendar-print-other-dates)
2279 (define-key map "id" 'insert-diary-entry)
2280 (define-key map "iw" 'insert-weekly-diary-entry)
2281 (define-key map "im" 'insert-monthly-diary-entry)
2282 (define-key map "iy" 'insert-yearly-diary-entry)
2283 (define-key map "ia" 'insert-anniversary-diary-entry)
2284 (define-key map "ib" 'insert-block-diary-entry)
2285 (define-key map "ic" 'insert-cyclic-diary-entry)
2286 (define-key map "ihd" 'insert-hebrew-diary-entry)
2287 (define-key map "ihm" 'insert-monthly-hebrew-diary-entry)
2288 (define-key map "ihy" 'insert-yearly-hebrew-diary-entry)
2289 (define-key map "iid" 'insert-islamic-diary-entry)
2290 (define-key map "iim" 'insert-monthly-islamic-diary-entry)
2291 (define-key map "iiy" 'insert-yearly-islamic-diary-entry)
2292 (define-key map "iBd" 'insert-bahai-diary-entry)
2293 (define-key map "iBm" 'insert-monthly-bahai-diary-entry)
2294 (define-key map "iBy" 'insert-yearly-bahai-diary-entry)
2295 (define-key map "?" 'calendar-goto-info-node)
2296 (define-key map "tm" 'cal-tex-cursor-month)
2297 (define-key map "tM" 'cal-tex-cursor-month-landscape)
2298 (define-key map "td" 'cal-tex-cursor-day)
2299 (define-key map "tw1" 'cal-tex-cursor-week)
2300 (define-key map "tw2" 'cal-tex-cursor-week2)
2301 (define-key map "tw3" 'cal-tex-cursor-week-iso)
2302 (define-key map "tw4" 'cal-tex-cursor-week-monday)
2303 (define-key map "tfd" 'cal-tex-cursor-filofax-daily)
2304 (define-key map "tfw" 'cal-tex-cursor-filofax-2week)
2305 (define-key map "tfW" 'cal-tex-cursor-filofax-week)
2306 (define-key map "tfy" 'cal-tex-cursor-filofax-year)
2307 (define-key map "ty" 'cal-tex-cursor-year)
2308 (define-key map "tY" 'cal-tex-cursor-year-landscape)
2309 (setq calendar-mode-map map)
2310 ;; Require cal-menu after initializing calendar-mode-map because it uses it.
2311 (require 'cal-menu)))
2313 (defun describe-calendar-mode ()
2314 "Create a help buffer with a brief description of the `calendar-mode'."
2315 (interactive)
2316 (help-setup-xref (list #'describe-calendar-mode) (interactive-p))
2317 (with-output-to-temp-buffer (help-buffer)
2318 (princ
2319 (format
2321 (substitute-command-keys
2324 (print-help-return-message)))
2326 ;; Calendar mode is suitable only for specially formatted data.
2327 (put 'calendar-mode 'mode-class 'special)
2329 (defvar calendar-mode-line-format
2330 (list
2331 (propertize (substitute-command-keys
2333 'help-echo "mouse-2: scroll left"
2334 'mouse-face 'mode-line-highlight
2335 'keymap (make-mode-line-mouse-map 'mouse-2
2336 'mouse-scroll-calendar-left))
2337 "Calendar"
2338 (concat
2339 (propertize
2340 (substitute-command-keys
2342 'help-echo "mouse-2: read Info on Calendar"
2343 'mouse-face 'mode-line-highlight
2344 'keymap (make-mode-line-mouse-map 'mouse-2 'calendar-goto-info-node))
2345 "/"
2346 (propertize
2347 (substitute-command-keys
2349 'help-echo "mouse-2: choose another month"
2350 'mouse-face 'mode-line-highlight
2351 'keymap (make-mode-line-mouse-map
2352 'mouse-2 'mouse-calendar-other-month))
2353 "/"
2354 (propertize
2355 (substitute-command-keys
2357 'help-echo "mouse-2: go to today's date"
2358 'mouse-face 'mode-line-highlight
2359 'keymap (make-mode-line-mouse-map 'mouse-2 #'calendar-goto-today)))
2360 '(calendar-date-string (calendar-current-date) t)
2361 (propertize (substitute-command-keys
2363 'help-echo "mouse-2: scroll right"
2364 'mouse-face 'mode-line-highlight
2365 'keymap (make-mode-line-mouse-map
2366 'mouse-2 'mouse-scroll-calendar-right)))
2367 "The mode line of the calendar buffer.
2369 This must be a list of items that evaluate to strings--those strings are
2370 evaluated and concatenated together, evenly separated by blanks. The variable
2371 `date' is available for use as the date under (or near) the cursor; `date'
2372 defaults to the current date if it is otherwise undefined. Here is an example
2373 value that has the Hebrew date, the day number/days remaining in the year,
2374 and the ISO week/year numbers in the mode. When calendar-move-hook is set to
2375 'update-calendar-mode-line, these mode line shows these values for the date
2376 under the cursor:
2378 (list
2379 \"\"
2380 '(calendar-hebrew-date-string date)
2381 '(let* ((year (extract-calendar-year date))
2382 (d (calendar-day-number date))
2383 (days-remaining
2384 (- (calendar-day-number (list 12 31 year)) d)))
2386 '(let* ((d (calendar-absolute-from-gregorian date))
2387 (iso-date (calendar-iso-from-absolute d)))
2389 (extract-calendar-month iso-date)
2390 (extract-calendar-year iso-date)))
2392 ")
2394 (defun mouse-scroll-calendar-left (event)
2395 "Scroll the displayed calendar left by one month.
2396 Maintains the relative position of the cursor
2397 with respect to the calendar as well as possible."
2398 (interactive "e")
2399 (save-selected-window
2400 (select-window (posn-window (event-start event)))
2401 (scroll-calendar-left 1)))
2403 (defun mouse-scroll-calendar-right (event)
2404 "Scroll the displayed calendar right by one month.
2405 Maintains the relative position of the cursor
2406 with respect to the calendar as well as possible."
2407 (interactive "e")
2408 (save-selected-window
2409 (select-window (posn-window (event-start event)))
2410 (scroll-calendar-right 1)))
2412 (defun mouse-calendar-other-month (event)
2413 "Display a three-month calendar centered around a specified month and year."
2414 (interactive "e")
2415 (save-selected-window
2416 (select-window (posn-window (event-start event)))
2417 (call-interactively 'calendar-other-month)))
2419 (defun calendar-goto-info-node ()
2420 "Go to the info node for the calendar."
2421 (interactive)
2422 (require 'info)
2423 (let ((where (save-window-excursion
2424 (Info-find-emacs-command-nodes 'calendar))))
2425 (if (not where)
2426 (error "Couldn't find documentation for the calendar")
2427 (let (same-window-buffer-names)
2428 (info))
2429 (Info-find-node (car (car where)) (car (cdr (car where)))))))
2433 (defun calendar-mode ()
2434 "A major mode for the calendar window.
2436 For a complete description, type \
2440 (kill-all-local-variables)
2441 (setq major-mode 'calendar-mode)
2442 (setq mode-name "Calendar")
2443 (use-local-map calendar-mode-map)
2444 (setq buffer-read-only t)
2445 (setq indent-tabs-mode nil)
2446 (update-calendar-mode-line)
2447 (add-hook 'activate-menubar-hook 'cal-menu-update nil t)
2448 (make-local-variable 'calendar-mark-ring)
2449 (make-local-variable 'displayed-month);; Month in middle of window.
2450 (make-local-variable 'displayed-year) ;; Year in middle of window.
2451 (set (make-local-variable 'font-lock-defaults)
2452 '(calendar-font-lock-keywords t))
2453 (run-mode-hooks 'calendar-mode-hook))
2455 (defun calendar-string-spread (strings char length)
2456 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
2457 The effect is like mapconcat but the separating pieces are as balanced as
2458 possible. Each item of STRINGS is evaluated before concatenation so it can
2459 actually be an expression that evaluates to a string. If LENGTH is too short,
2460 the STRINGS are just concatenated and the result truncated."
2461 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
2462 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
2463 ;; Addison-Wesley, Reading, MA, 1989
2464 (let* ((strings (mapcar 'eval
2465 (if (< (length strings) 2)
2466 (append (list "") strings (list ""))
2467 strings)))
2468 (n (- length (length (apply 'concat strings))))
2469 (m (1- (length strings)))
2470 (s (car strings))
2471 (strings (cdr strings))
2472 (i 0))
2473 (dolist (string strings)
2474 (setq s (concat s
2475 (make-string (max 0 (/ (+ n i) m)) char)
2476 string))
2477 (setq i (1+ i)))
2478 (substring s 0 length)))
2480 (defun update-calendar-mode-line ()
2481 "Update the calendar mode line with the current date and date style."
2482 (if (bufferp (get-buffer calendar-buffer))
2483 (with-current-buffer calendar-buffer
2484 (setq mode-line-format
2485 (calendar-string-spread
2486 (let ((date (condition-case nil
2487 (calendar-cursor-to-nearest-date)
2488 (error (calendar-current-date)))))
2489 (mapcar 'eval calendar-mode-line-format))
2490 ? (frame-width)))
2491 (force-mode-line-update))))
2493 (defun calendar-window-list ()
2494 "List of all calendar-related windows."
2495 (let ((calendar-buffers (calendar-buffer-list))
2496 list)
2497 (walk-windows (lambda (w)
2498 (if (memq (window-buffer w) calendar-buffers)
2499 (push w list)))
2500 nil t)
2501 list))
2503 (defun calendar-buffer-list ()
2504 "List of all calendar-related buffers."
2505 (let* ((diary-buffer (get-file-buffer diary-file))
2506 (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer
2507 fancy-diary-buffer diary-buffer calendar-buffer
2508 other-calendars-buffer))
2509 (buffer-list nil))
2510 (dolist (b buffers)
2511 (setq b (cond ((stringp b) (get-buffer b))
2512 ((bufferp b) b)
2513 (t nil)))
2514 (if b (push b buffer-list)))
2515 buffer-list))
2517 (defun exit-calendar ()
2518 "Get out of the calendar window and hide it and related buffers."
2519 (interactive)
2520 (let* ((diary-buffer (get-file-buffer diary-file)))
2521 (if (or (not diary-buffer)
2522 (not (buffer-modified-p diary-buffer))
2523 (yes-or-no-p
2524 "Diary modified; do you really want to exit the calendar? "))
2525 ;; Need to do this multiple times because one time can replace some
2526 ;; calendar-related buffers with other calendar-related buffers
2527 (mapcar (lambda (x)
2528 (mapcar 'calendar-hide-window (calendar-window-list)))
2529 (calendar-window-list)))))
2531 (defun calendar-hide-window (window)
2532 "Hide WINDOW if it is calendar-related."
2533 (let ((buffer (if (window-live-p window) (window-buffer window))))
2534 (if (memq buffer (calendar-buffer-list))
2535 (cond
2536 ((and (display-multi-frame-p)
2537 (eq 'icon (cdr (assoc 'visibility
2538 (frame-parameters
2539 (window-frame window))))))
2540 nil)
2541 ((and (display-multi-frame-p) (window-dedicated-p window))
2542 (if calendar-remove-frame-by-deleting
2543 (delete-frame (window-frame window))
2544 (iconify-frame (window-frame window))))
2545 ((not (and (select-window window) (one-window-p window)))
2546 (delete-window window))
2547 (t (set-buffer buffer)
2548 (bury-buffer))))))
2550 (defun calendar-current-date ()
2551 "Return the current date in a list (month day year)."
2552 (let ((now (decode-time)))
2553 (list (nth 4 now) (nth 3 now) (nth 5 now))))
2555 (defun calendar-cursor-to-date (&optional error)
2556 "Return a list (month day year) of current cursor position.
2557 If cursor is not on a specific date, signals an error if optional parameter
2558 ERROR is t, otherwise just returns nil."
2559 (let* ((segment (/ (current-column) 25))
2560 (month (% (+ displayed-month segment -1) 12))
2561 (month (if (= 0 month) 12 month))
2562 (year
2563 (cond
2564 ((and (= 12 month) (= segment 0)) (1- displayed-year))
2565 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
2566 (t displayed-year))))
2567 (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
2568 (< 2 (count-lines (point-min) (point))))
2569 (save-excursion
2570 (if (not (looking-at " "))
2571 (re-search-backward "[^0-9]"))
2572 (list month
2573 (string-to-number (buffer-substring (1+ (point)) (+ 4 (point))))
2574 year))
2576 (save-excursion
2577 (re-search-backward "[^*]")
2579 (list month calendar-starred-day year)
2580 (if error (error "Not on a date!"))))))
2582 (add-to-list 'debug-ignored-errors "Not on a date!")
2584 ;; The following version of calendar-gregorian-from-absolute is preferred for
2585 ;; reasons of clarity, BUT it's much slower than the version that follows it.
2587 ;;(defun calendar-gregorian-from-absolute (date)
2588 ;; "Compute the list (month day year) corresponding to the absolute DATE.
2589 ;;The absolute date is the number of days elapsed since the (imaginary)
2590 ;;Gregorian date Sunday, December 31, 1 BC."
2591 ;; (let* ((approx (/ date 366));; Approximation from below.
2592 ;; (year ;; Search forward from the approximation.
2593 ;; (+ approx
2594 ;; (calendar-sum y approx
2595 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
2596 ;; 1)))
2597 ;; (month ;; Search forward from January.
2598 ;; (1+ (calendar-sum m 1
2599 ;; (> date
2600 ;; (calendar-absolute-from-gregorian
2601 ;; (list m (calendar-last-day-of-month m year) year)))
2602 ;; 1)))
2603 ;; (day ;; Calculate the day by subtraction.
2604 ;; (- date
2605 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
2606 ;; (list month day year)))
2608 (defun calendar-gregorian-from-absolute (date)
2609 "Compute the list (month day year) corresponding to the absolute DATE.
2610 The absolute date is the number of days elapsed since the (imaginary)
2611 Gregorian date Sunday, December 31, 1 BC. This function does not
2612 handle dates in years BC."
2613 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
2614 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
2615 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
2616 ;; (April, 1993), pages 383-404 for an explanation.
2617 (let* ((d0 (1- date))
2618 (n400 (/ d0 146097))
2619 (d1 (% d0 146097))
2620 (n100 (/ d1 36524))
2621 (d2 (% d1 36524))
2622 (n4 (/ d2 1461))
2623 (d3 (% d2 1461))
2624 (n1 (/ d3 365))
2625 (day (1+ (% d3 365)))
2626 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1)))
2627 (if (or (= n100 4) (= n1 4))
2628 (list 12 31 year)
2629 (let ((year (1+ year))
2630 (month 1))
2631 (while (let ((mdays (calendar-last-day-of-month month year)))
2632 (and (< mdays day)
2633 (setq day (- day mdays))))
2634 (setq month (1+ month)))
2635 (list month day year)))))
2637 (defun calendar-other-month (month year)
2638 "Display a three-month calendar centered around MONTH and YEAR."
2639 (interactive (calendar-read-date 'noday))
2640 (if (and (= month displayed-month)
2641 (= year displayed-year))
2642 nil
2643 (let ((old-date (calendar-cursor-to-date))
2644 (today (calendar-current-date)))
2645 (generate-calendar-window month year)
2646 (calendar-cursor-to-visible-date
2647 (cond
2648 ((calendar-date-is-visible-p old-date) old-date)
2649 ((calendar-date-is-visible-p today) today)
2650 (t (list month 1 year)))))))
2652 (defun calendar-set-mark (arg)
2653 "Mark the date under the cursor, or jump to marked date.
2654 With no prefix argument, push current date onto marked date ring.
2655 With argument, jump to mark, pop it, and put point at end of ring."
2656 (interactive "P")
2657 (let ((date (calendar-cursor-to-date t)))
2658 (if (null arg)
2659 (progn
2660 (push date calendar-mark-ring)
2661 ;; Since the top of the mark ring is the marked date in the
2662 ;; calendar, the mark ring in the calendar is one longer than
2663 ;; in other buffers to get the same effect.
2664 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
2665 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
2666 (message "Mark set"))
2667 (if (null calendar-mark-ring)
2668 (error "No mark set in this buffer")
2669 (calendar-goto-date (car calendar-mark-ring))
2670 (setq calendar-mark-ring
2671 (cdr (nconc calendar-mark-ring (list date))))))))
2673 (defun calendar-exchange-point-and-mark ()
2674 "Exchange the current cursor position with the marked date."
2675 (interactive)
2676 (let ((mark (car calendar-mark-ring))
2677 (date (calendar-cursor-to-date t)))
2678 (if (null mark)
2679 (error "No mark set in this buffer")
2680 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
2681 (calendar-goto-date mark))))
2683 (defun calendar-count-days-region ()
2684 "Count the number of days (inclusive) between point and the mark."
2685 (interactive)
2686 (let* ((days (- (calendar-absolute-from-gregorian
2687 (calendar-cursor-to-date t))
2688 (calendar-absolute-from-gregorian
2689 (or (car calendar-mark-ring)
2690 (error "No mark set in this buffer")))))
2691 (days (1+ (if (> days 0) days (- days)))))
2692 (message "Region has %d day%s (inclusive)"
2693 days (if (> days 1) "s" ""))))
2695 (defun calendar-not-implemented ()
2696 "Not implemented."
2697 (interactive)
2698 (error "%s not available in the calendar"
2699 (global-key-binding (this-command-keys))))
2701 (defun calendar-read (prompt acceptable &optional initial-contents)
2702 "Return an object read from the minibuffer.
2703 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2704 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2705 is a string to insert in the minibuffer before reading."
2706 (let ((value (read-minibuffer prompt initial-contents)))
2707 (while (not (funcall acceptable value))
2708 (setq value (read-minibuffer prompt initial-contents)))
2709 value))
2711 (defun calendar-read-date (&optional noday)
2712 "Prompt for Gregorian date. Return a list (month day year).
2713 If optional NODAY is t, does not ask for day, but just returns
2714 \(month nil year); if NODAY is any other non-nil value the value returned is
2715 \(month year)"
2716 (let* ((year (calendar-read
2717 "Year (>0): "
2718 (lambda (x) (> x 0))
2719 (int-to-string (extract-calendar-year
2720 (calendar-current-date)))))
2721 (month-array calendar-month-name-array)
2722 (completion-ignore-case t)
2723 (month (cdr (assoc-string
2724 (completing-read
2725 "Month name: "
2726 (mapcar 'list (append month-array nil))
2727 nil t)
2728 (calendar-make-alist month-array 1) t)))
2729 (last (calendar-last-day-of-month month year)))
2730 (if noday
2731 (if (eq noday t)
2732 (list month nil year)
2733 (list month year))
2734 (list month
2735 (calendar-read (format "Day (1-%d): " last)
2736 (lambda (x) (and (< 0 x) (<= x last))))
2737 year))))
2739 (defun calendar-interval (mon1 yr1 mon2 yr2)
2740 "The number of months difference between MON1, YR1 and MON2, YR2.
2741 The result is positive if the second date is later than the first.
2742 Negative years are interpreted as years BC; -1 being 1 BC, and so on."
2743 (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc
2744 (if (< yr2 0) (setq yr2 (1+ yr2)))
2745 (+ (* 12 (- yr2 yr1))
2746 (- mon2 mon1)))
2748 (defvar calendar-abbrev-length 3
2749 "*Length of abbreviations to be used for day and month names.
2750 See also `calendar-day-abbrev-array' and `calendar-month-abbrev-array'.")
2752 (defvar calendar-day-name-array
2753 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2754 "*Array of capitalized strings giving, in order, the day names.
2755 The first two characters of each string will be used to head the
2756 day columns in the calendar. See also the variable
2757 `calendar-day-abbrev-array'.")
2759 (defvar calendar-day-abbrev-array
2760 [nil nil nil nil nil nil nil]
2761 "*Array of capitalized strings giving the abbreviated day names.
2762 The order should be the same as that of the full names specified
2763 in `calendar-day-name-array'. These abbreviations may be used
2764 instead of the full names in the diary file. Do not include a
2765 trailing `.' in the strings specified in this variable, though
2766 you may use such in the diary file. If any element of this array
2767 is nil, then the abbreviation will be constructed as the first
2768 `calendar-abbrev-length' characters of the corresponding full name.")
2770 (defvar calendar-month-name-array
2771 ["January" "February" "March" "April" "May" "June"
2772 "July" "August" "September" "October" "November" "December"]
2773 "*Array of capitalized strings giving, in order, the month names.
2774 See also the variable `calendar-month-abbrev-array'.")
2776 (defvar calendar-month-abbrev-array
2777 [nil nil nil nil nil nil nil nil nil nil nil nil]
2778 "*Array of capitalized strings giving the abbreviated month names.
2779 The order should be the same as that of the full names specified
2780 in `calendar-month-name-array'. These abbreviations are used in
2781 the calendar menu entries, and can also be used in the diary
2782 file. Do not include a trailing `.' in the strings specified in
2783 this variable, though you may use such in the diary file. If any
2784 element of this array is nil, then the abbreviation will be
2785 constructed as the first `calendar-abbrev-length' characters of the
2786 corresponding full name.")
2788 (defun calendar-abbrev-construct (abbrev full &optional period)
2789 "Internal calendar function to return a complete abbreviation array.
2790 ABBREV is an array of abbreviations, FULL the corresponding array
2791 of full names. The return value is the ABBREV array, with any nil
2792 elements replaced by the first three characters taken from the
2793 corresponding element of FULL. If optional argument PERIOD is non-nil,
2794 each element returned has a final `.' character."
2795 (let (elem array name)
2796 (dotimes (i (length full))
2797 (setq name (aref full i)
2798 elem (or (aref abbrev i)
2799 (substring name 0
2800 (min calendar-abbrev-length (length name))))
2801 elem (format "%s%s" elem (if period "." ""))
2802 array (append array (list elem))))
2803 (vconcat array)))
2805 (defvar calendar-font-lock-keywords
2806 `((,(concat (regexp-opt (mapcar 'identity calendar-month-name-array) t)
2807 " -?[0-9]+")
2808 . font-lock-function-name-face) ; month and year
2809 (,(regexp-opt
2810 (list (substring (aref calendar-day-name-array 6) 0 2)
2811 (substring (aref calendar-day-name-array 0) 0 2)))
2812 ;; Saturdays and Sundays are hilited differently.
2813 . font-lock-comment-face)
2814 ;; First two chars of each day are used in the calendar.
2815 (,(regexp-opt (mapcar (lambda (x) (substring x 0 2)) calendar-day-name-array))
2816 . font-lock-reference-face))
2817 "Default keywords to highlight in Calendar mode.")
2819 (defun calendar-day-name (date &optional abbrev absolute)
2820 "Return a string with the name of the day of the week of DATE.
2821 DATE should be a list in the format (MONTH DAY YEAR), unless the
2822 optional argument ABSOLUTE is non-nil, in which case DATE should
2823 be an integer in the range 0 to 6 corresponding to the day of the
2824 week. Day names are taken from the variable `calendar-day-name-array',
2825 unless the optional argument ABBREV is non-nil, in which case
2826 the variable `calendar-day-abbrev-array' is used."
2827 (aref (if abbrev
2828 (calendar-abbrev-construct calendar-day-abbrev-array
2829 calendar-day-name-array)
2830 calendar-day-name-array)
2831 (if absolute date (calendar-day-of-week date))))
2833 (defun calendar-make-alist (sequence &optional start-index filter abbrevs)
2834 "Make an assoc list corresponding to SEQUENCE.
2835 Each element of sequence will be associated with an integer, starting
2836 from 1, or from START-INDEX if that is non-nil. If a sequence ABBREVS
2837 is supplied, the function `calendar-abbrev-construct' is used to
2838 construct abbreviations corresponding to the elements in SEQUENCE.
2839 Each abbreviation is entered into the alist with the same
2840 association index as the full name it represents.
2841 If FILTER is provided, apply it to each key in the alist."
2842 (let ((index 0)
2843 (offset (or start-index 1))
2844 (aseq (if abbrevs (calendar-abbrev-construct abbrevs sequence)))
2845 (aseqp (if abbrevs (calendar-abbrev-construct abbrevs sequence
2846 'period)))
2847 alist elem)
2848 (dotimes (i (length sequence) (reverse alist))
2849 (setq index (+ i offset)
2850 elem (elt sequence i)
2851 alist
2852 (cons (cons (if filter (funcall filter elem) elem) index) alist))
2853 (if aseq
2854 (setq elem (elt aseq i)
2855 alist (cons (cons (if filter (funcall filter elem) elem)
2856 index) alist)))
2857 (if aseqp
2858 (setq elem (elt aseqp i)
2859 alist (cons (cons (if filter (funcall filter elem) elem)
2860 index) alist))))))
2862 (defun calendar-month-name (month &optional abbrev)
2863 "Return a string with the name of month number MONTH.
2864 Months are numbered from one. Month names are taken from the
2865 variable `calendar-month-name-array', unless the optional
2866 argument ABBREV is non-nil, in which case
2867 `calendar-month-abbrev-array' is used."
2868 (aref (if abbrev
2869 (calendar-abbrev-construct calendar-month-abbrev-array
2870 calendar-month-name-array)
2871 calendar-month-name-array)
2872 (1- month)))
2874 (defun calendar-day-of-week (date)
2875 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc.
2876 DATE is a list of the form (month day year). A negative year is
2877 interpreted as BC; -1 being 1 BC, and so on."
2878 (mod (calendar-absolute-from-gregorian date) 7))
2880 (defun calendar-unmark ()
2881 "Delete all diary/holiday marks/highlighting from the calendar."
2882 (interactive)
2883 (setq mark-holidays-in-calendar nil)
2884 (setq mark-diary-entries-in-calendar nil)
2885 (redraw-calendar))
2887 (defun calendar-date-is-visible-p (date)
2888 "Return t if DATE is valid and is visible in the calendar window."
2889 (let ((gap (calendar-interval
2890 displayed-month displayed-year
2891 (extract-calendar-month date) (extract-calendar-year date))))
2892 (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap))))
2894 (defun calendar-date-is-legal-p (date)
2895 "Return t if DATE is a valid date."
2896 (let ((month (extract-calendar-month date))
2897 (day (extract-calendar-day date))
2898 (year (extract-calendar-year date)))
2899 (and (<= 1 month) (<= month 12)
2900 (<= 1 day) (<= day (calendar-last-day-of-month month year))
2901 ;; BC dates left as non-valid, to suppress errors from
2902 ;; complex holiday algorithms not suitable for years BC.
2903 ;; Note there are side effects on calendar navigation.
2904 (<= 1 year))))
2906 (defun calendar-date-equal (date1 date2)
2907 "Return t if the DATE1 and DATE2 are the same."
2908 (and
2909 (= (extract-calendar-month date1) (extract-calendar-month date2))
2910 (= (extract-calendar-day date1) (extract-calendar-day date2))
2911 (= (extract-calendar-year date1) (extract-calendar-year date2))))
2913 (defun mark-visible-calendar-date (date &optional mark)
2914 "Mark DATE in the calendar window with MARK.
2915 MARK is a single-character string, a list of face attributes/values, or a face.
2916 MARK defaults to `diary-entry-marker'."
2917 (if (calendar-date-is-legal-p date)
2918 (with-current-buffer calendar-buffer
2919 (save-excursion
2920 (calendar-cursor-to-visible-date date)
2921 (setq mark
2922 (or (and (stringp mark) (= (length mark) 1) mark) ; single-char
2923 (and (listp mark) (> (length mark) 0) mark) ; attr list
2924 (and (facep mark) mark) ; face-name
2925 diary-entry-marker))
2926 (cond
2927 ;; face or an attr-list that contained a face
2928 ((facep mark)
2929 (overlay-put
2930 (make-overlay (1- (point)) (1+ (point))) 'face mark))
2931 ;; single-char
2932 ((and (stringp mark) (= (length mark) 1))
2933 (let ((inhibit-read-only t))
2934 (forward-char 1)
2935 ;; Insert before delete so as to better preserve markers.
2936 (insert mark)
2937 (delete-char 1)
2938 (forward-char -2)))
2939 (t ;; attr list
2940 (let ((temp-face
2941 (make-symbol
2942 (apply 'concat "temp-"
2943 (mapcar (lambda (sym)
2944 (cond
2945 ((symbolp sym) (symbol-name sym))
2946 ((numberp sym) (number-to-string sym))
2947 (t sym)))
2948 mark))))
2949 (faceinfo mark))
2950 (make-face temp-face)
2951 ;; Remove :face info from the mark, copy the face info into
2952 ;; temp-face
2953 (while (setq faceinfo (memq :face faceinfo))
2954 (copy-face (read (nth 1 faceinfo)) temp-face)
2955 (setcar faceinfo nil)
2956 (setcar (cdr faceinfo) nil))
2957 (setq mark (delq nil mark))
2958 ;; Apply the font aspects
2959 (apply 'set-face-attribute temp-face nil mark)
2960 (overlay-put
2961 (make-overlay (1- (point)) (1+ (point))) 'face temp-face))))))))
2963 (defun calendar-star-date ()
2964 "Replace the date under the cursor in the calendar window with asterisks.
2965 This function can be used with the `today-visible-calendar-hook' run after the
2966 calendar window has been prepared."
2967 (let ((inhibit-read-only t)
2968 (modified (buffer-modified-p)))
2969 (forward-char 1)
2970 (set (make-local-variable 'calendar-starred-day)
2971 (string-to-number
2972 (buffer-substring (point) (- (point) 2))))
2973 ;; Insert before deleting, to better preserve markers.
2974 (insert "**")
2975 (forward-char -2)
2976 (delete-char -2)
2977 (forward-char 1)
2978 (restore-buffer-modified-p modified)))
2980 (defun calendar-mark-today ()
2981 "Mark the date under the cursor in the calendar window.
2982 The date is marked with `calendar-today-marker'. This function can be used with
2983 the `today-visible-calendar-hook' run after the calendar window has been
2984 prepared."
2985 (mark-visible-calendar-date
2986 (calendar-cursor-to-date)
2987 calendar-today-marker))
2989 (defun calendar-date-compare (date1 date2)
2990 "Return t if DATE1 is before DATE2, nil otherwise.
2991 The actual dates are in the car of DATE1 and DATE2."
2992 (< (calendar-absolute-from-gregorian (car date1))
2993 (calendar-absolute-from-gregorian (car date2))))
2995 (defun calendar-date-string (date &optional abbreviate nodayname)
2996 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2997 An optional parameter ABBREVIATE, when non-nil, causes the month
2998 and day names to be abbreviated as specified by
2999 `calendar-month-abbrev-array' and `calendar-day-abbrev-array',
3000 respectively. An optional parameter NODAYNAME, when t, omits the
3001 name of the day of the week."
3002 (let* ((dayname
3003 (unless nodayname
3004 (calendar-day-name date abbreviate)))
3005 (month (extract-calendar-month date))
3006 (monthname (calendar-month-name month abbreviate))
3007 (day (int-to-string (extract-calendar-day date)))
3008 (month (int-to-string month))
3009 (year (int-to-string (extract-calendar-year date))))
3010 (mapconcat 'eval calendar-date-display-form "")))
3012 (defun calendar-dayname-on-or-before (dayname date)
3013 "Return the absolute date of the DAYNAME on or before absolute DATE.
3014 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
3016 Note: Applying this function to d+6 gives us the DAYNAME on or after an
3017 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
3018 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
3019 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
3020 (- date (% (- date dayname) 7)))
3022 (defun calendar-nth-named-absday (n dayname month year &optional day)
3023 "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3024 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3025 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3026 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3028 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3029 (if (> n 0)
3030 (+ (* 7 (1- n))
3031 (calendar-dayname-on-or-before
3032 dayname
3033 (+ 6 (calendar-absolute-from-gregorian
3034 (list month (or day 1) year)))))
3035 (+ (* 7 (1+ n))
3036 (calendar-dayname-on-or-before
3037 dayname
3038 (calendar-absolute-from-gregorian
3039 (list month
3040 (or day (calendar-last-day-of-month month year))
3041 year))))))
3043 (defun calendar-nth-named-day (n dayname month year &optional day)
3044 "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
3045 A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
3046 return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
3047 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
3049 If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
3050 (calendar-gregorian-from-absolute
3051 (calendar-nth-named-absday n dayname month year day)))
3053 (defun calendar-day-of-year-string (&optional date)
3054 "String of day number of year of Gregorian DATE.
3055 Defaults to today's date if DATE is not given."
3056 (let* ((d (or date (calendar-current-date)))
3057 (year (extract-calendar-year d))
3058 (day (calendar-day-number d))
3059 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
3060 (format "Day %d of %d; %d day%s remaining in the year"
3061 day year days-remaining (if (= days-remaining 1) "" "s"))))
3063 (defun calendar-print-other-dates ()
3064 "Show dates on other calendars for date under the cursor."
3065 (interactive)
3066 (let* ((date (calendar-cursor-to-date t)))
3067 (with-current-buffer (get-buffer-create other-calendars-buffer)
3068 (let ((inhibit-read-only t)
3069 (modified (buffer-modified-p)))
3070 (calendar-set-mode-line
3071 (concat (calendar-date-string date) " (Gregorian)"))
3072 (erase-buffer)
3073 (apply
3074 'insert
3075 (delq nil
3076 (list
3080 (calendar-julian-date-string date))
3082 (calendar-astro-date-string date))
3084 (calendar-absolute-from-gregorian date))
3086 (calendar-hebrew-date-string date))
3088 (calendar-persian-date-string date))
3089 (let ((i (calendar-islamic-date-string date)))
3090 (if (not (string-equal i ""))
3092 (let ((b (calendar-bahai-date-string date)))
3093 (if (not (string-equal b ""))
3096 (calendar-chinese-date-string date))
3097 (let ((c (calendar-coptic-date-string date)))
3098 (if (not (string-equal c ""))
3100 (let ((e (calendar-ethiopic-date-string date)))
3101 (if (not (string-equal e ""))
3103 (let ((f (calendar-french-date-string date)))
3104 (if (not (string-equal f ""))
3107 (calendar-mayan-date-string date)))))
3108 (goto-char (point-min))
3109 (restore-buffer-modified-p modified))
3110 (display-buffer other-calendars-buffer))))
3112 (defun calendar-print-day-of-year ()
3113 "Show day number in year/days remaining in year for date under the cursor."
3114 (interactive)
3115 (message (calendar-day-of-year-string (calendar-cursor-to-date t))))
3117 (defun calendar-set-mode-line (str)
3118 "Set mode line to STR, centered, surrounded by dashes."
3119 (let* ((edges (window-edges))
3120 ;; As per doc of window-width, total visible mode-line length.
3121 (width (- (nth 2 edges) (nth 0 edges))))
3122 (setq mode-line-format
3123 (if buffer-file-name
3124 `("-" mode-line-modified
3125 ,(calendar-string-spread (list str) ?- (- width 6))
3126 "---")
3127 (calendar-string-spread (list str) ?- width)))))
3129 (defun calendar-mod (m n)
3130 "Non-negative remainder of M/N with N instead of 0."
3131 (1+ (mod (1- m) n)))
3133 (run-hooks 'calendar-load-hook)
3135 (provide 'calendar)
3137 ;; Local variables:
3138 ;; byte-compile-dynamic: t
3139 ;; End:
3141 ;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8
3142 ;;; calendar.el ends here