(diary-from-outlook, diary-from-outlook-gnus)
[emacs.git] / lisp / calendar / diary-lib.el
blob679c4b991b6b5dd9ef950629cbd42c5b9bced295
1 ;;; diary-lib.el --- diary functions
3 ;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995, 2003, 2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Maintainer: Glenn Morris <gmorris@ast.cam.ac.uk>
8 ;; Keywords: calendar
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)
15 ;; 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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; This collection of functions implements the diary features as described
30 ;; in calendar.el.
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
38 ;;; Code:
40 (require 'calendar)
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)
48 d-file
49 (error "Diary file `%s' is not readable" diary-file))
50 (error "Diary file `%s' does not exist" diary-file))))
52 ;;;###autoload
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."
58 (interactive "P")
59 (diary-check-diary-file)
60 (let ((date (calendar-current-date)))
61 (list-diary-entries
62 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."
73 (interactive "p")
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."
82 (interactive
83 (list (if arg (prefix-numeric-value arg) 1)
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)
196 (defvar entry)
197 (defvar date)
198 (defvar number)
199 (defvar date-string)
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."
205 (let (ret)
206 (setq ret (cond ((eq type 'string) attrvalue)
207 ((eq type 'symbol) (read attrvalue))
208 ((eq type 'int) (string-to-int attrvalue))
209 ((eq type 'stringtnil)
210 (cond ((string= "t" attrvalue) t)
211 ((string= "nil" attrvalue) nil)
212 (t attrvalue)))
213 ((eq type 'tnil)
214 (cond ((string= "t" attrvalue) t)
215 ((string= "nil" attrvalue) nil)))))
216 ; (message "(%s)[%s]=[%s]" (print type) attrvalue ret)
217 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
228 search."
229 (save-excursion
230 (let (regexp regnum attrname attr-list attrname attrvalue type
231 ret-attr attr)
232 (if (null entry)
233 (progn
234 (setq ret-attr '()
235 attr-list diary-face-attrs)
236 (while attr-list
237 (goto-char (point-min))
238 (setq attr (car attr-list)
239 regexp (nth 0 attr)
240 regnum (nth 1 attr)
241 attrname (nth 2 attr)
242 type (nth 3 attr)
243 regexp (concat diary-glob-file-regexp-prefix regexp))
244 (setq attrvalue nil)
245 (if (re-search-forward regexp (point-max) t)
246 (setq attrvalue (buffer-substring-no-properties
247 (match-beginning regnum)
248 (match-end regnum))))
249 (if (and attrvalue
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))
254 (progn
255 (setq ret-attr fileglobattrs
256 attr-list diary-face-attrs)
257 (while attr-list
258 (goto-char (point-min))
259 (setq attr (car attr-list)
260 regexp (nth 0 attr)
261 regnum (nth 1 attr)
262 attrname (nth 2 attr)
263 type (nth 3 attr))
264 (setq attrvalue nil)
265 (if (string-match regexp entry)
266 (progn
267 (setq attrvalue (substring-no-properties entry
268 (match-beginning regnum)
269 (match-end regnum)))
270 (setq entry (replace-match "" t t entry))))
271 (if (and attrvalue
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'."
283 :group 'diary
284 :type 'boolean
285 :version "21.4")
287 (defcustom diary-header-line-format
288 '(:eval (calendar-string-spread
289 (list (if selective-display
290 "Selective display active - press \"s\" in calendar \
291 before edit/copy"
292 "Diary"))
293 ?\ (frame-width)))
294 "*Format of the header line displayed by `simple-diary-display'.
295 Only used if `diary-header-line-flag' is non-nil."
296 :group 'diary
297 :type 'sexp
298 :version "21.4")
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."
336 (when (> number 0)
337 (let ((original-date date);; save for possible use in the hooks
338 old-diary-syntax-table
339 diary-entries-list
340 file-glob-attrs
341 (date-string (calendar-date-string date))
342 (d-file (substitute-in-file-name diary-file)))
343 (message "Preparing diary...")
344 (save-excursion
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)))
353 (save-excursion
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)
361 (unwind-protect
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"))
369 (progn
370 (goto-char (point-max))
371 (insert "\^M")))
372 (goto-char (point-min))
373 (if (not (looking-at "\^M\\|\n"))
374 (insert "\^M"))
375 (subst-char-in-region (point-min) (point-max) ?\n ?\^M t)
376 (calendar-for-loop
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)))
383 (while d
384 (let*
385 ((date-form (if (equal (car (car d)) 'backup)
386 (cdr (car d))
387 (car d)))
388 (backup (equal (car (car d)) 'backup))
389 (dayname
390 (format "%s\\|%s\\.?"
391 (calendar-day-name date)
392 (calendar-day-name date 'abbrev)))
393 (monthname
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)))
399 (year
400 (concat
401 "\\*\\|0*" (int-to-string year)
402 (if abbreviated-calendar-year
403 (concat "\\|" (format "%02d" (% year 100)))
404 "")))
405 (regexp
406 (concat
407 "\\(\\`\\|\^M\\|\n\\)" mark "?\\("
408 (mapconcat 'eval date-form "\\)\\(")
409 "\\)"))
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.
418 (backward-char 1)
419 ;; Found a nonempty diary entry--make it
420 ;; visible and add it to the list.
421 (setq entry-found t)
422 (let ((entry-start (point))
423 date-start temp)
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))
429 (backward-char 1)
430 (subst-char-in-region date-start
431 (point) ?\^M ?\n t)
432 (setq entry (buffer-substring entry-start (point))
433 temp (diary-pull-attrs entry file-glob-attrs)
434 entry (nth 0 temp))
435 (add-to-diary-list
436 date
437 entry
438 (buffer-substring
439 (1+ date-start) (1- entry-start))
440 (copy-marker entry-start) (nth 1 temp))))))
441 (setq d (cdr d)))
442 (or entry-found
443 (not diary-list-include-blanks)
444 (setq diary-entries-list
445 (append diary-entries-list
446 (list (list date "" "" "" "")))))
447 (setq 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
473 (concat
474 "\\(\\`\\|\^M\\|\n\\)"
475 (regexp-quote diary-include-string)
476 " \"\\([^\"]*\\)\"")
477 nil t)
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)
484 (diary-hook nil)
485 (d-buffer (find-buffer-visiting diary-file))
486 (diary-modified (if d-buffer
487 (save-excursion
488 (set-buffer d-buffer)
489 (buffer-modified-p)))))
490 (if (file-exists-p diary-file)
491 (if (file-readable-p diary-file)
492 (unwind-protect
493 (setq diary-entries-list
494 (append diary-entries-list
495 (list-diary-entries original-date number)))
496 (save-excursion
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)))
502 (beep)
503 (message "Can't read included diary file %s" diary-file)
504 (sleep-for 2))
505 (beep)
506 (message "Can't find included diary file %s" diary-file)
507 (sleep-for 2))))
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"
515 date-string
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))
527 (message "%s" msg)
528 (set-buffer (get-buffer-create holiday-buffer))
529 (setq buffer-read-only nil)
530 (calendar-set-mode-line date-string)
531 (erase-buffer)
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))
538 (with-current-buffer
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-face '((((type pc) (class color))
547 (:foreground "lightblue")))
548 "Default face used for buttons."
549 :version "21.4"
550 :group 'diary)
552 (define-button-type 'diary-entry
553 'action #'diary-goto-entry
554 'face #'diary-button-face)
556 (defun diary-goto-entry (button)
557 (let ((marker (button-get button 'marker)))
558 (when marker
559 (pop-to-buffer (marker-buffer marker))
560 (goto-char (marker-position marker)))))
562 (defun fancy-diary-display ()
563 "Prepare a diary buffer with relevant entries in a fancy, noneditable form.
564 This function is provided for optional use as the `diary-display-hook'."
565 (save-excursion;; Turn off selective-display in the diary file's buffer.
566 (set-buffer (find-buffer-visiting (substitute-in-file-name diary-file)))
567 (let ((diary-modified (buffer-modified-p)))
568 (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
569 (setq selective-display nil)
570 (kill-local-variable 'mode-line-format)
571 (set-buffer-modified-p diary-modified)))
572 (if (or (not diary-entries-list)
573 (and (not (cdr diary-entries-list))
574 (string-equal (car (cdr (car diary-entries-list))) "")))
575 (let* ((holiday-list (if holidays-in-diary-buffer
576 (check-calendar-holidays original-date)))
577 (msg (format "No diary entries for %s %s"
578 (concat date-string (if holiday-list ":" ""))
579 (mapconcat 'identity holiday-list "; "))))
580 (if (<= (length msg) (frame-width))
581 (message "%s" msg)
582 (set-buffer (get-buffer-create holiday-buffer))
583 (setq buffer-read-only nil)
584 (erase-buffer)
585 (insert (mapconcat 'identity holiday-list "\n"))
586 (goto-char (point-min))
587 (set-buffer-modified-p nil)
588 (setq buffer-read-only t)
589 (display-buffer holiday-buffer)
590 (message "No diary entries for %s" date-string)))
591 (save-excursion;; Prepare the fancy diary buffer.
592 (set-buffer (make-fancy-diary-buffer))
593 (setq buffer-read-only nil)
594 (let ((entry-list diary-entries-list)
595 (holiday-list)
596 (holiday-list-last-month 1)
597 (holiday-list-last-year 1)
598 (date (list 0 0 0)))
599 (while entry-list
600 (if (not (calendar-date-equal date (car (car entry-list))))
601 (progn
602 (setq date (car (car entry-list)))
603 (and holidays-in-diary-buffer
604 (calendar-date-compare
605 (list (list holiday-list-last-month
606 (calendar-last-day-of-month
607 holiday-list-last-month
608 holiday-list-last-year)
609 holiday-list-last-year))
610 (list date))
611 ;; We need to get the holidays for the next 3 months.
612 (setq holiday-list-last-month
613 (extract-calendar-month date))
614 (setq holiday-list-last-year
615 (extract-calendar-year date))
616 (progn
617 (increment-calendar-month
618 holiday-list-last-month holiday-list-last-year 1)
620 (setq holiday-list
621 (let ((displayed-month holiday-list-last-month)
622 (displayed-year holiday-list-last-year))
623 (calendar-holiday-list)))
624 (increment-calendar-month
625 holiday-list-last-month holiday-list-last-year 1))
626 (let* ((date-string (calendar-date-string date))
627 (date-holiday-list
628 (let ((h holiday-list)
629 (d))
630 ;; Make a list of all holidays for date.
631 (while h
632 (if (calendar-date-equal date (car (car h)))
633 (setq d (append d (cdr (car h)))))
634 (setq h (cdr h)))
635 d)))
636 (insert (if (= (point) (point-min)) "" ?\n) date-string)
637 (if date-holiday-list (insert ": "))
638 (let* ((l (current-column))
639 (longest 0))
640 (insert (mapconcat (lambda (x)
641 (if (< longest (length x))
642 (setq longest (length x)))
644 date-holiday-list
645 (concat "\n" (make-string l ? ))))
646 (insert ?\n (make-string (+ l longest) ?=) ?\n)))))
648 (setq entry (car (cdr (car entry-list))))
649 (if (< 0 (length entry))
650 (progn
651 (if (nth 3 (car entry-list))
652 (insert-button (concat entry "\n")
653 'marker (nth 3 (car entry-list))
654 :type 'diary-entry)
655 (insert entry ?\n))
656 (save-excursion
657 (let* ((marks (nth 4 (car entry-list)))
658 (temp-face (make-symbol
659 (apply
660 'concat "temp-face-"
661 (mapcar '(lambda (sym)
662 (if (stringp sym)
664 (symbol-name sym)))
665 marks))))
666 (faceinfo marks))
667 (make-face temp-face)
668 ;; Remove :face info from the marks,
669 ;; copy the face info into temp-face
670 (while (setq faceinfo (memq :face faceinfo))
671 (copy-face (read (nth 1 faceinfo)) temp-face)
672 (setcar faceinfo nil)
673 (setcar (cdr faceinfo) nil))
674 (setq marks (delq nil marks))
675 ;; Apply the font aspects
676 (apply 'set-face-attribute temp-face nil marks)
677 (search-backward entry)
678 (overlay-put
679 (make-overlay (match-beginning 0) (match-end 0))
680 'face temp-face)))))
681 (setq entry-list (cdr entry-list))))
682 (set-buffer-modified-p nil)
683 (goto-char (point-min))
684 (setq buffer-read-only t)
685 (display-buffer fancy-diary-buffer)
686 (fancy-diary-display-mode)
687 (calendar-set-mode-line date-string)
688 (message "Preparing diary...done"))))
690 (defun make-fancy-diary-buffer ()
691 "Create and return the initial fancy diary buffer."
692 (save-excursion
693 (set-buffer (get-buffer-create fancy-diary-buffer))
694 (setq buffer-read-only nil)
695 (calendar-set-mode-line "Diary Entries")
696 (erase-buffer)
697 (set-buffer-modified-p nil)
698 (setq buffer-read-only t)
699 (get-buffer fancy-diary-buffer)))
701 (defun print-diary-entries ()
702 "Print a hard copy of the diary display.
704 If the simple diary display is being used, prepare a temp buffer with the
705 visible lines of the diary buffer, add a heading line composed from the mode
706 line, print the temp buffer, and destroy it.
708 If the fancy diary display is being used, just print the buffer.
710 The hooks given by the variable `print-diary-entries-hook' are called to do
711 the actual printing."
712 (interactive)
713 (if (bufferp (get-buffer fancy-diary-buffer))
714 (save-excursion
715 (set-buffer (get-buffer fancy-diary-buffer))
716 (run-hooks 'print-diary-entries-hook))
717 (let ((diary-buffer
718 (find-buffer-visiting (substitute-in-file-name diary-file))))
719 (if diary-buffer
720 (let ((temp-buffer (get-buffer-create "*Printable Diary Entries*"))
721 (heading))
722 (save-excursion
723 (set-buffer diary-buffer)
724 (setq heading
725 (if (not (stringp mode-line-format))
726 "All Diary Entries"
727 (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
728 (substring mode-line-format
729 (match-beginning 1) (match-end 1))))
730 (copy-to-buffer temp-buffer (point-min) (point-max))
731 (set-buffer temp-buffer)
732 (while (re-search-forward "\^M.*$" nil t)
733 (replace-match ""))
734 (goto-char (point-min))
735 (insert heading "\n"
736 (make-string (length heading) ?=) "\n")
737 (run-hooks 'print-diary-entries-hook)
738 (kill-buffer temp-buffer)))
739 (error "You don't have a diary buffer!")))))
741 (defun show-all-diary-entries ()
742 "Show all of the diary entries in the diary file.
743 This function gets rid of the selective display of the diary file so that
744 all entries, not just some, are visible. If there is no diary buffer, one
745 is created."
746 (interactive)
747 (let ((d-file (diary-check-diary-file))
748 (pop-up-frames (window-dedicated-p (selected-window))))
749 (save-excursion
750 (set-buffer (or (find-buffer-visiting d-file)
751 (find-file-noselect d-file t)))
752 (let ((buffer-read-only nil)
753 (diary-modified (buffer-modified-p)))
754 (subst-char-in-region (point-min) (point-max) ?\^M ?\n t)
755 (setq selective-display nil
756 mode-line-format default-mode-line-format)
757 (display-buffer (current-buffer))
758 (set-buffer-modified-p diary-modified)))))
760 (defcustom diary-mail-addr
761 (if (boundp 'user-mail-address) user-mail-address "")
762 "*Email address that `diary-mail-entries' will send email to."
763 :group 'diary
764 :type 'string
765 :version "20.3")
767 (defcustom diary-mail-days 7
768 "*Default number of days for `diary-mail-entries' to check."
769 :group 'diary
770 :type 'integer
771 :version "20.3")
773 ;;;###autoload
774 (defun diary-mail-entries (&optional ndays)
775 "Send a mail message showing diary entries for next NDAYS days.
776 If no prefix argument is given, NDAYS is set to `diary-mail-days'.
777 Mail is sent to the address specified by `diary-mail-addr'.
779 You can call `diary-mail-entries' every night using an at/cron job.
780 For example, this script will run the program at 2am daily. Since
781 `emacs -batch' does not load your `.emacs' file, you must ensure that
782 all relevant variables are set, as done here.
784 #!/bin/sh
785 # diary-rem.sh -- repeatedly run the Emacs diary-reminder
786 emacs -batch \\
787 -eval \"(setq diary-mail-days 3 \\
788 diary-file \\\"/path/to/diary.file\\\" \\
789 european-calendar-style t \\
790 diary-mail-addr \\\"user@host.name\\\" )\" \\
791 -l diary-lib -f diary-mail-entries
792 at -f diary-rem.sh 0200 tomorrow
794 You may have to tweak the syntax of the `at' command to suit your
795 system. Alternatively, you can specify a cron entry:
796 0 1 * * * diary-rem.sh
797 to run it every morning at 1am."
798 (interactive "P")
799 (if (string-equal diary-mail-addr "")
800 (error "You must set `diary-mail-addr' to use this command")
801 (let ((diary-display-hook 'fancy-diary-display))
802 (list-diary-entries (calendar-current-date) (or ndays diary-mail-days)))
803 (compose-mail diary-mail-addr
804 (concat "Diary entries generated "
805 (calendar-date-string (calendar-current-date))))
806 (insert
807 (if (get-buffer fancy-diary-buffer)
808 (save-excursion
809 (set-buffer fancy-diary-buffer)
810 (buffer-substring (point-min) (point-max)))
811 "No entries found"))
812 (call-interactively (get mail-user-agent 'sendfunc))))
814 (defun diary-name-pattern (string-array &optional abbrev-array paren)
815 "Return a regexp matching the strings in the array STRING-ARRAY.
816 If the optional argument ABBREV-ARRAY is present, then the function
817 `calendar-abbrev-construct' is used to construct abbreviations from the
818 two supplied arrays. The returned regexp will then also match these
819 abbreviations, with or without final `.' characters. If the optional
820 argument PAREN is non-nil, the regexp is surrounded by parentheses."
821 (regexp-opt (append string-array
822 (if abbrev-array
823 (calendar-abbrev-construct abbrev-array
824 string-array))
825 (if abbrev-array
826 (calendar-abbrev-construct abbrev-array
827 string-array
828 'period))
829 nil)
830 paren))
832 (defvar marking-diary-entries nil
833 "True during the marking of diary entries, nil otherwise.")
835 (defvar marking-diary-entry nil
836 "True during the marking of diary entries, if current entry is marking.")
838 (defun mark-diary-entries ()
839 "Mark days in the calendar window that have diary entries.
840 Each entry in the diary file visible in the calendar window is marked.
841 After the entries are marked, the hooks `nongregorian-diary-marking-hook' and
842 `mark-diary-entries-hook' are run."
843 (interactive)
844 (setq mark-diary-entries-in-calendar t)
845 (let ((marking-diary-entries t)
846 file-glob-attrs marks)
847 (save-excursion
848 (set-buffer (find-file-noselect (diary-check-diary-file) t))
849 (message "Marking diary entries...")
850 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
851 (let ((d diary-date-forms)
852 (old-diary-syntax-table (syntax-table))
853 temp)
854 (set-syntax-table diary-syntax-table)
855 (while d
856 (let* ((date-form (if (equal (car (car d)) 'backup)
857 (cdr (car d))
858 (car d)));; ignore 'backup directive
859 (dayname
860 (diary-name-pattern calendar-day-name-array
861 calendar-day-abbrev-array))
862 (monthname
863 (format "%s\\|\\*"
864 (diary-name-pattern calendar-month-name-array
865 calendar-month-abbrev-array)))
866 (month "[0-9]+\\|\\*")
867 (day "[0-9]+\\|\\*")
868 (year "[0-9]+\\|\\*")
869 (l (length date-form))
870 (d-name-pos (- l (length (memq 'dayname date-form))))
871 (d-name-pos (if (/= l d-name-pos) (+ 2 d-name-pos)))
872 (m-name-pos (- l (length (memq 'monthname date-form))))
873 (m-name-pos (if (/= l m-name-pos) (+ 2 m-name-pos)))
874 (d-pos (- l (length (memq 'day date-form))))
875 (d-pos (if (/= l d-pos) (+ 2 d-pos)))
876 (m-pos (- l (length (memq 'month date-form))))
877 (m-pos (if (/= l m-pos) (+ 2 m-pos)))
878 (y-pos (- l (length (memq 'year date-form))))
879 (y-pos (if (/= l y-pos) (+ 2 y-pos)))
880 (regexp
881 (concat
882 "\\(\\`\\|\^M\\|\n\\)\\("
883 (mapconcat 'eval date-form "\\)\\(")
884 "\\)"))
885 (case-fold-search t))
886 (goto-char (point-min))
887 (while (re-search-forward regexp nil t)
888 (let* ((dd-name
889 (if d-name-pos
890 (buffer-substring-no-properties
891 (match-beginning d-name-pos)
892 (match-end d-name-pos))))
893 (mm-name
894 (if m-name-pos
895 (buffer-substring-no-properties
896 (match-beginning m-name-pos)
897 (match-end m-name-pos))))
898 (mm (string-to-int
899 (if m-pos
900 (buffer-substring-no-properties
901 (match-beginning m-pos)
902 (match-end m-pos))
903 "")))
904 (dd (string-to-int
905 (if d-pos
906 (buffer-substring-no-properties
907 (match-beginning d-pos)
908 (match-end d-pos))
909 "")))
910 (y-str (if y-pos
911 (buffer-substring-no-properties
912 (match-beginning y-pos)
913 (match-end y-pos))))
914 (yy (if (not y-str)
916 (if (and (= (length y-str) 2)
917 abbreviated-calendar-year)
918 (let* ((current-y
919 (extract-calendar-year
920 (calendar-current-date)))
921 (y (+ (string-to-int y-str)
922 (* 100
923 (/ current-y 100)))))
924 (if (> (- y current-y) 50)
925 (- y 100)
926 (if (> (- current-y y) 50)
927 (+ y 100)
928 y)))
929 (string-to-int y-str))))
930 (save-excursion
931 (setq entry (buffer-substring-no-properties
932 (point) (line-end-position))
933 temp (diary-pull-attrs entry file-glob-attrs)
934 entry (nth 0 temp)
935 marks (nth 1 temp))))
936 (if dd-name
937 (mark-calendar-days-named
938 (cdr (assoc-string
939 dd-name
940 (calendar-make-alist
941 calendar-day-name-array
942 0 nil calendar-day-abbrev-array) t)) marks)
943 (if mm-name
944 (setq mm
945 (if (string-equal mm-name "*") 0
946 (cdr (assoc-string
947 mm-name
948 (calendar-make-alist
949 calendar-month-name-array
950 1 nil calendar-month-abbrev-array) t)))))
951 (mark-calendar-date-pattern mm dd yy marks))))
952 (setq d (cdr d))))
953 (mark-sexp-diary-entries)
954 (run-hooks 'nongregorian-diary-marking-hook
955 'mark-diary-entries-hook)
956 (set-syntax-table old-diary-syntax-table)
957 (message "Marking diary entries...done")))))
959 (defun mark-sexp-diary-entries ()
960 "Mark days in the calendar window that have sexp diary entries.
961 Each entry in the diary file (or included files) visible in the calendar window
962 is marked. See the documentation for the function `list-sexp-diary-entries'."
963 (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol))
964 (s-entry (concat "\\(\\`\\|\^M\\|\n\\)\\("
965 sexp-mark "(\\)\\|\\("
966 (regexp-quote diary-nonmarking-symbol)
967 sexp-mark "(diary-remind\\)"))
968 (file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
969 m y first-date last-date mark file-glob-attrs)
970 (save-excursion
971 (set-buffer calendar-buffer)
972 (setq m displayed-month)
973 (setq y displayed-year))
974 (increment-calendar-month m y -1)
975 (setq first-date
976 (calendar-absolute-from-gregorian (list m 1 y)))
977 (increment-calendar-month m y 2)
978 (setq last-date
979 (calendar-absolute-from-gregorian
980 (list m (calendar-last-day-of-month m y) y)))
981 (goto-char (point-min))
982 (while (re-search-forward s-entry nil t)
983 (setq marking-diary-entry (char-equal (preceding-char) ?\())
984 (re-search-backward "(")
985 (let ((sexp-start (point))
986 sexp entry entry-start line-start marks)
987 (forward-sexp)
988 (setq sexp (buffer-substring-no-properties sexp-start (point)))
989 (save-excursion
990 (re-search-backward "\^M\\|\n\\|\\`")
991 (setq line-start (point)))
992 (forward-char 1)
993 (if (and (or (char-equal (preceding-char) ?\^M)
994 (char-equal (preceding-char) ?\n))
995 (not (looking-at " \\|\^I")))
996 (progn;; Diary entry consists only of the sexp
997 (backward-char 1)
998 (setq entry ""))
999 (setq entry-start (point))
1000 ;; Find end of entry
1001 (re-search-forward "\^M\\|\n" nil t)
1002 (while (looking-at " \\|\^I")
1003 (or (re-search-forward "\^M\\|\n" nil t)
1004 (re-search-forward "$" nil t)))
1005 (if (or (char-equal (preceding-char) ?\^M)
1006 (char-equal (preceding-char) ?\n))
1007 (backward-char 1))
1008 (setq entry (buffer-substring-no-properties entry-start (point)))
1009 (while (string-match "[\^M]" entry)
1010 (aset entry (match-beginning 0) ?\n )))
1011 (calendar-for-loop date from first-date to last-date do
1012 (if (setq mark (diary-sexp-entry sexp entry
1013 (calendar-gregorian-from-absolute date)))
1014 (progn
1015 (setq marks (diary-pull-attrs entry file-glob-attrs)
1016 marks (nth 1 (diary-pull-attrs entry file-glob-attrs)))
1017 (mark-visible-calendar-date
1018 (calendar-gregorian-from-absolute date)
1019 (if (< 0 (length marks))
1020 marks
1021 (if (consp mark)
1022 (car mark)))))))))))
1024 (defun mark-included-diary-files ()
1025 "Mark the diary entries from other diary files with those of the diary file.
1026 This function is suitable for use as the `mark-diary-entries-hook'; it enables
1027 you to use shared diary files together with your own. The files included are
1028 specified in the diary-file by lines of this form:
1029 #include \"filename\"
1030 This is recursive; that is, #include directives in diary files thus included
1031 are obeyed. You can change the `#include' to some other string by
1032 changing the variable `diary-include-string'."
1033 (goto-char (point-min))
1034 (while (re-search-forward
1035 (concat
1036 "\\(\\`\\|\^M\\|\n\\)"
1037 (regexp-quote diary-include-string)
1038 " \"\\([^\"]*\\)\"")
1039 nil t)
1040 (let ((diary-file (substitute-in-file-name
1041 (buffer-substring-no-properties
1042 (match-beginning 2) (match-end 2))))
1043 (mark-diary-entries-hook 'mark-included-diary-files))
1044 (if (file-exists-p diary-file)
1045 (if (file-readable-p diary-file)
1046 (progn
1047 (mark-diary-entries)
1048 (kill-buffer (find-buffer-visiting diary-file)))
1049 (beep)
1050 (message "Can't read included diary file %s" diary-file)
1051 (sleep-for 2))
1052 (beep)
1053 (message "Can't find included diary file %s" diary-file)
1054 (sleep-for 2))))
1055 (goto-char (point-min)))
1057 (defun mark-calendar-days-named (dayname &optional color)
1058 "Mark all dates in the calendar window that are day DAYNAME of the week.
1059 0 means all Sundays, 1 means all Mondays, and so on."
1060 (save-excursion
1061 (set-buffer calendar-buffer)
1062 (let ((prev-month displayed-month)
1063 (prev-year displayed-year)
1064 (succ-month displayed-month)
1065 (succ-year displayed-year)
1066 (last-day)
1067 (day))
1068 (increment-calendar-month succ-month succ-year 1)
1069 (increment-calendar-month prev-month prev-year -1)
1070 (setq day (calendar-absolute-from-gregorian
1071 (calendar-nth-named-day 1 dayname prev-month prev-year)))
1072 (setq last-day (calendar-absolute-from-gregorian
1073 (calendar-nth-named-day -1 dayname succ-month succ-year)))
1074 (while (<= day last-day)
1075 (mark-visible-calendar-date (calendar-gregorian-from-absolute day) color)
1076 (setq day (+ day 7))))))
1078 (defun mark-calendar-date-pattern (month day year &optional color)
1079 "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
1080 A value of 0 in any position is a wildcard."
1081 (save-excursion
1082 (set-buffer calendar-buffer)
1083 (let ((m displayed-month)
1084 (y displayed-year))
1085 (increment-calendar-month m y -1)
1086 (calendar-for-loop i from 0 to 2 do
1087 (mark-calendar-month m y month day year color)
1088 (increment-calendar-month m y 1)))))
1090 (defun mark-calendar-month (month year p-month p-day p-year &optional color)
1091 "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P_DAY/P-YEAR.
1092 A value of 0 in any position of the pattern is a wildcard."
1093 (if (or (and (= month p-month)
1094 (or (= p-year 0) (= year p-year)))
1095 (and (= p-month 0)
1096 (or (= p-year 0) (= year p-year))))
1097 (if (= p-day 0)
1098 (calendar-for-loop
1099 i from 1 to (calendar-last-day-of-month month year) do
1100 (mark-visible-calendar-date (list month i year) color))
1101 (mark-visible-calendar-date (list month p-day year) color))))
1103 (defun sort-diary-entries ()
1104 "Sort the list of diary entries by time of day."
1105 (setq diary-entries-list (sort diary-entries-list 'diary-entry-compare)))
1107 (defun diary-entry-compare (e1 e2)
1108 "Returns t if E1 is earlier than E2."
1109 (or (calendar-date-compare e1 e2)
1110 (and (calendar-date-equal (car e1) (car e2))
1111 (let* ((ts1 (cadr e1)) (t1 (diary-entry-time ts1))
1112 (ts2 (cadr e2)) (t2 (diary-entry-time ts2)))
1113 (or (< t1 t2)
1114 (and (= t1 t2)
1115 (string-lessp ts1 ts2)))))))
1117 (defcustom diary-unknown-time
1118 -9999
1119 "*Value returned by diary-entry-time when no time is found.
1120 The default value -9999 causes entries with no recognizable time to be placed
1121 before those with times; 9999 would place entries with no recognizable time
1122 after those with times."
1123 :type 'integer
1124 :group 'diary
1125 :version "20.3")
1127 (defun diary-entry-time (s)
1128 "Return time at the beginning of the string S as a military-style integer.
1129 For example, returns 1325 for 1:25pm.
1131 Returns `diary-unknown-time' (default value -9999) if no time is recognized.
1132 The recognized forms are XXXX, X:XX, or XX:XX (military time), and XXam,
1133 XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm, or XX:XXPM. A period (.) can
1134 be used instead of a colon (:) to separate the hour and minute parts."
1135 (let ((case-fold-search nil))
1136 (cond ((string-match ; Military time
1137 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)"
1139 (+ (* 100 (string-to-int
1140 (substring s (match-beginning 1) (match-end 1))))
1141 (string-to-int (substring s (match-beginning 2) (match-end 2)))))
1142 ((string-match ; Hour only XXam or XXpm
1143 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s)
1144 (+ (* 100 (% (string-to-int
1145 (substring s (match-beginning 1) (match-end 1)))
1146 12))
1147 (if (equal ?a (downcase (aref s (match-beginning 2))))
1148 0 1200)))
1149 ((string-match ; Hour and minute XX:XXam or XX:XXpm
1150 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]\\([0-9][0-9]\\)\\([ap]\\)m\\>" s)
1151 (+ (* 100 (% (string-to-int
1152 (substring s (match-beginning 1) (match-end 1)))
1153 12))
1154 (string-to-int (substring s (match-beginning 2) (match-end 2)))
1155 (if (equal ?a (downcase (aref s (match-beginning 3))))
1156 0 1200)))
1157 (t diary-unknown-time)))) ; Unrecognizable
1159 ;; Unrecognizable
1161 (defun list-sexp-diary-entries (date)
1162 "Add sexp entries for DATE from the diary file to `diary-entries-list'.
1163 Also, Make them visible in the diary file. Returns t if any entries were
1164 found.
1166 Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally
1167 `%%'). The form of a sexp diary entry is
1169 %%(SEXP) ENTRY
1171 Both ENTRY and DATE are globally available when the SEXP is evaluated. If the
1172 SEXP yields the value nil, the diary entry does not apply. If it yields a
1173 non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a
1174 string, that string will be the diary entry in the fancy diary display.
1176 For example, the following diary entry will apply to the 21st of the month
1177 if it is a weekday and the Friday before if the 21st is on a weekend:
1179 &%%(let ((dayname (calendar-day-of-week date))
1180 (day (extract-calendar-day date)))
1182 (and (= day 21) (memq dayname '(1 2 3 4 5)))
1183 (and (memq day '(19 20)) (= dayname 5)))
1184 ) UIUC pay checks deposited
1186 A number of built-in functions are available for this type of diary entry:
1188 %%(diary-date MONTH DAY YEAR &optional MARK) text
1189 Entry applies if date is MONTH, DAY, YEAR if
1190 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1191 `european-calendar-style' is t. DAY, MONTH, and YEAR
1192 can be lists of integers, the constant t, or an integer.
1193 The constant t means all values. An optional parameter
1194 MARK specifies a face or single-character string to use
1195 when highlighting the day in the calendar.
1197 %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
1198 Entry will appear on the Nth DAYNAME of MONTH.
1199 (DAYNAME=0 means Sunday, 1 means Monday, and so on;
1200 if N is negative it counts backward from the end of
1201 the month. MONTH can be a list of months, a single
1202 month, or t to specify all months. Optional DAY means
1203 Nth DAYNAME of MONTH on or after/before DAY. DAY defaults
1204 to 1 if N>0 and the last day of the month if N<0. An
1205 optional parameter MARK specifies a face or single-character
1206 string to use when highlighting the day in the calendar.
1208 %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
1209 Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
1210 inclusive. (If `european-calendar-style' is t, the
1211 order of the parameters should be changed to D1, M1, Y1,
1212 D2, M2, Y2.) An optional parameter MARK specifies a face
1213 or single-character string to use when highlighting the
1214 day in the calendar.
1216 %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
1217 Entry will appear on anniversary dates of MONTH DAY, YEAR.
1218 (If `european-calendar-style' is t, the order of the
1219 parameters should be changed to DAY, MONTH, YEAR.) Text
1220 can contain %d or %d%s; %d will be replaced by the number
1221 of years since the MONTH DAY, YEAR and %s will be replaced
1222 by the ordinal ending of that number (that is, `st', `nd',
1223 `rd' or `th', as appropriate. The anniversary of February
1224 29 is considered to be March 1 in a non-leap year. An
1225 optional parameter MARK specifies a face or single-character
1226 string to use when highlighting the day in the calendar.
1228 %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text
1229 Entry will appear every N days, starting MONTH DAY, YEAR.
1230 (If `european-calendar-style' is t, the order of the
1231 parameters should be changed to N, DAY, MONTH, YEAR.) Text
1232 can contain %d or %d%s; %d will be replaced by the number
1233 of repetitions since the MONTH DAY, YEAR and %s will
1234 be replaced by the ordinal ending of that number (that is,
1235 `st', `nd', `rd' or `th', as appropriate. An optional
1236 parameter MARK specifies a face or single-character string
1237 to use when highlighting the day in the calendar.
1239 %%(diary-remind SEXP DAYS &optional MARKING) text
1240 Entry is a reminder for diary sexp SEXP. DAYS is either a
1241 single number or a list of numbers indicating the number(s)
1242 of days before the event that the warning(s) should occur.
1243 If the current date is (one of) DAYS before the event
1244 indicated by EXPR, then a suitable message (as specified
1245 by `diary-remind-message') appears. In addition to the
1246 reminders beforehand, the diary entry also appears on
1247 the date itself. If optional MARKING is non-nil then the
1248 *reminders* are marked on the calendar. Marking of
1249 reminders is independent of whether the entry *itself* is
1250 a marking or nonmarking one.
1252 %%(diary-day-of-year)
1253 Diary entries giving the day of the year and the number of
1254 days remaining in the year will be made every day. Note
1255 that since there is no text, it makes sense only if the
1256 fancy diary display is used.
1258 %%(diary-iso-date)
1259 Diary entries giving the corresponding ISO commercial date
1260 will be made every day. Note that since there is no text,
1261 it makes sense only if the fancy diary display is used.
1263 %%(diary-french-date)
1264 Diary entries giving the corresponding French Revolutionary
1265 date will be made every day. Note that since there is no
1266 text, it makes sense only if the fancy diary display is used.
1268 %%(diary-islamic-date)
1269 Diary entries giving the corresponding Islamic date will be
1270 made every day. Note that since there is no text, it
1271 makes sense only if the fancy diary display is used.
1273 %%(diary-hebrew-date)
1274 Diary entries giving the corresponding Hebrew date will be
1275 made every day. Note that since there is no text, it
1276 makes sense only if the fancy diary display is used.
1278 %%(diary-astro-day-number) Diary entries giving the corresponding
1279 astronomical (Julian) day number will be made every day.
1280 Note that since there is no text, it makes sense only if the
1281 fancy diary display is used.
1283 %%(diary-julian-date) Diary entries giving the corresponding
1284 Julian date will be made every day. Note that since
1285 there is no text, it makes sense only if the fancy diary
1286 display is used.
1288 %%(diary-sunrise-sunset)
1289 Diary entries giving the local times of sunrise and sunset
1290 will be made every day. Note that since there is no text,
1291 it makes sense only if the fancy diary display is used.
1292 Floating point required.
1294 %%(diary-phases-of-moon)
1295 Diary entries giving the times of the phases of the moon
1296 will be when appropriate. Note that since there is no text,
1297 it makes sense only if the fancy diary display is used.
1298 Floating point required.
1300 %%(diary-yahrzeit MONTH DAY YEAR) text
1301 Text is assumed to be the name of the person; the date is
1302 the date of death on the *civil* calendar. The diary entry
1303 will appear on the proper Hebrew-date anniversary and on the
1304 day before. (If `european-calendar-style' is t, the order
1305 of the parameters should be changed to DAY, MONTH, YEAR.)
1307 %%(diary-rosh-hodesh)
1308 Diary entries will be made on the dates of Rosh Hodesh on
1309 the Hebrew calendar. Note that since there is no text, it
1310 makes sense only if the fancy diary display is used.
1312 %%(diary-parasha)
1313 Diary entries giving the weekly parasha will be made on
1314 every Saturday. Note that since there is no text, it
1315 makes sense only if the fancy diary display is used.
1317 %%(diary-omer)
1318 Diary entries giving the omer count will be made every day
1319 from Passover to Shavuot. Note that since there is no text,
1320 it makes sense only if the fancy diary display is used.
1322 Marking these entries is *extremely* time consuming, so these entries are
1323 best if they are nonmarking."
1324 (let ((s-entry (concat "\\(\\`\\|\^M\\|\n\\)"
1325 (regexp-quote diary-nonmarking-symbol)
1327 (regexp-quote sexp-diary-entry-symbol)
1328 "("))
1329 entry-found file-glob-attrs marks)
1330 (goto-char (point-min))
1331 (save-excursion
1332 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '()))))
1333 (while (re-search-forward s-entry nil t)
1334 (backward-char 1)
1335 (let ((sexp-start (point))
1336 sexp entry specifier entry-start line-start)
1337 (forward-sexp)
1338 (setq sexp (buffer-substring-no-properties sexp-start (point)))
1339 (save-excursion
1340 (re-search-backward "\^M\\|\n\\|\\`")
1341 (setq line-start (point)))
1342 (setq specifier
1343 (buffer-substring-no-properties (1+ line-start) (point))
1344 entry-start (1+ line-start))
1345 (forward-char 1)
1346 (if (and (or (char-equal (preceding-char) ?\^M)
1347 (char-equal (preceding-char) ?\n))
1348 (not (looking-at " \\|\^I")))
1349 (progn;; Diary entry consists only of the sexp
1350 (backward-char 1)
1351 (setq entry ""))
1352 (setq entry-start (point))
1353 (re-search-forward "\^M\\|\n" nil t)
1354 (while (looking-at " \\|\^I")
1355 (re-search-forward "\^M\\|\n" nil t))
1356 (backward-char 1)
1357 (setq entry (buffer-substring-no-properties entry-start (point)))
1358 (while (string-match "[\^M]" entry)
1359 (aset entry (match-beginning 0) ?\n )))
1360 (let ((diary-entry (diary-sexp-entry sexp entry date))
1361 temp)
1362 (setq entry (if (consp diary-entry)
1363 (cdr diary-entry)
1364 diary-entry))
1365 (if diary-entry
1366 (progn
1367 (subst-char-in-region line-start (point) ?\^M ?\n t)
1368 (if (< 0 (length entry))
1369 (setq temp (diary-pull-attrs entry file-glob-attrs)
1370 entry (nth 0 temp)
1371 marks (nth 1 temp)))))
1372 (add-to-diary-list date
1373 entry
1374 specifier
1375 (if entry-start (copy-marker entry-start)
1376 nil)
1377 marks)
1378 (setq entry-found (or entry-found diary-entry)))))
1379 entry-found))
1381 (defun diary-sexp-entry (sexp entry date)
1382 "Process a SEXP diary ENTRY for DATE."
1383 (let ((result (if calendar-debug-sexp
1384 (let ((stack-trace-on-error t))
1385 (eval (car (read-from-string sexp))))
1386 (condition-case nil
1387 (eval (car (read-from-string sexp)))
1388 (error
1389 (beep)
1390 (message "Bad sexp at line %d in %s: %s"
1391 (save-excursion
1392 (save-restriction
1393 (narrow-to-region 1 (point))
1394 (goto-char (point-min))
1395 (let ((lines 1))
1396 (while (re-search-forward "\n\\|\^M" nil t)
1397 (setq lines (1+ lines)))
1398 lines)))
1399 diary-file sexp)
1400 (sleep-for 2))))))
1401 (cond ((stringp result) result)
1402 ((and (consp result)
1403 (stringp (cdr result))) result)
1404 (result entry)
1405 (t nil))))
1407 (defun diary-date (month day year &optional mark)
1408 "Specific date(s) diary entry.
1409 Entry applies if date is MONTH, DAY, YEAR if `european-calendar-style' is nil,
1410 and DAY, MONTH, YEAR if `european-calendar-style' is t. DAY, MONTH, and YEAR
1411 can be lists of integers, the constant t, or an integer. The constant t means
1412 all values.
1414 An optional parameter MARK specifies a face or single-character string to
1415 use when highlighting the day in the calendar."
1416 (let ((dd (if european-calendar-style
1417 month
1418 day))
1419 (mm (if european-calendar-style
1421 month))
1422 (m (extract-calendar-month date))
1423 (y (extract-calendar-year date))
1424 (d (extract-calendar-day date)))
1425 (if (and
1426 (or (and (listp dd) (memq d dd))
1427 (equal d dd)
1428 (eq dd t))
1429 (or (and (listp mm) (memq m mm))
1430 (equal m mm)
1431 (eq mm t))
1432 (or (and (listp year) (memq y year))
1433 (equal y year)
1434 (eq year t)))
1435 (cons mark entry))))
1437 (defun diary-block (m1 d1 y1 m2 d2 y2 &optional mark)
1438 "Block diary entry.
1439 Entry applies if date is between, or on one of, two dates.
1440 The order of the parameters is
1441 M1, D1, Y1, M2, D2, Y2 if `european-calendar-style' is nil, and
1442 D1, M1, Y1, D2, M2, Y2 if `european-calendar-style' is t.
1444 An optional parameter MARK specifies a face or single-character string to
1445 use when highlighting the day in the calendar."
1447 (let ((date1 (calendar-absolute-from-gregorian
1448 (if european-calendar-style
1449 (list d1 m1 y1)
1450 (list m1 d1 y1))))
1451 (date2 (calendar-absolute-from-gregorian
1452 (if european-calendar-style
1453 (list d2 m2 y2)
1454 (list m2 d2 y2))))
1455 (d (calendar-absolute-from-gregorian date)))
1456 (if (and (<= date1 d) (<= d date2))
1457 (cons mark entry))))
1459 (defun diary-float (month dayname n &optional day mark)
1460 "Floating diary entry--entry applies if date is the nth dayname of month.
1461 Parameters are MONTH, DAYNAME, N. MONTH can be a list of months, the constant
1462 t, or an integer. The constant t means all months. If N is negative, count
1463 backward from the end of the month.
1465 An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY.
1466 Optional MARK specifies a face or single-character string to use when
1467 highlighting the day in the calendar."
1468 ;; This is messy because the diary entry may apply, but the date on which it
1469 ;; is based can be in a different month/year. For example, asking for the
1470 ;; first Monday after December 30. For large values of |n| the problem is
1471 ;; more grotesque.
1472 (and (= dayname (calendar-day-of-week date))
1473 (let* ((m (extract-calendar-month date))
1474 (d (extract-calendar-day date))
1475 (y (extract-calendar-year date))
1476 (limit; last (n>0) or first (n<0) possible base date for entry
1477 (calendar-nth-named-absday (- n) dayname m y d))
1478 (last-abs (if (> n 0) limit (+ limit 6)))
1479 (first-abs (if (> n 0) (- limit 6) limit))
1480 (last (calendar-gregorian-from-absolute last-abs))
1481 (first (calendar-gregorian-from-absolute first-abs))
1482 ; m1, d1 is first possible base date
1483 (m1 (extract-calendar-month first))
1484 (d1 (extract-calendar-day first))
1485 (y1 (extract-calendar-year first))
1486 ; m2, d2 is last possible base date
1487 (m2 (extract-calendar-month last))
1488 (d2 (extract-calendar-day last))
1489 (y2 (extract-calendar-year last)))
1490 (if (or (and (= m1 m2) ; only possible base dates in one month
1491 (or (eq month t)
1492 (if (listp month)
1493 (memq m1 month)
1494 (= m1 month)))
1495 (let ((d (or day (if (> n 0)
1497 (calendar-last-day-of-month m1 y1)))))
1498 (and (<= d1 d) (<= d d2))))
1499 ;; only possible base dates straddle two months
1500 (and (or (< y1 y2)
1501 (and (= y1 y2) (< m1 m2)))
1503 ;; m1, d1 works as a base date
1504 (and
1505 (or (eq month t)
1506 (if (listp month)
1507 (memq m1 month)
1508 (= m1 month)))
1509 (<= d1 (or day (if (> n 0)
1511 (calendar-last-day-of-month m1 y1)))))
1512 ;; m2, d2 works as a base date
1513 (and (or (eq month t)
1514 (if (listp month)
1515 (memq m2 month)
1516 (= m2 month)))
1517 (<= (or day (if (> n 0)
1519 (calendar-last-day-of-month m2 y2)))
1520 d2)))))
1521 (cons mark entry)))))
1524 (defun diary-anniversary (month day year &optional mark)
1525 "Anniversary diary entry.
1526 Entry applies if date is the anniversary of MONTH, DAY, YEAR if
1527 `european-calendar-style' is nil, and DAY, MONTH, YEAR if
1528 `european-calendar-style' is t. Diary entry can contain `%d' or `%d%s'; the
1529 %d will be replaced by the number of years since the MONTH DAY, YEAR and the
1530 %s will be replaced by the ordinal ending of that number (that is, `st', `nd',
1531 `rd' or `th', as appropriate. The anniversary of February 29 is considered
1532 to be March 1 in non-leap years.
1534 An optional parameter MARK specifies a face or single-character string to
1535 use when highlighting the day in the calendar."
1536 (let* ((d (if european-calendar-style
1537 month
1538 day))
1539 (m (if european-calendar-style
1541 month))
1542 (y (extract-calendar-year date))
1543 (diff (- y year)))
1544 (if (and (= m 2) (= d 29) (not (calendar-leap-year-p y)))
1545 (setq m 3
1546 d 1))
1547 (if (and (> diff 0) (calendar-date-equal (list m d y) date))
1548 (cons mark (format entry diff (diary-ordinal-suffix diff))))))
1550 (defun diary-cyclic (n month day year &optional mark)
1551 "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
1552 If `european-calendar-style' is t, parameters are N, DAY, MONTH, YEAR.
1553 ENTRY can contain `%d' or `%d%s'; the %d will be replaced by the number of
1554 repetitions since the MONTH DAY, YEAR and %s will be replaced by the
1555 ordinal ending of that number (that is, `st', `nd', `rd' or `th', as
1556 appropriate.
1558 An optional parameter MARK specifies a face or single-character string to
1559 use when highlighting the day in the calendar."
1560 (let* ((d (if european-calendar-style
1561 month
1562 day))
1563 (m (if european-calendar-style
1565 month))
1566 (diff (- (calendar-absolute-from-gregorian date)
1567 (calendar-absolute-from-gregorian
1568 (list m d year))))
1569 (cycle (/ diff n)))
1570 (if (and (>= diff 0) (zerop (% diff n)))
1571 (cons mark (format entry cycle (diary-ordinal-suffix cycle))))))
1573 (defun diary-ordinal-suffix (n)
1574 "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
1575 (if (or (memq (% n 100) '(11 12 13))
1576 (< 3 (% n 10)))
1577 "th"
1578 (aref ["th" "st" "nd" "rd"] (% n 10))))
1580 (defun diary-day-of-year ()
1581 "Day of year and number of days remaining in the year of date diary entry."
1582 (calendar-day-of-year-string date))
1584 (defcustom diary-remind-message
1585 '("Reminder: Only "
1586 (if (= 0 (% days 7))
1587 (concat (int-to-string (/ days 7)) (if (= 7 days) " week" " weeks"))
1588 (concat (int-to-string days) (if (= 1 days) " day" " days")))
1589 " until "
1590 diary-entry)
1591 "*Pseudo-pattern giving form of reminder messages in the fancy diary
1592 display.
1594 Used by the function `diary-remind', a pseudo-pattern is a list of
1595 expressions that can involve the keywords `days' (a number), `date' (a list of
1596 month, day, year), and `diary-entry' (a string)."
1597 :type 'sexp
1598 :group 'diary)
1600 (defun diary-remind (sexp days &optional marking)
1601 "Provide a reminder of a diary entry.
1602 SEXP is a diary-sexp. DAYS is either a single number or a list of numbers
1603 indicating the number(s) of days before the event that the warning(s) should
1604 occur on. If the current date is (one of) DAYS before the event indicated by
1605 SEXP, then a suitable message (as specified by `diary-remind-message' is
1606 returned.
1608 In addition to the reminders beforehand, the diary entry also appears on the
1609 date itself.
1611 A `diary-nonmarking-symbol' at the beginning of the line of the diary-remind
1612 entry specifies that the diary entry (not the reminder) is non-marking.
1613 Marking of reminders is independent of whether the entry itself is a marking
1614 or nonmarking; if optional parameter MARKING is non-nil then the reminders are
1615 marked on the calendar."
1616 (let ((diary-entry (eval sexp)))
1617 (cond
1618 ;; Diary entry applies on date
1619 ((and diary-entry
1620 (or (not marking-diary-entries) marking-diary-entry))
1621 diary-entry)
1622 ;; Diary entry may apply to `days' before date
1623 ((and (integerp days)
1624 (not diary-entry); Diary entry does not apply to date
1625 (or (not marking-diary-entries) marking))
1626 (let ((date (calendar-gregorian-from-absolute
1627 (+ (calendar-absolute-from-gregorian date) days))))
1628 (if (setq diary-entry (eval sexp))
1629 (mapconcat 'eval diary-remind-message ""))))
1630 ;; Diary entry may apply to one of a list of days before date
1631 ((and (listp days) days)
1632 (or (diary-remind sexp (car days) marking)
1633 (diary-remind sexp (cdr days) marking))))))
1635 (defun add-to-diary-list (date string specifier marker &optional globcolor)
1636 "Add the entry (DATE STRING SPECIFIER MARKER GLOBCOLOR) to `diary-entries-list'.
1637 Do nothing if DATE or STRING is nil."
1638 (when (and date string)
1639 (if diary-file-name-prefix
1640 (let ((prefix (funcall diary-file-name-prefix-function
1641 (buffer-file-name))))
1642 (or (string= prefix "")
1643 (setq string (format "[%s] %s" prefix string)))))
1644 (setq diary-entries-list
1645 (append diary-entries-list
1646 (list (list date string specifier marker globcolor))))))
1648 (defun make-diary-entry (string &optional nonmarking file)
1649 "Insert a diary entry STRING which may be NONMARKING in FILE.
1650 If omitted, NONMARKING defaults to nil and FILE defaults to `diary-file'."
1651 (let ((pop-up-frames (window-dedicated-p (selected-window))))
1652 (find-file-other-window (substitute-in-file-name (or file diary-file))))
1653 (widen)
1654 (goto-char (point-max))
1655 (when (let ((case-fold-search t))
1656 (search-backward "Local Variables:"
1657 (max (- (point-max) 3000) (point-min))
1659 (beginning-of-line)
1660 (insert "\n")
1661 (previous-line 1))
1662 (insert
1663 (if (bolp) "" "\n")
1664 (if nonmarking diary-nonmarking-symbol "")
1665 string " "))
1667 (defun insert-diary-entry (arg)
1668 "Insert a diary entry for the date indicated by point.
1669 Prefix arg will make the entry nonmarking."
1670 (interactive "P")
1671 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t t)
1672 arg))
1674 (defun insert-weekly-diary-entry (arg)
1675 "Insert a weekly diary entry for the day of the week indicated by point.
1676 Prefix arg will make the entry nonmarking."
1677 (interactive "P")
1678 (make-diary-entry (calendar-day-name (calendar-cursor-to-date t))
1679 arg))
1681 (defun insert-monthly-diary-entry (arg)
1682 "Insert a monthly diary entry for the day of the month indicated by point.
1683 Prefix arg will make the entry nonmarking."
1684 (interactive "P")
1685 (let ((calendar-date-display-form
1686 (if european-calendar-style
1687 '(day " * ")
1688 '("* " day))))
1689 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
1690 arg)))
1692 (defun insert-yearly-diary-entry (arg)
1693 "Insert an annual diary entry for the day of the year indicated by point.
1694 Prefix arg will make the entry nonmarking."
1695 (interactive "P")
1696 (let ((calendar-date-display-form
1697 (if european-calendar-style
1698 '(day " " monthname)
1699 '(monthname " " day))))
1700 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
1701 arg)))
1703 (defun insert-anniversary-diary-entry (arg)
1704 "Insert an anniversary diary entry for the date given by point.
1705 Prefix arg will make the entry nonmarking."
1706 (interactive "P")
1707 (let ((calendar-date-display-form
1708 (if european-calendar-style
1709 '(day " " month " " year)
1710 '(month " " day " " year))))
1711 (make-diary-entry
1712 (format "%s(diary-anniversary %s)"
1713 sexp-diary-entry-symbol
1714 (calendar-date-string (calendar-cursor-to-date t) nil t))
1715 arg)))
1717 (defun insert-block-diary-entry (arg)
1718 "Insert a block diary entry for the days between the point and marked date.
1719 Prefix arg will make the entry nonmarking."
1720 (interactive "P")
1721 (let ((calendar-date-display-form
1722 (if european-calendar-style
1723 '(day " " month " " year)
1724 '(month " " day " " year)))
1725 (cursor (calendar-cursor-to-date t))
1726 (mark (or (car calendar-mark-ring)
1727 (error "No mark set in this buffer")))
1728 start end)
1729 (if (< (calendar-absolute-from-gregorian mark)
1730 (calendar-absolute-from-gregorian cursor))
1731 (setq start mark
1732 end cursor)
1733 (setq start cursor
1734 end mark))
1735 (make-diary-entry
1736 (format "%s(diary-block %s %s)"
1737 sexp-diary-entry-symbol
1738 (calendar-date-string start nil t)
1739 (calendar-date-string end nil t))
1740 arg)))
1742 (defun insert-cyclic-diary-entry (arg)
1743 "Insert a cyclic diary entry starting at the date given by point.
1744 Prefix arg will make the entry nonmarking."
1745 (interactive "P")
1746 (let ((calendar-date-display-form
1747 (if european-calendar-style
1748 '(day " " month " " year)
1749 '(month " " day " " year))))
1750 (make-diary-entry
1751 (format "%s(diary-cyclic %d %s)"
1752 sexp-diary-entry-symbol
1753 (calendar-read "Repeat every how many days: "
1754 (lambda (x) (> x 0)))
1755 (calendar-date-string (calendar-cursor-to-date t) nil t))
1756 arg)))
1758 ;;;###autoload
1759 (define-derived-mode diary-mode fundamental-mode
1760 "Diary"
1761 "Major mode for editing the diary file."
1762 (set (make-local-variable 'font-lock-defaults)
1763 '(diary-font-lock-keywords t)))
1765 (define-derived-mode fancy-diary-display-mode fundamental-mode
1766 "Diary"
1767 "Major mode used while displaying diary entries using Fancy Display."
1768 (set (make-local-variable 'font-lock-defaults)
1769 '(fancy-diary-font-lock-keywords t))
1770 (define-key (current-local-map) "q" 'quit-window))
1773 (defvar fancy-diary-font-lock-keywords
1774 (list
1775 (cons
1776 (concat
1777 (let ((dayname (diary-name-pattern calendar-day-name-array nil t))
1778 (monthname (diary-name-pattern calendar-month-name-array nil t))
1779 (day "[0-9]+")
1780 (month "[0-9]+")
1781 (year "-?[0-9]+"))
1782 (mapconcat 'eval calendar-date-display-form ""))
1783 "\\(\\(: .*\\)\\|\\(\n +.*\\)\\)*\n=+$")
1784 'diary-face)
1785 '("^.*anniversary.*$" . font-lock-keyword-face)
1786 '("^.*birthday.*$" . font-lock-keyword-face)
1787 '("^.*Yahrzeit.*$" . font-lock-reference-face)
1788 '("^\\(Erev \\)?Rosh Hodesh.*" . font-lock-function-name-face)
1789 '("^Day.*omer.*$" . font-lock-builtin-face)
1790 '("^Parashat.*$" . font-lock-comment-face)
1791 '("^[ \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\\)?\\)?"
1792 . font-lock-variable-name-face))
1793 "Keywords to highlight in fancy diary display")
1796 (defun font-lock-diary-sexps (limit)
1797 "Recognize sexp diary entry for font-locking."
1798 (if (re-search-forward
1799 (concat "^" (regexp-quote diary-nonmarking-symbol)
1800 "?\\(" (regexp-quote sexp-diary-entry-symbol) "\\)")
1801 limit t)
1802 (condition-case nil
1803 (save-restriction
1804 (narrow-to-region (point-min) limit)
1805 (let ((start (point)))
1806 (forward-sexp 1)
1807 (store-match-data (list start (point)))
1809 (error t))))
1811 (defun font-lock-diary-date-forms (month-array &optional symbol abbrev-array)
1812 "Create font-lock patterns for `diary-date-forms' using MONTH-ARRAY.
1813 If given, optional SYMBOL must be a prefix to entries.
1814 If optional ABBREV-ARRAY is present, the abbreviations constructed
1815 from this array by the function `calendar-abbrev-construct' are
1816 matched (with or without a final `.'), in addition to the full month
1817 names."
1818 (let ((dayname (diary-name-pattern calendar-day-name-array
1819 calendar-day-abbrev-array t))
1820 (monthname (format "\\(%s\\|\\*\\)"
1821 (diary-name-pattern month-array abbrev-array)))
1822 (month "\\([0-9]+\\|\\*\\)")
1823 (day "\\([0-9]+\\|\\*\\)")
1824 (year "-?\\([0-9]+\\|\\*\\)"))
1825 (mapcar '(lambda (x)
1826 (cons
1827 (concat "^" (regexp-quote diary-nonmarking-symbol) "?"
1828 (if symbol (regexp-quote symbol) "") "\\("
1829 (mapconcat 'eval
1830 ;; If backup, omit first item (backup)
1831 ;; and last item (not part of date)
1832 (if (equal (car x) 'backup)
1833 (reverse (cdr (reverse (cdr x))))
1836 ;; With backup, last item is not part of date
1837 (if (equal (car x) 'backup)
1838 (concat "\\)" (eval (car (reverse x))))
1839 "\\)"))
1840 '(1 diary-face)))
1841 diary-date-forms)))
1843 (eval-when-compile (require 'cal-hebrew)
1844 (require 'cal-islam))
1846 (defvar diary-font-lock-keywords
1847 (append
1848 (font-lock-diary-date-forms calendar-month-name-array
1849 nil calendar-month-abbrev-array)
1850 (when (or (memq 'mark-hebrew-diary-entries
1851 nongregorian-diary-marking-hook)
1852 (memq 'list-hebrew-diary-entries
1853 nongregorian-diary-listing-hook))
1854 (require 'cal-hebrew)
1855 (font-lock-diary-date-forms
1856 calendar-hebrew-month-name-array-leap-year
1857 hebrew-diary-entry-symbol))
1858 (when (or (memq 'mark-islamic-diary-entries
1859 nongregorian-diary-marking-hook)
1860 (memq 'list-islamic-diary-entries
1861 nongregorian-diary-listing-hook))
1862 (require 'cal-islam)
1863 (font-lock-diary-date-forms
1864 calendar-islamic-month-name-array
1865 islamic-diary-entry-symbol))
1866 (list
1867 (cons
1868 (concat "^" (regexp-quote diary-include-string) ".*$")
1869 'font-lock-keyword-face)
1870 (cons
1871 (concat "^" (regexp-quote diary-nonmarking-symbol)
1872 "?\\(" (regexp-quote sexp-diary-entry-symbol) "\\)")
1873 '(1 font-lock-reference-face))
1874 (cons
1875 (concat "^" (regexp-quote diary-nonmarking-symbol))
1876 'font-lock-reference-face)
1877 (cons
1878 (concat "^" (regexp-quote diary-nonmarking-symbol)
1879 "?\\(" (regexp-quote hebrew-diary-entry-symbol) "\\)")
1880 '(1 font-lock-reference-face))
1881 (cons
1882 (concat "^" (regexp-quote diary-nonmarking-symbol)
1883 "?\\(" (regexp-quote islamic-diary-entry-symbol) "\\)")
1884 '(1 font-lock-reference-face))
1885 '(font-lock-diary-sexps . font-lock-keyword-face)
1886 '("[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)\\(-[0-9]?[0-9]\\([:.]?[0-9][0-9]\\)?\\(am\\|pm\\|AM\\|PM\\)\\)?"
1887 . font-lock-function-name-face)))
1888 "Forms to highlight in diary-mode")
1891 ;; Following code from Dave Love <fx@gnu.org>.
1892 ;; Import Outlook-format appointments from mail messages in Gnus or
1893 ;; Rmail using command `diary-from-outlook'. This, or the specialized
1894 ;; functions `diary-from-outlook-gnus' and `diary-from-outlook-rmail',
1895 ;; could be run from hooks to notice appointments automatically (in
1896 ;; which case they will prompt about adding to the diary). The
1897 ;; message formats recognized are customizable through
1898 ;; `diary-outlook-formats'.
1900 (defcustom diary-outlook-formats
1902 ;; When: 11 October 2001 12:00-14:00 (GMT) Greenwich Mean Time : Dublin, ...
1903 ;; [Current UK format? The timezone is meaningless. Sometimes the
1904 ;; Where is missing.]
1905 ("When: \\([0-9]+ [[:alpha:]]+ [0-9]+\\) \
1906 \\([^ ]+\\) [^\n]+
1907 \[^\n]+
1908 \\(?:Where: \\([^\n]+\\)\n+\\)?
1909 \\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*"
1910 . "\\1\n \\2 %s, \\3")
1911 ;; When: Tuesday, April 30, 2002 03:00 PM-03:30 PM (GMT) Greenwich Mean ...
1912 ;; [Old UK format?]
1913 ("^When: [[:alpha:]]+, \\([[:alpha:]]+\\) \\([0-9][0-9]*\\), \\([0-9]\\{4\\}\\) \
1914 \\([^ ]+\\) [^\n]+
1915 \[^\n]+
1916 \\(?:Where: \\([^\n]+\\)\\)?\n+"
1917 . "\\2 \\1 \\3\n \\4 %s, \\5")
1919 ;; German format, apparently.
1920 "^Zeit: [^ ]+, +\\([0-9]+\\)\. +\\([[:upper:]][[:lower:]][[:lower:]]\\)[^ ]* +\\([0-9]+\\) +\\([^ ]+\\).*$"
1921 . "\\1 \\2 \\3\n \\4 %s"))
1922 "Alist of regexps matching message text and replacement text.
1924 The regexp must match the start of the message text containing an
1925 appointment, but need not include a leading `^'. If it matches the
1926 current message, a diary entry is made from the corresponding
1927 template. If the template is a string, it should be suitable for
1928 passing to `replace-match', and so will have occurrences of `\\D' to
1929 substitute the match for the Dth subexpression. It must also contain
1930 a single `%s' which will be replaced with the text of the message's
1931 Subject field. Any other `%' characters must be doubled, so that the
1932 template can be passed to `format'.
1934 If the template is actually a function, it is called with the message
1935 body text as argument, and may use `match-string' etc. to make a
1936 template following the rules above."
1937 :type '(alist :key-type (regexp :tag "Regexp matching time/place")
1938 :value-type (choice
1939 (string :tag "Template for entry")
1940 (function :tag "Unary function providing template")))
1941 :version "21.4"
1942 :group 'diary)
1945 ;; Dynamically bound.
1946 (defvar body)
1947 (defvar subject)
1949 (defun diary-from-outlook-internal (&optional test-only)
1950 "Snarf a diary entry from a message assumed to be from MS Outlook.
1951 Assumes `body' is bound to a string comprising the body of the message and
1952 `subject' is bound to a string comprising its subject.
1953 Arg TEST-ONLY non-nil means return non-nil if and only if the
1954 message contains an appointment, don't make a diary entry."
1955 (catch 'finished
1956 (let (format-string)
1957 (dotimes (i (length diary-outlook-formats))
1958 (when (eq 0 (string-match (car (nth i diary-outlook-formats))
1959 body))
1960 (unless test-only
1961 (setq format-string (cdr (nth i diary-outlook-formats)))
1962 (save-excursion
1963 (save-window-excursion
1964 ;; Fixme: References to optional fields in the format
1965 ;; are treated literally, not replaced by the empty
1966 ;; string. I think this is an Emacs bug.
1967 (make-diary-entry
1968 (format (replace-match (if (functionp format-string)
1969 (funcall format-string body)
1970 format-string)
1971 t nil (match-string 0 body))
1972 subject))
1973 (save-buffer))))
1974 (throw 'finished t))))
1975 nil))
1977 (defun diary-from-outlook (&optional noconfirm)
1978 "Maybe snarf diary entry from current Outlook-generated message.
1979 Currently knows about Gnus and Rmail modes. Unless the optional
1980 argument NOCONFIRM is non-nil (which is the case when this
1981 function is called interactively), then if an entry is found the
1982 user is asked to confirm its addition."
1983 (interactive "p")
1984 (let ((func (cond
1985 ((eq major-mode 'rmail-mode)
1986 #'diary-from-outlook-rmail)
1987 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
1988 #'diary-from-outlook-gnus)
1989 (t (error "Don't know how to snarf in `%s'" major-mode)))))
1990 (funcall func noconfirm)))
1993 (defvar gnus-article-mime-handles)
1994 (defvar gnus-article-buffer)
1996 (autoload 'gnus-fetch-field "gnus-util")
1997 (autoload 'gnus-narrow-to-body "gnus")
1998 (autoload 'mm-get-part "mm-decode")
2000 (defun diary-from-outlook-gnus (&optional noconfirm)
2001 "Maybe snarf diary entry from Outlook-generated message in Gnus.
2002 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2003 this function is called interactively), then if an entry is found the
2004 user is asked to confirm its addition.
2005 Add this function to `gnus-article-prepare-hook' to notice appointments
2006 automatically."
2007 (interactive "p")
2008 (with-current-buffer gnus-article-buffer
2009 (let ((subject (gnus-fetch-field "subject"))
2010 (body (if gnus-article-mime-handles
2011 ;; We're multipart. Don't get confused by part
2012 ;; buttons &c. Assume info is in first part.
2013 (mm-get-part (nth 1 gnus-article-mime-handles))
2014 (save-restriction
2015 (gnus-narrow-to-body)
2016 (buffer-string)))))
2017 (when (diary-from-outlook-internal t)
2018 (when (or noconfirm (y-or-n-p "Snarf diary entry? "))
2019 (diary-from-outlook-internal)
2020 (message "Diary entry added"))))))
2022 (custom-add-option 'gnus-article-prepare-hook 'diary-from-outlook-gnus)
2025 (defvar rmail-buffer)
2027 (defun diary-from-outlook-rmail (&optional noconfirm)
2028 "Maybe snarf diary entry from Outlook-generated message in Rmail.
2029 Unless the optional argument NOCONFIRM is non-nil (which is the case when
2030 this function is called interactively), then if an entry is found the
2031 user is asked to confirm its addition."
2032 (interactive "p")
2033 (with-current-buffer rmail-buffer
2034 (let ((subject (mail-fetch-field "subject"))
2035 (body (buffer-substring (save-excursion
2036 (rfc822-goto-eoh)
2037 (point))
2038 (point-max))))
2039 (when (diary-from-outlook-internal t)
2040 (when (or noconfirm (y-or-n-p "Snarf diary entry? "))
2041 (diary-from-outlook-internal)
2042 (message "Diary entry added"))))))
2045 (provide 'diary-lib)
2047 ;;; arch-tag: 22dd506e-2e33-410d-9ae1-095a0c1b2010
2048 ;;; diary-lib.el ends here