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 29 30 31 32 33 34 35

;;; Commentary:

;; This collection of functions implements the diary features as described
;; in calendar.el.

;;; Code:

(require 'calendar)

36 37 38
(eval-and-compile
  (load "diary-loaddefs" nil 'quiet))

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

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

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

59 60 61 62 63 64 65
;; 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
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
(defcustom diary-face-attrs
  '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string)
    (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string)
    (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol)
    (" *\\[height:\\([-0-9a-z]+\\)\\]$" 1 :height int)
    (" *\\[weight:\\([-a-z]+\\)\\]$" 1 :weight symbol)
    (" *\\[slant:\\([-a-z]+\\)\\]$" 1 :slant symbol)
    (" *\\[underline:\\([-a-z]+\\)\\]$" 1 :underline stringtnil)
    (" *\\[overline:\\([-a-z]+\\)\\]$" 1 :overline stringtnil)
    (" *\\[strike-through:\\([-a-z]+\\)\\]$" 1 :strike-through stringtnil)
    (" *\\[inverse-video:\\([-a-z]+\\)\\]$" 1 :inverse-video tnil)
    (" *\\[face:\\([-0-9a-z]+\\)\\]$" 1 :face string)
    (" *\\[font:\\([-a-z0-9]+\\)\\]$" 1 :font string)
    ;; Unsupported.
;;;    (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box)
;;;    (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple)
    )
83 84 85 86
  "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'
87
is pre-pended to REGEXP for file-wide specifiers.  ATTRIBUTE
88 89 90 91 92
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
93 94 95 96 97 98 99 100
                       (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'"))))
101 102 103
  :group 'diary)

(defcustom diary-glob-file-regexp-prefix "^\\#"
104
  "Regular expression pre-pended to `diary-face-attrs' for file-wide specifiers."
105
  :type 'regexp
Glenn Morris's avatar
Glenn Morris committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
  :group 'diary)

(defcustom diary-file-name-prefix nil
  "Non-nil means prefix each diary entry with the name of the file defining it."
  :type 'boolean
  :group 'diary)

(defcustom diary-file-name-prefix-function 'identity
  "The function that will take a diary file name and return the desired prefix."
  :type 'function
  :group 'diary)

(defcustom sexp-diary-entry-symbol "%%"
  "The string used to indicate a sexp diary entry in `diary-file'.
See the documentation for the function `list-sexp-diary-entries'."
  :type 'string
  :group 'diary)

(defcustom list-diary-entries-hook nil
  "List of functions called after diary file is culled for relevant entries.
It is to be used for diary entries that are not found in the diary file.

A function `include-other-diary-files' is provided for use as the value of
this hook.  This function enables you to use shared diary files together
with your own.  The files included are specified in the diary file by lines
of the form

        #include \"filename\"

This is recursive; that is, #include directives in files thus included are
obeyed.  You can change the \"#include\" to some other string by changing
the variable `diary-include-string'.  When you use `include-other-diary-files'
as part of the list-diary-entries-hook, you will probably also want to use the
function `mark-included-diary-files' as part of `mark-diary-entries-hook'.

For example, you could use

143 144 145
     (add-hook 'list-diary-entries-hook 'include-other-diary-files)
     (add-hook 'list-diary-entries-hook 'sort-diary-entries)
     (add-hook 'diary-display-hook 'fancy-diary-display)
Glenn Morris's avatar
Glenn Morris committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179

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

(defcustom mark-diary-entries-hook nil
  "List of functions called after marking diary entries in the calendar.

A function `mark-included-diary-files' is also provided for use as the
`mark-diary-entries-hook'; it enables you to use shared diary files together
with your own.  The files included are specified in the diary file by lines
of the form
        #include \"filename\"
This is recursive; that is, #include directives in files thus included are
obeyed.  You can change the \"#include\" to some other string by changing the
variable `diary-include-string'.  When you use `mark-included-diary-files' as
part of the mark-diary-entries-hook, you will probably also want to use the
function `include-other-diary-files' as part of `list-diary-entries-hook'."
  :type 'hook
  :options '(mark-included-diary-files)
  :group 'diary)

(defcustom nongregorian-diary-listing-hook nil
  "List of functions called for listing diary file and included files.
As the files are processed for diary entries, these functions are used
to cull relevant entries.  You can use either or both of
`list-hebrew-diary-entries', `list-islamic-diary-entries' and
`diary-bahai-list-entries'.  The documentation for these functions
describes the style of such diary entries."
  :type 'hook
  :options '(list-hebrew-diary-entries
Glenn Morris's avatar
Glenn Morris committed
180 181
             list-islamic-diary-entries
             diary-bahai-list-entries)
Glenn Morris's avatar
Glenn Morris committed
182 183 184 185 186 187 188
  :group 'diary)

(defcustom nongregorian-diary-marking-hook nil
  "List of functions called for marking diary file and included files.
As the files are processed for diary entries, these functions are used
to cull relevant entries.  You can use either or both of
`mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
189
`bahai-mark-diary-entries'.  The documentation for these functions
Glenn Morris's avatar
Glenn Morris committed
190 191 192
describes the style of such diary entries."
  :type 'hook
  :options '(mark-hebrew-diary-entries
Glenn Morris's avatar
Glenn Morris committed
193 194
             mark-islamic-diary-entries
             diary-bahai-mark-entries)
Glenn Morris's avatar
Glenn Morris committed
195 196 197 198 199 200 201 202 203 204 205 206
  :group 'diary)

(defcustom print-diary-entries-hook 'lpr-buffer
  "List of functions called after a temporary diary buffer is prepared.
The buffer shows only the diary entries currently visible in the diary
buffer.  The default just does the printing.  Other uses might include, for
example, rearranging the lines into order by day and time, saving the buffer
instead of deleting it, or changing the function used to do the printing."
  :type 'hook
  :group 'diary)

(defcustom diary-unknown-time -9999
207
  "Value returned by `diary-entry-time' when no time is found.
Glenn Morris's avatar
Glenn Morris committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
The default value -9999 causes entries with no recognizable time to be placed
before those with times; 9999 would place entries with no recognizable time
after those with times."
  :type 'integer
  :group 'diary
  :version "20.3")

(defcustom diary-mail-addr
  (if (boundp 'user-mail-address) user-mail-address "")
  "Email address that `diary-mail-entries' will send email to."
  :group 'diary
  :type  'string
  :version "20.3")

(defcustom diary-mail-days 7
  "Default number of days for `diary-mail-entries' to check."
  :group 'diary
  :type 'integer
  :version "20.3")

(defcustom diary-remind-message
  '("Reminder: Only "
230
    (if (zerop (% days 7))
231 232
        (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
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
    " until "
    diary-entry)
  "Pseudo-pattern giving form of reminder messages in the fancy diary display.

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

(defcustom diary-outlook-formats
  '(
    ;; When: 11 October 2001 12:00-14:00 (GMT) Greenwich Mean Time : Dublin, ...
    ;; [Current UK format?  The timezone is meaningless.  Sometimes the
    ;; Where is missing.]
    ("When: \\([0-9]+ [[:alpha:]]+ [0-9]+\\) \
\\([^ ]+\\) [^\n]+
\[^\n]+
\\(?:Where: \\([^\n]+\\)\n+\\)?
\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*"
     . "\\1\n \\2 %s, \\3")
    ;; When: Tuesday, April 30, 2002 03:00 PM-03:30 PM (GMT) Greenwich Mean ...
    ;; [Old UK format?]
    ("^When: [[:alpha:]]+, \\([[:alpha:]]+\\) \\([0-9][0-9]*\\), \\([0-9]\\{4\\}\\) \
\\([^ ]+\\) [^\n]+
\[^\n]+
\\(?:Where: \\([^\n]+\\)\\)?\n+"
     . "\\2 \\1 \\3\n \\4 %s, \\5")
    (
     ;; German format, apparently.
     "^Zeit: [^ ]+, +\\([0-9]+\\)\. +\\([[:upper:]][[:lower:]][[:lower:]]\\)[^ ]* +\\([0-9]+\\) +\\([^ ]+\\).*$"
     . "\\1 \\2 \\3\n \\4 %s"))
  "Alist of regexps matching message text and replacement text.

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

If the template is actually a function, it is called with the message
body text as argument, and may use `match-string' etc. to make a
template following the rules above."
  :type '(alist :key-type (regexp :tag "Regexp matching time/place")
Glenn Morris's avatar
Glenn Morris committed
281 282 283 284
                :value-type (choice
                             (string :tag "Template for entry")
                             (function :tag
                                       "Unary function providing template")))
Glenn Morris's avatar
Glenn Morris committed
285 286 287 288 289 290
  :version "22.1"
  :group 'diary)

;;; More user options below and in calendar.el.


291 292 293 294 295 296 297 298 299 300
(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
301 302 303 304
;;;###autoload
(defun diary (&optional arg)
  "Generate the diary window for ARG days starting with the current date.
If no argument is provided, the number of days of diary entries is governed
Glenn Morris's avatar
Glenn Morris committed
305 306
by the variable `number-of-diary-entries'.  A value of ARG less than 1
does nothing.  This function is suitable for execution in a `.emacs' file."
Edward M. Reingold's avatar
Edward M. Reingold committed
307
  (interactive "P")
308
  (diary-check-diary-file)
309 310
  (diary-list-entries (calendar-current-date)
                      (if arg (prefix-numeric-value arg))))
311 312

(define-obsolete-function-alias 'view-diary-entries 'diary-view-entries)
313
;;;###cal-autoload
314
(defun diary-view-entries (&optional arg)
Edward M. Reingold's avatar
Edward M. Reingold committed
315 316 317 318 319
  "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")
320
  (diary-check-diary-file)
321
  (diary-list-entries (calendar-cursor-to-date t) arg))
Edward M. Reingold's avatar
Edward M. Reingold committed
322

323
;;;###cal-autoload
324
(defun view-other-diary-entries (arg dfile)
Edward M. Reingold's avatar
Edward M. Reingold committed
325
  "Prepare and display buffer of diary entries from an alternative diary file.
326 327
Searches for entries that match ARG days, starting with the date indicated
by the cursor position in the displayed three-month calendar.
328
DFILE specifies the file to use as the diary file."
Edward M. Reingold's avatar
Edward M. Reingold committed
329
  (interactive
330
   (list (prefix-numeric-value current-prefix-arg)
331
         (read-file-name "Enter diary file name: " default-directory nil t)))
332
  (let ((diary-file dfile))
333
    (diary-view-entries arg)))
Edward M. Reingold's avatar
Edward M. Reingold committed
334

335 336 337 338 339
(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
340 341
  "The syntax table used when parsing dates in the diary file.
It is the standard syntax table used in Fundamental mode, but with the
342
syntax of `*' and `:' changed to be word constituents.")
Edward M. Reingold's avatar
Edward M. Reingold committed
343

344
(defun diary-attrtype-convert (attrvalue type)
345 346
  "Convert string ATTRVALUE to TYPE appropriate for a face description.
Valid TYPEs are: string, symbol, int, stringtnil, tnil."
347
  (cond ((eq type 'string) attrvalue)
Glenn Morris's avatar
Glenn Morris committed
348 349 350 351 352 353 354
        ((eq type 'symbol) (read attrvalue)) ; FIXME intern-soft?
        ((eq type 'int) (string-to-number attrvalue))
        ((eq type 'stringtnil)
         (cond ((string-equal "t" attrvalue) t)
               ((string-equal "nil" attrvalue) nil)
               (t attrvalue)))
        ((eq type 'tnil) (string-equal "t" attrvalue))))
355 356

(defun diary-pull-attrs (entry fileglobattrs)
357 358 359 360 361 362 363 364 365
  "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
366 367 368 369 370 371 372 373 374 375 376 377 378 379
        (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))))))
380 381
      (setq ret-attr fileglobattrs)
      (dolist (attr diary-face-attrs)
Glenn Morris's avatar
Glenn Morris committed
382 383 384 385 386 387 388 389 390 391 392 393
        (setq regexp (car attr)
              regnum (cadr attr)
              attrname (nth 2 attr)
              type (nth 3 attr)
              attrvalue nil)
        ;; FIXME multiple matches?
        (if (string-match regexp entry)
            (setq attrvalue (match-string-no-properties regnum entry)
                  entry (replace-match "" t t entry)))
        (and attrvalue
             (setq attrvalue (diary-attrtype-convert attrvalue type))
             (setq ret-attr (append ret-attr (list attrname attrvalue))))))
394
    (list entry ret-attr)))
395

396
;;;###cal-autoload
397 398 399 400 401 402 403 404 405 406
(defun diary-set-maybe-redraw (symbol value)
  "Set SYMBOL's value to VALUE, and redraw the diary if necessary.
Redraws the diary if it is being displayed (note this is not the same as
just visiting the `diary-file'), and SYMBOL's value is to be changed."
  (let ((oldvalue (eval symbol)))
    (custom-set-default symbol value)
    (and (not (equal value oldvalue))
         (diary-live-p)
         ;; Note this assumes diary was called without prefix arg.
         (diary))))
407

408 409 410
;; This can be removed once the kill/yank treatment of invisible text
;; (see etc/TODO) is fixed. -- gm
(defcustom diary-header-line-flag t
411
  "Non-nil means `simple-diary-display' will show a header line.
412 413 414
The format of the header is specified by `diary-header-line-format'."
  :group   'diary
  :type    'boolean
415
  :initialize 'custom-initialize-default
416
  ;; FIXME overkill.
417
  :set 'diary-set-maybe-redraw
418
  :version "22.1")
419

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

423 424
(defcustom diary-header-line-format
  '(:eval (calendar-string-spread
425
           (list (if diary-selective-display
426
                     "Some text is hidden - press \"s\" in calendar \
427 428
before edit/copy"
                   "Diary"))
429
           ?\s (frame-width)))
430
  "Format of the header line displayed by `simple-diary-display'.
431 432 433
Only used if `diary-header-line-flag' is non-nil."
  :group   'diary
  :type    'sexp
434 435 436
  :initialize 'custom-initialize-default
  ;; FIXME overkill.
  :set 'diary-set-maybe-redraw
437
  :version "22.1")
438

439 440 441 442
;; 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
443 444
;; display does not create the fancy buffer, nor does it set
;; diary-selective-display in the diary buffer. This means some
445 446
;; customizations will not take effect, eg:
;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00466.html
447
;; So the check for diary-selective-display was dropped. This means the
448 449
;; 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.
450
;;;###cal-autoload
Glenn Morris's avatar
Glenn Morris committed
451
(defun diary-live-p ()
452
  "Return non-nil if the diary is being displayed."
Glenn Morris's avatar
Glenn Morris committed
453
  (or (get-buffer fancy-diary-buffer)
454 455
      (and diary-file
           (find-buffer-visiting (substitute-in-file-name diary-file)))))
456 457 458 459

(defcustom number-of-diary-entries 1
  "Specifies how many days of diary entries are to be displayed initially.
This variable affects the diary display when the command \\[diary] is used,
460 461
or if the value of the variable `view-diary-entries-initially' is non-nil.
For example, if the default value 1 is used, then only the current day's diary
462 463 464 465
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
466 467 468 469
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.
470 471 472 473 474

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")
Glenn Morris's avatar
Glenn Morris committed
475 476 477 478 479 480 481 482
                 (vector :value [0 0 0 0 0 0 0]
                         (integer :tag "Sunday")
                         (integer :tag "Monday")
                         (integer :tag "Tuesday")
                         (integer :tag "Wednesday")
                         (integer :tag "Thursday")
                         (integer :tag "Friday")
                         (integer :tag "Saturday")))
Glenn Morris's avatar
Glenn Morris committed
483
  :initialize 'custom-initialize-default
484
  :set 'diary-set-maybe-redraw
485 486
  :group 'diary)

Glenn Morris's avatar
Glenn Morris committed
487 488 489 490 491 492 493

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

Glenn Morris's avatar
Glenn Morris committed
496 497 498 499 500 501
(defun add-to-diary-list (date string specifier &optional marker
                               globcolor literal)
  "Add an entry to `diary-entries-list'.
Do nothing if DATE or STRING is nil.  DATE is the (MONTH DAY
YEAR) for which the entry applies; STRING is the text of the
entry as it will appear in the diary (i.e. with any format
502
strings such as \"%d\" expanded); SPECIFIER is the date part of
Glenn Morris's avatar
Glenn Morris committed
503
the entry as it appears in the diary-file; LITERAL is the entry
504
as it appears in the diary-file (i.e. before expansion).  If
Glenn Morris's avatar
Glenn Morris committed
505 506 507 508 509 510 511 512 513
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))))
514
          (or (string-equal prefix "")
Glenn Morris's avatar
Glenn Morris committed
515 516
              (setq string (format "[%s] %s" prefix string)))))
    (and diary-modify-entry-list-string-function
Glenn Morris's avatar
Glenn Morris committed
517 518
         (setq string (funcall diary-modify-entry-list-string-function
                               string)))
Glenn Morris's avatar
Glenn Morris committed
519 520 521 522 523 524
    (setq diary-entries-list
          (append diary-entries-list
                  (list (list date string specifier
                              (list marker (buffer-file-name) literal)
                              globcolor))))))

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
(defvar number)                     ; not clear this should use number

(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."
  (let* ((month (extract-calendar-month date))
         (day (extract-calendar-day date))
         (year (extract-calendar-year date))
         (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
                       (if abbreviated-calendar-year
                           ;; FIXME was %d in non-greg case.
                           (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))
          (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.
            ;; Actual entry starts on the next-line?
            (if (looking-at "[ \t]*\n[ \t]") (forward-line 1))
            (setq entry-found t
                  entry-start (point)
                  ;; If bolp, must have done (forward-line 1).
                  ;; FIXME Why number > 1?
                  date-start (line-end-position (if (and (bolp) (> number 1))
                                                    -1 0)))
            (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))
            (add-to-diary-list
             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)
600 601 602 603 604 605

(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."
606 607 608 609 610 611 612 613 614
  (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)))
615

616
(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries)
617
(defun diary-list-entries (date number &optional list-only)
618
  "Create and display a buffer containing the relevant lines in `diary-file'.
Edward M. Reingold's avatar
Edward M. Reingold committed
619 620
The arguments are DATE and NUMBER; the entries selected are those
for NUMBER days starting with date DATE.  The other entries are hidden
621
using overlays.  If NUMBER is less than 1, this function does nothing.
Edward M. Reingold's avatar
Edward M. Reingold committed
622 623

Returns a list of all relevant diary entries found, if any, in order by date.
624 625 626
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'
627 628
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
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643

After the list is prepared, the hooks `nongregorian-diary-listing-hook',
`list-diary-entries-hook', `diary-display-hook', and `diary-hook' are run.
These hooks have the following distinct roles:

    `nongregorian-diary-listing-hook' can cull dates from the diary
        and each included file.  Usually used for Hebrew or Islamic
        diary entries in files.  Applied to *each* file.

    `list-diary-entries-hook' adds or manipulates diary entries from
        external sources.  Used, for example, to include diary entries
        from other files or to sort the diary entries.  Invoked *once* only,
        before the display hook is run.

    `diary-display-hook' does the actual display of information.  If this is
644 645 646
        nil, `simple-diary-display' will be used.  Use `add-hook' to use
        `fancy-diary-display', if desired.  If you want no diary display, use
        add-hook to set this to `ignore'.
Edward M. Reingold's avatar
Edward M. Reingold committed
647 648

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

Glenn Morris's avatar
Glenn Morris committed
651 652 653
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.
654
\(Sexp diary entries may use DATE - see `list-sexp-diary-entries'.)
655

656
If LIST-ONLY is non-nil don't modify or display the buffer, only return a list."
657 658 659 660
  (unless number
    (setq number (if (vectorp number-of-diary-entries)
                     (aref number-of-diary-entries (calendar-day-of-week date))
                   number-of-diary-entries)))
Glenn Morris's avatar
Glenn Morris committed
661
  (when (> number 0)
Glenn Morris's avatar
Glenn Morris committed
662
    (let ((original-date date)    ; save for possible use in the hooks
Glenn Morris's avatar
Glenn Morris committed
663 664 665 666 667 668 669 670 671 672 673 674
          diary-entries-list
          file-glob-attrs
          (date-string (calendar-date-string date))
          (d-file (substitute-in-file-name diary-file)))
      (message "Preparing diary...")
      (save-excursion
        (let ((diary-buffer (find-buffer-visiting d-file)))
          (if (not diary-buffer)
              (set-buffer (find-file-noselect d-file t))
            (set-buffer diary-buffer)
            (or (verify-visited-file-modtime diary-buffer)
                (revert-buffer t t))))
675
        ;; Setup things like the header-line-format and invisibility-spec.
676 677 678 679 680 681 682 683
        (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
684 685 686
          (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
687 688 689 690
        ;; d-s-p is passed to the diary display function.
        (let ((diary-saved-point (point)))
          (save-excursion
            (setq file-glob-attrs (nth 1 (diary-pull-attrs nil "")))
691
            (with-syntax-table diary-syntax-table
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
              (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)
                (let ((sexp-found (list-sexp-diary-entries date))
                      (entry-found (diary-list-entries-2
                                    date diary-nonmarking-symbol
                                    file-glob-attrs list-only)))
                  (if diary-list-include-blanks
                      (or sexp-found entry-found
                          (add-to-diary-list date "" "" "" "")))
                  (setq date
                        (calendar-gregorian-from-absolute
                         (1+ (calendar-absolute-from-gregorian date)))))))
Glenn Morris's avatar
Glenn Morris committed
709 710 711
            (goto-char (point-min))
            (run-hooks 'nongregorian-diary-listing-hook
                       'list-diary-entries-hook)
712 713
            (unless list-only
              (if diary-display-hook
Glenn Morris's avatar
Glenn Morris committed
714 715
                  (run-hooks 'diary-display-hook)
                (simple-diary-display)))
Glenn Morris's avatar
Glenn Morris committed
716 717
            (run-hooks 'diary-hook)
            diary-entries-list))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
718

719
(defun diary-unhide-everything ()
720
  "Show all invisible text in the diary."
721 722
  (kill-local-variable 'diary-selective-display)
  (remove-overlays (point-min) (point-max) 'invisible 'diary)
723 724
  (kill-local-variable 'mode-line-format))

Glenn Morris's avatar
Glenn Morris committed
725
(defvar original-date)                  ; bound in diary-list-entries
726 727
(defvar number)

Edward M. Reingold's avatar
Edward M. Reingold committed
728
(defun include-other-diary-files ()
729
  "Include the diary entries from other diary files with those of `diary-file'.
Edward M. Reingold's avatar
Edward M. Reingold committed
730 731
This function is suitable for use in `list-diary-entries-hook';
it enables you to use shared diary files together with your own.
732
The files included are specified in the `diary-file' by lines of this form:
Edward M. Reingold's avatar
Edward M. Reingold committed
733 734 735 736 737 738
        #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
739
          (format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string))
Edward M. Reingold's avatar
Edward M. Reingold committed
740
          nil t)
Glenn Morris's avatar
Glenn Morris committed
741
    (let ((diary-file (substitute-in-file-name
Glenn Morris's avatar
Glenn Morris committed
742 743 744 745 746
                       (match-string-no-properties 1)))
          (diary-list-include-blanks nil)
          (list-diary-entries-hook 'include-other-diary-files)
          (diary-display-hook 'ignore)
          (diary-hook nil))
Edward M. Reingold's avatar
Edward M. Reingold committed
747 748 749 750 751
      (if (file-exists-p diary-file)
          (if (file-readable-p diary-file)
              (unwind-protect
                  (setq diary-entries-list
                        (append diary-entries-list
752
                                (diary-list-entries original-date number)))
753 754
                (with-current-buffer (find-buffer-visiting diary-file)
                  (diary-unhide-everything)))
Edward M. Reingold's avatar
Edward M. Reingold committed
755 756 757 758 759 760
            (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
761
  (goto-char (point-min)))
Edward M. Reingold's avatar
Edward M. Reingold committed
762

763 764 765 766
;; Bound in diary-list-entries.
(defvar date-string)
(defvar diary-saved-point)

Edward M. Reingold's avatar
Edward M. Reingold committed
767 768 769
(defun simple-diary-display ()
  "Display the diary buffer if there are any relevant entries or holidays."
  (let* ((holiday-list (if holidays-in-diary-buffer
770
                           (calendar-check-holidays original-date)))
771 772 773 774 775 776 777
         (hol-string (format "%s%s%s"
                             date-string
                             (if holiday-list ": " "")
                             (mapconcat 'identity holiday-list "; ")))
         (msg (format "No diary entries for %s" hol-string))
         ;; If selected window is dedicated (to the calendar),
         ;; need a new one to display the diary.
778 779
         (pop-up-frames (or pop-up-frames
                            (window-dedicated-p (selected-window)))))
780
    (calendar-set-mode-line (format "Diary for %s" hol-string))
Edward M. Reingold's avatar
Edward M. Reingold committed
781 782
    (if (or (not diary-entries-list)
            (and (not (cdr diary-entries-list))
783
                 (string-equal (cadr (car diary-entries-list)) "")))
784
        (if (< (length msg) (frame-width))
785
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
786 787 788 789 790 791 792 793 794 795
          (set-buffer (get-buffer-create holiday-buffer))
          (setq buffer-read-only nil)
          (calendar-set-mode-line date-string)
          (erase-buffer)
          (insert (mapconcat 'identity holiday-list "\n"))
          (goto-char (point-min))
          (set-buffer-modified-p nil)
          (setq buffer-read-only t)
          (display-buffer holiday-buffer)
          (message  "No diary entries for %s" date-string))
Glenn Morris's avatar
Glenn Morris committed
796 797 798
      (with-current-buffer
          (find-buffer-visiting (substitute-in-file-name diary-file))
        (let ((window (display-buffer (current-buffer))))
799
          ;; d-s-p is passed from diary-list-entries.
Glenn Morris's avatar
Glenn Morris committed
800 801
          (set-window-point window diary-saved-point)
          (set-window-start window (point-min))))
Edward M. Reingold's avatar
Edward M. Reingold committed
802 803
      (message "Preparing diary...done"))))

804
(defface diary-button '((((type pc) (class color))
Glenn Morris's avatar
Glenn Morris committed
805
                         (:foreground "lightblue")))
806
  "Default face used for buttons."
807
  :version "22.1"
808
  :group 'diary)
809
;; Backward-compatibility alias. FIXME make obsolete.
810
(put 'diary-button-face 'face-alias 'diary-button)
811 812 813

(define-button-type 'diary-entry
  'action #'diary-goto-entry
814
  'face 'diary-button)
815 816

(defun diary-goto-entry (button)
817
  "Jump to the diary entry for the BUTTON at point."
Glenn Morris's avatar
Glenn Morris committed
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
  (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")))))
839

Edward M. Reingold's avatar
Edward M. Reingold committed
840 841 842
(defun fancy-diary-display ()
  "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
This function is provided for optional use as the `diary-display-hook'."
843 844
  ;; Turn off selective-display in the diary file's buffer.
  (with-current-buffer
845 846
      (find-buffer-visiting (substitute-in-file-name diary-file))
    (diary-unhide-everything))
Edward M. Reingold's avatar
Edward M. Reingold committed
847 848
  (if (or (not diary-entries-list)
          (and (not (cdr diary-entries-list))
849
               (string-equal (cadr (car diary-entries-list)) "")))
Edward M. Reingold's avatar
Edward M. Reingold committed
850
      (let* ((holiday-list (if holidays-in-diary-buffer
851
                               (calendar-check-holidays original-date)))
Edward M. Reingold's avatar
Edward M. Reingold committed
852 853 854 855
             (msg (format "No diary entries for %s %s"
                          (concat date-string (if holiday-list ":" ""))
                          (mapconcat 'identity holiday-list "; "))))
        (if (<= (length msg) (frame-width))
856
            (message "%s" msg)
Edward M. Reingold's avatar
Edward M. Reingold committed
857 858 859 860 861 862 863 864 865
          (set-buffer (get-buffer-create holiday-buffer))
          (setq buffer-read-only nil)
          (erase-buffer)
          (insert (mapconcat 'identity holiday-list "\n"))
          (goto-char (point-min))
          (set-buffer-modified-p nil)
          (setq buffer-read-only t)
          (display-buffer holiday-buffer)
          (message  "No diary entries for %s" date-string)))
866 867
    ;; Prepare the fancy diary buffer.
    (with-current-buffer
868
        (make-fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
869 870 871 872 873 874
      (setq buffer-read-only nil)
      (let ((entry-list diary-entries-list)
            (holiday-list)
            (holiday-list-last-month 1)
            (holiday-list-last-year 1)
            (date (list 0 0 0)))
Glenn Morris's avatar
Glenn Morris committed
875
        (dolist (entry entry-list)
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
          (unless (calendar-date-equal date (car entry))
            (setq date (car entry))
            (and holidays-in-diary-buffer
                 (calendar-date-compare
                  (list (list holiday-list-last-month
                              (calendar-last-day-of-month
                               holiday-list-last-month
                               holiday-list-last-year)
                              holiday-list-last-year))
                  (list date))
                 ;; We need to get the holidays for the next 3 months.
                 (setq holiday-list-last-month
                       (extract-calendar-month date)
                       holiday-list-last-year
                       (extract-calendar-year date))
                 (progn
                   (increment-calendar-month
                    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)))
                 (increment-calendar-month
                  holiday-list-last-month holiday-list-last-year 1))
            (let (date-holiday-list)
              ;; Make a list of all holidays for date.
              (dolist (h holiday-list)
                (if (calendar-date-equal date (car h))
                    (setq date-holiday-list (append date-holiday-list
                                                    (cdr h)))))
              (insert (if (bobp) "" ?\n) (calendar-date-string date))
              (if date-holiday-list (insert ":  "))
              (let ((l (current-column))
                    (longest 0))
                (insert (mapconcat (lambda (x)
                                     (if (< longest (length x))
                                         (setq longest (length x)))
                                     x)
                                   date-holiday-list
                                   (concat "\n" (make-string l ? ))))
                (insert ?\n (make-string (+ l longest) ?=) ?\n))))
Glenn Morris's avatar
Glenn Morris committed
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
          (let ((this-entry (cadr entry))
                this-loc)
            (unless (zerop (length this-entry))
              (if (setq this-loc (nth 3 entry))
                  (insert-button (concat this-entry "\n")
                                 ;; (MARKER FILENAME SPECIFIER LITERAL)
                                 'locator (list (car this-loc)
                                                (cadr this-loc)
                                                (nth 2 entry)
                                                (or (nth 2 this-loc)
                                                    (nth 1 entry)))
                                 :type 'diary-entry)
                (insert this-entry ?\n))
              (save-excursion
                (let* ((marks (nth 4 entry))
                       (faceinfo marks)
                       temp-face)
                  (when marks
                    (setq temp-face (make-symbol
                                     (apply
                                      'concat "temp-face-"
                                      (mapcar (lambda (sym)
                                                (if (stringp sym)
                                                    sym
                                                  (symbol-name sym)))
                                              marks))))
                    (make-face temp-face)
                    ;; Remove :face info from the marks,
                    ;; copy the face info into temp-face
                    (while (setq faceinfo (memq :face faceinfo))
                      (copy-face (read (nth 1 faceinfo)) temp-face)
                      (setcar faceinfo nil)
                      (setcar (cdr faceinfo) nil))
                    (setq marks (delq nil marks))
                    ;; Apply the font aspects.
                    (apply 'set-face-attribute temp-face nil marks)
                    (search-backward this-entry)
                    (overlay-put
                     (make-overlay (match-beginning 0) (match-end 0))
                     'face temp-face))))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
958 959 960 961
      (set-buffer-modified-p nil)
      (goto-char (point-min))
      (setq buffer-read-only t)
      (display-buffer fancy-diary-buffer)
962
      (fancy-diary-display-mode)
Glenn Morris's avatar
Glenn Morris committed
963
      (calendar-set-mode-line date-string)
Edward M. Reingold's avatar
Edward M. Reingold committed
964 965 966 967
      (message "Preparing diary...done"))))

(defun make-fancy-diary-buffer ()
  "Create and return the initial fancy diary buffer."
968
  (with-current-buffer (get-buffer-create fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
    (setq buffer-read-only nil)
    (calendar-set-mode-line "Diary Entries")
    (erase-buffer)
    (set-buffer-modified-p nil)
    (setq buffer-read-only t)
    (get-buffer fancy-diary-buffer)))

(defun print-diary-entries ()
  "Print a hard copy of the diary display.

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

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

The hooks given by the variable `print-diary-entries-hook' are called to do
the actual printing."
  (interactive)
  (if (bufferp (get-buffer fancy-diary-buffer))
989
      (with-current-buffer (get-buffer fancy-diary-buffer)
Edward M. Reingold's avatar
Edward M. Reingold committed
990 991
        (run-hooks 'print-diary-entries-hook))
    (let ((diary-buffer
992
           (find-buffer-visiting (substitute-in-file-name diary-file))))
Edward M. Reingold's avatar
Edward M. Reingold committed
993
      (if diary-buffer
994
          (let ((temp-buffer (get-buffer-create " *Printable Diary Entries*"))
Edward M. Reingold's avatar
Edward M. Reingold committed
995
                (heading))
996
            (with-current-buffer diary-buffer
Edward M. Reingold's avatar
Edward M. Reingold committed
997 998 999 1000
              (setq heading
                    (if (not (stringp mode-line-format))
                        "All Diary Entries"
                      (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
1001 1002 1003 1004 1005 1006 1007
                      (match-string 1 mode-line-format)))
              (let ((start (point-min))
                    end)
                (while
                    (progn
                      (setq end (next-single-char-property-change
                                 start 'invisible))
1008
                      (unless (get-char-property start 'invisible)
1009 1010 1011 1012 1013
                        (with-current-buffer temp-buffer
                          (insert-buffer-substring diary-buffer
                                                   start (or end (point-max)))))
                      (setq start end)
                      (and end (< end (point-max))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1014 1015 1016 1017 1018 1019 1020 1021
              (set-buffer temp-buffer)
              (goto-char (point-min))
              (insert heading "\n"
                      (make-string (length heading) ?=) "\n")
              (run-hooks 'print-diary-entries-hook)
              (kill-buffer temp-buffer)))
        (error "You don't have a diary buffer!")))))

1022
(define-obsolete-function-alias 'show-all-diary-entries 'diary-show-all-entries)
1023
;;;###cal-autoload
1024
(defun diary-show-all-entries ()
Edward M. Reingold's avatar
Edward M. Reingold committed
1025 1026 1027 1028 1029
  "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
1030 1031
  (let ((d-file (diary-check-diary-file))
        (pop-up-frames (window-dedicated-p (selected-window))))
1032 1033
    (with-current-buffer (or (find-buffer-visiting d-file)
                             (find-file-noselect d-file t))
1034
      (when (eq major-mode default-major-mode) (diary-mode))
1035 1036
      (diary-unhide-everything)
      (display-buffer (current-buffer)))))
1037

1038
;;;###autoload
1039 1040 1041
(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'.
1042
Mail is sent to the address specified by `diary-mail-addr'.
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052

You can call `diary-mail-entries' every night using an at/cron job.
For example, this script will run the program at 2am daily.  Since
`emacs -batch' does not load your `.emacs' file, you must ensure that
all relevant variables are set, as done here.

#!/bin/sh
# diary-rem.sh -- repeatedly run the Emacs diary-reminder
emacs -batch \\
-eval \"(setq diary-mail-days 3 \\
1053
             diary-file \\\"/path/to/diary.file\\\" \\
1054 1055
             european-calendar-style t \\
             diary-mail-addr \\\"user@host.name\\\" )\" \\
1056
-l diary-lib -f diary-mail-entries
1057 1058 1059 1060 1061 1062
at -f diary-rem.sh 0200 tomorrow

You may have to tweak the syntax of the `at' command to suit your
system.  Alternatively, you can specify a cron entry:
0 1 * * * diary-rem.sh
to run it every morning at 1am."
1063
  (interactive "P")
1064 1065 1066
  (if (string-equal diary-mail-addr "")
      (error "You must set `diary-mail-addr' to use this command")
    (let ((diary-display-hook 'fancy-diary-display))
1067
      (diary-list-entries (calendar-current-date) (or ndays diary-mail-days)))
1068 1069 1070 1071 1072
    (compose-mail diary-mail-addr
                  (concat "Diary entries generated "
                          (calendar-date-string (calendar-current-date))))
    (insert
     (if (get-buffer fancy-diary-buffer)
1073
         (with-current-buffer fancy-diary-buffer (buffer-string))
1074 1075
       "No entries found"))
    (call-interactively (get mail-user-agent 'sendfunc))))
1076

1077 1078 1079 1080
(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
1081
two supplied arrays.  The returned regexp will then also match these
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
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
1094 1095 1096 1097 1098 1099 1100

(defvar marking-diary-entries nil
  "True during the marking of diary entries, nil otherwise.")

(defvar marking-diary-entry nil
  "True during the marking of diary entries, if current entry is marking.")

1101 1102
;; file-glob-attrs bound in mark-diary-entries.
(defun diary-mark-entries-1 (markfunc &optional months symbol absfunc)
1103
  "Mark diary entries of a certain type.
1104 1105 1106 1107
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.  "
1108 1109
  (let ((dayname (diary-name-pattern calendar-day-name-array
                                     calendar-day-abbrev-array))
1110 1111 1112 1113 1114
        (monthname (format "%s\\|\\*"
                           (if months
                               (diary-name-pattern months)
                             (diary-name-pattern calendar-month-name-array
                                                 calendar-month-abbrev-array))))
1115 1116 1117
        (month "[0-9]+\\|\\*")
        (day "[0-9]+\\|\\*")
        (year "[0-9]+\\|\\*")
1118 1119 1120 1121 1122
        (case-fold-search t)
        ;; FIXME is this the right reason for 1 versus 2?
        ;; Should docs of symbols say must be single character?
        (inc (if symbol 2 1))
        marks)
1123 1124 1125 1126 1127
    (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))))
1128
             (d-name-pos (if (/= l d-name-pos) (+ inc d-name-pos)))
1129
             (m-name-pos (- l (length (memq 'monthname date-form))))
1130
             (m-name-pos (if (/= l m-name-pos) (+ inc m-name-pos)))
1131
             (d-pos (- l (length (memq 'day date-form))))
1132
             (d-pos (if (/= l d-pos) (+ inc d-pos)))
1133
             (m-pos (- l (length (memq 'month date-form))))
1134
             (m-pos (if (/= l m-pos) (+ inc m-pos)))
1135
             (y-pos (- l (length (memq 'year date-form))))
1136 1137 1138
             (y-pos (if (/= l y-pos) (+ inc y-pos)))
             (regexp (format "^%s\\(%s\\)"
                             (if symbol (regexp-quote symbol) "")
1139 1140 1141 1142 1143
                             (mapconcat 'eval date-form "\\)\\("))))
        (goto-char (point-min))
        (while (re-search-forward regexp nil t)
          (let* ((dd-name
                  (if d-name-pos
1144
                      (match-string-no-properties d-name-pos)))
1145 1146
                 (mm-name
                  (if m-name-pos
1147
                      (match-string-no-properties m-name-pos)))
1148 1149
                 (mm (string-to-number
                      (if m-pos
1150
                          (match-string-no-properties m-pos)
1151 1152 1153
                        "")))
                 (dd (string-to-number
                      (if d-pos
1154
                          (match-string-no-properties d-pos)
1155 1156
                        "")))
                 (y-str (if y-pos
1157
                            (match-string-no-properties y-pos)))
1158 1159 1160 1161 1162 1163
                 (yy (if (not y-str)
                         0
                       (if (and (= (length y-str) 2)
                                abbreviated-calendar-year)
                           (let* ((current-y
                                   (extract-calendar-year
1164 1165 1166 1167 1168 1169
                                    (if absfunc
                                        (funcall
                                         absfunc
                                         (calendar-absolute-from-gregorian
                                          (calendar-current-date)))
                                      (calendar-current-date))))
1170 1171 1172 1173 1174 1175 1176 1177
                                  (y (+ (string-to-number y-str)
                                        (* 100 (/ current-y 100)))))
                             (if (> (- y current-y) 50)
                                 (- y 100)
                               (if (> (- current-y y) 50)
                                   (+ y 100)
                                 y)))
                         (string-to-number y-str)))))
1178 1179 1180 1181
            (setq marks (cadr (diary-pull-attrs
                               (buffer-substring-no-properties
                                (point) (line-end-position))
                               file-glob-attrs)))
1182 1183 1184 1185 1186
            (if dd-name
                (mark-calendar-days-named
                 (cdr (assoc-string dd-name
                                    (calendar-make-alist
                                     calendar-day-name-array
1187
                                     0 nil calendar-day-abbrev-array) t)) marks)
1188 1189 1190 1191 1192
              (if mm-name
                  (setq mm
                        (if (string-equal mm-name "*") 0
                          (cdr (assoc-string
                                mm-name
1193 1194 1195 1196 1197
                                (if months (calendar-make-alist months)
                                  (calendar-make-alist
                                   calendar-month-name-array
                                   1 nil calendar-month-abbrev-array)) t)))))
              (funcall markfunc mm dd yy marks))))))))
1198

1199
;;;###cal-autoload
1200
(defun mark-diary-entries (&optional redraw)
Edward M. Reingold's avatar
Edward M. Reingold committed
1201
  "Mark days in the calendar window that have diary entries.
1202 1203 1204 1205 1206
Each entry in the diary file visible in the calendar window is
marked.  After the entries are marked, the hooks
`nongregorian-diary-marking-hook' and `mark-diary-entries-hook'
are run.  If the optional argument REDRAW is non-nil (which is
the case interactively, for example) then any existing diary
1207
marks are first removed.  This is intended to deal with deleted
1208 1209 1210 1211 1212 1213 1214 1215 1216
diary entries."
  (interactive "p")
  ;; To remove any deleted diary entries. Do not redraw when:
  ;; i) processing #include diary files (else only get the marks from
  ;; the last #include file processed).
  ;; ii) called via calendar-redraw (since calendar has already been
  ;; erased).
  ;; Use of REDRAW handles both of these cases.
  (when (and redraw mark-diary-entries-in-calendar)
1217 1218
    (setq mark-diary-entries-in-calendar nil)
    (redraw-calendar))
1219
  (let ((marking-diary-entries t)
1220
        file-glob-attrs)
1221 1222
    (with-current-buffer (find-file-noselect (diary-check-diary-file) t)
      (save-excursion
1223
        (when (eq major-mode default-major-mode) (diary-mode))
1224 1225 1226 1227
        (setq mark-diary-entries-in-calendar t)
        (message "Marking diary entries...")
        (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
        (with-syntax-table diary-syntax-table
1228
          (diary-mark-entries-1 'mark-calendar-date-pattern)
1229 1230 1231
          (mark-sexp-diary-entries)
          (run-hooks 'nongregorian-diary-marking-hook
                     'mark-diary-entries-hook))
1232
        (message "Marking diary entries...done")))))
Edward M. Reingold's avatar
Edward M. Reingold committed
1233

Glenn Morris's avatar
Glenn Morris committed
1234
(defvar displayed-year)                 ; bound in generate-calendar
1235 1236
(defvar displayed-month)

Edward M. Reingold's avatar
Edward M. Reingold committed
1237 1238 1239 1240 1241
(defun mark-sexp-diary-entries ()
  "Mark days in the calendar window that have sexp diary entries.
Each entry in the diary file (or included files) visible in the calendar window
is marked.  See the documentation for the function `list-sexp-diary-entries'."
  (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol))
1242
         (s-entry (format "^\\(%s(\\)\\|\\(%s%s(diary-remind\\)" sexp-mark
Edward M. Reingold's avatar
Edward M. Reingold committed
1243
                          (regexp-quote diary-nonmarking-symbol)
1244
                          sexp-mark))
1245 1246
         (file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
         m y first-date last-date mark file-glob-attrs)
1247
    (with-current-buffer calendar-buffer
1248 1249
      (setq m displayed-month
            y displayed-year))
Edward M. Reingold's avatar
Edward M. Reingold committed
1250 1251 1252 1253 1254 1255 1256 1257 1258
    (increment-calendar-month m y -1)
    (setq first-date
          (calendar-absolute-from-gregorian (list m 1 y)))
    (increment-calendar-month m y 2)
    (setq last-date
          (calendar-absolute-from-gregorian
           (list m (calendar-last-day-of-month m y) y)))
    (goto-char (point-min))
    (while (re-search-forward s-entry nil t)
1259
      (setq marking-diary-entry (char-equal (preceding-char) ?\())
Edward M. Reingold's avatar
Edward M. Reingold committed
1260 1261
      (re-search-backward "(")
      (let ((sexp-start (point))
1262
            sexp entry entry-start marks)
Edward M. Reingold's avatar
Edward M. Reingold committed
1263
        (forward-sexp)
1264
        (setq sexp (buffer-substring-no-properties sexp-start (point)))
Edward M. Reingold's avatar
Edward M. Reingold committed
1265
        (forward-char 1)