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 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 (require 'diary-loaddefs
)
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
)
74 ;; Backward-compatibility alias. FIXME make obsolete.
75 (put 'diary-button-face
'face-alias
'diary-button
)
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-simple-display
155 "Function used to display the diary.
156 The default is `diary-simple-display'; `diary-fancy-display' is
159 For historical reasons, `nil' is the same as `diary-simple-display'
160 \(so you must use `ignore' for no display). Also for historical
161 reasons, this variable can be a list of functions to run. These
162 uses are not recommended and may be removed at some point.
164 When this function is called, the variable `diary-entries-list'
165 is a list, in order by date, of all relevant diary entries in the
166 form of ((MONTH DAY YEAR) STRING), where string is the diary
167 entry for the given date. This can be used, for example, to
168 produce a different buffer for display (perhaps combined with
169 holidays), or hard copy output."
170 :type
'(choice (const diary-simple-display
:tag
"Basic display")
171 (const diary-fancy-display
:tag
"Fancy display")
172 (const ignore
:tag
"No display")
173 (const nil
:tag
"Obsolete way to choose basic display")
174 (hook :tag
"Obsolete form with list of display functions"))
175 :initialize
'custom-initialize-default
176 :set
'diary-set-maybe-redraw
180 (define-obsolete-variable-alias 'list-diary-entries-hook
181 'diary-list-entries-hook
"23.1")
183 (defcustom diary-list-entries-hook nil
184 "List of functions called after diary file is culled for relevant entries.
185 You might wish to add `diary-include-other-diary-files', in which case
186 you will probably also want to add `diary-mark-included-diary-files' to
187 `diary-mark-entries-hook'. For example, you could use
189 (setq diary-display-function 'diary-fancy-display)
190 (add-hook 'diary-list-entries-hook 'diary-include-other-diary-files)
191 (add-hook 'diary-list-entries-hook 'diary-sort-entries)
193 in your `.emacs' file to cause the fancy diary buffer to be displayed with
194 diary entries from various included files, each day's entries sorted into
195 lexicographic order."
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
359 (find-buffer-visiting
360 (substitute-in-file-name diary-file
)))))
361 (custom-set-default symbol value
)
363 (not (equal value oldvalue
))
364 (with-current-buffer dbuff
365 (if (eq major-mode
'diary-mode
)
366 (setq header-line-format
(and diary-header-line-flag
367 diary-header-line-format
)))))))
369 ;; This can be removed once the kill/yank treatment of invisible text
370 ;; (see etc/TODO) is fixed. -- gm
371 (defcustom diary-header-line-flag t
372 "Non-nil means `diary-simple-display' will show a header line.
373 The format of the header is specified by `diary-header-line-format'."
376 :initialize
'custom-initialize-default
377 :set
'diary-set-header
380 (defvar diary-selective-display nil
381 "Internal diary variable; non-nil if some diary text is hidden.")
383 (defcustom diary-header-line-format
384 '(:eval
(calendar-string-spread
385 (list (if diary-selective-display
386 "Some text is hidden - press \"s\" in calendar \
390 "Format of the header line displayed by `diary-simple-display'.
391 Only used if `diary-header-line-flag' is non-nil."
394 :initialize
'custom-initialize-default
395 :set
'diary-set-header
398 ;; The first version of this also checked for diary-selective-display
399 ;; in the non-fancy case. This was an attempt to distinguish between
400 ;; displaying the diary and just visiting the diary file. However,
401 ;; when using fancy diary, calling diary when there are no entries to
402 ;; display does not create the fancy buffer, nor does it set
403 ;; diary-selective-display in the diary buffer. This means some
404 ;; customizations will not take effect, eg:
405 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00466.html
406 ;; So the check for diary-selective-display was dropped. This means the
407 ;; diary will be displayed if one customizes a diary variable while
408 ;; just visiting the diary-file. This is i) unlikely, and ii) no great loss.
410 (defun diary-live-p ()
411 "Return non-nil if the diary is being displayed."
412 (or (get-buffer diary-fancy-buffer
)
414 (find-buffer-visiting (substitute-in-file-name diary-file
)))))
417 (defun diary-set-maybe-redraw (symbol value
)
418 "Set SYMBOL's value to VALUE, and redraw the diary if necessary.
419 Redraws the diary if it is being displayed (note this is not the same as
420 just visiting the `diary-file'), and SYMBOL's value is to be changed."
421 (let ((oldvalue (symbol-value symbol
)))
422 (custom-set-default symbol value
)
423 (and (not (equal value oldvalue
))
425 ;; Note this assumes diary was called without prefix arg.
428 (define-obsolete-variable-alias 'number-of-diary-entries
429 'diary-number-of-entries
"23.1")
431 (defcustom diary-number-of-entries
1
432 "Specifies how many days of diary entries are to be displayed initially.
433 This variable affects the diary display when the command \\[diary] is
434 used, or if the value of the variable `calendar-view-diary-initially-flag'
435 is non-nil. For example, if the default value 1 is used, then only the
436 current day's diary entries will be displayed. If the value 2 is used,
437 then both the current day's and the next day's entries will be displayed.
439 The value can also be a vector such as [0 2 2 2 2 4 1]; this value says
440 to display no diary entries on Sunday, the entries for the current date
441 and the day after on Monday through Thursday, Friday through Monday's
442 entries on Friday, and only Saturday's entries on Saturday.
444 This variable does not affect the diary display with the `d' command
445 from the calendar; in that case, the prefix argument controls the number
446 of days of diary entries displayed."
447 :type
'(choice (integer :tag
"Entries")
448 (vector :value
[0 0 0 0 0 0 0]
449 (integer :tag
"Sunday")
450 (integer :tag
"Monday")
451 (integer :tag
"Tuesday")
452 (integer :tag
"Wednesday")
453 (integer :tag
"Thursday")
454 (integer :tag
"Friday")
455 (integer :tag
"Saturday")))
456 :initialize
'custom-initialize-default
457 :set
'diary-set-maybe-redraw
460 ;;; More user options in calendar.el, holidays.el.
463 (defun diary-check-diary-file ()
464 "Check that the file specified by `diary-file' exists and is readable.
465 If so, return the expanded file name, otherwise signal an error."
466 (let ((d-file (substitute-in-file-name diary-file
)))
467 (if (and d-file
(file-exists-p d-file
))
468 (if (file-readable-p d-file
)
470 (error "Diary file `%s' is not readable" diary-file
))
471 (error "Diary file `%s' does not exist" diary-file
))))
474 (defun diary (&optional arg
)
475 "Generate the diary window for ARG days starting with the current date.
476 If no argument is provided, the number of days of diary entries is governed
477 by the variable `diary-number-of-entries'. A value of ARG less than 1
478 does nothing. This function is suitable for execution in a `.emacs' file."
480 (diary-check-diary-file)
481 (diary-list-entries (calendar-current-date)
482 (if arg
(prefix-numeric-value arg
))))
485 (defun diary-view-entries (&optional arg
)
486 "Prepare and display a buffer with diary entries.
487 Searches the file named in `diary-file' for entries that match
488 ARG days starting with the date indicated by the cursor position
489 in the displayed three-month calendar."
491 (diary-check-diary-file)
492 (diary-list-entries (calendar-cursor-to-date t
) arg
))
494 (define-obsolete-function-alias 'view-diary-entries
'diary-view-entries
"22.1")
498 (defun diary-view-other-diary-entries (arg dfile
)
499 "Prepare and display buffer of diary entries from an alternative diary file.
500 Searches for entries that match ARG days, starting with the date indicated
501 by the cursor position in the displayed three-month calendar.
502 DFILE specifies the file to use as the diary file."
504 (list (prefix-numeric-value current-prefix-arg
)
505 (read-file-name "Enter diary file name: " default-directory nil t
)))
506 (let ((diary-file dfile
))
507 (diary-view-entries arg
)))
510 (define-obsolete-function-alias 'view-other-diary-entries
511 'diary-view-other-diary-entries
"23.1")
513 (defvar diary-syntax-table
514 (let ((st (copy-syntax-table (standard-syntax-table))))
515 (modify-syntax-entry ?
* "w" st
)
516 (modify-syntax-entry ?
: "w" st
)
518 "The syntax table used when parsing dates in the diary file.
519 It is the standard syntax table used in Fundamental mode, but with the
520 syntax of `*' and `:' changed to be word constituents.")
522 (defun diary-attrtype-convert (attrvalue type
)
523 "Convert string ATTRVALUE to TYPE appropriate for a face description.
524 Valid TYPEs are: string, symbol, int, stringtnil, tnil."
525 (cond ((eq type
'string
) attrvalue
)
526 ((eq type
'symbol
) (intern-soft attrvalue
))
527 ((eq type
'int
) (string-to-number attrvalue
))
528 ((eq type
'stringtnil
)
529 (cond ((string-equal "t" attrvalue
) t
)
530 ((string-equal "nil" attrvalue
) nil
)
532 ((eq type
'tnil
) (string-equal "t" attrvalue
))))
534 (defun diary-pull-attrs (entry fileglobattrs
)
535 "Search for matches for regexps from `diary-face-attrs'.
536 If ENTRY is nil, searches from the start of the current buffer, and
537 prepends all regexps with `diary-glob-file-regexp-prefix'.
538 If ENTRY is a string, search for matches in that string, and remove them.
539 Returns a list of ENTRY followed by (ATTRIBUTE VALUE) pairs.
540 When ENTRY is non-nil, FILEGLOBATTRS forms the start of the (ATTRIBUTE VALUE)
542 (let (regexp regnum attrname attrname attrvalue type ret-attr
)
545 (dolist (attr diary-face-attrs
)
546 ;; FIXME inefficient searching.
547 (goto-char (point-min))
548 (setq regexp
(concat diary-glob-file-regexp-prefix
(car attr
))
550 attrname
(nth 2 attr
)
552 attrvalue
(if (re-search-forward regexp nil t
)
553 (match-string-no-properties regnum
)))
555 (setq attrvalue
(diary-attrtype-convert attrvalue type
))
556 (setq ret-attr
(append ret-attr
557 (list attrname attrvalue
))))))
558 (setq ret-attr fileglobattrs
)
559 (dolist (attr diary-face-attrs
)
560 (setq regexp
(car attr
)
562 attrname
(nth 2 attr
)
565 ;; If multiple matches, replace all, use the last (which may
566 ;; be the first instance in the line, if the regexp is
568 (while (string-match regexp entry
)
569 (setq attrvalue
(match-string-no-properties regnum entry
)
570 entry
(replace-match "" t t entry
)))
572 (setq attrvalue
(diary-attrtype-convert attrvalue type
))
573 (setq ret-attr
(append ret-attr
(list attrname attrvalue
))))))
574 (list entry ret-attr
)))
578 (defvar diary-modify-entry-list-string-function nil
579 "Function applied to entry string before putting it into the entries list.
580 Can be used by programs integrating a diary list into other buffers (e.g.
581 org.el and planner.el) to modify the string or add properties to it.
582 The function takes a string argument and must return a string.")
584 (defvar diary-entries-list
) ; bound in diary-list-entries
586 (defun diary-add-to-list (date string specifier
&optional marker
588 "Add an entry to `diary-entries-list'.
589 Do nothing if DATE or STRING are nil. DATE is the (MONTH DAY
590 YEAR) for which the entry applies; STRING is the text of the
591 entry as it will appear in the diary (i.e. with any format
592 strings such as \"%d\" expanded); SPECIFIER is the date part of
593 the entry as it appears in the diary-file; LITERAL is the entry
594 as it appears in the diary-file (i.e. before expansion).
595 If LITERAL is nil, it is taken to be the same as STRING.
597 The entry is added to the list as (DATE STRING SPECIFIER LOCATOR
598 GLOBCOLOR), where LOCATOR has the form (MARKER FILENAME LITERAL),
599 FILENAME being the file containing the diary entry."
600 (when (and date string
)
601 (if diary-file-name-prefix
602 (let ((prefix (funcall diary-file-name-prefix-function
603 (buffer-file-name))))
604 (or (string-equal prefix
"")
605 (setq string
(format "[%s] %s" prefix string
)))))
606 (and diary-modify-entry-list-string-function
607 (setq string
(funcall diary-modify-entry-list-string-function
609 (setq diary-entries-list
610 (append diary-entries-list
611 (list (list date string specifier
612 (list marker
(buffer-file-name) literal
)
615 (define-obsolete-function-alias 'add-to-diary-list
'diary-add-to-list
"23.1")
617 (defun diary-list-entries-2 (date mark globattr list-only
618 &optional months symbol gdate
)
619 "Internal subroutine of `diary-list-entries'.
620 Find diary entries applying to DATE, by searching from point-min for
621 each element of `diary-date-forms'. MARK indicates an entry is non-marking.
622 GLOBATTR is the list of global file attributes. If LIST-ONLY is
623 non-nil, don't change the buffer, only return a list of entries.
624 Optional array MONTHS replaces `calendar-month-name-array', and
625 means months cannot be abbreviated. Optional string SYMBOL marks diary
626 entries of the desired type. If DATE is not Gregorian, then the
627 Gregorian equivalent should be provided via GDATE. Returns non-nil if
628 any entries were found."
629 (let* ((month (calendar-extract-month date
))
630 (day (calendar-extract-day date
))
631 (year (calendar-extract-year date
))
632 (dayname (format "%s\\|%s\\.?" (calendar-day-name date
)
633 (calendar-day-name date
'abbrev
)))
634 (calendar-month-name-array (or months calendar-month-name-array
))
635 (monthname (format "\\*\\|%s%s" (calendar-month-name month
)
638 (calendar-month-name month
'abbrev
)))))
639 (month (format "\\*\\|0*%d" month
))
640 (day (format "\\*\\|0*%d" day
))
641 (year (format "\\*\\|0*%d%s" year
642 (if diary-abbreviated-year-flag
643 (format "\\|%02d" (% year
100))
647 (dolist (date-form diary-date-forms
)
648 (let ((backup (when (eq (car date-form
) 'backup
)
649 (setq date-form
(cdr date-form
))
651 ;; date-form uses day etc as set above.
652 (regexp (format "^%s?%s\\(%s\\)" (regexp-quote mark
)
653 (if symbol
(regexp-quote symbol
) "")
654 (mapconcat 'eval date-form
"\\)\\(?:")))
655 entry-start date-start temp
)
656 (goto-char (point-min))
657 (while (re-search-forward regexp nil t
)
658 (if backup
(re-search-backward "\\<" nil t
))
659 ;; regexp moves us past the end of date, onto the next line.
660 ;; Trailing whitespace after date not allowed (see diary-file).
661 (if (and (bolp) (not (looking-at "[ \t]")))
662 ;; Diary entry that consists only of date.
664 ;; Found a nonempty diary entry--make it
665 ;; visible and add it to the list.
666 (setq date-start
(line-end-position 0))
667 ;; Actual entry starts on the next-line?
668 (if (looking-at "[ \t]*\n[ \t]") (forward-line 1))
672 (while (looking-at "[ \t]") ; continued entry
674 (unless (and (eobp) (not (bolp)))
677 (remove-overlays date-start
(point) 'invisible
'diary
))
678 (setq temp
(diary-pull-attrs
679 (buffer-substring-no-properties
680 entry-start
(point)) globattr
))
682 (or gdate date
) (car temp
)
683 (buffer-substring-no-properties (1+ date-start
) (1- entry-start
))
684 (copy-marker entry-start
) (cadr temp
))))))
687 (defvar original-date
) ; from diary-list-entries
688 (defvar file-glob-attrs
)
692 (defun diary-list-entries-1 (months symbol absfunc
)
693 "List diary entries of a certain type.
694 MONTHS is an array of month names. SYMBOL marks diary entries of the type
695 in question. ABSFUNC is a function that converts absolute dates to dates
696 of the appropriate type."
697 (let ((gdate original-date
))
698 (dotimes (idummy number
)
699 (diary-list-entries-2
700 (funcall absfunc
(calendar-absolute-from-gregorian gdate
))
701 diary-nonmarking-symbol file-glob-attrs list-only months symbol gdate
)
703 (calendar-gregorian-from-absolute
704 (1+ (calendar-absolute-from-gregorian gdate
))))))
705 (goto-char (point-min)))
707 ;; FIXME non-greg and list hooks run same number of times?
708 (defun diary-list-entries (date number
&optional list-only
)
709 "Create and display a buffer containing the relevant lines in `diary-file'.
710 The arguments are DATE and NUMBER; the entries selected are those
711 for NUMBER days starting with date DATE. The other entries are hidden
712 using overlays. If NUMBER is less than 1, this function does nothing.
714 Returns a list of all relevant diary entries found, if any, in order by date.
715 The list entries have the form ((MONTH DAY YEAR) STRING SPECIFIER) where
716 \(MONTH DAY YEAR) is the date of the entry, STRING is the entry text, and
717 SPECIFIER is the applicability. If the variable `diary-list-include-blanks'
718 is non-nil, this list includes a dummy diary entry consisting of the empty
719 string for a date with no diary entries.
721 After the list is prepared, the following hooks are run:
723 `diary-nongregorian-listing-hook' can cull dates from the diary
724 and each included file, for example to process Islamic diary
725 entries. Applied to *each* file.
727 `diary-list-entries-hook' adds or manipulates diary entries from
728 external sources. Used, for example, to include diary entries
729 from other files or to sort the diary entries. Invoked *once*
730 only, before the display hook is run.
732 `diary-hook' is run last, after the diary is displayed.
733 This is used e.g. by `appt-check'.
735 Functions called by these hooks may use the variables ORIGINAL-DATE
736 and NUMBER, which are the arguments with which this function was called.
737 Note that hook functions should _not_ use DATE, but ORIGINAL-DATE.
738 \(Sexp diary entries may use DATE - see `diary-list-sexp-entries'.)
740 This function displays the list using `diary-display-function', unless
741 LIST-ONLY is non-nil, in which case it just returns the list."
743 (setq number
(if (vectorp diary-number-of-entries
)
744 (aref diary-number-of-entries
(calendar-day-of-week date
))
745 diary-number-of-entries
)))
747 (let* ((original-date date
) ; save for possible use in the hooks
748 (date-string (calendar-date-string date
))
749 (d-file (substitute-in-file-name diary-file
))
750 (diary-buffer (find-buffer-visiting d-file
))
751 diary-entries-list file-glob-attrs
)
752 (message "Preparing diary...")
754 (if (not diary-buffer
)
755 (set-buffer (find-file-noselect d-file t
))
756 (set-buffer diary-buffer
)
757 (or (verify-visited-file-modtime diary-buffer
)
758 (revert-buffer t t
)))
759 ;; Setup things like the header-line-format and invisibility-spec.
760 (if (eq major-mode default-major-mode
)
762 ;; This kludge is to make customizations to
763 ;; diary-header-line-flag after diary has been displayed
764 ;; take effect. Unconditionally calling (diary-mode)
765 ;; clobbers file local variables.
766 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00363.html
767 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-04/msg00404.html
768 (if (eq major-mode
'diary-mode
)
769 (setq header-line-format
(and diary-header-line-flag
770 diary-header-line-format
))))
771 ;; d-s-p is passed to the diary display function.
772 (let ((diary-saved-point (point)))
774 (setq file-glob-attrs
(cadr (diary-pull-attrs nil
"")))
775 (with-syntax-table diary-syntax-table
776 (goto-char (point-min))
778 (let ((ol (make-overlay (point-min) (point-max) nil t nil
)))
779 (set (make-local-variable 'diary-selective-display
) t
)
780 (overlay-put ol
'invisible
'diary
)
781 (overlay-put ol
'evaporate t
)))
782 (dotimes (idummy number
)
783 (let ((sexp-found (diary-list-sexp-entries date
))
784 (entry-found (diary-list-entries-2
785 date diary-nonmarking-symbol
786 file-glob-attrs list-only
)))
787 (if diary-list-include-blanks
788 (or sexp-found entry-found
789 (diary-add-to-list date
"" "" "" "")))
791 (calendar-gregorian-from-absolute
792 (1+ (calendar-absolute-from-gregorian date
)))))))
793 (goto-char (point-min))
794 (run-hooks 'diary-nongregorian-listing-hook
795 'diary-list-entries-hook
)
797 (if (and diary-display-function
798 (listp diary-display-function
))
799 ;; Backwards compatibility.
800 (run-hooks 'diary-display-function
)
801 (funcall (or diary-display-function
802 'diary-simple-display
))))
803 (run-hooks 'diary-hook
)
804 diary-entries-list
))))))
806 (define-obsolete-function-alias 'list-diary-entries
'diary-list-entries
"22.1")
808 (defun diary-unhide-everything ()
809 "Show all invisible text in the diary."
810 (kill-local-variable 'diary-selective-display
)
811 (remove-overlays (point-min) (point-max) 'invisible
'diary
)
812 (kill-local-variable 'mode-line-format
))
814 (defvar original-date
) ; bound in diary-list-entries
817 (defun diary-include-other-diary-files ()
818 "Include the diary entries from other diary files with those of `diary-file'.
819 This function is suitable for use with `diary-list-entries-hook';
820 it enables you to use shared diary files together with your own.
821 The files included are specified in the `diary-file' by lines of this form:
822 #include \"filename\"
823 This is recursive; that is, #include directives in diary files thus included
824 are obeyed. You can change the `#include' to some other string by changing
825 the variable `diary-include-string'."
826 (goto-char (point-min))
827 (while (re-search-forward
828 (format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string
))
830 (let ((diary-file (substitute-in-file-name
831 (match-string-no-properties 1)))
832 (diary-list-include-blanks nil
)
833 (diary-list-entries-hook 'diary-include-other-diary-files
)
834 (diary-display-function 'ignore
)
836 (if (file-exists-p diary-file
)
837 (if (file-readable-p diary-file
)
839 (setq diary-entries-list
840 (append diary-entries-list
841 (diary-list-entries original-date number
)))
842 (with-current-buffer (find-buffer-visiting diary-file
)
843 (diary-unhide-everything)))
845 (message "Can't read included diary file %s" diary-file
)
848 (message "Can't find included diary file %s" diary-file
)
850 (goto-char (point-min)))
852 (define-obsolete-function-alias 'include-other-diary-files
853 'diary-include-other-diary-files
"23.1")
855 (defvar date-string
) ; bound in diary-list-entries
857 (defun diary-display-no-entries ()
858 "Common subroutine of `diary-simple-display' and `diary-fancy-display'.
859 Handles the case where there are no diary entries.
860 Returns a cons (NOENTRIES . HOLIDAY-STRING)."
861 (let* ((holiday-list (if diary-show-holidays-flag
862 (calendar-check-holidays original-date
)))
863 (hol-string (format "%s%s%s"
865 (if holiday-list
": " "")
866 (mapconcat 'identity holiday-list
"; ")))
867 (msg (format "No diary entries for %s" hol-string
))
868 ;; Empty list, or single item with no text.
869 ;; FIXME multiple items with no text?
870 (noentries (or (not diary-entries-list
)
871 (and (not (cdr diary-entries-list
))
872 (string-equal "" (cadr
873 (car diary-entries-list
)))))))
874 ;; Inconsistency: whether or not the holidays are displayed in a
875 ;; separate buffer depends on if there are diary entries.
877 (if (or (< (length msg
) (frame-width))
880 ;; holiday-list which is too wide for a message gets a buffer.
881 (calendar-in-read-only-buffer holiday-buffer
882 (calendar-set-mode-line (format "Holidays for %s" date-string
))
883 (insert (mapconcat 'identity holiday-list
"\n")))
884 (message "No diary entries for %s" date-string
)))
885 (cons noentries hol-string
)))
888 (defvar diary-saved-point
) ; bound in diary-list-entries
890 (defun diary-simple-display ()
891 "Display the diary buffer if there are any relevant entries or holidays.
892 Entries that do not apply are made invisible. Holidays are shown
893 in the mode line. This is an option for `diary-display-function'."
894 ;; If selected window is dedicated (to the calendar), need a new one
895 ;; to display the diary.
896 (let* ((pop-up-frames (or pop-up-frames
897 (window-dedicated-p (selected-window))))
898 (dbuff (find-buffer-visiting (substitute-in-file-name diary-file
)))
899 (empty (diary-display-no-entries)))
900 ;; This may be too wide, but when simple diary is used there is
901 ;; nowhere else for the holidays to go. Also, it is documented in
902 ;; diary-show-holidays-flag that the holidays go in the mode-line.
903 ;; FIXME however if there are no diary entries a separate buffer
904 ;; is displayed - this is inconsistent.
905 (with-current-buffer dbuff
906 (calendar-set-mode-line (format "Diary for %s" (cdr empty
))))
907 (unless (car empty
) ; no entries
908 (with-current-buffer dbuff
909 (let ((window (display-buffer (current-buffer))))
910 ;; d-s-p is passed from diary-list-entries.
911 (set-window-point window diary-saved-point
)
912 (set-window-start window
(point-min))))
913 (message "Preparing diary...done"))))
915 (define-obsolete-function-alias 'simple-diary-display
916 'diary-simple-display
"23.1")
918 (define-button-type 'diary-entry
919 'action
#'diary-goto-entry
922 (defun diary-goto-entry (button)
923 "Jump to the diary entry for the BUTTON at point."
924 (let* ((locator (button-get button
'locator
))
925 (marker (car locator
))
927 ;; If marker pointing to diary location is valid, use that.
928 (if (and marker
(setq markbuf
(marker-buffer marker
)))
930 (pop-to-buffer markbuf
)
931 (goto-char (marker-position marker
)))
932 ;; Marker is invalid (eg buffer has been killed).
933 (or (and (setq file
(cadr locator
))
935 (find-file-other-window file
)
937 (when (eq major-mode default-major-mode
) (diary-mode))
938 (goto-char (point-min))
939 (if (re-search-forward (format "%s.*\\(%s\\)"
940 (regexp-quote (nth 2 locator
))
941 (regexp-quote (nth 3 locator
)))
943 (goto-char (match-beginning 1)))))
944 (message "Unable to locate this diary entry")))))
946 (defun diary-fancy-display ()
947 "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
948 Holidays are shown unless `diary-show-holidays-flag' is nil.
949 Days with no diary entries are not shown (even if that day is a
950 holiday), unless `diary-list-include-blanks' is non-nil.
952 This is an option for `diary-display-function'."
953 ;; Turn off selective-display in the diary file's buffer.
955 (find-buffer-visiting (substitute-in-file-name diary-file
))
956 (diary-unhide-everything))
957 (unless (car (diary-display-no-entries)) ; no entries
958 ;; Prepare the fancy diary buffer.
959 (calendar-in-read-only-buffer diary-fancy-buffer
960 (calendar-set-mode-line "Diary Entries")
961 (let ((holiday-list-last-month 1)
962 (holiday-list-last-year 1)
965 (dolist (entry diary-entries-list
)
966 (unless (calendar-date-equal date
(car entry
))
967 (setq date
(car entry
))
968 (and diary-show-holidays-flag
969 (calendar-date-compare
970 (list (list holiday-list-last-month
971 (calendar-last-day-of-month
972 holiday-list-last-month
973 holiday-list-last-year
)
974 holiday-list-last-year
))
976 ;; We need to get the holidays for the next 3 months.
977 (setq holiday-list-last-month
978 (calendar-extract-month date
)
979 holiday-list-last-year
980 (calendar-extract-year date
))
982 (calendar-increment-month
983 holiday-list-last-month holiday-list-last-year
1)
986 (let ((displayed-month holiday-list-last-month
)
987 (displayed-year holiday-list-last-year
))
988 (calendar-holiday-list)))
989 (calendar-increment-month
990 holiday-list-last-month holiday-list-last-year
1))
992 date-holiday-list cc
)
993 ;; Make a list of all holidays for date.
994 (dolist (h holiday-list
)
995 (if (calendar-date-equal date
(car h
))
996 (setq date-holiday-list
(append date-holiday-list
998 (insert (if (bobp) "" ?
\n) (calendar-date-string date
))
999 (if date-holiday-list
(insert ": "))
1000 (setq cc
(current-column))
1001 (insert (mapconcat (lambda (x)
1002 (setq longest
(max longest
(length x
)))
1005 (concat "\n" (make-string cc ?\s
))))
1006 (insert ?
\n (make-string (+ cc longest
) ?
=) ?
\n)))
1007 (let ((this-entry (cadr entry
))
1008 this-loc marks temp-face
)
1009 (unless (zerop (length this-entry
))
1010 (if (setq this-loc
(nth 3 entry
))
1011 (insert-button (concat this-entry
"\n")
1012 ;; (MARKER FILENAME SPECIFIER LITERAL)
1013 'locator
(list (car this-loc
)
1016 (or (nth 2 this-loc
)
1019 (insert this-entry ?
\n))
1020 ;; Doesn't make sense to check font-lock-mode - see
1021 ;; comments above diary-entry-marker in calendar.el.
1022 (and ; font-lock-mode
1023 (setq marks
(nth 4 entry
))
1025 (setq temp-face
(calendar-make-temp-face marks
))
1026 (search-backward this-entry
)
1028 (make-overlay (match-beginning 0) (match-end 0))
1029 'face temp-face
)))))))
1030 (diary-fancy-display-mode)
1031 (calendar-set-mode-line date-string
)
1032 (message "Preparing diary...done"))))
1034 (define-obsolete-function-alias 'fancy-diary-display
1035 'diary-fancy-display
"23.1")
1038 (defun diary-print-entries ()
1039 "Print a hard copy of the diary display.
1041 If the simple diary display is being used, prepare a temp buffer with the
1042 visible lines of the diary buffer, add a heading line composed from the mode
1043 line, print the temp buffer, and destroy it.
1045 If the fancy diary display is being used, just print the buffer.
1047 The hooks given by the variable `diary-print-entries-hook' are called to do
1048 the actual printing."
1050 (let ((diary-buffer (get-buffer diary-fancy-buffer
))
1051 temp-buffer heading start end
)
1053 (with-current-buffer diary-buffer
1054 (run-hooks 'diary-print-entries-hook
))
1055 (or (setq diary-buffer
1056 (find-buffer-visiting (substitute-in-file-name diary-file
)))
1057 (error "You don't have a diary buffer!"))
1058 ;; Name affects printing?
1059 (setq temp-buffer
(get-buffer-create " *Printable Diary Entries*"))
1060 (with-current-buffer diary-buffer
1062 (if (not (stringp mode-line-format
))
1064 (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format
)
1065 (match-string 1 mode-line-format
))
1069 (setq end
(next-single-char-property-change start
'invisible
))
1070 (unless (get-char-property start
'invisible
)
1071 (with-current-buffer temp-buffer
1072 (insert-buffer-substring diary-buffer start end
)))
1074 (and end
(< end
(point-max))))))
1075 (set-buffer temp-buffer
)
1076 (goto-char (point-min))
1077 (insert heading
"\n"
1078 (make-string (length heading
) ?
=) "\n")
1079 (run-hooks 'diary-print-entries-hook
)
1080 (kill-buffer temp-buffer
))))
1082 (define-obsolete-function-alias 'print-diary-entries
1083 'diary-print-entries
"23.1")
1086 (defun diary-show-all-entries ()
1087 "Show all of the diary entries in the diary file.
1088 This function gets rid of the selective display of the diary file so that
1089 all entries, not just some, are visible. If there is no diary buffer, one
1092 (let ((d-file (diary-check-diary-file))
1093 (pop-up-frames (or pop-up-frames
1094 (window-dedicated-p (selected-window)))))
1095 (with-current-buffer (or (find-buffer-visiting d-file
)
1096 (find-file-noselect d-file t
))
1097 (when (eq major-mode default-major-mode
) (diary-mode))
1098 (diary-unhide-everything)
1099 (display-buffer (current-buffer)))))
1101 (define-obsolete-function-alias 'show-all-diary-entries
1102 'diary-show-all-entries
"22.1")
1105 (defun diary-mail-entries (&optional ndays
)
1106 "Send a mail message showing diary entries for next NDAYS days.
1107 If no prefix argument is given, NDAYS is set to `diary-mail-days'.
1108 Mail is sent to the address specified by `diary-mail-addr'.
1110 Here is an example of a script to call `diary-mail-entries',
1111 suitable for regular scheduling using cron (or at). Note that
1112 since `emacs -script' does not load your `.emacs' file, you
1113 should ensure that all relevant variables are set.
1115 #!/usr/bin/emacs -script
1116 ;; diary-rem.el - run the Emacs diary-reminder
1118 \(setq diary-mail-days 3
1119 diary-file \"/path/to/diary.file\"
1120 calendar-date-style 'european
1121 diary-mail-addr \"user@host.name\")
1123 \(diary-mail-entries)
1125 # diary-rem.el ends here
1128 (if (string-equal diary-mail-addr
"")
1129 (error "You must set `diary-mail-addr' to use this command")
1130 (let ((diary-display-function 'diary-fancy-display
))
1131 (diary-list-entries (calendar-current-date) (or ndays diary-mail-days
)))
1132 (compose-mail diary-mail-addr
1133 (concat "Diary entries generated "
1134 (calendar-date-string (calendar-current-date))))
1136 (if (get-buffer diary-fancy-buffer
)
1137 (with-current-buffer diary-fancy-buffer
(buffer-string))
1138 "No entries found"))
1139 (call-interactively (get mail-user-agent
'sendfunc
))))
1141 (defun diary-name-pattern (string-array &optional abbrev-array paren
)
1142 "Return a regexp matching the strings in the array STRING-ARRAY.
1143 If the optional argument ABBREV-ARRAY is present, then the function
1144 `calendar-abbrev-construct' is used to construct abbreviations from the
1145 two supplied arrays. The returned regexp will then also match these
1146 abbreviations, with or without final `.' characters. If the optional
1147 argument PAREN is non-nil, the regexp is surrounded by parentheses."
1148 (regexp-opt (append string-array
1150 (calendar-abbrev-construct abbrev-array
1153 (calendar-abbrev-construct abbrev-array
1159 (defvar diary-marking-entries-flag nil
1160 "True during the marking of diary entries, nil otherwise.")
1162 (defvar diary-marking-entry-flag nil
1163 "True during the marking of diary entries, if current entry is marking.")
1165 ;; file-glob-attrs bound in diary-mark-entries.
1166 (defun diary-mark-entries-1 (markfunc &optional months symbol absfunc
)
1167 "Mark diary entries of a certain type.
1168 MARKFUNC is a function that marks entries of the appropriate type
1169 matching a given date pattern. MONTHS is an array of month names.
1170 SYMBOL marks diary entries of the type in question. ABSFUNC is a
1171 function that converts absolute dates to dates of the appropriate type. "
1172 (let ((dayname (diary-name-pattern calendar-day-name-array
1173 calendar-day-abbrev-array
))
1174 (monthname (format "%s\\|\\*"
1176 (diary-name-pattern months
)
1177 (diary-name-pattern calendar-month-name-array
1178 calendar-month-abbrev-array
))))
1179 (month "[0-9]+\\|\\*")
1180 (day "[0-9]+\\|\\*")
1181 (year "[0-9]+\\|\\*")
1182 (case-fold-search t
)
1184 (dolist (date-form diary-date-forms
)
1185 (if (eq (car date-form
) 'backup
) ; ignore 'backup directive
1186 (setq date-form
(cdr date-form
)))
1187 (let* ((l (length date-form
))
1188 (d-name-pos (- l
(length (memq 'dayname date-form
))))
1189 (d-name-pos (if (/= l d-name-pos
) (1+ d-name-pos
)))
1190 (m-name-pos (- l
(length (memq 'monthname date-form
))))
1191 (m-name-pos (if (/= l m-name-pos
) (1+ m-name-pos
)))
1192 (d-pos (- l
(length (memq 'day date-form
))))
1193 (d-pos (if (/= l d-pos
) (1+ d-pos
)))
1194 (m-pos (- l
(length (memq 'month date-form
))))
1195 (m-pos (if (/= l m-pos
) (1+ m-pos
)))
1196 (y-pos (- l
(length (memq 'year date-form
))))
1197 (y-pos (if (/= l y-pos
) (1+ y-pos
)))
1198 (regexp (format "^%s\\(%s\\)"
1199 (if symbol
(regexp-quote symbol
) "")
1200 (mapconcat 'eval date-form
"\\)\\("))))
1201 (goto-char (point-min))
1202 (while (re-search-forward regexp nil t
)
1205 (match-string-no-properties d-name-pos
)))
1208 (match-string-no-properties m-name-pos
)))
1209 (mm (string-to-number
1211 (match-string-no-properties m-pos
)
1213 (dd (string-to-number
1215 (match-string-no-properties d-pos
)
1218 (match-string-no-properties y-pos
)))
1221 (if (and (= (length y-str
) 2)
1222 diary-abbreviated-year-flag
)
1224 (calendar-extract-year
1228 (calendar-absolute-from-gregorian
1229 (calendar-current-date)))
1230 (calendar-current-date))))
1231 (y (+ (string-to-number y-str
)
1232 ;; Current century, eg 2000.
1233 (* 100 (/ current-y
100))))
1234 (offset (- y current-y
)))
1235 ;; Add 2-digit year to current century.
1236 ;; If more than 50 years in the future,
1237 ;; assume last century. If more than 50
1238 ;; years in the past, assume next century.
1244 (string-to-number y-str
)))))
1245 (setq marks
(cadr (diary-pull-attrs
1246 (buffer-substring-no-properties
1247 (point) (line-end-position))
1249 ;; Only mark all days of a given name if the pattern
1250 ;; contains no more specific elements.
1251 (if (and dd-name
(not (or d-pos m-pos y-pos
)))
1252 (calendar-mark-days-named
1253 (cdr (assoc-string dd-name
1254 (calendar-make-alist
1255 calendar-day-name-array
1256 0 nil calendar-day-abbrev-array
) t
)) marks
)
1259 (if (string-equal mm-name
"*") 0
1262 (if months
(calendar-make-alist months
)
1263 (calendar-make-alist
1264 calendar-month-name-array
1265 1 nil calendar-month-abbrev-array
)) t
)))))
1266 (funcall markfunc mm dd yy marks
))))))))
1269 (defun diary-mark-entries (&optional redraw
)
1270 "Mark days in the calendar window that have diary entries.
1271 Each entry in the diary file visible in the calendar window is
1272 marked. After the entries are marked, the hooks
1273 `diary-nongregorian-marking-hook' and `diary-mark-entries-hook'
1274 are run. If the optional argument REDRAW is non-nil (which is
1275 the case interactively, for example) then any existing diary
1276 marks are first removed. This is intended to deal with deleted
1279 ;; To remove any deleted diary entries. Do not redraw when:
1280 ;; i) processing #include diary files (else only get the marks from
1281 ;; the last #include file processed).
1282 ;; ii) called via calendar-redraw (since calendar has already been
1284 ;; Use of REDRAW handles both of these cases.
1285 (when (and redraw calendar-mark-diary-entries-flag
)
1286 (setq calendar-mark-diary-entries-flag nil
)
1288 (let ((diary-marking-entries-flag t
)
1290 (with-current-buffer (find-file-noselect (diary-check-diary-file) t
)
1292 (when (eq major-mode default-major-mode
) (diary-mode))
1293 (setq calendar-mark-diary-entries-flag t
)
1294 (message "Marking diary entries...")
1295 (setq file-glob-attrs
(nth 1 (diary-pull-attrs nil
'())))
1296 (with-syntax-table diary-syntax-table
1297 (diary-mark-entries-1 'calendar-mark-date-pattern
)
1298 (diary-mark-sexp-entries)
1299 (run-hooks 'diary-nongregorian-marking-hook
1300 'diary-mark-entries-hook
))
1301 (message "Marking diary entries...done")))))
1304 (define-obsolete-function-alias 'mark-diary-entries
'diary-mark-entries
"23.1")
1306 (defun diary-sexp-entry (sexp entry date
)
1307 "Process a SEXP diary ENTRY for DATE."
1308 (let ((result (if calendar-debug-sexp
1309 (let ((stack-trace-on-error t
))
1310 (eval (car (read-from-string sexp
))))
1312 (eval (car (read-from-string sexp
)))
1315 (message "Bad sexp at line %d in %s: %s"
1316 (count-lines (point-min) (point))
1319 (cond ((stringp result
) result
)
1320 ((and (consp result
)
1321 (stringp (cdr result
))) result
)
1325 (defvar displayed-year
) ; bound in calendar-generate
1326 (defvar displayed-month
)
1328 (defun diary-mark-sexp-entries ()
1329 "Mark days in the calendar window that have sexp diary entries.
1330 Each entry in the diary file (or included files) visible in the calendar window
1331 is marked. See the documentation for the function `diary-list-sexp-entries'."
1332 (let* ((sexp-mark (regexp-quote diary-sexp-entry-symbol
))
1333 (s-entry (format "^\\(%s(\\)\\|\\(%s%s(diary-remind\\)" sexp-mark
1334 (regexp-quote diary-nonmarking-symbol
)
1336 (file-glob-attrs (nth 1 (diary-pull-attrs nil
'())))
1337 m y first-date last-date date mark file-glob-attrs
1338 sexp-start sexp entry entry-start
)
1339 (with-current-buffer calendar-buffer
1340 (setq m displayed-month
1342 (calendar-increment-month m y -
1)
1343 (setq first-date
(calendar-absolute-from-gregorian (list m
1 y
)))
1344 (calendar-increment-month m y
2)
1346 (calendar-absolute-from-gregorian
1347 (list m
(calendar-last-day-of-month m y
) y
)))
1348 (goto-char (point-min))
1349 (while (re-search-forward s-entry nil t
)
1350 (setq diary-marking-entry-flag
(char-equal (preceding-char) ?\
())
1351 (re-search-backward "(")
1352 (setq sexp-start
(point))
1354 (setq sexp
(buffer-substring-no-properties sexp-start
(point)))
1356 (if (and (bolp) (not (looking-at "[ \t]")))
1357 ;; Diary entry consists only of the sexp.
1361 (setq entry-start
(point))
1362 ;; Find end of entry.
1364 (while (looking-at "[ \t]")
1366 (if (bolp) (backward-char 1))
1367 (setq entry
(buffer-substring-no-properties entry-start
(point))))
1368 (setq date
(1- first-date
))
1369 ;; FIXME this loops over all visible dates.
1370 ;; Could be optimized in many cases. Depends on whether t or * present.
1371 (while (<= (setq date
(1+ date
)) last-date
)
1372 (when (setq mark
(diary-sexp-entry
1374 (calendar-gregorian-from-absolute date
)))
1375 (calendar-mark-visible-date
1376 (calendar-gregorian-from-absolute date
)
1377 (or (cadr (diary-pull-attrs entry file-glob-attrs
))
1378 (if (consp mark
) (car mark
)))))))))
1380 (define-obsolete-function-alias 'mark-sexp-diary-entries
1381 'diary-mark-sexp-entries
"23.1")
1383 (defun diary-mark-included-diary-files ()
1384 "Mark the diary entries from other diary files with those of the diary file.
1385 This function is suitable for use with `diary-mark-entries-hook'; it enables
1386 you to use shared diary files together with your own. The files included are
1387 specified in the `diary-file' by lines of this form:
1388 #include \"filename\"
1389 This is recursive; that is, #include directives in diary files thus included
1390 are obeyed. You can change the `#include' to some other string by changing
1391 the variable `diary-include-string'."
1392 (goto-char (point-min))
1393 (while (re-search-forward
1394 (format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string
))
1396 (let* ((diary-file (substitute-in-file-name
1397 (match-string-no-properties 1)))
1398 (diary-mark-entries-hook 'diary-mark-included-diary-files
)
1399 (dbuff (find-buffer-visiting diary-file
)))
1400 (if (file-exists-p diary-file
)
1401 (if (file-readable-p diary-file
)
1403 (diary-mark-entries)
1405 (kill-buffer (find-buffer-visiting diary-file
))))
1407 (message "Can't read included diary file %s" diary-file
)
1410 (message "Can't find included diary file %s" diary-file
)
1412 (goto-char (point-min)))
1414 (define-obsolete-function-alias 'mark-included-diary-files
1415 'diary-mark-included-diary-files
"23.1")
1417 (defun calendar-mark-days-named (dayname &optional color
)
1418 "Mark all dates in the calendar window that are day DAYNAME of the week.
1419 0 means all Sundays, 1 means all Mondays, and so on.
1420 Optional argument COLOR is passed to `calendar-mark-visible-date' as MARK."
1421 (with-current-buffer calendar-buffer
1422 (let ((prev-month displayed-month
)
1423 (prev-year displayed-year
)
1424 (succ-month displayed-month
)
1425 (succ-year displayed-year
)
1428 (calendar-increment-month succ-month succ-year
1)
1429 (calendar-increment-month prev-month prev-year -
1)
1430 (setq day
(calendar-absolute-from-gregorian
1431 (calendar-nth-named-day 1 dayname prev-month prev-year
))
1432 last-day
(calendar-absolute-from-gregorian
1433 (calendar-nth-named-day -
1 dayname succ-month succ-year
)))
1434 (while (<= day last-day
)
1435 (calendar-mark-visible-date (calendar-gregorian-from-absolute day
)
1437 (setq day
(+ day
7))))))
1439 (define-obsolete-function-alias 'mark-calendar-days-named
1440 'calendar-mark-days-named
"23.1")
1442 (defun calendar-mark-month (month year p-month p-day p-year
&optional color
)
1443 "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P-DAY/P-YEAR.
1444 A value of 0 in any position of the pattern is a wildcard.
1445 Optional argument COLOR is passed to `calendar-mark-visible-date' as MARK."
1446 (if (or (and (= month p-month
)
1447 (or (zerop p-year
) (= year p-year
)))
1448 (and (zerop p-month
)
1449 (or (zerop p-year
) (= year p-year
))))
1451 (dotimes (i (calendar-last-day-of-month month year
))
1452 (calendar-mark-visible-date (list month
(1+ i
) year
) color
))
1453 (calendar-mark-visible-date (list month p-day year
) color
))))
1455 (define-obsolete-function-alias 'mark-calendar-month
1456 'calendar-mark-month
"23.1")
1458 (defun calendar-mark-date-pattern (month day year
&optional color
)
1459 "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
1460 A value of 0 in any position is a wildcard. Optional argument COLOR is
1461 passed to `calendar-mark-visible-date' as MARK."
1462 (with-current-buffer calendar-buffer
1463 (let ((m displayed-month
)
1465 (calendar-increment-month m y -
1)
1467 (calendar-mark-month m y month day year color
)
1468 (calendar-increment-month m y
1)))))
1470 (define-obsolete-function-alias 'mark-calendar-date-pattern
1471 'calendar-mark-date-pattern
"23.1")
1473 ;; Bahai, Hebrew, Islamic.
1474 (defun calendar-mark-complex (month day year fromabs
&optional color
)
1475 "Mark dates in the calendar conforming to MONTH DAY YEAR of some system.
1476 The function FROMABS converts absolute dates to the appropriate date system.
1477 Optional argument COLOR is passed to `calendar-mark-visible-date' as MARK."
1478 ;; Not one of the simple cases--check all visible dates for match.
1479 ;; Actually, the following code takes care of ALL of the cases, but
1480 ;; it's much too slow to be used for the simple (common) cases.
1481 (let* ((m displayed-month
)
1484 (calendar-increment-month m y -
1)
1485 (calendar-absolute-from-gregorian (list m
1 y
))))
1487 (calendar-increment-month m y
2)
1488 (calendar-absolute-from-gregorian
1489 (list m
(calendar-last-day-of-month m y
) y
))))
1490 (date (1- first-date
))
1492 (while (<= (setq date
(1+ date
)) last-date
)
1493 (setq local-date
(funcall fromabs date
))
1494 (and (or (zerop month
)
1495 (= month
(calendar-extract-month local-date
)))
1497 (= day
(calendar-extract-day local-date
)))
1499 (= year
(calendar-extract-year local-date
)))
1500 (calendar-mark-visible-date
1501 (calendar-gregorian-from-absolute date
) color
)))))
1504 (defun calendar-mark-1 (month day year fromabs toabs
&optional color
)
1505 "Mark dates in the calendar conforming to MONTH DAY YEAR of some system.
1506 The function FROMABS converts absolute dates to the appropriate date system.
1507 The function TOABS carries out the inverse operation. Optional argument
1508 COLOR is passed to `calendar-mark-visible-date' as MARK."
1510 (set-buffer calendar-buffer
)
1511 (if (and (not (zerop month
)) (not (zerop day
)))
1512 (if (not (zerop year
))
1513 ;; Fully specified date.
1514 (let ((date (calendar-gregorian-from-absolute
1515 (funcall toabs
(list month day year
)))))
1516 (if (calendar-date-is-visible-p date
)
1517 (calendar-mark-visible-date date color
)))
1518 ;; Month and day in any year--this taken from the holiday stuff.
1519 (let* ((i-date (funcall fromabs
1520 (calendar-absolute-from-gregorian
1521 (list displayed-month
15 displayed-year
))))
1522 (m (calendar-extract-month i-date
))
1523 (y (calendar-extract-year i-date
))
1525 (unless (< m
1) ; calendar doesn't apply
1526 (calendar-increment-month m y
(- 10 month
))
1527 (and (> m
7) ; date might be visible
1528 (calendar-date-is-visible-p
1529 (setq date
(calendar-gregorian-from-absolute
1530 (funcall toabs
(list month day y
)))))
1531 (calendar-mark-visible-date date color
)))))
1532 (calendar-mark-complex month day year
1533 'calendar-bahai-from-absolute color
))))
1536 (defun diary-entry-time (s)
1537 "Return time at the beginning of the string S as a military-style integer.
1538 For example, returns 1325 for 1:25pm.
1540 Returns `diary-unknown-time' (default value -9999) if no time is recognized.
1541 The recognized forms are XXXX, X:XX, or XX:XX (military time), and XXam,
1542 XXAM, XXpm, XXPM, XX:XXam, XX:XXAM, XX:XXpm, or XX:XXPM. A period (.) can
1543 be used instead of a colon (:) to separate the hour and minute parts."
1544 (let (case-fold-search)
1545 (cond ((string-match ; military time
1546 "\\`[ \t\n]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)"
1548 (+ (* 100 (string-to-number (match-string 1 s
)))
1549 (string-to-number (match-string 2 s
))))
1550 ((string-match ; hour only (XXam or XXpm)
1551 "\\`[ \t\n]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s
)
1552 (+ (* 100 (%
(string-to-number (match-string 1 s
)) 12))
1553 (if (equal ?a
(downcase (aref s
(match-beginning 2))))
1555 ((string-match ; hour and minute (XX:XXam or XX:XXpm)
1556 "\\`[ \t\n]*\\([0-9]?[0-9]\\)[:.]\\([0-9][0-9]\\)\\([ap]\\)m\\>" s
)
1557 (+ (* 100 (%
(string-to-number (match-string 1 s
)) 12))
1558 (string-to-number (match-string 2 s
))
1559 (if (equal ?a
(downcase (aref s
(match-beginning 3))))
1561 (t diary-unknown-time
)))) ; unrecognizable
1563 (defun diary-entry-compare (e1 e2
)
1564 "Return t if E1 is earlier than E2."
1565 (or (calendar-date-compare e1 e2
)
1566 (and (calendar-date-equal (car e1
) (car e2
))
1567 (let* ((ts1 (cadr e1
)) (t1 (diary-entry-time ts1
))
1568 (ts2 (cadr e2
)) (t2 (diary-entry-time ts2
)))
1571 (string-lessp ts1 ts2
)))))))
1573 (defun diary-sort-entries ()
1574 "Sort the list of diary entries by time of day."
1575 (setq diary-entries-list
(sort diary-entries-list
'diary-entry-compare
)))
1577 (define-obsolete-function-alias 'sort-diary-entries
'diary-sort-entries
"23.1")
1580 (defun diary-list-sexp-entries (date)
1581 "Add sexp entries for DATE from the diary file to `diary-entries-list'.
1582 Also, make them visible in the diary. Returns t if any entries are found.
1584 Sexp diary entries must be prefaced by a `diary-sexp-entry-symbol'
1585 \(normally `%%'). The form of a sexp diary entry is
1589 Both ENTRY and DATE are available when the SEXP is evaluated. If
1590 the SEXP returns nil, the diary entry does not apply. If it
1591 returns a non-nil value, ENTRY will be taken to apply to DATE; if
1592 the value is a string, that string will be the diary entry in the
1593 fancy diary display.
1595 For example, the following diary entry will apply to the 21st of
1596 the month if it is a weekday and the Friday before if the 21st is
1599 &%%(let ((dayname (calendar-day-of-week date))
1600 (day (calendar-extract-day date)))
1602 (and (= day 21) (memq dayname '(1 2 3 4 5)))
1603 (and (memq day '(19 20)) (= dayname 5)))
1604 ) UIUC pay checks deposited
1606 A number of built-in functions are available for this type of
1607 diary entry. In the following, the optional parameter MARK
1608 specifies a face or single-character string to use when
1609 highlighting the day in the calendar. For those functions that
1610 take MONTH, DAY, and YEAR as arguments, the order of the input
1611 parameters changes according to `calendar-date-style' (e.g. to
1612 DAY MONTH YEAR in the European style).
1614 %%(diary-date MONTH DAY YEAR &optional MARK) text
1615 Entry applies if date is MONTH, DAY, YEAR. DAY, MONTH, and YEAR can
1616 be a list of integers, `t' (meaning all values), or an integer.
1618 %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
1619 Entry will appear on the Nth DAYNAME after/before MONTH DAY.
1620 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
1621 If N>0, use the Nth DAYNAME after MONTH DAY.
1622 If N<0, use the Nth DAYNAME before MONTH DAY.
1623 DAY defaults to 1 if N>0, and MONTH's last day otherwise.
1624 MONTH can be a list of months, a single month, or `t' to
1627 %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
1628 Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
1631 %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
1632 Entry will appear on anniversary dates of MONTH DAY, YEAR.
1633 Text can contain `%d' or `%d%s'; `%d' will be replaced by the
1634 number of years since the MONTH DAY, YEAR, and `%s' by the
1635 ordinal ending of that number (i.e. `st', `nd', `rd' or `th',
1636 as appropriate). The anniversary of February 29 is
1637 considered to be March 1 in a non-leap year.
1639 %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text
1640 Entry will appear every N days, starting MONTH DAY, YEAR.
1641 Text can contain `%d' or `%d%s'; `%d' will be replaced by the
1642 number of repetitions since the MONTH DAY, YEAR and `%s' by
1643 the ordinal ending of that number (i.e. `st', `nd', `rd' or
1644 `th', as appropriate).
1646 %%(diary-remind SEXP DAYS &optional MARKING) text
1647 Entry is a reminder for diary sexp SEXP. DAYS is either a
1648 single number or a list of numbers indicating the number(s)
1649 of days before the event that the warning(s) should occur.
1650 A negative number -DAYS has the same meaning as a list (1 2 ... DAYS).
1651 If the current date is (one of) DAYS before the event indicated
1652 by EXPR, then a suitable message (as specified by
1653 `diary-remind-message') appears. In addition to the
1654 reminders beforehand, the diary entry also appears on the
1655 date itself. If optional MARKING is non-nil then the
1656 *reminders* are marked on the calendar. Marking of reminders
1657 is independent of whether the entry *itself* is a marking or
1660 %%(diary-hebrew-yahrzeit MONTH DAY YEAR) text
1661 Text is assumed to be the name of the person; the date is the
1662 date of death on the *civil* calendar. The diary entry will
1663 appear on the proper Hebrew-date anniversary and on the day
1666 All the remaining functions do not accept any text, and so only
1667 make sense with `diary-fancy-display'. Most produce output every day.
1669 `diary-day-of-year' - day of year and number of days remaining
1670 `diary-iso-date' - ISO commercial date
1671 `diary-astro-day-number' - astronomical (Julian) day number
1672 `diary-sunrise-sunset' - local times of sunrise and sunset
1674 These functions give the date in alternative calendrical systems:
1676 `diary-bahai-date', `diary-chinese-date', `diary-coptic-date',
1677 `diary-ethiopic-date', `diary-french-date', `diary-hebrew-date',
1678 `diary-islamic-date', `diary-julian-date', `diary-mayan-date',
1679 `diary-persian-date'
1681 Theses functions only produce output on certain dates:
1683 `diary-lunar-phases' - phases of moon (on the appropriate days)
1684 `diary-hebrew-omer' - Omer count, within 50 days after Passover
1685 `diary-hebrew-parasha' - weekly parasha, every Saturday
1686 `diary-hebrew-rosh-hodesh' - Rosh Hodesh, or the day or Saturday before
1687 `diary-hebrew-sabbath-candles' - local time of candle lighting, on Fridays
1690 Marking these entries is *extremely* time consuming, so it is
1691 best if they are non-marking."
1692 (let ((s-entry (format "^%s?%s(" (regexp-quote diary-nonmarking-symbol
)
1693 (regexp-quote diary-sexp-entry-symbol
)))
1694 entry-found file-glob-attrs marks
1695 sexp-start sexp entry specifier entry-start line-start
1696 diary-entry temp literal
)
1697 (goto-char (point-min))
1699 (setq file-glob-attrs
(nth 1 (diary-pull-attrs nil
'()))))
1700 (while (re-search-forward s-entry nil t
)
1702 (setq sexp-start
(point))
1704 (setq sexp
(buffer-substring-no-properties sexp-start
(point))
1705 line-start
(line-end-position 0)
1707 (buffer-substring-no-properties (1+ line-start
) (point))
1708 entry-start
(1+ line-start
))
1710 (if (and (bolp) (not (looking-at "[ \t]")))
1711 ;; Diary entry consists only of the sexp.
1715 (setq entry-start
(point))
1717 (while (looking-at "[ \t]")
1720 (setq entry
(buffer-substring-no-properties entry-start
(point))))
1721 (setq diary-entry
(diary-sexp-entry sexp entry date
)
1722 literal entry
; before evaluation
1723 entry
(if (consp diary-entry
)
1727 (remove-overlays line-start
(point) 'invisible
'diary
)
1728 (if (< 0 (length entry
))
1729 (setq temp
(diary-pull-attrs entry file-glob-attrs
)
1731 marks
(nth 1 temp
))))
1732 (diary-add-to-list date entry specifier
1733 (if entry-start
(copy-marker entry-start
))
1735 (setq entry-found
(or entry-found diary-entry
)))
1738 (define-obsolete-function-alias 'list-sexp-diary-entries
1739 'diary-list-sexp-entries
"23.1")
1741 (defun diary-make-date (a b c
)
1742 "Convert A B C into the internal calendar date form.
1743 The expected order of the inputs depends on `calendar-date-style',
1744 e.g. in the European case, A = day, B = month, C = year. Returns
1745 a list (MONTH DAY YEAR), i.e. the American style, which is the
1746 form used internally by the calendar and diary."
1747 (cond ((eq calendar-date-style
'iso
) ; YMD
1749 ((eq calendar-date-style
'european
) ; DMY
1754 ;;; Sexp diary functions.
1759 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1760 (defun diary-date (month day year
&optional mark
)
1761 "Specific date(s) diary entry.
1762 Entry applies if date is MONTH, DAY, YEAR. Each parameter can be a
1763 list of integers, `t' (meaning all values), or an integer. The order
1764 of the input parameters changes according to `calendar-date-style'
1765 \(e.g. to DAY MONTH YEAR in the European style).
1767 An optional parameter MARK specifies a face or single-character string
1768 to use when highlighting the day in the calendar."
1769 (let* ((ddate (diary-make-date month day year
))
1770 (dd (calendar-extract-day ddate
))
1771 (mm (calendar-extract-month ddate
))
1772 (yy (calendar-extract-year ddate
))
1773 (m (calendar-extract-month date
))
1774 (y (calendar-extract-year date
))
1775 (d (calendar-extract-day date
)))
1777 (or (and (listp dd
) (memq d dd
))
1780 (or (and (listp mm
) (memq m mm
))
1783 (or (and (listp yy
) (memq y yy
))
1786 (cons mark entry
))))
1788 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1789 (defun diary-block (m1 d1 y1 m2 d2 y2
&optional mark
)
1791 Entry applies if date is between, or on one of, two dates. The order
1792 of the input parameters changes according to `calendar-date-style'
1793 \(e.g. to D1, M1, Y1, D2, M2, Y2 in the European style).
1795 An optional parameter MARK specifies a face or single-character string
1796 to use when highlighting the day in the calendar."
1797 (let ((date1 (calendar-absolute-from-gregorian
1798 (diary-make-date m1 d1 y1
)))
1799 (date2 (calendar-absolute-from-gregorian
1800 (diary-make-date m2 d2 y2
)))
1801 (d (calendar-absolute-from-gregorian date
)))
1802 (and (<= date1 d
) (<= d date2
)
1803 (cons mark entry
))))
1805 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1806 (defun diary-float (month dayname n
&optional day mark
)
1807 "Diary entry for the Nth DAYNAME after/before MONTH DAY.
1808 DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
1809 If N>0, use the Nth DAYNAME after MONTH DAY.
1810 If N<0, use the Nth DAYNAME before MONTH DAY.
1811 DAY defaults to 1 if N>0, and MONTH's last day otherwise.
1812 MONTH can be a list of months, an integer, or `t' (meaning all months).
1813 Optional MARK specifies a face or single-character string to use when
1814 highlighting the day in the calendar."
1815 ;; This is messy because the diary entry may apply, but the date on which it
1816 ;; is based can be in a different month/year. For example, asking for the
1817 ;; first Monday after December 30. For large values of |n| the problem is
1819 (and (= dayname
(calendar-day-of-week date
))
1820 (let* ((m (calendar-extract-month date
))
1821 (d (calendar-extract-day date
))
1822 (y (calendar-extract-year date
))
1823 ;; Last (n>0) or first (n<0) possible base date for entry.
1825 (calendar-nth-named-absday (- n
) dayname m y d
))
1826 (last-abs (if (> n
0) limit
(+ limit
6)))
1827 (first-abs (if (> n
0) (- limit
6) limit
))
1828 (last (calendar-gregorian-from-absolute last-abs
))
1829 (first (calendar-gregorian-from-absolute first-abs
))
1830 ;; m1, d1 is first possible base date.
1831 (m1 (calendar-extract-month first
))
1832 (d1 (calendar-extract-day first
))
1833 (y1 (calendar-extract-year first
))
1834 ;; m2, d2 is last possible base date.
1835 (m2 (calendar-extract-month last
))
1836 (d2 (calendar-extract-day last
))
1837 (y2 (calendar-extract-year last
)))
1838 (if (or (and (= m1 m2
) ; only possible base dates in one month
1843 (let ((d (or day
(if (> n
0)
1845 (calendar-last-day-of-month m1 y1
)))))
1846 (and (<= d1 d
) (<= d d2
))))
1847 ;; Only possible base dates straddle two months.
1849 (and (= y1 y2
) (< m1 m2
)))
1851 ;; m1, d1 works as a base date.
1857 (<= d1
(or day
(if (> n
0)
1859 (calendar-last-day-of-month m1 y1
)))))
1860 ;; m2, d2 works as a base date.
1861 (and (or (eq month t
)
1865 (<= (or day
(if (> n
0)
1867 (calendar-last-day-of-month m2 y2
)))
1869 (cons mark entry
)))))
1871 (defun diary-ordinal-suffix (n)
1872 "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
1873 (if (or (memq (% n
100) '(11 12 13))
1876 (aref ["th" "st" "nd" "rd"] (% n
10))))
1878 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1879 (defun diary-anniversary (month day
&optional year mark
)
1880 "Anniversary diary entry.
1881 Entry applies if date is the anniversary of MONTH, DAY, YEAR.
1882 The order of the input parameters changes according to
1883 `calendar-date-style' (e.g. to DAY MONTH YEAR in the European style).
1885 The diary entry can contain `%d' or `%d%s'; the %d will be replaced
1886 by the number of years since the MONTH, DAY, YEAR, and the %s will
1887 be replaced by the ordinal ending of that number (that is, `st',
1888 `nd', `rd' or `th', as appropriate). The anniversary of February 29
1889 is considered to be March 1 in non-leap years.
1891 An optional parameter MARK specifies a face or single-character
1892 string to use when highlighting the day in the calendar."
1893 (let* ((ddate (diary-make-date month day year
))
1894 (dd (calendar-extract-day ddate
))
1895 (mm (calendar-extract-month ddate
))
1896 (yy (calendar-extract-year ddate
))
1897 (y (calendar-extract-year date
))
1898 (diff (if yy
(- y yy
) 100)))
1899 (and (= mm
2) (= dd
29) (not (calendar-leap-year-p y
))
1902 (and (> diff
0) (calendar-date-equal (list mm dd y
) date
)
1903 (cons mark
(format entry diff
(diary-ordinal-suffix diff
))))))
1905 ;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
1906 (defun diary-cyclic (n month day year
&optional mark
)
1907 "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
1908 The order of the input parameters changes according to
1909 `calendar-date-style' (e.g. to N DAY MONTH YEAR in the European
1910 style). The entry can contain `%d' or `%d%s'; the %d will be
1911 replaced by the number of repetitions since the MONTH DAY YEAR,
1912 and %s by the ordinal ending of that number (that is, `st', `nd',
1913 `rd' or `th', as appropriate).
1915 An optional parameter MARK specifies a face or single-character
1916 string to use when highlighting the day in the calendar."
1918 (error "Day count must be positive"))
1919 (let* ((diff (- (calendar-absolute-from-gregorian date
)
1920 (calendar-absolute-from-gregorian
1921 (diary-make-date month day year
))))
1923 (and (>= diff
0) (zerop (% diff n
))
1924 (cons mark
(format entry cycle
(diary-ordinal-suffix cycle
))))))
1926 (defun diary-day-of-year ()
1927 "Day of year and number of days remaining in the year of date diary entry."
1928 (calendar-day-of-year-string date
))
1930 (defun diary-remind (sexp days
&optional marking
)
1931 "Provide a reminder of a diary entry.
1932 SEXP is a diary-sexp. DAYS is either a single number or a list
1933 of numbers indicating the number(s) of days before the event that
1934 the warning(s) should occur on. A negative number -DAYS has the
1935 same meaning as a list (1 2 ... DAYS). If the current date
1936 is (one of) DAYS before the event indicated by SEXP, then this function
1937 returns a suitable message (as specified by `diary-remind-message').
1939 In addition to the reminders beforehand, the diary entry also
1940 appears on the date itself.
1942 A `diary-nonmarking-symbol' at the beginning of the line of the
1943 `diary-remind' entry specifies that the diary entry (not the
1944 reminder) is non-marking. Marking of reminders is independent of
1945 whether the entry itself is a marking or nonmarking; if optional
1946 parameter MARKING is non-nil then the reminders are marked on the
1948 ;; `date' has a value at this point, from diary-sexp-entry.
1949 ;; Convert a negative number to a list of days.
1950 (and (integerp days
)
1952 (setq days
(number-sequence 1 (- days
))))
1953 (let ((diary-entry (eval sexp
)))
1955 ;; Diary entry applies on date.
1957 (or (not diary-marking-entries-flag
) diary-marking-entry-flag
))
1959 ;; Diary entry may apply to `days' before date.
1960 ((and (integerp days
)
1961 (not diary-entry
) ; diary entry does not apply to date
1962 (or (not diary-marking-entries-flag
) marking
))
1963 ;; Adjust date, and re-evaluate.
1964 (let ((date (calendar-gregorian-from-absolute
1965 (+ (calendar-absolute-from-gregorian date
) days
))))
1966 (when (setq diary-entry
(eval sexp
))
1967 ;; Discard any mark portion from diary-anniversary, etc.
1968 (if (consp diary-entry
) (setq diary-entry
(cdr diary-entry
)))
1969 (mapconcat 'eval diary-remind-message
""))))
1970 ;; Diary entry may apply to one of a list of days before date.
1971 ((and (listp days
) days
)
1972 (or (diary-remind sexp
(car days
) marking
)
1973 (diary-remind sexp
(cdr days
) marking
))))))
1976 ;;; Diary insertion functions.
1979 (defun diary-make-entry (string &optional nonmarking file
)
1980 "Insert a diary entry STRING which may be NONMARKING in FILE.
1981 If omitted, NONMARKING defaults to nil and FILE defaults to
1983 (let ((pop-up-frames (or pop-up-frames
1984 (window-dedicated-p (selected-window)))))
1985 (find-file-other-window (substitute-in-file-name (or file diary-file
))))
1986 (when (eq major-mode default-major-mode
) (diary-mode))
1988 (diary-unhide-everything)
1989 (goto-char (point-max))
1990 (when (let ((case-fold-search t
))
1991 (search-backward "Local Variables:"
1992 (max (- (point-max) 3000) (point-min))
1999 (if nonmarking diary-nonmarking-symbol
"")
2003 (define-obsolete-function-alias 'make-diary-entry
'diary-make-entry
"23.1")
2006 (defun diary-insert-entry (arg &optional event
)
2007 "Insert a diary entry for the date indicated by point.
2008 Prefix argument ARG makes the entry nonmarking."
2010 (list current-prefix-arg last-nonmenu-event
))
2011 (diary-make-entry (calendar-date-string (calendar-cursor-to-date t event
) t t
)
2015 (define-obsolete-function-alias 'insert-diary-entry
'diary-insert-entry
"23.1")
2018 (defun diary-insert-weekly-entry (arg)
2019 "Insert a weekly diary entry for the day of the week indicated by point.
2020 Prefix argument ARG makes the entry nonmarking."
2022 (diary-make-entry (calendar-day-name (calendar-cursor-to-date t
))
2026 (define-obsolete-function-alias 'insert-weekly-diary-entry
2027 'diary-insert-weekly-entry
"23.1")
2029 (defun diary-date-display-form (&optional type
)
2030 "Return value for `calendar-date-display-form' using `calendar-date-style'.
2031 Optional symbol TYPE is either `monthly' or `yearly'."
2032 (cond ((eq type
'monthly
) (cond ((eq calendar-date-style
'iso
)
2033 '((format "*-*-%.2d"
2034 (string-to-number day
))))
2035 ((eq calendar-date-style
'european
)
2038 ((eq type
'yearly
) (cond ((eq calendar-date-style
'iso
)
2039 '((format "*-%.2d-%.2d"
2040 (string-to-number month
)
2041 (string-to-number day
))))
2042 ((eq calendar-date-style
'european
)
2043 '(day " " monthname
))
2044 (t '(monthname " " day
))))
2045 ;; Iso cannot contain "-", because this form used eg by
2046 ;; insert-anniversary-diary-entry.
2047 (t (cond ((eq calendar-date-style
'iso
)
2048 '((format "%s %.2d %.2d" year
2049 (string-to-number month
) (string-to-number day
))))
2050 ((eq calendar-date-style
'european
)
2051 '(day " " month
" " year
))
2052 (t '(month " " day
" " year
))))))
2054 (defun diary-insert-entry-1 (&optional type nomark months symbol absfunc
)
2055 "Subroutine to insert a diary entry related to the date at point.
2056 TYPE is the type of entry (`monthly' or `yearly'). NOMARK non-nil
2057 means make the entry non-marking. Array MONTHS is used in place
2058 of `calendar-month-name-array'. String SYMBOL marks the type of
2059 diary entry. Function ABSFUNC converts absolute dates to dates of
2060 the appropriate type."
2061 (let ((calendar-date-display-form (if type
2062 (diary-date-display-form type
)
2063 calendar-date-display-form
))
2064 (calendar-month-name-array (or months calendar-month-name-array
))
2065 (date (calendar-cursor-to-date t
)))
2067 (format "%s%s" (or symbol
"")
2068 (calendar-date-string
2070 (funcall absfunc
(calendar-absolute-from-gregorian date
))
2077 (defun diary-insert-monthly-entry (arg)
2078 "Insert a monthly diary entry for the day of the month indicated by point.
2079 Prefix argument ARG makes the entry nonmarking."
2081 (diary-insert-entry-1 'monthly arg
))
2084 (define-obsolete-function-alias 'insert-monthly-diary-entry
2085 'diary-insert-monthly-entry
"23.1")
2088 (defun diary-insert-yearly-entry (arg)
2089 "Insert an annual diary entry for the day of the year indicated by point.
2090 Prefix argument ARG makes the entry nonmarking."
2092 (diary-insert-entry-1 'yearly arg
))
2095 (define-obsolete-function-alias 'insert-yearly-diary-entry
2096 'diary-insert-yearly-entry
"23.1")
2099 (defun diary-insert-anniversary-entry (arg)
2100 "Insert an anniversary diary entry for the date given by point.
2101 Prefix argument ARG makes the entry nonmarking."
2103 (let ((calendar-date-display-form (diary-date-display-form)))
2105 (format "%s(diary-anniversary %s)"
2106 diary-sexp-entry-symbol
2107 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
2111 (define-obsolete-function-alias 'insert-anniversary-diary-entry
2112 'diary-insert-anniversary-entry
"23.1")
2115 (defun diary-insert-block-entry (arg)
2116 "Insert a block diary entry for the days between the point and marked date.
2117 Prefix argument ARG makes the entry nonmarking."
2119 (let ((calendar-date-display-form (diary-date-display-form))
2120 (cursor (calendar-cursor-to-date t
))
2121 (mark (or (car calendar-mark-ring
)
2122 (error "No mark set in this buffer")))
2124 (if (< (calendar-absolute-from-gregorian mark
)
2125 (calendar-absolute-from-gregorian cursor
))
2131 (format "%s(diary-block %s %s)"
2132 diary-sexp-entry-symbol
2133 (calendar-date-string start nil t
)
2134 (calendar-date-string end nil t
))
2138 (define-obsolete-function-alias 'insert-block-diary-entry
2139 'diary-insert-block-entry
"23.1")
2142 (defun diary-insert-cyclic-entry (arg)
2143 "Insert a cyclic diary entry starting at the date given by point.
2144 Prefix argument ARG makes the entry nonmarking."
2146 (let ((calendar-date-display-form (diary-date-display-form)))
2148 (format "%s(diary-cyclic %d %s)"
2149 diary-sexp-entry-symbol
2150 (calendar-read "Repeat every how many days: "
2151 (lambda (x) (> x
0)))
2152 (calendar-date-string (calendar-cursor-to-date t
) nil t
))
2156 (define-obsolete-function-alias 'insert-cyclic-diary-entry
2157 'diary-insert-cyclic-entry
"23.1")
2161 (defun diary-redraw-calendar ()
2162 "If `calendar-buffer' is live and diary entries are marked, redraw it."
2163 (and calendar-mark-diary-entries-flag
2166 ;; Return value suitable for `write-contents-functions'.
2169 (defvar diary-mode-map
2170 (let ((map (make-sparse-keymap)))
2171 (define-key map
"\C-c\C-s" 'diary-show-all-entries
)
2172 (define-key map
"\C-c\C-q" 'quit-window
)
2174 "Keymap for `diary-mode'.")
2176 (defun diary-font-lock-sexps (limit)
2177 "Recognize sexp diary entry up to LIMIT for font-locking."
2178 (if (re-search-forward
2179 (format "^%s?\\(%s\\)" (regexp-quote diary-nonmarking-symbol
)
2180 (regexp-quote diary-sexp-entry-symbol
))
2184 (narrow-to-region (point-min) limit
)
2185 (let ((start (point)))
2187 (store-match-data (list start
(point)))
2191 (defun diary-font-lock-date-forms (month-array &optional symbol abbrev-array
)
2192 "Create font-lock patterns for `diary-date-forms' using MONTH-ARRAY.
2193 If given, optional SYMBOL must be a prefix to entries.
2194 If optional ABBREV-ARRAY is present, the abbreviations constructed
2195 from this array by the function `calendar-abbrev-construct' are
2196 matched (with or without a final `.'), in addition to the full month
2198 (let ((dayname (diary-name-pattern calendar-day-name-array
2199 calendar-day-abbrev-array t
))
2200 (monthname (format "\\(%s\\|\\*\\)"
2201 (diary-name-pattern month-array abbrev-array
)))
2202 (month "\\([0-9]+\\|\\*\\)")
2203 (day "\\([0-9]+\\|\\*\\)")
2204 (year "-?\\([0-9]+\\|\\*\\)"))
2207 (concat "^" (regexp-quote diary-nonmarking-symbol
) "?"
2208 (if symbol
(regexp-quote symbol
) "") "\\("
2210 ;; If backup, omit first item (backup)
2211 ;; and last item (not part of date).
2212 (if (equal (car x
) 'backup
)
2213 (nreverse (cdr (reverse (cdr x
))))
2216 ;; With backup, last item is not part of date.
2217 (if (equal (car x
) 'backup
)
2218 (concat "\\)" (eval (car (reverse x
))))
2223 (defmacro diary-font-lock-keywords-1
(markfunc listfunc feature months symbol
)
2224 "Subroutine of the function `diary-font-lock-keywords'.
2225 If MARKFUNC is a member of `diary-nongregorian-marking-hook', or
2226 LISTFUNC of `diary-nongregorian-listing-hook', then require FEATURE and
2227 return a font-lock pattern matching array of MONTHS and marking SYMBOL."
2228 `(when (or (memq ',markfunc diary-nongregorian-marking-hook
)
2229 (memq ',listfunc diary-nongregorian-listing-hook
))
2231 (diary-font-lock-date-forms ,months
,symbol
)))
2233 (defconst diary-time-regexp
2234 ;; Accepted formats: 10:00 10.00 10h00 10h 10am 10:00am 10.00am
2235 ;; Use of "." as a separator annoyingly matches numbers, eg "123.45".
2236 ;; Hence often prefix this with "\\(^\\|\\s-\\)."
2237 (concat "[0-9]?[0-9]\\([AaPp][mM]\\|\\("
2238 "[Hh]\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]"
2239 "\\)\\([AaPp][Mm]\\)?\\)")
2240 "Regular expression matching a time of day.")
2242 (defvar calendar-hebrew-month-name-array-leap-year
)
2243 (defvar calendar-islamic-month-name-array
)
2244 (defvar calendar-bahai-month-name-array
)
2247 (defun diary-font-lock-keywords ()
2248 "Return a value for the variable `diary-font-lock-keywords'."
2250 (diary-font-lock-date-forms calendar-month-name-array
2251 nil calendar-month-abbrev-array
)
2252 (diary-font-lock-keywords-1 diary-hebrew-mark-entries
2253 diary-hebrew-list-entries
2255 calendar-hebrew-month-name-array-leap-year
2256 diary-hebrew-entry-symbol
)
2257 (diary-font-lock-keywords-1 diary-islamic-mark-entries
2258 diary-islamic-list-entries
2260 calendar-islamic-month-name-array
2261 diary-islamic-entry-symbol
)
2262 (diary-font-lock-keywords-1 diary-bahai-mark-entries
2263 diary-bahai-list-entries
2265 calendar-bahai-month-name-array
2266 diary-bahai-entry-symbol
)
2269 (format "^%s.*$" (regexp-quote diary-include-string
))
2270 'font-lock-keyword-face
)
2272 (format "^%s?\\(%s\\)" (regexp-quote diary-nonmarking-symbol
)
2273 (regexp-quote diary-sexp-entry-symbol
))
2274 '(1 font-lock-reference-face
))
2276 (format "^%s" (regexp-quote diary-nonmarking-symbol
))
2277 'font-lock-reference-face
)
2279 (format "^%s?%s" (regexp-quote diary-nonmarking-symbol
)
2280 (regexp-opt (mapcar 'regexp-quote
2281 (list diary-hebrew-entry-symbol
2282 diary-islamic-entry-symbol
2283 diary-bahai-entry-symbol
))
2285 '(1 font-lock-reference-face
))
2286 '(diary-font-lock-sexps . font-lock-keyword-face
)
2287 `(,(format "\\(^\\|\\s-\\)%s\\(-%s\\)?" diary-time-regexp
2291 (defvar diary-font-lock-keywords
(diary-font-lock-keywords)
2292 "Forms to highlight in `diary-mode'.")
2295 (define-derived-mode diary-mode fundamental-mode
"Diary"
2296 "Major mode for editing the diary file."
2297 (set (make-local-variable 'font-lock-defaults
)
2298 '(diary-font-lock-keywords t
))
2299 (add-to-invisibility-spec '(diary . nil
))
2300 (add-hook 'after-save-hook
'diary-redraw-calendar nil t
)
2301 (if diary-header-line-flag
2302 (setq header-line-format diary-header-line-format
)))
2305 ;;; Fancy Diary Mode.
2307 (defvar diary-fancy-date-pattern
2309 (let ((dayname (diary-name-pattern calendar-day-name-array nil t
))
2310 (monthname (diary-name-pattern calendar-month-name-array nil t
))
2314 (mapconcat 'eval calendar-date-display-form
""))
2315 ;; Optional ": holiday name" after the date.
2317 "Regular expression matching a date header in Fancy Diary.")
2319 (define-obsolete-variable-alias 'fancy-diary-font-lock-keywords
2320 'diary-fancy-font-lock-keywords
"23.1")
2322 (defvar diary-fancy-font-lock-keywords
2325 ;; Any number of " other holiday name" lines, followed by "==" line.
2326 (concat diary-fancy-date-pattern
"\\(\n +.*\\)*\n=+$")
2327 '(0 (progn (put-text-property (match-beginning 0) (match-end 0)
2328 'font-lock-multiline t
)
2330 '("^.*\\([aA]nniversary\\|[bB]irthday\\).*$" .
'diary-anniversary
)
2331 '("^.*Yahrzeit.*$" . font-lock-reference-face
)
2332 '("^\\(Erev \\)?Rosh Hodesh.*" . font-lock-function-name-face
)
2333 '("^Day.*omer.*$" . font-lock-builtin-face
)
2334 '("^Parashat.*$" . font-lock-comment-face
)
2335 `(,(format "\\(^\\|\\s-\\)%s\\(-%s\\)?" diary-time-regexp
2336 diary-time-regexp
) .
'diary-time
))
2337 "Keywords to highlight in fancy diary display.")
2339 ;; If region looks like it might start or end in the middle of a
2340 ;; multiline pattern, extend the region to encompass the whole pattern.
2341 (defun diary-fancy-font-lock-fontify-region-function (beg end
&optional verbose
)
2342 "Function to use for `font-lock-fontify-region-function' in Fancy Diary.
2343 Needed to handle multiline keyword in `diary-fancy-font-lock-keywords'.
2344 Fontify the region between BEG and END, quietly unless VERBOSE is non-nil."
2347 (if (looking-at "=+$") (forward-line -
1))
2348 (while (and (looking-at " +[^ ]")
2349 (zerop (forward-line -
1))))
2350 ;; This check not essential.
2351 (if (looking-at diary-fancy-date-pattern
)
2352 (setq beg
(line-beginning-position)))
2355 (while (and (looking-at " +[^ ]")
2356 (zerop (forward-line 1))))
2357 (if (looking-at "=+$")
2358 (setq end
(line-beginning-position 2)))
2359 (font-lock-default-fontify-region beg end verbose
))
2361 (define-derived-mode diary-fancy-display-mode fundamental-mode
2363 "Major mode used while displaying diary entries using Fancy Display."
2364 (set (make-local-variable 'font-lock-defaults
)
2365 '(diary-fancy-font-lock-keywords
2367 (font-lock-fontify-region-function
2368 . diary-fancy-font-lock-fontify-region-function
)))
2369 (local-set-key "q" 'quit-window
))
2371 (define-obsolete-function-alias 'fancy-diary-display-mode
2372 'diary-fancy-display-mode
"23.1")
2374 ;; Following code from Dave Love <fx@gnu.org>.
2375 ;; Import Outlook-format appointments from mail messages in Gnus or
2376 ;; Rmail using command `diary-from-outlook'. This, or the specialized
2377 ;; functions `diary-from-outlook-gnus' and `diary-from-outlook-rmail',
2378 ;; could be run from hooks to notice appointments automatically (in
2379 ;; which case they will prompt about adding to the diary). The
2380 ;; message formats recognized are customizable through
2381 ;; `diary-outlook-formats'.
2383 (defvar subject
) ; bound in diary-from-outlook-gnus
2385 (defun diary-from-outlook-internal (&optional test-only
)
2386 "Snarf a diary entry from a message assumed to be from MS Outlook.
2387 Assumes `body' is bound to a string comprising the body of the message and
2388 `subject' is bound to a string comprising its subject.
2389 Arg TEST-ONLY non-nil means return non-nil if and only if the
2390 message contains an appointment, don't make a diary entry."
2392 (let (format-string)
2393 (dotimes (i (length diary-outlook-formats
))
2394 (when (eq 0 (string-match (car (nth i diary-outlook-formats
))
2397 (setq format-string
(cdr (nth i diary-outlook-formats
)))
2399 (save-window-excursion
2400 ;; Fixme: References to optional fields in the format
2401 ;; are treated literally, not replaced by the empty
2402 ;; string. I think this is an Emacs bug.
2404 (format (replace-match (if (functionp format-string
)
2405 (funcall format-string body
)
2407 t nil
(match-string 0 body
))
2410 (throw 'finished t
))))
2413 (defvar gnus-article-mime-handles
)
2414 (defvar gnus-article-buffer
)
2416 (autoload 'gnus-fetch-field
"gnus-util")
2417 (autoload 'gnus-narrow-to-body
"gnus")
2418 (autoload 'mm-get-part
"mm-decode")
2420 (defun diary-from-outlook-gnus (&optional noconfirm
)
2421 "Maybe snarf diary entry from Outlook-generated message in Gnus.
2422 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2423 this function is called interactively), then if an entry is found the
2424 user is asked to confirm its addition.
2425 Add this function to `gnus-article-prepare-hook' to notice appointments
2428 (with-current-buffer gnus-article-buffer
2429 (let ((subject (gnus-fetch-field "subject"))
2430 (body (if gnus-article-mime-handles
2431 ;; We're multipart. Don't get confused by part
2432 ;; buttons &c. Assume info is in first part.
2433 (mm-get-part (nth 1 gnus-article-mime-handles
))
2435 (gnus-narrow-to-body)
2437 (when (diary-from-outlook-internal t
)
2438 (when (or noconfirm
(y-or-n-p "Snarf diary entry? "))
2439 (diary-from-outlook-internal)
2440 (message "Diary entry added"))))))
2442 (custom-add-option 'gnus-article-prepare-hook
'diary-from-outlook-gnus
)
2444 (defvar rmail-buffer
)
2446 (defun diary-from-outlook-rmail (&optional noconfirm
)
2447 "Maybe snarf diary entry from Outlook-generated message in Rmail.
2448 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2449 this function is called interactively), then if an entry is found the
2450 user is asked to confirm its addition."
2452 (with-current-buffer rmail-buffer
2453 (let ((subject (mail-fetch-field "subject"))
2454 (body (buffer-substring (save-excursion
2458 (when (diary-from-outlook-internal t
)
2459 (when (or noconfirm
(y-or-n-p "Snarf diary entry? "))
2460 (diary-from-outlook-internal)
2461 (message "Diary entry added"))))))
2463 (defun diary-from-outlook (&optional noconfirm
)
2464 "Maybe snarf diary entry from current Outlook-generated message.
2465 Currently knows about Gnus and Rmail modes. Unless the optional
2466 argument NOCONFIRM is non-nil (which is the case when this
2467 function is called interactively), then if an entry is found the
2468 user is asked to confirm its addition."
2471 ((eq major-mode
'rmail-mode
)
2472 #'diary-from-outlook-rmail
)
2473 ((memq major-mode
'(gnus-summary-mode gnus-article-mode
))
2474 #'diary-from-outlook-gnus
)
2475 (t (error "Don't know how to snarf in `%s'" major-mode
)))))
2476 (funcall func noconfirm
)))
2478 (provide 'diary-lib
)
2480 ;; arch-tag: 22dd506e-2e33-410d-9ae1-095a0c1b2010
2481 ;;; diary-lib.el ends here