Commit | Line | Data |
---|---|---|
3afbc435 | 1 | ;;; calendar.el --- calendar functions |
fd7fa35a | 2 | |
f059e122 | 3 | ;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997, |
6b61353c | 4 | ;; 2000, 2001, 2003, 2004 Free Software Foundation, Inc. |
3a801d0c | 5 | |
fd7fa35a | 6 | ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu> |
e9571d2a | 7 | ;; Keywords: calendar |
3076647c | 8 | ;; Human-Keywords: calendar, Gregorian calendar, diary, holidays |
fd7fa35a | 9 | |
ecaa0527 RS |
10 | ;; This file is part of GNU Emacs. |
11 | ||
e555fdd8 RS |
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
13 | ;; it under the terms of the GNU General Public License as published by | |
14 | ;; the Free Software Foundation; either version 2, or (at your option) | |
15 | ;; any later version. | |
16 | ||
ecaa0527 | 17 | ;; GNU Emacs is distributed in the hope that it will be useful, |
e555fdd8 RS |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
24 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 | ;; Boston, MA 02111-1307, USA. | |
ecaa0527 | 26 | |
fd7fa35a ER |
27 | ;;; Commentary: |
28 | ||
b0e6051a GM |
29 | ;; This collection of functions implements a calendar window. It generates a |
30 | ;; calendar for the current month, together with the previous and coming | |
31 | ;; months, or for any other three-month period. The calendar can be scrolled | |
32 | ;; forward and backward in the window to show months in the past or future; | |
33 | ;; the cursor can move forward and backward by days, weeks, or months, making | |
34 | ;; it possible, for instance, to jump to the date a specified number of days, | |
35 | ;; weeks, or months from the date under the cursor. The user can display a | |
36 | ;; list of holidays and other notable days for the period shown; the notable | |
37 | ;; days can be marked on the calendar, if desired. The user can also specify | |
38 | ;; that dates having corresponding diary entries (in a file that the user | |
39 | ;; specifies) be marked; the diary entries for any date can be viewed in a | |
40 | ;; separate window. The diary and the notable days can be viewed | |
41 | ;; independently of the calendar. Dates can be translated from the (usual) | |
42 | ;; Gregorian calendar to the day of the year/days remaining in year, to the | |
43 | ;; ISO commercial calendar, to the Julian (old style) calendar, to the Hebrew | |
44 | ;; calendar, to the Islamic calendar, to the French Revolutionary calendar, to | |
45 | ;; the Mayan calendar, to the Chinese calendar, to the Coptic calendar, to the | |
46 | ;; Ethiopic calendar, and to the astronomical (Julian) day number. When | |
47 | ;; floating point is available, times of sunrise/sunset can be displayed, as | |
48 | ;; can the phases of the moon. Appointment notification for diary entries is | |
3076647c | 49 | ;; available. Calendar printing via LaTeX is available. |
7e1dae73 JB |
50 | |
51 | ;; The following files are part of the calendar/diary code: | |
52 | ||
3076647c | 53 | ;; appt.el Appointment notification |
327b6868 | 54 | ;; cal-china.el Chinese calendar |
3076647c ER |
55 | ;; cal-coptic.el Coptic/Ethiopic calendars |
56 | ;; cal-dst.el Daylight savings time rules | |
57 | ;; cal-hebrew.el Hebrew calendar | |
327b6868 | 58 | ;; cal-islam.el Islamic calendar |
3076647c ER |
59 | ;; cal-iso.el ISO calendar |
60 | ;; cal-julian.el Julian/astronomical calendars | |
61 | ;; cal-mayan.el Mayan calendars | |
6a2aa94c | 62 | ;; cal-menu.el Menu support |
7086b78e | 63 | ;; cal-move.el Movement in the calendar |
a45eee72 | 64 | ;; cal-persia.el Persian calendar |
3076647c | 65 | ;; cal-tex.el Calendars in LaTeX |
bcbb4a0a | 66 | ;; cal-x.el X-windows dedicated frame functions |
f5e13137 | 67 | ;; diary-lib.el Diary functions |
7e1dae73 | 68 | ;; holidays.el Holiday functions |
7e1dae73 | 69 | ;; lunar.el Phases of the moon |
3076647c | 70 | ;; solar.el Sunrise/sunset, equinoxes/solstices |
ecaa0527 | 71 | |
ecaa0527 | 72 | ;; Technical details of all the calendrical calculations can be found in |
a96a5fca PE |
73 | ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold, |
74 | ;; Cambridge University Press (1997). | |
7e1dae73 | 75 | |
a96a5fca | 76 | ;; An earlier version of the technical details appeared in |
ecaa0527 RS |
77 | ;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold, |
78 | ;; Software--Practice and Experience, Volume 20, Number 9 (September, 1990), | |
7e1dae73 JB |
79 | ;; pages 899-928. ``Calendrical Calculations, Part II: Three Historical |
80 | ;; Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen, | |
e4c61e50 JB |
81 | ;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993), |
82 | ;; pages 383-404. | |
7e1dae73 JB |
83 | |
84 | ;; Hard copies of these two papers can be obtained by sending email to | |
85 | ;; reingold@cs.uiuc.edu with the SUBJECT "send-paper-cal" (no quotes) and | |
86 | ;; the message BODY containing your mailing address (snail). | |
ecaa0527 | 87 | |
a96a5fca PE |
88 | ;; Comments, corrections, and improvements should be sent to |
89 | ;; Edward M. Reingold Department of Computer Science | |
90 | ;; (217) 333-6733 University of Illinois at Urbana-Champaign | |
91 | ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue | |
92 | ;; Urbana, Illinois 61801 | |
93 | ||
fd7fa35a | 94 | ;;; Code: |
ecaa0527 | 95 | |
f059e122 | 96 | (eval-when-compile |
d4ff5db9 DL |
97 | (defvar displayed-month) |
98 | (defvar displayed-year) | |
99 | (defvar calendar-month-name-array) | |
100 | (defvar calendar-starred-day)) | |
101 | ||
e555fdd8 RS |
102 | (defun calendar-version () |
103 | (interactive) | |
3076647c | 104 | (message "Version 6, October 12, 1995")) |
e555fdd8 | 105 | |
b032077a RS |
106 | (defgroup calendar nil |
107 | "Calendar and time management support." | |
108 | :group 'applications) | |
109 | ||
110 | (defgroup diary nil | |
111 | "Emacs diary." | |
112 | :group 'calendar) | |
113 | ||
114 | (defgroup appt nil | |
115 | "Appointment notification." | |
116 | :group 'calendar) | |
117 | ||
118 | (defgroup holidays nil | |
119 | "Holidays support in calendar." | |
120 | :group 'calendar | |
121 | :prefix "calendar-" | |
122 | :group 'local) | |
123 | ||
124 | (defgroup chinese-calendar nil | |
125 | "Chinese calendar support." | |
126 | :group 'calendar) | |
127 | ||
128 | (defgroup calendar-tex nil | |
129 | "Options for printing calendar with LaTeX." | |
130 | :prefix "cal-tex-" | |
131 | :group 'calendar) | |
132 | ||
133 | (defgroup calendar-hooks nil | |
134 | "Calendar hooks." | |
135 | :prefix "calendar-" | |
136 | :group 'calendar) | |
137 | ||
138 | ||
d8a200a7 | 139 | ;;;###autoload |
b032077a | 140 | (defcustom calendar-week-start-day 0 |
d8a200a7 | 141 | "*The day of the week on which a week in the calendar begins. |
b032077a RS |
142 | 0 means Sunday (default), 1 means Monday, and so on." |
143 | :type 'integer | |
144 | :group 'calendar) | |
d8a200a7 | 145 | |
cba0c253 | 146 | ;;;###autoload |
b032077a | 147 | (defcustom calendar-offset 0 |
cba0c253 ER |
148 | "*The offset of the principal month from the center of the calendar window. |
149 | 0 means the principal month is in the center (default), -1 means on the left, | |
150 | +1 means on the right. Larger (or smaller) values push the principal month off | |
b032077a RS |
151 | the screen." |
152 | :type 'integer | |
153 | :group 'calendar) | |
cba0c253 | 154 | |
7e1dae73 | 155 | ;;;###autoload |
b032077a | 156 | (defcustom view-diary-entries-initially nil |
6b61353c | 157 | "*Non-nil means display current date's diary entries on entry to calendar. |
ecaa0527 RS |
158 | The diary is displayed in another window when the calendar is first displayed, |
159 | if the current date is visible. The number of days of diary entries displayed | |
6b61353c KH |
160 | is governed by the variable `number-of-diary-entries'. This variable can |
161 | be overridden by the value of `calendar-setup'." | |
b032077a RS |
162 | :type 'boolean |
163 | :group 'diary) | |
ecaa0527 | 164 | |
7e1dae73 | 165 | ;;;###autoload |
b032077a | 166 | (defcustom number-of-diary-entries 1 |
ecaa0527 | 167 | "*Specifies how many days of diary entries are to be displayed initially. |
3cbb4860 | 168 | This variable affects the diary display when the command \\[diary] is used, |
ecaa0527 RS |
169 | or if the value of the variable `view-diary-entries-initially' is t. For |
170 | example, if the default value 1 is used, then only the current day's diary | |
171 | entries will be displayed. If the value 2 is used, then both the current | |
e555fdd8 RS |
172 | day's and the next day's entries will be displayed. |
173 | ||
174 | The value can also be a vector such as [0 2 2 2 2 4 1]; this value | |
175 | says to display no diary entries on Sunday, the display the entries | |
176 | for the current date and the day after on Monday through Thursday, | |
177 | display Friday through Monday's entries on Friday, and display only | |
178 | Saturday's entries on Saturday. | |
179 | ||
180 | This variable does not affect the diary display with the `d' command | |
181 | from the calendar; in that case, the prefix argument controls the | |
b032077a RS |
182 | number of days of diary entries displayed." |
183 | :type '(choice (integer :tag "Entries") | |
184 | (vector :value [0 0 0 0 0 0 0] | |
185 | (integer :tag "Sunday") | |
186 | (integer :tag "Monday") | |
187 | (integer :tag "Tuesday") | |
188 | (integer :tag "Wednesday") | |
189 | (integer :tag "Thursday") | |
190 | (integer :tag "Friday") | |
191 | (integer :tag "Saturday"))) | |
192 | :group 'diary) | |
ecaa0527 | 193 | |
7e1dae73 | 194 | ;;;###autoload |
b032077a | 195 | (defcustom mark-diary-entries-in-calendar nil |
e555fdd8 | 196 | "*Non-nil means mark dates with diary entries, in the calendar window. |
b032077a RS |
197 | The marking symbol is specified by the variable `diary-entry-marker'." |
198 | :type 'boolean | |
199 | :group 'diary) | |
ecaa0527 | 200 | |
7e1e5cf1 SS |
201 | ;;;###autoload |
202 | (defcustom calendar-remove-frame-by-deleting nil | |
203 | "*Determine how the calendar mode removes a frame no longer needed. | |
204 | If nil, make an icon of the frame. If non-nil, delete the frame." | |
205 | :type 'boolean | |
206 | :group 'view) | |
207 | ||
5d22135b MR |
208 | (defvar diary-face 'diary-face |
209 | "Face name to use for diary entries.") | |
9c887ada MB |
210 | (defface diary-face |
211 | '((((class color) (background light)) | |
42121c23 | 212 | :foreground "red") |
9c887ada | 213 | (((class color) (background dark)) |
42121c23 | 214 | :foreground "yellow") |
9c887ada | 215 | (t |
1fd714a4 | 216 | :weight bold)) |
9c887ada MB |
217 | "Face for highlighting diary entries." |
218 | :group 'diary) | |
219 | ||
9c887ada MB |
220 | (defface calendar-today-face |
221 | '((t (:underline t))) | |
222 | "Face for indicating today's date." | |
223 | :group 'diary) | |
224 | ||
9c887ada MB |
225 | (defface holiday-face |
226 | '((((class color) (background light)) | |
42121c23 | 227 | :background "pink") |
9c887ada | 228 | (((class color) (background dark)) |
42121c23 | 229 | :background "chocolate4") |
9c887ada | 230 | (t |
42121c23 | 231 | :inverse-video t)) |
9c887ada MB |
232 | "Face for indicating dates that have holidays." |
233 | :group 'diary) | |
a69e7dae | 234 | |
f5f57411 SM |
235 | (eval-after-load "facemenu" |
236 | '(progn | |
237 | (add-to-list 'facemenu-unlisted-faces 'diary-face) | |
238 | (add-to-list 'facemenu-unlisted-faces 'calendar-today-face) | |
239 | (add-to-list 'facemenu-unlisted-faces 'holiday-face))) | |
240 | ||
b032077a | 241 | (defcustom diary-entry-marker |
13f0f988 | 242 | (if (not (display-color-p)) |
6a2aa94c | 243 | "+" |
6a2aa94c | 244 | 'diary-face) |
a69e7dae RS |
245 | "*How to mark dates that have diary entries. |
246 | The value can be either a single-character string or a face." | |
b032077a RS |
247 | :type '(choice string face) |
248 | :group 'diary) | |
6a2aa94c | 249 | |
b032077a | 250 | (defcustom calendar-today-marker |
13f0f988 | 251 | (if (not (display-color-p)) |
6a2aa94c | 252 | "=" |
6a2aa94c | 253 | 'calendar-today-face) |
a69e7dae RS |
254 | "*How to mark today's date in the calendar. |
255 | The value can be either a single-character string or a face. | |
256 | Marking today's date is done only if you set up `today-visible-calendar-hook' | |
257 | to request that." | |
b032077a RS |
258 | :type '(choice string face) |
259 | :group 'calendar) | |
6a2aa94c | 260 | |
b032077a | 261 | (defcustom calendar-holiday-marker |
13f0f988 | 262 | (if (not (display-color-p)) |
6a2aa94c | 263 | "*" |
6a2aa94c | 264 | 'holiday-face) |
a69e7dae RS |
265 | "*How to mark notable dates in the calendar. |
266 | The value can be either a single-character string or a face." | |
b032077a RS |
267 | :type '(choice string face) |
268 | :group 'calendar) | |
ecaa0527 | 269 | |
7e1dae73 | 270 | ;;;###autoload |
b032077a | 271 | (defcustom view-calendar-holidays-initially nil |
e555fdd8 | 272 | "*Non-nil means display holidays for current three month period on entry. |
354d0644 | 273 | The holidays are displayed in another window when the calendar is first |
b032077a RS |
274 | displayed." |
275 | :type 'boolean | |
276 | :group 'holidays) | |
ecaa0527 | 277 | |
e5d77022 | 278 | ;;;###autoload |
b032077a | 279 | (defcustom mark-holidays-in-calendar nil |
e555fdd8 | 280 | "*Non-nil means mark dates of holidays in the calendar window. |
b032077a RS |
281 | The marking symbol is specified by the variable `calendar-holiday-marker'." |
282 | :type 'boolean | |
283 | :group 'holidays) | |
ecaa0527 | 284 | |
e5d77022 | 285 | ;;;###autoload |
b032077a | 286 | (defcustom all-hebrew-calendar-holidays nil |
354d0644 | 287 | "*If nil, show only major holidays from the Hebrew calendar. |
e555fdd8 | 288 | This means only those Jewish holidays that appear on secular calendars. |
354d0644 | 289 | |
b032077a RS |
290 | If t, show all the holidays that would appear in a complete Hebrew calendar." |
291 | :type 'boolean | |
292 | :group 'holidays) | |
ecaa0527 | 293 | |
e5d77022 | 294 | ;;;###autoload |
b032077a | 295 | (defcustom all-christian-calendar-holidays nil |
354d0644 | 296 | "*If nil, show only major holidays from the Christian calendar. |
e555fdd8 | 297 | This means only those Christian holidays that appear on secular calendars. |
354d0644 | 298 | |
e555fdd8 | 299 | If t, show all the holidays that would appear in a complete Christian |
b032077a RS |
300 | calendar." |
301 | :type 'boolean | |
302 | :group 'holidays) | |
ecaa0527 | 303 | |
e5d77022 | 304 | ;;;###autoload |
b032077a | 305 | (defcustom all-islamic-calendar-holidays nil |
354d0644 | 306 | "*If nil, show only major holidays from the Islamic calendar. |
e555fdd8 | 307 | This means only those Islamic holidays that appear on secular calendars. |
354d0644 | 308 | |
e555fdd8 | 309 | If t, show all the holidays that would appear in a complete Islamic |
b032077a RS |
310 | calendar." |
311 | :type 'boolean | |
312 | :group 'holidays) | |
ecaa0527 | 313 | |
d13c1378 JB |
314 | (defcustom diary-file-name-prefix-function (function (lambda (str) str)) |
315 | "*The function that will take a diary file name and return the desired prefix." | |
808052d6 | 316 | :type 'function |
d13c1378 JB |
317 | :group 'diary) |
318 | ||
7e1dae73 | 319 | ;;;###autoload |
b032077a | 320 | (defcustom calendar-load-hook nil |
7e1dae73 | 321 | "*List of functions to be called after the calendar is first loaded. |
b032077a RS |
322 | This is the place to add key bindings to `calendar-mode-map'." |
323 | :type 'hook | |
324 | :group 'calendar-hooks) | |
7e1dae73 JB |
325 | |
326 | ;;;###autoload | |
b032077a | 327 | (defcustom initial-calendar-window-hook nil |
ecaa0527 RS |
328 | "*List of functions to be called when the calendar window is first opened. |
329 | The functions invoked are called after the calendar window is opened, but | |
330 | once opened is never called again. Leaving the calendar with the `q' command | |
b032077a RS |
331 | and reentering it will cause these functions to be called again." |
332 | :type 'hook | |
333 | :group 'calendar-hooks) | |
ecaa0527 | 334 | |
7e1dae73 | 335 | ;;;###autoload |
b032077a | 336 | (defcustom today-visible-calendar-hook nil |
ecaa0527 RS |
337 | "*List of functions called whenever the current date is visible. |
338 | This can be used, for example, to replace today's date with asterisks; a | |
339 | function `calendar-star-date' is included for this purpose: | |
340 | (setq today-visible-calendar-hook 'calendar-star-date) | |
6b1abbd1 | 341 | It can also be used to mark the current date with `calendar-today-marker'; |
6a2aa94c | 342 | a function is also provided for this: |
ecaa0527 RS |
343 | (setq today-visible-calendar-hook 'calendar-mark-today) |
344 | ||
345 | The corresponding variable `today-invisible-calendar-hook' is the list of | |
346 | functions called when the calendar function was called when the current | |
347 | date is not visible in the window. | |
348 | ||
349 | Other than the use of the provided functions, the changing of any | |
350 | characters in the calendar buffer by the hooks may cause the failure of the | |
b032077a RS |
351 | functions that move by days and weeks." |
352 | :type 'hook | |
353 | :group 'calendar-hooks) | |
ecaa0527 | 354 | |
7e1dae73 | 355 | ;;;###autoload |
b032077a | 356 | (defcustom today-invisible-calendar-hook nil |
ecaa0527 RS |
357 | "*List of functions called whenever the current date is not visible. |
358 | ||
359 | The corresponding variable `today-visible-calendar-hook' is the list of | |
360 | functions called when the calendar function was called when the current | |
361 | date is visible in the window. | |
362 | ||
363 | Other than the use of the provided functions, the changing of any | |
364 | characters in the calendar buffer by the hooks may cause the failure of the | |
b032077a RS |
365 | functions that move by days and weeks." |
366 | :type 'hook | |
367 | :group 'calendar-hooks) | |
ecaa0527 | 368 | |
5c9705e5 RS |
369 | ;;;###autoload |
370 | (defcustom calendar-move-hook nil | |
371 | "*List of functions called whenever the cursor moves in the calendar. | |
372 | ||
7e1e5cf1 | 373 | For example, |
5c9705e5 RS |
374 | |
375 | (add-hook 'calendar-move-hook (lambda () (view-diary-entries 1))) | |
376 | ||
377 | redisplays the diary for whatever date the cursor is moved to." | |
378 | :type 'hook | |
379 | :group 'calendar-hooks) | |
380 | ||
7e1dae73 | 381 | ;;;###autoload |
b032077a | 382 | (defcustom diary-file "~/diary" |
ecaa0527 RS |
383 | "*Name of the file in which one's personal diary of dates is kept. |
384 | ||
2c8811d4 GM |
385 | The file's entries are lines beginning with any of the forms |
386 | specified by the variable `american-date-diary-pattern', by default: | |
ecaa0527 RS |
387 | |
388 | MONTH/DAY | |
389 | MONTH/DAY/YEAR | |
390 | MONTHNAME DAY | |
391 | MONTHNAME DAY, YEAR | |
392 | DAYNAME | |
393 | ||
2c8811d4 GM |
394 | with the remainder of the line being the diary entry string for |
395 | that date. MONTH and DAY are one or two digit numbers, YEAR is a | |
396 | number and may be written in full or abbreviated to the final two | |
397 | digits (if `abbreviated-calendar-year' is non-nil). MONTHNAME | |
398 | and DAYNAME can be spelled in full (as specified by the variables | |
399 | `calendar-month-name-array' and `calendar-day-name-array'), | |
400 | abbreviated (as specified by `calendar-month-abbrev-array' and | |
401 | `calendar-day-abbrev-array') with or without a period, | |
402 | capitalized or not. Any of DAY, MONTH, or MONTHNAME, YEAR can be | |
403 | `*' which matches any day, month, or year, respectively. If the | |
404 | date does not contain a year, it is generic and applies to any | |
405 | year. A DAYNAME entry applies to the appropriate day of the week | |
406 | in every week. | |
407 | ||
408 | The European style (in which the day precedes the month) can be | |
409 | used instead, if you execute `european-calendar' when in the | |
410 | calendar, or set `european-calendar-style' to t in your .emacs | |
411 | file. The European forms (see `european-date-diary-pattern') are | |
ecaa0527 RS |
412 | |
413 | DAY/MONTH | |
414 | DAY/MONTH/YEAR | |
415 | DAY MONTHNAME | |
416 | DAY MONTHNAME YEAR | |
417 | DAYNAME | |
418 | ||
419 | To revert to the default American style from the European style, execute | |
420 | `american-calendar' in the calendar. | |
421 | ||
6b1abbd1 RS |
422 | A diary entry can be preceded by the character |
423 | `diary-nonmarking-symbol' (ordinarily `&') to make that entry | |
424 | nonmarking--that is, it will not be marked on dates in the calendar | |
425 | window but will appear in a diary window. | |
ecaa0527 RS |
426 | |
427 | Multiline diary entries are made by indenting lines after the first with | |
428 | either a TAB or one or more spaces. | |
429 | ||
430 | Lines not in one the above formats are ignored. Here are some sample diary | |
431 | entries (in the default American style): | |
432 | ||
433 | 12/22/1988 Twentieth wedding anniversary!! | |
434 | &1/1. Happy New Year! | |
435 | 10/22 Ruth's birthday. | |
436 | 21: Payday | |
437 | Tuesday--weekly meeting with grad students at 10am | |
438 | Supowit, Shen, Bitner, and Kapoor to attend. | |
439 | 1/13/89 Friday the thirteenth!! | |
440 | &thu 4pm squash game with Lloyd. | |
441 | mar 16 Dad's birthday | |
442 | April 15, 1989 Income tax due. | |
443 | &* 15 time cards due. | |
444 | ||
445 | If the first line of a diary entry consists only of the date or day name with | |
e555fdd8 RS |
446 | no trailing blanks or punctuation, then that line is not displayed in the |
447 | diary window; only the continuation lines is shown. For example, the | |
ecaa0527 RS |
448 | single diary entry |
449 | ||
450 | 02/11/1989 | |
451 | Bill Blattner visits Princeton today | |
452 | 2pm Cognitive Studies Committee meeting | |
453 | 2:30-5:30 Lizzie at Lawrenceville for `Group Initiative' | |
454 | 4:00pm Jamie Tappenden | |
455 | 7:30pm Dinner at George and Ed's for Alan Ryan | |
456 | 7:30-10:00pm dance at Stewart Country Day School | |
457 | ||
458 | will appear in the diary window without the date line at the beginning. This | |
459 | facility allows the diary window to look neater, but can cause confusion if | |
460 | used with more than one day's entries displayed. | |
461 | ||
462 | Diary entries can be based on Lisp sexps. For example, the diary entry | |
463 | ||
464 | %%(diary-block 11 1 1990 11 10 1990) Vacation | |
465 | ||
b0e6051a GM |
466 | causes the diary entry \"Vacation\" to appear from November 1 through November |
467 | 10, 1990. Other functions available are `diary-float', `diary-anniversary', | |
468 | `diary-cyclic', `diary-day-of-year', `diary-iso-date', `diary-french-date', | |
469 | `diary-hebrew-date', `diary-islamic-date', `diary-mayan-date', | |
7086b78e | 470 | `diary-chinese-date', `diary-coptic-date', `diary-ethiopic-date', |
c21eb13d | 471 | `diary-persian-date', `diary-yahrzeit', `diary-sunrise-sunset', |
b0e6051a GM |
472 | `diary-phases-of-moon', `diary-parasha', `diary-omer', `diary-rosh-hodesh', |
473 | and `diary-sabbath-candles'. See the documentation for the function | |
474 | `list-sexp-diary-entries' for more details. | |
ecaa0527 | 475 | |
b0e6051a GM |
476 | Diary entries based on the Hebrew and/or the Islamic calendar are also |
477 | possible, but because these are somewhat slow, they are ignored | |
478 | unless you set the `nongregorian-diary-listing-hook' and the | |
479 | `nongregorian-diary-marking-hook' appropriately. See the documentation | |
480 | for these functions for details. | |
ecaa0527 RS |
481 | |
482 | Diary files can contain directives to include the contents of other files; for | |
b032077a RS |
483 | details, see the documentation for the variable `list-diary-entries-hook'." |
484 | :type 'file | |
485 | :group 'diary) | |
ecaa0527 | 486 | |
7e1dae73 | 487 | ;;;###autoload |
b032077a RS |
488 | (defcustom diary-nonmarking-symbol "&" |
489 | "*Symbol indicating that a diary entry is not to be marked in the calendar." | |
490 | :type 'string | |
491 | :group 'diary) | |
ecaa0527 | 492 | |
7e1dae73 | 493 | ;;;###autoload |
b032077a RS |
494 | (defcustom hebrew-diary-entry-symbol "H" |
495 | "*Symbol indicating a diary entry according to the Hebrew calendar." | |
496 | :type 'string | |
497 | :group 'diary) | |
ecaa0527 | 498 | |
7e1dae73 | 499 | ;;;###autoload |
b032077a RS |
500 | (defcustom islamic-diary-entry-symbol "I" |
501 | "*Symbol indicating a diary entry according to the Islamic calendar." | |
502 | :type 'string | |
503 | :group 'diary) | |
ecaa0527 | 504 | |
7e1dae73 | 505 | ;;;###autoload |
b032077a | 506 | (defcustom diary-include-string "#include" |
354d0644 | 507 | "*The string indicating inclusion of another file of diary entries. |
b032077a RS |
508 | See the documentation for the function `include-other-diary-files'." |
509 | :type 'string | |
510 | :group 'diary) | |
ecaa0527 | 511 | |
d13c1378 JB |
512 | (defcustom diary-glob-file-regexp-prefix "^\\#" |
513 | "*The regular expression that gets pre-pended to each of the attribute-regexp's for file-wide specifiers." | |
514 | :type 'regexp | |
515 | :group 'diary) | |
516 | ||
2c8811d4 GM |
517 | (defcustom diary-face-attrs |
518 | '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string) | |
519 | (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string) | |
520 | (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol) | |
521 | (" *\\[height:\\([-0-9a-z]+\\)\\]$" 1 :height int) | |
522 | (" *\\[weight:\\([-a-z]+\\)\\]$" 1 :weight symbol) | |
523 | (" *\\[slant:\\([-a-z]+\\)\\]$" 1 :slant symbol) | |
524 | (" *\\[underline:\\([-a-z]+\\)\\]$" 1 :underline stringtnil) | |
525 | (" *\\[overline:\\([-a-z]+\\)\\]$" 1 :overline stringtnil) | |
526 | (" *\\[strike-through:\\([-a-z]+\\)\\]$" 1 :strike-through stringtnil) | |
527 | (" *\\[inverse-video:\\([-a-z]+\\)\\]$" 1 :inverse-video tnil) | |
528 | (" *\\[face:\\([-0-9a-z]+\\)\\]$" 1 :face string) | |
529 | (" *\\[font:\\([-a-z0-9]+\\)\\]$" 1 :font string) | |
530 | ;; Unsupported. | |
531 | ;;; (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box) | |
532 | ;;; (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple) | |
533 | ) | |
534 | "*A list of (regexp regnum attr attrtype) lists where the | |
535 | regexp says how to find the tag, the regnum says which | |
536 | parenthetical sub-regexp this regexp looks for, and the attr says | |
537 | which attribute of the face (or that this _is_ a face) is being | |
538 | modified." | |
d13c1378 JB |
539 | :type 'sexp |
540 | :group 'diary) | |
541 | ||
542 | (defcustom diary-file-name-prefix nil | |
2c8811d4 | 543 | "If non-nil each diary entry is prefixed with the name of the file where it is defined." |
d13c1378 JB |
544 | :type 'boolean |
545 | :group 'diary) | |
546 | ||
7e1dae73 | 547 | ;;;###autoload |
b032077a | 548 | (defcustom sexp-diary-entry-symbol "%%" |
3cbb4860 | 549 | "*The string used to indicate a sexp diary entry in `diary-file'. |
b032077a RS |
550 | See the documentation for the function `list-sexp-diary-entries'." |
551 | :type 'string | |
552 | :group 'diary) | |
ecaa0527 | 553 | |
7e1dae73 | 554 | ;;;###autoload |
b032077a | 555 | (defcustom abbreviated-calendar-year t |
354d0644 | 556 | "*Interpret a two-digit year DD in a diary entry as either 19DD or 20DD. |
b0e6051a GM |
557 | For the Gregorian calendar; similarly for the Hebrew and Islamic calendars. |
558 | If this variable is nil, years must be written in full." | |
b032077a RS |
559 | :type 'boolean |
560 | :group 'diary) | |
ecaa0527 | 561 | |
7e1dae73 | 562 | ;;;###autoload |
b032077a | 563 | (defcustom european-calendar-style nil |
354d0644 JB |
564 | "*Use the European style of dates in the diary and in any displays. |
565 | If this variable is t, a date 1/2/1990 would be interpreted as February 1, | |
2c8811d4 GM |
566 | 1990. The default European date styles (see `european-date-diary-pattern') |
567 | are | |
ecaa0527 RS |
568 | |
569 | DAY/MONTH | |
570 | DAY/MONTH/YEAR | |
571 | DAY MONTHNAME | |
572 | DAY MONTHNAME YEAR | |
573 | DAYNAME | |
574 | ||
2c8811d4 GM |
575 | Names can be capitalized or not, written in full (as specified by the |
576 | variable `calendar-day-name-array'), or abbreviated (as specified by | |
6b61353c KH |
577 | `calendar-day-abbrev-array') with or without a period. To take effect, |
578 | this variable should be set before the calendar package and its associates | |
579 | are loaded. Otherwise, use one of the functions `european-calendar' or | |
580 | `american-calendar' to force the appropriate update." | |
b032077a RS |
581 | :type 'boolean |
582 | :group 'diary) | |
ecaa0527 | 583 | |
7e1dae73 | 584 | ;;;###autoload |
b032077a | 585 | (defcustom american-date-diary-pattern |
ecaa0527 RS |
586 | '((month "/" day "[^/0-9]") |
587 | (month "/" day "/" year "[^0-9]") | |
588 | (monthname " *" day "[^,0-9]") | |
589 | (monthname " *" day ", *" year "[^0-9]") | |
590 | (dayname "\\W")) | |
591 | "*List of pseudo-patterns describing the American patterns of date used. | |
b032077a RS |
592 | See the documentation of `diary-date-forms' for an explanation." |
593 | :type '(repeat (choice (cons :tag "Backup" | |
594 | :value (backup . nil) | |
595 | (const backup) | |
596 | (repeat (list :inline t :format "%v" | |
597 | (symbol :tag "Keyword") | |
598 | (choice symbol regexp)))) | |
599 | (repeat (list :inline t :format "%v" | |
600 | (symbol :tag "Keyword") | |
601 | (choice symbol regexp))))) | |
602 | :group 'diary) | |
ecaa0527 | 603 | |
7e1dae73 | 604 | ;;;###autoload |
b032077a | 605 | (defcustom european-date-diary-pattern |
ecaa0527 RS |
606 | '((day "/" month "[^/0-9]") |
607 | (day "/" month "/" year "[^0-9]") | |
bb0541f8 | 608 | (backup day " *" monthname "\\W+\\<\\([^*0-9]\\|\\([0-9]+[:aApP]\\)\\)") |
ecaa0527 RS |
609 | (day " *" monthname " *" year "[^0-9]") |
610 | (dayname "\\W")) | |
611 | "*List of pseudo-patterns describing the European patterns of date used. | |
b032077a RS |
612 | See the documentation of `diary-date-forms' for an explanation." |
613 | :type '(repeat (choice (cons :tag "Backup" | |
614 | :value (backup . nil) | |
615 | (const backup) | |
616 | (repeat (list :inline t :format "%v" | |
617 | (symbol :tag "Keyword") | |
618 | (choice symbol regexp)))) | |
619 | (repeat (list :inline t :format "%v" | |
620 | (symbol :tag "Keyword") | |
621 | (choice symbol regexp))))) | |
622 | :group 'diary) | |
623 | ||
624 | (defcustom diary-date-forms | |
ecaa0527 RS |
625 | (if european-calendar-style |
626 | european-date-diary-pattern | |
627 | american-date-diary-pattern) | |
628 | "*List of pseudo-patterns describing the forms of date used in the diary. | |
8c64a298 | 629 | The patterns on the list must be MUTUALLY EXCLUSIVE and should not match |
ecaa0527 RS |
630 | any portion of the diary entry itself, just the date component. |
631 | ||
632 | A pseudo-pattern is a list of regular expressions and the keywords `month', | |
633 | `day', `year', `monthname', and `dayname'. The keyword `monthname' will | |
2c8811d4 GM |
634 | match the name of the month (see `calendar-month-name-array'), capitalized |
635 | or not, or its user-specified abbreviation (see `calendar-month-abbrev-array'), | |
636 | followed by a period or not; it will also match `*'. Similarly, `dayname' | |
637 | will match the name of the day (see `calendar-day-name-array'), capitalized or | |
638 | not, or its user-specified abbreviation (see `calendar-day-abbrev-array'), | |
639 | followed by a period or not. The keywords `month', `day', and `year' will | |
640 | match those numerical values, preceded by arbitrarily many zeros; they will | |
641 | also match `*'. | |
ecaa0527 RS |
642 | |
643 | The matching of the diary entries with the date forms is done with the | |
644 | standard syntax table from Fundamental mode, but with the `*' changed so | |
645 | that it is a word constituent. | |
646 | ||
647 | If, to be mutually exclusive, a pseudo-pattern must match a portion of the | |
648 | diary entry itself, the first element of the pattern MUST be `backup'. This | |
7e1dae73 JB |
649 | directive causes the date recognizer to back up to the beginning of the |
650 | current word of the diary entry, so in no case can the pattern match more than | |
b032077a RS |
651 | a portion of the first word of the diary entry." |
652 | :type '(repeat (choice (cons :tag "Backup" | |
653 | :value (backup . nil) | |
654 | (const backup) | |
655 | (repeat (list :inline t :format "%v" | |
656 | (symbol :tag "Keyword") | |
657 | (choice symbol regexp)))) | |
658 | (repeat (list :inline t :format "%v" | |
659 | (symbol :tag "Keyword") | |
660 | (choice symbol regexp))))) | |
661 | :group 'diary) | |
ecaa0527 | 662 | |
7e1dae73 | 663 | ;;;###autoload |
b032077a | 664 | (defcustom european-calendar-display-form |
7e1dae73 | 665 | '((if dayname (concat dayname ", ")) day " " monthname " " year) |
354d0644 | 666 | "*Pseudo-pattern governing the way a date appears in the European style. |
5d22135b | 667 | See the documentation of `calendar-date-display-form' for an explanation." |
b032077a RS |
668 | :type 'sexp |
669 | :group 'calendar) | |
ecaa0527 | 670 | |
7e1dae73 | 671 | ;;;###autoload |
b032077a | 672 | (defcustom american-calendar-display-form |
7e1dae73 | 673 | '((if dayname (concat dayname ", ")) monthname " " day ", " year) |
354d0644 | 674 | "*Pseudo-pattern governing the way a date appears in the American style. |
b032077a RS |
675 | See the documentation of `calendar-date-display-form' for an explanation." |
676 | :type 'sexp | |
677 | :group 'calendar) | |
ecaa0527 | 678 | |
b032077a | 679 | (defcustom calendar-date-display-form |
ecaa0527 RS |
680 | (if european-calendar-style |
681 | european-calendar-display-form | |
682 | american-calendar-display-form) | |
354d0644 JB |
683 | "*Pseudo-pattern governing the way a date appears. |
684 | ||
685 | Used by the function `calendar-date-string', a pseudo-pattern is a list of | |
686 | expressions that can involve the keywords `month', `day', and `year', all | |
687 | numbers in string form, and `monthname' and `dayname', both alphabetic | |
688 | strings. For example, the ISO standard would use the pseudo- pattern | |
ecaa0527 RS |
689 | |
690 | '(year \"-\" month \"-\" day) | |
691 | ||
692 | while a typical American form would be | |
693 | ||
694 | '(month \"/\" day \"/\" (substring year -2)) | |
695 | ||
696 | and | |
697 | ||
698 | '((format \"%9s, %9s %2s, %4s\" dayname monthname day year)) | |
699 | ||
700 | would give the usual American style in fixed-length fields. | |
701 | ||
b032077a RS |
702 | See the documentation of the function `calendar-date-string'." |
703 | :type 'sexp | |
704 | :group 'calendar) | |
ecaa0527 RS |
705 | |
706 | (defun european-calendar () | |
707 | "Set the interpretation and display of dates to the European style." | |
708 | (interactive) | |
709 | (setq european-calendar-style t) | |
710 | (setq calendar-date-display-form european-calendar-display-form) | |
711 | (setq diary-date-forms european-date-diary-pattern) | |
712 | (update-calendar-mode-line)) | |
713 | ||
714 | (defun american-calendar () | |
715 | "Set the interpretation and display of dates to the American style." | |
716 | (interactive) | |
717 | (setq european-calendar-style nil) | |
718 | (setq calendar-date-display-form american-calendar-display-form) | |
719 | (setq diary-date-forms american-date-diary-pattern) | |
720 | (update-calendar-mode-line)) | |
721 | ||
7e1dae73 | 722 | ;;;###autoload |
b032077a | 723 | (defcustom print-diary-entries-hook 'lpr-buffer |
354d0644 JB |
724 | "*List of functions called after a temporary diary buffer is prepared. |
725 | The buffer shows only the diary entries currently visible in the diary | |
726 | buffer. The default just does the printing. Other uses might include, for | |
727 | example, rearranging the lines into order by day and time, saving the buffer | |
b032077a RS |
728 | instead of deleting it, or changing the function used to do the printing." |
729 | :type 'hook | |
730 | :group 'diary) | |
ecaa0527 | 731 | |
e5d77022 | 732 | ;;;###autoload |
b032077a | 733 | (defcustom list-diary-entries-hook nil |
354d0644 JB |
734 | "*List of functions called after diary file is culled for relevant entries. |
735 | It is to be used for diary entries that are not found in the diary file. | |
ecaa0527 RS |
736 | |
737 | A function `include-other-diary-files' is provided for use as the value of | |
738 | this hook. This function enables you to use shared diary files together | |
6b1abbd1 | 739 | with your own. The files included are specified in the diary file by lines |
ecaa0527 RS |
740 | of the form |
741 | ||
742 | #include \"filename\" | |
743 | ||
744 | This is recursive; that is, #include directives in files thus included are | |
745 | obeyed. You can change the \"#include\" to some other string by changing | |
746 | the variable `diary-include-string'. When you use `include-other-diary-files' | |
747 | as part of the list-diary-entries-hook, you will probably also want to use the | |
6b1abbd1 | 748 | function `mark-included-diary-files' as part of `mark-diary-entries-hook'. |
ecaa0527 RS |
749 | |
750 | For example, you could use | |
751 | ||
752 | (setq list-diary-entries-hook | |
7e1dae73 | 753 | '(include-other-diary-files sort-diary-entries)) |
ecaa0527 RS |
754 | (setq diary-display-hook 'fancy-diary-display) |
755 | ||
6b1abbd1 | 756 | in your `.emacs' file to cause the fancy diary buffer to be displayed with |
ecaa0527 | 757 | diary entries from various included files, each day's entries sorted into |
b032077a RS |
758 | lexicographic order." |
759 | :type 'hook | |
6b61353c | 760 | :options '(include-other-diary-files sort-diary-entries) |
b032077a | 761 | :group 'diary) |
ecaa0527 | 762 | |
e5d77022 | 763 | ;;;###autoload |
b032077a | 764 | (defcustom diary-hook nil |
34fa2dc2 | 765 | "*List of functions called after the display of the diary. |
b032077a RS |
766 | Can be used for appointment notification." |
767 | :type 'hook | |
768 | :group 'diary) | |
34fa2dc2 RS |
769 | |
770 | ;;;###autoload | |
b032077a | 771 | (defcustom diary-display-hook nil |
ecaa0527 | 772 | "*List of functions that handle the display of the diary. |
e555fdd8 | 773 | If nil (the default), `simple-diary-display' is used. Use `ignore' for no |
34fa2dc2 | 774 | diary display. |
ecaa0527 RS |
775 | |
776 | Ordinarily, this just displays the diary buffer (with holidays indicated in | |
777 | the mode line), if there are any relevant entries. At the time these | |
778 | functions are called, the variable `diary-entries-list' is a list, in order | |
779 | by date, of all relevant diary entries in the form of ((MONTH DAY YEAR) | |
780 | STRING), where string is the diary entry for the given date. This can be | |
34fa2dc2 RS |
781 | used, for example, a different buffer for display (perhaps combined with |
782 | holidays), or produce hard copy output. | |
ecaa0527 RS |
783 | |
784 | A function `fancy-diary-display' is provided as an alternative | |
785 | choice for this hook; this function prepares a special noneditable diary | |
786 | buffer with the relevant diary entries that has neat day-by-day arrangement | |
787 | with headings. The fancy diary buffer will show the holidays unless the | |
788 | variable `holidays-in-diary-buffer' is set to nil. Ordinarily, the fancy | |
789 | diary buffer will not show days for which there are no diary entries, even | |
790 | if that day is a holiday; if you want such days to be shown in the fancy | |
b032077a RS |
791 | diary buffer, set the variable `diary-list-include-blanks' to t." |
792 | :type 'hook | |
6b61353c | 793 | :options '(fancy-diary-display) |
b032077a | 794 | :group 'diary) |
ecaa0527 | 795 | |
e5d77022 | 796 | ;;;###autoload |
b032077a | 797 | (defcustom nongregorian-diary-listing-hook nil |
354d0644 | 798 | "*List of functions called for listing diary file and included files. |
b0e6051a GM |
799 | As the files are processed for diary entries, these functions are used to cull |
800 | relevant entries. You can use either or both of `list-hebrew-diary-entries' | |
801 | and `list-islamic-diary-entries'. The documentation for these functions | |
b032077a RS |
802 | describes the style of such diary entries." |
803 | :type 'hook | |
6b61353c | 804 | :options '(list-hebrew-diary-entries list-islamic-diary-entries) |
b032077a | 805 | :group 'diary) |
ecaa0527 | 806 | |
7e1dae73 | 807 | ;;;###autoload |
b032077a | 808 | (defcustom mark-diary-entries-hook nil |
ecaa0527 RS |
809 | "*List of functions called after marking diary entries in the calendar. |
810 | ||
811 | A function `mark-included-diary-files' is also provided for use as the | |
3cbb4860 | 812 | `mark-diary-entries-hook'; it enables you to use shared diary files together |
6b1abbd1 | 813 | with your own. The files included are specified in the diary file by lines |
ecaa0527 RS |
814 | of the form |
815 | #include \"filename\" | |
816 | This is recursive; that is, #include directives in files thus included are | |
817 | obeyed. You can change the \"#include\" to some other string by changing the | |
818 | variable `diary-include-string'. When you use `mark-included-diary-files' as | |
819 | part of the mark-diary-entries-hook, you will probably also want to use the | |
b032077a RS |
820 | function `include-other-diary-files' as part of `list-diary-entries-hook'." |
821 | :type 'hook | |
6b61353c | 822 | :options '(mark-included-diary-files) |
b032077a | 823 | :group 'diary) |
ecaa0527 | 824 | |
e5d77022 | 825 | ;;;###autoload |
b032077a | 826 | (defcustom nongregorian-diary-marking-hook nil |
354d0644 | 827 | "*List of functions called for marking diary file and included files. |
b0e6051a GM |
828 | As the files are processed for diary entries, these functions are used to cull |
829 | relevant entries. You can use either or both of `mark-hebrew-diary-entries' | |
830 | and `mark-islamic-diary-entries'. The documentation for these functions | |
b032077a RS |
831 | describes the style of such diary entries." |
832 | :type 'hook | |
6b61353c | 833 | :options '(mark-hebrew-diary-entries mark-islamic-diary-entries) |
b032077a | 834 | :group 'diary) |
ecaa0527 | 835 | |
e5d77022 | 836 | ;;;###autoload |
b032077a | 837 | (defcustom diary-list-include-blanks nil |
354d0644 | 838 | "*If nil, do not include days with no diary entry in the list of diary entries. |
ac96331d | 839 | Such days will then not be shown in the fancy diary buffer, even if they |
b032077a RS |
840 | are holidays." |
841 | :type 'boolean | |
842 | :group 'diary) | |
ecaa0527 | 843 | |
7e1dae73 | 844 | ;;;###autoload |
b032077a | 845 | (defcustom holidays-in-diary-buffer t |
e555fdd8 RS |
846 | "*Non-nil means include holidays in the diary display. |
847 | The holidays appear in the mode line of the diary buffer, or in the | |
354d0644 | 848 | fancy diary buffer next to the date. This slows down the diary functions |
b032077a RS |
849 | somewhat; setting it to nil makes the diary display faster." |
850 | :type 'boolean | |
851 | :group 'holidays) | |
ecaa0527 | 852 | |
2ec778d0 RS |
853 | (defvar calendar-mark-ring nil) |
854 | ||
e555fdd8 RS |
855 | ;;;###autoload |
856 | (put 'general-holidays 'risky-local-variable t) | |
7e1dae73 | 857 | ;;;###autoload |
b032077a | 858 | (defcustom general-holidays |
354d0644 JB |
859 | '((holiday-fixed 1 1 "New Year's Day") |
860 | (holiday-float 1 1 3 "Martin Luther King Day") | |
11f23ea2 | 861 | (holiday-fixed 2 2 "Groundhog Day") |
354d0644 JB |
862 | (holiday-fixed 2 14 "Valentine's Day") |
863 | (holiday-float 2 1 3 "President's Day") | |
864 | (holiday-fixed 3 17 "St. Patrick's Day") | |
9e32719f | 865 | (holiday-fixed 4 1 "April Fools' Day") |
354d0644 JB |
866 | (holiday-float 5 0 2 "Mother's Day") |
867 | (holiday-float 5 1 -1 "Memorial Day") | |
868 | (holiday-fixed 6 14 "Flag Day") | |
869 | (holiday-float 6 0 3 "Father's Day") | |
870 | (holiday-fixed 7 4 "Independence Day") | |
871 | (holiday-float 9 1 1 "Labor Day") | |
872 | (holiday-float 10 1 2 "Columbus Day") | |
873 | (holiday-fixed 10 31 "Halloween") | |
874 | (holiday-fixed 11 11 "Veteran's Day") | |
875 | (holiday-float 11 4 4 "Thanksgiving")) | |
876 | "*General holidays. Default value is for the United States. | |
b032077a RS |
877 | See the documentation for `calendar-holidays' for details." |
878 | :type 'sexp | |
879 | :group 'holidays) | |
ecaa0527 | 880 | |
7086b78e ER |
881 | ;;;###autoload |
882 | (put 'oriental-holidays 'risky-local-variable t) | |
883 | ;;;###autoload | |
b032077a | 884 | (defcustom oriental-holidays |
7086b78e ER |
885 | '((if (fboundp 'atan) |
886 | (holiday-chinese-new-year))) | |
887 | "*Oriental holidays. | |
b032077a RS |
888 | See the documentation for `calendar-holidays' for details." |
889 | :type 'sexp | |
890 | :group 'holidays) | |
7086b78e | 891 | |
e555fdd8 RS |
892 | ;;;###autoload |
893 | (put 'local-holidays 'risky-local-variable t) | |
7e1dae73 | 894 | ;;;###autoload |
b032077a | 895 | (defcustom local-holidays nil |
7e1dae73 | 896 | "*Local holidays. |
b032077a RS |
897 | See the documentation for `calendar-holidays' for details." |
898 | :type 'sexp | |
899 | :group 'holidays) | |
7e1dae73 | 900 | |
e555fdd8 RS |
901 | ;;;###autoload |
902 | (put 'other-holidays 'risky-local-variable t) | |
7e1dae73 | 903 | ;;;###autoload |
b032077a | 904 | (defcustom other-holidays nil |
7e1dae73 | 905 | "*User defined holidays. |
b032077a RS |
906 | See the documentation for `calendar-holidays' for details." |
907 | :type 'sexp | |
908 | :group 'holidays) | |
ecaa0527 | 909 | |
e555fdd8 RS |
910 | ;;;###autoload |
911 | (put 'hebrew-holidays-1 'risky-local-variable t) | |
7e1dae73 | 912 | ;;;###autoload |
97344751 | 913 | (defvar hebrew-holidays-1 |
354d0644 | 914 | '((holiday-rosh-hashanah-etc) |
ecaa0527 | 915 | (if all-hebrew-calendar-holidays |
354d0644 JB |
916 | (holiday-julian |
917 | 11 | |
918 | (let* ((m displayed-month) | |
919 | (y displayed-year) | |
920 | (year)) | |
921 | (increment-calendar-month m y -1) | |
922 | (let ((year (extract-calendar-year | |
923 | (calendar-julian-from-absolute | |
924 | (calendar-absolute-from-gregorian | |
925 | (list m 1 y)))))) | |
926 | (if (zerop (% (1+ year) 4)) | |
927 | 22 | |
97344751 RS |
928 | 21))) "\"Tal Umatar\" (evening)")))) |
929 | ||
e555fdd8 RS |
930 | ;;;###autoload |
931 | (put 'hebrew-holidays-2 'risky-local-variable t) | |
97344751 RS |
932 | ;;;###autoload |
933 | (defvar hebrew-holidays-2 | |
934 | '((if all-hebrew-calendar-holidays | |
354d0644 JB |
935 | (holiday-hanukkah) |
936 | (holiday-hebrew 9 25 "Hanukkah")) | |
ecaa0527 | 937 | (if all-hebrew-calendar-holidays |
354d0644 JB |
938 | (holiday-hebrew |
939 | 10 | |
940 | (let ((h-year (extract-calendar-year | |
941 | (calendar-hebrew-from-absolute | |
942 | (calendar-absolute-from-gregorian | |
943 | (list displayed-month 28 displayed-year)))))) | |
944 | (if (= (% (calendar-absolute-from-hebrew (list 10 10 h-year)) | |
945 | 7) | |
946 | 6) | |
947 | 11 10)) | |
948 | "Tzom Teveth")) | |
ecaa0527 | 949 | (if all-hebrew-calendar-holidays |
97344751 RS |
950 | (holiday-hebrew 11 15 "Tu B'Shevat")))) |
951 | ||
e555fdd8 RS |
952 | ;;;###autoload |
953 | (put 'hebrew-holidays-3 'risky-local-variable t) | |
97344751 | 954 | ;;;###autoload |
d7fa63b2 | 955 | (defvar hebrew-holidays-3 |
97344751 | 956 | '((if all-hebrew-calendar-holidays |
354d0644 | 957 | (holiday-hebrew |
ecaa0527 RS |
958 | 11 |
959 | (let ((m displayed-month) | |
960 | (y displayed-year)) | |
961 | (increment-calendar-month m y 1) | |
962 | (let* ((h-year (extract-calendar-year | |
963 | (calendar-hebrew-from-absolute | |
964 | (calendar-absolute-from-gregorian | |
965 | (list m | |
966 | (calendar-last-day-of-month m y) | |
967 | y))))) | |
968 | (s-s | |
969 | (calendar-hebrew-from-absolute | |
970 | (if (= | |
971 | (% (calendar-absolute-from-hebrew | |
972 | (list 7 1 h-year)) | |
973 | 7) | |
974 | 6) | |
975 | (calendar-dayname-on-or-before | |
976 | 6 (calendar-absolute-from-hebrew | |
977 | (list 11 17 h-year))) | |
978 | (calendar-dayname-on-or-before | |
979 | 6 (calendar-absolute-from-hebrew | |
980 | (list 11 16 h-year)))))) | |
981 | (day (extract-calendar-day s-s))) | |
982 | day)) | |
97344751 RS |
983 | "Shabbat Shirah")))) |
984 | ||
e555fdd8 RS |
985 | ;;;###autoload |
986 | (put 'hebrew-holidays-4 'risky-local-variable t) | |
97344751 RS |
987 | ;;;###autoload |
988 | (defvar hebrew-holidays-4 | |
989 | '((holiday-passover-etc) | |
ecaa0527 RS |
990 | (if (and all-hebrew-calendar-holidays |
991 | (let* ((m displayed-month) | |
992 | (y displayed-year) | |
993 | (year)) | |
994 | (increment-calendar-month m y -1) | |
995 | (let ((year (extract-calendar-year | |
996 | (calendar-julian-from-absolute | |
997 | (calendar-absolute-from-gregorian | |
998 | (list m 1 y)))))) | |
999 | (= 21 (% year 28))))) | |
354d0644 | 1000 | (holiday-julian 3 26 "Kiddush HaHamah")) |
ecaa0527 | 1001 | (if all-hebrew-calendar-holidays |
97344751 RS |
1002 | (holiday-tisha-b-av-etc)))) |
1003 | ||
e555fdd8 RS |
1004 | ;;;###autoload |
1005 | (put 'hebrew-holidays 'risky-local-variable t) | |
97344751 | 1006 | ;;;###autoload |
b032077a | 1007 | (defcustom hebrew-holidays (append hebrew-holidays-1 hebrew-holidays-2 |
97344751 | 1008 | hebrew-holidays-3 hebrew-holidays-4) |
7e1dae73 | 1009 | "*Jewish holidays. |
b032077a RS |
1010 | See the documentation for `calendar-holidays' for details." |
1011 | :type 'sexp | |
1012 | :group 'holidays) | |
7e1dae73 | 1013 | |
e555fdd8 RS |
1014 | ;;;###autoload |
1015 | (put 'christian-holidays 'risky-local-variable t) | |
7e1dae73 | 1016 | ;;;###autoload |
b032077a | 1017 | (defcustom christian-holidays |
7e1dae73 | 1018 | '((if all-christian-calendar-holidays |
354d0644 JB |
1019 | (holiday-fixed 1 6 "Epiphany")) |
1020 | (holiday-easter-etc) | |
7e1dae73 | 1021 | (if all-christian-calendar-holidays |
354d0644 | 1022 | (holiday-greek-orthodox-easter)) |
7e1dae73 | 1023 | (if all-christian-calendar-holidays |
354d0644 | 1024 | (holiday-fixed 8 15 "Assumption")) |
7e1dae73 | 1025 | (if all-christian-calendar-holidays |
354d0644 JB |
1026 | (holiday-advent)) |
1027 | (holiday-fixed 12 25 "Christmas") | |
7e1dae73 | 1028 | (if all-christian-calendar-holidays |
354d0644 | 1029 | (holiday-julian 12 25 "Eastern Orthodox Christmas"))) |
7e1dae73 | 1030 | "*Christian holidays. |
b032077a RS |
1031 | See the documentation for `calendar-holidays' for details." |
1032 | :type 'sexp | |
1033 | :group 'holidays) | |
ecaa0527 | 1034 | |
e555fdd8 RS |
1035 | ;;;###autoload |
1036 | (put 'islamic-holidays 'risky-local-variable t) | |
7e1dae73 | 1037 | ;;;###autoload |
b032077a | 1038 | (defcustom islamic-holidays |
354d0644 JB |
1039 | '((holiday-islamic |
1040 | 1 1 | |
1041 | (format "Islamic New Year %d" | |
1042 | (let ((m displayed-month) | |
1043 | (y displayed-year)) | |
1044 | (increment-calendar-month m y 1) | |
1045 | (extract-calendar-year | |
1046 | (calendar-islamic-from-absolute | |
1047 | (calendar-absolute-from-gregorian | |
1048 | (list | |
1049 | m (calendar-last-day-of-month m y) y))))))) | |
ecaa0527 | 1050 | (if all-islamic-calendar-holidays |
354d0644 | 1051 | (holiday-islamic 1 10 "Ashura")) |
ecaa0527 | 1052 | (if all-islamic-calendar-holidays |
354d0644 | 1053 | (holiday-islamic 3 12 "Mulad-al-Nabi")) |
ecaa0527 | 1054 | (if all-islamic-calendar-holidays |
354d0644 | 1055 | (holiday-islamic 7 26 "Shab-e-Mi'raj")) |
ecaa0527 | 1056 | (if all-islamic-calendar-holidays |
354d0644 JB |
1057 | (holiday-islamic 8 15 "Shab-e-Bara't")) |
1058 | (holiday-islamic 9 1 "Ramadan Begins") | |
ecaa0527 | 1059 | (if all-islamic-calendar-holidays |
354d0644 | 1060 | (holiday-islamic 9 27 "Shab-e Qadr")) |
ecaa0527 | 1061 | (if all-islamic-calendar-holidays |
354d0644 | 1062 | (holiday-islamic 10 1 "Id-al-Fitr")) |
ecaa0527 | 1063 | (if all-islamic-calendar-holidays |
354d0644 | 1064 | (holiday-islamic 12 10 "Id-al-Adha"))) |
7e1dae73 | 1065 | "*Islamic holidays. |
b032077a RS |
1066 | See the documentation for `calendar-holidays' for details." |
1067 | :type 'sexp | |
1068 | :group 'holidays) | |
7e1dae73 | 1069 | |
e555fdd8 RS |
1070 | ;;;###autoload |
1071 | (put 'solar-holidays 'risky-local-variable t) | |
7e1dae73 | 1072 | ;;;###autoload |
b032077a | 1073 | (defcustom solar-holidays |
7e1dae73 JB |
1074 | '((if (fboundp 'atan) |
1075 | (solar-equinoxes-solstices)) | |
3b92bdd2 RS |
1076 | (if (progn |
1077 | (require 'cal-dst) | |
1078 | t) | |
354d0644 | 1079 | (funcall |
3b92bdd2 | 1080 | 'holiday-sexp |
354d0644 JB |
1081 | calendar-daylight-savings-starts |
1082 | '(format "Daylight Savings Time Begins %s" | |
1083 | (if (fboundp 'atan) | |
1084 | (solar-time-string | |
8a7cdf3a ER |
1085 | (/ calendar-daylight-savings-starts-time (float 60)) |
1086 | calendar-standard-time-zone-name) | |
354d0644 JB |
1087 | "")))) |
1088 | (funcall | |
1089 | 'holiday-sexp | |
1090 | calendar-daylight-savings-ends | |
1091 | '(format "Daylight Savings Time Ends %s" | |
1092 | (if (fboundp 'atan) | |
1093 | (solar-time-string | |
8a7cdf3a ER |
1094 | (/ calendar-daylight-savings-ends-time (float 60)) |
1095 | calendar-daylight-time-zone-name) | |
354d0644 | 1096 | "")))) |
7e1dae73 | 1097 | "*Sun-related holidays. |
b032077a RS |
1098 | See the documentation for `calendar-holidays' for details." |
1099 | :type 'sexp | |
1100 | :group 'holidays) | |
7e1dae73 | 1101 | |
e555fdd8 RS |
1102 | ;;;###autoload |
1103 | (put 'calendar-holidays 'risky-local-variable t) | |
b032077a | 1104 | (defcustom calendar-holidays |
354d0644 JB |
1105 | (append general-holidays local-holidays other-holidays |
1106 | christian-holidays hebrew-holidays islamic-holidays | |
b0e6051a | 1107 | oriental-holidays solar-holidays) |
3cbb4860 | 1108 | "*List of notable days for the command \\[holidays]. |
7e1dae73 | 1109 | |
b0e6051a GM |
1110 | Additional holidays are easy to add to the list, just put them in the list |
1111 | `other-holidays' in your .emacs file. Similarly, by setting any of | |
1112 | `general-holidays', `local-holidays' `christian-holidays', `hebrew-holidays', | |
1113 | `islamic-holidays', `oriental-holidays', or `solar-holidays' to nil in your | |
1114 | .emacs file, you can eliminate unwanted categories of holidays. The intention | |
1115 | is that (in the US) `local-holidays' be set in site-init.el and | |
7086b78e | 1116 | `other-holidays' be set by the user. |
7e1dae73 | 1117 | |
354d0644 JB |
1118 | Entries on the list are expressions that return (possibly empty) lists of |
1119 | items of the form ((month day year) string) of a holiday in the in the | |
1120 | three-month period centered around `displayed-month' of `displayed-year'. | |
1121 | Several basic functions are provided for this purpose: | |
1122 | ||
1123 | (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar | |
1124 | (holiday-float MONTH DAYNAME K STRING &optional day) is the Kth DAYNAME in | |
1125 | MONTH on the Gregorian calendar (0 for Sunday, | |
1126 | etc.); K<0 means count back from the end of the | |
3cbb4860 | 1127 | month. An optional parameter DAY means the Kth |
354d0644 JB |
1128 | DAYNAME after/before MONTH DAY. |
1129 | (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar | |
1130 | (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar | |
1131 | (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar | |
1132 | (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression | |
7e1dae73 JB |
1133 | in the variable `year'; if it evaluates to |
1134 | a visible date, that's the holiday; if it | |
354d0644 JB |
1135 | evaluates to nil, there's no holiday. STRING |
1136 | is an expression in the variable `date'. | |
ecaa0527 RS |
1137 | |
1138 | For example, to add Bastille Day, celebrated in France on July 14, add | |
1139 | ||
354d0644 | 1140 | (holiday-fixed 7 14 \"Bastille Day\") |
ecaa0527 RS |
1141 | |
1142 | to the list. To add Hurricane Supplication Day, celebrated in the Virgin | |
1143 | Islands on the fourth Monday in August, add | |
1144 | ||
354d0644 | 1145 | (holiday-float 8 1 4 \"Hurricane Supplication Day\") |
ecaa0527 RS |
1146 | |
1147 | to the list (the last Monday would be specified with `-1' instead of `4'). | |
7e1dae73 | 1148 | To add the last day of Hanukkah to the list, use |
ecaa0527 | 1149 | |
354d0644 | 1150 | (holiday-hebrew 10 2 \"Last day of Hanukkah\") |
ecaa0527 RS |
1151 | |
1152 | since the Hebrew months are numbered with 1 starting from Nisan, while to | |
1153 | add the Islamic feast celebrating Mohammed's birthday use | |
1154 | ||
354d0644 | 1155 | (holiday-islamic 3 12 \"Mohammed's Birthday\") |
ecaa0527 RS |
1156 | |
1157 | since the Islamic months are numbered from 1 starting with Muharram. To | |
1158 | add Thomas Jefferson's birthday, April 2, 1743 (Julian), use | |
1159 | ||
354d0644 | 1160 | (holiday-julian 4 2 \"Jefferson's Birthday\") |
ecaa0527 | 1161 | |
354d0644 JB |
1162 | To include a holiday conditionally, use the sexp form or a conditional. For |
1163 | example, to include American presidential elections, which occur on the first | |
1164 | Tuesday after the first Monday in November of years divisible by 4, add | |
ecaa0527 | 1165 | |
354d0644 | 1166 | (holiday-sexp |
6b61353c | 1167 | '(if (zerop (% year 4)) |
354d0644 JB |
1168 | (calendar-gregorian-from-absolute |
1169 | (1+ (calendar-dayname-on-or-before | |
1170 | 1 (+ 6 (calendar-absolute-from-gregorian | |
1171 | (list 11 1 year))))))) | |
1172 | \"US Presidential Election\") | |
7e1dae73 JB |
1173 | |
1174 | or | |
1175 | ||
ecaa0527 | 1176 | (if (zerop (% displayed-year 4)) |
354d0644 | 1177 | (holiday-fixed 11 |
ecaa0527 RS |
1178 | (extract-calendar-day |
1179 | (calendar-gregorian-from-absolute | |
1180 | (1+ (calendar-dayname-on-or-before | |
1181 | 1 (+ 6 (calendar-absolute-from-gregorian | |
1182 | (list 11 1 displayed-year))))))) | |
1183 | \"US Presidential Election\")) | |
1184 | ||
1185 | to the list. To include the phases of the moon, add | |
1186 | ||
1187 | (lunar-phases) | |
1188 | ||
354d0644 JB |
1189 | to the holiday list, where `lunar-phases' is an Emacs-Lisp function that |
1190 | you've written to return a (possibly empty) list of the relevant VISIBLE dates | |
1191 | with descriptive strings such as | |
ecaa0527 | 1192 | |
b032077a RS |
1193 | (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )." |
1194 | :type 'sexp | |
1195 | :group 'holidays) | |
ecaa0527 | 1196 | |
ecaa0527 RS |
1197 | (defconst calendar-buffer "*Calendar*" |
1198 | "Name of the buffer used for the calendar.") | |
1199 | ||
1200 | (defconst holiday-buffer "*Holidays*" | |
1201 | "Name of the buffer used for the displaying the holidays.") | |
1202 | ||
1203 | (defconst fancy-diary-buffer "*Fancy Diary Entries*" | |
1204 | "Name of the buffer used for the optional fancy display of the diary.") | |
1205 | ||
726669d8 ER |
1206 | (defconst other-calendars-buffer "*Other Calendars*" |
1207 | "Name of the buffer used for the display of date on other calendars.") | |
1208 | ||
cba0c253 ER |
1209 | (defconst lunar-phases-buffer "*Phases of Moon*" |
1210 | "Name of the buffer used for the lunar phases.") | |
1211 | ||
ecaa0527 | 1212 | (defmacro increment-calendar-month (mon yr n) |
6b61353c KH |
1213 | "Increment the variables MON and YR by N months. |
1214 | Forward if N is positive or backward if N is negative. | |
1215 | A negative YR is interpreted as BC; -1 being 1 BC, and so on." | |
1216 | `(let (macro-y) | |
1217 | (if (< ,yr 0) (setq ,yr (1+ ,yr))) ; -1 BC -> 0 AD, etc | |
1218 | (setq macro-y (+ (* ,yr 12) ,mon -1 ,n) | |
1219 | ,mon (1+ (mod macro-y 12)) | |
1220 | ,yr (/ macro-y 12)) | |
1221 | (and (< macro-y 0) (> ,mon 1) (setq ,yr (1- ,yr))) | |
1222 | (if (< ,yr 1) (setq ,yr (1- ,yr))))) ; 0 AD -> -1 BC, etc | |
ecaa0527 RS |
1223 | |
1224 | (defmacro calendar-for-loop (var from init to final do &rest body) | |
1225 | "Execute a for loop." | |
7e1e5cf1 SS |
1226 | `(let ((,var (1- ,init))) |
1227 | (while (>= ,final (setq ,var (1+ ,var))) | |
1228 | ,@body))) | |
ecaa0527 RS |
1229 | |
1230 | (defmacro calendar-sum (index initial condition expression) | |
354d0644 | 1231 | "For INDEX = INITIAL et seq, as long as CONDITION holds, sum EXPRESSION." |
7e1e5cf1 SS |
1232 | `(let ((,index ,initial) |
1233 | (sum 0)) | |
1234 | (while ,condition | |
1235 | (setq sum (+ sum ,expression)) | |
1236 | (setq ,index (1+ ,index))) | |
1237 | sum)) | |
ecaa0527 | 1238 | |
cba0c253 ER |
1239 | ;; The following are in-line for speed; they can be called thousands of times |
1240 | ;; when looking up holidays or processing the diary. Here, for example, are | |
1241 | ;; the numbers of calls to calendar/diary/holiday functions in preparing the | |
e5d77022 JB |
1242 | ;; fancy diary display, for a moderately complex diary file, with functions |
1243 | ;; used instead of macros. There were a total of 10000 such calls: | |
1244 | ;; | |
1245 | ;; 1934 extract-calendar-month | |
1246 | ;; 1852 extract-calendar-year | |
1247 | ;; 1819 extract-calendar-day | |
1248 | ;; 845 calendar-leap-year-p | |
1249 | ;; 837 calendar-day-number | |
1250 | ;; 775 calendar-absolute-from-gregorian | |
1251 | ;; 346 calendar-last-day-of-month | |
1252 | ;; 286 hebrew-calendar-last-day-of-month | |
1253 | ;; 188 hebrew-calendar-leap-year-p | |
1254 | ;; 180 hebrew-calendar-elapsed-days | |
1255 | ;; 163 hebrew-calendar-last-month-of-year | |
1256 | ;; 66 calendar-date-compare | |
1257 | ;; 65 hebrew-calendar-days-in-year | |
1258 | ;; 60 calendar-absolute-from-julian | |
1259 | ;; 50 calendar-absolute-from-hebrew | |
1260 | ;; 43 calendar-date-equal | |
1261 | ;; 38 calendar-gregorian-from-absolute | |
1262 | ;; . | |
1263 | ;; . | |
1264 | ;; . | |
1265 | ;; | |
1266 | ;; The use of these seven macros eliminates the overhead of 92% of the function | |
cba0c253 | 1267 | ;; calls; it's faster this way. |
e5d77022 | 1268 | |
cba0c253 | 1269 | (defsubst extract-calendar-month (date) |
ecaa0527 | 1270 | "Extract the month part of DATE which has the form (month day year)." |
cba0c253 | 1271 | (car date)) |
ecaa0527 | 1272 | |
cba0c253 | 1273 | (defsubst extract-calendar-day (date) |
ecaa0527 | 1274 | "Extract the day part of DATE which has the form (month day year)." |
cba0c253 | 1275 | (car (cdr date))) |
ecaa0527 | 1276 | |
cba0c253 | 1277 | (defsubst extract-calendar-year (date) |
ecaa0527 | 1278 | "Extract the year part of DATE which has the form (month day year)." |
cba0c253 | 1279 | (car (cdr (cdr date)))) |
ecaa0527 | 1280 | |
cba0c253 | 1281 | (defsubst calendar-leap-year-p (year) |
6b61353c KH |
1282 | "Return t if YEAR is a Gregorian leap year. |
1283 | A negative year is interpreted as BC; -1 being 1 BC, and so on." | |
1284 | ;; 1 BC = 0 AD, 2 BC acts like 1 AD, etc. | |
1285 | (if (< year 0) (setq year (1- (abs year)))) | |
cba0c253 ER |
1286 | (and (zerop (% year 4)) |
1287 | (or (not (zerop (% year 100))) | |
1288 | (zerop (% year 400))))) | |
1289 | ||
354d0644 JB |
1290 | ;; The foregoing is a bit faster, but not as clear as the following: |
1291 | ;; | |
cba0c253 | 1292 | ;;(defsubst calendar-leap-year-p (year) |
7e1dae73 JB |
1293 | ;; "Returns t if YEAR is a Gregorian leap year." |
1294 | ;; (or | |
1295 | ;; (and (= (% year 4) 0) | |
1296 | ;; (/= (% year 100) 0)) | |
1297 | ;; (= (% year 400) 0))) | |
e5d77022 | 1298 | |
cba0c253 | 1299 | (defsubst calendar-last-day-of-month (month year) |
e5d77022 | 1300 | "The last day in MONTH during YEAR." |
cba0c253 ER |
1301 | (if (and (= month 2) (calendar-leap-year-p year)) |
1302 | 29 | |
1303 | (aref [31 28 31 30 31 30 31 31 30 31 30 31] (1- month)))) | |
1304 | ||
1305 | ;; An explanation of the calculation can be found in PascAlgorithms by | |
1306 | ;; Edward and Ruth Reingold, Scott-Foresman/Little, Brown, 1988. | |
1307 | ||
1308 | (defsubst calendar-day-number (date) | |
e5d77022 JB |
1309 | "Return the day number within the year of the date DATE. |
1310 | For example, (calendar-day-number '(1 1 1987)) returns the value 1, | |
1311 | while (calendar-day-number '(12 31 1980)) returns 366." | |
cba0c253 ER |
1312 | (let* ((month (extract-calendar-month date)) |
1313 | (day (extract-calendar-day date)) | |
1314 | (year (extract-calendar-year date)) | |
1315 | (day-of-year (+ day (* 31 (1- month))))) | |
1316 | (if (> month 2) | |
1317 | (progn | |
1318 | (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10))) | |
1319 | (if (calendar-leap-year-p year) | |
e5d77022 | 1320 | (setq day-of-year (1+ day-of-year))))) |
cba0c253 ER |
1321 | day-of-year)) |
1322 | ||
1323 | (defsubst calendar-absolute-from-gregorian (date) | |
e5d77022 | 1324 | "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE. |
6b61353c KH |
1325 | The Gregorian date Sunday, December 31, 1 BC is imaginary. |
1326 | DATE is a list of the form (month day year). A negative year is | |
1327 | interpreted as BC; -1 being 1 BC, and so on. Dates before 12/31/1 BC | |
1328 | return negative results." | |
1329 | (let ((year (extract-calendar-year date)) | |
1330 | offset-years) | |
1331 | (cond ((= year 0) | |
1332 | (error "There was no year zero")) | |
1333 | ((> year 0) | |
1334 | (setq offset-years (1- year)) | |
1335 | (+ (calendar-day-number date) ; Days this year | |
1336 | (* 365 offset-years) ; + Days in prior years | |
1337 | (/ offset-years 4) ; + Julian leap years | |
1338 | (- (/ offset-years 100)) ; - century years | |
1339 | (/ offset-years 400))) ; + Gregorian leap years | |
1340 | (t | |
1341 | ;; Years between date and 1 BC, excluding 1 BC (1 for 2 BC, etc). | |
1342 | (setq offset-years (abs (1+ year))) | |
1343 | (- (calendar-day-number date) | |
1344 | (* 365 offset-years) | |
1345 | (/ offset-years 4) | |
1346 | (- (/ offset-years 100)) | |
1347 | (/ offset-years 400) | |
1348 | (calendar-day-number '(12 31 -1))))))) ; days in year 1 BC | |
e5d77022 | 1349 | |
7086b78e ER |
1350 | (autoload 'calendar-goto-today "cal-move" |
1351 | "Reposition the calendar window so the current date is visible." | |
1352 | t) | |
1353 | ||
1354 | (autoload 'calendar-forward-month "cal-move" | |
1355 | "Move the cursor forward ARG months." | |
1356 | t) | |
1357 | ||
1358 | (autoload 'calendar-forward-year "cal-move" | |
1359 | "Move the cursor forward by ARG years." | |
1360 | t) | |
1361 | ||
1362 | (autoload 'calendar-backward-month "cal-move" | |
1363 | "Move the cursor backward by ARG months." | |
1364 | t) | |
1365 | ||
1366 | (autoload 'calendar-backward-year "cal-move" | |
1367 | "Move the cursor backward ARG years." | |
1368 | t) | |
1369 | ||
1370 | (autoload 'scroll-calendar-left "cal-move" | |
1371 | "Scroll the displayed calendar left by ARG months." | |
1372 | t) | |
1373 | ||
1374 | (autoload 'scroll-calendar-right "cal-move" | |
1375 | "Scroll the displayed calendar window right by ARG months." | |
1376 | t) | |
1377 | ||
1378 | (autoload 'scroll-calendar-left-three-months "cal-move" | |
1379 | "Scroll the displayed calendar window left by 3*ARG months." | |
1380 | t) | |
1381 | ||
1382 | (autoload 'scroll-calendar-right-three-months "cal-move" | |
1383 | "Scroll the displayed calendar window right by 3*ARG months." | |
1384 | t) | |
1385 | ||
1386 | (autoload 'calendar-cursor-to-nearest-date "cal-move" | |
1387 | "Move the cursor to the closest date." | |
1388 | t) | |
1389 | ||
1390 | (autoload 'calendar-forward-day "cal-move" | |
1391 | "Move the cursor forward ARG days." | |
1392 | t) | |
1393 | ||
1394 | (autoload 'calendar-backward-day "cal-move" | |
1395 | "Move the cursor back ARG days." | |
1396 | t) | |
1397 | ||
1398 | (autoload 'calendar-forward-week "cal-move" | |
1399 | "Move the cursor forward ARG weeks." | |
1400 | t) | |
1401 | ||
1402 | (autoload 'calendar-backward-week "cal-move" | |
1403 | "Move the cursor back ARG weeks." | |
1404 | t) | |
1405 | ||
1406 | (autoload 'calendar-beginning-of-week "cal-move" | |
1407 | "Move the cursor back ARG calendar-week-start-day's." | |
1408 | t) | |
1409 | ||
1410 | (autoload 'calendar-end-of-week "cal-move" | |
1411 | "Move the cursor forward ARG calendar-week-start-day+6's." | |
1412 | t) | |
1413 | ||
1414 | (autoload 'calendar-beginning-of-month "cal-move" | |
1415 | "Move the cursor backward ARG month beginnings." | |
1416 | t) | |
1417 | ||
1418 | (autoload 'calendar-end-of-month "cal-move" | |
1419 | "Move the cursor forward ARG month ends." | |
1420 | t) | |
1421 | ||
1422 | (autoload 'calendar-beginning-of-year "cal-move" | |
1423 | "Move the cursor backward ARG year beginnings." | |
1424 | t) | |
1425 | ||
1426 | (autoload 'calendar-end-of-year "cal-move" | |
1427 | "Move the cursor forward ARG year beginnings." | |
1428 | t) | |
1429 | ||
1430 | (autoload 'calendar-cursor-to-visible-date "cal-move" | |
1431 | "Move the cursor to DATE that is on the screen." | |
1432 | t) | |
1433 | ||
1434 | (autoload 'calendar-goto-date "cal-move" | |
1435 | "Move cursor to DATE." | |
1436 | t) | |
1437 | ||
6b61353c KH |
1438 | (autoload 'calendar-goto-day-of-year "cal-move" |
1439 | "Move cursor to day of year." | |
1440 | t) | |
1441 | ||
945e6102 GM |
1442 | (autoload 'calendar-only-one-frame-setup "cal-x" |
1443 | "Start calendar and display it in a dedicated frame.") | |
1444 | ||
7086b78e ER |
1445 | (autoload 'calendar-one-frame-setup "cal-x" |
1446 | "Start calendar and display it in a dedicated frame together with the diary.") | |
1447 | ||
1448 | (autoload 'calendar-two-frame-setup "cal-x" | |
1449 | "Start calendar and diary in separate, dedicated frames.") | |
7e1e5cf1 | 1450 | |
7086b78e | 1451 | ;;;###autoload |
6b61353c KH |
1452 | (defcustom calendar-setup nil |
1453 | "The frame setup of the calendar. | |
1454 | The choices are: `one-frame' (calendar and diary together in one separate, | |
1455 | dedicated frame); `two-frames' (calendar and diary in separate, dedicated | |
1456 | frames); `calendar-only' (calendar in a separate, dedicated frame); with | |
1457 | any other value the current frame is used. Using any of the first | |
1458 | three options overrides the value of `view-diary-entries-initially'." | |
1459 | :type '(choice | |
1460 | (const :tag "calendar and diary in separate frame" one-frame) | |
1461 | (const :tag "calendar and diary each in own frame" two-frames) | |
1462 | (const :tag "calendar in separate frame" calendar-only) | |
1463 | (const :tag "use current frame" nil)) | |
1464 | :group 'calendar) | |
7086b78e | 1465 | |
94b304d7 | 1466 | ;;;###autoload |
ecaa0527 | 1467 | (defun calendar (&optional arg) |
7086b78e | 1468 | "Choose between the one frame, two frame, or basic calendar displays. |
bc461571 EZ |
1469 | If called with an optional prefix argument, prompts for month and year. |
1470 | ||
1471 | The original function `calendar' has been renamed `calendar-basic-setup'. | |
1472 | See the documentation of that function for more information." | |
7086b78e ER |
1473 | (interactive "P") |
1474 | (cond ((equal calendar-setup 'one-frame) (calendar-one-frame-setup arg)) | |
1475 | ((equal calendar-setup 'two-frames) (calendar-two-frame-setup arg)) | |
a4410177 KH |
1476 | ((equal calendar-setup 'calendar-only) |
1477 | (calendar-only-one-frame-setup arg)) | |
7086b78e ER |
1478 | (t (calendar-basic-setup arg)))) |
1479 | ||
1480 | (defun calendar-basic-setup (&optional arg) | |
ecaa0527 RS |
1481 | "Display a three-month calendar in another window. |
1482 | The three months appear side by side, with the current month in the middle | |
1483 | surrounded by the previous and next months. The cursor is put on today's date. | |
1484 | ||
7e1dae73 JB |
1485 | If called with an optional prefix argument, prompts for month and year. |
1486 | ||
ecaa0527 RS |
1487 | This function is suitable for execution in a .emacs file; appropriate setting |
1488 | of the variable `view-diary-entries-initially' will cause the diary entries for | |
1489 | the current date to be displayed in another window. The value of the variable | |
1490 | `number-of-diary-entries' controls the number of days of diary entries | |
1491 | displayed upon initial display of the calendar. | |
1492 | ||
ecaa0527 RS |
1493 | Once in the calendar window, future or past months can be moved into view. |
1494 | Arbitrary months can be displayed, or the calendar can be scrolled forward | |
1495 | or backward. | |
1496 | ||
1497 | The cursor can be moved forward or backward by one day, one week, one month, | |
1498 | or one year. All of these commands take prefix arguments which, when negative, | |
1499 | cause movement in the opposite direction. For convenience, the digit keys | |
1500 | and the minus sign are automatically prefixes. The window is replotted as | |
1501 | necessary to display the desired date. | |
1502 | ||
1503 | Diary entries can be marked on the calendar or displayed in another window. | |
1504 | ||
3cbb4860 | 1505 | Use \\[describe-mode] for details of the key bindings in the calendar window. |
ecaa0527 RS |
1506 | |
1507 | The Gregorian calendar is assumed. | |
1508 | ||
7e1dae73 | 1509 | After loading the calendar, the hooks given by the variable |
2b803765 | 1510 | `calendar-load-hook' are run. This is the place to add key bindings to the |
7e1dae73 JB |
1511 | calendar-mode-map. |
1512 | ||
ecaa0527 RS |
1513 | After preparing the calendar window initially, the hooks given by the variable |
1514 | `initial-calendar-window-hook' are run. | |
1515 | ||
1516 | The hooks given by the variable `today-visible-calendar-hook' are run | |
a69472b3 | 1517 | every time the calendar window gets scrolled, if the current date is visible |
ecaa0527 RS |
1518 | in the window. If it is not visible, the hooks given by the variable |
1519 | `today-invisible-calendar-hook' are run. Thus, for example, setting | |
1520 | `today-visible-calendar-hook' to 'calendar-star-date will cause today's date | |
1521 | to be replaced by asterisks to highlight it whenever it is in the window." | |
1522 | (interactive "P") | |
ecaa0527 RS |
1523 | (set-buffer (get-buffer-create calendar-buffer)) |
1524 | (calendar-mode) | |
ecd42d42 | 1525 | (let* ((pop-up-windows t) |
7e1dae73 | 1526 | (split-height-threshold 1000) |
cba0c253 ER |
1527 | (date (if arg |
1528 | (calendar-read-date t) | |
1529 | (calendar-current-date))) | |
1530 | (month (extract-calendar-month date)) | |
1531 | (year (extract-calendar-year date))) | |
ecaa0527 | 1532 | (pop-to-buffer calendar-buffer) |
cba0c253 | 1533 | (increment-calendar-month month year (- calendar-offset)) |
7e1dae73 JB |
1534 | (generate-calendar-window month year) |
1535 | (if (and view-diary-entries-initially (calendar-date-is-visible-p date)) | |
1536 | (view-diary-entries | |
1537 | (if (vectorp number-of-diary-entries) | |
1538 | (aref number-of-diary-entries (calendar-day-of-week date)) | |
1539 | number-of-diary-entries)))) | |
1540 | (let* ((diary-buffer (get-file-buffer diary-file)) | |
1541 | (diary-window (if diary-buffer (get-buffer-window diary-buffer))) | |
1542 | (split-height-threshold (if diary-window 2 1000))) | |
1543 | (if view-calendar-holidays-initially | |
1544 | (list-calendar-holidays))) | |
ecaa0527 RS |
1545 | (run-hooks 'initial-calendar-window-hook)) |
1546 | ||
fb30f0ce | 1547 | (autoload 'view-diary-entries "diary-lib" |
ecaa0527 | 1548 | "Prepare and display a buffer with diary entries. |
6b1abbd1 | 1549 | Searches your diary file for entries that match ARG days starting with |
ecaa0527 RS |
1550 | the date indicated by the cursor position in the displayed three-month |
1551 | calendar." | |
1552 | t) | |
1553 | ||
7e1dae73 JB |
1554 | (autoload 'calendar-sunrise-sunset "solar" |
1555 | "Local time of sunrise and sunset for date under cursor." | |
1556 | t) | |
1557 | ||
1558 | (autoload 'calendar-phases-of-moon "lunar" | |
1559 | "Create a buffer of the phases of the moon for the current calendar window." | |
1560 | t) | |
1561 | ||
1562 | (autoload 'calendar-print-french-date "cal-french" | |
6a2aa94c | 1563 | "Show the French Revolutionary calendar equivalent of the date under the cursor." |
7e1dae73 JB |
1564 | t) |
1565 | ||
1566 | (autoload 'calendar-goto-french-date "cal-french" | |
1567 | "Move cursor to French Revolutionary date." | |
1568 | t) | |
1569 | ||
6a2aa94c | 1570 | (autoload 'calendar-french-date-string "cal-french" |
7086b78e | 1571 | "String of French Revolutionary date of Gregorian date." |
6a2aa94c RS |
1572 | t) |
1573 | ||
1574 | (autoload 'calendar-mayan-date-string "cal-mayan" | |
7086b78e | 1575 | "String of Mayan date of Gregorian date." |
6a2aa94c RS |
1576 | t) |
1577 | ||
7e1dae73 | 1578 | (autoload 'calendar-print-mayan-date "cal-mayan" |
6a2aa94c | 1579 | "Show the Mayan long count, Tzolkin, and Haab equivalents of the date under the cursor." |
7e1dae73 JB |
1580 | t) |
1581 | ||
1582 | (autoload 'calendar-goto-mayan-long-count-date "cal-mayan" | |
1583 | "Move cursor to Mayan long count date." | |
1584 | t) | |
1585 | ||
1586 | (autoload 'calendar-next-haab-date "cal-mayan" | |
1587 | "Move cursor to next instance of Mayan Haab date." | |
1588 | t) | |
1589 | ||
1590 | (autoload 'calendar-previous-haab-date "cal-mayan" | |
1591 | "Move cursor to previous instance of Mayan Haab date." | |
1592 | t) | |
1593 | ||
1594 | (autoload 'calendar-next-tzolkin-date "cal-mayan" | |
1595 | "Move cursor to next instance of Mayan Tzolkin date." | |
1596 | t) | |
1597 | ||
1598 | (autoload 'calendar-previous-tzolkin-date "cal-mayan" | |
1599 | "Move cursor to previous instance of Mayan Tzolkin date." | |
1600 | t) | |
1601 | ||
1602 | (autoload 'calendar-next-calendar-round-date "cal-mayan" | |
a69472b3 | 1603 | "Move cursor to next instance of Mayan Haab/Tzolkin combination." |
7e1dae73 JB |
1604 | t) |
1605 | ||
1606 | (autoload 'calendar-previous-calendar-round-date "cal-mayan" | |
a69472b3 | 1607 | "Move cursor to previous instance of Mayan Haab/Tzolkin combination." |
7e1dae73 JB |
1608 | t) |
1609 | ||
327b6868 | 1610 | (autoload 'calendar-goto-chinese-date "cal-china" |
6cf0fb79 | 1611 | "Move cursor to Chinese date." |
7086b78e ER |
1612 | t) |
1613 | ||
327b6868 | 1614 | (autoload 'calendar-print-chinese-date "cal-china" |
7086b78e ER |
1615 | "Show the Chinese date equivalents of date." |
1616 | t) | |
1617 | ||
327b6868 | 1618 | (autoload 'calendar-chinese-date-string "cal-china" |
7086b78e ER |
1619 | "String of Chinese date of Gregorian date." |
1620 | t) | |
1621 | ||
d1b8adf7 | 1622 | (autoload 'calendar-absolute-from-astro "cal-julian" |
6cf0fb79 | 1623 | "Absolute date of astronomical (Julian) day number D." |
d1b8adf7 | 1624 | t ) |
6cf0fb79 | 1625 | |
14fcc701 KH |
1626 | (autoload 'calendar-astro-from-absolute "cal-julian" |
1627 | "Astronomical (Julian) day number of absolute date D.") | |
1628 | ||
6cf0fb79 ER |
1629 | (autoload 'calendar-astro-date-string "cal-julian" |
1630 | "String of astronomical (Julian) day number of Gregorian date." | |
1631 | t) | |
1632 | ||
435d749c | 1633 | (autoload 'calendar-goto-astro-day-number "cal-julian" |
6cf0fb79 ER |
1634 | "Move cursor to astronomical (Julian) day number." |
1635 | t) | |
1636 | ||
d1b8adf7 GM |
1637 | (autoload 'calendar-print-astro-day-number "cal-julian" |
1638 | "Show the astro date equivalents of date." | |
1639 | t) | |
1640 | ||
6dcba8a3 RS |
1641 | (autoload 'calendar-julian-from-absolute "cal-julian" |
1642 | "Compute the Julian (month day year) corresponding to the absolute DATE. | |
1643 | The absolute date is the number of days elapsed since the (imaginary) | |
1644 | Gregorian date Sunday, December 31, 1 BC.") | |
1645 | ||
7086b78e ER |
1646 | (autoload 'calendar-goto-julian-date "cal-julian" |
1647 | "Move cursor to Julian DATE; echo Julian date unless NOECHO is t." | |
1648 | t) | |
1649 | ||
2b3f69c8 RS |
1650 | (autoload 'calendar-print-julian-date "cal-julian" |
1651 | "Show the Julian calendar equivalent of the date under the cursor." | |
1652 | t) | |
1653 | ||
07986bc4 RS |
1654 | (autoload 'calendar-julian-date-string "cal-julian" |
1655 | "String of Julian date of Gregorian DATE. | |
1656 | Defaults to today's date if DATE is not given. | |
bfca0f6b | 1657 | Driven by the variable `calendar-date-display-form'.") |
07986bc4 | 1658 | |
7086b78e ER |
1659 | (autoload 'calendar-goto-iso-date "cal-iso" |
1660 | "Move cursor to ISO date." | |
1661 | t) | |
1662 | ||
1663 | (autoload 'calendar-print-iso-date "cal-iso" | |
1664 | "Show the ISO date equivalents of date." | |
1665 | t) | |
1666 | ||
1667 | (autoload 'calendar-iso-date-string "cal-iso" | |
1668 | "String of ISO date of Gregorian date." | |
1669 | t) | |
1670 | ||
93867648 GM |
1671 | (autoload 'calendar-goto-islamic-date "cal-islam" |
1672 | "Move cursor to Islamic date." | |
1673 | t) | |
1674 | ||
327b6868 | 1675 | (autoload 'calendar-print-islamic-date "cal-islam" |
7086b78e ER |
1676 | "Show the Islamic date equivalents of date." |
1677 | t) | |
1678 | ||
327b6868 | 1679 | (autoload 'calendar-islamic-date-string "cal-islam" |
7086b78e ER |
1680 | "String of Islamic date of Gregorian date." |
1681 | t) | |
1682 | ||
1683 | (autoload 'calendar-goto-hebrew-date "cal-hebrew" | |
1684 | "Move cursor to Hebrew date date." | |
1685 | t) | |
1686 | ||
1687 | (autoload 'calendar-print-hebrew-date "cal-hebrew" | |
1688 | "Show the Hebrew date equivalents of date." | |
1689 | t) | |
1690 | ||
1691 | (autoload 'calendar-hebrew-date-string "cal-hebrew" | |
1692 | "String of Hebrew date of Gregorian date." | |
1693 | t) | |
1694 | ||
1695 | (autoload 'calendar-goto-coptic-date "cal-coptic" | |
1696 | "Move cursor to Coptic date date." | |
1697 | t) | |
1698 | ||
1699 | (autoload 'calendar-print-coptic-date "cal-coptic" | |
1700 | "Show the Coptic date equivalents of date." | |
1701 | t) | |
1702 | ||
1703 | (autoload 'calendar-coptic-date-string "cal-coptic" | |
1704 | "String of Coptic date of Gregorian date." | |
1705 | t) | |
1706 | ||
1707 | (autoload 'calendar-goto-ethiopic-date "cal-coptic" | |
1708 | "Move cursor to Ethiopic date date." | |
1709 | t) | |
1710 | ||
1711 | (autoload 'calendar-print-ethiopic-date "cal-coptic" | |
1712 | "Show the Ethiopic date equivalents of date." | |
1713 | t) | |
1714 | ||
1715 | (autoload 'calendar-ethiopic-date-string "cal-coptic" | |
1716 | "String of Ethiopic date of Gregorian date." | |
1717 | t) | |
1718 | ||
a45eee72 | 1719 | (autoload 'calendar-goto-persian-date "cal-persia" |
c21eb13d ER |
1720 | "Move cursor to Persian date date." |
1721 | t) | |
1722 | ||
a45eee72 | 1723 | (autoload 'calendar-print-persian-date "cal-persia" |
c21eb13d ER |
1724 | "Show the Persian date equivalents of date." |
1725 | t) | |
1726 | ||
a45eee72 | 1727 | (autoload 'calendar-persian-date-string "cal-persia" |
c21eb13d ER |
1728 | "String of Persian date of Gregorian date." |
1729 | t) | |
1730 | ||
fb30f0ce | 1731 | (autoload 'show-all-diary-entries "diary-lib" |
6b1abbd1 RS |
1732 | "Show all of the diary entries in the diary file. |
1733 | This function gets rid of the selective display of the diary file so that | |
ecaa0527 RS |
1734 | all entries, not just some, are visible. If there is no diary buffer, one |
1735 | is created." | |
1736 | t) | |
1737 | ||
fb30f0ce | 1738 | (autoload 'mark-diary-entries "diary-lib" |
ecaa0527 | 1739 | "Mark days in the calendar window that have diary entries. |
6b1abbd1 | 1740 | Each entry in diary file visible in the calendar window is marked." |
ecaa0527 RS |
1741 | t) |
1742 | ||
fb30f0ce | 1743 | (autoload 'make-diary-entry "diary-lib" |
7086b78e ER |
1744 | "Insert a diary entry STRING which may be NONMARKING in FILE." |
1745 | t) | |
1746 | ||
fb30f0ce | 1747 | (autoload 'insert-diary-entry "diary-lib" |
ecaa0527 RS |
1748 | "Insert a diary entry for the date indicated by point." |
1749 | t) | |
1750 | ||
fb30f0ce | 1751 | (autoload 'insert-weekly-diary-entry "diary-lib" |
ecaa0527 RS |
1752 | "Insert a weekly diary entry for the day of the week indicated by point." |
1753 | t) | |
1754 | ||
354d0644 | 1755 | |
fb30f0ce | 1756 | (autoload 'insert-monthly-diary-entry "diary-lib" |
ecaa0527 RS |
1757 | "Insert a monthly diary entry for the day of the month indicated by point." |
1758 | t) | |
1759 | ||
fb30f0ce | 1760 | (autoload 'insert-yearly-diary-entry "diary-lib" |
ecaa0527 RS |
1761 | "Insert an annual diary entry for the day of the year indicated by point." |
1762 | t) | |
1763 | ||
fb30f0ce | 1764 | (autoload 'insert-anniversary-diary-entry "diary-lib" |
ecaa0527 RS |
1765 | "Insert an anniversary diary entry for the date indicated by point." |
1766 | t) | |
1767 | ||
fb30f0ce | 1768 | (autoload 'insert-block-diary-entry "diary-lib" |
ecaa0527 RS |
1769 | "Insert a block diary entry for the dates indicated by point and mark." |
1770 | t) | |
1771 | ||
fb30f0ce | 1772 | (autoload 'insert-cyclic-diary-entry "diary-lib" |
ecaa0527 RS |
1773 | "Insert a cyclic diary entry starting at the date indicated by point." |
1774 | t) | |
1775 | ||
7086b78e | 1776 | (autoload 'insert-hebrew-diary-entry "cal-hebrew" |
ecaa0527 RS |
1777 | "Insert a diary entry for the Hebrew date corresponding to the date |
1778 | indicated by point." | |
1779 | t) | |
1780 | ||
7086b78e | 1781 | (autoload 'insert-monthly-hebrew-diary-entry "cal-hebrew" |
ecaa0527 RS |
1782 | "Insert a monthly diary entry for the day of the Hebrew month corresponding |
1783 | to the date indicated by point." | |
1784 | t) | |
1785 | ||
7086b78e | 1786 | (autoload 'insert-yearly-hebrew-diary-entry "cal-hebrew" |
ecaa0527 RS |
1787 | "Insert an annual diary entry for the day of the Hebrew year corresponding |
1788 | to the date indicated by point." | |
1789 | t) | |
1790 | ||
327b6868 | 1791 | (autoload 'insert-islamic-diary-entry "cal-islam" |
ecaa0527 RS |
1792 | "Insert a diary entry for the Islamic date corresponding to the date |
1793 | indicated by point." | |
1794 | t) | |
1795 | ||
327b6868 | 1796 | (autoload 'insert-monthly-islamic-diary-entry "cal-islam" |
ecaa0527 RS |
1797 | "Insert a monthly diary entry for the day of the Islamic month corresponding |
1798 | to the date indicated by point." | |
1799 | t) | |
1800 | ||
327b6868 | 1801 | (autoload 'insert-yearly-islamic-diary-entry "cal-islam" |
ecaa0527 RS |
1802 | "Insert an annual diary entry for the day of the Islamic year corresponding |
1803 | to the date indicated by point." | |
1804 | t) | |
1805 | ||
1806 | (autoload 'list-calendar-holidays "holidays" | |
1807 | "Create a buffer containing the holidays for the current calendar window. | |
1808 | The holidays are those in the list `calendar-notable-days'. Returns t if any | |
1809 | holidays are found, nil if not." | |
1810 | t) | |
1811 | ||
3076647c ER |
1812 | (autoload 'cal-tex-cursor-month "cal-tex" |
1813 | "Make a buffer with LaTeX commands for the month cursor is on. | |
1814 | Optional prefix argument specifies number of months to be produced. | |
1815 | Calendar is condensed onto one page.") | |
1816 | ||
1817 | (autoload 'cal-tex-cursor-month-landscape "cal-tex" | |
1818 | "Make a buffer with LaTeX commands for the month cursor is on. | |
1819 | Optional prefix argument specifies number of months to be produced.") | |
1820 | ||
1821 | (autoload 'cal-tex-cursor-day "cal-tex" | |
1822 | "Make a buffer with LaTeX commands for the day cursor is on.") | |
1823 | ||
1824 | (autoload 'cal-tex-cursor-week "cal-tex" | |
5a2c140a RS |
1825 | "Make a buffer with LaTeX commands for a two-page one-week calendar. |
1826 | It applies to the week that point is in. | |
1827 | Optional prefix argument specifies number of weeks. | |
1828 | Holidays are included if `cal-tex-holidays' is t.") | |
1829 | ||
7e1e5cf1 | 1830 | (autoload 'cal-tex-cursor-week2 "cal-tex" |
5a2c140a RS |
1831 | "Make a buffer with LaTeX commands for a two-page one-week calendar. |
1832 | It applies to the week that point is in. | |
1833 | Optional prefix argument specifies number of weeks. | |
1834 | Holidays are included if `cal-tex-holidays' is t.") | |
1835 | ||
1836 | (autoload 'cal-tex-cursor-week-iso "cal-tex" | |
1837 | "Make a buffer with LaTeX commands for a one page ISO-style weekly calendar. | |
07e4feff | 1838 | Optional prefix argument specifies number of weeks. |
5a2c140a RS |
1839 | Diary entries are included if `cal-tex-diary' is t. |
1840 | Holidays are included if `cal-tex-holidays' is t.") | |
1841 | ||
1842 | (autoload 'cal-tex-cursor-week-monday "cal-tex" | |
1843 | "Make a buffer with LaTeX commands for a two-page one-week calendar. | |
1844 | It applies to the week that point is in, and starts on Monday. | |
1845 | Optional prefix argument specifies number of weeks. | |
1846 | Holidays are included if `cal-tex-holidays' is t.") | |
1847 | ||
1848 | (autoload 'cal-tex-cursor-filofax-2week "cal-tex" | |
1849 | "Two-weeks-at-a-glance Filofax style calendar for week indicated by cursor. | |
1850 | Optional prefix argument specifies number of weeks. | |
1851 | Diary entries are included if cal-tex-diary is t. | |
1852 | Holidays are included if `cal-tex-holidays' is t.") | |
1853 | ||
1854 | (autoload 'cal-tex-cursor-filofax-week "cal-tex" | |
1855 | "One-week-at-a-glance Filofax style calendar for week indicated by cursor. | |
1856 | Optional prefix argument specifies number of weeks. | |
7e1e5cf1 | 1857 | Weeks start on Monday. |
5a2c140a RS |
1858 | Diary entries are included if cal-tex-diary is t. |
1859 | Holidays are included if `cal-tex-holidays' is t.") | |
3076647c | 1860 | |
9018e77d KH |
1861 | (autoload 'cal-tex-cursor-filofax-daily "cal-tex" |
1862 | "Day-per-page Filofax style calendar for week indicated by cursor. | |
7e1e5cf1 | 1863 | Optional prefix argument specifies number of weeks. Weeks start on Monday. |
9018e77d KH |
1864 | Diary entries are included if `cal-tex-diary' is t. |
1865 | Holidays are included if `cal-tex-holidays' is t.") | |
1866 | ||
3076647c ER |
1867 | (autoload 'cal-tex-cursor-year "cal-tex" |
1868 | "Make a buffer with LaTeX commands for a year's calendar. | |
a69472b3 | 1869 | Optional prefix argument specifies number of years.") |
3076647c ER |
1870 | |
1871 | (autoload 'cal-tex-cursor-year-landscape "cal-tex" | |
1872 | "Make a buffer with LaTeX commands for a year's calendar (landscape). | |
1873 | Optional prefix argument specifies number of years.") | |
1874 | ||
1875 | (autoload 'cal-tex-cursor-filofax-year "cal-tex" | |
1876 | "Make a buffer with LaTeX commands for a year's calendar (Filofax). | |
1877 | Optional prefix argument specifies number of years.") | |
1878 | ||
ecaa0527 RS |
1879 | (autoload 'mark-calendar-holidays "holidays" |
1880 | "Mark notable days in the calendar window." | |
1881 | t) | |
1882 | ||
1883 | (autoload 'calendar-cursor-holidays "holidays" | |
1884 | "Find holidays for the date specified by the cursor in the calendar window." | |
1885 | t) | |
1886 | ||
7e1dae73 JB |
1887 | (defun generate-calendar-window (&optional mon yr) |
1888 | "Generate the calendar window for the current date. | |
1889 | Or, for optional MON, YR." | |
ecaa0527 | 1890 | (let* ((buffer-read-only nil) |
ecaa0527 RS |
1891 | (today (calendar-current-date)) |
1892 | (month (extract-calendar-month today)) | |
1893 | (day (extract-calendar-day today)) | |
1894 | (year (extract-calendar-year today)) | |
7e1dae73 JB |
1895 | (today-visible |
1896 | (or (not mon) | |
1897 | (let ((offset (calendar-interval mon yr month year))) | |
1898 | (and (<= offset 1) (>= offset -1))))) | |
ecaa0527 RS |
1899 | (day-in-week (calendar-day-of-week today))) |
1900 | (update-calendar-mode-line) | |
7e1dae73 JB |
1901 | (if mon |
1902 | (generate-calendar mon yr) | |
1903 | (generate-calendar month year)) | |
ecaa0527 RS |
1904 | (calendar-cursor-to-visible-date |
1905 | (if today-visible today (list displayed-month 1 displayed-year))) | |
1906 | (set-buffer-modified-p nil) | |
31754518 MB |
1907 | (if (or (one-window-p t) (/= (frame-width) (window-width))) |
1908 | ;; Don't mess with the window size, but ensure that the first | |
1909 | ;; line is fully visible | |
1910 | (set-window-vscroll nil 0) | |
1911 | ;; Adjust the window to exactly fit the displayed calendar | |
b85fa13c | 1912 | (fit-window-to-buffer)) |
ecaa0527 | 1913 | (sit-for 0) |
d13c1378 JB |
1914 | (if (and (boundp 'font-lock-mode) |
1915 | font-lock-mode) | |
5d22135b | 1916 | (font-lock-fontify-buffer)) |
ecaa0527 | 1917 | (and mark-holidays-in-calendar |
6b61353c | 1918 | ;;; (calendar-date-is-legal-p today) ; useful for BC dates |
ecaa0527 RS |
1919 | (mark-calendar-holidays) |
1920 | (sit-for 0)) | |
1921 | (unwind-protect | |
1922 | (if mark-diary-entries-in-calendar (mark-diary-entries)) | |
1923 | (if today-visible | |
1924 | (run-hooks 'today-visible-calendar-hook) | |
1925 | (run-hooks 'today-invisible-calendar-hook))))) | |
1926 | ||
1927 | (defun generate-calendar (month year) | |
1928 | "Generate a three-month Gregorian calendar centered around MONTH, YEAR." | |
6b61353c KH |
1929 | ;;; A negative YEAR is interpreted as BC; -1 being 1 BC, and so on. |
1930 | ;;; Note that while calendars for years BC could be displayed as it | |
1931 | ;;; stands, almost all other calendar functions (eg holidays) would | |
1932 | ;;; at best have unpredictable results for such dates. | |
ecaa0527 | 1933 | (if (< (+ month (* 12 (1- year))) 2) |
3afbc435 | 1934 | (error "Months before February, 1 AD are not available")) |
6b61353c KH |
1935 | (setq displayed-month month |
1936 | displayed-year year) | |
ecaa0527 RS |
1937 | (erase-buffer) |
1938 | (increment-calendar-month month year -1) | |
1939 | (calendar-for-loop i from 0 to 2 do | |
1940 | (generate-calendar-month month year (+ 5 (* 25 i))) | |
1941 | (increment-calendar-month month year 1))) | |
1942 | ||
1943 | (defun generate-calendar-month (month year indent) | |
1944 | "Produce a calendar for MONTH, YEAR on the Gregorian calendar. | |
f2172a68 EZ |
1945 | The calendar is inserted at the top of the buffer in which point is currently |
1946 | located, but indented INDENT spaces. The indentation is done from the first | |
1947 | character on the line and does not disturb the first INDENT characters on the | |
1948 | line." | |
d8a200a7 | 1949 | (let* ((blank-days;; at start of month |
b6c0aabf | 1950 | (mod |
d8a200a7 RS |
1951 | (- (calendar-day-of-week (list month 1 year)) |
1952 | calendar-week-start-day) | |
1953 | 7)) | |
1954 | (last (calendar-last-day-of-month month year))) | |
1955 | (goto-char (point-min)) | |
1956 | (calendar-insert-indented | |
1957 | (calendar-string-spread | |
cbecb9f9 | 1958 | (list (format "%s %d" (calendar-month-name month) year)) ? 20) |
d8a200a7 RS |
1959 | indent t) |
1960 | (calendar-insert-indented "" indent);; Go to proper spot | |
2c8811d4 | 1961 | ;; Use the first two characters of each day to head the columns. |
d8a200a7 | 1962 | (calendar-for-loop i from 0 to 6 do |
2c8811d4 GM |
1963 | (insert |
1964 | (let ((string | |
1965 | (calendar-day-name (mod (+ calendar-week-start-day i) 7) nil t))) | |
1966 | (if enable-multibyte-characters | |
1967 | (truncate-string-to-width string 2) | |
1968 | (substring string 0 2))) | |
1969 | " ")) | |
d8a200a7 RS |
1970 | (calendar-insert-indented "" 0 t);; Force onto following line |
1971 | (calendar-insert-indented "" indent);; Go to proper spot | |
1972 | ;; Add blank days before the first of the month | |
1973 | (calendar-for-loop i from 1 to blank-days do (insert " ")) | |
1974 | ;; Put in the days of the month | |
1975 | (calendar-for-loop i from 1 to last do | |
1976 | (insert (format "%2d " i)) | |
218abc51 EZ |
1977 | (add-text-properties |
1978 | (- (point) 3) (1- (point)) | |
1979 | '(mouse-face highlight | |
1980 | help-echo "mouse-2: menu of operations for this date")) | |
b6c0aabf | 1981 | (and (zerop (mod (+ i blank-days) 7)) |
d8a200a7 RS |
1982 | (/= i last) |
1983 | (calendar-insert-indented "" 0 t) ;; Force onto following line | |
1984 | (calendar-insert-indented "" indent)))));; Go to proper spot | |
ecaa0527 RS |
1985 | |
1986 | (defun calendar-insert-indented (string indent &optional newline) | |
1987 | "Insert STRING at column INDENT. | |
1988 | If the optional parameter NEWLINE is t, leave point at start of next line, | |
1989 | inserting a newline if there was no next line; otherwise, leave point after | |
1990 | the inserted text. Value is always t." | |
1991 | ;; Try to move to that column. | |
1992 | (move-to-column indent) | |
1993 | ;; If line is too short, indent out to that column. | |
1994 | (if (< (current-column) indent) | |
1995 | (indent-to indent)) | |
1996 | (insert string) | |
1997 | ;; Advance to next line, if requested. | |
1998 | (if newline | |
1999 | (progn | |
2000 | (end-of-line) | |
2001 | (if (eobp) | |
2002 | (newline) | |
2003 | (forward-line 1)))) | |
2004 | t) | |
2005 | ||
2006 | (defun redraw-calendar () | |
2007 | "Redraw the calendar display." | |
2008 | (interactive) | |
d172e3e4 | 2009 | (let ((cursor-date (calendar-cursor-to-nearest-date))) |
7e1dae73 | 2010 | (generate-calendar-window displayed-month displayed-year) |
ecaa0527 RS |
2011 | (calendar-cursor-to-visible-date cursor-date))) |
2012 | ||
b032077a RS |
2013 | (defcustom calendar-debug-sexp nil |
2014 | "*Turn debugging on when evaluating a sexp in the diary or holiday list." | |
2015 | :type 'boolean | |
2016 | :group 'calendar) | |
354d0644 | 2017 | |
ecaa0527 RS |
2018 | (defvar calendar-mode-map nil) |
2019 | (if calendar-mode-map | |
2020 | nil | |
2021 | (setq calendar-mode-map (make-sparse-keymap)) | |
d24f1b15 | 2022 | (require 'cal-menu) |
ecaa0527 RS |
2023 | (calendar-for-loop i from 0 to 9 do |
2024 | (define-key calendar-mode-map (int-to-string i) 'digit-argument)) | |
2025 | (let ((l (list 'narrow-to-region 'mark-word 'mark-sexp 'mark-paragraph | |
6b39e127 | 2026 | 'mark-defun 'mark-whole-buffer 'mark-page |
8f12817f ER |
2027 | 'downcase-region 'upcase-region 'kill-region |
2028 | 'copy-region-as-kill 'capitalize-region 'write-region))) | |
6b39e127 RS |
2029 | (while l |
2030 | (substitute-key-definition (car l) 'calendar-not-implemented | |
2031 | calendar-mode-map global-map) | |
2032 | (setq l (cdr l)))) | |
ecaa0527 RS |
2033 | (define-key calendar-mode-map "-" 'negative-argument) |
2034 | (define-key calendar-mode-map "\C-x>" 'scroll-calendar-right) | |
0d336f18 | 2035 | (define-key calendar-mode-map [prior] 'scroll-calendar-right-three-months) |
ff4373ed | 2036 | (define-key calendar-mode-map "\ev" 'scroll-calendar-right-three-months) |
ecaa0527 | 2037 | (define-key calendar-mode-map "\C-x<" 'scroll-calendar-left) |
0d336f18 | 2038 | (define-key calendar-mode-map [next] 'scroll-calendar-left-three-months) |
ff4373ed | 2039 | (define-key calendar-mode-map "\C-v" 'scroll-calendar-left-three-months) |
ecaa0527 RS |
2040 | (define-key calendar-mode-map "\C-b" 'calendar-backward-day) |
2041 | (define-key calendar-mode-map "\C-p" 'calendar-backward-week) | |
7e1dae73 | 2042 | (define-key calendar-mode-map "\e{" 'calendar-backward-month) |
ecaa0527 RS |
2043 | (define-key calendar-mode-map "\C-x[" 'calendar-backward-year) |
2044 | (define-key calendar-mode-map "\C-f" 'calendar-forward-day) | |
2045 | (define-key calendar-mode-map "\C-n" 'calendar-forward-week) | |
e9c78f07 RS |
2046 | (define-key calendar-mode-map [left] 'calendar-backward-day) |
2047 | (define-key calendar-mode-map [up] 'calendar-backward-week) | |
2048 | (define-key calendar-mode-map [right] 'calendar-forward-day) | |
2049 | (define-key calendar-mode-map [down] 'calendar-forward-week) | |
7e1dae73 | 2050 | (define-key calendar-mode-map "\e}" 'calendar-forward-month) |
ecaa0527 RS |
2051 | (define-key calendar-mode-map "\C-x]" 'calendar-forward-year) |
2052 | (define-key calendar-mode-map "\C-a" 'calendar-beginning-of-week) | |
2053 | (define-key calendar-mode-map "\C-e" 'calendar-end-of-week) | |
2054 | (define-key calendar-mode-map "\ea" 'calendar-beginning-of-month) | |
2055 | (define-key calendar-mode-map "\ee" 'calendar-end-of-month) | |
2056 | (define-key calendar-mode-map "\e<" 'calendar-beginning-of-year) | |
2057 | (define-key calendar-mode-map "\e>" 'calendar-end-of-year) | |
2058 | (define-key calendar-mode-map "\C-@" 'calendar-set-mark) | |
5e2a0ae4 | 2059 | ;; Many people are used to typing C-SPC and getting C-@. |
e68e61b5 | 2060 | (define-key calendar-mode-map [?\C- ] 'calendar-set-mark) |
ecaa0527 | 2061 | (define-key calendar-mode-map "\C-x\C-x" 'calendar-exchange-point-and-mark) |
7e1dae73 JB |
2062 | (define-key calendar-mode-map "\e=" 'calendar-count-days-region) |
2063 | (define-key calendar-mode-map "gd" 'calendar-goto-date) | |
6b61353c | 2064 | (define-key calendar-mode-map "gD" 'calendar-goto-day-of-year) |
7e1dae73 JB |
2065 | (define-key calendar-mode-map "gj" 'calendar-goto-julian-date) |
2066 | (define-key calendar-mode-map "ga" 'calendar-goto-astro-day-number) | |
2067 | (define-key calendar-mode-map "gh" 'calendar-goto-hebrew-date) | |
2068 | (define-key calendar-mode-map "gi" 'calendar-goto-islamic-date) | |
7086b78e ER |
2069 | (define-key calendar-mode-map "gC" 'calendar-goto-chinese-date) |
2070 | (define-key calendar-mode-map "gk" 'calendar-goto-coptic-date) | |
2071 | (define-key calendar-mode-map "ge" 'calendar-goto-ethiopic-date) | |
c21eb13d | 2072 | (define-key calendar-mode-map "gp" 'calendar-goto-persian-date) |
7e1dae73 JB |
2073 | (define-key calendar-mode-map "gc" 'calendar-goto-iso-date) |
2074 | (define-key calendar-mode-map "gf" 'calendar-goto-french-date) | |
2075 | (define-key calendar-mode-map "gml" 'calendar-goto-mayan-long-count-date) | |
2076 | (define-key calendar-mode-map "gmpc" 'calendar-previous-calendar-round-date) | |
2077 | (define-key calendar-mode-map "gmnc" 'calendar-next-calendar-round-date) | |
2078 | (define-key calendar-mode-map "gmph" 'calendar-previous-haab-date) | |
2079 | (define-key calendar-mode-map "gmnh" 'calendar-next-haab-date) | |
2080 | (define-key calendar-mode-map "gmpt" 'calendar-previous-tzolkin-date) | |
2081 | (define-key calendar-mode-map "gmnt" 'calendar-next-tzolkin-date) | |
14f1a889 ER |
2082 | (define-key calendar-mode-map "Aa" 'appt-add) |
2083 | (define-key calendar-mode-map "Ad" 'appt-delete) | |
7e1dae73 JB |
2084 | (define-key calendar-mode-map "S" 'calendar-sunrise-sunset) |
2085 | (define-key calendar-mode-map "M" 'calendar-phases-of-moon) | |
2086 | (define-key calendar-mode-map " " 'scroll-other-window) | |
ecaa0527 | 2087 | (define-key calendar-mode-map "\C-c\C-l" 'redraw-calendar) |
899b130e | 2088 | (define-key calendar-mode-map "." 'calendar-goto-today) |
7e1dae73 JB |
2089 | (define-key calendar-mode-map "o" 'calendar-other-month) |
2090 | (define-key calendar-mode-map "q" 'exit-calendar) | |
2091 | (define-key calendar-mode-map "a" 'list-calendar-holidays) | |
2092 | (define-key calendar-mode-map "h" 'calendar-cursor-holidays) | |
2093 | (define-key calendar-mode-map "x" 'mark-calendar-holidays) | |
2094 | (define-key calendar-mode-map "u" 'calendar-unmark) | |
2095 | (define-key calendar-mode-map "m" 'mark-diary-entries) | |
2096 | (define-key calendar-mode-map "d" 'view-diary-entries) | |
46e07c15 | 2097 | (define-key calendar-mode-map "D" 'view-other-diary-entries) |
7e1dae73 JB |
2098 | (define-key calendar-mode-map "s" 'show-all-diary-entries) |
2099 | (define-key calendar-mode-map "pd" 'calendar-print-day-of-year) | |
7086b78e ER |
2100 | (define-key calendar-mode-map "pC" 'calendar-print-chinese-date) |
2101 | (define-key calendar-mode-map "pk" 'calendar-print-coptic-date) | |
2102 | (define-key calendar-mode-map "pe" 'calendar-print-ethiopic-date) | |
c21eb13d | 2103 | (define-key calendar-mode-map "pp" 'calendar-print-persian-date) |
7e1dae73 JB |
2104 | (define-key calendar-mode-map "pc" 'calendar-print-iso-date) |
2105 | (define-key calendar-mode-map "pj" 'calendar-print-julian-date) | |
2106 | (define-key calendar-mode-map "pa" 'calendar-print-astro-day-number) | |
2107 | (define-key calendar-mode-map "ph" 'calendar-print-hebrew-date) | |
2108 | (define-key calendar-mode-map "pi" 'calendar-print-islamic-date) | |
2109 | (define-key calendar-mode-map "pf" 'calendar-print-french-date) | |
2110 | (define-key calendar-mode-map "pm" 'calendar-print-mayan-date) | |
726669d8 | 2111 | (define-key calendar-mode-map "po" 'calendar-print-other-dates) |
7e1dae73 JB |
2112 | (define-key calendar-mode-map "id" 'insert-diary-entry) |
2113 | (define-key calendar-mode-map "iw" 'insert-weekly-diary-entry) | |
2114 | (define-key calendar-mode-map "im" 'insert-monthly-diary-entry) | |
2115 | (define-key calendar-mode-map "iy" 'insert-yearly-diary-entry) | |
2116 | (define-key calendar-mode-map "ia" 'insert-anniversary-diary-entry) | |
2117 | (define-key calendar-mode-map "ib" 'insert-block-diary-entry) | |
2118 | (define-key calendar-mode-map "ic" 'insert-cyclic-diary-entry) | |
2119 | (define-key calendar-mode-map "ihd" 'insert-hebrew-diary-entry) | |
2120 | (define-key calendar-mode-map "ihm" 'insert-monthly-hebrew-diary-entry) | |
2121 | (define-key calendar-mode-map "ihy" 'insert-yearly-hebrew-diary-entry) | |
2122 | (define-key calendar-mode-map "iid" 'insert-islamic-diary-entry) | |
2123 | (define-key calendar-mode-map "iim" 'insert-monthly-islamic-diary-entry) | |
2124 | (define-key calendar-mode-map "iiy" 'insert-yearly-islamic-diary-entry) | |
3076647c ER |
2125 | (define-key calendar-mode-map "?" 'calendar-goto-info-node) |
2126 | (define-key calendar-mode-map "tm" 'cal-tex-cursor-month) | |
2127 | (define-key calendar-mode-map "tM" 'cal-tex-cursor-month-landscape) | |
2128 | (define-key calendar-mode-map "td" 'cal-tex-cursor-day) | |
2129 | (define-key calendar-mode-map "tw1" 'cal-tex-cursor-week) | |
2130 | (define-key calendar-mode-map "tw2" 'cal-tex-cursor-week2) | |
5a2c140a RS |
2131 | (define-key calendar-mode-map "tw3" 'cal-tex-cursor-week-iso) |
2132 | (define-key calendar-mode-map "tw4" 'cal-tex-cursor-week-monday) | |
9018e77d | 2133 | (define-key calendar-mode-map "tfd" 'cal-tex-cursor-filofax-daily) |
5a2c140a RS |
2134 | (define-key calendar-mode-map "tfw" 'cal-tex-cursor-filofax-2week) |
2135 | (define-key calendar-mode-map "tfW" 'cal-tex-cursor-filofax-week) | |
3076647c ER |
2136 | (define-key calendar-mode-map "tfy" 'cal-tex-cursor-filofax-year) |
2137 | (define-key calendar-mode-map "ty" 'cal-tex-cursor-year) | |
2138 | (define-key calendar-mode-map "tY" 'cal-tex-cursor-year-landscape)) | |
ecaa0527 RS |
2139 | |
2140 | (defun describe-calendar-mode () | |
5d22135b | 2141 | "Create a help buffer with a brief description of the `calendar-mode'." |
ecaa0527 RS |
2142 | (interactive) |
2143 | (with-output-to-temp-buffer "*Help*" | |
2144 | (princ | |
2145 | (format | |
2146 | "Calendar Mode:\nFor a complete description, type %s\n%s\n" | |
2147 | (substitute-command-keys | |
2148 | "\\<calendar-mode-map>\\[describe-mode] from within the calendar") | |
2149 | (substitute-command-keys "\\{calendar-mode-map}"))) | |
ddbfcbde KH |
2150 | (save-excursion |
2151 | (set-buffer standard-output) | |
2152 | (help-mode)) | |
ecaa0527 RS |
2153 | (print-help-return-message))) |
2154 | ||
2155 | ;; Calendar mode is suitable only for specially formatted data. | |
2156 | (put 'calendar-mode 'mode-class 'special) | |
2157 | ||
2158 | (defvar calendar-mode-line-format | |
7e1dae73 | 2159 | (list |
d4ff5db9 DL |
2160 | (propertize (substitute-command-keys |
2161 | "\\<calendar-mode-map>\\[scroll-calendar-left]") | |
2162 | 'help-echo "mouse-2: scroll left" | |
f059e122 | 2163 | 'keymap (make-mode-line-mouse-map 'mouse-2 |
989a6aa7 | 2164 | 'mouse-scroll-calendar-left)) |
7e1dae73 | 2165 | "Calendar" |
d4ff5db9 DL |
2166 | (concat |
2167 | (propertize | |
2168 | (substitute-command-keys | |
2169 | "\\<calendar-mode-map>\\[calendar-goto-info-node] info") | |
2170 | 'help-echo "mouse-2: read Info on Calendar" | |
f059e122 | 2171 | 'keymap (make-mode-line-mouse-map 'mouse-2 'calendar-goto-info-node)) |
d4ff5db9 DL |
2172 | "/" |
2173 | (propertize | |
2174 | (substitute-command-keys | |
2175 | "\\<calendar-mode-map>\\[calendar-other-month] other") | |
2176 | 'help-echo "mouse-2: choose another month" | |
f059e122 | 2177 | 'keymap (make-mode-line-mouse-map |
989a6aa7 | 2178 | 'mouse-2 'mouse-calendar-other-month)) |
d4ff5db9 DL |
2179 | "/" |
2180 | (propertize | |
2181 | (substitute-command-keys | |
2182 | "\\<calendar-mode-map>\\[calendar-goto-today] today") | |
2183 | 'help-echo "mouse-2: go to today's date" | |
d0b56ec5 | 2184 | 'keymap (make-mode-line-mouse-map 'mouse-2 #'calendar-goto-today))) |
7e1dae73 | 2185 | '(calendar-date-string (calendar-current-date) t) |
d4ff5db9 DL |
2186 | (propertize (substitute-command-keys |
2187 | "\\<calendar-mode-map>\\[scroll-calendar-right]") | |
2188 | 'help-echo "mouse-2: scroll right" | |
f059e122 | 2189 | 'keymap (make-mode-line-mouse-map |
989a6aa7 | 2190 | 'mouse-2 'mouse-scroll-calendar-right))) |
a39f5a80 RS |
2191 | "The mode line of the calendar buffer. |
2192 | ||
2193 | This must be a list of items that evaluate to strings--those strings are | |
2194 | evaluated and concatenated together, evenly separated by blanks. The variable | |
2195 | `date' is available for use as the date under (or near) the cursor; `date' | |
2196 | defaults to the current date if it is otherwise undefined. Here is an example | |
8c64a298 | 2197 | value that has the Hebrew date, the day number/days remaining in the year, |
a39f5a80 RS |
2198 | and the ISO week/year numbers in the mode. When calendar-move-hook is set to |
2199 | 'update-calendar-mode-line, these mode line shows these values for the date | |
2200 | under the cursor: | |
2201 | ||
2202 | (list | |
2203 | \"\" | |
2204 | '(calendar-hebrew-date-string date) | |
2205 | '(let* ((year (extract-calendar-year date)) | |
2206 | (d (calendar-day-number date)) | |
2207 | (days-remaining | |
2208 | (- (calendar-day-number (list 12 31 year)) d))) | |
2209 | (format \"%d/%d\" d days-remaining)) | |
2210 | '(let* ((d (calendar-absolute-from-gregorian date)) | |
2211 | (iso-date (calendar-iso-from-absolute d))) | |
2212 | (format \"ISO week %d of %d\" | |
2213 | (extract-calendar-month iso-date) | |
2214 | (extract-calendar-year iso-date))) | |
2215 | \"\")) | |
2216 | ") | |
ecaa0527 | 2217 | |
989a6aa7 RS |
2218 | (defun mouse-scroll-calendar-left (event) |
2219 | "Scroll the displayed calendar left by one month. | |
2220 | Maintains the relative position of the cursor | |
2221 | with respect to the calendar as well as possible." | |
2222 | (interactive "e") | |
2223 | (save-selected-window | |
2224 | (select-window (posn-window (event-start event))) | |
2225 | (scroll-calendar-left 1))) | |
2226 | ||
2227 | (defun mouse-scroll-calendar-right (event) | |
2228 | "Scroll the displayed calendar right by one month. | |
2229 | Maintains the relative position of the cursor | |
2230 | with respect to the calendar as well as possible." | |
2231 | (interactive "e") | |
2232 | (save-selected-window | |
2233 | (select-window (posn-window (event-start event))) | |
2234 | (scroll-calendar-right 1))) | |
2235 | ||
2236 | (defun mouse-calendar-other-month (event) | |
2237 | "Display a three-month calendar centered around a specified month and year." | |
2238 | (interactive "e") | |
2239 | (save-selected-window | |
2240 | (select-window (posn-window (event-start event))) | |
2241 | (call-interactively 'calendar-other-month))) | |
2242 | ||
cba0c253 ER |
2243 | (defun calendar-goto-info-node () |
2244 | "Go to the info node for the calendar." | |
2245 | (interactive) | |
2246 | (require 'info) | |
83ff5106 RS |
2247 | (let ((where (save-window-excursion |
2248 | (Info-find-emacs-command-nodes 'calendar)))) | |
cba0c253 | 2249 | (if (not where) |
3afbc435 | 2250 | (error "Couldn't find documentation for the calendar") |
83ff5106 RS |
2251 | (let (same-window-buffer-names) |
2252 | (info)) | |
cba0c253 ER |
2253 | (Info-find-node (car (car where)) (car (cdr (car where))))))) |
2254 | ||
5d22135b MR |
2255 | |
2256 | ||
ecaa0527 | 2257 | (defun calendar-mode () |
7e1dae73 | 2258 | "A major mode for the calendar window. |
ecaa0527 | 2259 | |
cba0c253 ER |
2260 | For a complete description, type \ |
2261 | \\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar. | |
ecaa0527 | 2262 | |
cba0c253 | 2263 | \\<calendar-mode-map>\\{calendar-mode-map}" |
ecaa0527 RS |
2264 | |
2265 | (kill-all-local-variables) | |
2266 | (setq major-mode 'calendar-mode) | |
2267 | (setq mode-name "Calendar") | |
2268 | (use-local-map calendar-mode-map) | |
2269 | (setq buffer-read-only t) | |
2270 | (setq indent-tabs-mode nil) | |
7e1dae73 | 2271 | (update-calendar-mode-line) |
d24f1b15 | 2272 | (add-hook 'activate-menubar-hook 'cal-menu-update nil t) |
ecaa0527 | 2273 | (make-local-variable 'calendar-mark-ring) |
ecaa0527 | 2274 | (make-local-variable 'displayed-month);; Month in middle of window. |
5d22135b MR |
2275 | (make-local-variable 'displayed-year) ;; Year in middle of window. |
2276 | (set (make-local-variable 'font-lock-defaults) | |
2277 | '(calendar-font-lock-keywords t))) | |
ecaa0527 | 2278 | |
7e1dae73 | 2279 | (defun calendar-string-spread (strings char length) |
cbecb9f9 ER |
2280 | "Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH. |
2281 | The effect is like mapconcat but the separating pieces are as balanced as | |
2282 | possible. Each item of STRINGS is evaluated before concatenation so it can | |
2283 | actually be an expression that evaluates to a string. If LENGTH is too short, | |
2284 | the STRINGS are just concatenated and the result truncated." | |
7e1dae73 JB |
2285 | ;; The algorithm is based on equation (3.25) on page 85 of Concrete |
2286 | ;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik, | |
2287 | ;; Addison-Wesley, Reading, MA, 1989 | |
cbecb9f9 ER |
2288 | (let* ((strings (mapcar 'eval |
2289 | (if (< (length strings) 2) | |
2290 | (append (list "") strings (list "")) | |
2291 | strings))) | |
7e1dae73 JB |
2292 | (n (- length (length (apply 'concat strings)))) |
2293 | (m (1- (length strings))) | |
2294 | (s (car strings)) | |
2295 | (strings (cdr strings)) | |
2296 | (i 0)) | |
2297 | (while strings | |
2298 | (setq s (concat s | |
2299 | (make-string (max 0 (/ (+ n i) m)) char) | |
2300 | (car strings))) | |
2301 | (setq i (1+ i)) | |
2302 | (setq strings (cdr strings))) | |
2303 | (substring s 0 length))) | |
2304 | ||
ecaa0527 RS |
2305 | (defun update-calendar-mode-line () |
2306 | "Update the calendar mode line with the current date and date style." | |
2307 | (if (bufferp (get-buffer calendar-buffer)) | |
2308 | (save-excursion | |
2309 | (set-buffer calendar-buffer) | |
2310 | (setq mode-line-format | |
7e1dae73 | 2311 | (calendar-string-spread |
a39f5a80 RS |
2312 | (let ((date (condition-case nil |
2313 | (calendar-cursor-to-nearest-date) | |
2314 | (error (calendar-current-date))))) | |
2315 | (mapcar 'eval calendar-mode-line-format)) | |
2316 | ? (frame-width))) | |
2317 | (force-mode-line-update)))) | |
ecaa0527 | 2318 | |
cba0c253 ER |
2319 | (defun calendar-window-list () |
2320 | "List of all calendar-related windows." | |
2321 | (let ((calendar-buffers (calendar-buffer-list)) | |
2322 | list) | |
d4ff5db9 DL |
2323 | (walk-windows (lambda (w) |
2324 | (if (memq (window-buffer w) calendar-buffers) | |
2325 | (setq list (cons w list)))) | |
cba0c253 ER |
2326 | nil t) |
2327 | list)) | |
2328 | ||
2329 | (defun calendar-buffer-list () | |
2330 | "List of all calendar-related buffers." | |
2331 | (let* ((diary-buffer (get-file-buffer diary-file)) | |
2332 | (buffers (list "*Yahrzeits*" lunar-phases-buffer holiday-buffer | |
9c73a356 ER |
2333 | fancy-diary-buffer diary-buffer calendar-buffer |
2334 | other-calendars-buffer)) | |
cba0c253 ER |
2335 | (buffer-list nil) |
2336 | b) | |
2337 | (while buffers | |
2338 | (setq b (car buffers)) | |
2339 | (setq b (cond ((stringp b) (get-buffer b)) | |
2340 | ((bufferp b) b) | |
2341 | (t nil))) | |
2342 | (if b (setq buffer-list (cons b buffer-list))) | |
2343 | (setq buffers (cdr buffers))) | |
2344 | buffer-list)) | |
2345 | ||
ecaa0527 | 2346 | (defun exit-calendar () |
cba0c253 | 2347 | "Get out of the calendar window and hide it and related buffers." |
ecaa0527 | 2348 | (interactive) |
cba0c253 | 2349 | (let* ((diary-buffer (get-file-buffer diary-file))) |
38023020 ER |
2350 | (if (or (not diary-buffer) |
2351 | (not (buffer-modified-p diary-buffer)) | |
2352 | (yes-or-no-p | |
2353 | "Diary modified; do you really want to exit the calendar? ")) | |
cba0c253 ER |
2354 | ;; Need to do this multiple times because one time can replace some |
2355 | ;; calendar-related buffers with other calendar-related buffers | |
2356 | (mapcar (lambda (x) | |
2357 | (mapcar 'calendar-hide-window (calendar-window-list))) | |
2358 | (calendar-window-list))))) | |
2359 | ||
2360 | (defun calendar-hide-window (window) | |
2361 | "Hide WINDOW if it is calendar-related." | |
2362 | (let ((buffer (if (window-live-p window) (window-buffer window)))) | |
2363 | (if (memq buffer (calendar-buffer-list)) | |
2364 | (cond | |
13f0f988 | 2365 | ((and (display-multi-frame-p) |
cba0c253 ER |
2366 | (eq 'icon (cdr (assoc 'visibility |
2367 | (frame-parameters | |
2368 | (window-frame window)))))) | |
2369 | nil) | |
13f0f988 | 2370 | ((and (display-multi-frame-p) (window-dedicated-p window)) |
7e1e5cf1 SS |
2371 | (if calendar-remove-frame-by-deleting |
2372 | (delete-frame (window-frame window)) | |
2373 | (iconify-frame (window-frame window)))) | |
cba0c253 ER |
2374 | ((not (and (select-window window) (one-window-p window))) |
2375 | (delete-window window)) | |
2376 | (t (set-buffer buffer) | |
2377 | (bury-buffer)))))) | |
ecaa0527 | 2378 | |
ecaa0527 | 2379 | (defun calendar-current-date () |
3cbb4860 | 2380 | "Return the current date in a list (month day year)." |
d8396371 RS |
2381 | (let ((now (decode-time))) |
2382 | (list (nth 4 now) (nth 3 now) (nth 5 now)))) | |
ecaa0527 | 2383 | |
ffd82264 | 2384 | (defun calendar-cursor-to-date (&optional error) |
3cbb4860 | 2385 | "Return a list (month day year) of current cursor position. |
ffd82264 RS |
2386 | If cursor is not on a specific date, signals an error if optional parameter |
2387 | ERROR is t, otherwise just returns nil." | |
c93b9aae ER |
2388 | (let* ((segment (/ (current-column) 25)) |
2389 | (month (% (+ displayed-month segment -1) 12)) | |
2390 | (month (if (= 0 month) 12 month)) | |
2391 | (year | |
2392 | (cond | |
2393 | ((and (= 12 month) (= segment 0)) (1- displayed-year)) | |
2394 | ((and (= 1 month) (= segment 2)) (1+ displayed-year)) | |
2395 | (t displayed-year)))) | |
7086b78e | 2396 | (if (and (looking-at "[ 0-9]?[0-9][^0-9]") |
c93b9aae ER |
2397 | (< 2 (count-lines (point-min) (point)))) |
2398 | (save-excursion | |
7086b78e ER |
2399 | (if (not (looking-at " ")) |
2400 | (re-search-backward "[^0-9]")) | |
c93b9aae ER |
2401 | (list month |
2402 | (string-to-int (buffer-substring (1+ (point)) (+ 4 (point)))) | |
2403 | year)) | |
21c8986e ER |
2404 | (if (looking-at "\\*") |
2405 | (save-excursion | |
2406 | (re-search-backward "[^*]") | |
2407 | (if (looking-at ".\\*\\*") | |
3a7f8079 | 2408 | (list month calendar-starred-day year) |
21c8986e ER |
2409 | (if error (error "Not on a date!")))) |
2410 | (if error (error "Not on a date!")))))) | |
ecaa0527 | 2411 | |
354d0644 JB |
2412 | ;; The following version of calendar-gregorian-from-absolute is preferred for |
2413 | ;; reasons of clarity, BUT it's much slower than the version that follows it. | |
2414 | ||
2415 | ;;(defun calendar-gregorian-from-absolute (date) | |
2416 | ;; "Compute the list (month day year) corresponding to the absolute DATE. | |
2417 | ;;The absolute date is the number of days elapsed since the (imaginary) | |
2418 | ;;Gregorian date Sunday, December 31, 1 BC." | |
2419 | ;; (let* ((approx (/ date 366));; Approximation from below. | |
2420 | ;; (year ;; Search forward from the approximation. | |
2421 | ;; (+ approx | |
2422 | ;; (calendar-sum y approx | |
2423 | ;; (>= date (calendar-absolute-from-gregorian (list 1 1 (1+ y)))) | |
2424 | ;; 1))) | |
2425 | ;; (month ;; Search forward from January. | |
2426 | ;; (1+ (calendar-sum m 1 | |
2427 | ;; (> date | |
2428 | ;; (calendar-absolute-from-gregorian | |
2429 | ;; (list m (calendar-last-day-of-month m year) year))) | |
2430 | ;; 1))) | |
2431 | ;; (day ;; Calculate the day by subtraction. | |
2432 | ;; (- date | |
2433 | ;; (1- (calendar-absolute-from-gregorian (list month 1 year)))))) | |
2434 | ;; (list month day year))) | |
2435 | ||
ecaa0527 RS |
2436 | (defun calendar-gregorian-from-absolute (date) |
2437 | "Compute the list (month day year) corresponding to the absolute DATE. | |
2438 | The absolute date is the number of days elapsed since the (imaginary) | |
6b61353c KH |
2439 | Gregorian date Sunday, December 31, 1 BC. This function does not |
2440 | handle dates in years BC." | |
354d0644 JB |
2441 | ;; See the footnote on page 384 of ``Calendrical Calculations, Part II: |
2442 | ;; Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. | |
2443 | ;; Clamen, Software--Practice and Experience, Volume 23, Number 4 | |
2444 | ;; (April, 1993), pages 383-404 for an explanation. | |
2445 | (let* ((d0 (1- date)) | |
2446 | (n400 (/ d0 146097)) | |
2447 | (d1 (% d0 146097)) | |
2448 | (n100 (/ d1 36524)) | |
2449 | (d2 (% d1 36524)) | |
2450 | (n4 (/ d2 1461)) | |
2451 | (d3 (% d2 1461)) | |
2452 | (n1 (/ d3 365)) | |
2453 | (day (1+ (% d3 365))) | |
2454 | (year (+ (* 400 n400) (* 100 n100) (* n4 4) n1))) | |
2455 | (if (or (= n100 4) (= n1 4)) | |
2456 | (list 12 31 year) | |
2457 | (let ((year (1+ year)) | |
2458 | (month 1)) | |
2459 | (while (let ((mdays (calendar-last-day-of-month month year))) | |
2460 | (and (< mdays day) | |
2461 | (setq day (- day mdays)))) | |
2462 | (setq month (1+ month))) | |
2463 | (list month day year))))) | |
ecaa0527 | 2464 | |
ecaa0527 RS |
2465 | (defun calendar-other-month (month year) |
2466 | "Display a three-month calendar centered around MONTH and YEAR." | |
ecd42d42 | 2467 | (interactive (calendar-read-date 'noday)) |
ecaa0527 RS |
2468 | (if (and (= month displayed-month) |
2469 | (= year displayed-year)) | |
2470 | nil | |
2471 | (let ((old-date (calendar-cursor-to-date)) | |
2472 | (today (calendar-current-date))) | |
7e1dae73 | 2473 | (generate-calendar-window month year) |
ecaa0527 RS |
2474 | (calendar-cursor-to-visible-date |
2475 | (cond | |
2476 | ((calendar-date-is-visible-p old-date) old-date) | |
2477 | ((calendar-date-is-visible-p today) today) | |
2478 | (t (list month 1 year))))))) | |
2479 | ||
2480 | (defun calendar-set-mark (arg) | |
2481 | "Mark the date under the cursor, or jump to marked date. | |
2482 | With no prefix argument, push current date onto marked date ring. | |
2483 | With argument, jump to mark, pop it, and put point at end of ring." | |
2484 | (interactive "P") | |
ffd82264 | 2485 | (let ((date (calendar-cursor-to-date t))) |
ecaa0527 RS |
2486 | (if (null arg) |
2487 | (progn | |
2488 | (setq calendar-mark-ring (cons date calendar-mark-ring)) | |
2489 | ;; Since the top of the mark ring is the marked date in the | |
2490 | ;; calendar, the mark ring in the calendar is one longer than | |
2491 | ;; in other buffers to get the same effect. | |
2492 | (if (> (length calendar-mark-ring) (1+ mark-ring-max)) | |
2493 | (setcdr (nthcdr mark-ring-max calendar-mark-ring) nil)) | |
2494 | (message "Mark set")) | |
2495 | (if (null calendar-mark-ring) | |
2496 | (error "No mark set in this buffer") | |
2497 | (calendar-goto-date (car calendar-mark-ring)) | |
2498 | (setq calendar-mark-ring | |
2499 | (cdr (nconc calendar-mark-ring (list date)))))))) | |
2500 | ||
2501 | (defun calendar-exchange-point-and-mark () | |
2502 | "Exchange the current cursor position with the marked date." | |
2503 | (interactive) | |
2504 | (let ((mark (car calendar-mark-ring)) | |
ffd82264 | 2505 | (date (calendar-cursor-to-date t))) |
ecaa0527 RS |
2506 | (if (null mark) |
2507 | (error "No mark set in this buffer") | |
2508 | (setq calendar-mark-ring (cons date (cdr calendar-mark-ring))) | |
2509 | (calendar-goto-date mark)))) | |
2510 | ||
2511 | (defun calendar-count-days-region () | |
2512 | "Count the number of days (inclusive) between point and the mark." | |
2513 | (interactive) | |
2514 | (let* ((days (- (calendar-absolute-from-gregorian | |
ffd82264 | 2515 | (calendar-cursor-to-date t)) |
ecaa0527 RS |
2516 | (calendar-absolute-from-gregorian |
2517 | (or (car calendar-mark-ring) | |
2518 | (error "No mark set in this buffer"))))) | |
2519 | (days (1+ (if (> days 0) days (- days))))) | |
2520 | (message "Region has %d day%s (inclusive)" | |
2521 | days (if (> days 1) "s" "")))) | |
2522 | ||
2523 | (defun calendar-not-implemented () | |
2524 | "Not implemented." | |
2525 | (interactive) | |
2526 | (error "%s not available in the calendar" | |
2527 | (global-key-binding (this-command-keys)))) | |
2528 | ||
2529 | (defun calendar-read (prompt acceptable &optional initial-contents) | |
2530 | "Return an object read from the minibuffer. | |
2531 | Prompt with the string PROMPT and use the function ACCEPTABLE to decide if | |
2532 | entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS | |
2533 | is a string to insert in the minibuffer before reading." | |
2534 | (let ((value (read-minibuffer prompt initial-contents))) | |
2535 | (while (not (funcall acceptable value)) | |
2536 | (setq value (read-minibuffer prompt initial-contents))) | |
2537 | value)) | |
2538 | ||
cba0c253 | 2539 | (defun calendar-read-date (&optional noday) |
3cbb4860 | 2540 | "Prompt for Gregorian date. Return a list (month day year). |
cba0c253 | 2541 | If optional NODAY is t, does not ask for day, but just returns |
ae58b7ad | 2542 | \(month nil year); if NODAY is any other non-nil value the value returned is |
3cbb4860 | 2543 | \(month year)" |
7e1dae73 JB |
2544 | (let* ((year (calendar-read |
2545 | "Year (>0): " | |
d4ff5db9 | 2546 | (lambda (x) (> x 0)) |
7e1dae73 JB |
2547 | (int-to-string (extract-calendar-year |
2548 | (calendar-current-date))))) | |
2549 | (month-array calendar-month-name-array) | |
2550 | (completion-ignore-case t) | |
6b61353c | 2551 | (month (cdr (assoc-string |
7e1dae73 JB |
2552 | (completing-read |
2553 | "Month name: " | |
2554 | (mapcar 'list (append month-array nil)) | |
bf51dce3 | 2555 | nil t) |
6b61353c | 2556 | (calendar-make-alist month-array 1) t))) |
cba0c253 | 2557 | (last (calendar-last-day-of-month month year))) |
ecd42d42 ER |
2558 | (if noday |
2559 | (if (eq noday t) | |
2560 | (list month nil year) | |
2561 | (list month year)) | |
2562 | (list month | |
2563 | (calendar-read (format "Day (1-%d): " last) | |
d4ff5db9 | 2564 | (lambda (x) (and (< 0 x) (<= x last)))) |
ecd42d42 | 2565 | year)))) |
7e1dae73 | 2566 | |
ecaa0527 | 2567 | (defun calendar-interval (mon1 yr1 mon2 yr2) |
6b61353c KH |
2568 | "The number of months difference between MON1, YR1 and MON2, YR2. |
2569 | The result is positive if the second date is later than the first. | |
2570 | Negative years are interpreted as years BC; -1 being 1 BC, and so on." | |
2571 | (if (< yr1 0) (setq yr1 (1+ yr1))) ; -1 BC -> 0 AD, etc | |
2572 | (if (< yr2 0) (setq yr2 (1+ yr2))) | |
ecaa0527 RS |
2573 | (+ (* 12 (- yr2 yr1)) |
2574 | (- mon2 mon1))) | |
2575 | ||
2c8811d4 GM |
2576 | (defvar calendar-abbrev-length 3 |
2577 | "*Length of abbreviations to be used for day and month names. | |
2578 | See also `calendar-day-abbrev-array' and `calendar-month-abbrev-array'.") | |
2579 | ||
d8a200a7 | 2580 | (defvar calendar-day-name-array |
b642d11e | 2581 | ["Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"] |
2c8811d4 GM |
2582 | "*Array of capitalized strings giving, in order, the day names. |
2583 | The first two characters of each string will be used to head the | |
2584 | day columns in the calendar. See also the variable | |
2585 | `calendar-day-abbrev-array'.") | |
2586 | ||
2587 | (defvar calendar-day-abbrev-array | |
2588 | [nil nil nil nil nil nil nil] | |
2589 | "*Array of capitalized strings giving the abbreviated day names. | |
2590 | The order should be the same as that of the full names specified | |
2591 | in `calendar-day-name-array'. These abbreviations may be used | |
2592 | instead of the full names in the diary file. Do not include a | |
2593 | trailing `.' in the strings specified in this variable, though | |
2594 | you may use such in the diary file. If any element of this array | |
2595 | is nil, then the abbreviation will be constructed as the first | |
2596 | `calendar-abbrev-length' characters of the corresponding full name.") | |
ecaa0527 | 2597 | |
d8a200a7 | 2598 | (defvar calendar-month-name-array |
ecaa0527 | 2599 | ["January" "February" "March" "April" "May" "June" |
b642d11e | 2600 | "July" "August" "September" "October" "November" "December"] |
2c8811d4 GM |
2601 | "*Array of capitalized strings giving, in order, the month names. |
2602 | See also the variable `calendar-month-abbrev-array'.") | |
2603 | ||
2604 | (defvar calendar-month-abbrev-array | |
2605 | [nil nil nil nil nil nil nil nil nil nil nil nil] | |
2606 | "*Array of capitalized strings giving the abbreviated month names. | |
2607 | The order should be the same as that of the full names specified | |
2608 | in `calendar-month-name-array'. These abbreviations are used in | |
2609 | the calendar menu entries, and can also be used in the diary | |
2610 | file. Do not include a trailing `.' in the strings specified in | |
2611 | this variable, though you may use such in the diary file. If any | |
2612 | element of this array is nil, then the abbreviation will be | |
2613 | constructed as the first `calendar-abbrev-length' characters of the | |
2614 | corresponding full name.") | |
2615 | ||
2616 | (defun calendar-abbrev-construct (abbrev full &optional period) | |
2617 | "Internal calendar function to return a complete abbreviation array. | |
2618 | ABBREV is an array of abbreviations, FULL the corresponding array | |
2619 | of full names. The return value is the ABBREV array, with any nil | |
2620 | elements replaced by the first three characters taken from the | |
2621 | corresponding element of FULL. If optional argument PERIOD is non-nil, | |
2622 | each element returned has a final `.' character." | |
6b61353c | 2623 | (let (elem array name) |
2c8811d4 | 2624 | (dotimes (i (length full)) |
6b61353c KH |
2625 | (setq name (aref full i) |
2626 | elem (or (aref abbrev i) | |
2627 | (substring name 0 | |
2628 | (min calendar-abbrev-length (length name)))) | |
2c8811d4 GM |
2629 | elem (format "%s%s" elem (if period "." "")) |
2630 | array (append array (list elem)))) | |
2631 | (vconcat array))) | |
ecaa0527 | 2632 | |
5d22135b | 2633 | (defvar calendar-font-lock-keywords |
f5f57411 SM |
2634 | `((,(concat (regexp-opt (mapcar 'identity calendar-month-name-array) t) |
2635 | " -?[0-9]+") | |
2636 | . font-lock-function-name-face) ; month and year | |
2637 | (,(regexp-opt | |
2638 | (list (substring (aref calendar-day-name-array 6) 0 2) | |
2639 | (substring (aref calendar-day-name-array 0) 0 2))) | |
2640 | ;; Saturdays and Sundays are hilited differently. | |
2641 | . font-lock-comment-face) | |
2c8811d4 | 2642 | ;; First two chars of each day are used in the calendar. |
f5f57411 SM |
2643 | (,(regexp-opt (mapcar (lambda (x) (substring x 0 2)) calendar-day-name-array)) |
2644 | . font-lock-reference-face)) | |
5d22135b MR |
2645 | "Default keywords to highlight in Calendar mode.") |
2646 | ||
2c8811d4 | 2647 | (defun calendar-day-name (date &optional abbrev absolute) |
e0dfc625 | 2648 | "Return a string with the name of the day of the week of DATE. |
2c8811d4 GM |
2649 | DATE should be a list in the format (MONTH DAY YEAR), unless the |
2650 | optional argument ABSOLUTE is non-nil, in which case DATE should | |
2651 | be an integer in the range 0 to 6 corresponding to the day of the | |
2652 | week. Day names are taken from the variable `calendar-day-name-array', | |
2653 | unless the optional argument ABBREV is non-nil, in which case | |
2654 | the variable `calendar-day-abbrev-array' is used." | |
2655 | (aref (if abbrev | |
2656 | (calendar-abbrev-construct calendar-day-abbrev-array | |
2657 | calendar-day-name-array) | |
2658 | calendar-day-name-array) | |
2659 | (if absolute date (calendar-day-of-week date)))) | |
2660 | ||
2661 | (defun calendar-make-alist (sequence &optional start-index filter abbrevs) | |
ecaa0527 | 2662 | "Make an assoc list corresponding to SEQUENCE. |
2c8811d4 GM |
2663 | Each element of sequence will be associated with an integer, starting |
2664 | from 1, or from START-INDEX if that is non-nil. If a sequence ABBREVS | |
2665 | is supplied, the function `calendar-abbrev-construct' is used to | |
2666 | construct abbreviations corresponding to the elements in SEQUENCE. | |
2667 | Each abbreviation is entered into the alist with the same | |
2668 | association index as the full name it represents. | |
2669 | If FILTER is provided, apply it to each key in the alist." | |
2670 | (let ((index 0) | |
2671 | (offset (or start-index 1)) | |
2672 | (aseq (if abbrevs (calendar-abbrev-construct abbrevs sequence))) | |
2673 | (aseqp (if abbrevs (calendar-abbrev-construct abbrevs sequence | |
2674 | 'period))) | |
2675 | alist elem) | |
6b61353c | 2676 | (dotimes (i (length sequence) (reverse alist)) |
2c8811d4 GM |
2677 | (setq index (+ i offset) |
2678 | elem (elt sequence i) | |
2679 | alist | |
2680 | (cons (cons (if filter (funcall filter elem) elem) index) alist)) | |
2681 | (if aseq | |
2682 | (setq elem (elt aseq i) | |
2683 | alist (cons (cons (if filter (funcall filter elem) elem) | |
2684 | index) alist))) | |
2685 | (if aseqp | |
2686 | (setq elem (elt aseqp i) | |
2687 | alist (cons (cons (if filter (funcall filter elem) elem) | |
2688 | index) alist)))))) | |
2689 | ||
2690 | (defun calendar-month-name (month &optional abbrev) | |
2691 | "Return a string with the name of month number MONTH. | |
2692 | Months are numbered from one. Month names are taken from the | |
2693 | variable `calendar-month-name-array', unless the optional | |
2694 | argument ABBREV is non-nil, in which case | |
2695 | `calendar-month-abbrev-array' is used." | |
2696 | (aref (if abbrev | |
2697 | (calendar-abbrev-construct calendar-month-abbrev-array | |
2698 | calendar-month-name-array) | |
2699 | calendar-month-name-array) | |
2700 | (1- month))) | |
ecaa0527 RS |
2701 | |
2702 | (defun calendar-day-of-week (date) | |
6b61353c KH |
2703 | "Return the day-of-the-week index of DATE, 0 for Sunday, 1 for Monday, etc. |
2704 | DATE is a list of the form (month day year). A negative year is | |
2705 | interpreted as BC; -1 being 1 BC, and so on." | |
2706 | (mod (calendar-absolute-from-gregorian date) 7)) | |
ecaa0527 | 2707 | |
ecaa0527 | 2708 | (defun calendar-unmark () |
6a2aa94c | 2709 | "Delete all diary/holiday marks/highlighting from the calendar." |
ecaa0527 | 2710 | (interactive) |
ecaa0527 | 2711 | (setq mark-holidays-in-calendar nil) |
6a2aa94c RS |
2712 | (setq mark-diary-entries-in-calendar nil) |
2713 | (redraw-calendar)) | |
ecaa0527 RS |
2714 | |
2715 | (defun calendar-date-is-visible-p (date) | |
3cbb4860 | 2716 | "Return t if DATE is legal and is visible in the calendar window." |
ecaa0527 RS |
2717 | (let ((gap (calendar-interval |
2718 | displayed-month displayed-year | |
2719 | (extract-calendar-month date) (extract-calendar-year date)))) | |
2720 | (and (calendar-date-is-legal-p date) (> 2 gap) (< -2 gap)))) | |
2721 | ||
2722 | (defun calendar-date-is-legal-p (date) | |
3cbb4860 | 2723 | "Return t if DATE is a legal date." |
ecaa0527 RS |
2724 | (let ((month (extract-calendar-month date)) |
2725 | (day (extract-calendar-day date)) | |
2726 | (year (extract-calendar-year date))) | |
2727 | (and (<= 1 month) (<= month 12) | |
2728 | (<= 1 day) (<= day (calendar-last-day-of-month month year)) | |
6b61353c KH |
2729 | ;; BC dates left as non-legal, to suppress errors from |
2730 | ;; complex holiday algorithms not suitable for years BC. | |
2731 | ;; Note there are side effects on calendar navigation. | |
ecaa0527 RS |
2732 | (<= 1 year)))) |
2733 | ||
2734 | (defun calendar-date-equal (date1 date2) | |
3cbb4860 | 2735 | "Return t if the DATE1 and DATE2 are the same." |
ecaa0527 RS |
2736 | (and |
2737 | (= (extract-calendar-month date1) (extract-calendar-month date2)) | |
2738 | (= (extract-calendar-day date1) (extract-calendar-day date2)) | |
2739 | (= (extract-calendar-year date1) (extract-calendar-year date2)))) | |
2740 | ||
2741 | (defun mark-visible-calendar-date (date &optional mark) | |
6a2aa94c | 2742 | "Mark DATE in the calendar window with MARK. |
d13c1378 | 2743 | MARK is a single-character string, a list of face attributes/values, or a face. |
5d22135b | 2744 | MARK defaults to `diary-entry-marker'." |
ecaa0527 RS |
2745 | (if (calendar-date-is-legal-p date) |
2746 | (save-excursion | |
2747 | (set-buffer calendar-buffer) | |
2748 | (calendar-cursor-to-visible-date date) | |
d13c1378 JB |
2749 | (let ((mark (or (and (stringp mark) (= (length mark) 1) mark) ; single-char |
2750 | (and (listp mark) (> (length mark) 0) mark) ; attr list | |
2751 | (and (facep mark) mark) ; face-name | |
2752 | diary-entry-marker))) | |
2753 | (if (facep mark) | |
2754 | (progn ; face or an attr-list that contained a face | |
2755 | (overlay-put | |
2756 | (make-overlay (1- (point)) (1+ (point))) 'face mark)) | |
2757 | (if (and (stringp mark) | |
2758 | (= (length mark) 1)) ; single-char | |
2759 | (let ((buffer-read-only nil)) | |
2760 | (forward-char 1) | |
2761 | (delete-char 1) | |
2762 | (insert mark) | |
2763 | (forward-char -2)) | |
6b61353c KH |
2764 | (let ; attr list |
2765 | ((temp-face | |
2766 | (make-symbol (apply 'concat "temp-face-" | |
2767 | (mapcar '(lambda (sym) | |
2768 | (cond ((symbolp sym) (symbol-name sym)) | |
2769 | ((numberp sym) (int-to-string sym)) | |
2770 | (t sym))) mark)))) | |
2771 | (faceinfo mark)) | |
d13c1378 JB |
2772 | (make-face temp-face) |
2773 | ;; Remove :face info from the mark, copy the face info into temp-face | |
d13c1378 JB |
2774 | (while (setq faceinfo (memq :face faceinfo)) |
2775 | (copy-face (read (nth 1 faceinfo)) temp-face) | |
2776 | (setcar faceinfo nil) | |
2777 | (setcar (cdr faceinfo) nil)) | |
2778 | (setq mark (delq nil mark)) | |
2779 | ;; Apply the font aspects | |
2780 | (apply 'set-face-attribute temp-face nil mark) | |
2781 | (overlay-put | |
2782 | (make-overlay (1- (point)) (1+ (point))) 'face temp-face)))))))) | |
ecaa0527 RS |
2783 | |
2784 | (defun calendar-star-date () | |
2785 | "Replace the date under the cursor in the calendar window with asterisks. | |
3cbb4860 | 2786 | This function can be used with the `today-visible-calendar-hook' run after the |
ecaa0527 | 2787 | calendar window has been prepared." |
3cbb4860 SM |
2788 | (let ((inhibit-read-only t)) |
2789 | (make-local-variable 'calendar-starred-day) | |
ecaa0527 | 2790 | (forward-char 1) |
c00f638d | 2791 | (setq calendar-starred-day |
7e1dae73 JB |
2792 | (string-to-int |
2793 | (buffer-substring (point) (- (point) 2)))) | |
ecaa0527 RS |
2794 | (delete-char -2) |
2795 | (insert "**") | |
2796 | (backward-char 1) | |
2797 | (set-buffer-modified-p nil))) | |
2798 | ||
2799 | (defun calendar-mark-today () | |
6a2aa94c | 2800 | "Mark the date under the cursor in the calendar window. |
5d22135b | 2801 | The date is marked with `calendar-today-marker'. This function can be used with |
3cbb4860 | 2802 | the `today-visible-calendar-hook' run after the calendar window has been |
6a2aa94c RS |
2803 | prepared." |
2804 | (mark-visible-calendar-date | |
2805 | (calendar-cursor-to-date) | |
2806 | calendar-today-marker)) | |
ecaa0527 RS |
2807 | |
2808 | (defun calendar-date-compare (date1 date2) | |
3cbb4860 | 2809 | "Return t if DATE1 is before DATE2, nil otherwise. |
ecaa0527 RS |
2810 | The actual dates are in the car of DATE1 and DATE2." |
2811 | (< (calendar-absolute-from-gregorian (car date1)) | |
2812 | (calendar-absolute-from-gregorian (car date2)))) | |
2813 | ||
2814 | (defun calendar-date-string (date &optional abbreviate nodayname) | |
2815 | "A string form of DATE, driven by the variable `calendar-date-display-form'. | |
2c8811d4 GM |
2816 | An optional parameter ABBREVIATE, when non-nil, causes the month |
2817 | and day names to be abbreviated as specified by | |
2818 | `calendar-month-abbrev-array' and `calendar-day-abbrev-array', | |
2819 | respectively. An optional parameter NODAYNAME, when t, omits the | |
2820 | name of the day of the week." | |
ecaa0527 | 2821 | (let* ((dayname |
2c8811d4 GM |
2822 | (unless nodayname |
2823 | (calendar-day-name date abbreviate))) | |
ecaa0527 | 2824 | (month (extract-calendar-month date)) |
2c8811d4 | 2825 | (monthname (calendar-month-name month abbreviate)) |
ecaa0527 RS |
2826 | (day (int-to-string (extract-calendar-day date))) |
2827 | (month (int-to-string month)) | |
2828 | (year (int-to-string (extract-calendar-year date)))) | |
2829 | (mapconcat 'eval calendar-date-display-form ""))) | |
2830 | ||
2831 | (defun calendar-dayname-on-or-before (dayname date) | |
3cbb4860 | 2832 | "Return the absolute date of the DAYNAME on or before absolute DATE. |
ecaa0527 RS |
2833 | DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on. |
2834 | ||
2835 | Note: Applying this function to d+6 gives us the DAYNAME on or after an | |
2836 | absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to | |
2837 | absolute date d, applying it to d-1 gives the DAYNAME previous to absolute | |
2838 | date d, and applying it to d+7 gives the DAYNAME following absolute date d." | |
2839 | (- date (% (- date dayname) 7))) | |
2840 | ||
04d5d338 PE |
2841 | (defun calendar-nth-named-absday (n dayname month year &optional day) |
2842 | "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY. | |
2843 | A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0, | |
2844 | return the Nth DAYNAME before MONTH DAY, YEAR (inclusive). | |
2845 | If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive). | |
2846 | ||
2847 | If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise." | |
2848 | (if (> n 0) | |
2849 | (+ (* 7 (1- n)) | |
2850 | (calendar-dayname-on-or-before | |
2851 | dayname | |
2852 | (+ 6 (calendar-absolute-from-gregorian | |
2853 | (list month (or day 1) year))))) | |
2854 | (+ (* 7 (1+ n)) | |
2855 | (calendar-dayname-on-or-before | |
2856 | dayname | |
2857 | (calendar-absolute-from-gregorian | |
2858 | (list month | |
2859 | (or day (calendar-last-day-of-month month year)) | |
2860 | year)))))) | |
2861 | ||
354d0644 JB |
2862 | (defun calendar-nth-named-day (n dayname month year &optional day) |
2863 | "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY. | |
2864 | A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0, | |
2865 | return the Nth DAYNAME before MONTH DAY, YEAR (inclusive). | |
2866 | If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive). | |
2867 | ||
2868 | If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise." | |
ecaa0527 | 2869 | (calendar-gregorian-from-absolute |
04d5d338 | 2870 | (calendar-nth-named-absday n dayname month year day))) |
ecaa0527 | 2871 | |
6a2aa94c RS |
2872 | (defun calendar-day-of-year-string (&optional date) |
2873 | "String of day number of year of Gregorian DATE. | |
2874 | Defaults to today's date if DATE is not given." | |
2875 | (let* ((d (or date (calendar-current-date))) | |
2876 | (year (extract-calendar-year d)) | |
2877 | (day (calendar-day-number d)) | |
2878 | (days-remaining (- (calendar-day-number (list 12 31 year)) day))) | |
2879 | (format "Day %d of %d; %d day%s remaining in the year" | |
2880 | day year days-remaining (if (= days-remaining 1) "" "s")))) | |
2881 | ||
726669d8 ER |
2882 | (defun calendar-print-other-dates () |
2883 | "Show dates on other calendars for date under the cursor." | |
2884 | (interactive) | |
2885 | (let* ((date (calendar-cursor-to-date t))) | |
2886 | (save-excursion | |
2887 | (set-buffer (get-buffer-create other-calendars-buffer)) | |
2888 | (setq buffer-read-only nil) | |
2889 | (calendar-set-mode-line | |
2890 | (concat (calendar-date-string date) " (Gregorian)")) | |
2891 | (erase-buffer) | |
2892 | (insert | |
2893 | (mapconcat 'identity | |
2894 | (list (calendar-day-of-year-string date) | |
2895 | (format "ISO date: %s" (calendar-iso-date-string date)) | |
2896 | (format "Julian date: %s" | |
2897 | (calendar-julian-date-string date)) | |
2898 | (format | |
2899 | "Astronomical (Julian) day number (at noon UTC): %s.0" | |
2900 | (calendar-astro-date-string date)) | |
2901 | (format "Fixed (RD) date: %s" | |
2902 | (calendar-absolute-from-gregorian date)) | |
2903 | (format "Hebrew date (before sunset): %s" | |
2904 | (calendar-hebrew-date-string date)) | |
2905 | (format "Persian date: %s" | |
2906 | (calendar-persian-date-string date)) | |
2907 | (let ((i (calendar-islamic-date-string date))) | |
2908 | (if (not (string-equal i "")) | |
2909 | (format "Islamic date (before sunset): %s" i))) | |
2910 | (format "Chinese date: %s" | |
2911 | (calendar-chinese-date-string date)) | |
2912 | (let ((c (calendar-coptic-date-string date))) | |
2913 | (if (not (string-equal c "")) | |
2914 | (format "Coptic date: %s" c))) | |
2915 | (let ((e (calendar-ethiopic-date-string date))) | |
2916 | (if (not (string-equal e "")) | |
2917 | (format "Ethiopic date: %s" e))) | |
2918 | (let ((f (calendar-french-date-string date))) | |
2919 | (if (not (string-equal f "")) | |
2920 | (format "French Revolutionary date: %s" f))) | |
2921 | (format "Mayan date: %s" | |
2922 | (calendar-mayan-date-string date))) | |
2923 | "\n")) | |
2924 | (goto-char (point-min)) | |
2925 | (set-buffer-modified-p nil) | |
2926 | (setq buffer-read-only t) | |
2927 | (display-buffer other-calendars-buffer)))) | |
2928 | ||
7e1dae73 | 2929 | (defun calendar-print-day-of-year () |
6a2aa94c | 2930 | "Show day number in year/days remaining in year for date under the cursor." |
ecaa0527 | 2931 | (interactive) |
ffd82264 | 2932 | (message (calendar-day-of-year-string (calendar-cursor-to-date t)))) |
ecaa0527 | 2933 | |
7e1dae73 JB |
2934 | (defun calendar-set-mode-line (str) |
2935 | "Set mode line to STR, centered, surrounded by dashes." | |
2936 | (setq mode-line-format | |
6b61353c KH |
2937 | (calendar-string-spread |
2938 | (list str) ?- | |
2939 | ;; As per doc of window-width, total visible mode-line length. | |
2940 | (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges)))))) | |
7e1dae73 | 2941 | |
7086b78e ER |
2942 | (defun calendar-mod (m n) |
2943 | "Non-negative remainder of M/N with N instead of 0." | |
2944 | (1+ (mod (1- m) n))) | |
7e1dae73 JB |
2945 | |
2946 | (run-hooks 'calendar-load-hook) | |
ecaa0527 RS |
2947 | |
2948 | (provide 'calendar) | |
2949 | ||
b578f267 EN |
2950 | ;;; Local variables: |
2951 | ;;; byte-compile-dynamic: t | |
2952 | ;;; End: | |
2953 | ||
6b61353c | 2954 | ;;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8 |
94b304d7 | 2955 | ;;; calendar.el ends here |