diary-lib.el 99.9 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
(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-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")

56 57 58 59 60 61 62
;; Face markup of calendar and diary displays: Any entry line that
;; ends with [foo:value] where foo is a face attribute (except :box
;; :stipple) or with [face:blah] tags, will have these values applied
;; to the calendar and fancy diary displays.  These attributes "stack"
;; on calendar displays.  File-wide attributes can be defined as
;; follows: the first line matching "^# [tag:value]" defines the value
;; for that particular tag.
Glenn Morris's avatar
Glenn Morris committed
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
(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)
    )
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
  "Alist of (REGEXP SUBEXP ATTRIBUTE TYPE) elements.
This is used by `diary-pull-attrs' to fontify certain diary
elements.  REGEXP is a regular expression to for, and SUBEXP is
the numbered sub-expression to extract.  `diary-glob-file-regexp-prefix'
is prepended to REGEXP for file-wide specifiers.  ATTRIBUTE
specifies which face attribute (e.g. `:foreground') to modify, or
that this is a face (`:face') to apply.  TYPE is the type of
attribute being applied.  Available TYPES (see `diary-attrtype-convert')
are: `string', `symbol', `int', `tnil',`stringtnil.'"
  :type '(repeat (list (string :tag "Regular expression")
		       (integer :tag "Sub-expression")
		       (symbol :tag "Attribute (e.g. :foreground)")
		       (choice (const string :tag "A string")
			       (const symbol :tag "A symbol")
			       (const int :tag "An integer")
			       (const tnil :tag "`t' or `nil'")
			       (const stringtnil
				      :tag "A string, `t', or `nil'"))))
  :group 'diary)

(defcustom diary-glob-file-regexp-prefix "^\\#"
  "Regular expression prepended to `diary-face-attrs' for file-wide specifiers."
  :type 'regexp
Glenn Morris's avatar
Glenn Morris committed
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
  :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

140 141 142
     (add-hook 'list-diary-entries-hook 'include-other-diary-files)
     (add-hook 'list-diary-entries-hook 'sort-diary-entries)
     (add-hook 'diary-display-hook 'fancy-diary-display)
Glenn Morris's avatar
Glenn Morris committed
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

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
186
`bahai-mark-diary-entries'.  The documentation for these functions
Glenn Morris's avatar
Glenn Morris committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
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
204
  "Value returned by `diary-entry-time' when no time is found.
Glenn Morris's avatar
Glenn Morris committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
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 "
227
    (if (zerop (% days 7))
Glenn Morris's avatar
Glenn Morris committed
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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
        (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.


288 289 290 291 292 293 294 295 296 297
(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
298 299 300 301
;;;###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
302 303
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
304
  (interactive "P")
305 306
  (diary-check-diary-file)
  (let ((date (calendar-current-date)))
307 308 309 310
    (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
311 312 313 314 315
  "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")
316
  (diary-check-diary-file)
317
  (diary-list-entries (calendar-cursor-to-date t) arg))
Edward M. Reingold's avatar
Edward M. Reingold committed
318

319
(defun view-other-diary-entries (arg d-file)
Edward M. Reingold's avatar
Edward M. Reingold committed
320
  "Prepare and display buffer of diary entries from an alternative diary file.
321 322 323
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
324
  (interactive
325
   (list (prefix-numeric-value current-prefix-arg)
326 327
         (read-file-name "Enter diary file name: " default-directory nil t)))
  (let ((diary-file d-file))
328
    (diary-view-entries arg)))
Edward M. Reingold's avatar
Edward M. Reingold committed
329

330
(autoload 'calendar-check-holidays "holidays"
Edward M. Reingold's avatar
Edward M. Reingold committed
331 332
  "Check the list of holidays for any that occur on DATE.
The value returned is a list of strings of relevant holiday descriptions.
333
The holidays are those in the list `calendar-holidays'.")
Edward M. Reingold's avatar
Edward M. Reingold committed
334 335 336

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

(autoload 'diary-french-date "cal-french"
340
  "French calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
341 342

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

Edward M. Reingold's avatar
Edward M. Reingold committed
345
(autoload 'diary-iso-date "cal-iso"
346
  "ISO calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
347

Edward M. Reingold's avatar
Edward M. Reingold committed
348
(autoload 'diary-julian-date "cal-julian"
349
  "Julian calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
350 351

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

354
(autoload 'diary-chinese-date "cal-china"
355
  "Chinese calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
356

357
(autoload 'diary-islamic-date "cal-islam"
358
  "Islamic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
359

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

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

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

369
(autoload 'diary-bahai-date "cal-bahai"
Glenn Morris's avatar
Glenn Morris committed
370
  "Baha'i calendar equivalent of date diary entry.")
371

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

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

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

Edward M. Reingold's avatar
Edward M. Reingold committed
381
(autoload 'diary-hebrew-date "cal-hebrew"
382
  "Hebrew calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
383 384

(autoload 'diary-omer "cal-hebrew"
385
  "Omer count diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
386 387

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

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

(autoload 'diary-rosh-hodesh "cal-hebrew"
394
  "Rosh Hodesh diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
395 396

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

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

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

(autoload 'diary-coptic-date "cal-coptic"
406
  "Coptic calendar equivalent of date diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
407 408

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

411
(autoload 'diary-persian-date "cal-persia"
412
  "Persian calendar equivalent of date diary entry.")
413

414
(autoload 'diary-phases-of-moon "lunar" "Moon phases diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
415 416

(autoload 'diary-sunrise-sunset "solar"
417
  "Local time of sunrise and sunset as a diary entry.")
Edward M. Reingold's avatar
Edward M. Reingold committed
418 419 420

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

423 424 425 426 427
(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
428 429
  "The syntax table used when parsing dates in the diary file.
It is the standard syntax table used in Fundamental mode, but with the
430
syntax of `*' and `:' changed to be word constituents.")
Edward M. Reingold's avatar
Edward M. Reingold committed
431

432
(defun diary-attrtype-convert (attrvalue type)
433 434
  "Convert string ATTRVALUE to TYPE appropriate for a face description.
Valid TYPEs are: string, symbol, int, stringtnil, tnil."
435 436 437 438 439 440 441 442
  (cond ((eq type 'string) attrvalue)
	((eq type 'symbol) (read attrvalue)) ; FIXME intern-soft?
	((eq type 'int) (string-to-number attrvalue))
	((eq type 'stringtnil)
	 (cond ((string-equal "t" attrvalue) t)
	       ((string-equal "nil" attrvalue) nil)
	       (t attrvalue)))
	((eq type 'tnil) (string-equal "t" attrvalue))))
443 444

(defun diary-pull-attrs (entry fileglobattrs)
445 446 447 448 449 450 451 452 453 454 455 456
  "Search for matches for regexps from `diary-face-attrs'.
If ENTRY is nil, searches from the start of the current buffer, and
prepends all regexps with `diary-glob-file-regexp-prefix'.
If ENTRY is a string, search for matches in that string, and remove them.
Returns a list of ENTRY followed by (ATTRIBUTE VALUE) pairs.
When ENTRY is non-nil, FILEGLOBATTRS forms the start of the (ATTRIBUTE VALUE)
pairs."
  (let (regexp regnum attrname attrname attrvalue type ret-attr)
    (if (null entry)
	(save-excursion
	  (dolist (attr diary-face-attrs)
	    ;; FIXME inefficient searching.
457
	    (goto-char (point-min))
458 459
	    (setq regexp (concat diary-glob-file-regexp-prefix (car attr))
		  regnum (cadr attr)
460
		  attrname (nth 2 attr)
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
		  type (nth 3 attr)
		  attrvalue (if (re-search-forward regexp nil t)
				(match-string-no-properties regnum)))
	    (and attrvalue
		 (setq attrvalue (diary-attrtype-convert attrvalue type))
		 (setq ret-attr (append ret-attr
					(list attrname attrvalue))))))
      (setq ret-attr fileglobattrs)
      (dolist (attr diary-face-attrs)
	(setq regexp (car attr)
	      regnum (cadr attr)
	      attrname (nth 2 attr)
	      type (nth 3 attr)
	      attrvalue nil)
	;; FIXME multiple matches?
	(if (string-match regexp entry)
	    (setq attrvalue (match-string-no-properties regnum entry)
		  entry (replace-match "" t t entry)))
	(and attrvalue
	     (setq attrvalue (diary-attrtype-convert attrvalue type))
	     (setq ret-attr (append ret-attr (list attrname attrvalue))))))
    (list entry ret-attr)))
483

484 485 486 487 488 489 490 491 492 493
(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))))
494

495 496 497
;; This can be removed once the kill/yank treatment of invisible text
;; (see etc/TODO) is fixed. -- gm
(defcustom diary-header-line-flag t
498
  "Non-nil means `simple-diary-display' will show a header line.
499 500 501
The format of the header is specified by `diary-header-line-format'."
  :group   'diary
  :type    'boolean
502
  :initialize 'custom-initialize-default
503
  ;; FIXME overkill.
504
  :set 'diary-set-maybe-redraw
505
  :version "22.1")
506

507 508
(defvar diary-selective-display nil)

509 510
(defcustom diary-header-line-format
  '(:eval (calendar-string-spread
511
           (list (if diary-selective-display
512 513 514
                     "Selective display active - press \"s\" in calendar \
before edit/copy"
                   "Diary"))
515
           ?\s (frame-width)))
516
  "Format of the header line displayed by `simple-diary-display'.
517 518 519
Only used if `diary-header-line-flag' is non-nil."
  :group   'diary
  :type    'sexp
520 521 522
  :initialize 'custom-initialize-default
  ;; FIXME overkill.
  :set 'diary-set-maybe-redraw
523
  :version "22.1")
524

525 526 527 528 529 530 531 532 533 534 535
;; 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
536
(defun diary-live-p ()
537
  "Return non-nil if the diary is being displayed."
Glenn Morris's avatar
Glenn Morris committed
538
  (or (get-buffer fancy-diary-buffer)
539 540
      (and diary-file
           (find-buffer-visiting (substitute-in-file-name diary-file)))))
541 542 543 544 545 546 547 548 549 550

(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
551 552 553 554
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.
555 556 557 558 559 560 561 562 563 564 565 566 567

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
568
  :initialize 'custom-initialize-default
569
  :set 'diary-set-maybe-redraw
570 571
  :group 'diary)

Glenn Morris's avatar
Glenn Morris committed
572 573 574 575 576 577 578

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

579 580
(defvar diary-entries-list)		; bound in diary-list-entries

Glenn Morris's avatar
Glenn Morris committed
581 582 583 584 585 586
(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
587
strings such as \"%d\" expanded); SPECIFIER is the date part of
Glenn Morris's avatar
Glenn Morris committed
588
the entry as it appears in the diary-file; LITERAL is the entry
589
as it appears in the diary-file (i.e. before expansion).  If
Glenn Morris's avatar
Glenn Morris committed
590 591 592 593 594 595 596 597 598
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))))
599
          (or (string-equal prefix "")
Glenn Morris's avatar
Glenn Morris committed
600 601 602 603 604 605 606 607 608 609
              (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))))))

610
(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries)
611
(defun diary-list-entries (date number &optional list-only)
612
  "Create and display a buffer containing the relevant lines in `diary-file'.
Edward M. Reingold's avatar
Edward M. Reingold committed
613 614
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
615
using selective display.  If NUMBER is less than 1, this function does nothing.
Edward M. Reingold's avatar
Edward M. Reingold committed
616 617

Returns a list of all relevant diary entries found, if any, in order by date.
618 619 620 621
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
622
for a date with no diary entries.
Edward M. Reingold's avatar
Edward M. Reingold committed
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637

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
638 639 640
        nil, `simple-diary-display' will be used.  Use `add-hook' to use
        `fancy-diary-display', if desired.  If you want no diary display, use
        add-hook to set this to `ignore'.
Edward M. Reingold's avatar
Edward M. Reingold committed
641 642

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

Glenn Morris's avatar
Glenn Morris committed
645 646 647
Functions called by these hooks may use the variables ORIGINAL-DATE
and NUMBER, which are the arguments with which this function was called.
Note that hook functions should _not_ use DATE, but ORIGINAL-DATE.
648
\(Sexp diary entries may use DATE - see `list-sexp-diary-entries'.)
649

650
If LIST-ONLY is non-nil don't modify or display the buffer, only return a list."
651 652 653 654
  (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
655
  (when (> number 0)
Glenn Morris's avatar
Glenn Morris committed
656
    (let ((original-date date)	  ; save for possible use in the hooks
Glenn Morris's avatar
Glenn Morris committed
657 658 659 660 661 662 663 664 665 666 667 668
          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))))
669
        ;; Setup things like the header-line-format and invisibility-spec.
670 671 672 673 674 675 676 677
        (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
678 679 680
          (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
681 682 683 684
        ;; 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 "")))
685
            (with-syntax-table diary-syntax-table
686
              (let ((mark (regexp-quote diary-nonmarking-symbol)))
687
                (goto-char (point-min))
688 689 690 691 692
                (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)))
693 694 695 696 697 698
                (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)
699
                      (let* ((backup (when (eq (car date-form) 'backup)
Glenn Morris's avatar
Glenn Morris committed
700 701
				      (setq date-form (cdr date-form))
				      t))
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
                           (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
720
                             "^" mark "?\\("
721 722
			     ;; This must be let* so that date-form
			     ;; can use day etc.
723 724 725 726 727 728
                             (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))
729
                         (if (and (bolp) (not (looking-at "[ \t]")))
730 731 732 733 734
                              ;;  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)
735
                           (if (looking-at "[ \t]*\n[ \t]") (forward-line 1))
736 737
                            (let ((entry-start (point))
                                  date-start temp)
738 739 740 741 742 743
                             (setq date-start
                                   (line-end-position
                                    (if (and (bolp) (> number 1)) -1 0)))
                             (forward-line 1)
                             (while (looking-at "[ \t]")
                               (forward-line 1))
744 745 746 747 748
                              (unless (and (eobp) (not (bolp)))
                                (backward-char 1))
                              (unless list-only
                                (remove-overlays date-start (point)
                                                 'invisible 'diary))
749 750 751
			      (setq temp (diary-pull-attrs
					  (buffer-substring entry-start (point))
					  file-glob-attrs))
752 753
                              (add-to-diary-list
                               date
754
                               (car temp)
755 756 757 758 759 760 761 762 763 764
                               (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
765 766 767
            (goto-char (point-min))
            (run-hooks 'nongregorian-diary-listing-hook
                       'list-diary-entries-hook)
768 769
            (unless list-only
              (if diary-display-hook
770 771
              (run-hooks 'diary-display-hook)
              (simple-diary-display)))
Glenn Morris's avatar
Glenn Morris committed
772 773
            (run-hooks 'diary-hook)
            diary-entries-list))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
774

775
(defun diary-unhide-everything ()
776
  "Show all invisible text in the diary."
777 778
  (kill-local-variable 'diary-selective-display)
  (remove-overlays (point-min) (point-max) 'invisible 'diary)
779 780
  (kill-local-variable 'mode-line-format))

781 782 783
(defvar original-date)			; bound in diary-list-entries
(defvar number)

Edward M. Reingold's avatar
Edward M. Reingold committed
784
(defun include-other-diary-files ()
785
  "Include the diary entries from other diary files with those of `diary-file'.
Edward M. Reingold's avatar
Edward M. Reingold committed
786 787
This function is suitable for use in `list-diary-entries-hook';
it enables you to use shared diary files together with your own.
788
The files included are specified in the `diary-file' by lines of this form:
Edward M. Reingold's avatar
Edward M. Reingold committed
789 790 791 792 793 794 795
        #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
796
           "^"
Edward M. Reingold's avatar
Edward M. Reingold committed
797 798 799
           (regexp-quote diary-include-string)
           " \"\\([^\"]*\\)\"")
          nil t)
Glenn Morris's avatar
Glenn Morris committed
800 801 802 803 804 805
    (let ((diary-file (substitute-in-file-name
		       (match-string-no-properties 1)))
	  (diary-list-include-blanks nil)
	  (list-diary-entries-hook 'include-other-diary-files)
	  (diary-display-hook 'ignore)
	  (diary-hook nil))
Edward M. Reingold's avatar
Edward M. Reingold committed
806 807 808 809 810
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
              (unwind-protect
                  (setq diary-entries-list
                        (append diary-entries-list
811
                                (diary-list-entries original-date number)))
812 813
                (with-current-buffer (find-buffer-visiting diary-file)
                  (diary-unhide-everything)))
Edward M. Reingold's avatar
Edward M. Reingold committed
814 815 816 817 818 819 820 821
            (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)))

822 823 824 825
;; Bound in diary-list-entries.
(defvar date-string)
(defvar diary-saved-point)

Edward M. Reingold's avatar
Edward M. Reingold committed
826 827 828
(defun simple-diary-display ()
  "Display the diary buffer if there are any relevant entries or holidays."
  (let* ((holiday-list (if holidays-in-diary-buffer
829
                           (calendar-check-holidays original-date)))
830 831 832 833 834 835 836
         (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.
837 838
         (pop-up-frames (or pop-up-frames
                            (window-dedicated-p (selected-window)))))
839
    (calendar-set-mode-line (format "Diary for %s" hol-string))
Edward M. Reingold's avatar
Edward M. Reingold committed
840 841 842
    (if (or (not diary-entries-list)
            (and (not (cdr diary-entries-list))
                 (string-equal (car (cdr (car diary-entries-list))) "")))
843
        (if (< (length msg) (frame-width))
844
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
845 846 847 848 849 850 851 852 853 854
          (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
855 856 857
      (with-current-buffer
          (find-buffer-visiting (substitute-in-file-name diary-file))
        (let ((window (display-buffer (current-buffer))))
858
          ;; d-s-p is passed from diary-list-entries.
Glenn Morris's avatar
Glenn Morris committed
859 860
          (set-window-point window diary-saved-point)
          (set-window-start window (point-min))))
Edward M. Reingold's avatar
Edward M. Reingold committed
861 862
      (message "Preparing diary...done"))))

863 864
(defface diary-button '((((type pc) (class color))
			 (:foreground "lightblue")))
865
  "Default face used for buttons."
866
  :version "22.1"
867
  :group 'diary)
868
;; Backward-compatibility alias. FIXME make obsolete.
869
(put 'diary-button-face 'face-alias 'diary-button)
870 871 872

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

(defun diary-goto-entry (button)
876
  "Jump to the diary entry for the button at point."
Glenn Morris's avatar
Glenn Morris committed
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
  (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")))))
898

Edward M. Reingold's avatar
Edward M. Reingold committed
899 900 901
(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'."
902 903
  ;; Turn off selective-display in the diary file's buffer.
  (with-current-buffer
904 905
      (find-buffer-visiting (substitute-in-file-name diary-file))
    (diary-unhide-everything))
Edward M. Reingold's avatar
Edward M. Reingold committed
906 907 908 909
  (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
910
                               (calendar-check-holidays original-date)))
Edward M. Reingold's avatar
Edward M. Reingold committed
911 912 913 914
             (msg (format "No diary entries for %s %s"
                          (concat date-string (if holiday-list ":" ""))
                          (mapconcat 'identity holiday-list "; "))))
        (if (<= (length msg) (frame-width))
915
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
916 917 918 919 920 921 922 923 924
          (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)))
925 926
    ;; Prepare the fancy diary buffer.
    (with-current-buffer
927
        (make-fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
928 929 930 931 932 933
      (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)))
934 935
	(dolist (entry entry-list)
          (if (not (calendar-date-equal date (car entry)))
Edward M. Reingold's avatar
Edward M. Reingold committed
936
              (progn
937
                (setq date (car entry))
Edward M. Reingold's avatar
Edward M. Reingold committed
938 939 940 941 942 943 944 945 946 947
                (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
948 949
                           (extract-calendar-month date)
			   holiday-list-last-year
Edward M. Reingold's avatar
Edward M. Reingold committed
950
                           (extract-calendar-year date))
951 952 953 954
                     (progn
                       (increment-calendar-month
                        holiday-list-last-month holiday-list-last-year 1)
                       t)
Edward M. Reingold's avatar
Edward M. Reingold committed
955 956 957 958 959 960
                     (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))
Glenn Morris's avatar
Glenn Morris committed
961 962 963 964 965 966 967
                (let (date-holiday-list)
		  ;; Make a list of all holidays for date.
		  (dolist (h holiday-list)
		    (if (calendar-date-equal date (car h))
			(setq date-holiday-list (append date-holiday-list
							(cdr h)))))
                  (insert (if (bobp) "" ?\n) (calendar-date-string date))
Edward M. Reingold's avatar
Edward M. Reingold committed
968
                  (if date-holiday-list (insert ":  "))
Glenn Morris's avatar
Glenn Morris committed
969 970
                  (let ((l (current-column))
			(longest 0))
971 972 973 974
                    (insert (mapconcat (lambda (x)
					 (if (< longest (length x))
					     (setq longest (length x)))
					 x)
975 976 977
                                       date-holiday-list
                                       (concat "\n" (make-string l ? ))))
                    (insert ?\n (make-string (+ l longest) ?=) ?\n)))))
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
	  (let ((this-entry (cadr entry))
		this-loc)
	    (unless (zerop (length this-entry))
	      (if (setq this-loc (nth 3 entry))
		  (insert-button (concat this-entry "\n")
				 ;; (MARKER FILENAME SPECIFIER LITERAL)
				 'locator (list (car this-loc)
						(cadr this-loc)
						(nth 2 entry)
						(or (nth 2 this-loc)
						    (nth 1 entry)))
				 :type 'diary-entry)
		(insert this-entry ?\n))
	      (save-excursion
		(let* ((marks (nth 4 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 this-entry)
		    (overlay-put
		     (make-overlay (match-beginning 0) (match-end 0))
		     'face temp-face))))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1018 1019 1020 1021
      (set-buffer-modified-p nil)
      (goto-char (point-min))
      (setq buffer-read-only t)
      (display-buffer fancy-diary-buffer)
1022
      (fancy-diary-display-mode)
Glenn Morris's avatar
Glenn Morris committed
1023
      (calendar-set-mode-line date-string)
Edward M. Reingold's avatar
Edward M. Reingold committed
1024 1025 1026 1027
      (message "Preparing diary...done"))))

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

1083 1084
(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
1085 1086 1087 1088 1089
  "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
1090 1091
  (let ((d-file (diary-check-diary-file))
        (pop-up-frames (window-dedicated-p (selected-window))))
1092 1093
    (with-current-buffer (or (find-buffer-visiting d-file)
                             (find-file-noselect d-file t))
1094
      (when (eq major-mode default-major-mode) (diary-mode))
1095 1096
      (diary-unhide-everything)
      (display-buffer (current-buffer)))))
1097

1098
;;;###autoload
1099 1100 1101
(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'.
1102
Mail is sent to the address specified by `diary-mail-addr'.
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112

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

1137 1138 1139 1140
(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
1141
two supplied arrays.  The returned regexp will then also match these
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
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
1154 1155 1156 1157 1158 1159 1160

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

1161
(defun mark-diary-entries (&optional redraw)
Edward M. Reingold's avatar
Edward M. Reingold committed
1162
  "Mark days in the calendar window that have diary entries.
1163 1164 1165 1166 1167
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
1168
marks are first removed.  This is intended to deal with deleted
1169 1170 1171 1172 1173 1174 1175 1176 1177
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)
1178 1179
    (setq mark-diary-entries-in-calendar nil)
    (redraw-calendar))
1180 1181
  (let ((marking-diary-entries t)
        file-glob-attrs marks)
1182 1183
    (with-current-buffer (find-file-noselect (diary-check-diary-file) t)
      (save-excursion
1184
        (when (eq major-mode default-major-mode) (diary-mode))
1185 1186 1187 1188 1189 1190
        (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)
Glenn Morris's avatar
Glenn Morris committed
1191
                (setq date-form (cdr date-form))) ; ignore 'backup directive
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
            (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))))
1204
                   (d-name-pos (if (/= l d-name-pos) (+ 1 d-name-pos)))
1205
                   (m-name-pos (- l (length (memq 'monthname date-form))))
1206
                   (m-name-pos (if (/= l m-name-pos) (+ 1 m-name-pos)))
1207
                   (d-pos (- l (length (memq 'day date-form))))
1208
                   (d-pos (if (/= l d-pos) (+ 1 d-pos)))
1209
                   (m-pos (- l (length (memq 'month date-form))))
1210
                   (m-pos (if (/= l m-pos) (+ 1 m-pos)))
1211
                   (y-pos (- l (length (memq 'year date-form))))
1212
                   (y-pos (if (/= l y-pos) (+ 1 y-pos)))
1213 1214
                   (regexp
                    (concat