diary-lib.el 114 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-1995, 2001-2011
Glenn Morris's avatar
Glenn Morris committed
4
;;   Free Software Foundation, Inc.
Edward M. Reingold's avatar
Edward M. Reingold committed
5 6

;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7
;; Maintainer: Glenn Morris <rgm@gnu.org>
Edward M. Reingold's avatar
Edward M. Reingold committed
8 9 10 11
;; 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 52 53 54
  :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
55
  :group 'calendar-faces)
Glenn Morris's avatar
Glenn Morris committed
56
(make-obsolete-variable 'diary-face "customize the face `diary' instead."
Glenn Morris's avatar
Glenn Morris committed
57
                        "23.1")
Glenn Morris's avatar
Glenn Morris committed
58

59 60 61
(defface diary-anniversary '((t :inherit font-lock-keyword-face))
  "Face used for anniversaries in the fancy diary display."
  :version "22.1"
62
  :group 'calendar-faces)
63 64

(defface diary-time '((t :inherit font-lock-variable-name-face))
65
  "Face used for times of day in the fancy diary display."
66
  :version "22.1"
67
  :group 'calendar-faces)
68 69 70

(defface diary-button '((((type pc) (class color))
                         (:foreground "lightblue")))
71
  "Face used for buttons in the fancy diary display."
72
  :version "22.1"
73
  :group 'calendar-faces)
74 75

(define-obsolete-face-alias 'diary-button-face 'diary-button "22.1")
76

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

(defcustom diary-glob-file-regexp-prefix "^\\#"
122
  "Regular expression pre-pended to `diary-face-attrs' for file-wide specifiers."
123
  :type 'regexp
Glenn Morris's avatar
Glenn Morris committed
124 125 126 127 128 129 130 131 132 133 134 135
  :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)

136 137 138
(define-obsolete-variable-alias 'sexp-diary-entry-symbol
  'diary-sexp-entry-symbol "23.1")

139
(defcustom diary-sexp-entry-symbol "%%"
Glenn Morris's avatar
Glenn Morris committed
140
  "The string used to indicate a sexp diary entry in `diary-file'.
141
See the documentation for the function `diary-list-sexp-entries'."
Glenn Morris's avatar
Glenn Morris committed
142 143 144
  :type 'string
  :group 'diary)

Glenn Morris's avatar
Glenn Morris committed
145 146 147 148 149
(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
150 151
`appt.el' can use.  Comments may not span mutliple lines, and there
can be only one comment on any line.
Glenn Morris's avatar
Glenn Morris committed
152 153 154 155 156 157 158 159 160 161 162 163 164
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)

165 166 167 168 169 170
(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)

171 172 173
(define-obsolete-variable-alias 'diary-display-hook 'diary-display-function
  "23.1")

174
(defcustom diary-display-function 'diary-fancy-display
175
  "Function used to display the diary.
176
The two standard options are `diary-fancy-display' and `diary-simple-display'.
177 178 179 180 181 182 183 184 185 186 187 188

For historical reasons, `nil' is the same as `diary-simple-display'
\(so you must use `ignore' for no display).  Also for historical
reasons, this variable can be a list of functions to run.  These
uses are not recommended and may be removed at some point.

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."
189 190
  :type '(choice (const diary-fancy-display :tag "Fancy display")
                 (const diary-simple-display :tag "Basic display")
191 192 193
                 (const ignore :tag "No display")
                 (const nil :tag "Obsolete way to choose basic display")
                 (hook :tag "Obsolete form with list of display functions"))
194 195
  :initialize 'custom-initialize-default
  :set 'diary-set-maybe-redraw
196
  :version "23.2"                       ; simple->fancy
197 198
  :group 'diary)

199 200 201
(define-obsolete-variable-alias 'list-diary-entries-hook
  'diary-list-entries-hook "23.1")

202
(defcustom diary-list-entries-hook nil
Glenn Morris's avatar
Glenn Morris committed
203
  "List of functions called after diary file is culled for relevant entries.
204 205 206
You might wish to add `diary-include-other-diary-files', in which case
you will probably also want to add `diary-mark-included-diary-files' to
`diary-mark-entries-hook'.  For example, you could use
Glenn Morris's avatar
Glenn Morris committed
207

208
     (setq diary-display-function 'diary-fancy-display)
209
     (add-hook 'diary-list-entries-hook 'diary-include-other-diary-files)
210
     (add-hook 'diary-list-entries-hook 'diary-sort-entries t)
Glenn Morris's avatar
Glenn Morris committed
211 212 213

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
214 215
lexicographic order.  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
216
  :type 'hook
217
  :options '(diary-include-other-diary-files diary-sort-entries)
Glenn Morris's avatar
Glenn Morris committed
218 219
  :group 'diary)

220 221
(define-obsolete-variable-alias 'mark-diary-entries-hook
  'diary-mark-entries-hook "23.1")
222 223

(defcustom diary-mark-entries-hook nil
Glenn Morris's avatar
Glenn Morris committed
224
  "List of functions called after marking diary entries in the calendar.
225 226 227
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
`diary-list-entries-hook'."
Glenn Morris's avatar
Glenn Morris committed
228
  :type 'hook
229
  :options '(diary-mark-included-diary-files)
Glenn Morris's avatar
Glenn Morris committed
230 231
  :group 'diary)

232 233
(define-obsolete-variable-alias 'nongregorian-diary-listing-hook
  'diary-nongregorian-listing-hook "23.1")
234 235

(defcustom diary-nongregorian-listing-hook nil
Glenn Morris's avatar
Glenn Morris committed
236 237
  "List of functions called for listing diary file and included files.
As the files are processed for diary entries, these functions are used
238
to cull relevant entries.  You can use any or all of
Glenn Morris's avatar
Glenn Morris committed
239 240
`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
241 242
describes the style of such diary entries."
  :type 'hook
Glenn Morris's avatar
Glenn Morris committed
243 244 245
  :options '(diary-bahai-list-entries
             diary-hebrew-list-entries
             diary-islamic-list-entries)
Glenn Morris's avatar
Glenn Morris committed
246 247
  :group 'diary)

248 249
(define-obsolete-variable-alias 'nongregorian-diary-marking-hook
  'diary-nongregorian-marking-hook "23.1")
250 251

(defcustom diary-nongregorian-marking-hook nil
Glenn Morris's avatar
Glenn Morris committed
252 253
  "List of functions called for marking diary file and included files.
As the files are processed for diary entries, these functions are used
254
to cull relevant entries.  You can use any or all of
Glenn Morris's avatar
Glenn Morris committed
255 256
`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
257 258
describes the style of such diary entries."
  :type 'hook
Glenn Morris's avatar
Glenn Morris committed
259 260 261
  :options '(diary-bahai-mark-entries
             diary-hebrew-mark-entries
             diary-islamic-mark-entries)
Glenn Morris's avatar
Glenn Morris committed
262 263
  :group 'diary)

264 265
(define-obsolete-variable-alias 'print-diary-entries-hook
  'diary-print-entries-hook "23.1")
266 267 268

(defcustom diary-print-entries-hook 'lpr-buffer
  "Run by `diary-print-entries' after preparing a temporary diary buffer.
269 270 271 272 273
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
274 275 276 277
  :type 'hook
  :group 'diary)

(defcustom diary-unknown-time -9999
278
  "Value returned by `diary-entry-time' when no time is found.
279 280 281
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
282 283 284 285 286
  :type 'integer
  :group 'diary
  :version "20.3")

(defcustom diary-mail-addr
287
  (or (bound-and-true-p user-mail-address) "")
Glenn Morris's avatar
Glenn Morris committed
288 289 290 291 292 293 294 295 296 297 298 299 300
  "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 "
301
    (if (zerop (% days 7))
302 303
        (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
304 305 306 307 308
    " 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
309 310
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
311 312 313
  :type 'sexp
  :group 'diary)

314 315 316
(define-obsolete-variable-alias 'abbreviated-calendar-year
  'diary-abbreviated-year-flag "23.1")

317
(defcustom diary-abbreviated-year-flag t
318 319 320 321 322 323 324 325 326
  "Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
This applies to the Gregorian, Hebrew, Islamic, and Baha'i calendars.
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)

327 328 329 330
(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
331 332 333 334
%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))
335 336 337 338 339 340 341 342 343 344
        ;; 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
345
                (calendar-date-string (list month (string-to-number day)
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
                                            (string-to-number year)))
              (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
363
(defcustom diary-outlook-formats
364 365 366 367
  '(;; 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\
368
\\(?:Where: \\(.+\n\\)\\)?" . diary-outlook-format-1))
Glenn Morris's avatar
Glenn Morris committed
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
  "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
385 386 387 388
                :value-type (choice
                             (string :tag "Template for entry")
                             (function :tag
                                       "Unary function providing template")))
Glenn Morris's avatar
Glenn Morris committed
389 390 391
  :version "22.1"
  :group 'diary)

392 393
(defvar diary-header-line-flag)
(defvar diary-header-line-format)
394

395 396 397
(defun diary-set-header (symbol value)
  "Set SYMBOL's value to VALUE, and redraw the diary header if necessary."
  (let ((oldvalue (symbol-value symbol))
398
        (dbuff (and diary-file (find-buffer-visiting diary-file))))
399 400 401 402 403 404 405 406 407 408 409
    (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
410
  "Non-nil means `diary-simple-display' will show a header line.
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
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
                     "Some text is hidden - press \"s\" in calendar \
before edit/copy"
                   "Diary"))
Glenn Morris's avatar
Glenn Morris committed
427
           ?\s (window-width)))
428
  "Format of the header line displayed by `diary-simple-display'.
429 430 431 432 433
Only used if `diary-header-line-flag' is non-nil."
  :group 'diary
  :type 'sexp
  :initialize 'custom-initialize-default
  :set 'diary-set-header
434
  :version "23.3")                      ; frame-width -> window-width
435

436 437 438 439 440 441 442 443 444 445 446 447 448 449
;; 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 ()
  "Return non-nil if the diary is being displayed."
450
  (or (get-buffer diary-fancy-buffer)
451
      (and diary-file (find-buffer-visiting diary-file))))
452 453 454 455 456 457

;;;###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."
458
  (let ((oldvalue (symbol-value symbol)))
459 460 461 462 463 464
    (custom-set-default symbol value)
    (and (not (equal value oldvalue))
         (diary-live-p)
         ;; Note this assumes diary was called without prefix arg.
         (diary))))

465 466 467
(define-obsolete-variable-alias 'number-of-diary-entries
  'diary-number-of-entries "23.1")

468
(defcustom diary-number-of-entries 1
469
  "Specifies how many days of diary entries are to be displayed initially.
470 471 472 473 474 475 476 477 478 479
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.
480 481

This variable does not affect the diary display with the `d' command
482 483
from the calendar; in that case, the prefix argument controls the number
of days of diary entries displayed."
484 485 486 487 488 489 490 491 492 493 494 495 496
  :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)

497
;;; More user options in calendar.el, holidays.el.
Glenn Morris's avatar
Glenn Morris committed
498 499


500 501 502
(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."
503 504 505 506 507
  (if (and diary-file (file-exists-p diary-file))
      (if (file-readable-p diary-file)
          diary-file
        (error "Diary file `%s' is not readable" diary-file))
    (error "Diary file `%s' does not exist" diary-file)))
508

Edward M. Reingold's avatar
Edward M. Reingold committed
509 510 511 512
;;;###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
513
by the variable `diary-number-of-entries'.  A value of ARG less than 1
Glenn Morris's avatar
Glenn Morris committed
514
does nothing.  This function is suitable for execution in a `.emacs' file."
Edward M. Reingold's avatar
Edward M. Reingold committed
515
  (interactive "P")
516
  (diary-check-diary-file)
517 518
  (diary-list-entries (calendar-current-date)
                      (if arg (prefix-numeric-value arg))))
519

520
;;;###cal-autoload
521
(defun diary-view-entries (&optional arg)
Edward M. Reingold's avatar
Edward M. Reingold committed
522
  "Prepare and display a buffer with diary entries.
523 524
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
525 526
in the displayed three-month calendar."
  (interactive "p")
527
  (diary-check-diary-file)
528
  (diary-list-entries (calendar-cursor-to-date t) arg))
Edward M. Reingold's avatar
Edward M. Reingold committed
529

530

531
;;;###cal-autoload
532
(defun diary-view-other-diary-entries (arg dfile)
Edward M. Reingold's avatar
Edward M. Reingold committed
533
  "Prepare and display buffer of diary entries from an alternative diary file.
534 535
Searches for entries that match ARG days, starting with the date indicated
by the cursor position in the displayed three-month calendar.
536
DFILE specifies the file to use as the diary file."
Edward M. Reingold's avatar
Edward M. Reingold committed
537
  (interactive
538
   (list (prefix-numeric-value current-prefix-arg)
539
         (read-file-name "Enter diary file name: " default-directory nil t)))
540
  (let ((diary-file dfile))
541
    (diary-view-entries arg)))
Edward M. Reingold's avatar
Edward M. Reingold committed
542

543 544 545 546
;;;###cal-autoload
(define-obsolete-function-alias 'view-other-diary-entries
  'diary-view-other-diary-entries "23.1")

547 548 549 550 551
(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
552 553
  "The syntax table used when parsing dates in the diary file.
It is the standard syntax table used in Fundamental mode, but with the
554
syntax of `*' and `:' changed to be word constituents.")
Edward M. Reingold's avatar
Edward M. Reingold committed
555

556
(defun diary-attrtype-convert (attrvalue type)
557 558
  "Convert string ATTRVALUE to TYPE appropriate for a face description.
Valid TYPEs are: string, symbol, int, stringtnil, tnil."
559
  (cond ((eq type 'string) attrvalue)
560
        ((eq type 'symbol) (intern-soft attrvalue))
Glenn Morris's avatar
Glenn Morris committed
561 562 563 564 565 566
        ((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))))
567 568

(defun diary-pull-attrs (entry fileglobattrs)
569 570 571 572 573 574 575 576 577
  "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
578 579 580 581 582 583 584 585 586 587 588 589 590 591
        (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))))))
592 593
      (setq ret-attr fileglobattrs)
      (dolist (attr diary-face-attrs)
Glenn Morris's avatar
Glenn Morris committed
594 595 596 597 598
        (setq regexp (car attr)
              regnum (cadr attr)
              attrname (nth 2 attr)
              type (nth 3 attr)
              attrvalue nil)
599 600 601 602 603 604
        ;; 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
605 606 607
        (and attrvalue
             (setq attrvalue (diary-attrtype-convert attrvalue type))
             (setq ret-attr (append ret-attr (list attrname attrvalue))))))
608
    (list entry ret-attr)))
609

610

Glenn Morris's avatar
Glenn Morris committed
611 612 613 614 615 616 617

(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
618
(defvar diary-entries-list)             ; bound in diary-list-entries
619

620
(defun diary-add-to-list (date string specifier &optional marker
Glenn Morris's avatar
Glenn Morris committed
621 622
                               globcolor literal)
  "Add an entry to `diary-entries-list'.
623
Do nothing if DATE or STRING are nil.  DATE is the (MONTH DAY
Glenn Morris's avatar
Glenn Morris committed
624 625
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
626
strings such as \"%d\" expanded); SPECIFIER is the date part of
Glenn Morris's avatar
Glenn Morris committed
627
the entry as it appears in the diary-file; LITERAL is the entry
628 629
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
630 631 632

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
633 634 635 636 637
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
638
  (when (and date string)
639
    ;; b-f-n is nil if we are visiting an include file in a temp-buffer.
Glenn Morris's avatar
Glenn Morris committed
640 641
    (let ((dfile (or (buffer-file-name) diary-file))
          cstart)
642 643 644 645 646 647 648
      (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
649 650 651 652 653
      (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))
654 655
        ;; 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
656
        (setq string (replace-regexp-in-string
657
                      (format "%s.*%s" cstart (regexp-quote diary-comment-end))
Glenn Morris's avatar
Glenn Morris committed
658
                      "" string)))
659 660 661 662 663
      (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
664

665 666
(define-obsolete-function-alias 'add-to-diary-list 'diary-add-to-list "23.1")

667
(defun diary-list-entries-2 (date mark globattr list-only
668
                                  &optional months symbol gdate)
669 670 671 672 673 674 675
  "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
676 677 678
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."
679 680 681
  (let* ((month (calendar-extract-month date))
         (day (calendar-extract-day date))
         (year (calendar-extract-year date))
682 683 684 685 686 687 688 689 690 691
         (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
692
                       (if diary-abbreviated-year-flag
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
                           (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))
709 710
          ;; regexp moves us past the end of date, onto the next line.
          ;; Trailing whitespace after date not allowed (see diary-file).
711
          (if (and (bolp) (not (looking-at "[ \t]")))
712
              ;; Diary entry that consists only of date.
713 714 715
              (backward-char 1)
            ;; Found a nonempty diary entry--make it
            ;; visible and add it to the list.
716
            (setq date-start (line-end-position 0))
717 718 719
            ;; Actual entry starts on the next-line?
            (if (looking-at "[ \t]*\n[ \t]") (forward-line 1))
            (setq entry-found t
720
                  entry-start (point))
721 722 723 724 725 726 727 728 729 730
            (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))
731
            (diary-add-to-list
732
             (or gdate date) (car temp)
733 734 735 736 737 738 739
             (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)
740
(defvar number)
741 742 743 744 745 746

(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."
747
  (let ((gdate original-date))
748
    (dotimes (_idummy number)
749 750
      (diary-list-entries-2
       (funcall absfunc (calendar-absolute-from-gregorian gdate))
751
       diary-nonmarking-symbol file-glob-attrs list-only months symbol gdate)
752 753 754 755
      (setq gdate
            (calendar-gregorian-from-absolute
             (1+ (calendar-absolute-from-gregorian gdate))))))
  (goto-char (point-min)))
756

Glenn Morris's avatar
Glenn Morris committed
757 758 759
(defvar diary-included-files nil
  "List of any diary files included in the last call to `diary-list-entries'.")

760
;; FIXME non-greg and list hooks run same number of times?
761
(defun diary-list-entries (date number &optional list-only)
762
  "Create and display a buffer containing the relevant lines in `diary-file'.
Edward M. Reingold's avatar
Edward M. Reingold committed
763 764
The arguments are DATE and NUMBER; the entries selected are those
for NUMBER days starting with date DATE.  The other entries are hidden
765
using overlays.  If NUMBER is less than 1, this function does nothing.
Edward M. Reingold's avatar
Edward M. Reingold committed
766

767
Returns a list of all relevant diary entries found.
768 769 770
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'
771 772
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
773

774 775 776 777 778 779 780 781 782 783 784 785 786
If entries are being produced 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
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
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'.

After the initial list is prepared, the following hooks are run:
Edward M. Reingold's avatar
Edward M. Reingold committed
787

788
  `diary-nongregorian-listing-hook' can cull dates from the diary
789 790
      and each included file, for example to process Islamic diary
      entries.  Applied to *each* file.
Edward M. Reingold's avatar
Edward M. Reingold committed
791

792
  `diary-list-entries-hook' adds or manipulates diary entries from
793 794 795
      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.
Edward M. Reingold's avatar
Edward M. Reingold committed
796

797 798
  `diary-hook' is run last, after the diary is displayed.
      This is used e.g. by `appt-check'.
799

Glenn Morris's avatar
Glenn Morris committed
800 801 802
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.
803
\(Sexp diary entries may use DATE - see `diary-list-sexp-entries'.)
804

805 806
This function displays the list using `diary-display-function', unless
LIST-ONLY is non-nil, in which case it just returns the list."
807
  (unless number
808 809 810
    (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
811
  (when (> number 0)
812 813
    (let* ((original-date date)    ; save for possible use in the hooks
           (date-string (calendar-date-string date))
814
           (diary-buffer (find-buffer-visiting diary-file))
Glenn Morris's avatar
Glenn Morris committed
815 816
           ;; Dynamically bound in diary-include-other-diary-files.
           (d-incp (and (boundp 'diary-including) diary-including))
817
           diary-entries-list file-glob-attrs temp-buff)
Glenn Morris's avatar
Glenn Morris committed
818 819 820
      (unless d-incp
        (setq diary-included-files nil)
        (message "Preparing diary..."))
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
      (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)))
858
                    (dotimes (_idummy number)
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
                      (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))
                  (run-hooks 'diary-nongregorian-listing-hook
                             'diary-list-entries-hook)
                  (unless list-only
                    (if (and diary-display-function
                             (listp diary-display-function))
                        ;; Backwards compatibility.
                        (run-hooks 'diary-display-function)
                      (funcall (or diary-display-function
                                   'diary-simple-display))))
                  (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
883

884
(defun diary-unhide-everything ()
885
  "Show all invisible text in the diary."
886
  (kill-local-variable 'diary-selective-display)
Stephen Berman's avatar
Stephen Berman committed
887 888 889
  (save-restriction                     ; bug#5477
    (widen)
    (remove-overlays (point-min) (point-max) 'invisible 'diary))
890 891
  (kill-local-variable 'mode-line-format))

Glenn Morris's avatar
Glenn Morris committed
892
(defvar original-date)                  ; bound in diary-list-entries
893
;(defvar number)                         ; already declared above
894

895
(defun diary-include-other-diary-files ()
896
  "Include the diary entries from other diary files with those of `diary-file'.
897
This function is suitable for use with `diary-list-entries-hook';
Edward M. Reingold's avatar
Edward M. Reingold committed
898
it enables you to use shared diary files together with your own.
899
The files included are specified in the `diary-file' by lines of this form:
Edward M. Reingold's avatar
Edward M. Reingold committed
900 901
        #include \"filename\"
This is recursive; that is, #include directives in diary files thus included
902 903
are obeyed.  You can change the `#include' to some other string by changing
the variable `diary-include-string'."
Edward M. Reingold's avatar
Edward M. Reingold committed
904 905
  (goto-char (point-min))
  (while (re-search-forward
906
          (format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string))
Edward M. Reingold's avatar
Edward M. Reingold committed
907
          nil t)
908
    (let ((diary-file (match-string-no-properties 1))
909
          (diary-list-entries-hook 'diary-include-other-diary-files)
Glenn Morris's avatar
Glenn Morris committed
910
          (diary-including t)
911
          diary-hook diary-list-include-blanks efile)
Edward M. Reingold's avatar
Edward M. Reingold committed
912 913
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
Glenn Morris's avatar
Glenn Morris committed
914 915 916 917 918 919 920 921
              (if (member (setq efile (expand-file-name diary-file))
                          diary-included-files)
                  (error "Recursive diary include for %s" diary-file)
                (setq diary-included-files
                      (append diary-included-files (list efile))
                      diary-entries-list
                      (append diary-entries-list
                              (diary-list-entries original-date number t))))
Edward M. Reingold's avatar
Edward M. Reingold committed
922 923 924 925 926 927
            (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))))
Glenn Morris's avatar
Glenn Morris committed
928
  (goto-char (point-min)))
Edward M. Reingold's avatar
Edward M. Reingold committed
929

930 931 932
(define-obsolete-function-alias 'include-other-diary-files
  'diary-include-other-diary-files "23.1")

933 934 935
(defvar date-string)                    ; bound in diary-list-entries

(defun diary-display-no-entries ()
936
  "Common subroutine of `diary-simple-display' and `diary-fancy-display'.
937 938
Handles the case where there are no diary entries.
Returns a cons (NOENTRIES . HOLIDAY-STRING)."
939
    (let* ((holiday-list (if diary-show-holidays-flag
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
                             (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))
957
            (message "%s" msg)
958
          ;; holiday-list which is too wide for a message gets a buffer.
959
          (calendar-in-read-only-buffer holiday-buffer
960
            (calendar-set-mode-line (format "Holidays for %s" date-string))
961
            (insert (mapconcat 'identity holiday-list "\n")))
962 963 964 965 966 967
          (message "No diary entries for %s" date-string)))
      (cons noentries hol-string)))


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

968
(defun diary-simple-display ()
969 970 971
  "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'."
972 973 974 975
  ;; If selected window is dedicated (to the calendar), need a new one
  ;; to display the diary.
  (let* ((pop-up-frames (or pop-up-frames
                            (window-dedicated-p (selected-window))))
976
         (dbuff (find-buffer-visiting diary-file))
977 978 979
         (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
980
    ;; diary-show-holidays-flag that the holidays go in the mode-line.
981 982 983 984 985 986
    ;; 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
987
        (let ((window (display-buffer (current-buffer))))
988
          ;; d-s-p is passed from diary-list-entries.
Glenn Morris's avatar
Glenn Morris committed
989
          (set-window-point window diary-saved-point)
Glenn Morris's avatar
Glenn Morris committed
990
          (set-window-start window (point-min)))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
991

992 993 994
(define-obsolete-function-alias 'simple-diary-display
  'diary-simple-display "23.1")

995 996 997
(define-button-type 'diary-entry 'action #'diary-goto-entry
  'face 'diary-button 'help-echo "Find this diary entry"
  'follow-link t)
998 999

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

1023
(defun diary-fancy-display ()
Edward M. Reingold's avatar
Edward M. Reingold committed
1024
  "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
1025 1026 1027 1028 1029
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'."
1030
  ;; Turn off selective-display in the diary file's buffer.
1031
  (with-current-buffer (find-buffer-visiting diary-file)
1032
    (diary-unhide-everything))
1033
  (unless (car (diary-display-no-entries)) ; no entries
1034
    ;; Prepare the fancy diary buffer.
1035
    (calendar-in-read-only-buffer diary-fancy-buffer
1036
      (calendar-set-mode-line "Diary Entries")
1037
      (let ((holiday-list-last-month 1)
Edward M. Reingold's avatar
Edward M. Reingold committed
1038
            (holiday-list-last-year 1)
1039 1040 1041
            (date (list 0 0 0))
            holiday-list)
        (dolist (entry diary-entries-list)
1042 1043
          (unless (calendar-date-equal date (car entry))
            (setq date (car entry))
1044
            (and diary-show-holidays-flag
1045 1046 1047 1048 1049 1050 1051 1052 1053
                 (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
1054
                       (calendar-extract-month date)
1055
                       holiday-list-last-year
1056
                       (calendar-extract-year date))
1057
                 (progn
1058
                   (calendar-increment-month
1059 1060 1061 1062 1063 1064
                    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)))
1065
                 (calendar-increment-month
1066
                  holiday-list-last-month holiday-list-last-year 1))
1067 1068
            (let ((longest 0)
                  date-holiday-list cc)
1069 1070 1071 1072 1073 1074 1075
              ;; 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))
              (if date-holiday-list (insert ":  "))
1076 1077 1078 1079 1080 1081 1082
              (setq cc (current-column))
              (insert (mapconcat (lambda (x)
                                   (setq longest (max longest (length x)))
                                   x)
                                 date-holiday-list
                                 (concat "\n" (make-string cc ?\s))))
              (insert ?\n (make-string (+ cc longest) ?=) ?\n)))
Glenn Morris's avatar
Glenn Morris committed
1083
          (let ((this-entry (cadr entry))
1084
                this-loc marks temp-face)
Glenn Morris's avatar
Glenn Morris committed
1085 1086
            (unless (zerop (length this-entry))
              (if (setq this-loc (nth 3 entry))
1087
                  (insert-button this-entry
Glenn Morris's avatar
Glenn Morris committed
1088 1089 1090 1091 1092 1093 1094
                                 ;; (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)