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

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

;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7
;; Maintainer: Glenn Morris <rgm@gnu.org>
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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, 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
  (diary-check-diary-file)
  (let ((date (calendar-current-date)))
61 62 63 64
    (diary-list-entries date (if arg (prefix-numeric-value arg)))))

(define-obsolete-function-alias 'view-diary-entries 'diary-view-entries)
(defun diary-view-entries (&optional arg)
Edward M. Reingold's avatar
Edward M. Reingold committed
65 66 67 68 69
  "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")
70
  (diary-check-diary-file)
71
  (diary-list-entries (calendar-cursor-to-date t) arg))
Edward M. Reingold's avatar
Edward M. Reingold committed
72

73
(defun view-other-diary-entries (arg d-file)
Edward M. Reingold's avatar
Edward M. Reingold committed
74
  "Prepare and display buffer of diary entries from an alternative diary file.
75 76 77
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
78
  (interactive
79
   (list (prefix-numeric-value current-prefix-arg)
80 81 82
         (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
83 84 85 86

(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.
87
The holidays are those in the list `calendar-holidays'.")
Edward M. Reingold's avatar
Edward M. Reingold committed
88 89 90

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

(autoload 'diary-french-date "cal-french"
94
  "French calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
95 96

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

Edward M. Reingold's avatar
Edward M. Reingold committed
99
(autoload 'diary-iso-date "cal-iso"
100
  "ISO calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
101

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

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

108
(autoload 'diary-chinese-date "cal-china"
109
  "Chinese calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
110

111
(autoload 'diary-islamic-date "cal-islam"
112
  "Islamic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
113

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

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

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

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
(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
139
(autoload 'diary-hebrew-date "cal-hebrew"
140
  "Hebrew calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
141 142

(autoload 'diary-omer "cal-hebrew"
143
  "Omer count diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
144 145

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

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

(autoload 'diary-rosh-hodesh "cal-hebrew"
152
  "Rosh Hodesh diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
153 154

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

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

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

(autoload 'diary-coptic-date "cal-coptic"
164
  "Coptic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
165 166

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

169
(autoload 'diary-persian-date "cal-persia"
170
  "Persian calendar equivalent of date diary entry.")
171

172
(autoload 'diary-phases-of-moon "lunar" "Moon phases diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
173 174

(autoload 'diary-sunrise-sunset "solar"
175
  "Local time of sunrise and sunset as a diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
176 177 178

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

181 182 183 184 185
(defvar diary-syntax-table
  (let ((st (copy-syntax-table (standard-syntax-table))))
    (modify-syntax-entry ?* "w" st)
    (modify-syntax-entry ?: "w" st)
    st)
Edward M. Reingold's avatar
Edward M. Reingold committed
186 187
  "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 191 192 193 194 195 196 197 198
(defvar diary-entries-list)
(defvar displayed-year)
(defvar displayed-month)
(defvar entry)
(defvar date)
(defvar number)
(defvar date-string)
(defvar original-date)

199
(defun diary-attrtype-convert (attrvalue type)
200 201
  "Convert string ATTRVALUE to TYPE appropriate for a face description.
Valid TYPEs are: string, symbol, int, stringtnil, tnil."
202 203 204
  (let (ret)
    (setq ret (cond ((eq type 'string) attrvalue)
		    ((eq type 'symbol) (read attrvalue))
205
		    ((eq type 'int) (string-to-number attrvalue))
206 207 208 209 210 211 212 213 214
		    ((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))
215

216 217

(defun diary-pull-attrs (entry fileglobattrs)
218 219 220
  "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.
221
The entry will be modified to drop all tags that are used for face matching.
222 223 224
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
225 226
search."
  (save-excursion
227 228
    (let (regexp regnum attrname attr-list attrname attrvalue type
                 ret-attr attr)
229 230 231 232 233 234 235 236 237 238 239 240 241 242
      (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)
243
		  (setq attrvalue (match-string-no-properties regnum)))
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
	      (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)
261
		(progn
262
		  (setq attrvalue (match-string-no-properties regnum entry))
263 264 265 266
		  (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))))
267 268
	    (setq attr-list (cdr attr-list)))))
      (list entry ret-attr))))
269 270


271 272 273
;; This can be removed once the kill/yank treatment of invisible text
;; (see etc/TODO) is fixed. -- gm
(defcustom diary-header-line-flag t
274
  "If non-nil, `diary-simple-display' will show a header line.
275 276 277
The format of the header is specified by `diary-header-line-format'."
  :group   'diary
  :type    'boolean
278
  :version "22.1")
279

280 281
(defvar diary-selective-display nil)

282 283
(defcustom diary-header-line-format
  '(:eval (calendar-string-spread
284
           (list (if diary-selective-display
285 286 287
                     "Selective display active - press \"s\" in calendar \
before edit/copy"
                   "Diary"))
288
           ?\s (frame-width)))
289
  "Format of the header line displayed by `diary-simple-display'.
290 291 292
Only used if `diary-header-line-flag' is non-nil."
  :group   'diary
  :type    'sexp
293
  :version "22.1")
294

Glenn Morris's avatar
Glenn Morris committed
295 296
(defvar diary-saved-point)		; internal

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

(defcustom number-of-diary-entries 1
  "Specifies how many days of diary entries are to be displayed initially.
This variable affects the diary display when the command \\[diary] is used,
or if the value of the variable `view-diary-entries-initially' is t.  For
example, if the default value 1 is used, then only the current day's diary
entries will be displayed.  If the value 2 is used, then both the current
day's and the next day's entries will be displayed.

The value can also be a vector such as [0 2 2 2 2 4 1]; this value
says to display no diary entries on Sunday, the display the entries
for the current date and the day after on Monday through Thursday,
display Friday through Monday's entries on Friday, and display only
Saturday's entries on Saturday.

This variable does not affect the diary display with the `d' command
from the calendar; in that case, the prefix argument controls the
number of days of diary entries displayed."
  :type '(choice (integer :tag "Entries")
		 (vector :value [0 0 0 0 0 0 0]
			 (integer :tag "Sunday")
			 (integer :tag "Monday")
			 (integer :tag "Tuesday")
			 (integer :tag "Wednesday")
			 (integer :tag "Thursday")
			 (integer :tag "Friday")
			 (integer :tag "Saturday")))
  :group 'diary)

(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries)
327
(defun diary-list-entries (date number &optional list-only)
328
  "Create and display a buffer containing the relevant lines in `diary-file'.
Edward M. Reingold's avatar
Edward M. Reingold committed
329 330
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
331
using selective display.  If NUMBER is less than 1, this function does nothing.
Edward M. Reingold's avatar
Edward M. Reingold committed
332 333

Returns a list of all relevant diary entries found, if any, in order by date.
334 335 336 337
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
338
for a date with no diary entries.
Edward M. Reingold's avatar
Edward M. Reingold committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358

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
359 360 361
        notification function.

If LIST-ONLY is non-nil don't modify or display the buffer, only return a list."
362 363 364 365
  (unless number
    (setq number (if (vectorp number-of-diary-entries)
                     (aref number-of-diary-entries (calendar-day-of-week date))
                   number-of-diary-entries)))
Glenn Morris's avatar
Glenn Morris committed
366 367 368 369 370 371 372 373 374 375 376 377 378 379
  (when (> number 0)
    (let ((original-date date);; save for possible use in the hooks
          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))))
380 381
        ;; Setup things like the header-line-format and invisibility-spec.
        (when (eq major-mode 'fundamental-mode) (diary-mode))
Glenn Morris's avatar
Glenn Morris committed
382 383 384 385
        ;; 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 "")))
386
            (with-syntax-table diary-syntax-table
387
              (let ((mark (regexp-quote diary-nonmarking-symbol)))
388
                (goto-char (point-min))
389 390 391 392 393
                (unless list-only
                  (let ((ol (make-overlay (point-min) (point-max) nil t nil)))
                    (set (make-local-variable 'diary-selective-display) t)
                    (overlay-put ol 'invisible 'diary)
                    (overlay-put ol 'evaporate t)))
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
                (calendar-for-loop
                 i from 1 to number do
                 (let ((month (extract-calendar-month date))
                       (day (extract-calendar-day date))
                       (year (extract-calendar-year date))
                       (entry-found (list-sexp-diary-entries date)))
                   (dolist (date-form diary-date-forms)
                     (let*
                         ((backup (when (eq (car date-form) 'backup)
                                    (setq date-form (cdr date-form))
                                    t))
                          (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 "?\\("
424
                            (mapconcat 'eval date-form "\\)\\(?:")
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
                            "\\)"))
                          (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)
446 447 448
                             (unless list-only
                               (remove-overlays date-start (point)
                                                'invisible 'diary))
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
                             (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)))))))
                   (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))))
466
                   (setq entry-found nil)))))
Glenn Morris's avatar
Glenn Morris committed
467 468 469
            (goto-char (point-min))
            (run-hooks 'nongregorian-diary-listing-hook
                       'list-diary-entries-hook)
470 471 472 473
            (unless list-only
              (if diary-display-hook
                  (run-hooks 'diary-display-hook)
                (simple-diary-display)))
Glenn Morris's avatar
Glenn Morris committed
474 475
            (run-hooks 'diary-hook)
            diary-entries-list))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
476

477
(defun diary-unhide-everything ()
478 479
  (kill-local-variable 'diary-selective-display)
  (remove-overlays (point-min) (point-max) 'invisible 'diary)
480 481
  (kill-local-variable 'mode-line-format))

Edward M. Reingold's avatar
Edward M. Reingold committed
482 483 484 485 486 487 488 489 490 491 492 493
(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
494
           "\\(?:\\`\\|\^M\\|\n\\)"
Edward M. Reingold's avatar
Edward M. Reingold committed
495 496 497
           (regexp-quote diary-include-string)
           " \"\\([^\"]*\\)\"")
          nil t)
498
    (let* ((diary-file (substitute-in-file-name
499
                        (match-string-no-properties 1)))
500 501 502
           (diary-list-include-blanks nil)
           (list-diary-entries-hook 'include-other-diary-files)
           (diary-display-hook 'ignore)
503
           (diary-hook nil))
Edward M. Reingold's avatar
Edward M. Reingold committed
504 505 506 507 508 509
      (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)))
510 511
                (with-current-buffer (find-buffer-visiting diary-file)
                  (diary-unhide-everything)))
Edward M. Reingold's avatar
Edward M. Reingold committed
512 513 514 515 516 517 518 519 520 521 522 523
            (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)))
524 525 526 527 528 529 530 531 532
         (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
533 534 535
    (if (or (not diary-entries-list)
            (and (not (cdr diary-entries-list))
                 (string-equal (car (cdr (car diary-entries-list))) "")))
536
        (if (< (length msg) (frame-width))
537
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
538 539 540 541 542 543 544 545 546 547
          (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
548 549 550 551 552 553
      (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
554 555
      (message "Preparing diary...done"))))

556 557
(defface diary-button '((((type pc) (class color))
			 (:foreground "lightblue")))
558
  "Default face used for buttons."
559
  :version "22.1"
560
  :group 'diary)
561 562
;; backward-compatibility alias
(put 'diary-button-face 'face-alias 'diary-button)
563 564 565

(define-button-type 'diary-entry
  'action #'diary-goto-entry
566
  'face 'diary-button)
567 568 569 570 571 572 573

(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
574 575 576
(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'."
577 578 579
  (with-current-buffer ;; Turn off selective-display in the diary file's buffer.
      (find-buffer-visiting (substitute-in-file-name diary-file))
    (diary-unhide-everything))
Edward M. Reingold's avatar
Edward M. Reingold committed
580 581 582 583 584 585 586 587 588
  (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))
589
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
590 591 592 593 594 595 596 597 598
          (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)))
599 600
    (with-current-buffer;; Prepare the fancy diary buffer.
        (make-fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
      (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))
624 625 626 627
                     (progn
                       (increment-calendar-month
                        holiday-list-last-month holiday-list-last-year 1)
                       t)
Edward M. Reingold's avatar
Edward M. Reingold committed
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
                     (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 ":  "))
646 647
                  (let* ((l (current-column))
                         (longest 0))
648 649 650 651
                    (insert (mapconcat (lambda (x)
					 (if (< longest (length x))
					     (setq longest (length x)))
					 x)
652 653 654
                                       date-holiday-list
                                       (concat "\n" (make-string l ? ))))
                    (insert ?\n (make-string (+ l longest) ?=) ?\n)))))
655 656 657 658 659 660 661 662 663 664

	  (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
665 666 667 668
                  (let* ((marks (nth 4 (car entry-list)))
                         (temp-face (make-symbol
                                     (apply
                                      'concat "temp-face-"
669 670 671 672
                                      (mapcar (lambda (sym)
                                                (if (stringp sym)
                                                    sym
                                                  (symbol-name sym)))
673
                                              marks))))
Glenn Morris's avatar
Glenn Morris committed
674 675
                         (faceinfo marks))
                    (make-face temp-face)
676
                    ;; Remove :face info from the marks,
677 678 679 680 681 682
                    ;; 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))
683
                    ;; Apply the font aspects.
684 685 686 687 688
                    (apply 'set-face-attribute temp-face nil marks)
                    (search-backward entry)
                    (overlay-put
                     (make-overlay (match-beginning 0) (match-end 0))
                     'face temp-face)))))
689
	  (setq entry-list (cdr entry-list))))
Edward M. Reingold's avatar
Edward M. Reingold committed
690 691 692 693
      (set-buffer-modified-p nil)
      (goto-char (point-min))
      (setq buffer-read-only t)
      (display-buffer fancy-diary-buffer)
694
      (fancy-diary-display-mode)
Glenn Morris's avatar
Glenn Morris committed
695
      (calendar-set-mode-line date-string)
Edward M. Reingold's avatar
Edward M. Reingold committed
696 697 698 699
      (message "Preparing diary...done"))))

(defun make-fancy-diary-buffer ()
  "Create and return the initial fancy diary buffer."
700
  (with-current-buffer (get-buffer-create fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
    (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))
721
      (with-current-buffer (get-buffer fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
722 723
        (run-hooks 'print-diary-entries-hook))
    (let ((diary-buffer
724
           (find-buffer-visiting (substitute-in-file-name diary-file))))
Edward M. Reingold's avatar
Edward M. Reingold committed
725
      (if diary-buffer
726
          (let ((temp-buffer (get-buffer-create " *Printable Diary Entries*"))
Edward M. Reingold's avatar
Edward M. Reingold committed
727
                (heading))
728
            (with-current-buffer diary-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
729 730 731 732
              (setq heading
                    (if (not (stringp mode-line-format))
                        "All Diary Entries"
                      (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
733 734 735 736 737 738 739 740 741 742 743 744 745 746
                      (match-string 1 mode-line-format)))
              (let ((start (point-min))
                    end)
                (while
                    (progn
                      (setq end (next-single-char-property-change
                                 start 'invisible))
                      (if (get-char-property start 'invisible)
                          nil
                        (with-current-buffer temp-buffer
                          (insert-buffer-substring diary-buffer
                                                   start (or end (point-max)))))
                      (setq start end)
                      (and end (< end (point-max))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
747 748 749 750 751 752 753 754
              (set-buffer temp-buffer)
              (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!")))))

755 756
(define-obsolete-function-alias 'show-all-diary-entries 'diary-show-all-entries)
(defun diary-show-all-entries ()
Edward M. Reingold's avatar
Edward M. Reingold committed
757 758 759 760 761
  "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
762 763
  (let ((d-file (diary-check-diary-file))
        (pop-up-frames (window-dedicated-p (selected-window))))
764 765
    (with-current-buffer (or (find-buffer-visiting d-file)
                             (find-file-noselect d-file t))
766
      (when (eq major-mode 'fundamental-mode) (diary-mode))
767 768
      (diary-unhide-everything)
      (display-buffer (current-buffer)))))
769

770
(defcustom diary-mail-addr
771
  (if (boundp 'user-mail-address) user-mail-address "")
772
  "Email address that `diary-mail-entries' will send email to."
773
  :group 'diary
774
  :type  'string
Dan Nicolaescu's avatar
Dan Nicolaescu committed
775
  :version "20.3")
776 777

(defcustom diary-mail-days 7
778
  "Default number of days for `diary-mail-entries' to check."
779
  :group 'diary
Dan Nicolaescu's avatar
Dan Nicolaescu committed
780 781
  :type 'integer
  :version "20.3")
782

783
;;;###autoload
784 785 786
(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'.
787
Mail is sent to the address specified by `diary-mail-addr'.
788 789 790 791 792 793 794 795 796 797

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 \\
798
             diary-file \\\"/path/to/diary.file\\\" \\
799 800
             european-calendar-style t \\
             diary-mail-addr \\\"user@host.name\\\" )\" \\
801
-l diary-lib -f diary-mail-entries
802 803 804 805 806 807
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."
808
  (interactive "P")
809 810 811 812 813 814 815 816 817
  (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)
818
         (with-current-buffer fancy-diary-buffer (buffer-string))
819 820
       "No entries found"))
    (call-interactively (get mail-user-agent 'sendfunc))))
821

822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
(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
839 840 841 842 843 844 845

(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.")

846
(defun mark-diary-entries (&optional redraw)
Edward M. Reingold's avatar
Edward M. Reingold committed
847
  "Mark days in the calendar window that have diary entries.
848 849 850 851 852
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.  If the optional argument REDRAW is non-nil (which is
the case interactively, for example) then any existing diary
853
marks are first removed.  This is intended to deal with deleted
854 855 856 857 858 859 860 861 862
diary entries."
  (interactive "p")
  ;; To remove any deleted diary entries. Do not redraw when:
  ;; i) processing #include diary files (else only get the marks from
  ;; the last #include file processed).
  ;; ii) called via calendar-redraw (since calendar has already been
  ;; erased).
  ;; Use of REDRAW handles both of these cases.
  (when (and redraw mark-diary-entries-in-calendar)
863 864
    (setq mark-diary-entries-in-calendar nil)
    (redraw-calendar))
865 866
  (let ((marking-diary-entries t)
        file-glob-attrs marks)
867 868
    (with-current-buffer (find-file-noselect (diary-check-diary-file) t)
      (save-excursion
869
        (when (eq major-mode 'fundamental-mode) (diary-mode))
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 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
        (setq mark-diary-entries-in-calendar t)
        (message "Marking diary entries...")
        (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
        (with-syntax-table diary-syntax-table
          (dolist (date-form diary-date-forms)
            (if (eq (car date-form) 'backup)
                (setq date-form (cdr date-form))) ;; ignore 'backup directive
            (let* ((dayname
                    (diary-name-pattern calendar-day-name-array
                                        calendar-day-abbrev-array))
                   (monthname
                    (format "%s\\|\\*"
                            (diary-name-pattern calendar-month-name-array
                                                calendar-month-abbrev-array)))
                   (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
                            (match-string-no-properties d-name-pos)))
                       (mm-name
                        (if m-name-pos
                            (match-string-no-properties m-name-pos)))
                       (mm (string-to-number
                            (if m-pos
                                (match-string-no-properties m-pos)
                              "")))
                       (dd (string-to-number
                            (if d-pos
                                (match-string-no-properties d-pos)
                              "")))
                       (y-str (if y-pos
                                  (match-string-no-properties 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-number y-str)
                                              (* 100
                                                 (/ current-y 100)))))
                                   (if (> (- y current-y) 50)
                                       (- y 100)
                                     (if (> (- current-y y) 50)
                                         (+ y 100)
                                       y)))
                               (string-to-number y-str)))))
                  (let ((tmp (diary-pull-attrs (buffer-substring-no-properties
                                                (point) (line-end-position))
                                               file-glob-attrs)))
                    (setq entry (nth 0 tmp)
                          marks (nth 1 tmp)))
                  (if dd-name
                      (mark-calendar-days-named
                       (cdr (assoc-string
                             dd-name
                             (calendar-make-alist
                              calendar-day-name-array
                              0 nil calendar-day-abbrev-array) t)) marks)
                    (if mm-name
                        (setq mm
                              (if (string-equal mm-name "*") 0
                                (cdr (assoc-string
                                      mm-name
                                      (calendar-make-alist
                                       calendar-month-name-array
                                       1 nil calendar-month-abbrev-array) t)))))
                    (mark-calendar-date-pattern mm dd yy marks))))))
          (mark-sexp-diary-entries)
          (run-hooks 'nongregorian-diary-marking-hook
                     'mark-diary-entries-hook))
962
        (message "Marking diary entries...done")))))
Edward M. Reingold's avatar
Edward M. Reingold committed
963 964 965 966 967 968 969

(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\\)\\("
970
                          sexp-mark "(\\)\\|\\("
Edward M. Reingold's avatar
Edward M. Reingold committed
971
                          (regexp-quote diary-nonmarking-symbol)
972 973 974
                          sexp-mark "(diary-remind\\)"))
         (file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
         m y first-date last-date mark file-glob-attrs)
975
    (with-current-buffer calendar-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
976 977 978 979 980 981 982 983 984 985 986
      (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)
987
      (setq marking-diary-entry (char-equal (preceding-char) ?\())
Edward M. Reingold's avatar
Edward M. Reingold committed
988 989
      (re-search-backward "(")
      (let ((sexp-start (point))
990
            sexp entry entry-start line-start marks)
Edward M. Reingold's avatar
Edward M. Reingold committed
991
        (forward-sexp)
992
        (setq sexp (buffer-substring-no-properties sexp-start (point)))
Edward M. Reingold's avatar
Edward M. Reingold committed
993 994 995 996 997 998 999 1000 1001 1002 1003
        (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))
1004
          ;; Find end of entry
Edward M. Reingold's avatar
Edward M. Reingold committed
1005 1006
          (re-search-forward "\^M\\|\n" nil t)
          (while (looking-at " \\|\^I")
1007 1008
 	    (or (re-search-forward "\^M\\|\n" nil t)
 		(re-search-forward "$" nil t)))
1009 1010 1011
          (if (or (char-equal (preceding-char) ?\^M)
 		  (char-equal (preceding-char) ?\n))
 	      (backward-char 1))
1012
          (setq entry (buffer-substring-no-properties entry-start (point)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1013 1014 1015
          (while (string-match "[\^M]" entry)
            (aset entry (match-beginning 0) ?\n )))
        (calendar-for-loop date from first-date to last-date do
1016 1017
          (if (setq mark (diary-sexp-entry sexp entry
                                (calendar-gregorian-from-absolute date)))
1018 1019
	      (progn
		(setq marks (diary-pull-attrs entry file-glob-attrs)
1020
		      marks (nth 1 (diary-pull-attrs entry file-glob-attrs)))
1021
		(mark-visible-calendar-date
1022
		 (calendar-gregorian-from-absolute date)
1023 1024 1025 1026
		 (if (< 0 (length marks))
		     marks
		   (if (consp mark)
		     (car mark)))))))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039

(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
1040
           "\\(?:\\`\\|\^M\\|\n\\)"
Edward M. Reingold's avatar
Edward M. Reingold committed
1041 1042 1043
           (regexp-quote diary-include-string)
           " \"\\([^\"]*\\)\"")
          nil t)
1044
    (let* ((diary-file (substitute-in-file-name
1045
                        (match-string-no-properties 1)))
1046 1047
           (mark-diary-entries-hook 'mark-included-diary-files)
           (dbuff (find-buffer-visiting diary-file)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1048 1049 1050 1051
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
              (progn
                (mark-diary-entries)
1052 1053
                (unless dbuff
                  (kill-buffer (find-buffer-visiting diary-file))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1054 1055 1056 1057 1058 1059 1060 1061
            (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)))

1062
(defun mark-calendar-days-named (dayname &optional color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1063 1064
  "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."
1065
  (with-current-buffer calendar-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
    (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)
1079
        (mark-visible-calendar-date (calendar-gregorian-from-absolute day) color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1080 1081
        (setq day (+ day 7))))))

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

1093
(defun mark-calendar-month (month year p-month p-day p-year &optional color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1094 1095 1096 1097 1098 1099 1100 1101 1102
  "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
1103 1104
            (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
1105 1106 1107 1108 1109 1110 1111 1112 1113

(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))
1114 1115 1116 1117 1118
           (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
1119

1120 1121
(defcustom diary-unknown-time
  -9999
1122
  "Value returned by diary-entry-time when no time is found.
1123 1124 1125 1126
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
1127 1128
  :group 'diary
  :version "20.3")
1129

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

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
1136 1137
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."
1138
  (let ((case-fold-search nil))
1139
    (cond ((string-match        ; Military time
1140 1141
	    "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)"
            s)
1142 1143
	   (+ (* 100 (string-to-number (match-string 1 s)))
	      (string-to-number (match-string 2 s))))
1144
	  ((string-match        ; Hour only  XXam or XXpm
1145
	    "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s)
1146
	   (+ (* 100 (% (string-to-number (match-string 1 s)) 12))
1147 1148
	      (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
	   (+ (* 100 (% (string-to-number (match-string 1 s)) 12))
	      (string-to-number (match-string 2 s))
1153 1154
	      (if (equal ?a (downcase (aref s (match-beginning 3))))
		  0 1200)))
1155
	  (t diary-unknown-time)))) ; Unrecognizable
1156

1157 1158
;; Unrecognizable

Edward M. Reingold's avatar
Edward M. Reingold committed
1159 1160 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
(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:

1186
      %%(diary-date MONTH DAY YEAR &optional MARK) text
Edward M. Reingold's avatar
Edward M. Reingold committed
1187 1188 1189 1190
                  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.
1191
                  The constant t means all values.  An optional parameter
1192 1193
                  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
1194

1195
      %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
Edward M. Reingold's avatar
Edward M. Reingold committed
1196 1197 1198 1199
                  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
1200 1201
                  month, or t to specify all months. Optional DAY means
                  Nth DAYNAME of MONTH on or after/before DAY.  DAY defaults
1202 1203
                  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
1204
                  string to use when highlighting the day in the calendar.
Edward M. Reingold's avatar
Edward M. Reingold committed
1205

1206
      %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
Edward M. Reingold's avatar
Edward M. Reingold committed
1207 1208 1209
                  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,
1210 1211
                  D2, M2, Y2.)  An optional parameter MARK specifies a face
                  or single-character string to use when highlighting the
1212
                  day in the calendar.
Edward M. Reingold's avatar
Edward M. Reingold committed
1213

1214
      %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
Edward M. Reingold's avatar
Edward M. Reingold committed
1215 1216 1217 1218 1219 1220 1221
                  Entry will appear on anniversary dates of MONTH DAY, YEAR.