diary-lib.el 93.7 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, 2001, 2002, 2003,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2004, 2005, 2006, 2007  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
         (read-file-name "Enter diary file name: " default-directory nil t)))
  (let ((diary-file d-file))
82
    (diary-view-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
(autoload 'diary-bahai-date "cal-bahai"
Glenn Morris's avatar
Glenn Morris committed
124
  "Baha'i calendar equivalent of date diary entry.")
125 126

(autoload 'list-bahai-diary-entries "cal-bahai"
Glenn Morris's avatar
Glenn Morris committed
127
  "Add any Baha'i date entries from the diary file to `diary-entries-list'.")
128 129

(autoload 'mark-bahai-diary-entries "cal-bahai"
Glenn Morris's avatar
Glenn Morris committed
130
  "Mark days in the calendar window that have Baha'i date diary entries.")
131 132

(autoload 'mark-bahai-calendar-date-pattern "cal-bahai"
Glenn Morris's avatar
Glenn Morris committed
133
   "Mark dates in calendar window that conform to Baha'i date MONTH/DAY/YEAR.")
134

Edward M. Reingold's avatar
Edward M. Reingold committed
135
(autoload 'diary-hebrew-date "cal-hebrew"
136
  "Hebrew calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
137 138

(autoload 'diary-omer "cal-hebrew"
139
  "Omer count diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
140 141

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

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

(autoload 'diary-rosh-hodesh "cal-hebrew"
148
  "Rosh Hodesh diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
149 150

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

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

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

(autoload 'diary-coptic-date "cal-coptic"
160
  "Coptic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
161 162

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

165
(autoload 'diary-persian-date "cal-persia"
166
  "Persian calendar equivalent of date diary entry.")
167

168
(autoload 'diary-phases-of-moon "lunar" "Moon phases diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
169 170

(autoload 'diary-sunrise-sunset "solar"
171
  "Local time of sunrise and sunset as a diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
172 173 174

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

177 178 179 180 181
(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
182 183
  "The syntax table used when parsing dates in the diary file.
It is the standard syntax table used in Fundamental mode, but with the
184
syntax of `*' and `:' changed to be word constituents.")
Edward M. Reingold's avatar
Edward M. Reingold committed
185

186 187 188 189 190 191 192 193 194
(defvar diary-entries-list)
(defvar displayed-year)
(defvar displayed-month)
(defvar entry)
(defvar date)
(defvar number)
(defvar date-string)
(defvar original-date)

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

212 213

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


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

276 277
(defvar diary-selective-display nil)

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

Glenn Morris's avatar
Glenn Morris committed
291 292
(defvar diary-saved-point)		; internal

Glenn Morris's avatar
Glenn Morris committed
293 294 295 296 297 298 299 300 301 302
(defun diary-live-p ()
  "Return non-nil if the diary is being displayed.
This is not the same as just visiting the `diary-file'."
  (or (get-buffer fancy-diary-buffer)
      (when diary-file
        (let ((dbuff (find-buffer-visiting
                      (substitute-in-file-name diary-file))))
          (when dbuff
            (with-current-buffer dbuff
              diary-selective-display))))))
303 304 305 306 307 308 309 310 311 312

(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
313 314 315 316
says to display no diary entries on Sunday, the entries for
the current date and the day after on Monday through Thursday,
Friday through Monday's entries on Friday, and only Saturday's
entries on Saturday.
317 318 319 320 321 322 323 324 325 326 327 328 329

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")))
Glenn Morris's avatar
Glenn Morris committed
330 331 332 333 334 335 336 337 338
  :initialize 'custom-initialize-default
  ;; Redraw a live diary buffer if necessary. Note this assumes diary
  ;; was not called with a prefix arg.
  :set (lambda (symbol value)
         (let ((oldvalue number-of-diary-entries))
           (custom-set-default symbol value)
           (and (not (equal value oldvalue))
                (diary-live-p)
                (diary))))
339 340
  :group 'diary)

Glenn Morris's avatar
Glenn Morris committed
341 342 343 344 345 346 347 348 349 350 351 352 353

(defvar diary-modify-entry-list-string-function nil
  "Function applied to entry string before putting it into the entries list.
Can be used by programs integrating a diary list into other buffers (e.g.
org.el and planner.el) to modify the string or add properties to it.
The function takes a string argument and must return a string.")

(defun add-to-diary-list (date string specifier &optional marker
                               globcolor literal)
  "Add an entry to `diary-entries-list'.
Do nothing if DATE or STRING is nil.  DATE is the (MONTH DAY
YEAR) for which the entry applies; STRING is the text of the
entry as it will appear in the diary (i.e. with any format
354
strings such as \"%d\" expanded); SPECIFIER is the date part of
Glenn Morris's avatar
Glenn Morris committed
355
the entry as it appears in the diary-file; LITERAL is the entry
356
as it appears in the diary-file (i.e. before expansion).  If
Glenn Morris's avatar
Glenn Morris committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
LITERAL is nil, it is taken to be the same as STRING.

The entry is added to the list as (DATE STRING SPECIFIER LOCATOR
GLOBCOLOR), where LOCATOR has the form (MARKER FILENAME LITERAL),
FILENAME being the file containing the diary entry."
  (when (and date string)
    (if diary-file-name-prefix
        (let ((prefix (funcall diary-file-name-prefix-function
                               (buffer-file-name))))
          (or (string= prefix "")
              (setq string (format "[%s] %s" prefix string)))))
    (and diary-modify-entry-list-string-function
	 (setq string (funcall diary-modify-entry-list-string-function
			       string)))
    (setq diary-entries-list
          (append diary-entries-list
                  (list (list date string specifier
                              (list marker (buffer-file-name) literal)
                              globcolor))))))

377
(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries)
378
(defun diary-list-entries (date number &optional list-only)
379
  "Create and display a buffer containing the relevant lines in `diary-file'.
Edward M. Reingold's avatar
Edward M. Reingold committed
380 381
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
382
using selective display.  If NUMBER is less than 1, this function does nothing.
Edward M. Reingold's avatar
Edward M. Reingold committed
383 384

Returns a list of all relevant diary entries found, if any, in order by date.
385 386 387 388
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
389
for a date with no diary entries.
Edward M. Reingold's avatar
Edward M. Reingold committed
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

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
410 411 412
        notification function.

If LIST-ONLY is non-nil don't modify or display the buffer, only return a list."
413 414 415 416
  (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
417 418 419 420 421 422 423 424 425 426 427 428 429 430
  (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))))
431
        ;; Setup things like the header-line-format and invisibility-spec.
432
        (when (eq major-mode default-major-mode) (diary-mode))
Glenn Morris's avatar
Glenn Morris committed
433 434 435 436
        ;; 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 "")))
437
            (with-syntax-table diary-syntax-table
438
              (let ((mark (regexp-quote diary-nonmarking-symbol)))
439
                (goto-char (point-min))
440 441 442 443 444
                (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)))
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
                (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 "?\\("
475
                            (mapconcat 'eval date-form "\\)\\(?:")
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
                            "\\)"))
                          (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))
493 494 495 496 497 498 499 500 501 502 503
                             ;; When selective display (rather than
                             ;; overlays) was used, diary file used to
                             ;; start in a blank line and end in a
                             ;; newline. Now that neither of these
                             ;; need be true, 'move handles the latter
                             ;; and 1/2 kludge the former.
                             (re-search-forward
                              "\^M\\|\n" nil 'move
                              (if (and (bobp) (not (looking-at "\^M\\|\n")))
                                  1
                                2))
504
                             (while (looking-at " \\|\^I")
505
                               (re-search-forward "\^M\\|\n" nil 'move))
506 507
                             (unless (and (eobp) (not (bolp)))
                               (backward-char 1))
508 509 510
                             (unless list-only
                               (remove-overlays date-start (point)
                                                'invisible 'diary))
511 512 513 514 515 516 517 518 519 520 521
                             (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)
Glenn Morris's avatar
Glenn Morris committed
522
                       (add-to-diary-list date "" "" "" ""))
523 524 525
                   (setq date
                         (calendar-gregorian-from-absolute
                          (1+ (calendar-absolute-from-gregorian date))))
526
                   (setq entry-found nil)))))
Glenn Morris's avatar
Glenn Morris committed
527 528 529
            (goto-char (point-min))
            (run-hooks 'nongregorian-diary-listing-hook
                       'list-diary-entries-hook)
530 531 532 533
            (unless list-only
              (if diary-display-hook
                  (run-hooks 'diary-display-hook)
                (simple-diary-display)))
Glenn Morris's avatar
Glenn Morris committed
534 535
            (run-hooks 'diary-hook)
            diary-entries-list))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
536

537
(defun diary-unhide-everything ()
538 539
  (kill-local-variable 'diary-selective-display)
  (remove-overlays (point-min) (point-max) 'invisible 'diary)
540 541
  (kill-local-variable 'mode-line-format))

Edward M. Reingold's avatar
Edward M. Reingold committed
542 543 544 545 546 547 548 549 550 551 552 553
(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
554
           "\\(?:\\`\\|\^M\\|\n\\)"
Edward M. Reingold's avatar
Edward M. Reingold committed
555 556 557
           (regexp-quote diary-include-string)
           " \"\\([^\"]*\\)\"")
          nil t)
558
    (let* ((diary-file (substitute-in-file-name
559
                        (match-string-no-properties 1)))
560 561 562
           (diary-list-include-blanks nil)
           (list-diary-entries-hook 'include-other-diary-files)
           (diary-display-hook 'ignore)
563
           (diary-hook nil))
Edward M. Reingold's avatar
Edward M. Reingold committed
564 565 566 567 568
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
              (unwind-protect
                  (setq diary-entries-list
                        (append diary-entries-list
569
                                (diary-list-entries original-date number)))
570 571
                (with-current-buffer (find-buffer-visiting diary-file)
                  (diary-unhide-everything)))
Edward M. Reingold's avatar
Edward M. Reingold committed
572 573 574 575 576 577 578 579 580 581 582 583
            (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)))
584 585 586 587 588 589 590 591 592
         (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
593 594 595
    (if (or (not diary-entries-list)
            (and (not (cdr diary-entries-list))
                 (string-equal (car (cdr (car diary-entries-list))) "")))
596
        (if (< (length msg) (frame-width))
597
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
598 599 600 601 602 603 604 605 606 607
          (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
608 609 610 611 612 613
      (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
614 615
      (message "Preparing diary...done"))))

616 617
(defface diary-button '((((type pc) (class color))
			 (:foreground "lightblue")))
618
  "Default face used for buttons."
619
  :version "22.1"
620
  :group 'diary)
621 622
;; backward-compatibility alias
(put 'diary-button-face 'face-alias 'diary-button)
623 624 625

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

(defun diary-goto-entry (button)
Glenn Morris's avatar
Glenn Morris committed
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
  (let* ((locator (button-get button 'locator))
         (marker (car locator))
         markbuf file)
    ;; If marker pointing to diary location is valid, use that.
    (if (and marker (setq markbuf (marker-buffer marker)))
        (progn
          (pop-to-buffer markbuf)
          (goto-char (marker-position marker)))
      ;; Marker is invalid (eg buffer has been killed).
      (or (and (setq file (cadr locator))
               (file-exists-p file)
               (find-file-other-window file)
               (progn
                 (when (eq major-mode default-major-mode) (diary-mode))
                 (goto-char (point-min))
                 (if (re-search-forward (format "%s.*\\(%s\\)"
                                                (regexp-quote (nth 2 locator))
                                                (regexp-quote (nth 3 locator)))
                                        nil t)
                     (goto-char (match-beginning 1)))))
          (message "Unable to locate this diary entry")))))
650

Edward M. Reingold's avatar
Edward M. Reingold committed
651 652 653
(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'."
654 655 656
  (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
657 658 659 660 661 662 663 664 665
  (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))
666
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
667 668 669 670 671 672 673 674 675
          (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)))
676 677
    (with-current-buffer;; Prepare the fancy diary buffer.
        (make-fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
      (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))
701 702 703 704
                     (progn
                       (increment-calendar-month
                        holiday-list-last-month holiday-list-last-year 1)
                       t)
Edward M. Reingold's avatar
Edward M. Reingold committed
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
                     (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 ":  "))
723 724
                  (let* ((l (current-column))
                         (longest 0))
725 726 727 728
                    (insert (mapconcat (lambda (x)
					 (if (< longest (length x))
					     (setq longest (length x)))
					 x)
729 730 731
                                       date-holiday-list
                                       (concat "\n" (make-string l ? ))))
                    (insert ?\n (make-string (+ l longest) ?=) ?\n)))))
732 733 734

	  (setq entry (car (cdr (car entry-list))))
	  (if (< 0 (length entry))
Glenn Morris's avatar
Glenn Morris committed
735 736 737
              (let ((this-entry (car entry-list))
                    this-loc)
		(if (setq this-loc (nth 3 this-entry))
738
		    (insert-button (concat entry "\n")
Glenn Morris's avatar
Glenn Morris committed
739 740 741 742 743 744
                                   ;; (MARKER FILENAME SPECIFIER LITERAL)
                                   'locator (list (car this-loc)
                                                  (cadr this-loc)
                                                  (nth 2 this-entry)
                                                  (or (nth 2 this-loc)
                                                      (nth 1 this-entry)))
745 746 747
				   :type 'diary-entry)
		  (insert entry ?\n))
		(save-excursion
Glenn Morris's avatar
Glenn Morris committed
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
                  (let* ((marks (nth 4 this-entry))
                         (faceinfo marks)
                         temp-face)
                    (when marks
                      (setq temp-face (make-symbol
                                       (apply
                                        'concat "temp-face-"
                                        (mapcar (lambda (sym)
                                                  (if (stringp sym)
                                                      sym
                                                    (symbol-name sym)))
                                                marks))))
                      (make-face temp-face)
                      ;; Remove :face info from the marks,
                      ;; 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))
                      ;; Apply the font aspects.
                      (apply 'set-face-attribute temp-face nil marks)
                      (search-backward entry)
                      (overlay-put
                       (make-overlay (match-beginning 0) (match-end 0))
                       'face temp-face))))))
774
	  (setq entry-list (cdr entry-list))))
Edward M. Reingold's avatar
Edward M. Reingold committed
775 776 777 778
      (set-buffer-modified-p nil)
      (goto-char (point-min))
      (setq buffer-read-only t)
      (display-buffer fancy-diary-buffer)
779
      (fancy-diary-display-mode)
Glenn Morris's avatar
Glenn Morris committed
780
      (calendar-set-mode-line date-string)
Edward M. Reingold's avatar
Edward M. Reingold committed
781 782 783 784
      (message "Preparing diary...done"))))

(defun make-fancy-diary-buffer ()
  "Create and return the initial fancy diary buffer."
785
  (with-current-buffer (get-buffer-create fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
    (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))
806
      (with-current-buffer (get-buffer fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
807 808
        (run-hooks 'print-diary-entries-hook))
    (let ((diary-buffer
809
           (find-buffer-visiting (substitute-in-file-name diary-file))))
Edward M. Reingold's avatar
Edward M. Reingold committed
810
      (if diary-buffer
811
          (let ((temp-buffer (get-buffer-create " *Printable Diary Entries*"))
Edward M. Reingold's avatar
Edward M. Reingold committed
812
                (heading))
813
            (with-current-buffer diary-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
814 815 816 817
              (setq heading
                    (if (not (stringp mode-line-format))
                        "All Diary Entries"
                      (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
818 819 820 821 822 823 824 825 826 827 828 829 830 831
                      (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
832 833 834 835 836 837 838 839
              (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!")))))

840 841
(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
842 843 844 845 846
  "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
847 848
  (let ((d-file (diary-check-diary-file))
        (pop-up-frames (window-dedicated-p (selected-window))))
849 850
    (with-current-buffer (or (find-buffer-visiting d-file)
                             (find-file-noselect d-file t))
851
      (when (eq major-mode default-major-mode) (diary-mode))
852 853
      (diary-unhide-everything)
      (display-buffer (current-buffer)))))
854

855
(defcustom diary-mail-addr
856
  (if (boundp 'user-mail-address) user-mail-address "")
857
  "Email address that `diary-mail-entries' will send email to."
858
  :group 'diary
859
  :type  'string
Dan Nicolaescu's avatar
Dan Nicolaescu committed
860
  :version "20.3")
861 862

(defcustom diary-mail-days 7
863
  "Default number of days for `diary-mail-entries' to check."
864
  :group 'diary
Dan Nicolaescu's avatar
Dan Nicolaescu committed
865 866
  :type 'integer
  :version "20.3")
867

868
;;;###autoload
869 870 871
(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'.
872
Mail is sent to the address specified by `diary-mail-addr'.
873 874 875 876 877 878 879 880 881 882

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 \\
883
             diary-file \\\"/path/to/diary.file\\\" \\
884 885
             european-calendar-style t \\
             diary-mail-addr \\\"user@host.name\\\" )\" \\
886
-l diary-lib -f diary-mail-entries
887 888 889 890 891 892
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."
893
  (interactive "P")
894 895 896
  (if (string-equal diary-mail-addr "")
      (error "You must set `diary-mail-addr' to use this command")
    (let ((diary-display-hook 'fancy-diary-display))
897
      (diary-list-entries (calendar-current-date) (or ndays diary-mail-days)))
898 899 900 901 902
    (compose-mail diary-mail-addr
                  (concat "Diary entries generated "
                          (calendar-date-string (calendar-current-date))))
    (insert
     (if (get-buffer fancy-diary-buffer)
903
         (with-current-buffer fancy-diary-buffer (buffer-string))
904 905
       "No entries found"))
    (call-interactively (get mail-user-agent 'sendfunc))))
906

907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
(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
924 925 926 927 928 929 930

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

931
(defun mark-diary-entries (&optional redraw)
Edward M. Reingold's avatar
Edward M. Reingold committed
932
  "Mark days in the calendar window that have diary entries.
933 934 935 936 937
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
938
marks are first removed.  This is intended to deal with deleted
939 940 941 942 943 944 945 946 947
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)
948 949
    (setq mark-diary-entries-in-calendar nil)
    (redraw-calendar))
950 951
  (let ((marking-diary-entries t)
        file-glob-attrs marks)
952 953
    (with-current-buffer (find-file-noselect (diary-check-diary-file) t)
      (save-excursion
954
        (when (eq major-mode default-major-mode) (diary-mode))
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
        (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))
1047
        (message "Marking diary entries...done")))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1048 1049 1050 1051 1052 1053 1054

(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\\)\\("
1055
                          sexp-mark "(\\)\\|\\("
Edward M. Reingold's avatar
Edward M. Reingold committed
1056
                          (regexp-quote diary-nonmarking-symbol)
1057 1058 1059
                          sexp-mark "(diary-remind\\)"))
         (file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
         m y first-date last-date mark file-glob-attrs)
1060
    (with-current-buffer calendar-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
      (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)
1072
      (setq marking-diary-entry (char-equal (preceding-char) ?\())
Edward M. Reingold's avatar
Edward M. Reingold committed
1073 1074
      (re-search-backward "(")
      (let ((sexp-start (point))
1075
            sexp entry entry-start line-start marks)
Edward M. Reingold's avatar
Edward M. Reingold committed
1076
        (forward-sexp)
1077
        (setq sexp (buffer-substring-no-properties sexp-start (point)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
        (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))
1089
          ;; Find end of entry
Edward M. Reingold's avatar
Edward M. Reingold committed
1090 1091
          (re-search-forward "\^M\\|\n" nil t)
          (while (looking-at " \\|\^I")
1092 1093
 	    (or (re-search-forward "\^M\\|\n" nil t)
 		(re-search-forward "$" nil t)))
1094 1095 1096
          (if (or (char-equal (preceding-char) ?\^M)
 		  (char-equal (preceding-char) ?\n))
 	      (backward-char 1))
1097
          (setq entry (buffer-substring-no-properties entry-start (point)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1098 1099 1100
          (while (string-match "[\^M]" entry)
            (aset entry (match-beginning 0) ?\n )))
        (calendar-for-loop date from first-date to last-date do
1101 1102
          (if (setq mark (diary-sexp-entry sexp entry
                                (calendar-gregorian-from-absolute date)))
1103 1104
	      (progn
		(setq marks (diary-pull-attrs entry file-glob-attrs)
1105
		      marks (nth 1 (diary-pull-attrs entry file-glob-attrs)))
1106
		(mark-visible-calendar-date
1107
		 (calendar-gregorian-from-absolute date)
1108 1109 1110 1111
		 (if (< 0 (length marks))
		     marks
		   (if (consp mark)
		     (car mark)))))))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124

(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
1125
           "\\(?:\\`\\|\^M\\|\n\\)"
Edward M. Reingold's avatar
Edward M. Reingold committed
1126 1127 1128
           (regexp-quote diary-include-string)
           " \"\\([^\"]*\\)\"")
          nil t)
1129
    (let* ((diary-file (substitute-in-file-name
1130
                        (match-string-no-properties 1)))
1131 1132
           (mark-diary-entries-hook 'mark-included-diary-files)
           (dbuff (find-buffer-visiting diary-file)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1133 1134 1135 1136
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
              (progn
                (mark-diary-entries)
1137 1138
                (unless dbuff
                  (kill-buffer (find-buffer-visiting diary-file))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1139 1140 1141 1142 1143 1144 1145 1146
            (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)))

1147
(defun mark-calendar-days-named (dayname &optional color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1148 1149
  "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."
1150
  (with-current-buffer calendar-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
    (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)
1164
        (mark-visible-calendar-date (calendar-gregorian-from-absolute day) color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1165 1166
        (setq day (+ day 7))))))

1167
(defun mark-calendar-date-pattern (month day year &optional color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1168 1169
  "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
A value of 0 in any position is a wildcard."
1170
  (with-current-buffer calendar-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
1171 1172 1173 1174
    (let ((m displayed-month)
          (y displayed-year))
      (increment-calendar-month m y -1)
      (calendar-for-loop i from 0 to 2 do
1175
          (mark-calendar-month m y month day year color)
Edward M. Reingold's avatar
Edward M. Reingold committed
1176 1177
          (increment-calendar-month m y 1)))))

Juanma Barranquero's avatar