Fix C-M-a in a C function finding the start of a macro preceding it.
[emacs.git] / lisp / calendar / calendar.el
blobccdae484fa60870d15acad422594c19f4d59360e
1 ;;; calendar.el --- calendar functions
3 ;; Copyright (C) 1988-1995, 1997, 2000-2016 Free Software Foundation,
4 ;; 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 3 of the License, or
16 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This collection of functions implements a calendar window. It
29 ;; generates a calendar for the current month, together with the
30 ;; previous and coming months, or for any other three-month period.
31 ;; The calendar can be scrolled forward and backward in the window to
32 ;; show months in the past or future; the cursor can move forward and
33 ;; backward by days, weeks, or months, making it possible, for
34 ;; instance, to jump to the date a specified number of days, weeks, or
35 ;; months from the date under the cursor. The user can display a list
36 ;; of holidays and other notable days for the period shown; the
37 ;; notable days can be marked on the calendar, if desired. The user
38 ;; can also specify that dates having corresponding diary entries (in
39 ;; a file that the user specifies) be marked; the diary entries for
40 ;; any date can be viewed in a separate window. The diary and the
41 ;; notable days can be viewed independently of the calendar. Dates
42 ;; can be translated from the (usual) Gregorian calendar to the day of
43 ;; the year/days remaining in year, to the ISO commercial calendar, to
44 ;; the Julian (old style) calendar, to the Hebrew calendar, to the
45 ;; Islamic calendar, to the Bahá’í calendar, to the French
46 ;; Revolutionary calendar, to the Mayan calendar, to the Chinese
47 ;; calendar, to the Coptic calendar, to the Ethiopic calendar, and to
48 ;; the astronomical (Julian) day number. Times of sunrise/sunset can
49 ;; be displayed, as can the phases of the moon. Appointment
50 ;; notification for diary entries is available. Calendar printing via
51 ;; LaTeX is available.
53 ;; The following files are part of the calendar/diary code:
55 ;; appt.el Appointment notification
56 ;; cal-bahai.el Bahá’í calendar
57 ;; cal-china.el Chinese calendar
58 ;; cal-coptic.el Coptic/Ethiopic calendars
59 ;; cal-dst.el Daylight saving time rules
60 ;; cal-french.el French revolutionary calendar
61 ;; cal-hebrew.el Hebrew calendar
62 ;; cal-html.el Calendars in HTML
63 ;; cal-islam.el Islamic 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 Dedicated frame functions
72 ;; calendar.el This file
73 ;; diary-lib.el Diary functions
74 ;; holidays.el Holiday functions
75 ;; lunar.el Phases of the moon
76 ;; solar.el Sunrise/sunset, equinoxes/solstices
78 ;; Technical details of all the calendrical calculations can be found in
79 ;; ``Calendrical Calculations: The Millennium Edition'' by Edward M. Reingold
80 ;; and Nachum Dershowitz, Cambridge University Press (2001).
82 ;; An earlier version of the technical details appeared in
83 ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
84 ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990),
85 ;; pages 899-928, and in ``Calendrical Calculations, Part II: Three Historical
86 ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen,
87 ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
88 ;; pages 383-404.
90 ;; Hard copies of these two papers can be obtained by sending email to
91 ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and
92 ;; the message BODY containing your mailing address (snail).
95 ;; A note on free variables:
97 ;; The calendar passes around a few dynamically bound variables, which
98 ;; unfortunately have rather common names. They are meant to be
99 ;; available for external functions, so the names can't be changed.
101 ;; displayed-month, displayed-year: bound in calendar-generate, the
102 ;; central month of the 3 month calendar window
103 ;; original-date, number: bound in diary-list-entries, the arguments
104 ;; with which that function was called.
105 ;; date, entry: bound in diary-list-sexp-entries (qv)
107 ;; Bound in diary-list-entries:
108 ;; diary-entries-list: use in d-l, appt.el, and by diary-add-to-list
109 ;; diary-saved-point: only used in diary-lib.el, passed to the display func
110 ;; date-string: only used in diary-lib.el
111 ;; list-only: don't modify the diary-buffer, just return a list of entries
112 ;; file-glob-attrs: yuck
114 ;;; Code:
116 (load "cal-loaddefs" nil t)
118 ;; Avoid recursive load of calendar when loading cal-menu. Yuck.
119 (provide 'calendar)
120 (require 'cal-menu)
122 (defgroup calendar nil
123 "Calendar and time management support."
124 :prefix "calendar-"
125 :group 'applications)
127 (defgroup calendar-hooks nil
128 "Calendar hooks."
129 :prefix "calendar-"
130 :group 'calendar)
132 (defgroup calendar-faces nil
133 "Calendar faces."
134 :prefix "calendar-"
135 :group 'calendar)
137 (defcustom calendar-offset 0
138 "The offset of the principal month from the center of the calendar window.
139 0 means the principal month is in the center (default), -1 means on the left,
140 +1 means on the right. Larger (or smaller) values push the principal month off
141 the screen."
142 :type 'integer
143 :group 'calendar)
145 (defcustom calendar-setup nil
146 "The frame setup of the calendar.
147 The choices are: `one-frame' (calendar and diary together in one separate,
148 dedicated frame); `two-frames' (calendar and diary in separate, dedicated
149 frames); `calendar-only' (calendar in a separate, dedicated frame); with
150 any other value the current frame is used. Using any of the first
151 three options overrides the value of `calendar-view-diary-initially-flag'."
152 :type '(choice
153 (const :tag "calendar and diary in separate frame" one-frame)
154 (const :tag "calendar and diary each in own frame" two-frames)
155 (const :tag "calendar in separate frame" calendar-only)
156 (const :tag "use current frame" nil))
157 :group 'calendar)
159 (defcustom calendar-minimum-window-height 8
160 "Minimum height `calendar-generate-window' should use for calendar window."
161 :type 'integer
162 :version "22.1"
163 :group 'calendar)
165 ;; See discussion in bug#1806.
166 (defcustom calendar-split-width-threshold nil
167 "Value to use for `split-width-threshold' when creating a calendar.
168 This only affects frames wider than the default value of
169 `split-width-threshold'."
170 :type '(choice (const nil)
171 (integer))
172 :version "23.2"
173 :group 'calendar)
175 (defcustom calendar-week-start-day 0
176 "The day of the week on which a week in the calendar begins.
177 0 means Sunday (default), 1 means Monday, and so on.
179 If you change this variable directly (without using customize)
180 after starting `calendar', you should call `calendar-redraw' to
181 update the calendar display to reflect the change, otherwise
182 movement commands will not work correctly."
183 :type 'integer
184 ;; Change the initialize so that if you reload calendar.el, it will not
185 ;; cause a redraw (which may fail, e.g. with "invalid byte-code in
186 ;; calendar.elc" because of the "byte-compile-dynamic").
187 :initialize 'custom-initialize-default
188 :set (lambda (sym val)
189 (set sym val)
190 (calendar-redraw))
191 :group 'calendar)
193 (defcustom calendar-weekend-days '(0 6)
194 "Days of the week considered weekend days.
195 0 means Sunday, 1 means Monday, and so on.
197 Determines which day headers are fontified with
198 `calendar-weekend-header'."
199 :type '(repeat integer)
200 :version "25.1"
201 :group 'calendar)
203 (defcustom calendar-view-diary-initially-flag nil
204 "Non-nil means display current date's diary entries on entry to calendar.
205 The diary is displayed in another window when the calendar is first displayed,
206 if the current date is visible. The number of days of diary entries displayed
207 is governed by the variable `diary-number-of-entries'. This variable can
208 be overridden by the value of `calendar-setup'."
209 :type 'boolean
210 :group 'diary)
212 ;; FIXME :set
213 (defcustom calendar-mark-diary-entries-flag nil
214 "Non-nil means mark dates with diary entries, in the calendar window.
215 The marking symbol is specified by the variable `diary-entry-marker'."
216 :type 'boolean
217 :group 'diary)
219 (defcustom calendar-remove-frame-by-deleting t
220 "Determine how the calendar mode removes a frame no longer needed.
221 If nil, make an icon of the frame. If non-nil, delete the frame."
222 :type 'boolean
223 :version "23.1" ; changed from nil to t
224 :group 'view
225 :group 'calendar)
227 (defface calendar-today
228 '((t (:underline t)))
229 "Face for indicating today's date in the calendar.
230 See the variable `calendar-today-marker'."
231 :group 'calendar-faces)
233 (defface diary
234 '((((min-colors 88) (class color) (background light))
235 :foreground "red1")
236 (((class color) (background light))
237 :foreground "red")
238 (((min-colors 88) (class color) (background dark))
239 :foreground "yellow1")
240 (((class color) (background dark))
241 :foreground "yellow")
243 :weight bold))
244 "Face for highlighting diary entries.
245 Used to mark diary entries in the calendar (see `diary-entry-marker'),
246 and to highlight the date header in the fancy diary."
247 :group 'calendar-faces)
249 (defface holiday
250 '((((class color) (background light))
251 :background "pink")
252 (((class color) (background dark))
253 :background "chocolate4")
255 :inverse-video t))
256 "Face for indicating in the calendar dates that have holidays.
257 See `calendar-holiday-marker'."
258 :group 'calendar-faces)
260 (defface calendar-weekday-header '((t :inherit font-lock-constant-face))
261 "Face used for weekday column headers in the calendar.
262 See also the face `calendar-weekend-header'."
263 :version "24.4"
264 :group 'calendar-faces)
266 (defface calendar-weekend-header '((t :inherit font-lock-comment-face))
267 "Face used for weekend column headers in the calendar.
268 See also the face `calendar-weekday-header'."
269 :version "24.4"
270 :group 'calendar-faces)
272 (defface calendar-month-header '((t :inherit font-lock-function-name-face))
273 "Face used for month headers in the calendar."
274 :version "24.4"
275 :group 'calendar-faces)
277 ;; These briefly checked font-lock-mode, but that is broken, since it
278 ;; is a buffer-local variable, and which buffer happens to be current
279 ;; when this file is loaded shouldn't make a difference. One could
280 ;; perhaps check global-font-lock-mode, or font-lock-global-modes; but
281 ;; this feature doesn't use font-lock, so there's no real reason it
282 ;; should respect those either. See bug#2199.
283 ;; They also used to check display-color-p, but that is a problem if
284 ;; loaded from --daemon. Since BW displays are rare now, this was
285 ;; also taken out. The way to keep it would be to have nil mean do a
286 ;; runtime check whenever this variable is used.
287 (defcustom diary-entry-marker 'diary
288 "How to mark dates that have diary entries.
289 The value can be either a single-character string (e.g. \"+\") or a face."
290 :type '(choice (string :tag "Single character string") face)
291 :group 'diary
292 :version "23.1")
294 (defcustom calendar-today-marker 'calendar-today
295 "How to mark today's date in the calendar.
296 The value can be either a single-character string (e.g. \"=\") or a face.
297 Used by `calendar-mark-today'."
298 :type '(choice (string :tag "Single character string") face)
299 :group 'calendar
300 :version "23.1")
302 (defcustom calendar-holiday-marker 'holiday
303 "How to mark notable dates in the calendar.
304 The value can be either a single-character string (e.g. \"*\") or a face."
305 :type '(choice (string :tag "Single character string") face)
306 :group 'holidays
307 :version "23.1")
309 (defcustom calendar-view-holidays-initially-flag nil
310 "Non-nil means display holidays for current three month period on entry.
311 The holidays are displayed in another window when the calendar is first
312 displayed."
313 :type 'boolean
314 :group 'holidays)
316 ;; FIXME :set
317 (defcustom calendar-mark-holidays-flag nil
318 "Non-nil means mark dates of holidays in the calendar window.
319 The marking symbol is specified by the variable `calendar-holiday-marker'."
320 :type 'boolean
321 :group 'holidays)
323 (defcustom calendar-mode-hook nil
324 "Hook run when entering `calendar-mode'."
325 :type 'hook
326 :group 'calendar-hooks)
328 (defcustom calendar-load-hook nil
329 "List of functions to be called after the calendar is first loaded.
330 This is the place to add key bindings to `calendar-mode-map'."
331 :type 'hook
332 :group 'calendar-hooks)
334 (defcustom calendar-initial-window-hook nil
335 "List of functions to be called when the calendar window is created.
336 Quitting the calendar and re-entering it will cause these functions
337 to be called again."
338 :type 'hook
339 :group 'calendar-hooks)
341 (defcustom calendar-today-visible-hook nil
342 "List of functions called whenever the current date is visible.
343 To mark today's date, add the function `calendar-mark-today'.
344 To replace the date with asterisks, add the function `calendar-star-date'.
345 See also `calendar-today-invisible-hook'.
347 In general, be careful about changing characters in the calendar buffer,
348 since it may cause the movement commands to fail."
349 :type 'hook
350 :options '(calendar-mark-today calendar-star-date)
351 :group 'calendar-hooks)
353 (defcustom calendar-today-invisible-hook nil
354 "List of functions called whenever the current date is not visible.
355 See also `calendar-today-visible-hook'."
356 :type 'hook
357 :group 'calendar-hooks)
359 (defcustom calendar-move-hook nil
360 "List of functions called whenever the cursor moves in the calendar.
361 For example,
363 (add-hook \\='calendar-move-hook (lambda () (diary-view-entries 1)))
365 redisplays the diary for whatever date the cursor is moved to."
366 :type 'hook
367 :options '(calendar-update-mode-line)
368 :group 'calendar-hooks)
370 (defcustom calendar-date-echo-text
371 "mouse-2: general menu\nmouse-3: menu for this date"
372 "String displayed when the cursor is over a date in the calendar.
373 Can be either a fixed string, or a lisp expression that returns one.
374 When this expression is evaluated, DAY, MONTH, and YEAR are
375 integers appropriate to the relevant date. For example, to
376 display the ISO date:
378 (setq calendar-date-echo-text \\='(format \"ISO date: %s\"
379 (calendar-iso-date-string
380 (list month day year))))
381 Changing this variable without using customize has no effect on
382 pre-existing calendar windows."
383 :group 'calendar
384 :initialize 'custom-initialize-default
385 :risky t
386 :set (lambda (sym val)
387 (set sym val)
388 (calendar-redraw))
389 :type '(choice (string :tag "Fixed string")
390 (sexp :value
391 (format "ISO date: %s"
392 (calendar-iso-date-string
393 (list month day year)))))
394 :version "23.1")
397 (defvar calendar-month-digit-width nil
398 "Width of the region with numbers in each month in the calendar.")
400 (defvar calendar-month-width nil
401 "Full width of each month in the calendar.")
403 (defvar calendar-right-margin nil
404 "Right margin of the calendar.")
406 (defvar calendar-month-edges nil
407 "Alist of month edge columns.
408 Each element has the form (N LEFT FIRST LAST RIGHT), where
409 LEFT is the leftmost column associated with month segment N,
410 FIRST and LAST are the first and last columns with day digits in,
411 and LAST is the rightmost column.")
413 (defun calendar-month-edges (segment)
414 "Compute the month edge columns for month SEGMENT.
415 Returns a list (LEFT FIRST LAST RIGHT), where LEFT is the
416 leftmost column associated with a month, FIRST and LAST are the
417 first and last columns with day digits in, and LAST is the
418 rightmost column."
419 ;; The leftmost column with a digit in it in this month segment.
420 (let* ((first (+ calendar-left-margin
421 (* segment calendar-month-width)))
422 ;; The rightmost column with a digit in it in this month segment.
423 (last (+ first (1- calendar-month-digit-width)))
424 (left (if (eq segment 0)
426 (+ calendar-left-margin
427 (* segment calendar-month-width)
428 (- (/ calendar-intermonth-spacing 2)))))
429 ;; The rightmost edge of this month segment, dividing the
430 ;; space between months in two.
431 (right (+ calendar-left-margin
432 (* (1+ segment) calendar-month-width)
433 (- (/ calendar-intermonth-spacing 2)))))
434 (list left first last right)))
436 (defun calendar-recompute-layout-variables ()
437 "Recompute some layout-related calendar \"constants\"."
438 (setq calendar-month-digit-width (+ (* 6 calendar-column-width)
439 calendar-day-digit-width)
440 calendar-month-width (+ (* 7 calendar-column-width)
441 calendar-intermonth-spacing)
442 calendar-right-margin (+ calendar-left-margin
443 (* 3 (* 7 calendar-column-width))
444 (* 2 calendar-intermonth-spacing))
445 calendar-month-edges nil)
446 (dotimes (i 3)
447 (push (cons i (calendar-month-edges i)) calendar-month-edges))
448 (setq calendar-month-edges (reverse calendar-month-edges)))
450 (defun calendar-set-layout-variable (symbol value &optional minmax)
451 "Set SYMBOL's value to VALUE, an integer.
452 A positive/negative MINMAX enforces a minimum/maximum value.
453 Then redraw the calendar, if necessary."
454 (let ((oldvalue (symbol-value symbol)))
455 (custom-set-default symbol (if minmax
456 (if (< minmax 0)
457 (min value (- minmax))
458 (max value minmax))
459 value))
460 (unless (equal value oldvalue)
461 (calendar-recompute-layout-variables)
462 (calendar-redraw))))
464 (defcustom calendar-left-margin 5
465 "Empty space to the left of the first month in the calendar."
466 :group 'calendar
467 :initialize 'custom-initialize-default
468 :set 'calendar-set-layout-variable
469 :type 'integer
470 :version "23.1")
472 ;; Or you can view it as columns of width 2, with 1 space, no space
473 ;; after the last column, and a 5 space gap between month.
474 ;; FIXME check things work if this is odd.
475 (defcustom calendar-intermonth-spacing 4
476 "Space between months in the calendar. Minimum value is 1."
477 :group 'calendar
478 :initialize 'custom-initialize-default
479 :set (lambda (sym val)
480 (calendar-set-layout-variable sym val 1))
481 :type 'integer
482 :version "23.1")
484 ;; FIXME calendar-month-column-width?
485 (defcustom calendar-column-width 3
486 "Width of each day column in the calendar. Minimum value is 3."
487 :initialize 'custom-initialize-default
488 :set (lambda (sym val)
489 (calendar-set-layout-variable sym val 3))
490 :type 'integer
491 :version "23.1")
493 (defun calendar-day-header-construct (&optional width)
494 "Return the default value for `calendar-day-header-array'.
495 WIDTH defaults to `calendar-day-header-width'."
496 (or width (setq width calendar-day-header-width))
497 (calendar-abbrev-construct (if (<= width calendar-abbrev-length)
498 calendar-day-abbrev-array
499 calendar-day-name-array)
500 width))
502 ;; FIXME better to use a format spec?
503 (defcustom calendar-day-header-width 2
504 "Width of the day column headers in the calendar.
505 Must be at least one less than `calendar-column-width'."
506 :group 'calendar
507 :initialize 'custom-initialize-default
508 :set (lambda (sym val)
509 (or (calendar-customized-p 'calendar-day-header-array)
510 (setq calendar-day-header-array
511 (calendar-day-header-construct val)))
512 (calendar-set-layout-variable sym val (- 1 calendar-column-width)))
513 :type 'integer
514 :version "23.1")
516 ;; FIXME a format specifier instead?
517 (defcustom calendar-day-digit-width 2
518 "Width of the day digits in the calendar. Minimum value is 2."
519 :group 'calendar
520 :initialize 'custom-initialize-default
521 :set (lambda (sym val)
522 (calendar-set-layout-variable sym val 2))
523 :type 'integer
524 :version "23.1")
526 (defcustom calendar-intermonth-header nil
527 "Header text to display in the space to the left of each calendar month.
528 See `calendar-intermonth-text'."
529 :group 'calendar
530 :initialize 'custom-initialize-default
531 :risky t
532 :set (lambda (sym val)
533 (set sym val)
534 (calendar-redraw))
535 :type '(choice (const nil :tag "Nothing")
536 (string :tag "Fixed string")
537 (sexp :value
538 (propertize "WK" 'font-lock-face
539 'font-lock-function-name-face)))
540 :version "23.1")
542 (defcustom calendar-intermonth-text nil
543 "Text to display in the space to the left of each calendar month.
544 Can be nil, a fixed string, or a lisp expression that returns a string.
545 When the expression is evaluated, the variables DAY, MONTH and YEAR
546 are integers appropriate for the first day in each week.
547 Will be truncated to the smaller of `calendar-left-margin' and
548 `calendar-intermonth-spacing'. The last character is forced to be a space.
549 For example, to display the ISO week numbers:
551 (setq calendar-week-start-day 1
552 calendar-intermonth-text
553 \\='(propertize
554 (format \"%2d\"
555 (car
556 (calendar-iso-from-absolute
557 (calendar-absolute-from-gregorian (list month day year)))))
558 \\='font-lock-face \\='font-lock-function-name-face))
560 See also `calendar-intermonth-header'."
561 :group 'calendar
562 :initialize 'custom-initialize-default
563 :risky t
564 :set (lambda (sym val)
565 (set sym val)
566 (calendar-redraw))
567 :type '(choice (const nil :tag "Nothing")
568 (string :tag "Fixed string")
569 (sexp :value
570 (propertize
571 (format "%2d"
572 (car
573 (calendar-iso-from-absolute
574 (calendar-absolute-from-gregorian
575 (list month day year)))))
576 'font-lock-face 'font-lock-function-name-face)))
577 :version "23.1")
579 (defcustom diary-file (locate-user-emacs-file "diary" "diary")
580 "Name of the file in which one's personal diary of dates is kept.
582 The file's entries are lines beginning with any of the forms
583 specified by the variable `diary-date-forms', which by default
584 uses the forms of `diary-american-date-forms':
586 MONTH/DAY
587 MONTH/DAY/YEAR
588 MONTHNAME DAY
589 MONTHNAME DAY, YEAR
590 DAYNAME
592 with the remainder of the line being the diary entry string for
593 that date. MONTH and DAY are one or two digit numbers, YEAR is a
594 number and may be written in full or abbreviated to the final two
595 digits (if `diary-abbreviated-year-flag' is non-nil). MONTHNAME
596 and DAYNAME can be spelled in full (as specified by the variables
597 `calendar-month-name-array' and `calendar-day-name-array'), or
598 abbreviated (as specified by `calendar-month-abbrev-array' and
599 `calendar-day-abbrev-array') with or without a period. Case is
600 ignored. Any of DAY, MONTH, or MONTHNAME, YEAR can be `*' which
601 matches any day, month, or year, respectively. If the date does
602 not contain a year, it is generic and applies to any year. A
603 DAYNAME entry applies to the appropriate day of the week in every week.
605 You can customize `diary-date-forms' to your preferred format.
606 Three default styles are provided: `diary-american-date-forms',
607 `diary-european-date-forms', and `diary-iso-date-forms'.
608 You can choose between these by setting `calendar-date-style' in your
609 init file, or by using `calendar-set-date-style' when in the calendar.
611 A diary entry can be preceded by the character `diary-nonmarking-symbol'
612 \(ordinarily `&') to make that entry nonmarking--that is, it will not be
613 marked on dates in the calendar window but will appear in a diary window.
615 Multiline diary entries are made by indenting lines after the first with
616 either a TAB or one or more spaces.
618 Lines not in one the above formats are ignored. Here are some sample diary
619 entries (in the default American style):
621 12/22/1988 Twentieth wedding anniversary!!
622 &1/1. Happy New Year!
623 10/22 Ruth's birthday.
624 21: Payday
625 Tuesday--weekly meeting with grad students at 10am
626 Supowit, Shen, Bitner, and Kapoor to attend.
627 1/13/89 Friday the thirteenth!!
628 &thu 4pm squash game with Lloyd.
629 mar 16 Dad's birthday
630 April 15, 1989 Income tax due.
631 &* 15 time cards due.
633 If the first line of a diary entry consists only of the date or day name with
634 no trailing blanks or punctuation, then that line is not displayed in the
635 diary window; only the continuation lines is shown. For example, the
636 single diary entry
638 02/11/1989
639 Bill Blattner visits Princeton today
640 2pm Cognitive Studies Committee meeting
641 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative'
642 4:00pm Jamie Tappenden
643 7:30pm Dinner at George and Ed's for Alan Ryan
644 7:30-10:00pm dance at Stewart Country Day School
646 will appear in the diary window without the date line at the beginning. This
647 facility allows the diary window to look neater, but can cause confusion if
648 used with more than one day's entries displayed.
650 Diary entries can be based on Lisp sexps. For example, the diary entry
652 %%(diary-block 11 1 1990 11 10 1990) Vacation
654 causes the diary entry \"Vacation\" to appear from November 1 through
655 November 10, 1990. See the documentation for the function
656 `diary-list-sexp-entries' for more details.
658 Diary entries based on the Hebrew, the Islamic and/or the Bahá’í
659 calendar are also possible, but because these are somewhat slow, they
660 are ignored unless you set the `diary-nongregorian-listing-hook' and
661 the `diary-nongregorian-marking-hook' appropriately. See the
662 documentation of these hooks for details.
664 Diary files can contain directives to include the contents of other files; for
665 details, see the documentation for the variable `diary-list-entries-hook'."
666 :version "25.1" ; ~/diary -> locate-user-emacs-file
667 :type 'file
668 :group 'diary)
670 ;; FIXME do these have to be single characters?
671 (defcustom diary-nonmarking-symbol "&"
672 "Symbol indicating that a diary entry is not to be marked in the calendar."
673 :type 'string
674 :group 'diary)
676 (defcustom diary-chinese-entry-symbol "C"
677 "Symbol indicating a diary entry according to the Chinese calendar."
678 :type 'string
679 :group 'diary
680 :version "25.1")
682 (defcustom diary-hebrew-entry-symbol "H"
683 "Symbol indicating a diary entry according to the Hebrew calendar."
684 :type 'string
685 :group 'diary)
687 (defcustom diary-islamic-entry-symbol "I"
688 "Symbol indicating a diary entry according to the Islamic calendar."
689 :type 'string
690 :group 'diary)
692 (defcustom diary-bahai-entry-symbol "B"
693 "Symbol indicating a diary entry according to the Bahá’í calendar."
694 :type 'string
695 :group 'diary)
697 (defcustom calendar-date-style 'american
698 "Your preferred style for writing dates.
699 The options are:
700 `american' - month/day/year
701 `european' - day/month/year
702 `iso' - year/month/day
703 This affects how dates written in your diary are interpreted.
704 It also affects date display, as well as those calendar and diary
705 functions that take a date as an argument, e.g. `diary-date', by
706 changing the order in which the arguments are interpreted.
708 Setting this variable directly does not take effect (if the
709 calendar package is already loaded). Rather, use either
710 \\[customize] or the function `calendar-set-date-style'."
711 :version "23.1"
712 :type '(choice (const american :tag "Month/Day/Year")
713 (const european :tag "Day/Month/Year")
714 (const iso :tag "Year/Month/Day"))
715 :initialize 'custom-initialize-default
716 :set (lambda (symbol value)
717 (calendar-set-date-style value))
718 :group 'calendar)
720 ;; Next three are provided to aid in setting diary-date-forms.
721 ;; FIXME move to diary-lib?
722 (defcustom diary-iso-date-forms
723 '((month "[-/]" day "[^-/0-9]")
724 (year "[-/]" month "[-/]" day "[^0-9]")
725 ;; Cannot allow [-/] as separators here, since it would also match
726 ;; the first element (bug#7377).
727 (monthname " *" day "[^-0-9]")
728 (year " *" monthname " *" day "[^0-9]")
729 (dayname "\\W"))
730 "List of pseudo-patterns describing the ISO style of dates.
731 The defaults are: MONTH[-/]DAY; YEAR[-/]MONTH[-/]DAY; MONTHNAME DAY;
732 YEAR MONTHNAME DAY; DAYNAME. Normally you should not customize this,
733 but `diary-date-forms' (which see)."
734 :version "23.3" ; bug#7377
735 :type '(repeat (choice (cons :tag "Backup"
736 :value (backup . nil)
737 (const backup)
738 (repeat (list :inline t :format "%v"
739 (symbol :tag "Keyword")
740 (choice symbol regexp))))
741 (repeat (list :inline t :format "%v"
742 (symbol :tag "Keyword")
743 (choice symbol regexp)))))
744 :group 'diary)
746 (defcustom diary-american-date-forms
747 '((month "/" day "[^/0-9]")
748 (month "/" day "/" year "[^0-9]")
749 (monthname " *" day "[^,0-9]")
750 (monthname " *" day ", *" year "[^0-9]")
751 (dayname "\\W"))
752 "List of pseudo-patterns describing the American style of dates.
753 The defaults are: MONTH/DAY; MONTH/DAY/YEAR; MONTHNAME DAY;
754 MONTHNAME DAY, YEAR; DAYNAME. Normally you should not customize this,
755 but `diary-date-forms' (which see)."
756 :type '(repeat (choice (cons :tag "Backup"
757 :value (backup . nil)
758 (const backup)
759 (repeat (list :inline t :format "%v"
760 (symbol :tag "Keyword")
761 (choice symbol regexp))))
762 (repeat (list :inline t :format "%v"
763 (symbol :tag "Keyword")
764 (choice symbol regexp)))))
765 :group 'diary)
767 (defcustom diary-european-date-forms
768 '((day "/" month "[^/0-9]")
769 (day "/" month "/" year "[^0-9]")
770 (backup day " *" monthname "\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)")
771 (day " *" monthname " *" year "[^0-9]")
772 (dayname "\\W"))
773 "List of pseudo-patterns describing the European style of dates.
774 The defaults are: DAY/MONTH; DAY/MONTH/YEAR; DAY MONTHNAME;
775 DAY MONTHNAME YEAR; DAYNAME. Normally you should not customize this, but
776 `diary-date-forms' (which see)."
777 :type '(repeat (choice (cons :tag "Backup"
778 :value (backup . nil)
779 (const backup)
780 (repeat (list :inline t :format "%v"
781 (symbol :tag "Keyword")
782 (choice symbol regexp))))
783 (repeat (list :inline t :format "%v"
784 (symbol :tag "Keyword")
785 (choice symbol regexp)))))
786 :group 'diary)
788 (defvar diary-font-lock-keywords)
790 (defcustom diary-date-forms (cond ((eq calendar-date-style 'iso)
791 diary-iso-date-forms)
792 ((eq calendar-date-style 'european)
793 diary-european-date-forms)
794 (t diary-american-date-forms))
795 "List of pseudo-patterns describing the forms of date used in the diary.
796 The patterns on the list must be MUTUALLY EXCLUSIVE and should not match
797 any portion of the diary entry itself, just the date component.
799 A pseudo-pattern is a list of regular expressions and the keywords `month',
800 `day', `year', `monthname', and `dayname'. The keyword `monthname' will
801 match the name of the month (see `calendar-month-name-array'), capitalized
802 or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'),
803 followed by a period or not; it will also match `*'. Similarly, `dayname'
804 will match the name of the day (see `calendar-day-name-array'), capitalized or
805 not, or its user-specified abbreviation (see `calendar-day-abbrev-array'),
806 followed by a period or not. The keywords `month', `day', and `year' will
807 match those numerical values, preceded by arbitrarily many zeros; they will
808 also match `*'.
810 The matching of the diary entries with the date forms is done with the
811 standard syntax table from Fundamental mode, but with the `*' changed so
812 that it is a word constituent.
814 If, to be mutually exclusive, a pseudo-pattern must match a portion of the
815 diary entry itself, the first element of the pattern MUST be `backup'. This
816 directive causes the date recognizer to back up to the beginning of the
817 current word of the diary entry, so in no case can the pattern match more than
818 a portion of the first word of the diary entry.
820 For examples of three common styles, see `diary-american-date-forms',
821 `diary-european-date-forms', and `diary-iso-date-forms'."
822 :type '(repeat (choice (cons :tag "Backup"
823 :value (backup . nil)
824 (const backup)
825 (repeat (list :inline t :format "%v"
826 (symbol :tag "Keyword")
827 (choice symbol regexp))))
828 (repeat (list :inline t :format "%v"
829 (symbol :tag "Keyword")
830 (choice symbol regexp)))))
831 :set-after '(calendar-date-style diary-iso-date-forms
832 diary-european-date-forms
833 diary-american-date-forms)
834 :initialize 'custom-initialize-default
835 :set (lambda (symbol value)
836 (unless (equal value (eval symbol))
837 (custom-set-default symbol value)
838 (setq diary-font-lock-keywords (diary-font-lock-keywords))
839 ;; Need to redraw not just to get new font-locking, but also
840 ;; to pick up any newly recognized entries.
841 (and (diary-live-p)
842 (diary))))
843 :group 'diary)
845 ;; Next three are provided to aid in setting calendar-date-display-form.
846 (defcustom calendar-iso-date-display-form '((format "%s-%.2d-%.2d" year
847 (string-to-number month)
848 (string-to-number day)))
849 "Pseudo-pattern governing the way a date appears in the ISO style.
850 Normally you should not customize this, but `calendar-date-display-form'
851 \(which see)."
852 :type 'sexp
853 :risky t
854 :version "23.1"
855 :group 'calendar)
857 (defcustom calendar-european-date-display-form
858 '((if dayname (concat dayname ", ")) day " " monthname " " year)
859 "Pseudo-pattern governing the way a date appears in the European style.
860 Normally you should not customize this, but `calendar-date-display-form'
861 \(which see)."
862 :type 'sexp
863 :risky t
864 :group 'calendar)
866 (defcustom calendar-american-date-display-form
867 '((if dayname (concat dayname ", ")) monthname " " day ", " year)
868 "Pseudo-pattern governing the way a date appears in the American style.
869 Normally you should not customize this, but `calendar-date-display-form'
870 \(which see)."
871 :type 'sexp
872 :risky t
873 :group 'calendar)
875 (defcustom calendar-date-display-form
876 (cond ((eq calendar-date-style 'iso)
877 calendar-iso-date-display-form)
878 ((eq calendar-date-style 'european)
879 calendar-european-date-display-form)
880 (t calendar-american-date-display-form))
881 "Pseudo-pattern governing the way a calendar date appears.
882 Used by the function `calendar-date-string' (which see), a pseudo-pattern
883 is a list of expressions that can involve the keywords `month', `day',
884 and `year' (all numbers in string form), and `monthname' and `dayname'
885 \(both alphabetic strings). For example, a typical American form would be
887 (month \"/\" day \"/\" (substring year -2))
889 whereas
891 ((format \"%9s, %9s %2s, %4s\" dayname monthname day year))
893 would give the usual American style in fixed-length fields. The variables
894 `calendar-iso-date-display-form', `calendar-european-date-display-form', and
895 `calendar-american-date-display-form' provide some defaults for three common
896 styles."
897 :type 'sexp
898 :risky t
899 :set-after '(calendar-date-style calendar-iso-date-display-form
900 calendar-european-date-display-form
901 calendar-american-date-display-form)
902 :group 'calendar)
904 (defcustom calendar-american-month-header
905 '(propertize (format "%s %d" (calendar-month-name month) year)
906 'font-lock-face 'calendar-month-header)
907 "Default format for calendar month headings with the American date style.
908 Normally you should not customize this, but `calender-month-header'."
909 :group 'calendar
910 :risky t
911 :type 'sexp
912 :version "24.4") ; font-lock-function-name-face -> calendar-month-header
914 (defcustom calendar-european-month-header
915 '(propertize (format "%s %d" (calendar-month-name month) year)
916 'font-lock-face 'calendar-month-header)
917 "Default format for calendar month headings with the European date style.
918 Normally you should not customize this, but `calender-month-header'."
919 :group 'calendar
920 :risky t
921 :type 'sexp
922 :version "24.4") ; font-lock-function-name-face -> calendar-month-header
924 (defcustom calendar-iso-month-header
925 '(propertize (format "%d %s" year (calendar-month-name month))
926 'font-lock-face 'calendar-month-header)
927 "Default format for calendar month headings with the ISO date style.
928 Normally you should not customize this, but `calender-month-header'."
929 :group 'calendar
930 :risky t
931 :type 'sexp
932 :version "24.4") ; font-lock-function-name-face -> calendar-month-header
934 (defcustom calendar-month-header
935 (cond ((eq calendar-date-style 'iso)
936 calendar-iso-month-header)
937 ((eq calendar-date-style 'european)
938 calendar-european-month-header)
939 (t calendar-american-month-header))
940 "Expression to evaluate to return the calendar month headings.
941 When this expression is evaluated, the variables MONTH and YEAR are
942 integers appropriate to the relevant month. The result is padded
943 to the width of `calendar-month-digit-width'.
945 For examples of three common styles, see `calendar-american-month-header',
946 `calendar-european-month-header', and `calendar-iso-month-header'.
948 Changing this variable without using customize has no effect on
949 pre-existing calendar windows."
950 :group 'calendar
951 :initialize 'custom-initialize-default
952 :risky t
953 :set (lambda (sym val)
954 (set sym val)
955 (calendar-redraw))
956 :set-after '(calendar-date-style calendar-american-month-header
957 calendar-european-month-header
958 calendar-iso-month-header)
959 :type 'sexp
960 :version "24.3")
962 (defun calendar-set-date-style (style)
963 "Set the style of calendar and diary dates to STYLE (a symbol).
964 The valid styles are described in the documentation of `calendar-date-style'."
965 (interactive (list (intern
966 (completing-read "Date style: "
967 '("american" "european" "iso") nil t
968 nil nil "american"))))
969 (or (memq style '(american european iso))
970 (setq style 'american))
971 (setq calendar-date-style style
972 calendar-date-display-form
973 (symbol-value (intern-soft
974 (format "calendar-%s-date-display-form" style)))
975 calendar-month-header
976 (symbol-value (intern-soft (format "calendar-%s-month-header" style)))
977 diary-date-forms
978 (symbol-value (intern-soft (format "diary-%s-date-forms" style))))
979 (calendar-redraw)
980 (calendar-update-mode-line))
982 (defcustom diary-show-holidays-flag t
983 "Non-nil means include holidays in the diary display.
984 The holidays appear in the mode line of the diary buffer, or in the
985 fancy diary buffer next to the date. This slows down the diary functions
986 somewhat; setting it to nil makes the diary display faster."
987 :type 'boolean
988 :group 'holidays)
990 (defcustom calendar-debug-sexp nil
991 "Turn debugging on when evaluating a sexp in the diary or holiday list."
992 :type 'boolean
993 :group 'calendar)
995 (defcustom calendar-hebrew-all-holidays-flag nil
996 "If nil, show only major holidays from the Hebrew calendar.
997 This means only those Jewish holidays that appear on secular calendars.
998 Otherwise, show all the holidays that would appear in a complete Hebrew
999 calendar."
1000 :type 'boolean
1001 :group 'holidays)
1003 (defcustom calendar-christian-all-holidays-flag nil
1004 "If nil, show only major holidays from the Christian calendar.
1005 This means only those Christian holidays that appear on secular calendars.
1006 Otherwise, show all the holidays that would appear in a complete Christian
1007 calendar."
1008 :type 'boolean
1009 :group 'holidays)
1011 (defcustom calendar-islamic-all-holidays-flag nil
1012 "If nil, show only major holidays from the Islamic calendar.
1013 This means only those Islamic holidays that appear on secular calendars.
1014 Otherwise, show all the holidays that would appear in a complete Islamic
1015 calendar."
1016 :type 'boolean
1017 :group 'holidays)
1019 (defcustom calendar-bahai-all-holidays-flag nil
1020 "If nil, show only major holidays from the Bahá’í calendar.
1021 These are the days on which work and school must be suspended.
1022 Otherwise, show all the holidays that would appear in a complete Bahá’í
1023 calendar."
1024 :type 'boolean
1025 :group 'holidays)
1027 (defcustom calendar-chinese-all-holidays-flag nil
1028 "If nil, show only the major holidays from the Chinese calendar."
1029 :version "23.1"
1030 :type 'boolean
1031 :group 'holidays)
1033 ;;; End of user options.
1035 (calendar-recompute-layout-variables)
1037 (defconst calendar-first-date-row 3
1038 "First row in the calendar with actual dates.")
1040 (defconst calendar-buffer "*Calendar*"
1041 "Name of the buffer used for the calendar.")
1043 (defconst holiday-buffer "*Holidays*"
1044 "Name of the buffer used for the displaying the holidays.")
1046 (defconst diary-fancy-buffer "*Fancy Diary Entries*"
1047 "Name of the buffer used for the optional fancy display of the diary.")
1049 (defconst calendar-other-calendars-buffer "*Other Calendars*"
1050 "Name of the buffer used for the display of date on other calendars.")
1052 (defconst lunar-phases-buffer "*Phases of Moon*"
1053 "Name of the buffer used for the lunar phases.")
1055 (defconst solar-sunrises-buffer "*Sunrise/Sunset Times*"
1056 "Name of buffer used for sunrise/sunset times.")
1058 (defconst calendar-hebrew-yahrzeit-buffer "*Yahrzeits*"
1059 "Name of the buffer used by `list-yahrzeit-dates'.")
1061 (defmacro calendar-increment-month (mon yr n &optional nmonths)
1062 "Increment the variables MON and YR by N months.
1063 Forward if N is positive or backward if N is negative.
1064 A negative YR is interpreted as BC; -1 being 1 BC, and so on.
1065 Optional NMONTHS is the number of months per year (default 12)."
1066 ;; Can view this as a form of base-nmonths arithmetic, in which "a
1067 ;; year" = "ten", and we never bother to use hundreds.
1068 `(let ((nmonths (or ,nmonths 12))
1069 macro-y)
1070 (if (< ,yr 0) (setq ,yr (1+ ,yr))) ; -1 BC -> 0 AD, etc
1071 (setq macro-y (+ (* ,yr nmonths) ,mon -1 ,n)
1072 ,mon (1+ (mod macro-y nmonths))
1073 ,yr (/ macro-y nmonths))
1074 ;; Alternative:
1075 ;;; (setq macro-y (+ (* ,yr nmonths) ,mon -1 ,n)
1076 ;;; ,yr (/ macro-y nmonths)
1077 ;;; ,mon (- macro-y (* ,yr nmonths)))
1078 (and (< macro-y 0) (> ,mon 1) (setq ,yr (1- ,yr)))
1079 (if (< ,yr 1) (setq ,yr (1- ,yr))))) ; 0 AD -> -1 BC, etc
1081 (defvar displayed-month)
1082 (defvar displayed-year)
1084 (defun calendar-increment-month-cons (n &optional mon yr)
1085 "Return the Nth month after MON/YR.
1086 The return value is a pair (MONTH . YEAR).
1087 MON defaults to `displayed-month'. YR defaults to `displayed-year'."
1088 (unless mon (setq mon displayed-month))
1089 (unless yr (setq yr displayed-year))
1090 (calendar-increment-month mon yr n)
1091 (cons mon yr))
1093 (defmacro calendar-sum (index initial condition expression)
1094 "For INDEX = INITIAL, +1, ... (as long as CONDITION holds), sum EXPRESSION."
1095 (declare (debug (symbolp form form form)))
1096 `(let ((,index ,initial)
1097 (sum 0))
1098 (while ,condition
1099 (setq sum (+ sum ,expression)
1100 ,index (1+ ,index)))
1101 sum))
1103 (defmacro calendar-in-read-only-buffer (buffer &rest body)
1104 "Switch to BUFFER and execute the forms in BODY.
1105 First creates or erases BUFFER as needed. Leaves BUFFER read-only,
1106 with disabled undo. Leaves point at point-min, displays BUFFER."
1107 (declare (indent 1) (debug t))
1108 `(progn
1109 (set-buffer (get-buffer-create ,buffer))
1110 (or (derived-mode-p 'special-mode) (special-mode))
1111 (setq buffer-read-only nil
1112 buffer-undo-list t)
1113 (erase-buffer)
1114 (display-buffer ,buffer)
1115 ,@body
1116 (goto-char (point-min))
1117 (set-buffer-modified-p nil)
1118 (setq buffer-read-only t)))
1120 ;; The following are in-line for speed; they can be called thousands of times
1121 ;; when looking up holidays or processing the diary. Here, for example, are
1122 ;; the numbers of calls to calendar/diary/holiday functions in preparing the
1123 ;; fancy diary display, for a moderately complex diary file, with functions
1124 ;; used instead of macros. There were a total of 10000 such calls:
1126 ;; 1934 calendar-extract-month
1127 ;; 1852 calendar-extract-year
1128 ;; 1819 calendar-extract-day
1129 ;; 845 calendar-leap-year-p
1130 ;; 837 calendar-day-number
1131 ;; 775 calendar-absolute-from-gregorian
1132 ;; 346 calendar-last-day-of-month
1133 ;; 286 calendar-hebrew-last-day-of-month
1134 ;; 188 calendar-hebrew-leap-year-p
1135 ;; 180 calendar-hebrew-elapsed-days
1136 ;; 163 calendar-hebrew-last-month-of-year
1137 ;; 66 calendar-date-compare
1138 ;; 65 calendar-hebrew-days-in-year
1139 ;; 60 calendar-julian-to-absolute
1140 ;; 50 calendar-hebrew-to-absolute
1141 ;; 43 calendar-date-equal
1142 ;; 38 calendar-gregorian-from-absolute
1143 ;; .
1145 ;; The use of these seven macros eliminates the overhead of 92% of the function
1146 ;; calls; it's faster this way.
1148 (defsubst calendar-extract-month (date)
1149 "Extract the month part of DATE which has the form (month day year)."
1150 (car date))
1152 ;; Note gives wrong answer for result of (calendar-read-date 'noday),
1153 ;; but that is only used by `calendar-other-month'.
1154 (defsubst calendar-extract-day (date)
1155 "Extract the day part of DATE which has the form (month day year)."
1156 (cadr date))
1158 (defsubst calendar-extract-year (date)
1159 "Extract the year part of DATE which has the form (month day year)."
1160 (nth 2 date))
1162 (defsubst calendar-leap-year-p (year)
1163 "Return t if YEAR is a Gregorian leap year.
1164 A negative year is interpreted as BC; -1 being 1 BC, and so on."
1165 ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc.
1166 (if (< year 0) (setq year (1- (abs year))))
1167 (and (zerop (% year 4))
1168 (or (not (zerop (% year 100)))
1169 (zerop (% year 400)))))
1171 ;; The foregoing is a bit faster, but not as clear as the following:
1173 ;;(defsubst calendar-leap-year-p (year)
1174 ;; "Return t if YEAR is a Gregorian leap year."
1175 ;; (or
1176 ;; (and (zerop (% year 4))
1177 ;; (not (zerop (% year 100))))
1178 ;; (zerop (% year 400)))
1180 (defsubst calendar-last-day-of-month (month year)
1181 "The last day in MONTH during YEAR."
1182 (if (and (= month 2) (calendar-leap-year-p year))
1184 (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month))))
1186 ;; An explanation of the calculation can be found in PascAlgorithms by
1187 ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988.
1189 (defsubst calendar-day-number (date)
1190 "Return the day number within the year of the date DATE.
1191 For example, (calendar-day-number \\='(1 1 1987)) returns the value 1,
1192 while (calendar-day-number \\='(12 31 1980)) returns 366."
1193 (let* ((month (calendar-extract-month date))
1194 (day (calendar-extract-day date))
1195 (year (calendar-extract-year date))
1196 (day-of-year (+ day (* 31 (1- month)))))
1197 (when (> month 2)
1198 (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
1199 (if (calendar-leap-year-p year)
1200 (setq day-of-year (1+ day-of-year))))
1201 day-of-year))
1203 (defsubst calendar-absolute-from-gregorian (date)
1204 "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
1205 The Gregorian date Sunday, December 31, 1 BC is imaginary.
1206 DATE is a list of the form (month day year). A negative year is
1207 interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC
1208 return negative results."
1209 (let ((year (calendar-extract-year date))
1210 offset-years)
1211 (cond ((zerop year)
1212 (user-error "There was no year zero"))
1213 ((> year 0)
1214 (setq offset-years (1- year))
1215 (+ (calendar-day-number date) ; days this year
1216 (* 365 offset-years) ; + days in prior years
1217 (/ offset-years 4) ; + Julian leap years
1218 (- (/ offset-years 100)) ; - century years
1219 (/ offset-years 400))) ; + Gregorian leap years
1221 ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc).
1222 (setq offset-years (abs (1+ year)))
1223 (- (calendar-day-number date)
1224 (* 365 offset-years)
1225 (/ offset-years 4)
1226 (- (/ offset-years 100))
1227 (/ offset-years 400)
1228 (calendar-day-number '(12 31 -1))))))) ; days in year 1 BC
1230 ;;;###autoload
1231 (defun calendar (&optional arg)
1232 "Display a three-month Gregorian calendar.
1233 The three months appear side by side, with the current month in
1234 the middle surrounded by the previous and next months. The
1235 cursor is put on today's date. If optional prefix argument ARG
1236 is non-nil, prompts for the central month and year.
1238 Once in the calendar window, future or past months can be moved
1239 into view. Arbitrary months can be displayed, or the calendar
1240 can be scrolled forward or backward. The cursor can be moved
1241 forward or backward by one day, one week, one month, or one year.
1242 All of these commands take prefix arguments which, when negative,
1243 cause movement in the opposite direction. For convenience, the
1244 digit keys and the minus sign are automatically prefixes. Use
1245 \\[describe-mode] for details of the key bindings in the calendar
1246 window.
1248 Displays the calendar in a separate window, or optionally in a
1249 separate frame, depending on the value of `calendar-setup'.
1251 If `calendar-view-diary-initially-flag' is non-nil, also displays the
1252 diary entries for the current date (or however many days
1253 `diary-number-of-entries' specifies). This variable can be
1254 overridden by `calendar-setup'. As well as being displayed,
1255 diary entries can also be marked on the calendar (see
1256 `calendar-mark-diary-entries-flag').
1258 Runs the following hooks:
1260 `calendar-load-hook' - after loading calendar.el
1261 `calendar-today-visible-hook', `calendar-today-invisible-hook' - after
1262 generating a calendar, if today's date is visible or not, respectively
1263 `calendar-initial-window-hook' - after first creating a calendar
1265 This function is suitable for execution in an init file."
1266 (interactive "P")
1267 ;; Avoid loading cal-x unless it will be used.
1268 (if (and (memq calendar-setup '(one-frame two-frames calendar-only))
1269 (display-multi-frame-p))
1270 (calendar-frame-setup calendar-setup arg)
1271 (calendar-basic-setup arg)))
1273 (defun calendar-basic-setup (&optional arg nodisplay)
1274 "Create a three-month calendar.
1275 If optional prefix argument ARG is non-nil, prompts for the month
1276 and year, else uses the current date. If NODISPLAY is non-nil, don't
1277 display the generated calendar."
1278 (interactive "P")
1279 (let ((buff (current-buffer)))
1280 (set-buffer (get-buffer-create calendar-buffer))
1281 (calendar-mode)
1282 (let* ((pop-up-windows t)
1283 ;; Not really needed now, but means we use exactly the same
1284 ;; behavior as before in the non-wide case (see below).
1285 (split-height-threshold 1000)
1286 (split-width-threshold calendar-split-width-threshold)
1287 (date (if arg (calendar-read-date t)
1288 (calendar-current-date)))
1289 (month (calendar-extract-month date))
1290 (year (calendar-extract-year date)))
1291 (calendar-increment-month month year (- calendar-offset))
1292 ;; Display the buffer before calling calendar-generate-window so that it
1293 ;; can get a chance to adjust the window sizes to the frame size.
1294 (unless nodisplay
1295 ;; We want a window configuration that looks something like
1296 ;; X X | Y
1297 ;; - -----
1298 ;; C Z | C
1299 ;; where C is the calendar, and the LHS is the traditional,
1300 ;; non-wide frame, and the RHS is the wide frame case.
1301 ;; We should end up in the same state regardless of whether the
1302 ;; windows were initially split or not.
1303 ;; Previously, we only thought about the non-wide case.
1304 ;; We could just set split-height-threshold to 1000, relying on
1305 ;; the fact that the window splitting treated a single window as
1306 ;; a special case and would always split it (vertically). The
1307 ;; same thing does not work in the wide-frame case, so now we do
1308 ;; the splitting by hand.
1309 ;; See discussion in bug#1806.
1310 ;; Actually, this still does not do quite the right thing in the
1311 ;; wide frame case if started from a configuration like the LHS.
1312 ;; Eg if you start with a non-wide frame, call calendar, then
1313 ;; make the frame wider. This one is problematic because you
1314 ;; might need to split a totally unrelated window. Oh well, it
1315 ;; seems unlikely, and perhaps respecting the original layout is
1316 ;; the right thing in that case.
1318 ;; Is this a wide frame? If so, split it horizontally.
1320 ;; The following doesn't sound useful: If we split horizontally
1321 ;; here, the subsequent `pop-to-buffer' will likely split again
1322 ;; horizontally and we end up with three side-by-side windows.
1323 (when (window-splittable-p (selected-window) t)
1324 (split-window-right))
1325 (pop-to-buffer calendar-buffer)
1326 ;; Has the window already been split vertically?
1327 (when (and (not (window-dedicated-p))
1328 (window-splittable-p (selected-window))
1329 (window-full-height-p))
1330 (let ((win (split-window-below)))
1331 ;; In the upper window, show whatever was visible before.
1332 ;; This looks better than using other-buffer.
1333 (switch-to-buffer buff)
1334 ;; Switch to the lower window with the calendar buffer.
1335 (select-window win))))
1336 (calendar-generate-window month year)
1337 (if (and calendar-view-diary-initially-flag
1338 (calendar-date-is-visible-p date))
1339 ;; Do not clobber the calendar with the diary, if the diary
1340 ;; has previously been shown in the window that now shows the
1341 ;; calendar (bug#18381).
1342 (let ((display-buffer-overriding-action
1343 '(nil . ((inhibit-same-window . t)))))
1344 (diary-view-entries)))))
1345 (if calendar-view-holidays-initially-flag
1346 (let* ((diary-buffer (diary-live-p))
1347 (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1348 (split-height-threshold (if diary-window 2 1000)))
1349 ;; FIXME display buffer?
1350 (calendar-list-holidays)))
1351 (run-hooks 'calendar-initial-window-hook))
1353 (defun calendar-generate-window (&optional mon yr)
1354 "Generate the calendar window for the current date.
1355 Optional integers MON and YR are used instead of today's date."
1356 (let* ((inhibit-read-only t)
1357 (today (calendar-current-date))
1358 (month (calendar-extract-month today))
1359 (day (calendar-extract-day today))
1360 (year (calendar-extract-year today))
1361 (today-visible (or (not mon)
1362 (<= (abs (calendar-interval mon yr month year)) 1)))
1363 (in-calendar-window (eq (window-buffer)
1364 (get-buffer calendar-buffer))))
1365 (calendar-generate (or mon month) (or yr year))
1366 (calendar-update-mode-line)
1367 (calendar-cursor-to-visible-date
1368 (if today-visible today (list displayed-month 1 displayed-year)))
1369 (set-buffer-modified-p nil)
1370 ;; Don't do any window-related stuff if we weren't called from a
1371 ;; window displaying the calendar.
1372 (when in-calendar-window
1373 (if (window-combined-p)
1374 ;; Adjust the window to exactly fit the displayed calendar.
1375 (fit-window-to-buffer nil nil calendar-minimum-window-height)
1376 ;; For a full height window or a window that is horizontally
1377 ;; combined don't fit height to that of its buffer.
1378 (set-window-vscroll nil 0))
1379 (sit-for 0))
1380 (and calendar-mark-holidays-flag
1381 ;; (calendar-date-is-valid-p today) ; useful for BC dates
1382 (calendar-mark-holidays)
1383 (and in-calendar-window (sit-for 0)))
1384 (unwind-protect
1385 (if calendar-mark-diary-entries-flag (diary-mark-entries))
1386 (run-hooks (if today-visible
1387 'calendar-today-visible-hook
1388 'calendar-today-invisible-hook)))))
1390 (defun calendar-generate (month year)
1391 "Generate a three-month Gregorian calendar centered around MONTH, YEAR."
1392 ;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on.
1393 ;; Note that while calendars for years BC could be displayed as it
1394 ;; stands, almost all other calendar functions (eg holidays) would
1395 ;; at best have unpredictable results for such dates.
1396 (if (< (+ month (* 12 (1- year))) 2)
1397 (user-error "Months before January, 1 AD cannot be displayed"))
1398 (setq displayed-month month
1399 displayed-year year)
1400 (erase-buffer)
1401 (calendar-increment-month month year -1)
1402 (dotimes (i 3)
1403 (calendar-generate-month month year
1404 (+ calendar-left-margin
1405 (* calendar-month-width i)))
1406 (calendar-increment-month month year 1)))
1408 (defun calendar-move-to-column (indent)
1409 "Like `move-to-column', but indents if the line is too short."
1410 (if (< (move-to-column indent) indent)
1411 (indent-to indent)))
1413 (defun calendar-ensure-newline ()
1414 "Move to the next line, adding a newline if necessary."
1415 (or (zerop (forward-line 1))
1416 (insert "\n")))
1418 (defun calendar-insert-at-column (indent string truncate)
1419 "Move to column INDENT, adding spaces as needed.
1420 Inserts STRING so that it ends at INDENT. STRING is either a
1421 literal string, or a sexp to evaluate to return such. Truncates
1422 STRING to length TRUNCATE, and ensures a trailing space."
1423 (if (not (ignore-errors (stringp (setq string (eval string)))))
1424 (calendar-move-to-column indent)
1425 (if (> (string-width string) truncate)
1426 (setq string (truncate-string-to-width string truncate)))
1427 (or (string-match " $" string)
1428 (setq string (concat (if (= (string-width string) truncate)
1429 (substring string 0 -1)
1430 string)
1431 ;; Avoid inserting text properties unless
1432 ;; we have to (ie, non-unit-width chars).
1433 ;; This is by no means essential.
1434 (if (= (string-width string) (length string))
1436 ;; Cribbed from buff-menu.el.
1437 (propertize
1438 " " 'display `(space :align-to ,indent))))))
1439 (calendar-move-to-column (- indent (string-width string)))
1440 (insert string)))
1442 (defun calendar-generate-month (month year indent)
1443 "Produce a calendar for MONTH, YEAR on the Gregorian calendar.
1444 The calendar is inserted at the top of the buffer in which point is currently
1445 located, but indented INDENT spaces. The indentation is done from the first
1446 character on the line and does not disturb the first INDENT characters on the
1447 line."
1448 (let ((blank-days ; at start of month
1449 (mod
1450 (- (calendar-day-of-week (list month 1 year))
1451 calendar-week-start-day)
1453 (last (calendar-last-day-of-month month year))
1454 (trunc (min calendar-intermonth-spacing
1455 (1- calendar-left-margin)))
1456 (day 1)
1458 (goto-char (point-min))
1459 (calendar-move-to-column indent)
1460 (insert
1461 (calendar-string-spread (list calendar-month-header)
1462 ?\s calendar-month-digit-width))
1463 (calendar-ensure-newline)
1464 (calendar-insert-at-column indent calendar-intermonth-header trunc)
1465 ;; Use the first N characters of each day to head the columns.
1466 (dotimes (i 7)
1467 (setq j (mod (+ calendar-week-start-day i) 7))
1468 (insert
1469 (truncate-string-to-width
1470 (propertize (calendar-day-name j 'header t)
1471 'font-lock-face (if (memq j calendar-weekend-days)
1472 'calendar-weekend-header
1473 'calendar-weekday-header))
1474 calendar-day-header-width nil ?\s)
1475 (make-string (- calendar-column-width calendar-day-header-width) ?\s)))
1476 (calendar-ensure-newline)
1477 (calendar-insert-at-column indent calendar-intermonth-text trunc)
1478 ;; Add blank days before the first of the month.
1479 (insert (make-string (* blank-days calendar-column-width) ?\s))
1480 ;; Put in the days of the month.
1481 (dotimes (i last)
1482 (setq day (1+ i))
1483 ;; TODO should numbers be left-justified, centered...?
1484 (insert (propertize
1485 (format (format "%%%dd" calendar-day-digit-width) day)
1486 'mouse-face 'highlight
1487 'help-echo (eval calendar-date-echo-text)
1488 ;; 'date property prevents intermonth text confusing re-searches.
1489 ;; (Tried intangible, it did not really work.)
1490 'date t)
1491 (make-string
1492 (- calendar-column-width calendar-day-digit-width) ?\s))
1493 (when (and (zerop (mod (+ day blank-days) 7))
1494 (/= day last))
1495 (calendar-ensure-newline)
1496 (setq day (1+ day)) ; first day of next week
1497 (calendar-insert-at-column indent calendar-intermonth-text trunc)))))
1499 (defun calendar-redraw ()
1500 "Redraw the calendar display, if `calendar-buffer' is live."
1501 (interactive)
1502 (when (get-buffer calendar-buffer)
1503 (with-current-buffer calendar-buffer
1504 (let ((cursor-date (calendar-cursor-to-nearest-date)))
1505 (calendar-generate-window displayed-month displayed-year)
1506 (calendar-cursor-to-visible-date cursor-date))
1507 (when (window-live-p (get-buffer-window))
1508 (set-window-point (get-buffer-window) (point))))))
1510 (defvar calendar-mode-map
1511 (let ((map (make-keymap)))
1512 (suppress-keymap map)
1513 (dolist (c '(narrow-to-region mark-word mark-sexp mark-paragraph
1514 mark-defun mark-whole-buffer mark-page
1515 downcase-region upcase-region kill-region
1516 copy-region-as-kill capitalize-region write-region))
1517 (define-key map (vector 'remap c) 'calendar-not-implemented))
1518 (define-key map "<" 'calendar-scroll-right)
1519 (define-key map "\C-x<" 'calendar-scroll-right)
1520 (define-key map [prior] 'calendar-scroll-right-three-months)
1521 (define-key map "\ev" 'calendar-scroll-right-three-months)
1522 (define-key map ">" 'calendar-scroll-left)
1523 (define-key map "\C-x>" 'calendar-scroll-left)
1524 (define-key map [next] 'calendar-scroll-left-three-months)
1525 (define-key map "\C-v" 'calendar-scroll-left-three-months)
1526 (define-key map "\C-b" 'calendar-backward-day)
1527 (define-key map "\C-p" 'calendar-backward-week)
1528 (define-key map "\e{" 'calendar-backward-month)
1529 (define-key map "\C-x[" 'calendar-backward-year)
1530 (define-key map "\C-f" 'calendar-forward-day)
1531 (define-key map "\C-n" 'calendar-forward-week)
1532 (define-key map [left] 'calendar-backward-day)
1533 (define-key map [up] 'calendar-backward-week)
1534 (define-key map [right] 'calendar-forward-day)
1535 (define-key map [down] 'calendar-forward-week)
1536 (define-key map "\e}" 'calendar-forward-month)
1537 (define-key map "\C-x]" 'calendar-forward-year)
1538 (define-key map "\C-a" 'calendar-beginning-of-week)
1539 (define-key map "\C-e" 'calendar-end-of-week)
1540 (define-key map "\ea" 'calendar-beginning-of-month)
1541 (define-key map "\ee" 'calendar-end-of-month)
1542 (define-key map "\e<" 'calendar-beginning-of-year)
1543 (define-key map "\e>" 'calendar-end-of-year)
1544 (define-key map "\C-@" 'calendar-set-mark)
1545 ;; Many people are used to typing C-SPC and getting C-@.
1546 (define-key map [?\C-\s] 'calendar-set-mark)
1547 (define-key map "\C-x\C-x" 'calendar-exchange-point-and-mark)
1548 (define-key map "\e=" 'calendar-count-days-region)
1549 (define-key map "gd" 'calendar-goto-date)
1550 (define-key map "gD" 'calendar-goto-day-of-year)
1551 (define-key map "gj" 'calendar-julian-goto-date)
1552 (define-key map "ga" 'calendar-astro-goto-day-number)
1553 (define-key map "gh" 'calendar-hebrew-goto-date)
1554 (define-key map "gi" 'calendar-islamic-goto-date)
1555 (define-key map "gb" 'calendar-bahai-goto-date)
1556 (define-key map "gC" 'calendar-chinese-goto-date)
1557 (define-key map "gk" 'calendar-coptic-goto-date)
1558 (define-key map "ge" 'calendar-ethiopic-goto-date)
1559 (define-key map "gp" 'calendar-persian-goto-date)
1560 (define-key map "gc" 'calendar-iso-goto-date)
1561 (define-key map "gw" 'calendar-iso-goto-week)
1562 (define-key map "gf" 'calendar-french-goto-date)
1563 (define-key map "gml" 'calendar-mayan-goto-long-count-date)
1564 (define-key map "gmpc" 'calendar-mayan-previous-round-date)
1565 (define-key map "gmnc" 'calendar-mayan-next-round-date)
1566 (define-key map "gmph" 'calendar-mayan-previous-haab-date)
1567 (define-key map "gmnh" 'calendar-mayan-next-haab-date)
1568 (define-key map "gmpt" 'calendar-mayan-previous-tzolkin-date)
1569 (define-key map "gmnt" 'calendar-mayan-next-tzolkin-date)
1570 (define-key map "Aa" 'appt-add)
1571 (define-key map "Ad" 'appt-delete)
1572 (define-key map "S" 'calendar-sunrise-sunset)
1573 (define-key map "M" 'calendar-lunar-phases)
1574 (define-key map " " 'scroll-other-window)
1575 (define-key map [?\S-\ ] 'scroll-other-window-down)
1576 (define-key map "\d" 'scroll-other-window-down)
1577 (define-key map "\C-c\C-l" 'calendar-redraw)
1578 (define-key map "." 'calendar-goto-today)
1579 (define-key map "o" 'calendar-other-month)
1580 (define-key map "q" 'calendar-exit)
1581 (define-key map "a" 'calendar-list-holidays)
1582 (define-key map "h" 'calendar-cursor-holidays)
1583 (define-key map "x" 'calendar-mark-holidays)
1584 (define-key map "u" 'calendar-unmark)
1585 (define-key map "m" 'diary-mark-entries)
1586 (define-key map "d" 'diary-view-entries)
1587 (define-key map "D" 'diary-view-other-diary-entries)
1588 (define-key map "s" 'diary-show-all-entries)
1589 (define-key map "pd" 'calendar-print-day-of-year)
1590 (define-key map "pC" 'calendar-chinese-print-date)
1591 (define-key map "pk" 'calendar-coptic-print-date)
1592 (define-key map "pe" 'calendar-ethiopic-print-date)
1593 (define-key map "pp" 'calendar-persian-print-date)
1594 (define-key map "pc" 'calendar-iso-print-date)
1595 (define-key map "pj" 'calendar-julian-print-date)
1596 (define-key map "pa" 'calendar-astro-print-day-number)
1597 (define-key map "ph" 'calendar-hebrew-print-date)
1598 (define-key map "pi" 'calendar-islamic-print-date)
1599 (define-key map "pb" 'calendar-bahai-print-date)
1600 (define-key map "pf" 'calendar-french-print-date)
1601 (define-key map "pm" 'calendar-mayan-print-date)
1602 (define-key map "po" 'calendar-print-other-dates)
1603 (define-key map "id" 'diary-insert-entry)
1604 (define-key map "iw" 'diary-insert-weekly-entry)
1605 (define-key map "im" 'diary-insert-monthly-entry)
1606 (define-key map "iy" 'diary-insert-yearly-entry)
1607 (define-key map "ia" 'diary-insert-anniversary-entry)
1608 (define-key map "ib" 'diary-insert-block-entry)
1609 (define-key map "ic" 'diary-insert-cyclic-entry)
1610 (define-key map "ihd" 'diary-hebrew-insert-entry)
1611 (define-key map "ihm" 'diary-hebrew-insert-monthly-entry)
1612 (define-key map "ihy" 'diary-hebrew-insert-yearly-entry)
1613 (define-key map "iid" 'diary-islamic-insert-entry)
1614 (define-key map "iim" 'diary-islamic-insert-monthly-entry)
1615 (define-key map "iiy" 'diary-islamic-insert-yearly-entry)
1616 (define-key map "iBd" 'diary-bahai-insert-entry)
1617 (define-key map "iBm" 'diary-bahai-insert-monthly-entry)
1618 (define-key map "iBy" 'diary-bahai-insert-yearly-entry)
1619 (define-key map "iCd" 'diary-chinese-insert-entry)
1620 (define-key map "iCm" 'diary-chinese-insert-monthly-entry)
1621 (define-key map "iCy" 'diary-chinese-insert-yearly-entry)
1622 (define-key map "iCa" 'diary-chinese-insert-anniversary-entry)
1623 (define-key map "?" 'calendar-goto-info-node)
1624 (define-key map "Hm" 'cal-html-cursor-month)
1625 (define-key map "Hy" 'cal-html-cursor-year)
1626 (define-key map "tm" 'cal-tex-cursor-month)
1627 (define-key map "tM" 'cal-tex-cursor-month-landscape)
1628 (define-key map "td" 'cal-tex-cursor-day)
1629 (define-key map "tw1" 'cal-tex-cursor-week)
1630 (define-key map "tw2" 'cal-tex-cursor-week2)
1631 (define-key map "tw3" 'cal-tex-cursor-week-iso) ; FIXME twi ?
1632 (define-key map "tw4" 'cal-tex-cursor-week-monday) ; twm ?
1633 (define-key map "twW" 'cal-tex-cursor-week2-summary)
1634 (define-key map "tfd" 'cal-tex-cursor-filofax-daily)
1635 (define-key map "tfw" 'cal-tex-cursor-filofax-2week)
1636 (define-key map "tfW" 'cal-tex-cursor-filofax-week)
1637 (define-key map "tfy" 'cal-tex-cursor-filofax-year)
1638 (define-key map "ty" 'cal-tex-cursor-year)
1639 (define-key map "tY" 'cal-tex-cursor-year-landscape)
1641 (define-key map [menu-bar edit] 'undefined)
1642 (define-key map [menu-bar search] 'undefined)
1644 (easy-menu-define nil map nil cal-menu-sunmoon-menu)
1645 (easy-menu-define nil map nil cal-menu-diary-menu)
1646 (easy-menu-define nil map nil cal-menu-holidays-menu)
1647 (easy-menu-define nil map nil cal-menu-goto-menu)
1648 (easy-menu-define nil map nil cal-menu-scroll-menu)
1650 ;; These are referenced in the default calendar-date-echo-text.
1651 (define-key map [down-mouse-3]
1652 (easy-menu-binding cal-menu-context-mouse-menu))
1653 (define-key map [down-mouse-2]
1654 (easy-menu-binding cal-menu-global-mouse-menu))
1656 ;; cf scroll-bar.el.
1657 (if (and (boundp 'x-toolkit-scroll-bars) x-toolkit-scroll-bars)
1658 (define-key map [vertical-scroll-bar mouse-1]
1659 'calendar-scroll-toolkit-scroll)
1660 ;; Left-click moves us forward in time, right-click backwards.
1661 (define-key map [vertical-scroll-bar mouse-1] 'calendar-scroll-left)
1662 (define-key map [vertical-scroll-bar drag-mouse-1] 'calendar-scroll-left)
1663 ;; down-mouse-2 stays as scroll-bar-drag.
1664 (define-key map [vertical-scroll-bar mouse-3] 'calendar-scroll-right)
1665 (define-key map [vertical-scroll-bar drag-mouse-3]
1666 'calendar-scroll-right))
1667 map)
1668 "Keymap for `calendar-mode'.")
1670 ;; Calendar mode is suitable only for specially formatted data.
1671 (put 'calendar-mode 'mode-class 'special)
1673 (defun calendar-mode-line-entry (command echo &optional key string)
1674 "Return a propertized string for `calendar-mode-line-format'.
1675 COMMAND is a command to run, ECHO is the help-echo text, KEY
1676 is COMMAND's keybinding, STRING describes the binding."
1677 (propertize (or key
1678 (substitute-command-keys
1679 (format "\\<calendar-mode-map>\\[%s] %s" command string)))
1680 'help-echo (format "mouse-1: %s" echo)
1681 'mouse-face 'mode-line-highlight
1682 'keymap (make-mode-line-mouse-map 'mouse-1 command)))
1684 ;; After calendar-mode-map.
1685 (defcustom calendar-mode-line-format
1686 (list
1687 (calendar-mode-line-entry 'calendar-scroll-right "previous month" "<")
1688 "Calendar"
1689 (concat
1690 (calendar-mode-line-entry 'calendar-goto-info-node "read Info on Calendar"
1691 nil "info")
1692 " / "
1693 (calendar-mode-line-entry 'calendar-other-month "choose another month"
1694 nil "other")
1695 " / "
1696 (calendar-mode-line-entry 'calendar-goto-today "go to today's date"
1697 nil "today"))
1698 '(calendar-date-string (calendar-current-date) t)
1699 (calendar-mode-line-entry 'calendar-scroll-left "next month" ">"))
1700 "If non-nil, the mode line of the calendar buffer.
1701 This is a list of items that evaluate to strings. The elements
1702 are evaluated and concatenated, evenly separated by blanks.
1703 During evaluation, the variable `date' is available as the date
1704 nearest the cursor (or today's date if that fails). To update
1705 the mode-line as the cursor moves, add
1706 `calendar-update-mode-line' to `calendar-move-hook'.
1708 If nil, do not modify the mode line at all.
1710 Here is an example that has the Hebrew date, the day number/days
1711 remaining in the year, and the ISO week/year numbers:
1713 (list
1714 \"\"
1715 \\='(calendar-hebrew-date-string date)
1716 \\='(let* ((year (calendar-extract-year date))
1717 (d (calendar-day-number date))
1718 (days-remaining
1719 (- (calendar-day-number (list 12 31 year)) d)))
1720 (format \"%d/%d\" d days-remaining))
1721 \\='(let* ((d (calendar-absolute-from-gregorian date))
1722 (iso-date (calendar-iso-from-absolute d)))
1723 (format \"ISO week %d of %d\"
1724 (calendar-extract-month iso-date)
1725 (calendar-extract-year iso-date)))
1726 \"\"))"
1727 :risky t
1728 :type 'sexp
1729 :group 'calendar)
1731 (defun calendar-goto-info-node ()
1732 "Go to the info node for the calendar."
1733 (interactive)
1734 (info "(emacs)Calendar/Diary")
1735 (fit-window-to-buffer))
1737 (defvar calendar-mark-ring nil
1738 "Used by `calendar-set-mark'.")
1740 (define-derived-mode calendar-mode nil "Calendar"
1741 "A major mode for the calendar window.
1742 For a complete description, see the info node `Calendar/Diary'.
1744 \\<calendar-mode-map>\\{calendar-mode-map}"
1745 (setq buffer-read-only t
1746 buffer-undo-list t
1747 indent-tabs-mode nil)
1748 (set (make-local-variable 'scroll-margin) 0) ; bug#10379
1749 (calendar-update-mode-line)
1750 (make-local-variable 'calendar-mark-ring)
1751 (make-local-variable 'displayed-month) ; month in middle of window
1752 (make-local-variable 'displayed-year) ; year in middle of window
1753 ;; Most functions only work if displayed-month and displayed-year are set,
1754 ;; so let's make sure they're always set. Most likely, this will be reset
1755 ;; soon in calendar-generate, but better safe than sorry.
1756 (unless (boundp 'displayed-month) (setq displayed-month 1))
1757 (unless (boundp 'displayed-year) (setq displayed-year 2001))
1758 (if (bound-and-true-p calendar-font-lock-keywords)
1759 (set (make-local-variable 'font-lock-defaults)
1760 '(calendar-font-lock-keywords t))))
1762 (defun calendar-string-spread (strings char length)
1763 "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
1764 The effect is like mapconcat but the separating pieces are as balanced as
1765 possible. Each item of STRINGS is evaluated before concatenation so it can
1766 actually be an expression that evaluates to a string. If LENGTH is too short,
1767 the STRINGS are just concatenated and the result truncated."
1768 ;; The algorithm is based on equation (3.25) on page 85 of Concrete
1769 ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
1770 ;; Addison-Wesley, Reading, MA, 1989.
1771 (let* ((strings (mapcar 'eval
1772 (if (< (length strings) 2)
1773 (append (list "") strings (list ""))
1774 strings)))
1775 (n (- length (string-width (apply 'concat strings))))
1776 (m (* (1- (length strings)) (char-width char)))
1777 (s (car strings))
1778 (strings (cdr strings))
1779 (i 0))
1780 (dolist (string strings)
1781 (setq s (concat s
1782 (make-string (max 0 (/ (+ n i) m)) char)
1783 string)
1784 i (1+ i)))
1785 (truncate-string-to-width s length)))
1787 (defun calendar-update-mode-line ()
1788 "Update the calendar mode line with the current date and date style."
1789 (if (and calendar-mode-line-format
1790 (bufferp (get-buffer calendar-buffer)))
1791 (with-current-buffer calendar-buffer
1792 (let ((start (- calendar-left-margin 2))
1793 (date (condition-case nil
1794 (calendar-cursor-to-nearest-date)
1795 (error (calendar-current-date)))))
1796 (setq mode-line-format
1797 (concat (make-string (max 0 (+ start
1798 (- (car (window-inside-edges))
1799 (car (window-edges))))) ?\s)
1800 (calendar-string-spread
1801 (mapcar 'eval calendar-mode-line-format)
1802 ?\s (- calendar-right-margin (1- start))))))
1803 (force-mode-line-update))))
1805 (defun calendar-buffer-list ()
1806 "List of all calendar-related buffers (as buffers, not strings)."
1807 (let (buffs)
1808 (dolist (b (list calendar-hebrew-yahrzeit-buffer lunar-phases-buffer
1809 holiday-buffer diary-fancy-buffer solar-sunrises-buffer
1810 (get-file-buffer diary-file)
1811 calendar-buffer calendar-other-calendars-buffer))
1812 (and b (setq b (get-buffer b))
1813 (push b buffs)))
1814 buffs))
1816 (defun calendar-exit (&optional kill)
1817 "Get out of the calendar window and hide it and related buffers."
1818 (interactive "P")
1819 (let ((diary-buffer (get-file-buffer diary-file))
1820 (calendar-buffers (calendar-buffer-list)))
1821 (when (or (not diary-buffer)
1822 (not (buffer-modified-p diary-buffer))
1823 (yes-or-no-p
1824 "Diary modified; do you really want to exit the calendar? "))
1825 (if (and calendar-setup (display-multi-frame-p))
1826 ;; FIXME: replace this cruft with the `quit-restore' window property
1827 (dolist (w (window-list-1 nil nil t))
1828 (if (and (memq (window-buffer w) calendar-buffers)
1829 (window-dedicated-p w))
1830 (if (eq (window-deletable-p w) 'frame)
1831 (if calendar-remove-frame-by-deleting
1832 (delete-frame (window-frame w))
1833 (iconify-frame (window-frame w)))
1834 (quit-window kill w))))
1835 (dolist (b calendar-buffers)
1836 (quit-windows-on b kill))))))
1838 (defun calendar-current-date (&optional offset)
1839 "Return the current date in a list (month day year).
1840 Optional integer OFFSET is a number of days from the current date."
1841 (let* ((now (decode-time))
1842 (now (list (nth 4 now) (nth 3 now) (nth 5 now))))
1843 (if (zerop (or offset 0))
1845 (calendar-gregorian-from-absolute
1846 (+ offset (calendar-absolute-from-gregorian now))))))
1848 (defun calendar-column-to-segment ()
1849 "Convert current column to calendar month \"segment\".
1850 The left-most month returns 0, the next right 1, and so on."
1851 (let ((col (max 0 (+ (current-column)
1852 (/ calendar-intermonth-spacing 2)
1853 (- calendar-left-margin)))))
1854 (/ col (+ (* 7 calendar-column-width) calendar-intermonth-spacing))))
1856 (defun calendar-cursor-to-date (&optional error event)
1857 "Return a list (month day year) of current cursor position.
1858 If cursor is not on a specific date, signals an error if optional parameter
1859 ERROR is non-nil, otherwise just returns nil.
1860 If EVENT is non-nil, it's an event indicating the buffer position to
1861 use instead of point."
1862 (with-current-buffer
1863 (if event (window-buffer (posn-window (event-start event)))
1864 (current-buffer))
1865 (save-excursion
1866 (and event (setq event (event-start event))
1867 (goto-char (posn-point event)))
1868 (let* ((segment (calendar-column-to-segment))
1869 (month (% (+ displayed-month (1- segment)) 12)))
1870 ;; Call with point on either of the two digits in a 2-digit date,
1871 ;; or on or before the digit of a 1-digit date.
1872 (if (not (and (looking-at "[ 0-9]?[0-9][^0-9]")
1873 (get-text-property (point) 'date)))
1874 (if error (user-error "Not on a date!"))
1875 ;; Convert segment to real month and year.
1876 (if (zerop month) (setq month 12))
1877 ;; Go back to before the first date digit.
1878 (or (looking-at " ")
1879 (re-search-backward "[^0-9]"))
1880 (list month
1881 (string-to-number
1882 (buffer-substring (1+ (point))
1883 (+ 1 calendar-day-digit-width (point))))
1884 (cond
1885 ((and (= 12 month) (zerop segment)) (1- displayed-year))
1886 ((and (= 1 month) (= segment 2)) (1+ displayed-year))
1887 (t displayed-year))))))))
1889 ;; The following version of calendar-gregorian-from-absolute is preferred for
1890 ;; reasons of clarity, BUT it's much slower than the version that follows it.
1892 ;;(defun calendar-gregorian-from-absolute (date)
1893 ;; "Compute the list (month day year) corresponding to the absolute DATE.
1894 ;;The absolute date is the number of days elapsed since the (imaginary)
1895 ;;Gregorian date Sunday, December 31, 1 BC."
1896 ;; (let* ((approx (/ date 366)) ; approximation from below
1897 ;; (year ; search forward from the approximation
1898 ;; (+ approx
1899 ;; (calendar-sum y approx
1900 ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y))))
1901 ;; 1)))
1902 ;; (month ; search forward from January
1903 ;; (1+ (calendar-sum m 1
1904 ;; (> date
1905 ;; (calendar-absolute-from-gregorian
1906 ;; (list m (calendar-last-day-of-month m year) year)))
1907 ;; 1)))
1908 ;; (day ; calculate the day by subtraction
1909 ;; (- date
1910 ;; (1- (calendar-absolute-from-gregorian (list month 1 year))))))
1911 ;; (list month day year)))
1913 (defun calendar-gregorian-from-absolute (date)
1914 "Compute the list (month day year) corresponding to the absolute DATE.
1915 The absolute date is the number of days elapsed since the (imaginary)
1916 Gregorian date Sunday, December 31, 1 BC. This function does not
1917 handle dates in years BC."
1918 ;; See the footnote on page 384 of ``Calendrical Calculations, Part II:
1919 ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M.
1920 ;; Clamen, Software--Practice and Experience, Volume 23, Number 4
1921 ;; (April, 1993), pages 383-404 for an explanation.
1922 (let* ((d0 (1- date))
1923 (n400 (/ d0 146097))
1924 (d1 (% d0 146097))
1925 (n100 (/ d1 36524))
1926 (d2 (% d1 36524))
1927 (n4 (/ d2 1461))
1928 (d3 (% d2 1461))
1929 (n1 (/ d3 365))
1930 (day (1+ (% d3 365)))
1931 (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1))
1932 (month 1)
1933 mdays)
1934 (if (or (= n100 4) (= n1 4))
1935 (list 12 31 year)
1936 (setq year (1+ year))
1937 (while (< (setq mdays (calendar-last-day-of-month month year)) day)
1938 (setq day (- day mdays)
1939 month (1+ month)))
1940 (list month day year))))
1942 (defun calendar-other-month (month year &optional event)
1943 "Display a three-month calendar centered around MONTH and YEAR.
1944 EVENT is an event like `last-nonmenu-event'."
1945 (interactive (let ((event (list last-nonmenu-event)))
1946 (append (calendar-read-date 'noday) event)))
1947 (save-selected-window
1948 (and event
1949 (setq event (event-start event))
1950 (select-window (posn-window event)))
1951 (unless (and (= month displayed-month)
1952 (= year displayed-year))
1953 (let ((old-date (calendar-cursor-to-date))
1954 (today (calendar-current-date)))
1955 (calendar-generate-window month year)
1956 (calendar-cursor-to-visible-date
1957 (cond
1958 ((calendar-date-is-visible-p old-date) old-date)
1959 ((calendar-date-is-visible-p today) today)
1960 (t (list month 1 year))))))))
1962 (defun calendar-set-mark (arg &optional event)
1963 "Mark the date under the cursor, or jump to marked date.
1964 With no prefix argument, push current date onto marked date ring.
1965 With argument ARG, jump to mark, pop it, and put point at end of ring."
1966 (interactive
1967 (list current-prefix-arg last-nonmenu-event))
1968 (let ((date (calendar-cursor-to-date t event)))
1969 (if arg
1970 (if (null calendar-mark-ring)
1971 (error "No mark set in this buffer")
1972 (calendar-goto-date (car calendar-mark-ring))
1973 (setq calendar-mark-ring
1974 (cdr (nconc calendar-mark-ring (list date)))))
1975 (push date calendar-mark-ring)
1976 ;; Since the top of the mark ring is the marked date in the
1977 ;; calendar, the mark ring in the calendar is one longer than
1978 ;; in other buffers to get the same effect.
1979 (if (> (length calendar-mark-ring) (1+ mark-ring-max))
1980 (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil))
1981 (message "Mark set"))))
1983 (defun calendar-exchange-point-and-mark ()
1984 "Exchange the current cursor position with the marked date."
1985 (interactive)
1986 (let ((mark (car calendar-mark-ring))
1987 (date (calendar-cursor-to-date t)))
1988 (if (null mark)
1989 (error "No mark set in this buffer")
1990 (setq calendar-mark-ring (cons date (cdr calendar-mark-ring)))
1991 (calendar-goto-date mark))))
1993 (defun calendar-count-days-region ()
1994 "Count the number of days (inclusive) between point and the mark."
1995 (interactive)
1996 (let* ((days (- (calendar-absolute-from-gregorian
1997 (calendar-cursor-to-date t))
1998 (calendar-absolute-from-gregorian
1999 (or (car calendar-mark-ring)
2000 (error "No mark set in this buffer")))))
2001 (days (1+ (if (> days 0) days (- days)))))
2002 (message "Region has %d day%s (inclusive)"
2003 days (if (> days 1) "s" ""))))
2005 (defun calendar-not-implemented ()
2006 "Not implemented."
2007 (interactive)
2008 (error "%s not available in the calendar"
2009 (global-key-binding (this-command-keys))))
2011 (defun calendar-read (prompt acceptable &optional initial-contents)
2012 "Return an object read from the minibuffer.
2013 Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
2014 entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
2015 is a string to insert in the minibuffer before reading."
2016 (let ((value (read-minibuffer prompt initial-contents)))
2017 (while (not (funcall acceptable value))
2018 (setq value (read-minibuffer prompt initial-contents)))
2019 value))
2022 (defun calendar-customized-p (symbol)
2023 "Return non-nil if SYMBOL has been customized."
2024 (and (default-boundp symbol)
2025 (let ((standard (get symbol 'standard-value)))
2026 (and standard
2027 (not (equal (eval (car standard)) (default-value symbol)))))))
2029 (defun calendar-abbrev-construct (full &optional maxlen)
2030 "From sequence FULL, return a vector of abbreviations.
2031 Each abbreviation is no longer than MAXLEN (default `calendar-abbrev-length')
2032 characters."
2033 (or maxlen (setq maxlen calendar-abbrev-length))
2034 (apply 'vector (mapcar
2035 (lambda (f)
2036 ;; TODO? truncate-string-to-width?
2037 (substring f 0 (min maxlen (length f))))
2038 full)))
2040 (defcustom calendar-day-name-array
2041 ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"]
2042 "Array of capitalized strings giving, in order from Sunday, the day names.
2043 If you change this without using customize after the calendar has loaded,
2044 then you may also want to change `calendar-day-abbrev-array'
2045 and `calendar-day-header-array'."
2046 :group 'calendar
2047 :initialize 'custom-initialize-default
2048 :set (lambda (symbol value)
2049 (let ((dcustomized (calendar-customized-p 'calendar-day-abbrev-array))
2050 (hcustomized (calendar-customized-p 'cal-html-day-abbrev-array))
2051 (ccustomized (calendar-customized-p 'calendar-day-header-array)))
2052 (set symbol value)
2053 (or dcustomized
2054 (setq calendar-day-abbrev-array
2055 (calendar-abbrev-construct calendar-day-name-array)))
2056 (and (not hcustomized)
2057 (boundp 'cal-html-day-abbrev-array)
2058 (setq cal-html-day-abbrev-array calendar-day-abbrev-array))
2059 (or ccustomized
2060 (equal calendar-day-header-array
2061 (setq calendar-day-header-array
2062 (calendar-day-header-construct)))
2063 (calendar-redraw))))
2064 :type '(vector (string :tag "Sunday")
2065 (string :tag "Monday")
2066 (string :tag "Tuesday")
2067 (string :tag "Wednesday")
2068 (string :tag "Thursday")
2069 (string :tag "Friday")
2070 (string :tag "Saturday")))
2072 (defcustom calendar-abbrev-length 3
2073 "Default length of abbreviations to use for day and month names.
2074 If you change this without using customize after the calendar has loaded,
2075 then you may also want to change `calendar-day-abbrev-array' and
2076 `calendar-month-abbrev-array'."
2077 :group 'calendar
2078 :initialize 'custom-initialize-default
2079 :set (lambda (symbol value)
2080 (let ((dcustomized (calendar-customized-p 'calendar-day-abbrev-array))
2081 (mcustomized (calendar-customized-p
2082 'calendar-month-abbrev-array))
2083 (hcustomized (calendar-customized-p 'cal-html-day-abbrev-array))
2084 (ccustomized (calendar-customized-p 'calendar-day-header-array)))
2085 (set symbol value)
2086 (or dcustomized
2087 (setq calendar-day-abbrev-array
2088 (calendar-abbrev-construct calendar-day-name-array)))
2089 (or mcustomized
2090 (setq calendar-month-abbrev-array
2091 (calendar-abbrev-construct calendar-month-name-array)))
2092 (and (not hcustomized)
2093 (boundp 'cal-html-day-abbrev-array)
2094 (setq cal-html-day-abbrev-array calendar-day-abbrev-array))
2095 (or ccustomized
2096 (equal calendar-day-header-array
2097 (setq calendar-day-header-array
2098 (calendar-day-header-construct)))
2099 (calendar-redraw))))
2100 :type 'integer)
2102 (defcustom calendar-day-abbrev-array
2103 (calendar-abbrev-construct calendar-day-name-array)
2104 "Array of capitalized strings giving the abbreviated day names.
2105 The order should be the same as that of the full names specified
2106 in `calendar-day-name-array'. These abbreviations may be used
2107 instead of the full names in the diary file. Do not include a
2108 trailing `.' in the strings specified in this variable, though
2109 you may use such in the diary file. By default, each string is
2110 the first `calendar-abbrev-length' characters of the corresponding
2111 full name."
2112 :group 'calendar
2113 :initialize 'custom-initialize-default
2114 :set-after '(calendar-abbrev-length calendar-day-name-array)
2115 :set (lambda (symbol value)
2116 (let ((hcustomized (calendar-customized-p 'cal-html-day-abbrev-array))
2117 (ccustomized (calendar-customized-p 'calendar-day-header-array)))
2118 (set symbol value)
2119 (and (not hcustomized)
2120 (boundp 'cal-html-day-abbrev-array)
2121 (setq cal-html-day-abbrev-array calendar-day-abbrev-array))
2122 (or ccustomized
2123 (equal calendar-day-header-array
2124 (setq calendar-day-header-array
2125 (calendar-day-header-construct)))
2126 (calendar-redraw))))
2127 :type '(vector (string :tag "Sun")
2128 (string :tag "Mon")
2129 (string :tag "Tue")
2130 (string :tag "Wed")
2131 (string :tag "Thu")
2132 (string :tag "Fri")
2133 (string :tag "Sat"))
2134 ;; Made defcustom, changed defaults from nil nil...
2135 :version "24.1")
2137 (defcustom calendar-day-header-array (calendar-day-header-construct)
2138 "Array of strings to use for the headers of the calendar's day columns.
2139 The order should be the same as in `calendar-day-name-array'.
2140 In use, the calendar truncates elements to no more than
2141 `calendar-day-header-width' columns wide.
2142 Emacs constructs the default from either `calendar-day-name-array'
2143 \(if `calendar-day-header-width' is more than `calendar-abbrev-length'),
2144 or from `calendar-day-abbrev-array' (assuming that the abbreviated
2145 name are more likely to be unique when truncated)."
2146 :group 'calendar
2147 :initialize 'custom-initialize-default
2148 :set-after '(calendar-day-header-width
2149 calendar-abbrev-length calendar-day-name-array
2150 calendar-day-abbrev-array)
2151 :set (lambda (symbol value)
2152 (or (equal calendar-day-header-array
2153 (set symbol value))
2154 (calendar-redraw)))
2155 :type '(vector (string :tag "Su")
2156 (string :tag "Mo")
2157 (string :tag "Tu")
2158 (string :tag "We")
2159 (string :tag "Th")
2160 (string :tag "Fr")
2161 (string :tag "Sa"))
2162 :version "24.4")
2164 (defcustom calendar-month-name-array
2165 ["January" "February" "March" "April" "May" "June"
2166 "July" "August" "September" "October" "November" "December"]
2167 "Array of capitalized strings giving, in order, the month names.
2168 If you change this without using customize after the calendar has loaded,
2169 then you may also want to change `calendar-month-abbrev-array'."
2170 :group 'calendar
2171 :initialize 'custom-initialize-default
2172 :set (lambda (symbol value)
2173 (let ((mcustomized (calendar-customized-p
2174 'calendar-month-abbrev-array)))
2175 (set symbol value)
2176 (or mcustomized
2177 (setq calendar-month-abbrev-array
2178 (calendar-abbrev-construct calendar-month-name-array)))))
2179 :type '(vector (string :tag "January")
2180 (string :tag "February")
2181 (string :tag "March")
2182 (string :tag "April")
2183 (string :tag "May")
2184 (string :tag "June")
2185 (string :tag "July")
2186 (string :tag "August")
2187 (string :tag "September")
2188 (string :tag "October")
2189 (string :tag "November")
2190 (string :tag "December")))
2192 (defcustom calendar-month-abbrev-array
2193 (calendar-abbrev-construct calendar-month-name-array)
2194 "Array of capitalized strings giving the abbreviated month names.
2195 The order should be the same as that of the full names specified
2196 in `calendar-month-name-array'. These abbreviations are used in
2197 the calendar menu entries, and can also be used in the diary
2198 file. Do not include a trailing `.' in the strings specified in
2199 this variable, though you may use such in the diary file. By
2200 default, each string is the first `calendar-abbrev-length'
2201 characters of the corresponding full name."
2202 :group 'calendar
2203 :set-after '(calendar-abbrev-length calendar-month-name-array)
2204 :type '(vector (string :tag "Jan")
2205 (string :tag "Feb")
2206 (string :tag "Mar")
2207 (string :tag "Apr")
2208 (string :tag "May")
2209 (string :tag "Jun")
2210 (string :tag "Jul")
2211 (string :tag "Aug")
2212 (string :tag "Sep")
2213 (string :tag "Oct")
2214 (string :tag "Nov")
2215 (string :tag "Dec"))
2216 ;; Made defcustom, changed defaults from nil nil...
2217 :version "24.1")
2219 (defun calendar-make-alist (sequence &optional start-index filter
2220 &rest sequences)
2221 "Return an association list corresponding to SEQUENCE.
2222 Associates each element of SEQUENCE with an incremented integer,
2223 starting from START-INDEX (default 1). Applies the function FILTER,
2224 if provided, to each key in the alist. Repeats the process, with
2225 indices starting from START-INDEX each time, for any remaining
2226 arguments SEQUENCES."
2227 (or start-index (setq start-index 1))
2228 (let (index alist)
2229 (mapc (lambda (seq)
2230 (setq index start-index)
2231 (mapc (lambda (elem)
2232 (setq alist (cons
2233 (cons (if filter (funcall filter elem) elem)
2234 index)
2235 alist)
2236 index (1+ index)))
2237 seq))
2238 (append (list sequence) sequences))
2239 (reverse alist)))
2241 (defun calendar-read-date (&optional noday)
2242 "Prompt for Gregorian date. Return a list (month day year).
2243 If optional NODAY is t, does not ask for day, but just returns
2244 \(month 1 year); if NODAY is any other non-nil value the value returned is
2245 \(month year)"
2246 (let* ((year (calendar-read
2247 "Year (>0): "
2248 (lambda (x) (> x 0))
2249 (number-to-string (calendar-extract-year
2250 (calendar-current-date)))))
2251 (month-array calendar-month-name-array)
2252 (completion-ignore-case t)
2253 (month (cdr (assoc-string
2254 (completing-read
2255 "Month name: "
2256 (mapcar 'list (append month-array nil))
2257 nil t)
2258 (calendar-make-alist month-array 1) t)))
2259 (last (calendar-last-day-of-month month year)))
2260 (if noday
2261 (if (eq noday t)
2262 (list month 1 year)
2263 (list month year))
2264 (list month
2265 (calendar-read (format "Day (1-%d): " last)
2266 (lambda (x) (and (< 0 x) (<= x last))))
2267 year))))
2269 (defun calendar-interval (mon1 yr1 mon2 yr2)
2270 "The number of months difference between MON1, YR1 and MON2, YR2.
2271 The result is positive if the second date is later than the first.
2272 Negative years are interpreted as years BC; -1 being 1 BC, and so on."
2273 (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc
2274 (if (< yr2 0) (setq yr2 (1+ yr2)))
2275 (+ (* 12 (- yr2 yr1))
2276 (- mon2 mon1)))
2278 (defvar calendar-font-lock-keywords nil
2279 "Default keywords to highlight in Calendar mode.")
2281 (make-obsolete-variable 'calendar-font-lock-keywords
2282 "set font-lock keywords in `calendar-mode-hook', \
2283 or customize calendar faces." "24.4")
2285 (defun calendar-day-name (date &optional abbrev absolute)
2286 "Return a string with the name of the day of the week of DATE.
2287 DATE should be a list in the format (MONTH DAY YEAR), unless the
2288 optional argument ABSOLUTE is non-nil, in which case DATE should
2289 be an integer in the range 0 to 6 corresponding to the day of the
2290 week. Day names are taken from the variable `calendar-day-name-array',
2291 unless the optional argument ABBREV is non-nil:
2292 `header' means to use `calendar-day-header-array';
2293 t to use `calendar-day-abbrev-array'."
2294 (aref (cond ((eq abbrev 'header) calendar-day-header-array)
2295 (abbrev calendar-day-abbrev-array)
2296 (t calendar-day-name-array))
2297 (if absolute date (calendar-day-of-week date))))
2299 (defun calendar-month-name (month &optional abbrev)
2300 "Return a string with the name of month number MONTH.
2301 Months are numbered from one. Month names are taken from the
2302 variable `calendar-month-name-array', unless the optional
2303 argument ABBREV is non-nil, in which case
2304 `calendar-month-abbrev-array' is used."
2305 (aref (if abbrev calendar-month-abbrev-array calendar-month-name-array)
2306 (1- month)))
2308 (defun calendar-day-of-week (date)
2309 "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc.
2310 DATE is a list of the form (month day year). A negative year is
2311 interpreted as BC; -1 being 1 BC, and so on."
2312 (mod (calendar-absolute-from-gregorian date) 7))
2314 (defun calendar-week-end-day ()
2315 "Return the index (0 for Sunday, etc.) of the last day of the week."
2316 (mod (+ calendar-week-start-day 6) 7))
2318 (defun calendar-unmark ()
2319 "Delete all diary/holiday marks/highlighting from the calendar."
2320 (interactive)
2321 (setq calendar-mark-holidays-flag nil
2322 calendar-mark-diary-entries-flag nil)
2323 (with-current-buffer calendar-buffer
2324 (mapc 'delete-overlay (overlays-in (point-min) (point-max)))))
2326 (defun calendar-date-is-visible-p (date)
2327 "Return non-nil if DATE is valid and is visible in the calendar window."
2328 (and (calendar-date-is-valid-p date)
2329 (< (abs (calendar-interval
2330 displayed-month displayed-year
2331 (calendar-extract-month date) (calendar-extract-year date)))
2332 2)))
2334 ;; FIXME can this be generalized for holiday-chinese?
2335 (defun calendar-nongregorian-visible-p (month day toabs fromabs switch)
2336 "Return non-nil if MONTH, DAY is visible in the calendar window.
2337 MONTH and DAY are in some non-Gregorian calendar system. The
2338 functions TOABS and FROMABS convert that system to and from
2339 absolute, respectively. SWITCH is a function that takes a single
2340 argument (a local month number). It applies when the local year
2341 changes across the calendar window, and returns non-nil if the
2342 specified month should be associated with the higher year.
2343 Returns the corresponding Gregorian date."
2344 ;; We need to choose the local year associated with month and day
2345 ;; that might make them visible.
2346 (let* ((m1 displayed-month)
2347 (y1 displayed-year)
2348 (m2 displayed-month)
2349 (y2 displayed-year)
2350 ;; Absolute date of first/last dates in calendar window.
2351 (start-date (progn
2352 (calendar-increment-month m1 y1 -1)
2353 (calendar-absolute-from-gregorian (list m1 1 y1))))
2354 (end-date (progn
2355 (calendar-increment-month m2 y2 1)
2356 (calendar-absolute-from-gregorian
2357 (list m2 (calendar-last-day-of-month m2 y2) y2))))
2358 ;; Local date of first/last date in calendar window.
2359 (local-start (funcall fromabs start-date))
2360 (local-end (funcall fromabs end-date))
2361 ;; Local year of first/last dates.
2362 ;; Can only differ if displayed-month = 12, 1, 2.
2363 (local-y1 (calendar-extract-year local-start))
2364 (local-y2 (calendar-extract-year local-end))
2365 ;; Choose which year might be visible in the window.
2366 ;; Obviously it only matters when y1 and y2 differ, ie
2367 ;; when the _local_ new year is visible.
2368 (year (if (funcall switch month) local-y2 local-y1))
2369 (date (calendar-gregorian-from-absolute
2370 (funcall toabs (list month day year)))))
2371 (if (calendar-date-is-visible-p date)
2372 date)))
2374 (defun calendar-date-is-valid-p (date)
2375 "Return t if DATE is a valid date."
2376 (let ((month (calendar-extract-month date))
2377 (day (calendar-extract-day date))
2378 (year (calendar-extract-year date)))
2379 (and (<= 1 month) (<= month 12)
2380 ;; (calendar-read-date t) used to return a date with day = nil.
2381 ;; Should not be valid (?), since many funcs prob assume integer.
2382 ;; (calendar-read-date 'noday) returns (month year), which
2383 ;; currently results in calendar-extract-year returning nil.
2384 day year (<= 1 day) (<= day (calendar-last-day-of-month month year))
2385 ;; BC dates left as non-valid, to suppress errors from
2386 ;; complex holiday algorithms not suitable for years BC.
2387 ;; Note there are side effects on calendar navigation.
2388 (<= 1 year))))
2390 (defun calendar-date-equal (date1 date2)
2391 "Return t if the DATE1 and DATE2 are the same."
2392 (and
2393 (= (calendar-extract-month date1) (calendar-extract-month date2))
2394 (= (calendar-extract-day date1) (calendar-extract-day date2))
2395 (= (calendar-extract-year date1) (calendar-extract-year date2))))
2397 (defun calendar-make-temp-face (attrlist)
2398 "Return a temporary face based on the attributes in ATTRLIST.
2399 ATTRLIST is a list with elements of the form :face face :foreground color."
2400 (let ((attrs attrlist)
2401 faceinfo face temp-face)
2402 ;; Separate :face from the other attributes. Use the last :face
2403 ;; if there are more than one. FIXME is merging meaningful?
2404 (while attrs
2405 (if (eq (car attrs) :face)
2406 (setq face (intern-soft (cadr attrs))
2407 attrs (cddr attrs))
2408 (push (car attrs) faceinfo)
2409 (setq attrs (cdr attrs))))
2410 (or (facep face) (setq face 'default))
2411 (if (not faceinfo)
2412 ;; No attributes to apply, so just use an existing-face.
2413 face
2414 ;; FIXME should we be using numbered temp-faces, re-using where poss?
2415 (setq temp-face
2416 (make-symbol
2417 (concat ":caltemp"
2418 (mapconcat (lambda (sym)
2419 (cond
2420 ((symbolp sym) (symbol-name sym))
2421 ((numberp sym) (number-to-string sym))
2422 (t sym)))
2423 attrlist ""))))
2424 (make-face temp-face)
2425 (copy-face face temp-face)
2426 ;; Apply the font aspects.
2427 (apply 'set-face-attribute temp-face nil (nreverse faceinfo))
2428 temp-face)))
2430 (defun calendar-mark-visible-date (date &optional mark)
2431 "Mark DATE in the calendar window with MARK.
2432 MARK is a single-character string, a list of face attributes/values, or a face.
2433 MARK defaults to `diary-entry-marker'."
2434 (if (calendar-date-is-valid-p date)
2435 (with-current-buffer calendar-buffer
2436 (save-excursion
2437 (calendar-cursor-to-visible-date date)
2438 (setq mark
2439 (or (and (stringp mark) (= (length mark) 1) mark) ; single-char
2440 ;; The next two use to also check font-lock-mode.
2441 ;; See comments above diary-entry-marker for why
2442 ;; this was dropped.
2443 ;;; (and font-lock-mode
2444 ;;; (or
2445 (and (listp mark) (> (length mark) 0) mark) ; attrs
2446 (and (facep mark) mark) ; )) face-name
2447 diary-entry-marker))
2448 (cond
2449 ;; Face or an attr-list that contained a face.
2450 ((facep mark)
2451 (overlay-put
2452 (make-overlay (1- (point)) (1+ (point))) 'face mark))
2453 ;; Single-character mark, goes after the date.
2454 ((and (stringp mark) (= (length mark) 1))
2455 (overlay-put
2456 (make-overlay (1+ (point)) (+ 2 (point))) 'display mark))
2457 (t ; attr list
2458 (overlay-put
2459 (make-overlay (1- (point)) (1+ (point))) 'face
2460 (calendar-make-temp-face mark))))))))
2462 (defun calendar-star-date ()
2463 "Replace the date under the cursor in the calendar window with asterisks.
2464 You might want to add this function to `calendar-today-visible-hook'."
2465 (unless (catch 'found
2466 (dolist (ol (overlays-at (point)))
2467 (and (overlay-get ol 'calendar-star)
2468 (throw 'found t))))
2469 (let ((ol (make-overlay (1- (point)) (point))))
2470 (overlay-put ol 'display "*")
2471 (overlay-put ol 'calendar-star t)
2472 ;; Use copy-sequence to avoid merging of identical 'display props.
2473 ;; Use two overlays so as not to mess up
2474 ;; calendar-cursor-to-nearest-date (and calendar-forward-day).
2475 (overlay-put (setq ol (make-overlay (point) (1+ (point))))
2476 'display (copy-sequence "*"))
2477 (overlay-put ol 'calendar-star t))))
2479 (defun calendar-mark-today ()
2480 "Mark the date under the cursor in the calendar window.
2481 The date is marked with `calendar-today-marker'. You might want to add
2482 this function to `calendar-today-visible-hook'."
2483 (calendar-mark-visible-date (calendar-cursor-to-date) calendar-today-marker))
2485 ;; FIXME why the car? Almost every usage calls list on the args.
2486 (defun calendar-date-compare (date1 date2)
2487 "Return t if DATE1 is before DATE2, nil otherwise.
2488 The actual dates are in the car of DATE1 and DATE2."
2489 (< (calendar-absolute-from-gregorian (car date1))
2490 (calendar-absolute-from-gregorian (car date2))))
2492 (defun calendar-date-string (date &optional abbreviate nodayname)
2493 "A string form of DATE, driven by the variable `calendar-date-display-form'.
2494 An optional parameter ABBREVIATE, when non-nil, causes the month
2495 and day names to be abbreviated as specified by
2496 `calendar-month-abbrev-array' and `calendar-day-abbrev-array',
2497 respectively. An optional parameter NODAYNAME, when t, omits the
2498 name of the day of the week."
2499 (let* ((dayname (unless nodayname (calendar-day-name date abbreviate)))
2500 (month (calendar-extract-month date))
2501 (monthname (calendar-month-name month abbreviate))
2502 (day (number-to-string (calendar-extract-day date)))
2503 (month (number-to-string month))
2504 (year (number-to-string (calendar-extract-year date))))
2505 (mapconcat 'eval calendar-date-display-form "")))
2507 (defun calendar-dayname-on-or-before (dayname date)
2508 "Return the absolute date of the DAYNAME on or before absolute DATE.
2509 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
2511 Note: Applying this function to d+6 gives us the DAYNAME on or after an
2512 absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
2513 absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
2514 date d, and applying it to d+7 gives the DAYNAME following absolute date d."
2515 (- date (% (- date dayname) 7)))
2517 (defun calendar-nth-named-absday (n dayname month year &optional day)
2518 "Absolute date of the Nth DAYNAME after/before MONTH YEAR DAY.
2519 A DAYNAME of 0 means Sunday, 1 means Monday, and so on.
2520 If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
2521 If N<0, return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
2522 DAY defaults to 1 if N>0, and MONTH's last day otherwise."
2523 (if (> n 0)
2524 (+ (* 7 (1- n))
2525 (calendar-dayname-on-or-before
2526 dayname
2527 (+ 6 (calendar-absolute-from-gregorian
2528 (list month (or day 1) year)))))
2529 (+ (* 7 (1+ n))
2530 (calendar-dayname-on-or-before
2531 dayname
2532 (calendar-absolute-from-gregorian
2533 (list month
2534 (or day (calendar-last-day-of-month month year))
2535 year))))))
2537 (defun calendar-nth-named-day (n dayname month year &optional day)
2538 "Date of the Nth DAYNAME after/before MONTH YEAR DAY.
2539 Like `calendar-nth-named-absday', but returns a Gregorian date."
2540 (calendar-gregorian-from-absolute
2541 (calendar-nth-named-absday n dayname month year day)))
2543 (defun calendar-day-of-year-string (&optional date)
2544 "String of day number of year of Gregorian DATE.
2545 Defaults to today's date if DATE is not given."
2546 (let* ((d (or date (calendar-current-date)))
2547 (year (calendar-extract-year d))
2548 (day (calendar-day-number d))
2549 (days-remaining (- (calendar-day-number (list 12 31 year)) day)))
2550 (format "Day %d of %d; %d day%s remaining in the year"
2551 day year days-remaining (if (= days-remaining 1) "" "s"))))
2553 (defun calendar-other-dates (date)
2554 "Return a list of strings giving Gregorian DATE in other calendars.
2555 DATE is (month day year). Calendars that do not apply are omitted."
2556 (let (odate)
2557 (delq nil
2558 (list
2559 (calendar-day-of-year-string date)
2560 (format "ISO date: %s" (calendar-iso-date-string date))
2561 (format "Julian date: %s"
2562 (calendar-julian-date-string date))
2563 (format "Astronomical (Julian) day number (at noon UTC): %s.0"
2564 (calendar-astro-date-string date))
2565 (format "Fixed (RD) date: %s"
2566 (calendar-absolute-from-gregorian date))
2567 (format "Hebrew date (before sunset): %s"
2568 (calendar-hebrew-date-string date))
2569 (format "Persian date: %s"
2570 (calendar-persian-date-string date))
2571 (unless (string-equal
2572 (setq odate (calendar-islamic-date-string date))
2574 (format "Islamic date (before sunset): %s" odate))
2575 (unless (string-equal
2576 (setq odate (calendar-bahai-date-string date))
2578 (format "Bahá’í date: %s" odate))
2579 (format "Chinese date: %s"
2580 (calendar-chinese-date-string date))
2581 (unless (string-equal
2582 (setq odate (calendar-coptic-date-string date))
2584 (format "Coptic date: %s" odate))
2585 (unless (string-equal
2586 (setq odate (calendar-ethiopic-date-string date))
2588 (format "Ethiopic date: %s" odate))
2589 (unless (string-equal
2590 (setq odate (calendar-french-date-string date))
2592 (format "French Revolutionary date: %s" odate))
2593 (format "Mayan date: %s"
2594 (calendar-mayan-date-string date))))))
2596 (declare-function x-popup-menu "menu.c" (position menu))
2598 (defun calendar-print-other-dates (&optional event)
2599 "Show dates on other calendars for date under the cursor.
2600 If called by a mouse-event, pops up a menu with the result."
2601 (interactive (list last-nonmenu-event))
2602 (let* ((date (calendar-cursor-to-date t event))
2603 (title (format "%s (Gregorian)" (calendar-date-string date)))
2604 (others (calendar-other-dates date))
2605 selection)
2606 (if (mouse-event-p event)
2607 (and (setq selection (cal-menu-x-popup-menu event title
2608 (mapcar 'list others)))
2609 (call-interactively selection))
2610 (calendar-in-read-only-buffer calendar-other-calendars-buffer
2611 (calendar-set-mode-line title)
2612 (insert (mapconcat 'identity others "\n"))))))
2614 (defun calendar-print-day-of-year ()
2615 "Show day number in year/days remaining in year for date under the cursor."
2616 (interactive)
2617 (message "%s" (calendar-day-of-year-string (calendar-cursor-to-date t))))
2619 (defun calendar-set-mode-line (str)
2620 "Set mode line to STR, centered, surrounded by dashes."
2621 (let* ((edges (window-edges))
2622 ;; As per doc of window-width, total visible mode-line length.
2623 (width (- (nth 2 edges) (car edges))))
2624 ;; Hack for --daemon. See bug #2199.
2625 ;; If no frame exists yet, we have no idea what width to use.
2626 (and (= width 10)
2627 (not window-system)
2628 (setq width (string-to-number (or (getenv "COLUMNS") "80"))))
2629 (setq mode-line-format
2630 (if buffer-file-name
2631 `("-" mode-line-modified
2632 ,(calendar-string-spread (list str) ?- (- width 6))
2633 "---")
2634 (calendar-string-spread (list str) ?- width)))))
2636 (run-hooks 'calendar-load-hook)
2638 (provide 'calendar)
2640 ;; Local variables:
2641 ;; byte-compile-dynamic: t
2642 ;; End:
2644 ;;; calendar.el ends here