code.delx.au - gnu-emacs/blob - lisp/calendar/diary-lib.el

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