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

Paul Eggert's avatar
Paul Eggert committed
3 4
;; Copyright (C) 1989-1990, 1992-1995, 2001-2015 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
;; Keywords: calendar

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Edward M. Reingold's avatar
Edward M. Reingold committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Edward M. Reingold's avatar
Edward M. Reingold committed
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Edward M. Reingold's avatar
Edward M. Reingold committed
24 25 26

;;; Commentary:

Glenn Morris's avatar
Glenn Morris committed
27
;; See calendar.el.
Edward M. Reingold's avatar
Edward M. Reingold committed
28 29 30 31

;;; Code:

(require 'calendar)
32
(eval-and-compile (load "diary-loaddefs" nil t))
33

34 35 36 37 38
(defgroup diary nil
  "Emacs diary."
  :prefix "diary-"
  :group 'calendar)

Glenn Morris's avatar
Glenn Morris committed
39 40
(defcustom diary-include-string "#include"
  "The string indicating inclusion of another file of diary entries.
41
See the documentation for the function `diary-include-other-diary-files'."
Glenn Morris's avatar
Glenn Morris committed
42 43 44 45 46 47 48 49 50 51
  :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)

52 53 54
(defface diary-anniversary '((t :inherit font-lock-keyword-face))
  "Face used for anniversaries in the fancy diary display."
  :version "22.1"
55
  :group 'calendar-faces)
56 57

(defface diary-time '((t :inherit font-lock-variable-name-face))
58
  "Face used for times of day in the fancy diary display."
59
  :version "22.1"
60
  :group 'calendar-faces)
61 62 63

(defface diary-button '((((type pc) (class color))
                         (:foreground "lightblue")))
64
  "Face used for buttons in the fancy diary display."
65
  :version "22.1"
66
  :group 'calendar-faces)
67

68 69 70 71 72 73 74
;; 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
75 76 77
(defcustom diary-face-attrs
  '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string)
    (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string)
78 79
    (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol)
    (" *\\[height:\\([.0-9]+\\)\\]$" 1 :height int)
Glenn Morris's avatar
Glenn Morris committed
80 81 82 83 84 85 86 87 88 89 90 91
    (" *\\[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)
    )
92 93 94 95
  "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'
96
is pre-pended to REGEXP for file-wide specifiers.  ATTRIBUTE
97 98 99
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')
100
are: `string', `symbol', `int', `tnil', `stringtnil.'"
101
  :type '(repeat (list (string :tag "Regular expression")
Glenn Morris's avatar
Glenn Morris committed
102 103 104 105 106
                       (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")
107
                               (const tnil :tag "t or nil")
Glenn Morris's avatar
Glenn Morris committed
108
                               (const stringtnil
109
                                      :tag "A string, t, or nil"))))
110 111 112
  :group 'diary)

(defcustom diary-glob-file-regexp-prefix "^\\#"
113
  "Regular expression pre-pended to `diary-face-attrs' for file-wide specifiers."
114
  :type 'regexp
Glenn Morris's avatar
Glenn Morris committed
115 116 117 118 119 120 121 122 123 124 125 126
  :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)

127
(defcustom diary-sexp-entry-symbol "%%"
Glenn Morris's avatar
Glenn Morris committed
128
  "The string used to indicate a sexp diary entry in `diary-file'.
129
See the documentation for the function `diary-list-sexp-entries'."
Glenn Morris's avatar
Glenn Morris committed
130 131 132
  :type 'string
  :group 'diary)

Glenn Morris's avatar
Glenn Morris committed
133 134 135 136 137
(defcustom diary-comment-start nil
  "String marking the start of a comment in the diary, or nil.
Nil means there are no comments.  The diary does not display
parts of entries that are inside comments.  You can use comments
for whatever you like, e.g. for meta-data that packages such as
Paul Eggert's avatar
Paul Eggert committed
138
`appt.el' can use.  Comments may not span multiple lines, and there
139
can be only one comment on any line.
Glenn Morris's avatar
Glenn Morris committed
140 141 142 143 144 145 146 147 148 149 150 151 152
See also `diary-comment-end'."
  :version "24.1"
  :type '(choice (const :tag "No comment" nil) string)
  :group 'diary)

(defcustom diary-comment-end ""
  "String marking the end of a comment in the diary.
The empty string means comments finish at the end of a line.
See also `diary-comment-start'."
  :version "24.1"
  :type 'string
  :group 'diary)

153 154 155 156 157 158
(defcustom diary-hook nil
  "List of functions called after the display of the diary.
Used for example by the appointment package - see `appt-activate'."
  :type 'hook
  :group 'diary)

159
(defcustom diary-display-function 'diary-fancy-display
160
  "Function used to display the diary.
161
The two standard options are `diary-fancy-display' and `diary-simple-display'.
162 163 164 165 166 167 168

When this function is called, the variable `diary-entries-list'
is a list, in order by date, of all relevant diary entries in the
form of ((MONTH DAY YEAR) STRING), where string is the diary
entry for the given date.  This can be used, for example, to
produce a different buffer for display (perhaps combined with
holidays), or hard copy output."
169 170
  :type '(choice (const diary-fancy-display :tag "Fancy display")
                 (const diary-simple-display :tag "Basic display")
171 172
                 (const :tag "No display" ignore)
                 (function :tag "User-specified function"))
173 174
  :initialize 'custom-initialize-default
  :set 'diary-set-maybe-redraw
175
  :version "23.2"                       ; simple->fancy
176 177
  :group 'diary)

178
(defcustom diary-list-entries-hook nil
179 180 181 182 183 184 185 186
  "Hook run after diary file is culled for relevant entries.

If you add `diary-include-other-diary-files' to this hook, you
will probably also want to add `diary-mark-included-diary-files'
to `diary-mark-entries-hook'.  For example, to cause the fancy
diary buffer to be displayed with diary entries from various
included files, each day's entries sorted into lexicographic
order, add the following to your init file:
Glenn Morris's avatar
Glenn Morris committed
187

188 189 190
     (setq diary-display-function \\='diary-fancy-display)
     (add-hook \\='diary-list-entries-hook \\='diary-include-other-diary-files)
     (add-hook \\='diary-list-entries-hook \\='diary-sort-entries t)
Glenn Morris's avatar
Glenn Morris committed
191

192 193
Note how the sort function is placed last, so that it can sort
the entries included from other files.
Glenn Morris's avatar
Glenn Morris committed
194 195 196 197 198 199 200 201

This hook runs after `diary-nongregorian-listing-hook'.  These two hooks
differ only if you are using included diary files.  In that case,
`diary-nongregorian-listing-hook' runs for each file, whereas
`diary-list-entries-hook' only runs once, for the main diary file.
So for example, to sort the complete list of diary entries you would
use the list-entries hook, whereas to process e.g. Islamic entries in
the main file and all included files, you would use the nongregorian hook."
Glenn Morris's avatar
Glenn Morris committed
202
  :type 'hook
203
  :options '(diary-include-other-diary-files diary-sort-entries)
Glenn Morris's avatar
Glenn Morris committed
204 205
  :group 'diary)

206
(defcustom diary-mark-entries-hook nil
Glenn Morris's avatar
Glenn Morris committed
207
  "List of functions called after marking diary entries in the calendar.
208 209
You might wish to add `diary-mark-included-diary-files', in which case
you will probably also want to add `diary-include-other-diary-files' to
Glenn Morris's avatar
Glenn Morris committed
210 211 212 213 214 215
`diary-list-entries-hook'.

This hook runs after `diary-nongregorian-marking-hook'.  These two hooks
differ only if you are using included diary files.  In that case,
`diary-nongregorian-marking-hook' runs for each file, whereas
`diary-mark-entries-hook' only runs once, for the main diary file."
Glenn Morris's avatar
Glenn Morris committed
216
  :type 'hook
217
  :options '(diary-mark-included-diary-files)
Glenn Morris's avatar
Glenn Morris committed
218 219
  :group 'diary)

220
(defcustom diary-nongregorian-listing-hook nil
Glenn Morris's avatar
Glenn Morris committed
221 222
  "List of functions called for listing diary file and included files.
As the files are processed for diary entries, these functions are used
223
to cull relevant entries.  You can use any or all of
Glenn Morris's avatar
Glenn Morris committed
224 225
`diary-bahai-list-entries', `diary-hebrew-list-entries', and
`diary-islamic-list-entries'.  The documentation for these functions
Glenn Morris's avatar
Glenn Morris committed
226 227 228 229 230
describes the style of such diary entries.

You can use this hook for other functions as well, if you want them to
be run on the main diary file and any included diary files.  Otherwise,
use `diary-list-entries-hook', which runs only for the main diary file."
Glenn Morris's avatar
Glenn Morris committed
231
  :type 'hook
Glenn Morris's avatar
Glenn Morris committed
232 233 234
  :options '(diary-bahai-list-entries
             diary-hebrew-list-entries
             diary-islamic-list-entries)
Glenn Morris's avatar
Glenn Morris committed
235 236
  :group 'diary)

237
(defcustom diary-nongregorian-marking-hook nil
Glenn Morris's avatar
Glenn Morris committed
238 239
  "List of functions called for marking diary file and included files.
As the files are processed for diary entries, these functions are used
240
to cull relevant entries.  You can use any or all of
Glenn Morris's avatar
Glenn Morris committed
241 242
`diary-bahai-mark-entries', `diary-hebrew-mark-entries' and
`diary-islamic-mark-entries'.  The documentation for these functions
Glenn Morris's avatar
Glenn Morris committed
243 244 245 246 247
describes the style of such diary entries.

You can use this hook for other functions as well, if you want them to
be run on the main diary file and any included diary files.  Otherwise,
use `diary-mark-entries-hook', which runs only for the main diary file."
Glenn Morris's avatar
Glenn Morris committed
248
  :type 'hook
Glenn Morris's avatar
Glenn Morris committed
249 250 251
  :options '(diary-bahai-mark-entries
             diary-hebrew-mark-entries
             diary-islamic-mark-entries)
Glenn Morris's avatar
Glenn Morris committed
252 253
  :group 'diary)

254 255
(defcustom diary-print-entries-hook 'lpr-buffer
  "Run by `diary-print-entries' after preparing a temporary diary buffer.
256 257 258 259 260
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."
Glenn Morris's avatar
Glenn Morris committed
261 262 263 264
  :type 'hook
  :group 'diary)

(defcustom diary-unknown-time -9999
265
  "Value returned by `diary-entry-time' when no time is found.
266 267 268
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."
Glenn Morris's avatar
Glenn Morris committed
269 270 271 272 273
  :type 'integer
  :group 'diary
  :version "20.3")

(defcustom diary-mail-addr
274
  (or (bound-and-true-p user-mail-address) "")
Glenn Morris's avatar
Glenn Morris committed
275 276 277 278 279 280 281 282 283 284 285 286 287
  "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 "
288
    (if (zerop (% days 7))
289 290
        (format "%d week%s" (/ days 7) (if (= 7 days) "" "s"))
      (format "%d day%s" days (if (= 1 days) "" "s")))
Glenn Morris's avatar
Glenn Morris committed
291 292 293 294 295
    " 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
296 297
expressions that can involve the keywords `days' (a number), `date'
\(a list of month, day, year), and `diary-entry' (a string)."
Glenn Morris's avatar
Glenn Morris committed
298 299 300
  :type 'sexp
  :group 'diary)

301
(defcustom diary-abbreviated-year-flag t
302
  "Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
303
This applies to the Gregorian, Hebrew, Islamic, and Bahá’í calendars.
304 305 306 307 308 309 310
When the current century is added to a two-digit year, if the result
is more than 50 years in the future, the previous century is assumed.
If the result is more than 50 years in the past, the next century is assumed.
If this variable is nil, years must be written in full."
  :type 'boolean
  :group 'diary)

311 312 313 314
(defun diary-outlook-format-1 (body)
  "Return a replace-match template for an element of `diary-outlook-formats'.
Returns a string using match elements 1-5, where:
1 = month name, 2 = day, 3 = year, 4 = time, 5 = location; also uses
315 316 317 318
%s = message subject.  BODY is the string from which the matches derive."
  (let* ((monthname (match-string 1 body))
        (day (match-string 2 body))
        (year (match-string 3 body))
319 320 321 322 323 324 325 326 327 328
        ;; Blech.
        (month (catch 'found
                 (dotimes (i (length calendar-month-name-array))
                   (if (string-equal (aref calendar-month-name-array i)
                                     monthname)
                       (throw 'found (1+ i))))
                 nil)))
    ;; If we could convert the monthname to a numeric month, we can
    ;; use the standard function calendar-date-string.
    (concat (if month
329
                (calendar-date-string (list month (string-to-number day)
330
                                            (string-to-number year)) nil t)
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
              (cond ((eq calendar-date-style 'iso) "\\3 \\1 \\2") ; YMD
                    ((eq calendar-date-style 'european) "\\2 \\1 \\3") ; DMY
                    (t "\\1 \\2 \\3"))) ; MDY
            "\n \\4 %s, \\5")))
;; TODO Sometimes the time is in a different time-zone to the one you
;; are in.  Eg in PST, you might still get an email referring to:
;; "7:00 PM-8:00 PM. Greenwich Standard Time".
;; Note that it doesn't use a standard abbreviation for the timezone,
;; or anything helpful like that.
;; Sigh, this could cause the meeting to even be on a different day
;; to that given in the When: string.
;; These things seem to come in a multipart mail with a calendar part,
;; it's probably better to use that rather than this whole thing.
;; So this is unlikely to get improved.

;; TODO Is the format of these messages actually documented anywhere?
Glenn Morris's avatar
Glenn Morris committed
347
(defcustom diary-outlook-formats
348 349 350 351
  '(;; When: Tuesday, November 9, 2010 7:00 PM-8:00 PM. Greenwich Standard Time
    ;; Where: Meeting room B
    ("[ \t\n]*When: [[:alpha:]]+, \\([[:alpha:]]+\\) \\([0-9][0-9]*\\), \
\\([0-9]\\{4\\}\\),? \\(.+\\)\n\
352
\\(?:Where: \\(.+\n\\)\\)?" . diary-outlook-format-1))
Glenn Morris's avatar
Glenn Morris committed
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
  "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")
Glenn Morris's avatar
Glenn Morris committed
369 370 371 372
                :value-type (choice
                             (string :tag "Template for entry")
                             (function :tag
                                       "Unary function providing template")))
Glenn Morris's avatar
Glenn Morris committed
373 374 375
  :version "22.1"
  :group 'diary)

376 377
(defvar diary-header-line-flag)
(defvar diary-header-line-format)
378

379 380 381
(defun diary-set-header (symbol value)
  "Set SYMBOL's value to VALUE, and redraw the diary header if necessary."
  (let ((oldvalue (symbol-value symbol))
382
        (dbuff (and diary-file (find-buffer-visiting diary-file))))
383 384 385 386 387 388 389 390 391 392 393
    (custom-set-default symbol value)
    (and dbuff
         (not (equal value oldvalue))
         (with-current-buffer dbuff
           (if (eq major-mode 'diary-mode)
               (setq header-line-format (and diary-header-line-flag
                                             diary-header-line-format)))))))

;; This can be removed once the kill/yank treatment of invisible text
;; (see etc/TODO) is fixed. -- gm
(defcustom diary-header-line-flag t
394
  "Non-nil means `diary-simple-display' will show a header line.
395 396 397 398 399 400 401 402 403 404 405 406 407
The format of the header is specified by `diary-header-line-format'."
  :group   'diary
  :type    'boolean
  :initialize 'custom-initialize-default
  :set 'diary-set-header
  :version "22.1")

(defvar diary-selective-display nil
  "Internal diary variable; non-nil if some diary text is hidden.")

(defcustom diary-header-line-format
  '(:eval (calendar-string-spread
           (list (if diary-selective-display
408
                     "Some text is hidden - press \"C-c C-s\" before edit/copy"
409
                   "Diary"))
Glenn Morris's avatar
Glenn Morris committed
410
           ?\s (window-width)))
411
  "Format of the header line displayed by `diary-simple-display'.
412 413 414 415 416
Only used if `diary-header-line-flag' is non-nil."
  :group 'diary
  :type 'sexp
  :initialize 'custom-initialize-default
  :set 'diary-set-header
417
  :version "23.3")                      ; frame-width -> window-width
418

419 420 421 422 423 424 425 426 427 428 429 430 431
;; 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 set
;; diary-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 diary-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.
;;;###cal-autoload
(defun diary-live-p ()
432 433
  "Return non-nil if the diary is being displayed.
The actual return value is a diary buffer."
434
  (or (get-buffer diary-fancy-buffer)
435
      (and diary-file (find-buffer-visiting diary-file))))
436 437 438 439 440 441

;;;###cal-autoload
(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."
442
  (let ((oldvalue (symbol-value symbol)))
443 444 445 446 447 448
    (custom-set-default symbol value)
    (and (not (equal value oldvalue))
         (diary-live-p)
         ;; Note this assumes diary was called without prefix arg.
         (diary))))

449
(defcustom diary-number-of-entries 1
450
  "Specifies how many days of diary entries are to be displayed initially.
451 452 453 454 455 456 457 458 459 460
This variable affects the diary display when the command \\[diary] is
used, or if the value of the variable `calendar-view-diary-initially-flag'
is non-nil.  For example, if the default value 1 is used, then only the
current day's diary entries will be displayed.  If the value 2 is used,
then both the current day's and the next day's entries will be displayed.

The value can also be a vector such as [0 2 2 2 2 4 1]; this value says
to display no diary entries on Sunday, the 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.
461 462

This variable does not affect the diary display with the `d' command
463 464
from the calendar; in that case, the prefix argument controls the number
of days of diary entries displayed."
465 466 467 468 469 470 471 472 473 474 475 476 477
  :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")))
  :initialize 'custom-initialize-default
  :set 'diary-set-maybe-redraw
  :group 'diary)

478
;;; More user options in calendar.el, holidays.el.
Glenn Morris's avatar
Glenn Morris committed
479 480


481 482 483
(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."
484 485 486
  (if (and diary-file (file-exists-p diary-file))
      (if (file-readable-p diary-file)
          diary-file
487 488
        (error "Diary file ‘%s’ is not readable" diary-file))
    (error "Diary file ‘%s’ does not exist" diary-file)))
489

Edward M. Reingold's avatar
Edward M. Reingold committed
490 491 492 493
;;;###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
494
by the variable `diary-number-of-entries'.  A value of ARG less than 1
495
does nothing.  This function is suitable for execution in an init file."
Edward M. Reingold's avatar
Edward M. Reingold committed
496
  (interactive "P")
497
  (diary-check-diary-file)
498 499
  (diary-list-entries (calendar-current-date)
                      (if arg (prefix-numeric-value arg))))
500

501
;;;###cal-autoload
502
(defun diary-view-entries (&optional arg)
Edward M. Reingold's avatar
Edward M. Reingold committed
503
  "Prepare and display a buffer with diary entries.
504 505
Searches the file named in `diary-file' for entries that match
ARG days starting with the date indicated by the cursor position
Edward M. Reingold's avatar
Edward M. Reingold committed
506 507
in the displayed three-month calendar."
  (interactive "p")
508
  (diary-check-diary-file)
509
  (diary-list-entries (calendar-cursor-to-date t) arg))
Edward M. Reingold's avatar
Edward M. Reingold committed
510

511

512
;;;###cal-autoload
513
(defun diary-view-other-diary-entries (arg dfile)
Edward M. Reingold's avatar
Edward M. Reingold committed
514
  "Prepare and display buffer of diary entries from an alternative diary file.
515 516
Searches for entries that match ARG days, starting with the date indicated
by the cursor position in the displayed three-month calendar.
517
DFILE specifies the file to use as the diary file."
Edward M. Reingold's avatar
Edward M. Reingold committed
518
  (interactive
519
   (list (prefix-numeric-value current-prefix-arg)
520
         (read-file-name "Enter diary file name: " default-directory nil t)))
521
  (let ((diary-file dfile))
522
    (diary-view-entries arg)))
Edward M. Reingold's avatar
Edward M. Reingold committed
523

524 525 526 527 528
(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
529 530
  "The syntax table used when parsing dates in the diary file.
It is the standard syntax table used in Fundamental mode, but with the
531
syntax of `*' and `:' changed to be word constituents.")
Edward M. Reingold's avatar
Edward M. Reingold committed
532

533
(defun diary-attrtype-convert (attrvalue type)
534 535
  "Convert string ATTRVALUE to TYPE appropriate for a face description.
Valid TYPEs are: string, symbol, int, stringtnil, tnil."
536
  (cond ((eq type 'string) attrvalue)
537
        ((eq type 'symbol) (intern-soft attrvalue))
Glenn Morris's avatar
Glenn Morris committed
538 539 540 541 542 543
        ((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))))
544 545

(defun diary-pull-attrs (entry fileglobattrs)
546 547 548 549 550 551 552 553 554
  "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)
Glenn Morris's avatar
Glenn Morris committed
555 556 557 558 559 560 561 562 563 564 565 566 567 568
        (save-excursion
          (dolist (attr diary-face-attrs)
            ;; FIXME inefficient searching.
            (goto-char (point-min))
            (setq regexp (concat diary-glob-file-regexp-prefix (car attr))
                  regnum (cadr attr)
                  attrname (nth 2 attr)
                  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))))))
569 570
      (setq ret-attr fileglobattrs)
      (dolist (attr diary-face-attrs)
Glenn Morris's avatar
Glenn Morris committed
571 572 573 574 575
        (setq regexp (car attr)
              regnum (cadr attr)
              attrname (nth 2 attr)
              type (nth 3 attr)
              attrvalue nil)
576 577 578 579 580 581
        ;; If multiple matches, replace all, use the last (which may
        ;; be the first instance in the line, if the regexp is
        ;; anchored with $).
        (while (string-match regexp entry)
          (setq attrvalue (match-string-no-properties regnum entry)
                entry (replace-match "" t t entry)))
Glenn Morris's avatar
Glenn Morris committed
582 583 584
        (and attrvalue
             (setq attrvalue (diary-attrtype-convert attrvalue type))
             (setq ret-attr (append ret-attr (list attrname attrvalue))))))
585
    (list entry ret-attr)))
586

587

Glenn Morris's avatar
Glenn Morris committed
588 589 590 591 592 593 594

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

Glenn Morris's avatar
Glenn Morris committed
595
(defvar diary-entries-list)             ; bound in diary-list-entries
596

597
(defun diary-add-to-list (date string specifier &optional marker
Glenn Morris's avatar
Glenn Morris committed
598 599
                               globcolor literal)
  "Add an entry to `diary-entries-list'.
600
Do nothing if DATE or STRING are nil.  DATE is the (MONTH DAY
Glenn Morris's avatar
Glenn Morris committed
601 602
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
603
strings such as \"%d\" expanded); SPECIFIER is the date part of
Glenn Morris's avatar
Glenn Morris committed
604
the entry as it appears in the diary-file; LITERAL is the entry
605 606
as it appears in the diary-file (i.e. before expansion).
If LITERAL is nil, it is taken to be the same as STRING.
Glenn Morris's avatar
Glenn Morris committed
607 608 609

The entry is added to the list as (DATE STRING SPECIFIER LOCATOR
GLOBCOLOR), where LOCATOR has the form (MARKER FILENAME LITERAL),
Glenn Morris's avatar
Glenn Morris committed
610 611 612 613 614
FILENAME being the file containing the diary entry.

Modifies STRING using `diary-modify-entry-list-string-function', if non-nil.
Also removes the region between `diary-comment-start' and
`diary-comment-end', if the former is non-nil."
Glenn Morris's avatar
Glenn Morris committed
615
  (when (and date string)
616
    ;; b-f-n is nil if we are visiting an include file in a temp-buffer.
Glenn Morris's avatar
Glenn Morris committed
617 618
    (let ((dfile (or (buffer-file-name) diary-file))
          cstart)
619 620 621 622 623 624 625
      (if diary-file-name-prefix
          (let ((prefix (funcall diary-file-name-prefix-function dfile)))
            (or (string-equal 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)))
Glenn Morris's avatar
Glenn Morris committed
626 627 628 629 630
      (when (and diary-comment-start
                 (string-match (setq cstart (regexp-quote diary-comment-start))
                               string))
        ;; Preserve the value with the comments.
        (or literal (setq literal string))
631 632
        ;; Handles multiple comments per entry, so long as each is on
        ;; a single line, and each line has no more than one comment.
Glenn Morris's avatar
Glenn Morris committed
633
        (setq string (replace-regexp-in-string
634
                      (format "%s.*%s" cstart (regexp-quote diary-comment-end))
Glenn Morris's avatar
Glenn Morris committed
635
                      "" string)))
636 637 638 639 640
      (setq diary-entries-list
            (append diary-entries-list
                    (list (list date string specifier
                                (list marker dfile literal)
                                globcolor)))))))
Glenn Morris's avatar
Glenn Morris committed
641

642
(defun diary-list-entries-2 (date mark globattr list-only
643
                                  &optional months symbol gdate)
644 645 646 647 648 649 650
  "Internal subroutine of `diary-list-entries'.
Find diary entries applying to DATE, by searching from point-min for
each element of `diary-date-forms'.  MARK indicates an entry is non-marking.
GLOBATTR is the list of global file attributes.  If LIST-ONLY is
non-nil, don't change the buffer, only return a list of entries.
Optional array MONTHS replaces `calendar-month-name-array', and
means months cannot be abbreviated.  Optional string SYMBOL marks diary
651 652 653
entries of the desired type.  If DATE is not Gregorian, then the
Gregorian equivalent should be provided via GDATE.  Returns non-nil if
any entries were found."
654 655 656
  (let* ((month (calendar-extract-month date))
         (day (calendar-extract-day date))
         (year (calendar-extract-year date))
657 658 659 660 661 662 663 664 665 666
         (dayname (format "%s\\|%s\\.?" (calendar-day-name date)
                          (calendar-day-name date 'abbrev)))
         (calendar-month-name-array (or months calendar-month-name-array))
         (monthname (format "\\*\\|%s%s" (calendar-month-name month)
                            (if months ""
                              (format "\\|%s\\.?"
                                      (calendar-month-name month 'abbrev)))))
         (month (format "\\*\\|0*%d" month))
         (day (format "\\*\\|0*%d" day))
         (year (format "\\*\\|0*%d%s" year
667
                       (if diary-abbreviated-year-flag
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
                           (format "\\|%02d" (% year 100))
                         "")))
        (case-fold-search t)
        entry-found)
    (dolist (date-form diary-date-forms)
      (let ((backup (when (eq (car date-form) 'backup)
                      (setq date-form (cdr date-form))
                      t))
            ;; date-form uses day etc as set above.
            (regexp (format "^%s?%s\\(%s\\)" (regexp-quote mark)
                            (if symbol (regexp-quote symbol) "")
                            (mapconcat 'eval date-form "\\)\\(?:")))
            entry-start date-start temp)
        (goto-char (point-min))
        (while (re-search-forward regexp nil t)
          (if backup (re-search-backward "\\<" nil t))
684 685
          ;; regexp moves us past the end of date, onto the next line.
          ;; Trailing whitespace after date not allowed (see diary-file).
686
          (if (and (bolp) (not (looking-at "[ \t]")))
687
              ;; Diary entry that consists only of date.
688 689 690
              (backward-char 1)
            ;; Found a nonempty diary entry--make it
            ;; visible and add it to the list.
691
            (setq date-start (line-end-position 0))
692 693 694
            ;; Actual entry starts on the next-line?
            (if (looking-at "[ \t]*\n[ \t]") (forward-line 1))
            (setq entry-found t
695
                  entry-start (point))
696 697 698 699 700 701 702 703 704 705
            (forward-line 1)
            (while (looking-at "[ \t]") ; continued entry
              (forward-line 1))
            (unless (and (eobp) (not (bolp)))
              (backward-char 1))
            (unless list-only
              (remove-overlays date-start (point) 'invisible 'diary))
            (setq temp (diary-pull-attrs
                        (buffer-substring-no-properties
                         entry-start (point)) globattr))
706
            (diary-add-to-list
707
             (or gdate date) (car temp)
708 709 710 711 712 713 714
             (buffer-substring-no-properties (1+ date-start) (1- entry-start))
             (copy-marker entry-start) (cadr temp))))))
    entry-found))

(defvar original-date)                  ; from diary-list-entries
(defvar file-glob-attrs)
(defvar list-only)
715
(defvar number)
716 717 718 719 720 721

(defun diary-list-entries-1 (months symbol absfunc)
  "List diary entries of a certain type.
MONTHS is an array of month names.  SYMBOL marks diary entries of the type
in question.  ABSFUNC is a function that converts absolute dates to dates
of the appropriate type."
722
  (let ((gdate original-date))
723
    (dotimes (_idummy number)
724 725
      (diary-list-entries-2
       (funcall absfunc (calendar-absolute-from-gregorian gdate))
726
       diary-nonmarking-symbol file-glob-attrs list-only months symbol gdate)
727 728 729 730
      (setq gdate
            (calendar-gregorian-from-absolute
             (1+ (calendar-absolute-from-gregorian gdate))))))
  (goto-char (point-min)))
731

Glenn Morris's avatar
Glenn Morris committed
732
(defvar diary-included-files nil
733 734
  "List of any diary files included in the last call to `diary-list-entries'.
Or to `diary-mark-entries'.")
Glenn Morris's avatar
Glenn Morris committed
735

736
(defun diary-list-entries (date number &optional list-only)
737
  "Create and display a buffer containing the relevant lines in `diary-file'.
Glenn Morris's avatar
Glenn Morris committed
738 739 740
Selects entries for NUMBER days starting with date DATE.  Hides any
other entries using overlays.  If NUMBER is less than 1, this function
does nothing.
Edward M. Reingold's avatar
Edward M. Reingold committed
741

742
Returns a list of all relevant diary entries found.
743 744 745
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'
746 747
is non-nil, this list includes a dummy diary entry consisting of the empty
string for a date with no diary entries.
Edward M. Reingold's avatar
Edward M. Reingold committed
748

Glenn Morris's avatar
Glenn Morris committed
749 750 751 752 753
If producing entries for multiple dates (i.e., NUMBER > 1), then
this function normally returns the entries from any given diary
file in date order.  The entries for any given day are in the
order in which they were found in the file, not necessarily in
time-of-day order.  Note that any functions present on the
754 755 756 757
hooks (see below) may add entries, or change the order.  For
example, `diary-include-other-diary-files' adds entries from any
include files that it finds to the end of the original list.  The
entries from each file will be in date order, but the overall
Glenn Morris's avatar
Glenn Morris committed
758 759
list will not be.  If you want the entire list to be in time
order, add `diary-sort-entries' to the end of `diary-list-entries-hook'.
760

Glenn Morris's avatar
Glenn Morris committed
761
After preparing the initial list, hooks run in this order:
Edward M. Reingold's avatar
Edward M. Reingold committed
762

Glenn Morris's avatar
Glenn Morris committed
763 764 765
  `diary-nongregorian-listing-hook' runs for the main diary file,
      and each included file.  For example, this is the appropriate hook
      to process Islamic entries in all diary files.
Edward M. Reingold's avatar
Edward M. Reingold committed
766

Glenn Morris's avatar
Glenn Morris committed
767 768 769 770
  `diary-list-entries-hook' runs once only, for the main diary file.
      For example, this is appropriate for sorting all the entries.
      If not using include files, there is no difference from the previous
      hook.
Edward M. Reingold's avatar
Edward M. Reingold committed
771

Glenn Morris's avatar
Glenn Morris committed
772
  `diary-hook' runs last, after the diary is displayed.
773
      This is used e.g. by `appt-check'.
774

Glenn Morris's avatar
Glenn Morris committed
775 776 777
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.
778
\(Sexp diary entries may use DATE - see `diary-list-sexp-entries'.)
779

780 781
This function displays the list using `diary-display-function', unless
LIST-ONLY is non-nil, in which case it just returns the list."
782
  (unless number
783 784 785
    (setq number (if (vectorp diary-number-of-entries)
                     (aref diary-number-of-entries (calendar-day-of-week date))
                   diary-number-of-entries)))
Glenn Morris's avatar
Glenn Morris committed
786
  (when (> number 0)
787 788
    (let* ((original-date date)    ; save for possible use in the hooks
           (date-string (calendar-date-string date))
789
           (diary-buffer (find-buffer-visiting diary-file))
790
           ;; Dynamically bound in diary-include-files.
Glenn Morris's avatar
Glenn Morris committed
791
           (d-incp (and (boundp 'diary-including) diary-including))
792
           diary-entries-list file-glob-attrs temp-buff)
Glenn Morris's avatar
Glenn Morris committed
793 794 795
      (unless d-incp
        (setq diary-included-files nil)
        (message "Preparing diary..."))
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
      (unwind-protect
          (with-current-buffer (or diary-buffer
                                   (if list-only
                                       (setq temp-buff (generate-new-buffer
                                                        " *diary-temp*"))
                                     (find-file-noselect diary-file t)))
            (if diary-buffer
                (or (verify-visited-file-modtime diary-buffer)
                    (revert-buffer t t)))
            (if temp-buff
                ;; If including, caller has already verified it is readable.
                (insert-file-contents diary-file)
              ;; Setup things like the header-line-format and invisibility-spec.
              (if (eq major-mode (default-value '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
                (if (eq major-mode 'diary-mode)
                    (setq header-line-format (and diary-header-line-flag
                                                  diary-header-line-format)))))
            ;; d-s-p is passed to the diary display function.
            (let ((diary-saved-point (point)))
              (save-excursion
                (save-restriction
                  (widen)                   ; bug#5093
                  (setq file-glob-attrs (cadr (diary-pull-attrs nil "")))
                  (with-syntax-table diary-syntax-table
                    (goto-char (point-min))
                    (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)))
833
                    (dotimes (_idummy number)
834 835 836 837 838 839 840 841 842 843 844
                      (let ((sexp-found (diary-list-sexp-entries date))
                            (entry-found (diary-list-entries-2
                                          date diary-nonmarking-symbol
                                          file-glob-attrs list-only)))
                        (if diary-list-include-blanks
                            (or sexp-found entry-found
                                (diary-add-to-list date "" "" "" "")))
                        (setq date
                              (calendar-gregorian-from-absolute
                               (1+ (calendar-absolute-from-gregorian date)))))))
                  (goto-char (point-min))
Glenn Morris's avatar
Glenn Morris committed
845 846 847 848
                  ;; Although it looks like list-entries-hook runs
                  ;; every time, diary-include-other-diary-files
                  ;; binds it to nil (essentially) when it runs
                  ;; in included files.
849 850
                  (run-hooks 'diary-nongregorian-listing-hook
                             'diary-list-entries-hook)
Glenn Morris's avatar
Glenn Morris committed
851 852 853 854 855
                  ;; We could make this explicit:
                  ;;; (run-hooks 'diary-nongregorian-listing-hook)
                  ;;; (if d-incp
                  ;;;     (diary-include-other-diary-files) ; recurse
                  ;;;   (run-hooks 'diary-list-entries-hook))
856
                  (unless list-only
857 858 859 860 861 862 863 864
                    ;; Avoid M-x diary; M-x calendar; M-x diary
                    ;; clobbering the calendar window.
                    ;; FIXME this is not the right solution.
                    (let ((display-buffer-fallback-action
                           (list (delq
                                  'display-buffer-in-previous-window
                                  (copy-sequence
                                   (car display-buffer-fallback-action))))))
865
                      (funcall diary-display-function)))
866 867 868 869
                  (run-hooks 'diary-hook)))))
        (and temp-buff (buffer-name temp-buff) (kill-buffer temp-buff)))
      (or d-incp (message "Preparing diary...done"))
      diary-entries-list)))
Edward M. Reingold's avatar
Edward M. Reingold committed
870

871
(defun diary-unhide-everything ()
872
  "Show all invisible text in the diary."
873
  (kill-local-variable 'diary-selective-display)
Stephen Berman's avatar
Stephen Berman committed
874 875 876
  (save-restriction                     ; bug#5477
    (widen)
    (remove-overlays (point-min) (point-max) 'invisible 'diary))
877 878
  (kill-local-variable 'mode-line-format))

Glenn Morris's avatar
Glenn Morris committed
879
(defvar original-date)                  ; bound in diary-list-entries
880
;(defvar number)                         ; already declared above
881

882 883 884 885
(defun diary-include-files (&optional mark)
  "Process diary entries from included diary files.
By default, lists included entries, but if optional argument MARK is non-nil
marks entries instead.
Glenn Morris's avatar
Glenn Morris committed
886 887 888
For example, this enables you to share common diary files.
Specify include files using lines matching `diary-include-string', e.g.
    #include \"filename\"
889
This is recursive; that is, included files may include other files."
Edward M. Reingold's avatar
Edward M. Reingold committed
890 891
  (goto-char (point-min))
  (while (re-search-forward
892
          (format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string))
Edward M. Reingold's avatar
Edward M. Reingold committed
893
          nil t)
894
    (let ((diary-file (match-string-no-properties 1))
895
          (diary-mark-entries-hook 'diary-mark-included-diary-files)
896
          (diary-list-entries-hook 'diary-include-other-diary-files)
Glenn Morris's avatar
Glenn Morris committed
897
          (diary-including t)
898
          diary-hook diary-list-include-blanks efile)
Edward M. Reingold's avatar
Edward M. Reingold committed
899 900
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
Glenn Morris's avatar
Glenn Morris committed
901 902 903 904
              (if (member (setq efile (expand-file-name diary-file))
                          diary-included-files)
                  (error "Recursive diary include for %s" diary-file)
                (setq diary-included-files
905 906 907 908 909 910
                      (append diary-included-files (list efile)))
                (if mark
                    (diary-mark-entries)
                  (setq diary-entries-list
                        (append diary-entries-list
                                (diary-list-entries original-date number t)))))
911 912
            (display-warning
             :error
913 914
             (format-message "Can't read included diary file %s\n"
			     diary-file)))
915 916
        (display-warning
         :error
917 918
         (format-message "Can't find included diary file %s\n"
			 diary-file)))))
Glenn Morris's avatar
Glenn Morris committed
919
  (goto-char (point-min)))
Edward M. Reingold's avatar
Edward M. Reingold committed
920

921 922 923 924 925 926 927
(defun diary-include-other-diary-files ()
  "Add diary entries from included diary files to `diary-entries-list'.
To use, add this function to `diary-list-entries-hook'.
For details, see `diary-include-files'.
See also `diary-mark-included-diary-files'."
  (diary-include-files))

928 929 930
(defvar date-string)                    ; bound in diary-list-entries

(defun diary-display-no-entries ()
931
  "Common subroutine of `diary-simple-display' and `diary-fancy-display'.
932 933
Handles the case where there are no diary entries.
Returns a cons (NOENTRIES . HOLIDAY-STRING)."
934
    (let* ((holiday-list (if diary-show-holidays-flag
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
                             (calendar-check-holidays original-date)))
           (hol-string (format "%s%s%s"
                               date-string
                               (if holiday-list ": " "")
                               (mapconcat 'identity holiday-list "; ")))
           (msg (format "No diary entries for %s" hol-string))
           ;; Empty list, or single item with no text.
           ;; FIXME multiple items with no text?
           (noentries (or (not diary-entries-list)
                          (and (not (cdr diary-entries-list))
                               (string-equal "" (cadr
                                                 (car diary-entries-list)))))))
      ;; Inconsistency: whether or not the holidays are displayed in a
      ;; separate buffer depends on if there are diary entries.
      (when noentries
        (if (or (< (length msg) (frame-width))
                (not holiday-list))
952
            (message "%s" msg)
953
          ;; holiday-list which is too wide for a message gets a buffer.
954
          (calendar-in-read-only-buffer holiday-buffer
955
            (calendar-set-mode-line (format "Holidays for %s" date-string))
956
            (insert (mapconcat 'identity holiday-list "\n")))
957 958 959 960 961 962
          (message "No diary entries for %s" date-string)))
      (cons noentries hol-string)))


(defvar diary-saved-point)              ; bound in diary-list-entries

963
(defun diary-simple-display ()
964 965 966
  "Display the diary buffer if there are any relevant entries or holidays.
Entries that do not apply are made invisible.  Holidays are shown
in the mode line.  This is an option for `diary-display-function'."
967 968
  ;; If selected window is dedicated (to the calendar), need a new one
  ;; to display the diary.
969
  (let* ((pop-up-frames (or pop-up-frames (window-dedicated-p)))
970
         (dbuff (find-buffer-visiting diary-file))
971 972 973
         (empty (diary-display-no-entries)))
    ;; This may be too wide, but when simple diary is used there is
    ;; nowhere else for the holidays to go.  Also, it is documented in
974
    ;; diary-show-holidays-flag that the holidays go in the mode-line.
975 976 977 978 979 980
    ;; FIXME however if there are no diary entries a separate buffer
    ;; is displayed - this is inconsistent.
    (with-current-buffer dbuff
      (calendar-set-mode-line (format "Diary for %s" (cdr empty))))
    (unless (car empty)                 ; no entries
      (with-current-buffer dbuff
Glenn Morris's avatar
Glenn Morris committed
981
        (let ((window (display-buffer (current-buffer))))
982
          ;; d-s-p is passed from diary-list-entries.
Glenn Morris's avatar
Glenn Morris committed
983
          (set-window-point window diary-saved-point)
Glenn Morris's avatar
Glenn Morris committed
984
          (set-window-start window (point-min)))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
985

986 987 988 989 990 991 992 993
(defvar diary-goto-entry-function 'diary-goto-entry
  "Function called to jump to a diary entry.
Modes that require special handling of the included file
containing the diary entry can assign a suitable function to this
variable.")

(define-button-type 'diary-entry
  'action (lambda (button) (funcall diary-goto-entry-function button))
994 995
  'face 'diary-button 'help-echo "Find this diary entry"
  'follow-link t)
996 997

(defun diary-goto-entry (button)
998
  "Jump to the diary entry for the BUTTON at point."
Glenn Morris's avatar
Glenn Morris committed
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
  (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
1012
                 (when (eq major-mode (default-value 'major-mode)) (diary-mode))
Glenn Morris's avatar
Glenn Morris committed
1013 1014 1015 1016 1017 1018 1019
                 (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")))))
1020

1021
(defun diary-fancy-display ()
Edward M. Reingold's avatar
Edward M. Reingold committed
1022
  "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
1023 1024 1025 1026 1027
Holidays are shown unless `diary-show-holidays-flag' is nil.
Days with no diary entries are not shown (even if that day is a
holiday), unless `diary-list-include-blanks' is non-nil.

This is an option for `diary-display-function'."
1028
  ;; Turn off selective-display in the diary file's buffer.
1029
  (with-current-buffer (find-buffer-visiting diary-file)
1030
    (diary-unhide-everything))
1031
  (unless (car (diary-display-no-entries)) ; no entries
1032
    ;; Prepare the fancy diary buffer.
1033
    (calendar-in-read-only-buffer diary-fancy-buffer
1034
      (calendar-set-mode-line "Diary Entries")
1035
      (let ((holiday-list-last-month 1)
Edward M. Reingold's avatar
Edward M. Reingold committed
1036
            (holiday-list-last-year 1)
1037 1038 1039
            (date (list 0 0 0))
            holiday-list)
        (dolist (entry diary-entries-list)
1040 1041
          (unless (calendar-date-equal date (car entry))
            (setq date (car entry))
1042
            (and diary-show-holidays-flag
1043 1044 1045 1046 1047 1048 1049 1050 1051
                 (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
1052
                       (calendar-extract-month date)
1053
                       holiday-list-last-year
1054
                       (calendar-extract-year date))
1055
                 (progn
1056
                   (calendar-increment-month
1057 1058 1059 1060 1061 1062
                    holiday-list-last-month holiday-list-last-year 1)
                   t)
                 (setq holiday-list
                       (let ((displayed-month holiday-list-last-month)
                             (displayed-year holiday-list-last-year))
                         (calendar-holiday-list)))
Glenn Morris's avatar