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

3
;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995, 2001, 2002, 2003,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2004, 2005, 2006, 2007, 2008  Free Software Foundation, Inc.
Edward M. Reingold's avatar
Edward M. Reingold committed
5 6

;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7
;; Maintainer: Glenn Morris <rgm@gnu.org>
Edward M. Reingold's avatar
Edward M. Reingold committed
8 9 10 11 12 13
;; Keywords: calendar

;; This file is part of GNU Emacs.

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

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Edward M. Reingold's avatar
Edward M. Reingold committed
26 27 28

;;; Commentary:

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

;;; Code:

(require 'calendar)
34
(require 'diary-loaddefs)
35

Glenn Morris's avatar
Glenn Morris committed
36 37
(defcustom diary-include-string "#include"
  "The string indicating inclusion of another file of diary entries.
38
See the documentation for the function `diary-include-other-diary-files'."
Glenn Morris's avatar
Glenn Morris committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
  :type 'string
  :group 'diary)

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

(defcustom diary-face 'diary
  "Face name to use for diary entries."
  :type 'face
  :group 'diary)
(make-obsolete-variable 'diary-face "customize the face `diary' instead."
Glenn Morris's avatar
Glenn Morris committed
54
                        "23.1")
Glenn Morris's avatar
Glenn Morris committed
55

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
(defface diary-anniversary '((t :inherit font-lock-keyword-face))
  "Face used for anniversaries in the fancy diary display."
  :version "22.1"
  :group 'diary)

(defface diary-time '((t :inherit font-lock-variable-name-face))
  "Face used for times of day in the diary."
  :version "22.1"
  :group 'diary)

(defface diary-button '((((type pc) (class color))
                         (:foreground "lightblue")))
  "Default face used for buttons."
  :version "22.1"
  :group 'diary)
;; Backward-compatibility alias. FIXME make obsolete.
(put 'diary-button-face 'face-alias 'diary-button)

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

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

133
(defcustom diary-sexp-entry-symbol "%%"
Glenn Morris's avatar
Glenn Morris committed
134
  "The string used to indicate a sexp diary entry in `diary-file'.
135
See the documentation for the function `diary-list-sexp-entries'."
Glenn Morris's avatar
Glenn Morris committed
136 137 138
  :type 'string
  :group 'diary)

139 140 141
(define-obsolete-variable-alias 'sexp-diary-entry-symbol
  'diary-sexp-entry-symbol "23.1")

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
(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)

(defcustom diary-display-hook nil
  "List of functions that handle the display of the diary.
If nil (the default), `diary-simple-display' is used.  Use
`ignore' for no diary display.

Ordinarily, this just displays the diary buffer (with holidays
indicated in the mode line), if there are any relevant entries.
At the time these functions are 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, a different buffer for display (perhaps combined
with holidays), or produce hard copy output.

A function `diary-fancy-display' is provided for use with this
hook; this function prepares a special noneditable diary buffer
with the relevant diary entries that has neat day-by-day
arrangement with headings.  The fancy diary buffer will show the
holidays unless the variable `diary-show-holidays-flag' is set to
nil.  Ordinarily, the fancy diary buffer will not show days for
which there are no diary entries, even if that day is a holiday;
if you want such days to be shown in the fancy diary buffer, set
the variable `diary-list-include-blanks' non-nil."
  :type 'hook
  :options '(diary-fancy-display)
  :initialize 'custom-initialize-default
  :set 'diary-set-maybe-redraw
  :group 'diary)

177
(defcustom diary-list-entries-hook nil
Glenn Morris's avatar
Glenn Morris committed
178
  "List of functions called after diary file is culled for relevant entries.
179 180 181
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
182

183 184 185
     (add-hook 'diary-list-entries-hook 'diary-include-other-diary-files)
     (add-hook 'diary-list-entries-hook 'diary-sort-entries)
     (add-hook 'diary-display-hook 'diary-fancy-display)
Glenn Morris's avatar
Glenn Morris committed
186 187 188 189 190

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

194 195 196 197
(define-obsolete-variable-alias 'list-diary-entries-hook
  'diary-list-entries-hook "23.1")

(defcustom diary-mark-entries-hook nil
Glenn Morris's avatar
Glenn Morris committed
198
  "List of functions called after marking diary entries in the calendar.
199 200 201
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
202
  :type 'hook
203
  :options '(diary-mark-included-diary-files)
Glenn Morris's avatar
Glenn Morris committed
204 205
  :group 'diary)

206 207 208 209
(define-obsolete-variable-alias 'mark-diary-entries-hook
  'diary-mark-entries-hook "23.1")

(defcustom diary-nongregorian-listing-hook nil
Glenn Morris's avatar
Glenn Morris committed
210 211
  "List of functions called for listing diary file and included files.
As the files are processed for diary entries, these functions are used
212
to cull relevant entries.  You can use any or all of
Glenn Morris's avatar
Glenn Morris committed
213 214
`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
215 216
describes the style of such diary entries."
  :type 'hook
Glenn Morris's avatar
Glenn Morris committed
217 218 219
  :options '(diary-bahai-list-entries
             diary-hebrew-list-entries
             diary-islamic-list-entries)
Glenn Morris's avatar
Glenn Morris committed
220 221
  :group 'diary)

222 223 224 225
(define-obsolete-variable-alias 'nongregorian-diary-listing-hook
  'diary-nongregorian-listing-hook "23.1")

(defcustom diary-nongregorian-marking-hook nil
Glenn Morris's avatar
Glenn Morris committed
226 227
  "List of functions called for marking diary file and included files.
As the files are processed for diary entries, these functions are used
228
to cull relevant entries.  You can use any or all of
Glenn Morris's avatar
Glenn Morris committed
229 230
`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
231 232
describes the style of such diary entries."
  :type 'hook
Glenn Morris's avatar
Glenn Morris committed
233 234 235
  :options '(diary-bahai-mark-entries
             diary-hebrew-mark-entries
             diary-islamic-mark-entries)
Glenn Morris's avatar
Glenn Morris committed
236 237
  :group 'diary)

238 239 240 241 242
(define-obsolete-variable-alias 'nongregorian-diary-marking-hook
  'diary-nongregorian-marking-hook "23.1")

(defcustom diary-print-entries-hook 'lpr-buffer
  "Run by `diary-print-entries' after preparing a temporary diary buffer.
243 244 245 246 247
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
248 249 250
  :type 'hook
  :group 'diary)

251 252 253
(define-obsolete-variable-alias 'print-diary-entries-hook
  'diary-print-entries-hook "23.1")

Glenn Morris's avatar
Glenn Morris committed
254
(defcustom diary-unknown-time -9999
255
  "Value returned by `diary-entry-time' when no time is found.
256 257 258
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
259 260 261 262 263
  :type 'integer
  :group 'diary
  :version "20.3")

(defcustom diary-mail-addr
264
  (or (bound-and-true-p user-mail-address) "")
Glenn Morris's avatar
Glenn Morris committed
265 266 267 268 269 270 271 272 273 274 275 276 277
  "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 "
278
    (if (zerop (% days 7))
279 280
        (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
281 282 283 284 285 286 287 288 289 290
    " until "
    diary-entry)
  "Pseudo-pattern giving form of reminder messages in the fancy diary display.

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

291
(defcustom diary-abbreviated-year-flag t
292 293 294 295 296 297 298 299 300
  "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)

301 302 303
(define-obsolete-variable-alias 'abbreviated-calendar-year
  'diary-abbreviated-year-flag "23.1")

Glenn Morris's avatar
Glenn Morris committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
(defcustom diary-outlook-formats
  '(
    ;; When: 11 October 2001 12:00-14:00 (GMT) Greenwich Mean Time : Dublin, ...
    ;; [Current UK format?  The timezone is meaningless.  Sometimes the
    ;; Where is missing.]
    ("When: \\([0-9]+ [[:alpha:]]+ [0-9]+\\) \
\\([^ ]+\\) [^\n]+
\[^\n]+
\\(?:Where: \\([^\n]+\\)\n+\\)?
\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*"
     . "\\1\n \\2 %s, \\3")
    ;; When: Tuesday, April 30, 2002 03:00 PM-03:30 PM (GMT) Greenwich Mean ...
    ;; [Old UK format?]
    ("^When: [[:alpha:]]+, \\([[:alpha:]]+\\) \\([0-9][0-9]*\\), \\([0-9]\\{4\\}\\) \
\\([^ ]+\\) [^\n]+
\[^\n]+
\\(?:Where: \\([^\n]+\\)\\)?\n+"
     . "\\2 \\1 \\3\n \\4 %s, \\5")
    (
     ;; German format, apparently.
     "^Zeit: [^ ]+, +\\([0-9]+\\)\. +\\([[:upper:]][[:lower:]][[:lower:]]\\)[^ ]* +\\([0-9]+\\) +\\([^ ]+\\).*$"
     . "\\1 \\2 \\3\n \\4 %s"))
  "Alist of regexps matching message text and replacement text.

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

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

349 350
(defvar diary-header-line-flag)
(defvar diary-header-line-format)
351

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
(defun diary-set-header (symbol value)
  "Set SYMBOL's value to VALUE, and redraw the diary header if necessary."
  (let ((oldvalue (symbol-value symbol))
        (dbuff (and diary-file
                    (find-buffer-visiting
                     (substitute-in-file-name diary-file)))))
    (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
369
  "Non-nil means `diary-simple-display' will show a header line.
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
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"))
           ?\s (frame-width)))
387
  "Format of the header line displayed by `diary-simple-display'.
388 389 390 391 392 393 394
Only used if `diary-header-line-flag' is non-nil."
  :group 'diary
  :type 'sexp
  :initialize 'custom-initialize-default
  :set 'diary-set-header
  :version "22.1")

395 396 397 398 399 400 401 402 403 404 405 406 407 408
;; 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."
409
  (or (get-buffer diary-fancy-buffer)
410 411 412 413 414 415 416 417
      (and diary-file
           (find-buffer-visiting (substitute-in-file-name diary-file)))))

;;;###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."
418
  (let ((oldvalue (symbol-value symbol)))
419 420 421 422 423 424
    (custom-set-default symbol value)
    (and (not (equal value oldvalue))
         (diary-live-p)
         ;; Note this assumes diary was called without prefix arg.
         (diary))))

425
(defcustom diary-number-of-entries 1
426 427
  "Specifies how many days of diary entries are to be displayed initially.
This variable affects the diary display when the command \\[diary] is used,
428
or if the value of the variable `calendar-view-diary-initially-flag' is non-nil.
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
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.

This variable does not affect the diary display with the `d' command
from the calendar; in that case, the prefix argument controls the
number of days of diary entries displayed."
  :type '(choice (integer :tag "Entries")
                 (vector :value [0 0 0 0 0 0 0]
                         (integer :tag "Sunday")
                         (integer :tag "Monday")
                         (integer :tag "Tuesday")
                         (integer :tag "Wednesday")
                         (integer :tag "Thursday")
                         (integer :tag "Friday")
                         (integer :tag "Saturday")))
  :initialize 'custom-initialize-default
  :set 'diary-set-maybe-redraw
  :group 'diary)

455 456 457
(define-obsolete-variable-alias 'number-of-diary-entries
  'diary-number-of-entries "23.1")

458
;;; More user options in calendar.el.
Glenn Morris's avatar
Glenn Morris committed
459 460


461 462 463 464 465 466 467 468 469 470
(defun diary-check-diary-file ()
  "Check that the file specified by `diary-file' exists and is readable.
If so, return the expanded file name, otherwise signal an error."
  (let ((d-file (substitute-in-file-name diary-file)))
    (if (and d-file (file-exists-p d-file))
        (if (file-readable-p d-file)
            d-file
          (error "Diary file `%s' is not readable" diary-file))
      (error "Diary file `%s' does not exist" diary-file))))

Edward M. Reingold's avatar
Edward M. Reingold committed
471 472 473 474
;;;###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
475
by the variable `diary-number-of-entries'.  A value of ARG less than 1
Glenn Morris's avatar
Glenn Morris committed
476
does nothing.  This function is suitable for execution in a `.emacs' file."
Edward M. Reingold's avatar
Edward M. Reingold committed
477
  (interactive "P")
478
  (diary-check-diary-file)
479 480
  (diary-list-entries (calendar-current-date)
                      (if arg (prefix-numeric-value arg))))
481

482
;;;###cal-autoload
483
(defun diary-view-entries (&optional arg)
Edward M. Reingold's avatar
Edward M. Reingold committed
484 485 486 487 488
  "Prepare and display a buffer with diary entries.
Searches the file named in `diary-file' for entries that
match ARG days starting with the date indicated by the cursor position
in the displayed three-month calendar."
  (interactive "p")
489
  (diary-check-diary-file)
490
  (diary-list-entries (calendar-cursor-to-date t) arg))
Edward M. Reingold's avatar
Edward M. Reingold committed
491

492
(define-obsolete-function-alias 'view-diary-entries 'diary-view-entries "22.1")
493 494


495
;;;###cal-autoload
496
(defun diary-view-other-diary-entries (arg dfile)
Edward M. Reingold's avatar
Edward M. Reingold committed
497
  "Prepare and display buffer of diary entries from an alternative diary file.
498 499
Searches for entries that match ARG days, starting with the date indicated
by the cursor position in the displayed three-month calendar.
500
DFILE specifies the file to use as the diary file."
Edward M. Reingold's avatar
Edward M. Reingold committed
501
  (interactive
502
   (list (prefix-numeric-value current-prefix-arg)
503
         (read-file-name "Enter diary file name: " default-directory nil t)))
504
  (let ((diary-file dfile))
505
    (diary-view-entries arg)))
Edward M. Reingold's avatar
Edward M. Reingold committed
506

507 508 509 510
;;;###cal-autoload
(define-obsolete-function-alias 'view-other-diary-entries
  'diary-view-other-diary-entries "23.1")

511 512 513 514 515
(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
516 517
  "The syntax table used when parsing dates in the diary file.
It is the standard syntax table used in Fundamental mode, but with the
518
syntax of `*' and `:' changed to be word constituents.")
Edward M. Reingold's avatar
Edward M. Reingold committed
519

520
(defun diary-attrtype-convert (attrvalue type)
521 522
  "Convert string ATTRVALUE to TYPE appropriate for a face description.
Valid TYPEs are: string, symbol, int, stringtnil, tnil."
523
  (cond ((eq type 'string) attrvalue)
524
        ((eq type 'symbol) (intern-soft attrvalue))
Glenn Morris's avatar
Glenn Morris committed
525 526 527 528 529 530
        ((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))))
531 532

(defun diary-pull-attrs (entry fileglobattrs)
533 534 535 536 537 538 539 540 541
  "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
542 543 544 545 546 547 548 549 550 551 552 553 554 555
        (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))))))
556 557
      (setq ret-attr fileglobattrs)
      (dolist (attr diary-face-attrs)
Glenn Morris's avatar
Glenn Morris committed
558 559 560 561 562
        (setq regexp (car attr)
              regnum (cadr attr)
              attrname (nth 2 attr)
              type (nth 3 attr)
              attrvalue nil)
563 564 565 566 567 568
        ;; 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
569 570 571
        (and attrvalue
             (setq attrvalue (diary-attrtype-convert attrvalue type))
             (setq ret-attr (append ret-attr (list attrname attrvalue))))))
572
    (list entry ret-attr)))
573

574

Glenn Morris's avatar
Glenn Morris committed
575 576 577 578 579 580 581

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

584
(defun diary-add-to-list (date string specifier &optional marker
Glenn Morris's avatar
Glenn Morris committed
585 586 587 588 589
                               globcolor literal)
  "Add an entry to `diary-entries-list'.
Do nothing if DATE or STRING is nil.  DATE is the (MONTH DAY
YEAR) for which the entry applies; STRING is the text of the
entry as it will appear in the diary (i.e. with any format
590
strings such as \"%d\" expanded); SPECIFIER is the date part of
Glenn Morris's avatar
Glenn Morris committed
591
the entry as it appears in the diary-file; LITERAL is the entry
592
as it appears in the diary-file (i.e. before expansion).  If
Glenn Morris's avatar
Glenn Morris committed
593 594 595 596 597 598 599 600 601
LITERAL is nil, it is taken to be the same as STRING.

The entry is added to the list as (DATE STRING SPECIFIER LOCATOR
GLOBCOLOR), where LOCATOR has the form (MARKER FILENAME LITERAL),
FILENAME being the file containing the diary entry."
  (when (and date string)
    (if diary-file-name-prefix
        (let ((prefix (funcall diary-file-name-prefix-function
                               (buffer-file-name))))
602
          (or (string-equal prefix "")
Glenn Morris's avatar
Glenn Morris committed
603 604
              (setq string (format "[%s] %s" prefix string)))))
    (and diary-modify-entry-list-string-function
Glenn Morris's avatar
Glenn Morris committed
605 606
         (setq string (funcall diary-modify-entry-list-string-function
                               string)))
Glenn Morris's avatar
Glenn Morris committed
607 608 609 610 611 612
    (setq diary-entries-list
          (append diary-entries-list
                  (list (list date string specifier
                              (list marker (buffer-file-name) literal)
                              globcolor))))))

613 614
(define-obsolete-function-alias 'add-to-diary-list 'diary-add-to-list "23.1")

615 616 617 618 619 620 621 622 623 624
(defun diary-list-entries-2 (date mark globattr list-only
                                  &optional months symbol)
  "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
entries of the desired type.  Returns non-nil if any entries were found."
625 626 627
  (let* ((month (calendar-extract-month date))
         (day (calendar-extract-day date))
         (year (calendar-extract-year date))
628 629 630 631 632 633 634 635 636 637
         (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
638
                       (if diary-abbreviated-year-flag
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
                           (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))
655 656
          ;; regexp moves us past the end of date, onto the next line.
          ;; Trailing whitespace after date not allowed (see diary-file).
657 658 659 660 661
          (if (and (bolp) (not (looking-at "[ \t]")))
              ;;  Diary entry that consists only of date.
              (backward-char 1)
            ;; Found a nonempty diary entry--make it
            ;; visible and add it to the list.
662
            (setq date-start (line-end-position 0))
663 664 665
            ;; Actual entry starts on the next-line?
            (if (looking-at "[ \t]*\n[ \t]") (forward-line 1))
            (setq entry-found t
666
                  entry-start (point))
667 668 669 670 671 672 673 674 675 676
            (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))
677
            (diary-add-to-list
678 679 680 681 682 683 684 685
             date (car temp)
             (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)
686
(defvar number)
687 688 689 690 691 692

(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."
693 694 695 696 697 698 699 700 701
  (let ((gdate original-date))
    (dotimes (idummy number)
      (diary-list-entries-2
       (funcall absfunc (calendar-absolute-from-gregorian gdate))
       diary-nonmarking-symbol file-glob-attrs list-only months symbol)
      (setq gdate
            (calendar-gregorian-from-absolute
             (1+ (calendar-absolute-from-gregorian gdate))))))
  (goto-char (point-min)))
702

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

Returns a list of all relevant diary entries found, if any, in order by date.
711 712 713
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'
714 715
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
716

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

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

723
  `diary-list-entries-hook' adds or manipulates diary entries from
724 725 726
      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
727

728
  `diary-display-hook' does the actual display of information.  If nil,
729 730
      `diary-simple-display' is used.  Use `add-hook' to use
      `diary-fancy-display', if desired, or `ignore' for no display.
Edward M. Reingold's avatar
Edward M. Reingold committed
731

732
  `diary-hook' is run last.  This is used e.g. by `appt-check'.
733

Glenn Morris's avatar
Glenn Morris committed
734 735 736
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.
737
\(Sexp diary entries may use DATE - see `diary-list-sexp-entries'.)
738

739
If LIST-ONLY is non-nil don't modify or display the buffer, only return a list."
740
  (unless number
741 742 743
    (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
744
  (when (> number 0)
745 746 747 748 749
    (let* ((original-date date)    ; save for possible use in the hooks
           (date-string (calendar-date-string date))
           (d-file (substitute-in-file-name diary-file))
           (diary-buffer (find-buffer-visiting d-file))
           diary-entries-list file-glob-attrs)
Glenn Morris's avatar
Glenn Morris committed
750 751
      (message "Preparing diary...")
      (save-excursion
752 753 754 755 756
        (if (not diary-buffer)
            (set-buffer (find-file-noselect d-file t))
          (set-buffer diary-buffer)
          (or (verify-visited-file-modtime diary-buffer)
              (revert-buffer t t)))
757
        ;; Setup things like the header-line-format and invisibility-spec.
758 759 760 761 762 763 764 765
        (if (eq major-mode default-major-mode)
            (diary-mode)
          ;; This kludge is to make customizations to
          ;; diary-header-line-flag after diary has been displayed
          ;; take effect. Unconditionally calling (diary-mode)
          ;; clobbers file local variables.
          ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00363.html
          ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-04/msg00404.html
766 767 768
          (if (eq major-mode 'diary-mode)
              (setq header-line-format (and diary-header-line-flag
                                            diary-header-line-format))))
Glenn Morris's avatar
Glenn Morris committed
769 770 771
        ;; d-s-p is passed to the diary display function.
        (let ((diary-saved-point (point)))
          (save-excursion
772
            (setq file-glob-attrs (cadr (diary-pull-attrs nil "")))
773
            (with-syntax-table diary-syntax-table
774 775 776 777 778 779 780
              (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)))
              (dotimes (idummy number)
781
                (let ((sexp-found (diary-list-sexp-entries date))
782 783 784 785 786
                      (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
787
                          (diary-add-to-list date "" "" "" "")))
788 789 790
                  (setq date
                        (calendar-gregorian-from-absolute
                         (1+ (calendar-absolute-from-gregorian date)))))))
Glenn Morris's avatar
Glenn Morris committed
791
            (goto-char (point-min))
792 793
            (run-hooks 'diary-nongregorian-listing-hook
                       'diary-list-entries-hook)
794 795
            (unless list-only
              (if diary-display-hook
Glenn Morris's avatar
Glenn Morris committed
796
                  (run-hooks 'diary-display-hook)
797
                (diary-simple-display)))
Glenn Morris's avatar
Glenn Morris committed
798 799
            (run-hooks 'diary-hook)
            diary-entries-list))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
800

801 802
(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries "22.1")

803
(defun diary-unhide-everything ()
804
  "Show all invisible text in the diary."
805 806
  (kill-local-variable 'diary-selective-display)
  (remove-overlays (point-min) (point-max) 'invisible 'diary)
807 808
  (kill-local-variable 'mode-line-format))

Glenn Morris's avatar
Glenn Morris committed
809
(defvar original-date)                  ; bound in diary-list-entries
810 811
(defvar number)

812
(defun diary-include-other-diary-files ()
813
  "Include the diary entries from other diary files with those of `diary-file'.
814
This function is suitable for use with `diary-list-entries-hook';
Edward M. Reingold's avatar
Edward M. Reingold committed
815
it enables you to use shared diary files together with your own.
816
The files included are specified in the `diary-file' by lines of this form:
Edward M. Reingold's avatar
Edward M. Reingold committed
817 818 819 820 821 822
        #include \"filename\"
This is recursive; that is, #include directives in diary files thus included
are obeyed.  You can change the `#include' to some other string by
changing the variable `diary-include-string'."
  (goto-char (point-min))
  (while (re-search-forward
823
          (format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string))
Edward M. Reingold's avatar
Edward M. Reingold committed
824
          nil t)
Glenn Morris's avatar
Glenn Morris committed
825
    (let ((diary-file (substitute-in-file-name
Glenn Morris's avatar
Glenn Morris committed
826 827
                       (match-string-no-properties 1)))
          (diary-list-include-blanks nil)
828
          (diary-list-entries-hook 'diary-include-other-diary-files)
Glenn Morris's avatar
Glenn Morris committed
829 830
          (diary-display-hook 'ignore)
          (diary-hook nil))
Edward M. Reingold's avatar
Edward M. Reingold committed
831 832 833 834 835
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
              (unwind-protect
                  (setq diary-entries-list
                        (append diary-entries-list
836
                                (diary-list-entries original-date number)))
837 838
                (with-current-buffer (find-buffer-visiting diary-file)
                  (diary-unhide-everything)))
Edward M. Reingold's avatar
Edward M. Reingold committed
839 840 841 842 843 844
            (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
845
  (goto-char (point-min)))
Edward M. Reingold's avatar
Edward M. Reingold committed
846

847 848 849
(define-obsolete-function-alias 'include-other-diary-files
  'diary-include-other-diary-files "23.1")

850 851 852
(defvar date-string)                    ; bound in diary-list-entries

(defun diary-display-no-entries ()
853
  "Common subroutine of `diary-simple-display' and `diary-fancy-display'.
854 855
Handles the case where there are no diary entries.
Returns a cons (NOENTRIES . HOLIDAY-STRING)."
856
    (let* ((holiday-list (if diary-show-holidays-flag
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
                             (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))
874
            (message "%s" msg)
875
          ;; holiday-list which is too wide for a message gets a buffer.
876
          (calendar-in-read-only-buffer holiday-buffer
877
            (calendar-set-mode-line (format "Holidays for %s" date-string))
878
            (insert (mapconcat 'identity holiday-list "\n")))
879 880 881 882 883 884
          (message "No diary entries for %s" date-string)))
      (cons noentries hol-string)))


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

885
(defun diary-simple-display ()
886 887 888 889 890 891 892 893 894
  "Display the diary buffer if there are any relevant entries or holidays."
  ;; 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))))
         (dbuff (find-buffer-visiting (substitute-in-file-name diary-file)))
         (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
895
    ;; diary-show-holidays-flag that the holidays go in the mode-line.
896 897 898 899 900 901
    ;; 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
902
        (let ((window (display-buffer (current-buffer))))
903
          ;; d-s-p is passed from diary-list-entries.
Glenn Morris's avatar
Glenn Morris committed
904 905
          (set-window-point window diary-saved-point)
          (set-window-start window (point-min))))
Edward M. Reingold's avatar
Edward M. Reingold committed
906 907
      (message "Preparing diary...done"))))

908 909 910
(define-obsolete-function-alias 'simple-diary-display
  'diary-simple-display "23.1")

911 912
(define-button-type 'diary-entry
  'action #'diary-goto-entry
913
  'face 'diary-button)
914 915

(defun diary-goto-entry (button)
916
  "Jump to the diary entry for the BUTTON at point."
Glenn Morris's avatar
Glenn Morris committed
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
  (let* ((locator (button-get button 'locator))
         (marker (car locator))
         markbuf file)
    ;; If marker pointing to diary location is valid, use that.
    (if (and marker (setq markbuf (marker-buffer marker)))
        (progn
          (pop-to-buffer markbuf)
          (goto-char (marker-position marker)))
      ;; Marker is invalid (eg buffer has been killed).
      (or (and (setq file (cadr locator))
               (file-exists-p file)
               (find-file-other-window file)
               (progn
                 (when (eq major-mode default-major-mode) (diary-mode))
                 (goto-char (point-min))
                 (if (re-search-forward (format "%s.*\\(%s\\)"
                                                (regexp-quote (nth 2 locator))
                                                (regexp-quote (nth 3 locator)))
                                        nil t)
                     (goto-char (match-beginning 1)))))
          (message "Unable to locate this diary entry")))))
938

939
(defun diary-fancy-display ()
Edward M. Reingold's avatar
Edward M. Reingold committed
940
  "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
941
To use this function, add it to `diary-display-hook'."
942 943
  ;; Turn off selective-display in the diary file's buffer.
  (with-current-buffer
944 945
      (find-buffer-visiting (substitute-in-file-name diary-file))
    (diary-unhide-everything))
946
  (unless (car (diary-display-no-entries)) ; no entries
947
    ;; Prepare the fancy diary buffer.
948
    (calendar-in-read-only-buffer diary-fancy-buffer
949
      (calendar-set-mode-line "Diary Entries")
950
      (let ((holiday-list-last-month 1)
Edward M. Reingold's avatar
Edward M. Reingold committed
951
            (holiday-list-last-year 1)
952 953 954
            (date (list 0 0 0))
            holiday-list)
        (dolist (entry diary-entries-list)
955 956
          (unless (calendar-date-equal date (car entry))
            (setq date (car entry))
957
            (and diary-show-holidays-flag
958 959 960 961 962 963 964 965 966
                 (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
967
                       (calendar-extract-month date)
968
                       holiday-list-last-year
969
                       (calendar-extract-year date))
970
                 (progn
971
                   (calendar-increment-month
972 973 974 975 976 977
                    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)))
978
                 (calendar-increment-month
979
                  holiday-list-last-month holiday-list-last-year 1))
980 981
            (let ((longest 0)
                  date-holiday-list cc)
982 983 984 985 986 987 988
              ;; 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 ":  "))
989 990 991 992 993 994 995
              (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
996
          (let ((this-entry (cadr entry))
997
                this-loc marks temp-face)
Glenn Morris's avatar
Glenn Morris committed
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
            (unless (zerop (length this-entry))
              (if (setq this-loc (nth 3 entry))
                  (insert-button (concat this-entry "\n")
                                 ;; (MARKER FILENAME SPECIFIER LITERAL)
                                 'locator (list (car this-loc)
                                                (cadr this-loc)
                                                (nth 2 entry)
                                                (or (nth 2 this-loc)
                                                    (nth 1 entry)))
                                 :type 'diary-entry)
                (insert this-entry ?\n))
1009 1010 1011 1012 1013 1014 1015 1016
              (and font-lock-mode
                   (setq marks (nth 4 entry))
                   (save-excursion
                     (setq temp-face (calendar-make-temp-face marks))
                     (search-backward this-entry)
                     (overlay-put
                      (make-overlay (match-beginning 0) (match-end 0))
                      'face temp-face)))))))
1017
      (diary-fancy-display-mode)
Glenn Morris's avatar
Glenn Morris committed
1018
      (calendar-set-mode-line date-string)
Edward M. Reingold's avatar
Edward M. Reingold committed
1019 1020
      (message "Preparing diary...done"))))

1021 1022 1023
(define-obsolete-function-alias 'fancy-diary-display
  'diary-fancy-display "23.1")

1024
;; FIXME modernize?
1025
(defun diary-print-entries ()
Edward M. Reingold's avatar
Edward M. Reingold committed
1026 1027 1028 1029 1030 1031 1032 1033
  "Print a hard copy of the diary display.

If the simple diary display is being used, prepare a temp buffer with the
visible lines of the diary buffer, add a heading line composed from the mode
line, print the temp buffer, and destroy it.

If the fancy diary display is being used, just print the buffer.

1034
The hooks given by the variable `diary-print-entries-hook' are called to do
Edward M. Reingold's avatar
Edward M. Reingold committed
1035 1036
the actual printing."
  (interactive)
1037
  (let ((diary-buffer (get-buffer diary-fancy-buffer))
1038 1039 1040
        temp-buffer heading start end)
    (if diary-buffer
        (with-current-buffer diary-buffer
1041
          (run-hooks 'diary-print-entries-hook))
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
      (or (setq diary-buffer
                (find-buffer-visiting (substitute-in-file-name diary-file)))
          (error "You don't have a diary buffer!"))
      ;; Name affects printing?
      (setq temp-buffer (get-buffer-create " *Printable Diary Entries*"))
      (with-current-buffer diary-buffer
        (setq heading
              (if (not (stringp mode-line-format))
                  "All Diary Entries"
                (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
                (match-string 1 mode-line-format))
              start (point-min))
        (while
            (progn
              (setq end (next-single-char-property-change start 'invisible))
              (unless (get-char-property start 'invisible)
                (with-current-buffer temp-buffer
                  (insert-buffer-substring diary-buffer start end)))
              (setq start end)
              (and end (< end (point-max))))))
      (set-buffer temp-buffer)
      (goto-char (point-min))
      (insert heading "\n"
              (make-string (length heading) ?=) "\n")
1066
      (run-hooks 'diary-print-entries-hook)
1067
      (kill-buffer temp-buffer))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1068

1069 1070 1071
(define-obsolete-function-alias 'print-diary-entries
  'diary-print-entries "23.1")

1072
;;;###cal-autoload
1073
(defun diary-show-all-entries ()
Edward M. Reingold's avatar
Edward M. Reingold committed
1074 1075 1076 1077 1078
  "Show all of the diary entries in the diary file.
This function gets rid of the selective display of the diary file so that
all entries, not just some, are visible.  If there is no diary buffer, one
is created."
  (interactive)
Glenn Morris's avatar
Glenn Morris committed
1079
  (let ((d-file (diary-check-diary-file))
1080 1081
        (pop-up-frames (or pop-up-frames
                           (window-dedicated-p (selected-window)))))
1082 1083
    (with-current-buffer (or (find-buffer-visiting d-file)
                             (find-file-noselect d-file t))
1084
      (when (eq major-mode default-major-mode) (diary-mode))
1085 1086
      (diary-unhide-everything)
      (display-buffer (current-buffer)))))
1087

1088 1089 1090
(define-obsolete-function-alias 'show-all-diary-entries
  'diary-show-all-entries "22.1")

1091
;;;###autoload
1092 1093 1094
(defun diary-mail-entries (&optional ndays)
  "Send a mail message showing diary entries for next NDAYS days.
If no prefix argument is given, NDAYS is set to `diary-mail-days'.
1095
Mail is sent to the address specified by `diary-mail-addr'.
1096

Glenn Morris's avatar
Glenn Morris committed
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
Here is an example of a script to call `diary-mail-entries',
suitable for regular scheduling using cron (or at).  Note that
since `emacs -script' does not load your `.emacs' file, you
should ensure that all relevant variables are set.

#!/usr/bin/emacs -script
;; diary-rem.el - run the Emacs diary-reminder

\(setq diary-mail-days 3
      diary-file \"/path/to/diary.file\"
1107
      calendar-date-style 'european
Glenn Morris's avatar
Glenn Morris committed
1108 1109 1110 1111 1112 1113
      diary-mail-addr \"user@host.name\")

\(diary-mail-entries)

# diary-rem.el ends here
"
1114
  (interactive "P")
1115 1116
  (if (string-equal diary-mail-addr "")
      (error "You must set `diary-mail-addr' to use this command")
1117
    (let ((diary-display-hook 'diary-fancy-display))
1118
      (diary-list-entries (calendar-current-date) (or ndays diary-mail-days)))
1119 1120 1121 1122
    (compose-mail diary-mail-addr
                  (concat "Diary entries generated "
                          (calendar-date-string (calendar-current-date))))
    (insert
1123 1124
     (if (get-buffer diary-fancy-buffer)
         (with-current-buffer diary-fancy-buffer (buffer-string))
1125 1126
       "No entries found"))
    (call-interactively (get mail-user-agent 'sendfunc))))
1127

1128 1129 1130 1131
(defun diary-name-pattern (string-array &optional abbrev-array paren)
  "Return a regexp matching the strings in the array STRING-ARRAY.
If the optional argument ABBREV-ARRAY is present, then the function
`calendar-abbrev-construct' is used to construct abbreviations from the
1132
two supplied arrays.  The returned regexp will then also match these
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
abbreviations, with or without final `.' characters.  If the optional
argument PAREN is non-nil, the regexp is surrounded by parentheses."
  (regexp-opt (append string-array
                      (if abbrev-array
                          (calendar-abbrev-construct abbrev-array
                                                     string-array))
                      (if abbrev-array
                          (calendar-abbrev-construct abbrev-array
                                                     string-array
                                                     'period))
                      nil)
              paren))
Edward M. Reingold's avatar
Edward M. Reingold committed
1145

1146
(defvar diary-marking-entries-flag nil
Edward M. Reingold's avatar
Edward M. Reingold committed
1147 1148
  "True during the marking of diary entries, nil otherwise.")

1149
(defvar diary-marking-entry-flag nil
Edward M. Reingold's avatar
Edward M. Reingold committed
1150 1151
  "True during the marking of diary entries, if current entry is marking.")

1152
;; file-glob-attrs bound in diary-mark-entries.
1153
(defun diary-mark-entries-1 (markfunc &optional months symbol absfunc)
1154
  "Mark diary entries of a certain type.
1155 1156 1157 1158
MARKFUNC is a function that marks entries of the appropriate type
matching a given date pattern.  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.  "
1159 1160
  (let ((dayname (diary-name-pattern calendar-day-name-array
                                     calendar-day-abbrev-array))
1161 1162 1163 1164 1165
        (monthname (format "%s\\|\\*"
                           (if months
                               (diary-name-pattern months)
                             (diary-name-pattern calendar-month-name-array
                                                 calendar-month-abbrev-array))))
1166 1167 1168
        (month "[0-9]+\\|\\*")
        (day "[0-9]+\\|\\*")
        (year "[0-9]+\\|\\*")
1169 1170
        (case-fold-search t)
        marks)
Glenn Morris's avatar