lisp/calendar/calendar.el

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