1 ;;; diary-lib.el --- diary functions
3 ;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995, 2003, 2004, 2005
4 ;; Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <gmorris@ast.cam.ac.uk>
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 2, or (at your option)
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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; This collection of functions implements the diary features as described
32 ;; Comments, corrections, and improvements should be sent to
33 ;; Edward M. Reingold Department of Computer Science
34 ;; (217) 333-6733 University of Illinois at Urbana-Champaign
35 ;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
36 ;; Urbana, Illinois 61801
42 (defun diary-check-diary-file ()
43 "Check that the file specified by `diary-file' exists and is readable.
44 If so, return the expanded file name, otherwise signal an error."
45 (let ((d-file (substitute-in-file-name diary-file)))
46 (if (and d-file (file-exists-p d-file))
47 (if (file-readable-p d-file)
49 (error "Diary file `%s' is not readable" diary-file))
50 (error "Diary file `%s' does not exist" diary-file))))
53 (defun diary (&optional arg)
54 "Generate the diary window for ARG days starting with the current date.
55 If no argument is provided, the number of days of diary entries is governed
56 by the variable `number-of-diary-entries'. A value of ARG less than 1
57 does nothing. This function is suitable for execution in a `.emacs' file."
59 (diary-check-diary-file)
60 (let ((date (calendar-current-date)))
63 (cond (arg (prefix-numeric-value arg))
64 ((vectorp number-of-diary-entries)
65 (aref number-of-diary-entries (calendar-day-of-week date)))
66 (t number-of-diary-entries)))))
68 (defun view-diary-entries (arg)
69 "Prepare and display a buffer with diary entries.
70 Searches the file named in `diary-file' for entries that
71 match ARG days starting with the date indicated by the cursor position
72 in the displayed three-month calendar."
74 (diary-check-diary-file)
75 (list-diary-entries (calendar-cursor-to-date t) arg))
77 (defun view-other-diary-entries (arg d-file)
78 "Prepare and display buffer of diary entries from an alternative diary file.
79 Searches for entries that match ARG days, starting with the date indicated
80 by the cursor position in the displayed three-month calendar.
81 D-FILE specifies the file to use as the diary file."
83 (list (prefix-numeric-value current-prefix-arg)
84 (read-file-name "Enter diary file name: " default-directory nil t)))
85 (let ((diary-file d-file))
86 (view-diary-entries arg)))
88 (autoload 'check-calendar-holidays "holidays"
89 "Check the list of holidays for any that occur on DATE.
90 The value returned is a list of strings of relevant holiday descriptions.
91 The holidays are those in the list `calendar-holidays'.")
93 (autoload 'calendar-holiday-list "holidays"
94 "Form the list of holidays that occur on dates in the calendar window.
95 The holidays are those in the list `calendar-holidays'.")
97 (autoload 'diary-french-date "cal-french"
98 "French calendar equivalent of date diary entry.")
100 (autoload 'diary-mayan-date "cal-mayan"
101 "Mayan calendar equivalent of date diary entry.")
103 (autoload 'diary-iso-date "cal-iso"
104 "ISO calendar equivalent of date diary entry.")
106 (autoload 'diary-julian-date "cal-julian"
107 "Julian calendar equivalent of date diary entry.")
109 (autoload 'diary-astro-day-number "cal-julian"
110 "Astronomical (Julian) day number diary entry.")
112 (autoload 'diary-chinese-date "cal-china"
113 "Chinese calendar equivalent of date diary entry.")
115 (autoload 'diary-islamic-date "cal-islam"
116 "Islamic calendar equivalent of date diary entry.")
118 (autoload 'list-islamic-diary-entries "cal-islam"
119 "Add any Islamic date entries from the diary file to `diary-entries-list'.")
121 (autoload 'mark-islamic-diary-entries "cal-islam"
122 "Mark days in the calendar window that have Islamic date diary entries.")
124 (autoload 'mark-islamic-calendar-date-pattern "cal-islam"
125 "Mark dates in calendar window that conform to Islamic date MONTH/DAY/YEAR.")
127 (autoload 'diary-bahai-date "cal-bahai"
128 "Baha'i calendar equivalent of date diary entry."
131 (autoload 'list-bahai-diary-entries "cal-bahai"
132 "Add any Baha'i date entries from the diary file to `diary-entries-list'."
135 (autoload 'mark-bahai-diary-entries "cal-bahai"
136 "Mark days in the calendar window that have Baha'i date diary entries."
139 (autoload 'mark-bahai-calendar-date-pattern "cal-bahai"
140 "Mark dates in calendar window that conform to Baha'i date MONTH/DAY/YEAR."
143 (autoload 'diary-hebrew-date "cal-hebrew"
144 "Hebrew calendar equivalent of date diary entry.")
146 (autoload 'diary-omer "cal-hebrew"
147 "Omer count diary entry.")
149 (autoload 'diary-yahrzeit "cal-hebrew"
150 "Yahrzeit diary entry--entry applies if date is yahrzeit or the day before.")
152 (autoload 'diary-parasha "cal-hebrew"
153 "Parasha diary entry--entry applies if date is a Saturday.")
155 (autoload 'diary-rosh-hodesh "cal-hebrew"
156 "Rosh Hodesh diary entry.")
158 (autoload 'list-hebrew-diary-entries "cal-hebrew"
159 "Add any Hebrew date entries from the diary file to `diary-entries-list'.")
161 (autoload 'mark-hebrew-diary-entries "cal-hebrew"
162 "Mark days in the calendar window that have Hebrew date diary entries.")
164 (autoload 'mark-hebrew-calendar-date-pattern "cal-hebrew"
165 "Mark dates in calendar window that conform to Hebrew date MONTH/DAY/YEAR.")
167 (autoload 'diary-coptic-date "cal-coptic"
168 "Coptic calendar equivalent of date diary entry.")
170 (autoload 'diary-ethiopic-date "cal-coptic"
171 "Ethiopic calendar equivalent of date diary entry.")
173 (autoload 'diary-persian-date "cal-persia"
174 "Persian calendar equivalent of date diary entry.")
176 (autoload 'diary-phases-of-moon "lunar" "Moon phases diary entry.")
178 (autoload 'diary-sunrise-sunset "solar"
179 "Local time of sunrise and sunset as a diary entry.")
181 (autoload 'diary-sabbath-candles "solar"
182 "Local time of candle lighting diary entry--applies if date is a Friday.
183 No diary entry if there is no sunset on that date.")
185 (defvar diary-syntax-table (copy-syntax-table (standard-syntax-table))
186 "The syntax table used when parsing dates in the diary file.
187 It is the standard syntax table used in Fundamental mode, but with the
188 syntax of `*' and `:' changed to be word constituents.")
190 (modify-syntax-entry ?* "w" diary-syntax-table)
191 (modify-syntax-entry ?: "w" diary-syntax-table)
193 (defvar diary-entries-list)
194 (defvar displayed-year)
195 (defvar displayed-month)
200 (defvar original-date)
202 (defun diary-attrtype-convert (attrvalue type)
203 "Convert string ATTRVALUE to TYPE appropriate for a face description.
204 Valid TYPEs are: string, symbol, int, stringtnil, tnil."
206 (setq ret (cond ((eq type 'string) attrvalue)
207 ((eq type 'symbol) (read attrvalue))
208 ((eq type 'int) (string-to-number attrvalue))
209 ((eq type 'stringtnil)
210 (cond ((string= "t" attrvalue) t)
211 ((string= "nil" attrvalue) nil)
214 (cond ((string= "t" attrvalue) t)
215 ((string= "nil" attrvalue) nil)))))
216 ; (message "(%s)[%s]=[%s]" (print type) attrvalue ret)
220 (defun diary-pull-attrs (entry fileglobattrs)
221 "Pull the face-related attributes off the entry, merge with the
222 fileglobattrs, and return the (possibly modified) entry and face
223 data in a list of attrname attrvalue values.
224 The entry will be modified to drop all tags that are used for face matching.
225 If entry is nil, then the fileglobattrs are being searched for,
226 the fileglobattrs variable is ignored, and
227 diary-glob-file-regexp-prefix is prepended to the regexps before each
230 (let (regexp regnum attrname attr-list attrname attrvalue type
235 attr-list diary-face-attrs)
237 (goto-char (point-min))
238 (setq attr (car attr-list)
241 attrname (nth 2 attr)
243 regexp (concat diary-glob-file-regexp-prefix regexp))
245 (if (re-search-forward regexp (point-max) t)
246 (setq attrvalue (buffer-substring-no-properties
247 (match-beginning regnum)
248 (match-end regnum))))
250 (setq attrvalue (diary-attrtype-convert attrvalue type)))
251 (setq ret-attr (append ret-attr (list attrname attrvalue))))
252 (setq attr-list (cdr attr-list)))
253 (setq fileglobattrs ret-attr))
255 (setq ret-attr fileglobattrs
256 attr-list diary-face-attrs)
258 (goto-char (point-min))
259 (setq attr (car attr-list)
262 attrname (nth 2 attr)
265 (if (string-match regexp entry)
267 (setq attrvalue (substring-no-properties entry
268 (match-beginning regnum)
270 (setq entry (replace-match "" t t entry))))
272 (setq attrvalue (diary-attrtype-convert attrvalue type)))
273 (setq ret-attr (append ret-attr (list attrname attrvalue))))
274 (setq attr-list (cdr attr-list)))))
275 (list entry ret-attr))))
278 ;; This can be removed once the kill/yank treatment of invisible text
279 ;; (see etc/TODO) is fixed. -- gm
280 (defcustom diary-header-line-flag t
281 "*If non-nil, `simple-diary-display' will show a header line.
282 The format of the header is specified by `diary-header-line-format'."
287 (defcustom diary-header-line-format
288 '(:eval (calendar-string-spread
289 (list (if selective-display
290 "Selective display active - press \"s\" in calendar \
294 "*Format of the header line displayed by `simple-diary-display'.
295 Only used if `diary-header-line-flag' is non-nil."
300 (defvar diary-saved-point) ; internal
302 (defun list-diary-entries (date number)
303 "Create and display a buffer containing the relevant lines in diary-file.
304 The arguments are DATE and NUMBER; the entries selected are those
305 for NUMBER days starting with date DATE. The other entries are hidden
306 using selective display. If NUMBER is less than 1, this function does nothing.
308 Returns a list of all relevant diary entries found, if any, in order by date.
309 The list entries have the form ((month day year) string specifier) where
310 \(month day year) is the date of the entry, string is the entry text, and
311 specifier is the applicability. If the variable `diary-list-include-blanks'
312 is t, this list includes a dummy diary entry consisting of the empty string)
313 for a date with no diary entries.
315 After the list is prepared, the hooks `nongregorian-diary-listing-hook',
316 `list-diary-entries-hook', `diary-display-hook', and `diary-hook' are run.
317 These hooks have the following distinct roles:
319 `nongregorian-diary-listing-hook' can cull dates from the diary
320 and each included file. Usually used for Hebrew or Islamic
321 diary entries in files. Applied to *each* file.
323 `list-diary-entries-hook' adds or manipulates diary entries from
324 external sources. Used, for example, to include diary entries
325 from other files or to sort the diary entries. Invoked *once* only,
326 before the display hook is run.
328 `diary-display-hook' does the actual display of information. If this is
329 nil, simple-diary-display will be used. Use add-hook to set this to
330 fancy-diary-display, if desired. If you want no diary display, use
331 add-hook to set this to ignore.
333 `diary-hook' is run last. This can be used for an appointment
334 notification function."
337 (let ((original-date date);; save for possible use in the hooks
338 old-diary-syntax-table
341 (date-string (calendar-date-string date))
342 (d-file (substitute-in-file-name diary-file)))
343 (message "Preparing diary...")
345 (let ((diary-buffer (find-buffer-visiting d-file)))
346 (if (not diary-buffer)
347 (set-buffer (find-file-noselect d-file t))
348 (set-buffer diary-buffer)
349 (or (verify-visited-file-modtime diary-buffer)
350 (revert-buffer t t))))
351 ;; d-s-p is passed to the diary display function.
352 (let ((diary-saved-point (point)))
354 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil "")))
355 (setq selective-display t)
356 (setq selective-display-ellipses nil)
357 (if diary-header-line-flag
358 (setq header-line-format diary-header-line-format))
359 (setq old-diary-syntax-table (syntax-table))
360 (set-syntax-table diary-syntax-table)
362 (let ((buffer-read-only nil)
363 (diary-modified (buffer-modified-p))
364 (mark (regexp-quote diary-nonmarking-symbol)))
365 ;; First and last characters must be ^M or \n for
366 ;; selective display to work properly
367 (goto-char (1- (point-max)))
368 (if (not (looking-at "\^M\\|\n"))
370 (goto-char (point-max))
372 (goto-char (point-min))
373 (if (not (looking-at "\^M\\|\n"))
375 (subst-char-in-region (point-min) (point-max) ?\n ?\^M t)
377 i from 1 to number do
378 (let ((d diary-date-forms)
379 (month (extract-calendar-month date))
380 (day (extract-calendar-day date))
381 (year (extract-calendar-year date))
382 (entry-found (list-sexp-diary-entries date)))
385 ((date-form (if (equal (car (car d)) 'backup)
388 (backup (equal (car (car d)) 'backup))
390 (format "%s\\|%s\\.?"
391 (calendar-day-name date)
392 (calendar-day-name date 'abbrev)))
394 (format "\\*\\|%s\\|%s\\.?"
395 (calendar-month-name month)
396 (calendar-month-name month 'abbrev)))
397 (month (concat "\\*\\|0*" (int-to-string month)))
398 (day (concat "\\*\\|0*" (int-to-string day)))
401 "\\*\\|0*" (int-to-string year)
402 (if abbreviated-calendar-year
403 (concat "\\|" (format "%02d" (% year 100)))
407 "\\(\\`\\|\^M\\|\n\\)" mark "?\\("
408 (mapconcat 'eval date-form "\\)\\(")
410 (case-fold-search t))
411 (goto-char (point-min))
412 (while (re-search-forward regexp nil t)
413 (if backup (re-search-backward "\\<" nil t))
414 (if (and (or (char-equal (preceding-char) ?\^M)
415 (char-equal (preceding-char) ?\n))
416 (not (looking-at " \\|\^I")))
417 ;; Diary entry that consists only of date.
419 ;; Found a nonempty diary entry--make it
420 ;; visible and add it to the list.
422 (let ((entry-start (point))
424 (re-search-backward "\^M\\|\n\\|\\`")
425 (setq date-start (point))
426 (re-search-forward "\^M\\|\n" nil t 2)
427 (while (looking-at " \\|\^I")
428 (re-search-forward "\^M\\|\n" nil t))
430 (subst-char-in-region date-start
432 (setq entry (buffer-substring entry-start (point))
433 temp (diary-pull-attrs entry file-glob-attrs)
439 (1+ date-start) (1- entry-start))
440 (copy-marker entry-start) (nth 1 temp))))))
443 (not diary-list-include-blanks)
444 (setq diary-entries-list
445 (append diary-entries-list
446 (list (list date "" "" "" "")))))
448 (calendar-gregorian-from-absolute
449 (1+ (calendar-absolute-from-gregorian date))))
450 (setq entry-found nil)))
451 (set-buffer-modified-p diary-modified))
452 (set-syntax-table old-diary-syntax-table))
453 (goto-char (point-min))
454 (run-hooks 'nongregorian-diary-listing-hook
455 'list-diary-entries-hook)
456 (if diary-display-hook
457 (run-hooks 'diary-display-hook)
458 (simple-diary-display))
459 (run-hooks 'diary-hook)
460 diary-entries-list))))))
462 (defun include-other-diary-files ()
463 "Include the diary entries from other diary files with those of diary-file.
464 This function is suitable for use in `list-diary-entries-hook';
465 it enables you to use shared diary files together with your own.
466 The files included are specified in the diaryfile by lines of this form:
467 #include \"filename\"
468 This is recursive; that is, #include directives in diary files thus included
469 are obeyed. You can change the `#include' to some other string by
470 changing the variable `diary-include-string'."
471 (goto-char (point-min))
472 (while (re-search-forward
474 "\\(\\`\\|\^M\\|\n\\)"
475 (regexp-quote diary-include-string)
478 (let* ((diary-file (substitute-in-file-name
479 (buffer-substring-no-properties
480 (match-beginning 2) (match-end 2))))
481 (diary-list-include-blanks nil)
482 (list-diary-entries-hook 'include-other-diary-files)
483 (diary-display-hook 'ignore)
485 (d-buffer (find-buffer-visiting diary-file))
486 (diary-modified (if d-buffer
488 (set-buffer d-buffer)
489 (buffer-modified-p)))))
490 (if (file-exists-p diary-file)
491 (if (file-readable-p diary-file)
493 (setq diary-entries-list
494 (append diary-entries-list
495 (list-diary-entries original-date number)))
497 (set-buffer (find-buffer-visiting diary-file))
498 (let ((inhibit-read-only t))
499 (subst-char-in-region (point-min) (point-max) ?\^M ?\n t))
500 (setq selective-display nil)
501 (set-buffer-modified-p diary-modified)))
503 (message "Can't read included diary file %s" diary-file)
506 (message "Can't find included diary file %s" diary-file)
508 (goto-char (point-min)))
510 (defun simple-diary-display ()
511 "Display the diary buffer if there are any relevant entries or holidays."
512 (let* ((holiday-list (if holidays-in-diary-buffer
513 (check-calendar-holidays original-date)))
514 (hol-string (format "%s%s%s"
516 (if holiday-list ": " "")
517 (mapconcat 'identity holiday-list "; ")))
518 (msg (format "No diary entries for %s" hol-string))
519 ;; If selected window is dedicated (to the calendar),
520 ;; need a new one to display the diary.
521 (pop-up-frames (window-dedicated-p (selected-window))))
522 (calendar-set-mode-line (format "Diary for %s" hol-string))
523 (if (or (not diary-entries-list)
524 (and (not (cdr diary-entries-list))
525 (string-equal (car (cdr (car diary-entries-list))) "")))
526 (if (< (length msg) (frame-width))
528 (set-buffer (get-buffer-create holiday-buffer))
529 (setq buffer-read-only nil)
530 (calendar-set-mode-line date-string)
532 (insert (mapconcat 'identity holiday-list "\n"))
533 (goto-char (point-min))
534 (set-buffer-modified-p nil)
535 (setq buffer-read-only t)
536 (display-buffer holiday-buffer)
537 (message "No diary entries for %s" date-string))
539 (find-buffer-visiting (substitute-in-file-name diary-file))
540 (let ((window (display-buffer (current-buffer))))
541 ;; d-s-p is passed from list-diary-entries.
542 (set-window-point window diary-saved-point)
543 (set-window-start window (point-min))))
544 (message "Preparing diary...done"))))
546 (defface diary-button '((((type pc) (class color))
547 (:foreground "lightblue")))
548 "Default face used for buttons."
551 ;; backward-compatibility alias
552 (put 'diary-button-face 'face-alias 'diary-button)
554 (define-button-type 'diary-entry
555 'action #'diary-goto-entry
558 (defun diary-goto-entry (button)
559 (let ((marker (button-get button 'marker)))
561 (pop-to-buffer (marker-buffer marker))
562 (goto-char (marker-position marker)))))
564 (defun fancy-diary-display ()
565 "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
566 This function is provided for optional use as the `diary-display-hook'."
567 (save-excursion;; Turn off selective-display in the diary file's buffer.
568 (set-buffer (find-buffer-visiting (substitute-in-file-name diary-file)))
569 (let ((diary-modified (buffer-modified-p)))
570 (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
571 (setq selective-display nil)
572 (kill-local-variable 'mode-line-format)
573 (set-buffer-modified-p diary-modified)))
574 (if (or (not diary-entries-list)
575 (and (not (cdr diary-entries-list))
576 (string-equal (car (cdr (car diary-entries-list))) "")))
577 (let* ((holiday-list (if holidays-in-diary-buffer
578 (check-calendar-holidays original-date)))
579 (msg (format "No diary entries for %s %s"
580 (concat date-string (if holiday-list ":" ""))
581 (mapconcat 'identity holiday-list "; "))))
582 (if (<= (length msg) (frame-width))
584 (set-buffer (get-buffer-create holiday-buffer))
585 (setq buffer-read-only nil)
587 (insert (mapconcat 'identity holiday-list "\n"))
588 (goto-char (point-min))
589 (set-buffer-modified-p nil)
590 (setq buffer-read-only t)
591 (display-buffer holiday-buffer)
592 (message "No diary entries for %s" date-string)))
593 (save-excursion;; Prepare the fancy diary buffer.
594 (set-buffer (make-fancy-diary-buffer))
595 (setq buffer-read-only nil)
596 (let ((entry-list diary-entries-list)
598 (holiday-list-last-month 1)
599 (holiday-list-last-year 1)
602 (if (not (calendar-date-equal date (car (car entry-list))))
604 (setq date (car (car entry-list)))
605 (and holidays-in-diary-buffer
606 (calendar-date-compare
607 (list (list holiday-list-last-month
608 (calendar-last-day-of-month
609 holiday-list-last-month
610 holiday-list-last-year)
611 holiday-list-last-year))
613 ;; We need to get the holidays for the next 3 months.
614 (setq holiday-list-last-month
615 (extract-calendar-month date))
616 (setq holiday-list-last-year
617 (extract-calendar-year date))
619 (increment-calendar-month
620 holiday-list-last-month holiday-list-last-year 1)
623 (let ((displayed-month holiday-list-last-month)
624 (displayed-year holiday-list-last-year))
625 (calendar-holiday-list)))
626 (increment-calendar-month
627 holiday-list-last-month holiday-list-last-year 1))
628 (let* ((date-string (calendar-date-string date))
630 (let ((h holiday-list)
632 ;; Make a list of all holidays for date.
634 (if (calendar-date-equal date (car (car h)))
635 (setq d (append d (cdr (car h)))))
638 (insert (if (= (point) (point-min)) "" ?\n) date-string)
639 (if date-holiday-list (insert ": "))
640 (let* ((l (current-column))
642 (insert (mapconcat (lambda (x)
643 (if (< longest (length x))
644 (setq longest (length x)))
647 (concat "\n" (make-string l ? ))))
648 (insert ?\n (make-string (+ l longest) ?=) ?\n)))))
650 (setq entry (car (cdr (car entry-list))))
651 (if (< 0 (length entry))
653 (if (nth 3 (car entry-list))
654 (insert-button (concat entry "\n")
655 'marker (nth 3 (car entry-list))
659 (let* ((marks (nth 4 (car entry-list)))
660 (temp-face (make-symbol
663 (mapcar '(lambda (sym)
669 (make-face temp-face)
670 ;; Remove :face info from the marks,
671 ;; copy the face info into temp-face
672 (while (setq faceinfo (memq :face faceinfo))
673 (copy-face (read (nth 1 faceinfo)) temp-face)
674 (setcar faceinfo nil)
675 (setcar (cdr faceinfo) nil))
676 (setq marks (delq nil marks))
677 ;; Apply the font aspects
678 (apply 'set-face-attribute temp-face nil marks)
679 (search-backward entry)
681 (make-overlay (match-beginning 0) (match-end 0))
683 (setq entry-list (cdr entry-list))))
684 (set-buffer-modified-p nil)
685 (goto-char (point-min))
686 (setq buffer-read-only t)
687 (display-buffer fancy-diary-buffer)
688 (fancy-diary-display-mode)
689 (calendar-set-mode-line date-string)
690 (message "Preparing diary...done"))))
692 (defun make-fancy-diary-buffer ()
693 "Create and return the initial fancy diary buffer."
695 (set-buffer (get-buffer-create fancy-diary-buffer))
696 (setq buffer-read-only nil)
697 (calendar-set-mode-line "Diary Entries")
699 (set-buffer-modified-p nil)
700 (setq buffer-read-only t)
701 (get-buffer fancy-diary-buffer)))
703 (defun print-diary-entries ()
704 "Print a hard copy of the diary display.
706 If the simple diary display is being used, prepare a temp buffer with the
707 visible lines of the diary buffer, add a heading line composed from the mode
708 line, print the temp buffer, and destroy it.
710 If the fancy diary display is being used, just print the buffer.
712 The hooks given by the variable `print-diary-entries-hook' are called to do
713 the actual printing."
715 (if (bufferp (get-buffer fancy-diary-buffer))
717 (set-buffer (get-buffer fancy-diary-buffer))
718 (run-hooks 'print-diary-entries-hook))
720 (find-buffer-visiting (substitute-in-file-name diary-file))))
722 (let ((temp-buffer (get-buffer-create "*Printable Diary Entries*"))
725 (set-buffer diary-buffer)
727 (if (not (stringp mode-line-format))
729 (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
730 (substring mode-line-format
731 (match-beginning 1) (match-end 1))))
732 (copy-to-buffer temp-buffer (point-min) (point-max))
733 (set-buffer temp-buffer)
734 (while (re-search-forward "\^M.*$" nil t)
736 (goto-char (point-min))
738 (make-string (length heading) ?=) "\n")
739 (run-hooks 'print-diary-entries-hook)
740 (kill-buffer temp-buffer)))
741 (error "You don't have a diary buffer!")))))
743 (defun show-all-diary-entries ()
744 "Show all of the diary entries in the diary file.
745 This function gets rid of the selective display of the diary file so that
746 all entries, not just some, are visible. If there is no diary buffer, one
749 (let ((d-file (diary-check-diary-file))
750 (pop-up-frames (window-dedicated-p (selected-window))))
752 (set-buffer (or (find-buffer-visiting d-file)
753 (find-file-noselect d-file t)))
754 (let ((buffer-read-only nil)
755 (diary-modified (buffer-modified-p)))
756 (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
757 (setq selective-display nil
758 mode-line-format default-mode-line-format)
759 (display-buffer (current-buffer))
760 (set-buffer-modified-p diary-modified)))))
762 (defcustom diary-mail-addr
763 (if (boundp 'user-mail-address) user-mail-address "")
764 "*Email address that `diary-mail-entries' will send email to."
769 (defcustom diary-mail-days 7
770 "*Default number of days for `diary-mail-entries' to check."
776 (defun diary-mail-entries (&optional ndays)
777 "Send a mail message showing diary entries for next NDAYS days.
778 If no prefix argument is given, NDAYS is set to `diary-mail-days'.
779 Mail is sent to the address specified by `diary-mail-addr'.
781 You can call `diary-mail-entries' every night using an at/cron job.
782 For example, this script will run the program at 2am daily. Since
783 `emacs -batch' does not load your `.emacs' file, you must ensure that
784 all relevant variables are set, as done here.
787 # diary-rem.sh -- repeatedly run the Emacs diary-reminder
789 -eval \"(setq diary-mail-days 3 \\
790 diary-file \\\"/path/to/diary.file\\\" \\
791 european-calendar-style t \\
792 diary-mail-addr \\\"user@host.name\\\" )\" \\
793 -l diary-lib -f diary-mail-entries
794 at -f diary-rem.sh 0200 tomorrow
796 You may have to tweak the syntax of the `at' command to suit your
797 system. Alternatively, you can specify a cron entry:
798 0 1 * * * diary-rem.sh
799 to run it every morning at 1am."
801 (if (string-equal diary-mail-addr "")
802 (error "You must set `diary-mail-addr' to use this command")
803 (let ((diary-display-hook 'fancy-diary-display))
804 (list-diary-entries (calendar-current-date) (or ndays diary-mail-days)))
805 (compose-mail diary-mail-addr
806 (concat "Diary entries generated "
807 (calendar-date-string (calendar-current-date))))
809 (if (get-buffer fancy-diary-buffer)
811 (set-buffer fancy-diary-buffer)
812 (buffer-substring (point-min) (point-max)))
814 (call-interactively (get mail-user-agent 'sendfunc))))
816 (defun diary-name-pattern (string-array &optional abbrev-array paren)
817 "Return a regexp matching the strings in the array STRING-ARRAY.
818 If the optional argument ABBREV-ARRAY is present, then the function
819 `calendar-abbrev-construct' is used to construct abbreviations from the
820 two supplied arrays. The returned regexp will then also match these
821 abbreviations, with or without final `.' characters. If the optional
822 argument PAREN is non-nil, the regexp is surrounded by parentheses."
823 (regexp-opt (append string-array
825 (calendar-abbrev-construct abbrev-array
828 (calendar-abbrev-construct abbrev-array
834 (defvar marking-diary-entries nil
835 "True during the marking of diary entries, nil otherwise.")
837 (defvar marking-diary-entry nil
838 "True during the marking of diary entries, if current entry is marking.")
840 (defun mark-diary-entries (&optional redraw)
841 "Mark days in the calendar window that have diary entries.
842 Each entry in the diary file visible in the calendar window is
843 marked. After the entries are marked, the hooks
844 `nongregorian-diary-marking-hook' and `mark-diary-entries-hook'
845 are run. If the optional argument REDRAW is non-nil (which is
846 the case interactively, for example) then any existing diary
847 marks are first removed. This is intended to deal with deleted
850 ;; To remove any deleted diary entries. Do not redraw when:
851 ;; i) processing #include diary files (else only get the marks from
852 ;; the last #include file processed).
853 ;; ii) called via calendar-redraw (since calendar has already been
855 ;; Use of REDRAW handles both of these cases.
856 (when (and redraw mark-diary-entries-in-calendar)
857 (setq mark-diary-entries-in-calendar nil)
859 (let ((marking-diary-entries t)
860 file-glob-attrs marks)
862 (set-buffer (find-file-noselect (diary-check-diary-file) t))
863 (setq mark-diary-entries-in-calendar t)
864 (message "Marking diary entries...")
865 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
866 (let ((d diary-date-forms)
867 (old-diary-syntax-table (syntax-table))
869 (set-syntax-table diary-syntax-table)
871 (let* ((date-form (if (equal (car (car d)) 'backup)
873 (car d)));; ignore 'backup directive
875 (diary-name-pattern calendar-day-name-array
876 calendar-day-abbrev-array))
879 (diary-name-pattern calendar-month-name-array
880 calendar-month-abbrev-array)))
881 (month "[0-9]+\\|\\*")
883 (year "[0-9]+\\|\\*")
884 (l (length date-form))
885 (d-name-pos (- l (length (memq 'dayname date-form))))
886 (d-name-pos (if (/= l d-name-pos) (+ 2 d-name-pos)))
887 (m-name-pos (- l (length (memq 'monthname date-form))))
888 (m-name-pos (if (/= l m-name-pos) (+ 2 m-name-pos)))
889 (d-pos (- l (length (memq 'day date-form))))
890 (d-pos (if (/= l d-pos) (+ 2 d-pos)))
891 (m-pos (- l (length (memq 'month date-form))))
892 (m-pos (if (/= l m-pos) (+ 2 m-pos)))
893 (y-pos (- l (length (memq 'year date-form))))
894 (y-pos (if (/= l y-pos) (+ 2 y-pos)))
897 "\\(\\`\\|\^M\\|\n\\)\\("
898 (mapconcat 'eval date-form "\\)\\(")
900 (case-fold-search t))
901 (goto-char (point-min))
902 (while (re-search-forward regexp nil t)
905 (buffer-substring-no-properties
906 (match-beginning d-name-pos)
907 (match-end d-name-pos))))
910 (buffer-substring-no-properties
911 (match-beginning m-name-pos)
912 (match-end m-name-pos))))
913 (mm (string-to-number
915 (buffer-substring-no-properties
916 (match-beginning m-pos)
919 (dd (string-to-number
921 (buffer-substring-no-properties
922 (match-beginning d-pos)
926 (buffer-substring-no-properties
927 (match-beginning y-pos)
931 (if (and (= (length y-str) 2)
932 abbreviated-calendar-year)
934 (extract-calendar-year
935 (calendar-current-date)))
936 (y (+ (string-to-number y-str)
938 (/ current-y 100)))))
939 (if (> (- y current-y) 50)
941 (if (> (- current-y y) 50)
944 (string-to-number y-str))))
946 (setq entry (buffer-substring-no-properties
947 (point) (line-end-position))
948 temp (diary-pull-attrs entry file-glob-attrs)
950 marks (nth 1 temp))))
952 (mark-calendar-days-named
956 calendar-day-name-array
957 0 nil calendar-day-abbrev-array) t)) marks)
960 (if (string-equal mm-name "*") 0
964 calendar-month-name-array
965 1 nil calendar-month-abbrev-array) t)))))
966 (mark-calendar-date-pattern mm dd yy marks))))
968 (mark-sexp-diary-entries)
969 (run-hooks 'nongregorian-diary-marking-hook
970 'mark-diary-entries-hook)
971 (set-syntax-table old-diary-syntax-table)
972 (message "Marking diary entries...done")))))
974 (defun mark-sexp-diary-entries ()
975 "Mark days in the calendar window that have sexp diary entries.
976 Each entry in the diary file (or included files) visible in the calendar window
977 is marked. See the documentation for the function `list-sexp-diary-entries'."
978 (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol))
979 (s-entry (concat "\\(\\`\\|\^M\\|\n\\)\\("
980 sexp-mark "(\\)\\|\\("
981 (regexp-quote diary-nonmarking-symbol)
982 sexp-mark "(diary-remind\\)"))
983 (file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
984 m y first-date last-date mark file-glob-attrs)
986 (set-buffer calendar-buffer)
987 (setq m displayed-month)
988 (setq y displayed-year))
989 (increment-calendar-month m y -1)
991 (calendar-absolute-from-gregorian (list m 1 y)))
992 (increment-calendar-month m y 2)
994 (calendar-absolute-from-gregorian
995 (list m (calendar-last-day-of-month m y) y)))
996 (goto-char (point-min))
997 (while (re-search-forward s-entry nil t)
998 (setq marking-diary-entry (char-equal (preceding-char) ?\())
999 (re-search-backward "(")
1000 (let ((sexp-start (point))
1001 sexp entry entry-start line-start marks)
1003 (setq sexp (buffer-substring-no-properties sexp-start (point)))
1005 (re-search-backward "\^M\\|\n\\|\\`")
1006 (setq line-start (point)))
1008 (if (and (or (char-equal (preceding-char) ?\^M)
1009 (char-equal (preceding-char) ?\n))
1010 (not (looking-at " \\|\^I")))
1011 (progn;; Diary entry consists only of the sexp
1014 (setq entry-start (point))
1015 ;; Find end of entry
1016 (re-search-forward "\^M\\|\n" nil t)
1017 (while (looking-at " \\|\^I")
1018 (or (re-search-forward "\^M\\|\n" nil t)
1019 (re-search-forward "$" nil t)))
1020 (if (or (char-equal (preceding-char) ?\^M)
1021 (char-equal (preceding-char) ?\n))
1023 (setq entry (buffer-substring-no-properties entry-start (point)))
1024 (while (string-match "[\^M]" entry)
1025 (aset entry (match-beginning 0) ?\n )))
1026 (calendar-for-loop date from first-date to last-date do
1027 (if (setq mark (diary-sexp-entry sexp entry
1028 (calendar-gregorian-from-absolute date)))
1030 (setq marks (diary-pull-attrs entry file-glob-attrs)
1031 marks (nth 1 (diary-pull-attrs entry file-glob-attrs)))
1032 (mark-visible-calendar-date
1033 (calendar-gregorian-from-absolute date)
1034 (if (< 0 (length marks))
1037 (car mark)))))))))))
1039 (defun mark-included-diary-files ()
1040 "Mark the diary entries from other diary files with those of the diary file.
1041 This function is suitable for use as the `mark-diary-entries-hook'; it enables
1042 you to use shared diary files together with your own. The files included are
1043 specified in the diary-file by lines of this form:
1044 #include \"filename\"
1045 This is recursive; that is, #include directives in diary files thus included
1046 are obeyed. You can change the `#include' to some other string by
1047 changing the variable `diary-include-string'."
1048 (goto-char (point-min))
1049 (while (re-search-forward
1051 "\\(\\`\\|\^M\\|\n\\)"
1052 (regexp-quote diary-include-string)
1053 " \"\\([^\"]*\\)\"")
1055 (let* ((diary-file (substitute-in-file-name
1056 (match-string-no-properties 2)))
1057 (mark-diary-entries-hook 'mark-included-diary-files)
1058 (dbuff (find-buffer-visiting diary-file)))
1059 (if (file-exists-p diary-file)
1060 (if (file-readable-p diary-file)
1062 (mark-diary-entries)
1064 (kill-buffer (find-buffer-visiting diary-file))))
1066 (message "Can't read included diary file %s" diary-file)
1069 (message "Can't find included diary file %s" diary-file)
1071 (goto-char (point-min)))
1073 (defun mark-calendar-days-named (dayname &optional color)
1074 "Mark all dates in the calendar window that are day DAYNAME of the week.
1075 0 means all Sundays, 1 means all Mondays, and so on."
1077 (set-buffer calendar-buffer)
1078 (let ((prev-month displayed-month)
1079 (prev-year displayed-year)
1080 (succ-month displayed-month)
1081 (succ-year displayed-year)
1084 (increment-calendar-month succ-month succ-year 1)
1085 (increment-calendar-month prev-month prev-year -1)
1086 (setq day (calendar-absolute-from-gregorian
1087 (calendar-nth-named-day 1 dayname prev-month prev-year)))
1088 (setq last-day (calendar-absolute-from-gregorian
1089 (calendar-nth-named-day -1 dayname succ-month succ-year)))
1090 (while (<= day last-day)
1091 (mark-visible-calendar-date (calendar-gregorian-from-absolute day) color)
1092 (setq day (+ day 7))))))
1094 (defun mark-calendar-date-pattern (month day year &optional color)
1095 "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
1096 A value of 0 in any position is a wildcard."
1098 (set-buffer calendar-buffer)
1099 (let ((m displayed-month)
1101 (increment-calendar-month m y -1)
1102 (calendar-for-loop i from 0 to 2 do
1103 (mark-calendar-month m y month day year color)
1104 (increment-calendar-month m y 1)))))
1106 (defun mark-calendar-month (month year p-month p-day p-year &optional color)
1107 "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P_DAY/P-YEAR.
1108 A value of 0 in any position of the pattern is a wildcard."
1109 (if (or (and (= month p-month)
1110 (or (= p-year 0) (= year p-year)))
1112 (or (= p-year 0) (= year p-year))))
1115 i from 1 to (calendar-last-day-of-month month year) do
1116 (mark-visible-calendar-date (list month i year) color))
1117 (mark-visible-calendar-date (list month p-day year) color))))
1119 (defun sort-diary-entries ()
1120 "Sort the list of diary entries by time of day."
1121 (setq diary-entries-list (sort diary-entries-list 'diary-entry-compare)))
1123 (defun diary-entry-compare (e1 e2)
1124 "Returns t if E1 is earlier than E2."
1125 (or (calendar-date-compare e1 e2)
1126 (and (calendar-date-equal (car e1) (car e2))
1127 (let* ((ts1 (cadr e1)) (t1 (diary-entry-time ts1))
1128 (ts2 (cadr e2)) (t2 (diary-entry-time ts2)))
1131 (string-lessp ts1 ts2)))))))
1133 (defcustom diary-unknown-time
1135 "*Value returned by diary-entry-time when no time is found.
1136 The default value -9999 causes entries with no recognizable time to be placed
1137 before those with times; 9999 would place entries with no recognizable time
1138 after those with times."
1143 (defun diary-entry-time (s)
1144 "Return time at the beginning of the string S as a military-style integer.
1145 For example, returns 1325 for 1:25pm.
1147 Returns `diary-unknown-time' (default value -9999) if no time is recognized.
1148 The recognized forms are XXXX, X:XX, or XX:XX (military time), and XXam,
1149 XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm, or XX:XXPM. A period (.) can
1150 be used instead of a colon (:) to separate the hour and minute parts."
1151 (let ((case-fold-search nil))
1152 (cond ((string-match ; Military time
1153 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)"
1155 (+ (* 100 (string-to-number
1156 (substring s (match-beginning 1) (match-end 1))))
1157 (string-to-number (substring s (match-beginning 2) (match-end 2)))))
1158 ((string-match ; Hour only XXam or XXpm
1159 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s)
1160 (+ (* 100 (% (string-to-number
1161 (substring s (match-beginning 1) (match-end 1)))
1163 (if (equal ?a (downcase (aref s (match-beginning 2))))
1165 ((string-match ; Hour and minute XX:XXam or XX:XXpm
1166 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]\\([0-9][0-9]\\)\\([ap]\\)m\\>" s)
1167 (+ (* 100 (% (string-to-number
1168 (substring s (match-beginning 1) (match-end 1)))
1170 (string-to-number (substring s (match-beginning 2) (match-end 2)))
1171 (if (equal ?a (downcase (aref s (match-beginning 3))))
1173 (t diary-unknown-time)))) ; Unrecognizable
1177 (defun list-sexp-diary-entries (date)
1178 "Add sexp entries for DATE from the diary file to `diary-entries-list'.
1179 Also, Make them visible in the diary file. Returns t if any entries were
1182 Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally
1183 `%%'). The form of a sexp diary entry is
1187 Both ENTRY and DATE are globally available when the SEXP is evaluated. If the
1188 SEXP yields the value nil, the diary entry does not apply. If it yields a
1189 non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a
1190 string, that string will be the diary entry in the fancy diary display.
1192 For example, the following diary entry will apply to the 21st of the month
1193 if it is a weekday and the Friday before if the 21st is on a weekend:
1195 &%%(let ((dayname (calendar-day-of-week date))
1196 (day (extract-calendar-day date)))
1198 (and (= day 21) (memq dayname '(1 2 3 4 5)))
1199 (and (memq day '(19 20)) (= dayname 5)))
1200 ) UIUC pay checks deposited
1202 A number of built-in functions are available for this type of diary entry:
1204 %%(diary-date MONTH DAY YEAR &optional MARK) text
1205 Entry applies if date is MONTH, DAY, YEAR if
1206 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1207 `european-calendar-style' is t. DAY, MONTH, and YEAR
1208 can be lists of integers, the constant t, or an integer.
1209 The constant t means all values. An optional parameter
1210 MARK specifies a face or single-character string to use
1211 when highlighting the day in the calendar.
1213 %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
1214 Entry will appear on the Nth DAYNAME of MONTH.
1215 (DAYNAME=0 means Sunday, 1 means Monday, and so on;
1216 if N is negative it counts backward from the end of
1217 the month. MONTH can be a list of months, a single
1218 month, or t to specify all months. Optional DAY means
1219 Nth DAYNAME of MONTH on or after/before DAY. DAY defaults
1220 to 1 if N>0 and the last day of the month if N<0. An
1221 optional parameter MARK specifies a face or single-character
1222 string to use when highlighting the day in the calendar.
1224 %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
1225 Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
1226 inclusive. (If `european-calendar-style' is t, the
1227 order of the parameters should be changed to D1, M1, Y1,
1228 D2, M2, Y2.) An optional parameter MARK specifies a face
1229 or single-character string to use when highlighting the
1230 day in the calendar.
1232 %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
1233 Entry will appear on anniversary dates of MONTH DAY, YEAR.
1234 (If `european-calendar-style' is t, the order of the
1235 parameters should be changed to DAY, MONTH, YEAR.) Text
1236 can contain %d or %d%s; %d will be replaced by the number
1237 of years since the MONTH DAY, YEAR and %s will be replaced
1238 by the ordinal ending of that number (that is, `st', `nd',
1239 `rd' or `th', as appropriate. The anniversary of February
1240 29 is considered to be March 1 in a non-leap year. An
1241 optional parameter MARK specifies a face or single-character
1242 string to use when highlighting the day in the calendar.
1244 %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text
1245 Entry will appear every N days, starting MONTH DAY, YEAR.
1246 (If `european-calendar-style' is t, the order of the
1247 parameters should be changed to N, DAY, MONTH, YEAR.) Text
1248 can contain %d or %d%s; %d will be replaced by the number
1249 of repetitions since the MONTH DAY, YEAR and %s will
1250 be replaced by the ordinal ending of that number (that is,
1251 `st', `nd', `rd' or `th', as appropriate. An optional
1252 parameter MARK specifies a face or single-character string
1253 to use when highlighting the day in the calendar.
1255 %%(diary-remind SEXP DAYS &optional MARKING) text
1256 Entry is a reminder for diary sexp SEXP. DAYS is either a
1257 single number or a list of numbers indicating the number(s)
1258 of days before the event that the warning(s) should occur.
1259 If the current date is (one of) DAYS before the event
1260 indicated by EXPR, then a suitable message (as specified
1261 by `diary-remind-message') appears. In addition to the
1262 reminders beforehand, the diary entry also appears on
1263 the date itself. If optional MARKING is non-nil then the
1264 *reminders* are marked on the calendar. Marking of
1265 reminders is independent of whether the entry *itself* is
1266 a marking or nonmarking one.
1268 %%(diary-day-of-year)
1269 Diary entries giving the day of the year and the number of
1270 days remaining in the year will be made every day. Note
1271 that since there is no text, it makes sense only if the
1272 fancy diary display is used.
1275 Diary entries giving the corresponding ISO commercial date
1276 will be made every day. Note that since there is no text,
1277 it makes sense only if the fancy diary display is used.
1279 %%(diary-french-date)
1280 Diary entries giving the corresponding French Revolutionary
1281 date will be made every day. Note that since there is no
1282 text, it makes sense only if the fancy diary display is used.
1284 %%(diary-islamic-date)
1285 Diary entries giving the corresponding Islamic date will be
1286 made every day. Note that since there is no text, it
1287 makes sense only if the fancy diary display is used.
1289 %%(diary-hebrew-date)
1290 Diary entries giving the corresponding Hebrew date will be
1291 made every day. Note that since there is no text, it
1292 makes sense only if the fancy diary display is used.
1294 %%(diary-astro-day-number) Diary entries giving the corresponding
1295 astronomical (Julian) day number will be made every day.
1296 Note that since there is no text, it makes sense only if the
1297 fancy diary display is used.
1299 %%(diary-julian-date) Diary entries giving the corresponding
1300 Julian date will be made every day. Note that since
1301 there is no text, it makes sense only if the fancy diary
1304 %%(diary-sunrise-sunset)
1305 Diary entries giving the local times of sunrise and sunset
1306 will be made every day. Note that since there is no text,
1307 it makes sense only if the fancy diary display is used.
1308 Floating point required.
1310 %%(diary-phases-of-moon)
1311 Diary entries giving the times of the phases of the moon
1312 will be when appropriate. Note that since there is no text,
1313 it makes sense only if the fancy diary display is used.
1314 Floating point required.
1316 %%(diary-yahrzeit MONTH DAY YEAR) text
1317 Text is assumed to be the name of the person; the date is
1318 the date of death on the *civil* calendar. The diary entry
1319 will appear on the proper Hebrew-date anniversary and on the
1320 day before. (If `european-calendar-style' is t, the order
1321 of the parameters should be changed to DAY, MONTH, YEAR.)
1323 %%(diary-rosh-hodesh)
1324 Diary entries will be made on the dates of Rosh Hodesh on
1325 the Hebrew calendar. Note that since there is no text, it
1326 makes sense only if the fancy diary display is used.
1329 Diary entries giving the weekly parasha will be made on
1330 every Saturday. Note that since there is no text, it
1331 makes sense only if the fancy diary display is used.
1334 Diary entries giving the omer count will be made every day
1335 from Passover to Shavuot. Note that since there is no text,
1336 it makes sense only if the fancy diary display is used.
1338 Marking these entries is *extremely* time consuming, so these entries are
1339 best if they are nonmarking."
1340 (let ((s-entry (concat "\\(\\`\\|\^M\\|\n\\)"
1341 (regexp-quote diary-nonmarking-symbol)
1343 (regexp-quote sexp-diary-entry-symbol)
1345 entry-found file-glob-attrs marks)
1346 (goto-char (point-min))
1348 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '()))))
1349 (while (re-search-forward s-entry nil t)
1351 (let ((sexp-start (point))
1352 sexp entry specifier entry-start line-start)
1354 (setq sexp (buffer-substring-no-properties sexp-start (point)))
1356 (re-search-backward "\^M\\|\n\\|\\`")
1357 (setq line-start (point)))
1359 (buffer-substring-no-properties (1+ line-start) (point))
1360 entry-start (1+ line-start))
1362 (if (and (or (char-equal (preceding-char) ?\^M)
1363 (char-equal (preceding-char) ?\n))
1364 (not (looking-at " \\|\^I")))
1365 (progn;; Diary entry consists only of the sexp
1368 (setq entry-start (point))
1369 (re-search-forward "\^M\\|\n" nil t)
1370 (while (looking-at " \\|\^I")
1371 (re-search-forward "\^M\\|\n" nil t))
1373 (setq entry (buffer-substring-no-properties entry-start (point)))
1374 (while (string-match "[\^M]" entry)
1375 (aset entry (match-beginning 0) ?\n )))
1376 (let ((diary-entry (diary-sexp-entry sexp entry date))
1378 (setq entry (if (consp diary-entry)
1383 (subst-char-in-region line-start (point) ?\^M ?\n t)
1384 (if (< 0 (length entry))
1385 (setq temp (diary-pull-attrs entry file-glob-attrs)
1387 marks (nth 1 temp)))))
1388 (add-to-diary-list date
1391 (if entry-start (copy-marker entry-start)
1394 (setq entry-found (or entry-found diary-entry)))))
1397 (defun diary-sexp-entry (sexp entry date)
1398 "Process a SEXP diary ENTRY for DATE."
1399 (let ((result (if calendar-debug-sexp
1400 (let ((stack-trace-on-error t))
1401 (eval (car (read-from-string sexp))))
1403 (eval (car (read-from-string sexp)))
1406 (message "Bad sexp at line %d in %s: %s"
1409 (narrow-to-region 1 (point))
1410 (goto-char (point-min))
1412 (while (re-search-forward "\n\\|\^M" nil t)
1413 (setq lines (1+ lines)))
1417 (cond ((stringp result) result)
1418 ((and (consp result)
1419 (stringp (cdr result))) result)
1423 (defun diary-date (month day year &optional mark)
1424 "Specific date(s) diary entry.
1425 Entry applies if date is MONTH, DAY, YEAR if `european-calendar-style' is nil,
1426 and DAY, MONTH, YEAR if `european-calendar-style' is t. DAY, MONTH, and YEAR
1427 can be lists of integers, the constant t, or an integer. The constant t means
1430 An optional parameter MARK specifies a face or single-character string to
1431 use when highlighting the day in the calendar."
1432 (let ((dd (if european-calendar-style
1435 (mm (if european-calendar-style
1438 (m (extract-calendar-month date))
1439 (y (extract-calendar-year date))
1440 (d (extract-calendar-day date)))
1442 (or (and (listp dd) (memq d dd))
1445 (or (and (listp mm) (memq m mm))
1448 (or (and (listp year) (memq y year))
1451 (cons mark entry))))
1453 (defun diary-block (m1 d1 y1 m2 d2 y2 &optional mark)
1455 Entry applies if date is between, or on one of, two dates.
1456 The order of the parameters is
1457 M1, D1, Y1, M2, D2, Y2 if `european-calendar-style' is nil, and
1458 D1, M1, Y1, D2, M2, Y2 if `european-calendar-style' is t.
1460 An optional parameter MARK specifies a face or single-character string to
1461 use when highlighting the day in the calendar."
1463 (let ((date1 (calendar-absolute-from-gregorian
1464 (if european-calendar-style
1467 (date2 (calendar-absolute-from-gregorian
1468 (if european-calendar-style
1471 (d (calendar-absolute-from-gregorian date)))
1472 (if (and (<= date1 d) (<= d date2))
1473 (cons mark entry))))
1475 (defun diary-float (month dayname n &optional day mark)
1476 "Floating diary entry--entry applies if date is the nth dayname of month.
1477 Parameters are MONTH, DAYNAME, N. MONTH can be a list of months, the constant
1478 t, or an integer. The constant t means all months. If N is negative, count
1479 backward from the end of the month.
1481 An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY.
1482 Optional MARK specifies a face or single-character string to use when
1483 highlighting the day in the calendar."
1484 ;; This is messy because the diary entry may apply, but the date on which it
1485 ;; is based can be in a different month/year. For example, asking for the
1486 ;; first Monday after December 30. For large values of |n| the problem is
1488 (and (= dayname (calendar-day-of-week date))
1489 (let* ((m (extract-calendar-month date))
1490 (d (extract-calendar-day date))
1491 (y (extract-calendar-year date))
1492 (limit; last (n>0) or first (n<0) possible base date for entry
1493 (calendar-nth-named-absday (- n) dayname m y d))
1494 (last-abs (if (> n 0) limit (+ limit 6)))
1495 (first-abs (if (> n 0) (- limit 6) limit))
1496 (last (calendar-gregorian-from-absolute last-abs))
1497 (first (calendar-gregorian-from-absolute first-abs))
1498 ; m1, d1 is first possible base date
1499 (m1 (extract-calendar-month first))
1500 (d1 (extract-calendar-day first))
1501 (y1 (extract-calendar-year first))
1502 ; m2, d2 is last possible base date
1503 (m2 (extract-calendar-month last))
1504 (d2 (extract-calendar-day last))
1505 (y2 (extract-calendar-year last)))
1506 (if (or (and (= m1 m2) ; only possible base dates in one month
1511 (let ((d (or day (if (> n 0)
1513 (calendar-last-day-of-month m1 y1)))))
1514 (and (<= d1 d) (<= d d2))))
1515 ;; only possible base dates straddle two months
1517 (and (= y1 y2) (< m1 m2)))
1519 ;; m1, d1 works as a base date
1525 (<= d1 (or day (if (> n 0)
1527 (calendar-last-day-of-month m1 y1)))))
1528 ;; m2, d2 works as a base date
1529 (and (or (eq month t)
1533 (<= (or day (if (> n 0)
1535 (calendar-last-day-of-month m2 y2)))
1537 (cons mark entry)))))
1540 (defun diary-anniversary (month day year &optional mark)
1541 "Anniversary diary entry.
1542 Entry applies if date is the anniversary of MONTH, DAY, YEAR if
1543 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1544 `european-calendar-style' is t. Diary entry can contain `%d' or `%d%s'; the
1545 %d will be replaced by the number of years since the MONTH DAY, YEAR and the
1546 %s will be replaced by the ordinal ending of that number (that is, `st', `nd',
1547 `rd' or `th', as appropriate. The anniversary of February 29 is considered
1548 to be March 1 in non-leap years.
1550 An optional parameter MARK specifies a face or single-character string to
1551 use when highlighting the day in the calendar."
1552 (let* ((d (if european-calendar-style
1555 (m (if european-calendar-style
1558 (y (extract-calendar-year date))
1560 (if (and (= m 2) (= d 29) (not (calendar-leap-year-p y)))
1563 (if (and (> diff 0) (calendar-date-equal (list m d y) date))
1564 (cons mark (format entry diff (diary-ordinal-suffix diff))))))
1566 (defun diary-cyclic (n month day year &optional mark)
1567 "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
1568 If `european-calendar-style' is t, parameters are N, DAY, MONTH, YEAR.
1569 ENTRY can contain `%d' or `%d%s'; the %d will be replaced by the number of
1570 repetitions since the MONTH DAY, YEAR and %s will be replaced by the
1571 ordinal ending of that number (that is, `st', `nd', `rd' or `th', as
1574 An optional parameter MARK specifies a face or single-character string to
1575 use when highlighting the day in the calendar."
1576 (let* ((d (if european-calendar-style
1579 (m (if european-calendar-style
1582 (diff (- (calendar-absolute-from-gregorian date)
1583 (calendar-absolute-from-gregorian
1586 (if (and (>= diff 0) (zerop (% diff n)))
1587 (cons mark (format entry cycle (diary-ordinal-suffix cycle))))))
1589 (defun diary-ordinal-suffix (n)
1590 "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
1591 (if (or (memq (% n 100) '(11 12 13))
1594 (aref ["th" "st" "nd" "rd"] (% n 10))))
1596 (defun diary-day-of-year ()
1597 "Day of year and number of days remaining in the year of date diary entry."
1598 (calendar-day-of-year-string date))
1600 (defcustom diary-remind-message
1602 (if (= 0 (% days 7))
1603 (concat (int-to-string (/ days 7)) (if (= 7 days) " week" " weeks"))
1604 (concat (int-to-string days) (if (= 1 days) " day" " days")))
1607 "*Pseudo-pattern giving form of reminder messages in the fancy diary
1610 Used by the function `diary-remind', a pseudo-pattern is a list of
1611 expressions that can involve the keywords `days' (a number), `date' (a list of
1612 month, day, year), and `diary-entry' (a string)."
1616 (defun diary-remind (sexp days &optional marking)
1617 "Provide a reminder of a diary entry.
1618 SEXP is a diary-sexp. DAYS is either a single number or a list of numbers
1619 indicating the number(s) of days before the event that the warning(s) should
1620 occur on. If the current date is (one of) DAYS before the event indicated by
1621 SEXP, then a suitable message (as specified by `diary-remind-message' is
1624 In addition to the reminders beforehand, the diary entry also appears on the
1627 A `diary-nonmarking-symbol' at the beginning of the line of the diary-remind
1628 entry specifies that the diary entry (not the reminder) is non-marking.
1629 Marking of reminders is independent of whether the entry itself is a marking
1630 or nonmarking; if optional parameter MARKING is non-nil then the reminders are
1631 marked on the calendar."
1632 (let ((diary-entry (eval sexp)))
1634 ;; Diary entry applies on date
1636 (or (not marking-diary-entries) marking-diary-entry))
1638 ;; Diary entry may apply to `days' before date
1639 ((and (integerp days)
1640 (not diary-entry); Diary entry does not apply to date
1641 (or (not marking-diary-entries) marking))
1642 (let ((date (calendar-gregorian-from-absolute
1643 (+ (calendar-absolute-from-gregorian date) days))))
1644 (when (setq diary-entry (eval sexp)) ; re-evaluate with adjusted date
1645 ;; Discard any mark portion from diary-anniversary, etc.
1646 (if (consp diary-entry) (setq diary-entry (cdr diary-entry)))
1647 (mapconcat 'eval diary-remind-message ""))))
1648 ;; Diary entry may apply to one of a list of days before date
1649 ((and (listp days) days)
1650 (or (diary-remind sexp (car days) marking)
1651 (diary-remind sexp (cdr days) marking))))))
1653 (defvar diary-modify-entry-list-string-function nil
1654 "Function applied to entry string before putting it into the entries list.
1655 Can be used by programs integrating a diary list into other buffers (e.g.
1656 org.el and planner.el) to modify the string or add properties to it.
1657 The function takes a string argument and must return a string.")
1659 (defun add-to-diary-list (date string specifier &optional marker globcolor)
1660 "Add the entry (DATE STRING SPECIFIER MARKER GLOBCOLOR) to `diary-entries-list'.
1661 Do nothing if DATE or STRING is nil."
1662 (when (and date string)
1663 (if diary-file-name-prefix
1664 (let ((prefix (funcall diary-file-name-prefix-function
1665 (buffer-file-name))))
1666 (or (string= prefix "")
1667 (setq string (format "[%s] %s" prefix string)))))
1668 (and diary-modify-entry-list-string-function
1669 (setq string (funcall diary-modify-entry-list-string-function
1671 (setq diary-entries-list
1672 (append diary-entries-list
1673 (list (list date string specifier marker globcolor))))))
1675 (defun diary-redraw-calendar ()
1676 "If `calendar-buffer' is live and diary entries are marked, redraw it."
1677 (and mark-diary-entries-in-calendar
1680 ;; Return value suitable for `write-contents-functions'.
1683 (defun make-diary-entry (string &optional nonmarking file)
1684 "Insert a diary entry STRING which may be NONMARKING in FILE.
1685 If omitted, NONMARKING defaults to nil and FILE defaults to
1686 `diary-file'. Adds `diary-redraw-calendar' to
1687 `write-contents-functions' for FILE, so that the calendar will be
1688 redrawn with the new entry marked, if necessary."
1689 (let ((pop-up-frames (window-dedicated-p (selected-window))))
1690 (find-file-other-window (substitute-in-file-name (or file diary-file))))
1691 (add-hook 'write-contents-functions 'diary-redraw-calendar nil t)
1692 (when selective-display
1693 (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
1694 (setq selective-display nil)
1695 (kill-local-variable 'mode-line-format))
1697 (goto-char (point-max))
1698 (when (let ((case-fold-search t))
1699 (search-backward "Local Variables:"
1700 (max (- (point-max) 3000) (point-min))
1707 (if nonmarking diary-nonmarking-symbol "")
1710 (defun insert-diary-entry (arg)
1711 "Insert a diary entry for the date indicated by point.
1712 Prefix arg will make the entry nonmarking."
1714 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t t)
1717 (defun insert-weekly-diary-entry (arg)
1718 "Insert a weekly diary entry for the day of the week indicated by point.
1719 Prefix arg will make the entry nonmarking."
1721 (make-diary-entry (calendar-day-name (calendar-cursor-to-date t))
1724 (defun insert-monthly-diary-entry (arg)
1725 "Insert a monthly diary entry for the day of the month indicated by point.
1726 Prefix arg will make the entry nonmarking."
1728 (let ((calendar-date-display-form
1729 (if european-calendar-style
1732 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
1735 (defun insert-yearly-diary-entry (arg)
1736 "Insert an annual diary entry for the day of the year indicated by point.
1737 Prefix arg will make the entry nonmarking."
1739 (let ((calendar-date-display-form
1740 (if european-calendar-style
1741 '(day " " monthname)
1742 '(monthname " " day))))
1743 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
1746 (defun insert-anniversary-diary-entry (arg)
1747 "Insert an anniversary diary entry for the date given by point.
1748 Prefix arg will make the entry nonmarking."
1750 (let ((calendar-date-display-form
1751 (if european-calendar-style
1752 '(day " " month " " year)
1753 '(month " " day " " year))))
1755 (format "%s(diary-anniversary %s)"
1756 sexp-diary-entry-symbol
1757 (calendar-date-string (calendar-cursor-to-date t) nil t))
1760 (defun insert-block-diary-entry (arg)
1761 "Insert a block diary entry for the days between the point and marked date.
1762 Prefix arg will make the entry nonmarking."
1764 (let ((calendar-date-display-form
1765 (if european-calendar-style
1766 '(day " " month " " year)
1767 '(month " " day " " year)))
1768 (cursor (calendar-cursor-to-date t))
1769 (mark (or (car calendar-mark-ring)
1770 (error "No mark set in this buffer")))
1772 (if (< (calendar-absolute-from-gregorian mark)
1773 (calendar-absolute-from-gregorian cursor))
1779 (format "%s(diary-block %s %s)"
1780 sexp-diary-entry-symbol
1781 (calendar-date-string start nil t)
1782 (calendar-date-string end nil t))
1785 (defun insert-cyclic-diary-entry (arg)
1786 "Insert a cyclic diary entry starting at the date given by point.
1787 Prefix arg will make the entry nonmarking."
1789 (let ((calendar-date-display-form
1790 (if european-calendar-style
1791 '(day " " month " " year)
1792 '(month " " day " " year))))
1794 (format "%s(diary-cyclic %d %s)"
1795 sexp-diary-entry-symbol
1796 (calendar-read "Repeat every how many days: "
1797 (lambda (x) (> x 0)))
1798 (calendar-date-string (calendar-cursor-to-date t) nil t))
1802 (define-derived-mode diary-mode fundamental-mode
1804 "Major mode for editing the diary file."
1805 (set (make-local-variable 'font-lock-defaults)
1806 '(diary-font-lock-keywords t)))
1808 (define-derived-mode fancy-diary-display-mode fundamental-mode
1810 "Major mode used while displaying diary entries using Fancy Display."
1811 (set (make-local-variable 'font-lock-defaults)
1812 '(fancy-diary-font-lock-keywords t))
1813 (define-key (current-local-map) "q" 'quit-window))
1816 (defvar fancy-diary-font-lock-keywords
1820 (let ((dayname (diary-name-pattern calendar-day-name-array nil t))
1821 (monthname (diary-name-pattern calendar-month-name-array nil t))
1825 (mapconcat 'eval calendar-date-display-form ""))
1826 "\\(\\(: .*\\)\\|\\(\n +.*\\)\\)*\n=+$")
1828 '("^.*anniversary.*$" . font-lock-keyword-face)
1829 '("^.*birthday.*$" . font-lock-keyword-face)
1830 '("^.*Yahrzeit.*$" . font-lock-reference-face)
1831 '("^\\(Erev \\)?Rosh Hodesh.*" . font-lock-function-name-face)
1832 '("^Day.*omer.*$" . font-lock-builtin-face)
1833 '("^Parashat.*$" . font-lock-comment-face)
1834 '("^[ \t]*[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)?\\(-[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)?\\)?"
1835 . font-lock-variable-name-face))
1836 "Keywords to highlight in fancy diary display")
1839 (defun font-lock-diary-sexps (limit)
1840 "Recognize sexp diary entry for font-locking."
1841 (if (re-search-forward
1842 (concat "^" (regexp-quote diary-nonmarking-symbol)
1843 "?\\(" (regexp-quote sexp-diary-entry-symbol) "\\)")
1847 (narrow-to-region (point-min) limit)
1848 (let ((start (point)))
1850 (store-match-data (list start (point)))
1854 (defun font-lock-diary-date-forms (month-array &optional symbol abbrev-array)
1855 "Create font-lock patterns for `diary-date-forms' using MONTH-ARRAY.
1856 If given, optional SYMBOL must be a prefix to entries.
1857 If optional ABBREV-ARRAY is present, the abbreviations constructed
1858 from this array by the function `calendar-abbrev-construct' are
1859 matched (with or without a final `.'), in addition to the full month
1861 (let ((dayname (diary-name-pattern calendar-day-name-array
1862 calendar-day-abbrev-array t))
1863 (monthname (format "\\(%s\\|\\*\\)"
1864 (diary-name-pattern month-array abbrev-array)))
1865 (month "\\([0-9]+\\|\\*\\)")
1866 (day "\\([0-9]+\\|\\*\\)")
1867 (year "-?\\([0-9]+\\|\\*\\)"))
1868 (mapcar '(lambda (x)
1870 (concat "^" (regexp-quote diary-nonmarking-symbol) "?"
1871 (if symbol (regexp-quote symbol) "") "\\("
1873 ;; If backup, omit first item (backup)
1874 ;; and last item (not part of date)
1875 (if (equal (car x) 'backup)
1876 (reverse (cdr (reverse (cdr x))))
1879 ;; With backup, last item is not part of date
1880 (if (equal (car x) 'backup)
1881 (concat "\\)" (eval (car (reverse x))))
1886 (eval-when-compile (require 'cal-hebrew)
1887 (require 'cal-islam))
1889 (defvar diary-font-lock-keywords
1891 (font-lock-diary-date-forms calendar-month-name-array
1892 nil calendar-month-abbrev-array)
1893 (when (or (memq 'mark-hebrew-diary-entries
1894 nongregorian-diary-marking-hook)
1895 (memq 'list-hebrew-diary-entries
1896 nongregorian-diary-listing-hook))
1897 (require 'cal-hebrew)
1898 (font-lock-diary-date-forms
1899 calendar-hebrew-month-name-array-leap-year
1900 hebrew-diary-entry-symbol))
1901 (when (or (memq 'mark-islamic-diary-entries
1902 nongregorian-diary-marking-hook)
1903 (memq 'list-islamic-diary-entries
1904 nongregorian-diary-listing-hook))
1905 (require 'cal-islam)
1906 (font-lock-diary-date-forms
1907 calendar-islamic-month-name-array
1908 islamic-diary-entry-symbol))
1911 (concat "^" (regexp-quote diary-include-string) ".*$")
1912 'font-lock-keyword-face)
1914 (concat "^" (regexp-quote diary-nonmarking-symbol)
1915 "?\\(" (regexp-quote sexp-diary-entry-symbol) "\\)")
1916 '(1 font-lock-reference-face))
1918 (concat "^" (regexp-quote diary-nonmarking-symbol))
1919 'font-lock-reference-face)
1921 (concat "^" (regexp-quote diary-nonmarking-symbol)
1922 "?\\(" (regexp-quote hebrew-diary-entry-symbol) "\\)")
1923 '(1 font-lock-reference-face))
1925 (concat "^" (regexp-quote diary-nonmarking-symbol)
1926 "?\\(" (regexp-quote islamic-diary-entry-symbol) "\\)")
1927 '(1 font-lock-reference-face))
1928 '(font-lock-diary-sexps . font-lock-keyword-face)
1929 '("[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)\\(-[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)\\)?"
1930 . font-lock-function-name-face)))
1931 "Forms to highlight in diary-mode")
1934 ;; Following code from Dave Love <fx@gnu.org>.
1935 ;; Import Outlook-format appointments from mail messages in Gnus or
1936 ;; Rmail using command `diary-from-outlook'. This, or the specialized
1937 ;; functions `diary-from-outlook-gnus' and `diary-from-outlook-rmail',
1938 ;; could be run from hooks to notice appointments automatically (in
1939 ;; which case they will prompt about adding to the diary). The
1940 ;; message formats recognized are customizable through
1941 ;; `diary-outlook-formats'.
1943 (defcustom diary-outlook-formats
1945 ;; When: 11 October 2001 12:00-14:00 (GMT) Greenwich Mean Time : Dublin, ...
1946 ;; [Current UK format? The timezone is meaningless. Sometimes the
1947 ;; Where is missing.]
1948 ("When: \\([0-9]+ [[:alpha:]]+ [0-9]+\\) \
1951 \\(?:Where: \\([^\n]+\\)\n+\\)?
1952 \\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*"
1953 . "\\1\n \\2 %s, \\3")
1954 ;; When: Tuesday, April 30, 2002 03:00 PM-03:30 PM (GMT) Greenwich Mean ...
1956 ("^When: [[:alpha:]]+, \\([[:alpha:]]+\\) \\([0-9][0-9]*\\), \\([0-9]\\{4\\}\\) \
1959 \\(?:Where: \\([^\n]+\\)\\)?\n+"
1960 . "\\2 \\1 \\3\n \\4 %s, \\5")
1962 ;; German format, apparently.
1963 "^Zeit: [^ ]+, +\\([0-9]+\\)\. +\\([[:upper:]][[:lower:]][[:lower:]]\\)[^ ]* +\\([0-9]+\\) +\\([^ ]+\\).*$"
1964 . "\\1 \\2 \\3\n \\4 %s"))
1965 "Alist of regexps matching message text and replacement text.
1967 The regexp must match the start of the message text containing an
1968 appointment, but need not include a leading `^'. If it matches the
1969 current message, a diary entry is made from the corresponding
1970 template. If the template is a string, it should be suitable for
1971 passing to `replace-match', and so will have occurrences of `\\D' to
1972 substitute the match for the Dth subexpression. It must also contain
1973 a single `%s' which will be replaced with the text of the message's
1974 Subject field. Any other `%' characters must be doubled, so that the
1975 template can be passed to `format'.
1977 If the template is actually a function, it is called with the message
1978 body text as argument, and may use `match-string' etc. to make a
1979 template following the rules above."
1980 :type '(alist :key-type (regexp :tag "Regexp matching time/place")
1982 (string :tag "Template for entry")
1983 (function :tag "Unary function providing template")))
1988 ;; Dynamically bound.
1992 (defun diary-from-outlook-internal (&optional test-only)
1993 "Snarf a diary entry from a message assumed to be from MS Outlook.
1994 Assumes `body' is bound to a string comprising the body of the message and
1995 `subject' is bound to a string comprising its subject.
1996 Arg TEST-ONLY non-nil means return non-nil if and only if the
1997 message contains an appointment, don't make a diary entry."
1999 (let (format-string)
2000 (dotimes (i (length diary-outlook-formats))
2001 (when (eq 0 (string-match (car (nth i diary-outlook-formats))
2004 (setq format-string (cdr (nth i diary-outlook-formats)))
2006 (save-window-excursion
2007 ;; Fixme: References to optional fields in the format
2008 ;; are treated literally, not replaced by the empty
2009 ;; string. I think this is an Emacs bug.
2011 (format (replace-match (if (functionp format-string)
2012 (funcall format-string body)
2014 t nil (match-string 0 body))
2017 (throw 'finished t))))
2020 (defun diary-from-outlook (&optional noconfirm)
2021 "Maybe snarf diary entry from current Outlook-generated message.
2022 Currently knows about Gnus and Rmail modes. Unless the optional
2023 argument NOCONFIRM is non-nil (which is the case when this
2024 function is called interactively), then if an entry is found the
2025 user is asked to confirm its addition."
2028 ((eq major-mode 'rmail-mode)
2029 #'diary-from-outlook-rmail)
2030 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
2031 #'diary-from-outlook-gnus)
2032 (t (error "Don't know how to snarf in `%s'" major-mode)))))
2033 (funcall func noconfirm)))
2036 (defvar gnus-article-mime-handles)
2037 (defvar gnus-article-buffer)
2039 (autoload 'gnus-fetch-field "gnus-util")
2040 (autoload 'gnus-narrow-to-body "gnus")
2041 (autoload 'mm-get-part "mm-decode")
2043 (defun diary-from-outlook-gnus (&optional noconfirm)
2044 "Maybe snarf diary entry from Outlook-generated message in Gnus.
2045 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2046 this function is called interactively), then if an entry is found the
2047 user is asked to confirm its addition.
2048 Add this function to `gnus-article-prepare-hook' to notice appointments
2051 (with-current-buffer gnus-article-buffer
2052 (let ((subject (gnus-fetch-field "subject"))
2053 (body (if gnus-article-mime-handles
2054 ;; We're multipart. Don't get confused by part
2055 ;; buttons &c. Assume info is in first part.
2056 (mm-get-part (nth 1 gnus-article-mime-handles))
2058 (gnus-narrow-to-body)
2060 (when (diary-from-outlook-internal t)
2061 (when (or noconfirm (y-or-n-p "Snarf diary entry? "))
2062 (diary-from-outlook-internal)
2063 (message "Diary entry added"))))))
2065 (custom-add-option 'gnus-article-prepare-hook 'diary-from-outlook-gnus)
2068 (defvar rmail-buffer)
2070 (defun diary-from-outlook-rmail (&optional noconfirm)
2071 "Maybe snarf diary entry from Outlook-generated message in Rmail.
2072 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2073 this function is called interactively), then if an entry is found the
2074 user is asked to confirm its addition."
2076 (with-current-buffer rmail-buffer
2077 (let ((subject (mail-fetch-field "subject"))
2078 (body (buffer-substring (save-excursion
2082 (when (diary-from-outlook-internal t)
2083 (when (or noconfirm (y-or-n-p "Snarf diary entry? "))
2084 (diary-from-outlook-internal)
2085 (message "Diary entry added"))))))
2088 (provide 'diary-lib)
2090 ;;; arch-tag: 22dd506e-2e33-410d-9ae1-095a0c1b2010
2091 ;;; diary-lib.el ends here