diary-lib.el 86.8 KB
Newer Older
1
;;; diary-lib.el --- diary functions
Edward M. Reingold's avatar
Edward M. Reingold committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995, 2003, 2004
4
;;           Free Software Foundation, Inc.
Edward M. Reingold's avatar
Edward M. Reingold committed
5 6

;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
Glenn Morris's avatar
Glenn Morris committed
7
;; Maintainer: Glenn Morris <gmorris@ast.cam.ac.uk>
Edward M. Reingold's avatar
Edward M. Reingold committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
;; Keywords: calendar

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
23 24 25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Edward M. Reingold's avatar
Edward M. Reingold committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

;;; Commentary:

;; This collection of functions implements the diary features as described
;; in calendar.el.

;; Comments, corrections, and improvements should be sent to
;;  Edward M. Reingold               Department of Computer Science
;;  (217) 333-6733                   University of Illinois at Urbana-Champaign
;;  reingold@cs.uiuc.edu             1304 West Springfield Avenue
;;                                   Urbana, Illinois 61801

;;; Code:

(require 'calendar)

42 43 44 45 46 47 48 49 50 51
(defun diary-check-diary-file ()
  "Check that the file specified by `diary-file' exists and is readable.
If so, return the expanded file name, otherwise signal an error."
  (let ((d-file (substitute-in-file-name diary-file)))
    (if (and d-file (file-exists-p d-file))
        (if (file-readable-p d-file)
            d-file
          (error "Diary file `%s' is not readable" diary-file))
      (error "Diary file `%s' does not exist" diary-file))))

Edward M. Reingold's avatar
Edward M. Reingold committed
52 53 54 55
;;;###autoload
(defun diary (&optional arg)
  "Generate the diary window for ARG days starting with the current date.
If no argument is provided, the number of days of diary entries is governed
Glenn Morris's avatar
Glenn Morris committed
56 57
by the variable `number-of-diary-entries'.  A value of ARG less than 1
does nothing.  This function is suitable for execution in a `.emacs' file."
Edward M. Reingold's avatar
Edward M. Reingold committed
58
  (interactive "P")
59 60 61 62 63 64 65 66
  (diary-check-diary-file)
  (let ((date (calendar-current-date)))
    (list-diary-entries
     date
     (cond (arg (prefix-numeric-value arg))
           ((vectorp number-of-diary-entries)
            (aref number-of-diary-entries (calendar-day-of-week date)))
           (t number-of-diary-entries)))))
Edward M. Reingold's avatar
Edward M. Reingold committed
67 68 69 70 71 72 73

(defun view-diary-entries (arg)
  "Prepare and display a buffer with diary entries.
Searches the file named in `diary-file' for entries that
match ARG days starting with the date indicated by the cursor position
in the displayed three-month calendar."
  (interactive "p")
74 75
  (diary-check-diary-file)
  (list-diary-entries (calendar-cursor-to-date t) arg))
Edward M. Reingold's avatar
Edward M. Reingold committed
76

77
(defun view-other-diary-entries (arg d-file)
Edward M. Reingold's avatar
Edward M. Reingold committed
78
  "Prepare and display buffer of diary entries from an alternative diary file.
79 80 81
Searches for entries that match ARG days, starting with the date indicated
by the cursor position in the displayed three-month calendar.
D-FILE specifies the file to use as the diary file."
Edward M. Reingold's avatar
Edward M. Reingold committed
82
  (interactive
83
   (list (prefix-numeric-value current-prefix-arg)
84 85 86
         (read-file-name "Enter diary file name: " default-directory nil t)))
  (let ((diary-file d-file))
    (view-diary-entries arg)))
Edward M. Reingold's avatar
Edward M. Reingold committed
87 88 89 90

(autoload 'check-calendar-holidays "holidays"
  "Check the list of holidays for any that occur on DATE.
The value returned is a list of strings of relevant holiday descriptions.
91
The holidays are those in the list `calendar-holidays'.")
Edward M. Reingold's avatar
Edward M. Reingold committed
92 93 94

(autoload 'calendar-holiday-list "holidays"
  "Form the list of holidays that occur on dates in the calendar window.
95
The holidays are those in the list `calendar-holidays'.")
Edward M. Reingold's avatar
Edward M. Reingold committed
96 97

(autoload 'diary-french-date "cal-french"
98
  "French calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
99 100

(autoload 'diary-mayan-date "cal-mayan"
101
  "Mayan calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
102

Edward M. Reingold's avatar
Edward M. Reingold committed
103
(autoload 'diary-iso-date "cal-iso"
104
  "ISO calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
105

Edward M. Reingold's avatar
Edward M. Reingold committed
106
(autoload 'diary-julian-date "cal-julian"
107
  "Julian calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
108 109

(autoload 'diary-astro-day-number "cal-julian"
110
  "Astronomical (Julian) day number diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
111

112
(autoload 'diary-chinese-date "cal-china"
113
  "Chinese calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
114

115
(autoload 'diary-islamic-date "cal-islam"
116
  "Islamic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
117

118
(autoload 'list-islamic-diary-entries "cal-islam"
119
  "Add any Islamic date entries from the diary file to `diary-entries-list'.")
Edward M. Reingold's avatar
Edward M. Reingold committed
120

121
(autoload 'mark-islamic-diary-entries "cal-islam"
122
  "Mark days in the calendar window that have Islamic date diary entries.")
Edward M. Reingold's avatar
Edward M. Reingold committed
123

124
(autoload 'mark-islamic-calendar-date-pattern "cal-islam"
125
   "Mark dates in calendar window that conform to Islamic date MONTH/DAY/YEAR.")
Edward M. Reingold's avatar
Edward M. Reingold committed
126

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
(autoload 'diary-bahai-date "cal-bahai"
  "Baha'i calendar equivalent of date diary entry."
  t)

(autoload 'list-bahai-diary-entries "cal-bahai"
  "Add any Baha'i date entries from the diary file to `diary-entries-list'."
  t)

(autoload 'mark-bahai-diary-entries "cal-bahai"
  "Mark days in the calendar window that have Baha'i date diary entries."
  t)

(autoload 'mark-bahai-calendar-date-pattern "cal-bahai"
   "Mark dates in calendar window that conform to Baha'i date MONTH/DAY/YEAR."
  t)

Edward M. Reingold's avatar
Edward M. Reingold committed
143
(autoload 'diary-hebrew-date "cal-hebrew"
144
  "Hebrew calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
145 146

(autoload 'diary-omer "cal-hebrew"
147
  "Omer count diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
148 149

(autoload 'diary-yahrzeit "cal-hebrew"
150
  "Yahrzeit diary entry--entry applies if date is yahrzeit or the day before.")
Edward M. Reingold's avatar
Edward M. Reingold committed
151 152

(autoload 'diary-parasha "cal-hebrew"
153
  "Parasha diary entry--entry applies if date is a Saturday.")
Edward M. Reingold's avatar
Edward M. Reingold committed
154 155

(autoload 'diary-rosh-hodesh "cal-hebrew"
156
  "Rosh Hodesh diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
157 158

(autoload 'list-hebrew-diary-entries "cal-hebrew"
159
  "Add any Hebrew date entries from the diary file to `diary-entries-list'.")
Edward M. Reingold's avatar
Edward M. Reingold committed
160 161

(autoload 'mark-hebrew-diary-entries "cal-hebrew"
162
  "Mark days in the calendar window that have Hebrew date diary entries.")
Edward M. Reingold's avatar
Edward M. Reingold committed
163 164

(autoload 'mark-hebrew-calendar-date-pattern "cal-hebrew"
165
   "Mark dates in calendar window that conform to Hebrew date MONTH/DAY/YEAR.")
Edward M. Reingold's avatar
Edward M. Reingold committed
166 167

(autoload 'diary-coptic-date "cal-coptic"
168
  "Coptic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
169 170

(autoload 'diary-ethiopic-date "cal-coptic"
171
  "Ethiopic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
172

173
(autoload 'diary-persian-date "cal-persia"
174
  "Persian calendar equivalent of date diary entry.")
175

176
(autoload 'diary-phases-of-moon "lunar" "Moon phases diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
177 178

(autoload 'diary-sunrise-sunset "solar"
179
  "Local time of sunrise and sunset as a diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
180 181 182

(autoload 'diary-sabbath-candles "solar"
  "Local time of candle lighting diary entry--applies if date is a Friday.
183
No diary entry if there is no sunset on that date.")
Edward M. Reingold's avatar
Edward M. Reingold committed
184 185 186 187

(defvar diary-syntax-table (copy-syntax-table (standard-syntax-table))
  "The syntax table used when parsing dates in the diary file.
It is the standard syntax table used in Fundamental mode, but with the
188
syntax of `*' and `:' changed to be word constituents.")
Edward M. Reingold's avatar
Edward M. Reingold committed
189 190

(modify-syntax-entry ?* "w" diary-syntax-table)
191
(modify-syntax-entry ?: "w" diary-syntax-table)
Edward M. Reingold's avatar
Edward M. Reingold committed
192

193 194 195 196 197 198 199 200 201
(defvar diary-entries-list)
(defvar displayed-year)
(defvar displayed-month)
(defvar entry)
(defvar date)
(defvar number)
(defvar date-string)
(defvar original-date)

202
(defun diary-attrtype-convert (attrvalue type)
203 204
  "Convert string ATTRVALUE to TYPE appropriate for a face description.
Valid TYPEs are: string, symbol, int, stringtnil, tnil."
205 206 207 208 209 210 211 212 213 214 215 216 217
  (let (ret)
    (setq ret (cond ((eq type 'string) attrvalue)
		    ((eq type 'symbol) (read attrvalue))
		    ((eq type 'int) (string-to-int attrvalue))
		    ((eq type 'stringtnil)
		     (cond ((string= "t" attrvalue) t)
			   ((string= "nil" attrvalue) nil)
			   (t attrvalue)))
		    ((eq type 'tnil)
		     (cond ((string= "t" attrvalue) t)
			   ((string= "nil" attrvalue) nil)))))
;    (message "(%s)[%s]=[%s]" (print type) attrvalue ret)
    ret))
218

219 220

(defun diary-pull-attrs (entry fileglobattrs)
221 222 223
  "Pull the face-related attributes off the entry, merge with the
fileglobattrs, and return the (possibly modified) entry and face
data in a list of attrname attrvalue values.
224
The entry will be modified to drop all tags that are used for face matching.
225 226 227
If entry is nil, then the fileglobattrs are being searched for,
the fileglobattrs variable is ignored, and
diary-glob-file-regexp-prefix is prepended to the regexps before each
228 229
search."
  (save-excursion
230 231
    (let (regexp regnum attrname attr-list attrname attrvalue type
                 ret-attr attr)
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
      (if (null entry)
	  (progn
	    (setq ret-attr '()
		  attr-list diary-face-attrs)
	    (while attr-list
	      (goto-char (point-min))
	      (setq attr (car attr-list)
		    regexp (nth 0 attr)
		    regnum (nth 1 attr)
		    attrname (nth 2 attr)
		    type (nth 3 attr)
		    regexp (concat diary-glob-file-regexp-prefix regexp))
	      (setq attrvalue nil)
	      (if (re-search-forward regexp (point-max) t)
		  (setq attrvalue (buffer-substring-no-properties
				   (match-beginning regnum)
				   (match-end regnum))))
	      (if (and attrvalue
		       (setq attrvalue (diary-attrtype-convert attrvalue type)))
		  (setq ret-attr (append ret-attr (list attrname attrvalue))))
	      (setq attr-list (cdr attr-list)))
	    (setq fileglobattrs ret-attr))
	(progn
	  (setq ret-attr fileglobattrs
		attr-list diary-face-attrs)
	  (while attr-list
	    (goto-char (point-min))
	    (setq attr (car attr-list)
		  regexp (nth 0 attr)
		  regnum (nth 1 attr)
		  attrname (nth 2 attr)
		  type (nth 3 attr))
	    (setq attrvalue nil)
	    (if (string-match regexp entry)
266
		(progn
267 268 269 270 271 272 273
		  (setq attrvalue (substring-no-properties entry
							   (match-beginning regnum)
							   (match-end regnum)))
		  (setq entry (replace-match "" t t entry))))
	    (if (and attrvalue
		     (setq attrvalue (diary-attrtype-convert attrvalue type)))
		(setq ret-attr (append ret-attr (list attrname attrvalue))))
274 275
	    (setq attr-list (cdr attr-list)))))
      (list entry ret-attr))))
276 277


278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
;; This can be removed once the kill/yank treatment of invisible text
;; (see etc/TODO) is fixed. -- gm
(defcustom diary-header-line-flag t
  "*If non-nil, `simple-diary-display' will show a header line.
The format of the header is specified by `diary-header-line-format'."
  :group   'diary
  :type    'boolean
  :version "21.4")

(defcustom diary-header-line-format
  '(:eval (calendar-string-spread
           (list (if selective-display
                     "Selective display active - press \"s\" in calendar \
before edit/copy"
                   "Diary"))
           ?\ (frame-width)))
  "*Format of the header line displayed by `simple-diary-display'.
Only used if `diary-header-line-flag' is non-nil."
  :group   'diary
  :type    'sexp
  :version "21.4")
299

Glenn Morris's avatar
Glenn Morris committed
300 301
(defvar diary-saved-point)		; internal

Edward M. Reingold's avatar
Edward M. Reingold committed
302 303 304 305
(defun list-diary-entries (date number)
  "Create and display a buffer containing the relevant lines in diary-file.
The arguments are DATE and NUMBER; the entries selected are those
for NUMBER days starting with date DATE.  The other entries are hidden
Glenn Morris's avatar
Glenn Morris committed
306
using selective display.  If NUMBER is less than 1, this function does nothing.
Edward M. Reingold's avatar
Edward M. Reingold committed
307 308

Returns a list of all relevant diary entries found, if any, in order by date.
309 310 311 312 313
The list entries have the form ((month day year) string specifier) where
\(month day year) is the date of the entry, string is the entry text, and
specifier is the applicability.  If the variable `diary-list-include-blanks'
is t, this list includes a dummy diary entry consisting of the empty string)
for a date with no diary entries.
Edward M. Reingold's avatar
Edward M. Reingold committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335

After the list is prepared, the hooks `nongregorian-diary-listing-hook',
`list-diary-entries-hook', `diary-display-hook', and `diary-hook' are run.
These hooks have the following distinct roles:

    `nongregorian-diary-listing-hook' can cull dates from the diary
        and each included file.  Usually used for Hebrew or Islamic
        diary entries in files.  Applied to *each* file.

    `list-diary-entries-hook' adds or manipulates diary entries from
        external sources.  Used, for example, to include diary entries
        from other files or to sort the diary entries.  Invoked *once* only,
        before the display hook is run.

    `diary-display-hook' does the actual display of information.  If this is
        nil, simple-diary-display will be used.  Use add-hook to set this to
        fancy-diary-display, if desired.  If you want no diary display, use
        add-hook to set this to ignore.

    `diary-hook' is run last.  This can be used for an appointment
        notification function."

Glenn Morris's avatar
Glenn Morris committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
  (when (> number 0)
    (let ((original-date date);; save for possible use in the hooks
          old-diary-syntax-table
          diary-entries-list
          file-glob-attrs
          (date-string (calendar-date-string date))
          (d-file (substitute-in-file-name diary-file)))
      (message "Preparing diary...")
      (save-excursion
        (let ((diary-buffer (find-buffer-visiting d-file)))
          (if (not diary-buffer)
              (set-buffer (find-file-noselect d-file t))
            (set-buffer diary-buffer)
            (or (verify-visited-file-modtime diary-buffer)
                (revert-buffer t t))))
Glenn Morris's avatar
Glenn Morris committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
        ;; d-s-p is passed to the diary display function.
        (let ((diary-saved-point (point)))
          (save-excursion
            (setq file-glob-attrs (nth 1 (diary-pull-attrs nil "")))
            (setq selective-display t)
            (setq selective-display-ellipses nil)
            (if diary-header-line-flag
                (setq header-line-format diary-header-line-format))
            (setq old-diary-syntax-table (syntax-table))
            (set-syntax-table diary-syntax-table)
            (unwind-protect
                (let ((buffer-read-only nil)
                      (diary-modified (buffer-modified-p))
                      (mark (regexp-quote diary-nonmarking-symbol)))
                  ;; First and last characters must be ^M or \n for
                  ;; selective display to work properly
                  (goto-char (1- (point-max)))
                  (if (not (looking-at "\^M\\|\n"))
                      (progn
                        (goto-char (point-max))
                        (insert "\^M")))
                  (goto-char (point-min))
                  (if (not (looking-at "\^M\\|\n"))
                      (insert "\^M"))
                  (subst-char-in-region (point-min) (point-max) ?\n ?\^M t)
                  (calendar-for-loop
                   i from 1 to number do
                   (let ((d diary-date-forms)
                         (month (extract-calendar-month date))
                         (day (extract-calendar-day date))
                         (year (extract-calendar-year date))
                         (entry-found (list-sexp-diary-entries date)))
                     (while d
                       (let*
                           ((date-form (if (equal (car (car d)) 'backup)
                                           (cdr (car d))
                                         (car d)))
                            (backup (equal (car (car d)) 'backup))
                            (dayname
                             (format "%s\\|%s\\.?"
                                     (calendar-day-name date)
                                     (calendar-day-name date 'abbrev)))
                            (monthname
                             (format "\\*\\|%s\\|%s\\.?"
                                     (calendar-month-name month)
                                     (calendar-month-name month 'abbrev)))
                            (month (concat "\\*\\|0*" (int-to-string month)))
                            (day (concat "\\*\\|0*" (int-to-string day)))
                            (year
                             (concat
                              "\\*\\|0*" (int-to-string year)
                              (if abbreviated-calendar-year
                                  (concat "\\|" (format "%02d" (% year 100)))
                                "")))
                            (regexp
                             (concat
                              "\\(\\`\\|\^M\\|\n\\)" mark "?\\("
                              (mapconcat 'eval date-form "\\)\\(")
                              "\\)"))
                            (case-fold-search t))
                         (goto-char (point-min))
                         (while (re-search-forward regexp nil t)
                           (if backup (re-search-backward "\\<" nil t))
                           (if (and (or (char-equal (preceding-char) ?\^M)
                                        (char-equal (preceding-char) ?\n))
                                    (not (looking-at " \\|\^I")))
                               ;;  Diary entry that consists only of date.
                               (backward-char 1)
                             ;; Found a nonempty diary entry--make it
                             ;; visible and add it to the list.
                             (setq entry-found t)
                             (let ((entry-start (point))
                                   date-start temp)
                               (re-search-backward "\^M\\|\n\\|\\`")
                               (setq date-start (point))
                               (re-search-forward "\^M\\|\n" nil t 2)
                               (while (looking-at " \\|\^I")
                                 (re-search-forward "\^M\\|\n" nil t))
                               (backward-char 1)
                               (subst-char-in-region date-start
                                                     (point) ?\^M ?\n t)
                               (setq entry (buffer-substring entry-start (point))
                                     temp (diary-pull-attrs entry file-glob-attrs)
                                     entry (nth 0 temp))
                               (add-to-diary-list
                                date
                                entry
                                (buffer-substring
                                 (1+ date-start) (1- entry-start))
                                (copy-marker entry-start) (nth 1 temp))))))
                       (setq d (cdr d)))
                     (or entry-found
                         (not diary-list-include-blanks)
                         (setq diary-entries-list
                               (append diary-entries-list
                                       (list (list date "" "" "" "")))))
                     (setq date
                           (calendar-gregorian-from-absolute
                            (1+ (calendar-absolute-from-gregorian date))))
                     (setq entry-found nil)))
                  (set-buffer-modified-p diary-modified))
              (set-syntax-table old-diary-syntax-table))
            (goto-char (point-min))
            (run-hooks 'nongregorian-diary-listing-hook
                       'list-diary-entries-hook)
            (if diary-display-hook
                (run-hooks 'diary-display-hook)
              (simple-diary-display))
            (run-hooks 'diary-hook)
            diary-entries-list))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477

(defun include-other-diary-files ()
  "Include the diary entries from other diary files with those of diary-file.
This function is suitable for use in `list-diary-entries-hook';
it enables you to use shared diary files together with your own.
The files included are specified in the diaryfile by lines of this form:
        #include \"filename\"
This is recursive; that is, #include directives in diary files thus included
are obeyed.  You can change the `#include' to some other string by
changing the variable `diary-include-string'."
  (goto-char (point-min))
  (while (re-search-forward
          (concat
           "\\(\\`\\|\^M\\|\n\\)"
           (regexp-quote diary-include-string)
           " \"\\([^\"]*\\)\"")
          nil t)
478 479 480 481 482 483 484 485 486 487 488 489
    (let* ((diary-file (substitute-in-file-name
                        (buffer-substring-no-properties
                         (match-beginning 2) (match-end 2))))
           (diary-list-include-blanks nil)
           (list-diary-entries-hook 'include-other-diary-files)
           (diary-display-hook 'ignore)
           (diary-hook nil)
           (d-buffer (find-buffer-visiting diary-file))
           (diary-modified (if d-buffer
                               (save-excursion
                                 (set-buffer d-buffer)
                                 (buffer-modified-p)))))
Edward M. Reingold's avatar
Edward M. Reingold committed
490 491 492 493 494 495
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
              (unwind-protect
                  (setq diary-entries-list
                        (append diary-entries-list
                                (list-diary-entries original-date number)))
496 497
                (save-excursion
                  (set-buffer (find-buffer-visiting diary-file))
498 499
		  (let ((inhibit-read-only t))
		    (subst-char-in-region (point-min) (point-max) ?\^M ?\n t))
500 501
                  (setq selective-display nil)
                  (set-buffer-modified-p diary-modified)))
Edward M. Reingold's avatar
Edward M. Reingold committed
502 503 504 505 506 507 508 509 510 511 512 513
            (beep)
            (message "Can't read included diary file %s" diary-file)
            (sleep-for 2))
        (beep)
        (message "Can't find included diary file %s" diary-file)
        (sleep-for 2))))
    (goto-char (point-min)))

(defun simple-diary-display ()
  "Display the diary buffer if there are any relevant entries or holidays."
  (let* ((holiday-list (if holidays-in-diary-buffer
                           (check-calendar-holidays original-date)))
514 515 516 517 518 519 520 521 522
         (hol-string (format "%s%s%s"
                             date-string
                             (if holiday-list ": " "")
                             (mapconcat 'identity holiday-list "; ")))
         (msg (format "No diary entries for %s" hol-string))
         ;; If selected window is dedicated (to the calendar),
         ;; need a new one to display the diary.
         (pop-up-frames (window-dedicated-p (selected-window))))
    (calendar-set-mode-line (format "Diary for %s" hol-string))
Edward M. Reingold's avatar
Edward M. Reingold committed
523 524 525
    (if (or (not diary-entries-list)
            (and (not (cdr diary-entries-list))
                 (string-equal (car (cdr (car diary-entries-list))) "")))
526
        (if (< (length msg) (frame-width))
527
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
528 529 530 531 532 533 534 535 536 537
          (set-buffer (get-buffer-create holiday-buffer))
          (setq buffer-read-only nil)
          (calendar-set-mode-line date-string)
          (erase-buffer)
          (insert (mapconcat 'identity holiday-list "\n"))
          (goto-char (point-min))
          (set-buffer-modified-p nil)
          (setq buffer-read-only t)
          (display-buffer holiday-buffer)
          (message  "No diary entries for %s" date-string))
Glenn Morris's avatar
Glenn Morris committed
538 539 540 541 542 543
      (with-current-buffer
          (find-buffer-visiting (substitute-in-file-name diary-file))
        (let ((window (display-buffer (current-buffer))))
          ;; d-s-p is passed from list-diary-entries.
          (set-window-point window diary-saved-point)
          (set-window-start window (point-min))))
Edward M. Reingold's avatar
Edward M. Reingold committed
544 545
      (message "Preparing diary...done"))))

546 547
(defface diary-button-face '((((type pc) (class color))
		   (:foreground "lightblue")))
548 549 550
  "Default face used for buttons."
  :version "21.4"
  :group 'diary)
551 552 553 554 555 556 557 558 559 560 561

(define-button-type 'diary-entry
  'action #'diary-goto-entry
  'face #'diary-button-face)

(defun diary-goto-entry (button)
  (let ((marker (button-get button 'marker)))
    (when marker
      (pop-to-buffer (marker-buffer marker))
      (goto-char (marker-position marker)))))

Edward M. Reingold's avatar
Edward M. Reingold committed
562 563 564 565
(defun fancy-diary-display ()
  "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
This function is provided for optional use as the `diary-display-hook'."
  (save-excursion;; Turn off selective-display in the diary file's buffer.
566
    (set-buffer (find-buffer-visiting (substitute-in-file-name diary-file)))
Edward M. Reingold's avatar
Edward M. Reingold committed
567 568 569 570 571 572 573 574 575 576 577 578 579 580
    (let ((diary-modified (buffer-modified-p)))
      (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
      (setq selective-display nil)
      (kill-local-variable 'mode-line-format)
      (set-buffer-modified-p diary-modified)))
  (if (or (not diary-entries-list)
          (and (not (cdr diary-entries-list))
               (string-equal (car (cdr (car diary-entries-list))) "")))
      (let* ((holiday-list (if holidays-in-diary-buffer
                               (check-calendar-holidays original-date)))
             (msg (format "No diary entries for %s %s"
                          (concat date-string (if holiday-list ":" ""))
                          (mapconcat 'identity holiday-list "; "))))
        (if (<= (length msg) (frame-width))
581
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
          (set-buffer (get-buffer-create holiday-buffer))
          (setq buffer-read-only nil)
          (erase-buffer)
          (insert (mapconcat 'identity holiday-list "\n"))
          (goto-char (point-min))
          (set-buffer-modified-p nil)
          (setq buffer-read-only t)
          (display-buffer holiday-buffer)
          (message  "No diary entries for %s" date-string)))
    (save-excursion;; Prepare the fancy diary buffer.
      (set-buffer (make-fancy-diary-buffer))
      (setq buffer-read-only nil)
      (let ((entry-list diary-entries-list)
            (holiday-list)
            (holiday-list-last-month 1)
            (holiday-list-last-year 1)
            (date (list 0 0 0)))
        (while entry-list
          (if (not (calendar-date-equal date (car (car entry-list))))
              (progn
                (setq date (car (car entry-list)))
                (and holidays-in-diary-buffer
                     (calendar-date-compare
                      (list (list holiday-list-last-month
                                  (calendar-last-day-of-month
                                   holiday-list-last-month
                                   holiday-list-last-year)
                                  holiday-list-last-year))
                      (list date))
                     ;; We need to get the holidays for the next 3 months.
                     (setq holiday-list-last-month
                           (extract-calendar-month date))
                     (setq holiday-list-last-year
                           (extract-calendar-year date))
616 617 618 619
                     (progn
                       (increment-calendar-month
                        holiday-list-last-month holiday-list-last-year 1)
                       t)
Edward M. Reingold's avatar
Edward M. Reingold committed
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
                     (setq holiday-list
                           (let ((displayed-month holiday-list-last-month)
                                 (displayed-year holiday-list-last-year))
                             (calendar-holiday-list)))
                     (increment-calendar-month
                      holiday-list-last-month holiday-list-last-year 1))
                (let* ((date-string (calendar-date-string date))
                       (date-holiday-list
                        (let ((h holiday-list)
                              (d))
                          ;; Make a list of all holidays for date.
                          (while h
                            (if (calendar-date-equal date (car (car h)))
                                (setq d (append d (cdr (car h)))))
                            (setq h (cdr h)))
                          d)))
                  (insert (if (= (point) (point-min)) "" ?\n) date-string)
                  (if date-holiday-list (insert ":  "))
638 639
                  (let* ((l (current-column))
                         (longest 0))
640 641 642 643
                    (insert (mapconcat (lambda (x)
					 (if (< longest (length x))
					     (setq longest (length x)))
					 x)
644 645 646
                                       date-holiday-list
                                       (concat "\n" (make-string l ? ))))
                    (insert ?\n (make-string (+ l longest) ?=) ?\n)))))
647 648 649 650 651 652 653 654 655 656

	  (setq entry (car (cdr (car entry-list))))
	  (if (< 0 (length entry))
	      (progn
		(if (nth 3 (car entry-list))
		    (insert-button (concat entry "\n")
				   'marker (nth 3 (car entry-list))
				   :type 'diary-entry)
		  (insert entry ?\n))
		(save-excursion
657 658 659 660 661 662 663 664 665
                  (let* ((marks (nth 4 (car entry-list)))
                         (temp-face (make-symbol
                                     (apply
                                      'concat "temp-face-"
                                      (mapcar '(lambda (sym)
                                                 (if (stringp sym)
                                                     sym
                                                   (symbol-name sym)))
                                              marks))))
Glenn Morris's avatar
Glenn Morris committed
666 667
                         (faceinfo marks))
                    (make-face temp-face)
668
                    ;; Remove :face info from the marks,
669 670 671 672 673 674
                    ;; copy the face info into temp-face
                    (while (setq faceinfo (memq :face faceinfo))
                      (copy-face (read (nth 1 faceinfo)) temp-face)
                      (setcar faceinfo nil)
                      (setcar (cdr faceinfo) nil))
                    (setq marks (delq nil marks))
675
		  ;; Apply the font aspects
676 677 678 679 680
                    (apply 'set-face-attribute temp-face nil marks)
                    (search-backward entry)
                    (overlay-put
                     (make-overlay (match-beginning 0) (match-end 0))
                     'face temp-face)))))
681
	  (setq entry-list (cdr entry-list))))
Edward M. Reingold's avatar
Edward M. Reingold committed
682 683 684 685
      (set-buffer-modified-p nil)
      (goto-char (point-min))
      (setq buffer-read-only t)
      (display-buffer fancy-diary-buffer)
686
      (fancy-diary-display-mode)
Glenn Morris's avatar
Glenn Morris committed
687
      (calendar-set-mode-line date-string)
Edward M. Reingold's avatar
Edward M. Reingold committed
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
      (message "Preparing diary...done"))))

(defun make-fancy-diary-buffer ()
  "Create and return the initial fancy diary buffer."
  (save-excursion
    (set-buffer (get-buffer-create fancy-diary-buffer))
    (setq buffer-read-only nil)
    (calendar-set-mode-line "Diary Entries")
    (erase-buffer)
    (set-buffer-modified-p nil)
    (setq buffer-read-only t)
    (get-buffer fancy-diary-buffer)))

(defun print-diary-entries ()
  "Print a hard copy of the diary display.

If the simple diary display is being used, prepare a temp buffer with the
visible lines of the diary buffer, add a heading line composed from the mode
line, print the temp buffer, and destroy it.

If the fancy diary display is being used, just print the buffer.

The hooks given by the variable `print-diary-entries-hook' are called to do
the actual printing."
  (interactive)
  (if (bufferp (get-buffer fancy-diary-buffer))
      (save-excursion
        (set-buffer (get-buffer fancy-diary-buffer))
        (run-hooks 'print-diary-entries-hook))
    (let ((diary-buffer
718
           (find-buffer-visiting (substitute-in-file-name diary-file))))
Edward M. Reingold's avatar
Edward M. Reingold committed
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
      (if diary-buffer
          (let ((temp-buffer (get-buffer-create "*Printable Diary Entries*"))
                (heading))
            (save-excursion
              (set-buffer diary-buffer)
              (setq heading
                    (if (not (stringp mode-line-format))
                        "All Diary Entries"
                      (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
                      (substring mode-line-format
                                 (match-beginning 1) (match-end 1))))
              (copy-to-buffer temp-buffer (point-min) (point-max))
              (set-buffer temp-buffer)
              (while (re-search-forward "\^M.*$" nil t)
                (replace-match ""))
              (goto-char (point-min))
              (insert heading "\n"
                      (make-string (length heading) ?=) "\n")
              (run-hooks 'print-diary-entries-hook)
              (kill-buffer temp-buffer)))
        (error "You don't have a diary buffer!")))))

(defun show-all-diary-entries ()
  "Show all of the diary entries in the diary file.
This function gets rid of the selective display of the diary file so that
all entries, not just some, are visible.  If there is no diary buffer, one
is created."
  (interactive)
Glenn Morris's avatar
Glenn Morris committed
747 748
  (let ((d-file (diary-check-diary-file))
        (pop-up-frames (window-dedicated-p (selected-window))))
749 750 751 752 753 754 755 756 757 758
    (save-excursion
      (set-buffer (or (find-buffer-visiting d-file)
                      (find-file-noselect d-file t)))
      (let ((buffer-read-only nil)
            (diary-modified (buffer-modified-p)))
        (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
        (setq selective-display nil
              mode-line-format default-mode-line-format)
        (display-buffer (current-buffer))
        (set-buffer-modified-p diary-modified)))))
759

760
(defcustom diary-mail-addr
761
  (if (boundp 'user-mail-address) user-mail-address "")
762 763
  "*Email address that `diary-mail-entries' will send email to."
  :group 'diary
764
  :type  'string
Dan Nicolaescu's avatar
Dan Nicolaescu committed
765
  :version "20.3")
766 767

(defcustom diary-mail-days 7
768
  "*Default number of days for `diary-mail-entries' to check."
769
  :group 'diary
Dan Nicolaescu's avatar
Dan Nicolaescu committed
770 771
  :type 'integer
  :version "20.3")
772

773
;;;###autoload
774 775 776
(defun diary-mail-entries (&optional ndays)
  "Send a mail message showing diary entries for next NDAYS days.
If no prefix argument is given, NDAYS is set to `diary-mail-days'.
777
Mail is sent to the address specified by `diary-mail-addr'.
778 779 780 781 782 783 784 785 786 787

You can call `diary-mail-entries' every night using an at/cron job.
For example, this script will run the program at 2am daily.  Since
`emacs -batch' does not load your `.emacs' file, you must ensure that
all relevant variables are set, as done here.

#!/bin/sh
# diary-rem.sh -- repeatedly run the Emacs diary-reminder
emacs -batch \\
-eval \"(setq diary-mail-days 3 \\
788
             diary-file \\\"/path/to/diary.file\\\" \\
789 790
             european-calendar-style t \\
             diary-mail-addr \\\"user@host.name\\\" )\" \\
791
-l diary-lib -f diary-mail-entries
792 793 794 795 796 797
at -f diary-rem.sh 0200 tomorrow

You may have to tweak the syntax of the `at' command to suit your
system.  Alternatively, you can specify a cron entry:
0 1 * * * diary-rem.sh
to run it every morning at 1am."
798
  (interactive "P")
799 800 801 802 803 804 805 806 807 808 809 810 811 812
  (if (string-equal diary-mail-addr "")
      (error "You must set `diary-mail-addr' to use this command")
    (let ((diary-display-hook 'fancy-diary-display))
      (list-diary-entries (calendar-current-date) (or ndays diary-mail-days)))
    (compose-mail diary-mail-addr
                  (concat "Diary entries generated "
                          (calendar-date-string (calendar-current-date))))
    (insert
     (if (get-buffer fancy-diary-buffer)
         (save-excursion
           (set-buffer fancy-diary-buffer)
           (buffer-substring (point-min) (point-max)))
       "No entries found"))
    (call-interactively (get mail-user-agent 'sendfunc))))
813

814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
(defun diary-name-pattern (string-array &optional abbrev-array paren)
  "Return a regexp matching the strings in the array STRING-ARRAY.
If the optional argument ABBREV-ARRAY is present, then the function
`calendar-abbrev-construct' is used to construct abbreviations from the
two supplied arrays. The returned regexp will then also match these
abbreviations, with or without final `.' characters.  If the optional
argument PAREN is non-nil, the regexp is surrounded by parentheses."
  (regexp-opt (append string-array
                      (if abbrev-array
                          (calendar-abbrev-construct abbrev-array
                                                     string-array))
                      (if abbrev-array
                          (calendar-abbrev-construct abbrev-array
                                                     string-array
                                                     'period))
                      nil)
              paren))
Edward M. Reingold's avatar
Edward M. Reingold committed
831 832 833 834 835 836 837 838 839 840 841 842 843

(defvar marking-diary-entries nil
  "True during the marking of diary entries, nil otherwise.")

(defvar marking-diary-entry nil
  "True during the marking of diary entries, if current entry is marking.")

(defun mark-diary-entries ()
  "Mark days in the calendar window that have diary entries.
Each entry in the diary file visible in the calendar window is marked.
After the entries are marked, the hooks `nongregorian-diary-marking-hook' and
`mark-diary-entries-hook' are run."
  (interactive)
844 845 846 847
  (let ((marking-diary-entries t)
        file-glob-attrs marks)
    (save-excursion
      (set-buffer (find-file-noselect (diary-check-diary-file) t))
848
      (setq mark-diary-entries-in-calendar t)
849 850 851 852 853 854 855 856 857 858
      (message "Marking diary entries...")
      (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
      (let ((d diary-date-forms)
            (old-diary-syntax-table (syntax-table))
            temp)
        (set-syntax-table diary-syntax-table)
        (while d
          (let* ((date-form (if (equal (car (car d)) 'backup)
                                (cdr (car d))
                              (car d)));; ignore 'backup directive
859 860 861
                 (dayname
                  (diary-name-pattern calendar-day-name-array
                                      calendar-day-abbrev-array))
862
                 (monthname
863 864 865
                  (format "%s\\|\\*"
                   (diary-name-pattern calendar-month-name-array
                                       calendar-month-abbrev-array)))
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
                 (month "[0-9]+\\|\\*")
                 (day "[0-9]+\\|\\*")
                 (year "[0-9]+\\|\\*")
                 (l (length date-form))
                 (d-name-pos (- l (length (memq 'dayname date-form))))
                 (d-name-pos (if (/= l d-name-pos) (+ 2 d-name-pos)))
                 (m-name-pos (- l (length (memq 'monthname date-form))))
                 (m-name-pos (if (/= l m-name-pos) (+ 2 m-name-pos)))
                 (d-pos (- l (length (memq 'day date-form))))
                 (d-pos (if (/= l d-pos) (+ 2 d-pos)))
                 (m-pos (- l (length (memq 'month date-form))))
                 (m-pos (if (/= l m-pos) (+ 2 m-pos)))
                 (y-pos (- l (length (memq 'year date-form))))
                 (y-pos (if (/= l y-pos) (+ 2 y-pos)))
                 (regexp
                  (concat
                   "\\(\\`\\|\^M\\|\n\\)\\("
                   (mapconcat 'eval date-form "\\)\\(")
                   "\\)"))
                 (case-fold-search t))
            (goto-char (point-min))
            (while (re-search-forward regexp nil t)
              (let* ((dd-name
                      (if d-name-pos
                          (buffer-substring-no-properties
                           (match-beginning d-name-pos)
                           (match-end d-name-pos))))
                     (mm-name
                      (if m-name-pos
                          (buffer-substring-no-properties
                           (match-beginning m-name-pos)
                           (match-end m-name-pos))))
                     (mm (string-to-int
                          (if m-pos
                              (buffer-substring-no-properties
                               (match-beginning m-pos)
                               (match-end m-pos))
                            "")))
                     (dd (string-to-int
                          (if d-pos
                              (buffer-substring-no-properties
                               (match-beginning d-pos)
                               (match-end d-pos))
                            "")))
                     (y-str (if y-pos
                                (buffer-substring-no-properties
                                 (match-beginning y-pos)
                                 (match-end y-pos))))
                     (yy (if (not y-str)
                             0
                           (if (and (= (length y-str) 2)
                                    abbreviated-calendar-year)
                               (let* ((current-y
                                       (extract-calendar-year
                                        (calendar-current-date)))
                                      (y (+ (string-to-int y-str)
                                            (* 100
                                               (/ current-y 100)))))
                                 (if (> (- y current-y) 50)
                                     (- y 100)
                                   (if (> (- current-y y) 50)
                                       (+ y 100)
                                     y)))
                             (string-to-int y-str))))
                     (save-excursion
                       (setq entry (buffer-substring-no-properties
                                    (point) (line-end-position))
                             temp (diary-pull-attrs entry file-glob-attrs)
                             entry (nth 0 temp)
                             marks (nth 1 temp))))
                (if dd-name
                    (mark-calendar-days-named
938
                     (cdr (assoc-string
939
                           dd-name
940 941
                           (calendar-make-alist
                            calendar-day-name-array
942
                            0 nil calendar-day-abbrev-array) t)) marks)
943
                  (if mm-name
944 945
                      (setq mm
                            (if (string-equal mm-name "*") 0
946
                              (cdr (assoc-string
947
                                    mm-name
948 949
                                    (calendar-make-alist
                                     calendar-month-name-array
950
                                     1 nil calendar-month-abbrev-array) t)))))
951 952 953 954 955 956 957
                  (mark-calendar-date-pattern mm dd yy marks))))
            (setq d (cdr d))))
        (mark-sexp-diary-entries)
        (run-hooks 'nongregorian-diary-marking-hook
                   'mark-diary-entries-hook)
        (set-syntax-table old-diary-syntax-table)
        (message "Marking diary entries...done")))))
Edward M. Reingold's avatar
Edward M. Reingold committed
958 959 960 961 962 963 964

(defun mark-sexp-diary-entries ()
  "Mark days in the calendar window that have sexp diary entries.
Each entry in the diary file (or included files) visible in the calendar window
is marked.  See the documentation for the function `list-sexp-diary-entries'."
  (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol))
         (s-entry (concat "\\(\\`\\|\^M\\|\n\\)\\("
965
                          sexp-mark "(\\)\\|\\("
Edward M. Reingold's avatar
Edward M. Reingold committed
966
                          (regexp-quote diary-nonmarking-symbol)
967 968 969
                          sexp-mark "(diary-remind\\)"))
         (file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
         m y first-date last-date mark file-glob-attrs)
Edward M. Reingold's avatar
Edward M. Reingold committed
970 971 972 973 974 975 976 977 978 979 980 981 982
    (save-excursion
      (set-buffer calendar-buffer)
      (setq m displayed-month)
      (setq y displayed-year))
    (increment-calendar-month m y -1)
    (setq first-date
          (calendar-absolute-from-gregorian (list m 1 y)))
    (increment-calendar-month m y 2)
    (setq last-date
          (calendar-absolute-from-gregorian
           (list m (calendar-last-day-of-month m y) y)))
    (goto-char (point-min))
    (while (re-search-forward s-entry nil t)
983
      (setq marking-diary-entry (char-equal (preceding-char) ?\())
Edward M. Reingold's avatar
Edward M. Reingold committed
984 985
      (re-search-backward "(")
      (let ((sexp-start (point))
986
            sexp entry entry-start line-start marks)
Edward M. Reingold's avatar
Edward M. Reingold committed
987
        (forward-sexp)
988
        (setq sexp (buffer-substring-no-properties sexp-start (point)))
Edward M. Reingold's avatar
Edward M. Reingold committed
989 990 991 992 993 994 995 996 997 998 999
        (save-excursion
          (re-search-backward "\^M\\|\n\\|\\`")
          (setq line-start (point)))
        (forward-char 1)
        (if (and (or (char-equal (preceding-char) ?\^M)
                     (char-equal (preceding-char) ?\n))
                 (not (looking-at " \\|\^I")))
            (progn;; Diary entry consists only of the sexp
              (backward-char 1)
              (setq entry ""))
          (setq entry-start (point))
1000
          ;; Find end of entry
Edward M. Reingold's avatar
Edward M. Reingold committed
1001 1002
          (re-search-forward "\^M\\|\n" nil t)
          (while (looking-at " \\|\^I")
1003 1004
 	    (or (re-search-forward "\^M\\|\n" nil t)
 		(re-search-forward "$" nil t)))
1005 1006 1007
          (if (or (char-equal (preceding-char) ?\^M)
 		  (char-equal (preceding-char) ?\n))
 	      (backward-char 1))
1008
          (setq entry (buffer-substring-no-properties entry-start (point)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1009 1010 1011
          (while (string-match "[\^M]" entry)
            (aset entry (match-beginning 0) ?\n )))
        (calendar-for-loop date from first-date to last-date do
1012 1013
          (if (setq mark (diary-sexp-entry sexp entry
                                (calendar-gregorian-from-absolute date)))
1014 1015
	      (progn
		(setq marks (diary-pull-attrs entry file-glob-attrs)
1016
		      marks (nth 1 (diary-pull-attrs entry file-glob-attrs)))
1017
		(mark-visible-calendar-date
1018
		 (calendar-gregorian-from-absolute date)
1019 1020 1021 1022
		 (if (< 0 (length marks))
		     marks
		   (if (consp mark)
		     (car mark)))))))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040

(defun mark-included-diary-files ()
  "Mark the diary entries from other diary files with those of the diary file.
This function is suitable for use as the `mark-diary-entries-hook'; it enables
you to use shared diary files together with your own.  The files included are
specified in the diary-file by lines of this form:
        #include \"filename\"
This is recursive; that is, #include directives in diary files thus included
are obeyed.  You can change the `#include' to some other string by
changing the variable `diary-include-string'."
  (goto-char (point-min))
  (while (re-search-forward
          (concat
           "\\(\\`\\|\^M\\|\n\\)"
           (regexp-quote diary-include-string)
           " \"\\([^\"]*\\)\"")
          nil t)
    (let ((diary-file (substitute-in-file-name
1041 1042
                       (buffer-substring-no-properties
                        (match-beginning 2) (match-end 2))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1043 1044 1045 1046 1047
          (mark-diary-entries-hook 'mark-included-diary-files))
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
              (progn
                (mark-diary-entries)
1048
                (kill-buffer (find-buffer-visiting diary-file)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1049 1050 1051 1052 1053 1054 1055 1056
            (beep)
            (message "Can't read included diary file %s" diary-file)
            (sleep-for 2))
        (beep)
        (message "Can't find included diary file %s" diary-file)
        (sleep-for 2))))
  (goto-char (point-min)))

1057
(defun mark-calendar-days-named (dayname &optional color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
  "Mark all dates in the calendar window that are day DAYNAME of the week.
0 means all Sundays, 1 means all Mondays, and so on."
  (save-excursion
    (set-buffer calendar-buffer)
    (let ((prev-month displayed-month)
          (prev-year displayed-year)
          (succ-month displayed-month)
          (succ-year displayed-year)
          (last-day)
          (day))
      (increment-calendar-month succ-month succ-year 1)
      (increment-calendar-month prev-month prev-year -1)
      (setq day (calendar-absolute-from-gregorian
                 (calendar-nth-named-day 1 dayname prev-month prev-year)))
      (setq last-day (calendar-absolute-from-gregorian
                 (calendar-nth-named-day -1 dayname succ-month succ-year)))
      (while (<= day last-day)
1075
        (mark-visible-calendar-date (calendar-gregorian-from-absolute day) color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1076 1077
        (setq day (+ day 7))))))

1078
(defun mark-calendar-date-pattern (month day year &optional color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1079 1080 1081 1082 1083 1084 1085 1086
  "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
A value of 0 in any position is a wildcard."
  (save-excursion
    (set-buffer calendar-buffer)
    (let ((m displayed-month)
          (y displayed-year))
      (increment-calendar-month m y -1)
      (calendar-for-loop i from 0 to 2 do
1087
          (mark-calendar-month m y month day year color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1088 1089
          (increment-calendar-month m y 1)))))

1090
(defun mark-calendar-month (month year p-month p-day p-year &optional color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1091 1092 1093 1094 1095 1096 1097 1098 1099
  "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P_DAY/P-YEAR.
A value of 0 in any position of the pattern is a wildcard."
  (if (or (and (= month p-month)
               (or (= p-year 0) (= year p-year)))
          (and (= p-month 0)
               (or (= p-year 0) (= year p-year))))
      (if (= p-day 0)
          (calendar-for-loop
              i from 1 to (calendar-last-day-of-month month year) do
1100 1101
            (mark-visible-calendar-date (list month i year) color))
        (mark-visible-calendar-date (list month p-day year) color))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1102 1103 1104 1105 1106 1107 1108 1109 1110

(defun sort-diary-entries ()
  "Sort the list of diary entries by time of day."
  (setq diary-entries-list (sort diary-entries-list 'diary-entry-compare)))

(defun diary-entry-compare (e1 e2)
  "Returns t if E1 is earlier than E2."
  (or (calendar-date-compare e1 e2)
      (and (calendar-date-equal (car e1) (car e2))
1111 1112 1113 1114 1115
           (let* ((ts1 (cadr e1)) (t1 (diary-entry-time ts1))
                  (ts2 (cadr e2)) (t2 (diary-entry-time ts2)))
             (or (< t1 t2)
                 (and (= t1 t2)
                      (string-lessp ts1 ts2)))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1116

1117 1118 1119 1120 1121 1122 1123
(defcustom diary-unknown-time
  -9999
  "*Value returned by diary-entry-time when no time is found.
The default value -9999 causes entries with no recognizable time to be placed
before those with times; 9999 would place entries with no recognizable time
after those with times."
  :type 'integer
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1124 1125
  :group 'diary
  :version "20.3")
1126

Edward M. Reingold's avatar
Edward M. Reingold committed
1127
(defun diary-entry-time (s)
1128 1129
  "Return time at the beginning of the string S as a military-style integer.
For example, returns 1325 for 1:25pm.
1130 1131 1132

Returns `diary-unknown-time' (default value -9999) if no time is recognized.
The recognized forms are XXXX, X:XX, or XX:XX (military time), and XXam,
Glenn Morris's avatar
Glenn Morris committed
1133 1134
XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm, or XX:XXPM.  A period (.) can
be used instead of a colon (:) to separate the hour and minute parts."
1135
  (let ((case-fold-search nil))
1136
    (cond ((string-match        ; Military time
1137 1138
	    "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)"
            s)
1139 1140 1141
	   (+ (* 100 (string-to-int
		      (substring s (match-beginning 1) (match-end 1))))
	      (string-to-int (substring s (match-beginning 2) (match-end 2)))))
1142
	  ((string-match        ; Hour only  XXam or XXpm
1143
	    "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s)
1144 1145 1146 1147 1148
	   (+ (* 100 (% (string-to-int
			   (substring s (match-beginning 1) (match-end 1)))
			  12))
	      (if (equal ?a (downcase (aref s (match-beginning 2))))
		  0 1200)))
1149
	  ((string-match        ; Hour and minute  XX:XXam or XX:XXpm
1150
	    "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]\\([0-9][0-9]\\)\\([ap]\\)m\\>" s)
1151 1152 1153 1154 1155 1156
	   (+ (* 100 (% (string-to-int
			   (substring s (match-beginning 1) (match-end 1)))
			  12))
	      (string-to-int (substring s (match-beginning 2) (match-end 2)))
	      (if (equal ?a (downcase (aref s (match-beginning 3))))
		  0 1200)))
1157
	  (t diary-unknown-time)))) ; Unrecognizable
1158

1159 1160
;; Unrecognizable

Edward M. Reingold's avatar
Edward M. Reingold committed
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
(defun list-sexp-diary-entries (date)
  "Add sexp entries for DATE from the diary file to `diary-entries-list'.
Also, Make them visible in the diary file.  Returns t if any entries were
found.

Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally
`%%').  The form of a sexp diary entry is

                  %%(SEXP) ENTRY

Both ENTRY and DATE are globally available when the SEXP is evaluated.  If the
SEXP yields the value nil, the diary entry does not apply.  If it yields a
non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a
string, that string will be the diary entry in the fancy diary display.

For example, the following diary entry will apply to the 21st of the month
if it is a weekday and the Friday before if the 21st is on a weekend:

      &%%(let ((dayname (calendar-day-of-week date))
               (day (extract-calendar-day date)))
           (or
             (and (= day 21) (memq dayname '(1 2 3 4 5)))
             (and (memq day '(19 20)) (= dayname 5)))
         ) UIUC pay checks deposited

A number of built-in functions are available for this type of diary entry:

1188
      %%(diary-date MONTH DAY YEAR &optional MARK) text
Edward M. Reingold's avatar
Edward M. Reingold committed
1189 1190 1191 1192
                  Entry applies if date is MONTH, DAY, YEAR if
                  `european-calendar-style' is nil, and DAY, MONTH, YEAR if
                  `european-calendar-style' is t.  DAY, MONTH, and YEAR
                  can be lists of integers, the constant t, or an integer.
1193
                  The constant t means all values.  An optional parameter
1194 1195
                  MARK specifies a face or single-character string to use
                  when highlighting the day in the calendar.
Edward M. Reingold's avatar
Edward M. Reingold committed
1196

1197
      %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
Edward M. Reingold's avatar
Edward M. Reingold committed
1198 1199 1200 1201
                  Entry will appear on the Nth DAYNAME of MONTH.
                  (DAYNAME=0 means Sunday, 1 means Monday, and so on;
                  if N is negative it counts backward from the end of
                  the month.  MONTH can be a list of months, a single
1202 1203
                  month, or t to specify all months. Optional DAY means
                  Nth DAYNAME of MONTH on or after/before DAY.  DAY defaults
1204 1205
                  to 1 if N>0 and the last day of the month if N<0.  An
                  optional parameter MARK specifies a face or single-character
1206
                  string to use when highlighting the day in the calendar.
Edward M. Reingold's avatar
Edward M. Reingold committed
1207

1208
      %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
Edward M. Reingold's avatar
Edward M. Reingold committed
1209 1210 1211
                  Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
                  inclusive.  (If `european-calendar-style' is t, the
                  order of the parameters should be changed to D1, M1, Y1,
1212 1213
                  D2, M2, Y2.)  An optional parameter MARK specifies a face
                  or single-character string to use when highlighting the
1214
                  day in the calendar.
Edward M. Reingold's avatar
Edward M. Reingold committed
1215

1216
      %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
Edward M. Reingold's avatar
Edward M. Reingold committed
1217 1218 1219 1220 1221 1222 1223
                  Entry will appear on anniversary dates of MONTH DAY, YEAR.
                  (If `european-calendar-style' is t, the order of the
                  parameters should be changed to DAY, MONTH, YEAR.)  Text
                  can contain %d or %d%s; %d will be replaced by the number
                  of years since the MONTH DAY, YEAR and %s will be replaced
                  by the ordinal ending of that number (that is, `st', `nd',
                  `rd' or `th', as appropriate.  The anniversary of February
1224 1225
                  29 is considered to be March 1 in a non-leap year.  An
                  optional parameter MARK specifies a face or single-character
1226
                  string to use when highlighting the day in the calendar.
Edward M. Reingold's avatar
Edward M. Reingold committed
1227

1228
      %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text
Edward M. Reingold's avatar
Edward M. Reingold committed
1229 1230 1231 1232 1233 1234
                  Entry will appear every N days, starting MONTH DAY, YEAR.
                  (If `european-calendar-style' is t, the order of the
                  parameters should be changed to N, DAY, MONTH, YEAR.)  Text
                  can contain %d or %d%s; %d will be replaced by the number
                  of repetitions since the MONTH DAY, YEAR and %s will
                  be replaced by the ordinal ending of that number (that is,
1235 1236
                  `st', `nd', `rd' or `th', as appropriate.  An optional
                  parameter MARK specifies a face or single-character string
1237
                  to use when highlighting the day in the calendar.
Edward M. Reingold's avatar
Edward M. Reingold committed
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305

      %%(diary-remind SEXP DAYS &optional MARKING) text
                  Entry is a reminder for diary sexp SEXP.  DAYS is either a
                  single number or a list of numbers indicating the number(s)
                  of days before the event that the warning(s) should occur.
                  If the current date is (one of) DAYS before the event
                  indicated by EXPR, then a suitable message (as specified
                  by `diary-remind-message') appears.  In addition to the
                  reminders beforehand, the diary entry also appears on
                  the date itself.  If optional MARKING is non-nil then the
                  *reminders* are marked on the calendar.  Marking of
                  reminders is independent of whether the entry *itself* is
                  a marking or nonmarking one.

      %%(diary-day-of-year)
                  Diary entries giving the day of the year and the number of
                  days remaining in the year will be made every day.  Note
                  that since there is no text, it makes sense only if the
                  fancy diary display is used.

      %%(diary-iso-date)
                  Diary entries giving the corresponding ISO commercial date
                  will be made every day.  Note that since there is no text,
                  it makes sense only if the fancy diary display is used.

      %%(diary-french-date)
                  Diary entries giving the corresponding French Revolutionary
                  date will be made every day.  Note that since there is no
                  text, it makes sense only if the fancy diary display is used.

      %%(diary-islamic-date)
                  Diary entries giving the corresponding Islamic date will be
                  made every day.  Note that since there is no text, it
                  makes sense only if the fancy diary display is used.

      %%(diary-hebrew-date)
                  Diary entries giving the corresponding Hebrew date will be
                  made every day.  Note that since there is no text, it
                  makes sense only if the fancy diary display is used.

      %%(diary-astro-day-number) Diary entries giving the corresponding
                  astronomical (Julian) day number will be made every day.
                  Note that since there is no text, it makes sense only if the
                  fancy diary display is used.

      %%(diary-julian-date) Diary entries giving the corresponding
                 Julian date will be made every day.  Note that since
                 there is no text, it makes sense only if the fancy diary
                 display is used.

      %%(diary-sunrise-sunset)
                  Diary entries giving the local times of sunrise and sunset
                  will be made every day.  Note that since there is no text,
                  it makes sense only if the fancy diary display is used.
                  Floating point required.

      %%(diary-phases-of-moon)
                  Diary entries giving the times of the phases of the moon
                  will be when appropriate.  Note that since there is no text,
                  it makes sense only if the fancy diary display is used.
                  Floating point required.

      %%(diary-yahrzeit MONTH DAY YEAR) text
                  Text is assumed to be the name of the person; the date is
                  the date of death on the *civil* calendar.  The diary entry
                  will appear on the proper Hebrew-date anniversary and on the
                  day before.  (If `european-calendar-style' is t, the order
                  of the parameters should be changed to DAY, MONTH, YEAR.)
1306

Edward M. Reingold's avatar
Edward M. Reingold committed
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
      %%(diary-rosh-hodesh)
                  Diary entries will be made on the dates of Rosh Hodesh on
                  the Hebrew calendar.  Note that since there is no text, it
                  makes sense only if the fancy diary display is used.

      %%(diary-parasha)
                  Diary entries giving the weekly parasha will be made on
                  every Saturday.  Note that since there is no text, it
                  makes sense only if the fancy diary display is used.

      %%(diary-omer)
                  Diary entries giving the omer count will be made every day
1319
                  from Passover to Shavuot.  Note that since there is no text,
Edward M. Reingold's avatar
Edward M. Reingold committed
1320 1321 1322 1323
                  it makes sense only if the fancy diary display is used.

Marking these entries is *extremely* time consuming, so these entries are
best if they are nonmarking."
1324
  (let ((s-entry (concat "\\(\\`\\|\^M\\|\n\\)"
1325 1326 1327 1328 1329
                         (regexp-quote diary-nonmarking-symbol)
                         "?"
                         (regexp-quote sexp-diary-entry-symbol)
                         "("))
        entry-found file-glob-attrs marks)
Edward M. Reingold's avatar
Edward M. Reingold committed
1330
    (goto-char (point-min))
1331 1332
    (save-excursion
      (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '()))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1333 1334 1335
    (while (re-search-forward s-entry nil t)
      (backward-char 1)
      (let ((sexp-start (point))
1336
            sexp entry specifier entry-start line-start)
Edward M. Reingold's avatar
Edward M. Reingold committed
1337
        (forward-sexp)
1338
        (setq sexp (buffer-substring-no-properties sexp-start (point)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1339 1340 1341
        (save-excursion
          (re-search-backward "\^M\\|\n\\|\\`")
          (setq line-start (point)))
1342
        (setq specifier
1343 1344
              (buffer-substring-no-properties (1+ line-start) (point))
	      entry-start (1+ line-start))
Edward M. Reingold's avatar
Edward M. Reingold committed
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
        (forward-char 1)
        (if (and (or (char-equal (preceding-char) ?\^M)
                     (char-equal (preceding-char) ?\n))
                 (not (looking-at " \\|\^I")))
            (progn;; Diary entry consists only of the sexp
              (backward-char 1)
              (setq entry ""))
          (setq entry-start (point))
          (re-search-forward "\^M\\|\n" nil t)
          (while (looking-at " \\|\^I")
            (re-search-forward "\^M\\|\n" nil t))
          (backward-char 1)
1357
          (setq entry (buffer-substring-no-properties entry-start (point)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1358 1359
          (while (string-match "[\^M]" entry)
            (aset entry (match-beginning 0) ?\n )))
1360 1361
        (let ((diary-entry (diary-sexp-entry sexp entry date))
              temp)
1362 1363 1364
	  (setq entry (if (consp diary-entry)
			  (cdr diary-entry)
			diary-entry))
Edward M. Reingold's avatar
Edward M. Reingold committed
1365
          (if diary-entry
1366 1367 1368 1369 1370 1371 1372 1373
	      (progn
		(subst-char-in-region line-start (point) ?\^M ?\n t)
		(if (< 0 (length entry))
		    (setq temp (diary-pull-attrs entry file-glob-attrs)
			  entry (nth 0 temp)
			  marks (nth 1 temp)))))
	  (add-to-diary-list date
			     entry
1374 1375
			     specifier
			     (if entry-start (copy-marker entry-start)
1376
			       nil)
1377
			     marks)
1378
	  (setq entry-found (or entry-found diary-entry)))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
    entry-found))

(defun diary-sexp-entry (sexp entry date)
  "Process a SEXP diary ENTRY for DATE."
  (let ((result (if calendar-debug-sexp
                    (let ((stack-trace-on-error t))
                      (eval (car (read-from-string sexp))))
                  (condition-case nil
                      (eval (car (read-from-string sexp)))
                    (error
                     (beep)
                     (message "Bad sexp at line %d in %s: %s"
                              (save-excursion
                                (save-restriction
                                  (narrow-to-region 1 (point))
                                  (goto-char (point-min))
                                  (let ((lines 1))
                                    (while (re-search-forward "\n\\|\^M" nil t)
                                      (setq lines (1+ lines)))
                                    lines)))
                              diary-file sexp)
                     (sleep-for 2))))))
1401 1402