diary-lib.el 101 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, 2008  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
;; 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
14
;; the Free Software Foundation; either version 3, or (at your option)
Edward M. Reingold's avatar
Edward M. Reingold committed
15 16 17 18 19 20 21 22
;; 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

;;; Commentary:

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

;;; Code:

(require 'calendar)

Glenn Morris's avatar
Glenn Morris committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
(defcustom diary-include-string "#include"
  "The string indicating inclusion of another file of diary entries.
See the documentation for the function `include-other-diary-files'."
  :type 'string
  :group 'diary)

(defcustom diary-list-include-blanks nil
  "If nil, do not include days with no diary entry in the list of diary entries.
Such days will then not be shown in the fancy diary buffer, even if they
are holidays."
  :type 'boolean
  :group 'diary)

(defcustom diary-glob-file-regexp-prefix "^\\#"
  "Regular expression prepended to attribute-regexps for file-wide specifiers."
  :type 'regexp
  :group 'diary)

(defcustom diary-face 'diary
  "Face name to use for diary entries."
  :type 'face
  :group 'diary)
(make-obsolete-variable 'diary-face "customize the face `diary' instead."
			"23.1")

(defcustom diary-face-attrs
  '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string)
    (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string)
    (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol)
    (" *\\[height:\\([-0-9a-z]+\\)\\]$" 1 :height int)
    (" *\\[weight:\\([-a-z]+\\)\\]$" 1 :weight symbol)
    (" *\\[slant:\\([-a-z]+\\)\\]$" 1 :slant symbol)
    (" *\\[underline:\\([-a-z]+\\)\\]$" 1 :underline stringtnil)
    (" *\\[overline:\\([-a-z]+\\)\\]$" 1 :overline stringtnil)
    (" *\\[strike-through:\\([-a-z]+\\)\\]$" 1 :strike-through stringtnil)
    (" *\\[inverse-video:\\([-a-z]+\\)\\]$" 1 :inverse-video tnil)
    (" *\\[face:\\([-0-9a-z]+\\)\\]$" 1 :face string)
    (" *\\[font:\\([-a-z0-9]+\\)\\]$" 1 :font string)
    ;; Unsupported.
;;;    (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box)
;;;    (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple)
    )
  "A list of (regexp regnum attr attrtype) lists where the
regexp says how to find the tag, the regnum says which
parenthetical sub-regexp this regexp looks for, and the attr says
which attribute of the face (or that this _is_ a face) is being
modified."
  :type 'sexp
  :group 'diary)

(defcustom diary-file-name-prefix nil
  "Non-nil means prefix each diary entry with the name of the file defining it."
  :type 'boolean
  :group 'diary)

(defcustom diary-file-name-prefix-function 'identity
  "The function that will take a diary file name and return the desired prefix."
  :type 'function
  :group 'diary)

(defcustom sexp-diary-entry-symbol "%%"
  "The string used to indicate a sexp diary entry in `diary-file'.
See the documentation for the function `list-sexp-diary-entries'."
  :type 'string
  :group 'diary)

(defcustom list-diary-entries-hook nil
  "List of functions called after diary file is culled for relevant entries.
It is to be used for diary entries that are not found in the diary file.

A function `include-other-diary-files' is provided for use as the value of
this hook.  This function enables you to use shared diary files together
with your own.  The files included are specified in the diary file by lines
of the form

        #include \"filename\"

This is recursive; that is, #include directives in files thus included are
obeyed.  You can change the \"#include\" to some other string by changing
the variable `diary-include-string'.  When you use `include-other-diary-files'
as part of the list-diary-entries-hook, you will probably also want to use the
function `mark-included-diary-files' as part of `mark-diary-entries-hook'.

For example, you could use

     (setq list-diary-entries-hook
       '(include-other-diary-files sort-diary-entries))
     (setq diary-display-hook 'fancy-diary-display)

in your `.emacs' file to cause the fancy diary buffer to be displayed with
diary entries from various included files, each day's entries sorted into
lexicographic order."
  :type 'hook
  :options '(include-other-diary-files sort-diary-entries)
  :group 'diary)

(defcustom mark-diary-entries-hook nil
  "List of functions called after marking diary entries in the calendar.

A function `mark-included-diary-files' is also provided 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 the form
        #include \"filename\"
This is recursive; that is, #include directives in files thus included are
obeyed.  You can change the \"#include\" to some other string by changing the
variable `diary-include-string'.  When you use `mark-included-diary-files' as
part of the mark-diary-entries-hook, you will probably also want to use the
function `include-other-diary-files' as part of `list-diary-entries-hook'."
  :type 'hook
  :options '(mark-included-diary-files)
  :group 'diary)

(defcustom nongregorian-diary-listing-hook nil
  "List of functions called for listing diary file and included files.
As the files are processed for diary entries, these functions are used
to cull relevant entries.  You can use either or both of
`list-hebrew-diary-entries', `list-islamic-diary-entries' and
`diary-bahai-list-entries'.  The documentation for these functions
describes the style of such diary entries."
  :type 'hook
  :options '(list-hebrew-diary-entries
	     list-islamic-diary-entries
	     diary-bahai-list-entries)
  :group 'diary)

(defcustom nongregorian-diary-marking-hook nil
  "List of functions called for marking diary file and included files.
As the files are processed for diary entries, these functions are used
to cull relevant entries.  You can use either or both of
`mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
`mark-bahai-diary-entries'.  The documentation for these functions
describes the style of such diary entries."
  :type 'hook
  :options '(mark-hebrew-diary-entries
	     mark-islamic-diary-entries
	     diary-bahai-mark-entries)
  :group 'diary)

(defcustom print-diary-entries-hook 'lpr-buffer
  "List of functions called after a temporary diary buffer is prepared.
The buffer shows only the diary entries currently visible in the diary
buffer.  The default just does the printing.  Other uses might include, for
example, rearranging the lines into order by day and time, saving the buffer
instead of deleting it, or changing the function used to do the printing."
  :type 'hook
  :group 'diary)

(defcustom diary-unknown-time -9999
  "Value returned by diary-entry-time when no time is found.
The default value -9999 causes entries with no recognizable time to be placed
before those with times; 9999 would place entries with no recognizable time
after those with times."
  :type 'integer
  :group 'diary
  :version "20.3")

(defcustom diary-mail-addr
  (if (boundp 'user-mail-address) user-mail-address "")
  "Email address that `diary-mail-entries' will send email to."
  :group 'diary
  :type  'string
  :version "20.3")

(defcustom diary-mail-days 7
  "Default number of days for `diary-mail-entries' to check."
  :group 'diary
  :type 'integer
  :version "20.3")

(defcustom diary-remind-message
  '("Reminder: Only "
    (if (= 0 (% days 7))
        (concat (int-to-string (/ days 7)) (if (= 7 days) " week" " weeks"))
      (concat (int-to-string days) (if (= 1 days) " day" " days")))
    " until "
    diary-entry)
  "Pseudo-pattern giving form of reminder messages in the fancy diary display.

Used by the function `diary-remind', a pseudo-pattern is a list of
expressions that can involve the keywords `days' (a number), `date' (a list of
month, day, year), and `diary-entry' (a string)."
  :type 'sexp
  :group 'diary)

(defcustom diary-outlook-formats
  '(
    ;; When: 11 October 2001 12:00-14:00 (GMT) Greenwich Mean Time : Dublin, ...
    ;; [Current UK format?  The timezone is meaningless.  Sometimes the
    ;; Where is missing.]
    ("When: \\([0-9]+ [[:alpha:]]+ [0-9]+\\) \
\\([^ ]+\\) [^\n]+
\[^\n]+
\\(?:Where: \\([^\n]+\\)\n+\\)?
\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*"
     . "\\1\n \\2 %s, \\3")
    ;; When: Tuesday, April 30, 2002 03:00 PM-03:30 PM (GMT) Greenwich Mean ...
    ;; [Old UK format?]
    ("^When: [[:alpha:]]+, \\([[:alpha:]]+\\) \\([0-9][0-9]*\\), \\([0-9]\\{4\\}\\) \
\\([^ ]+\\) [^\n]+
\[^\n]+
\\(?:Where: \\([^\n]+\\)\\)?\n+"
     . "\\2 \\1 \\3\n \\4 %s, \\5")
    (
     ;; German format, apparently.
     "^Zeit: [^ ]+, +\\([0-9]+\\)\. +\\([[:upper:]][[:lower:]][[:lower:]]\\)[^ ]* +\\([0-9]+\\) +\\([^ ]+\\).*$"
     . "\\1 \\2 \\3\n \\4 %s"))
  "Alist of regexps matching message text and replacement text.

The regexp must match the start of the message text containing an
appointment, but need not include a leading `^'.  If it matches the
current message, a diary entry is made from the corresponding
template.  If the template is a string, it should be suitable for
passing to `replace-match', and so will have occurrences of `\\D' to
substitute the match for the Dth subexpression.  It must also contain
a single `%s' which will be replaced with the text of the message's
Subject field.  Any other `%' characters must be doubled, so that the
template can be passed to `format'.

If the template is actually a function, it is called with the message
body text as argument, and may use `match-string' etc. to make a
template following the rules above."
  :type '(alist :key-type (regexp :tag "Regexp matching time/place")
		:value-type (choice
			     (string :tag "Template for entry")
			     (function :tag
				       "Unary function providing template")))
  :version "22.1"
  :group 'diary)

;;; More user options below and in calendar.el.


269 270 271 272 273 274 275 276 277 278
(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
279 280 281 282
;;;###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
283 284
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
285
  (interactive "P")
286 287
  (diary-check-diary-file)
  (let ((date (calendar-current-date)))
288 289 290 291
    (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
292 293 294 295 296
  "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")
297
  (diary-check-diary-file)
298
  (diary-list-entries (calendar-cursor-to-date t) arg))
Edward M. Reingold's avatar
Edward M. Reingold committed
299

300
(defun view-other-diary-entries (arg d-file)
Edward M. Reingold's avatar
Edward M. Reingold committed
301
  "Prepare and display buffer of diary entries from an alternative diary file.
302 303 304
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
305
  (interactive
306
   (list (prefix-numeric-value current-prefix-arg)
307 308
         (read-file-name "Enter diary file name: " default-directory nil t)))
  (let ((diary-file d-file))
309
    (diary-view-entries arg)))
Edward M. Reingold's avatar
Edward M. Reingold committed
310

311
(autoload 'calendar-check-holidays "holidays"
Edward M. Reingold's avatar
Edward M. Reingold committed
312 313
  "Check the list of holidays for any that occur on DATE.
The value returned is a list of strings of relevant holiday descriptions.
314
The holidays are those in the list `calendar-holidays'.")
Edward M. Reingold's avatar
Edward M. Reingold committed
315 316 317

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

(autoload 'diary-french-date "cal-french"
321
  "French calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
322 323

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

Edward M. Reingold's avatar
Edward M. Reingold committed
326
(autoload 'diary-iso-date "cal-iso"
327
  "ISO calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
328

Edward M. Reingold's avatar
Edward M. Reingold committed
329
(autoload 'diary-julian-date "cal-julian"
330
  "Julian calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
331 332

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

335
(autoload 'diary-chinese-date "cal-china"
336
  "Chinese calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
337

338
(autoload 'diary-islamic-date "cal-islam"
339
  "Islamic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
340

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

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

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

350
(autoload 'diary-bahai-date "cal-bahai"
Glenn Morris's avatar
Glenn Morris committed
351
  "Baha'i calendar equivalent of date diary entry.")
352

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

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

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

Edward M. Reingold's avatar
Edward M. Reingold committed
362
(autoload 'diary-hebrew-date "cal-hebrew"
363
  "Hebrew calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
364 365

(autoload 'diary-omer "cal-hebrew"
366
  "Omer count diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
367 368

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

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

(autoload 'diary-rosh-hodesh "cal-hebrew"
375
  "Rosh Hodesh diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
376 377

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

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

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

(autoload 'diary-coptic-date "cal-coptic"
387
  "Coptic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
388 389

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

392
(autoload 'diary-persian-date "cal-persia"
393
  "Persian calendar equivalent of date diary entry.")
394

395
(autoload 'diary-phases-of-moon "lunar" "Moon phases diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
396 397

(autoload 'diary-sunrise-sunset "solar"
398
  "Local time of sunrise and sunset as a diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
399 400 401

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

404 405 406 407 408
(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
409 410
  "The syntax table used when parsing dates in the diary file.
It is the standard syntax table used in Fundamental mode, but with the
411
syntax of `*' and `:' changed to be word constituents.")
Edward M. Reingold's avatar
Edward M. Reingold committed
412

413 414 415 416 417 418 419 420 421
(defvar diary-entries-list)
(defvar displayed-year)
(defvar displayed-month)
(defvar entry)
(defvar date)
(defvar number)
(defvar date-string)
(defvar original-date)

422
(defun diary-attrtype-convert (attrvalue type)
423 424
  "Convert string ATTRVALUE to TYPE appropriate for a face description.
Valid TYPEs are: string, symbol, int, stringtnil, tnil."
425 426 427
  (let (ret)
    (setq ret (cond ((eq type 'string) attrvalue)
		    ((eq type 'symbol) (read attrvalue))
428
		    ((eq type 'int) (string-to-number attrvalue))
429 430 431 432 433 434 435 436 437
		    ((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))
438

439 440

(defun diary-pull-attrs (entry fileglobattrs)
441 442 443
  "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.
444
The entry will be modified to drop all tags that are used for face matching.
445 446 447
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
448 449
search."
  (save-excursion
450 451
    (let (regexp regnum attrname attr-list attrname attrvalue type
                 ret-attr attr)
452 453 454 455 456 457 458 459 460 461 462 463 464 465
      (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)
466
		  (setq attrvalue (match-string-no-properties regnum)))
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
	      (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)
484
		(progn
485
		  (setq attrvalue (match-string-no-properties regnum entry))
486 487 488 489
		  (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))))
490 491
	    (setq attr-list (cdr attr-list)))))
      (list entry ret-attr))))
492

493 494 495 496 497 498 499 500 501 502
(defun diary-set-maybe-redraw (symbol value)
  "Set SYMBOL's value to VALUE, and redraw the diary if necessary.
Redraws the diary if it is being displayed (note this is not the same as
just visiting the `diary-file'), and SYMBOL's value is to be changed."
  (let ((oldvalue (eval symbol)))
    (custom-set-default symbol value)
    (and (not (equal value oldvalue))
         (diary-live-p)
         ;; Note this assumes diary was called without prefix arg.
         (diary))))
503

504 505 506
;; This can be removed once the kill/yank treatment of invisible text
;; (see etc/TODO) is fixed. -- gm
(defcustom diary-header-line-flag t
507
  "If non-nil, `simple-diary-display' will show a header line.
508 509 510
The format of the header is specified by `diary-header-line-format'."
  :group   'diary
  :type    'boolean
511
  :initialize 'custom-initialize-default
512
  ;; FIXME overkill.
513
  :set 'diary-set-maybe-redraw
514
  :version "22.1")
515

516 517
(defvar diary-selective-display nil)

518 519
(defcustom diary-header-line-format
  '(:eval (calendar-string-spread
520
           (list (if diary-selective-display
521 522 523
                     "Selective display active - press \"s\" in calendar \
before edit/copy"
                   "Diary"))
524
           ?\s (frame-width)))
525
  "Format of the header line displayed by `simple-diary-display'.
526 527 528
Only used if `diary-header-line-flag' is non-nil."
  :group   'diary
  :type    'sexp
529 530 531
  :initialize 'custom-initialize-default
  ;; FIXME overkill.
  :set 'diary-set-maybe-redraw
532
  :version "22.1")
533

Glenn Morris's avatar
Glenn Morris committed
534 535
(defvar diary-saved-point)		; internal

536 537 538 539 540 541 542 543 544 545 546
;; The first version of this also checked for diary-selective-display
;; in the non-fancy case. This was an attempt to distinguish between
;; displaying the diary and just visiting the diary file. However,
;; when using fancy diary, calling diary when there are no entries to
;; display does not create the fancy buffer, nor does it switch on
;; selective-display in the diary buffer. This means some
;; customizations will not take effect, eg:
;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00466.html
;; So the check for selective-display was dropped. This means the
;; diary will be displayed if one customizes a diary variable while
;; just visiting the diary-file. This is i) unlikely, and ii) no great loss.
Glenn Morris's avatar
Glenn Morris committed
547
(defun diary-live-p ()
548
  "Return non-nil if the diary is being displayed."
Glenn Morris's avatar
Glenn Morris committed
549
  (or (get-buffer fancy-diary-buffer)
550 551
      (and diary-file
           (find-buffer-visiting (substitute-in-file-name diary-file)))))
552 553 554 555 556 557 558 559 560 561

(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
562 563 564 565
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.
566 567 568 569 570 571 572 573 574 575 576 577 578

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
579
  :initialize 'custom-initialize-default
580
  :set 'diary-set-maybe-redraw
581 582
  :group 'diary)

Glenn Morris's avatar
Glenn Morris committed
583 584 585 586 587 588 589 590 591 592 593 594 595

(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
596
strings such as \"%d\" expanded); SPECIFIER is the date part of
Glenn Morris's avatar
Glenn Morris committed
597
the entry as it appears in the diary-file; LITERAL is the entry
598
as it appears in the diary-file (i.e. before expansion).  If
Glenn Morris's avatar
Glenn Morris committed
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
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))))))

619
(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries)
620
(defun diary-list-entries (date number &optional list-only)
621
  "Create and display a buffer containing the relevant lines in `diary-file'.
Edward M. Reingold's avatar
Edward M. Reingold committed
622 623
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
624
using selective display.  If NUMBER is less than 1, this function does nothing.
Edward M. Reingold's avatar
Edward M. Reingold committed
625 626

Returns a list of all relevant diary entries found, if any, in order by date.
627 628 629 630
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
631
for a date with no diary entries.
Edward M. Reingold's avatar
Edward M. Reingold committed
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651

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
652 653 654
        notification function.

If LIST-ONLY is non-nil don't modify or display the buffer, only return a list."
655 656 657 658
  (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
659 660 661 662 663 664 665 666 667 668 669 670 671 672
  (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))))
673
        ;; Setup things like the header-line-format and invisibility-spec.
674 675 676 677 678 679 680 681
        (if (eq major-mode default-major-mode)
            (diary-mode)
          ;; This kludge is to make customizations to
          ;; diary-header-line-flag after diary has been displayed
          ;; take effect. Unconditionally calling (diary-mode)
          ;; clobbers file local variables.
          ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00363.html
          ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-04/msg00404.html
682 683 684
          (if (eq major-mode 'diary-mode)
              (setq header-line-format (and diary-header-line-flag
                                            diary-header-line-format))))
Glenn Morris's avatar
Glenn Morris committed
685 686 687 688
        ;; 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 "")))
689
            (with-syntax-table diary-syntax-table
690
              (let ((mark (regexp-quote diary-nonmarking-symbol)))
691
                (goto-char (point-min))
692 693 694 695 696
                (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)))
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 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 774 775 776 777
                (dotimes (idummy number)
                  (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 "?\\("
                             (mapconcat 'eval date-form "\\)\\(?:")
                             "\\)"))
                           (case-fold-search t))
                        (goto-char (point-min))
                        (while (re-search-forward regexp nil t)
                          (if backup (re-search-backward "\\<" nil t))
                          (if (and (or (char-equal (preceding-char) ?\^M)
                                       (char-equal (preceding-char) ?\n))
                                   (not (looking-at " \\|\^I")))
                              ;;  Diary entry that consists only of date.
                              (backward-char 1)
                            ;; Found a nonempty diary entry--make it
                            ;; visible and add it to the list.
                            (setq entry-found t)
                            (let ((entry-start (point))
                                  date-start temp)
                              (re-search-backward "\^M\\|\n\\|\\`")
                              (setq date-start (point))
                              ;; 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))
                              (while (looking-at " \\|\^I")
                                (re-search-forward "\^M\\|\n" nil 'move))
                              (unless (and (eobp) (not (bolp)))
                                (backward-char 1))
                              (unless list-only
                                (remove-overlays date-start (point)
                                                 'invisible 'diary))
                              (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)
                        (add-to-diary-list date "" "" "" ""))
                    (setq date
                          (calendar-gregorian-from-absolute
                           (1+ (calendar-absolute-from-gregorian date))))
                    (setq entry-found nil)))))
Glenn Morris's avatar
Glenn Morris committed
778 779 780
            (goto-char (point-min))
            (run-hooks 'nongregorian-diary-listing-hook
                       'list-diary-entries-hook)
781 782
            (unless list-only
              (if diary-display-hook
783 784
              (run-hooks 'diary-display-hook)
              (simple-diary-display)))
Glenn Morris's avatar
Glenn Morris committed
785 786
            (run-hooks 'diary-hook)
            diary-entries-list))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
787

788
(defun diary-unhide-everything ()
789 790
  (kill-local-variable 'diary-selective-display)
  (remove-overlays (point-min) (point-max) 'invisible 'diary)
791 792
  (kill-local-variable 'mode-line-format))

Edward M. Reingold's avatar
Edward M. Reingold committed
793 794 795 796 797 798 799 800 801 802 803 804
(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
805
           "\\(?:\\`\\|\^M\\|\n\\)"
Edward M. Reingold's avatar
Edward M. Reingold committed
806 807 808
           (regexp-quote diary-include-string)
           " \"\\([^\"]*\\)\"")
          nil t)
809
    (let* ((diary-file (substitute-in-file-name
810
                        (match-string-no-properties 1)))
811 812 813
           (diary-list-include-blanks nil)
           (list-diary-entries-hook 'include-other-diary-files)
           (diary-display-hook 'ignore)
814
           (diary-hook nil))
Edward M. Reingold's avatar
Edward M. Reingold committed
815 816 817 818 819
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
              (unwind-protect
                  (setq diary-entries-list
                        (append diary-entries-list
820
                                (diary-list-entries original-date number)))
821 822
                (with-current-buffer (find-buffer-visiting diary-file)
                  (diary-unhide-everything)))
Edward M. Reingold's avatar
Edward M. Reingold committed
823 824 825 826 827 828 829 830 831 832 833
            (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
834
                           (calendar-check-holidays original-date)))
835 836 837 838 839 840 841 842 843
         (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
844 845 846
    (if (or (not diary-entries-list)
            (and (not (cdr diary-entries-list))
                 (string-equal (car (cdr (car diary-entries-list))) "")))
847
        (if (< (length msg) (frame-width))
848
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
849 850 851 852 853 854 855 856 857 858
          (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
859 860 861 862 863 864
      (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
865 866
      (message "Preparing diary...done"))))

867 868
(defface diary-button '((((type pc) (class color))
			 (:foreground "lightblue")))
869
  "Default face used for buttons."
870
  :version "22.1"
871
  :group 'diary)
872 873
;; backward-compatibility alias
(put 'diary-button-face 'face-alias 'diary-button)
874 875 876

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

(defun diary-goto-entry (button)
Glenn Morris's avatar
Glenn Morris committed
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
  (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")))))
901

Edward M. Reingold's avatar
Edward M. Reingold committed
902 903 904
(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'."
905 906 907
  (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
908 909 910 911
  (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
912
                               (calendar-check-holidays original-date)))
Edward M. Reingold's avatar
Edward M. Reingold committed
913 914 915 916
             (msg (format "No diary entries for %s %s"
                          (concat date-string (if holiday-list ":" ""))
                          (mapconcat 'identity holiday-list "; "))))
        (if (<= (length msg) (frame-width))
917
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
918 919 920 921 922 923 924 925 926
          (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)))
927 928
    (with-current-buffer;; Prepare the fancy diary buffer.
        (make-fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
      (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))
952 953 954 955
                     (progn
                       (increment-calendar-month
                        holiday-list-last-month holiday-list-last-year 1)
                       t)
Edward M. Reingold's avatar
Edward M. Reingold committed
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
                     (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 ":  "))
974 975
                  (let* ((l (current-column))
                         (longest 0))
976 977 978 979
                    (insert (mapconcat (lambda (x)
					 (if (< longest (length x))
					     (setq longest (length x)))
					 x)
980 981 982
                                       date-holiday-list
                                       (concat "\n" (make-string l ? ))))
                    (insert ?\n (make-string (+ l longest) ?=) ?\n)))))
983 984 985

	  (setq entry (car (cdr (car entry-list))))
	  (if (< 0 (length entry))
Glenn Morris's avatar
Glenn Morris committed
986 987 988
              (let ((this-entry (car entry-list))
                    this-loc)
		(if (setq this-loc (nth 3 this-entry))
989
		    (insert-button (concat entry "\n")
Glenn Morris's avatar
Glenn Morris committed
990 991 992 993 994 995
                                   ;; (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)))
996 997 998
				   :type 'diary-entry)
		  (insert entry ?\n))
		(save-excursion
Glenn Morris's avatar
Glenn Morris committed
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
                  (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))))))
1025
	  (setq entry-list (cdr entry-list))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1026 1027 1028 1029
      (set-buffer-modified-p nil)
      (goto-char (point-min))
      (setq buffer-read-only t)
      (display-buffer fancy-diary-buffer)
1030
      (fancy-diary-display-mode)
Glenn Morris's avatar
Glenn Morris committed
1031
      (calendar-set-mode-line date-string)
Edward M. Reingold's avatar
Edward M. Reingold committed
1032 1033 1034 1035
      (message "Preparing diary...done"))))

(defun make-fancy-diary-buffer ()
  "Create and return the initial fancy diary buffer."
1036
  (with-current-buffer (get-buffer-create fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
    (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))
1057
      (with-current-buffer (get-buffer fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
1058 1059
        (run-hooks 'print-diary-entries-hook))
    (let ((diary-buffer
1060
           (find-buffer-visiting (substitute-in-file-name diary-file))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1061
      (if diary-buffer
1062
          (let ((temp-buffer (get-buffer-create " *Printable Diary Entries*"))
Edward M. Reingold's avatar
Edward M. Reingold committed
1063
                (heading))
1064
            (with-current-buffer diary-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
1065 1066 1067 1068
              (setq heading
                    (if (not (stringp mode-line-format))
                        "All Diary Entries"
                      (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
                      (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
1083 1084 1085 1086 1087 1088 1089 1090
              (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!")))))

1091 1092
(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
1093 1094 1095 1096 1097
  "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
1098 1099
  (let ((d-file (diary-check-diary-file))
        (pop-up-frames (window-dedicated-p (selected-window))))
1100 1101
    (with-current-buffer (or (find-buffer-visiting d-file)
                             (find-file-noselect d-file t))
1102
      (when (eq major-mode default-major-mode) (diary-mode))
1103 1104
      (diary-unhide-everything)
      (display-buffer (current-buffer)))))
1105

1106
;;;###autoload
1107 1108 1109
(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'.
1110
Mail is sent to the address specified by `diary-mail-addr'.
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120

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 \\
1121
             diary-file \\\"/path/to/diary.file\\\" \\
1122 1123
             european-calendar-style t \\
             diary-mail-addr \\\"user@host.name\\\" )\" \\
1124
-l diary-lib -f diary-mail-entries
1125 1126 1127 1128 1129 1130
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."
1131
  (interactive "P")
1132 1133 1134
  (if (string-equal diary-mail-addr "")
      (error "You must set `diary-mail-addr' to use this command")
    (let ((diary-display-hook 'fancy-diary-display))
1135
      (diary-list-entries (calendar-current-date) (or ndays diary-mail-days)))
1136 1137 1138 1139 1140
    (compose-mail diary-mail-addr
                  (concat "Diary entries generated "
                          (calendar-date-string (calendar-current-date))))
    (insert
     (if (get-buffer fancy-diary-buffer)
1141
         (with-current-buffer fancy-diary-buffer (buffer-string))
1142 1143
       "No entries found"))
    (call-interactively (get mail-user-agent 'sendfunc))))
1144

1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
(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
1162 1163 1164 1165 1166 1167 1168

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

1169
(defun mark-diary-entries (&optional redraw)
Edward M. Reingold's avatar
Edward M. Reingold committed
1170
  "Mark days in the calendar window that have diary entries.
1171 1172 1173 1174 1175
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
1176
marks are first removed.  This is intended to deal with deleted
1177 1178 1179 1180 1181 1182 1183 1184 1185
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)
1186 1187
    (setq mark-diary-entries-in-calendar nil)
    (redraw-calendar))
1188 1189
  (let ((marking-diary-entries t)
        file-glob-attrs marks)
1190 1191
    (with-current-buffer (find-file-noselect (diary-check-diary-file) t)
      (save-excursion
1192
        (when (eq major-mode default-major-mode) (diary-mode))
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
        (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))
1285
        (message "Marking diary entries...done")))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1286 1287 1288 1289 1290 1291 1292

(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\\)\\("
1293
                          sexp-mark "(\\)\\|\\("
Edward M. Reingold's avatar
Edward M. Reingold committed
1294
                          (regexp-quote diary-nonmarking-symbol)
1295 1296 1297
                          sexp-mark "(diary-remind\\)"))
         (file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
         m y first-date last-date mark file-glob-attrs)
1298
    (with-current-buffer calendar-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
      (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)