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