1 ;;; holidays.el --- holiday functions for the calendar package
3 ;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1997, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
8 ;; Keywords: holidays, calendar
10 ;; This file is part of GNU Emacs.
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 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32 (require 'hol-loaddefs
)
34 (defgroup holidays nil
35 "Holidays support in calendar."
40 ;; The various holiday variables are autoloaded because people
41 ;; are used to using them to set calendar-holidays without having to
42 ;; explicitly load this file.
45 (defcustom holiday-general-holidays
46 '((holiday-fixed 1 1 "New Year's Day")
47 (holiday-float 1 1 3 "Martin Luther King Day")
48 (holiday-fixed 2 2 "Groundhog Day")
49 (holiday-fixed 2 14 "Valentine's Day")
50 (holiday-float 2 1 3 "President's Day")
51 (holiday-fixed 3 17 "St. Patrick's Day")
52 (holiday-fixed 4 1 "April Fools' Day")
53 (holiday-float 5 0 2 "Mother's Day")
54 (holiday-float 5 1 -
1 "Memorial Day")
55 (holiday-fixed 6 14 "Flag Day")
56 (holiday-float 6 0 3 "Father's Day")
57 (holiday-fixed 7 4 "Independence Day")
58 (holiday-float 9 1 1 "Labor Day")
59 (holiday-float 10 1 2 "Columbus Day")
60 (holiday-fixed 10 31 "Halloween")
61 (holiday-fixed 11 11 "Veteran's Day")
62 (holiday-float 11 4 4 "Thanksgiving"))
63 "General holidays. Default value is for the United States.
64 See the documentation for `calendar-holidays' for details."
68 (put 'holiday-general-holidays
'risky-local-variable t
)
70 (define-obsolete-variable-alias 'general-holidays
71 'holiday-general-holidays
"23.1")
74 (defcustom holiday-oriental-holidays
75 '((holiday-chinese-new-year)
76 (if calendar-chinese-all-holidays-flag
78 (holiday-chinese 1 15 "Lantern Festival")
79 (holiday-chinese-qingming)
80 (holiday-chinese 5 5 "Dragon Boat Festival")
81 (holiday-chinese 7 7 "Double Seventh Festival")
82 (holiday-chinese 8 15 "Mid-Autumn Festival")
83 (holiday-chinese 9 9 "Double Ninth Festival")
84 (holiday-chinese-winter-solstice)
87 See the documentation for `calendar-holidays' for details."
88 :version
"23.1" ; added more holidays
92 (put 'holiday-oriental-holidays
'risky-local-variable t
)
94 (define-obsolete-variable-alias 'oriental-holidays
95 'holiday-oriental-holidays
"23.1")
98 (defcustom holiday-local-holidays nil
100 See the documentation for `calendar-holidays' for details."
104 (put 'holiday-local-holidays
'risky-local-variable t
)
106 (define-obsolete-variable-alias 'local-holidays
'holiday-local-holidays
"23.1")
109 (defcustom holiday-other-holidays nil
110 "User defined holidays.
111 See the documentation for `calendar-holidays' for details."
115 (put 'holiday-other-holidays
'risky-local-variable t
)
117 (define-obsolete-variable-alias 'other-holidays
'holiday-other-holidays
"23.1")
120 (defvar hebrew-holidays-1
121 '((holiday-hebrew-rosh-hashanah)
122 (if calendar-hebrew-all-holidays-flag
125 (let ((m displayed-month
)
128 (calendar-increment-month m y -
1)
129 (setq year
(calendar-extract-year
130 (calendar-julian-from-absolute
131 (calendar-absolute-from-gregorian (list m
1 y
)))))
132 (if (zerop (%
(1+ year
) 4))
134 21)) "\"Tal Umatar\" (evening)")))
135 "Component of the old default value of `holiday-hebrew-holidays'.")
137 (put 'hebrew-holidays-1
'risky-local-variable t
)
138 (make-obsolete-variable 'hebrew-holidays-1
'hebrew-holidays
"23.1")
141 (defvar hebrew-holidays-2
142 '((holiday-hebrew-hanukkah) ; respects calendar-hebrew-all-holidays-flag
143 (if calendar-hebrew-all-holidays-flag
146 (let ((h-year (calendar-extract-year
147 (calendar-hebrew-from-absolute
148 (calendar-absolute-from-gregorian
149 (list displayed-month
28 displayed-year
))))))
150 (if (= 6 (%
(calendar-hebrew-to-absolute (list 10 10 h-year
))
154 (if calendar-hebrew-all-holidays-flag
155 (holiday-hebrew 11 15 "Tu B'Shevat")))
156 "Component of the old default value of `holiday-hebrew-holidays'.")
158 (put 'hebrew-holidays-2
'risky-local-variable t
)
159 (make-obsolete-variable 'hebrew-holidays-2
'hebrew-holidays
"23.1")
162 (defvar hebrew-holidays-3
163 '((if calendar-hebrew-all-holidays-flag
166 (let* ((m displayed-month
)
169 (calendar-increment-month m y
1)
170 (calendar-extract-year
171 (calendar-hebrew-from-absolute
172 (calendar-absolute-from-gregorian
173 (list m
(calendar-last-day-of-month m y
) y
))))))
175 (calendar-hebrew-from-absolute
177 (%
(calendar-hebrew-to-absolute
180 (calendar-dayname-on-or-before
181 6 (calendar-hebrew-to-absolute
182 (list 11 17 h-year
)))
183 (calendar-dayname-on-or-before
184 6 (calendar-hebrew-to-absolute
185 (list 11 16 h-year
))))))
186 (day (calendar-extract-day s-s
)))
189 "Component of the old default value of `holiday-hebrew-holidays'.")
191 (put 'hebrew-holidays-3
'risky-local-variable t
)
192 (make-obsolete-variable 'hebrew-holidays-3
'hebrew-holidays
"23.1")
195 (defvar hebrew-holidays-4
196 '((holiday-hebrew-passover)
197 (and calendar-hebrew-all-holidays-flag
198 (let* ((m displayed-month
)
201 (calendar-increment-month m y -
1)
202 (calendar-extract-year
203 (calendar-julian-from-absolute
204 (calendar-absolute-from-gregorian (list m
1 y
)))))))
206 (holiday-julian 3 26 "Kiddush HaHamah"))
207 (if calendar-hebrew-all-holidays-flag
208 (holiday-hebrew-tisha-b-av)))
209 "Component of the old default value of `holiday-hebrew-holidays'.")
211 (put 'hebrew-holidays-4
'risky-local-variable t
)
212 (make-obsolete-variable 'hebrew-holidays-4
'hebrew-holidays
"23.1")
215 (defcustom holiday-hebrew-holidays
216 '((holiday-hebrew-passover)
217 (holiday-hebrew-rosh-hashanah)
218 (holiday-hebrew-hanukkah)
219 (if calendar-hebrew-all-holidays-flag
221 (holiday-hebrew-tisha-b-av)
222 (holiday-hebrew-misc))))
224 See the documentation for `calendar-holidays' for details."
226 :version
"23.1" ; removed dependency on hebrew-holidays-N
229 (put 'holiday-hebrew-holidays
'risky-local-variable t
)
231 (define-obsolete-variable-alias 'hebrew-holidays
232 'holiday-hebrew-holidays
"23.1")
235 (defcustom holiday-christian-holidays
236 '((holiday-easter-etc) ; respects calendar-christian-all-holidays-flag
237 (holiday-fixed 12 25 "Christmas")
238 (if calendar-christian-all-holidays-flag
240 (holiday-fixed 1 6 "Epiphany")
241 (holiday-julian 12 25 "Eastern Orthodox Christmas")
242 (holiday-greek-orthodox-easter)
243 (holiday-fixed 8 15 "Assumption")
244 (holiday-advent 0 "Advent"))))
246 See the documentation for `calendar-holidays' for details."
250 (put 'holiday-christian-holidays
'risky-local-variable t
)
252 (define-obsolete-variable-alias 'christian-holidays
253 'holiday-christian-holidays
"23.1")
256 (defcustom holiday-islamic-holidays
257 '((holiday-islamic-new-year)
258 (holiday-islamic 9 1 "Ramadan Begins")
259 (if calendar-islamic-all-holidays-flag
261 (holiday-islamic 1 10 "Ashura")
262 (holiday-islamic 3 12 "Mulad-al-Nabi")
263 (holiday-islamic 7 26 "Shab-e-Mi'raj")
264 (holiday-islamic 8 15 "Shab-e-Bara't")
265 (holiday-islamic 9 27 "Shab-e Qadr")
266 (holiday-islamic 10 1 "Id-al-Fitr")
267 (holiday-islamic 12 10 "Id-al-Adha"))))
269 See the documentation for `calendar-holidays' for details."
273 (put 'holiday-islamic-holidays
'risky-local-variable t
)
275 (define-obsolete-variable-alias 'islamic-holidays
276 'holiday-islamic-holidays
"23.1")
279 (defcustom holiday-bahai-holidays
280 '((holiday-bahai-new-year)
281 (holiday-bahai-ridvan) ; respects calendar-bahai-all-holidays-flag
282 (holiday-fixed 5 23 "Declaration of the Bab")
283 (holiday-fixed 5 29 "Ascension of Baha'u'llah")
284 (holiday-fixed 7 9 "Martyrdom of the Bab")
285 (holiday-fixed 10 20 "Birth of the Bab")
286 (holiday-fixed 11 12 "Birth of Baha'u'llah")
287 (if calendar-bahai-all-holidays-flag
289 (holiday-fixed 11 26 "Day of the Covenant")
290 (holiday-fixed 11 28 "Ascension of `Abdu'l-Baha"))))
292 See the documentation for `calendar-holidays' for details."
296 (put 'holiday-bahai-holidays
'risky-local-variable t
)
298 (define-obsolete-variable-alias 'bahai-holidays
'holiday-bahai-holidays
"23.1")
301 (defcustom holiday-solar-holidays
302 '((solar-equinoxes-solstices)
303 (holiday-sexp calendar-daylight-savings-starts
304 (format "Daylight Saving Time Begins %s"
306 (/ calendar-daylight-savings-starts-time
(float 60))
307 calendar-standard-time-zone-name
)))
308 (holiday-sexp calendar-daylight-savings-ends
309 (format "Daylight Saving Time Ends %s"
311 (/ calendar-daylight-savings-ends-time
(float 60))
312 calendar-daylight-time-zone-name
))))
313 "Sun-related holidays.
314 See the documentation for `calendar-holidays' for details."
318 (put 'holiday-solar-holidays
'risky-local-variable t
)
320 (define-obsolete-variable-alias 'solar-holidays
'holiday-solar-holidays
"23.1")
323 (defcustom calendar-holidays
324 (append holiday-general-holidays holiday-local-holidays
325 holiday-other-holidays holiday-christian-holidays
326 holiday-hebrew-holidays holiday-islamic-holidays
327 holiday-bahai-holidays holiday-oriental-holidays
328 holiday-solar-holidays
)
329 "List of notable days for the command \\[holidays].
331 Additional holidays are easy to add to the list, just put them in the
332 list `holiday-other-holidays' in your .emacs file. Similarly, by setting
333 any of `holiday-general-holidays', `holiday-local-holidays',
334 `holiday-christian-holidays', `holiday-hebrew-holidays',
335 `holiday-islamic-holidays', `holiday-bahai-holidays',
336 `holiday-oriental-holidays', or `holiday-solar-holidays' to nil in your
337 .emacs file, you can eliminate unwanted categories of holidays.
339 The aforementioned variables control the holiday choices offered
340 by the function `holiday-list' when it is called interactively.
342 They also initialize the default value of `calendar-holidays',
343 which is the default list of holidays used by the function
344 `holiday-list' in the non-interactive case. Note that these
345 variables have no effect on `calendar-holidays' after it has been
346 set (e.g. after the calendar is loaded). In that case, customize
347 `calendar-holidays' directly.
349 The intention is that (in the US) `holiday-local-holidays' be set in
350 site-init.el and `holiday-other-holidays' be set by the user.
352 Entries on the list are expressions that return (possibly empty) lists of
353 items of the form ((month day year) string) of a holiday in the
354 three-month period centered around `displayed-month' of `displayed-year'.
355 Several basic functions are provided for this purpose:
357 (holiday-fixed MONTH DAY STRING) is a fixed date on the Gregorian calendar
358 (holiday-float MONTH DAYNAME K STRING &optional DAY) is the Kth DAYNAME
359 (0 for Sunday, etc.) after/before Gregorian
360 MONTH DAY. K<0 means count back from the end
361 of the month. Optional DAY defaults to 1 if
362 K>0, and MONTH's last day otherwise.
363 (holiday-hebrew MONTH DAY STRING) a fixed date on the Hebrew calendar
364 (holiday-islamic MONTH DAY STRING) a fixed date on the Islamic calendar
365 (holiday-bahai MONTH DAY STRING) a fixed date on the Baha'i calendar
366 (holiday-julian MONTH DAY STRING) a fixed date on the Julian calendar
367 (holiday-sexp SEXP STRING) SEXP is a Gregorian-date-valued expression
368 in the variable `year'; if it evaluates to
369 a visible date, that's the holiday; if it
370 evaluates to nil, there's no holiday. STRING
371 is an expression in the variable `date'.
373 For example, to add Bastille Day, celebrated in France on July 14, add
375 (holiday-fixed 7 14 \"Bastille Day\")
377 to the list. To add Hurricane Supplication Day, celebrated in the Virgin
378 Islands on the fourth Monday in August, add
380 (holiday-float 8 1 4 \"Hurricane Supplication Day\")
382 to the list (the last Monday would be specified with `-1' instead of `4').
383 To add the last day of Hanukkah to the list, use
385 (holiday-hebrew 10 2 \"Last day of Hanukkah\")
387 since the Hebrew months are numbered with 1 starting from Nisan.
388 To add the Islamic feast celebrating Mohammed's birthday, use
390 (holiday-islamic 3 12 \"Mohammed's Birthday\")
392 since the Islamic months are numbered from 1 starting with Muharram.
393 To add an entry for the Baha'i festival of Ridvan, use
395 (holiday-bahai 2 13 \"Festival of Ridvan\")
397 since the Baha'i months are numbered from 1 starting with Baha.
398 To add Thomas Jefferson's birthday, April 2, 1743 (Julian), use
400 (holiday-julian 4 2 \"Jefferson's Birthday\")
402 To include a holiday conditionally, use the sexp form or a conditional. For
403 example, to include American presidential elections, which occur on the first
404 Tuesday after the first Monday in November of years divisible by 4, add
407 '(if (zerop (% year 4))
408 (calendar-gregorian-from-absolute
409 (1+ (calendar-dayname-on-or-before
410 1 (+ 6 (calendar-absolute-from-gregorian
411 (list 11 1 year)))))))
412 \"US Presidential Election\")
416 (if (zerop (% displayed-year 4))
418 (calendar-extract-day
419 (calendar-gregorian-from-absolute
420 (1+ (calendar-dayname-on-or-before
421 1 (+ 6 (calendar-absolute-from-gregorian
422 (list 11 1 displayed-year)))))))
423 \"US Presidential Election\"))
425 to the list. To include the phases of the moon, add
429 to the holiday list, where `lunar-phases' is an Emacs-Lisp function that
430 you've written to return a (possibly empty) list of the relevant VISIBLE dates
431 with descriptive strings such as
433 (((2 6 1989) \"New Moon\") ((2 12 1989) \"First Quarter Moon\") ... )."
437 (put 'calendar-holidays
'risky-local-variable t
)
439 ;;; End of user options.
442 ;; FIXME name that makes sense
444 (defun calendar-holiday-list ()
445 "Form the list of holidays that occur on dates in the calendar window.
446 The holidays are those in the list `calendar-holidays'."
449 (dolist (p calendar-holidays res
)
450 (if (setq h
(if calendar-debug-sexp
451 (let ((stack-trace-on-error t
))
456 (message "Bad holiday list item: %s" p
)
458 (setq res
(append h res
))))
459 'calendar-date-compare
)))
461 (defvar displayed-month
) ; from calendar-generate
462 (defvar displayed-year
)
464 ;; FIXME name that makes sense
466 (defun calendar-list-holidays (&optional event
)
467 "Create a buffer containing the holidays for the current calendar window.
468 The holidays are those in the list `calendar-notable-days'.
469 Returns non-nil if any holidays are found.
470 If EVENT is non-nil, it's an event indicating the buffer position to
471 use instead of point."
472 (interactive (list last-nonmenu-event
))
473 ;; If called from a menu, with the calendar window not selected.
475 (if event
(window-buffer (posn-window (event-start event
)))
477 (message "Looking up holidays...")
478 (let ((holiday-list (calendar-holiday-list))
483 (if (not holiday-list
)
484 (message "Looking up holidays...none found")
485 (calendar-in-read-only-buffer holiday-buffer
486 (calendar-increment-month m1 y1 -
1)
487 (calendar-increment-month m2 y2
1)
488 (calendar-set-mode-line
490 (format "Notable Dates from %s to %s, %d%%-"
491 (calendar-month-name m1
) (calendar-month-name m2
) y2
)
492 (format "Notable Dates from %s, %d to %s, %d%%-"
493 (calendar-month-name m1
) y1
(calendar-month-name m2
) y2
)))
496 (lambda (x) (concat (calendar-date-string (car x
))
499 (message "Looking up holidays...done"))
502 (define-obsolete-function-alias
503 'list-calendar-holidays
'calendar-list-holidays
"23.1")
506 (defun holidays (&optional arg
)
507 "Display the holidays for last month, this month, and next month.
508 If called with an optional prefix argument ARG, prompts for month and year.
509 This function is suitable for execution in a .emacs file."
512 (let* ((completion-ignore-case t
)
513 (date (if arg
(calendar-read-date t
)
514 (calendar-current-date)))
515 (displayed-month (calendar-extract-month date
))
516 (displayed-year (calendar-extract-year date
)))
517 (calendar-list-holidays))))
519 ;; rms: "Emacs commands to display a list of something generally start
520 ;; with `list-'. Please make `list-holidays' the principal name."
522 (defun list-holidays (y1 &optional y2 l label
)
523 "Display holidays for years Y1 to Y2 (inclusive).
524 Y2 defaults to Y1. The optional list of holidays L defaults to
525 `calendar-holidays'. If you want to control what holidays are
526 displayed, use a different list. For example,
528 (list-holidays 2006 2006
529 (append holiday-general-holidays holiday-local-holidays))
531 will display holidays for the year 2006 defined in the two
532 mentioned lists, and nothing else.
534 When called interactively, this command offers a choice of
535 holidays, based on the variables `holiday-solar-holidays' etc. See the
536 documentation of `calendar-holidays' for a list of the variables
537 that control the choices, as well as a description of the format
540 The optional LABEL is used to label the buffer created."
542 (let* ((start-year (calendar-read
543 "Starting year of holidays (>0): "
545 (number-to-string (calendar-extract-year
546 (calendar-current-date)))))
547 (end-year (calendar-read
548 (format "Ending year (inclusive) of holidays (>=%s): "
550 (lambda (x) (>= x start-year
))
551 (number-to-string start-year
)))
552 (completion-ignore-case t
)
555 (cons "All" calendar-holidays
)
556 (cons "Equinoxes/Solstices"
557 (list (list 'solar-equinoxes-solstices
)))
558 (if holiday-general-holidays
559 (cons "General" holiday-general-holidays
))
560 (if holiday-local-holidays
561 (cons "Local" holiday-local-holidays
))
562 (if holiday-other-holidays
563 (cons "Other" holiday-other-holidays
))
564 (if holiday-christian-holidays
565 (cons "Christian" holiday-christian-holidays
))
566 (if holiday-hebrew-holidays
567 (cons "Hebrew" holiday-hebrew-holidays
))
568 (if holiday-islamic-holidays
569 (cons "Islamic" holiday-islamic-holidays
))
570 (if holiday-bahai-holidays
571 (cons "Baha'i" holiday-bahai-holidays
))
572 (if holiday-oriental-holidays
573 (cons "Oriental" holiday-oriental-holidays
))
574 (if holiday-solar-holidays
575 (cons "Solar" holiday-solar-holidays
))
578 (completing-read "List (TAB for choices): " lists nil t
)))
579 (which (if (string-equal choice
"Ask")
580 (eval (read-variable "Enter list name: "))
581 (cdr (assoc choice lists
))))
582 (name (if (string-equal choice
"Equinoxes/Solstices")
584 (if (member choice
'("Ask" ""))
586 (format "%s Holidays" choice
)))))
587 (list start-year end-year which name
)))
588 (unless y2
(setq y2 y1
))
589 (message "Computing holidays...")
590 (let ((calendar-holidays (or l calendar-holidays
))
591 (title (or label
"Holidays"))
592 (s (calendar-absolute-from-gregorian (list 2 1 y1
)))
593 (e (calendar-absolute-from-gregorian (list 11 1 y2
)))
598 (setq holiday-list
(append holiday-list
(calendar-holiday-list)))
599 (calendar-increment-month displayed-month displayed-year
3)
600 (setq s
(calendar-absolute-from-gregorian
601 (list displayed-month
1 displayed-year
))))
603 (calendar-in-read-only-buffer holiday-buffer
604 (calendar-set-mode-line
606 (format "%s for %s" title y1
)
607 (format "%s for %s-%s" title y1 y2
)))
610 (lambda (x) (concat (calendar-date-string (car x
))
613 (message "Computing holidays...done"))))
616 (defalias 'holiday-list
'list-holidays
)
619 (defun calendar-check-holidays (date)
620 "Check the list of holidays for any that occur on DATE.
621 The value returned is a list of strings of relevant holiday descriptions.
622 The holidays are those in the list `calendar-holidays'."
623 (let ((displayed-month (calendar-extract-month date
))
624 (displayed-year (calendar-extract-year date
))
626 (dolist (h (calendar-holiday-list) holiday-list
)
627 (if (calendar-date-equal date
(car h
))
628 (setq holiday-list
(append holiday-list
(cdr h
)))))))
630 (define-obsolete-function-alias
631 'check-calendar-holidays
'calendar-check-holidays
"23.1")
633 (declare-function x-popup-menu
"xmenu.c" (position menu
))
636 (defun calendar-cursor-holidays (&optional date event
)
637 "Find holidays for the date specified by the cursor in the calendar window.
638 Optional DATE is a list (month day year) to use instead of the
639 cursor position. EVENT specifies a buffer position to use for a date."
640 (interactive (list nil last-nonmenu-event
))
641 (message "Checking holidays...")
642 (or date
(setq date
(calendar-cursor-to-date t event
)))
643 (let ((date-string (calendar-date-string date
))
644 (holiday-list (calendar-check-holidays date
))
646 (if (mouse-event-p event
)
647 (and (setq selection
(cal-menu-x-popup-menu event
648 (format "Holidays for %s" date-string
)
650 (mapcar 'list holiday-list
)
652 (call-interactively selection
))
653 (if (not holiday-list
)
654 (message "No holidays known for %s" date-string
)
655 (if (<= (length (setq msg
656 (format "%s: %s" date-string
657 (mapconcat 'identity holiday-list
"; "))))
660 (calendar-in-read-only-buffer holiday-buffer
661 (calendar-set-mode-line date-string
)
662 (insert (mapconcat 'identity holiday-list
"\n")))
663 (message "Checking holidays...done"))))))
665 ;; FIXME move to calendar?
667 (defun calendar-mark-holidays (&optional event
)
668 "Mark notable days in the calendar window.
669 If EVENT is non-nil, it's an event indicating the buffer position to
670 use instead of point."
671 (interactive (list last-nonmenu-event
))
672 ;; If called from a menu, with the calendar window not selected.
674 (if event
(window-buffer (posn-window (event-start event
)))
676 (setq calendar-mark-holidays-flag t
)
677 (message "Marking holidays...")
678 (dolist (holiday (calendar-holiday-list))
679 (calendar-mark-visible-date (car holiday
) calendar-holiday-marker
))
680 (message "Marking holidays...done")))
682 (define-obsolete-function-alias
683 'mark-calendar-holidays
'calendar-mark-holidays
"23.1")
685 ;; Below are the functions that calculate the dates of holidays; these
686 ;; are eval'ed in the function calendar-holiday-list. If you
687 ;; write other such functions, be sure to imitate the style used below.
688 ;; Remember that each function must return a list of items of the form
689 ;; ((month day year) string) of VISIBLE dates in the calendar window.
691 (defun holiday-fixed (month day string
)
692 "Holiday on MONTH, DAY (Gregorian) called STRING.
693 If MONTH, DAY is visible, the value returned is the list (((MONTH DAY year)
694 STRING)). Returns nil if it is not visible in the current calendar window."
695 ;; This determines whether a given month is visible in the calendar.
696 ;; cf calendar-date-is-visible-p (which also checks the year part).
697 ;; The day is irrelevant since only full months are displayed.
698 ;; Since the calendar displays three months at a time, month N
699 ;; is visible if displayed-month = N-1, N, N+1.
700 ;; In particular, November is visible if d-m = 10, 11, 12.
701 ;; This is useful, because we can do a one-sided test:
702 ;; November is visible if d-m > 9. (Similarly, February is visible if
704 ;; To determine if December is visible, we can shift the calendar
705 ;; back a month and ask if November is visible; to determine if
706 ;; October is visible, we can shift it forward a month and ask if
707 ;; November is visible; etc.
708 (let ((m displayed-month
)
710 (calendar-increment-month m y
(- 11 month
))
711 (if (> m
9) ; is november visible?
712 (list (list (list month day y
) string
)))))
714 (defun holiday-float (month dayname n string
&optional day
)
715 "Holiday called STRING on the Nth DAYNAME after/before MONTH DAY.
716 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
717 If N>0, use the Nth DAYNAME after MONTH DAY.
718 If N<0, use the Nth DAYNAME before MONTH DAY.
719 DAY defaults to 1 if N>0, and MONTH's last day otherwise.
720 If the holiday is visible in the calendar window, returns a
721 list (((month day year) STRING)). Otherwise returns nil."
722 ;; This is messy because the holiday may be visible, while the date
723 ;; on which it is based is not. For example, the first Monday after
724 ;; December 30 may be visible when January is not. For large values
725 ;; of |n| the problem is more grotesque. If we didn't have to worry
726 ;; about such cases, we could just use the original version of this
728 ;; (let ((m displayed-month)
729 ;; (y displayed-year))
730 ;; (calendar-increment-month m y (- 11 month))
731 ;; (if (> m 9); month in year y is visible
732 ;; (list (list (calendar-nth-named-day n dayname month y day) string)))))
733 (let* ((m1 displayed-month
)
737 (d1 (progn ; first possible base date for holiday
738 (calendar-increment-month m1 y1 -
1)
739 (+ (calendar-nth-named-absday 1 dayname m1 y1
)
742 (d2 ; last possible base date for holiday
744 (calendar-increment-month m2 y2
1)
745 (+ (calendar-nth-named-absday -
1 dayname m2 y2
)
748 (y1 (calendar-extract-year (calendar-gregorian-from-absolute d1
)))
749 (y2 (calendar-extract-year (calendar-gregorian-from-absolute d2
)))
750 (y ; year of base date
751 (if (or (= y1 y2
) (> month
9))
754 (d ; day of base date
757 (calendar-last-day-of-month month y
))))
758 (date ; base date for holiday
759 (calendar-absolute-from-gregorian (list month d y
))))
760 (and (<= d1 date
) (<= date d2
)
761 (list (list (calendar-nth-named-day n dayname month y d
)
764 (defun holiday-filter-visible-calendar (hlist)
765 "Filter list of holidays HLIST, and return only the visible ones.
766 HLIST is a list of elements of the form (DATE) TEXT."
767 (delq nil
(mapcar (lambda (p)
768 (and (car p
) (calendar-date-is-visible-p (car p
)) p
))
771 (define-obsolete-function-alias
772 'filter-visible-calendar-holidays
'holiday-filter-visible-calendar
"23.1")
774 (defun holiday-sexp (sexp string
)
775 "Sexp holiday for dates in the calendar window.
776 SEXP is an expression in variable `year' that is evaluated to
777 give `date'. STRING is an expression in `date' that evaluates to
778 the holiday description of `date'. If `date' is visible in the
779 calendar window, the holiday STRING is on that date. If date is
780 nil, or if the date is not visible, there is no holiday."
781 (let ((m displayed-month
)
784 (calendar-increment-month m y -
1)
785 (holiday-filter-visible-calendar
790 (list date
(if date
(eval string
))))
794 (list date
(if date
(eval string
))))))))
797 (defun holiday-advent (&optional n string
)
798 "Date of Nth day after advent (named STRING), if visible in calendar window.
799 Negative values of N are interpreted as days before advent.
800 STRING is used purely for display purposes. The return value has
801 the form ((MONTH DAY YEAR) STRING), where the date is that of the
802 Nth day before or after advent.
804 For backwards compatibility, if this function is called with no
805 arguments, then it returns the value appropriate for advent itself."
806 ;; Backwards compatibility layer.
808 (holiday-advent 0 "Advent")
809 (let* ((year displayed-year
)
810 (month displayed-month
)
812 (calendar-increment-month month year -
1)
813 (calendar-gregorian-from-absolute
815 (calendar-dayname-on-or-before
817 (calendar-absolute-from-gregorian
818 (list 12 3 year
))))))))
819 (if (calendar-date-is-visible-p advent
)
820 (list (list advent string
))))))
822 (defun holiday-easter-etc (&optional n string
)
823 "Date of Nth day after Easter (named STRING), if visible in calendar window.
824 Negative values of N are interpreted as days before Easter.
825 STRING is used purely for display purposes. The return value has
826 the form ((MONTH DAY YEAR) STRING), where the date is that of the
827 Nth day before or after Easter.
829 For backwards compatibility, if this function is called with no
830 arguments, then it returns a list of \"standard\" Easter-related
831 holidays (with more entries if `calendar-christian-all-holidays-flag'
833 ;; Backwards compatibility layer.
837 (apply 'holiday-easter-etc e
))
838 ;; The combined list is not in order.
840 (if calendar-christian-all-holidays-flag
841 '((-63 "Septuagesima Sunday")
842 (-56 "Sexagesima Sunday")
843 (-49 "Shrove Sunday")
844 (-48 "Shrove Monday")
845 (-47 "Shrove Tuesday")
846 (-14 "Passion Sunday")
848 (-3 "Maundy Thursday")
849 (35 "Rogation Sunday")
851 (49 "Pentecost (Whitsunday)")
853 (56 "Trinity Sunday")
854 (60 "Corpus Christi")))
855 '((-46 "Ash Wednesday")
857 (0 "Easter Sunday")))))
858 (let* ((century (1+ (/ displayed-year
100)))
859 (shifted-epact ; age of moon for April 5...
860 (%
(+ 14 (* 11 (% displayed-year
19)) ; ...by Nicaean rule
861 (- ; ...corrected for the Gregorian century rule
863 (/ ; ...corrected for Metonic cycle inaccuracy
864 (+ 5 (* 8 century
)) 25)
865 (* 30 century
)) ; keeps value positive
867 (adjusted-epact ; adjust for 29.5 day month
868 (if (or (zerop shifted-epact
)
869 (and (= shifted-epact
1) (< 10 (% displayed-year
19))))
872 (paschal-moon ; day after the full moon on or after March 21
873 (- (calendar-absolute-from-gregorian (list 4 19 displayed-year
))
875 (abs-easter (calendar-dayname-on-or-before 0 (+ paschal-moon
7)))
876 (greg (calendar-gregorian-from-absolute (+ abs-easter n
))))
877 (if (calendar-date-is-visible-p greg
)
878 (list (list greg string
))))))
880 ;; Prior call to calendar-julian-from-absolute will autoload cal-julian.
881 (declare-function calendar-julian-to-absolute
"cal-julian" (date))
883 (defun holiday-greek-orthodox-easter ()
884 "Date of Easter according to the rule of the Council of Nicaea."
885 (let* ((m displayed-month
)
888 (calendar-increment-month m y
1)
889 (calendar-extract-year
890 (calendar-julian-from-absolute
891 (calendar-absolute-from-gregorian
892 (list m
(calendar-last-day-of-month m y
) y
))))))
893 (shifted-epact ; age of moon for April 5
895 (* 11 (% julian-year
19)))
897 (paschal-moon ; day after full moon on or after March 21
898 (- (calendar-julian-to-absolute (list 4 19 julian-year
))
900 (nicaean-easter ; Sunday following the Paschal moon
901 (calendar-gregorian-from-absolute
902 (calendar-dayname-on-or-before 0 (+ paschal-moon
7)))))
903 (if (calendar-date-is-visible-p nicaean-easter
)
904 (list (list nicaean-easter
"Pascha (Greek Orthodox Easter)")))))
908 ;; arch-tag: 48eb3117-75a7-4dbe-8fd9-873c3cbb0d37
909 ;;; holidays.el ends here