1 ;;; diary-lib.el --- diary functions
3 ;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <rgm@gnu.org>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32 (eval-and-compile (load "diary-loaddefs" nil t
))
39 (defcustom diary-include-string
"#include"
40 "The string indicating inclusion of another file of diary entries.
41 See the documentation for the function `diary-include-other-diary-files'."
45 (defcustom diary-list-include-blanks nil
46 "If nil, do not include days with no diary entry in the list of diary entries.
47 Such days will then not be shown in the fancy diary buffer, even if they
52 (defcustom diary-face
'diary
53 "Face name to use for diary entries."
55 :group
'calendar-faces
)
56 (make-obsolete-variable 'diary-face
"customize the face `diary' instead."
59 (defface diary-anniversary
'((t :inherit font-lock-keyword-face
))
60 "Face used for anniversaries in the fancy diary display."
62 :group
'calendar-faces
)
64 (defface diary-time
'((t :inherit font-lock-variable-name-face
))
65 "Face used for times of day in the fancy diary display."
67 :group
'calendar-faces
)
69 (defface diary-button
'((((type pc
) (class color
))
70 (:foreground
"lightblue")))
71 "Face used for buttons in the fancy diary display."
73 :group
'calendar-faces
)
75 (define-obsolete-face-alias 'diary-button-face
'diary-button
"22.1")
77 ;; Face markup of calendar and diary displays: Any entry line that
78 ;; ends with [foo:value] where foo is a face attribute (except :box
79 ;; :stipple) or with [face:blah] tags, will have these values applied
80 ;; to the calendar and fancy diary displays. These attributes "stack"
81 ;; on calendar displays. File-wide attributes can be defined as
82 ;; follows: the first line matching "^# [tag:value]" defines the value
83 ;; for that particular tag.
84 (defcustom diary-face-attrs
85 '((" *\\[foreground:\\([-a-z]+\\)\\]$" 1 :foreground string
)
86 (" *\\[background:\\([-a-z]+\\)\\]$" 1 :background string
)
87 (" *\\[width:\\([-a-z]+\\)\\]$" 1 :width symbol
)
88 (" *\\[height:\\([.0-9]+\\)\\]$" 1 :height int
)
89 (" *\\[weight:\\([-a-z]+\\)\\]$" 1 :weight symbol
)
90 (" *\\[slant:\\([-a-z]+\\)\\]$" 1 :slant symbol
)
91 (" *\\[underline:\\([-a-z]+\\)\\]$" 1 :underline stringtnil
)
92 (" *\\[overline:\\([-a-z]+\\)\\]$" 1 :overline stringtnil
)
93 (" *\\[strike-through:\\([-a-z]+\\)\\]$" 1 :strike-through stringtnil
)
94 (" *\\[inverse-video:\\([-a-z]+\\)\\]$" 1 :inverse-video tnil
)
95 (" *\\[face:\\([-0-9a-z]+\\)\\]$" 1 :face string
)
96 (" *\\[font:\\([-a-z0-9]+\\)\\]$" 1 :font string
)
98 ;;; (" *\\[box:\\([-a-z]+\\)\\]$" 1 :box)
99 ;;; (" *\\[stipple:\\([-a-z]+\\)\\]$" 1 :stipple)
101 "Alist of (REGEXP SUBEXP ATTRIBUTE TYPE) elements.
102 This is used by `diary-pull-attrs' to fontify certain diary
103 elements. REGEXP is a regular expression to for, and SUBEXP is
104 the numbered sub-expression to extract. `diary-glob-file-regexp-prefix'
105 is pre-pended to REGEXP for file-wide specifiers. ATTRIBUTE
106 specifies which face attribute (e.g. `:foreground') to modify, or
107 that this is a face (`:face') to apply. TYPE is the type of
108 attribute being applied. Available TYPES (see `diary-attrtype-convert')
109 are: `string', `symbol', `int', `tnil', `stringtnil.'"
110 :type
'(repeat (list (string :tag
"Regular expression")
111 (integer :tag
"Sub-expression")
112 (symbol :tag
"Attribute (e.g. :foreground)")
113 (choice (const string
:tag
"A string")
114 (const symbol
:tag
"A symbol")
115 (const int
:tag
"An integer")
116 (const tnil
:tag
"`t' or `nil'")
118 :tag
"A string, `t', or `nil'"))))
121 (defcustom diary-glob-file-regexp-prefix
"^\\#"
122 "Regular expression pre-pended to `diary-face-attrs' for file-wide specifiers."
126 (defcustom diary-file-name-prefix nil
127 "Non-nil means prefix each diary entry with the name of the file defining it."
131 (defcustom diary-file-name-prefix-function
'identity
132 "The function that will take a diary file name and return the desired prefix."
136 (define-obsolete-variable-alias 'sexp-diary-entry-symbol
137 'diary-sexp-entry-symbol
"23.1")
139 (defcustom diary-sexp-entry-symbol
"%%"
140 "The string used to indicate a sexp diary entry in `diary-file'.
141 See the documentation for the function `diary-list-sexp-entries'."
145 (defcustom diary-hook nil
146 "List of functions called after the display of the diary.
147 Used for example by the appointment package - see `appt-activate'."
151 (define-obsolete-variable-alias 'diary-display-hook
'diary-display-function
154 (defcustom diary-display-function
'diary-fancy-display
155 "Function used to display the diary.
156 The two standard options are `diary-fancy-display' and `diary-simple-display'.
158 For historical reasons, `nil' is the same as `diary-simple-display'
159 \(so you must use `ignore' for no display). Also for historical
160 reasons, this variable can be a list of functions to run. These
161 uses are not recommended and may be removed at some point.
163 When this function is called, the variable `diary-entries-list'
164 is a list, in order by date, of all relevant diary entries in the
165 form of ((MONTH DAY YEAR) STRING), where string is the diary
166 entry for the given date. This can be used, for example, to
167 produce a different buffer for display (perhaps combined with
168 holidays), or hard copy output."
169 :type
'(choice (const diary-fancy-display
:tag
"Fancy display")
170 (const diary-simple-display
:tag
"Basic display")
171 (const ignore
:tag
"No display")
172 (const nil
:tag
"Obsolete way to choose basic display")
173 (hook :tag
"Obsolete form with list of display functions"))
174 :initialize
'custom-initialize-default
175 :set
'diary-set-maybe-redraw
176 :version
"23.2" ; simple->fancy
179 (define-obsolete-variable-alias 'list-diary-entries-hook
180 'diary-list-entries-hook
"23.1")
182 (defcustom diary-list-entries-hook nil
183 "List of functions called after diary file is culled for relevant entries.
184 You might wish to add `diary-include-other-diary-files', in which case
185 you will probably also want to add `diary-mark-included-diary-files' to
186 `diary-mark-entries-hook'. For example, you could use
188 (setq diary-display-function 'diary-fancy-display)
189 (add-hook 'diary-list-entries-hook 'diary-include-other-diary-files)
190 (add-hook 'diary-list-entries-hook 'diary-sort-entries t)
192 in your `.emacs' file to cause the fancy diary buffer to be displayed with
193 diary entries from various included files, each day's entries sorted into
194 lexicographic order. Note how the sort function is placed last,
195 so that it can sort the entries included from other files."
197 :options
'(diary-include-other-diary-files diary-sort-entries
)
200 (define-obsolete-variable-alias 'mark-diary-entries-hook
201 'diary-mark-entries-hook
"23.1")
203 (defcustom diary-mark-entries-hook nil
204 "List of functions called after marking diary entries in the calendar.
205 You might wish to add `diary-mark-included-diary-files', in which case
206 you will probably also want to add `diary-include-other-diary-files' to
207 `diary-list-entries-hook'."
209 :options
'(diary-mark-included-diary-files)
212 (define-obsolete-variable-alias 'nongregorian-diary-listing-hook
213 'diary-nongregorian-listing-hook
"23.1")
215 (defcustom diary-nongregorian-listing-hook nil
216 "List of functions called for listing diary file and included files.
217 As the files are processed for diary entries, these functions are used
218 to cull relevant entries. You can use any or all of
219 `diary-bahai-list-entries', `diary-hebrew-list-entries', and
220 `diary-islamic-list-entries'. The documentation for these functions
221 describes the style of such diary entries."
223 :options
'(diary-bahai-list-entries
224 diary-hebrew-list-entries
225 diary-islamic-list-entries
)
228 (define-obsolete-variable-alias 'nongregorian-diary-marking-hook
229 'diary-nongregorian-marking-hook
"23.1")
231 (defcustom diary-nongregorian-marking-hook nil
232 "List of functions called for marking diary file and included files.
233 As the files are processed for diary entries, these functions are used
234 to cull relevant entries. You can use any or all of
235 `diary-bahai-mark-entries', `diary-hebrew-mark-entries' and
236 `diary-islamic-mark-entries'. The documentation for these functions
237 describes the style of such diary entries."
239 :options
'(diary-bahai-mark-entries
240 diary-hebrew-mark-entries
241 diary-islamic-mark-entries
)
244 (define-obsolete-variable-alias 'print-diary-entries-hook
245 'diary-print-entries-hook
"23.1")
247 (defcustom diary-print-entries-hook
'lpr-buffer
248 "Run by `diary-print-entries' after preparing a temporary diary buffer.
249 The buffer shows only the diary entries currently visible in the
250 diary buffer. The default just does the printing. Other uses
251 might include, for example, rearranging the lines into order by
252 day and time, saving the buffer instead of deleting it, or
253 changing the function used to do the printing."
257 (defcustom diary-unknown-time -
9999
258 "Value returned by `diary-entry-time' when no time is found.
259 The default value -9999 causes entries with no recognizable time
260 to be placed before those with times; 9999 would place entries
261 with no recognizable time after those with times."
266 (defcustom diary-mail-addr
267 (or (bound-and-true-p user-mail-address
) "")
268 "Email address that `diary-mail-entries' will send email to."
273 (defcustom diary-mail-days
7
274 "Default number of days for `diary-mail-entries' to check."
279 (defcustom diary-remind-message
281 (if (zerop (% days
7))
282 (format "%d week%s" (/ days
7) (if (= 7 days
) "" "s"))
283 (format "%d day%s" days
(if (= 1 days
) "" "s")))
286 "Pseudo-pattern giving form of reminder messages in the fancy diary display.
288 Used by the function `diary-remind', a pseudo-pattern is a list of
289 expressions that can involve the keywords `days' (a number), `date'
290 \(a list of month, day, year), and `diary-entry' (a string)."
294 (define-obsolete-variable-alias 'abbreviated-calendar-year
295 'diary-abbreviated-year-flag
"23.1")
297 (defcustom diary-abbreviated-year-flag t
298 "Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
299 This applies to the Gregorian, Hebrew, Islamic, and Baha'i calendars.
300 When the current century is added to a two-digit year, if the result
301 is more than 50 years in the future, the previous century is assumed.
302 If the result is more than 50 years in the past, the next century is assumed.
303 If this variable is nil, years must be written in full."
307 (defcustom diary-outlook-formats
309 ;; When: 11 October 2001 12:00-14:00 (GMT) Greenwich Mean Time : Dublin, ...
310 ;; [Current UK format? The timezone is meaningless. Sometimes the
311 ;; Where is missing.]
312 ("When: \\([0-9]+ [[:alpha:]]+ [0-9]+\\) \
315 \\(?:Where: \\([^\n]+\\)\n+\\)?
316 \\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*"
317 .
"\\1\n \\2 %s, \\3")
318 ;; When: Tuesday, April 30, 2002 03:00 PM-03:30 PM (GMT) Greenwich Mean ...
320 ("^When: [[:alpha:]]+, \\([[:alpha:]]+\\) \\([0-9][0-9]*\\), \\([0-9]\\{4\\}\\) \
323 \\(?:Where: \\([^\n]+\\)\\)?\n+"
324 .
"\\2 \\1 \\3\n \\4 %s, \\5")
326 ;; German format, apparently.
327 "^Zeit: [^ ]+, +\\([0-9]+\\)\. +\\([[:upper:]][[:lower:]][[:lower:]]\\)[^ ]* +\\([0-9]+\\) +\\([^ ]+\\).*$"
328 .
"\\1 \\2 \\3\n \\4 %s"))
329 "Alist of regexps matching message text and replacement text.
331 The regexp must match the start of the message text containing an
332 appointment, but need not include a leading `^'. If it matches the
333 current message, a diary entry is made from the corresponding
334 template. If the template is a string, it should be suitable for
335 passing to `replace-match', and so will have occurrences of `\\D' to
336 substitute the match for the Dth subexpression. It must also contain
337 a single `%s' which will be replaced with the text of the message's
338 Subject field. Any other `%' characters must be doubled, so that the
339 template can be passed to `format'.
341 If the template is actually a function, it is called with the message
342 body text as argument, and may use `match-string' etc. to make a
343 template following the rules above."
344 :type
'(alist :key-type
(regexp :tag
"Regexp matching time/place")
346 (string :tag
"Template for entry")
348 "Unary function providing template")))
352 (defvar diary-header-line-flag
)
353 (defvar diary-header-line-format
)
355 (defun diary-set-header (symbol value
)
356 "Set SYMBOL's value to VALUE, and redraw the diary header if necessary."
357 (let ((oldvalue (symbol-value symbol
))
358 (dbuff (and diary-file
(find-buffer-visiting diary-file
))))
359 (custom-set-default symbol value
)
361 (not (equal value oldvalue
))
362 (with-current-buffer dbuff
363 (if (eq major-mode
'diary-mode
)
364 (setq header-line-format
(and diary-header-line-flag
365 diary-header-line-format
)))))))
367 ;; This can be removed once the kill/yank treatment of invisible text
368 ;; (see etc/TODO) is fixed. -- gm
369 (defcustom diary-header-line-flag t
370 "Non-nil means `diary-simple-display' will show a header line.
371 The format of the header is specified by `diary-header-line-format'."
374 :initialize
'custom-initialize-default
375 :set
'diary-set-header
378 (defvar diary-selective-display nil
379 "Internal diary variable; non-nil if some diary text is hidden.")
381 (defcustom diary-header-line-format
382 '(:eval
(calendar-string-spread
383 (list (if diary-selective-display
384 "Some text is hidden - press \"s\" in calendar \
388 "Format of the header line displayed by `diary-simple-display'.
389 Only used if `diary-header-line-flag' is non-nil."
392 :initialize
'custom-initialize-default
393 :set
'diary-set-header
394 :version
"23.3") ; frame-width -> window-width
396 ;; The first version of this also checked for diary-selective-display
397 ;; in the non-fancy case. This was an attempt to distinguish between
398 ;; displaying the diary and just visiting the diary file. However,
399 ;; when using fancy diary, calling diary when there are no entries to
400 ;; display does not create the fancy buffer, nor does it set
401 ;; diary-selective-display in the diary buffer. This means some
402 ;; customizations will not take effect, eg:
403 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00466.html
404 ;; So the check for diary-selective-display was dropped. This means the
405 ;; diary will be displayed if one customizes a diary variable while
406 ;; just visiting the diary-file. This is i) unlikely, and ii) no great loss.
408 (defun diary-live-p ()
409 "Return non-nil if the diary is being displayed."
410 (or (get-buffer diary-fancy-buffer
)
411 (and diary-file
(find-buffer-visiting diary-file
))))
414 (defun diary-set-maybe-redraw (symbol value
)
415 "Set SYMBOL's value to VALUE, and redraw the diary if necessary.
416 Redraws the diary if it is being displayed (note this is not the same as
417 just visiting the `diary-file'), and SYMBOL's value is to be changed."
418 (let ((oldvalue (symbol-value symbol
)))
419 (custom-set-default symbol value
)
420 (and (not (equal value oldvalue
))
422 ;; Note this assumes diary was called without prefix arg.
425 (define-obsolete-variable-alias 'number-of-diary-entries
426 'diary-number-of-entries
"23.1")
428 (defcustom diary-number-of-entries
1
429 "Specifies how many days of diary entries are to be displayed initially.
430 This variable affects the diary display when the command \\[diary] is
431 used, or if the value of the variable `calendar-view-diary-initially-flag'
432 is non-nil. For example, if the default value 1 is used, then only the
433 current day's diary entries will be displayed. If the value 2 is used,
434 then both the current day's and the next day's entries will be displayed.
436 The value can also be a vector such as [0 2 2 2 2 4 1]; this value says
437 to display no diary entries on Sunday, the entries for the current date
438 and the day after on Monday through Thursday, Friday through Monday's
439 entries on Friday, and only Saturday's entries on Saturday.
441 This variable does not affect the diary display with the `d' command
442 from the calendar; in that case, the prefix argument controls the number
443 of days of diary entries displayed."
444 :type
'(choice (integer :tag
"Entries")
445 (vector :value
[0 0 0 0 0 0 0]
446 (integer :tag
"Sunday")
447 (integer :tag
"Monday")
448 (integer :tag
"Tuesday")
449 (integer :tag
"Wednesday")
450 (integer :tag
"Thursday")
451 (integer :tag
"Friday")
452 (integer :tag
"Saturday")))
453 :initialize
'custom-initialize-default
454 :set
'diary-set-maybe-redraw
457 ;;; More user options in calendar.el, holidays.el.
460 (defun diary-check-diary-file ()
461 "Check that the file specified by `diary-file' exists and is readable.
462 If so, return the expanded file name, otherwise signal an error."
463 (if (and diary-file
(file-exists-p diary-file
))
464 (if (file-readable-p diary-file
)
466 (error "Diary file `%s' is not readable" diary-file
))
467 (error "Diary file `%s' does not exist" diary-file
)))
470 (defun diary (&optional arg
)
471 "Generate the diary window for ARG days starting with the current date.
472 If no argument is provided, the number of days of diary entries is governed
473 by the variable `diary-number-of-entries'. A value of ARG less than 1
474 does nothing. This function is suitable for execution in a `.emacs' file."
476 (diary-check-diary-file)
477 (diary-list-entries (calendar-current-date)
478 (if arg
(prefix-numeric-value arg
))))
481 (defun diary-view-entries (&optional arg
)
482 "Prepare and display a buffer with diary entries.
483 Searches the file named in `diary-file' for entries that match
484 ARG days starting with the date indicated by the cursor position
485 in the displayed three-month calendar."
487 (diary-check-diary-file)
488 (diary-list-entries (calendar-cursor-to-date t
) arg
))
490 (define-obsolete-function-alias 'view-diary-entries
'diary-view-entries
"22.1")
494 (defun diary-view-other-diary-entries (arg dfile
)
495 "Prepare and display buffer of diary entries from an alternative diary file.
496 Searches for entries that match ARG days, starting with the date indicated
497 by the cursor position in the displayed three-month calendar.
498 DFILE specifies the file to use as the diary file."
500 (list (prefix-numeric-value current-prefix-arg
)
501 (read-file-name "Enter diary file name: " default-directory nil t
)))
502 (let ((diary-file dfile
))
503 (diary-view-entries arg
)))
506 (define-obsolete-function-alias 'view-other-diary-entries
507 'diary-view-other-diary-entries
"23.1")
509 (defvar diary-syntax-table
510 (let ((st (copy-syntax-table (standard-syntax-table))))
511 (modify-syntax-entry ?
* "w" st
)
512 (modify-syntax-entry ?
: "w" st
)
514 "The syntax table used when parsing dates in the diary file.
515 It is the standard syntax table used in Fundamental mode, but with the
516 syntax of `*' and `:' changed to be word constituents.")
518 (defun diary-attrtype-convert (attrvalue type
)
519 "Convert string ATTRVALUE to TYPE appropriate for a face description.
520 Valid TYPEs are: string, symbol, int, stringtnil, tnil."
521 (cond ((eq type
'string
) attrvalue
)
522 ((eq type
'symbol
) (intern-soft attrvalue
))
523 ((eq type
'int
) (string-to-number attrvalue
))
524 ((eq type
'stringtnil
)
525 (cond ((string-equal "t" attrvalue
) t
)
526 ((string-equal "nil" attrvalue
) nil
)
528 ((eq type
'tnil
) (string-equal "t" attrvalue
))))
530 (defun diary-pull-attrs (entry fileglobattrs
)
531 "Search for matches for regexps from `diary-face-attrs'.
532 If ENTRY is nil, searches from the start of the current buffer, and
533 prepends all regexps with `diary-glob-file-regexp-prefix'.
534 If ENTRY is a string, search for matches in that string, and remove them.
535 Returns a list of ENTRY followed by (ATTRIBUTE VALUE) pairs.
536 When ENTRY is non-nil, FILEGLOBATTRS forms the start of the (ATTRIBUTE VALUE)
538 (let (regexp regnum attrname attrname attrvalue type ret-attr
)
541 (dolist (attr diary-face-attrs
)
542 ;; FIXME inefficient searching.
543 (goto-char (point-min))
544 (setq regexp
(concat diary-glob-file-regexp-prefix
(car attr
))
546 attrname
(nth 2 attr
)
548 attrvalue
(if (re-search-forward regexp nil t
)
549 (match-string-no-properties regnum
)))
551 (setq attrvalue
(diary-attrtype-convert attrvalue type
))
552 (setq ret-attr
(append ret-attr
553 (list attrname attrvalue
))))))
554 (setq ret-attr fileglobattrs
)
555 (dolist (attr diary-face-attrs
)
556 (setq regexp
(car attr
)
558 attrname
(nth 2 attr
)
561 ;; If multiple matches, replace all, use the last (which may
562 ;; be the first instance in the line, if the regexp is
564 (while (string-match regexp entry
)
565 (setq attrvalue
(match-string-no-properties regnum entry
)
566 entry
(replace-match "" t t entry
)))
568 (setq attrvalue
(diary-attrtype-convert attrvalue type
))
569 (setq ret-attr
(append ret-attr
(list attrname attrvalue
))))))
570 (list entry ret-attr
)))
574 (defvar diary-modify-entry-list-string-function nil
575 "Function applied to entry string before putting it into the entries list.
576 Can be used by programs integrating a diary list into other buffers (e.g.
577 org.el and planner.el) to modify the string or add properties to it.
578 The function takes a string argument and must return a string.")
580 (defvar diary-entries-list
) ; bound in diary-list-entries
582 (defun diary-add-to-list (date string specifier
&optional marker
584 "Add an entry to `diary-entries-list'.
585 Do nothing if DATE or STRING are nil. DATE is the (MONTH DAY
586 YEAR) for which the entry applies; STRING is the text of the
587 entry as it will appear in the diary (i.e. with any format
588 strings such as \"%d\" expanded); SPECIFIER is the date part of
589 the entry as it appears in the diary-file; LITERAL is the entry
590 as it appears in the diary-file (i.e. before expansion).
591 If LITERAL is nil, it is taken to be the same as STRING.
593 The entry is added to the list as (DATE STRING SPECIFIER LOCATOR
594 GLOBCOLOR), where LOCATOR has the form (MARKER FILENAME LITERAL),
595 FILENAME being the file containing the diary entry."
596 (when (and date string
)
597 (if diary-file-name-prefix
598 (let ((prefix (funcall diary-file-name-prefix-function
599 (buffer-file-name))))
600 (or (string-equal prefix
"")
601 (setq string
(format "[%s] %s" prefix string
)))))
602 (and diary-modify-entry-list-string-function
603 (setq string
(funcall diary-modify-entry-list-string-function
605 (setq diary-entries-list
606 (append diary-entries-list
607 (list (list date string specifier
608 (list marker
(buffer-file-name) literal
)
611 (define-obsolete-function-alias 'add-to-diary-list
'diary-add-to-list
"23.1")
613 (defun diary-list-entries-2 (date mark globattr list-only
614 &optional months symbol gdate
)
615 "Internal subroutine of `diary-list-entries'.
616 Find diary entries applying to DATE, by searching from point-min for
617 each element of `diary-date-forms'. MARK indicates an entry is non-marking.
618 GLOBATTR is the list of global file attributes. If LIST-ONLY is
619 non-nil, don't change the buffer, only return a list of entries.
620 Optional array MONTHS replaces `calendar-month-name-array', and
621 means months cannot be abbreviated. Optional string SYMBOL marks diary
622 entries of the desired type. If DATE is not Gregorian, then the
623 Gregorian equivalent should be provided via GDATE. Returns non-nil if
624 any entries were found."
625 (let* ((month (calendar-extract-month date
))
626 (day (calendar-extract-day date
))
627 (year (calendar-extract-year date
))
628 (dayname (format "%s\\|%s\\.?" (calendar-day-name date
)
629 (calendar-day-name date
'abbrev
)))
630 (calendar-month-name-array (or months calendar-month-name-array
))
631 (monthname (format "\\*\\|%s%s" (calendar-month-name month
)
634 (calendar-month-name month
'abbrev
)))))
635 (month (format "\\*\\|0*%d" month
))
636 (day (format "\\*\\|0*%d" day
))
637 (year (format "\\*\\|0*%d%s" year
638 (if diary-abbreviated-year-flag
639 (format "\\|%02d" (% year
100))
643 (dolist (date-form diary-date-forms
)
644 (let ((backup (when (eq (car date-form
) 'backup
)
645 (setq date-form
(cdr date-form
))
647 ;; date-form uses day etc as set above.
648 (regexp (format "^%s?%s\\(%s\\)" (regexp-quote mark
)
649 (if symbol
(regexp-quote symbol
) "")
650 (mapconcat 'eval date-form
"\\)\\(?:")))
651 entry-start date-start temp
)
652 (goto-char (point-min))
653 (while (re-search-forward regexp nil t
)
654 (if backup
(re-search-backward "\\<" nil t
))
655 ;; regexp moves us past the end of date, onto the next line.
656 ;; Trailing whitespace after date not allowed (see diary-file).
657 (if (and (bolp) (not (looking-at "[ \t]")))
658 ;; Diary entry that consists only of date.
660 ;; Found a nonempty diary entry--make it
661 ;; visible and add it to the list.
662 (setq date-start
(line-end-position 0))
663 ;; Actual entry starts on the next-line?
664 (if (looking-at "[ \t]*\n[ \t]") (forward-line 1))
668 (while (looking-at "[ \t]") ; continued entry
670 (unless (and (eobp) (not (bolp)))
673 (remove-overlays date-start
(point) 'invisible
'diary
))
674 (setq temp
(diary-pull-attrs
675 (buffer-substring-no-properties
676 entry-start
(point)) globattr
))
678 (or gdate date
) (car temp
)
679 (buffer-substring-no-properties (1+ date-start
) (1- entry-start
))
680 (copy-marker entry-start
) (cadr temp
))))))
683 (defvar original-date
) ; from diary-list-entries
684 (defvar file-glob-attrs
)
688 (defun diary-list-entries-1 (months symbol absfunc
)
689 "List diary entries of a certain type.
690 MONTHS is an array of month names. SYMBOL marks diary entries of the type
691 in question. ABSFUNC is a function that converts absolute dates to dates
692 of the appropriate type."
693 (let ((gdate original-date
))
694 (dotimes (idummy number
)
695 (diary-list-entries-2
696 (funcall absfunc
(calendar-absolute-from-gregorian gdate
))
697 diary-nonmarking-symbol file-glob-attrs list-only months symbol gdate
)
699 (calendar-gregorian-from-absolute
700 (1+ (calendar-absolute-from-gregorian gdate
))))))
701 (goto-char (point-min)))
703 (defvar diary-included-files nil
704 "List of any diary files included in the last call to `diary-list-entries'.")
706 ;; FIXME non-greg and list hooks run same number of times?
707 (defun diary-list-entries (date number
&optional list-only
)
708 "Create and display a buffer containing the relevant lines in `diary-file'.
709 The arguments are DATE and NUMBER; the entries selected are those
710 for NUMBER days starting with date DATE. The other entries are hidden
711 using overlays. If NUMBER is less than 1, this function does nothing.
713 Returns a list of all relevant diary entries found.
714 The list entries have the form ((MONTH DAY YEAR) STRING SPECIFIER) where
715 \(MONTH DAY YEAR) is the date of the entry, STRING is the entry text, and
716 SPECIFIER is the applicability. If the variable `diary-list-include-blanks'
717 is non-nil, this list includes a dummy diary entry consisting of the empty
718 string for a date with no diary entries.
720 If entries are being produced for multiple dates (i.e., NUMBER > 1),
721 then this function normally returns the entries from any given
722 diary file in date order. The entries for any given day are in
723 the order in which they were found in the file, not necessarily
724 in time-of-day order. Note that any functions present on the
725 hooks (see below) may add entries, or change the order. For
726 example, `diary-include-other-diary-files' adds entries from any
727 include files that it finds to the end of the original list. The
728 entries from each file will be in date order, but the overall
729 list will not be. If you want the entire list to be in time order,
730 add `diary-sort-entries' to the end of `diary-list-entries-hook'.
732 After the initial list is prepared, the following hooks are run:
734 `diary-nongregorian-listing-hook' can cull dates from the diary
735 and each included file, for example to process Islamic diary
736 entries. Applied to *each* file.
738 `diary-list-entries-hook' adds or manipulates diary entries from
739 external sources. Used, for example, to include diary entries
740 from other files or to sort the diary entries. Invoked *once*
741 only, before the display hook is run.
743 `diary-hook' is run last, after the diary is displayed.
744 This is used e.g. by `appt-check'.
746 Functions called by these hooks may use the variables ORIGINAL-DATE
747 and NUMBER, which are the arguments with which this function was called.
748 Note that hook functions should _not_ use DATE, but ORIGINAL-DATE.
749 \(Sexp diary entries may use DATE - see `diary-list-sexp-entries'.)
751 This function displays the list using `diary-display-function', unless
752 LIST-ONLY is non-nil, in which case it just returns the list."
754 (setq number
(if (vectorp diary-number-of-entries
)
755 (aref diary-number-of-entries
(calendar-day-of-week date
))
756 diary-number-of-entries
)))
758 (let* ((original-date date
) ; save for possible use in the hooks
759 (date-string (calendar-date-string date
))
760 (diary-buffer (find-buffer-visiting diary-file
))
761 ;; Dynamically bound in diary-include-other-diary-files.
762 (d-incp (and (boundp 'diary-including
) diary-including
))
763 diary-entries-list file-glob-attrs
)
765 (setq diary-included-files nil
)
766 (message "Preparing diary..."))
768 (if (not diary-buffer
)
769 (set-buffer (find-file-noselect diary-file t
))
770 (set-buffer diary-buffer
)
771 (or (verify-visited-file-modtime diary-buffer
)
772 (revert-buffer t t
)))
773 ;; Setup things like the header-line-format and invisibility-spec.
774 (if (eq major-mode
(default-value 'major-mode
))
776 ;; This kludge is to make customizations to
777 ;; diary-header-line-flag after diary has been displayed
778 ;; take effect. Unconditionally calling (diary-mode)
779 ;; clobbers file local variables.
780 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00363.html
781 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-04/msg00404.html
782 (if (eq major-mode
'diary-mode
)
783 (setq header-line-format
(and diary-header-line-flag
784 diary-header-line-format
))))
785 ;; d-s-p is passed to the diary display function.
786 (let ((diary-saved-point (point)))
790 (setq file-glob-attrs
(cadr (diary-pull-attrs nil
"")))
791 (with-syntax-table diary-syntax-table
792 (goto-char (point-min))
794 (let ((ol (make-overlay (point-min) (point-max) nil t nil
)))
795 (set (make-local-variable 'diary-selective-display
) t
)
796 (overlay-put ol
'invisible
'diary
)
797 (overlay-put ol
'evaporate t
)))
798 (dotimes (idummy number
)
799 (let ((sexp-found (diary-list-sexp-entries date
))
800 (entry-found (diary-list-entries-2
801 date diary-nonmarking-symbol
802 file-glob-attrs list-only
)))
803 (if diary-list-include-blanks
804 (or sexp-found entry-found
805 (diary-add-to-list date
"" "" "" "")))
807 (calendar-gregorian-from-absolute
808 (1+ (calendar-absolute-from-gregorian date
)))))))
809 (goto-char (point-min))
810 (run-hooks 'diary-nongregorian-listing-hook
811 'diary-list-entries-hook
)
813 (if (and diary-display-function
814 (listp diary-display-function
))
815 ;; Backwards compatibility.
816 (run-hooks 'diary-display-function
)
817 (funcall (or diary-display-function
818 'diary-simple-display
))))
819 (run-hooks 'diary-hook
)
820 (or d-incp
(message "Preparing diary...done"))
821 diary-entries-list
)))))))
823 (define-obsolete-function-alias 'list-diary-entries
'diary-list-entries
"22.1")
825 (defun diary-unhide-everything ()
826 "Show all invisible text in the diary."
827 (kill-local-variable 'diary-selective-display
)
828 (save-restriction ; bug#5477
830 (remove-overlays (point-min) (point-max) 'invisible
'diary
))
831 (kill-local-variable 'mode-line-format
))
833 (defvar original-date
) ; bound in diary-list-entries
836 (defun diary-include-other-diary-files ()
837 "Include the diary entries from other diary files with those of `diary-file'.
838 This function is suitable for use with `diary-list-entries-hook';
839 it enables you to use shared diary files together with your own.
840 The files included are specified in the `diary-file' by lines of this form:
841 #include \"filename\"
842 This is recursive; that is, #include directives in diary files thus included
843 are obeyed. You can change the `#include' to some other string by changing
844 the variable `diary-include-string'."
845 (goto-char (point-min))
846 (while (re-search-forward
847 (format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string
))
849 (let ((diary-file (match-string-no-properties 1))
850 (diary-list-entries-hook 'diary-include-other-diary-files
)
852 diary-hook diary-list-include-blanks efile
)
853 (if (file-exists-p diary-file
)
854 (if (file-readable-p diary-file
)
855 (if (member (setq efile
(expand-file-name diary-file
))
856 diary-included-files
)
857 (error "Recursive diary include for %s" diary-file
)
858 (setq diary-included-files
859 (append diary-included-files
(list efile
))
861 (append diary-entries-list
862 (diary-list-entries original-date number t
))))
864 (message "Can't read included diary file %s" diary-file
)
867 (message "Can't find included diary file %s" diary-file
)
869 (goto-char (point-min)))
871 (define-obsolete-function-alias 'include-other-diary-files
872 'diary-include-other-diary-files
"23.1")
874 (defvar date-string
) ; bound in diary-list-entries
876 (defun diary-display-no-entries ()
877 "Common subroutine of `diary-simple-display' and `diary-fancy-display'.
878 Handles the case where there are no diary entries.
879 Returns a cons (NOENTRIES . HOLIDAY-STRING)."
880 (let* ((holiday-list (if diary-show-holidays-flag
881 (calendar-check-holidays original-date
)))
882 (hol-string (format "%s%s%s"
884 (if holiday-list
": " "")
885 (mapconcat 'identity holiday-list
"; ")))
886 (msg (format "No diary entries for %s" hol-string
))
887 ;; Empty list, or single item with no text.
888 ;; FIXME multiple items with no text?
889 (noentries (or (not diary-entries-list
)
890 (and (not (cdr diary-entries-list
))
891 (string-equal "" (cadr
892 (car diary-entries-list
)))))))
893 ;; Inconsistency: whether or not the holidays are displayed in a
894 ;; separate buffer depends on if there are diary entries.
896 (if (or (< (length msg
) (frame-width))
899 ;; holiday-list which is too wide for a message gets a buffer.
900 (calendar-in-read-only-buffer holiday-buffer
901 (calendar-set-mode-line (format "Holidays for %s" date-string
))
902 (insert (mapconcat 'identity holiday-list
"\n")))
903 (message "No diary entries for %s" date-string
)))
904 (cons noentries hol-string
)))
907 (defvar diary-saved-point
) ; bound in diary-list-entries
909 (defun diary-simple-display ()
910 "Display the diary buffer if there are any relevant entries or holidays.
911 Entries that do not apply are made invisible. Holidays are shown
912 in the mode line. This is an option for `diary-display-function'."
913 ;; If selected window is dedicated (to the calendar), need a new one
914 ;; to display the diary.
915 (let* ((pop-up-frames (or pop-up-frames
916 (window-dedicated-p (selected-window))))
917 (dbuff (find-buffer-visiting diary-file
))
918 (empty (diary-display-no-entries)))
919 ;; This may be too wide, but when simple diary is used there is
920 ;; nowhere else for the holidays to go. Also, it is documented in
921 ;; diary-show-holidays-flag that the holidays go in the mode-line.
922 ;; FIXME however if there are no diary entries a separate buffer
923 ;; is displayed - this is inconsistent.
924 (with-current-buffer dbuff
925 (calendar-set-mode-line (format "Diary for %s" (cdr empty
))))
926 (unless (car empty
) ; no entries
927 (with-current-buffer dbuff
928 (let ((window (display-buffer (current-buffer))))
929 ;; d-s-p is passed from diary-list-entries.
930 (set-window-point window diary-saved-point
)
931 (set-window-start window
(point-min)))))))
933 (define-obsolete-function-alias 'simple-diary-display
934 'diary-simple-display
"23.1")
936 (define-button-type 'diary-entry
'action
#'diary-goto-entry
937 'face
'diary-button
'help-echo
"Find this diary entry"
940 (defun diary-goto-entry (button)
941 "Jump to the diary entry for the BUTTON at point."
942 (let* ((locator (button-get button
'locator
))
943 (marker (car locator
))
945 ;; If marker pointing to diary location is valid, use that.
946 (if (and marker
(setq markbuf
(marker-buffer marker
)))
948 (pop-to-buffer markbuf
)
949 (goto-char (marker-position marker
)))
950 ;; Marker is invalid (eg buffer has been killed).
951 (or (and (setq file
(cadr locator
))
953 (find-file-other-window file
)
955 (when (eq major-mode
(default-value 'major-mode
)) (diary-mode))
956 (goto-char (point-min))
957 (if (re-search-forward (format "%s.*\\(%s\\)"
958 (regexp-quote (nth 2 locator
))
959 (regexp-quote (nth 3 locator
)))
961 (goto-char (match-beginning 1)))))
962 (message "Unable to locate this diary entry")))))
964 (defun diary-fancy-display ()
965 "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
966 Holidays are shown unless `diary-show-holidays-flag' is nil.
967 Days with no diary entries are not shown (even if that day is a
968 holiday), unless `diary-list-include-blanks' is non-nil.
970 This is an option for `diary-display-function'."
971 ;; Turn off selective-display in the diary file's buffer.
972 (with-current-buffer (find-buffer-visiting diary-file
)
973 (diary-unhide-everything))
974 (unless (car (diary-display-no-entries)) ; no entries
975 ;; Prepare the fancy diary buffer.
976 (calendar-in-read-only-buffer diary-fancy-buffer
977 (calendar-set-mode-line "Diary Entries")
978 (let ((holiday-list-last-month 1)
979 (holiday-list-last-year 1)
982 (dolist (entry diary-entries-list
)
983 (unless (calendar-date-equal date
(car entry
))
984 (setq date
(car entry
))
985 (and diary-show-holidays-flag
986 (calendar-date-compare
987 (list (list holiday-list-last-month
988 (calendar-last-day-of-month
989 holiday-list-last-month
990 holiday-list-last-year
)
991 holiday-list-last-year
))
993 ;; We need to get the holidays for the next 3 months.
994 (setq holiday-list-last-month
995 (calendar-extract-month date
)
996 holiday-list-last-year
997 (calendar-extract-year date
))
999 (calendar-increment-month
1000 holiday-list-last-month holiday-list-last-year
1)
1003 (let ((displayed-month holiday-list-last-month
)
1004 (displayed-year holiday-list-last-year
))
1005 (calendar-holiday-list)))
1006 (calendar-increment-month
1007 holiday-list-last-month holiday-list-last-year
1))
1009 date-holiday-list cc
)
1010 ;; Make a list of all holidays for date.
1011 (dolist (h holiday-list
)
1012 (if (calendar-date-equal date
(car h
))
1013 (setq date-holiday-list
(append date-holiday-list
1015 (insert (if (bobp) "" ?
\n) (calendar-date-string date
))
1016 (if date-holiday-list
(insert ": "))
1017 (setq cc
(current-column))
1018 (insert (mapconcat (lambda (x)
1019 (setq longest
(max longest
(length x
)))
1022 (concat "\n" (make-string cc ?\s
))))
1023 (insert ?
\n (make-string (+ cc longest
) ?
=) ?
\n)))
1024 (let ((this-entry (cadr entry
))
1025 this-loc marks temp-face
)
1026 (unless (zerop (length this-entry
))
1027 (if (setq this-loc
(nth 3 entry
))
1028 (insert-button this-entry
1029 ;; (MARKER FILENAME SPECIFIER LITERAL)
1030 'locator
(list (car this-loc
)
1033 (or (nth 2 this-loc
)
1036 (insert this-entry
))
1038 ;; Doesn't make sense to check font-lock-mode - see
1039 ;; comments above diary-entry-marker in calendar.el.
1040 (and ; font-lock-mode
1041 (setq marks
(nth 4 entry
))
1043 (setq temp-face
(calendar-make-temp-face marks
))
1044 (search-backward this-entry
)
1046 (make-overlay (match-beginning 0) (match-end 0))
1047 'face temp-face
)))))))
1048 ;; FIXME can't remember what this check was for.
1049 ;; To prevent something looping, or a minor optimization?
1050 (if (eq major-mode
'diary-fancy-display-mode
)
1051 (run-hooks 'diary-fancy-display-mode-hook
)
1052 (diary-fancy-display-mode))
1053 (calendar-set-mode-line date-string
))))
1055 (define-obsolete-function-alias 'fancy-diary-display
1056 'diary-fancy-display
"23.1")
1059 (defun diary-print-entries ()
1060 "Print a hard copy of the diary display.
1062 If the simple diary display is being used, prepare a temp buffer with the
1063 visible lines of the diary buffer, add a heading line composed from the mode
1064 line, print the temp buffer, and destroy it.
1066 If the fancy diary display is being used, just print the buffer.
1068 The hooks given by the variable `diary-print-entries-hook' are called to do
1069 the actual printing."
1071 (let ((diary-buffer (get-buffer diary-fancy-buffer
))
1072 temp-buffer heading start end
)
1074 (with-current-buffer diary-buffer
1075 (run-hooks 'diary-print-entries-hook
))
1076 (or (setq diary-buffer
(find-buffer-visiting diary-file
))
1077 (error "You don't have a diary buffer!"))
1078 ;; Name affects printing?
1079 (setq temp-buffer
(get-buffer-create " *Printable Diary Entries*"))
1080 (with-current-buffer diary-buffer
1082 (if (not (stringp mode-line-format
))
1084 (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format
)
1085 (match-string 1 mode-line-format
))
1089 (setq end
(next-single-char-property-change start
'invisible
))
1090 (unless (get-char-property start
'invisible
)
1091 (with-current-buffer temp-buffer
1092 (insert-buffer-substring diary-buffer start end
)))
1094 (and end
(< end
(point-max))))))
1095 (set-buffer temp-buffer
)
1096 (goto-char (point-min))
1097 (insert heading
"\n"
1098 (make-string (length heading
) ?
=) "\n")
1099 (run-hooks 'diary-print-entries-hook
)
1100 (kill-buffer temp-buffer
))))
1102 (define-obsolete-function-alias 'print-diary-entries
1103 'diary-print-entries
"23.1")
1106 (defun diary-show-all-entries ()
1107 "Show all of the diary entries in the diary file.
1108 This function gets rid of the selective display of the diary file so that
1109 all entries, not just some, are visible. If there is no diary buffer, one
1112 (let* ((d-file (diary-check-diary-file))
1113 (pop-up-frames (or pop-up-frames
1114 (window-dedicated-p (selected-window))))
1115 (win (selected-window))
1116 (height (window-height)))
1117 (with-current-buffer (or (find-buffer-visiting d-file
)
1118 (find-file-noselect d-file t
))
1119 (when (eq major-mode
(default-value 'major-mode
)) (diary-mode))
1120 (diary-unhide-everything)
1121 (display-buffer (current-buffer))
1122 (when (and (/= height
(window-height win
))
1123 (with-current-buffer (window-buffer win
)
1124 (derived-mode-p 'calendar-mode
)))
1125 (fit-window-to-buffer win
)))))
1127 (define-obsolete-function-alias 'show-all-diary-entries
1128 'diary-show-all-entries
"22.1")
1131 (defun diary-mail-entries (&optional ndays
)
1132 "Send a mail message showing diary entries for next NDAYS days.
1133 If no prefix argument is given, NDAYS is set to `diary-mail-days'.
1134 Mail is sent to the address specified by `diary-mail-addr'.
1136 Here is an example of a script to call `diary-mail-entries',
1137 suitable for regular scheduling using cron (or at). Note that
1138 since `emacs -script' does not load your `.emacs' file, you
1139 should ensure that all relevant variables are set.
1141 #!/usr/bin/emacs -script
1142 ;; diary-rem.el - run the Emacs diary-reminder
1144 \(setq diary-mail-days 3
1145 diary-file \"/path/to/diary.file\"
1146 calendar-date-style 'european
1147 diary-mail-addr \"user@host.name\")
1149 \(diary-mail-entries)
1151 # diary-rem.el ends here
1154 (if (string-equal diary-mail-addr
"")
1155 (error "You must set `diary-mail-addr' to use this command")
1156 (let ((diary-display-function 'diary-fancy-display
))
1157 (diary-list-entries (calendar-current-date) (or ndays diary-mail-days
)))
1158 (compose-mail diary-mail-addr
1159 (concat "Diary entries generated "
1160 (calendar-date-string (calendar-current-date))))
1162 (if (get-buffer diary-fancy-buffer
)
1163 (with-current-buffer diary-fancy-buffer
(buffer-string))
1164 "No entries found"))
1165 (call-interactively (get mail-user-agent
'sendfunc
))))
1167 (defun diary-name-pattern (string-array &optional abbrev-array paren
)
1168 "Return a regexp matching the strings in the array STRING-ARRAY.
1169 If the optional argument ABBREV-ARRAY is present, then the function
1170 `calendar-abbrev-construct' is used to construct abbreviations from the
1171 two supplied arrays. The returned regexp will then also match these
1172 abbreviations, with or without final `.' characters. If the optional
1173 argument PAREN is non-nil, the regexp is surrounded by parentheses."
1174 (regexp-opt (append string-array
1176 (calendar-abbrev-construct abbrev-array
1179 (calendar-abbrev-construct abbrev-array
1185 (defvar diary-marking-entries-flag nil
1186 "True during the marking of diary entries, nil otherwise.")
1188 (defvar diary-marking-entry-flag nil
1189 "True during the marking of diary entries, if current entry is marking.")
1191 ;; file-glob-attrs bound in diary-mark-entries.
1192 (defun diary-mark-entries-1 (markfunc &optional months symbol absfunc
)
1193 "Mark diary entries of a certain type.
1194 MARKFUNC is a function that marks entries of the appropriate type
1195 matching a given date pattern. MONTHS is an array of month names.
1196 SYMBOL marks diary entries of the type in question. ABSFUNC is a
1197 function that converts absolute dates to dates of the appropriate type. "
1198 (let ((dayname (diary-name-pattern calendar-day-name-array
1199 calendar-day-abbrev-array
))
1200 (monthname (format "%s\\|\\*"
1202 (diary-name-pattern months
)
1203 (diary-name-pattern calendar-month-name-array
1204 calendar-month-abbrev-array
))))
1205 (month "[0-9]+\\|\\*")
1206 (day "[0-9]+\\|\\*")
1207 (year "[0-9]+\\|\\*")
1208 (case-fold-search t
)
1210 (dolist (date-form diary-date-forms
)
1211 (if (eq (car date-form
) 'backup
) ; ignore 'backup directive
1212 (setq date-form
(cdr date-form
)))
1213 (let* ((l (length date-form
))
1214 (d-name-pos (- l
(length (memq 'dayname date-form
))))
1215 (d-name-pos (if (/= l d-name-pos
) (1+ d-name-pos
)))
1216 (m-name-pos (- l
(length (memq 'monthname date-form
))))
1217 (m-name-pos (if (/= l m-name-pos
) (1+ m-name-pos
)))
1218 (d-pos (- l
(length (memq 'day date-form
))))
1219 (d-pos (if (/= l d-pos
) (1+ d-pos
)))
1220 (m-pos (- l
(length (memq 'month date-form
))))
1221 (m-pos (if (/= l m-pos
) (1+ m-pos
)))
1222 (y-pos (- l
(length (memq 'year date-form
))))
1223 (y-pos (if (/= l y-pos
) (1+ y-pos
)))
1224 (regexp (format "^%s\\(%s\\)"
1225 (if symbol
(regexp-quote symbol
) "")
1226 (mapconcat 'eval date-form
"\\)\\("))))
1227 (goto-char (point-min))
1228 (while (re-search-forward regexp nil t
)
1231 (match-string-no-properties d-name-pos
)))
1234 (match-string-no-properties m-name-pos
)))
1235 (mm (string-to-number
1237 (match-string-no-properties m-pos
)
1239 (dd (string-to-number
1241 (match-string-no-properties d-pos
)
1244 (match-string-no-properties y-pos
)))
1247 (if (and (= (length y-str
) 2)
1248 diary-abbreviated-year-flag
)
1250 (calendar-extract-year
1254 (calendar-absolute-from-gregorian
1255 (calendar-current-date)))
1256 (calendar-current-date))))
1257 (y (+ (string-to-number y-str
)
1258 ;; Current century, eg 2000.
1259 (* 100 (/ current-y
100))))
1260 (offset (- y current-y
)))
1261 ;; Add 2-digit year to current century.
1262 ;; If more than 50 years in the future,
1263 ;; assume last century. If more than 50
1264 ;; years in the past, assume next century.
1270 (string-to-number y-str
)))))
1271 (setq marks
(cadr (diary-pull-attrs
1272 (buffer-substring-no-properties
1273 (point) (line-end-position))
1275 ;; Only mark all days of a given name if the pattern
1276 ;; contains no more specific elements.
1277 (if (and dd-name
(not (or d-pos m-pos y-pos
)))
1278 (calendar-mark-days-named
1279 (cdr (assoc-string dd-name
1280 (calendar-make-alist
1281 calendar-day-name-array
1282 0 nil calendar-day-abbrev-array
) t
)) marks
)
1285 (if (string-equal mm-name
"*") 0
1288 (if months
(calendar-make-alist months
)
1289 (calendar-make-alist
1290 calendar-month-name-array
1291 1 nil calendar-month-abbrev-array
)) t
)))))
1292 (funcall markfunc mm dd yy marks
))))))))
1295 (defun diary-mark-entries (&optional redraw
)
1296 "Mark days in the calendar window that have diary entries.
1297 Each entry in the diary file visible in the calendar window is
1298 marked. After the entries are marked, the hooks
1299 `diary-nongregorian-marking-hook' and `diary-mark-entries-hook'
1300 are run. If the optional argument REDRAW is non-nil (which is
1301 the case interactively, for example) then any existing diary
1302 marks are first removed. This is intended to deal with deleted
1305 ;; To remove any deleted diary entries. Do not redraw when:
1306 ;; i) processing #include diary files (else only get the marks from
1307 ;; the last #include file processed).
1308 ;; ii) called via calendar-redraw (since calendar has already been
1310 ;; Use of REDRAW handles both of these cases.
1311 (when (and redraw calendar-mark-diary-entries-flag
)
1312 (setq calendar-mark-diary-entries-flag nil
)
1314 (let ((diary-marking-entries-flag t
)
1316 (with-current-buffer (find-file-noselect (diary-check-diary-file) t
)
1318 (when (eq major-mode
(default-value 'major-mode
)) (diary-mode))
1319 (setq calendar-mark-diary-entries-flag t
)
1320 (message "Marking diary entries...")
1321 (setq file-glob-attrs
(nth 1 (diary-pull-attrs nil
'())))
1322 (with-syntax-table diary-syntax-table
1323 (diary-mark-entries-1 'calendar-mark-date-pattern
)
1324 (diary-mark-sexp-entries)
1325 (run-hooks 'diary-nongregorian-marking-hook
1326 'diary-mark-entries-hook
))
1327 (message "Marking diary entries...done")))))
1330 (define-obsolete-function-alias 'mark-diary-entries
'diary-mark-entries
"23.1")
1332 (defun diary-sexp-entry (sexp entry date
)
1333 "Process a SEXP diary ENTRY for DATE."
1334 (let ((result (if calendar-debug-sexp
1335 (let ((stack-trace-on-error t
))
1336 (eval (car (read-from-string sexp
))))
1338 (eval (car (read-from-string sexp
)))
1341 (message "Bad sexp at line %d in %s: %s"
1342 (count-lines (point-min) (point))
1345 (cond ((stringp result
) result
)
1346 ((and (consp result
)
1347 (stringp (cdr result
))) result
)
1351 (defvar displayed-year
) ; bound in calendar-generate
1352 (defvar displayed-month
)
1354 (defun diary-mark-sexp-entries ()
1355 "Mark days in the calendar window that have sexp diary entries.
1356 Each entry in the diary file (or included files) visible in the calendar window
1357 is marked. See the documentation for the function `diary-list-sexp-entries'."
1358 (let* ((sexp-mark (regexp-quote diary-sexp-entry-symbol
))
1359 (s-entry (format "^\\(%s(\\)\\|\\(%s%s(diary-remind\\)" sexp-mark
1360 (regexp-quote diary-nonmarking-symbol
)
1362 (file-glob-attrs (nth 1 (diary-pull-attrs nil
'())))
1363 m y first-date last-date date mark file-glob-attrs
1364 sexp-start sexp entry entry-start
)
1365 (with-current-buffer calendar-buffer
1366 (setq m displayed-month
1368 (calendar-increment-month m y -
1)
1369 (setq first-date
(calendar-absolute-from-gregorian (list m
1 y
)))
1370 (calendar-increment-month m y
2)
1372 (calendar-absolute-from-gregorian
1373 (list m
(calendar-last-day-of-month m y
) y
)))
1374 (goto-char (point-min))
1375 (while (re-search-forward s-entry nil t
)
1376 (setq diary-marking-entry-flag
(char-equal (preceding-char) ?\
())
1377 (re-search-backward "(")
1378 (setq sexp-start
(point))
1380 (setq sexp
(buffer-substring-no-properties sexp-start
(point)))
1382 (if (and (bolp) (not (looking-at "[ \t]")))
1383 ;; Diary entry consists only of the sexp.
1387 (setq entry-start
(point))
1388 ;; Find end of entry.
1390 (while (looking-at "[ \t]")
1392 (if (bolp) (backward-char 1))
1393 (setq entry
(buffer-substring-no-properties entry-start
(point))))
1394 (setq date
(1- first-date
))
1395 ;; FIXME this loops over all visible dates.
1396 ;; Could be optimized in many cases. Depends on whether t or * present.
1397 (while (<= (setq date
(1+ date
)) last-date
)
1398 (when (setq mark
(diary-sexp-entry
1400 (calendar-gregorian-from-absolute date
)))
1401 (calendar-mark-visible-date
1402 (calendar-gregorian-from-absolute date
)
1403 (or (cadr (diary-pull-attrs entry file-glob-attrs
))
1404 (if (consp mark
) (car mark
)))))))))
1406 (define-obsolete-function-alias 'mark-sexp-diary-entries
1407 'diary-mark-sexp-entries
"23.1")
1409 (defun diary-mark-included-diary-files ()
1410 "Mark the diary entries from other diary files with those of the diary file.
1411 This function is suitable for use with `diary-mark-entries-hook'; it enables
1412 you to use shared diary files together with your own. The files included are
1413 specified in the `diary-file' by lines of this form:
1414 #include \"filename\"
1415 This is recursive; that is, #include directives in diary files thus included
1416 are obeyed. You can change the `#include' to some other string by changing
1417 the variable `diary-include-string'."
1418 (goto-char (point-min))
1419 (while (re-search-forward
1420 (format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string
))
1422 (let* ((diary-file (match-string-no-properties 1))
1423 (diary-mark-entries-hook 'diary-mark-included-diary-files
)
1424 (dbuff (find-buffer-visiting diary-file
)))
1425 (if (file-exists-p diary-file
)
1426 (if (file-readable-p diary-file
)
1428 (diary-mark-entries)
1430 (kill-buffer (find-buffer-visiting diary-file
))))
1432 (message "Can't read included diary file %s" diary-file
)
1435 (message "Can't find included diary file %s" diary-file
)
1437 (goto-char (point-min)))
1439 (define-obsolete-function-alias 'mark-included-diary-files
1440 'diary-mark-included-diary-files
"23.1")
1442 (defun calendar-mark-days-named (dayname &optional color
)
1443 "Mark all dates in the calendar window that are day DAYNAME of the week.
1444 0 means all Sundays, 1 means all Mondays, and so on.
1445 Optional argument COLOR is passed to `calendar-mark-visible-date' as MARK."
1446 (with-current-buffer calendar-buffer
1447 (let ((prev-month displayed-month
)
1448 (prev-year displayed-year
)
1449 (succ-month displayed-month
)
1450 (succ-year displayed-year
)
1453 (calendar-increment-month succ-month succ-year
1)
1454 (calendar-increment-month prev-month prev-year -
1)
1455 (setq day
(calendar-absolute-from-gregorian
1456 (calendar-nth-named-day 1 dayname prev-month prev-year
))
1457 last-day
(calendar-absolute-from-gregorian
1458 (calendar-nth-named-day -
1 dayname succ-month succ-year
)))
1459 (while (<= day last-day
)
1460 (calendar-mark-visible-date (calendar-gregorian-from-absolute day
)
1462 (setq day
(+ day
7))))))
1464 (define-obsolete-function-alias 'mark-calendar-days-named
1465 'calendar-mark-days-named
"23.1")
1467 (defun calendar-mark-month (month year p-month p-day p-year
&optional color
)
1468 "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P-DAY/P-YEAR.
1469 A value of 0 in any position of the pattern is a wildcard.
1470 Optional argument COLOR is passed to `calendar-mark-visible-date' as MARK."
1471 (if (or (and (= month p-month
)
1472 (or (zerop p-year
) (= year p-year
)))
1473 (and (zerop p-month
)
1474 (or (zerop p-year
) (= year p-year
))))
1476 (dotimes (i (calendar-last-day-of-month month year
))
1477 (calendar-mark-visible-date (list month
(1+ i
) year
) color
))
1478 (calendar-mark-visible-date (list month p-day year
) color
))))
1480 (define-obsolete-function-alias 'mark-calendar-month
1481 'calendar-mark-month
"23.1")
1483 (defun calendar-mark-date-pattern (month day year
&optional color
)
1484 "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
1485 A value of 0 in any position is a wildcard. Optional argument COLOR is
1486 passed to `calendar-mark-visible-date' as MARK."
1487 (with-current-buffer calendar-buffer
1488 (let ((m displayed-month
)
1490 (calendar-increment-month m y -
1)
1492 (calendar-mark-month m y month day year color
)
1493 (calendar-increment-month m y
1)))))
1495 (define-obsolete-function-alias 'mark-calendar-date-pattern
1496 'calendar-mark-date-pattern
"23.1")
1498 ;; Bahai, Hebrew, Islamic.
1499 (defun calendar-mark-complex (month day year fromabs
&optional color
)
1500 "Mark dates in the calendar conforming to MONTH DAY YEAR of some system.
1501 The function FROMABS converts absolute dates to the appropriate date system.
1502 Optional argument COLOR is passed to `calendar-mark-visible-date' as MARK."
1503 ;; Not one of the simple cases--check all visible dates for match.
1504 ;; Actually, the following code takes care of ALL of the cases, but
1505 ;; it's much too slow to be used for the simple (common) cases.
1506 (let* ((m displayed-month
)
1509 (calendar-increment-month m y -
1)
1510 (calendar-absolute-from-gregorian (list m
1 y
))))
1512 (calendar-increment-month m y
2)
1513 (calendar-absolute-from-gregorian
1514 (list m
(calendar-last-day-of-month m y
) y
))))
1515 (date (1- first-date
))
1517 (while (<= (setq date
(1+ date
)) last-date
)
1518 (setq local-date
(funcall fromabs date
))
1519 (and (or (zerop month
)
1520 (= month
(calendar-extract-month local-date
)))
1522 (= day
(calendar-extract-day local-date
)))
1524 (= year
(calendar-extract-year local-date
)))
1525 (calendar-mark-visible-date
1526 (calendar-gregorian-from-absolute date
) color
)))))
1529 (defun calendar-mark-1 (month day year fromabs toabs
&optional color
)
1530 "Mark dates in the calendar conforming to MONTH DAY YEAR of some system.
1531 The function FROMABS converts absolute dates to the appropriate date system.
1532 The function TOABS carries out the inverse operation. Optional argument
1533 COLOR is passed to `calendar-mark-visible-date' as MARK."
1534 (with-current-buffer calendar-buffer
1535 (if (and (not (zerop month
)) (not (zerop day
)))
1536 (if (not (zerop year
))
1537 ;; Fully specified date.
1538 (let ((date (calendar-gregorian-from-absolute
1539 (funcall toabs
(list month day year
)))))
1540 (if (calendar-date-is-visible-p date
)
1541 (calendar-mark-visible-date date color
)))
1542 ;; Month and day in any year--this taken from the holiday stuff.
1543 (let* ((i-date (funcall fromabs
1544 (calendar-absolute-from-gregorian
1545 (list displayed-month
15 displayed-year
))))
1546 (m (calendar-extract-month i-date
))
1547 (y (calendar-extract-year i-date
))
1549 (unless (< m
1) ; calendar doesn't apply
1550 (calendar-increment-month m y
(- 10 month
))
1551 (and (> m
7) ; date might be visible
1552 (calendar-date-is-visible-p
1553 (setq date
(calendar-gregorian-from-absolute
1554 (funcall toabs
(list month day y
)))))
1555 (calendar-mark-visible-date date color
)))))
1556 (calendar-mark-complex month day year
1557 'calendar-bahai-from-absolute color
))))
1560 (defun diary-entry-time (s)
1561 "Return time at the beginning of the string S as a military-style integer.
1562 For example, returns 1325 for 1:25pm.
1564 Returns `diary-unknown-time' (default value -9999) if no time is recognized.
1565 The recognized forms are XXXX, X:XX, or XX:XX (military time), and XXam,
1566 XXAM, XXpm, XXPM, XX:XXam, XX:XXAM, XX:XXpm, or XX:XXPM. A period (.) can
1567 be used instead of a colon (:) to separate the hour and minute parts."
1568 (let (case-fold-search)
1569 (cond ((string-match ; military time
1570 "\\`[ \t\n]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)"
1572 (+ (* 100 (string-to-number (match-string 1 s
)))
1573 (string-to-number (match-string 2 s
))))
1574 ((string-match ; hour only (XXam or XXpm)
1575 "\\`[ \t\n]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s
)
1576 (+ (* 100 (%
(string-to-number (match-string 1 s
)) 12))
1577 (if (equal ?a
(downcase (aref s
(match-beginning 2))))
1579 ((string-match ; hour and minute (XX:XXam or XX:XXpm)
1580 "\\`[ \t\n]*\\([0-9]?[0-9]\\)[:.]\\([0-9][0-9]\\)\\([ap]\\)m\\>" s
)
1581 (+ (* 100 (%
(string-to-number (match-string 1 s
)) 12))
1582 (string-to-number (match-string 2 s
))
1583 (if (equal ?a
(downcase (aref s
(match-beginning 3))))
1585 (t diary-unknown-time
)))) ; unrecognizable
1587 (defun diary-entry-compare (e1 e2
)
1588 "Return t if E1 is earlier than E2."
1589 (or (calendar-date-compare e1 e2
)
1590 (and (calendar-date-equal (car e1
) (car e2
))
1591 (let* ((ts1 (cadr e1
)) (t1 (diary-entry-time ts1
))
1592 (ts2 (cadr e2
)) (t2 (diary-entry-time ts2
)))
1595 (string-lessp ts1 ts2
)))))))
1597 (defun diary-sort-entries ()
1598 "Sort the list of diary entries by time of day.
1599 If you add this function to `diary-list-entries-hook', it should
1600 be the last item in the hook, in case earlier items add diary
1601 entries, or change the order."
1602 (setq diary-entries-list
(sort diary-entries-list
'diary-entry-compare
)))
1604 (define-obsolete-function-alias 'sort-diary-entries
'diary-sort-entries
"23.1")
1607 (defun diary-list-sexp-entries (date)
1608 "Add sexp entries for DATE from the diary file to `diary-entries-list'.
1609 Also, make them visible in the diary. Returns t if any entries are found.
1611 Sexp diary entries must be prefaced by a `diary-sexp-entry-symbol'
1612 \(normally `%%'). The form of a sexp diary entry is
1616 Both ENTRY and DATE are available when the SEXP is evaluated. If
1617 the SEXP returns nil, the diary entry does not apply. If it
1618 returns a non-nil value, ENTRY will be taken to apply to DATE; if
1619 the value is a string, that string will be the diary entry in the
1620 fancy diary display.
1622 For example, the following diary entry will apply to the 21st of
1623 the month if it is a weekday and the Friday before if the 21st is
1626 &%%(let ((dayname (calendar-day-of-week date))
1627 (day (calendar-extract-day date)))
1629 (and (= day 21) (memq dayname '(1 2 3 4 5)))
1630 (and (memq day '(19 20)) (= dayname 5)))
1631 ) UIUC pay checks deposited
1633 A number of built-in functions are available for this type of
1634 diary entry. In the following, the optional parameter MARK
1635 specifies a face or single-character string to use when
1636 highlighting the day in the calendar. For those functions that
1637 take MONTH, DAY, and YEAR as arguments, the order of the input
1638 parameters changes according to `calendar-date-style' (e.g. to
1639 DAY MONTH YEAR in the European style).
1641 %%(diary-date MONTH DAY YEAR &optional MARK) text
1642 Entry applies if date is MONTH, DAY, YEAR. DAY, MONTH, and YEAR can
1643 be a list of integers, `t' (meaning all values), or an integer.
1645 %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
1646 Entry will appear on the Nth DAYNAME after/before MONTH DAY.
1647 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
1648 If N>0, use the Nth DAYNAME after MONTH DAY.
1649 If N<0, use the Nth DAYNAME before MONTH DAY.
1650 DAY defaults to 1 if N>0, and MONTH's last day otherwise.
1651 MONTH can be a list of months, a single month, or `t' to
1654 %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
1655 Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
1658 %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
1659 Entry will appear on anniversary dates of MONTH DAY, YEAR.
1660 Text can contain `%d' or `%d%s'; `%d' will be replaced by the
1661 number of years since the MONTH DAY, YEAR, and `%s' by the
1662 ordinal ending of that number (i.e. `st', `nd', `rd' or `th',
1663 as appropriate). The anniversary of February 29 is
1664 considered to be March 1 in a non-leap year.
1666 %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text
1667 Entry will appear every N days, starting MONTH DAY, YEAR.
1668 Text can contain `%d' or `%d%s'; `%d' will be replaced by the
1669 number of repetitions since the MONTH DAY, YEAR and `%s' by
1670 the ordinal ending of that number (i.e. `st', `nd', `rd' or
1671 `th', as appropriate).
1673 %%(diary-remind SEXP DAYS &optional MARKING) text
1674 Entry is a reminder for diary sexp SEXP. DAYS is either a
1675 single number or a list of numbers indicating the number(s)
1676 of days before the event that the warning(s) should occur.
1677 A negative number -DAYS has the same meaning as a list (1 2 ... DAYS).
1678 If the current date is (one of) DAYS before the event indicated
1679 by EXPR, then a suitable message (as specified by
1680 `diary-remind-message') appears. In addition to the
1681 reminders beforehand, the diary entry also appears on the
1682 date itself. If optional MARKING is non-nil then the
1683 *reminders* are marked on the calendar. Marking of reminders
1684 is independent of whether the entry *itself* is a marking or
1687 %%(diary-hebrew-yahrzeit MONTH DAY YEAR) text
1688 Text is assumed to be the name of the person; the date is the
1689 date of death on the *civil* calendar. The diary entry will
1690 appear on the proper Hebrew-date anniversary and on the day
1693 All the remaining functions do not accept any text, and so only
1694 make sense with `diary-fancy-display'. Most produce output every day.
1696 `diary-day-of-year' - day of year and number of days remaining
1697 `diary-iso-date' - ISO commercial date
1698 `diary-astro-day-number' - astronomical (Julian) day number
1699 `diary-sunrise-sunset' - local times of sunrise and sunset
1701 These functions give the date in alternative calendrical systems:
1703 `diary-bahai-date', `diary-chinese-date', `diary-coptic-date',
1704 `diary-ethiopic-date', `diary-french-date', `diary-hebrew-date',
1705 `diary-islamic-date', `diary-julian-date', `diary-mayan-date',
1706 `diary-persian-date'
1708 Theses functions only produce output on certain dates:
1710 `diary-lunar-phases' - phases of moon (on the appropriate days)
1711 `diary-hebrew-omer' - Omer count, within 50 days after Passover
1712 `diary-hebrew-parasha' - weekly parasha, every Saturday
1713 `diary-hebrew-rosh-hodesh' - Rosh Hodesh, or the day or Saturday before
1714 `diary-hebrew-sabbath-candles' - local time of candle lighting, on Fridays
1717 Marking these entries is *extremely* time consuming, so it is
1718 best if they are non-marking."
1719 (let ((s-entry (format "^%s?%s(" (regexp-quote diary-nonmarking-symbol
)
1720 (regexp-quote diary-sexp-entry-symbol
)))
1721 entry-found file-glob-attrs marks
1722 sexp-start sexp entry specifier entry-start line-start
1723 diary-entry temp literal
)
1724 (goto-char (point-min))
1725 (setq file-glob-attrs
(nth 1 (diary-pull-attrs nil
'())))
1726 (while (re-search-forward s-entry nil t
)
1728 (setq sexp-start
(point))
1730 (setq sexp
(buffer-substring-no-properties sexp-start
(point))
1731 line-start
(line-end-position 0)
1733 (buffer-substring-no-properties (1+ line-start
) (point))
1734 entry-start
(1+ line-start
))
1736 (if (and (bolp) (not (looking-at "[ \t]")))
1737 ;; Diary entry consists only of the sexp.
1741 (setq entry-start
(point))
1743 (while (looking-at "[ \t]")
1746 (setq entry
(buffer-substring-no-properties entry-start
(point))))
1747 (setq diary-entry
(diary-sexp-entry sexp entry date
)
1748 literal entry
; before evaluation
1749 entry
(if (consp diary-entry
)
1753 (remove-overlays line-start
(point) 'invisible
'diary
)
1754 (if (< 0 (length entry
))
1755 (setq temp
(diary-pull-attrs entry file-glob-attrs
)
1757 marks
(nth 1 temp
))))
1758 (diary-add-to-list date entry specifier
1759 (if entry-start
(copy-marker entry-start
))
1761 (setq entry-found
(or entry-found diary-entry
)))
1764 (define-obsolete-function-alias 'list-sexp-diary-entries
1765 'diary-list-sexp-entries
"23.1")
1767 (defun diary-make-date (a b c
)
1768 "Convert A B C into the internal calendar date form.
1769 The expected order of the inputs depends on `calendar-date-style',
1770 e.g. in the European case, A = day, B = month, C = year. Returns
1771 a list (MONTH DAY YEAR), i.e. the American style, which is the
1772 form used internally by the calendar and diary."
1773 (cond ((eq calendar-date-style
'iso
) ; YMD
1775 ((eq calendar-date-style
'european
) ; DMY
1780 ;;; Sexp diary functions.
1785 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1786 (defun diary-date (month day year
&optional mark
)
1787 "Specific date(s) diary entry.
1788 Entry applies if date is MONTH, DAY, YEAR. Each parameter can be a
1789 list of integers, `t' (meaning all values), or an integer. The order
1790 of the input parameters changes according to `calendar-date-style'
1791 \(e.g. to DAY MONTH YEAR in the European style).
1793 An optional parameter MARK specifies a face or single-character string
1794 to use when highlighting the day in the calendar."
1795 (let* ((ddate (diary-make-date month day year
))
1796 (dd (calendar-extract-day ddate
))
1797 (mm (calendar-extract-month ddate
))
1798 (yy (calendar-extract-year ddate
))
1799 (m (calendar-extract-month date
))
1800 (y (calendar-extract-year date
))
1801 (d (calendar-extract-day date
)))
1803 (or (and (listp dd
) (memq d dd
))
1806 (or (and (listp mm
) (memq m mm
))
1809 (or (and (listp yy
) (memq y yy
))
1812 (cons mark entry
))))
1814 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1815 (defun diary-block (m1 d1 y1 m2 d2 y2
&optional mark
)
1817 Entry applies if date is between, or on one of, two dates. The order
1818 of the input parameters changes according to `calendar-date-style'
1819 \(e.g. to D1, M1, Y1, D2, M2, Y2 in the European style).
1821 An optional parameter MARK specifies a face or single-character string
1822 to use when highlighting the day in the calendar."
1823 (let ((date1 (calendar-absolute-from-gregorian
1824 (diary-make-date m1 d1 y1
)))
1825 (date2 (calendar-absolute-from-gregorian
1826 (diary-make-date m2 d2 y2
)))
1827 (d (calendar-absolute-from-gregorian date
)))
1828 (and (<= date1 d
) (<= d date2
)
1829 (cons mark entry
))))
1831 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1832 (defun diary-float (month dayname n
&optional day mark
)
1833 "Diary entry for the Nth DAYNAME after/before MONTH DAY.
1834 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
1835 If N>0, use the Nth DAYNAME after MONTH DAY.
1836 If N<0, use the Nth DAYNAME before MONTH DAY.
1837 DAY defaults to 1 if N>0, and MONTH's last day otherwise.
1838 MONTH can be a list of months, an integer, or `t' (meaning all months).
1839 Optional MARK specifies a face or single-character string to use when
1840 highlighting the day in the calendar."
1841 ;; This is messy because the diary entry may apply, but the date on which it
1842 ;; is based can be in a different month/year. For example, asking for the
1843 ;; first Monday after December 30. For large values of |n| the problem is
1845 (and (= dayname
(calendar-day-of-week date
))
1846 (let* ((m (calendar-extract-month date
))
1847 (d (calendar-extract-day date
))
1848 (y (calendar-extract-year date
))
1849 ;; Last (n>0) or first (n<0) possible base date for entry.
1851 (calendar-nth-named-absday (- n
) dayname m y d
))
1852 (last-abs (if (> n
0) limit
(+ limit
6)))
1853 (first-abs (if (> n
0) (- limit
6) limit
))
1854 (last (calendar-gregorian-from-absolute last-abs
))
1855 (first (calendar-gregorian-from-absolute first-abs
))
1856 ;; m1, d1 is first possible base date.
1857 (m1 (calendar-extract-month first
))
1858 (d1 (calendar-extract-day first
))
1859 (y1 (calendar-extract-year first
))
1860 ;; m2, d2 is last possible base date.
1861 (m2 (calendar-extract-month last
))
1862 (d2 (calendar-extract-day last
))
1863 (y2 (calendar-extract-year last
)))
1864 (if (or (and (= m1 m2
) ; only possible base dates in one month
1869 (let ((d (or day
(if (> n
0)
1871 (calendar-last-day-of-month m1 y1
)))))
1872 (and (<= d1 d
) (<= d d2
))))
1873 ;; Only possible base dates straddle two months.
1875 (and (= y1 y2
) (< m1 m2
)))
1877 ;; m1, d1 works as a base date.
1883 (<= d1
(or day
(if (> n
0)
1885 (calendar-last-day-of-month m1 y1
)))))
1886 ;; m2, d2 works as a base date.
1887 (and (or (eq month t
)
1891 (<= (or day
(if (> n
0)
1893 (calendar-last-day-of-month m2 y2
)))
1895 (cons mark entry
)))))
1897 (defun diary-ordinal-suffix (n)
1898 "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
1899 (if (or (memq (% n
100) '(11 12 13))
1902 (aref ["th" "st" "nd" "rd"] (% n
10))))
1904 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1905 (defun diary-anniversary (month day
&optional year mark
)
1906 "Anniversary diary entry.
1907 Entry applies if date is the anniversary of MONTH, DAY, YEAR.
1908 The order of the input parameters changes according to
1909 `calendar-date-style' (e.g. to DAY MONTH YEAR in the European style).
1911 The diary entry can contain `%d' or `%d%s'; the %d will be replaced
1912 by the number of years since the MONTH, DAY, YEAR, and the %s will
1913 be replaced by the ordinal ending of that number (that is, `st',
1914 `nd', `rd' or `th', as appropriate). The anniversary of February 29
1915 is considered to be March 1 in non-leap years.
1917 An optional parameter MARK specifies a face or single-character
1918 string to use when highlighting the day in the calendar."
1919 (let* ((ddate (diary-make-date month day year
))
1920 (dd (calendar-extract-day ddate
))
1921 (mm (calendar-extract-month ddate
))
1922 (yy (calendar-extract-year ddate
))
1923 (y (calendar-extract-year date
))
1924 (diff (if yy
(- y yy
) 100)))
1925 (and (= mm
2) (= dd
29) (not (calendar-leap-year-p y
))
1928 (and (> diff
0) (calendar-date-equal (list mm dd y
) date
)
1929 (cons mark
(format entry diff
(diary-ordinal-suffix diff
))))))
1931 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1932 (defun diary-cyclic (n month day year
&optional mark
)
1933 "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
1934 The order of the input parameters changes according to
1935 `calendar-date-style' (e.g. to N DAY MONTH YEAR in the European
1936 style). The entry can contain `%d' or `%d%s'; the %d will be
1937 replaced by the number of repetitions since the MONTH DAY YEAR,
1938 and %s by the ordinal ending of that number (that is, `st', `nd',
1939 `rd' or `th', as appropriate).
1941 An optional parameter MARK specifies a face or single-character
1942 string to use when highlighting the day in the calendar."
1944 (error "Day count must be positive"))
1945 (let* ((diff (- (calendar-absolute-from-gregorian date
)
1946 (calendar-absolute-from-gregorian
1947 (diary-make-date month day year
))))
1949 (and (>= diff
0) (zerop (% diff n
))
1950 (cons mark
(format entry cycle
(diary-ordinal-suffix cycle
))))))
1952 (defun diary-day-of-year ()
1953 "Day of year and number of days remaining in the year of date diary entry."
1954 (calendar-day-of-year-string date
))
1956 (defun diary-remind (sexp days
&optional marking
)
1957 "Provide a reminder of a diary entry.
1958 SEXP is a diary-sexp. DAYS is either a single number or a list
1959 of numbers indicating the number(s) of days before the event that
1960 the warning(s) should occur on. A negative number -DAYS has the
1961 same meaning as a list (1 2 ... DAYS). If the current date
1962 is (one of) DAYS before the event indicated by SEXP, then this function
1963 returns a suitable message (as specified by `diary-remind-message').
1965 In addition to the reminders beforehand, the diary entry also
1966 appears on the date itself.
1968 A `diary-nonmarking-symbol' at the beginning of the line of the
1969 `diary-remind' entry specifies that the diary entry (not the
1970 reminder) is non-marking. Marking of reminders is independent of
1971 whether the entry itself is a marking or nonmarking; if optional
1972 parameter MARKING is non-nil then the reminders are marked on the
1974 ;; `date' has a value at this point, from diary-sexp-entry.
1975 ;; Convert a negative number to a list of days.
1976 (and (integerp days
)
1978 (setq days
(number-sequence 1 (- days
))))
1979 (let ((diary-entry (eval sexp
)))
1981 ;; Diary entry applies on date.
1983 (or (not diary-marking-entries-flag
) diary-marking-entry-flag
))
1985 ;; Diary entry may apply to `days' before date.
1986 ((and (integerp days
)
1987 (not diary-entry
) ; diary entry does not apply to date
1988 (or (not diary-marking-entries-flag
) marking
))
1989 ;; Adjust date, and re-evaluate.
1990 (let ((date (calendar-gregorian-from-absolute
1991 (+ (calendar-absolute-from-gregorian date
) days
))))
1992 (when (setq diary-entry
(eval sexp
))
1993 ;; Discard any mark portion from diary-anniversary, etc.
1994 (if (consp diary-entry
) (setq diary-entry
(cdr diary-entry
)))
1995 (mapconcat 'eval diary-remind-message
""))))
1996 ;; Diary entry may apply to one of a list of days before date.
1997 ((and (listp days
) days
)
1998 (or (diary-remind sexp
(car days
) marking
)
1999 (diary-remind sexp
(cdr days
) marking
))))))
2002 ;;; Diary insertion functions.
2005 (defun diary-make-entry (string &optional nonmarking file
)
2006 "Insert a diary entry STRING which may be NONMARKING in FILE.
2007 If omitted, NONMARKING defaults to nil and FILE defaults to
2009 (let ((pop-up-frames (or pop-up-frames
2010 (window-dedicated-p (selected-window)))))
2011 (find-file-other-window (or file diary-file
)))
2012 (when (eq major-mode
(default-value 'major-mode
)) (diary-mode))
2014 (diary-unhide-everything)
2015 (goto-char (point-max))
2016 (when (let ((case-fold-search t
))
2017 (search-backward "Local Variables:"
2018 (max (- (point-max) 3000) (point-min))
2025 (if nonmarking diary-nonmarking-symbol
"")
2029 (define-obsolete-function-alias 'make-diary-entry
'diary-make-entry
"23.1")
2032 (defun diary-insert-entry (arg &optional event
)
2033 "Insert a diary entry for the date indicated by point.
2034 Prefix argument ARG makes the entry nonmarking."
2036 (list current-prefix-arg last-nonmenu-event
))
2037 (diary-make-entry (calendar-date-string (calendar-cursor-to-date t event
) t t
)
2041 (define-obsolete-function-alias 'insert-diary-entry
'diary-insert-entry
"23.1")
2044 (defun diary-insert-weekly-entry (arg)
2045 "Insert a weekly diary entry for the day of the week indicated by point.
2046 Prefix argument ARG makes the entry nonmarking."
2048 (diary-make-entry (calendar-day-name (calendar-cursor-to-date t
))
2052 (define-obsolete-function-alias 'insert-weekly-diary-entry
2053 'diary-insert-weekly-entry
"23.1")
2055 (defun diary-date-display-form (&optional type
)
2056 "Return value for `calendar-date-display-form' using `calendar-date-style'.
2057 Optional symbol TYPE is either `monthly' or `yearly'."
2058 (cond ((eq type
'monthly
) (cond ((eq calendar-date-style
'iso
)
2059 '((format "*-*-%.2d"
2060 (string-to-number day
))))
2061 ((eq calendar-date-style
'european
)
2064 ((eq type
'yearly
) (cond ((eq calendar-date-style
'iso
)
2065 '((format "*-%.2d-%.2d"
2066 (string-to-number month
)
2067 (string-to-number day
))))
2068 ((eq calendar-date-style
'european
)
2069 '(day " " monthname
))
2070 (t '(monthname " " day
))))
2071 ;; Iso cannot contain "-", because this form used eg by
2072 ;; insert-anniversary-diary-entry.
2073 (t (cond ((eq calendar-date-style
'iso
)
2074 '((format "%s %.2d %.2d" year
2075 (string-to-number month
) (string-to-number day
))))
2076 ((eq calendar-date-style
'european
)
2077 '(day " " month
" " year
))
2078 (t '(month " " day
" " year
))))))
2080 (defun diary-insert-entry-1 (&optional type nomark months symbol absfunc
)
2081 "Subroutine to insert a diary entry related to the date at point.
2082 TYPE is the type of entry (`monthly' or `yearly'). NOMARK non-nil
2083 means make the entry non-marking. Array MONTHS is used in place
2084 of `calendar-month-name-array'. String SYMBOL marks the type of
2085 diary entry. Function ABSFUNC converts absolute dates to dates of
2086 the appropriate type."
2087 (let ((calendar-date-display-form (if type
2088 (diary-date-display-form type
)
2089 calendar-date-display-form
))
2090 (calendar-month-name-array (or months calendar-month-name-array
))
2091 (date (calendar-cursor-to-date t
)))
2093 (format "%s%s" (or symbol
"")
2094 (calendar-date-string
2096 (funcall absfunc
(calendar-absolute-from-gregorian date
))
2103 (defun diary-insert-monthly-entry (arg)
2104 "Insert a monthly diary entry for the day of the month indicated by point.
2105 Prefix argument ARG makes the entry nonmarking."
2107 (diary-insert-entry-1 'monthly arg
))
2110 (define-obsolete-function-alias 'insert-monthly-diary-entry
2111 'diary-insert-monthly-entry
"23.1")
2114 (defun diary-insert-yearly-entry (arg)
2115 "Insert an annual diary entry for the day of the year indicated by point.
2116 Prefix argument ARG makes the entry nonmarking."
2118 (diary-insert-entry-1 'yearly arg
))
2121 (define-obsolete-function-alias 'insert-yearly-diary-entry
2122 'diary-insert-yearly-entry
"23.1")
2125 (defun diary-insert-anniversary-entry (arg)
2126 "Insert an anniversary diary entry for the date given by point.
2127 Prefix argument ARG makes the entry nonmarking."
2129 (let ((calendar-date-display-form (diary-date-display-form)))
2131 (format "%s(diary-anniversary %s)"
2132 diary-sexp-entry-symbol
2133 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
2137 (define-obsolete-function-alias 'insert-anniversary-diary-entry
2138 'diary-insert-anniversary-entry
"23.1")
2141 (defun diary-insert-block-entry (arg)
2142 "Insert a block diary entry for the days between the point and marked date.
2143 Prefix argument ARG makes the entry nonmarking."
2145 (let ((calendar-date-display-form (diary-date-display-form))
2146 (cursor (calendar-cursor-to-date t
))
2147 (mark (or (car calendar-mark-ring
)
2148 (error "No mark set in this buffer")))
2150 (if (< (calendar-absolute-from-gregorian mark
)
2151 (calendar-absolute-from-gregorian cursor
))
2157 (format "%s(diary-block %s %s)"
2158 diary-sexp-entry-symbol
2159 (calendar-date-string start nil t
)
2160 (calendar-date-string end nil t
))
2164 (define-obsolete-function-alias 'insert-block-diary-entry
2165 'diary-insert-block-entry
"23.1")
2168 (defun diary-insert-cyclic-entry (arg)
2169 "Insert a cyclic diary entry starting at the date given by point.
2170 Prefix argument ARG makes the entry nonmarking."
2172 (let ((calendar-date-display-form (diary-date-display-form)))
2174 (format "%s(diary-cyclic %d %s)"
2175 diary-sexp-entry-symbol
2176 (calendar-read "Repeat every how many days: "
2177 (lambda (x) (> x
0)))
2178 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
2182 (define-obsolete-function-alias 'insert-cyclic-diary-entry
2183 'diary-insert-cyclic-entry
"23.1")
2187 (defun diary-redraw-calendar ()
2188 "If `calendar-buffer' is live and diary entries are marked, redraw it."
2189 (and calendar-mark-diary-entries-flag
2192 ;; Return value suitable for `write-contents-functions'.
2195 (defvar diary-mode-map
2196 (let ((map (make-sparse-keymap)))
2197 (define-key map
"\C-c\C-s" 'diary-show-all-entries
)
2198 (define-key map
"\C-c\C-q" 'quit-window
)
2200 "Keymap for `diary-mode'.")
2202 (defun diary-font-lock-sexps (limit)
2203 "Recognize sexp diary entry up to LIMIT for font-locking."
2204 (if (re-search-forward
2205 (format "^%s?\\(%s\\)" (regexp-quote diary-nonmarking-symbol
)
2206 (regexp-quote diary-sexp-entry-symbol
))
2210 (narrow-to-region (point-min) limit
)
2211 (let ((start (point)))
2213 (store-match-data (list start
(point)))
2217 (defun diary-font-lock-date-forms (month-array &optional symbol abbrev-array
)
2218 "Create font-lock patterns for `diary-date-forms' using MONTH-ARRAY.
2219 If given, optional SYMBOL must be a prefix to entries.
2220 If optional ABBREV-ARRAY is present, the abbreviations constructed
2221 from this array by the function `calendar-abbrev-construct' are
2222 matched (with or without a final `.'), in addition to the full month
2224 (let ((dayname (diary-name-pattern calendar-day-name-array
2225 calendar-day-abbrev-array t
))
2226 (monthname (format "\\(%s\\|\\*\\)"
2227 (diary-name-pattern month-array abbrev-array
)))
2228 (month "\\([0-9]+\\|\\*\\)")
2229 (day "\\([0-9]+\\|\\*\\)")
2230 (year "-?\\([0-9]+\\|\\*\\)"))
2233 (concat "^" (regexp-quote diary-nonmarking-symbol
) "?"
2234 (if symbol
(regexp-quote symbol
) "") "\\("
2236 ;; If backup, omit first item (backup)
2237 ;; and last item (not part of date).
2238 (if (equal (car x
) 'backup
)
2239 (nreverse (cdr (reverse (cdr x
))))
2242 ;; With backup, last item is not part of date.
2243 (if (equal (car x
) 'backup
)
2244 (concat "\\)" (eval (car (reverse x
))))
2249 (defmacro diary-font-lock-keywords-1
(markfunc listfunc feature months symbol
)
2250 "Subroutine of the function `diary-font-lock-keywords'.
2251 If MARKFUNC is a member of `diary-nongregorian-marking-hook', or
2252 LISTFUNC of `diary-nongregorian-listing-hook', then require FEATURE and
2253 return a font-lock pattern matching array of MONTHS and marking SYMBOL."
2254 `(when (or (memq ',markfunc diary-nongregorian-marking-hook
)
2255 (memq ',listfunc diary-nongregorian-listing-hook
))
2257 (diary-font-lock-date-forms ,months
,symbol
)))
2259 (defconst diary-time-regexp
2260 ;; Accepted formats: 10:00 10.00 10h00 10h 10am 10:00am 10.00am
2261 ;; Use of "." as a separator annoyingly matches numbers, eg "123.45".
2262 ;; Hence often prefix this with "\\(^\\|\\s-\\)."
2263 (concat "[0-9]?[0-9]\\([AaPp][mM]\\|\\("
2264 "[Hh]\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]"
2265 "\\)\\([AaPp][Mm]\\)?\\)")
2266 "Regular expression matching a time of day.")
2268 (defvar calendar-hebrew-month-name-array-leap-year
)
2269 (defvar calendar-islamic-month-name-array
)
2270 (defvar calendar-bahai-month-name-array
)
2273 (defun diary-font-lock-keywords ()
2274 "Return a value for the variable `diary-font-lock-keywords'."
2276 (diary-font-lock-date-forms calendar-month-name-array
2277 nil calendar-month-abbrev-array
)
2278 (diary-font-lock-keywords-1 diary-hebrew-mark-entries
2279 diary-hebrew-list-entries
2281 calendar-hebrew-month-name-array-leap-year
2282 diary-hebrew-entry-symbol
)
2283 (diary-font-lock-keywords-1 diary-islamic-mark-entries
2284 diary-islamic-list-entries
2286 calendar-islamic-month-name-array
2287 diary-islamic-entry-symbol
)
2288 (diary-font-lock-keywords-1 diary-bahai-mark-entries
2289 diary-bahai-list-entries
2291 calendar-bahai-month-name-array
2292 diary-bahai-entry-symbol
)
2295 (format "^%s.*$" (regexp-quote diary-include-string
))
2296 'font-lock-keyword-face
)
2298 (format "^%s?\\(%s\\)" (regexp-quote diary-nonmarking-symbol
)
2299 (regexp-quote diary-sexp-entry-symbol
))
2300 '(1 font-lock-reference-face
))
2302 (format "^%s" (regexp-quote diary-nonmarking-symbol
))
2303 'font-lock-reference-face
)
2305 (format "^%s?%s" (regexp-quote diary-nonmarking-symbol
)
2306 (regexp-opt (mapcar 'regexp-quote
2307 (list diary-hebrew-entry-symbol
2308 diary-islamic-entry-symbol
2309 diary-bahai-entry-symbol
))
2311 '(1 font-lock-reference-face
))
2312 '(diary-font-lock-sexps . font-lock-keyword-face
)
2313 `(,(format "\\(^\\|\\s-\\)%s\\(-%s\\)?" diary-time-regexp
2317 (defvar diary-font-lock-keywords
(diary-font-lock-keywords)
2318 "Forms to highlight in `diary-mode'.")
2321 (define-derived-mode diary-mode fundamental-mode
"Diary"
2322 "Major mode for editing the diary file."
2323 (set (make-local-variable 'font-lock-defaults
)
2324 '(diary-font-lock-keywords t
))
2325 (add-to-invisibility-spec '(diary . nil
))
2326 (add-hook 'after-save-hook
'diary-redraw-calendar nil t
)
2327 (if diary-header-line-flag
2328 (setq header-line-format diary-header-line-format
)))
2331 ;;; Fancy Diary Mode.
2333 (defvar diary-fancy-date-pattern
2335 (let ((dayname (diary-name-pattern calendar-day-name-array nil t
))
2336 (monthname (diary-name-pattern calendar-month-name-array nil t
))
2340 (mapconcat 'eval calendar-date-display-form
""))
2341 ;; Optional ": holiday name" after the date.
2343 "Regular expression matching a date header in Fancy Diary.")
2345 (define-obsolete-variable-alias 'fancy-diary-font-lock-keywords
2346 'diary-fancy-font-lock-keywords
"23.1")
2348 (defvar diary-fancy-font-lock-keywords
2351 ;; Any number of " other holiday name" lines, followed by "==" line.
2352 (concat diary-fancy-date-pattern
"\\(\n +.*\\)*\n=+$")
2353 '(0 (progn (put-text-property (match-beginning 0) (match-end 0)
2354 'font-lock-multiline t
)
2356 '("^.*\\([aA]nniversary\\|[bB]irthday\\).*$" .
'diary-anniversary
)
2357 '("^.*Yahrzeit.*$" . font-lock-reference-face
)
2358 '("^\\(Erev \\)?Rosh Hodesh.*" . font-lock-function-name-face
)
2359 '("^Day.*omer.*$" . font-lock-builtin-face
)
2360 '("^Parashat.*$" . font-lock-comment-face
)
2361 `(,(format "\\(^\\|\\s-\\)%s\\(-%s\\)?" diary-time-regexp
2362 diary-time-regexp
) .
'diary-time
))
2363 "Keywords to highlight in fancy diary display.")
2365 ;; If region looks like it might start or end in the middle of a
2366 ;; multiline pattern, extend the region to encompass the whole pattern.
2367 (defun diary-fancy-font-lock-fontify-region-function (beg end
&optional verbose
)
2368 "Function to use for `font-lock-fontify-region-function' in Fancy Diary.
2369 Needed to handle multiline keyword in `diary-fancy-font-lock-keywords'.
2370 Fontify the region between BEG and END, quietly unless VERBOSE is non-nil."
2373 (if (looking-at "=+$") (forward-line -
1))
2374 (while (and (looking-at " +[^ ]")
2375 (zerop (forward-line -
1))))
2376 ;; This check not essential.
2377 (if (looking-at diary-fancy-date-pattern
)
2378 (setq beg
(line-beginning-position)))
2381 (while (and (looking-at " +[^ ]")
2382 (zerop (forward-line 1))))
2383 (if (looking-at "=+$")
2384 (setq end
(line-beginning-position 2)))
2385 (font-lock-default-fontify-region beg end verbose
))
2387 (defvar diary-fancy-overriding-map
(let ((map (make-sparse-keymap)))
2388 (define-key map
"q" 'quit-window
)
2390 "Keymap overriding minor-mode maps in `diary-fancy-display-mode'.")
2392 (define-derived-mode diary-fancy-display-mode fundamental-mode
2394 "Major mode used while displaying diary entries using Fancy Display."
2395 (set (make-local-variable 'font-lock-defaults
)
2396 '(diary-fancy-font-lock-keywords
2398 (font-lock-fontify-region-function
2399 . diary-fancy-font-lock-fontify-region-function
)))
2400 (local-set-key "q" 'quit-window
)
2401 (set (make-local-variable 'minor-mode-overriding-map-alist
)
2402 (list (cons t diary-fancy-overriding-map
)))
2405 (define-obsolete-function-alias 'fancy-diary-display-mode
2406 'diary-fancy-display-mode
"23.1")
2408 ;; Following code from Dave Love <fx@gnu.org>.
2409 ;; Import Outlook-format appointments from mail messages in Gnus or
2410 ;; Rmail using command `diary-from-outlook'. This, or the specialized
2411 ;; functions `diary-from-outlook-gnus' and `diary-from-outlook-rmail',
2412 ;; could be run from hooks to notice appointments automatically (in
2413 ;; which case they will prompt about adding to the diary). The
2414 ;; message formats recognized are customizable through
2415 ;; `diary-outlook-formats'.
2417 (defvar subject
) ; bound in diary-from-outlook-gnus
2420 (defun diary-from-outlook-internal (&optional test-only
)
2421 "Snarf a diary entry from a message assumed to be from MS Outlook.
2422 Assumes `body' is bound to a string comprising the body of the message and
2423 `subject' is bound to a string comprising its subject.
2424 Arg TEST-ONLY non-nil means return non-nil if and only if the
2425 message contains an appointment, don't make a diary entry."
2427 (let (format-string)
2428 (dotimes (i (length diary-outlook-formats
))
2429 (when (eq 0 (string-match (car (nth i diary-outlook-formats
))
2432 (setq format-string
(cdr (nth i diary-outlook-formats
)))
2434 (save-window-excursion
2435 ;; Fixme: References to optional fields in the format
2436 ;; are treated literally, not replaced by the empty
2437 ;; string. I think this is an Emacs bug.
2439 (format (replace-match (if (functionp format-string
)
2440 (funcall format-string body
)
2442 t nil
(match-string 0 body
))
2445 (throw 'finished t
))))
2448 (defvar gnus-article-mime-handles
)
2449 (defvar gnus-article-buffer
)
2451 (autoload 'gnus-fetch-field
"gnus-util")
2452 (autoload 'gnus-narrow-to-body
"gnus")
2453 (autoload 'mm-get-part
"mm-decode")
2455 (defun diary-from-outlook-gnus (&optional noconfirm
)
2456 "Maybe snarf diary entry from Outlook-generated message in Gnus.
2457 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2458 this function is called interactively), then if an entry is found the
2459 user is asked to confirm its addition.
2460 Add this function to `gnus-article-prepare-hook' to notice appointments
2463 (with-current-buffer gnus-article-buffer
2464 (let ((subject (gnus-fetch-field "subject"))
2465 (body (if gnus-article-mime-handles
2466 ;; We're multipart. Don't get confused by part
2467 ;; buttons &c. Assume info is in first part.
2468 (mm-get-part (nth 1 gnus-article-mime-handles
))
2470 (gnus-narrow-to-body)
2472 (when (diary-from-outlook-internal t
)
2473 (when (or noconfirm
(y-or-n-p "Snarf diary entry? "))
2474 (diary-from-outlook-internal)
2475 (message "Diary entry added"))))))
2477 (custom-add-option 'gnus-article-prepare-hook
'diary-from-outlook-gnus
)
2479 (defvar rmail-buffer
)
2481 (defun diary-from-outlook-rmail (&optional noconfirm
)
2482 "Maybe snarf diary entry from Outlook-generated message in Rmail.
2483 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2484 this function is called interactively), then if an entry is found the
2485 user is asked to confirm its addition."
2487 (with-current-buffer rmail-buffer
2488 (let ((subject (mail-fetch-field "subject"))
2489 (body (buffer-substring (save-excursion
2493 (when (diary-from-outlook-internal t
)
2494 (when (or noconfirm
(y-or-n-p "Snarf diary entry? "))
2495 (diary-from-outlook-internal)
2496 (message "Diary entry added"))))))
2498 (defun diary-from-outlook (&optional noconfirm
)
2499 "Maybe snarf diary entry from current Outlook-generated message.
2500 Currently knows about Gnus and Rmail modes. Unless the optional
2501 argument NOCONFIRM is non-nil (which is the case when this
2502 function is called interactively), then if an entry is found the
2503 user is asked to confirm its addition."
2506 ((eq major-mode
'rmail-mode
)
2507 #'diary-from-outlook-rmail
)
2508 ((memq major-mode
'(gnus-summary-mode gnus-article-mode
))
2509 #'diary-from-outlook-gnus
)
2510 (t (error "Don't know how to snarf in `%s'" major-mode
)))))
2511 (funcall func noconfirm
)))
2513 (provide 'diary-lib
)
2515 ;; arch-tag: 22dd506e-2e33-410d-9ae1-095a0c1b2010
2516 ;;; diary-lib.el ends here