diary-lib.el 105 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 142
(define-obsolete-variable-alias 'sexp-diary-entry-symbol
  'diary-sexp-entry-symbol "23.1")

(defcustom diary-list-entries-hook nil
Glenn Morris's avatar
Glenn Morris committed
143
  "List of functions called after diary file is culled for relevant entries.
144 145 146
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
147

148 149 150
     (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
151 152 153 154 155

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
156
  :options '(diary-include-other-diary-files diary-sort-entries)
Glenn Morris's avatar
Glenn Morris committed
157 158
  :group 'diary)

159 160 161 162
(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
163
  "List of functions called after marking diary entries in the calendar.
164 165 166
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
167
  :type 'hook
168
  :options '(diary-mark-included-diary-files)
Glenn Morris's avatar
Glenn Morris committed
169 170
  :group 'diary)

171 172 173 174
(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
175 176
  "List of functions called for listing diary file and included files.
As the files are processed for diary entries, these functions are used
177
to cull relevant entries.  You can use any or all of
Glenn Morris's avatar
Glenn Morris committed
178 179
`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
180 181
describes the style of such diary entries."
  :type 'hook
Glenn Morris's avatar
Glenn Morris committed
182 183 184
  :options '(diary-bahai-list-entries
             diary-hebrew-list-entries
             diary-islamic-list-entries)
Glenn Morris's avatar
Glenn Morris committed
185 186
  :group 'diary)

187 188 189 190
(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
191 192
  "List of functions called for marking diary file and included files.
As the files are processed for diary entries, these functions are used
193
to cull relevant entries.  You can use any or all of
Glenn Morris's avatar
Glenn Morris committed
194 195
`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
196 197
describes the style of such diary entries."
  :type 'hook
Glenn Morris's avatar
Glenn Morris committed
198 199 200
  :options '(diary-bahai-mark-entries
             diary-hebrew-mark-entries
             diary-islamic-mark-entries)
Glenn Morris's avatar
Glenn Morris committed
201 202
  :group 'diary)

203 204 205 206 207
(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.
208 209 210 211 212
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
213 214 215
  :type 'hook
  :group 'diary)

216 217 218
(define-obsolete-variable-alias 'print-diary-entries-hook
  'diary-print-entries-hook "23.1")

Glenn Morris's avatar
Glenn Morris committed
219
(defcustom diary-unknown-time -9999
220
  "Value returned by `diary-entry-time' when no time is found.
221 222 223
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
224 225 226 227 228
  :type 'integer
  :group 'diary
  :version "20.3")

(defcustom diary-mail-addr
229
  (or (bound-and-true-p user-mail-address) "")
Glenn Morris's avatar
Glenn Morris committed
230 231 232 233 234 235 236 237 238 239 240 241 242
  "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 "
243
    (if (zerop (% days 7))
244 245
        (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
246 247 248 249 250 251 252 253 254 255
    " 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)

256
(defcustom diary-abbreviated-year-flag t
257 258 259 260 261 262 263 264 265
  "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)

266 267 268
(define-obsolete-variable-alias 'abbreviated-calendar-year
  'diary-abbreviated-year-flag "23.1")

Glenn Morris's avatar
Glenn Morris committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
(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
307 308 309 310
                :value-type (choice
                             (string :tag "Template for entry")
                             (function :tag
                                       "Unary function providing template")))
Glenn Morris's avatar
Glenn Morris committed
311 312 313
  :version "22.1"
  :group 'diary)

314 315
(defvar diary-header-line-flag)
(defvar diary-header-line-format)
316

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
(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
334
  "Non-nil means `diary-simple-display' will show a header line.
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
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)))
352
  "Format of the header line displayed by `diary-simple-display'.
353 354 355 356 357 358 359
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")

360 361 362 363 364 365 366 367 368 369 370 371 372 373
;; 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."
374
  (or (get-buffer diary-fancy-buffer)
375 376 377 378 379 380 381 382
      (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."
383
  (let ((oldvalue (symbol-value symbol)))
384 385 386 387 388 389
    (custom-set-default symbol value)
    (and (not (equal value oldvalue))
         (diary-live-p)
         ;; Note this assumes diary was called without prefix arg.
         (diary))))

390
(defcustom diary-number-of-entries 1
391 392
  "Specifies how many days of diary entries are to be displayed initially.
This variable affects the diary display when the command \\[diary] is used,
393
or if the value of the variable `calendar-view-diary-initially-flag' is non-nil.
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
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)

420 421 422
(define-obsolete-variable-alias 'number-of-diary-entries
  'diary-number-of-entries "23.1")

423
;;; More user options in calendar.el.
Glenn Morris's avatar
Glenn Morris committed
424 425


426 427 428 429 430 431 432 433 434 435
(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
436 437 438 439
;;;###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
440
by the variable `diary-number-of-entries'.  A value of ARG less than 1
Glenn Morris's avatar
Glenn Morris committed
441
does nothing.  This function is suitable for execution in a `.emacs' file."
Edward M. Reingold's avatar
Edward M. Reingold committed
442
  (interactive "P")
443
  (diary-check-diary-file)
444 445
  (diary-list-entries (calendar-current-date)
                      (if arg (prefix-numeric-value arg))))
446

447
;;;###cal-autoload
448
(defun diary-view-entries (&optional arg)
Edward M. Reingold's avatar
Edward M. Reingold committed
449 450 451 452 453
  "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")
454
  (diary-check-diary-file)
455
  (diary-list-entries (calendar-cursor-to-date t) arg))
Edward M. Reingold's avatar
Edward M. Reingold committed
456

457
(define-obsolete-function-alias 'view-diary-entries 'diary-view-entries "22.1")
458 459


460
;;;###cal-autoload
461
(defun diary-view-other-diary-entries (arg dfile)
Edward M. Reingold's avatar
Edward M. Reingold committed
462
  "Prepare and display buffer of diary entries from an alternative diary file.
463 464
Searches for entries that match ARG days, starting with the date indicated
by the cursor position in the displayed three-month calendar.
465
DFILE specifies the file to use as the diary file."
Edward M. Reingold's avatar
Edward M. Reingold committed
466
  (interactive
467
   (list (prefix-numeric-value current-prefix-arg)
468
         (read-file-name "Enter diary file name: " default-directory nil t)))
469
  (let ((diary-file dfile))
470
    (diary-view-entries arg)))
Edward M. Reingold's avatar
Edward M. Reingold committed
471

472 473 474 475
;;;###cal-autoload
(define-obsolete-function-alias 'view-other-diary-entries
  'diary-view-other-diary-entries "23.1")

476 477 478 479 480
(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
481 482
  "The syntax table used when parsing dates in the diary file.
It is the standard syntax table used in Fundamental mode, but with the
483
syntax of `*' and `:' changed to be word constituents.")
Edward M. Reingold's avatar
Edward M. Reingold committed
484

485
(defun diary-attrtype-convert (attrvalue type)
486 487
  "Convert string ATTRVALUE to TYPE appropriate for a face description.
Valid TYPEs are: string, symbol, int, stringtnil, tnil."
488
  (cond ((eq type 'string) attrvalue)
489
        ((eq type 'symbol) (intern-soft attrvalue))
Glenn Morris's avatar
Glenn Morris committed
490 491 492 493 494 495
        ((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))))
496 497

(defun diary-pull-attrs (entry fileglobattrs)
498 499 500 501 502 503 504 505 506
  "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
507 508 509 510 511 512 513 514 515 516 517 518 519 520
        (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))))))
521 522
      (setq ret-attr fileglobattrs)
      (dolist (attr diary-face-attrs)
Glenn Morris's avatar
Glenn Morris committed
523 524 525 526 527
        (setq regexp (car attr)
              regnum (cadr attr)
              attrname (nth 2 attr)
              type (nth 3 attr)
              attrvalue nil)
528 529 530 531 532 533
        ;; 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
534 535 536
        (and attrvalue
             (setq attrvalue (diary-attrtype-convert attrvalue type))
             (setq ret-attr (append ret-attr (list attrname attrvalue))))))
537
    (list entry ret-attr)))
538

539

Glenn Morris's avatar
Glenn Morris committed
540 541 542 543 544 545 546

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

549
(defun diary-add-to-list (date string specifier &optional marker
Glenn Morris's avatar
Glenn Morris committed
550 551 552 553 554
                               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
555
strings such as \"%d\" expanded); SPECIFIER is the date part of
Glenn Morris's avatar
Glenn Morris committed
556
the entry as it appears in the diary-file; LITERAL is the entry
557
as it appears in the diary-file (i.e. before expansion).  If
Glenn Morris's avatar
Glenn Morris committed
558 559 560 561 562 563 564 565 566
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))))
567
          (or (string-equal prefix "")
Glenn Morris's avatar
Glenn Morris committed
568 569
              (setq string (format "[%s] %s" prefix string)))))
    (and diary-modify-entry-list-string-function
Glenn Morris's avatar
Glenn Morris committed
570 571
         (setq string (funcall diary-modify-entry-list-string-function
                               string)))
Glenn Morris's avatar
Glenn Morris committed
572 573 574 575 576 577
    (setq diary-entries-list
          (append diary-entries-list
                  (list (list date string specifier
                              (list marker (buffer-file-name) literal)
                              globcolor))))))

578 579
(define-obsolete-function-alias 'add-to-diary-list 'diary-add-to-list "23.1")

580 581 582 583 584 585 586 587 588 589
(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."
590 591 592
  (let* ((month (calendar-extract-month date))
         (day (calendar-extract-day date))
         (year (calendar-extract-year date))
593 594 595 596 597 598 599 600 601 602
         (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
603
                       (if diary-abbreviated-year-flag
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
                           (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))
620 621
          ;; regexp moves us past the end of date, onto the next line.
          ;; Trailing whitespace after date not allowed (see diary-file).
622 623 624 625 626
          (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.
627
            (setq date-start (line-end-position 0))
628 629 630
            ;; Actual entry starts on the next-line?
            (if (looking-at "[ \t]*\n[ \t]") (forward-line 1))
            (setq entry-found t
631
                  entry-start (point))
632 633 634 635 636 637 638 639 640 641
            (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))
642
            (diary-add-to-list
643 644 645 646 647 648 649 650
             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)
651
(defvar number)
652 653 654 655 656 657

(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."
658 659 660 661 662 663 664 665 666
  (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)))
667

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

Returns a list of all relevant diary entries found, if any, in order by date.
676 677 678
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'
679 680
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
681

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

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

688
  `diary-list-entries-hook' adds or manipulates diary entries from
689 690 691
      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
692

693
  `diary-display-hook' does the actual display of information.  If nil,
694 695
      `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
696

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

Glenn Morris's avatar
Glenn Morris committed
699 700 701
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.
702
\(Sexp diary entries may use DATE - see `diary-list-sexp-entries'.)
703

704
If LIST-ONLY is non-nil don't modify or display the buffer, only return a list."
705
  (unless number
706 707 708
    (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
709
  (when (> number 0)
710 711 712 713 714
    (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
715 716
      (message "Preparing diary...")
      (save-excursion
717 718 719 720 721
        (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)))
722
        ;; Setup things like the header-line-format and invisibility-spec.
723 724 725 726 727 728 729 730
        (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
731 732 733
          (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
734 735 736
        ;; d-s-p is passed to the diary display function.
        (let ((diary-saved-point (point)))
          (save-excursion
737
            (setq file-glob-attrs (cadr (diary-pull-attrs nil "")))
738
            (with-syntax-table diary-syntax-table
739 740 741 742 743 744 745
              (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)
746
                (let ((sexp-found (diary-list-sexp-entries date))
747 748 749 750 751
                      (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
752
                          (diary-add-to-list date "" "" "" "")))
753 754 755
                  (setq date
                        (calendar-gregorian-from-absolute
                         (1+ (calendar-absolute-from-gregorian date)))))))
Glenn Morris's avatar
Glenn Morris committed
756
            (goto-char (point-min))
757 758
            (run-hooks 'diary-nongregorian-listing-hook
                       'diary-list-entries-hook)
759 760
            (unless list-only
              (if diary-display-hook
Glenn Morris's avatar
Glenn Morris committed
761
                  (run-hooks 'diary-display-hook)
762
                (diary-simple-display)))
Glenn Morris's avatar
Glenn Morris committed
763 764
            (run-hooks 'diary-hook)
            diary-entries-list))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
765

766 767
(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries "22.1")

768
(defun diary-unhide-everything ()
769
  "Show all invisible text in the diary."
770 771
  (kill-local-variable 'diary-selective-display)
  (remove-overlays (point-min) (point-max) 'invisible 'diary)
772 773
  (kill-local-variable 'mode-line-format))

Glenn Morris's avatar
Glenn Morris committed
774
(defvar original-date)                  ; bound in diary-list-entries
775 776
(defvar number)

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

812 813 814
(define-obsolete-function-alias 'include-other-diary-files
  'diary-include-other-diary-files "23.1")

815 816 817
(defvar date-string)                    ; bound in diary-list-entries

(defun diary-display-no-entries ()
818
  "Common subroutine of `diary-simple-display' and `diary-fancy-display'.
819 820
Handles the case where there are no diary entries.
Returns a cons (NOENTRIES . HOLIDAY-STRING)."
821
    (let* ((holiday-list (if diary-show-holidays-flag
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
                             (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))
839
            (message "%s" msg)
840
          ;; holiday-list which is too wide for a message gets a buffer.
841
          (calendar-in-read-only-buffer holiday-buffer
842
            (calendar-set-mode-line (format "Holidays for %s" date-string))
843
            (insert (mapconcat 'identity holiday-list "\n")))
844 845 846 847 848 849
          (message "No diary entries for %s" date-string)))
      (cons noentries hol-string)))


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

850
(defun diary-simple-display ()
851 852 853 854 855 856 857 858 859
  "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
860
    ;; diary-show-holidays-flag that the holidays go in the mode-line.
861 862 863 864 865 866
    ;; 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
867
        (let ((window (display-buffer (current-buffer))))
868
          ;; d-s-p is passed from diary-list-entries.
Glenn Morris's avatar
Glenn Morris committed
869 870
          (set-window-point window diary-saved-point)
          (set-window-start window (point-min))))
Edward M. Reingold's avatar
Edward M. Reingold committed
871 872
      (message "Preparing diary...done"))))

873 874 875
(define-obsolete-function-alias 'simple-diary-display
  'diary-simple-display "23.1")

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

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

904
(defun diary-fancy-display ()
Edward M. Reingold's avatar
Edward M. Reingold committed
905
  "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
906
To use this function, add it to `diary-display-hook'."
907 908
  ;; Turn off selective-display in the diary file's buffer.
  (with-current-buffer
909 910
      (find-buffer-visiting (substitute-in-file-name diary-file))
    (diary-unhide-everything))
911
  (unless (car (diary-display-no-entries)) ; no entries
912
    ;; Prepare the fancy diary buffer.
913
    (calendar-in-read-only-buffer diary-fancy-buffer
914
      (calendar-set-mode-line "Diary Entries")
915
      (let ((holiday-list-last-month 1)
Edward M. Reingold's avatar
Edward M. Reingold committed
916
            (holiday-list-last-year 1)
917 918 919
            (date (list 0 0 0))
            holiday-list)
        (dolist (entry diary-entries-list)
920 921
          (unless (calendar-date-equal date (car entry))
            (setq date (car entry))
922
            (and diary-show-holidays-flag
923 924 925 926 927 928 929 930 931
                 (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
932
                       (calendar-extract-month date)
933
                       holiday-list-last-year
934
                       (calendar-extract-year date))
935
                 (progn
936
                   (calendar-increment-month
937 938 939 940 941 942
                    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)))
943
                 (calendar-increment-month
944
                  holiday-list-last-month holiday-list-last-year 1))
945 946
            (let ((longest 0)
                  date-holiday-list cc)
947 948 949 950 951 952 953
              ;; 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 ":  "))
954 955 956 957 958 959 960
              (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
961
          (let ((this-entry (cadr entry))
962
                this-loc marks temp-face)
Glenn Morris's avatar
Glenn Morris committed
963 964 965 966 967 968 969 970 971 972 973
            (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))
974 975 976 977 978 979 980 981
              (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)))))))
982
      (diary-fancy-display-mode)
Glenn Morris's avatar
Glenn Morris committed
983
      (calendar-set-mode-line date-string)
Edward M. Reingold's avatar
Edward M. Reingold committed
984 985
      (message "Preparing diary...done"))))

986 987 988
(define-obsolete-function-alias 'fancy-diary-display
  'diary-fancy-display "23.1")

989
;; FIXME modernize?
990
(defun diary-print-entries ()
Edward M. Reingold's avatar
Edward M. Reingold committed
991 992 993 994 995 996 997 998
  "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.

999
The hooks given by the variable `diary-print-entries-hook' are called to do
Edward M. Reingold's avatar
Edward M. Reingold committed
1000 1001
the actual printing."
  (interactive)
1002
  (let ((diary-buffer (get-buffer diary-fancy-buffer))
1003 1004 1005
        temp-buffer heading start end)
    (if diary-buffer
        (with-current-buffer diary-buffer
1006
          (run-hooks 'diary-print-entries-hook))
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
      (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")
1031
      (run-hooks 'diary-print-entries-hook)
1032
      (kill-buffer temp-buffer))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1033

1034 1035 1036
(define-obsolete-function-alias 'print-diary-entries
  'diary-print-entries "23.1")

1037
;;;###cal-autoload
1038
(defun diary-show-all-entries ()
Edward M. Reingold's avatar
Edward M. Reingold committed
1039 1040 1041 1042 1043
  "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
1044
  (let ((d-file (diary-check-diary-file))
1045 1046
        (pop-up-frames (or pop-up-frames
                           (window-dedicated-p (selected-window)))))
1047 1048
    (with-current-buffer (or (find-buffer-visiting d-file)
                             (find-file-noselect d-file t))
1049
      (when (eq major-mode default-major-mode) (diary-mode))
1050 1051
      (diary-unhide-everything)
      (display-buffer (current-buffer)))))
1052

1053 1054 1055
(define-obsolete-function-alias 'show-all-diary-entries
  'diary-show-all-entries "22.1")

1056
;;;###autoload
1057 1058 1059
(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'.
1060
Mail is sent to the address specified by `diary-mail-addr'.
1061

Glenn Morris's avatar
Glenn Morris committed
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
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\"
1072
      calendar-date-style 'european
Glenn Morris's avatar
Glenn Morris committed
1073 1074 1075 1076 1077 1078
      diary-mail-addr \"user@host.name\")

\(diary-mail-entries)

# diary-rem.el ends here
"
1079
  (interactive "P")
1080 1081
  (if (string-equal diary-mail-addr "")
      (error "You must set `diary-mail-addr' to use this command")
1082
    (let ((diary-display-hook 'diary-fancy-display))
1083
      (diary-list-entries (calendar-current-date) (or ndays diary-mail-days)))
1084 1085 1086 1087
    (compose-mail diary-mail-addr
                  (concat "Diary entries generated "
                          (calendar-date-string (calendar-current-date))))
    (insert
1088 1089
     (if (get-buffer diary-fancy-buffer)
         (with-current-buffer diary-fancy-buffer (buffer-string))
1090 1091
       "No entries found"))
    (call-interactively (get mail-user-agent 'sendfunc))))
1092

1093 1094 1095 1096
(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
1097
two supplied arrays.  The returned regexp will then also match these
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
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
1110

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

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

1117
;; file-glob-attrs bound in diary-mark-entries.
1118
(defun diary-mark-entries-1 (markfunc &optional months symbol absfunc)
1119
  "Mark diary entries of a certain type.
1120 1121 1122 1123
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.  "
1124 1125
  (let ((dayname (diary-name-pattern calendar-day-name-array
                                     calendar-day-abbrev-array))
1126 1127 1128 1129 1130
        (monthname (format "%s\\|\\*"
                           (if months
                               (diary-name-pattern months)
                             (diary-name-pattern calendar-month-name-array
                                                 calendar-month-abbrev-array))))
1131 1132 1133
        (month "[0-9]+\\|\\*")
        (day "[0-9]+\\|\\*")
        (year "[0-9]+\\|\\*")
1134 1135
        (case-fold-search t)
        marks)
1136 1137 1138 1139 1140
    (dolist (date-form diary-date-forms)
      (if (eq (car date-form) 'backup)  ; ignore 'backup directive
          (setq date-form (cdr date-form)))
      (let* ((l (length date-form))
             (d-name-pos (- l (length (memq 'dayname date-form))))
1141
             (d-name-pos (if (/= l d-name-pos) (1+ d-name-pos)))
1142
             (m-name-pos (- l (length (memq 'monthname date-form))))
1143
             (m-name-pos (if (/= l m-name-pos) (1+ m-name-pos)))
1144
             (d-pos (- l (length (memq 'day date-form))))
1145
             (d-pos (if (/= l d-pos) (1+ d-pos)))
1146
             (m-pos (- l (length (memq 'month date-form))))
1147
             (m-pos (if (/= l m-pos) (1+ m-pos)))