lisp/calendar/diary-lib.el

   1 ;;; diary-lib.el --- diary functions
   2
   3 ;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995 Free Software
   4 ;; Foundation, Inc.
   5
   6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
   7 ;; Keywords: calendar
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; This collection of functions implements the diary features as described
  29 ;; in calendar.el.
  30
  31 ;; Comments, corrections, and improvements should be sent to
  32 ;;  Edward M. Reingold               Department of Computer Science
  33 ;;  (217) 333-6733                   University of Illinois at Urbana-Champaign
  34 ;;  reingold@cs.uiuc.edu             1304 West Springfield Avenue
  35 ;;                                   Urbana, Illinois 61801
  36
  37 ;;; Code:
  38
  39 (require 'calendar)
  40
  41 ;;;###autoload
  42 (defun diary (&optional arg)
  43   "Generate the diary window for ARG days starting with the current date.
  44 If no argument is provided, the number of days of diary entries is governed
  45 by the variable `number-of-diary-entries'.  This function is suitable for
  46 execution in a `.emacs' file."
  47   (interactive "P")
  48   (let ((d-file (substitute-in-file-name diary-file))
  49         (date (calendar-current-date)))
  50     (if (and d-file (file-exists-p d-file))
  51         (if (file-readable-p d-file)
  52             (list-diary-entries
  53              date
  54              (cond
  55               (arg (prefix-numeric-value arg))
  56               ((vectorp number-of-diary-entries)
  57                (aref number-of-diary-entries (calendar-day-of-week date)))
  58               (t number-of-diary-entries)))
  59         (error "Your diary file is not readable!"))
  60       (error "You don't have a diary file!"))))
  61
  62 (defun view-diary-entries (arg)
  63   "Prepare and display a buffer with diary entries.
  64 Searches the file named in `diary-file' for entries that
  65 match ARG days starting with the date indicated by the cursor position
  66 in the displayed three-month calendar."
  67   (interactive "p")
  68   (let ((d-file (substitute-in-file-name diary-file)))
  69     (if (and d-file (file-exists-p d-file))
  70         (if (file-readable-p d-file)
  71             (list-diary-entries (calendar-cursor-to-date t) arg)
  72           (error "Diary file is not readable!"))
  73       (error "You don't have a diary file!"))))
  74
  75 (defun view-other-diary-entries (arg d-file)
  76   "Prepare and display buffer of diary entries from an alternative diary file.
  77 Prompts for a file name and searches that file for entries that match ARG
  78 days starting with the date indicated by the cursor position in the displayed
  79 three-month calendar."
  80   (interactive
  81    (list (cond ((null current-prefix-arg) 1)
  82                ((listp current-prefix-arg) (car current-prefix-arg))
  83                (t current-prefix-arg))
  84          (read-file-name "Enter diary file name: " default-directory nil t)))
  85   (let ((diary-file d-file))
  86     (view-diary-entries arg)))
  87
  88 (autoload 'check-calendar-holidays "holidays"
  89   "Check the list of holidays for any that occur on DATE.
  90 The value returned is a list of strings of relevant holiday descriptions.
  91 The holidays are those in the list `calendar-holidays'."
  92   t)
  93
  94 (autoload 'calendar-holiday-list "holidays"
  95   "Form the list of holidays that occur on dates in the calendar window.
  96 The holidays are those in the list `calendar-holidays'."
  97   t)
  98
  99 (autoload 'diary-french-date "cal-french"
 100   "French calendar equivalent of date diary entry."
 101   t)
 102
 103 (autoload 'diary-mayan-date "cal-mayan"
 104   "Mayan calendar equivalent of date diary entry."
 105   t)
 106
 107 (autoload 'diary-iso-date "cal-iso"
 108   "ISO calendar equivalent of date diary entry."
 109   t)
 110
 111 (autoload 'diary-julian-date "cal-julian"
 112   "Julian calendar equivalent of date diary entry."
 113   t)
 114
 115 (autoload 'diary-astro-day-number "cal-julian"
 116   "Astronomical (Julian) day number diary entry."
 117   t)
 118
 119 (autoload 'diary-chinese-date "cal-china"
 120   "Chinese calendar equivalent of date diary entry."
 121   t)
 122
 123 (autoload 'diary-islamic-date "cal-islam"
 124   "Islamic calendar equivalent of date diary entry."
 125   t)
 126
 127 (autoload 'list-islamic-diary-entries "cal-islam"
 128   "Add any Islamic date entries from the diary file to `diary-entries-list'."
 129   t)
 130
 131 (autoload 'mark-islamic-diary-entries "cal-islam"
 132   "Mark days in the calendar window that have Islamic date diary entries."
 133   t)
 134
 135 (autoload 'mark-islamic-calendar-date-pattern "cal-islam"
 136    "Mark dates in calendar window that conform to Islamic date MONTH/DAY/YEAR."
 137   t)
 138
 139 (autoload 'diary-hebrew-date "cal-hebrew"
 140   "Hebrew calendar equivalent of date diary entry."
 141   t)
 142
 143 (autoload 'diary-omer "cal-hebrew"
 144   "Omer count diary entry."
 145   t)
 146
 147 (autoload 'diary-yahrzeit "cal-hebrew"
 148   "Yahrzeit diary entry--entry applies if date is yahrzeit or the day before."
 149   t)
 150
 151 (autoload 'diary-parasha "cal-hebrew"
 152   "Parasha diary entry--entry applies if date is a Saturday."
 153   t)
 154
 155 (autoload 'diary-rosh-hodesh "cal-hebrew"
 156   "Rosh Hodesh diary entry."
 157   t)
 158
 159 (autoload 'list-hebrew-diary-entries "cal-hebrew"
 160   "Add any Hebrew date entries from the diary file to `diary-entries-list'."
 161   t)
 162
 163 (autoload 'mark-hebrew-diary-entries "cal-hebrew"
 164   "Mark days in the calendar window that have Hebrew date diary entries."
 165   t)
 166
 167 (autoload 'mark-hebrew-calendar-date-pattern "cal-hebrew"
 168    "Mark dates in calendar window that conform to Hebrew date MONTH/DAY/YEAR."
 169   t)
 170
 171 (autoload 'diary-coptic-date "cal-coptic"
 172   "Coptic calendar equivalent of date diary entry."
 173   t)
 174
 175 (autoload 'diary-ethiopic-date "cal-coptic"
 176   "Ethiopic calendar equivalent of date diary entry."
 177   t)
 178
 179 (autoload 'diary-persian-date "cal-persia"
 180   "Persian calendar equivalent of date diary entry."
 181   t)
 182
 183 (autoload 'diary-phases-of-moon "lunar" "Moon phases diary entry." t)
 184
 185 (autoload 'diary-sunrise-sunset "solar"
 186   "Local time of sunrise and sunset as a diary entry."
 187   t)
 188
 189 (autoload 'diary-sabbath-candles "solar"
 190   "Local time of candle lighting diary entry--applies if date is a Friday.
 191 No diary entry if there is no sunset on that date."
 192   t)
 193
 194 (defvar diary-syntax-table (copy-syntax-table (standard-syntax-table))
 195   "The syntax table used when parsing dates in the diary file.
 196 It is the standard syntax table used in Fundamental mode, but with the
 197 syntax of `*' changed to be a word constituent.")
 198
 199 (modify-syntax-entry ?* "w" diary-syntax-table)
 200 (modify-syntax-entry ?: "w" diary-syntax-table)
 201
 202 (defun list-diary-entries (date number)
 203   "Create and display a buffer containing the relevant lines in diary-file.
 204 The arguments are DATE and NUMBER; the entries selected are those
 205 for NUMBER days starting with date DATE.  The other entries are hidden
 206 using selective display.
 207
 208 Returns a list of all relevant diary entries found, if any, in order by date.
 209 The list entries have the form ((month day year) string specifier) where
 210 \(month day year) is the date of the entry, string is the entry text, and
 211 specifier is the applicability.  If the variable `diary-list-include-blanks'
 212 is t, this list includes a dummy diary entry consisting of the empty string)
 213 for a date with no diary entries.
 214
 215 After the list is prepared, the hooks `nongregorian-diary-listing-hook',
 216 `list-diary-entries-hook', `diary-display-hook', and `diary-hook' are run.
 217 These hooks have the following distinct roles:
 218
 219     `nongregorian-diary-listing-hook' can cull dates from the diary
 220         and each included file.  Usually used for Hebrew or Islamic
 221         diary entries in files.  Applied to *each* file.
 222
 223     `list-diary-entries-hook' adds or manipulates diary entries from
 224         external sources.  Used, for example, to include diary entries
 225         from other files or to sort the diary entries.  Invoked *once* only,
 226         before the display hook is run.
 227
 228     `diary-display-hook' does the actual display of information.  If this is
 229         nil, simple-diary-display will be used.  Use add-hook to set this to
 230         fancy-diary-display, if desired.  If you want no diary display, use
 231         add-hook to set this to ignore.
 232
 233     `diary-hook' is run last.  This can be used for an appointment
 234         notification function."
 235
 236   (if (< 0 number)
 237       (let* ((original-date date);; save for possible use in the hooks
 238              (old-diary-syntax-table)
 239              (diary-entries-list)
 240              (date-string (calendar-date-string date))
 241              (d-file (substitute-in-file-name diary-file)))
 242         (message "Preparing diary...")
 243         (save-excursion
 244           (let ((diary-buffer (find-buffer-visiting d-file)))
 245             (if (not diary-buffer)
 246                 (set-buffer (find-file-noselect d-file t))
 247               (set-buffer diary-buffer)
 248               (or (verify-visited-file-modtime diary-buffer)
 249                   (revert-buffer t t))))
 250           (setq selective-display t)
 251           (setq selective-display-ellipses nil)
 252           (setq old-diary-syntax-table (syntax-table))
 253           (set-syntax-table diary-syntax-table)
 254           (unwind-protect
 255             (let ((buffer-read-only nil)
 256                   (diary-modified (buffer-modified-p))
 257                   (mark (regexp-quote diary-nonmarking-symbol)))
 258               ;; First and last characters must be ^M or \n for
 259               ;; selective display to work properly
 260               (goto-char (1- (point-max)))
 261               (if (not (looking-at "\^M\\|\n"))
 262                   (progn
 263                     (goto-char (point-max))
 264                     (insert "\^M")))
 265               (goto-char (point-min))
 266               (if (not (looking-at "\^M\\|\n"))
 267                   (insert "\^M"))
 268               (subst-char-in-region (point-min) (point-max) ?\n ?\^M t)
 269               (calendar-for-loop i from 1 to number do
 270                  (let ((d diary-date-forms)
 271                        (month (extract-calendar-month date))
 272                        (day (extract-calendar-day date))
 273                        (year (extract-calendar-year date))
 274                        (entry-found (list-sexp-diary-entries date)))
 275                    (while d
 276                      (let*
 277                           ((date-form (if (equal (car (car d)) 'backup)
 278                                           (cdr (car d))
 279                                         (car d)))
 280                           (backup (equal (car (car d)) 'backup))
 281                           (dayname
 282                            (concat
 283                             (calendar-day-name date) "\\|"
 284                             (substring (calendar-day-name date) 0 3) ".?"))
 285                           (monthname
 286                            (concat
 287                             "\\*\\|"
 288                             (calendar-month-name month) "\\|"
 289                             (substring (calendar-month-name month) 0 3) ".?"))
 290                           (month (concat "\\*\\|0*" (int-to-string month)))
 291                           (day (concat "\\*\\|0*" (int-to-string day)))
 292                           (year
 293                            (concat
 294                             "\\*\\|0*" (int-to-string year)
 295                             (if abbreviated-calendar-year
 296                                 (concat "\\|" (format "%02d" (% year 100)))
 297                               "")))
 298                           (regexp
 299                            (concat
 300                             "\\(\\`\\|\^M\\|\n\\)" mark "?\\("
 301                             (mapconcat 'eval date-form "\\)\\(")
 302                             "\\)"))
 303                           (case-fold-search t))
 304                        (goto-char (point-min))
 305                        (while (re-search-forward regexp nil t)
 306                          (if backup (re-search-backward "\\<" nil t))
 307                          (if (and (or (char-equal (preceding-char) ?\^M)
 308                                       (char-equal (preceding-char) ?\n))
 309                                   (not (looking-at " \\|\^I")))
 310                              ;;  Diary entry that consists only of date.
 311                              (backward-char 1)
 312                            ;; Found a nonempty diary entry--make it visible and
 313                            ;; add it to the list.
 314                            (setq entry-found t)
 315                            (let ((entry-start (point))
 316                                  (date-start))
 317                              (re-search-backward "\^M\\|\n\\|\\`")
 318                              (setq date-start (point))
 319                              (re-search-forward "\^M\\|\n" nil t 2)
 320                              (while (looking-at " \\|\^I")
 321                                (re-search-forward "\^M\\|\n" nil t))
 322                              (backward-char 1)
 323                              (subst-char-in-region date-start
 324                                 (point) ?\^M ?\n t)
 325                              (add-to-diary-list
 326                               date
 327                               (buffer-substring
 328                                entry-start (point))
 329                               (buffer-substring
 330                                (1+ date-start) (1- entry-start)))))))
 331                      (setq d (cdr d)))
 332                    (or entry-found
 333                        (not diary-list-include-blanks)
 334                        (setq diary-entries-list
 335                              (append diary-entries-list
 336                                      (list (list date "" "")))))
 337                    (setq date
 338                          (calendar-gregorian-from-absolute
 339                            (1+ (calendar-absolute-from-gregorian date))))
 340                    (setq entry-found nil)))
 341               (set-buffer-modified-p diary-modified))
 342           (set-syntax-table old-diary-syntax-table))
 343         (goto-char (point-min))
 344         (run-hooks 'nongregorian-diary-listing-hook
 345                    'list-diary-entries-hook)
 346         (if diary-display-hook
 347             (run-hooks 'diary-display-hook)
 348           (simple-diary-display))
 349         (run-hooks 'diary-hook)
 350         diary-entries-list))))
 351
 352 (defun include-other-diary-files ()
 353   "Include the diary entries from other diary files with those of diary-file.
 354 This function is suitable for use in `list-diary-entries-hook';
 355 it enables you to use shared diary files together with your own.
 356 The files included are specified in the diaryfile by lines of this form:
 357         #include \"filename\"
 358 This is recursive; that is, #include directives in diary files thus included
 359 are obeyed.  You can change the `#include' to some other string by
 360 changing the variable `diary-include-string'."
 361   (goto-char (point-min))
 362   (while (re-search-forward
 363           (concat
 364            "\\(\\`\\|\^M\\|\n\\)"
 365            (regexp-quote diary-include-string)
 366            " \"\\([^\"]*\\)\"")
 367           nil t)
 368     (let* ((diary-file (substitute-in-file-name
 369                         (buffer-substring-no-properties
 370                          (match-beginning 2) (match-end 2))))
 371            (diary-list-include-blanks nil)
 372            (list-diary-entries-hook 'include-other-diary-files)
 373            (diary-display-hook 'ignore)
 374            (diary-hook nil)
 375            (d-buffer (find-buffer-visiting diary-file))
 376            (diary-modified (if d-buffer
 377                                (save-excursion
 378                                  (set-buffer d-buffer)
 379                                  (buffer-modified-p)))))
 380       (if (file-exists-p diary-file)
 381           (if (file-readable-p diary-file)
 382               (unwind-protect
 383                   (setq diary-entries-list
 384                         (append diary-entries-list
 385                                 (list-diary-entries original-date number)))
 386                 (save-excursion
 387                   (set-buffer (find-buffer-visiting diary-file))
 388                   (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
 389                   (setq selective-display nil)
 390                   (set-buffer-modified-p diary-modified)))
 391             (beep)
 392             (message "Can't read included diary file %s" diary-file)
 393             (sleep-for 2))
 394         (beep)
 395         (message "Can't find included diary file %s" diary-file)
 396         (sleep-for 2))))
 397     (goto-char (point-min)))
 398
 399 (defun simple-diary-display ()
 400   "Display the diary buffer if there are any relevant entries or holidays."
 401   (let* ((holiday-list (if holidays-in-diary-buffer
 402                            (check-calendar-holidays original-date)))
 403          (msg (format "No diary entries for %s %s"
 404                       (concat date-string (if holiday-list ":" ""))
 405                       (mapconcat 'identity holiday-list "; "))))
 406     (calendar-set-mode-line
 407      (concat "Diary for " date-string
 408              (if holiday-list ": " "")
 409              (mapconcat 'identity holiday-list "; ")))
 410     (if (or (not diary-entries-list)
 411             (and (not (cdr diary-entries-list))
 412                  (string-equal (car (cdr (car diary-entries-list))) "")))
 413         (if (<= (length msg) (frame-width))
 414             (message "%s" msg)
 415           (set-buffer (get-buffer-create holiday-buffer))
 416           (setq buffer-read-only nil)
 417           (calendar-set-mode-line date-string)
 418           (erase-buffer)
 419           (insert (mapconcat 'identity holiday-list "\n"))
 420           (goto-char (point-min))
 421           (set-buffer-modified-p nil)
 422           (setq buffer-read-only t)
 423           (display-buffer holiday-buffer)
 424           (message  "No diary entries for %s" date-string))
 425       (display-buffer (find-buffer-visiting d-file))
 426       (message "Preparing diary...done"))))
 427
 428 (defun fancy-diary-display ()
 429   "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
 430 This function is provided for optional use as the `diary-display-hook'."
 431   (save-excursion;; Turn off selective-display in the diary file's buffer.
 432     (set-buffer (find-buffer-visiting (substitute-in-file-name diary-file)))
 433     (let ((diary-modified (buffer-modified-p)))
 434       (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
 435       (setq selective-display nil)
 436       (kill-local-variable 'mode-line-format)
 437       (set-buffer-modified-p diary-modified)))
 438   (if (or (not diary-entries-list)
 439           (and (not (cdr diary-entries-list))
 440                (string-equal (car (cdr (car diary-entries-list))) "")))
 441       (let* ((holiday-list (if holidays-in-diary-buffer
 442                                (check-calendar-holidays original-date)))
 443              (msg (format "No diary entries for %s %s"
 444                           (concat date-string (if holiday-list ":" ""))
 445                           (mapconcat 'identity holiday-list "; "))))
 446         (if (<= (length msg) (frame-width))
 447             (message "%s" msg)
 448           (set-buffer (get-buffer-create holiday-buffer))
 449           (setq buffer-read-only nil)
 450           (calendar-set-mode-line date-string)
 451           (erase-buffer)
 452           (insert (mapconcat 'identity holiday-list "\n"))
 453           (goto-char (point-min))
 454           (set-buffer-modified-p nil)
 455           (setq buffer-read-only t)
 456           (display-buffer holiday-buffer)
 457           (message  "No diary entries for %s" date-string)))
 458     (save-excursion;; Prepare the fancy diary buffer.
 459       (set-buffer (make-fancy-diary-buffer))
 460       (setq buffer-read-only nil)
 461       (let ((entry-list diary-entries-list)
 462             (holiday-list)
 463             (holiday-list-last-month 1)
 464             (holiday-list-last-year 1)
 465             (date (list 0 0 0)))
 466         (while entry-list
 467           (if (not (calendar-date-equal date (car (car entry-list))))
 468               (progn
 469                 (setq date (car (car entry-list)))
 470                 (and holidays-in-diary-buffer
 471                      (calendar-date-compare
 472                       (list (list holiday-list-last-month
 473                                   (calendar-last-day-of-month
 474                                    holiday-list-last-month
 475                                    holiday-list-last-year)
 476                                   holiday-list-last-year))
 477                       (list date))
 478                      ;; We need to get the holidays for the next 3 months.
 479                      (setq holiday-list-last-month
 480                            (extract-calendar-month date))
 481                      (setq holiday-list-last-year
 482                            (extract-calendar-year date))
 483                      (increment-calendar-month
 484                       holiday-list-last-month holiday-list-last-year 1)
 485                      (setq holiday-list
 486                            (let ((displayed-month holiday-list-last-month)
 487                                  (displayed-year holiday-list-last-year))
 488                              (calendar-holiday-list)))
 489                      (increment-calendar-month
 490                       holiday-list-last-month holiday-list-last-year 1))
 491                 (let* ((date-string (calendar-date-string date))
 492                        (date-holiday-list
 493                         (let ((h holiday-list)
 494                               (d))
 495                           ;; Make a list of all holidays for date.
 496                           (while h
 497                             (if (calendar-date-equal date (car (car h)))
 498                                 (setq d (append d (cdr (car h)))))
 499                             (setq h (cdr h)))
 500                           d)))
 501                   (insert (if (= (point) (point-min)) "" ?\n) date-string)
 502                   (if date-holiday-list (insert ":  "))
 503                   (let* ((l (current-column))
 504                          (longest 0))
 505                     (insert (mapconcat (lambda (x)
 506                                          (if (< longest (length x))
 507                                              (setq longest (length x)))
 508                                          x)
 509                                        date-holiday-list
 510                                        (concat "\n" (make-string l ? ))))
 511                     (insert ?\n (make-string (+ l longest) ?=) ?\n)))))
 512           (if (< 0 (length (car (cdr (car entry-list)))))
 513               (insert (car (cdr (car entry-list))) ?\n))
 514           (setq entry-list (cdr entry-list))))
 515       (set-buffer-modified-p nil)
 516       (goto-char (point-min))
 517       (setq buffer-read-only t)
 518       (display-buffer fancy-diary-buffer)
 519       (message "Preparing diary...done"))))
 520
 521 (defun make-fancy-diary-buffer ()
 522   "Create and return the initial fancy diary buffer."
 523   (save-excursion
 524     (set-buffer (get-buffer-create fancy-diary-buffer))
 525     (setq buffer-read-only nil)
 526     (make-local-variable 'mode-line-format)
 527     (calendar-set-mode-line "Diary Entries")
 528     (erase-buffer)
 529     (set-buffer-modified-p nil)
 530     (setq buffer-read-only t)
 531     (get-buffer fancy-diary-buffer)))
 532
 533 (defun print-diary-entries ()
 534   "Print a hard copy of the diary display.
 535
 536 If the simple diary display is being used, prepare a temp buffer with the
 537 visible lines of the diary buffer, add a heading line composed from the mode
 538 line, print the temp buffer, and destroy it.
 539
 540 If the fancy diary display is being used, just print the buffer.
 541
 542 The hooks given by the variable `print-diary-entries-hook' are called to do
 543 the actual printing."
 544   (interactive)
 545   (if (bufferp (get-buffer fancy-diary-buffer))
 546       (save-excursion
 547         (set-buffer (get-buffer fancy-diary-buffer))
 548         (run-hooks 'print-diary-entries-hook))
 549     (let ((diary-buffer
 550            (find-buffer-visiting (substitute-in-file-name diary-file))))
 551       (if diary-buffer
 552           (let ((temp-buffer (get-buffer-create "*Printable Diary Entries*"))
 553                 (heading))
 554             (save-excursion
 555               (set-buffer diary-buffer)
 556               (setq heading
 557                     (if (not (stringp mode-line-format))
 558                         "All Diary Entries"
 559                       (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
 560                       (substring mode-line-format
 561                                  (match-beginning 1) (match-end 1))))
 562               (copy-to-buffer temp-buffer (point-min) (point-max))
 563               (set-buffer temp-buffer)
 564               (while (re-search-forward "\^M.*$" nil t)
 565                 (replace-match ""))
 566               (goto-char (point-min))
 567               (insert heading "\n"
 568                       (make-string (length heading) ?=) "\n")
 569               (run-hooks 'print-diary-entries-hook)
 570               (kill-buffer temp-buffer)))
 571         (error "You don't have a diary buffer!")))))
 572
 573 (defun show-all-diary-entries ()
 574   "Show all of the diary entries in the diary file.
 575 This function gets rid of the selective display of the diary file so that
 576 all entries, not just some, are visible.  If there is no diary buffer, one
 577 is created."
 578   (interactive)
 579   (let ((d-file (substitute-in-file-name diary-file)))
 580     (if (and d-file (file-exists-p d-file))
 581         (if (file-readable-p d-file)
 582             (save-excursion
 583               (let ((diary-buffer (find-buffer-visiting d-file)))
 584                 (set-buffer (if diary-buffer
 585                                 diary-buffer
 586                               (find-file-noselect d-file t)))
 587                 (let ((buffer-read-only nil)
 588                       (diary-modified (buffer-modified-p)))
 589                   (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
 590                   (setq selective-display nil)
 591                   (make-local-variable 'mode-line-format)
 592                   (setq mode-line-format default-mode-line-format)
 593                   (display-buffer (current-buffer))
 594                   (set-buffer-modified-p diary-modified))))
 595           (error "Your diary file is not readable!"))
 596       (error "You don't have a diary file!"))))
 597
 598
 599
 600 (defcustom diary-mail-addr
 601   (if (boundp 'user-mail-address) user-mail-address nil)
 602   "*Email address that `diary-mail-entries' will send email to."
 603   :group 'diary
 604   :type '(choice string (const nil))
 605   :version "20.3")
 606
 607 (defcustom diary-mail-days 7
 608   "*Number of days for `diary-mail-entries' to check."
 609   :group 'diary
 610   :type 'integer
 611   :version "20.3")
 612
 613 ;;;###autoload
 614 (defun diary-mail-entries (&optional ndays)
 615   "Send a mail message showing diary entries for next NDAYS days.
 616 If no prefix argument is given, NDAYS is set to `diary-mail-days'.
 617
 618 You can call `diary-mail-entries' every night using an at/cron job.
 619 For example, this script will run the program at 2am daily.  Since
 620 `emacs -batch' does not load your `.emacs' file, you must ensure that
 621 all relevant variables are set, as done here.
 622
 623 #!/bin/sh
 624 # diary-rem.sh -- repeatedly run the Emacs diary-reminder
 625 emacs -batch \\
 626 -eval \"(setq diary-mail-days 3 \\
 627              european-calendar-style t \\
 628              diary-mail-addr \\\"user@host.name\\\" )\" \\
 629 -l diary-lib -f diary-mail-entries
 630 at -f diary-rem.sh 0200 tomorrow
 631
 632 You may have to tweak the syntax of the `at' command to suit your
 633 system.  Alternatively, you can specify a cron entry:
 634 0 1 * * * diary-rem.sh
 635 to run it every morning at 1am."
 636   (interactive "P")
 637   (let* ((diary-display-hook 'fancy-diary-display)
 638          (diary-list-include-blanks t)
 639          (text (progn (list-diary-entries (calendar-current-date)
 640                                           (if ndays ndays diary-mail-days))
 641                       (set-buffer fancy-diary-buffer)
 642                       (buffer-substring (point-min) (point-max)))))
 643     (mail)
 644     (mail-to) (insert diary-mail-addr)
 645     (mail-subject) (insert "Diary entries generated "
 646                            (calendar-date-string (calendar-current-date)))
 647     (mail-text) (insert text)
 648     (mail-send-and-exit nil)))
 649
 650
 651 (defun diary-name-pattern (string-array &optional fullname)
 652   "Convert an STRING-ARRAY, an array of strings to a pattern.
 653 The pattern will match any of the strings, either entirely or abbreviated
 654 to three characters.  An abbreviated form will match with or without a period;
 655 If the optional FULLNAME is t, abbreviations will not match, just the full
 656 name."
 657   (let ((pattern ""))
 658     (calendar-for-loop i from 0 to (1- (length string-array)) do
 659       (setq pattern
 660             (concat
 661              pattern
 662              (if (string-equal pattern "") "" "\\|")
 663              (aref string-array i)
 664              (if fullname
 665                  ""
 666                (concat
 667                 "\\|"
 668                 (substring (aref string-array i) 0 3) ".?")))))
 669     pattern))
 670
 671 (defvar marking-diary-entries nil
 672   "True during the marking of diary entries, nil otherwise.")
 673
 674 (defvar marking-diary-entry nil
 675   "True during the marking of diary entries, if current entry is marking.")
 676
 677 (defun mark-diary-entries ()
 678   "Mark days in the calendar window that have diary entries.
 679 Each entry in the diary file visible in the calendar window is marked.
 680 After the entries are marked, the hooks `nongregorian-diary-marking-hook' and
 681 `mark-diary-entries-hook' are run."
 682   (interactive)
 683   (setq mark-diary-entries-in-calendar t)
 684   (let ((d-file (substitute-in-file-name diary-file))
 685         (marking-diary-entries t))
 686     (if (and d-file (file-exists-p d-file))
 687         (if (file-readable-p d-file)
 688             (save-excursion
 689               (message "Marking diary entries...")
 690               (set-buffer (find-file-noselect d-file t))
 691               (let ((d diary-date-forms)
 692                     (old-diary-syntax-table))
 693                 (setq old-diary-syntax-table (syntax-table))
 694                 (set-syntax-table diary-syntax-table)
 695                 (while d
 696                   (let*
 697                       ((date-form (if (equal (car (car d)) 'backup)
 698                                       (cdr (car d))
 699                                     (car d)));; ignore 'backup directive
 700                        (dayname (diary-name-pattern calendar-day-name-array))
 701                        (monthname
 702                         (concat
 703                          (diary-name-pattern calendar-month-name-array)
 704                          "\\|\\*"))
 705                        (month "[0-9]+\\|\\*")
 706                        (day "[0-9]+\\|\\*")
 707                        (year "[0-9]+\\|\\*")
 708                        (l (length date-form))
 709                        (d-name-pos (- l (length (memq 'dayname date-form))))
 710                        (d-name-pos (if (/= l d-name-pos) (+ 2 d-name-pos)))
 711                        (m-name-pos (- l (length (memq 'monthname date-form))))
 712                        (m-name-pos (if (/= l m-name-pos) (+ 2 m-name-pos)))
 713                        (d-pos (- l (length (memq 'day date-form))))
 714                        (d-pos (if (/= l d-pos) (+ 2 d-pos)))
 715                        (m-pos (- l (length (memq 'month date-form))))
 716                        (m-pos (if (/= l m-pos) (+ 2 m-pos)))
 717                        (y-pos (- l (length (memq 'year date-form))))
 718                        (y-pos (if (/= l y-pos) (+ 2 y-pos)))
 719                        (regexp
 720                         (concat
 721                          "\\(\\`\\|\^M\\|\n\\)\\("
 722                          (mapconcat 'eval date-form "\\)\\(")
 723                          "\\)"))
 724                        (case-fold-search t))
 725                     (goto-char (point-min))
 726                     (while (re-search-forward regexp nil t)
 727                       (let* ((dd-name
 728                               (if d-name-pos
 729                                   (buffer-substring-no-properties
 730                                    (match-beginning d-name-pos)
 731                                    (match-end d-name-pos))))
 732                              (mm-name
 733                               (if m-name-pos
 734                                   (buffer-substring-no-properties
 735                                    (match-beginning m-name-pos)
 736                                    (match-end m-name-pos))))
 737                              (mm (string-to-int
 738                                   (if m-pos
 739                                       (buffer-substring-no-properties
 740                                        (match-beginning m-pos)
 741                                        (match-end m-pos))
 742                                     "")))
 743                              (dd (string-to-int
 744                                   (if d-pos
 745                                       (buffer-substring-no-properties
 746                                        (match-beginning d-pos)
 747                                        (match-end d-pos))
 748                                     "")))
 749                              (y-str (if y-pos
 750                                         (buffer-substring-no-properties
 751                                          (match-beginning y-pos)
 752                                          (match-end y-pos))))
 753                              (yy (if (not y-str)
 754                                      0
 755                                    (if (and (= (length y-str) 2)
 756                                             abbreviated-calendar-year)
 757                                        (let* ((current-y
 758                                                (extract-calendar-year
 759                                                 (calendar-current-date)))
 760                                               (y (+ (string-to-int y-str)
 761                                                     (* 100
 762                                                        (/ current-y 100)))))
 763                                          (if (> (- y current-y) 50)
 764                                              (- y 100)
 765                                            (if (> (- current-y y) 50)
 766                                                (+ y 100)
 767                                              y)))
 768                                      (string-to-int y-str)))))
 769                         (if dd-name
 770                             (mark-calendar-days-named
 771                              (cdr (assoc-ignore-case
 772                                    (substring dd-name 0 3)
 773                                    (calendar-make-alist
 774                                     calendar-day-name-array
 775                                     0
 776                                     (lambda (x) (substring x 0 3))))))
 777                           (if mm-name
 778                               (if (string-equal mm-name "*")
 779                                   (setq mm 0)
 780                                 (setq mm
 781                                       (cdr (assoc-ignore-case
 782                                             (substring mm-name 0 3)
 783                                             (calendar-make-alist
 784                                              calendar-month-name-array
 785                                              1
 786                                              (lambda (x) (substring x 0 3)))
 787                                             )))))
 788                           (mark-calendar-date-pattern mm dd yy))))
 789                     (setq d (cdr d))))
 790                 (mark-sexp-diary-entries)
 791                 (run-hooks 'nongregorian-diary-marking-hook
 792                            'mark-diary-entries-hook)
 793                 (set-syntax-table old-diary-syntax-table)
 794                 (message "Marking diary entries...done")))
 795           (error "Your diary file is not readable!"))
 796       (error "You don't have a diary file!"))))
 797
 798 (defun mark-sexp-diary-entries ()
 799   "Mark days in the calendar window that have sexp diary entries.
 800 Each entry in the diary file (or included files) visible in the calendar window
 801 is marked.  See the documentation for the function `list-sexp-diary-entries'."
 802   (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol))
 803          (s-entry (concat "\\(\\`\\|\^M\\|\n\\)\\("
 804                           (regexp-quote sexp-mark) "(\\)\\|\\("
 805                           (regexp-quote diary-nonmarking-symbol)
 806                           (regexp-quote sexp-mark) "(diary-remind\\)"))
 807          (m)
 808          (y)
 809          (first-date)
 810          (last-date))
 811     (save-excursion
 812       (set-buffer calendar-buffer)
 813       (setq m displayed-month)
 814       (setq y displayed-year))
 815     (increment-calendar-month m y -1)
 816     (setq first-date
 817           (calendar-absolute-from-gregorian (list m 1 y)))
 818     (increment-calendar-month m y 2)
 819     (setq last-date
 820           (calendar-absolute-from-gregorian
 821            (list m (calendar-last-day-of-month m y) y)))
 822     (goto-char (point-min))
 823     (while (re-search-forward s-entry nil t)
 824       (if (char-equal (preceding-char) ?\()
 825           (setq marking-diary-entry t)
 826         (setq marking-diary-entry nil))
 827       (re-search-backward "(")
 828       (let ((sexp-start (point))
 829             (sexp)
 830             (entry)
 831             (entry-start)
 832             (line-start))
 833         (forward-sexp)
 834         (setq sexp (buffer-substring-no-properties sexp-start (point)))
 835         (save-excursion
 836           (re-search-backward "\^M\\|\n\\|\\`")
 837           (setq line-start (point)))
 838         (forward-char 1)
 839         (if (and (or (char-equal (preceding-char) ?\^M)
 840                      (char-equal (preceding-char) ?\n))
 841                  (not (looking-at " \\|\^I")))
 842             (progn;; Diary entry consists only of the sexp
 843               (backward-char 1)
 844               (setq entry ""))
 845           (setq entry-start (point))
 846           ;; Find end of entry
 847           (re-search-forward "\^M\\|\n" nil t)
 848           (while (looking-at " \\|\^I")
 849             (or (re-search-forward "\^M\\|\n" nil t)
 850                 (re-search-forward "$" nil t)))
 851           (if (or (char-equal (preceding-char) ?\^M)
 852                   (char-equal (preceding-char) ?\n))
 853               (backward-char 1))
 854           (setq entry (buffer-substring-no-properties entry-start (point)))
 855           (while (string-match "[\^M]" entry)
 856             (aset entry (match-beginning 0) ?\n )))
 857         (calendar-for-loop date from first-date to last-date do
 858           (if (diary-sexp-entry sexp entry
 859                                 (calendar-gregorian-from-absolute date))
 860               (mark-visible-calendar-date
 861                (calendar-gregorian-from-absolute date))))))))
 862
 863 (defun mark-included-diary-files ()
 864   "Mark the diary entries from other diary files with those of the diary file.
 865 This function is suitable for use as the `mark-diary-entries-hook'; it enables
 866 you to use shared diary files together with your own.  The files included are
 867 specified in the diary-file by lines of this form:
 868         #include \"filename\"
 869 This is recursive; that is, #include directives in diary files thus included
 870 are obeyed.  You can change the `#include' to some other string by
 871 changing the variable `diary-include-string'."
 872   (goto-char (point-min))
 873   (while (re-search-forward
 874           (concat
 875            "\\(\\`\\|\^M\\|\n\\)"
 876            (regexp-quote diary-include-string)
 877            " \"\\([^\"]*\\)\"")
 878           nil t)
 879     (let ((diary-file (substitute-in-file-name
 880                        (buffer-substring-no-properties
 881                         (match-beginning 2) (match-end 2))))
 882           (mark-diary-entries-hook 'mark-included-diary-files))
 883       (if (file-exists-p diary-file)
 884           (if (file-readable-p diary-file)
 885               (progn
 886                 (mark-diary-entries)
 887                 (kill-buffer (find-buffer-visiting diary-file)))
 888             (beep)
 889             (message "Can't read included diary file %s" diary-file)
 890             (sleep-for 2))
 891         (beep)
 892         (message "Can't find included diary file %s" diary-file)
 893         (sleep-for 2))))
 894   (goto-char (point-min)))
 895
 896 (defun mark-calendar-days-named (dayname)
 897   "Mark all dates in the calendar window that are day DAYNAME of the week.
 898 0 means all Sundays, 1 means all Mondays, and so on."
 899   (save-excursion
 900     (set-buffer calendar-buffer)
 901     (let ((prev-month displayed-month)
 902           (prev-year displayed-year)
 903           (succ-month displayed-month)
 904           (succ-year displayed-year)
 905           (last-day)
 906           (day))
 907       (increment-calendar-month succ-month succ-year 1)
 908       (increment-calendar-month prev-month prev-year -1)
 909       (setq day (calendar-absolute-from-gregorian
 910                  (calendar-nth-named-day 1 dayname prev-month prev-year)))
 911       (setq last-day (calendar-absolute-from-gregorian
 912                  (calendar-nth-named-day -1 dayname succ-month succ-year)))
 913       (while (<= day last-day)
 914         (mark-visible-calendar-date (calendar-gregorian-from-absolute day))
 915         (setq day (+ day 7))))))
 916
 917 (defun mark-calendar-date-pattern (month day year)
 918   "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
 919 A value of 0 in any position is a wildcard."
 920   (save-excursion
 921     (set-buffer calendar-buffer)
 922     (let ((m displayed-month)
 923           (y displayed-year))
 924       (increment-calendar-month m y -1)
 925       (calendar-for-loop i from 0 to 2 do
 926           (mark-calendar-month m y month day year)
 927           (increment-calendar-month m y 1)))))
 928
 929 (defun mark-calendar-month (month year p-month p-day p-year)
 930   "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P_DAY/P-YEAR.
 931 A value of 0 in any position of the pattern is a wildcard."
 932   (if (or (and (= month p-month)
 933                (or (= p-year 0) (= year p-year)))
 934           (and (= p-month 0)
 935                (or (= p-year 0) (= year p-year))))
 936       (if (= p-day 0)
 937           (calendar-for-loop
 938               i from 1 to (calendar-last-day-of-month month year) do
 939             (mark-visible-calendar-date (list month i year)))
 940         (mark-visible-calendar-date (list month p-day year)))))
 941
 942 (defun sort-diary-entries ()
 943   "Sort the list of diary entries by time of day."
 944   (setq diary-entries-list (sort diary-entries-list 'diary-entry-compare)))
 945
 946 (defun diary-entry-compare (e1 e2)
 947   "Returns t if E1 is earlier than E2."
 948   (or (calendar-date-compare e1 e2)
 949       (and (calendar-date-equal (car e1) (car e2))
 950            (let* ((ts1 (cadr e1)) (t1 (diary-entry-time ts1))
 951                   (ts2 (cadr e2)) (t2 (diary-entry-time ts2)))
 952              (or (< t1 t2)
 953                  (and (= t1 t2)
 954                       (string-lessp ts1 ts2)))))))
 955
 956 (defcustom diary-unknown-time
 957   -9999
 958   "*Value returned by diary-entry-time when no time is found.
 959 The default value -9999 causes entries with no recognizable time to be placed
 960 before those with times; 9999 would place entries with no recognizable time
 961 after those with times."
 962   :type 'integer
 963   :group 'diary
 964   :version "20.3")
 965
 966 (defun diary-entry-time (s)
 967   "Time at the beginning of the string S in a military-style integer.  For
 968 example, returns 1325 for 1:25pm.  Returns `diary-unknown-time' (default value
 969 -9999) if no time is recognized.  The recognized forms are XXXX, X:XX, or
 970 XX:XX (military time), and XXam, XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm,
 971 or XX:XXPM."
 972   (let ((case-fold-search nil))
 973     (cond ((string-match        ; Military time
 974             "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\):?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)" s)
 975            (+ (* 100 (string-to-int
 976                       (substring s (match-beginning 1) (match-end 1))))
 977               (string-to-int (substring s (match-beginning 2) (match-end 2)))))
 978           ((string-match        ; Hour only  XXam or XXpm
 979             "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s)
 980            (+ (* 100 (% (string-to-int
 981                            (substring s (match-beginning 1) (match-end 1)))
 982                           12))
 983               (if (equal ?a (downcase (aref s (match-beginning 2))))
 984                   0 1200)))
 985           ((string-match        ; Hour and minute  XX:XXam or XX:XXpm
 986             "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\):\\([0-9][0-9]\\)\\([ap]\\)m\\>" s)
 987            (+ (* 100 (% (string-to-int
 988                            (substring s (match-beginning 1) (match-end 1)))
 989                           12))
 990               (string-to-int (substring s (match-beginning 2) (match-end 2)))
 991               (if (equal ?a (downcase (aref s (match-beginning 3))))
 992                   0 1200)))
 993           (t diary-unknown-time)))) ; Unrecognizable
 994
 995 (defun list-sexp-diary-entries (date)
 996   "Add sexp entries for DATE from the diary file to `diary-entries-list'.
 997 Also, Make them visible in the diary file.  Returns t if any entries were
 998 found.
 999
1000 Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally
1001 `%%').  The form of a sexp diary entry is
1002
1003                   %%(SEXP) ENTRY
1004
1005 Both ENTRY and DATE are globally available when the SEXP is evaluated.  If the
1006 SEXP yields the value nil, the diary entry does not apply.  If it yields a
1007 non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a
1008 string, that string will be the diary entry in the fancy diary display.
1009
1010 For example, the following diary entry will apply to the 21st of the month
1011 if it is a weekday and the Friday before if the 21st is on a weekend:
1012
1013       &%%(let ((dayname (calendar-day-of-week date))
1014                (day (extract-calendar-day date)))
1015            (or
1016              (and (= day 21) (memq dayname '(1 2 3 4 5)))
1017              (and (memq day '(19 20)) (= dayname 5)))
1018          ) UIUC pay checks deposited
1019
1020 A number of built-in functions are available for this type of diary entry:
1021
1022       %%(diary-date MONTH DAY YEAR) text
1023                   Entry applies if date is MONTH, DAY, YEAR if
1024                   `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1025                   `european-calendar-style' is t.  DAY, MONTH, and YEAR
1026                   can be lists of integers, the constant t, or an integer.
1027                   The constant t means all values.
1028
1029       %%(diary-float MONTH DAYNAME N &optional DAY) text
1030                   Entry will appear on the Nth DAYNAME of MONTH.
1031                   (DAYNAME=0 means Sunday, 1 means Monday, and so on;
1032                   if N is negative it counts backward from the end of
1033                   the month.  MONTH can be a list of months, a single
1034                   month, or t to specify all months. Optional DAY means
1035                   Nth DAYNAME of MONTH on or after/before DAY.  DAY defaults
1036                   to 1 if N>0 and the last day of the month if N<0.
1037
1038       %%(diary-block M1 D1 Y1 M2 D2 Y2) text
1039                   Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
1040                   inclusive.  (If `european-calendar-style' is t, the
1041                   order of the parameters should be changed to D1, M1, Y1,
1042                   D2, M2, Y2.)
1043
1044       %%(diary-anniversary MONTH DAY YEAR) text
1045                   Entry will appear on anniversary dates of MONTH DAY, YEAR.
1046                   (If `european-calendar-style' is t, the order of the
1047                   parameters should be changed to DAY, MONTH, YEAR.)  Text
1048                   can contain %d or %d%s; %d will be replaced by the number
1049                   of years since the MONTH DAY, YEAR and %s will be replaced
1050                   by the ordinal ending of that number (that is, `st', `nd',
1051                   `rd' or `th', as appropriate.  The anniversary of February
1052                   29 is considered to be March 1 in a non-leap year.
1053
1054       %%(diary-cyclic N MONTH DAY YEAR) text
1055                   Entry will appear every N days, starting MONTH DAY, YEAR.
1056                   (If `european-calendar-style' is t, the order of the
1057                   parameters should be changed to N, DAY, MONTH, YEAR.)  Text
1058                   can contain %d or %d%s; %d will be replaced by the number
1059                   of repetitions since the MONTH DAY, YEAR and %s will
1060                   be replaced by the ordinal ending of that number (that is,
1061                   `st', `nd', `rd' or `th', as appropriate.
1062
1063       %%(diary-remind SEXP DAYS &optional MARKING) text
1064                   Entry is a reminder for diary sexp SEXP.  DAYS is either a
1065                   single number or a list of numbers indicating the number(s)
1066                   of days before the event that the warning(s) should occur.
1067                   If the current date is (one of) DAYS before the event
1068                   indicated by EXPR, then a suitable message (as specified
1069                   by `diary-remind-message') appears.  In addition to the
1070                   reminders beforehand, the diary entry also appears on
1071                   the date itself.  If optional MARKING is non-nil then the
1072                   *reminders* are marked on the calendar.  Marking of
1073                   reminders is independent of whether the entry *itself* is
1074                   a marking or nonmarking one.
1075
1076       %%(diary-day-of-year)
1077                   Diary entries giving the day of the year and the number of
1078                   days remaining in the year will be made every day.  Note
1079                   that since there is no text, it makes sense only if the
1080                   fancy diary display is used.
1081
1082       %%(diary-iso-date)
1083                   Diary entries giving the corresponding ISO commercial date
1084                   will be made every day.  Note that since there is no text,
1085                   it makes sense only if the fancy diary display is used.
1086
1087       %%(diary-french-date)
1088                   Diary entries giving the corresponding French Revolutionary
1089                   date will be made every day.  Note that since there is no
1090                   text, it makes sense only if the fancy diary display is used.
1091
1092       %%(diary-islamic-date)
1093                   Diary entries giving the corresponding Islamic date will be
1094                   made every day.  Note that since there is no text, it
1095                   makes sense only if the fancy diary display is used.
1096
1097       %%(diary-hebrew-date)
1098                   Diary entries giving the corresponding Hebrew date will be
1099                   made every day.  Note that since there is no text, it
1100                   makes sense only if the fancy diary display is used.
1101
1102       %%(diary-astro-day-number) Diary entries giving the corresponding
1103                   astronomical (Julian) day number will be made every day.
1104                   Note that since there is no text, it makes sense only if the
1105                   fancy diary display is used.
1106
1107       %%(diary-julian-date) Diary entries giving the corresponding
1108                  Julian date will be made every day.  Note that since
1109                  there is no text, it makes sense only if the fancy diary
1110                  display is used.
1111
1112       %%(diary-sunrise-sunset)
1113                   Diary entries giving the local times of sunrise and sunset
1114                   will be made every day.  Note that since there is no text,
1115                   it makes sense only if the fancy diary display is used.
1116                   Floating point required.
1117
1118       %%(diary-phases-of-moon)
1119                   Diary entries giving the times of the phases of the moon
1120                   will be when appropriate.  Note that since there is no text,
1121                   it makes sense only if the fancy diary display is used.
1122                   Floating point required.
1123
1124       %%(diary-yahrzeit MONTH DAY YEAR) text
1125                   Text is assumed to be the name of the person; the date is
1126                   the date of death on the *civil* calendar.  The diary entry
1127                   will appear on the proper Hebrew-date anniversary and on the
1128                   day before.  (If `european-calendar-style' is t, the order
1129                   of the parameters should be changed to DAY, MONTH, YEAR.)
1130
1131       %%(diary-rosh-hodesh)
1132                   Diary entries will be made on the dates of Rosh Hodesh on
1133                   the Hebrew calendar.  Note that since there is no text, it
1134                   makes sense only if the fancy diary display is used.
1135
1136       %%(diary-parasha)
1137                   Diary entries giving the weekly parasha will be made on
1138                   every Saturday.  Note that since there is no text, it
1139                   makes sense only if the fancy diary display is used.
1140
1141       %%(diary-omer)
1142                   Diary entries giving the omer count will be made every day
1143                   from Passover to Shavuot.  Note that since there is no text,
1144                   it makes sense only if the fancy diary display is used.
1145
1146 Marking these entries is *extremely* time consuming, so these entries are
1147 best if they are nonmarking."
1148   (let* ((mark (regexp-quote diary-nonmarking-symbol))
1149          (sexp-mark (regexp-quote sexp-diary-entry-symbol))
1150          (s-entry (concat "\\(\\`\\|\^M\\|\n\\)" mark "?" sexp-mark "("))
1151          (entry-found))
1152     (goto-char (point-min))
1153     (while (re-search-forward s-entry nil t)
1154       (backward-char 1)
1155       (let ((sexp-start (point))
1156             (sexp)
1157             (entry)
1158             (specifier)
1159             (entry-start)
1160             (line-start))
1161         (forward-sexp)
1162         (setq sexp (buffer-substring-no-properties sexp-start (point)))
1163         (save-excursion
1164           (re-search-backward "\^M\\|\n\\|\\`")
1165           (setq line-start (point)))
1166         (setq specifier
1167               (buffer-substring-no-properties (1+ line-start) (point)))
1168         (forward-char 1)
1169         (if (and (or (char-equal (preceding-char) ?\^M)
1170                      (char-equal (preceding-char) ?\n))
1171                  (not (looking-at " \\|\^I")))
1172             (progn;; Diary entry consists only of the sexp
1173               (backward-char 1)
1174               (setq entry ""))
1175           (setq entry-start (point))
1176           (re-search-forward "\^M\\|\n" nil t)
1177           (while (looking-at " \\|\^I")
1178             (re-search-forward "\^M\\|\n" nil t))
1179           (backward-char 1)
1180           (setq entry (buffer-substring-no-properties entry-start (point)))
1181           (while (string-match "[\^M]" entry)
1182             (aset entry (match-beginning 0) ?\n )))
1183         (let ((diary-entry (diary-sexp-entry sexp entry date)))
1184           (if diary-entry
1185               (subst-char-in-region line-start (point) ?\^M ?\n t))
1186           (add-to-diary-list date diary-entry specifier)
1187           (setq entry-found (or entry-found diary-entry)))))
1188     entry-found))
1189
1190 (defun diary-sexp-entry (sexp entry date)
1191   "Process a SEXP diary ENTRY for DATE."
1192   (let ((result (if calendar-debug-sexp
1193                     (let ((stack-trace-on-error t))
1194                       (eval (car (read-from-string sexp))))
1195                   (condition-case nil
1196                       (eval (car (read-from-string sexp)))
1197                     (error
1198                      (beep)
1199                      (message "Bad sexp at line %d in %s: %s"
1200                               (save-excursion
1201                                 (save-restriction
1202                                   (narrow-to-region 1 (point))
1203                                   (goto-char (point-min))
1204                                   (let ((lines 1))
1205                                     (while (re-search-forward "\n\\|\^M" nil t)
1206                                       (setq lines (1+ lines)))
1207                                     lines)))
1208                               diary-file sexp)
1209                      (sleep-for 2))))))
1210     (if (stringp result)
1211         result
1212       (if result
1213           entry
1214         nil))))
1215
1216 (defun diary-date (month day year)
1217   "Specific date(s) diary entry.
1218 Entry applies if date is MONTH, DAY, YEAR if `european-calendar-style' is nil,
1219 and DAY, MONTH, YEAR if `european-calendar-style' is t.  DAY, MONTH, and YEAR
1220 can be lists of integers, the constant t, or an integer.  The constant t means
1221 all values."
1222   (let* ((dd (if european-calendar-style
1223                 month
1224               day))
1225          (mm (if european-calendar-style
1226                 day
1227               month))
1228          (m (extract-calendar-month date))
1229          (y (extract-calendar-year date))
1230          (d (extract-calendar-day date)))
1231     (if (and
1232          (or (and (listp dd) (memq d dd))
1233              (equal d dd)
1234              (eq dd t))
1235          (or (and (listp mm) (memq m mm))
1236              (equal m mm)
1237              (eq mm t))
1238          (or (and (listp year) (memq y year))
1239              (equal y year)
1240              (eq year t)))
1241         entry)))
1242
1243 (defun diary-block (m1 d1 y1 m2 d2 y2)
1244   "Block diary entry.
1245 Entry applies if date is between, or on one of, two dates.
1246 The order of the parameters is
1247 M1, D1, Y1, M2, D2, Y2 if `european-calendar-style' is nil, and
1248 D1, M1, Y1, D2, M2, Y2 if `european-calendar-style' is t."
1249   (let ((date1 (calendar-absolute-from-gregorian
1250                 (if european-calendar-style
1251                     (list d1 m1 y1)
1252                   (list m1 d1 y1))))
1253         (date2 (calendar-absolute-from-gregorian
1254                 (if european-calendar-style
1255                     (list d2 m2 y2)
1256                   (list m2 d2 y2))))
1257         (d (calendar-absolute-from-gregorian date)))
1258     (if (and (<= date1 d) (<= d date2))
1259         entry)))
1260
1261 (defun diary-float (month dayname n &optional day)
1262   "Floating diary entry--entry applies if date is the nth dayname of month.
1263 Parameters are MONTH, DAYNAME, N.  MONTH can be a list of months, the constant
1264 t, or an integer.  The constant t means all months.  If N is negative, count
1265 backward from the end of the month.
1266
1267 An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY."
1268 ;; This is messy because the diary entry may apply, but the date on which it
1269 ;; is based can be in a different month/year.  For example, asking for the
1270 ;; first Monday after December 30.  For large values of |n| the problem is
1271 ;; more grotesque.
1272   (and (= dayname (calendar-day-of-week date))
1273        (let* ((m (extract-calendar-month date))
1274               (d (extract-calendar-day date))
1275               (y (extract-calendar-year date))
1276               (limit; last (n>0) or first (n<0) possible base date for entry
1277                (calendar-nth-named-absday (- n) dayname m y d))
1278               (last-abs (if (> n 0) limit (+ limit 6)))
1279               (first-abs (if (> n 0) (- limit 6) limit))
1280               (last (calendar-gregorian-from-absolute last-abs))
1281               (first (calendar-gregorian-from-absolute first-abs))
1282               ; m1, d1 is first possible base date
1283               (m1 (extract-calendar-month first))
1284               (d1 (extract-calendar-day first))
1285               (y1 (extract-calendar-year first))
1286               ; m2, d2 is last possible base date
1287               (m2 (extract-calendar-month last))
1288               (d2 (extract-calendar-day last))
1289               (y2 (extract-calendar-year last)))
1290          (if (or (and (= m1 m2) ; only possible base dates in one month
1291                       (or (eq month t)
1292                           (if (listp month)
1293                               (memq m1 month)
1294                             (= m1 month)))
1295                       (let ((d (or day (if (> n 0)
1296                                            1
1297                                          (calendar-last-day-of-month m1 y1)))))
1298                         (and (<= d1 d) (<= d d2))))
1299                  ;; only possible base dates straddle two months
1300                  (and (or (< y1 y2)
1301                           (and (= y1 y2) (< m1 m2)))
1302                       (or
1303                        ;; m1, d1 works as a base date
1304                        (and
1305                         (or (eq month t)
1306                             (if (listp month)
1307                                 (memq m1 month)
1308                               (= m1 month)))
1309                         (<= d1 (or day (if (> n 0)
1310                                            1
1311                                          (calendar-last-day-of-month m1 y1)))))
1312                        ;; m2, d2 works as a base date
1313                        (and (or (eq month t)
1314                                 (if (listp month)
1315                                     (memq m2 month)
1316                                   (= m2 month)))
1317                             (<= (or day (if (> n 0)
1318                                             1
1319                                           (calendar-last-day-of-month m2 y2)))
1320                                 d2)))))
1321              entry))))
1322
1323
1324 (defun diary-anniversary (month day year)
1325   "Anniversary diary entry.
1326 Entry applies if date is the anniversary of MONTH, DAY, YEAR if
1327 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1328 `european-calendar-style' is t.  Diary entry can contain `%d' or `%d%s'; the
1329 %d will be replaced by the number of years since the MONTH DAY, YEAR and the
1330 %s will be replaced by the ordinal ending of that number (that is, `st', `nd',
1331 `rd' or `th', as appropriate.  The anniversary of February 29 is considered
1332 to be March 1 in non-leap years."
1333   (let* ((d (if european-calendar-style
1334                 month
1335               day))
1336          (m (if european-calendar-style
1337                 day
1338               month))
1339          (y (extract-calendar-year date))
1340          (diff (- y year)))
1341     (if (and (= m 2) (= d 29) (not (calendar-leap-year-p y)))
1342         (setq m 3
1343               d 1))
1344     (if (and (> diff 0) (calendar-date-equal (list m d y) date))
1345         (format entry diff (diary-ordinal-suffix diff)))))
1346
1347 (defun diary-cyclic (n month day year)
1348   "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
1349 If `european-calendar-style' is t, parameters are N, DAY, MONTH, YEAR.
1350 ENTRY can contain `%d' or `%d%s'; the %d will be replaced by the number of
1351 repetitions since the MONTH DAY, YEAR and %s will be replaced by the
1352 ordinal ending of that number (that is, `st', `nd', `rd' or `th', as
1353 appropriate."
1354   (let* ((d (if european-calendar-style
1355                 month
1356               day))
1357          (m (if european-calendar-style
1358                 day
1359               month))
1360          (diff (- (calendar-absolute-from-gregorian date)
1361                   (calendar-absolute-from-gregorian
1362                    (list m d year))))
1363          (cycle (/ diff n)))
1364     (if (and (>= diff 0) (zerop (% diff n)))
1365         (format entry cycle (diary-ordinal-suffix cycle)))))
1366
1367 (defun diary-ordinal-suffix (n)
1368   "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
1369   (if (or (memq (% n 100) '(11 12 13))
1370           (< 3 (% n 10)))
1371       "th"
1372     (aref ["th" "st" "nd" "rd"] (% n 10))))
1373
1374 (defun diary-day-of-year ()
1375   "Day of year and number of days remaining in the year of date diary entry."
1376   (calendar-day-of-year-string date))
1377
1378 (defcustom diary-remind-message
1379   '("Reminder: Only "
1380     (if (= 0 (% days 7))
1381         (concat (int-to-string (/ days 7)) (if (= 7 days) " week" " weeks"))
1382       (concat (int-to-string days) (if (= 1 days) " day" " days")))
1383     " until "
1384     diary-entry)
1385   "*Pseudo-pattern giving form of reminder messages in the fancy diary
1386 display.
1387
1388 Used by the function `diary-remind', a pseudo-pattern is a list of
1389 expressions that can involve the keywords `days' (a number), `date' (a list of
1390 month, day, year), and `diary-entry' (a string)."
1391   :type 'sexp
1392   :group 'diary)
1393
1394 (defun diary-remind (sexp days &optional marking)
1395   "Provide a reminder of a diary entry.
1396 SEXP is a diary-sexp.  DAYS is either a single number or a list of numbers
1397 indicating the number(s) of days before the event that the warning(s) should
1398 occur on.  If the current date is (one of) DAYS before the event indicated by
1399 SEXP, then a suitable message (as specified by `diary-remind-message' is
1400 returned.
1401
1402 In addition to the reminders beforehand, the diary entry also appears on the
1403 date itself.
1404
1405 A `diary-nonmarking-symbol' at the beginning of the line of the diary-remind
1406 entry specifies that the diary entry (not the reminder) is non-marking.
1407 Marking of reminders is independent of whether the entry itself is a marking
1408 or nonmarking; if optional parameter MARKING is non-nil then the reminders are
1409 marked on the calendar."
1410   (let ((diary-entry (eval sexp)))
1411     (cond
1412      ;; Diary entry applies on date
1413      ((and diary-entry
1414            (or (not marking-diary-entries) marking-diary-entry))
1415       diary-entry)
1416      ;; Diary entry may apply to `days' before date
1417      ((and (integerp days)
1418            (not diary-entry); Diary entry does not apply to date
1419            (or (not marking-diary-entries) marking))
1420       (let ((date (calendar-gregorian-from-absolute
1421                    (+ (calendar-absolute-from-gregorian date) days))))
1422         (if (setq diary-entry (eval sexp))
1423             (mapconcat 'eval diary-remind-message ""))))
1424      ;; Diary entry may apply to one of a list of days before date
1425      ((and (listp days) days)
1426       (or (diary-remind sexp (car days) marking)
1427           (diary-remind sexp (cdr days) marking))))))
1428
1429 (defun add-to-diary-list (date string specifier)
1430   "Add the entry (DATE STRING SPECIFIER) to `diary-entries-list'.
1431 Do nothing if DATE or STRING is nil."
1432   (and date string
1433        (setq diary-entries-list
1434              (append diary-entries-list (list (list date string specifier))))))
1435
1436 (defun make-diary-entry (string &optional nonmarking file)
1437   "Insert a diary entry STRING which may be NONMARKING in FILE.
1438 If omitted, NONMARKING defaults to nil and FILE defaults to diary-file."
1439   (find-file-other-window
1440    (substitute-in-file-name (if file file diary-file)))
1441   (goto-char (point-max))
1442   (insert
1443    (if (bolp) "" "\n")
1444    (if nonmarking diary-nonmarking-symbol "")
1445    string " "))
1446
1447 (defun insert-diary-entry (arg)
1448   "Insert a diary entry for the date indicated by point.
1449 Prefix arg will make the entry nonmarking."
1450   (interactive "P")
1451   (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t t)
1452                     arg))
1453
1454 (defun insert-weekly-diary-entry (arg)
1455   "Insert a weekly diary entry for the day of the week indicated by point.
1456 Prefix arg will make the entry nonmarking."
1457   (interactive "P")
1458   (make-diary-entry (calendar-day-name (calendar-cursor-to-date t))
1459                     arg))
1460
1461 (defun insert-monthly-diary-entry (arg)
1462   "Insert a monthly diary entry for the day of the month indicated by point.
1463 Prefix arg will make the entry nonmarking."
1464   (interactive "P")
1465   (let* ((calendar-date-display-form
1466           (if european-calendar-style
1467               '(day " * ")
1468             '("* " day))))
1469     (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
1470                       arg)))
1471
1472 (defun insert-yearly-diary-entry (arg)
1473   "Insert an annual diary entry for the day of the year indicated by point.
1474 Prefix arg will make the entry nonmarking."
1475   (interactive "P")
1476   (let* ((calendar-date-display-form
1477           (if european-calendar-style
1478               '(day " " monthname)
1479             '(monthname " " day))))
1480     (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
1481                       arg)))
1482
1483 (defun insert-anniversary-diary-entry (arg)
1484   "Insert an anniversary diary entry for the date given by point.
1485 Prefix arg will make the entry nonmarking."
1486   (interactive "P")
1487   (let* ((calendar-date-display-form
1488           (if european-calendar-style
1489               '(day " " month " " year)
1490             '(month " " day " " year))))
1491     (make-diary-entry
1492      (format "%s(diary-anniversary %s)"
1493              sexp-diary-entry-symbol
1494              (calendar-date-string (calendar-cursor-to-date t) nil t))
1495      arg)))
1496
1497 (defun insert-block-diary-entry (arg)
1498   "Insert a block diary entry for the days between the point and marked date.
1499 Prefix arg will make the entry nonmarking."
1500   (interactive "P")
1501   (let* ((calendar-date-display-form
1502           (if european-calendar-style
1503               '(day " " month " " year)
1504             '(month " " day " " year)))
1505          (cursor (calendar-cursor-to-date t))
1506          (mark (or (car calendar-mark-ring)
1507                    (error "No mark set in this buffer")))
1508          (start)
1509          (end))
1510     (if (< (calendar-absolute-from-gregorian mark)
1511            (calendar-absolute-from-gregorian cursor))
1512         (setq start mark
1513               end cursor)
1514       (setq start cursor
1515               end mark))
1516     (make-diary-entry
1517      (format "%s(diary-block %s %s)"
1518       sexp-diary-entry-symbol
1519       (calendar-date-string start nil t)
1520       (calendar-date-string end nil t))
1521      arg)))
1522
1523 (defun insert-cyclic-diary-entry (arg)
1524   "Insert a cyclic diary entry starting at the date given by point.
1525 Prefix arg will make the entry nonmarking."
1526   (interactive "P")
1527   (let* ((calendar-date-display-form
1528           (if european-calendar-style
1529               '(day " " month " " year)
1530             '(month " " day " " year))))
1531     (make-diary-entry
1532      (format "%s(diary-cyclic %d %s)"
1533              sexp-diary-entry-symbol
1534              (calendar-read "Repeat every how many days: "
1535                             (lambda (x) (> x 0)))
1536              (calendar-date-string (calendar-cursor-to-date t) nil t))
1537      arg)))
1538
1539 (provide 'diary-lib)
1540
1541 ;;; diary-lib.el ends here